| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Typedefs | Enumerations
USB Descriptors
USB Core - software/LPCUSBLib/Drivers/USB/USB.h

## Detailed Description

Standard USB Descriptor definitions.

Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains structures and macros for the easy creation of standard USB descriptors in USB device projects.

## Macros
#define | WBVAL(x) ((x) & 0xFF),(((x) >> 8) & 0xFF)
#define | NO_DESCRIPTOR 0
#define | USB_CONFIG_POWER_MA(mA) ((mA) >> 1)
#define | USB_STRING_LEN(UnicodeChars) (sizeof(USB_Descriptor_Header_t) + ((UnicodeChars) << 1))
#define | VERSION_BCD(x)
#define | LANGUAGE_ID_ENG 0x0409

## Typedefs
struct {
uint8_t Size
uint8_t Type
} | USB_Descriptor_Header_t
struct {
uint8_t bLength
uint8_t bDescriptorType
} | USB_StdDescriptor_Header_t
struct {
USB_Descriptor_Header_t Header
uint16_t USBSpecification
uint8_t Class
uint8_t SubClass
uint8_t Protocol
uint8_t Endpoint0Size
uint16_t VendorID
uint16_t ProductID
uint16_t ReleaseNumber
uint8_t ManufacturerStrIndex
uint8_t ProductStrIndex
uint8_t SerialNumStrIndex
uint8_t NumberOfConfigurations
} | USB_Descriptor_Device_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint16_t bcdUSB
uint8_t bDeviceClass
uint8_t bDeviceSubClass
uint8_t bDeviceProtocol
uint8_t bMaxPacketSize0
uint16_t idVendor
uint16_t idProduct
uint16_t bcdDevice
uint8_t iManufacturer
uint8_t iProduct
uint8_t iSerialNumber
uint8_t bNumConfigurations
} | USB_StdDescriptor_Device_t
struct {
USB_Descriptor_Header_t Header
uint16_t USBSpecification
uint8_t Class
uint8_t SubClass
uint8_t Protocol
uint8_t Endpoint0Size
uint8_t NumberOfConfigurations
uint8_t Reserved
} | USB_Descriptor_DeviceQualifier_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint16_t bcdUSB
uint8_t bDeviceClass
uint8_t bDeviceSubClass
uint8_t bDeviceProtocol
uint8_t bMaxPacketSize0
uint8_t bNumConfigurations
uint8_t bReserved
} | USB_StdDescriptor_DeviceQualifier_t
struct {
USB_Descriptor_Header_t Header
uint16_t TotalConfigurationSize
uint8_t TotalInterfaces
uint8_t ConfigurationNumber
uint8_t ConfigurationStrIndex
uint8_t ConfigAttributes
uint8_t MaxPowerConsumption
} | USB_Descriptor_Configuration_Header_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint16_t wTotalLength
uint8_t bNumInterfaces
uint8_t bConfigurationValue
uint8_t iConfiguration
uint8_t bmAttributes
uint8_t bMaxPower
} | USB_StdDescriptor_Configuration_Header_t
struct {
USB_Descriptor_Header_t Header
uint8_t InterfaceNumber
uint8_t AlternateSetting
uint8_t TotalEndpoints
uint8_t Class
uint8_t SubClass
uint8_t Protocol
uint8_t InterfaceStrIndex
} | USB_Descriptor_Interface_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bInterfaceNumber
uint8_t bAlternateSetting
uint8_t bNumEndpoints
uint8_t bInterfaceClass
uint8_t bInterfaceSubClass
uint8_t bInterfaceProtocol
uint8_t iInterface
} | USB_StdDescriptor_Interface_t
struct {
USB_Descriptor_Header_t Header
uint8_t FirstInterfaceIndex
uint8_t TotalInterfaces
uint8_t Class
uint8_t SubClass
uint8_t Protocol
uint8_t IADStrIndex
} | USB_Descriptor_Interface_Association_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bFirstInterface
uint8_t bInterfaceCount
uint8_t bFunctionClass
uint8_t bFunctionSubClass
uint8_t bFunctionProtocol
uint8_t iFunction
} | USB_StdDescriptor_Interface_Association_t
struct {
USB_Descriptor_Header_t Header
uint8_t EndpointAddress
uint8_t Attributes
uint16_t EndpointSize
uint8_t PollingIntervalMS
} | USB_Descriptor_Endpoint_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bEndpointAddress
uint8_t bmAttributes
uint16_t wMaxPacketSize
uint8_t bInterval
} | USB_StdDescriptor_Endpoint_t
struct {
USB_Descriptor_Header_t Header
uint16_t UnicodeString []
} | USB_Descriptor_String_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint16_t bString []
} | USB_StdDescriptor_String_t

