reworking device hid class driver

1 files changed, 16 insertions, 45 deletions

diff --git a/src/class/hid/hid_device.h b/src/class/hid/hid_device.h
index 855421eca..a2238473d 100644
--- a/src/class/hid/hid_device.h
+++ b/src/class/hid/hid_device.h
@@ -57,12 +57,11 @@
  *  @{ */

 

 /** \brief      Check if the interface is currently busy or not

- * \param[in]   rhport USB Controller ID

  * \retval      true if the interface is busy meaning the stack is still transferring/waiting data from/to host

  * \retval      false if the interface is not busy meaning the stack successfully transferred data from/to host

  * \note        This function is primarily used for polling/waiting result after \ref tusbd_hid_keyboard_send.

  */

-bool tud_hid_keyboard_busy(uint8_t rhport);

+bool tud_hid_keyboard_busy(void);

 

 /** \brief        Submit USB transfer

  * \param[in]		  rhport USB Controller ID

@@ -75,29 +74,17 @@ bool tud_hid_keyboard_busy(uint8_t rhport);
  * \note          This function is non-blocking and returns immediately. Data will be transferred when USB Host work with this interface.

  *                The result of usb transfer will be reported by the interface's callback function

  */

-tusb_error_t tud_hid_keyboard_send(uint8_t rhport, hid_keyboard_report_t const *p_report);

+tusb_error_t tud_hid_keyboard_send(hid_keyboard_report_t const *p_report);

 

 //--------------------------------------------------------------------+

 // APPLICATION CALLBACK API

 //--------------------------------------------------------------------+

 

-/** \brief      Callback function that is invoked when an transferring event occurred

- *              after invoking \ref tusbd_hid_keyboard_send

- * \param[in]		rhport	USB Controller ID

- * \param[in]   event an value from \ref tusb_event_t

- * \note        event can be one of following

- *              - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully.

- *              - TUSB_EVENT_XFER_ERROR   : previously scheduled transfer encountered a transaction error.

- *              - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device.

- */

-void tud_hid_keyboard_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_bytes);

-

 /** \brief      Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_GET_REPORT

  *              via control endpoint.

- * \param[in]		rhport	USB Controller ID

  * \param[in]   report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests

- * \param[out]  pp_report pointer to buffer that application need to update, value must be accessible by USB controller (see \ref CFG_TUSB_ATTR_USBRAM)

- * \param[in]   requested_length  number of bytes that host requested

+ * \param[out]  buffer data that application need to update, value must be accessible by USB controller (see \ref CFG_TUSB_ATTR_USBRAM)

+ * \param[in]   reqlen  number of bytes that host requested

  * \retval      non-zero Actual number of bytes in the response's buffer.

  * \retval      zero  indicates the current request is not supported. Tinyusb device stack will reject the request by

  *              sending STALL in the data phase.

@@ -105,18 +92,17 @@ void tud_hid_keyboard_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_by
  *              the completion of this control request will not be reported to application.

  *              For Keyboard, USB host often uses this to turn on/off the LED for CAPLOCKS, NUMLOCK (\ref hid_keyboard_led_bm_t)

  */

-uint16_t tud_hid_keyboard_get_report_cb(uint8_t rhport, hid_request_report_type_t report_type, void** pp_report, uint16_t requested_length);

+ATTR_WEAK uint16_t tud_hid_keyboard_get_report_cb(hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen);

 

 /** \brief      Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_SET_REPORT

  *              via control endpoint.

- * \param[in]		rhport	USB Controller ID

  * \param[in]   report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests

- * \param[in]   p_report_data buffer containing the report's data

- * \param[in]   length  number of bytes in the \a p_report_data

+ * \param[in]   buffer  containing the report's data

+ * \param[in]   bufsize  number of bytes in the \a buffer

  * \note        By the time this callback is invoked, the USB control transfer is already completed in the hardware side.

  *              Application are free to handle data at its own will.

  */

-void tud_hid_keyboard_set_report_cb(uint8_t rhport, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length);

+ATTR_WEAK void tud_hid_keyboard_set_report_cb(hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize);

 

 /** @} */

 /** @} */

