Moved all source to the trunk directory.
[pub/lufa.git] / Demos / KeyboardHostViaInt / KeyboardHostViaInt.h
diff --git a/Demos/KeyboardHostViaInt/KeyboardHostViaInt.h b/Demos/KeyboardHostViaInt/KeyboardHostViaInt.h
new file mode 100644 (file)
index 0000000..22848ee
--- /dev/null
@@ -0,0 +1,95 @@
+/*\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
+\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 KeyboardHostViaInt.c.\r
+ */\r
\r
+#ifndef _KEYBOARD_HOST_VIA_INT_H_\r
+#define _KEYBOARD_HOST_VIA_INT_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <avr/pgmspace.h>\r
+               #include <avr/interrupt.h>\r
+               #include <avr/wdt.h>\r
+               #include <stdio.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/Misc/TerminalCodes.h>             // ANSI Terminal Escape Codes\r
+               #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality\r
+               #include <LUFA/Drivers/AT90USBXXX/Serial_Stream.h>       // Serial stream driver\r
+               #include <LUFA/Drivers/Board/LEDs.h>                     // LEDs driver\r
+               #include <LUFA/Scheduler/Scheduler.h>                    // Simple scheduler for task management\r
+               \r
+               #include "ConfigDescriptor.h"\r
+               \r
+       /* Macros: */\r
+               /** Pipe number for the keyboard data IN pipe */\r
+               #define KEYBOARD_DATAPIPE              1\r
+\r
+               /** HID Class Specific request to set the report protocol mode */\r
+               #define REQ_SetProtocol             0x0B\r
+\r
+       /* Type Defines: */\r
+               /** Type define for a standard Boot Protocol Keyboard report */\r
+               typedef struct\r
+               {\r
+                       uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (such as Shift, Control, etc.) */\r
+                       uint8_t RESERVED; /**< Reserved for OEM use, always set to 0 */\r
+                       uint8_t KeyCode; /**< Key code of the currently pressed key */\r
+               } USB_KeyboardReport_Data_t;\r
+\r
+               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
+               enum KeyboardHostViaInt_StatusCodes_t\r
+               {\r
+                       Status_USBNotReady      = 0, /**< USB is not ready (disconnected from a USB device) */\r
+                       Status_USBEnumerating   = 1, /**< USB interface is enumerating */\r
+                       Status_USBReady         = 2, /**< USB interface is connected and ready */\r
+                       Status_EnumerationError = 3, /**< Software error while enumerating the attached USB device */\r
+                       Status_HardwareError    = 4, /**< Hardware error while enumerating the attached USB device */\r
+               };\r
+               \r
+       /* Task Definitions: */\r
+               TASK(USB_Keyboard_Host);\r
+\r
+       /* Event Handlers: */\r
+               HANDLES_EVENT(USB_DeviceAttached);\r
+               HANDLES_EVENT(USB_DeviceUnattached);\r
+               HANDLES_EVENT(USB_DeviceEnumerationComplete);\r
+               HANDLES_EVENT(USB_HostError);\r
+               HANDLES_EVENT(USB_DeviceEnumerationFailed);\r
+\r
+       /* Function Prototypes: */\r
+               void UpdateStatus(uint8_t CurrentStatus);\r
+               \r
+#endif\r