X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d1e52660368d34d693131f6aff3c8fd8584162e5..b9b03aadb219d06fbad9d110e508db93e45461af:/LUFA/Drivers/USB/Class/Device/HID.h

diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index 8fdeb064a..f863f811d 100644
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -28,6 +28,20 @@
   this software.
 */
 
+/** \ingroup Group_USBDeviceClassDrivers
+ *  @defgroup Group_USBClassHIDDevice HID Device Class Driver - LUFA/Drivers/Class/Device/HID.h
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Device/HID.c
+ *
+ *  \section Module Description
+ *  Functions, macros, variables, enums and types related to the management of USB HID Class interfaces
+ *  within a USB device.
+ *
+ *  @{
+ */
+ 
 #ifndef _HID_CLASS_H_
 #define _HID_CLASS_H_
 
@@ -36,6 +50,11 @@
 
 		#include <string.h>
 
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
 	/* Macros: */
 		/** HID Class Specific Request to get the current HID report from the device. */
 		#define REQ_GetReport      0x01
@@ -85,6 +104,9 @@
 		 *  within the user application, and passed to each of the HID class driver functions as the
 		 *  HIDInterfaceInfo parameter. The contents of this structure should be set to their correct
 		 *  values when used, or ommitted to force the library to use default values.
+		 *
+		 *  Note that for the HID class driver, host-to-device reports are received via HID class requests
+		 *  rather than a dedicated endpoint to simplify the driver and its interface.
 		 */
 		typedef struct
 		{
@@ -92,11 +114,8 @@
 
 			uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */
 			uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */
-
-			uint8_t  ReportOUTEndpointNumber; /**< Endpoint number of the HID interface's OUT report endpoint, if used */
-			uint16_t ReportOUTEndpointSize;  /**< Size in bytes of the HID interface's OUT report endpoint, if used */
 			
-			uint8_t  ReportBufferSize;
+			uint8_t  ReportINBufferSize;
 
 			bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */
 			uint16_t IdleCount; /**< Report idle period, in ms, set by the host */
@@ -106,10 +125,38 @@
 	/* Function Prototypes: */
 		bool USB_HID_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);
 		void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);
-		void USB_HID_RegisterStartOfFrame(USB_ClassInfo_HID_t* HIDInterfaceInfo);
 		void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);
 		
-		uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData);
-		void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize);
+		/** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either
+		 *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the
+		 *  user is responsible for the creation of the next HID input report to be sent to the host.
+		 *
+		 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+		 *  \param ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should
+		 *                   be set to the report ID of the generated HID input report. If multiple reports are not sent via the
+		 *                   given HID interface, this parameter should be ignored.
+		 *  \param ReportData  Pointer to a buffer where the generated HID report should be stored.
+		 *
+		 *  \return  Number of bytes in the generated input report, or zero if no report is to be sent
+		 */
+		uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);
+
+		/** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to
+		 *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback
+		 *  the user is responsible for the processing of the received HID output report from the host.
+		 *
+		 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+		 *  \param ReportID  Report ID of the received output report. If multiple reports are not received via the given HID
+		 *                   interface, this parameter should be ignored.
+		 *  \param ReportData  Pointer to a buffer where the received HID report is stored.
+		 */
+		void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData, uint16_t ReportSize);
 
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+		
 #endif
+
+/** @} */