Add symbolic names for USB Device String Descriptors within the demos, applications and bootloaders.

2 files changed, 31 insertions, 19 deletions

diff --git a/Projects/AVRISP-MKII/AVRISPDescriptors.c b/Projects/AVRISP-MKII/AVRISPDescriptors.c
index 8f4ef5470..61c920601 100644
--- a/Projects/AVRISP-MKII/AVRISPDescriptors.c
+++ b/Projects/AVRISP-MKII/AVRISPDescriptors.c
@@ -43,7 +43,7 @@
 
 	/** Current AVRISP data IN endpoint address. */
 	uint8_t AVRISP_CurrDataINEndpointAddress;
-	
+
 	/** Saved AVRISP data IN endpoint address in EEPROM. */
 	uint8_t AVRISP_CurrDataINEndpointAddress_EEPROM EEMEM;
 #endif
@@ -68,9 +68,9 @@ const USB_Descriptor_Device_t PROGMEM AVRISP_DeviceDescriptor =
 	.ProductID              = 0x2104,
 	.ReleaseNumber          = VERSION_BCD(02.00),
 
-	.ManufacturerStrIndex   = 0x01,
-	.ProductStrIndex        = 0x02,
-	.SerialNumStrIndex      = 0x03,
+	.ManufacturerStrIndex   = STRING_ID_Manufacturer,
+	.ProductStrIndex        = STRING_ID_Product,
+	.SerialNumStrIndex      = STRING_ID_Serial,
 
 	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
@@ -177,7 +177,7 @@ const USB_Descriptor_String_t PROGMEM AVRISP_ProductString =
 USB_Descriptor_String_t AVRISP_SerialString =
 {
 	.Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
-	
+
 	.UnicodeString          = L"000200012345\0" // Note: Real AVRISP-MKII has the embedded NUL byte, bug in firmware?
 };
 
@@ -199,7 +199,7 @@ uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
 	uint16_t    Size    = NO_DESCRIPTOR;
 
 	*DescriptorMemorySpace = MEMSPACE_FLASH;
-	
+
 	switch (DescriptorType)
 	{
 		case DTYPE_Device:
@@ -219,25 +219,25 @@ uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
 		case DTYPE_String:
 			switch (DescriptorNumber)
 			{
-				case 0x00:
+				case STRING_ID_Language:
 					Address = &AVRISP_LanguageString;
 					Size    = pgm_read_byte(&AVRISP_LanguageString.Header.Size);
 					break;
-				case 0x01:
+				case STRING_ID_Manufacturer:
 					Address = &AVRISP_ManufacturerString;
 					Size    = pgm_read_byte(&AVRISP_ManufacturerString.Header.Size);
 					break;
-				case 0x02:
+				case STRING_ID_Product:
 					Address = &AVRISP_ProductString;
 					Size    = pgm_read_byte(&AVRISP_ProductString.Header.Size);
 					break;
-				case 0x03:
+				case STRING_ID_Serial:
 					Address = &AVRISP_SerialString;
 					Size    = AVRISP_SerialString.Header.Size;
-					
+
 					/* Update serial number to have a different serial based on the current endpoint address */
 					((uint16_t*)&AVRISP_SerialString.UnicodeString)[6] = cpu_to_le16('0' + (AVRISP_DATA_IN_EPADDR & ENDPOINT_EPNUM_MASK));
-					
+
 					*DescriptorMemorySpace = MEMSPACE_RAM;
 					break;
 			}
@@ -259,7 +259,7 @@ uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
  *  change.
  */
 void CheckExternalReset(void)
-{	
+{
 	/* If an external reset occurred, we need to change compatibility mode */
 	AVRISP_NeedCompatibilitySwitch = (MCUSR == (1 << EXTRF));
 
@@ -277,7 +277,7 @@ void UpdateCurrentCompatibilityMode(void)
 {
 	/* Load the current IN endpoint address stored in EEPROM */
 	AVRISP_CurrDataINEndpointAddress = eeprom_read_byte(&AVRISP_CurrDataINEndpointAddress_EEPROM);
-	
+
 	/* Check if we need to switch compatibility modes */
 	if (AVRISP_NeedCompatibilitySwitch)
 	{
@@ -303,7 +303,7 @@ void UpdateCurrentCompatibilityMode(void)
 			{
 				LEDs_ToggleLEDs(LEDS_ALL_LEDS);
 				Delay_MS(100);
-			}		
+			}
 			break;
 		case AVRISP_DATA_IN_EPADDR_LIBUSB:
 			/* Five flashes for libUSB compatibility mode */
@@ -314,7 +314,7 @@ void UpdateCurrentCompatibilityMode(void)
 			}
 			break;
 	}
-	
+
 	Delay_MS(500);
 }
 #endif
diff --git a/Projects/AVRISP-MKII/AVRISPDescriptors.h b/Projects/AVRISP-MKII/AVRISPDescriptors.h
index 3c874804a..d372350a1 100644
--- a/Projects/AVRISP-MKII/AVRISPDescriptors.h
+++ b/Projects/AVRISP-MKII/AVRISPDescriptors.h
@@ -41,7 +41,7 @@
 
 		#include <LUFA/Drivers/USB/USB.h>
 		#include <LUFA/Drivers/Board/LEDs.h>
-		
+
 		#include "Config/AppConfig.h"
 
 	/* Preprocessor Checks: */
@@ -67,7 +67,7 @@
 			/** Endpoint address of the AVRISP data IN endpoint. */
 			#define AVRISP_DATA_IN_EPADDR      AVRISP_DATA_IN_EPADDR_JUNGO
 		#endif
-		
+
 		/** Size in bytes of the AVRISP data endpoint. */
 		#define AVRISP_DATA_EPSIZE             64
 
@@ -86,11 +86,23 @@
 			USB_Descriptor_Endpoint_t                AVRISP_DataOutEndpoint;
 		} AVRISP_USB_Descriptor_Configuration_t;
 
+		/** Enum for the device string descriptor IDs within the device. Each string descriptor should
+		 *  have a unique ID index associated with it, which can be used to refer to the string from
+		 *  other descriptors.
+		 */
+		enum StringDescriptors_t
+		{
+		    STRING_ID_Language      = 0, /**< Supported Languages string descriptor ID (must be zero) */
+		    STRING_ID_Manufacturer  = 1, /**< Manufacturer string ID */
+		    STRING_ID_Product       = 2, /**< Product string ID */
+		    STRING_ID_Serial        = 3, /**< Serial number string ID */
+		};
+
 	/* External Variables: */
 		#if defined(RESET_TOGGLES_LIBUSB_COMPAT)
 			extern uint8_t AVRISP_CurrDataINEndpointAddress;
 		#endif
-		
+
 	/* Function Prototypes: */
 		uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
 		                              const uint8_t wIndex,