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