LUFA Library  120219
USB_ClassInfo_HID_Host_t Struct Reference

HID Class Host Mode Configuration and State Structure. More...

#include <HIDClassHost.h>

Data Fields

struct {
   uint8_t   DataINPipeNumber
   bool   DataINPipeDoubleBank
   uint8_t   DataOUTPipeNumber
   bool   DataOUTPipeDoubleBank
   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.

Indicates if the HID interface's IN data pipe should use double banking.

Pipe number of the HID interface's IN data pipe.

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

Indicates if the HID interface's OUT data pipe should use double banking.

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 separate 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, a protocol value from the HID_Descriptor_ClassSubclassProtocol_t enum.

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

Note:
When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.

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 initialized in Boot Protocol mode


The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines