Demos/Host/LowLevel/MouseHost/MouseHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the MouseHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MouseHost.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Mouse HID Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         sei();
  50
  51         for (;;)
  52         {
  53                 Mouse_HID_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         SerialStream_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72 }
  73
  74 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  75  *  starts the library USB task to begin the enumeration and USB management process.
  76  */
  77 void EVENT_USB_Host_DeviceAttached(void)
  78 {
  79         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  80         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  81 }
  82
  83 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  84  *  stops the library USB task management process.
  85  */
  86 void EVENT_USB_Host_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  89         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  90 }
  91
  92 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  93  *  enumerated by the host and is now ready to be used by the application.
  94  */
  95 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  98 }
  99
 100 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 101 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 106                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 107
 108         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 109         for(;;);
 110 }
 111
 112 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 113  *  enumerating an attached USB device.
 114  */
 115 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 116 {
 117         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 118                                  " -- Error Code %d\r\n"
 119                                  " -- Sub Error Code %d\r\n"
 120                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 121
 122         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Reads in and processes the next report from the attached device, displaying the report
 126  *  contents on the board LEDs and via the serial port.
 127  */
 128 void ReadNextReport(void)
 129 {
 130         USB_MouseReport_Data_t MouseReport;
 131         uint8_t                LEDMask = LEDS_NO_LEDS;
 132
 133         /* Select mouse data pipe */
 134         Pipe_SelectPipe(MOUSE_DATAPIPE);
 135
 136         /* Unfreeze keyboard data pipe */
 137         Pipe_Unfreeze();
 138
 139         /* Check to see if a packet has been received */
 140         if (!(Pipe_IsINReceived()))
 141         {
 142                 /* No packet received (no movement), turn off LEDs */
 143                 LEDs_SetAllLEDs(LEDS_NO_LEDS);
 144
 145                 /* Refreeze HID data IN pipe */
 146                 Pipe_Freeze();
 147
 148                 return;
 149         }
 150
 151         /* Ensure pipe contains data before trying to read from it */
 152         if (Pipe_IsReadWriteAllowed())
 153         {
 154                 /* Read in mouse report data */
 155                 Pipe_Read_Stream_LE(&MouseReport, sizeof(MouseReport));
 156
 157                 /* Alter status LEDs according to mouse X movement */
 158                 if (MouseReport.X > 0)
 159                   LEDMask |= LEDS_LED1;
 160                 else if (MouseReport.X < 0)
 161                   LEDMask |= LEDS_LED2;
 162
 163                 /* Alter status LEDs according to mouse Y movement */
 164                 if (MouseReport.Y > 0)
 165                   LEDMask |= LEDS_LED3;
 166                 else if (MouseReport.Y < 0)
 167                   LEDMask |= LEDS_LED4;
 168
 169                 /* Alter status LEDs according to mouse button position */
 170                 if (MouseReport.Button)
 171                   LEDMask  = LEDS_ALL_LEDS;
 172
 173                 LEDs_SetAllLEDs(LEDMask);
 174
 175                 /* Print mouse report data through the serial port */
 176                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 177                                                                                                           MouseReport.Y,
 178                                                                                                           MouseReport.Button);
 179         }
 180
 181         /* Clear the IN endpoint, ready for next data packet */
 182         Pipe_ClearIN();
 183
 184         /* Refreeze mouse data pipe */
 185         Pipe_Freeze();
 186 }
 187
 188 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 189  *  HID reports from the device and display the results onto the board LEDs.
 190  */
 191 void Mouse_HID_Task(void)
 192 {
 193         uint8_t ErrorCode;
 194
 195         /* Switch to determine what user-application handled host state the host state machine is in */
 196         switch (USB_HostState)
 197         {
 198                 case HOST_STATE_Addressed:
 199                         puts_P(PSTR("Getting Config Data.\r\n"));
 200
 201                         /* Get and process the configuration descriptor data */
 202                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 203                         {
 204                                 if (ErrorCode == ControlError)
 205                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 206                                 else
 207                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 208
 209                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 210
 211                                 /* Indicate error status */
 212                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 213
 214                                 /* Wait until USB device disconnected */
 215                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 216                                 break;
 217                         }
 218
 219                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 220                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 221                         {
 222                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 223                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 224
 225                                 /* Indicate error status */
 226                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 227
 228                                 /* Wait until USB device disconnected */
 229                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 230                                 break;
 231                         }
 232
 233                         /* HID class request to set the mouse protocol to the Boot Protocol */
 234                         USB_ControlRequest = (USB_Request_Header_t)
 235                                 {
 236                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 237                                         .bRequest      = REQ_SetProtocol,
 238                                         .wValue        = 0,
 239                                         .wIndex        = 0,
 240                                         .wLength       = 0,
 241                                 };
 242
 243                         /* Select the control pipe for the request transfer */
 244                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 245
 246                         /* Send the request, display error and wait for device detach if request fails */
 247                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 248                         {
 249                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
 250                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 251
 252                                 /* Indicate error status */
 253                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 254
 255                                 /* Wait until USB device disconnected */
 256                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 257                                 break;
 258                         }
 259
 260                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 261
 262                         USB_HostState = HOST_STATE_Configured;
 263                         break;
 264                 case HOST_STATE_Configured:
 265                         /* If a report has been received, read and process it */
 266                         ReadNextReport();
 267
 268                         break;
 269         }
 270 }