Add FatFS library to the Webserver project, extend the HTTP server so that it now...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / StdDescriptors.h

diff --git a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
index 3090d8c..008bbb8 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
+++ b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,31 +28,25 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-/** \file\r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_Descriptors USB Descriptors\r

  *\r
  *  Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains\r
  *\r
  *  Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains\r

- *  strucutures and macros for the easy creation of standard USB descriptors in USB device projects.\r
+ *  structures and macros for the easy creation of standard USB descriptors in USB device projects.\r

  *\r
  *\r

- *  All standard descriptors have their elements named in an identical manner to the official USB specification,\r
- *  however slightly more verbose alternate (non-standard) names are also supplied if the macro\r
- *  USE_NONSTANDARD_DESCRIPTOR_NAMES is defined in the user project makefile and passed to the compiler at\r
- *  compilation time using the -D option.\r
- *\r
- *  The non-standard names are documented here - if USE_NONSTANDARD_DESCRIPTOR_NAMES is not defined, then all\r
- *  descriptors will contain elements named identically to the official USB specification. The alternately\r
- *  named descriptor elements are placed in the same order inside the descriptor structures as their officially\r
- *  named counterparts, thus they can be correlated easily with the official USB specification.\r
+ *  @{\r

  */\r
  */\r

-\r
+ \r

 #ifndef __USBDESCRIPTORS_H__\r
 #define __USBDESCRIPTORS_H__\r
 \r
        /* Includes: */\r
                #include <avr/pgmspace.h>\r
                #include <stdbool.h>\r
 #ifndef __USBDESCRIPTORS_H__\r
 #define __USBDESCRIPTORS_H__\r
 \r
        /* Includes: */\r
                #include <avr/pgmspace.h>\r
                #include <stdbool.h>\r

+               #include <stddef.h>\r

 \r
                #include "../../../Common/Common.h"\r
 \r
                #include "../../../Common/Common.h"\r

-               #include "../LowLevel/USBMode.h"\r
+               #include "USBMode.h"\r

                #include "Events.h"\r
                \r
                #if defined(USB_CAN_BE_DEVICE)\r
                #include "Events.h"\r
                \r
                #if defined(USB_CAN_BE_DEVICE)\r


@@ -71,14 +65,29 @@
                         *  descriptor does not exist.\r
                         */\r
                        #define NO_DESCRIPTOR                     0\r
                         *  descriptor does not exist.\r
                         */\r
                        #define NO_DESCRIPTOR                     0\r

+\r
+                       #if (!defined(NO_INTERNAL_SERIAL) && (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))) || defined(__DOXYGEN__)\r
+                               /** String descriptor index for the device's unique serial number string descriptor within the device.\r
+                                *  This unique serial number is used by the host to associate resources to the device (such as drivers or COM port\r
+                                *  number allocations) to a device regardless of the port it is plugged in to on the host. Some USB AVRs contain\r
+                                *  a unique serial number internally, and setting the device descriptors serial number string index to this value\r
+                                *  will cause it to use the internal serial number.\r
+                                *\r
+                                *  On unsupported devices, this will evaluate to NO_DESCRIPTOR and so will force the host to create a pseudo-serial\r
+                                *  number for the device.\r
+                                */\r
+                               #define USE_INTERNAL_SERIAL           0xDC\r
+                       #else\r
+                               #define USE_INTERNAL_SERIAL           NO_DESCRIPTOR\r
+                       #endif\r

                        \r
                        /** Macro to calculate the power value for the device descriptor, from a given number of milliamps. */\r
                        \r
                        /** Macro to calculate the power value for the device descriptor, from a given number of milliamps. */\r

-                       #define USB_CONFIG_POWER_MA(x)            (x >> 1)\r
+                       #define USB_CONFIG_POWER_MA(mA)           ((mA) >> 1)\r

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

-                       #define USB_STRING_LEN(x)                 (sizeof(USB_Descriptor_Header_t) + (x << 1))\r
+                       #define USB_STRING_LEN(str)               (sizeof(USB_Descriptor_Header_t) + ((str) << 1))\r

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


@@ -87,104 +96,92 @@
                        #define VERSION_BCD(x)                    ((((VERSION_TENS(x) << 4) | VERSION_ONES(x)) << 8) | \\r
                                                                  ((VERSION_TENTHS(x) << 4) | VERSION_HUNDREDTHS(x)))\r
 \r
                        #define VERSION_BCD(x)                    ((((VERSION_TENS(x) << 4) | VERSION_ONES(x)) << 8) | \\r
                                                                  ((VERSION_TENTHS(x) << 4) | VERSION_HUNDREDTHS(x)))\r
 \r

-                       /** String language ID for the English language. Should be used in USB_Descriptor_Language_t descriptors\r
+                       /** String language ID for the English language. Should be used in \ref USB_Descriptor_String_t descriptors\r

                         *  to indicate that the English language is supported by the device in its string descriptors.\r
                         */\r
                        #define LANGUAGE_ID_ENG                   0x0409\r
 \r
                         *  to indicate that the English language is supported by the device in its string descriptors.\r
                         */\r
                        #define LANGUAGE_ID_ENG                   0x0409\r
 \r

-                       /** Can be masked with an endpoint address for a USB_Descriptor_Endpoint_t endpoint descriptor's\r
+                       /** Can be masked with an endpoint address for a \ref USB_Descriptor_Endpoint_t endpoint descriptor's\r

                         *  EndpointAddress value to indicate to the host that the endpoint is of the IN direction (i.e, from\r
                         *  device to host).\r
                         */\r
                        #define ENDPOINT_DESCRIPTOR_DIR_IN        0x80\r
 \r
                         *  EndpointAddress value to indicate to the host that the endpoint is of the IN direction (i.e, from\r
                         *  device to host).\r
                         */\r
                        #define ENDPOINT_DESCRIPTOR_DIR_IN        0x80\r
 \r

-                       /** Can be masked with an endpoint address for a USB_Descriptor_Endpoint_t endpoint descriptor's\r
+                       /** Can be masked with an endpoint address for a \ref USB_Descriptor_Endpoint_t endpoint descriptor's\r

                         *  EndpointAddress value to indicate to the host that the endpoint is of the OUT direction (i.e, from\r
                         *  host to device).\r
                         */\r
                        #define ENDPOINT_DESCRIPTOR_DIR_OUT       0x00          \r
 \r
                         *  EndpointAddress value to indicate to the host that the endpoint is of the OUT direction (i.e, from\r
                         *  host to device).\r
                         */\r
                        #define ENDPOINT_DESCRIPTOR_DIR_OUT       0x00          \r
 \r

-                       /** Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t\r
+                       /** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t\r

                         *  descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power\r
                         *  from the host's VBUS line.\r
                         */\r
                         *  descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power\r
                         *  from the host's VBUS line.\r
                         */\r

-                       #define USB_CONFIG_ATTR_BUSPOWERED        0b10000000\r
+                       #define USB_CONFIG_ATTR_BUSPOWERED        0x80\r

 \r
 \r

-                       /** Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t\r
+                       \r
+                       /** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t\r

                         *  descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power\r
                         *  from the device's own power source.\r
                         */\r
                         *  descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power\r
                         *  from the device's own power source.\r
                         */\r

-                       #define USB_CONFIG_ATTR_SELFPOWERED       0b11000000\r
+                       #define USB_CONFIG_ATTR_SELFPOWERED       0xC0\r

 \r
 \r

-                       /** Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t\r
+                       /** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t\r

                         *  descriptor's ConfigAttributes value to indicate that the specified configuration supports the\r
                         *  remote wakeup feature of the USB standard, allowing a suspended USB device to wake up the host upon\r
                         *  request.\r
                         */\r
                         *  descriptor's ConfigAttributes value to indicate that the specified configuration supports the\r
                         *  remote wakeup feature of the USB standard, allowing a suspended USB device to wake up the host upon\r
                         *  request.\r
                         */\r

-                       #define USB_CONFIG_ATTR_REMOTEWAKEUP      0b10100000\r
+                       #define USB_CONFIG_ATTR_REMOTEWAKEUP      0xA0\r

 \r
 \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is not synchronized.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is not synchronized.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r

-                       #define ENDPOINT_ATTR_NO_SYNC             (0b00 << 2)\r
+                       #define ENDPOINT_ATTR_NO_SYNC             (0 << 2)\r

 \r
 \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is asynchronous.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is asynchronous.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r

-                       #define ENDPOINT_ATTR_ASYNC               (0b01 << 2)\r
+                       #define ENDPOINT_ATTR_ASYNC               (1 << 2)\r

 \r
 \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is adaptive.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is adaptive.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r

-                       #define ENDPOINT_ATTR_ADAPTIVE            (0b10 << 2)\r
+                       #define ENDPOINT_ATTR_ADAPTIVE            (2 << 2)\r

 \r
 \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is synchronized.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is synchronized.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint attributes.\r
                         */\r

-                       #define ENDPOINT_ATTR_SYNC                (0b11 << 2)\r
+                       #define ENDPOINT_ATTR_SYNC                (3 << 2)\r

                        \r
                        \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is used for data transfers.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is used for data transfers.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.\r
                         */\r

-                       #define ENDPOINT_USAGE_DATA               (0b00 << 4)\r
+                       #define ENDPOINT_USAGE_DATA               (0 << 4)\r

 \r
 \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is used for feedback.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is used for feedback.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.\r
                         */\r

-                       #define ENDPOINT_USAGE_FEEDBACK           (0b01 << 4)\r
+                       #define ENDPOINT_USAGE_FEEDBACK           (1 << 4)\r

 \r
 \r

-                       /** Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's\r
+                       /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's\r

                         *  Attributes value to indicate that the specified endpoint is used for implicit feedback.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.\r
                         */\r
                         *  Attributes value to indicate that the specified endpoint is used for implicit feedback.\r
                         *\r
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.\r
                         */\r

-                       #define ENDPOINT_USAGE_IMPLICIT_FEEDBACK  (0b10 << 4)\r
+                       #define ENDPOINT_USAGE_IMPLICIT_FEEDBACK  (2 << 4)\r

 \r
 \r

