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