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                                 printf("Joystick Enumerated.\r\n");
 119                                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 120                                 USB_HostState = HOST_STATE_Configured;
 121                                 break;
 122                         case HOST_STATE_Configured:
 123                                 if (HID_Host_IsReportReceived(&Joystick_HID_Interface))
 124                                 {
 125                                         uint8_t JoystickReport[Joystick_HID_Interface.State.LargestReportSize];
 126                                         HID_Host_ReceiveReport(&Joystick_HID_Interface, &JoystickReport);
 127
 128                                         uint8_t LEDMask = LEDS_NO_LEDS;
 129
 130                                         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 131                                         {
 132                                                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 133
 134                                                 /* Update the report item value if it is contained within the current report */
 135                                                 if (!(USB_GetHIDReportItemInfo(JoystickReport, ReportItem)))
 136                                                   continue;
 137
 138                                                 /* Determine what report item is being tested, process updated value as needed */
 139                                                 if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 140                                                         (ReportItem->ItemType                     == REPORT_ITEM_TYPE_In))
 141                                                 {
 142                                                         if (ReportItem->Value)
 143                                                           LEDMask = LEDS_ALL_LEDS;
 144                                                 }
 145                                                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 146                                                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 147                                                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 148                                                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 149                                                 {
 150                                                         int16_t DeltaMovement = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));
 151
 152                                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 153                                                         {
 154                                                                 if (DeltaMovement)
 155                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 156                                                         }
 157                                                         else
 158                                                         {
 159                                                                 if (DeltaMovement)
 160                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 161                                                         }
 162                                                 }
 163                                         }
 164
 165                                         LEDs_SetAllLEDs(LEDMask);
 166                                 }
 167
 168                                 break;
 169                 }
 170
 171                 HID_Host_USBTask(&Joystick_HID_Interface);
 172                 USB_USBTask();
 173         }
 174 }
 175
 176 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 177 void SetupHardware(void)
 178 {
 179         /* Disable watchdog if enabled by bootloader/fuses */
 180         MCUSR &= ~(1 << WDRF);
 181         wdt_disable();
 182
 183         /* Disable clock division */
 184         clock_prescale_set(clock_div_1);
 185
 186         /* Hardware Initialization */
 187         SerialStream_Init(9600, false);
 188         LEDs_Init();
 189         USB_Init();
 190 }
 191
 192 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 193  *  starts the library USB task to begin the enumeration and USB management process.
 194  */
 195 void EVENT_USB_Host_DeviceAttached(void)
 196 {
 197         puts_P(PSTR("Device Attached.\r\n"));
 198         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 199 }
 200
 201 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 202  *  stops the library USB task management process.
 203  */
 204 void EVENT_USB_Host_DeviceUnattached(void)
 205 {
 206         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 207         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 208 }
 209
 210 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 211  *  enumerated by the host and is now ready to be used by the application.
 212  */
 213 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 214 {
 215         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 216 }
 217
 218 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 219 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 220 {
 221         USB_ShutDown();
 222
 223         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 224                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 225
 226         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 227         for(;;);
 228 }
 229
 230 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 231  *  enumerating an attached USB device.
 232  */
 233 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 234 {
 235         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 236                                  " -- Error Code %d\r\n"
 237                                  " -- Sub Error Code %d\r\n"
 238                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 239
 240         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 241 }
 242
 243 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 244  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 245  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 246  *  have occupied).
 247  *
 248  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 249  *
 250  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
 251  */
 252 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)
 253 {
 254         bool IsJoystick = false;
 255
 256         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 257          * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Joystick usage
 258          * parent node, from being erroneously treated as a joystick by the demo
 259          */
 260         for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
 261         {
 262                 if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
 263                     (CurrPath->Usage.Usage == USAGE_JOYSTICK))
 264                 {
 265                         IsJoystick = true;
 266                         break;
 267                 }
 268         }
 269
 270         /* If a collection with the joystick usage was not found, indicate that we are not interested in this item */
 271         if (!IsJoystick)
 272           return false;
 273
 274         /* Check the attributes of the current item - see if we are interested in it or not;
 275          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 276          * structure to save RAM and ignore the rest
 277          */
 278         return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
 279                 (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 280 }