X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b7049da11b6fe3c37b23d8f7dddfff08ba14f449..ecf7c18cf24a10df8d843c8f7c195d803e073330:/LUFA/Drivers/USB/Class/Host/HID.h

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index 56bf04f7e..48cdcb03b 100644
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassHID
  *  @defgroup Group_USBClassHIDHost HID Class Host Mode Driver
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Host/HID.c
+ *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.
  *
@@ -43,6 +47,7 @@
 	/* Includes: */
 		#include "../../USB.h"
 		#include "../Common/HID.h"
+		#include "HIDParser.h"
 		
 	/* Enable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
@@ -50,8 +55,77 @@
 		#endif
 
 	/* Public Interface - May be used in end-application: */
+		/* Type Defines: */
+			/** Class state structure. An instance of this structure should be made within the user application,
+			 *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This
+			 *  stores each HID interface's configuration and state information.
+			 */
+			typedef struct
+			{
+				const struct
+				{
+					uint8_t  DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe */
+					uint8_t  DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */
+
+					uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific
+					                                *   boot subclass protocol is required (e.g. keyboard, mouse), or
+					                                *   leave as 0 to match against the first HID interface found
+					                                */
+				} Config; /**< Config data for the USB class interface within the device. All elements in this section
+				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
+				           */
+				struct
+				{
+					bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid
+					              *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
+					              *   Configured state
+					              */
+					uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */
+
+					uint16_t DataINPipeSize; /**< Size in bytes of the HID interface's IN data pipe */
+					uint16_t DataOUTPipeSize;  /**< Size in bytes of the HID interface's OUT data pipe */
+					
+					bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot
+					                            *   Protocol when enabled via \ref USB_HID_Host_SetProtocol()
+					                            */
+				} State; /**< State data for the USB class interface within the device. All elements in this section
+						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
+						  *   the interface is enumerated.
+						  */
+			} USB_ClassInfo_HID_Host_t;
+
+		/* Enums: */
+			enum HIDHost_EnumerationFailure_ErrorCodes_t
+			{
+				HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
+				HID_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
+				HID_ENUMERROR_NoHIDInterfaceFound        = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor */
+				HID_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible HID endpoints were not found in the device's HID interface */
+			};
+	
 		/* Function Prototypes: */
+			void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+			uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength,
+			                                uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
+
+			bool    HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+			uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol) ATTR_NON_NULL_PTR_ARG(1);
 		
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define HID_INTERFACE_CLASS             0x03
+			
+			#define HID_FOUND_DATAPIPE_IN           (1 << 0)
+			#define HID_FOUND_DATAPIPE_OUT          (1 << 1)
+
+		/* Function Prototypes: */
+			#if defined(INCLUDE_FROM_HID_CLASS_HOST_C)
+				static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+				static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+			#endif	
+	#endif	
+	
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			}