Demos/Host/ClassDriver/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 /** Processed HID report descriptor items structure, containing information on each HID report element */
  40 HID_ReportInfo_t HIDReportInfo;
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Host_t Mouse_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .DataINPipeNumber       = 1,
  51                                 .DataOUTPipeNumber      = 2,
  52
  53                                 .HIDInterfaceProtocol   = HID_NON_BOOT_PROTOCOL,
  54
  55                                 .HIDParserData          = &HIDReportInfo
  56                         },
  57         };
  58
  59
  60 /** Main program entry point. This routine configures the hardware required by the application, then
  61  *  enters a loop to run the application tasks in sequence.
  62  */
  63 int main(void)
  64 {
  65         SetupHardware();
  66
  67         puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));
  68
  69         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  70
  71         for (;;)
  72         {
  73                 switch (USB_HostState)
  74                 {
  75                         case HOST_STATE_Addressed:
  76                                 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  77
  78                                 uint16_t ConfigDescriptorSize;
  79                                 uint8_t  ConfigDescriptorData[512];
  80
  81                                 if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
  82                                                                   sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
  83                                 {
  84                                         printf("Error Retrieving Configuration Descriptor.\r\n");
  85                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  86                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  87                                         break;
  88                                 }
  89
  90                                 if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
  91                                                             ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
  92                                 {
  93                                         printf("Attached Device Not a Valid Mouse.\r\n");
  94                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  95                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  96                                         break;
  97                                 }
  98
  99                                 if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 100                                 {
 101                                         printf("Error Setting Device Configuration.\r\n");
 102                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 103                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 104                                         break;
 105                                 }
 106
 107                                 if (HID_Host_SetReportProtocol(&Mouse_HID_Interface) != 0)
 108                                 {
 109                                         printf("Error Setting Report Protocol Mode or Not a Valid Mouse.\r\n");
 110                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 111                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 112                                         break;
 113                                 }
 114
 115                                 LEDs_SetAllLEDs(LEDS_NO_LEDS);
 116
 117                                 printf("Mouse Enumerated.\r\n");
 118                                 USB_HostState = HOST_STATE_Configured;
 119                                 break;
 120                         case HOST_STATE_Configured:
 121                                 if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 122                                 {
 123                                         uint8_t MouseReport[Mouse_HID_Interface.State.LargestReportSize];
 124                                         HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 125
 126                                         uint8_t LEDMask = LEDS_NO_LEDS;
 127
 128                                         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 129                                         {
 130                                                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 131
 132                                                 if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 133                                                         (ReportItem->ItemType                     == REPORT_ITEM_TYPE_In))
 134                                                 {
 135                                                         /* Get the mouse button value if it is contained within the current report, if not,
 136                                                          * skip to the next item in the parser list
 137                                                          */
 138                                                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 139                                                           continue;
 140
 141                                                         if (ReportItem->Value)
 142                                                           LEDMask = LEDS_ALL_LEDS;
 143                                                 }
 144                                                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 145                                                                  (ReportItem->Attributes.Usage.Usage  == USAGE_SCROLL_WHEEL)       &&
 146                                                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 147                                                 {
 148                                                         /* Get the mouse wheel value if it is contained within the current
 149                                                          * report, if not, skip to the next item in the parser list
 150                                                          */
 151                                                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 152                                                           continue;
 153
 154                                                         int16_t WheelDelta = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));
 155
 156                                                         if (WheelDelta)
 157                                                           LEDMask = (LEDS_LED1 | LEDS_LED2 | ((WheelDelta > 0) ? LEDS_LED3 : LEDS_LED4));
 158                                                 }
 159                                                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 160                                                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 161                                                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 162                                                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 163                                                 {
 164                                                         /* Get the mouse relative position value if it is contained within the current
 165                                                          * report, if not, skip to the next item in the parser list
 166                                                          */
 167                                                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 168                                                           continue;
 169
 170                                                         int16_t DeltaMovement = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));
 171
 172                                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 173                                                         {
 174                                                                 if (DeltaMovement)
 175                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 176                                                         }
 177                                                         else
 178                                                         {
 179                                                                 if (DeltaMovement)
 180                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 181                                                         }
 182                                                 }
 183                                         }
 184
 185                                         LEDs_SetAllLEDs(LEDMask);
 186                                 }
 187
 188                                 break;
 189                 }
 190
 191                 HID_Host_USBTask(&Mouse_HID_Interface);
 192                 USB_USBTask();
 193         }
 194 }
 195
 196 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 197 void SetupHardware(void)
 198 {
 199         /* Disable watchdog if enabled by bootloader/fuses */
 200         MCUSR &= ~(1 << WDRF);
 201         wdt_disable();
 202
 203         /* Disable clock division */
 204         clock_prescale_set(clock_div_1);
 205
 206         /* Hardware Initialization */
 207         SerialStream_Init(9600, false);
 208         LEDs_Init();
 209         USB_Init();
 210 }
 211
 212 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 213  *  starts the library USB task to begin the enumeration and USB management process.
 214  */
 215 void EVENT_USB_Host_DeviceAttached(void)
 216 {
 217         puts_P(PSTR("Device Attached.\r\n"));
 218         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 219 }
 220
 221 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 222  *  stops the library USB task management process.
 223  */
 224 void EVENT_USB_Host_DeviceUnattached(void)
 225 {
 226         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 227         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 228 }
 229
 230 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 231  *  enumerated by the host and is now ready to be used by the application.
 232  */
 233 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 234 {
 235         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 236 }
 237
 238 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 239 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 240 {
 241         USB_ShutDown();
 242
 243         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 244                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 245
 246         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 247         for(;;);
 248 }
 249
 250 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 251  *  enumerating an attached USB device.
 252  */
 253 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 254 {
 255         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 256                                  " -- Error Code %d\r\n"
 257                                  " -- Sub Error Code %d\r\n"
 258                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 259
 260         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 261 }
 262
 263 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 264  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 265  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 266  *  have occupied).
 267  *
 268  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 269  *
 270  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
 271  */
 272 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)
 273 {
 274         bool IsMouse = false;
 275
 276         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 277          * Mouse Usage is found - this prevents Joysticks, which use identical descriptors except for the Joystick usage
 278          * parent node, from being erronously treated as a mouse
 279          */
 280         for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
 281         {
 282                 if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
 283                     (CurrPath->Usage.Usage == USAGE_MOUSE))
 284                 {
 285                         IsMouse = true;
 286                         break;
 287                 }
 288         }
 289
 290         /* If a collection with the mouse usage was not found, indicate that we are not interested in this item */
 291         if (!IsMouse)
 292           return false;
 293
 294         /* Check the attributes of the current item - see if we are interested in it or not;
 295          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 296          * structure to save RAM and ignore the rest
 297          */
 298         return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
 299                 (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 300 }