summaryrefslogtreecommitdiff
path: root/tinyusb/class/hid_device.h
diff options
context:
space:
mode:
authorhathach <[email protected]>2013-10-29 16:29:48 +0700
committerhathach <[email protected]>2013-10-29 16:29:48 +0700
commitcb0a02f8c9734af86ea86b0571bf1c6026d15dff (patch)
tree3283c4b76a9203318367628bed7bc7641bdf65ac /tinyusb/class/hid_device.h
parent5ab195a73d58bcf8d104a7b49d2674368c292792 (diff)
change device driver init to open (when configured)
fix HID_REQUEST_CONTROL_SET_REPORT handle
Diffstat (limited to 'tinyusb/class/hid_device.h')
-rw-r--r--tinyusb/class/hid_device.h35
1 files changed, 32 insertions, 3 deletions
diff --git a/tinyusb/class/hid_device.h b/tinyusb/class/hid_device.h
index c74148d26..9cf65af58 100644
--- a/tinyusb/class/hid_device.h
+++ b/tinyusb/class/hid_device.h
@@ -56,8 +56,38 @@
/** \defgroup Keyboard_Device Device
* @{ */
+/** \brief Check if the interface is currently busy or not
+ * \param[in] coreid 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 tusbd_hid_keyboard_is_busy(uint8_t coreid);
-tusb_error_t tusbd_hid_keyboard_send(uint8_t coreid, hid_keyboard_report_t const *p_kbd_report);
+
+/** \brief Perform transfer queuing
+ * \param[in] coreid 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 TUSB_CFG_ATTR_USBRAM)
+ * \returns \ref tusb_error_t type to indicate success or error condition.
+ * \retval TUSB_ERROR_NONE on success
+ * \retval TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
+ * \retval TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
+ * \retval TUSB_ERROR_INVALID_PARA if input parameters are not correct
+ * \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 tusbd_hid_keyboard_send(uint8_t coreid, hid_keyboard_report_t const *p_report);
+
+//------------- Application Callback -------------//
+/** \brief Callback function that is invoked when an transferring event occurred
+ * \param[in] coreid 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.
+ * \note Application should schedule the next report by calling \ref tusbh_hid_keyboard_get_report within this callback
+ */
+void tusbd_hid_keyboard_isr(uint8_t coreid, tusb_event_t event);
/** @} */
/** @} */
@@ -82,9 +112,8 @@ tusb_error_t tusbd_hid_mouse_send(uint8_t coreid, hid_mouse_report_t const *p_mo
//--------------------------------------------------------------------+
#ifdef _TINY_USB_SOURCE_FILE_
-tusb_error_t hidd_init(uint8_t coreid, tusb_descriptor_interface_t const * p_interface_desc, uint16_t *p_length);
+tusb_error_t hidd_open(uint8_t coreid, tusb_descriptor_interface_t const * p_interface_desc, uint16_t *p_length);
tusb_error_t hidd_control_request(uint8_t coreid, tusb_control_request_t const * p_request);
-tusb_error_t hidd_configured(void);
#endif