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