usbcdc.h

The usbcdc.h header contains USB Communications device and interface class request and descriptor definitions. See the USB Class Definitions for Communications Devices document as well as USB Communications Class Subclass Specification documents for details.

Reference

Typedefs

typedef const struct usb_cdc_desc_functional_header usb_cdc_desc_functional_header_c

typedef const struct usb_cdc_desc_functional_call_mgmt usb_cdc_desc_functional_call_mgmt_c

typedef const struct usb_cdc_desc_functional_acm usb_cdc_desc_functional_acm_c

typedef const struct usb_cdc_desc_functional_union usb_cdc_desc_functional_union_c

Enums

Values:

enumerator USB_DEV_CLASS_CDC: Communications Device Class.

enumerator USB_IFACE_CLASS_CIC: Communications Interface Class.

enumerator USB_IFACE_CLASS_DIC: Data Interface Class.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_DLCM: Direct Line Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_ACM: Abstract Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_TCM: Telephone Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_MCCM: Multi-Channel Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_CAPICM: CAPI Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_ENCM: Ethernet Networking Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_ATMNCM: ATM Networking Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_WHCM: Wireless Handset Control Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_DEV_MGMT: Device Management Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_MDLM: Mobile Direct Line Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_OBEX: OBEX Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_EEM: Ethernet Emulation Model Interface Subclass.

enumerator USB_IFACE_SUBCLASS_CDC_CIC_NCM: Network Control Model Interface Subclass.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_NONE: Communications Interface Protocol: No class specific protocol required.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_AT_V250: Communications Interface Protocol: AT Commands: V.250 etc.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_AT_PCCA_101: Communications Interface Protocol: AT Commands defined by PCCA-101.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_AT_PCCA_101_ANNEX_O: Communications Interface Protocol: AT Commands defined by PCCA-101 & Annex O.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_GSM_07_07: Communications Interface Protocol: AT Commands defined by GSM 07.07.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_3GPP_27_007: Communications Interface Protocol: AT Commands defined by 3GPP 27.007.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_TIA_CDMA: Communications Interface Protocol: AT Commands defined by TIA for CDMA.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_EEM: Communications Interface Protocol: Ethernet Emulation Model.

enumerator USB_IFACE_PROTOCOL_CDC_CIC_EXTERNAL: Communications Interface Protocol: Commands defined by Command Set Functional Descriptor.

enumerator USB_IFACE_SUBCLASS_CDC_DIC: Data Interface Subclass.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_NONE: Data Interface Protocol: No class specific protocol required.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_NTB: Data Interface Protocol: Network Transfer Block.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_I_430: Data Interface Protocol: Physical interface protocol for ISDN BRI.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_HDLC: Data Interface Protocol: HDLC.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_TRANSPARENT: Data Interface Protocol: Transparent.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_Q_921M: Data Interface Protocol: Management protocol for Q.921 data link protocol.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_Q_921D: Data Interface Protocol: Data link protocol for Q.931.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_Q_921TM: Data Interface Protocol: TEI-multiplexor for Q.921 data link protocol.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_V_42BIS: Data Interface Protocol: Data compression procedures.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_Q_931_EURO_ISDN: Data Interface Protocol: Euro-ISDN protocol control.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_V_120: Data Interface Protocol: V.24 rate adaptation to ISDN.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_CAPI_2_0: Data Interface Protocol: CAPI Commands.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_HOST_BASED: Data Interface Protocol: Host based driver.

enumerator USB_IFACE_PROTOCOL_CDC_DIC_EXTERNAL: Data Interface Protocol: Protocol(s) defined by Protocol Unit Functional Descriptors on Communications Class Interface

Values:

enumerator USB_DESC_CS_INTERFACE

enumerator USB_DESC_CS_ENDPOINT

enum usb_cdc_desc_functional_subtype

Values:

enumerator USB_DESC_CDC_FUNCTIONAL_SUBTYPE_HEADER: Header Functional Descriptor.

enumerator USB_DESC_CDC_FUNCTIONAL_SUBTYPE_CALL_MGMT: Call Management Functional Descriptor.

enumerator USB_DESC_CDC_FUNCTIONAL_SUBTYPE_ACM: Abstract Control Management Functional Descriptor.

enumerator USB_DESC_CDC_FUNCTIONAL_SUBTYPE_UNION: Union Functional Descriptor.

Values:

enumerator USB_CDC_CALL_MGMT_CAP_HANDLES_CALL_MGMT: Not set - Device does not handle call management itself. Set - Device handles call management itself.

