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