Data Structures
struct	PACKED
	USB_CDC_GET/SET_LINE_CODING request-specific data. More...

Macros
#define	USB_RTYPE_DIR_IN 0x80

#define	USB_RTYPE_DIR_OUT 0x00

#define	USB_RTYPE_TYPE_M 0x60

#define	USB_RTYPE_VENDOR 0x40

#define	USB_RTYPE_CLASS 0x20

#define	USB_RTYPE_STANDARD 0x00

#define	USB_RTYPE_RECIPIENT_M 0x1f

#define	USB_RTYPE_OTHER 0x03

#define	USB_RTYPE_ENDPOINT 0x02

#define	USB_RTYPE_INTERFACE 0x01

#define	USB_RTYPE_DEVICE 0x00

#define	USBREQ_GET_STATUS 0x00

#define	USBREQ_CLEAR_FEATURE 0x01

#define	USBREQ_SET_FEATURE 0x03

#define	USBREQ_SET_ADDRESS 0x05

#define	USBREQ_GET_DESCRIPTOR 0x06

#define	USBREQ_SET_DESCRIPTOR 0x07

#define	USBREQ_GET_CONFIG 0x08

#define	USBREQ_SET_CONFIG 0x09

#define	USBREQ_GET_INTERFACE 0x0a

#define	USBREQ_SET_INTERFACE 0x0b

#define	USBREQ_SYNC_FRAME 0x0c

#define	USB_STATUS_SELF_PWR 0x0001

#define	USB_STATUS_BUS_PWR 0x0000

#define	USB_STATUS_PWR_M 0x0001

#define	USB_STATUS_REMOTE_WAKE 0x0002

#define	USB_FEATURE_EP_HALT 0x0000

#define	USB_FEATURE_REMOTE_WAKE 0x0001

#define	USB_FEATURE_TEST_MODE 0x0002

#define	USB_REQ_EP_NUM_M 0x007F

#define	USB_REQ_EP_DIR_M 0x0080

#define	USB_REQ_EP_DIR_IN 0x0080

#define	USB_REQ_EP_DIR_OUT 0x0000

#define	USB_DTYPE_DEVICE 1

#define	USB_DTYPE_CONFIGURATION 2

#define	USB_DTYPE_STRING 3

#define	USB_DTYPE_INTERFACE 4

#define	USB_DTYPE_ENDPOINT 5

#define	USB_DTYPE_DEVICE_QUAL 6

#define	USB_DTYPE_OSPEED_CONF 7

#define	USB_DTYPE_INTERFACE_PWR 8

#define	USB_DTYPE_OTG 9

#define	USB_DTYPE_INTERFACE_ASC 11

#define	USB_DTYPE_CS_INTERFACE 36

#define	USB_DTYPE_HUB 41

#define	USB_CLASS_DEVICE 0x00

#define	USB_CLASS_AUDIO 0x01

#define	USB_CLASS_CDC 0x02

#define	USB_CLASS_HID 0x03

#define	USB_CLASS_PHYSICAL 0x05

#define	USB_CLASS_IMAGE 0x06

#define	USB_CLASS_PRINTER 0x07

#define	USB_CLASS_MASS_STORAGE 0x08

#define	USB_CLASS_HUB 0x09

#define	USB_CLASS_CDC_DATA 0x0a

#define	USB_CLASS_SMART_CARD 0x0b

#define	USB_CLASS_SECURITY 0x0d

#define	USB_CLASS_VIDEO 0x0e

#define	USB_CLASS_HEALTHCARE 0x0f

#define	USB_CLASS_DIAG_DEVICE 0xdc

#define	USB_CLASS_WIRELESS 0xe0

#define	USB_CLASS_MISC 0xef

#define	USB_CLASS_APP_SPECIFIC 0xfe

#define	USB_CLASS_VEND_SPECIFIC 0xff

#define	USB_CLASS_EVENTS 0xffffffff

#define	USB_SUBCLASS_UNDEFINED 0x00

#define	USB_PROTOCOL_UNDEFINED 0x00

