More endianness porting of the LUFA host mode class drivers.
[pub/USBasp.git] / LUFA / Drivers / USB / Core / StdDescriptors.h
index 908f27b..e3d9255 100644 (file)
@@ -93,6 +93,9 @@
                         *  Decimal format for descriptor fields requiring BCD encoding, such as the USB version number in the
                         *  standard device descriptor.
                         *
+                        *  \note This value is automatically converted into Little Endian, suitable for direct use inside device
+                        *        descriptors on all architectures without endianness conversion macros.
+                        *
                         *  \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) | \
                        /** 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                   CPU_TO_LE16(0x0409)
+                       #define LANGUAGE_ID_ENG                   0x0409
 
                        /** \name Endpoint Address Direction Masks */
                        //@{
                         *  uses LUFA-specific element names to make each element's purpose clearer.
                         *
                         *  \see \ref USB_StdDescriptor_Header_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  uses the relevant standard's given element names to ensure compatibility with the standard.
                         *
                         *  \see \ref USB_Descriptor_Header_t for the version of this type with non-standard LUFA specific element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  element's purpose clearer.
                         *
                         *  \see \ref USB_StdDescriptor_Device_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  to ensure compatibility with the standard.
                         *
                         *  \see \ref USB_Descriptor_Device_t for the version of this type with non-standard LUFA specific element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  to make each element's purpose clearer.
                         *
                         *  \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  to ensure compatibility with the standard.
                         *
                         *  \see \ref USB_Descriptor_Device_t for the version of this type with non-standard LUFA specific element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  to make each element's purpose clearer.
                         *
                         *  \see \ref USB_StdDescriptor_Interface_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  to ensure compatibility with the standard.
                         *
                         *  \see \ref USB_Descriptor_Interface_t for the version of this type with non-standard LUFA specific element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  function. Read the ECN for more information.
                         *
                         *  \see \ref USB_StdDescriptor_Interface_Association_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *
                         *  \see \ref USB_Descriptor_Interface_Association_t for the version of this type with non-standard LUFA specific
                         *       element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  to make each element's purpose clearer.
                         *
                         *  \see \ref USB_StdDescriptor_Endpoint_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *
                         *  \see \ref USB_Descriptor_Endpoint_t for the version of this type with non-standard LUFA specific
                         *       element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                         *  This structure uses LUFA-specific element names to make each element's purpose clearer.
                         *
                         *  \see \ref USB_StdDescriptor_String_t for the version of this type with standard element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                                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).
                         *
                         *  \see \ref USB_Descriptor_String_t for the version of this type with with non-standard LUFA specific
                         *       element names.
+                        *
+                        *  \note Regardless of CPU architecture, these values should be stored as little endian.
                         */
                        typedef struct
                        {
                                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: */