X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/f670bdeff83ee519b67c661cbe794d787c2a5403..c029d72b9497ebf554c9d05ec58d48d7534b8a2f:/LUFA/Drivers/USB/Core/StdDescriptors.h

diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h
index 7840bcb8e..e3d925502 100644
--- a/LUFA/Drivers/USB/Core/StdDescriptors.h
+++ b/LUFA/Drivers/USB/Core/StdDescriptors.h
@@ -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) | \
@@ -101,7 +104,7 @@
 			/** 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 */
 			//@{
@@ -251,6 +254,8 @@
 			 *  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
 			{
@@ -266,6 +271,8 @@
 			 *  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
 			{
@@ -281,6 +288,8 @@
 			 *  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
 			{
@@ -330,6 +339,8 @@
 			 *  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
 			{
@@ -378,6 +389,8 @@
 			 *  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
 			{
@@ -407,6 +420,8 @@
 			 *  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
 			{
@@ -435,6 +450,8 @@
 			 *  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
 			{
@@ -461,6 +478,8 @@
 			 *  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
 			{
@@ -495,6 +514,8 @@
 			 *  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
 			{
@@ -525,6 +546,8 @@
 			 *
 			 *  \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
 			{
@@ -548,6 +571,8 @@
 			 *  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
 			{
@@ -574,6 +599,8 @@
 			 *
 			 *  \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
 			{
@@ -607,6 +634,8 @@
 			 *  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
 			{
@@ -642,6 +671,8 @@
 			 *
 			 *  \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
 			{