Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.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 JoystickHostWithParser demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "JoystickHostWithParser.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 Joystick_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 "Joystick 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(&Joystick_HID_Interface,
  94                                                             ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
  95                                 {
  96                                         printf("Attached Device Not a Valid Joystick.\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(&Joystick_HID_Interface) != 0)
 111                                 {
 112                                         printf("Error Setting Report Protocol Mode or Not a Valid Joystick.\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("Joystick Enumerated.\r\n");
 121                                 USB_HostState = HOST_STATE_Configured;
 122                                 break;
 123                         case HOST_STATE_Configured:
 124                                 if (HID_Host_IsReportReceived(&Joystick_HID_Interface))
 125                                 {
 126                                         uint8_t JoystickReport[Joystick_HID_Interface.State.LargestReportSize];
 127                                         HID_Host_ReceiveReport(&Joystick_HID_Interface, &JoystickReport);
 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 joystick 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(JoystickReport, 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_X)                  ||
 149                                                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 150                                                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 151                                                 {
 152                                                         /* Get the joystick relative position value if it is contained within the current
 153                                                          * report, if not, skip to the next item in the parser list
 154                                                          */
 155                                                         if (!(USB_GetHIDReportItemInfo(JoystickReport, ReportItem)))
 156                                                           continue;
 157
 158                                                         int16_t DeltaMovement = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));
 159
 160                                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 161                                                         {
 162                                                                 if (DeltaMovement)
 163                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 164                                                         }
 165                                                         else
 166                                                         {
 167                                                                 if (DeltaMovement)
 168                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 169                                                         }
 170                                                 }
 171                                         }
 172
 173                                         LEDs_SetAllLEDs(LEDMask);
 174                                 }
 175
 176                                 break;
 177                 }
 178
 179                 HID_Host_USBTask(&Joystick_HID_Interface);
 180                 USB_USBTask();
 181         }
 182 }
 183
 184 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 185 void SetupHardware(void)
 186 {
 187         /* Disable watchdog if enabled by bootloader/fuses */
 188         MCUSR &= ~(1 << WDRF);
 189         wdt_disable();
 190
 191         /* Disable clock division */
 192         clock_prescale_set(clock_div_1);
 193
 194         /* Hardware Initialization */
 195         SerialStream_Init(9600, false);
 196         LEDs_Init();
 197         USB_Init();
 198 }
 199
 200 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 201  *  starts the library USB task to begin the enumeration and USB management process.
 202  */
 203 void EVENT_USB_Host_DeviceAttached(void)
 204 {
 205         puts_P(PSTR("Device Attached.\r\n"));
 206         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 207 }
 208
 209 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 210  *  stops the library USB task management process.
 211  */
 212 void EVENT_USB_Host_DeviceUnattached(void)
 213 {
 214         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 215         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 216 }
 217
 218 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 219  *  enumerated by the host and is now ready to be used by the application.
 220  */
 221 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 222 {
 223         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 224 }
 225
 226 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 227 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 228 {
 229         USB_ShutDown();
 230
 231         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 232                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 233
 234         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 235         for(;;);
 236 }
 237
 238 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 239  *  enumerating an attached USB device.
 240  */
 241 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, 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* CurrentItem)
 261 {
 262         bool IsJoystick = false;
 263
 264         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 265          * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Joystick usage
 266          * parent node, from being erroneously treated as a joystick 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_JOYSTICK))
 272                 {
 273                         IsJoystick = true;
 274                         break;
 275                 }
 276         }
 277
 278         /* If a collection with the joystick usage was not found, indicate that we are not interested in this item */
 279         if (!IsJoystick)
 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 }