#define	USB_MISC_SUBCLASS_SYNC 0x01

#define	USB_MISC_SUBCLASS_COMMON 0x02

#define	USB_MISC_PROTOCOL_IAD 0x01

#define	USB_HUB_PROTOCOL_FS 0x00

#define	USB_HUB_PROTOCOL_SINGLE 0x01

#define	USB_HUB_PROTOCOL_MULTI 0x02

#define	USB_CONF_ATTR_PWR_M 0xC0

#define	USB_CONF_ATTR_SELF_PWR 0xC0

#define	USB_CONF_ATTR_BUS_PWR 0x80

#define	USB_CONF_ATTR_RWAKE 0xA0

#define	USB_EP_DESC_OUT 0x00

#define	USB_EP_DESC_IN 0x80

#define	USB_EP_DESC_NUM_M 0x0f

#define	USB_EP_MAX_PACKET_COUNT_M 0x07FF

#define	USB_EP_ATTR_CONTROL 0x00

#define	USB_EP_ATTR_ISOC 0x01

#define	USB_EP_ATTR_BULK 0x02

#define	USB_EP_ATTR_INT 0x03

#define	USB_EP_ATTR_TYPE_M 0x03

#define	USB_EP_ATTR_ISOC_M 0x0c

#define	USB_EP_ATTR_ISOC_NOSYNC 0x00

#define	USB_EP_ATTR_ISOC_ASYNC 0x04

#define	USB_EP_ATTR_ISOC_ADAPT 0x08

#define	USB_EP_ATTR_ISOC_SYNC 0x0c

#define	USB_EP_ATTR_USAGE_M 0x30

#define	USB_EP_ATTR_USAGE_DATA 0x00

#define	USB_EP_ATTR_USAGE_FEEDBACK 0x10

#define	USB_EP_ATTR_USAGE_IMPFEEDBACK 0x20

#define	USBShort(ui16Value) (ui16Value & 0xff), (ui16Value >> 8)

#define	USB3Byte(ui32Value)

#define	USBLong(ui32Value)

#define	NEXT_USB_DESCRIPTOR(ptr)

Detailed Description

Macro Definition Documentation

§ USB_RTYPE_DIR_IN

#define USB_RTYPE_DIR_IN 0x80

Referenced by USBHCDStringDescriptorGet(), and USBHHIDGetReportDescriptor().

§ USB_RTYPE_DIR_OUT

#define USB_RTYPE_DIR_OUT 0x00

Referenced by USBHCDSetAddress(), USBHCDSetConfig(), USBHCDSetInterface(), USBHHIDSetIdle(), USBHHIDSetProtocol(), USBHHIDSetReport(), and USBHostAudioVolumeSet().

§ USB_RTYPE_TYPE_M

#define USB_RTYPE_TYPE_M 0x60

§ USB_RTYPE_VENDOR

#define USB_RTYPE_VENDOR 0x40

§ USB_RTYPE_CLASS

#define USB_RTYPE_CLASS 0x20

Referenced by USBHHIDSetIdle(), USBHHIDSetProtocol(), USBHHIDSetReport(), and USBHostAudioVolumeSet().

§ USB_RTYPE_STANDARD

#define USB_RTYPE_STANDARD 0x00

Referenced by USBHCDSetAddress(), USBHCDSetConfig(), USBHCDSetInterface(), USBHCDStringDescriptorGet(), and USBHHIDGetReportDescriptor().

§ USB_RTYPE_RECIPIENT_M

#define USB_RTYPE_RECIPIENT_M 0x1f

§ USB_RTYPE_OTHER

#define USB_RTYPE_OTHER 0x03

§ USB_RTYPE_ENDPOINT

#define USB_RTYPE_ENDPOINT 0x02

§ USB_RTYPE_INTERFACE

#define USB_RTYPE_INTERFACE 0x01

Referenced by USBHCDSetInterface(), USBHHIDGetReportDescriptor(), USBHHIDSetIdle(), USBHHIDSetProtocol(), USBHHIDSetReport(), and USBHostAudioVolumeSet().

