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                                 printf_P(PSTR("\r\n\r\nTotal Reports: %" PRId8 "\r\n"), HIDReportInfo.TotalDeviceReports);
 127                                 for (uint8_t ReportIndex = 0; ReportIndex < HIDReportInfo.TotalDeviceReports; ReportIndex++)
 128                                 {
 129                                         HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[ReportIndex];
 130
 131                                         uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_In];
 132                                         uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Out];
 133                                         uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Feature];
 134
 135                                         /* Print out the byte sizes of each report within the device */
 136                                         printf_P(PSTR("  + Report ID 0x%02" PRIX8 "\r\n"
 137                                                       "    - Input Data:   %" PRId8 " bits (%" PRId8 " bytes)\r\n"
 138                                                       "    - Output Data:  %" PRId8 " bits (%" PRId8 " bytes)\r\n"
 139                                                       "    - Feature Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n"),
 140                                                  CurrReportIDInfo->ReportID,
 141                                                  ReportSizeInBits,
 142                                                  ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),
 143                                                  ReportSizeOutBits,
 144                                                  ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),
 145                                                  ReportSizeFeatureBits,
 146                                                  ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));
 147                                 }
 148
 149                                 puts_P(PSTR("\r\nReport Items:\r\n"));
 150                                 for (uint8_t ItemIndex = 0; ItemIndex < HIDReportInfo.TotalReportItems; ItemIndex++)
 151                                 {
 152                                         const HID_ReportItem_t* RItem = &HIDReportInfo.ReportItems[ItemIndex];
 153
 154                                         printf_P(PSTR("  + Item %" PRId8 ":\r\n"
 155                                                       "    - Report ID:          0x%02" PRIX8  "\r\n"
 156                                                       "    - Data Direction:     %s\r\n"
 157                                                       "    - Item Flags:         0x%02" PRIX8  "\r\n"
 158                                                       "    - Item Offset (Bits): 0x%02" PRIX8  "\r\n"
 159                                                       "    - Item Size (Bits):   0x%02" PRIX8  "\r\n"
 160                                                       "    - Usage Page:         0x%04" PRIX16 "\r\n"
 161                                                       "    - Usage:              0x%04" PRIX16 "\r\n"
 162                                                       "    - Unit Type:          0x%08" PRIX32 "\r\n"
 163                                                       "    - Unit Exponent:      0x%02" PRIX8  "\r\n"
 164                                                       "    - Logical Minimum:    0x%08" PRIX32 "\r\n"
 165                                                       "    - Logical Maximum:    0x%08" PRIX32 "\r\n"
 166                                                       "    - Physical Minimum:   0x%08" PRIX32 "\r\n"
 167                                                       "    - Physical Maximum:   0x%08" PRIX32 "\r\n"
 168                                                       "    - Collection Path:\r\n"),
 169                                                  ItemIndex,
 170                                                  RItem->ReportID,
 171                                                  ((RItem->ItemType == HID_REPORT_ITEM_In) ? "IN" : ((RItem->ItemType == HID_REPORT_ITEM_Out) ? "OUT" : "FEATURE")),
 172                                                  RItem->ItemFlags,
 173                                                  RItem->BitOffset,
 174                                                  RItem->Attributes.BitSize,
 175                                                  RItem->Attributes.Usage.Page,
 176                                                  RItem->Attributes.Usage.Usage,
 177                                                  RItem->Attributes.Unit.Type,
 178                                                  RItem->Attributes.Unit.Exponent,
 179                                                  RItem->Attributes.Logical.Minimum,
 180                                                  RItem->Attributes.Logical.Maximum,
 181                                                  RItem->Attributes.Physical.Minimum,
 182                                                  RItem->Attributes.Physical.Maximum);
 183
 184                                         const HID_CollectionPath_t* CollectionPath  = RItem->CollectionPath;
 185                                         uint8_t                     CollectionDepth = 6;
 186
 187                                         while (CollectionPath != NULL)
 188                                         {
 189                                                 for (uint8_t i = 0; i < CollectionDepth; i++)
 190                                                   putchar(' ');
 191
 192                                                 printf_P(PSTR("- Type:  0x%02" PRIX8 "\r\n"), CollectionPath->Type);
 193
 194                                                 for (uint8_t i = 0; i < CollectionDepth; i++)
 195                                                   putchar(' ');
 196
 197                                                 printf_P(PSTR("- Usage: 0x%02" PRIX8 "\r\n"), CollectionPath->Usage);
 198
 199                                                 CollectionDepth += 3;
 200                                                 CollectionPath   = CollectionPath->Parent;
 201                                         }
 202                                 }
 203
 204                                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 205                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 206                                 break;
 207                 }
 208
 209                 HID_Host_USBTask(&Device_HID_Interface);
 210                 USB_USBTask();
 211         }
 212 }
 213
 214 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 215 void SetupHardware(void)
 216 {
 217         /* Disable watchdog if enabled by bootloader/fuses */
 218         MCUSR &= ~(1 << WDRF);
 219         wdt_disable();
 220
 221         /* Disable clock division */
 222         clock_prescale_set(clock_div_1);
 223
 224         /* Hardware Initialization */
 225         Serial_Init(9600, false);
 226         LEDs_Init();
 227         USB_Init();
 228
 229         /* Create a stdio stream for the serial port for stdin and stdout */
 230         Serial_CreateStream(NULL);
 231 }
 232
 233 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 234  *  starts the library USB task to begin the enumeration and USB management process.
 235  */
 236 void EVENT_USB_Host_DeviceAttached(void)
 237 {
 238         puts_P(PSTR("Device Attached.\r\n"));
 239         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 240 }
 241
 242 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 243  *  stops the library USB task management process.
 244  */
 245 void EVENT_USB_Host_DeviceUnattached(void)
 246 {
 247         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 248         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 249 }
 250
 251 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 252  *  enumerated by the host and is now ready to be used by the application.
 253  */
 254 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 255 {
 256         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 257 }
 258
 259 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 260 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 261 {
 262         USB_Disable();
 263
 264         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 265                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 266
 267         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 268         for(;;);
 269 }
 270
 271 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 272  *  enumerating an attached USB device.
 273  */
 274 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 275                                             const uint8_t SubErrorCode)
 276 {
 277         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 278                                  " -- Error Code %d\r\n"
 279                                  " -- Sub Error Code %d\r\n"
 280                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 281
 282         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 283 }
 284
 285 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 286  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 287  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 288  *  have occupied).
 289  *
 290  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 291  *
 292  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
 293  */
 294 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 295 {
 296         return true;
 297 }
 298