Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c

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