§ USB_RTYPE_DEVICE

#define USB_RTYPE_DEVICE 0x00

Referenced by USBHCDSetAddress(), USBHCDSetConfig(), and USBHCDStringDescriptorGet().

§ USBREQ_GET_STATUS

#define USBREQ_GET_STATUS 0x00

§ USBREQ_CLEAR_FEATURE

#define USBREQ_CLEAR_FEATURE 0x01

§ USBREQ_SET_FEATURE

#define USBREQ_SET_FEATURE 0x03

§ USBREQ_SET_ADDRESS

#define USBREQ_SET_ADDRESS 0x05

Referenced by USBHCDSetAddress().

§ USBREQ_GET_DESCRIPTOR

#define USBREQ_GET_DESCRIPTOR 0x06

Referenced by USBHCDStringDescriptorGet(), and USBHHIDGetReportDescriptor().

§ USBREQ_SET_DESCRIPTOR

#define USBREQ_SET_DESCRIPTOR 0x07

§ USBREQ_GET_CONFIG

#define USBREQ_GET_CONFIG 0x08

§ USBREQ_SET_CONFIG

#define USBREQ_SET_CONFIG 0x09

Referenced by USBHCDSetConfig().

§ USBREQ_GET_INTERFACE

#define USBREQ_GET_INTERFACE 0x0a

§ USBREQ_SET_INTERFACE

#define USBREQ_SET_INTERFACE 0x0b

Referenced by USBHCDSetInterface().

§ USBREQ_SYNC_FRAME

#define USBREQ_SYNC_FRAME 0x0c

§ USB_STATUS_SELF_PWR

#define USB_STATUS_SELF_PWR 0x0001

Referenced by USBDCDPowerStatusSet().

§ USB_STATUS_BUS_PWR

#define USB_STATUS_BUS_PWR 0x0000

Referenced by USBDCDPowerStatusSet().

§ USB_STATUS_PWR_M

#define USB_STATUS_PWR_M 0x0001

Referenced by USBDCDPowerStatusSet().

§ USB_STATUS_REMOTE_WAKE

#define USB_STATUS_REMOTE_WAKE 0x0002

Referenced by USBDCDRemoteWakeupRequest(), and USBDeviceEnumResetHandler().

§ USB_FEATURE_EP_HALT

#define USB_FEATURE_EP_HALT 0x0000

§ USB_FEATURE_REMOTE_WAKE

#define USB_FEATURE_REMOTE_WAKE 0x0001

§ USB_FEATURE_TEST_MODE

#define USB_FEATURE_TEST_MODE 0x0002

§ USB_REQ_EP_NUM_M

#define USB_REQ_EP_NUM_M 0x007F

§ USB_REQ_EP_DIR_M

#define USB_REQ_EP_DIR_M 0x0080

§ USB_REQ_EP_DIR_IN

#define USB_REQ_EP_DIR_IN 0x0080

§ USB_REQ_EP_DIR_OUT

#define USB_REQ_EP_DIR_OUT 0x0000

§ USB_DTYPE_DEVICE

#define USB_DTYPE_DEVICE 1

§ USB_DTYPE_CONFIGURATION

#define USB_DTYPE_CONFIGURATION 2

§ USB_DTYPE_STRING

#define USB_DTYPE_STRING 3

Referenced by USBHCDStringDescriptorGet().

§ USB_DTYPE_INTERFACE

#define USB_DTYPE_INTERFACE 4

Referenced by BuildCompositeDescriptor(), USBDCDConfigGetInterface(), USBDCDConfigGetNumAlternateInterfaces(), USBDescGetInterface(), USBDescGetNumAlternateInterfaces(), USBDeviceConfig(), and USBDeviceConfigAlternate().

§ USB_DTYPE_ENDPOINT

#define USB_DTYPE_ENDPOINT 5

Referenced by USBDCDConfigGetInterfaceEndpoint(), USBDescGetInterfaceEndpoint(), and USBDeviceConfig().

§ USB_DTYPE_DEVICE_QUAL

#define USB_DTYPE_DEVICE_QUAL 6

