Add new tag for the LUFA-120219-BETA release.
[pub/USBasp.git] / Demos / Host / LowLevel / GenericHIDHost / ConfigDescriptor.h
index 0d78f09..4614893 100644 (file)
@@ -1,69 +1,69 @@
-/*\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, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all 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>\r
-               \r
-               #include "GenericHIDHost.h"\r
-               \r
-       /* Macros: */\r
-               /** Interface Class value for the Human Interface Device class */\r
-               #define HID_CLASS                   0x03\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
-       /* Enums: */\r
-               /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */\r
-               enum GenericHIDHost_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
-                       NoEndpointFound                 = 5, /**< A compatible HID IN endpoint was not found in the device's HID interface */\r
-               };      \r
-\r
-       /* Function Prototypes: */\r
-               uint8_t ProcessConfigurationDescriptor(void);\r
-\r
-               uint8_t DComp_NextHIDInterface(void* CurrentDescriptor);\r
-               uint8_t DComp_NextHIDInterfaceDataEndpoint(void* CurrentDescriptor);\r
-\r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Header file for ConfigDescriptor.c.
+ */
+
+#ifndef _CONFIGDESCRIPTOR_H_
+#define _CONFIGDESCRIPTOR_H_
+
+       /* Includes: */
+               #include <LUFA/Drivers/USB/USB.h>
+
+               #include "GenericHIDHost.h"
+
+       /* Macros: */
+               /** Pipe number for the HID data IN pipe. */
+               #define HID_DATA_IN_PIPE          1
+
+               /** Pipe number for the HID data OUT pipe. */
+               #define HID_DATA_OUT_PIPE         2
+
+       /* Enums: */
+               /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
+               enum GenericHIDHost_GetConfigDescriptorDataCodes_t
+               {
+                       SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
+                       ControlError                    = 1, /**< A control request to the device failed to complete successfully */
+                       DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
+                       InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
+                       NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
+               };
+
+       /* Function Prototypes: */
+               uint8_t ProcessConfigurationDescriptor(void);
+
+               uint8_t DComp_NextHIDInterface(void* CurrentDescriptor);
+               uint8_t DComp_NextHIDInterfaceDataEndpoint(void* CurrentDescriptor);
+
+#endif
+