This is file usb_host_hid.h.
|
Name |
Description |
![]() |
This is type USB_HOST_HID_RETURN_CODES. |
|
Name |
Description |
![]() |
This function is used to locate a specific button or indicator. Once the report descriptor is parsed by the HID layer without any error, data from the report descriptor is stored in pre defined dat structures. This function traverses these data structure and exract data required by application | |
![]() |
Find a specific Usage Value. Once the report descriptor is parsed by the HID layer without any error, data from the report descriptor is stored in pre defined dat structures. This function traverses these data structure and exract data required by application. | |
![]() |
This function reurns the interface number of the cuurent report descriptor parsed. This function must be called to fill data interface detail data structure and passed as parameter when requesinf for report transfers. | |
![]() |
This function can be used by application to extract data from the input reports. On receiving the input report from the device application can call the function with required inputs 'HID_DATA_DETAILS'. | |
![]() |
This function determines if a HID device is attached and ready to use. | |
![]() |
| |
![]() |
This function is the event handler for this client driver. | |
![]() |
This function is the initialization routine for this client driver. | |
![]() |
This function starts a Get report transfer reuest from the device, utilizing the function USBHostHIDTransfer(); | |
![]() |
This function indicates whether or not the last read request is complete. | |
![]() |
This function terminates a read request that is in progress. | |
![]() |
This function starts a HID reset. | |
![]() |
This function performs the maintenance tasks required by HID class | |
![]() |
This function starts a Set report transfer request to the device, utilizing the function USBHostHIDTransfer(); | |
![]() |
This function indicates whether or not the last write request is complete. | |
![]() |
This function terminates a write request that is in progress. |
|
Name |
Description |
![]() |
HID Interface Class Code | |
![]() |
HID Descriptor Code | |
![]() |
Physical Descriptor Code | |
![]() |
Report Descriptor Code, used for USBHostIssueDeviceRequest | |
![]() |
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. | |
![]() |
| |
![]() |
| |
![]() |
This is macro USB_HID_TRANSFER_OUT. | |
![]() |
This function returns a pointer to the current report info structure. | |
![]() |
This function returns a pointer to list of item pointers stored in a structure. |
|
Name |
Description |
![]() |
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 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 Device ID Information This structure contains identification information about an attached device. | |
![]() |
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 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 Device ID Information This structure contains identification information about an attached device. |
|
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 |
MLA - USB Library Help Version : 2.16
![]() |