§ USB_DTYPE_OSPEED_CONF

#define USB_DTYPE_OSPEED_CONF 7

§ USB_DTYPE_INTERFACE_PWR

#define USB_DTYPE_INTERFACE_PWR 8

§ USB_DTYPE_OTG

#define USB_DTYPE_OTG 9

§ USB_DTYPE_INTERFACE_ASC

#define USB_DTYPE_INTERFACE_ASC 11

§ USB_DTYPE_CS_INTERFACE

#define USB_DTYPE_CS_INTERFACE 36

§ USB_DTYPE_HUB

#define USB_DTYPE_HUB 41

§ USB_CLASS_DEVICE

#define USB_CLASS_DEVICE 0x00

§ USB_CLASS_AUDIO

#define USB_CLASS_AUDIO 0x01

§ USB_CLASS_CDC

#define USB_CLASS_CDC 0x02

§ USB_CLASS_HID

#define USB_CLASS_HID 0x03

§ USB_CLASS_PHYSICAL

#define USB_CLASS_PHYSICAL 0x05

§ USB_CLASS_IMAGE

#define USB_CLASS_IMAGE 0x06

§ USB_CLASS_PRINTER

#define USB_CLASS_PRINTER 0x07

§ USB_CLASS_MASS_STORAGE

#define USB_CLASS_MASS_STORAGE 0x08

§ USB_CLASS_HUB

#define USB_CLASS_HUB 0x09

§ USB_CLASS_CDC_DATA

#define USB_CLASS_CDC_DATA 0x0a

§ USB_CLASS_SMART_CARD

#define USB_CLASS_SMART_CARD 0x0b

§ USB_CLASS_SECURITY

#define USB_CLASS_SECURITY 0x0d

§ USB_CLASS_VIDEO

#define USB_CLASS_VIDEO 0x0e

§ USB_CLASS_HEALTHCARE

#define USB_CLASS_HEALTHCARE 0x0f

§ USB_CLASS_DIAG_DEVICE

#define USB_CLASS_DIAG_DEVICE 0xdc

§ USB_CLASS_WIRELESS

#define USB_CLASS_WIRELESS 0xe0

§ USB_CLASS_MISC

#define USB_CLASS_MISC 0xef

§ USB_CLASS_APP_SPECIFIC

#define USB_CLASS_APP_SPECIFIC 0xfe

§ USB_CLASS_VEND_SPECIFIC

#define USB_CLASS_VEND_SPECIFIC 0xff

§ USB_CLASS_EVENTS

#define USB_CLASS_EVENTS 0xffffffff

§ USB_SUBCLASS_UNDEFINED

#define USB_SUBCLASS_UNDEFINED 0x00

§ USB_PROTOCOL_UNDEFINED

#define USB_PROTOCOL_UNDEFINED 0x00

§ USB_MISC_SUBCLASS_SYNC

#define USB_MISC_SUBCLASS_SYNC 0x01

§ USB_MISC_SUBCLASS_COMMON

#define USB_MISC_SUBCLASS_COMMON 0x02

§ USB_MISC_PROTOCOL_IAD

#define USB_MISC_PROTOCOL_IAD 0x01

§ USB_HUB_PROTOCOL_FS

#define USB_HUB_PROTOCOL_FS 0x00

§ USB_HUB_PROTOCOL_SINGLE

#define USB_HUB_PROTOCOL_SINGLE 0x01

§ USB_HUB_PROTOCOL_MULTI

#define USB_HUB_PROTOCOL_MULTI 0x02

§ USB_CONF_ATTR_PWR_M

#define USB_CONF_ATTR_PWR_M 0xC0

§ USB_CONF_ATTR_SELF_PWR

#define USB_CONF_ATTR_SELF_PWR 0xC0

§ USB_CONF_ATTR_BUS_PWR

#define USB_CONF_ATTR_BUS_PWR 0x80

§ USB_CONF_ATTR_RWAKE

#define USB_CONF_ATTR_RWAKE 0xA0

§ USB_EP_DESC_OUT

