LUFA Library  120219
USB_ClassInfo_CDC_Host_t Struct Reference

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

#include <CDCClassHost.h>

Data Fields

struct {
   uint8_t   DataINPipeNumber
   bool   DataINPipeDoubleBank
   uint8_t   DataOUTPipeNumber
   bool   DataOUTPipeDoubleBank
   uint8_t   NotificationPipeNumber
   bool   NotificationPipeDoubleBank
Config
struct {
   bool   IsActive
   uint8_t   ControlInterfaceNumber
   uint16_t   DataINPipeSize
   uint16_t   DataOUTPipeSize
   uint16_t   NotificationPipeSize
   struct {
      uint16_t   HostToDevice
      uint16_t   DeviceToHost
   }   ControlLineStates
   CDC_LineEncoding_t   LineEncoding
State

Detailed Description

Class state structure. An instance of this structure should be made within the user application, and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This stores each CDC 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.

Interface index of the CDC-ACM control interface within the attached device.

Current states of the virtual serial port's control lines between the device and host.

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

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

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

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

Pipe number of the CDC interface's OUT data pipe.

Size in bytes of the CDC interface's OUT data pipe.

Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_* masks. This value is updated each time CDC_Host_USBTask() is called.

Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_* masks - to notify the device of changes to these values, call the CDC_Host_SendControlLineStateChange() function.

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

Line encoding used in the virtual serial port, for the device's information. This is generally only used if the virtual serial port data is to be reconstructed on a physical UART. When set by the host application, the CDC_Host_SetLineEncoding() function must be called to push the changes to the device.

Indicates if the CDC interface's notification pipe should use double banking.

Pipe number of the CDC interface's IN notification endpoint, if used.

Size in bytes of the CDC interface's IN notification pipe, if used.

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.


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