mirror/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-02-20 18:40:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

continue with hid host rework

Browse Source
This commit is contained in:
hathach 2021-05-13 14:09:33 +07:00
parent 9324fd8f2e
commit cc1b83412a
2 changed files with 85 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
src/class/hid/hid_host.c
View File

@ -82,26 +82,25 @@ typedef struct
static hidh_device_t _hidh_dev[CFG_TUSB_HOST_DEVICE_MAX-1]; static hidh_device_t _hidh_dev[CFG_TUSB_HOST_DEVICE_MAX-1];
//------------- Internal prototypes -------------//
TU_ATTR_ALWAYS_INLINE static inline hidh_device_t* get_dev(uint8_t dev_addr); TU_ATTR_ALWAYS_INLINE static inline hidh_device_t* get_dev(uint8_t dev_addr);
TU_ATTR_ALWAYS_INLINE static inline hidh_interface_t* get_instance(uint8_t dev_addr, uint8_t instance); TU_ATTR_ALWAYS_INLINE static inline hidh_interface_t* get_instance(uint8_t dev_addr, uint8_t instance);
static uint8_t get_instance_id(uint8_t dev_addr, uint8_t itf); static uint8_t get_instance_id_by_itfnum(uint8_t dev_addr, uint8_t itf);
static hidh_interface_t* get_interface(uint8_t dev_addr, uint8_t itf); static hidh_interface_t* get_instance_by_itfnum(uint8_t dev_addr, uint8_t itf);
static uint8_t get_instance_id_by_epaddr(uint8_t dev_addr, uint8_t ep_addr);
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// Application API // Application API
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
uint8_t tuh_n_hid_instance_count(uint8_t daddr)
uint8_t tuh_n_hid_instance_count(uint8_t dev_addr)
{ {
return get_dev(daddr)->inst_count; return get_dev(dev_addr)->inst_count;
} }
//--------------------------------------------------------------------+ bool tuh_n_hid_n_mounted(uint8_t dev_addr, uint8_t instance)
// HID Interface common functions
//--------------------------------------------------------------------+
bool tuh_n_hid_n_mounted(uint8_t daddr, uint8_t instance)
{ {
hidh_interface_t* hid_itf = get_instance(daddr, instance); hidh_interface_t* hid_itf = get_instance(dev_addr, instance);
return (hid_itf->ep_in != 0) || (hid_itf->ep_out != 0); return (hid_itf->ep_in != 0) || (hid_itf->ep_out != 0);
} }
@ -113,29 +112,29 @@ bool tuh_n_hid_n_ready(uint8_t dev_addr, uint8_t instance)
return !hcd_edpt_busy(dev_addr, hid_itf->ep_in); return !hcd_edpt_busy(dev_addr, hid_itf->ep_in);
} }
bool tuh_n_hid_n_get_report(uint8_t daddr, uint8_t instance, void* report, uint16_t len) bool tuh_n_hid_n_get_report(uint8_t dev_addr, uint8_t instance, void* report, uint16_t len)
{ {
TU_VERIFY( tuh_device_ready(daddr) && report && len); TU_VERIFY( tuh_device_ready(dev_addr) && report && len);
hidh_interface_t* hid_itf = get_instance(daddr, instance); hidh_interface_t* hid_itf = get_instance(dev_addr, instance);
// TODO change to claim endpoint // TODO change to claim endpoint
TU_VERIFY( !hcd_edpt_busy(daddr, hid_itf->ep_in) ); TU_VERIFY( !hcd_edpt_busy(dev_addr, hid_itf->ep_in) );
len = tu_min16(len, hid_itf->ep_size); len = tu_min16(len, hid_itf->ep_size);
return usbh_edpt_xfer(daddr, hid_itf->ep_in, report, len); return usbh_edpt_xfer(dev_addr, hid_itf->ep_in, report, len);
} }
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// KEYBOARD // KEYBOARD
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
bool tuh_n_hid_n_keyboard_mounted(uint8_t daddr, uint8_t instance) bool tuh_n_hid_n_keyboard_mounted(uint8_t dev_addr, uint8_t instance)
{ {
hidh_interface_t* hid_itf = get_instance(daddr, instance); hidh_interface_t* hid_itf = get_instance(dev_addr, instance);
// TODO check rid_keyboard // TODO check rid_keyboard
return tuh_device_ready(daddr) && (hid_itf->ep_in != 0); return tuh_device_ready(dev_addr) && (hid_itf->ep_in != 0);
} }
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
@ -164,26 +163,16 @@ void hidh_init(void)
bool hidh_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes) bool hidh_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes)
{ {
(void) xferred_bytes; // TODO may need to use this para later uint8_t const dir = tu_edpt_dir(ep_addr);
uint8_t const instance = get_instance_id_by_epaddr(dev_addr, ep_addr);
// uint8_t itf = 0; if ( dir == TUSB_DIR_IN )
// hidh_interface_t* hid_itf = &_hidh_itf[itf]; {
if (tuh_hid_get_report_complete_cb) tuh_hid_get_report_complete_cb(dev_addr, instance, xferred_bytes);
#if CFG_TUH_HID_KEYBOARD }else
// if ( ep_addr == keyboardh_data[dev_addr-1].ep_in ) {
// { if (tuh_hid_set_report_complete_cb) tuh_hid_set_report_complete_cb(dev_addr, instance, xferred_bytes);
// tuh_hid_keyboard_isr(dev_addr, event); }
// return true;
// }
#endif
#if CFG_TUH_HID_MOUSE
// if ( ep_addr == mouseh_data[dev_addr-1].ep_in )
// {
// tuh_hid_mouse_isr(dev_addr, event);
// return true;
// }
#endif
return true; return true;
} }
@ -311,7 +300,7 @@ bool config_set_idle_complete(uint8_t dev_addr, tusb_control_request_t const * r
uint8_t const itf_num = (uint8_t) request->wIndex; uint8_t const itf_num = (uint8_t) request->wIndex;
hidh_interface_t* hid_itf = get_interface(dev_addr, itf_num); hidh_interface_t* hid_itf = get_instance_by_itfnum(dev_addr, itf_num);
// Get Report Descriptor // Get Report Descriptor
// using usbh enumeration buffer since report descriptor can be very long // using usbh enumeration buffer since report descriptor can be very long
@ -340,7 +329,7 @@ bool config_get_report_desc_complete(uint8_t dev_addr, tusb_control_request_t co
{ {
TU_ASSERT(XFER_RESULT_SUCCESS == result); TU_ASSERT(XFER_RESULT_SUCCESS == result);
uint8_t const itf_num = (uint8_t) request->wIndex; uint8_t const itf_num = (uint8_t) request->wIndex;
uint8_t const inst = get_instance_id(dev_addr, itf_num); uint8_t const inst = get_instance_id_by_itfnum(dev_addr, itf_num);
//hidh_interface_t* hid_itf = get_instance(dev_addr, inst); //hidh_interface_t* hid_itf = get_instance(dev_addr, inst);
if (tuh_hid_descriptor_report_cb) if (tuh_hid_descriptor_report_cb)
@ -375,30 +364,43 @@ TU_ATTR_ALWAYS_INLINE static inline hidh_interface_t* get_instance(uint8_t dev_a
return &_hidh_dev[dev_addr-1].instances[instance]; return &_hidh_dev[dev_addr-1].instances[instance];
} }
// Get instance ID by interface number // Get instance by interface number
static uint8_t get_instance_id(uint8_t dev_addr, uint8_t itf) static hidh_interface_t* get_instance_by_itfnum(uint8_t dev_addr, uint8_t itf)
{ {
for ( uint8_t inst = 0; inst < CFG_TUH_HID; inst++ ) for ( uint8_t inst = 0; inst < CFG_TUH_HID; inst++ )
{ {
hidh_interface_t *hid = get_instance(dev_addr, inst); hidh_interface_t *hid = get_instance(dev_addr, inst);
if ( (hid->itf_num == itf) && (hid->ep_in != 0) ) return inst; if ( (hid->itf_num == itf) && (hid->ep_in || hid->ep_out) ) return hid;
}
return 0xff;
}
// Get Interface by interface number
static hidh_interface_t* get_interface(uint8_t dev_addr, uint8_t itf)
{
for ( uint8_t inst = 0; inst < CFG_TUH_HID; inst++ )
{
hidh_interface_t *hid = get_instance(dev_addr, inst);
if ( (hid->itf_num == itf) && (hid->ep_in != 0) ) return hid;
} }
return NULL; return NULL;
} }
// Get instance ID by interface number
static uint8_t get_instance_id_by_itfnum(uint8_t dev_addr, uint8_t itf)
{
for ( uint8_t inst = 0; inst < CFG_TUH_HID; inst++ )
{
hidh_interface_t *hid = get_instance(dev_addr, inst);
if ( (hid->itf_num == itf) && (hid->ep_in || hid->ep_out) ) return inst;
}
return 0xff;
}
// Get instance ID by endpoint address
static uint8_t get_instance_id_by_epaddr(uint8_t dev_addr, uint8_t ep_addr)
{
for ( uint8_t inst = 0; inst < CFG_TUH_HID; inst++ )
{
hidh_interface_t *hid = get_instance(dev_addr, inst);
if ( (ep_addr == hid->ep_in) || ( ep_addr == hid->ep_out) ) return inst;
}
return 0xff;
}
#endif #endif

132
src/class/hid/hid_host.h
View File

@ -58,22 +58,46 @@
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// Get the number of HID instances // Get the number of HID instances
uint8_t tuh_n_hid_instance_count(uint8_t daddr); uint8_t tuh_n_hid_instance_count(uint8_t dev_addr);
// Check if HID instance is mounted // Check if HID instance is mounted
bool tuh_n_hid_n_mounted(uint8_t daddr, uint8_t instance); bool tuh_n_hid_n_mounted(uint8_t dev_addr, uint8_t instance);
// Check if the interface is ready to use // Check if the interface is ready to use
bool tuh_n_hid_n_ready(uint8_t dev_addr, uint8_t instance); bool tuh_n_hid_n_ready(uint8_t dev_addr, uint8_t instance);
bool tuh_n_hid_n_get_report(uint8_t daddr, uint8_t instance, void* report, uint16_t len); // Get Report from device
bool tuh_n_hid_n_get_report(uint8_t dev_addr, uint8_t instance, void* report, uint16_t len);
//------------- -------------//
// Check if HID instance with Keyboard is mounted // Check if HID instance with Keyboard is mounted
bool tuh_n_hid_n_keyboard_mounted(uint8_t daddr, uint8_t instance); bool tuh_n_hid_n_keyboard_mounted(uint8_t dev_addr, uint8_t instance);
// Check if HID instance with Mouse is mounted // Check if HID instance with Mouse is mounted
bool tuh_n_hid_n_mouse_mounted(uint8_t dev_addr, uint8_t instance); bool tuh_n_hid_n_mouse_mounted(uint8_t dev_addr, uint8_t instance);
//--------------------------------------------------------------------+
// Callbacks (Weak is optional)
//--------------------------------------------------------------------+
// Invoked when report descriptor is received
// Note: enumeration is still not complete yet at this time
TU_ATTR_WEAK void tuh_hid_descriptor_report_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* report_desc, uint16_t desc_len);
// Invoked when device with hid interface is mounted
TU_ATTR_WEAK void tuh_hid_mounted_cb (uint8_t dev_addr, uint8_t instance);
// Invoked when device with hid interface is un-mounted
TU_ATTR_WEAK void tuh_hid_unmounted_cb(uint8_t dev_addr, uint8_t instance);
// Invoked when received Report from device
TU_ATTR_WEAK void tuh_hid_get_report_complete_cb(uint8_t dev_addr, uint8_t instance, uint8_t xferred_bytes);
// Invoked when Sent Report to device
TU_ATTR_WEAK void tuh_hid_set_report_complete_cb(uint8_t dev_addr, uint8_t instance, uint8_t xferred_bytes);
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// Application API (Single device) // Application API (Single device)
@ -86,106 +110,6 @@ uint8_t tuh_hid_instance_count(void)
return tuh_n_hid_instance_count(1); return tuh_n_hid_instance_count(1);
} }
//bool tuh_hid_get_report(uint8_t dev_addr, uint8_t report_id, void * p_report, uint8_t len);
//--------------------------------------------------------------------+
// Callbacks (Weak is optional)
//--------------------------------------------------------------------+
// Invoked when report descriptor is received
// Note: enumeration is still not complete yet
TU_ATTR_WEAK void tuh_hid_descriptor_report_cb(uint8_t daddr, uint8_t instance, uint8_t const* report_desc, uint16_t desc_len);
TU_ATTR_WEAK void tuh_hid_mounted_cb (uint8_t dev_addr, uint8_t instance);
TU_ATTR_WEAK void tuh_hid_unmounted_cb(uint8_t dev_addr, uint8_t instance);
//--------------------------------------------------------------------+
// 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
* @{ */
/** \brief Check if device supports Keyboard interface or not
* \param[in] dev_addr device address
* \retval true if device supports Keyboard interface
* \retval false if device does not support Keyboard interface or is not mounted
*/
bool tuh_hid_keyboard_mounted(uint8_t dev_addr);
/** \brief Check if the interface is currently busy or not
* \param[in] dev_addr device address
* \retval true if the interface is busy meaning the stack is still transferring/waiting data from/to device
* \retval false if the interface is not busy meaning the stack successfully transferred data from/to device
* \note This function is primarily used for polling/waiting result after \ref tuh_hid_keyboard_get_report.
* Alternatively, asynchronous event API can be used
*/
//------------- Application Callback -------------//
/** \brief Callback function that is invoked when an transferring event occurred
* \param[in] dev_addr Address of device
* \param[in] event an value from \ref xfer_result_t
* \note event can be one of following
* - XFER_RESULT_SUCCESS : previously scheduled transfer completes successfully.
* - XFER_RESULT_FAILED : previously scheduled transfer encountered a transaction error.
* - XFER_RESULT_STALLED : previously scheduled transfer is stalled by device.
* \note Application should schedule the next report by calling \ref tuh_hid_keyboard_get_report within this callback
*/
void tuh_hid_keyboard_isr(uint8_t dev_addr, xfer_result_t event);
/** \brief Callback function that will be invoked when a device with Keyboard interface is mounted
* \param[in] dev_addr Address of newly mounted device
* \note This callback should be used by Application to set-up interface-related data
*/
void tuh_hid_keyboard_mounted_cb(uint8_t dev_addr);
/** \brief Callback function that will be invoked when a device with Keyboard interface is unmounted
* \param[in] dev_addr Address of newly unmounted device
* \note This callback should be used by Application to tear-down interface-related data
*/
void tuh_hid_keyboard_unmounted_cb(uint8_t dev_addr);
/** @} */ // Keyboard_Host
/** @} */ // ClassDriver_HID_Keyboard
//--------------------------------------------------------------------+
// 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
* @{ */
//------------- Application Callback -------------//
/** \brief Callback function that is invoked when an transferring event occurred
* \param[in] dev_addr Address of device
* \param[in] event an value from \ref xfer_result_t
* \note event can be one of following
* - XFER_RESULT_SUCCESS : previously scheduled transfer completes successfully.
* - XFER_RESULT_FAILED : previously scheduled transfer encountered a transaction error.
* - XFER_RESULT_STALLED : previously scheduled transfer is stalled by device.
* \note Application should schedule the next report by calling \ref tuh_hid_mouse_get_report within this callback
*/
void tuh_hid_mouse_isr(uint8_t dev_addr, xfer_result_t event);
/** \brief Callback function that will be invoked when a device with Mouse interface is mounted
* \param[in] dev_addr Address of newly mounted device
* \note This callback should be used by Application to set-up interface-related data
*/
void tuh_hid_mouse_mounted_cb(uint8_t dev_addr);
/** \brief Callback function that will be invoked when a device with Mouse interface is unmounted
* \param[in] dev_addr Address of newly unmounted device
* \note This callback should be used by Application to tear-down interface-related data
*/
void tuh_hid_mouse_unmounted_cb(uint8_t dev_addr);
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// Internal Class Driver API // Internal Class Driver API