Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Device / ClassDriver / KeyboardMouse / Descriptors.h

diff --git a/Demos/Device/ClassDriver/KeyboardMouse/Descriptors.h b/Demos/Device/ClassDriver/KeyboardMouse/Descriptors.h
index e664996..707d76b 100644 (file)
--- a/Demos/Device/ClassDriver/KeyboardMouse/Descriptors.h
+++ b/Demos/Device/ClassDriver/KeyboardMouse/Descriptors.h
@@ -1,22 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   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 2010  Dean Camera (dean [at] fourwalledcubicle [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


@@ -33,7 +32,7 @@
  *
  *  Header file for Descriptors.c.
  */
  *
  *  Header file for Descriptors.c.
  */

- 
+

 #ifndef _DESCRIPTORS_H_
 #define _DESCRIPTORS_H_
 
 #ifndef _DESCRIPTORS_H_
 #define _DESCRIPTORS_H_
 


@@ -41,7 +40,6 @@
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>

-               #include <LUFA/Drivers/USB/Class/HID.h>

 
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
 
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the


@@ -52,13 +50,13 @@
                {
                        USB_Descriptor_Configuration_Header_t Config;
                        USB_Descriptor_Interface_t            HID1_KeyboardInterface;
                {
                        USB_Descriptor_Configuration_Header_t Config;
                        USB_Descriptor_Interface_t            HID1_KeyboardInterface;

-                       USB_HID_Descriptor_t                  HID1_KeyboardHID;
+                       USB_HID_Descriptor_HID_t              HID1_KeyboardHID;

                USB_Descriptor_Endpoint_t             HID1_ReportINEndpoint;
                        USB_Descriptor_Interface_t            HID2_MouseInterface;
                USB_Descriptor_Endpoint_t             HID1_ReportINEndpoint;
                        USB_Descriptor_Interface_t            HID2_MouseInterface;

-                       USB_HID_Descriptor_t                  HID2_MouseHID;
+                       USB_HID_Descriptor_HID_t              HID2_MouseHID;

                USB_Descriptor_Endpoint_t             HID2_ReportINEndpoint;
                } USB_Descriptor_Configuration_t;
                USB_Descriptor_Endpoint_t             HID2_ReportINEndpoint;
                } USB_Descriptor_Configuration_t;

-                                       
+

        /* Macros: */
                /** Endpoint number of the Keyboard HID reporting IN endpoint. */
                #define KEYBOARD_IN_EPNUM         1
        /* Macros: */
                /** Endpoint number of the Keyboard HID reporting IN endpoint. */
                #define KEYBOARD_IN_EPNUM         1


@@ -70,7 +68,10 @@
                #define HID_EPSIZE                8
 
        /* Function Prototypes: */
                #define HID_EPSIZE                8
 
        /* Function Prototypes: */

-               uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
+               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
                                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
 #endif

+