Data Structures | |
struct | USB_Descriptor_Header_t |
Standard USB Descriptor Header (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_Header_t |
Standard USB Descriptor Header (USB-IF naming conventions). More... | |
struct | USB_Descriptor_Device_t |
Standard USB Device Descriptor (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_Device_t |
Standard USB Device Descriptor (USB-IF naming conventions). More... | |
struct | USB_Descriptor_Configuration_Header_t |
Standard USB Configuration Descriptor (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_Configuration_Header_t |
Standard USB Configuration Descriptor (USB-IF naming conventions). More... | |
struct | USB_Descriptor_Interface_t |
Standard USB Interface Descriptor (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_Interface_t |
Standard USB Interface Descriptor (USB-IF naming conventions). More... | |
struct | USB_Descriptor_Interface_Association_t |
Standard USB Interface Association Descriptor (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_Interface_Association_t |
Standard USB Interface Association Descriptor (USB-IF naming conventions). More... | |
struct | USB_Descriptor_Endpoint_t |
Standard USB Endpoint Descriptor (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_Endpoint_t |
Standard USB Endpoint Descriptor (USB-IF naming conventions). More... | |
struct | USB_Descriptor_String_t |
Standard USB String Descriptor (LUFA naming conventions). More... | |
struct | USB_StdDescriptor_String_t |
Standard USB String Descriptor (USB-IF naming conventions). More... | |
Modules | |
Configuration Descriptor Parser | |
Defines | |
#define | NO_DESCRIPTOR 0 |
#define | USE_INTERNAL_SERIAL 0xDC |
#define | USB_CONFIG_POWER_MA(mA) ((mA) >> 1) |
#define | USB_STRING_LEN(str) (sizeof(USB_Descriptor_Header_t) + ((str) << 1)) |
#define | VERSION_BCD(x) |
#define | LANGUAGE_ID_ENG 0x0409 |
#define | ENDPOINT_DESCRIPTOR_DIR_IN 0x80 |
#define | ENDPOINT_DESCRIPTOR_DIR_OUT 0x00 |
#define | USB_CONFIG_ATTR_BUSPOWERED 0x80 |
#define | USB_CONFIG_ATTR_SELFPOWERED 0x40 |
#define | USB_CONFIG_ATTR_REMOTEWAKEUP 0x20 |
#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) |
#define | ENDPOINT_USAGE_DATA (0 << 4) |
#define | ENDPOINT_USAGE_FEEDBACK (1 << 4) |
#define | ENDPOINT_USAGE_IMPLICIT_FEEDBACK (2 << 4) |
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 } |
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.
#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.
#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.
#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.
#define ENDPOINT_DESCRIPTOR_DIR_IN 0x80 |
Can be masked with an endpoint address for a USB_Descriptor_Endpoint_t endpoint descriptor's EndpointAddress value to indicate to the host that the endpoint is of the IN direction (i.e, from device to host).
#define ENDPOINT_DESCRIPTOR_DIR_OUT 0x00 |
Can be masked with an endpoint address for a USB_Descriptor_Endpoint_t endpoint descriptor's EndpointAddress value to indicate to the host that the endpoint is of the OUT direction (i.e, from host to device).
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#define USB_CONFIG_POWER_MA | ( | mA | ) | ((mA) >> 1) |
Macro to calculate the power value for the configuration descriptor, from a given number of milliamps.
#define USB_STRING_LEN | ( | str | ) | (sizeof(USB_Descriptor_Header_t) + ((str) << 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.
#define USE_INTERNAL_SERIAL 0xDC |
String descriptor index for the device's unique serial number string descriptor within the device. This unique serial number is used by the host to associate resources to the device (such as drivers or COM port number allocations) to a device regardless of the port it is plugged in to on the host. Some USB AVRs contain a unique serial number internally, and setting the device descriptors serial number string index to this value will cause it to use the internal serial number.
On unsupported devices, this will evaluate to NO_DESCRIPTOR and so will force the host to create a pseudo-serial number for the device.
#define VERSION_BCD | ( | x | ) |
((((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.
Enum for the possible standard descriptor types, as given in each descriptor's header.