projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update Studio Integration DLL, to include package logging.
[pub/USBasp.git] / Demos / Device / LowLevel / KeyboardMouse / Descriptors.h
diff --git a/Demos/Device/LowLevel/KeyboardMouse/Descriptors.h b/Demos/Device/LowLevel/KeyboardMouse/Descriptors.h
index f23ef36..3eb9b1f 100644 (file)
--- a/Demos/Device/LowLevel/KeyboardMouse/Descriptors.h
+++ b/Demos/Device/LowLevel/KeyboardMouse/Descriptors.h
@@ -1,25 +1,25 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2015.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2015  Dean Camera (dean [at] fourwalledcubicle [dot] com)
   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
-  
-  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
   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
   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.
 
   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
   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.
  */
  *
  *  Header file for Descriptors.c.
  */
- 
+
 #ifndef _DESCRIPTORS_H_
 #define _DESCRIPTORS_H_
 
 #ifndef _DESCRIPTORS_H_
 #define _DESCRIPTORS_H_
 
@@ -43,25 +43,6 @@
                #include <avr/pgmspace.h>
 
        /* Type Defines: */
                #include <avr/pgmspace.h>
 
        /* Type Defines: */
-               /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
-                *  specification for details on the structure elements.
-                */
-               typedef struct
-               {
-                       USB_Descriptor_Header_t               Header;
-                               
-                       uint16_t                              HIDSpec;
-                       uint8_t                               CountryCode;
-               
-                       uint8_t                               TotalReportDescriptors;
-
-                       uint8_t                               HIDReportType;
-                       uint16_t                              HIDReportLength;
-               } USB_Descriptor_HID_t;
-
-               /** Type define for the data type used to store HID report descriptor elements. */
-               typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;
-
                /** 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.
                /** 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.
@@ -69,36 +50,58 @@
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
+
+                       // Keyboard HID Interface
                        USB_Descriptor_Interface_t            HID1_KeyboardInterface;
                        USB_Descriptor_Interface_t            HID1_KeyboardInterface;
-                       USB_Descriptor_HID_t                  HID1_KeyboardHID;
-               USB_Descriptor_Endpoint_t             HID1_ReportINEndpoint;
-               USB_Descriptor_Endpoint_t             HID1_ReportOUTEndpoint;
+                       USB_HID_Descriptor_HID_t              HID1_KeyboardHID;
+                       USB_Descriptor_Endpoint_t             HID1_ReportINEndpoint;
+                       USB_Descriptor_Endpoint_t             HID1_ReportOUTEndpoint;
+
+                       // Mouse HID Interface
                        USB_Descriptor_Interface_t            HID2_MouseInterface;
                        USB_Descriptor_Interface_t            HID2_MouseInterface;
-                       USB_Descriptor_HID_t                  HID2_MouseHID;
-               USB_Descriptor_Endpoint_t             HID2_ReportINEndpoint;
+                       USB_HID_Descriptor_HID_t              HID2_MouseHID;
+                       USB_Descriptor_Endpoint_t             HID2_ReportINEndpoint;
                } USB_Descriptor_Configuration_t;
                } 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: */
        /* 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 Keyboard HID reporting OUT endpoint. */
-               #define KEYBOARD_OUT_EPNUM        2
+               /** Endpoint address of the Keyboard HID reporting OUT endpoint. */
+               #define KEYBOARD_OUT_EPADDR       (ENDPOINT_DIR_OUT | 2)
 
 
-               /** 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. */
                #define HID_EPSIZE                8
 
 
                /** Size in bytes of each of the HID reporting IN and OUT endpoints. */
                #define HID_EPSIZE                8
 
-               /** Descriptor header type value, to indicate a HID class HID descriptor. */
-               #define DTYPE_HID                 0x21
-               
-               /** Descriptor header type value, to indicate a HID class HID report descriptor. */
-               #define DTYPE_Report              0x22
-
        /* Function Prototypes: */
        /* 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);
+               uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                                   const uint8_t wIndex,
+                                                   const void** const DescriptorAddress)
+                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
 #endif
 
 #endif
+
USB isp AVR programmer