Partial commit: Rename USBFOO LED driver to fix capitalisation of file name, which...
[pub/USBasp.git] / LUFA / Drivers / USB / Core / StdDescriptors.h
index 1ad1497..7840bcb 100644 (file)
                         */
                        #define NO_DESCRIPTOR                     0
 
-                       /** Macro to calculate the power value for the configuration descriptor, from a given number of milliamperes. */
+                       /** Macro to calculate the power value for the configuration descriptor, from a given number of milliamperes.
+                        *
+                        *  \param[in] mA  Maximum number of milliamps the device consumes when the given configuration is selected.
+                        */
                        #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.
+                        *
+                        *  \param[in] UnicodeChars  Number of Unicode characters in the string text.
                         */
-                       #define USB_STRING_LEN(str)               (sizeof(USB_Descriptor_Header_t) + ((str) << 1))
+                       #define USB_STRING_LEN(UnicodeChars)      (sizeof(USB_Descriptor_Header_t) + ((UnicodeChars) << 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.
+                        *
+                        *  \param[in]  x  Version number to encode as a 16-bit little-endian number, as a floating point number.
                         */
                        #define VERSION_BCD(x)                    CPU_TO_LE16((((VERSION_TENS(x) << 4) | VERSION_ONES(x)) << 8) | \
                                                                  ((VERSION_TENTHS(x) << 4) | VERSION_HUNDREDTHS(x)))
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
 
-                               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.
-                                                         */
+                               #if (ARCH == ARCH_AVR8)
+                               wchar_t  UnicodeString[];
+                               #else
+                               uint16_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.
+                                                          */
+                               #endif
                        } ATTR_PACKED USB_Descriptor_String_t;
 
                        /** \brief Standard USB String Descriptor (USB-IF naming conventions).
                                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.
-                                                   */
+                               uint16_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.
+                                                    */
                        } ATTR_PACKED USB_StdDescriptor_String_t;
 
        /* Private Interface - For use in library only: */