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