## Enumerations
enum | USB_DescriptorTypes_t { DTYPE_Device = 0x01, DTYPE_Configuration = 0x02, DTYPE_String = 0x03, DTYPE_Interface = 0x04, DTYPE_Endpoint = 0x05, DTYPE_DeviceQualifier = 0x06, DTYPE_Other = 0x07, DTYPE_InterfacePower = 0x08, DTYPE_InterfaceAssociation = 0x0B, DTYPE_CSInterface = 0x24, DTYPE_CSEndpoint = 0x25 }
enum | USB_Descriptor_ClassSubclassProtocol_t { USB_CSCP_NoDeviceClass = 0x00, USB_CSCP_NoDeviceSubclass = 0x00, USB_CSCP_NoDeviceProtocol = 0x00, USB_CSCP_VendorSpecificClass = 0xFF, USB_CSCP_VendorSpecificSubclass = 0xFF, USB_CSCP_VendorSpecificProtocol = 0xFF, USB_CSCP_IADDeviceClass = 0xEF, USB_CSCP_IADDeviceSubclass = 0x02, USB_CSCP_IADDeviceProtocol = 0x01 }

## Macro Definition Documentation

#define ENDPOINT_ATTR_ADAPTIVE (2 << 2)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is adaptive.

See Also
  The USB specification for more details on the possible Endpoint attributes.

Definition at line 148 of file StdDescriptors.h.

#define ENDPOINT_ATTR_ASYNC (1 << 2)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is asynchronous.

See Also
  The USB specification for more details on the possible Endpoint attributes.

Definition at line 141 of file StdDescriptors.h.

#define ENDPOINT_ATTR_NO_SYNC (0 << 2)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is not synchronized.

See Also
  The USB specification for more details on the possible Endpoint attributes.

Definition at line 134 of file StdDescriptors.h.

#define ENDPOINT_ATTR_SYNC (3 << 2)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is synchronized.

See Also
  The USB specification for more details on the possible Endpoint attributes.

Definition at line 155 of file StdDescriptors.h.

#define ENDPOINT_USAGE_DATA (0 << 4)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is used for data transfers.

See Also
  The USB specification for more details on the possible Endpoint usage attributes.

Definition at line 165 of file StdDescriptors.h.

#define ENDPOINT_USAGE_FEEDBACK (1 << 4)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is used for feedback.

See Also
  The USB specification for more details on the possible Endpoint usage attributes.

Definition at line 172 of file StdDescriptors.h.

#define ENDPOINT_USAGE_IMPLICIT_FEEDBACK (2 << 4)

Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is used for implicit feedback.

See Also
  The USB specification for more details on the possible Endpoint usage attributes.

Definition at line 179 of file StdDescriptors.h.

#define LANGUAGE_ID_ENG 0x0409

String language ID for the English language. Should be used in USB_Descriptor_String_t descriptors to indicate that the English language is supported by the device in its string descriptors.

Definition at line 103 of file StdDescriptors.h.

#define NO_DESCRIPTOR 0

Indicates that a given descriptor does not exist in the device. This can be used inside descriptors for string descriptor indexes, or may be use as a return value for GetDescriptor when the specified descriptor does not exist.

Definition at line 73 of file StdDescriptors.h.

#define USB_CONFIG_ATTR_BUSPOWERED 0x80

Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power from the host's VBUS line.

Definition at line 111 of file StdDescriptors.h.

#define USB_CONFIG_ATTR_REMOTEWAKEUP 0x20

Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t descriptor's ConfigAttributes value to indicate that the specified configuration supports the remote wakeup feature of the USB standard, allowing a suspended USB device to wake up the host upon request.

Definition at line 124 of file StdDescriptors.h.

#define USB_CONFIG_ATTR_SELFPOWERED 0x40

Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power from the device's own power source.

Definition at line 117 of file StdDescriptors.h.

#define USB_CONFIG_POWER_MA | ( |  | mA | ) | ((mA) >> 1)

Macro to calculate the power value for the configuration descriptor, from a given number of milliamperes.

Parameters

  mA | Maximum number of milliamps the device consumes when the given configuration is selected.

Definition at line 79 of file StdDescriptors.h.

#define USB_STRING_LEN | ( |  | UnicodeChars | ) | (sizeof(USB_Descriptor_Header_t) + ((UnicodeChars) << 1))

Macro to calculate the Unicode length of a string with a given number of Unicode characters. Should be used in string descriptor's headers for giving the string descriptor's byte length.

