Update copyrights for 2021.
[pub/lufa.git] / Demos / Device / ClassDriver / MassStorageKeyboard / Descriptors.h
index 50c6186..8b667b1 100644 (file)
@@ -1,25 +1,25 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2021.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
   Copyright 2010  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  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
@@ -33,7 +33,7 @@
  *
  *  Header file for Descriptors.c.
  */
+
 #ifndef _DESCRIPTORS_H_
 #define _DESCRIPTORS_H_
 
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>
-               #include <LUFA/Drivers/USB/Class/MassStorage.h>
-               #include <LUFA/Drivers/USB/Class/HID.h>
+
+               #include "Config/AppConfig.h"
 
        /* Macros: */
-               /** Endpoint number of the Keyboard HID reporting IN endpoint. */
-               #define KEYBOARD_EPNUM               1
-               
-               /** Size in bytes of the Keyboard HID reporting IN and OUT endpoints. */                
+               /** Endpoint address of the Keyboard HID reporting IN endpoint. */
+               #define KEYBOARD_EPADDR              (ENDPOINT_DIR_IN  | 1)
+
+               /** Size in bytes of the Keyboard HID reporting IN endpoint. */
                #define KEYBOARD_EPSIZE              8
 
-               /** Endpoint number of the Mass Storage device-to-host data IN endpoint. */
-               #define MASS_STORAGE_IN_EPNUM        3  
+               /** Endpoint address of the Mass Storage device-to-host data IN endpoint. */
+               #define MASS_STORAGE_IN_EPADDR       (ENDPOINT_DIR_IN  | 3)
 
-               /** Endpoint number of the Mass Storage host-to-device data OUT endpoint. */
-               #define MASS_STORAGE_OUT_EPNUM       4  
+               /** Endpoint address of the Mass Storage host-to-device data OUT endpoint. */
+               #define MASS_STORAGE_OUT_EPADDR      (ENDPOINT_DIR_OUT | 4)
 
                /** Size in bytes of the Mass Storage data endpoints. */
                #define MASS_STORAGE_IO_EPSIZE       64
-               
-       /* Type Defines: */             
+
+       /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
                 *  application code, as the configuration descriptor contains several sub-descriptors which
                 *  vary between devices, and which describe the device's usage to the host.
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
+
+                       // Mass Storage Interface
                        USB_Descriptor_Interface_t            MS_Interface;
                        USB_Descriptor_Endpoint_t             MS_DataInEndpoint;
                        USB_Descriptor_Endpoint_t             MS_DataOutEndpoint;
+
+                       // Generic HID Interface
                        USB_Descriptor_Interface_t            HID_KeyboardInterface;
-                       USB_HID_Descriptor_t                  HID_KeyboardHID;
+                       USB_HID_Descriptor_HID_t              HID_KeyboardHID;
                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                } 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_MassStorage = 0, /**< Mass storage interface descriptor ID */
+                       INTERFACE_ID_Keyboard    = 1, /**< Keyboard 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,
-                                                   void** const DescriptorAddress) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
+                                                   const uint16_t wIndex,
+                                                   const void** const DescriptorAddress)
+                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
 #endif
+