Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 static 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_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 "Joystick Host Demo running.\r\n" ESC_FG_WHITE));
  71
  72         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  73         sei();
  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(&Joystick_HID_Interface,
  95                                                             ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
  96                                 {
  97                                         puts_P(PSTR("Attached Device Not a Valid Joystick.\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(&Joystick_HID_Interface) != 0)
 112                                 {
 113                                         puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Joystick.\r\n"));
 114                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 115                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 116                                         break;
 117                                 }
 118
 119                                 puts_P(PSTR("Joystick 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(&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                                                 /* Update the report item value if it is contained within the current report */
 136                                                 if (!(USB_GetHIDReportItemInfo(JoystickReport, 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_X)                  ||
 148                                                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 149                                                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 150                                                 {
 151                                                         int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 152
 153                                                         if (DeltaMovement)
 154                                                         {
 155                                                                 if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 156                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 157                                                                 else
 158                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 159                                                         }
 160                                                 }
 161                                         }
 162
 163                                         LEDs_SetAllLEDs(LEDMask);
 164                                 }
 165
 166                                 break;
 167                 }
 168
 169                 HID_Host_USBTask(&Joystick_HID_Interface);
 170                 USB_USBTask();
 171         }
 172 }
 173
 174 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 175 void SetupHardware(void)
 176 {
 177         /* Disable watchdog if enabled by bootloader/fuses */
 178         MCUSR &= ~(1 << WDRF);
 179         wdt_disable();
 180
 181         /* Disable clock division */
 182         clock_prescale_set(clock_div_1);
 183
 184         /* Hardware Initialization */
 185         Serial_Init(9600, false);
 186         LEDs_Init();
 187         USB_Init();
 188
 189         /* Create a stdio stream for the serial port for stdin and stdout */
 190         Serial_CreateStream(NULL);
 191 }
 192
 193 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 194  *  starts the library USB task to begin the enumeration and USB management process.
 195  */
 196 void EVENT_USB_Host_DeviceAttached(void)
 197 {
 198         puts_P(PSTR("Device Attached.\r\n"));
 199         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 200 }
 201
 202 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 203  *  stops the library USB task management process.
 204  */
 205 void EVENT_USB_Host_DeviceUnattached(void)
 206 {
 207         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 208         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 209 }
 210
 211 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 212  *  enumerated by the host and is now ready to be used by the application.
 213  */
 214 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 215 {
 216         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 217 }
 218
 219 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 220 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 221 {
 222         USB_Disable();
 223
 224         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 225                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 226
 227         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 228         for(;;);
 229 }
 230
 231 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 232  *  enumerating an attached USB device.
 233  */
 234 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 235                                             const uint8_t SubErrorCode)
 236 {
 237         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 238                                  " -- Error Code %d\r\n"
 239                                  " -- Sub Error Code %d\r\n"
 240                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 241
 242         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 243 }
 244
 245 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 246  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 247  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 248  *  have occupied).
 249  *
 250  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 251  *
 252  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
 253  */
 254 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 255 {
 256         bool IsJoystick = false;
 257
 258         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 259          * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Joystick usage
 260          * parent node, from being erroneously treated as a joystick by the demo
 261          */
 262         for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
 263         {
 264                 if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
 265                     (CurrPath->Usage.Usage == USAGE_JOYSTICK))
 266                 {
 267                         IsJoystick = true;
 268                         break;
 269                 }
 270         }
 271
 272         /* If a collection with the joystick usage was not found, indicate that we are not interested in this item */
 273         if (!IsJoystick)
 274           return false;
 275
 276         /* Check the attributes of the current item - see if we are interested in it or not;
 277          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 278          * structure to save RAM and ignore the rest
 279          */
 280         return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
 281                 (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 282 }
 283