![]() |
LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
|
Standard USB Descriptor definitions. More...
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 |
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 } |
USB Configuration Descriptor Attribute Masks | |
#define | USB_CONFIG_ATTR_BUSPOWERED 0x80 |
#define | USB_CONFIG_ATTR_SELFPOWERED 0x40 |
#define | USB_CONFIG_ATTR_REMOTEWAKEUP 0x20 |
Endpoint Descriptor Attribute Masks | |
#define | ENDPOINT_ATTR_NO_SYNC (0 << 2) |
#define | ENDPOINT_ATTR_ASYNC (1 << 2) |
#define | ENDPOINT_ATTR_ADAPTIVE (2 << 2) |
#define | ENDPOINT_ATTR_SYNC (3 << 2) |
Endpoint Descriptor Usage Masks | |
#define | ENDPOINT_USAGE_DATA (0 << 4) |
#define | ENDPOINT_USAGE_FEEDBACK (1 << 4) |
#define | ENDPOINT_USAGE_IMPLICIT_FEEDBACK (2 << 4) |
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.
#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.
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.
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.
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.
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.
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.
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.
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.
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.
UnicodeChars | Number of Unicode characters in the string text. |
Definition at line 86 of file StdDescriptors.h.
#define VERSION_BCD | ( | 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.
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 { ... } 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 |
Enum for possible Class, Subclass and Protocol values of device and interface descriptors.
Definition at line 200 of file StdDescriptors.h.
Enum for the possible standard descriptor types, as given in each descriptor's header.
Definition at line 184 of file StdDescriptors.h.