Parameters

  UnicodeChars | Number of Unicode characters in the string text.

Definition at line 86 of file StdDescriptors.h.

#define VERSION_BCD | ( |  | x | ) |

Value:
CPU_TO_LE16((((VERSION_TENS(x) << 4) | VERSION_ONES(x)) << 8) | \
((VERSION_TENTHS(x) << 4) | VERSION_HUNDREDTHS(x)))

Macro to encode a given four digit floating point version number (e.g. 01.23) into Binary Coded Decimal format for descriptor fields requiring BCD encoding, such as the USB version number in the standard device descriptor.

Note
  This value is automatically converted into Little Endian, suitable for direct use inside device descriptors on all architectures without endianness conversion macros.

Parameters

  x | Version number to encode as a 16-bit little-endian number, as a floating point number.

Definition at line 97 of file StdDescriptors.h.

#define WBVAL | ( |  | x | ) | ((x) & 0xFF),(((x) >> 8) & 0xFF)

Utility macro used in the formation of descriptors

Definition at line 67 of file StdDescriptors.h.

## Typedef Documentation

typedef { ... } USB_Descriptor_Configuration_Header_t

typedef { ... } USB_Descriptor_Device_t

typedef { ... } USB_Descriptor_DeviceQualifier_t

typedef { ... } USB_Descriptor_Endpoint_t

typedef { ... } USB_Descriptor_Header_t

typedef { ... } USB_Descriptor_Interface_Association_t

typedef { ... } USB_Descriptor_Interface_t

typedef { ... } USB_Descriptor_String_t

typedef { ... } USB_StdDescriptor_Configuration_Header_t

typedef { ... } USB_StdDescriptor_Device_t

typedef { ... } USB_StdDescriptor_DeviceQualifier_t

typedef { ... } USB_StdDescriptor_Endpoint_t

typedef { ... } USB_StdDescriptor_Header_t

typedef { ... } USB_StdDescriptor_Interface_Association_t

typedef { ... } USB_StdDescriptor_Interface_t

typedef { ... } USB_StdDescriptor_String_t

## Enumeration Type Documentation

enum USB_Descriptor_ClassSubclassProtocol_t

Enum for possible Class, Subclass and Protocol values of device and interface descriptors.

Enumerator:

  USB_CSCP_NoDeviceClass | Descriptor Class value indicating that the device does not belong to a particular class at the device level.
  USB_CSCP_NoDeviceSubclass | Descriptor Subclass value indicating that the device does not belong to a particular subclass at the device level.
  USB_CSCP_NoDeviceProtocol | Descriptor Protocol value indicating that the device does not belong to a particular protocol at the device level.
  USB_CSCP_VendorSpecificClass | Descriptor Class value indicating that the device/interface belongs to a vendor specific class.
  USB_CSCP_VendorSpecificSubclass | Descriptor Subclass value indicating that the device/interface belongs to a vendor specific subclass.
  USB_CSCP_VendorSpecificProtocol | Descriptor Protocol value indicating that the device/interface belongs to a vendor specific protocol.
  USB_CSCP_IADDeviceClass | Descriptor Class value indicating that the device belongs to the Interface Association Descriptor class.
  USB_CSCP_IADDeviceSubclass | Descriptor Subclass value indicating that the device belongs to the Interface Association Descriptor subclass.
  USB_CSCP_IADDeviceProtocol | Descriptor Protocol value indicating that the device belongs to the Interface Association Descriptor protocol.

Definition at line 200 of file StdDescriptors.h.

enum USB_DescriptorTypes_t

Enum for the possible standard descriptor types, as given in each descriptor's header.

Enumerator:

  DTYPE_Device | Indicates that the descriptor is a device descriptor.
  DTYPE_Configuration | Indicates that the descriptor is a configuration descriptor.
  DTYPE_String | Indicates that the descriptor is a string descriptor.
  DTYPE_Interface | Indicates that the descriptor is an interface descriptor.
  DTYPE_Endpoint | Indicates that the descriptor is an endpoint descriptor.
  DTYPE_DeviceQualifier | Indicates that the descriptor is a device qualifier descriptor.
  DTYPE_Other | Indicates that the descriptor is of other type.
  DTYPE_InterfacePower | Indicates that the descriptor is an interface power descriptor.
  DTYPE_InterfaceAssociation | Indicates that the descriptor is an interface association descriptor.
  DTYPE_CSInterface | Indicates that the descriptor is a class specific interface descriptor.
  DTYPE_CSEndpoint | Indicates that the descriptor is a class specific endpoint descriptor.

Definition at line 184 of file StdDescriptors.h.