#define USB_EP_DESC_OUT 0x00

§ USB_EP_DESC_IN

#define USB_EP_DESC_IN 0x80

Referenced by USBDeviceConfig().

§ USB_EP_DESC_NUM_M

#define USB_EP_DESC_NUM_M 0x0f

Referenced by USBDeviceConfig().

§ USB_EP_MAX_PACKET_COUNT_M

#define USB_EP_MAX_PACKET_COUNT_M 0x07FF

§ USB_EP_ATTR_CONTROL

#define USB_EP_ATTR_CONTROL 0x00

§ USB_EP_ATTR_ISOC

#define USB_EP_ATTR_ISOC 0x01

§ USB_EP_ATTR_BULK

#define USB_EP_ATTR_BULK 0x02

§ USB_EP_ATTR_INT

#define USB_EP_ATTR_INT 0x03

§ USB_EP_ATTR_TYPE_M

#define USB_EP_ATTR_TYPE_M 0x03

§ USB_EP_ATTR_ISOC_M

#define USB_EP_ATTR_ISOC_M 0x0c

§ USB_EP_ATTR_ISOC_NOSYNC

#define USB_EP_ATTR_ISOC_NOSYNC 0x00

§ USB_EP_ATTR_ISOC_ASYNC

#define USB_EP_ATTR_ISOC_ASYNC 0x04

§ USB_EP_ATTR_ISOC_ADAPT

#define USB_EP_ATTR_ISOC_ADAPT 0x08

§ USB_EP_ATTR_ISOC_SYNC

#define USB_EP_ATTR_ISOC_SYNC 0x0c

§ USB_EP_ATTR_USAGE_M

#define USB_EP_ATTR_USAGE_M 0x30

§ USB_EP_ATTR_USAGE_DATA

#define USB_EP_ATTR_USAGE_DATA 0x00

§ USB_EP_ATTR_USAGE_FEEDBACK

#define USB_EP_ATTR_USAGE_FEEDBACK 0x10

§ USB_EP_ATTR_USAGE_IMPFEEDBACK

#define USB_EP_ATTR_USAGE_IMPFEEDBACK 0x20

§ USBShort

#define USBShort ( ui16Value ) (ui16Value & 0xff), (ui16Value >> 8)

Write a 16-bit value to a USB descriptor block.

Parameters

ui16Value is the 16-bit value to write to the descriptor.

This helper macro is used in descriptor definitions to write two-byte values. Since the configuration descriptor contains all interface and endpoint descriptors in a contiguous block of memory, these descriptors are typically defined using an array of bytes rather than as packed structures.

Returns: Not a function.

§ USB3Byte

#define USB3Byte ( ui32Value )

Value:

(ui32Value & 0xff),                           \
                                ((ui32Value >> 8) & 0xff),                    \
                                ((ui32Value >> 16) & 0xff)

Write a 24-bit value to a USB descriptor block.

Parameters

ui32Value is the 24-bit value that to write to the descriptor.

This helper macro is used in descriptor definitions to write three-byte values. Since the configuration descriptor contains all interface and endpoint descriptors in a contiguous block of memory, these descriptors are typically defined using an array of bytes rather than as packed structures.

Returns: Not a function.

§ USBLong

#define USBLong ( ui32Value )

Value:

(ui32Value & 0xff),                           \
                                ((ui32Value >> 8) & 0xff),                    \
                                ((ui32Value >> 16) & 0xff),                   \
                                ((ui32Value >> 24) & 0xff)

Write a 32-bit value to a USB descriptor block.

Parameters

ui32Value is the 32-bit value that to write to the descriptor.

This helper macro is used in descriptor definitions to write four-byte values. Since the configuration descriptor contains all interface and endpoint descriptors in a contiguous block of memory, these descriptors are typically defined using an array of bytes rather than as packed structures.

Returns: Not a function.

§ NEXT_USB_DESCRIPTOR

#define NEXT_USB_DESCRIPTOR ( ptr )

Value:

(tDescriptorHeader *)(((uint8_t *)(ptr)) + \

*((uint8_t *)(ptr)))

