X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/afe6ae14023c7040befe73e49d00077d3425c564..b7049da11b6fe3c37b23d8f7dddfff08ba14f449:/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 a4317d719..6ed6b3892 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -51,57 +51,58 @@ extern "C" { #endif - /* 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 HID_Device_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 HID_Device_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo); + /* Public Interface - May be used in end-application: */ + /* 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 HID_Device_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 HID_Device_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 HID_Device_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 - * 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_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData); + /** 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 HID_Device_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 + * 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_HID_Device_CreateHIDReport(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. - * \param ReportSize Size in bytes of the received report from the host. - */ - void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData, - uint16_t ReportSize); + /** 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. + * \param ReportSize Size in bytes of the received report from the host. + */ + void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData, + uint16_t ReportSize); /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)