diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-08 10:35:42 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-08 10:35:42 +0000 |
| commit | 1c12341cd73659a5c13b563b8cd682d766547af3 (patch) | |
| tree | 96896fd598c1ab90946ce494bba8196527e32659 /LUFA/Drivers/USB/Class/Device/HID.h | |
| parent | bde64666fbdda0a275344c0e5e5175f770be516d (diff) | |
| download | lufa-1c12341cd73659a5c13b563b8cd682d766547af3.tar.gz lufa-1c12341cd73659a5c13b563b8cd682d766547af3.tar.bz2 lufa-1c12341cd73659a5c13b563b8cd682d766547af3.zip | |
Completed documentation of the HID device class driver.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device/HID.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/HID.h | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index e812a39c7..4a59185ad 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)
|