Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old...

[pub/USBasp.git] / 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 4501fcb..f863f81 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -28,6 +28,20 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \ingroup Group_USBDeviceClassDrivers\r
+ *  @defgroup Group_USBClassHIDDevice HID Device Class Driver - LUFA/Drivers/Class/Device/HID.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/HID.c\r
+ *\r
+ *  \section Module Description\r
+ *  Functions, macros, variables, enums and types related to the management of USB HID Class interfaces\r
+ *  within a USB device.\r
+ *\r
+ *  @{\r
+ */\r
+ \r

 #ifndef _HID_CLASS_H_\r
 #define _HID_CLASS_H_\r
 \r
 #ifndef _HID_CLASS_H_\r
 #define _HID_CLASS_H_\r
 \r


@@ -36,6 +50,11 @@
 \r
                #include <string.h>\r
 \r
 \r
                #include <string.h>\r
 \r

+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r
+\r

        /* Macros: */\r
                /** HID Class Specific Request to get the current HID report from the device. */\r
                #define REQ_GetReport      0x01\r
        /* Macros: */\r
                /** HID Class Specific Request to get the current HID report from the device. */\r
                #define REQ_GetReport      0x01\r


@@ -85,6 +104,9 @@
                 *  within the user application, and passed to each of the HID class driver functions as the\r
                 *  HIDInterfaceInfo parameter. The contents of this structure should be set to their correct\r
                 *  values when used, or ommitted to force the library to use default values.\r
                 *  within the user application, and passed to each of the HID class driver functions as the\r
                 *  HIDInterfaceInfo parameter. The contents of this structure should be set to their correct\r
                 *  values when used, or ommitted to force the library to use default values.\r

+                *\r
+                *  Note that for the HID class driver, host-to-device reports are received via HID class requests\r
+                *  rather than a dedicated endpoint to simplify the driver and its interface.\r

                 */\r
                typedef struct\r
                {\r
                 */\r
                typedef struct\r
                {\r


@@ -92,9 +114,6 @@
 \r
                        uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
                        uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */\r
 \r
                        uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
                        uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */\r

-\r
-                       uint8_t  ReportOUTEndpointNumber; /**< Endpoint number of the HID interface's OUT report endpoint, if used */\r
-                       uint16_t ReportOUTEndpointSize;  /**< Size in bytes of the HID interface's OUT report endpoint, if used */\r

                        \r
                        uint8_t  ReportINBufferSize;\r
 \r
                        \r
                        uint8_t  ReportINBufferSize;\r
 \r


@@ -108,7 +127,36 @@
                void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                \r
                void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                \r

-               uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData);\r
-               void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize);\r
+               /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r
+                *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
+                *  user is responsible for the creation of the next HID input report to be sent to the host.\r
+                *\r
+                *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                *  \param ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
+                *                   be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
+                *                   given HID interface, this parameter should be ignored.\r
+                *  \param ReportData  Pointer to a buffer where the generated HID report should be stored.\r
+                *\r
+                *  \return  Number of bytes in the generated input report, or zero if no report is to be sent\r
+                */\r
+               uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
+\r
+               /** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to\r
+                *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback\r
+                *  the user is responsible for the processing of the received HID output report from the host.\r
+                *\r
+                *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                *  \param ReportID  Report ID of the received output report. If multiple reports are not received via the given HID\r
+                *                   interface, this parameter should be ignored.\r
+                *  \param ReportData  Pointer to a buffer where the received HID report is stored.\r
+                */\r
+               void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData, uint16_t ReportSize);\r

 \r
 \r

+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+               \r

 #endif\r
 #endif\r

+\r
+/** @} */\r