USB Library
Data Types and Constants
Enumerations
 
Name 
Description 
 
This is type HIDReportTypeEnum. 
 
HID parser error codes
This enumerates the error encountered during the parsing of report descriptor. In case of any error parsing is sttopped and the error is flagged. Device is not attched successfully. 
Macros
 
Name 
Description 
 
HID Interface Class Code 
 
HID Descriptor Code 
 
Physical Descriptor Code 
 
A HID device has attached. The returned data pointer points to a USB_HID_DEVICE_ID structure. 
 
There was a problem parsing the report descriptor of the attached device. Communication with the device is not allowed, and the device should be detached. 
 
A HID device has detached. The returned data pointer points to a byte with the previous address of the detached device. 
 
No event occured (NULL event) 
 
If the application has not defined an offset for HID events, set it to 0. 
 
define EVENT_HID_TRANSFER EVENT_HID_BASE + EVENT_HID_OFFSET + 3 // Unused - value retained for legacy. A HID Read transfer has completed. The returned data pointer points to a HID_TRANSFER_DATA structure, with information about the transfer. 
 
HID reset complete. The returned data pointer is NULL. 
 
An error occurred while trying to do a HID reset. The returned data pointer is NULL. 
 
A Report Descriptor has been parsed. The returned data pointer is NULL. The application must collect details, or simply return true if the application is already aware of the data format. 
 
A HID Write transfer has completed. The returned data pointer points to a HID_TRANSFER_DATA structure, with information about the transfer. 
 
 
Module
Structures
 
Name 
Description 
 
HID Collection Details
This structure contains information about each collection encountered in the report descriptor. 
 
HID Data Details
This structure defines the objects used by the application to access required report. Application must use parser interface functions to fill these details. e.g. USBHostHID_ApiFindValue 
 
HID Global Item Information
This structure contains information about each Global Item of the report descriptor. 
 
HID Item Information
This structure contains information about each Item of the report descriptor. 
 
HID Report details
This structure contains information about each report exchanged with the device. 
 
HID Report Details
This structure contains information about each Report encountered in the report descriptor. 
 
HID String Item Details
This structure contains information about each Report encountered in the report descriptor. 
 
HID Transfer Information
This structure is used when the event handler is used to notify the upper layer of transfer completion (EVENT_HID_READ_DONE or EVENT_HID_WRITE_DONE). 
 
HID Report Details
This structure contains information about each Usage Item encountered in the report descriptor. 
 
HID Collection Details
This structure contains information about each collection encountered in the report descriptor. 
 
HID Data Details
This structure defines the objects used by the application to access required report. Application must use parser interface functions to fill these details. e.g. USBHostHID_ApiFindValue 
 
HID String Item Details
This structure contains information about each Report encountered in the report descriptor. 
 
HID Global Item Information
This structure contains information about each Global Item of the report descriptor. 
 
HID Item Information
This structure contains information about each Item of the report descriptor. 
 
HID Report details
This structure contains information about each report exchanged with the device. 
 
HID Report Details
This structure contains information about each Report encountered in the report descriptor. 
 
HID String Item Details
This structure contains information about each Report encountered in the report descriptor. 
 
HID Transfer Information
This structure is used when the event handler is used to notify the upper layer of transfer completion (EVENT_HID_READ_DONE or EVENT_HID_WRITE_DONE). 
 
HID Report Details
This structure contains information about each Usage Item encountered in the report descriptor. 
 
HID Device ID Information
This structure contains identification information about an attached device. 
 
Report Descriptor Information
This structure contains top level information of the report descriptor. This information is important and is used to understand the information during th ecourse of parsing. This structure also stores temporary data needed during parsing the report descriptor. All of this information may not be of much inportance to the application. 
 
HID Device ID Information
This structure contains identification information about an attached device. 
 
List of Items
This structure contains array of pointers to all the Items in the report descriptor. HID parser will populate the lists while parsing the report descriptor. This data is used by interface functions provided in file usb_host_hid_interface.c to retrive data from the report received from the device. Application can also access these details to retreive the intended information incase provided interface function fail to do so. 
 
Report Descriptor Information
This structure contains top level information of the report descriptor. This information is important and is used to understand the information during th ecourse of parsing. This structure also stores temporary data needed during parsing the report descriptor. All of this information may not be of much inportance to the application. 
 
List of Items
This structure contains array of pointers to all the Items in the report descriptor. HID parser will populate the lists while parsing the report descriptor. This data is used by interface functions provided in file usb_host_hid_interface.c to retrive data from the report received from the device. Application can also access these details to retreive the intended information incase provided interface function fail to do so. 
Types
 
Name 
Description 
 
HID User Data Size
This defines the data type required to hold the maximum field size data.
Maximum size of data field within a report 
Variables
 
Name 
Description 
 
 
 
This is variable itemListPtrs. 
MLA - USB Library Help Version : 2.16
http://www.microchip.com/mla