Minor documentation improvements.

[pub/lufa.git] / Demos / Device / LowLevel / Keyboard / Descriptors.h

diff --git a/Demos/Device/LowLevel/Keyboard/Descriptors.h b/Demos/Device/LowLevel/Keyboard/Descriptors.h
index d4d7a98..3c0ea17 100644 (file)
--- a/Demos/Device/LowLevel/Keyboard/Descriptors.h
+++ b/Demos/Device/LowLevel/Keyboard/Descriptors.h
@@ -1,22 +1,22 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+

   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 2012  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.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -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,30 +50,29 @@
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;

+
+                       // Keyboard HID Interface

                        USB_Descriptor_Interface_t            HID_Interface;
                        USB_Descriptor_Interface_t            HID_Interface;

-                       USB_Descriptor_HID_t                  HID_KeyboardHID;
+                       USB_HID_Descriptor_HID_t              HID_KeyboardHID;

                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                USB_Descriptor_Endpoint_t             HID_ReportOUTEndpoint;
                } USB_Descriptor_Configuration_t;
                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                USB_Descriptor_Endpoint_t             HID_ReportOUTEndpoint;
                } USB_Descriptor_Configuration_t;

-                                       
+

        /* Macros: */
                /** Endpoint number of the Keyboard HID reporting IN endpoint. */
        /* Macros: */
                /** Endpoint number of the Keyboard HID reporting IN endpoint. */

-               #define KEYBOARD_EPNUM               1
+               #define KEYBOARD_IN_EPNUM         1

 
                /** Endpoint number of the Keyboard HID reporting OUT endpoint. */
 
                /** Endpoint number of the Keyboard HID reporting OUT endpoint. */

-               #define KEYBOARD_LEDS_EPNUM          2
-               
-               /** Size in bytes of the Keyboard HID reporting IN and OUT endpoints. */                
-               #define KEYBOARD_EPSIZE              8
+               #define KEYBOARD_OUT_EPNUM        2

 
 

-               /** 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
+               /** Size in bytes of the Keyboard HID reporting IN and OUT endpoints. */
+               #define KEYBOARD_EPSIZE           8

 
        /* 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

+