@@ -130,15 +116,13 @@ void tud_hid_keyboard_set_report_cb(uint8_t rhport, hid_request_report_type_t re
  *  @{ */

 

 /** \brief      Check if the interface is currently busy or not

- * \param[in]   rhport USB Controller ID

  * \retval      true if the interface is busy meaning the stack is still transferring/waiting data from/to host

  * \retval      false if the interface is not busy meaning the stack successfully transferred data from/to host

  * \note        This function is primarily used for polling/waiting result after \ref tusbd_hid_mouse_send.

  */

-bool tud_hid_mouse_is_busy(uint8_t rhport);

+bool tud_hid_mouse_is_busy(void);

 

 /** \brief        Perform transfer queuing

- * \param[in]		  rhport USB Controller ID

  * \param[in,out] p_report address that is used to store data from device. Must be accessible by usb controller (see \ref CFG_TUSB_ATTR_USBRAM)

  * \returns       \ref tusb_error_t type to indicate success or error condition.

  * \retval        TUSB_ERROR_NONE on success

@@ -148,47 +132,34 @@ bool tud_hid_mouse_is_busy(uint8_t rhport);
  * \note          This function is non-blocking and returns immediately. Data will be transferred when USB Host work with this interface.

  *                The result of usb transfer will be reported by the interface's callback function

  */

-tusb_error_t tud_hid_mouse_send(uint8_t rhport, hid_mouse_report_t const *p_report);

+tusb_error_t tud_hid_mouse_send(hid_mouse_report_t const *p_report);

 

 //--------------------------------------------------------------------+

 // APPLICATION CALLBACK API

 //--------------------------------------------------------------------+

 

-/** \brief      Callback function that is invoked when an transferring event occurred

- *              after invoking \ref tusbd_hid_mouse_send

- * \param[in]		rhport	USB Controller ID

- * \param[in]   event an value from \ref tusb_event_t

- * \note        event can be one of following

- *              - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully.

- *              - TUSB_EVENT_XFER_ERROR   : previously scheduled transfer encountered a transaction error.

- *              - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device.

- */

-void tud_hid_mouse_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_bytes);

-

 /** \brief      Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_GET_REPORT

  *              via control endpoint.

- * \param[in]		rhport	USB Controller ID

  * \param[in]   report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests

- * \param[out]  pp_report pointer to buffer that application need to update, value must be accessible by USB controller (see \ref CFG_TUSB_ATTR_USBRAM)

- * \param[in]   requested_length  number of bytes that host requested

+ * \param[out]  buffer buffer that application need to update, value must be accessible by USB controller (see \ref CFG_TUSB_ATTR_USBRAM)

+ * \param[in]   reqlen  number of bytes that host requested

  * \retval      non-zero Actual number of bytes in the response's buffer.

  * \retval      zero  indicates the current request is not supported. Tinyusb device stack will reject the request by

  *              sending STALL in the data phase.

  * \note        After this callback, the request is silently executed by the tinyusb stack, thus

  *              the completion of this control request will not be reported to application

  */

-uint16_t tud_hid_mouse_get_report_cb(uint8_t rhport, hid_request_report_type_t report_type, void** pp_report, uint16_t requested_length);

+ATTR_WEAK uint16_t tud_hid_mouse_get_report_cb(hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen);

 

 /** \brief      Callback function that is invoked when USB host request \ref HID_REQUEST_CONTROL_SET_REPORT

  *              via control endpoint.

- * \param[in]		rhport	USB Controller ID

  * \param[in]   report_type specify which report (INPUT, OUTPUT, FEATURE) that host requests

- * \param[in]   p_report_data buffer containing the report's data

- * \param[in]   length  number of bytes in the \a p_report_data

+ * \param[in]   buffer buffer containing the report's data

+ * \param[in]   bufsize  number of bytes in the \a p_report_data

  * \note        By the time this callback is invoked, the USB control transfer is already completed in the hardware side.

  *              Application are free to handle data at its own will.

  */

-void tud_hid_mouse_set_report_cb(uint8_t rhport, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length);

+ATTR_WEAK void tud_hid_mouse_set_report_cb(hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize);

 

 /** @} */

 /** @} */