-                       /** Gives a void pointer to the specified descriptor (of any type). */\r
-                       #define DESCRIPTOR_ADDRESS(Descriptor)    ((void*)&Descriptor)\r
-\r
-               /* Events: */\r
-                       #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
-                               /** This module raises the Device Error event while in device mode, if the USB_GetDescriptor()\r
-                                *  routine is not hooked in the user application to properly return descriptors to the library.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_DeviceError);\r
-                       #endif\r
-                       \r

                /* Enums: */\r
                        /** Enum for the possible standard descriptor types, as given in each descriptor's header. */\r
                        enum USB_DescriptorTypes_t\r
                /* Enums: */\r
                        /** Enum for the possible standard descriptor types, as given in each descriptor's header. */\r
                        enum USB_DescriptorTypes_t\r


@@ -201,323 +198,413 @@
                        };\r
 \r
                /* Type Defines: */\r
                        };\r
 \r
                /* Type Defines: */\r

-                       /** Type define for all descriptor's header, indicating the descriptor's length and type.\r
+                       /** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure\r
+                        *  uses LUFA-specific element names to make each element's purpose clearer.\r

                         *\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
+                        *  \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r
-                               uint8_t Size; /**< Size of the descriptor, in bytes. */\r
-                               uint8_t Type; /**< Type of the descriptor, either a value in DescriptorTypes_t or a value\r
-                                              *   given by the specific class.\r
-                                              */\r
-                               #else\r
-                               uint8_t bLength;\r
-                               uint8_t bDescriptorType;\r
-                               #endif\r
+                               uint8_t     Size; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     Type; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                  *   given by the specific class.\r
+                                                  */\r

                        } USB_Descriptor_Header_t;\r
                        \r
                        } USB_Descriptor_Header_t;\r
                        \r

-                       /** Type define for a standard device descriptor.\r
+                       /** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure\r
+                        *  uses the relevant standard's given element names to ensure compatibility with the standard.\r

                         *\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
+                        *  \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t     bLength; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                             *   given by the specific class.\r
+                                                             */\r
+                       } USB_StdDescriptor_Header_t;\r
+                       \r
+                       /** Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each\r
+                        *  element's purpose clearer.\r
+                        *\r
+                        *  \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r

                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
 \r
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
 \r

-                               uint16_t                USBSpecification; /**< BCD of the supported USB specification. */\r
-                               uint8_t                 Class; /**< USB device class. */\r
-                               uint8_t                 SubClass; /**< USB device subclass. */\r
-                               uint8_t                 Protocol; /**< USB device protocol. */\r
+                               uint16_t    USBSpecification; /**< BCD of the supported USB specification. */\r
+                               uint8_t     Class; /**< USB device class. */\r
+                               uint8_t     SubClass; /**< USB device subclass. */\r
+                               uint8_t     Protocol; /**< USB device protocol. */\r

                                \r
                                \r

-                               uint8_t                 Endpoint0Size; /**< Size of the control (address 0) endpoint's bank in bytes. */\r
+                               uint8_t     Endpoint0Size; /**< Size of the control (address 0) endpoint's bank in bytes. */\r

                                \r
                                \r

-                               uint16_t                VendorID; /**< Vendor ID for the USB product. */\r
-                               uint16_t                ProductID; /**< Unique product ID for the USB product. */\r
-                               uint16_t                ReleaseNumber; /**< Product release (version) number. */\r
+                               uint16_t    VendorID; /**< Vendor ID for the USB product. */\r
+                               uint16_t    ProductID; /**< Unique product ID for the USB product. */\r
+                               uint16_t    ReleaseNumber; /**< Product release (version) number. */\r

                                \r
                                \r

-                               uint8_t                 ManufacturerStrIndex; /**< String index for the manufacturer's name. The\r
-                                                               *   host will request this string via a seperate\r
-                                                                          *   control request for the string descriptor.\r
-                                                                              *\r
-                                                                              *   \note If no string supplied, use NO_DESCRIPTOR.\r
-                                                                              */\r
-                               uint8_t                 ProductStrIndex; /**< String index for the product name/details.\r
-                                                                         *\r
-                                                                         *  \see ManufacturerStrIndex structure entry.\r
-                                                                         */\r
-                               uint8_t                 SerialNumStrIndex; /**< String index for the product's globally unique hexadecimal\r
-                                                                           *   serial number, in uppercase Unicoded ASCII.\r
-                                                                           *\r
-                                                                           *  \see ManufacturerStrIndex structure entry.\r
-                                                                           */\r
-\r
-                               uint8_t                 NumberOfConfigurations; /**< Total number of configurations supported by\r
-                                                                                *   the device.\r
-                                                                                */\r
-                               #else\r
-                               uint8_t                 bLength;\r
-                               uint8_t                 bDescriptorType;\r
-                               uint16_t                bcdUSB;\r
-                               uint8_t                 bDeviceClass;\r
-                               uint8_t                 bDeviceSubClass;\r
-                               uint8_t                 bDeviceProtocol;\r
-                               uint8_t                 bMaxPacketSize0;\r
-                               uint16_t                idVendor;\r
-                               uint16_t                idProduct;\r
-                               uint16_t                bcdDevice;\r
-                               uint8_t                 iManufacturer;\r
-                               uint8_t                 iProduct;\r
-                               uint8_t                 iSerialNumber;\r
-                               uint8_t                 bNumConfigurations;\r
-                               #endif\r
+                               uint8_t     ManufacturerStrIndex; /**< String index for the manufacturer's name. The\r
+                                                                  *   host will request this string via a separate\r
+                                                                  *   control request for the string descriptor.\r
+                                                                  *\r
+                                                                  *   \note If no string supplied, use \ref NO_DESCRIPTOR.\r
+                                                                  */\r
+                               uint8_t     ProductStrIndex; /**< String index for the product name/details.\r
+                                                             *\r
+                                                             *  \see ManufacturerStrIndex structure entry.\r
+                                                             */\r
+                               uint8_t     SerialNumStrIndex; /**< String index for the product's globally unique hexadecimal\r
+                                                               *   serial number, in uppercase Unicode ASCII.\r
+                                                               *\r
+                                                               *  \note On some AVR models, there is an embedded serial number\r
+                                                               *        in the chip which can be used for the device serial number.\r
+                                                               *        To use this serial number, set this to USE_INTERNAL_SERIAL.\r
+                                                               *        On unsupported devices, this will evaluate to 0 and will cause\r
+                                                               *        the host to generate a pseudo-unique value for the device upon\r
+                                                               *        insertion.\r
+                                                               *\r
+                                                               *  \see ManufacturerStrIndex structure entry.\r
+                                                               */\r
+                               uint8_t     NumberOfConfigurations; /**< Total number of configurations supported by\r
+                                                                    *   the device.\r
+                                                                    */\r

                        } USB_Descriptor_Device_t;\r
 \r
                        } USB_Descriptor_Device_t;\r
 \r

-                       /** Type define for a standard configuration descriptor.\r
+                       /** Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names\r
+                        *  to ensure compatibility with the standard.\r

                         *\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
+                        *  \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t     bLength; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                             *   given by the specific class.\r
+                                                             */\r
+                               uint16_t    bcdUSB; /**< BCD of the supported USB specification. */\r
+                               uint8_t     bDeviceClass; /**< USB device class. */\r
+                               uint8_t     bDeviceSubClass; /**< USB device subclass. */\r
+                               uint8_t     bDeviceProtocol; /**< USB device protocol. */\r
+                               uint8_t     bMaxPacketSize0; /**< Size of the control (address 0) endpoint's bank in bytes. */\r
+                               uint16_t    idVendor; /**< Vendor ID for the USB product. */\r
+                               uint16_t    idProduct; /**< Unique product ID for the USB product. */\r
+                               uint16_t    bcdDevice; /**< Product release (version) number. */\r
+                               uint8_t     iManufacturer; /**< String index for the manufacturer's name. The\r
+                                                           *   host will request this string via a separate\r
+                                                           *   control request for the string descriptor.\r
+                                                           *\r
+                                                           *   \note If no string supplied, use \ref NO_DESCRIPTOR.\r
+                                                           */\r
+                               uint8_t     iProduct; /**< String index for the product name/details.\r
+                                                      *\r
+                                                      *  \see ManufacturerStrIndex structure entry.\r
+                                                      */\r
+                               uint8_t     iSerialNumber; /**< String index for the product's globally unique hexadecimal\r
+                                                           *   serial number, in uppercase Unicode ASCII.\r
+                                                           *\r
+                                                           *  \note On some AVR models, there is an embedded serial number\r
+                                                           *        in the chip which can be used for the device serial number.\r
+                                                           *        To use this serial number, set this to USE_INTERNAL_SERIAL.\r
+                                                           *        On unsupported devices, this will evaluate to 0 and will cause\r
+                                                           *        the host to generate a pseudo-unique value for the device upon\r
+                                                           *        insertion.\r
+                                                           *\r
+                                                           *  \see ManufacturerStrIndex structure entry.\r
+                                                            */\r
+                               uint8_t     bNumConfigurations; /**< Total number of configurations supported by\r
+                                                                *   the device.\r
+                                                                */\r
+                       } USB_StdDescriptor_Device_t;\r
+\r
+                       /** Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names\r
+                        *  to make each element's purpose clearer.\r
+                        *\r
+                        *  \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r

                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
                        \r
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
                        \r

-                               uint16_t                TotalConfigurationSize; /**< Size of the configuration descriptor header,\r
-                                                                                *   and all sub descriptors inside the configuration.\r
-                                                                                */\r
-                               uint8_t                 TotalInterfaces; /**< Total number of interfaces in the configuration. */\r
+                               uint16_t    TotalConfigurationSize; /**< Size of the configuration descriptor header,\r
+                                                                    *   and all sub descriptors inside the configuration.\r
+                                                                    */\r
+                               uint8_t     TotalInterfaces; /**< Total number of interfaces in the configuration. */\r

 \r
 \r

-                               uint8_t                 ConfigurationNumber; /**< Configuration index of the current configuration. */\r
-                               uint8_t                 ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */\r
+                               uint8_t     ConfigurationNumber; /**< Configuration index of the current configuration. */\r
+                               uint8_t     ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */\r

                                \r
                                \r

