Seperated out OTG, Device and Host mode demos into seperate folders for clarity....

[pub/lufa.git] / Demos / Device / KeyboardMouse / Descriptors.h

diff --git a/Demos/Device/KeyboardMouse/Descriptors.h b/Demos/Device/KeyboardMouse/Descriptors.h
new file mode 100644 (file)
index 0000000..5949542
--- /dev/null
+++ b/Demos/Device/KeyboardMouse/Descriptors.h
@@ -0,0 +1,104 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\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
+  \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
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Header file for Descriptors.c.\r
+ */\r
+ \r
+#ifndef _DESCRIPTORS_H_\r
+#define _DESCRIPTORS_H_\r
+\r
+       /* Includes: */\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+\r
+               #include <avr/pgmspace.h>\r
+\r
+       /* Type Defines: */\r
+               /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID\r
+                *  specification for details on the structure elements.\r
+                */\r
+               typedef struct\r
+               {\r
+                       USB_Descriptor_Header_t               Header;\r
+                               \r
+                       uint16_t                              HIDSpec;\r
+                       uint8_t                               CountryCode;\r
+               \r
+                       uint8_t                               TotalHIDReports;\r
+\r
+                       uint8_t                               HIDReportType;\r
+                       uint16_t                              HIDReportLength;\r
+               } USB_Descriptor_HID_t;\r
+\r
+               /** Type define for the data type used to store HID report descriptor elements. */\r
+               typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;\r
+\r
+               /** Type define for the device configuration descriptor structure. This must be defined in the\r
+                *  application code, as the configuration descriptor contains several sub-descriptors which\r
+                *  vary between devices, and which describe the device's usage to the host.\r
+                */\r
+               typedef struct\r
+               {\r
+                       USB_Descriptor_Configuration_Header_t Config;\r
+                       USB_Descriptor_Interface_t            KeyboardInterface;\r
+                       USB_Descriptor_HID_t                  KeyboardHID;\r
+               USB_Descriptor_Endpoint_t             KeyboardInEndpoint;\r
+               USB_Descriptor_Endpoint_t             KeyboardOutEndpoint;\r
+                       USB_Descriptor_Interface_t            MouseInterface;\r
+                       USB_Descriptor_HID_t                  MouseHID;\r
+               USB_Descriptor_Endpoint_t             MouseInEndpoint;\r
+               } USB_Descriptor_Configuration_t;\r
+                                       \r
+       /* Macros: */\r
+               /** Endpoint number of the Keyboard HID reporting IN endpoint. */\r
+               #define KEYBOARD_IN_EPNUM         1\r
+\r
+               /** Endpoint number of the Keyboard HID reporting OUT endpoint. */\r
+               #define KEYBOARD_OUT_EPNUM        2\r
+\r
+               /** Endpoint number of the Mouse HID reporting IN endpoint. */\r
+               #define MOUSE_IN_EPNUM            3\r
+\r
+               /** Size in bytes of each of the HID reporting IN and OUT endpoints. */\r
+               #define HID_EPSIZE                8\r
+\r
+               /** Descriptor header type value, to indicate a HID class HID descriptor. */\r
+               #define DTYPE_HID                 0x21\r
+               \r
+               /** Descriptor header type value, to indicate a HID class HID report descriptor. */\r
+               #define DTYPE_Report              0x22\r
+\r
+       /* Function Prototypes: */\r
+               uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
+\r
+#endif\r