Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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                 JoystickHost_Task();
  78
  79                 HID_Host_USBTask(&Joystick_HID_Interface);
  80                 USB_USBTask();
  81         }
  82 }
  83
  84 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  85 void SetupHardware(void)
  86 {
  87         /* Disable watchdog if enabled by bootloader/fuses */
  88         MCUSR &= ~(1 << WDRF);
  89         wdt_disable();
  90
  91         /* Disable clock division */
  92         clock_prescale_set(clock_div_1);
  93
  94         /* Hardware Initialization */
  95         Serial_Init(9600, false);
  96         LEDs_Init();
  97         USB_Init();
  98
  99         /* Create a stdio stream for the serial port for stdin and stdout */
 100         Serial_CreateStream(NULL);
 101 }
 102
 103 /** Task to manage an enumerated USB joystick once connected, to display movement
 104  *  data as it is received.
 105  */
 106 void JoystickHost_Task(void)
 107 {
 108         if (USB_HostState != HOST_STATE_Configured)
 109           return;
 110
 111         if (HID_Host_IsReportReceived(&Joystick_HID_Interface))
 112         {
 113                 uint8_t JoystickReport[Joystick_HID_Interface.State.LargestReportSize];
 114                 HID_Host_ReceiveReport(&Joystick_HID_Interface, &JoystickReport);
 115
 116                 uint8_t LEDMask = LEDS_NO_LEDS;
 117
 118                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 119                 {
 120                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 121
 122                         /* Update the report item value if it is contained within the current report */
 123                         if (!(USB_GetHIDReportItemInfo(JoystickReport, ReportItem)))
 124                           continue;
 125
 126                         /* Determine what report item is being tested, process updated value as needed */
 127                         if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 128                             (ReportItem->ItemType                     == HID_REPORT_ITEM_In))
 129                         {
 130                                 if (ReportItem->Value)
 131                                   LEDMask = LEDS_ALL_LEDS;
 132                         }
 133                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 134                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 135                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 136                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 137                         {
 138                                 int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 139
 140                                 if (DeltaMovement)
 141                                 {
 142                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 143                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 144                                         else
 145                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 146                                 }
 147                         }
 148                 }
 149
 150                 LEDs_SetAllLEDs(LEDMask);
 151         }
 152 }
 153
 154 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 155  *  starts the library USB task to begin the enumeration and USB management process.
 156  */
 157 void EVENT_USB_Host_DeviceAttached(void)
 158 {
 159         puts_P(PSTR("Device Attached.\r\n"));
 160         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 161 }
 162
 163 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 164  *  stops the library USB task management process.
 165  */
 166 void EVENT_USB_Host_DeviceUnattached(void)
 167 {
 168         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 169         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 170 }
 171
 172 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 173  *  enumerated by the host and is now ready to be used by the application.
 174  */
 175 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 176 {
 177         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 178
 179         uint16_t ConfigDescriptorSize;
 180         uint8_t  ConfigDescriptorData[512];
 181
 182         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 183                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 184         {
 185                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 186                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 187                 return;
 188         }
 189
 190         if (HID_Host_ConfigurePipes(&Joystick_HID_Interface,
 191                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 192         {
 193                 puts_P(PSTR("Attached Device Not a Valid Joystick.\r\n"));
 194                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 195                 return;
 196         }
 197
 198         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 199         {
 200                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 201                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 202                 return;
 203         }
 204
 205         if (HID_Host_SetReportProtocol(&Joystick_HID_Interface) != 0)
 206         {
 207                 puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Joystick.\r\n"));
 208                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 209                 USB_Host_SetDeviceConfiguration(0);
 210                 return;
 211         }
 212
 213         puts_P(PSTR("Joystick Enumerated.\r\n"));
 214         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 215 }
 216
 217 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 218 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 219 {
 220         USB_Disable();
 221
 222         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 223                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 224
 225         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 226         for(;;);
 227 }
 228
 229 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 230  *  enumerating an attached USB device.
 231  */
 232 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 233                                             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* const 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 }
 281