Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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                                 .DataINPipe             =
  51                                         {
  52                                                 .Address        = (PIPE_DIR_IN  | 1),
  53                                                 .Banks          = 1,
  54                                         },
  55                                 .DataOUTPipe            =
  56                                         {
  57                                                 .Address        = (PIPE_DIR_OUT | 2),
  58                                                 .Banks          = 1,
  59                                         },
  60                                 .HIDInterfaceProtocol   = HID_CSCP_NonBootProtocol,
  61                                 .HIDParserData          = &HIDReportInfo
  62                         },
  63         };
  64
  65
  66 /** Main program entry point. This routine configures the hardware required by the application, then
  67  *  enters a loop to run the application tasks in sequence.
  68  */
  69 int main(void)
  70 {
  71         SetupHardware();
  72
  73         puts_P(PSTR(ESC_FG_CYAN "Joystick Host Demo running.\r\n" ESC_FG_WHITE));
  74
  75         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  76         GlobalInterruptEnable();
  77
  78         for (;;)
  79         {
  80                 JoystickHost_Task();
  81
  82                 HID_Host_USBTask(&Joystick_HID_Interface);
  83                 USB_USBTask();
  84         }
  85 }
  86
  87 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  88 void SetupHardware(void)
  89 {
  90         /* Disable watchdog if enabled by bootloader/fuses */
  91         MCUSR &= ~(1 << WDRF);
  92         wdt_disable();
  93
  94         /* Disable clock division */
  95         clock_prescale_set(clock_div_1);
  96
  97         /* Hardware Initialization */
  98         Serial_Init(9600, false);
  99         LEDs_Init();
 100         USB_Init();
 101
 102         /* Create a stdio stream for the serial port for stdin and stdout */
 103         Serial_CreateStream(NULL);
 104 }
 105
 106 /** Task to manage an enumerated USB joystick once connected, to display movement
 107  *  data as it is received.
 108  */
 109 void JoystickHost_Task(void)
 110 {
 111         if (USB_HostState != HOST_STATE_Configured)
 112           return;
 113
 114         if (HID_Host_IsReportReceived(&Joystick_HID_Interface))
 115         {
 116                 uint8_t JoystickReport[Joystick_HID_Interface.State.LargestReportSize];
 117                 HID_Host_ReceiveReport(&Joystick_HID_Interface, &JoystickReport);
 118
 119                 uint8_t LEDMask = LEDS_NO_LEDS;
 120
 121                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 122                 {
 123                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 124
 125                         /* Update the report item value if it is contained within the current report */
 126                         if (!(USB_GetHIDReportItemInfo(JoystickReport, ReportItem)))
 127                           continue;
 128
 129                         /* Determine what report item is being tested, process updated value as needed */
 130                         if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 131                             (ReportItem->ItemType                     == HID_REPORT_ITEM_In))
 132                         {
 133                                 if (ReportItem->Value)
 134                                   LEDMask = LEDS_ALL_LEDS;
 135                         }
 136                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 137                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 138                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 139                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 140                         {
 141                                 int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 142
 143                                 if (DeltaMovement)
 144                                 {
 145                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 146                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 147                                         else
 148                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 149                                 }
 150                         }
 151                 }
 152
 153                 LEDs_SetAllLEDs(LEDMask);
 154         }
 155 }
 156
 157 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 158  *  starts the library USB task to begin the enumeration and USB management process.
 159  */
 160 void EVENT_USB_Host_DeviceAttached(void)
 161 {
 162         puts_P(PSTR("Device Attached.\r\n"));
 163         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 164 }
 165
 166 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 167  *  stops the library USB task management process.
 168  */
 169 void EVENT_USB_Host_DeviceUnattached(void)
 170 {
 171         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 172         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 173 }
 174
 175 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 176  *  enumerated by the host and is now ready to be used by the application.
 177  */
 178 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 179 {
 180         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 181
 182         uint16_t ConfigDescriptorSize;
 183         uint8_t  ConfigDescriptorData[512];
 184
 185         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 186                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 187         {
 188                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 189                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 190                 return;
 191         }
 192
 193         if (HID_Host_ConfigurePipes(&Joystick_HID_Interface,
 194                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 195         {
 196                 puts_P(PSTR("Attached Device Not a Valid Joystick.\r\n"));
 197                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 198                 return;
 199         }
 200
 201         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 202         {
 203                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 204                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 205                 return;
 206         }
 207
 208         if (HID_Host_SetReportProtocol(&Joystick_HID_Interface) != 0)
 209         {
 210                 puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Joystick.\r\n"));
 211                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 212                 USB_Host_SetDeviceConfiguration(0);
 213                 return;
 214         }
 215
 216         puts_P(PSTR("Joystick Enumerated.\r\n"));
 217         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 218 }
 219
 220 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 221 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 222 {
 223         USB_Disable();
 224
 225         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 226                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 227
 228         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 229         for(;;);
 230 }
 231
 232 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 233  *  enumerating an attached USB device.
 234  */
 235 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 236                                             const uint8_t SubErrorCode)
 237 {
 238         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 239                                  " -- Error Code %d\r\n"
 240                                  " -- Sub Error Code %d\r\n"
 241                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 242
 243         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 244 }
 245
 246 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 247  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 248  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 249  *  have occupied).
 250  *
 251  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 252  *
 253  *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded
 254  */
 255 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 256 {
 257         bool IsJoystick = false;
 258
 259         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 260          * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Joystick usage
 261          * parent node, from being erroneously treated as a joystick by the demo
 262          */
 263         for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
 264         {
 265                 if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
 266                     (CurrPath->Usage.Usage == USAGE_JOYSTICK))
 267                 {
 268                         IsJoystick = true;
 269                         break;
 270                 }
 271         }
 272
 273         /* If a collection with the joystick usage was not found, indicate that we are not interested in this item */
 274         if (!IsJoystick)
 275           return false;
 276
 277         /* Check the attributes of the current item - see if we are interested in it or not;
 278          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 279          * structure to save RAM and ignore the rest
 280          */
 281         return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
 282                 (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 283 }
 284