more minor clean up

- also rename usbh_classdriver.h to usbh_pvt.h to consitent with usbd
This commit is contained in:
hathach 2023-08-15 22:51:21 +07:00
parent 9d94296741
commit 1b33a31536
No known key found for this signature in database
GPG Key ID: F5D50C6D51D17CBA
9 changed files with 61 additions and 79 deletions

View File

@ -29,7 +29,7 @@
#if (CFG_TUH_ENABLED && CFG_TUH_CDC) #if (CFG_TUH_ENABLED && CFG_TUH_CDC)
#include "host/usbh.h" #include "host/usbh.h"
#include "host/usbh_classdriver.h" #include "host/usbh_pvt.h"
#include "cdc_host.h" #include "cdc_host.h"

View File

@ -29,7 +29,7 @@
#if (CFG_TUH_ENABLED && CFG_TUH_HID) #if (CFG_TUH_ENABLED && CFG_TUH_HID)
#include "host/usbh.h" #include "host/usbh.h"
#include "host/usbh_classdriver.h" #include "host/usbh_pvt.h"
#include "hid_host.h" #include "hid_host.h"

View File

@ -29,7 +29,7 @@
#if CFG_TUH_ENABLED && CFG_TUH_MSC #if CFG_TUH_ENABLED && CFG_TUH_MSC
#include "host/usbh.h" #include "host/usbh.h"
#include "host/usbh_classdriver.h" #include "host/usbh_pvt.h"
#include "msc_host.h" #include "msc_host.h"

View File

@ -238,34 +238,25 @@ enum { BUILTIN_DRIVER_COUNT = TU_ARRAY_SIZE(_usbd_driver) };
tu_static usbd_class_driver_t const * _app_driver = NULL; tu_static usbd_class_driver_t const * _app_driver = NULL;
tu_static uint8_t _app_driver_count = 0; tu_static uint8_t _app_driver_count = 0;
#define TOTAL_DRIVER_COUNT (_app_driver_count + BUILTIN_DRIVER_COUNT)
// virtually joins built-in and application drivers together. // virtually joins built-in and application drivers together.
// Application is positioned first to allow overwriting built-in ones. // Application is positioned first to allow overwriting built-in ones.
static inline usbd_class_driver_t const * get_driver(uint8_t drvid) static inline usbd_class_driver_t const * get_driver(uint8_t drvid)
{ {
// Application drivers usbd_class_driver_t const * driver = NULL;
if ( usbd_app_driver_get_cb )
{ if ( drvid < _app_driver_count ) {
if ( drvid < _app_driver_count ) return &_app_driver[drvid]; // Application drivers
drvid -= _app_driver_count; driver = &_app_driver[drvid];
} else if ( drvid < TOTAL_DRIVER_COUNT && BUILTIN_DRIVER_COUNT > 0 ){
driver = &_usbd_driver[drvid - _app_driver_count];
} }
// when there is no built-in drivers BUILTIN_DRIVER_COUNT = 0 will cause -Wtype-limits warning return driver;
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wtype-limits"
#endif
// Built-in drivers
if (drvid < BUILTIN_DRIVER_COUNT) return &_usbd_driver[drvid];
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
return NULL;
} }
#define TOTAL_DRIVER_COUNT (_app_driver_count + BUILTIN_DRIVER_COUNT)
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// DCD Event // DCD Event

View File

@ -59,7 +59,7 @@ typedef struct
} usbd_class_driver_t; } usbd_class_driver_t;
// Invoked when initializing device stack to get additional class drivers. // Invoked when initializing device stack to get additional class drivers.
// Can optionally implemented by application to extend/overwrite class driver support. // Can be implemented by application to extend/overwrite class driver support.
// Note: The drivers array must be accessible at all time when stack is active // Note: The drivers array must be accessible at all time when stack is active
usbd_class_driver_t const* usbd_app_driver_get_cb(uint8_t* driver_count) TU_ATTR_WEAK; usbd_class_driver_t const* usbd_app_driver_get_cb(uint8_t* driver_count) TU_ATTR_WEAK;

View File

