Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.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 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 /** 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 Parser 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,
 116                                             const uint8_t SubErrorCode)
 117 {
 118         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 119                                  " -- Error Code %d\r\n"
 120                                  " -- Sub Error Code %d\r\n"
 121                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 122
 123         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 124 }
 125
 126 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 127  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 128  */
 129 void Mouse_HID_Task(void)
 130 {
 131         uint8_t ErrorCode;
 132
 133         /* Switch to determine what user-application handled host state the host state machine is in */
 134         switch (USB_HostState)
 135         {
 136                 case HOST_STATE_Addressed:
 137                         puts_P(PSTR("Getting Config Data.\r\n"));
 138
 139                         /* Get and process the configuration descriptor data */
 140                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 141                         {
 142                                 if (ErrorCode == ControlError)
 143                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 144                                 else
 145                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 146
 147                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 148
 149                                 /* Indicate error via status LEDs */
 150                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 151
 152                                 /* Wait until USB device disconnected */
 153                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 154                                 break;
 155                         }
 156
 157                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 158                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 159                         {
 160                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 161                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 162
 163                                 /* Indicate error via status LEDs */
 164                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 165
 166                                 /* Wait until USB device disconnected */
 167                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 168                                 break;
 169                         }
 170
 171                         printf_P(PSTR("Processing HID Report (Size %d Bytes).\r\n"), HIDReportSize);
 172
 173                         /* Get and process the device's first HID report descriptor */
 174                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 175                         {
 176                                 puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
 177
 178                                 if (!(HIDReportInfo.TotalReportItems))
 179                                         puts_P(PSTR("Not a valid Mouse." ESC_FG_WHITE));
 180                                 else
 181                                         printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 182
 183                                 /* Indicate error via status LEDs */
 184                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 185
 186                                 /* Wait until USB device disconnected */
 187                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 188                                 break;
 189                         }
 190
 191                         printf("Total Reports: %d\r\n", HIDReportInfo.TotalDeviceReports);
 192
 193                         for (uint8_t i = 0; i < HIDReportInfo.TotalDeviceReports; i++)
 194                         {
 195                                 HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[i];
 196
 197                                 uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_In];
 198                                 uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Out];
 199                                 uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Feature];
 200
 201                                 /* Print out the byte sizes of each report within the device */
 202                                 printf_P(PSTR("  + Report ID %d - In: %d bytes, Out: %d bytes, Feature: %d bytes\r\n"),
 203                                          CurrReportIDInfo->ReportID,
 204                                          ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),
 205                                          ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),
 206                                          ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));
 207                         }
 208
 209                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 210
 211                         USB_HostState = HOST_STATE_Configured;
 212                         break;
 213                 case HOST_STATE_Configured:
 214                         /* Select and unfreeze mouse data pipe */
 215                         Pipe_SelectPipe(MOUSE_DATAPIPE);
 216                         Pipe_Unfreeze();
 217
 218                         /* Check to see if a packet has been received */
 219                         if (Pipe_IsINReceived())
 220                         {
 221                                 /* Check if data has been received from the attached mouse */
 222                                 if (Pipe_IsReadWriteAllowed())
 223                                 {
 224                                         /* Create buffer big enough for the report */
 225                                         uint8_t MouseReport[Pipe_BytesInPipe()];
 226
 227                                         /* Load in the mouse report */
 228                                         Pipe_Read_Stream_LE(MouseReport, Pipe_BytesInPipe());
 229
 230                                         /* Process the read in mouse report from the device */
 231                                         ProcessMouseReport(MouseReport);
 232                                 }
 233
 234                                 /* Clear the IN endpoint, ready for next data packet */
 235                                 Pipe_ClearIN();
 236                         }
 237
 238                         /* Freeze mouse data pipe */
 239                         Pipe_Freeze();
 240                         break;
 241         }
 242 }
 243
 244 /** Processes a read HID report from an attached mouse, extracting out elements via the HID parser results
 245  *  as required and displays movement and button presses on the board LEDs.
 246  *
 247  *  \param[in] MouseReport  Pointer to a HID report from an attached mouse device
 248  */
 249 void ProcessMouseReport(uint8_t* MouseReport)
 250 {
 251         uint8_t LEDMask = LEDS_NO_LEDS;
 252
 253         /* Check each HID report item in turn, looking for mouse X/Y/button reports */
 254         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 255         {
 256                 /* Create a temporary item pointer to the next report item */
 257                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 258
 259                 bool FoundData;
 260
 261                 if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 262                         (ReportItem->ItemType                     == REPORT_ITEM_TYPE_In))
 263                 {
 264                         /* Get the mouse button value */
 265                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 266
 267                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 268                         if (!(FoundData))
 269                           continue;
 270
 271                         /* If button is pressed, all LEDs are turned on */
 272                         if (ReportItem->Value)
 273                           LEDMask = LEDS_ALL_LEDS;
 274                 }
 275                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 276                                  (ReportItem->Attributes.Usage.Usage  == USAGE_SCROLL_WHEEL)       &&
 277                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 278                 {
 279                         /* Get the mouse wheel value if it is contained within the current
 280                          * report, if not, skip to the next item in the parser list
 281                          */
 282                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 283                           continue;
 284
 285                         int16_t WheelDelta = HID_ALIGN_DATA(ReportItem, int16_t);
 286
 287                         if (WheelDelta)
 288                           LEDMask = (LEDS_LED1 | LEDS_LED2 | ((WheelDelta > 0) ? LEDS_LED3 : LEDS_LED4));
 289                 }
 290                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 291                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 292                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 293                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 294                 {
 295                         /* Get the mouse relative position value */
 296                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 297
 298                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 299                         if (!(FoundData))
 300                           continue;
 301
 302                         int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 303
 304                         /* Check to see if a (non-zero) delta movement has been indicated */
 305                         if (DeltaMovement)
 306                         {
 307                                 /* Determine if the report is for the X or Y delta movement, light LEDs as appropriate */
 308                                 if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 309                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 310                                 else
 311                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 312                         }
 313                 }
 314         }
 315
 316         /* Display the button information on the board LEDs */
 317         LEDs_SetAllLEDs(LEDMask);
 318 }