Add script reading bootloader flags
[pub/lufa.git] / Bootloaders / DFU / Descriptors.h
index 14203c3..1b81432 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  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
@@ -39,6 +39,8 @@
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>
 
+               #include "Config/AppConfig.h"
+
        /* Macros: */
                /** Descriptor type value for a DFU class functional descriptor. */
                #define DTYPE_DFUFunctional               0x21
                        #define AVR_SIGNATURE_1               0x1E
                        #define AVR_SIGNATURE_2               0x96
                        #define AVR_SIGNATURE_3               0x82
-               #elif defined(__AVR_ATmega32U6__)
-                       #define PRODUCT_ID_CODE               0x2FFB
-                       #define AVR_SIGNATURE_1               0x1E
-                       #define AVR_SIGNATURE_2               0x95
-                       #define AVR_SIGNATURE_3               0x88
                #elif defined(__AVR_ATmega32U4__)
                        #define PRODUCT_ID_CODE               0x2FF4
                        #define AVR_SIGNATURE_1               0x1E
                        #define AVR_SIGNATURE_2               0x94
                        #define AVR_SIGNATURE_3               0x82
                #elif defined(__AVR_ATmega8U2__)
-                       #define PRODUCT_ID_CODE               0x2FF7
+                       #define PRODUCT_ID_CODE               0x2FEE
                        #define AVR_SIGNATURE_1               0x1E
                        #define AVR_SIGNATURE_2               0x93
-                       #define AVR_SIGNATURE_3               0x82
+                       #define AVR_SIGNATURE_3               0x89
                #elif defined(__AVR_AT90USB82__)
-                       #define PRODUCT_ID_CODE               0x2FEE
+                       #define PRODUCT_ID_CODE               0x2FF7
                        #define AVR_SIGNATURE_1               0x1E
                        #define AVR_SIGNATURE_2               0x93
-                       #define AVR_SIGNATURE_3               0x89
+                       #define AVR_SIGNATURE_3               0x82
                #else
                        #error The selected AVR part is not currently supported by this bootloader.
                #endif
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
+
+                       // DFU Interface
                        USB_Descriptor_Interface_t            DFU_Interface;
                        USB_Descriptor_DFU_Functional_t       DFU_Functional;
                } USB_Descriptor_Configuration_t;
 
+               /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
+                *  should have a unique ID index associated with it, which can be used to refer to the
+                *  interface from other descriptors.
+                */
+               enum InterfaceDescriptors_t
+               {
+                       INTERFACE_ID_DFU = 0, /**< DFU interface descriptor ID */
+               };
+
+               /** 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 */
+               };
+
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
-                                                   const uint8_t wIndex,
+                                                   const uint16_t wIndex,
                                                    const void** const DescriptorAddress)
                                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);