Traverse to the next USB descriptor in a block.

Parameters

ptr	points to the first byte of a descriptor in a block of USB descriptors.

This macro aids in traversing lists of descriptors by returning a pointer to the next descriptor in the list given a pointer to the current one.

Returns: Returns a pointer to the next descriptor in the block following ptr.

Referenced by USBDescGet(), USBDescGetNum(), and USBDescGetNumAlternateInterfaces().

Data Structures

Macros

Detailed Description

Macro Definition Documentation

§ USB_RTYPE_DIR_IN

§ USB_RTYPE_DIR_OUT

§ USB_RTYPE_TYPE_M

§ USB_RTYPE_VENDOR

§ USB_RTYPE_CLASS

§ USB_RTYPE_STANDARD

§ USB_RTYPE_RECIPIENT_M

§ USB_RTYPE_OTHER

§ USB_RTYPE_ENDPOINT

§ USB_RTYPE_INTERFACE

§ USB_RTYPE_DEVICE

§ USBREQ_GET_STATUS

§ USBREQ_CLEAR_FEATURE

§ USBREQ_SET_FEATURE

§ USBREQ_SET_ADDRESS

§ USBREQ_GET_DESCRIPTOR

§ USBREQ_SET_DESCRIPTOR

§ USBREQ_GET_CONFIG

§ USBREQ_SET_CONFIG

§ USBREQ_GET_INTERFACE

§ USBREQ_SET_INTERFACE

§ USBREQ_SYNC_FRAME

§ USB_STATUS_SELF_PWR

§ USB_STATUS_BUS_PWR

§ USB_STATUS_PWR_M

§ USB_STATUS_REMOTE_WAKE

§ USB_FEATURE_EP_HALT

§ USB_FEATURE_REMOTE_WAKE

§ USB_FEATURE_TEST_MODE

§ USB_REQ_EP_NUM_M

§ USB_REQ_EP_DIR_M

§ USB_REQ_EP_DIR_IN

§ USB_REQ_EP_DIR_OUT

§ USB_DTYPE_DEVICE

§ USB_DTYPE_CONFIGURATION

§ USB_DTYPE_STRING

§ USB_DTYPE_INTERFACE

§ USB_DTYPE_ENDPOINT

§ USB_DTYPE_DEVICE_QUAL

§ USB_DTYPE_OSPEED_CONF

§ USB_DTYPE_INTERFACE_PWR

§ USB_DTYPE_OTG

§ USB_DTYPE_INTERFACE_ASC

§ USB_DTYPE_CS_INTERFACE

§ USB_DTYPE_HUB

§ USB_CLASS_DEVICE

§ USB_CLASS_AUDIO

§ USB_CLASS_CDC

§ USB_CLASS_HID

§ USB_CLASS_PHYSICAL

§ USB_CLASS_IMAGE

§ USB_CLASS_PRINTER

§ USB_CLASS_MASS_STORAGE

§ USB_CLASS_HUB

§ USB_CLASS_CDC_DATA

§ USB_CLASS_SMART_CARD

§ USB_CLASS_SECURITY

§ USB_CLASS_VIDEO

§ USB_CLASS_HEALTHCARE

§ USB_CLASS_DIAG_DEVICE

§ USB_CLASS_WIRELESS

§ USB_CLASS_MISC

§ USB_CLASS_APP_SPECIFIC

§ USB_CLASS_VEND_SPECIFIC

§ USB_CLASS_EVENTS

§ USB_SUBCLASS_UNDEFINED

§ USB_PROTOCOL_UNDEFINED

§ USB_MISC_SUBCLASS_SYNC

§ USB_MISC_SUBCLASS_COMMON

§ USB_MISC_PROTOCOL_IAD

§ USB_HUB_PROTOCOL_FS

§ USB_HUB_PROTOCOL_SINGLE

§ USB_HUB_PROTOCOL_MULTI

§ USB_CONF_ATTR_PWR_M

§ USB_CONF_ATTR_SELF_PWR

§ USB_CONF_ATTR_BUS_PWR