Update copyrights for 2021.
[pub/lufa.git] / Projects / XPLAINBridge / USARTDescriptors.c
index 1b26541..8ea4eee 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -47,7 +47,7 @@ const USB_Descriptor_Device_t PROGMEM USART_DeviceDescriptor =
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
 
-       .USBSpecification       = VERSION_BCD(01.10),
+       .USBSpecification       = VERSION_BCD(1,1,0),
        .Class                  = CDC_CSCP_CDCClass,
        .SubClass               = CDC_CSCP_NoSpecificSubclass,
        .Protocol               = CDC_CSCP_NoSpecificProtocol,
@@ -56,10 +56,10 @@ const USB_Descriptor_Device_t PROGMEM USART_DeviceDescriptor =
 
        .VendorID               = 0x03EB,
        .ProductID              = 0x204B,
-       .ReleaseNumber          = VERSION_BCD(00.01),
+       .ReleaseNumber          = VERSION_BCD(0,0,1),
 
-       .ManufacturerStrIndex   = 0x01,
-       .ProductStrIndex        = 0x02,
+       .ManufacturerStrIndex   = USART_STRING_ID_Manufacturer,
+       .ProductStrIndex        = USART_STRING_ID_Product,
        .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
@@ -91,7 +91,7 @@ const USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
-                       .InterfaceNumber        = 0,
+                       .InterfaceNumber        = INTERFACE_ID_CDC_CCI,
                        .AlternateSetting       = 0,
 
                        .TotalEndpoints         = 1,
@@ -105,15 +105,15 @@ const USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor
 
        .CDC_Functional_Header =
                {
-                       .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
+                       .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = CDC_DTYPE_CSInterface},
                        .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
 
-                       .CDCSpecification       = VERSION_BCD(01.10),
+                       .CDCSpecification       = VERSION_BCD(1,1,0),
                },
 
        .CDC_Functional_ACM =
                {
-                       .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
+                       .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = CDC_DTYPE_CSInterface},
                        .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
 
                        .Capabilities           = 0x06,
@@ -121,11 +121,11 @@ const USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor
 
        .CDC_Functional_Union =
                {
-                       .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
+                       .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = CDC_DTYPE_CSInterface},
                        .Subtype                = CDC_DSUBTYPE_CSInterface_Union,
 
-                       .MasterInterfaceNumber  = 0,
-                       .SlaveInterfaceNumber   = 1,
+                       .MasterInterfaceNumber  = INTERFACE_ID_CDC_CCI,
+                       .SlaveInterfaceNumber   = INTERFACE_ID_CDC_DCI,
                },
 
        .CDC_NotificationEndpoint =
@@ -142,7 +142,7 @@ const USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
-                       .InterfaceNumber        = 1,
+                       .InterfaceNumber        = INTERFACE_ID_CDC_DCI,
                        .AlternateSetting       = 0,
 
                        .TotalEndpoints         = 2,
@@ -179,40 +179,25 @@ const USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor
  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
  */
-const USB_Descriptor_String_t PROGMEM USART_LanguageString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
-
-       .UnicodeString          = {LANGUAGE_ID_ENG}
-};
+const USB_Descriptor_String_t PROGMEM USART_LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 
 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-const USB_Descriptor_String_t PROGMEM USART_ManufacturerString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
-
-       .UnicodeString          = L"Dean Camera"
-};
+const USB_Descriptor_String_t PROGMEM USART_ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
 
 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-const USB_Descriptor_String_t PROGMEM USART_ProductString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
-
-       .UnicodeString          = L"LUFA XPLAIN Bridge"
-};
+const USB_Descriptor_String_t PROGMEM USART_ProductString = USB_STRING_DESCRIPTOR(L"LUFA XPLAIN Bridge");
 
 /** Descriptor retrieval function for the USART Bridge descriptors. This function is in turn called by the GetDescriptor
  *  callback function in the main source file, to retrieve the device's descriptors when in USART bridge mode.
  */
 uint16_t USART_GetDescriptor(const uint16_t wValue,
-                             const uint8_t wIndex,
+                             const uint16_t wIndex,
                              const void** const DescriptorAddress)
 {
        const uint8_t  DescriptorType   = (wValue >> 8);
@@ -234,15 +219,15 @@ uint16_t USART_GetDescriptor(const uint16_t wValue,
                case DTYPE_String:
                        switch (DescriptorNumber)
                        {
-                               case 0x00:
+                               case USART_STRING_ID_Language:
                                        Address = &USART_LanguageString;
                                        Size    = pgm_read_byte(&USART_LanguageString.Header.Size);
                                        break;
-                               case 0x01:
+                               case USART_STRING_ID_Manufacturer:
                                        Address = &USART_ManufacturerString;
                                        Size    = pgm_read_byte(&USART_ManufacturerString.Header.Size);
                                        break;
-                               case 0x02:
+                               case USART_STRING_ID_Product:
                                        Address = &USART_ProductString;
                                        Size    = pgm_read_byte(&USART_ProductString.Header.Size);
                                        break;