Moved all source to the trunk directory.
[pub/lufa.git] / Demos / KeyboardMouse / KeyboardMouse.h
diff --git a/Demos/KeyboardMouse/KeyboardMouse.h b/Demos/KeyboardMouse/KeyboardMouse.h
new file mode 100644 (file)
index 0000000..f5c1d4e
--- /dev/null
@@ -0,0 +1,114 @@
+/*\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
+#ifndef _KEYBOARD_MOUSE_H_\r
+#define _KEYBOARD_MOUSE_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <avr/wdt.h>\r
+               #include <stdbool.h>\r
+               #include <string.h>\r
+\r
+               #include "Descriptors.h"\r
+\r
+               #include <LUFA/Version.h>                    // Library Version Information\r
+               #include <LUFA/Common/ButtLoadTag.h>         // PROGMEM tags readable by the ButtLoad project\r
+               #include <LUFA/Drivers/USB/USB.h>            // USB Functionality\r
+               #include <LUFA/Drivers/Board/Joystick.h>     // Joystick driver\r
+               #include <LUFA/Drivers/Board/LEDs.h>         // LEDs driver\r
+               #include <LUFA/Drivers/Board/HWB.h>          // Hardware Button driver\r
+               #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management\r
+               \r
+       /* Task Definitions: */\r
+               TASK(USB_Keyboard);\r
+               TASK(USB_Mouse);\r
+\r
+       /* Enums: */\r
+               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
+               enum KeyboardMouse_StatusCodes_t\r
+               {\r
+                       Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */\r
+                       Status_USBEnumerating = 1, /**< USB interface is enumerating */\r
+                       Status_USBReady       = 2, /**< USB interface is connected and ready */\r
+               };\r
+               \r
+       /* Macros: */\r
+               /** HID Class specific request to get the next HID report from the device. */\r
+               #define REQ_GetReport      0x01\r
+\r
+               /** HID Class specific request to send the next HID report to the device. */\r
+               #define REQ_SetReport      0x09\r
+\r
+               /** HID Class specific request to get the current HID protocol in use, either report or boot. */\r
+               #define REQ_GetProtocol    0x03\r
+\r
+               /** HID Class specific request to set the current HID protocol in use, either report or boot. */\r
+               #define REQ_SetProtocol    0x0B\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
+       /* Event Handlers: */\r
+               /** Indicates that this module will catch the USB_Connect event when thrown by the library. */\r
+               HANDLES_EVENT(USB_Connect);\r
+\r
+               /** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */\r
+               HANDLES_EVENT(USB_Disconnect);\r
+\r
+               /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */\r
+               HANDLES_EVENT(USB_ConfigurationChanged);\r
+\r
+               /** Indicates that this module will catch the USB_UnhandledControlPacket event when thrown by the library. */\r
+               HANDLES_EVENT(USB_UnhandledControlPacket);\r
+\r
+       /* Function Prototypes: */\r
+               void UpdateStatus(uint8_t CurrentStatus);\r
+               \r
+#endif\r