Completed documentation of the HID device class driver.

[pub/lufa.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 e812a39..4a59185 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -123,8 +123,28 @@
                } USB_ClassInfo_HID_t;\r
 \r
        /* Function Prototypes: */\r
                } USB_ClassInfo_HID_t;\r
 \r
        /* Function Prototypes: */\r

+               /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\r
+                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                *  containing the given HID interface is selected.\r
+                *\r
+                *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                *\r
+                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                */\r

                bool USB_HID_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                bool USB_HID_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r

+               \r
+               /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r
+                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                *\r
+                *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                */             \r

                void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r

+\r
+               /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
+                *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                *\r
+                *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                */\r

                void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                \r
                /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r
                void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                \r
                /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r


@@ -150,7 +170,7 @@
                 *                   interface, this parameter should be ignored.\r
                 *  \param ReportData  Pointer to a buffer where the received HID report is stored.\r
                 */\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
+               void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData, uint16_t ReportSize);\r

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