-                               uint8_t                 ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or\r
-                                                                          *   more USB_CONFIG_ATTR_* masks.\r
-                                                                          */\r
+                               uint8_t     ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or\r
+                                                              *   more USB_CONFIG_ATTR_* masks.\r
+                                                              */\r

                                \r
                                \r

-                               uint8_t                 MaxPowerConsumption; /**< Maximum power consumption of the device while in the\r
-                                                                             *   current configuration, calculated by the USB_CONFIG_POWER_MA()\r
-                                                                             *   macro.\r
-                                                                             */\r
-                               #else\r
-                               uint8_t                 bLength;\r
-                               uint8_t                 bDescriptorType;\r
-                               uint16_t                wTotalLength;\r
-                               uint8_t                 bNumInterfaces;\r
-                               uint8_t                 bConfigurationValue;\r
-                               uint8_t                 iConfiguration;\r
-                               uint8_t                 bmAttributes;\r
-                               uint8_t                 bMaxPower;\r
-                               #endif\r
+                               uint8_t     MaxPowerConsumption; /**< Maximum power consumption of the device while in the\r
+                                                                 *   current configuration, calculated by the \ref USB_CONFIG_POWER_MA()\r
+                                                                 *   macro.\r
+                                                                 */\r

                        } USB_Descriptor_Configuration_Header_t;\r
                        } USB_Descriptor_Configuration_Header_t;\r

-\r
-                       /** Type define for a standard interface descriptor.\r
+                       \r
+                       /** Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names\r
+                        *  to ensure compatibility with the standard.\r
+                        *\r
+                        *  \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t     bLength; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                             *   given by the specific class.\r
+                                                             */\r
+                               uint16_t    wTotalLength; /**< Size of the configuration descriptor header,\r
+                                                          *   and all sub descriptors inside the configuration.\r
+                                                          */\r
+                               uint8_t     bNumInterfaces; /**< Total number of interfaces in the configuration. */\r
+                               uint8_t     bConfigurationValue; /**< Configuration index of the current configuration. */\r
+                               uint8_t     iConfiguration; /**< Index of a string descriptor describing the configuration. */\r
+                               uint8_t     bmAttributes; /**< Configuration attributes, comprised of a mask of zero or\r
+                                                          *   more USB_CONFIG_ATTR_* masks.\r
+                                                          */\r
+                               uint8_t     bMaxPower; /**< Maximum power consumption of the device while in the\r
+                                                       *   current configuration, calculated by the \ref USB_CONFIG_POWER_MA()\r
+                                                       *   macro.\r
+                                                       */\r
+                       } USB_StdDescriptor_Configuration_Header_t;\r
+\r
+                       /** Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names\r
+                        *  to make each element's purpose clearer.\r

                         *\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
+                        *  \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r

                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
 \r
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
 \r

-                               uint8_t                 InterfaceNumber; /**< Index of the interface in the current configuration. */\r
-                               uint8_t                 AlternateSetting; /**< Alternate setting for the interface number. The same\r
-                                                                          *   interface number can have multiple alternate settings\r
-                                                                          *   with different endpoint configurations, which can be\r
-                                                                          *   selected by the host.\r
-                                                                          */\r
-                               uint8_t                 TotalEndpoints; /**< Total number of endpoints in the interface. */\r
+                               uint8_t     InterfaceNumber; /**< Index of the interface in the current configuration. */\r
+                               uint8_t     AlternateSetting; /**< Alternate setting for the interface number. The same\r
+                                                              *   interface number can have multiple alternate settings\r
+                                                              *   with different endpoint configurations, which can be\r
+                                                              *   selected by the host.\r
+                                                              */\r
+                               uint8_t     TotalEndpoints; /**< Total number of endpoints in the interface. */\r

                                \r
                                \r

-                               uint8_t                 Class; /**< Interface class ID. */\r
-                               uint8_t                 SubClass; /**< Interface subclass ID. */\r
-                               uint8_t                 Protocol; /**< Interface protocol ID. */\r
-\r
-                               uint8_t                 InterfaceStrIndex; /**< Index of the string descriptor describing the\r
-                                                                           *   interface.\r
-                                                                           */\r
-                               #else\r
-                               uint8_t                 bLength;\r
-                               uint8_t                 bDescriptorType;\r
-                               uint8_t                 bInterfaceNumber;\r
-                               uint8_t                 bAlternateSetting;\r
-                               uint8_t                 bNumEndpoints;\r
-                               uint8_t                 bInterfaceClass;\r
-                               uint8_t                 bInterfaceSubClass;\r
-                               uint8_t                 bInterfaceProtocol;\r
-                               uint8_t                 iInterface;\r
-                               #endif\r
-                       } USB_Descriptor_Interface_t;\r
+                               uint8_t     Class; /**< Interface class ID. */\r
+                               uint8_t     SubClass; /**< Interface subclass ID. */\r
+                               uint8_t     Protocol; /**< Interface protocol ID. */\r

 \r
 \r

