Add new incomplete HIDReportViewer project.
[pub/lufa.git] / Projects / Incomplete / HIDReportViewer / HIDReportViewer.c
diff --git a/Projects/Incomplete/HIDReportViewer/HIDReportViewer.c b/Projects/Incomplete/HIDReportViewer/HIDReportViewer.c
new file mode 100644 (file)
index 0000000..6063f77
--- /dev/null
@@ -0,0 +1,286 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2011.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this\r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in\r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+#include "HIDReportViewer.h"\r
+\r
+/** Processed HID report descriptor items structure, containing information on each HID report element */\r
+static HID_ReportInfo_t HIDReportInfo;\r
+\r
+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ *  passed to all HID Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_HID_Host_t Device_HID_Interface =\r
+       {\r
+               .Config =\r
+                       {\r
+                               .DataINPipeNumber       = 1,\r
+                               .DataINPipeDoubleBank   = false,\r
+\r
+                               .DataOUTPipeNumber      = 2,\r
+                               .DataOUTPipeDoubleBank  = false,\r
+\r
+                               .HIDInterfaceProtocol   = HID_CSCP_NonBootProtocol,\r
+\r
+                               .HIDParserData          = &HIDReportInfo\r
+                       },\r
+       };\r
+\r
+\r
+/** Main program entry point. This routine configures the hardware required by the application, then\r
+ *  enters a loop to run the application tasks in sequence.\r
+ */\r
+int main(void)\r
+{\r
+       SetupHardware();\r
+\r
+       puts_P(PSTR(ESC_FG_CYAN "HID Device Report Viewer Running.\r\n" ESC_FG_WHITE));\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+       sei();\r
+\r
+       for (;;)\r
+       {\r
+               switch (USB_HostState)\r
+               {\r
+                       case HOST_STATE_Addressed:\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+\r
+                               uint16_t ConfigDescriptorSize;\r
+                               uint8_t  ConfigDescriptorData[512];\r
+\r
+                               if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,\r
+                                                                      sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)\r
+                               {\r
+                                       puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (HID_Host_ConfigurePipes(&Device_HID_Interface,\r
+                                                           ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)\r
+                               {\r
+                                       puts_P(PSTR("Attached Device Not a Valid HID Device.\r\n"));\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)\r
+                               {\r
+                                       puts_P(PSTR("Error Setting Device Configuration.\r\n"));\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (HID_Host_SetReportProtocol(&Device_HID_Interface) != 0)\r
+                               {\r
+                                       puts_P(PSTR("Error Setting Report Protocol Mode.\r\n"));\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               puts_P(PSTR("HID Device Enumerated.\r\n"));\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+                               USB_HostState = HOST_STATE_Configured;\r
+                               break;\r
+                       case HOST_STATE_Configured:\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_BUSY);\r
+                               \r
+                               printf_P(PSTR("\r\n\r\nTotal Reports: %d\r\n"), HIDReportInfo.TotalDeviceReports);\r
+                               for (uint8_t ReportIndex = 0; ReportIndex < HIDReportInfo.TotalDeviceReports; ReportIndex++)\r
+                               {\r
+                                       HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[ReportIndex];\r
+\r
+                                       uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_In];\r
+                                       uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Out];\r
+                                       uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Feature];\r
+\r
+                                       /* Print out the byte sizes of each report within the device */\r
+                                       printf_P(PSTR("  + Report ID %d - In: %d bytes, Out: %d bytes, Feature: %d bytes\r\n"),\r
+                                                CurrReportIDInfo->ReportID,\r
+                                                        ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),\r
+                                                        ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),\r
+                                                        ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));\r
+                               }\r
+                               \r
+                               printf_P(PSTR("\r\n\r\nReport Items: %d\r\n"), HIDReportInfo.TotalDeviceReports);\r
+                               for (uint8_t ItemIndex = 0; ItemIndex < HIDReportInfo.TotalReportItems; ItemIndex++)\r
+                               {\r
+                                       HID_ReportItem_t* RItem = &HIDReportInfo.ReportItems[ItemIndex];\r
+\r
+                                       printf_P(PSTR("  + Item %d:\r\n"\r
+                                                     "    - Report ID:          0x%02X\r\n"\r
+                                                     "    - Data Direction:     %s\r\n"\r
+                                                     "    - Item Flags:         0x%02X\r\n"\r
+                                                     "    - Item Offset (Bits): 0x%02X\r\n"\r
+                                                     "    - Item Size (Bits):   0x%02X\r\n"\r
+                                                     "    - Usage Page:         0x%04X\r\n"\r
+                                                     "    - Usage:              0x%04X\r\n"\r
+                                                     "    - Unit Type:          0x%04X\r\n"\r
+                                                     "    - Unit Exponent:      0x%02X\r\n"\r
+                                                     "    - Logical Minimum:    0x%04X\r\n"\r
+                                                     "    - Logical Maximum:    0x%04X\r\n"\r
+                                                     "    - Physical Minimum:   0x%04X\r\n"\r
+                                                     "    - Physical Maximum:   0x%04X\r\n"\r
+                                                     "    - Collection Path:\r\n"),\r
+                                                ItemIndex,\r
+                                                RItem->ReportID,\r
+                                                ((RItem->ItemType == HID_REPORT_ITEM_In) ? "IN" : ((RItem->ItemType == HID_REPORT_ITEM_Out) ? "OUT" : "FEATURE")),\r
+                                                RItem->ItemFlags,\r
+                                                RItem->BitOffset,\r
+                                                RItem->Attributes.BitSize,\r
+                                                RItem->Attributes.Usage.Page,\r
+                                                RItem->Attributes.Usage.Usage,\r
+                                                RItem->Attributes.Unit.Type,\r
+                                                RItem->Attributes.Unit.Exponent,\r
+                                                RItem->Attributes.Logical.Minimum,\r
+                                                RItem->Attributes.Logical.Maximum,\r
+                                                RItem->Attributes.Physical.Minimum,\r
+                                                RItem->Attributes.Physical.Maximum);\r
+                                       \r
+                                       HID_CollectionPath_t* CollectionPath  = RItem->CollectionPath;\r
+                                       uint8_t               CollectionDepth = 6;\r
+                                       \r
+                                       while (CollectionPath != NULL)\r
+                                       {\r
+                                               for (uint8_t i = 0; i < CollectionDepth; i++)\r
+                                                 putchar(' ');\r
+\r
+                                               printf_P(PSTR("- Type: 0x%02X\r\n"), CollectionPath->Type);\r
+                                       \r
+                                               for (uint8_t i = 0; i < CollectionDepth; i++)\r
+                                                 putchar(' ');\r
+\r
+                                               printf_P(PSTR("- Usage: 0x%02X\r\n"), CollectionPath->Usage);\r
+\r
+                                               CollectionDepth += 3;\r
+                                               CollectionPath   = CollectionPath->Parent;\r
+                                       }\r
+                               }\r
+                               \r
+                               LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                               break;\r
+               }\r
+\r
+               HID_Host_USBTask(&Device_HID_Interface);\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
+void SetupHardware(void)\r
+{\r
+       /* Disable watchdog if enabled by bootloader/fuses */\r
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable clock division */\r
+       clock_prescale_set(clock_div_1);\r
+\r
+       /* Hardware Initialization */\r
+       Serial_Init(9600, false);\r
+       LEDs_Init();\r
+       USB_Init();\r
+\r
+       /* Create a stdio stream for the serial port for stdin and stdout */\r
+       Serial_CreateStream(NULL);\r
+}\r
+\r
+/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
+ *  starts the library USB task to begin the enumeration and USB management process.\r
+ */\r
+void EVENT_USB_Host_DeviceAttached(void)\r
+{\r
+       puts_P(PSTR("Device Attached.\r\n"));\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+}\r
+\r
+/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
+ *  stops the library USB task management process.\r
+ */\r
+void EVENT_USB_Host_DeviceUnattached(void)\r
+{\r
+       puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+}\r
+\r
+/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
+ *  enumerated by the host and is now ready to be used by the application.\r
+ */\r
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+}\r
+\r
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\r
+{\r
+       USB_Disable();\r
+\r
+       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       for(;;);\r
+}\r
+\r
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
+ *  enumerating an attached USB device.\r
+ */\r
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,\r
+                                            const uint8_t SubErrorCode)\r
+{\r
+       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"\r
+                                " -- Error Code %d\r\n"\r
+                                " -- Sub Error Code %d\r\n"\r
+                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+}\r
+\r
+/** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store\r
+ *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items\r
+ *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would\r
+ *  have occupied).\r
+ *\r
+ *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with\r
+ *\r
+ *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded\r
+ */\r
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)\r
+{\r
+       return true;\r
+}\r
+\r