X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/91bc546be07ae20c9b35fb95f192e6cf26e1e721..77a9df36a77d2523dd2bc24fa17f9f04c6c175c5:/Projects/HIDReportViewer/HIDReportViewer.c diff --git a/Projects/HIDReportViewer/HIDReportViewer.c b/Projects/HIDReportViewer/HIDReportViewer.c index 1dfbd4058..c7a73e761 100644 --- a/Projects/HIDReportViewer/HIDReportViewer.c +++ b/Projects/HIDReportViewer/HIDReportViewer.c @@ -74,143 +74,128 @@ int main(void) for (;;) { - switch (USB_HostState) - { - case HOST_STATE_Addressed: - LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); - - uint16_t ConfigDescriptorSize; - uint8_t ConfigDescriptorData[512]; - - if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData, - sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful) - { - puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n")); - LEDs_SetAllLEDs(LEDMASK_USB_ERROR); - USB_HostState = HOST_STATE_WaitForDeviceRemoval; - break; - } - - if (HID_Host_ConfigurePipes(&Device_HID_Interface, - ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError) - { - puts_P(PSTR("Attached Device Not a Valid HID Device.\r\n")); - LEDs_SetAllLEDs(LEDMASK_USB_ERROR); - USB_HostState = HOST_STATE_WaitForDeviceRemoval; - break; - } - - if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful) - { - puts_P(PSTR("Error Setting Device Configuration.\r\n")); - LEDs_SetAllLEDs(LEDMASK_USB_ERROR); - USB_HostState = HOST_STATE_WaitForDeviceRemoval; - break; - } - - if (HID_Host_SetReportProtocol(&Device_HID_Interface) != 0) - { - puts_P(PSTR("Error Setting Report Protocol Mode.\r\n")); - LEDs_SetAllLEDs(LEDMASK_USB_ERROR); - USB_HostState = HOST_STATE_WaitForDeviceRemoval; - break; - } - - puts_P(PSTR("HID Device Enumerated.\r\n")); - LEDs_SetAllLEDs(LEDMASK_USB_READY); - USB_HostState = HOST_STATE_Configured; - break; - case HOST_STATE_Configured: - LEDs_SetAllLEDs(LEDMASK_USB_BUSY); - - printf_P(PSTR("\r\n\r\nTotal Reports: %" PRId8 "\r\n"), HIDReportInfo.TotalDeviceReports); - for (uint8_t ReportIndex = 0; ReportIndex < HIDReportInfo.TotalDeviceReports; ReportIndex++) - { - HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[ReportIndex]; - - uint8_t ReportSizeInBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_In]; - uint8_t ReportSizeOutBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Out]; - uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Feature]; - - /* Print out the byte sizes of each report within the device */ - printf_P(PSTR(" + Report ID 0x%02" PRIX8 "\r\n" - " - Input Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n" - " - Output Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n" - " - Feature Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n"), - CurrReportIDInfo->ReportID, - ReportSizeInBits, - ((ReportSizeInBits >> 3) + ((ReportSizeInBits & 0x07) != 0)), - ReportSizeOutBits, - ((ReportSizeOutBits >> 3) + ((ReportSizeOutBits & 0x07) != 0)), - ReportSizeFeatureBits, - ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0))); - } - - puts_P(PSTR("\r\nReport Items:\r\n")); - for (uint8_t ItemIndex = 0; ItemIndex < HIDReportInfo.TotalReportItems; ItemIndex++) - { - const HID_ReportItem_t* RItem = &HIDReportInfo.ReportItems[ItemIndex]; - - printf_P(PSTR(" + Item %" PRId8 ":\r\n" - " - Report ID: 0x%02" PRIX8 "\r\n" - " - Data Direction: %s\r\n" - " - Item Flags: 0x%02" PRIX8 "\r\n" - " - Item Offset (Bits): 0x%02" PRIX8 "\r\n" - " - Item Size (Bits): 0x%02" PRIX8 "\r\n" - " - Usage Page: 0x%04" PRIX16 "\r\n" - " - Usage: 0x%04" PRIX16 "\r\n" - " - Unit Type: 0x%08" PRIX32 "\r\n" - " - Unit Exponent: 0x%02" PRIX8 "\r\n" - " - Logical Minimum: 0x%08" PRIX32 "\r\n" - " - Logical Maximum: 0x%08" PRIX32 "\r\n" - " - Physical Minimum: 0x%08" PRIX32 "\r\n" - " - Physical Maximum: 0x%08" PRIX32 "\r\n" - " - Collection Path:\r\n"), - ItemIndex, - RItem->ReportID, - ((RItem->ItemType == HID_REPORT_ITEM_In) ? "IN" : ((RItem->ItemType == HID_REPORT_ITEM_Out) ? "OUT" : "FEATURE")), - RItem->ItemFlags, - RItem->BitOffset, - RItem->Attributes.BitSize, - RItem->Attributes.Usage.Page, - RItem->Attributes.Usage.Usage, - RItem->Attributes.Unit.Type, - RItem->Attributes.Unit.Exponent, - RItem->Attributes.Logical.Minimum, - RItem->Attributes.Logical.Maximum, - RItem->Attributes.Physical.Minimum, - RItem->Attributes.Physical.Maximum); - - const HID_CollectionPath_t* CollectionPath = RItem->CollectionPath; - uint8_t CollectionDepth = 6; - - while (CollectionPath != NULL) - { - for (uint8_t i = 0; i < CollectionDepth; i++) - putchar(' '); - - printf_P(PSTR("- Type: 0x%02" PRIX8 "\r\n"), CollectionPath->Type); - - for (uint8_t i = 0; i < CollectionDepth; i++) - putchar(' '); - - printf_P(PSTR("- Usage: 0x%02" PRIX8 "\r\n"), CollectionPath->Usage); - - CollectionDepth += 3; - CollectionPath = CollectionPath->Parent; - } - } - - LEDs_SetAllLEDs(LEDMASK_USB_READY); - USB_HostState = HOST_STATE_WaitForDeviceRemoval; - break; - } - + RetrieveDeviceData(); + HID_Host_USBTask(&Device_HID_Interface); USB_USBTask(); } } +/** Task to retrieve the HID device information from an attached device, and output + * the relevant data to the serial port for analysis. + */ +void RetrieveDeviceData(void) +{ + if (USB_CurrentMode != USB_MODE_Host) + return; + + LEDs_SetAllLEDs(LEDMASK_USB_BUSY); + + OutputReportSizes(); + OutputParsedReportItems(); + + LEDs_SetAllLEDs(LEDMASK_USB_READY); + USB_Host_SetDeviceConfiguration(0); +} + +/** Prints a summary of the device's HID report sizes from the HID parser output to the serial port + * for display to the user. + */ +void OutputReportSizes(void) +{ + printf_P(PSTR("\r\n\r\nTotal Device Reports: %" PRId8 "\r\n"), HIDReportInfo.TotalDeviceReports); + + for (uint8_t ReportIndex = 0; ReportIndex < HIDReportInfo.TotalDeviceReports; ReportIndex++) + { + const HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[ReportIndex]; + + uint8_t ReportSizeInBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_In]; + uint8_t ReportSizeOutBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Out]; + uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Feature]; + + /* Print out the byte sizes of each report within the device */ + printf_P(PSTR(" + Report ID 0x%02" PRIX8 "\r\n" + " - Input Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n" + " - Output Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n" + " - Feature Data: %" PRId8 " bits (%" PRId8 " bytes)\r\n"), + CurrReportIDInfo->ReportID, + ReportSizeInBits, + ((ReportSizeInBits >> 3) + ((ReportSizeInBits & 0x07) != 0)), + ReportSizeOutBits, + ((ReportSizeOutBits >> 3) + ((ReportSizeOutBits & 0x07) != 0)), + ReportSizeFeatureBits, + ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0))); + } +} + +/** Prints a summary of the device's parsed and stored report items along with their attributes + * to the serial port for display to the user. + */ +void OutputParsedReportItems(void) +{ + printf_P(PSTR("\r\nReport Items (%" PRId8 " in Table):\r\n"), HIDReportInfo.TotalReportItems); + + for (uint8_t ItemIndex = 0; ItemIndex < HIDReportInfo.TotalReportItems; ItemIndex++) + { + const HID_ReportItem_t* RItem = &HIDReportInfo.ReportItems[ItemIndex]; + + printf_P(PSTR(" + Item %" PRId8 ":\r\n" + " - Report ID: 0x%02" PRIX8 "\r\n" + " - Data Direction: %s\r\n" + " - Item Flags: 0x%02" PRIX8 "\r\n" + " - Item Offset (Bits): 0x%02" PRIX8 "\r\n" + " - Item Size (Bits): 0x%02" PRIX8 "\r\n" + " - Usage Page: 0x%04" PRIX16 "\r\n" + " - Usage: 0x%04" PRIX16 "\r\n" + " - Unit Type: 0x%08" PRIX32 "\r\n" + " - Unit Exponent: 0x%02" PRIX8 "\r\n" + " - Logical Minimum: 0x%08" PRIX32 "\r\n" + " - Logical Maximum: 0x%08" PRIX32 "\r\n" + " - Physical Minimum: 0x%08" PRIX32 "\r\n" + " - Physical Maximum: 0x%08" PRIX32 "\r\n" + " - Collection Path:\r\n"), + ItemIndex, + RItem->ReportID, + ((RItem->ItemType == HID_REPORT_ITEM_In) ? "IN" : ((RItem->ItemType == HID_REPORT_ITEM_Out) ? "OUT" : "FEATURE")), + RItem->ItemFlags, + RItem->BitOffset, + RItem->Attributes.BitSize, + RItem->Attributes.Usage.Page, + RItem->Attributes.Usage.Usage, + RItem->Attributes.Unit.Type, + RItem->Attributes.Unit.Exponent, + RItem->Attributes.Logical.Minimum, + RItem->Attributes.Logical.Maximum, + RItem->Attributes.Physical.Minimum, + RItem->Attributes.Physical.Maximum); + + OutputCollectionPath(RItem->CollectionPath); + } +} + +/** Prints the HID Collection path (along with each node's attributes) to the serial port + * for display to the user, from the given starting node to the root node. + * + * \param[in] CollectionPath Starting HID Collection node to print + */ +void OutputCollectionPath(const HID_CollectionPath_t* const CollectionPath) +{ + const HID_CollectionPath_t* CurrentNode = CollectionPath; + + while (CurrentNode != NULL) + { + printf_P(PSTR(" |\r\n" + " - Type: 0x%02" PRIX8 "\r\n" + " - Usage: 0x%02" PRIX8 "\r\n"), + CurrentNode->Type, CurrentNode->Usage); + + CurrentNode = CurrentNode->Parent; + } + + printf_P(PSTR(" |\r\n" + " END\r\n")); +} + /** Configures the board hardware and chip peripherals for the demo's functionality. */ void SetupHardware(void) { @@ -253,6 +238,43 @@ void EVENT_USB_Host_DeviceUnattached(void) */ void EVENT_USB_Host_DeviceEnumerationComplete(void) { + LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); + + uint16_t ConfigDescriptorSize; + uint8_t ConfigDescriptorData[512]; + + if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData, + sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful) + { + puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n")); + LEDs_SetAllLEDs(LEDMASK_USB_ERROR); + return; + } + + if (HID_Host_ConfigurePipes(&Device_HID_Interface, + ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError) + { + puts_P(PSTR("Attached Device Not a Valid HID Device.\r\n")); + LEDs_SetAllLEDs(LEDMASK_USB_ERROR); + return; + } + + if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful) + { + puts_P(PSTR("Error Setting Device Configuration.\r\n")); + LEDs_SetAllLEDs(LEDMASK_USB_ERROR); + return; + } + + if (HID_Host_SetReportProtocol(&Device_HID_Interface) != 0) + { + puts_P(PSTR("Error Setting Report Protocol Mode.\r\n")); + LEDs_SetAllLEDs(LEDMASK_USB_ERROR); + USB_Host_SetDeviceConfiguration(0); + return; + } + + puts_P(PSTR("HID Device Enumerated.\r\n")); LEDs_SetAllLEDs(LEDMASK_USB_READY); }