-                       /** Type define for a standard interface association descriptor.\r
+                               uint8_t     InterfaceStrIndex; /**< Index of the string descriptor describing the\r
+                                                               *   interface.\r
+                                                               */\r
+                       } USB_Descriptor_Interface_t;\r
+                       \r
+                       /** Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names\r
+                        *  to ensure compatibility with the standard.\r
+                        *\r
+                        *  \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t     bLength; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                             *   given by the specific class.\r
+                                                             */\r
+                               uint8_t     bInterfaceNumber; /**< Index of the interface in the current configuration. */\r
+                               uint8_t     bAlternateSetting; /**< Alternate setting for the interface number. The same\r
+                                                               *   interface number can have multiple alternate settings\r
+                                                               *   with different endpoint configurations, which can be\r
+                                                               *   selected by the host.\r
+                                                               */\r
+                               uint8_t     bNumEndpoints; /**< Total number of endpoints in the interface. */\r
+                               uint8_t     bInterfaceClass; /**< Interface class ID. */\r
+                               uint8_t     bInterfaceSubClass; /**< Interface subclass ID. */\r
+                               uint8_t     bInterfaceProtocol; /**< Interface protocol ID. */\r
+                               uint8_t     iInterface; /**< Index of the string descriptor describing the\r
+                                                        *   interface.\r
+                                                        */\r
+                       } USB_StdDescriptor_Interface_t;\r
+\r
+                       /** Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names\r
+                        *  to make each element's purpose clearer.\r

                         *\r
                         *\r

-                        *  This descriptor has been added as a suppliment to the USB2.0 standard, in the ECN located at\r
+                        *  This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r

                         *  <a>http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf</a>. It allows compound\r
                         *  devices with multiple interfaces related to the same function to have the multiple interfaces bound\r
                         *  together at the point of enumeration, loading one generic driver for all the interfaces in the single\r
                         *  function. Read the ECN for more information.\r
                         *\r
                         *  <a>http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf</a>. It allows compound\r
                         *  devices with multiple interfaces related to the same function to have the multiple interfaces bound\r
                         *  together at the point of enumeration, loading one generic driver for all the interfaces in the single\r
                         *  function. Read the ECN for more information.\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
+                        *  \see \ref USB_StdDescriptor_Interface_Association_t for the version of this define with standard element names\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r

                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
                                \r
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
                                \r

-                               uint8_t                 FirstInterfaceIndex; /**< Index of the first associated interface. */\r
-                               uint8_t                 TotalInterfaces; /** Total number of associated interfaces. */\r
-\r
-                               uint8_t                 Class; /**< Interface class ID. */\r
-                               uint8_t                 SubClass; /**< Interface subclass ID. */\r
-                               uint8_t                 Protocol; /**< Interface protocol ID. */\r
-\r
-                               uint8_t                 IADStrIndex; /**< Index of the string descriptor describing the\r
-                                                                     *   interface association.\r
-                                                                     */\r
-                               #else\r
-                               uint8_t                 bLength;\r
-                               uint8_t                 bDescriptorType;\r
-                               uint8_t                 bFirstInterface;\r
-                               uint8_t                 bInterfaceCount;\r
-                               uint8_t                 bFunctionClass;\r
-                               uint8_t                 bFunctionSubClass;\r
-                               uint8_t                 bFunctionProtocol;\r
-                               uint8_t                 iFunction;\r
-                               #endif\r
-                       } USB_Descriptor_Interface_Association_t;\r
+                               uint8_t     FirstInterfaceIndex; /**< Index of the first associated interface. */\r
+                               uint8_t     TotalInterfaces; /** Total number of associated interfaces. */\r
+\r
+                               uint8_t     Class; /**< Interface class ID. */\r
+                               uint8_t     SubClass; /**< Interface subclass ID. */\r
+                               uint8_t     Protocol; /**< Interface protocol ID. */\r

 \r
 \r

