StdDescriptors.h 32.9 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * \brief USB standard descriptor definitions. * * This file contains structures and macros for the easy creation of standard USB descriptors in USB device projects. * * \note This file should not be included directly. It is automatically included as needed by the USB driver * dispatch header located in LUFA/Drivers/USB/USB.h. */ /** \ingroup Group_USB * @defgroup Group_Descriptors USB Descriptors * * 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. * * @{ */ #ifndef __USBDESCRIPTORS_H__ #define __USBDESCRIPTORS_H__ /* Includes: */ #include #include  Dean Camera committed Jul 21, 2010 55  #include  Dean Camera committed May 08, 2010 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83  #include #include "../../../Common/Common.h" #include "USBMode.h" #include "Events.h" #if defined(USB_CAN_BE_DEVICE) #include "../LowLevel/Device.h" #endif /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_USB_DRIVER) #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead. #endif /* Public Interface - May be used in end-application: */ /* Macros: */ /** 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 NO_DESCRIPTOR 0  84 85 86 87  #if (!defined(NO_INTERNAL_SERIAL) && \ (defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1287__) || \ defined(__AVR_ATmega32U6__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__) || \ defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega8U2__)))  Dean Camera committed May 08, 2010 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222  /** 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 USE_INTERNAL_SERIAL 0xDC #else #define USE_INTERNAL_SERIAL NO_DESCRIPTOR #endif /** Macro to calculate the power value for the configuration descriptor, from a given number of milliamps. */ #define USB_CONFIG_POWER_MA(mA) ((mA) >> 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 USB_STRING_LEN(str) (sizeof(USB_Descriptor_Header_t) + ((str) << 1)) /** 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. */ #define VERSION_BCD(x) ((((VERSION_TENS(x) << 4) | VERSION_ONES(x)) << 8) | \ ((VERSION_TENTHS(x) << 4) | VERSION_HUNDREDTHS(x))) /** String language ID for the English language. Should be used in \ref USB_Descriptor_String_t descriptors * to indicate that the English language is supported by the device in its string descriptors. */ #define LANGUAGE_ID_ENG 0x0409 /** Can be masked with an endpoint address for a \ref 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_IN 0x80 /** Can be masked with an endpoint address for a \ref 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_DESCRIPTOR_DIR_OUT 0x00 /** Can be masked with other configuration descriptor attributes for a \ref 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_BUSPOWERED 0x80 /** Can be masked with other configuration descriptor attributes for a \ref 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_ATTR_SELFPOWERED 0x40 /** Can be masked with other configuration descriptor attributes for a \ref 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_REMOTEWAKEUP 0x20 /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is not synchronized. * * \see 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 \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is asynchronous. * * \see 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 \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is adaptive. * * \see The USB specification for more details on the possible Endpoint attributes. */ #define ENDPOINT_ATTR_ADAPTIVE (2 << 2) /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is synchronized. * * \see 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 \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is used for data transfers. * * \see The USB specification for more details on the possible Endpoint usage attributes. */ #define ENDPOINT_USAGE_DATA (0 << 4) /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is used for feedback. * * \see 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 \ref USB_Descriptor_Endpoint_t descriptor's * Attributes value to indicate that the specified endpoint is used for implicit feedback. * * \see The USB specification for more details on the possible Endpoint usage attributes. */ #define ENDPOINT_USAGE_IMPLICIT_FEEDBACK (2 << 4) /* Enums: */ /** Enum for the possible standard descriptor types, as given in each descriptor's header. */ enum USB_DescriptorTypes_t { DTYPE_Device = 0x01, /**< Indicates that the descriptor is a device descriptor. */ DTYPE_Configuration = 0x02, /**< Indicates that the descriptor is a configuration descriptor. */ DTYPE_String = 0x03, /**< Indicates that the descriptor is a string descriptor. */ DTYPE_Interface = 0x04, /**< Indicates that the descriptor is an interface descriptor. */ DTYPE_Endpoint = 0x05, /**< Indicates that the descriptor is an endpoint descriptor. */ DTYPE_DeviceQualifier = 0x06, /**< Indicates that the descriptor is a device qualifier descriptor. */ DTYPE_Other = 0x07, /**< Indicates that the descriptor is of other type. */ DTYPE_InterfacePower = 0x08, /**< Indicates that the descriptor is an interface power descriptor. */ DTYPE_InterfaceAssociation = 0x0B, /**< Indicates that the descriptor is an interface association descriptor. */ }; /* Type Defines: */ /** \brief Standard USB Descriptor Header (LUFA naming conventions). * * Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure * uses LUFA-specific element names to make each element's purpose clearer. *  Dean Camera committed Jun 17, 2010 223  * \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 224 225 226  */ typedef struct {  227 228 229 230  uint8_t Size; /**< Size of the descriptor, in bytes. */ uint8_t Type; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value * given by the specific class. */  Dean Camera committed May 08, 2010 231 232 233 234 235 236 237  } USB_Descriptor_Header_t; /** \brief Standard USB Descriptor Header (USB-IF naming conventions). * * Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure * uses the relevant standard's given element names to ensure compatibility with the standard. *  Dean Camera committed Jun 17, 2010 238  * \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names.  Dean Camera committed May 08, 2010 239 240 241  */ typedef struct {  242 243 244 245  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value * given by the specific class. */  Dean Camera committed May 08, 2010 246 247 248 249 250 251 252  } USB_StdDescriptor_Header_t; /** \brief Standard USB Device Descriptor (LUFA naming conventions). * * Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each * element's purpose clearer. *  Dean Camera committed Jun 17, 2010 253  * \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 254 255 256 257 258  */ typedef struct { USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */  259 260 261 262  uint16_t USBSpecification; /**< BCD of the supported USB specification. */ uint8_t Class; /**< USB device class. */ uint8_t SubClass; /**< USB device subclass. */ uint8_t Protocol; /**< USB device protocol. */  Dean Camera committed May 08, 2010 263   264  uint8_t Endpoint0Size; /**< Size of the control (address 0) endpoint's bank in bytes. */  Dean Camera committed May 08, 2010 265   266 267 268  uint16_t VendorID; /**< Vendor ID for the USB product. */ uint16_t ProductID; /**< Unique product ID for the USB product. */ uint16_t ReleaseNumber; /**< Product release (version) number. */  Dean Camera committed May 08, 2010 269   270 271 272  uint8_t ManufacturerStrIndex; /**< String index for the manufacturer's name. The * host will request this string via a separate * control request for the string descriptor.  Dean Camera committed May 08, 2010 273  *  274  * \note If no string supplied, use \ref NO_DESCRIPTOR.  Dean Camera committed May 08, 2010 275  */  276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294  uint8_t ProductStrIndex; /**< String index for the product name/details. * * \see ManufacturerStrIndex structure entry. */ uint8_t SerialNumStrIndex; /**< String index for the product's globally unique hexadecimal * serial number, in uppercase Unicode ASCII. * * \note On some AVR models, there is an embedded serial number * in the chip which can be used for the device serial number. * To use this serial number, set this to USE_INTERNAL_SERIAL. * On unsupported devices, this will evaluate to 0 and will cause * the host to generate a pseudo-unique value for the device upon * insertion. * * \see ManufacturerStrIndex structure entry. */ uint8_t NumberOfConfigurations; /**< Total number of configurations supported by * the device. */  Dean Camera committed May 08, 2010 295 296 297 298 299 300 301  } USB_Descriptor_Device_t; /** \brief Standard USB Device Descriptor (USB-IF naming conventions). * * Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names * to ensure compatibility with the standard. *  Dean Camera committed Jun 17, 2010 302  * \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names.  Dean Camera committed May 08, 2010 303 304 305  */ typedef struct {  306 307  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value  Dean Camera committed May 08, 2010 308 309  * given by the specific class. */  310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342  uint16_t bcdUSB; /**< BCD of the supported USB specification. */ uint8_t bDeviceClass; /**< USB device class. */ uint8_t bDeviceSubClass; /**< USB device subclass. */ uint8_t bDeviceProtocol; /**< USB device protocol. */ uint8_t bMaxPacketSize0; /**< Size of the control (address 0) endpoint's bank in bytes. */ uint16_t idVendor; /**< Vendor ID for the USB product. */ uint16_t idProduct; /**< Unique product ID for the USB product. */ uint16_t bcdDevice; /**< Product release (version) number. */ uint8_t iManufacturer; /**< String index for the manufacturer's name. The * host will request this string via a separate * control request for the string descriptor. * * \note If no string supplied, use \ref NO_DESCRIPTOR. */ uint8_t iProduct; /**< String index for the product name/details. * * \see ManufacturerStrIndex structure entry. */ uint8_t iSerialNumber; /**< String index for the product's globally unique hexadecimal * serial number, in uppercase Unicode ASCII. * * \note On some AVR models, there is an embedded serial number * in the chip which can be used for the device serial number. * To use this serial number, set this to USE_INTERNAL_SERIAL. * On unsupported devices, this will evaluate to 0 and will cause * the host to generate a pseudo-unique value for the device upon * insertion. * * \see ManufacturerStrIndex structure entry. */ uint8_t bNumConfigurations; /**< Total number of configurations supported by * the device. */  Dean Camera committed May 08, 2010 343 344 345 346 347 348 349  } USB_StdDescriptor_Device_t; /** \brief Standard USB Configuration Descriptor (LUFA naming conventions). * * Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names * to make each element's purpose clearer. *  Dean Camera committed Jun 17, 2010 350  * \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 351 352 353 354 355  */ typedef struct { USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */  356 357 358 359  uint16_t TotalConfigurationSize; /**< Size of the configuration descriptor header, * and all sub descriptors inside the configuration. */ uint8_t TotalInterfaces; /**< Total number of interfaces in the configuration. */  Dean Camera committed May 08, 2010 360   361 362  uint8_t ConfigurationNumber; /**< Configuration index of the current configuration. */ uint8_t ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */  Dean Camera committed May 08, 2010 363   364 365 366  uint8_t ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or * more USB_CONFIG_ATTR_* masks. */  Dean Camera committed May 08, 2010 367   368 369 370 371  uint8_t MaxPowerConsumption; /**< Maximum power consumption of the device while in the * current configuration, calculated by the \ref USB_CONFIG_POWER_MA() * macro. */  Dean Camera committed May 08, 2010 372 373 374 375 376 377 378  } USB_Descriptor_Configuration_Header_t; /** \brief Standard USB Configuration Descriptor (USB-IF naming conventions). * * Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names * to ensure compatibility with the standard. *  Dean Camera committed Jun 17, 2010 379  * \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names.  Dean Camera committed May 08, 2010 380 381 382  */ typedef struct {  383 384  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value  Dean Camera committed May 08, 2010 385 386  * given by the specific class. */  387  uint16_t wTotalLength; /**< Size of the configuration descriptor header,  Dean Camera committed May 08, 2010 388 389  * and all sub descriptors inside the configuration. */  390 391 392 393 394  uint8_t bNumInterfaces; /**< Total number of interfaces in the configuration. */ uint8_t bConfigurationValue; /**< Configuration index of the current configuration. */ uint8_t iConfiguration; /**< Index of a string descriptor describing the configuration. */ uint8_t bmAttributes; /**< Configuration attributes, comprised of a mask of zero or * more USB_CONFIG_ATTR_* masks.  Dean Camera committed May 08, 2010 395  */  396 397 398 399  uint8_t bMaxPower; /**< Maximum power consumption of the device while in the * current configuration, calculated by the \ref USB_CONFIG_POWER_MA() * macro. */  Dean Camera committed May 08, 2010 400 401 402 403 404 405 406  } USB_StdDescriptor_Configuration_Header_t; /** \brief Standard USB Interface Descriptor (LUFA naming conventions). * * Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names * to make each element's purpose clearer. *  Dean Camera committed Jun 17, 2010 407  * \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 408 409 410 411 412  */ typedef struct { USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */  413 414 415 416 417 418 419  uint8_t InterfaceNumber; /**< Index of the interface in the current configuration. */ uint8_t AlternateSetting; /**< Alternate setting for the interface number. The same * interface number can have multiple alternate settings * with different endpoint configurations, which can be * selected by the host. */ uint8_t TotalEndpoints; /**< Total number of endpoints in the interface. */  Dean Camera committed May 08, 2010 420   421 422 423  uint8_t Class; /**< Interface class ID. */ uint8_t SubClass; /**< Interface subclass ID. */ uint8_t Protocol; /**< Interface protocol ID. */  Dean Camera committed May 08, 2010 424   425  uint8_t InterfaceStrIndex; /**< Index of the string descriptor describing the interface. */  Dean Camera committed May 08, 2010 426 427 428 429 430 431 432  } USB_Descriptor_Interface_t; /** \brief Standard USB Interface Descriptor (USB-IF naming conventions). * * Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names * to ensure compatibility with the standard. *  Dean Camera committed Jun 17, 2010 433  * \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names.  Dean Camera committed May 08, 2010 434 435 436  */ typedef struct {  437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value * given by the specific class. */ uint8_t bInterfaceNumber; /**< Index of the interface in the current configuration. */ uint8_t bAlternateSetting; /**< Alternate setting for the interface number. The same * interface number can have multiple alternate settings * with different endpoint configurations, which can be * selected by the host. */ uint8_t bNumEndpoints; /**< Total number of endpoints in the interface. */ uint8_t bInterfaceClass; /**< Interface class ID. */ uint8_t bInterfaceSubClass; /**< Interface subclass ID. */ uint8_t bInterfaceProtocol; /**< Interface protocol ID. */ uint8_t iInterface; /**< Index of the string descriptor describing the * interface. */  Dean Camera committed May 08, 2010 454 455 456 457 458 459 460 461 462 463 464 465 466  } USB_StdDescriptor_Interface_t; /** \brief Standard USB Interface Association Descriptor (LUFA naming conventions). * * Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names * to make each element's purpose clearer. * * This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at * http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf. It allows compound * devices with multiple interfaces related to the same function to have the multiple interfaces bound * together at the point of enumeration, loading one generic driver for all the interfaces in the single * function. Read the ECN for more information. *  Dean Camera committed Jun 17, 2010 467  * \see \ref USB_StdDescriptor_Interface_Association_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 468 469 470 471 472  */ typedef struct { USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */  473 474  uint8_t FirstInterfaceIndex; /**< Index of the first associated interface. */ uint8_t TotalInterfaces; /**< Total number of associated interfaces. */  Dean Camera committed May 08, 2010 475   476 477 478  uint8_t Class; /**< Interface class ID. */ uint8_t SubClass; /**< Interface subclass ID. */ uint8_t Protocol; /**< Interface protocol ID. */  Dean Camera committed May 08, 2010 479   480 481 482  uint8_t IADStrIndex; /**< Index of the string descriptor describing the * interface association. */  Dean Camera committed May 08, 2010 483 484 485 486 487 488 489 490 491 492 493 494 495 496  } USB_Descriptor_Interface_Association_t; /** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions). * * Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given * element names to ensure compatibility with the standard. * * This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at * http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf. It allows compound * devices with multiple interfaces related to the same function to have the multiple interfaces bound * together at the point of enumeration, loading one generic driver for all the interfaces in the single * function. Read the ECN for more information. * * \see \ref USB_Descriptor_Interface_Association_t for the version of this define with non-standard LUFA specific  Dean Camera committed Jun 17, 2010 497  * element names.  Dean Camera committed May 08, 2010 498 499 500  */ typedef struct {  501 502 503 504 505 506 507 508 509 510 511 512  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value * given by the specific class. */ uint8_t bFirstInterface; /**< Index of the first associated interface. */ uint8_t bInterfaceCount; /**< Total number of associated interfaces. */ uint8_t bFunctionClass; /**< Interface class ID. */ uint8_t bFunctionSubClass; /**< Interface subclass ID. */ uint8_t bFunctionProtocol; /**< Interface protocol ID. */ uint8_t iFunction; /**< Index of the string descriptor describing the * interface association. */  Dean Camera committed May 08, 2010 513 514 515 516 517 518 519  } USB_StdDescriptor_Interface_Association_t; /** \brief Standard USB Endpoint Descriptor (LUFA naming conventions). * * Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names * to make each element's purpose clearer. *  Dean Camera committed Jun 17, 2010 520  * \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 521 522 523 524 525  */ typedef struct { USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */  526 527  uint8_t EndpointAddress; /**< Logical address of the endpoint within the device for the current * configuration, including direction mask.  Dean Camera committed May 08, 2010 528  */  529 530 531 532 533 534 535 536 537  uint8_t Attributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*) * and attributes (ENDPOINT_ATTR_*) masks. */ uint16_t EndpointSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet * size that the endpoint can receive at a time. */ uint8_t PollingIntervalMS; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT * or ISOCHRONOUS type. */  Dean Camera committed May 08, 2010 538 539 540 541 542 543 544 545  } USB_Descriptor_Endpoint_t; /** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions). * * Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given * element names to ensure compatibility with the standard. * * \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific  Dean Camera committed Jun 17, 2010 546  * element names.  Dean Camera committed May 08, 2010 547 548 549  */ typedef struct {  550 551 552  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a * value given by the specific class.  Dean Camera committed May 08, 2010 553  */  554 555 556 557 558  uint8_t bEndpointAddress; /**< Logical address of the endpoint within the device for the current * configuration, including direction mask. */ uint8_t bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*) * and attributes (ENDPOINT_ATTR_*) masks.  Dean Camera committed May 08, 2010 559  */  560 561 562 563 564 565  uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size * that the endpoint can receive at a time. */ uint8_t bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or * ISOCHRONOUS type. */  Dean Camera committed May 08, 2010 566 567 568 569 570 571 572 573 574 575 576 577 578  } USB_StdDescriptor_Endpoint_t; /** \brief Standard USB String Descriptor (LUFA naming conventions). * * Type define for a standard string descriptor. Unlike other standard descriptors, the length * of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN() * macro rather than by the size of the descriptor structure, as the length is not fixed. * * This structure should also be used for string index 0, which contains the supported language IDs for * the device as an array. * * This structure uses LUFA-specific element names to make each element's purpose clearer. *  Dean Camera committed Jun 17, 2010 579  * \see \ref USB_StdDescriptor_String_t for the version of this define with standard element names.  Dean Camera committed May 08, 2010 580 581 582 583 584  */ typedef struct { USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */  585 586 587 588 589 590 591 592 593 594 595  wchar_t UnicodeString[]; /**< String data, as unicode characters (alternatively, * string language IDs). If normal ASCII characters are * to be used, they must be added as an array of characters * rather than a normal C string so that they are widened to * Unicode size. * * Under GCC, strings prefixed with the "L" character (before * the opening string quotation mark) are considered to be * Unicode strings, and may be used instead of an explicit * array of ASCII characters. */  Dean Camera committed May 08, 2010 596 597 598 599 600 601 602 603 604 605 606 607 608 609  } USB_Descriptor_String_t; /** \brief Standard USB String Descriptor (USB-IF naming conventions). * * Type define for a standard string descriptor. Unlike other standard descriptors, the length * of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN() * macro rather than by the size of the descriptor structure, as the length is not fixed. * * This structure should also be used for string index 0, which contains the supported language IDs for * the device as an array. * * This structure uses the relevant standard's given element names to ensure compatibility with the standard. * * \see \ref USB_Descriptor_String_t for the version of this define with with non-standard LUFA specific  Dean Camera committed Jun 17, 2010 610  * element names.  Dean Camera committed May 08, 2010 611 612 613  */ typedef struct {  614 615 616 617 618 619 620 621 622 623 624 625 626  uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t * or a value given by the specific class. */ int16_t bString[]; /**< String data, as unicode characters (alternatively, string language IDs). * If normal ASCII characters are to be used, they must be added as an array * of characters rather than a normal C string so that they are widened to * Unicode size. * * Under GCC, strings prefixed with the "L" character (before the opening string * quotation mark) are considered to be Unicode strings, and may be used instead * of an explicit array of ASCII characters. */  Dean Camera committed May 08, 2010 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645  } USB_StdDescriptor_String_t; /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define VERSION_TENS(x) (int)((x) / 10) #define VERSION_ONES(x) (int)((x) - (10 * VERSION_TENS(x))) #define VERSION_TENTHS(x) (int)(((x) - (int)(x)) * 10) #define VERSION_HUNDREDTHS(x) (int)((((x) - (int)(x)) * 100) - (10 * VERSION_TENTHS(x))) #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */