Documentation: Update copyrights to 2019.
[pub/lufa.git] / Projects / RelayBoard / Descriptors.c
index e792aec..803e0d2 100644 (file)
@@ -1,14 +1,14 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2019.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
   Copyright 2010  OBinou (obconseil [at] gmail [dot] com)
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2019  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
@@ -19,7 +19,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
  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  *  process begins.
  */
-USB_Descriptor_Device_t PROGMEM RelayBoard_DeviceDescriptor =
+const USB_Descriptor_Device_t PROGMEM RelayBoard_DeviceDescriptor =
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
 
-       .USBSpecification       = VERSION_BCD(01.10),
-       .Class                  = 0xFF,
-       .SubClass               = 0x00,
-       .Protocol               = 0x00,
+       .USBSpecification       = VERSION_BCD(1,1,0),
+       .Class                  = USB_CSCP_VendorSpecificClass,
+       .SubClass               = USB_CSCP_NoDeviceSubclass,
+       .Protocol               = USB_CSCP_NoDeviceProtocol,
 
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 
        .VendorID               = 0x04B4,
        .ProductID              = 0xFD11,
-       .ReleaseNumber          = VERSION_BCD(02.00),
+       .ReleaseNumber          = VERSION_BCD(2,0,0),
 
-       .ManufacturerStrIndex   = 0x01,
-       .ProductStrIndex        = 0x02,
-       .SerialNumStrIndex      = 0x03,
+       .ManufacturerStrIndex   = STRING_ID_Manufacturer,
+       .ProductStrIndex        = STRING_ID_Product,
+       .SerialNumStrIndex      = STRING_ID_Serial,
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
@@ -70,19 +70,19 @@ USB_Descriptor_Device_t PROGMEM RelayBoard_DeviceDescriptor =
  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  *  a configuration so that the host may correctly communicate with the USB device.
  */
-RelayBoard_USB_Descriptor_Configuration_t PROGMEM RelayBoard_ConfigurationDescriptor =
+const USB_Descriptor_Configuration_t PROGMEM RelayBoard_ConfigurationDescriptor =
 {
        .Config =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 
-                       .TotalConfigurationSize = sizeof(RelayBoard_USB_Descriptor_Configuration_t),
+                       .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
                        .TotalInterfaces        = 1,
 
                        .ConfigurationNumber    = 1,
                        .ConfigurationStrIndex  = NO_DESCRIPTOR,
 
-                       .ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
+                       .ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
 
                        .MaxPowerConsumption    = USB_CONFIG_POWER_MA(500)
                },
@@ -91,12 +91,12 @@ RelayBoard_USB_Descriptor_Configuration_t PROGMEM RelayBoard_ConfigurationDescri
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
-                       .InterfaceNumber        = 0,
+                       .InterfaceNumber        = INTERFACE_ID_RelayBoard,
                        .AlternateSetting       = 0,
 
                        .TotalEndpoints         = 0,
 
-                       .Class                  = 0xFF,
+                       .Class                  = USB_CSCP_VendorSpecificClass,
                        .SubClass               = 0x00,
                        .Protocol               = 0x00,
 
@@ -108,7 +108,7 @@ RelayBoard_USB_Descriptor_Configuration_t PROGMEM RelayBoard_ConfigurationDescri
  *  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.
  */
-USB_Descriptor_String_t PROGMEM RelayBoard_LanguageString =
+const USB_Descriptor_String_t PROGMEM RelayBoard_LanguageString =
 {
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 
@@ -119,33 +119,18 @@ USB_Descriptor_String_t PROGMEM RelayBoard_LanguageString =
  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-USB_Descriptor_String_t PROGMEM RelayBoard_ManufacturerString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(5), .Type = DTYPE_String},
-
-       .UnicodeString          = L"SISPM"
-};
+const USB_Descriptor_String_t PROGMEM RelayBoard_ManufacturerString = USB_STRING_DESCRIPTOR(L"SISPM");
 
 /** 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.
  */
-USB_Descriptor_String_t PROGMEM RelayBoard_ProductString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(10), .Type = DTYPE_String},
-
-       .UnicodeString          = L"RelayBoard"
-};
+const USB_Descriptor_String_t PROGMEM RelayBoard_ProductString = USB_STRING_DESCRIPTOR(L"RelayBoard");
 
 /** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
  *  series of uppercase hexadecimal digits.
  */
-USB_Descriptor_String_t PROGMEM RelayBoard_SerialString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(5), .Type = DTYPE_String},
-
-       .UnicodeString          = L"00001"
-};
+const USB_Descriptor_String_t PROGMEM RelayBoard_SerialString = USB_STRING_DESCRIPTOR(L"00001");
 
 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  *  documentation) by the application code so that the address and size of a requested descriptor can be given
@@ -154,42 +139,42 @@ USB_Descriptor_String_t PROGMEM RelayBoard_SerialString =
  *  USB host.
  */
 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
-                                    const uint8_t wIndex,
-                                    void** const DescriptorAddress)
+                                    const uint16_t wIndex,
+                                    const void** const DescriptorAddress)
 {
        const uint8_t  DescriptorType   = (wValue >> 8);
        const uint8_t  DescriptorNumber = (wValue & 0xFF);
 
-       void*    Address = NULL;
-       uint16_t Size    = NO_DESCRIPTOR;
+       const void* Address = NULL;
+       uint16_t    Size    = NO_DESCRIPTOR;
 
        switch (DescriptorType)
        {
                case DTYPE_Device:
-                       Address = (void*)&RelayBoard_DeviceDescriptor;
+                       Address = &RelayBoard_DeviceDescriptor;
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
                case DTYPE_Configuration:
-                       Address = (void*)&RelayBoard_ConfigurationDescriptor;
-                       Size    = sizeof(RelayBoard_USB_Descriptor_Configuration_t);
+                       Address = &RelayBoard_ConfigurationDescriptor;
+                       Size    = sizeof(USB_Descriptor_Configuration_t);
                        break;
                case DTYPE_String:
                        switch (DescriptorNumber)
                        {
-                               case 0x00:
-                                       Address = (void*)&RelayBoard_LanguageString;
+                               case STRING_ID_Language:
+                                       Address = &RelayBoard_LanguageString;
                                        Size    = pgm_read_byte(&RelayBoard_LanguageString.Header.Size);
                                        break;
-                               case 0x01:
-                                       Address = (void*)&RelayBoard_ManufacturerString;
+                               case STRING_ID_Manufacturer:
+                                       Address = &RelayBoard_ManufacturerString;
                                        Size    = pgm_read_byte(&RelayBoard_ManufacturerString.Header.Size);
                                        break;
-                               case 0x02:
-                                       Address = (void*)&RelayBoard_ProductString;
+                               case STRING_ID_Product:
+                                       Address = &RelayBoard_ProductString;
                                        Size    = pgm_read_byte(&RelayBoard_ProductString.Header.Size);
                                        break;
-                               case 0x03:
-                                       Address = (void*)&RelayBoard_SerialString;
+                               case STRING_ID_Serial:
+                                       Address = &RelayBoard_SerialString;
                                        Size    = pgm_read_byte(&RelayBoard_SerialString.Header.Size);
                                        break;
                        }
@@ -200,3 +185,4 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
        *DescriptorAddress = Address;
        return Size;
 }
+