mirror/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-04-17 17:42:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

refractor HID document

Browse Source
This commit is contained in:
hathach 2013-10-24 15:48:57 +07:00
parent b71ffe3d5a
commit d8d00ca768
1 changed files with 31 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
tinyusb/class/hid_host.h
View File

@ -50,12 +50,16 @@
extern "C" { extern "C" {
#endif #endif
/** \defgroup hid_keyboard Keyboard
* The interface API includes status checking function, data transferring function and callback functions
* @{ */
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// KEYBOARD Application API // KEYBOARD Application API
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
/** \addtogroup ClassDriver_HID_Keyboard Keyboard
* @{ */
/** \defgroup Keyboard_Host Host
* The interface API includes status checking function, data transferring function and callback functions
* @{ */
extern uint8_t const hid_keycode_to_ascii_tbl[2][128]; // TODO used weak attr if build failed without KEYBOARD enabled extern uint8_t const hid_keycode_to_ascii_tbl[2][128]; // TODO used weak attr if build failed without KEYBOARD enabled
/** \brief Check if device supports Keyboard interface or not /** \brief Check if device supports Keyboard interface or not
@ -109,14 +113,20 @@ void tusbh_hid_keyboard_mounted_cb(uint8_t dev_addr);
* \note This callback should be used by Application to tear-down interface-related data * \note This callback should be used by Application to tear-down interface-related data
*/ */
void tusbh_hid_keyboard_unmounted_cb(uint8_t dev_addr); void tusbh_hid_keyboard_unmounted_cb(uint8_t dev_addr);
/** @} */
/** \defgroup hid_mouse Mouse /** @} */ // Keyboard_Host
* The interface API includes status checking function, data transferring function and callback functions /** @} */ // ClassDriver_HID_Keyboard
* @{ */
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// MOUSE Application API // MOUSE Application API
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
/** \addtogroup ClassDriver_HID_Mouse Mouse
* @{ */
/** \defgroup Mouse_Host Host
* The interface API includes status checking function, data transferring function and callback functions
* @{ */
/** \brief Check if device supports Mouse interface or not /** \brief Check if device supports Mouse interface or not
* \param[in] dev_addr device address * \param[in] dev_addr device address
* \retval true if device supports Mouse interface * \retval true if device supports Mouse interface
@ -168,14 +178,20 @@ void tusbh_hid_mouse_mounted_cb(uint8_t dev_addr);
* \note This callback should be used by Application to tear-down interface-related data * \note This callback should be used by Application to tear-down interface-related data
*/ */
void tusbh_hid_mouse_unmounted_cb(uint8_t dev_addr); void tusbh_hid_mouse_unmounted_cb(uint8_t dev_addr);
/** @} */
/** \defgroup hid_generic Generic (not supported yet) /** @} */ // Mouse_Host
* The interface API includes status checking function, data transferring function and callback functions /** @} */ // ClassDriver_HID_Mouse
* @{ */
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// GENERIC Application API // GENERIC Application API
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
/** \addtogroup ClassDriver_HID_Generic Generic
* @{ */
/** \defgroup Generic_Host Host
* The interface API includes status checking function, data transferring function and callback functions
* @{ */
bool tusbh_hid_generic_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT; bool tusbh_hid_generic_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
tusb_error_t tusbh_hid_generic_get_report(uint8_t dev_addr, void* p_report, bool int_on_complete) ATTR_WARN_UNUSED_RESULT; tusb_error_t tusbh_hid_generic_get_report(uint8_t dev_addr, void* p_report, bool int_on_complete) ATTR_WARN_UNUSED_RESULT;
tusb_error_t tusbh_hid_generic_set_report(uint8_t dev_addr, void* p_report, bool int_on_complete) ATTR_WARN_UNUSED_RESULT; tusb_error_t tusbh_hid_generic_set_report(uint8_t dev_addr, void* p_report, bool int_on_complete) ATTR_WARN_UNUSED_RESULT;
@ -184,7 +200,9 @@ tusb_interface_status_t tusbh_hid_generic_set_status(uint8_t dev_addr) ATTR_WARN
//------------- Application Callback -------------// //------------- Application Callback -------------//
void tusbh_hid_generic_isr(uint8_t dev_addr, tusb_event_t event); void tusbh_hid_generic_isr(uint8_t dev_addr, tusb_event_t event);
/** @} */
/** @} */ // Generic_Host
/** @} */ // ClassDriver_HID_Generic
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// USBH-CLASS DRIVER API // USBH-CLASS DRIVER API
@ -210,4 +228,4 @@ void hidh_close(uint8_t dev_addr);
#endif /* _TUSB_HID_HOST_H_ */ #endif /* _TUSB_HID_HOST_H_ */
/** @} */ /** @} */ // ClassDriver_HID