Make board specific and device peripheral specific drivers' file documentation copy...

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

diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.h b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.h
index 74b1c9e..ca4cfec 100644 (file)
--- a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.h
+++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.h
@@ -1,22 +1,22 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)\r
   \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -46,7 +46,7 @@
                #include <LUFA/Drivers/Board/LEDs.h>\r
                #include <LUFA/Drivers/Board/Buttons.h>\r
                #include <LUFA/Drivers/USB/USB.h>\r
-               #include <LUFA/Drivers/USB/Class/Device/HID.h>\r
+               #include <LUFA/Drivers/USB/Class/HID.h>\r
 \r
        /* Macros: */\r
                /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */\r
@@ -60,38 +60,19 @@
 \r
                /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */\r
                #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)\r
-               \r
-       /* Type Defines: */\r
-               /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.\r
-                *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */\r
-                       uint8_t Reserved; /**< Reserved, always set as 0x00 */\r
-                       uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */\r
-               } USB_KeyboardReport_Data_t;\r
-\r
-               /** Type define for the mouse HID report structure, for creating and sending HID reports to the host PC.\r
-                *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t Button; /**< Bit mask of the currently pressed mouse buttons */\r
-                       int8_t  X; /**< Current mouse delta X movement, as a signed 8-bit integer */\r
-                       int8_t  Y; /**< Current mouse delta Y movement, as a signed 8-bit integer */\r
-               } USB_MouseReport_Data_t;\r
                        \r
        /* Function Prototypes: */\r
                void SetupHardware(void);\r
 \r
-               void EVENT_USB_Connect(void);\r
-               void EVENT_USB_Disconnect(void);\r
-               void EVENT_USB_ConfigurationChanged(void);\r
-               void EVENT_USB_UnhandledControlPacket(void);\r
+               void EVENT_USB_Device_Connect(void);\r
+               void EVENT_USB_Device_Disconnect(void);\r
+               void EVENT_USB_Device_ConfigurationChanged(void);\r
+               void EVENT_USB_Device_UnhandledControlRequest(void);\r
+               void EVENT_USB_Device_StartOfFrame(void);\r
 \r
-               uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
-               void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, \r
-                                                                  void* ReportData, uint16_t ReportSize);\r
+               bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
+                                                 const uint8_t ReportType, void* ReportData, uint16_t* ReportSize);\r
+               void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID, \r
+                                                         const void* ReportData, const uint16_t ReportSize);\r
                \r
 #endif\r