USB_ClassInfo_HID_Host_t Struct Reference
[HID Class Host Mode Driver]

#include <HID.h>

Data Fields

struct {
   uint8_t   DataINPipeNumber
   uint8_t   DataOUTPipeNumber
   uint8_t   HIDInterfaceProtocol
   HID_ReportInfo_t *   HIDParserData
Config
struct {
   bool   IsActive
   uint8_t   InterfaceNumber
   uint16_t   DataINPipeSize
   uint16_t   DataOUTPipeSize
   bool   SupportsBootProtocol
   bool   DeviceUsesOUTPipe
   bool   UsingBootProtocol
   uint16_t   HIDReportSize
   uint8_t   LargestReportSize
State

Detailed Description

Class state structure. An instance of this structure should be made 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.


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.

Pipe number of the HID interface's IN data pipe

Size in bytes of the HID interface's IN data pipe

Pipe number of the HID interface's OUT data pipe

Size in bytes of the HID interface's OUT data pipe

Indicates if the current interface instance uses a seperate OUT data pipe for OUT reports, or if OUT reports are sent via the control pipe instead.

HID interface protocol value to match against if a specific boot subclass protocol is required, either HID_BOOT_MOUSE_PROTOCOL, HID_BOOT_KEYBOARD_PROTOCOL or HID_NON_BOOT_PROTOCOL if any HID device should be enumerated by the interface

HID parser data to store the parsed HID report data, when boot protocol is not used

Size in bytes of the HID report descriptor in the device

Interface index of the HID interface within the attached device

Indicates if the current interface instance is connected to an attached device, valid after HID_Host_ConfigurePipes() is called and the Host state machine is in the Configured state

Largest report the device will send, in bytes

State data for the USB class interface within the device. All elements in this section may be set to initial values, but may also be ignored to default to sane values when the interface is enumerated.

Indicates if the current interface instance supports the HID Boot Protocol when enabled via HID_Host_SetBootProtocol()

Indicates that the interface is currently initialised in Boot 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