-                       /** Type define for a standard endpoint descriptor.\r
+                               uint8_t     IADStrIndex; /**< Index of the string descriptor describing the\r
+                                                         *   interface association.\r
+                                                         */\r
+                       } USB_Descriptor_Interface_Association_t;\r
+                               \r
+                       /** Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given\r
+                        *  element names to ensure compatibility with the standard.\r
+                        *\r
+                        *  This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r
+                        *  <a>http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf</a>. It allows compound\r
+                        *  devices with multiple interfaces related to the same function to have the multiple interfaces bound\r
+                        *  together at the point of enumeration, loading one generic driver for all the interfaces in the single\r
+                        *  function. Read the ECN for more information.\r

                         *\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
-                       */\r
+                        *  \see \ref USB_Descriptor_Interface_Association_t for the version of this define with non-standard LUFA specific\r
+                        *       element names\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t     bLength; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                             *   given by the specific class.\r
+                                                             */\r
+                               uint8_t     bFirstInterface; /**< Index of the first associated interface. */\r
+                               uint8_t     bInterfaceCount; /** Total number of associated interfaces. */\r
+                               uint8_t     bFunctionClass; /**< Interface class ID. */\r
+                               uint8_t     bFunctionSubClass; /**< Interface subclass ID. */\r
+                               uint8_t     bFunctionProtocol; /**< Interface protocol ID. */\r
+                               uint8_t     iFunction; /**< Index of the string descriptor describing the\r
+                                                       *   interface association.\r
+                                                       */\r
+                       } USB_StdDescriptor_Interface_Association_t;\r
+\r
+                       /** Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names\r
+                        *  to make each element's purpose clearer.\r
+                        *\r
+                        *  \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names\r
+                        */\r

                        typedef struct\r
                        {\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r

                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
 \r
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
 \r

-                               uint8_t                 EndpointAddress; /**< Logical address of the endpoint within the device\r
-                                                                         *   for the current configuration, including direction\r
-                                                                         *   mask.\r
-                                                                         */\r
-                               uint8_t                 Attributes; /**< Endpoint attributes, comprised of a mask of the\r
-                                                                    *   endpoint type (EP_TYPE_*) and attributes (ENDPOINT_ATTR_*)\r
-                                                                    *   masks.\r
-                                                                    */\r
-                               uint16_t                EndpointSize; /**< Size of the endpoint bank, in bytes. This indicates the\r
-                                                                      *   maximum packet size that the endpoint can receive at a time.\r
-                                                                      */\r
+                               uint8_t     EndpointAddress; /**< Logical address of the endpoint within the device\r
+                                                             *   for the current configuration, including direction\r
+                                                             *   mask.\r
+                                                             */\r
+                               uint8_t     Attributes; /**< Endpoint attributes, comprised of a mask of the\r
+                                                        *   endpoint type (EP_TYPE_*) and attributes (ENDPOINT_ATTR_*)\r
+                                                        *   masks.\r
+                                                        */\r
+                               uint16_t    EndpointSize; /**< Size of the endpoint bank, in bytes. This indicates the\r
+                                                          *   maximum packet size that the endpoint can receive at a time.\r
+                                                          */\r

                                \r
                                \r

-                               uint8_t                 PollingIntervalMS; /**< Polling interval in milliseconds for the endpont\r
-                                                                           *   if it is an INTERRUPT or ISOCHRONOUS type.\r
-                                                                           */\r
-                               #else\r
-                               uint8_t                 bLength;\r
-                               uint8_t                 bDescriptorType;\r
-                               uint8_t                 bEndpointAddress;\r
-                               uint8_t                 bmAttributes;\r
-                               uint16_t                wMaxPacketSize;\r
-                               uint8_t                 bInterval;\r
-                               #endif\r
+                               uint8_t     PollingIntervalMS; /**< Polling interval in milliseconds for the endpoint\r
+                                                               *   if it is an INTERRUPT or ISOCHRONOUS type.\r
+                                                               */\r

                        } USB_Descriptor_Endpoint_t;\r
                        } USB_Descriptor_Endpoint_t;\r

+                               \r
+                       /** Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given\r
+                        *  element names to ensure compatibility with the standard.\r
+                        *\r
+                        *  \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific\r
+                        *       element names\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t     bLength; /**< Size of the descriptor, in bytes. */\r
+                               uint8_t     bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
+                                                             *   given by the specific class.\r
+                                                             */\r
+                               uint8_t     bEndpointAddress; /**< Logical address of the endpoint within the device\r
+                                                              *   for the current configuration, including direction\r
+                                                              *   mask.\r
+                                                              */\r
+                               uint8_t     bmAttributes; /**< Endpoint attributes, comprised of a mask of the\r
+                                                          *   endpoint type (EP_TYPE_*) and attributes (ENDPOINT_ATTR_*)\r
+                                                          *   masks.\r
+                                                          */\r
+                               uint16_t    wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the\r
+                                                            *   maximum packet size that the endpoint can receive at a time.\r
+                                                            */\r
+                               uint8_t     bInterval; /**< Polling interval in milliseconds for the endpoint\r
+                                                       *   if it is an INTERRUPT or ISOCHRONOUS type.\r
+                                                       */\r
+                       } USB_StdDescriptor_Endpoint_t;\r

 \r
                        /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
 \r
                        /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r

-                        *  of the descriptor for placement in the descriptor header must be determined by the USB_STRING_LEN()\r
+                        *  of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r

                         *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r
                         *\r
                         *  This structure should also be used for string index 0, which contains the supported language IDs for\r
                         *  the device as an array.\r
                         *\r
                         *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r
                         *\r
                         *  This structure should also be used for string index 0, which contains the supported language IDs for\r
                         *  the device as an array.\r
                         *\r

-                        *  \note The non-standard structure element names are documented here - see the StdDescriptors.h file\r
-                        *        documentation for more information on the two descriptor naming schemes. If the\r
-                        *        USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names\r
-                        *        identical to those listed in the USB standard.\r
+                        *  This structure uses LUFA-specific element names to make each element's purpose clearer.\r
+                        *\r
+                        *  \see \ref USB_StdDescriptor_String_t for the version of this define with standard element names\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r

                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
                                \r
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */\r
                                \r

