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