From 1c12341cd73659a5c13b563b8cd682d766547af3 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 8 Jun 2009 10:35:42 +0000 Subject: [PATCH] Completed documentation of the HID device class driver. --- LUFA/Drivers/USB/Class/Device/HID.h | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index e812a39c70..4a59185add 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -123,8 +123,28 @@ } USB_ClassInfo_HID_t; /* Function Prototypes: */ + /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library + * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration + * containing the given HID interface is selected. + * + * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state. + * + * \return Boolean true if the endpoints were sucessfully configured, false otherwise + */ bool USB_HID_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo); + + /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be + * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. + * + * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state. + */ void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo); + + /** General management task for a given HID class interface, required for the correct operation of the interface. This should + * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). + * + * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state. + */ void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo); /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either @@ -150,7 +170,7 @@ * 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); + 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)