Demos/Host/LowLevel/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 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Joystick HID Parser Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         sei();
  50
  51         for (;;)
  52         {
  53                 Joystick_HID_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         SerialStream_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72 }
  73
  74 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  75  *  starts the library USB task to begin the enumeration and USB management process.
  76  */
  77 void EVENT_USB_Host_DeviceAttached(void)
  78 {
  79         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  80         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  81 }
  82
  83 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  84  *  stops the library USB task management process.
  85  */
  86 void EVENT_USB_Host_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  89         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  90 }
  91
  92 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  93  *  enumerated by the host and is now ready to be used by the application.
  94  */
  95 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  98 }
  99
 100 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 101 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 106                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 107
 108         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 109         for(;;);
 110 }
 111
 112 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 113  *  enumerating an attached USB device.
 114  */
 115 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 116 {
 117         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 118                                  " -- Error Code %d\r\n"
 119                                  " -- Sub Error Code %d\r\n"
 120                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 121
 122         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 126  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 127  */
 128 void Joystick_HID_Task(void)
 129 {
 130         uint8_t ErrorCode;
 131
 132         /* Switch to determine what user-application handled host state the host state machine is in */
 133         switch (USB_HostState)
 134         {
 135                 case HOST_STATE_Addressed:
 136                         puts_P(PSTR("Getting Config Data.\r\n"));
 137
 138                         /* Get and process the configuration descriptor data */
 139                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 140                         {
 141                                 if (ErrorCode == ControlError)
 142                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 143                                 else
 144                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 145
 146                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 147
 148                                 /* Indicate error via status LEDs */
 149                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 150
 151                                 /* Wait until USB device disconnected */
 152                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 153                                 break;
 154                         }
 155
 156                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 157                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 158                         {
 159                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 160                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 161
 162                                 /* Indicate error via status LEDs */
 163                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 164
 165                                 /* Wait until USB device disconnected */
 166                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 167                                 break;
 168                         }
 169
 170                         printf_P(PSTR("Processing HID Report (Size %d Bytes).\r\n"), HIDReportSize);
 171
 172                         /* Get and process the device's first HID report descriptor */
 173                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 174                         {
 175                                 puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
 176
 177                                 if (!(HIDReportInfo.TotalReportItems))
 178                                         puts_P(PSTR("Not a valid Joystick." ESC_FG_WHITE));
 179                                 else
 180                                         printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 181
 182                                 /* Indicate error via status LEDs */
 183                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 184
 185                                 /* Wait until USB device disconnected */
 186                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 187                                 break;
 188                         }
 189
 190                         printf("Total Reports: %d\r\n", HIDReportInfo.TotalDeviceReports);
 191
 192                         for (uint8_t i = 0; i < HIDReportInfo.TotalDeviceReports; i++)
 193                         {
 194                                 HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[i];
 195
 196                                 uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_In];
 197                                 uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Out];
 198                                 uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Feature];
 199
 200                                 /* Print out the byte sizes of each report within the device */
 201                                 printf_P(PSTR("  + Report ID %d - In: %d bytes, Out: %d bytes, Feature: %d bytes\r\n"),
 202                                          CurrReportIDInfo->ReportID,
 203                                          ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),
 204                                          ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),
 205                                          ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));
 206                         }
 207
 208                         puts_P(PSTR("Joystick Enumerated.\r\n"));
 209
 210                         USB_HostState = HOST_STATE_Configured;
 211                         break;
 212                 case HOST_STATE_Configured:
 213                         /* Select and unfreeze joystick data pipe */
 214                         Pipe_SelectPipe(JOYSTICK_DATAPIPE);
 215                         Pipe_Unfreeze();
 216
 217                         /* Check to see if a packet has been received */
 218                         if (Pipe_IsINReceived())
 219                         {
 220                                 /* Check if data has been received from the attached joystick */
 221                                 if (Pipe_IsReadWriteAllowed())
 222                                 {
 223                                         /* Create buffer big enough for the report */
 224                                         uint8_t JoystickReport[Pipe_BytesInPipe()];
 225
 226                                         /* Load in the joystick report */
 227                                         Pipe_Read_Stream_LE(JoystickReport, Pipe_BytesInPipe());
 228
 229                                         /* Process the read in joystick report from the device */
 230                                         ProcessJoystickReport(JoystickReport);
 231                                 }
 232
 233                                 /* Clear the IN endpoint, ready for next data packet */
 234                                 Pipe_ClearIN();
 235                         }
 236
 237                         /* Freeze joystick data pipe */
 238                         Pipe_Freeze();
 239                         break;
 240         }
 241 }
 242
 243 /** Processes a read HID report from an attached joystick, extracting out elements via the HID parser results
 244  *  as required and displays movement and button presses on the board LEDs.
 245  *
 246  *  \param[in] JoystickReport  Pointer to a HID report from an attached joystick device
 247  */
 248 void ProcessJoystickReport(uint8_t* JoystickReport)
 249 {
 250         uint8_t LEDMask = LEDS_NO_LEDS;
 251
 252         /* Check each HID report item in turn, looking for joystick X/Y/button reports */
 253         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 254         {
 255                 /* Create a temporary item pointer to the next report item */
 256                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 257
 258                 bool FoundData;
 259
 260                 if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 261                         (ReportItem->ItemType                     == REPORT_ITEM_TYPE_In))
 262                 {
 263                         /* Get the joystick button value */
 264                         FoundData = USB_GetHIDReportItemInfo(JoystickReport, ReportItem);
 265
 266                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 267                         if (!(FoundData))
 268                           continue;
 269
 270                         /* If button is pressed, all LEDs are turned on */
 271                         if (ReportItem->Value)
 272                           LEDMask = LEDS_ALL_LEDS;
 273                 }
 274                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 275                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 276                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 277                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 278                 {
 279                         /* Get the joystick relative position value */
 280                         FoundData = USB_GetHIDReportItemInfo(JoystickReport, ReportItem);
 281
 282                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 283                         if (!(FoundData))
 284                           continue;
 285
 286                         int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 287
 288                         /* Determine if the report is for the X or Y delta movement */
 289                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 290                         {
 291                                 /* Turn on the appropriate LED according to direction if the delta is non-zero */
 292                                 if (DeltaMovement)
 293                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 294                         }
 295                         else
 296                         {
 297                                 /* Turn on the appropriate LED according to direction if the delta is non-zero */
 298                                 if (DeltaMovement)
 299                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 300                         }
 301                 }
 302         }
 303
 304         /* Display the button information on the board LEDs */
 305         LEDs_SetAllLEDs(LEDMask);
 306 }