Fix warning about possible string truncation in the TempDataLogger project.
[pub/USBasp.git] / Demos / Device / ClassDriver / KeyboardMouse / Descriptors.h
index 5b6a606..d7c874f 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2018.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2018  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
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
+
+                       // Keyboard HID Interface
                        USB_Descriptor_Interface_t            HID1_KeyboardInterface;
                        USB_HID_Descriptor_HID_t              HID1_KeyboardHID;
-               USB_Descriptor_Endpoint_t             HID1_ReportINEndpoint;
+                       USB_Descriptor_Endpoint_t             HID1_ReportINEndpoint;
+
+                       // Mouse HID Interface
                        USB_Descriptor_Interface_t            HID2_MouseInterface;
                        USB_HID_Descriptor_HID_t              HID2_MouseHID;
-               USB_Descriptor_Endpoint_t             HID2_ReportINEndpoint;
+                       USB_Descriptor_Endpoint_t             HID2_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_Keyboard = 0, /**< Keyboard interface descriptor ID */
+                       INTERFACE_ID_Mouse    = 1, /**< Mouse 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 */
+               };
+
        /* Macros: */
-               /** Endpoint number of the Keyboard HID reporting IN endpoint. */
-               #define KEYBOARD_IN_EPNUM         1
+               /** Endpoint address of the Keyboard HID reporting IN endpoint. */
+               #define KEYBOARD_IN_EPADDR        (ENDPOINT_DIR_IN | 1)
 
-               /** Endpoint number of the Mouse HID reporting IN endpoint. */
-               #define MOUSE_IN_EPNUM            3
+               /** Endpoint address of the Mouse HID reporting IN endpoint. */
+               #define MOUSE_IN_EPADDR           (ENDPOINT_DIR_IN | 3)
 
-               /** Size in bytes of each of the HID reporting IN and OUT endpoints. */
+               /** Size in bytes of each of the HID reporting IN endpoints. */
                #define HID_EPSIZE                8
 
        /* 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);