Use new VERSION_BCD() macro with explicit int arguments to fix edge cases with the previous floating point macro version.

This commit is contained in:
Dean Camera 2013-11-21 19:19:45 +01:00
parent 52c69331ec
commit e3cb0f48ef
51 changed files with 157 additions and 160 deletions

View file

@ -46,7 +46,7 @@ const USB_Descriptor_Device_t DeviceDescriptor =
{
.Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
.USBSpecification = VERSION_BCD(02.00),
.USBSpecification = VERSION_BCD(2,0,0),
.Class = USB_CSCP_NoDeviceClass,
.SubClass = USB_CSCP_NoDeviceSubclass,
.Protocol = USB_CSCP_NoDeviceProtocol,
@ -55,7 +55,7 @@ const USB_Descriptor_Device_t DeviceDescriptor =
.VendorID = 0x0000,
.ProductID = 0x0000,
.ReleaseNumber = VERSION_BCD(00.02),
.ReleaseNumber = VERSION_BCD(0,0,2),
.ManufacturerStrIndex = 0x01,
.ProductStrIndex = 0x02,

View file

@ -11,7 +11,9 @@
* areas relevant to making older projects compatible with the API changes of each new release.
*
* \section Sec_MigrationXXXXXX Migrating from 130901 to XXXXXX
* No migration information.
* <b>USB Core</b>
* - The \c VERSION_BCD() macro has changed from accepting one floating point parameter to taking three distinct major/minor/revision integer parameters, as
* some edge cases caused incorrect parsing of the input float into the final integer BCD encoded value.
*
* \section Sec_Migration130901 Migrating from 130303 to 130901
* <b>Non-USB Library Components</b>

View file

@ -85,17 +85,20 @@
*/
#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.
/** Macro to encode a given major/minor/revision version number into Binary Coded 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.
* \param[in] Major Major version number to encode.
* \param[in] Minor Minor version number to encode.
* \param[in] Revision Revision version number to encode.
*/
#define VERSION_BCD(x) CPU_TO_LE16((VERSION_TENS(x) << 12) | (VERSION_ONES(x) << 8) | \
(VERSION_TENTHS(x) << 4) | (VERSION_HUNDREDTHS(x) << 0) )
#define VERSION_BCD(Major, Minor, Revision) \
CPU_TO_LE16( ((Major & 0xFF) << 8) | \
((Minor & 0x0F) << 4) | \
(Revision & 0x0F) )
/** 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.
@ -736,14 +739,6 @@
*/
} ATTR_PACKED USB_StdDescriptor_String_t;
/* Private Interface - For use in library only: */
#if !defined(__DOXYGEN__)
/* Macros: */
#define VERSION_TENS(x) (int)((int)(x) / 10)
#define VERSION_ONES(x) (int)((int)(x) % 10)
#define VERSION_TENTHS(x) (int)((x - (int)x) * 10)
#define VERSION_HUNDREDTHS(x) (int)((x * 100) - ((int)(x * 10) * 10))
#endif
/* Disable C linkage for C++ Compilers: */
#if defined(__cplusplus)