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