Copy existing Host mode demos to new ClassDriver and LowLevel subfolders.

[pub/lufa.git] / Demos / Host / ClassDriver / GenericHIDHost / GenericHIDHost.h

diff --git a/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.h b/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.h
new file mode 100644 (file)
index 0000000..7e2f8b8
--- /dev/null
+++ b/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.h
@@ -0,0 +1,97 @@
+/*\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 MouseHost.c.\r
+ */\r
+\r
+#ifndef _GENERICHID_HOST_H_\r
+#define _GENERICHID_HOST_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <avr/wdt.h>\r
+               #include <avr/pgmspace.h>\r
+               #include <avr/interrupt.h>\r
+               #include <avr/power.h>\r
+               #include <stdio.h>\r
+\r
+               #include <LUFA/Version.h>                                // Library Version Information\r
+               #include <LUFA/Drivers/Misc/TerminalCodes.h>             // ANSI Terminal Escape Codes\r
+               #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality\r
+               #include <LUFA/Drivers/Peripheral/SerialStream.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 HID data IN pipe */\r
+               #define HID_DATA_IN_PIPE                 1\r
+               \r
+               /** Pipe number for the HID data OUT pipe */\r
+               #define HID_DATA_OUT_PIPE                2\r
+\r
+               /** HID Class specific request to send a HID report to the device. */\r
+               #define REQ_SetReport                    0x09\r
+               \r
+               /** HID Report type specifier, for output reports to a device */\r
+               #define HID_REPORTTYPE_OUTPUT            0x02\r
+               \r
+               /** HID Report type specifier, for feature reports to a device */\r
+               #define HID_REPORTTYPE_FEATURE           0x03\r
+\r
+       /* Task Definitions: */\r
+               TASK(USB_HID_Host);\r
+\r
+       /* Enums: */\r
+               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
+               enum GenricHIDHost_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
+       /* Function Prototypes: */\r
+               void EVENT_USB_HostError(const uint8_t ErrorCode);\r
+               void EVENT_USB_DeviceAttached(void);\r
+               void EVENT_USB_DeviceUnattached(void);\r
+               void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
+               void EVENT_USB_DeviceEnumerationComplete(void);\r
+\r
+               void UpdateStatus(uint8_t CurrentStatus);\r
+               void ReadNextReport(void);\r
+               void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength);\r
+               \r
+#endif\r