Projects/HIDReportViewer/HIDReportViewer.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 HIDReportViewer project. This file contains the main tasks of
  34  *  the project and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "HIDReportViewer.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 Device_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 "HID Device Report Viewer Running.\r\n" ESC_FG_WHITE));
  74
  75         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  76         GlobalInterruptEnable();
  77
  78         for (;;)
  79         {
  80                 RetrieveDeviceData();
  81
  82                 HID_Host_USBTask(&Device_HID_Interface);
  83                 USB_USBTask();
  84         }
  85 }
  86
  87 /** Task to retrieve the HID device information from an attached device, and output
  88  *  the relevant data to the serial port for analysis.
  89  */
  90 void RetrieveDeviceData(void)
  91 {
  92         if (USB_HostState != HOST_STATE_Configured)
  93           return;
  94
  95         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
  96
  97         OutputReportSizes();
  98         OutputParsedReportItems();
  99
 100         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 101         USB_Host_SetDeviceConfiguration(0);
 102 }
 103
 104 /** Prints a summary of the device's HID report sizes from the HID parser output to the serial port
 105  *  for display to the user.
 106  */
 107 void OutputReportSizes(void)
 108 {
 109         printf_P(PSTR("\r\n\r\nTotal Device Reports: %" PRId8 "\r\n"), HIDReportInfo.TotalDeviceReports);
 110
 111         for (uint8_t ReportIndex = 0; ReportIndex < HIDReportInfo.TotalDeviceReports; ReportIndex++)
 112         {
 113                 const HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[ReportIndex];
 114
 115                 uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_In];
 116                 uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Out];
 117                 uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Feature];
 118
 119                 /* Print out the byte sizes of each report within the device */
 120                 printf_P(PSTR("  + Report ID 0x%02" PRIX8 "\r\n"
 121                                           "    - Input Data:   %" PRId8 " bits (%" PRId8 " bytes)\r\n"
 122                                           "    - Output Data:  %" PRId8 " bits (%" PRId8 " bytes)\r\n"
 123                                           "    - Feature Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n"),
 124                                  CurrReportIDInfo->ReportID,
 125                                  ReportSizeInBits,
 126                                  ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),
 127                                  ReportSizeOutBits,
 128                                  ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),
 129                                  ReportSizeFeatureBits,
 130                                  ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));
 131         }
 132 }
 133
 134 /** Prints a summary of the device's parsed and stored report items along with their attributes
 135  *  to the serial port for display to the user.
 136  */
 137 void OutputParsedReportItems(void)
 138 {
 139         printf_P(PSTR("\r\nReport Items (%" PRId8 " in Table):\r\n"), HIDReportInfo.TotalReportItems);
 140
 141         for (uint8_t ItemIndex = 0; ItemIndex < HIDReportInfo.TotalReportItems; ItemIndex++)
 142         {
 143                 const HID_ReportItem_t* RItem = &HIDReportInfo.ReportItems[ItemIndex];
 144
 145                 printf_P(PSTR("  + Item %" PRId8 ":\r\n"
 146                                           "    - Report ID:          0x%02" PRIX8  "\r\n"
 147                                           "    - Data Direction:     %s\r\n"
 148                                           "    - Item Flags:         0x%02" PRIX8  "\r\n"
 149                                           "    - Item Offset (Bits): 0x%02" PRIX8  "\r\n"
 150                                           "    - Item Size (Bits):   0x%02" PRIX8  "\r\n"
 151                                           "    - Usage Page:         0x%04" PRIX16 "\r\n"
 152                                           "    - Usage:              0x%04" PRIX16 "\r\n"
 153                                           "    - Unit Type:          0x%08" PRIX32 "\r\n"
 154                                           "    - Unit Exponent:      0x%02" PRIX8  "\r\n"
 155                                           "    - Logical Minimum:    0x%08" PRIX32 "\r\n"
 156                                           "    - Logical Maximum:    0x%08" PRIX32 "\r\n"
 157                                           "    - Physical Minimum:   0x%08" PRIX32 "\r\n"
 158                                           "    - Physical Maximum:   0x%08" PRIX32 "\r\n"
 159                                           "    - Collection Path:\r\n"),
 160                                  ItemIndex,
 161                                  RItem->ReportID,
 162                                  ((RItem->ItemType == HID_REPORT_ITEM_In) ? "IN" : ((RItem->ItemType == HID_REPORT_ITEM_Out) ? "OUT" : "FEATURE")),
 163                                  RItem->ItemFlags,
 164                                  RItem->BitOffset,
 165                                  RItem->Attributes.BitSize,
 166                                  RItem->Attributes.Usage.Page,
 167                                  RItem->Attributes.Usage.Usage,
 168                                  RItem->Attributes.Unit.Type,
 169                                  RItem->Attributes.Unit.Exponent,
 170                                  RItem->Attributes.Logical.Minimum,
 171                                  RItem->Attributes.Logical.Maximum,
 172                                  RItem->Attributes.Physical.Minimum,
 173                                  RItem->Attributes.Physical.Maximum);
 174
 175                 OutputCollectionPath(RItem->CollectionPath);
 176         }
 177 }
 178
 179 /** Prints the HID Collection path (along with each node's attributes) to the serial port
 180  *  for display to the user, from the given starting node to the root node.
 181  *
 182  *  \param[in] CollectionPath  Starting HID Collection node to print
 183  */
 184 void OutputCollectionPath(const HID_CollectionPath_t* const CollectionPath)
 185 {
 186         const HID_CollectionPath_t* CurrentNode = CollectionPath;
 187
 188         while (CurrentNode != NULL)
 189         {
 190                 printf_P(PSTR("      |\r\n"
 191                                           "      - Type:  0x%02" PRIX8 "\r\n"
 192                                           "      - Usage: 0x%02" PRIX8 "\r\n"),
 193                                           CurrentNode->Type, CurrentNode->Usage);
 194
 195                 CurrentNode = CurrentNode->Parent;
 196         }
 197
 198         printf_P(PSTR("      |\r\n"
 199                                   "      END\r\n"));
 200 }
 201
 202 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 203 void SetupHardware(void)
 204 {
 205 #if (ARCH == ARCH_AVR8)
 206         /* Disable watchdog if enabled by bootloader/fuses */
 207         MCUSR &= ~(1 << WDRF);
 208         wdt_disable();
 209
 210         /* Disable clock division */
 211         clock_prescale_set(clock_div_1);
 212 #endif
 213
 214         /* Hardware Initialization */
 215         Serial_Init(9600, false);
 216         LEDs_Init();
 217         USB_Init();
 218
 219         /* Create a stdio stream for the serial port for stdin and stdout */
 220         Serial_CreateStream(NULL);
 221 }
 222
 223 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 224  *  starts the library USB task to begin the enumeration and USB management process.
 225  */
 226 void EVENT_USB_Host_DeviceAttached(void)
 227 {
 228         puts_P(PSTR("Device Attached.\r\n"));
 229         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 230 }
 231
 232 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 233  *  stops the library USB task management process.
 234  */
 235 void EVENT_USB_Host_DeviceUnattached(void)
 236 {
 237         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 238         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 239 }
 240
 241 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 242  *  enumerated by the host and is now ready to be used by the application.
 243  */
 244 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 245 {
 246         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 247
 248         uint16_t ConfigDescriptorSize;
 249         uint8_t  ConfigDescriptorData[512];
 250
 251         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 252                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 253         {
 254                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 255                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 256                 return;
 257         }
 258
 259         if (HID_Host_ConfigurePipes(&Device_HID_Interface,
 260                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 261         {
 262                 puts_P(PSTR("Attached Device Not a Valid HID Device.\r\n"));
 263                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 264                 return;
 265         }
 266
 267         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 268         {
 269                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 270                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 271                 return;
 272         }
 273
 274         if (HID_Host_SetReportProtocol(&Device_HID_Interface) != 0)
 275         {
 276                 puts_P(PSTR("Error Setting Report Protocol Mode.\r\n"));
 277                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 278                 USB_Host_SetDeviceConfiguration(0);
 279                 return;
 280         }
 281
 282         puts_P(PSTR("HID Device Enumerated.\r\n"));
 283         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 284 }
 285
 286 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 287 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 288 {
 289         USB_Disable();
 290
 291         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 292                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 293
 294         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 295         for(;;);
 296 }
 297
 298 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 299  *  enumerating an attached USB device.
 300  */
 301 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 302                                             const uint8_t SubErrorCode)
 303 {
 304         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 305                                  " -- Error Code %d\r\n"
 306                                  " -- Sub Error Code %d\r\n"
 307                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 308
 309         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 310 }
 311
 312 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 313  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 314  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 315  *  have occupied).
 316  *
 317  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 318  *
 319  *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded
 320  */
 321 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 322 {
 323         return true;
 324 }
 325