enumerator USB_CDC_CALL_MGMT_CAP_CALL_MGMT_OVER_DATA: Not set - Device sends/receives call management information only over the Communications Class interface. Set - Device can send/receive call management information over a Data Class interface.

Values:

enumerator USB_CDC_ACM_CAP_REQ_COMM_FEATURE: Set - Device supports the request combination of Set_Comm_Feature, Clear_Comm_Feature, and Get_Comm_Feature.

enumerator USB_CDC_ACM_CAP_REQ_LINE_CODING_STATE: Set - Device supports the request combination of Set_Line_Coding, Set_Control_Line_State, Get_Line_Coding, and the notification Serial_State.

enumerator USB_CDC_ACM_CAP_REQ_SEND_BREAK: Set - Device supports the request Send_Break.

enumerator USB_CDC_ACM_CAP_REQ_NETWORK_CONNECTION: Set - Device supports the notification Network_Connection.

enum usb_cdc_request

Class-Specific Request Codes.

Values:

enumerator USB_CDC_REQ_SEND_ENCAPSULATED_COMMAND

enumerator USB_CDC_REQ_GET_ENCAPSULATED_RESPONSE

enum usb_cdc_pstn_request

Class-Specific Request Codes for PSTN subclasses.

Values:

enumerator USB_CDC_PSTN_REQ_SET_COMM_FEATURE

enumerator USB_CDC_PSTN_REQ_GET_COMM_FEATURE

enumerator USB_CDC_PSTN_REQ_CLEAR_COMM_FEATURE

enumerator USB_CDC_PSTN_REQ_SET_AUX_LINE_STATE

enumerator USB_CDC_PSTN_REQ_SET_HOOK_STATE

enumerator USB_CDC_PSTN_REQ_PULSE_SETUP

enumerator USB_CDC_PSTN_REQ_SEND_PULSE

enumerator USB_CDC_PSTN_REQ_SET_PULSE_TIME

enumerator USB_CDC_PSTN_REQ_RING_AUX_JACK

enumerator USB_CDC_PSTN_REQ_SET_LINE_CODING

enumerator USB_CDC_PSTN_REQ_GET_LINE_CODING

enumerator USB_CDC_PSTN_REQ_SET_CONTROL_LINE_STATE

enumerator USB_CDC_PSTN_REQ_SEND_BREAK

enumerator USB_CDC_PSTN_REQ_SET_RINGER_PARMS

enumerator USB_CDC_PSTN_REQ_GET_RINGER_PARMS

enumerator USB_CDC_PSTN_REQ_SET_OPERATION_PARMS

enumerator USB_CDC_PSTN_REQ_GET_OPERATION_PARMS

enumerator USB_CDC_PSTN_REQ_SET_LINE_PARMS

enumerator USB_CDC_PSTN_REQ_GET_LINE_PARMS

enumerator USB_CDC_PSTN_REQ_DIAL_DIGITS

Values:

enumerator USB_CDC_REQ_LINE_CODING_STOP_BITS_1

enumerator USB_CDC_REQ_LINE_CODING_STOP_BITS_1_5

enumerator USB_CDC_REQ_LINE_CODING_STOP_BITS_2

enumerator USB_CDC_REQ_LINE_CODING_PARITY_NONE

enumerator USB_CDC_REQ_LINE_CODING_PARITY_ODD

enumerator USB_CDC_REQ_LINE_CODING_PARITY_EVEN

enumerator USB_CDC_REQ_LINE_CODING_PARITY_MARK

enumerator USB_CDC_REQ_LINE_CODING_PARITY_SPACE

struct usb_cdc_desc_functional_header

#include <usbcdc.h>

Public Members

uint8_t bLength

uint8_t bDescriptorType

uint8_t bDescriptorSubType

uint16_t bcdCDC

struct usb_cdc_desc_functional_call_mgmt

#include <usbcdc.h>

Public Members

uint8_t bLength

uint8_t bDescriptorType

uint8_t bDescriptorSubType

uint8_t bmCapabilities

uint8_t bDataInterface

struct usb_cdc_desc_functional_acm

#include <usbcdc.h>

Public Members

uint8_t bLength

uint8_t bDescriptorType

uint8_t bDescriptorSubType

uint8_t bmCapabilities

struct usb_cdc_desc_functional_union

#include <usbcdc.h>

Public Members

uint8_t bLength

uint8_t bDescriptorType

uint8_t bDescriptorSubType

uint8_t bControlInterface

uint8_t bSubordinateInterface[]

struct usb_cdc_req_line_coding

#include <usbcdc.h>

Public Members

uint32_t dwDTERate

uint8_t bCharFormat

uint8_t bParityType

uint8_t bDataBits