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

[pub/lufa.git] / Demos / Host / KeyboardHostWithParser / ConfigDescriptor.h

diff --git a/Demos/Host/KeyboardHostWithParser/ConfigDescriptor.h b/Demos/Host/KeyboardHostWithParser/ConfigDescriptor.h
new file mode 100644 (file)
index 0000000..e007a94
--- /dev/null
+++ b/Demos/Host/KeyboardHostWithParser/ConfigDescriptor.h
@@ -0,0 +1,81 @@
+/*\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 ConfigDescriptor.c.\r
+ */\r
+\r
+#ifndef _CONFIGDESCRIPTOR_H_\r
+#define _CONFIGDESCRIPTOR_H_\r
+\r
+       /* Includes: */\r
+               #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality\r
+               #include <LUFA/Drivers/USB/Class/ConfigDescriptor.h>     // Configuration Descriptor Parser\r
+               \r
+               #include "HIDReport.h"\r
+               \r
+       /* Macros: */\r
+               /** Interface Class value for the Human Interface Device class */\r
+               #define KEYBOARD_CLASS                 0x03\r
+\r
+               /** Interface Protocol value for a Boot Protocol Keyboard compliant device */\r
+               #define KEYBOARD_PROTOCOL              0x01\r
+               \r
+               /** Maximum size of a device configuration descriptor which can be processed by the host, in bytes */\r
+               #define MAX_CONFIG_DESCRIPTOR_SIZE     512\r
+\r
+               /** Descriptor header type constant for a HID descriptor */\r
+               #define DTYPE_HID                      0x21\r
+\r
+               /** Descriptor header type constant for a HID report descriptor */\r
+               #define DTYPE_Report                   0x22\r
+       \r
+       /* Enums: */\r
+               enum KeyboardHostWithParser_GetConfigDescriptorDataCodes_t\r
+               {\r
+                       SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */\r
+                       ControlError                    = 1, /**< A control request to the device failed to complete successfully */\r
+                       DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */\r
+                       InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */\r
+                       NoHIDInterfaceFound             = 4, /**< A compatible HID interface was not found in the device's Configuration Descriptor */\r
+                       NoHIDDescriptorFound            = 5, /**< A compatible HID descriptor was not found in the device's HID interface */\r
+                       NoEndpointFound                 = 5, /**< A compatible HID IN endpoint was not found in the device's HID interface */\r
+               };\r
+       \r
+       /* Configuration Descriptor Comparison Functions: */\r
+               DESCRIPTOR_COMPARATOR(NextKeyboardInterface);\r
+               DESCRIPTOR_COMPARATOR(NextInterfaceKeyboardDataEndpoint);\r
+               DESCRIPTOR_COMPARATOR(NextHID);\r
+\r
+       /* Function Prototypes: */\r
+               uint8_t ProcessConfigurationDescriptor(void);   \r
+\r
+#endif\r