LUFA Library  120219
Data Structures | Defines | Enumerations
USB Descriptors
USB Core - LUFA/Drivers/USB/USB.h

Standard USB Descriptor definitions. More...

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_DeviceQualifier_t
 Standard USB Device Qualifier Descriptor (LUFA naming conventions). More...
struct  USB_StdDescriptor_DeviceQualifier_t
 Standard USB Device Qualifier 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...

Defines

#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_RESERVED   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)

Detailed Description

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 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.
#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.
#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.
#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.
#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.
#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.
#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.
#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_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_RESERVED   0x80

Mask for the reserved bit in the Configuration Descriptor's ConfigAttributes field, which must be set on all devices for historial purposes.

#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 milliamperes.

Parameters:
[in]mAMaximum number of milliamps the device consumes when the given configuration is selected.
#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:
[in]UnicodeCharsNumber of Unicode characters in the string text.
#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:
[in]xVersion number to encode as a 16-bit little-endian number, as a floating point number.

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.

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.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines