Demos/Host/MouseHostWithParser/MouseHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 MouseHostWithParser demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MouseHostWithParser.h"
  38
  39 /* Project Tags, for reading out using the ButtLoad project */
  40 BUTTLOADTAG(ProjName,    "LUFA Mouse Host App");
  41 BUTTLOADTAG(BuildTime,   __TIME__);
  42 BUTTLOADTAG(BuildDate,   __DATE__);
  43 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
  44
  45 /* Scheduler Task List */
  46 TASK_LIST
  47 {
  48         { Task: USB_USBTask          , TaskStatus: TASK_STOP },
  49         { Task: USB_Mouse_Host       , TaskStatus: TASK_STOP },
  50 };
  51
  52
  53 /** Main program entry point. This routine configures the hardware required by the application, then
  54  *  starts the scheduler to run the application tasks.
  55  */
  56 int main(void)
  57 {
  58         /* Disable watchdog if enabled by bootloader/fuses */
  59         MCUSR &= ~(1 << WDRF);
  60         wdt_disable();
  61
  62         /* Disable clock division */
  63         clock_prescale_set(clock_div_1);
  64
  65         /* Hardware Initialization */
  66         SerialStream_Init(9600, false);
  67         LEDs_Init();
  68
  69         /* Indicate USB not ready */
  70         UpdateStatus(Status_USBNotReady);
  71
  72         /* Initialize Scheduler so that it can be used */
  73         Scheduler_Init();
  74
  75         /* Initialize USB Subsystem */
  76         USB_Init();
  77
  78         /* Start-up message */
  79         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  80                "Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));
  81
  82         /* Scheduling - routine never returns, so put this last in the main function */
  83         Scheduler_Start();
  84 }
  85
  86 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  87  *  starts the library USB task to begin the enumeration and USB management process.
  88  */
  89 EVENT_HANDLER(USB_DeviceAttached)
  90 {
  91         puts_P(PSTR("Device Attached.\r\n"));
  92         UpdateStatus(Status_USBEnumerating);
  93
  94         /* Start USB management task to enumerate the device */
  95         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  96 }
  97
  98 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  99  *  stops the library USB task management process.
 100  */
 101 EVENT_HANDLER(USB_DeviceUnattached)
 102 {
 103         /* Stop mouse and USB management task */
 104         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 105         Scheduler_SetTaskMode(USB_Mouse_Host, TASK_STOP);
 106
 107         puts_P(PSTR("Device Unattached.\r\n"));
 108         UpdateStatus(Status_USBNotReady);
 109 }
 110
 111 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 112  *  enumerated by the host and is now ready to be used by the application.
 113  */
 114 EVENT_HANDLER(USB_DeviceEnumerationComplete)
 115 {
 116         /* Start Mouse Host task */
 117         Scheduler_SetTaskMode(USB_Mouse_Host, TASK_RUN);
 118
 119         /* Indicate device enumeration complete */
 120         UpdateStatus(Status_USBReady);
 121 }
 122
 123 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 124 EVENT_HANDLER(USB_HostError)
 125 {
 126         USB_ShutDown();
 127
 128         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 129         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 130
 131         UpdateStatus(Status_HardwareError);
 132         for(;;);
 133 }
 134
 135 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 136  *  enumerating an attached USB device.
 137  */
 138 EVENT_HANDLER(USB_DeviceEnumerationFailed)
 139 {
 140         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 141         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 142         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 143         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 144
 145         UpdateStatus(Status_EnumerationError);
 146 }
 147
 148 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 149  *  log to a serial port, or anything else that is suitable for status updates.
 150  *
 151  *  \param CurrentStatus  Current status of the system, from the MouseHostWithParser_StatusCodes_t enum
 152  */
 153 void UpdateStatus(uint8_t CurrentStatus)
 154 {
 155         uint8_t LEDMask = LEDS_NO_LEDS;
 156
 157         /* Set the LED mask to the appropriate LED mask based on the given status code */
 158         switch (CurrentStatus)
 159         {
 160                 case Status_USBNotReady:
 161                         LEDMask = (LEDS_LED1);
 162                         break;
 163                 case Status_USBEnumerating:
 164                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 165                         break;
 166                 case Status_USBReady:
 167                         LEDMask = (LEDS_LED2);
 168                         break;
 169                 case Status_EnumerationError:
 170                 case Status_HardwareError:
 171                         LEDMask = (LEDS_LED1 | LEDS_LED3);
 172                         break;
 173                 case Status_Busy:
 174                         LEDMask = (LEDS_LED1 | LEDS_LED4);
 175                         break;
 176         }
 177
 178         /* Set the board LEDs to the new LED mask */
 179         LEDs_SetAllLEDs(LEDMask);
 180 }
 181
 182 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 183  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 184  */
 185 TASK(USB_Mouse_Host)
 186 {
 187         uint8_t ErrorCode;
 188
 189         /* Switch to determine what user-application handled host state the host state machine is in */
 190         switch (USB_HostState)
 191         {
 192                 case HOST_STATE_Addressed:
 193                         /* Standard request to set the device configuration to configuration 1 */
 194                         USB_HostRequest = (USB_Host_Request_Header_t)
 195                                 {
 196                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 197                                         bRequest:      REQ_SetConfiguration,
 198                                         wValue:        1,
 199                                         wIndex:        0,
 200                                         wLength:       0,
 201                                 };
 202
 203                         /* Select the control pipe for the request transfer */
 204                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 205
 206                         /* Send the request, display error and wait for device detach if request fails */
 207                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 208                         {
 209                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 210                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 211
 212                                 /* Indicate error via status LEDs */
 213                                 UpdateStatus(Status_EnumerationError);
 214
 215                                 /* Wait until USB device disconnected */
 216                                 while (USB_IsConnected);
 217                                 break;
 218                         }
 219
 220                         USB_HostState = HOST_STATE_Configured;
 221                         break;
 222                 case HOST_STATE_Configured:
 223                         puts_P(PSTR("Getting Config Data.\r\n"));
 224
 225                         /* Get and process the configuration descriptor data */
 226                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 227                         {
 228                                 if (ErrorCode == ControlError)
 229                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 230                                 else
 231                                   puts_P(PSTR("Invalid Device.\r\n"));
 232
 233                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 234
 235                                 /* Indicate error via status LEDs */
 236                                 UpdateStatus(Status_EnumerationError);
 237
 238                                 /* Wait until USB device disconnected */
 239                                 while (USB_IsConnected);
 240                                 break;
 241                         }
 242
 243                         puts_P(PSTR("Processing HID Report.\r\n"));
 244
 245                         /* LEDs one and two on to indicate busy processing */
 246                         UpdateStatus(Status_Busy);
 247
 248                         /* Get and process the device's first HID report descriptor */
 249                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 250                         {
 251                                 puts_P(PSTR("Report Parse Error.\r\n"));
 252                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 253
 254                                 /* Indicate error via status LEDs */
 255                                 UpdateStatus(Status_EnumerationError);
 256
 257                                 /* Wait until USB device disconnected */
 258                                 while (USB_IsConnected);
 259                                 break;
 260                         }
 261
 262                         /* All LEDs off - ready to indicate key presses */
 263                         UpdateStatus(Status_USBReady);
 264
 265                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 266
 267                         USB_HostState = HOST_STATE_Ready;
 268                         break;
 269                 case HOST_STATE_Ready:
 270                         /* Select and unfreeze mouse data pipe */
 271                         Pipe_SelectPipe(MOUSE_DATAPIPE);
 272                         Pipe_Unfreeze();
 273
 274                         /* Check if data has been received from the attached mouse */
 275                         if (Pipe_ReadWriteAllowed())
 276                         {
 277                                 uint8_t LEDMask = LEDS_NO_LEDS;
 278
 279                                 /* Create buffer big enough for the report */
 280                                 uint8_t MouseReport[Pipe_BytesInPipe()];
 281
 282                                 /* Load in the mouse report */
 283                                 Pipe_Read_Stream_LE(MouseReport, Pipe_BytesInPipe());
 284
 285                                 /* Clear the IN endpoint, ready for next data packet */
 286                                 Pipe_ClearCurrentBank();
 287
 288                                 /* Check each HID report item in turn, looking for mouse X/Y/button reports */
 289                                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 290                                 {
 291                                         /* Create a temporary item pointer to the next report item */
 292                                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 293
 294                                         bool FoundData;
 295
 296                                         if ((ReportItem->Attributes.Usage.Page       == USAGE_PAGE_BUTTON) &&
 297                                             (ReportItem->ItemType                    == REPORT_ITEM_TYPE_In))
 298                                         {
 299                                                 /* Get the mouse button value */
 300                                                 FoundData = GetReportItemInfo(MouseReport, ReportItem);
 301
 302                                                 /* For multi-report devices - if the requested data was not in the issued report, continue */
 303                                                 if (!(FoundData))
 304                                                   continue;
 305
 306                                                 /* If button is pressed, all LEDs are turned on */
 307                                                 if (ReportItem->Value)
 308                                                   LEDMask = LEDS_ALL_LEDS;
 309                                         }
 310                                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 311                                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 312                                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 313                                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 314                                         {
 315                                                 /* Get the mouse relative position value */
 316                                                 FoundData = GetReportItemInfo(MouseReport, ReportItem);
 317
 318                                                 /* For multi-report devices - if the requested data was not in the issued report, continue */
 319                                                 if (!(FoundData))
 320                                                   continue;
 321
 322                                                 int16_t DeltaMovement;
 323
 324                                                 if (ReportItem->Attributes.BitSize > 8)
 325                                                   DeltaMovement = (int16_t)ReportItem->Value;
 326                                                 else
 327                                                   DeltaMovement = (int8_t)ReportItem->Value;
 328
 329                                                 /* Determine if the report is for the X or Y delta movement */
 330                                                 if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 331                                                 {
 332                                                         /* Turn on the appropriate LED according to direction if the delta is non-zero */
 333                                                         if (DeltaMovement)
 334                                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 335                                                 }
 336                                                 else
 337                                                 {
 338                                                         /* Turn on the appropriate LED according to direction if the delta is non-zero */
 339                                                         if (DeltaMovement)
 340                                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 341                                                 }
 342                                         }
 343                                 }
 344
 345                                 /* Display the button information on the board LEDs */
 346                                 LEDs_SetAllLEDs(LEDMask);
 347                         }
 348
 349                         /* Freeze mouse data pipe */
 350                         Pipe_Freeze();
 351                         break;
 352         }
 353 }
 354