USB_ClassInfo_HID_Device_t Struct Reference
[HID Class Device Mode Driver]

#include <HID.h>

Data Fields

struct {
   uint8_t   InterfaceNumber
   uint8_t   ReportINEndpointNumber
   uint16_t   ReportINEndpointSize
   void *   PrevReportINBuffer
   uint8_t   PrevReportINBufferSize
Config
struct {
   bool   UsingReportProtocol
   uint16_t   IdleCount
   uint16_t   IdleMSRemaining
State

Detailed Description

Class state structure. An instance of this structure should be made for each HID interface within the user application, and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.

Note:
Due to technical limitations, the HID device class driver does not utilize a seperate OUT endpoint for host->device communications. Instead, the host->device data (if any) is sent to the device via the control endpoint.

Field Documentation

Config data for the USB class interface within the device. All elements in this section must be set or the interface will fail to enumerate and operate correctly.

Report idle period, in mS, set by the host

Total number of mS remaining before the idle period elapsed - this should be decremented by the user application if non-zero each millisecond

Interface number of the HID interface within the device

Pointer to a buffer where the previously created HID input report can be stored by the driver, for comparison purposes to detect report changes that must be sent immediately to the host. This should point to a buffer big enough to hold the largest HID input report sent from the HID interface.

Endpoint number of the HID interface's IN report endpoint

Size in bytes of the HID interface's IN report endpoint

State data for the USB class interface within the device. All elements in this section are reset to their defaults when the interface is enumerated.

Indicates if the HID interface is set to Boot or Report protocol mode


The documentation for this struct was generated from the following file:

Generated on Thu Sep 24 22:58:15 2009 for LUFA (Formerly MyUSB) Library by  doxygen 1.6.1