|
|
|
USBLibAPIGuide
1.00.00.01
|
#include <usbdhid.h>
Data Fields | |
| uint8_t | ui8Duration4mS |
| uint8_t | ui8ReportID |
| uint16_t | ui16TimeTillNextmS |
| uint32_t | ui32TimeSinceReportmS |
The structure used to track idle time for reports. An array of these structures is passed to the HID device class driver during USBDHIDInit and is used to track automatic resending of each report (if not disabled by the host).
| uint8_t tHIDReportIdle::ui8Duration4mS |
The idle duration for the report expressed in units of 4mS. 0 indicates infinite and informs the class driver not to send the report unless a state change occurs.
Referenced by USBDHIDGamepadCompositeInit(), USBDHIDKeyboardCompositeInit(), USBDHIDMouseCompositeInit(), and USBDHIDSensorCompositeInit().
| uint8_t tHIDReportIdle::ui8ReportID |
The ID of the report which this structure applies to. This is the report ID as specified using a ReportID tag in the report descriptor rather than the index of the report in the HID class descriptor array. If only a single Input report is supported and, thus, no ReportID tag is present, this field should be set to 0.
Referenced by USBDHIDGamepadCompositeInit(), USBDHIDKeyboardCompositeInit(), USBDHIDMouseCompositeInit(), and USBDHIDSensorCompositeInit().
| uint16_t tHIDReportIdle::ui16TimeTillNextmS |
The number of milliseconds before we need to send a copy of a given report back to the host. This field is updated by the HID driver and used to time sending of USBD_HID_EVENT_IDLE_TIMEOUT.
Referenced by USBDHIDGamepadCompositeInit(), USBDHIDKeyboardCompositeInit(), USBDHIDMouseCompositeInit(), and USBDHIDSensorCompositeInit().
| uint32_t tHIDReportIdle::ui32TimeSinceReportmS |
The number of milliseconds that have passed since the last time this report was sent. The HID class driver needs to track this since Set_Idle requests are required to take effect as if issued immediately after the last transmission of the report to which they refer.
Referenced by USBDHIDGamepadCompositeInit(), USBDHIDKeyboardCompositeInit(), USBDHIDMouseCompositeInit(), and USBDHIDSensorCompositeInit().