Get rid of the redundant ATTR_NEVER_INLINE macro which translated to the same as...
[pub/USBasp.git] / Demos / Device / LowLevel / Mouse / Descriptors.h
index 2d9a329..3b637e2 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2013.
 
   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 2013  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
 
   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.
 
   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
   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
 
                #include <avr/pgmspace.h>
 
 
                #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;
+       /* Macros: */
+               /** Endpoint address of the Mouse HID reporting IN endpoint. */
+               #define MOUSE_EPADDR              (ENDPOINT_DIR_IN | 1)
 
 
-               /** Type define for the data type used to store HID report descriptor elements. */
-               typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;
+               /** Size in bytes of the Mouse HID reporting IN endpoint. */
+               #define MOUSE_EPSIZE              8
 
 
+       /* 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.
                /** 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;
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
+
+                       // Mouse HID Interface
                        USB_Descriptor_Interface_t            HID_Interface;
                        USB_Descriptor_Interface_t            HID_Interface;
-                       USB_Descriptor_HID_t                  HID_MouseHID;
-               USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
+                       USB_HID_Descriptor_HID_t              HID_MouseHID;
+                       USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                } USB_Descriptor_Configuration_t;
 
                } USB_Descriptor_Configuration_t;
 
-       /* Macros: */
-               /** Endpoint number of the Mouse HID reporting IN endpoint. */
-               #define MOUSE_EPNUM               1
-
-               /** Size in bytes of the Mouse HID reporting IN endpoint. */
-               #define MOUSE_EPSIZE              8
-
-               /** Descriptor header type value, to indicate a HID class HID descriptor. */
-               #define DTYPE_HID                 0x21
+               /** 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_Mouse = 0, /**< Mouse interface descriptor ID */
+               };
 
 
-               /** Descriptor header type value, to indicate a HID class HID report descriptor. */
-               #define DTYPE_Report              0x22
+               /** 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,
 
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,