-                               int16_t                 UnicodeString[]; /**< String data, as unicode characters (alternatively,\r
-                                                                         *   string language IDs). If normal ASCII characters are\r
-                                                                         *   to be used, they must be added as an array of characters\r
-                                                                         *   rather than a normal C string so that they are widened to\r
-                                                                         *   Unicode size.\r
-                                                                         *\r
-                                                                         *   Under GCC, strings prefixed with the "L" character (before\r
-                                                                         *   the opening string quotation mark) are considered to be\r
-                                                                         *   Unicode strings, and may be used instead of an explicit\r
-                                                                         *   array of ASCII characters.\r
-                                                                         */\r
-                               #else\r
-                               uint8_t                 bLength;\r
-                               uint8_t                 bDescriptorType;\r
-                               int16_t                 bString[];\r
-                               #endif\r
+                               wchar_t UnicodeString[];  /**< String data, as unicode characters (alternatively,\r
+                                                          *   string language IDs). If normal ASCII characters are\r
+                                                          *   to be used, they must be added as an array of characters\r
+                                                          *   rather than a normal C string so that they are widened to\r
+                                                          *   Unicode size.\r
+                                                          *\r
+                                                          *   Under GCC, strings prefixed with the "L" character (before\r
+                                                          *   the opening string quotation mark) are considered to be\r
+                                                          *   Unicode strings, and may be used instead of an explicit\r
+                                                          *   array of ASCII characters.\r
+                                                          */\r

                        } USB_Descriptor_String_t;\r
                        } USB_Descriptor_String_t;\r

-                       \r
-                       typedef struct\r
-                       {\r
-                               uint16_t Size;\r
-                               void*    Address;\r
-                       } USB_Descriptor_Details_t;\r
-\r
-               /* Function Prototypes: */\r
-                       /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,\r
-                        *  index and language ID. This function MUST be overridden in the user application (added with full, identical  \r
-                        *  prototype and name except for the ATTR_WEAK attribute) so that the library can call it to retrieve descriptor \r
-                        *  data.\r
+\r
+                       /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
+                        *  of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
+                        *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r

                         *\r
                         *\r

-                        *  \param wValue             The type of the descriptor to retrieve in the upper byte, and the index in the \r
-                        *                            lower byte (when more than one descriptor of the given type exists, such as the\r
-                        *                            case of string descriptors). The type may be one of the standard types defined\r
-                        *                            in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.\r
-                        *  \param wIndex             The language ID of the string to return if the wValue type indicates DTYPE_String,\r
-                        *                            otherwise zero for standard descriptors, or as defined in a class-specific\r
-                        *                            standards.\r
-                        *  \param DescriptorAddress  Pointer to the descriptor in memory. This should be set by the routine to\r
-                        *                            the location of the descriptor, found by the DESCRIPTOR_ADDRESS macro.\r
+                        *  This structure should also be used for string index 0, which contains the supported language IDs for\r
+                        *  the device as an array.\r

                         *\r
                         *\r

-                        *  \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.\r
-                        *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to\r
-                        *        allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the \r
-                        *        USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D\r
-                        *        switch.\r
+                        *  This structure uses the relevant standard's given element names to ensure compatibility with the standard.\r

                         *\r
                         *\r

-                        *  \return Size in bytes of the descriptor if it exists, zero or NO_DESCRIPTOR otherwise\r
+                        *  \see \ref USB_Descriptor_String_t for the version of this define with with non-standard LUFA specific\r
+                        *       element names\r

                         */\r
                         */\r

-                       uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
-                                                                          ATTR_WARN_UNUSED_RESULT ATTR_WEAK ATTR_NON_NULL_PTR_ARG(3);\r
+                       typedef struct\r
+                       {\r
+                                       uint8_t                 bLength; /**< Size of the descriptor, in bytes. */\r
+                                       uint8_t                 bDescriptorType; /**< Type of the descriptor, either a value in\r
+                                                                                 *   \ref USB_DescriptorTypes_t or a value\r
+                                                                             *   given by the specific class.\r
+                                                                             */\r
+                                       int16_t                 bString[]; /**< String data, as unicode characters (alternatively,\r
+                                                                       *   string language IDs). If normal ASCII characters are\r
+                                                                       *   to be used, they must be added as an array of characters\r
+                                                                       *   rather than a normal C string so that they are widened to\r
+                                                                       *   Unicode size.\r
+                                                                       *\r
+                                                                       *   Under GCC, strings prefixed with the "L" character (before\r
+                                                                       *   the opening string quotation mark) are considered to be\r
+                                                                       *   Unicode strings, and may be used instead of an explicit\r
+                                                                       *   array of ASCII characters.\r
+                                                                       */\r
+                       } USB_StdDescriptor_String_t;\r

 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r

-                       #define VERSION_TENS(x)                   (int)(x / 10)\r
-                       #define VERSION_ONES(x)                   (int)(x - (10 * VERSION_TENS(x)))\r
-                       #define VERSION_TENTHS(x)                 (int)((x - (int)x) * 10)\r
-                       #define VERSION_HUNDREDTHS(x)             (int)(((x - (int)x) * 100) - (10 * VERSION_TENTHS(x)))\r
+                       #define VERSION_TENS(x)                   (int)((x) / 10)\r
+                       #define VERSION_ONES(x)                   (int)((x) - (10 * VERSION_TENS(x)))\r
+                       #define VERSION_TENTHS(x)                 (int)(((x) - (int)(x)) * 10)\r
+                       #define VERSION_HUNDREDTHS(x)             (int)((((x) - (int)(x)) * 100) - (10 * VERSION_TENTHS(x)))\r

        #endif\r
        \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r
                #endif\r
        #endif\r
        \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r
                #endif\r

-               \r
+       \r

 #endif\r
 #endif\r

+\r
+/** @} */\r