@ -30,7 +30,7 @@
#include "hcd.h" #include "hcd.h"
#include "usbh.h" #include "usbh.h"
#include "usbh_classdriver.h" #include "usbh_pvt.h"
#include "hub.h" #include "hub.h"
// Debug level, TUSB_CFG_DEBUG must be at least this level for debug message // Debug level, TUSB_CFG_DEBUG must be at least this level for debug message

View File

@ -30,7 +30,7 @@
#include "host/hcd.h" #include "host/hcd.h"
#include "tusb.h" #include "tusb.h"
#include "host/usbh_classdriver.h" #include "host/usbh_pvt.h"
#include "hub.h" #include "hub.h"
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
@ -183,6 +183,23 @@ static usbh_class_driver_t const usbh_class_drivers[] =
enum { USBH_BUILTIN_DRIVER_COUNT = TU_ARRAY_SIZE(usbh_class_drivers) }; enum { USBH_BUILTIN_DRIVER_COUNT = TU_ARRAY_SIZE(usbh_class_drivers) };
enum { CONFIG_NUM = 1 }; // default to use configuration 1 enum { CONFIG_NUM = 1 }; // default to use configuration 1
// Additional class drivers implemented by application
tu_static usbh_class_driver_t const * _app_driver = NULL;
tu_static uint8_t _app_driver_count = 0;
#define TOTAL_DRIVER_COUNT (_app_driver_count + USBH_BUILTIN_DRIVER_COUNT)
static inline usbh_class_driver_t const *get_driver(uint8_t drv_id) {
usbh_class_driver_t const *driver = NULL;
if ( drv_id < _app_driver_count ) {
driver = &_app_driver[drv_id];
} else if ( drv_id < TOTAL_DRIVER_COUNT && USBH_BUILTIN_DRIVER_COUNT > 0) {
driver = &usbh_class_drivers[drv_id - _app_driver_count];
}
return driver;
}
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// INTERNAL OBJECT & FUNCTION DECLARATION // INTERNAL OBJECT & FUNCTION DECLARATION
@ -246,21 +263,6 @@ static void process_removing_device(uint8_t rhport, uint8_t hub_addr, uint8_t hu
static bool usbh_edpt_control_open(uint8_t dev_addr, uint8_t max_packet_size); static bool usbh_edpt_control_open(uint8_t dev_addr, uint8_t max_packet_size);
static bool usbh_control_xfer_cb (uint8_t daddr, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes); static bool usbh_control_xfer_cb (uint8_t daddr, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes);
// Additional class drivers implemented by application
tu_static usbh_class_driver_t const * _app_driver = NULL;
tu_static uint8_t _app_driver_count = 0;
tu_static uint8_t _total_driver_count = USBH_BUILTIN_DRIVER_COUNT;
static usbh_class_driver_t const * usbh_get_driver(uint8_t drv_id)
{
usbh_class_driver_t const * driver = NULL;
if ( drv_id < _app_driver_count )
driver = &_app_driver[drv_id];
else if ( drv_id < _total_driver_count )
driver = &usbh_class_drivers[drv_id - _app_driver_count];
return driver;
}
#if CFG_TUSB_OS == OPT_OS_NONE #if CFG_TUSB_OS == OPT_OS_NONE
// TODO rework time-related function later // TODO rework time-related function later
// weak and overridable // weak and overridable
@ -354,11 +356,10 @@ bool tuh_init(uint8_t controller_id) {
_usbh_mutex = osal_mutex_create(&_usbh_mutexdef); _usbh_mutex = osal_mutex_create(&_usbh_mutexdef);
TU_ASSERT(_usbh_mutex); TU_ASSERT(_usbh_mutex);
#endif #endif
// Get application driver if available // Get application driver if available
if ( usbh_app_driver_get_cb ) if ( usbh_app_driver_get_cb ) {
{
_app_driver = usbh_app_driver_get_cb(&_app_driver_count); _app_driver = usbh_app_driver_get_cb(&_app_driver_count);
_total_driver_count = USBH_BUILTIN_DRIVER_COUNT + _app_driver_count;
} }
// Device // Device
@ -372,9 +373,9 @@ bool tuh_init(uint8_t controller_id) {
} }
// Class drivers // Class drivers
for (uint8_t drv_id = 0; drv_id < _total_driver_count; drv_id++) for (uint8_t drv_id = 0; drv_id < TOTAL_DRIVER_COUNT; drv_id++)
{ {
usbh_class_driver_t const * driver = usbh_get_driver(drv_id); usbh_class_driver_t const * driver = get_driver(drv_id);
if ( driver ) if ( driver )
{ {
TU_LOG_USBH("%s init\r\n", driver->name); TU_LOG_USBH("%s init\r\n", driver->name);
@ -508,12 +509,12 @@ void tuh_task_ext(uint32_t timeout_ms, bool in_isr) {
#endif #endif
{ {
uint8_t drv_id = dev->ep2drv[epnum][ep_dir]; uint8_t drv_id = dev->ep2drv[epnum][ep_dir];
usbh_class_driver_t const * driver = usbh_get_driver(drv_id); usbh_class_driver_t const * driver = get_driver(drv_id);
if ( driver ) if ( driver )
{ {
TU_LOG_USBH("%s xfer callback\r\n", driver->name); TU_LOG_USBH("%s xfer callback\r\n", driver->name);
driver->xfer_cb(event.dev_addr, ep_addr, (xfer_result_t) event.xfer_complete.result, driver->xfer_cb(event.dev_addr, ep_addr, (xfer_result_t) event.xfer_complete.result,
event.xfer_complete.len); event.xfer_complete.len);
} }
else else
{ {
@ -1220,12 +1221,10 @@ static void process_removing_device(uint8_t rhport, uint8_t hub_addr, uint8_t hu
// hub_addr = 0 means roothub, hub_port = 0 means all devices of downstream hub // hub_addr = 0 means roothub, hub_port = 0 means all devices of downstream hub
if (dev->rhport == rhport && dev->connected && if (dev->rhport == rhport && dev->connected &&
(hub_addr == 0 || dev->hub_addr == hub_addr) && (hub_addr == 0 || dev->hub_addr == hub_addr) &&
(hub_port == 0 || dev->hub_port == hub_port)) (hub_port == 0 || dev->hub_port == hub_port)) {
{
TU_LOG_USBH("Device unplugged address = %u\r\n", daddr); TU_LOG_USBH("Device unplugged address = %u\r\n", daddr);
if (is_hub_addr(daddr)) if (is_hub_addr(daddr)) {
{
TU_LOG(CFG_TUH_LOG_LEVEL, " is a HUB device %u\r\n", daddr); TU_LOG(CFG_TUH_LOG_LEVEL, " is a HUB device %u\r\n", daddr);
// Submit removed event If the device itself is a hub (un-rolled recursive) // Submit removed event If the device itself is a hub (un-rolled recursive)
@ -1243,14 +1242,11 @@ static void process_removing_device(uint8_t rhport, uint8_t hub_addr, uint8_t hu
} }
// Close class driver // Close class driver
for (uint8_t drv_id = 0; drv_id < _total_driver_count; drv_id++) for (uint8_t drv_id = 0; drv_id < TOTAL_DRIVER_COUNT; drv_id++) {
{ usbh_class_driver_t const * driver = get_driver(drv_id);
usbh_class_driver_t const * driver = usbh_get_driver(drv_id); if ( driver ) driver->close(daddr);
if ( driver )
{
driver->close(daddr);
}
} }
hcd_device_close(rhport, daddr); hcd_device_close(rhport, daddr);
clear_device(dev); clear_device(dev);
// abort on-going control xfer if any // abort on-going control xfer if any
@ -1679,10 +1675,9 @@ static bool _parse_configuration_descriptor(uint8_t dev_addr, tusb_desc_configur
TU_ASSERT(drv_len >= sizeof(tusb_desc_interface_t)); TU_ASSERT(drv_len >= sizeof(tusb_desc_interface_t));
// Find driver for this interface // Find driver for this interface
uint8_t drv_id = 0; for (uint8_t drv_id = 0; drv_id < TOTAL_DRIVER_COUNT; drv_id++)
for (; drv_id < _total_driver_count; drv_id++)
{ {
usbh_class_driver_t const * driver = usbh_get_driver(drv_id); usbh_class_driver_t const * driver = get_driver(drv_id);
if (driver && driver->open(dev->rhport, dev_addr, desc_itf, drv_len) ) if (driver && driver->open(dev->rhport, dev_addr, desc_itf, drv_len) )
{ {
@ -1705,12 +1700,11 @@ static bool _parse_configuration_descriptor(uint8_t dev_addr, tusb_desc_configur
break; // exit driver find loop break; // exit driver find loop
} }
} if ( drv_id == TOTAL_DRIVER_COUNT - 1 )
{
if( drv_id >= _total_driver_count ) TU_LOG(CFG_TUH_LOG_LEVEL, "[%u:%u] Interface %u: class = %u subclass = %u protocol = %u is not supported\r\n",
{ dev->rhport, dev_addr, desc_itf->bInterfaceNumber, desc_itf->bInterfaceClass, desc_itf->bInterfaceSubClass, desc_itf->bInterfaceProtocol);
TU_LOG(CFG_TUH_LOG_LEVEL, "Interface %u: class = %u subclass = %u protocol = %u is not supported\r\n", }
desc_itf->bInterfaceNumber, desc_itf->bInterfaceClass, desc_itf->bInterfaceSubClass, desc_itf->bInterfaceProtocol);
} }
// next Interface or IAD descriptor // next Interface or IAD descriptor
@ -1730,9 +1724,9 @@ void usbh_driver_set_config_complete(uint8_t dev_addr, uint8_t itf_num)
// IAD binding interface such as CDCs should return itf_num + 1 when complete // IAD binding interface such as CDCs should return itf_num + 1 when complete
// with usbh_driver_set_config_complete() // with usbh_driver_set_config_complete()
uint8_t const drv_id = dev->itf2drv[itf_num]; uint8_t const drv_id = dev->itf2drv[itf_num];
if (drv_id != TUSB_INDEX_INVALID_8) usbh_class_driver_t const * driver = get_driver(drv_id);
if (driver)
{ {
usbh_class_driver_t const * driver = usbh_get_driver(drv_id);
TU_LOG_USBH("%s set config: itf = %u\r\n", driver->name, itf_num); TU_LOG_USBH("%s set config: itf = %u\r\n", driver->name, itf_num);
driver->set_config(dev_addr, itf_num); driver->set_config(dev_addr, itf_num);
break; break;

View File

@ -62,6 +62,11 @@ typedef struct {
void (* const close )(uint8_t dev_addr); void (* const close )(uint8_t dev_addr);
} usbh_class_driver_t; } usbh_class_driver_t;
// Invoked when initializing host stack to get additional class drivers.
// Can be implemented by application to extend/overwrite class driver support.
// Note: The drivers array must be accessible at all time when stack is active
usbh_class_driver_t const* usbh_app_driver_get_cb(uint8_t* driver_count) TU_ATTR_WEAK;
// Call by class driver to tell USBH that it has complete the enumeration // Call by class driver to tell USBH that it has complete the enumeration
void usbh_driver_set_config_complete(uint8_t dev_addr, uint8_t itf_num); void usbh_driver_set_config_complete(uint8_t dev_addr, uint8_t itf_num);
@ -96,14 +101,6 @@ bool usbh_edpt_release(uint8_t dev_addr, uint8_t ep_addr);
// Check if endpoint transferring is complete // Check if endpoint transferring is complete
bool usbh_edpt_busy(uint8_t dev_addr, uint8_t ep_addr); bool usbh_edpt_busy(uint8_t dev_addr, uint8_t ep_addr);
//--------------------------------------------------------------------+
// USBH application additional driver API
//--------------------------------------------------------------------+
// Invoked when initializing host stack to get additional class drivers.
// Can optionally implemented by application to extend/overwrite class driver support.
// Note: The drivers array must be accessible at all time when stack is active
usbh_class_driver_t const* usbh_app_driver_get_cb(uint8_t* driver_count) TU_ATTR_WEAK;
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif

View File

@ -36,7 +36,7 @@
#endif #endif
#if CFG_TUH_ENABLED #if CFG_TUH_ENABLED
#include "host/usbh_classdriver.h" #include "host/usbh_pvt.h"
#endif #endif
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+