aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Core/StdDescriptors.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-03-13 21:25:05 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-03-13 21:25:05 +0000
commit6005a42150bf4d713fd962498bde8b540fef4035 (patch)
treecaebf4a4a487b5544f49123add4d6cc3e9284918 /LUFA/Drivers/USB/Core/StdDescriptors.h
parentf301a4a21f34bea6c41872258a9dab3263f04e2a (diff)
downloadlufa-6005a42150bf4d713fd962498bde8b540fef4035.tar.gz
lufa-6005a42150bf4d713fd962498bde8b540fef4035.tar.bz2
lufa-6005a42150bf4d713fd962498bde8b540fef4035.zip
Add experimental support for the UC3A0, UC3A1 and UC3A3 series AVR32 microcontrollers.
Diffstat (limited to 'LUFA/Drivers/USB/Core/StdDescriptors.h')
-rw-r--r--LUFA/Drivers/USB/Core/StdDescriptors.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h
index 1ad1497ae..908f27bcd 100644
--- a/LUFA/Drivers/USB/Core/StdDescriptors.h
+++ b/LUFA/Drivers/USB/Core/StdDescriptors.h
@@ -76,17 +76,24 @@
*/
#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)))