summaryrefslogtreecommitdiff
path: root/src/host
diff options
context:
space:
mode:
authorhathach <[email protected]>2022-03-20 00:51:00 +0700
committerhathach <[email protected]>2022-03-20 00:51:00 +0700
commit45052c625e962fa908c3234c228fca43181436d6 (patch)
treeebc895fc17fe056108af39e90e8b87ed6b09d895 /src/host
parentc0195fc6270394a489faf29fe8fc42dff48bcff1 (diff)
parentae531a79f654d566790a4daae350730cdc0a01e9 (diff)
Merge branch 'master' into pio-host
Diffstat (limited to 'src/host')
-rw-r--r--src/host/hcd.h29
-rw-r--r--src/host/hub.c159
-rw-r--r--src/host/hub.h33
-rw-r--r--src/host/usbh.c1470
-rw-r--r--src/host/usbh.h165
-rw-r--r--src/host/usbh_classdriver.h14
-rw-r--r--src/host/usbh_control.c145
7 files changed, 1247 insertions, 768 deletions
diff --git a/src/host/hcd.h b/src/host/hcd.h
index 9d10104f3..0e18351fc 100644
--- a/src/host/hcd.h
+++ b/src/host/hcd.h
@@ -35,6 +35,19 @@
extern "C" {
#endif
+//--------------------------------------------------------------------+
+// Configuration
+//--------------------------------------------------------------------+
+
+#ifndef CFG_TUH_ENDPOINT_MAX
+ #define CFG_TUH_ENDPOINT_MAX (CFG_TUH_HUB + CFG_TUH_HID*2 + CFG_TUH_MSC*2 + CFG_TUH_CDC*3)
+// #ifdef TUP_HCD_ENDPOINT_MAX
+// #define CFG_TUH_ENDPPOINT_MAX TUP_HCD_ENDPOINT_MAX
+// #else
+// #define
+// #endif
+#endif
+
//--------------------------------------------------------------------+
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
@@ -81,26 +94,14 @@ typedef struct
} hcd_event_t;
-#if CFG_TUH_ENABLED
-// Max number of endpoints per device
-enum {
- // TODO better computation
- HCD_MAX_ENDPOINT = CFG_TUH_DEVICE_MAX*(CFG_TUH_HUB + CFG_TUH_HID*2 + CFG_TUH_MSC*2 + CFG_TUH_CDC*3),
- HCD_MAX_XFER = HCD_MAX_ENDPOINT*2,
-};
-
-//#define HCD_MAX_ENDPOINT 16
-//#define HCD_MAX_XFER 16
-
-typedef struct {
+typedef struct
+{
uint8_t rhport;
uint8_t hub_addr;
uint8_t hub_port;
uint8_t speed;
} hcd_devtree_info_t;
-#endif
-
//--------------------------------------------------------------------+
// Controller API
//--------------------------------------------------------------------+
diff --git a/src/host/hub.c b/src/host/hub.c
index 53eb1d521..9e546f6f7 100644
--- a/src/host/hub.c
+++ b/src/host/hub.c
@@ -54,7 +54,7 @@ static inline hub_interface_t* get_itf(uint8_t dev_addr)
return &hub_data[dev_addr-1-CFG_TUH_DEVICE_MAX];
}
-#if CFG_TUSB_DEBUG
+#if CFG_TUSB_DEBUG >= 2
static char const* const _hub_feature_str[] =
{
[HUB_FEATURE_PORT_CONNECTION ] = "PORT_CONNECTION",
@@ -77,7 +77,8 @@ static char const* const _hub_feature_str[] =
//--------------------------------------------------------------------+
// HUB
//--------------------------------------------------------------------+
-bool hub_port_clear_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature, tuh_control_complete_cb_t complete_cb)
+bool hub_port_clear_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
{
tusb_control_request_t const request =
{
@@ -93,12 +94,23 @@ bool hub_port_clear_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
.wLength = 0
};
+ tuh_xfer_t xfer =
+ {
+ .daddr = hub_addr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = NULL,
+ .complete_cb = complete_cb,
+ .user_data = user_data
+ };
+
TU_LOG2("HUB Clear Feature: %s, addr = %u port = %u\r\n", _hub_feature_str[feature], hub_addr, hub_port);
- TU_ASSERT( tuh_control_xfer(hub_addr, &request, NULL, complete_cb) );
+ TU_ASSERT( tuh_control_xfer(&xfer) );
return true;
}
-bool hub_port_set_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature, tuh_control_complete_cb_t complete_cb)
+bool hub_port_set_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
{
tusb_control_request_t const request =
{
@@ -114,17 +126,23 @@ bool hub_port_set_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature, t
.wLength = 0
};
+ tuh_xfer_t xfer =
+ {
+ .daddr = hub_addr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = NULL,
+ .complete_cb = complete_cb,
+ .user_data = user_data
+ };
+
TU_LOG2("HUB Set Feature: %s, addr = %u port = %u\r\n", _hub_feature_str[feature], hub_addr, hub_port);
- TU_ASSERT( tuh_control_xfer(hub_addr, &request, NULL, complete_cb) );
+ TU_ASSERT( tuh_control_xfer(&xfer) );
return true;
}
-bool hub_port_reset(uint8_t hub_addr, uint8_t hub_port, tuh_control_complete_cb_t complete_cb)
-{
- return hub_port_set_feature(hub_addr, hub_port, HUB_FEATURE_PORT_RESET, complete_cb);
-}
-
-bool hub_port_get_status(uint8_t hub_addr, uint8_t hub_port, void* resp, tuh_control_complete_cb_t complete_cb)
+bool hub_port_get_status(uint8_t hub_addr, uint8_t hub_port, void* resp,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
{
tusb_control_request_t const request =
{
@@ -140,8 +158,18 @@ bool hub_port_get_status(uint8_t hub_addr, uint8_t hub_port, void* resp, tuh_con
.wLength = 4
};
+ tuh_xfer_t xfer =
+ {
+ .daddr = hub_addr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = resp,
+ .complete_cb = complete_cb,
+ .user_data = user_data
+ };
+
TU_LOG2("HUB Get Port Status: addr = %u port = %u\r\n", hub_addr, hub_port);
- TU_ASSERT( tuh_control_xfer( hub_addr, &request, resp, complete_cb) );
+ TU_ASSERT( tuh_control_xfer(&xfer) );
return true;
}
@@ -155,6 +183,8 @@ void hub_init(void)
bool hub_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *itf_desc, uint16_t max_len)
{
+ (void) rhport;
+
TU_VERIFY(TUSB_CLASS_HUB == itf_desc->bInterfaceClass &&
0 == itf_desc->bInterfaceSubClass);
@@ -171,7 +201,7 @@ bool hub_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *itf
TU_ASSERT(TUSB_DESC_ENDPOINT == desc_ep->bDescriptorType &&
TUSB_XFER_INTERRUPT == desc_ep->bmAttributes.xfer, 0);
- TU_ASSERT(usbh_edpt_open(rhport, dev_addr, desc_ep));
+ TU_ASSERT(tuh_edpt_open(dev_addr, desc_ep));
hub_interface_t* p_hub = get_itf(dev_addr);
@@ -189,7 +219,7 @@ void hub_close(uint8_t dev_addr)
if (p_hub->ep_in) tu_memclr(p_hub, sizeof( hub_interface_t));
}
-bool hub_status_pipe_queue(uint8_t dev_addr)
+bool hub_edpt_status_xfer(uint8_t dev_addr)
{
hub_interface_t* hub_itf = get_itf(dev_addr);
return usbh_edpt_xfer(dev_addr, hub_itf->ep_in, &hub_itf->status_change, 1);
@@ -200,8 +230,8 @@ bool hub_status_pipe_queue(uint8_t dev_addr)
// Set Configure
//--------------------------------------------------------------------+
-static bool config_set_port_power (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool config_port_power_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
+static void config_set_port_power (tuh_xfer_t* xfer);
+static void config_port_power_complete (tuh_xfer_t* xfer);
bool hub_set_config(uint8_t dev_addr, uint8_t itf_num)
{
@@ -223,17 +253,27 @@ bool hub_set_config(uint8_t dev_addr, uint8_t itf_num)
.wLength = sizeof(descriptor_hub_desc_t)
};
- TU_ASSERT( tuh_control_xfer(dev_addr, &request, _hub_buffer, config_set_port_power) );
+ tuh_xfer_t xfer =
+ {
+ .daddr = dev_addr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = _hub_buffer,
+ .complete_cb = config_set_port_power,
+ .user_data = 0
+ };
+
+ TU_ASSERT( tuh_control_xfer(&xfer) );
return true;
}
-static bool config_set_port_power (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
+static void config_set_port_power (tuh_xfer_t* xfer)
{
- (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
+ TU_ASSERT(XFER_RESULT_SUCCESS == xfer->result, );
- hub_interface_t* p_hub = get_itf(dev_addr);
+ uint8_t const daddr = xfer->daddr;
+ hub_interface_t* p_hub = get_itf(daddr);
// only use number of ports in hub descriptor
descriptor_hub_desc_t const* desc_hub = (descriptor_hub_desc_t const*) _hub_buffer;
@@ -243,38 +283,38 @@ static bool config_set_port_power (uint8_t dev_addr, tusb_control_request_t cons
// Set Port Power to be able to detect connection, starting with port 1
uint8_t const hub_port = 1;
- return hub_port_set_feature(dev_addr, hub_port, HUB_FEATURE_PORT_POWER, config_port_power_complete);
+ hub_port_set_feature(daddr, hub_port, HUB_FEATURE_PORT_POWER, config_port_power_complete, 0);
}
-static bool config_port_power_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
+static void config_port_power_complete (tuh_xfer_t* xfer)
{
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
- hub_interface_t* p_hub = get_itf(dev_addr);
+ TU_ASSERT(XFER_RESULT_SUCCESS == xfer->result, );
+
+ uint8_t const daddr = xfer->daddr;
+ hub_interface_t* p_hub = get_itf(daddr);
- if (request->wIndex == p_hub->port_count)
+ if (xfer->setup->wIndex == p_hub->port_count)
{
// All ports are power -> queue notification status endpoint and
// complete the SET CONFIGURATION
- TU_ASSERT( usbh_edpt_xfer(dev_addr, p_hub->ep_in, &p_hub->status_change, 1) );
+ TU_ASSERT( usbh_edpt_xfer(daddr, p_hub->ep_in, &p_hub->status_change, 1), );
- usbh_driver_set_config_complete(dev_addr, p_hub->itf_num);
+ usbh_driver_set_config_complete(daddr, p_hub->itf_num);
}else
{
// power next port
- uint8_t const hub_port = (uint8_t) (request->wIndex + 1);
- return hub_port_set_feature(dev_addr, hub_port, HUB_FEATURE_PORT_POWER, config_port_power_complete);
+ uint8_t const hub_port = (uint8_t) (xfer->setup->wIndex + 1);
+ hub_port_set_feature(daddr, hub_port, HUB_FEATURE_PORT_POWER, config_port_power_complete, 0);
}
-
- return true;
}
//--------------------------------------------------------------------+
// Connection Changes
//--------------------------------------------------------------------+
-static bool connection_get_status_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool connection_clear_conn_change_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool connection_port_reset_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
+static void connection_get_status_complete (tuh_xfer_t* xfer);
+static void connection_clear_conn_change_complete (tuh_xfer_t* xfer);
+static void connection_port_reset_complete (tuh_xfer_t* xfer);
// callback as response of interrupt endpoint polling
bool hub_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes)
@@ -292,7 +332,7 @@ bool hub_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint32
{
if ( tu_bit_test(p_hub->status_change, port) )
{
- hub_port_get_status(dev_addr, port, &p_hub->port_status, connection_get_status_complete);
+ hub_port_get_status(dev_addr, port, &p_hub->port_status, connection_get_status_complete, 0);
break;
}
}
@@ -302,12 +342,13 @@ bool hub_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint32
return true;
}
-static bool connection_get_status_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
+static void connection_get_status_complete (tuh_xfer_t* xfer)
{
- TU_ASSERT(result == XFER_RESULT_SUCCESS);
+ TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
- hub_interface_t* p_hub = get_itf(dev_addr);
- uint8_t const port_num = (uint8_t) request->wIndex;
+ uint8_t const daddr = xfer->daddr;
+ hub_interface_t* p_hub = get_itf(daddr);
+ uint8_t const port_num = (uint8_t) tu_le16toh(xfer->setup->wIndex);
// Connection change
if (p_hub->port_status.change.connection)
@@ -316,7 +357,7 @@ static bool connection_get_status_complete (uint8_t dev_addr, tusb_control_reque
//TU_VERIFY(port_status.status_current.port_power && port_status.status_current.port_enable, );
// Acknowledge Port Connection Change
- hub_port_clear_feature(dev_addr, port_num, HUB_FEATURE_PORT_CONNECTION_CHANGE, connection_clear_conn_change_complete);
+ hub_port_clear_feature(daddr, port_num, HUB_FEATURE_PORT_CONNECTION_CHANGE, connection_clear_conn_change_complete, 0);
}else
{
// Other changes are: Enable, Suspend, Over Current, Reset, L1 state
@@ -324,65 +365,61 @@ static bool connection_get_status_complete (uint8_t dev_addr, tusb_control_reque
// prepare for next hub status
// TODO continue with status_change, or maybe we can do it again with status
- hub_status_pipe_queue(dev_addr);
+ hub_edpt_status_xfer(daddr);
}
-
- return true;
}
-static bool connection_clear_conn_change_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
+static void connection_clear_conn_change_complete (tuh_xfer_t* xfer)
{
- TU_ASSERT(result == XFER_RESULT_SUCCESS);
+ TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
- hub_interface_t* p_hub = get_itf(dev_addr);
- uint8_t const port_num = (uint8_t) request->wIndex;
+ uint8_t const daddr = xfer->daddr;
+ hub_interface_t* p_hub = get_itf(daddr);
+ uint8_t const port_num = (uint8_t) tu_le16toh(xfer->setup->wIndex);
if ( p_hub->port_status.status.connection )
{
// Reset port if attach event
- hub_port_reset(dev_addr, port_num, connection_port_reset_complete);
+ hub_port_reset(daddr, port_num, connection_port_reset_complete, 0);
}else
{
// submit detach event
hcd_event_t event =
{
- .rhport = usbh_get_rhport(dev_addr),
+ .rhport = usbh_get_rhport(daddr),
.event_id = HCD_EVENT_DEVICE_REMOVE,
.connection =
{
- .hub_addr = dev_addr,
+ .hub_addr = daddr,
.hub_port = port_num
}
};
hcd_event_handler(&event, false);
}
-
- return true;
}
-static bool connection_port_reset_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
+static void connection_port_reset_complete (tuh_xfer_t* xfer)
{
- TU_ASSERT(result == XFER_RESULT_SUCCESS);
+ TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
- // hub_interface_t* p_hub = get_itf(dev_addr);
- uint8_t const port_num = (uint8_t) request->wIndex;
+ uint8_t const daddr = xfer->daddr;
+ // hub_interface_t* p_hub = get_itf(daddr);
+ uint8_t const port_num = (uint8_t) tu_le16toh(xfer->setup->wIndex);
// submit attach event
hcd_event_t event =
{
- .rhport = usbh_get_rhport(dev_addr),
+ .rhport = usbh_get_rhport(daddr),
.event_id = HCD_EVENT_DEVICE_ATTACH,
.connection =
{
- .hub_addr = dev_addr,
+ .hub_addr = daddr,
.hub_port = port_num
}
};
hcd_event_handler(&event, false);
-
- return true;
}
#endif
diff --git a/src/host/hub.h b/src/host/hub.h
index c4d544193..390740e1f 100644
--- a/src/host/hub.h
+++ b/src/host/hub.h
@@ -171,12 +171,35 @@ typedef struct {
TU_VERIFY_STATIC( sizeof(hub_port_status_response_t) == 4, "size is not correct");
-bool hub_port_clear_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature, tuh_control_complete_cb_t complete_cb);
-bool hub_port_set_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature, tuh_control_complete_cb_t complete_cb);
+// Clear feature
+bool hub_port_clear_feature (uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Set feature
+bool hub_port_set_feature (uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get port status
+bool hub_port_get_status (uint8_t hub_addr, uint8_t hub_port, void* resp,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get status from Interrupt endpoint
+bool hub_edpt_status_xfer(uint8_t dev_addr);
+
+// Reset a port
+static inline bool hub_port_reset(uint8_t hub_addr, uint8_t hub_port,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ return hub_port_set_feature(hub_addr, hub_port, HUB_FEATURE_PORT_RESET, complete_cb, user_data);
+}
+
+// Clear Reset Change
+static inline bool hub_port_clear_reset_change(uint8_t hub_addr, uint8_t hub_port,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ return hub_port_clear_feature(hub_addr, hub_port, HUB_FEATURE_PORT_RESET_CHANGE, complete_cb, user_data);
+}
-bool hub_port_reset(uint8_t hub_addr, uint8_t hub_port, tuh_control_complete_cb_t complete_cb);
-bool hub_port_get_status(uint8_t hub_addr, uint8_t hub_port, void* resp, tuh_control_complete_cb_t complete_cb);
-bool hub_status_pipe_queue(uint8_t dev_addr);
//--------------------------------------------------------------------+
// Internal Class Driver API
diff --git a/src/host/usbh.c b/src/host/usbh.c
index 1f2a19527..b388a4c08 100644
--- a/src/host/usbh.c
+++ b/src/host/usbh.c
@@ -29,6 +29,8 @@
#if CFG_TUH_ENABLED
#include "tusb.h"
+#include "common/tusb_private.h"
+
#include "host/usbh.h"
#include "host/usbh_classdriver.h"
#include "hub.h"
@@ -37,15 +39,14 @@
// USBH Configuration
//--------------------------------------------------------------------+
-// TODO remove,update
-#ifndef CFG_TUH_EP_MAX
-#define CFG_TUH_EP_MAX 9
-#endif
-
#ifndef CFG_TUH_TASK_QUEUE_SZ
#define CFG_TUH_TASK_QUEUE_SZ 16
#endif
+#ifndef CFG_TUH_INTERFACE_MAX
+#define CFG_TUH_INTERFACE_MAX 8
+#endif
+
// Debug level of USBD
#define USBH_DBG_LVL 2
@@ -54,6 +55,7 @@
//--------------------------------------------------------------------+
// device0 struct must be strictly a subset of normal device struct
+// TODO refactor later
typedef struct
{
// port
@@ -64,64 +66,58 @@ typedef struct
struct TU_ATTR_PACKED
{
- volatile uint8_t connected : 1;
- volatile uint8_t addressed : 1;
- volatile uint8_t configured : 1;
- volatile uint8_t suspended : 1;
+ volatile uint8_t connected : 1;
+ volatile uint8_t addressed : 1;
+ volatile uint8_t configured : 1;
+ volatile uint8_t suspended : 1;
};
+
} usbh_dev0_t;
typedef struct {
- // port
+ // port, must be same layout as usbh_dev0_t
uint8_t rhport;
uint8_t hub_addr;
uint8_t hub_port;
uint8_t speed;
- struct TU_ATTR_PACKED
- {
- volatile uint8_t connected : 1;
- volatile uint8_t addressed : 1;
- volatile uint8_t configured : 1;
- volatile uint8_t suspended : 1;
+ // Device State
+ struct TU_ATTR_PACKED {
+ volatile uint8_t connected : 1;
+ volatile uint8_t addressed : 1;
+ volatile uint8_t configured : 1;
+ volatile uint8_t suspended : 1;
};
- //------------- device descriptor -------------//
+ // Device Descriptor
+ uint8_t ep0_size;
+
uint16_t vid;
uint16_t pid;
- uint8_t ep0_size;
uint8_t i_manufacturer;
uint8_t i_product;
uint8_t i_serial;
- //------------- configuration descriptor -------------//
+ // Configuration Descriptor
// uint8_t interface_count; // bNumInterfaces alias
- //------------- device -------------//
- volatile uint8_t state; // device state, value from enum tusbh_device_state_t
-
- uint8_t itf2drv[16]; // map interface number to driver (0xff is invalid)
- uint8_t ep2drv[CFG_TUH_EP_MAX][2]; // map endpoint to driver ( 0xff is invalid )
-
- struct TU_ATTR_PACKED
- {
- volatile bool busy : 1;
- volatile bool stalled : 1;
- volatile bool claimed : 1;
+ // Endpoint & Interface
+ uint8_t itf2drv[CFG_TUH_INTERFACE_MAX]; // map interface number to driver (0xff is invalid)
+ uint8_t ep2drv[CFG_TUH_ENDPOINT_MAX][2]; // map endpoint to driver ( 0xff is invalid ), can use only 4-bit each
- // TODO merge ep2drv here, 4-bit should be sufficient
- }ep_status[CFG_TUH_EP_MAX][2];
+ tu_edpt_state_t ep_status[CFG_TUH_ENDPOINT_MAX][2];
- // Mutex for claiming endpoint, only needed when using with preempted RTOS
-#if CFG_TUSB_OS != OPT_OS_NONE
- osal_mutex_def_t mutexdef;
- osal_mutex_t mutex;
+#if CFG_TUH_API_EDPT_XFER
+ // TODO array can be CFG_TUH_ENDPOINT_MAX-1
+ struct {
+ tuh_xfer_cb_t complete_cb;
+ uintptr_t user_data;
+ }ep_callback[CFG_TUH_ENDPOINT_MAX][2];
#endif
} usbh_device_t;
-
//--------------------------------------------------------------------+
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
@@ -204,6 +200,9 @@ enum { CONFIG_NUM = 1 }; // default to use configuration 1
// INTERNAL OBJECT & FUNCTION DECLARATION
//--------------------------------------------------------------------+
+// sum of end device + hub
+#define TOTAL_DEVICES (CFG_TUH_DEVICE_MAX + CFG_TUH_HUB)
+
static bool _usbh_initialized = false;
// Device with address = 0 for enumeration
@@ -211,46 +210,86 @@ static usbh_dev0_t _dev0;
// all devices excluding zero-address
// hub address start from CFG_TUH_DEVICE_MAX+1
-CFG_TUSB_MEM_SECTION usbh_device_t _usbh_devices[CFG_TUH_DEVICE_MAX + CFG_TUH_HUB];
+// TODO: hub can has its own simpler struct to save memory
+CFG_TUSB_MEM_SECTION usbh_device_t _usbh_devices[TOTAL_DEVICES];
+
+// Mutex for claiming endpoint, only needed when using with preempted RTOS
+#if TUSB_OPT_MUTEX
+static osal_mutex_def_t _usbh_mutexdef;
+static osal_mutex_t _usbh_mutex;
+
+TU_ATTR_ALWAYS_INLINE static inline void usbh_lock(void)
+{
+ osal_mutex_lock(_usbh_mutex, OSAL_TIMEOUT_WAIT_FOREVER);
+}
+
+TU_ATTR_ALWAYS_INLINE static inline void usbh_unlock(void)
+{
+ osal_mutex_unlock(_usbh_mutex);
+}
+
+#else
+
+#define _usbh_mutex NULL
+
+#define usbh_lock()
+#define usbh_unlock()
+
+#endif
// Event queue
-// role device/host is used by OS NONE for mutex (disable usb isr)
+// usbh_int_set is used as mutex in OS NONE config
OSAL_QUEUE_DEF(usbh_int_set, _usbh_qdef, CFG_TUH_TASK_QUEUE_SZ, hcd_event_t);
static osal_queue_t _usbh_q;
-CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN static uint8_t _usbh_ctrl_buf[CFG_TUH_ENUMERATION_BUFSIZE];
+CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN
+static uint8_t _usbh_ctrl_buf[CFG_TUH_ENUMERATION_BUFSIZE];
+
+// Control transfer: since most controller does not support multiple control transfer
+// on multiple devices concurrently. And control transfer is not used much except enumeration
+// We will only execute control transfer one at a time.
+struct
+{
+ tusb_control_request_t request TU_ATTR_ALIGNED(4);
+ uint8_t* buffer;
+ tuh_xfer_cb_t complete_cb;
+ uintptr_t user_data;
+
+ uint8_t daddr;
+ volatile uint8_t stage;
+ volatile uint16_t actual_len;
+}_ctrl_xfer;
//------------- Helper Function -------------//
TU_ATTR_ALWAYS_INLINE
static inline usbh_device_t* get_device(uint8_t dev_addr)
{
- TU_ASSERT(dev_addr, NULL);
+ TU_VERIFY(dev_addr > 0 && dev_addr <= TOTAL_DEVICES, NULL);
return &_usbh_devices[dev_addr-1];
}
static bool enum_new_device(hcd_event_t* event);
static void process_device_unplugged(uint8_t rhport, uint8_t hub_addr, uint8_t hub_port);
static bool usbh_edpt_control_open(uint8_t dev_addr, uint8_t max_packet_size);
-
-// from usbh_control.c
-extern bool usbh_control_xfer_cb (uint8_t dev_addr, 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);
//--------------------------------------------------------------------+
// PUBLIC API (Parameter Verification is required)
//--------------------------------------------------------------------+
bool tuh_mounted(uint8_t dev_addr)
{
- return get_device(dev_addr)->configured;
+ usbh_device_t* dev = get_device(dev_addr);
+ TU_VERIFY(dev);
+ return dev->configured;
}
bool tuh_vid_pid_get(uint8_t dev_addr, uint16_t* vid, uint16_t* pid)
{
*vid = *pid = 0;
- TU_VERIFY(tuh_mounted(dev_addr));
-
usbh_device_t const* dev = get_device(dev_addr);
+ TU_VERIFY(dev && dev->configured);
*vid = dev->vid;
*pid = dev->pid;
@@ -260,7 +299,8 @@ bool tuh_vid_pid_get(uint8_t dev_addr, uint16_t* vid, uint16_t* pid)
tusb_speed_t tuh_speed_get (uint8_t dev_addr)
{
- return (tusb_speed_t) (dev_addr ? get_device(dev_addr)->speed : _dev0.speed);
+ usbh_device_t* dev = get_device(dev_addr);
+ return (tusb_speed_t) (dev ? get_device(dev_addr)->speed : _dev0.speed);
}
#if CFG_TUSB_OS == OPT_OS_NONE
@@ -277,6 +317,13 @@ void osal_task_delay(uint32_t msec)
// CLASS-USBD API (don't require to verify parameters)
//--------------------------------------------------------------------+
+static void clear_device(usbh_device_t* dev)
+{
+ tu_memclr(dev, sizeof(usbh_device_t));
+ memset(dev->itf2drv, DRVID_INVALID, sizeof(dev->itf2drv)); // invalid mapping
+ memset(dev->ep2drv , DRVID_INVALID, sizeof(dev->ep2drv )); // invalid mapping
+}
+
bool tuh_inited(void)
{
return _usbh_initialized;
@@ -288,29 +335,32 @@ bool tuh_init(uint8_t rhport)
if (_usbh_initialized) return _usbh_initialized;
TU_LOG2("USBH init\r\n");
+ TU_LOG2_INT(sizeof(usbh_device_t));
+ TU_LOG2_INT(sizeof(hcd_event_t));
+ TU_LOG2_INT(sizeof(_ctrl_xfer));
+ TU_LOG2_INT(sizeof(tuh_xfer_t));
- tu_memclr(_usbh_devices, sizeof(_usbh_devices));
- tu_memclr(&_dev0, sizeof(_dev0));
-
- //------------- Enumeration & Reporter Task init -------------//
+ // Event queue
_usbh_q = osal_queue_create( &_usbh_qdef );
TU_ASSERT(_usbh_q != NULL);
- //------------- Semaphore, Mutex for Control Pipe -------------//
- for(uint8_t i=0; i<TU_ARRAY_SIZE(_usbh_devices); i++)
- {
- usbh_device_t * dev = &_usbh_devices[i];
-
-#if CFG_TUSB_OS != OPT_OS_NONE
- dev->mutex = osal_mutex_create(&dev->mutexdef);
- TU_ASSERT(dev->mutex);
+#if TUSB_OPT_MUTEX
+ // Mutex
+ _usbh_mutex = osal_mutex_create(&_usbh_mutexdef);
+ TU_ASSERT(_usbh_mutex);
#endif
- memset(dev->itf2drv, DRVID_INVALID, sizeof(dev->itf2drv)); // invalid mapping
- memset(dev->ep2drv , DRVID_INVALID, sizeof(dev->ep2drv )); // invalid mapping
+ // Device
+ tu_memclr(&_dev0, sizeof(_dev0));
+ tu_memclr(_usbh_devices, sizeof(_usbh_devices));
+ tu_memclr(&_ctrl_xfer, sizeof(_ctrl_xfer));
+
+ for(uint8_t i=0; i<TOTAL_DEVICES; i++)
+ {
+ clear_device(&_usbh_devices[i]);
}
- // Class drivers init
+ // Class drivers
for (uint8_t drv_id = 0; drv_id < USBH_CLASS_DRIVER_COUNT; drv_id++)
{
TU_LOG2("%s init\r\n", usbh_class_drivers[drv_id].name);
@@ -363,7 +413,7 @@ void tuh_task(void)
break;
case HCD_EVENT_DEVICE_REMOVE:
- TU_LOG2("[rh%d] USBH DEVICE REMOVED\r\n", event.rhport);
+ TU_LOG2("[%u:%u:%u] USBH DEVICE REMOVED\r\n", event.rhport, event.connection.hub_addr, event.connection.hub_port);
process_device_unplugged(event.rhport, event.connection.hub_addr, event.connection.hub_port);
#if CFG_TUH_HUB
@@ -371,7 +421,7 @@ void tuh_task(void)
if ( event.connection.hub_addr != 0)
{
// done with hub, waiting for next data on status pipe
- (void) hub_status_pipe_queue( event.connection.hub_addr );
+ (void) hub_edpt_status_xfer( event.connection.hub_addr );
}
#endif
break;
@@ -393,7 +443,9 @@ void tuh_task(void)
else
{
usbh_device_t* dev = get_device(event.dev_addr);
- dev->ep_status[epnum][ep_dir].busy = false;
+ TU_ASSERT(dev, );
+
+ dev->ep_status[epnum][ep_dir].busy = 0;
dev->ep_status[epnum][ep_dir].claimed = 0;
if ( 0 == epnum )
@@ -402,10 +454,38 @@ void tuh_task(void)
}else
{
uint8_t drv_id = dev->ep2drv[epnum][ep_dir];
- TU_ASSERT(drv_id < USBH_CLASS_DRIVER_COUNT, );
+ if(drv_id < USBH_CLASS_DRIVER_COUNT)
+ {
+ TU_LOG2("%s xfer callback\r\n", usbh_class_drivers[drv_id].name);
+ usbh_class_drivers[drv_id].xfer_cb(event.dev_addr, ep_addr, event.xfer_complete.result, event.xfer_complete.len);
+ }
+ else
+ {
+#if CFG_TUH_API_EDPT_XFER
+ tuh_xfer_cb_t complete_cb = dev->ep_callback[epnum][ep_dir].complete_cb;
+ if ( complete_cb )
+ {
+ tuh_xfer_t xfer =
+ {
+ .daddr = event.dev_addr,
+ .ep_addr = ep_addr,
+ .result = event.xfer_complete.result,
+ .actual_len = event.xfer_complete.len,
+ .buflen = 0, // not available
+ .buffer = NULL, // not available
+ .complete_cb = complete_cb,
+ .user_data = dev->ep_callback[epnum][ep_dir].user_data
+ };
+
+ complete_cb(&xfer);
+ }else
+#endif
+ {
+ // no driver/callback responsible for this transfer
+ TU_ASSERT(false, );
+ }
- TU_LOG2("%s xfer callback\r\n", usbh_class_drivers[drv_id].name);
- usbh_class_drivers[drv_id].xfer_cb(event.dev_addr, ep_addr, event.xfer_complete.result, event.xfer_complete.len);
+ }
}
}
}
@@ -421,12 +501,207 @@ void tuh_task(void)
}
//--------------------------------------------------------------------+
+// Control transfer
+//--------------------------------------------------------------------+
+
+static void _control_blocking_complete_cb(tuh_xfer_t* xfer)
+{
+ // update result
+ *((xfer_result_t*) xfer->user_data) = xfer->result;
+}
+
+// TODO timeout_ms is not supported yet
+bool tuh_control_xfer (tuh_xfer_t* xfer)
+{
+ // EP0 with setup packet
+ TU_VERIFY(xfer->ep_addr == 0 && xfer->setup);
+
+ // pre-check to help reducing mutex lock
+ TU_VERIFY(_ctrl_xfer.stage == CONTROL_STAGE_IDLE);
+
+ uint8_t const daddr = xfer->daddr;
+
+ // TODO probably better to use semaphore as resource management than mutex
+ usbh_lock();
+
+ bool const is_idle = (_ctrl_xfer.stage == CONTROL_STAGE_IDLE);
+ if (is_idle)
+ {
+ _ctrl_xfer.stage = CONTROL_STAGE_SETUP;
+ _ctrl_xfer.daddr = daddr;
+ _ctrl_xfer.actual_len = 0;
+
+ _ctrl_xfer.request = (*xfer->setup);
+ _ctrl_xfer.buffer = xfer->buffer;
+ _ctrl_xfer.complete_cb = xfer->complete_cb;
+ _ctrl_xfer.user_data = xfer->user_data;
+ }
+
+ usbh_unlock();
+
+ TU_VERIFY(is_idle);
+ const uint8_t rhport = usbh_get_rhport(daddr);
+
+ TU_LOG2("[%u:%u] %s: ", rhport, daddr, xfer->setup->bRequest <= TUSB_REQ_SYNCH_FRAME ? tu_str_std_request[xfer->setup->bRequest] : "Unknown Request");
+ TU_LOG2_VAR(&xfer->setup);
+ TU_LOG2("\r\n");
+
+ if (xfer->complete_cb)
+ {
+ if ( hcd_edpt_control_xfer )
+ {
+ _ctrl_xfer.stage = CONTROL_STAGE_ACK;
+ TU_ASSERT( hcd_edpt_control_xfer(rhport, daddr, (uint8_t const*) &_ctrl_xfer.request, _ctrl_xfer.buffer) );
+ }else
+ {
+ TU_ASSERT( hcd_setup_send(rhport, daddr, (uint8_t const*) &_ctrl_xfer.request) );
+ }
+ }else
+ {
+ // blocking if complete callback is not provided
+ // change callback to internal blocking, and result as user argument
+ volatile xfer_result_t result = XFER_RESULT_INVALID;
+
+ // use user_data to point to xfer_result_t
+ _ctrl_xfer.user_data = (uintptr_t) &result;
+ _ctrl_xfer.complete_cb = _control_blocking_complete_cb;
+
+ TU_ASSERT( hcd_setup_send(rhport, daddr, (uint8_t*) &_ctrl_xfer.request) );
+
+ while (result == XFER_RESULT_INVALID)
+ {
+ // only need to call task if not preempted RTOS
+ #if CFG_TUSB_OS == OPT_OS_NONE || CFG_TUSB_OS == OPT_OS_PICO
+ tuh_task();
+ #endif
+
+ // TODO probably some timeout to prevent hanged
+ }
+
+ // update transfer result
+ xfer->result = result;
+ xfer->actual_len = _ctrl_xfer.actual_len;
+ }
+
+ return true;
+}
+
+TU_ATTR_ALWAYS_INLINE static inline void _set_control_xfer_stage(uint8_t stage)
+{
+ usbh_lock();
+ _ctrl_xfer.stage = stage;
+ usbh_unlock();
+}
+
+static void _xfer_complete(uint8_t daddr, xfer_result_t result)
+{
+ TU_LOG2("\r\n");
+
+ // duplicate xfer since user can execute control transfer within callback
+ tusb_control_request_t const request = _ctrl_xfer.request;
+ tuh_xfer_t xfer_temp =
+ {
+ .daddr = daddr,
+ .ep_addr = 0,
+ .result = result,
+ .setup = &request,
+ .actual_len = (uint32_t) _ctrl_xfer.actual_len,
+ .buffer = _ctrl_xfer.buffer,
+ .complete_cb = _ctrl_xfer.complete_cb,
+ .user_data = _ctrl_xfer.user_data
+ };
+
+ usbh_lock();
+ _ctrl_xfer.stage = CONTROL_STAGE_IDLE;
+ usbh_unlock();
+
+ if (xfer_temp.complete_cb)
+ {
+ xfer_temp.complete_cb(&xfer_temp);
+ }
+}
+
+static bool usbh_control_xfer_cb (uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes)
+{
+ (void) ep_addr;
+
+ const uint8_t rhport = usbh_get_rhport(dev_addr);
+ tusb_control_request_t const * request = &_ctrl_xfer.request;
+
+ if (XFER_RESULT_SUCCESS != result)
+ {
+ TU_LOG2("[%u:%u] Control %s\r\n", rhport, dev_addr, result == XFER_RESULT_STALLED ? "STALLED" : "FAILED");
+
+ // terminate transfer if any stage failed
+ _xfer_complete(dev_addr, result);
+ }else
+ {
+ switch(_ctrl_xfer.stage)
+ {
+ case CONTROL_STAGE_SETUP:
+ if (request->wLength)
+ {
+ // DATA stage: initial data toggle is always 1
+ _set_control_xfer_stage(CONTROL_STAGE_DATA);
+ return hcd_edpt_xfer(rhport, dev_addr, tu_edpt_addr(0, request->bmRequestType_bit.direction), _ctrl_xfer.buffer, request->wLength);
+ }
+ __attribute__((fallthrough));
+
+ case CONTROL_STAGE_DATA:
+ if (xferred_bytes)
+ {
+ TU_LOG2("[%u:%u] Control data:\r\n", rhport, dev_addr);
+ TU_LOG2_MEM(_ctrl_xfer.buffer, xferred_bytes, 2);
+ }
+
+ _ctrl_xfer.actual_len = xferred_bytes;
+
+ // ACK stage: toggle is always 1
+ _set_control_xfer_stage(CONTROL_STAGE_ACK);
+ hcd_edpt_xfer(rhport, dev_addr, tu_edpt_addr(0, 1-request->bmRequestType_bit.direction), NULL, 0);
+ break;
+
+ case CONTROL_STAGE_ACK:
+ _xfer_complete(dev_addr, result);
+ break;
+
+ default: return false;
+ }
+ }
+
+ return true;
+}
+
+//--------------------------------------------------------------------+
+//
+//--------------------------------------------------------------------+
+
+bool tuh_edpt_xfer(tuh_xfer_t* xfer)
+{
+ uint8_t const daddr = xfer->daddr;
+ uint8_t const ep_addr = xfer->ep_addr;
+
+ TU_VERIFY(daddr && ep_addr);
+
+ TU_VERIFY(usbh_edpt_claim(daddr, ep_addr));
+
+ if ( !usbh_edpt_xfer_with_callback(daddr, ep_addr, xfer->buffer, xfer->buflen, xfer->complete_cb, xfer->user_data) )
+ {
+ usbh_edpt_release(daddr, ep_addr);
+ return false;
+ }
+
+ return true;
+}
+
+//--------------------------------------------------------------------+
// USBH API For Class Driver
//--------------------------------------------------------------------+
uint8_t usbh_get_rhport(uint8_t dev_addr)
{
- return (dev_addr == 0) ? _dev0.rhport : get_device(dev_addr)->rhport;
+ usbh_device_t* dev = get_device(dev_addr);
+ return dev ? dev->rhport : _dev0.rhport;
}
uint8_t* usbh_get_enum_buf(void)
@@ -447,15 +722,125 @@ void usbh_int_set(bool enabled)
}
//--------------------------------------------------------------------+
+// Endpoint API
+//--------------------------------------------------------------------+
+
+// TODO has some duplication code with device, refactor later
+bool usbh_edpt_claim(uint8_t dev_addr, uint8_t ep_addr)
+{
+ usbh_device_t* dev = get_device(dev_addr);
+
+ // addr0 only use tuh_control_xfer
+ TU_ASSERT(dev);
+
+ uint8_t const epnum = tu_edpt_number(ep_addr);
+ uint8_t const dir = tu_edpt_dir(ep_addr);
+
+ return tu_edpt_claim(&dev->ep_status[epnum][dir], _usbh_mutex);
+}
+
+// TODO has some duplication code with device, refactor later
+bool usbh_edpt_release(uint8_t dev_addr, uint8_t ep_addr)
+{
+ usbh_device_t* dev = get_device(dev_addr);
+
+ // addr0 only use tuh_control_xfer
+ TU_ASSERT(dev);
+
+ uint8_t const epnum = tu_edpt_number(ep_addr);
+ uint8_t const dir = tu_edpt_dir(ep_addr);
+
+ return tu_edpt_release(&dev->ep_status[epnum][dir], _usbh_mutex);
+}
+
+// TODO has some duplication code with device, refactor later
+bool usbh_edpt_xfer_with_callback(uint8_t dev_addr, uint8_t ep_addr, uint8_t * buffer, uint16_t total_bytes,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ (void) complete_cb;
+ (void) user_data;
+
+ usbh_device_t* dev = get_device(dev_addr);
+ TU_VERIFY(dev);
+
+ uint8_t const epnum = tu_edpt_number(ep_addr);
+ uint8_t const dir = tu_edpt_dir(ep_addr);
+ tu_edpt_state_t* ep_state = &dev->ep_status[epnum][dir];
+
+ TU_LOG2(" Queue EP %02X with %u bytes ... ", ep_addr, total_bytes);
+
+ // Attempt to transfer on a busy endpoint, sound like an race condition !
+ TU_ASSERT(ep_state->busy == 0);
+
+ // Set busy first since the actual transfer can be complete before hcd_edpt_xfer()
+ // could return and USBH task can preempt and clear the busy
+ ep_state->busy = 1;
+
+#if CFG_TUH_API_EDPT_XFER
+ dev->ep_callback[epnum][dir].complete_cb = complete_cb;
+ dev->ep_callback[epnum][dir].user_data = user_data;
+#endif
+
+ if ( hcd_edpt_xfer(dev->rhport, dev_addr, ep_addr, buffer, total_bytes) )
+ {
+ TU_LOG2("OK\r\n");
+ return true;
+ }else
+ {
+ // HCD error, mark endpoint as ready to allow next transfer
+ ep_state->busy = 0;
+ ep_state->claimed = 0;
+ TU_LOG1("Failed\r\n");
+ TU_BREAKPOINT();
+ return false;
+ }
+}
+
+static bool usbh_edpt_control_open(uint8_t dev_addr, uint8_t max_packet_size)
+{
+ TU_LOG2("Open EP0 with Size = %u (addr = %u)\r\n", max_packet_size, dev_addr);
+
+ tusb_desc_endpoint_t ep0_desc =
+ {
+ .bLength = sizeof(tusb_desc_endpoint_t),
+ .bDescriptorType = TUSB_DESC_ENDPOINT,
+ .bEndpointAddress = 0,
+ .bmAttributes = { .xfer = TUSB_XFER_CONTROL },
+ .wMaxPacketSize = max_packet_size,
+ .bInterval = 0
+ };
+
+ return hcd_edpt_open(usbh_get_rhport(dev_addr), dev_addr, &ep0_desc);
+}
+
+bool tuh_edpt_open(uint8_t dev_addr, tusb_desc_endpoint_t const * desc_ep)
+{
+ TU_ASSERT( tu_edpt_validate(desc_ep, tuh_speed_get(dev_addr)) );
+
+ return hcd_edpt_open(usbh_get_rhport(dev_addr), dev_addr, desc_ep);
+}
+
+bool usbh_edpt_busy(uint8_t dev_addr, uint8_t ep_addr)
+{
+ uint8_t const epnum = tu_edpt_number(ep_addr);
+ uint8_t const dir = tu_edpt_dir(ep_addr);
+
+ usbh_device_t* dev = get_device(dev_addr);
+ TU_VERIFY(dev);
+
+ return dev->ep_status[epnum][dir].busy;
+}
+
+//--------------------------------------------------------------------+
// HCD Event Handler
//--------------------------------------------------------------------+
void hcd_devtree_get_info(uint8_t dev_addr, hcd_devtree_info_t* devtree_info)
{
- if (dev_addr)
- {
- usbh_device_t const* dev = get_device(dev_addr);
+ usbh_device_t const* dev = get_device(dev_addr);
+ if (dev)
+ {
devtree_info->rhport = dev->rhport;
devtree_info->hub_addr = dev->hub_addr;
devtree_info->hub_port = dev->hub_port;
@@ -525,10 +910,232 @@ void hcd_event_device_remove(uint8_t hostid, bool in_isr)
hcd_event_handler(&event, in_isr);
}
+//--------------------------------------------------------------------+
+// Descriptors Async
+//--------------------------------------------------------------------+
+
+// generic helper to get a descriptor
+// if blocking, user_data could be pointed to xfer_result
+static bool _get_descriptor(uint8_t daddr, uint8_t type, uint8_t index, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ tusb_control_request_t const request =
+ {
+ .bmRequestType_bit =
+ {
+ .recipient = TUSB_REQ_RCPT_DEVICE,
+ .type = TUSB_REQ_TYPE_STANDARD,
+ .direction = TUSB_DIR_IN
+ },
+ .bRequest = TUSB_REQ_GET_DESCRIPTOR,
+ .wValue = tu_htole16( TU_U16(type, index) ),
+ .wIndex = tu_htole16(language_id),
+ .wLength = tu_htole16(len)
+ };
+
+ tuh_xfer_t xfer =
+ {
+ .daddr = daddr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = buffer,
+ .complete_cb = complete_cb,
+ .user_data = user_data
+ };
+
+ bool const ret = tuh_control_xfer(&xfer);
+
+ // if blocking, user_data could be pointed to xfer_result
+ if ( !complete_cb && user_data )
+ {
+ *((xfer_result_t*) user_data) = xfer.result;
+ }
+
+ return ret;
+}
+
+bool tuh_descriptor_get(uint8_t daddr, uint8_t type, uint8_t index, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ return _get_descriptor(daddr, type, index, 0x0000, buffer, len, complete_cb, user_data);
+}
+
+bool tuh_descriptor_get_device(uint8_t daddr, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ len = tu_min16(len, sizeof(tusb_desc_device_t));
+ return tuh_descriptor_get(daddr, TUSB_DESC_DEVICE, 0, buffer, len, complete_cb, user_data);
+}
+
+bool tuh_descriptor_get_configuration(uint8_t daddr, uint8_t index, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ return tuh_descriptor_get(daddr, TUSB_DESC_CONFIGURATION, index, buffer, len, complete_cb, user_data);
+}
+
+//------------- String Descriptor -------------//
+
+bool tuh_descriptor_get_string(uint8_t daddr, uint8_t index, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ return _get_descriptor(daddr, TUSB_DESC_STRING, index, language_id, buffer, len, complete_cb, user_data);
+}
+
+// Get manufacturer string descriptor
+bool tuh_descriptor_get_manufacturer_string(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ usbh_device_t const* dev = get_device(daddr);
+ TU_VERIFY(dev && dev->i_manufacturer);
+ return tuh_descriptor_get_string(daddr, dev->i_manufacturer, language_id, buffer, len, complete_cb, user_data);
+}
+
+// Get product string descriptor
+bool tuh_descriptor_get_product_string(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ usbh_device_t const* dev = get_device(daddr);
+ TU_VERIFY(dev && dev->i_product);
+ return tuh_descriptor_get_string(daddr, dev->i_product, language_id, buffer, len, complete_cb, user_data);
+}
+
+// Get serial string descriptor
+bool tuh_descriptor_get_serial_string(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ usbh_device_t const* dev = get_device(daddr);
+ TU_VERIFY(dev && dev->i_serial);
+ return tuh_descriptor_get_string(daddr, dev->i_serial, language_id, buffer, len, complete_cb, user_data);
+}
+
+// Get HID report descriptor
+// if blocking, user_data could be pointed to xfer_result
+bool tuh_descriptor_get_hid_report(uint8_t daddr, uint8_t itf_num, uint8_t desc_type, uint8_t index, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ TU_LOG2("HID Get Report Descriptor\r\n");
+ tusb_control_request_t const request =
+ {
+ .bmRequestType_bit =
+ {
+ .recipient = TUSB_REQ_RCPT_INTERFACE,
+ .type = TUSB_REQ_TYPE_STANDARD,
+ .direction = TUSB_DIR_IN
+ },
+ .bRequest = TUSB_REQ_GET_DESCRIPTOR,
+ .wValue = tu_htole16(TU_U16(desc_type, index)),
+ .wIndex = tu_htole16((uint16_t) itf_num),
+ .wLength = len
+ };
+
+ tuh_xfer_t xfer =
+ {
+ .daddr = daddr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = buffer,
+ .complete_cb = complete_cb,
+ .user_data = user_data
+ };
+
+ bool const ret = tuh_control_xfer(&xfer);
-// a device unplugged on hostid, hub_addr, hub_port
-// return true if found and unmounted device, false if cannot find
-void process_device_unplugged(uint8_t rhport, uint8_t hub_addr, uint8_t hub_port)
+ // if blocking, user_data could be pointed to xfer_result
+ if ( !complete_cb && user_data )
+ {
+ *((xfer_result_t*) user_data) = xfer.result;
+ }
+
+ return ret;
+}
+
+bool tuh_configuration_set(uint8_t daddr, uint8_t config_num,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data)
+{
+ TU_LOG2("Set Configuration = %d\r\n", config_num);
+
+ tusb_control_request_t const request =
+ {
+ .bmRequestType_bit =
+ {
+ .recipient = TUSB_REQ_RCPT_DEVICE,
+ .type = TUSB_REQ_TYPE_STANDARD,
+ .direction = TUSB_DIR_OUT
+ },
+ .bRequest = TUSB_REQ_SET_CONFIGURATION,
+ .wValue = tu_htole16(config_num),
+ .wIndex = 0,
+ .wLength = 0
+ };
+
+ tuh_xfer_t xfer =
+ {
+ .daddr = daddr,
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = NULL,
+ .complete_cb = complete_cb,
+ .user_data = user_data
+ };
+
+ return tuh_control_xfer(&xfer);
+}
+
+//--------------------------------------------------------------------+
+// Descriptor Sync
+//--------------------------------------------------------------------+
+
+#define _CONTROL_SYNC_API(_async_func, ...) \
+ xfer_result_t result = XFER_RESULT_INVALID;\
+ TU_VERIFY(_async_func(__VA_ARGS__, NULL, (uintptr_t) &result), XFER_RESULT_TIMEOUT); \
+ return (uint8_t) result
+
+uint8_t tuh_descriptor_get_sync(uint8_t daddr, uint8_t type, uint8_t index, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get, daddr, type, index, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_device_sync(uint8_t daddr, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_device, daddr, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_configuration_sync(uint8_t daddr, uint8_t index, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_configuration, daddr, index, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_hid_report_sync(uint8_t daddr, uint8_t itf_num, uint8_t desc_type, uint8_t index, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_hid_report, daddr, itf_num, desc_type, index, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_string_sync(uint8_t daddr, uint8_t index, uint16_t language_id, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_string, daddr, index, language_id, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_manufacturer_string_sync(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_manufacturer_string, daddr, language_id, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_product_string_sync(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_product_string, daddr, language_id, buffer, len);
+}
+
+uint8_t tuh_descriptor_get_serial_string_sync(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len)
+{
+ _CONTROL_SYNC_API(tuh_descriptor_get_serial_string, daddr, language_id, buffer, len);
+}
+
+//--------------------------------------------------------------------+
+//
+//--------------------------------------------------------------------+
+
+// a device unplugged from rhport:hub_addr:hub_port
+static void process_device_unplugged(uint8_t rhport, uint8_t hub_addr, uint8_t hub_port)
{
//------------- find the all devices (star-network) under port that is unplugged -------------//
// TODO mark as disconnected in ISR, also handle dev0
@@ -541,8 +1148,10 @@ void process_device_unplugged(uint8_t rhport, uint8_t hub_addr, uint8_t hub_port
if (dev->rhport == rhport &&
(hub_addr == 0 || dev->hub_addr == hub_addr) && // hub_addr == 0 & hub_port == 0 means roothub
(hub_port == 0 || dev->hub_port == hub_port) &&
- dev->state != TUSB_DEVICE_STATE_UNPLUG)
+ dev->connected)
{
+ TU_LOG2(" Address = %u\r\n", dev_addr);
+
// Invoke callback before close driver
if (tuh_umount_cb) tuh_umount_cb(dev_addr);
@@ -554,154 +1163,240 @@ void process_device_unplugged(uint8_t rhport, uint8_t hub_addr, uint8_t hub_port
}
hcd_device_close(rhport, dev_addr);
-
- // release all endpoints associated with the device
- memset(dev->itf2drv, DRVID_INVALID, sizeof(dev->itf2drv)); // invalid mapping
- memset(dev->ep2drv , DRVID_INVALID, sizeof(dev->ep2drv )); // invalid mapping
- tu_memclr(dev->ep_status, sizeof(dev->ep_status));
-
- dev->state = TUSB_DEVICE_STATE_UNPLUG;
+ clear_device(dev);
+ // abort on-going control xfer if any
+ if (_ctrl_xfer.daddr == dev_addr) _set_control_xfer_stage(CONTROL_STAGE_IDLE);
}
}
}
//--------------------------------------------------------------------+
-// INTERNAL HELPER
+// Enumeration Process
+// is a lengthy process with a series of control transfer to configure
+// newly attached device.
+// NOTE: due to the shared _usbh_ctrl_buf, we must complete enumerating
+// one device before enumerating another one.
//--------------------------------------------------------------------+
-static uint8_t get_new_address(bool is_hub)
-{
- uint8_t const start = (is_hub ? CFG_TUH_DEVICE_MAX : 0) + 1;
- uint8_t const count = (is_hub ? CFG_TUH_HUB : CFG_TUH_DEVICE_MAX);
- for (uint8_t i=0; i < count; i++)
+enum {
+ ENUM_IDLE,
+ ENUM_RESET_1, // 1st reset when attached
+ //ENUM_HUB_GET_STATUS_1,
+ ENUM_HUB_CLEAR_RESET_1,
+ ENUM_ADDR0_DEVICE_DESC,
+ ENUM_RESET_2, // 2nd reset before set address
+ ENUM_HUB_GET_STATUS_2,
+ ENUM_HUB_CLEAR_RESET_2,
+ ENUM_SET_ADDR,
+
+ ENUM_GET_DEVICE_DESC,
+ ENUM_GET_9BYTE_CONFIG_DESC,
+ ENUM_GET_FULL_CONFIG_DESC,
+ ENUM_SET_CONFIG,
+ ENUM_CONFIG_DRIVER
+};
+
+static bool enum_request_set_addr(void);
+static bool _parse_configuration_descriptor (uint8_t dev_addr, tusb_desc_configuration_t const* desc_cfg);
+static void enum_full_complete(void);
+
+// process device enumeration
+static void process_enumeration(tuh_xfer_t* xfer)
+{
+ if (XFER_RESULT_SUCCESS != xfer->result)
{
- uint8_t const addr = start + i;
- if (get_device(addr)->state == TUSB_DEVICE_STATE_UNPLUG) return addr;
+ // stop enumeration, maybe we could retry this
+ enum_full_complete();
+ return;
}
- return ADDR_INVALID;
-}
-void usbh_driver_set_config_complete(uint8_t dev_addr, uint8_t itf_num)
-{
- usbh_device_t* dev = get_device(dev_addr);
+ uint8_t const daddr = xfer->daddr;
+ uintptr_t const state = xfer->user_data;
- for(itf_num++; itf_num < sizeof(dev->itf2drv); itf_num++)
+ switch(state)
{
- // continue with next valid interface
- // TODO skip IAD binding interface such as CDCs
- uint8_t const drv_id = dev->itf2drv[itf_num];
- if (drv_id != DRVID_INVALID)
+#if CFG_TUH_HUB
+ //case ENUM_HUB_GET_STATUS_1: break;
+
+ case ENUM_HUB_CLEAR_RESET_1:
{
- usbh_class_driver_t const * driver = &usbh_class_drivers[drv_id];
- TU_LOG2("%s set config: itf = %u\r\n", driver->name, itf_num);
- driver->set_config(dev_addr, itf_num);
- break;
+ hub_port_status_response_t port_status;
+ memcpy(&port_status, _usbh_ctrl_buf, sizeof(hub_port_status_response_t));
+
+ if ( !port_status.status.connection )
+ {
+ // device unplugged while delaying, nothing else to do
+ enum_full_complete();
+ return;
+ }
+
+ _dev0.speed = (port_status.status.high_speed) ? TUSB_SPEED_HIGH :
+ (port_status.status.low_speed ) ? TUSB_SPEED_LOW : TUSB_SPEED_FULL;
+
+ // Acknowledge Port Reset Change
+ if (port_status.change.reset)
+ {
+ hub_port_clear_reset_change(_dev0.hub_addr, _dev0.hub_port, process_enumeration, ENUM_ADDR0_DEVICE_DESC);
+ }
}
- }
+ break;
- // all interface are configured
- if (itf_num == sizeof(dev->itf2drv))
- {
- // Invoke callback if available
- if (tuh_mount_cb) tuh_mount_cb(dev_addr);
- }
-}
+ case ENUM_HUB_GET_STATUS_2:
+ osal_task_delay(RESET_DELAY);
+ TU_ASSERT( hub_port_get_status(_dev0.hub_addr, _dev0.hub_port, _usbh_ctrl_buf, process_enumeration, ENUM_HUB_CLEAR_RESET_2), );
+ break;
-//--------------------------------------------------------------------+
-// Enumeration Process
-// is a lengthy process with a seires of control transfer to configure
-// newly attached device. Each step is handled by a function in this
-// section
-// TODO due to the shared _usbh_ctrl_buf, we must complete enumerating
-// one device before enumerating another one.
-//--------------------------------------------------------------------+
+ case ENUM_HUB_CLEAR_RESET_2:
+ {
+ hub_port_status_response_t port_status;
+ memcpy(&port_status, _usbh_ctrl_buf, sizeof(hub_port_status_response_t));
-static bool enum_request_addr0_device_desc(void);
-static bool enum_request_set_addr(void);
+ // Acknowledge Port Reset Change if Reset Successful
+ if (port_status.change.reset)
+ {
+ TU_ASSERT( hub_port_clear_reset_change(_dev0.hub_addr, _dev0.hub_port, process_enumeration, ENUM_SET_ADDR), );
+ }
+ }
+ break;
+#endif
-static bool enum_get_addr0_device_desc_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool enum_set_address_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool enum_get_device_desc_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool enum_get_9byte_config_desc_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool enum_get_config_desc_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool enum_set_config_complete (uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
-static bool parse_configuration_descriptor (uint8_t dev_addr, tusb_desc_configuration_t const* desc_cfg);
+ case ENUM_ADDR0_DEVICE_DESC:
+ {
+ // TODO probably doesn't need to open/close each enumeration
+ uint8_t const addr0 = 0;
+ TU_ASSERT( usbh_edpt_control_open(addr0, 8), );
-#if CFG_TUH_HUB
-static bool enum_hub_clear_reset0_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) dev_addr; (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
- enum_request_addr0_device_desc();
- return true;
-}
+ // Get first 8 bytes of device descriptor for Control Endpoint size
+ TU_LOG2("Get 8 byte of Device Descriptor\r\n");
+ TU_ASSERT(tuh_descriptor_get_device(addr0, _usbh_ctrl_buf, 8, process_enumeration, ENUM_SET_ADDR), );
+ }
+ break;
-static bool enum_hub_clear_reset1_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) dev_addr; (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
+ case ENUM_RESET_2:
+ // Reset device again before Set Address
+ TU_LOG2("Port reset \r\n");
+ if (_dev0.hub_addr == 0)
+ {
+ // connected directly to roothub
+#if !CFG_TUH_RPI_PIO_USB // skip this reset for pio-usb
+ hcd_port_reset( _dev0.rhport );
+ osal_task_delay(RESET_DELAY);
+ hcd_port_reset_end(_dev0.rhport);
+#endif
+ // TODO: fall through to SET ADDRESS, refactor later
+ }
+ #if CFG_TUH_HUB
+ else
+ {
+ // after RESET_DELAY the hub_port_reset() already complete
+ TU_ASSERT( hub_port_reset(_dev0.hub_addr, _dev0.hub_port, process_enumeration, ENUM_HUB_GET_STATUS_2), );
+ break;
+ }
+ #endif
+ __attribute__((fallthrough));
- enum_request_set_addr();
+ case ENUM_SET_ADDR:
+ enum_request_set_addr();
+ break;
- // done with hub, waiting for next data on status pipe
- (void) hub_status_pipe_queue( _dev0.hub_addr );
+ case ENUM_GET_DEVICE_DESC:
+ {
+ uint8_t const new_addr = (uint8_t) tu_le16toh(xfer->setup->wValue);
- return true;
-}
+ usbh_device_t* new_dev = get_device(new_addr);
+ TU_ASSERT(new_dev, );
+ new_dev->addressed = 1;
-static bool enum_hub_get_status1_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) dev_addr; (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
+ // TODO close device 0, may not be needed
+ hcd_device_close(_dev0.rhport, 0);
- hub_port_status_response_t port_status;
- memcpy(&port_status, _usbh_ctrl_buf, sizeof(hub_port_status_response_t));
+ // open control pipe for new address
+ TU_ASSERT( usbh_edpt_control_open(new_addr, new_dev->ep0_size), );
- // Acknowledge Port Reset Change if Reset Successful
- if (port_status.change.reset)
- {
- TU_ASSERT( hub_port_clear_feature(_dev0.hub_addr, _dev0.hub_port, HUB_FEATURE_PORT_RESET_CHANGE, enum_hub_clear_reset1_complete) );
- }
+ // Get full device descriptor
+ TU_LOG2("Get Device Descriptor\r\n");
+ TU_ASSERT(tuh_descriptor_get_device(new_addr, _usbh_ctrl_buf, sizeof(tusb_desc_device_t), process_enumeration, ENUM_GET_9BYTE_CONFIG_DESC), );
+ }
+ break;
- return true;
-}
+ case ENUM_GET_9BYTE_CONFIG_DESC:
+ {
+ tusb_desc_device_t const * desc_device = (tusb_desc_device_t const*) _usbh_ctrl_buf;
+ usbh_device_t* dev = get_device(daddr);
+ TU_ASSERT(dev, );
-static bool enum_hub_get_status0_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) dev_addr; (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
+ dev->vid = desc_device->idVendor;
+ dev->pid = desc_device->idProduct;
+ dev->i_manufacturer = desc_device->iManufacturer;
+ dev->i_product = desc_device->iProduct;
+ dev->i_serial = desc_device->iSerialNumber;
- hub_port_status_response_t port_status;
- memcpy(&port_status, _usbh_ctrl_buf, sizeof(hub_port_status_response_t));
+ // if (tuh_attach_cb) tuh_attach_cb((tusb_desc_device_t*) _usbh_ctrl_buf);
- if ( !port_status.status.connection )
- {
- // device unplugged while delaying, nothing else to do, queue hub status
- return hub_status_pipe_queue(dev_addr);
- }
+ // Get 9-byte for total length
+ uint8_t const config_idx = CONFIG_NUM - 1;
+ TU_LOG2("Get Configuration[0] Descriptor (9 bytes)\r\n");
+ TU_ASSERT( tuh_descriptor_get_configuration(daddr, config_idx, _usbh_ctrl_buf, 9, process_enumeration, ENUM_GET_FULL_CONFIG_DESC), );
+ }
+ break;
- _dev0.speed = (port_status.status.high_speed) ? TUSB_SPEED_HIGH :
- (port_status.status.low_speed ) ? TUSB_SPEED_LOW : TUSB_SPEED_FULL;
+ case ENUM_GET_FULL_CONFIG_DESC:
+ {
+ uint8_t const * desc_config = _usbh_ctrl_buf;
- // Acknowledge Port Reset Change
- if (port_status.change.reset)
- {
- hub_port_clear_feature(_dev0.hub_addr, _dev0.hub_port, HUB_FEATURE_PORT_RESET_CHANGE, enum_hub_clear_reset0_complete);
- }
+ // Use offsetof to avoid pointer to the odd/misaligned address
+ uint16_t const total_len = tu_le16toh( tu_unaligned_read16(desc_config + offsetof(tusb_desc_configuration_t, wTotalLength)) );
- return true;
+ // TODO not enough buffer to hold configuration descriptor
+ TU_ASSERT(total_len <= CFG_TUH_ENUMERATION_BUFSIZE, );
+
+ // Get full configuration descriptor
+ uint8_t const config_idx = CONFIG_NUM - 1;
+ TU_LOG2("Get Configuration[0] Descriptor\r\n");
+ TU_ASSERT( tuh_descriptor_get_configuration(daddr, config_idx, _usbh_ctrl_buf, total_len, process_enumeration, ENUM_SET_CONFIG), );
+ }
+ break;
+
+ case ENUM_SET_CONFIG:
+ // Parse configuration & set up drivers
+ // Driver open aren't allowed to make any usb transfer yet
+ TU_ASSERT( _parse_configuration_descriptor(daddr, (tusb_desc_configuration_t*) _usbh_ctrl_buf), );
+
+ TU_ASSERT( tuh_configuration_set(daddr, CONFIG_NUM, process_enumeration, ENUM_CONFIG_DRIVER), );
+ break;
+
+ case ENUM_CONFIG_DRIVER:
+ {
+ TU_LOG2("Device configured\r\n");
+ usbh_device_t* dev = get_device(daddr);
+ TU_ASSERT(dev, );
+
+ dev->configured = 1;
+
+ // Start the Set Configuration process for interfaces (itf = DRVID_INVALID)
+ // Since driver can perform control transfer within its set_config, this is done asynchronously.
+ // The process continue with next interface when class driver complete its sequence with usbh_driver_set_config_complete()
+ // TODO use separated API instead of using DRVID_INVALID
+ usbh_driver_set_config_complete(daddr, DRVID_INVALID);
+ }
+ break;
+
+ default:
+ // stop enumeration if unknown state
+ enum_full_complete();
+ break;
+ }
}
-#endif
static bool enum_new_device(hcd_event_t* event)
{
- _dev0.rhport = event->rhport; // TODO refractor integrate to device_pool
+ _dev0.rhport = event->rhport;
_dev0.hub_addr = event->connection.hub_addr;
_dev0.hub_port = event->connection.hub_port;
- //------------- connected/disconnected directly with roothub -------------//
if (_dev0.hub_addr == 0)
{
+ // connected/disconnected directly with roothub
// wait until device is stable TODO non blocking
hcd_port_reset(_dev0.rhport);
osal_task_delay(RESET_DELAY);
@@ -711,102 +1406,62 @@ static bool enum_new_device(hcd_event_t* event)
if ( !hcd_port_connect_status(_dev0.rhport) ) return true;
_dev0.speed = hcd_port_speed_get(_dev0.rhport );
- TU_LOG2("%s Speed\r\n", tusb_speed_str[_dev0.speed]);
+ TU_LOG2("%s Speed\r\n", tu_str_speed[_dev0.speed]);
+
+ // fake transfer to kick-off the enumeration process
+ tuh_xfer_t xfer;
+ xfer.daddr = 0;
+ xfer.result = XFER_RESULT_SUCCESS;
+ xfer.user_data = ENUM_ADDR0_DEVICE_DESC;
+
+ process_enumeration(&xfer);
- enum_request_addr0_device_desc();
}
#if CFG_TUH_HUB
- //------------- connected/disconnected via hub -------------//
else
{
+ // connected/disconnected via external hub
// wait until device is stable
osal_task_delay(RESET_DELAY);
- TU_ASSERT( hub_port_get_status(_dev0.hub_addr, _dev0.hub_port, _usbh_ctrl_buf, enum_hub_get_status0_complete) );
+
+ // ENUM_HUB_GET_STATUS
+ //TU_ASSERT( hub_port_get_status(_dev0.hub_addr, _dev0.hub_port, _usbh_ctrl_buf, enum_hub_get_status0_complete, 0) );
+ TU_ASSERT( hub_port_get_status(_dev0.hub_addr, _dev0.hub_port, _usbh_ctrl_buf, process_enumeration, ENUM_HUB_CLEAR_RESET_1) );
}
-#endif // CFG_TUH_HUB
+#endif // hub
return true;
}
-static bool enum_request_addr0_device_desc(void)
+TU_ATTR_ALWAYS_INLINE
+static inline bool is_hub_addr(uint8_t daddr)
{
- // TODO probably doesn't need to open/close each enumeration
- uint8_t const addr0 = 0;
- TU_ASSERT( usbh_edpt_control_open(addr0, 8) );
-
- //------------- Get first 8 bytes of device descriptor to get Control Endpoint Size -------------//
- TU_LOG2("Get 8 byte of Device Descriptor\r\n");
- tusb_control_request_t const request =
- {
- .bmRequestType_bit =
- {
- .recipient = TUSB_REQ_RCPT_DEVICE,
- .type = TUSB_REQ_TYPE_STANDARD,
- .direction = TUSB_DIR_IN
- },
- .bRequest = TUSB_REQ_GET_DESCRIPTOR,
- .wValue = TUSB_DESC_DEVICE << 8,
- .wIndex = 0,
- .wLength = 8
- };
- TU_ASSERT( tuh_control_xfer(addr0, &request, _usbh_ctrl_buf, enum_get_addr0_device_desc_complete) );
-
- return true;
+ return daddr > CFG_TUH_DEVICE_MAX;
}
-// After Get Device Descriptor of Address 0
-static bool enum_get_addr0_device_desc_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
+static uint8_t get_new_address(bool is_hub)
{
- (void) request;
- TU_ASSERT(0 == dev_addr);
-
- if (XFER_RESULT_SUCCESS != result)
+ uint8_t start;
+ uint8_t end;
+ if ( is_hub )
{
-#if CFG_TUH_HUB
- // TODO remove, waiting for next data on status pipe
- if (_dev0.hub_addr != 0) hub_status_pipe_queue(_dev0.hub_addr);
-#endif
-
- return false;
- }
-
- tusb_desc_device_t const * desc_device = (tusb_desc_device_t const*) _usbh_ctrl_buf;
- TU_ASSERT( tu_desc_type(desc_device) == TUSB_DESC_DEVICE );
-
- // Reset device again before Set Address
- // reset port after 8 byte descriptor
- TU_LOG2("Port reset \r\n");
-
- if (_dev0.hub_addr == 0)
+ start = CFG_TUH_DEVICE_MAX;
+ end = start + CFG_TUH_HUB;
+ }else
{
-#if !CFG_TUH_RPI_PIO_USB // skip this reset for pio-usb
- // connected directly to roothub
- hcd_port_reset(_dev0.rhport);
- osal_task_delay(RESET_DELAY);
- hcd_port_reset_end(_dev0.rhport);
-#endif
-
- enum_request_set_addr();
+ start = 0;
+ end = start + CFG_TUH_DEVICE_MAX;
}
-#if CFG_TUH_HUB
- else
- {
- // after RESET_DELAY the hub_port_reset() already complete
- TU_ASSERT( hub_port_reset(_dev0.hub_addr, _dev0.hub_port, NULL) );
- osal_task_delay(RESET_DELAY);
-
- tuh_task(); // FIXME temporarily to clean up port_reset control transfer
- TU_ASSERT( hub_port_get_status(_dev0.hub_addr, _dev0.hub_port, _usbh_ctrl_buf, enum_hub_get_status1_complete) );
+ for ( uint8_t idx = start; idx < end; idx++)
+ {
+ if (!_usbh_devices[idx].connected) return (idx+1);
}
-#endif
-
- return true;
+ return ADDR_INVALID;
}
static bool enum_request_set_addr(void)
{
- uint8_t const addr0 = 0;
tusb_desc_device_t const * desc_device = (tusb_desc_device_t const*) _usbh_ctrl_buf;
// Get new address
@@ -824,7 +1479,7 @@ static bool enum_request_set_addr(void)
new_dev->connected = 1;
new_dev->ep0_size = desc_device->bMaxPacketSize0;
- tusb_control_request_t const new_request =
+ tusb_control_request_t const request =
{
.bmRequestType_bit =
{
@@ -833,174 +1488,27 @@ static bool enum_request_set_addr(void)
.direction = TUSB_DIR_OUT
},
.bRequest = TUSB_REQ_SET_ADDRESS,
- .wValue = new_addr,
+ .wValue = tu_htole16(new_addr),
.wIndex = 0,
.wLength = 0
};
- TU_ASSERT( tuh_control_xfer(addr0, &new_request, NULL, enum_set_address_complete) );
-
- return true;
-}
-
-// After SET_ADDRESS is complete
-static bool enum_set_address_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- TU_ASSERT(0 == dev_addr);
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
-
- uint8_t const new_addr = (uint8_t const) request->wValue;
-
- usbh_device_t* new_dev = get_device(new_addr);
- new_dev->addressed = 1;
-
- // TODO close device 0, may not be needed
- hcd_device_close(_dev0.rhport, 0);
-
- // open control pipe for new address
- TU_ASSERT( usbh_edpt_control_open(new_addr, new_dev->ep0_size) );
-
- // Get full device descriptor
- TU_LOG2("Get Device Descriptor\r\n");
- tusb_control_request_t const new_request =
+ tuh_xfer_t xfer =
{
- .bmRequestType_bit =
- {
- .recipient = TUSB_REQ_RCPT_DEVICE,
- .type = TUSB_REQ_TYPE_STANDARD,
- .direction = TUSB_DIR_IN
- },
- .bRequest = TUSB_REQ_GET_DESCRIPTOR,
- .wValue = TUSB_DESC_DEVICE << 8,
- .wIndex = 0,
- .wLength = sizeof(tusb_desc_device_t)
+ .daddr = 0, // dev0
+ .ep_addr = 0,
+ .setup = &request,
+ .buffer = NULL,
+ .complete_cb = process_enumeration,
+ .user_data = ENUM_GET_DEVICE_DESC
};
- TU_ASSERT(tuh_control_xfer(new_addr, &new_request, _usbh_ctrl_buf, enum_get_device_desc_complete));
+ TU_ASSERT( tuh_control_xfer(&xfer) );
return true;
}
-static bool enum_get_device_desc_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
-
- tusb_desc_device_t const * desc_device = (tusb_desc_device_t const*) _usbh_ctrl_buf;
- usbh_device_t* dev = get_device(dev_addr);
-
- dev->vid = desc_device->idVendor;
- dev->pid = desc_device->idProduct;
- dev->i_manufacturer = desc_device->iManufacturer;
- dev->i_product = desc_device->iProduct;
- dev->i_serial = desc_device->iSerialNumber;
-
-// if (tuh_attach_cb) tuh_attach_cb((tusb_desc_device_t*) _usbh_ctrl_buf);
-
- TU_LOG2("Get 9 bytes of Configuration Descriptor\r\n");
- tusb_control_request_t const new_request =
- {
- .bmRequestType_bit =
- {
- .recipient = TUSB_REQ_RCPT_DEVICE,
- .type = TUSB_REQ_TYPE_STANDARD,
- .direction = TUSB_DIR_IN
- },
- .bRequest = TUSB_REQ_GET_DESCRIPTOR,
- .wValue = (TUSB_DESC_CONFIGURATION << 8) | (CONFIG_NUM - 1),
- .wIndex = 0,
- .wLength = 9
- };
-
- TU_ASSERT( tuh_control_xfer(dev_addr, &new_request, _usbh_ctrl_buf, enum_get_9byte_config_desc_complete) );
-
- return true;
-}
-
-static bool enum_get_9byte_config_desc_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
-
- // TODO not enough buffer to hold configuration descriptor
- uint8_t const * desc_config = _usbh_ctrl_buf;
-
- // Use offsetof to avoid pointer to the odd/misaligned address
- uint16_t const total_len = tu_le16toh( tu_unaligned_read16(desc_config + offsetof(tusb_desc_configuration_t, wTotalLength)) );
-
- TU_ASSERT(total_len <= CFG_TUH_ENUMERATION_BUFSIZE);
-
- // Get full configuration descriptor
- TU_LOG2("Get Configuration Descriptor\r\n");
- tusb_control_request_t const new_request =
- {
- .bmRequestType_bit =
- {
- .recipient = TUSB_REQ_RCPT_DEVICE,
- .type = TUSB_REQ_TYPE_STANDARD,
- .direction = TUSB_DIR_IN
- },
- .bRequest = TUSB_REQ_GET_DESCRIPTOR,
- .wValue = (TUSB_DESC_CONFIGURATION << 8) | (CONFIG_NUM - 1),
- .wIndex = 0,
- .wLength = total_len
-
- };
-
- TU_ASSERT( tuh_control_xfer(dev_addr, &new_request, _usbh_ctrl_buf, enum_get_config_desc_complete) );
-
- return true;
-}
-
-static bool enum_get_config_desc_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
-
- // Parse configuration & set up drivers
- // Driver open aren't allowed to make any usb transfer yet
- TU_ASSERT( parse_configuration_descriptor(dev_addr, (tusb_desc_configuration_t*) _usbh_ctrl_buf) );
-
- TU_LOG2("Set Configuration = %d\r\n", CONFIG_NUM);
- tusb_control_request_t const new_request =
- {
- .bmRequestType_bit =
- {
- .recipient = TUSB_REQ_RCPT_DEVICE,
- .type = TUSB_REQ_TYPE_STANDARD,
- .direction = TUSB_DIR_OUT
- },
- .bRequest = TUSB_REQ_SET_CONFIGURATION,
- .wValue = CONFIG_NUM,
- .wIndex = 0,
- .wLength = 0
- };
-
- TU_ASSERT( tuh_control_xfer(dev_addr, &new_request, NULL, enum_set_config_complete) );
-
- return true;
-}
-
-static bool enum_set_config_complete(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result)
-{
- (void) request;
- TU_ASSERT(XFER_RESULT_SUCCESS == result);
-
- TU_LOG2("Device configured\r\n");
- usbh_device_t* dev = get_device(dev_addr);
- dev->configured = 1;
- dev->state = TUSB_DEVICE_STATE_CONFIGURED;
-
- // Start the Set Configuration process for interfaces (itf = DRVID_INVALID)
- // Since driver can perform control transfer within its set_config, this is done asynchronously.
- // The process continue with next interface when class driver complete its sequence with usbh_driver_set_config_complete()
- // TODO use separated API instead of using DRVID_INVALID
- usbh_driver_set_config_complete(dev_addr, DRVID_INVALID);
-
- return true;
-}
-
-static bool parse_configuration_descriptor(uint8_t dev_addr, tusb_desc_configuration_t const* desc_cfg)
+static bool _parse_configuration_descriptor(uint8_t dev_addr, tusb_desc_configuration_t const* desc_cfg)
{
usbh_device_t* dev = get_device(dev_addr);
@@ -1093,131 +1601,47 @@ static bool parse_configuration_descriptor(uint8_t dev_addr, tusb_desc_configura
return true;
}
-//--------------------------------------------------------------------+
-// Endpoint API
-//--------------------------------------------------------------------+
-
-// TODO has some duplication code with device, refactor later
-bool usbh_edpt_claim(uint8_t dev_addr, uint8_t ep_addr)
+void usbh_driver_set_config_complete(uint8_t dev_addr, uint8_t itf_num)
{
- uint8_t const epnum = tu_edpt_number(ep_addr);
- uint8_t const dir = tu_edpt_dir(ep_addr);
-
usbh_device_t* dev = get_device(dev_addr);
-#if CFG_TUSB_OS != OPT_OS_NONE
- // pre-check to help reducing mutex lock
- TU_VERIFY((dev->ep_status[epnum][dir].busy == 0) && (dev->ep_status[epnum][dir].claimed == 0));
- osal_mutex_lock(dev->mutex, OSAL_TIMEOUT_WAIT_FOREVER);
-#endif
-
- // can only claim the endpoint if it is not busy and not claimed yet.
- bool const ret = (dev->ep_status[epnum][dir].busy == 0) && (dev->ep_status[epnum][dir].claimed == 0);
- if (ret)
+ for(itf_num++; itf_num < CFG_TUH_INTERFACE_MAX; itf_num++)
{
- dev->ep_status[epnum][dir].claimed = 1;
+ // continue with next valid interface
+ // TODO skip IAD binding interface such as CDCs
+ uint8_t const drv_id = dev->itf2drv[itf_num];
+ if (drv_id != DRVID_INVALID)
+ {
+ usbh_class_driver_t const * driver = &usbh_class_drivers[drv_id];
+ TU_LOG2("%s set config: itf = %u\r\n", driver->name, itf_num);
+ driver->set_config(dev_addr, itf_num);
+ break;
+ }
}
-#if CFG_TUSB_OS != OPT_OS_NONE
- osal_mutex_unlock(dev->mutex);
-#endif
-
- return ret;
-}
-
-// TODO has some duplication code with device, refactor later
-bool usbh_edpt_release(uint8_t dev_addr, uint8_t ep_addr)
-{
- uint8_t const epnum = tu_edpt_number(ep_addr);
- uint8_t const dir = tu_edpt_dir(ep_addr);
-
- usbh_device_t* dev = get_device(dev_addr);
-
-#if CFG_TUSB_OS != OPT_OS_NONE
- osal_mutex_lock(dev->mutex, OSAL_TIMEOUT_WAIT_FOREVER);
-#endif
-
- // can only release the endpoint if it is claimed and not busy
- bool const ret = (dev->ep_status[epnum][dir].busy == 0) && (dev->ep_status[epnum][dir].claimed == 1);
- if (ret)
+ // all interface are configured
+ if (itf_num == CFG_TUH_INTERFACE_MAX)
{
- dev->ep_status[epnum][dir].claimed = 0;
- }
+ enum_full_complete();
-#if CFG_TUSB_OS != OPT_OS_NONE
- osal_mutex_unlock(dev->mutex);
+#if CFG_TUH_HUB
+ // skip device mount callback for hub
+ if ( !is_hub_addr(dev_addr) )
#endif
-
- return ret;
-}
-
-// TODO has some duplication code with device, refactor later
-bool usbh_edpt_xfer(uint8_t dev_addr, uint8_t ep_addr, uint8_t * buffer, uint16_t total_bytes)
-{
- uint8_t const epnum = tu_edpt_number(ep_addr);
- uint8_t const dir = tu_edpt_dir(ep_addr);
-
- usbh_device_t* dev = get_device(dev_addr);
-
- TU_LOG2(" Queue EP %02X with %u bytes ... ", ep_addr, total_bytes);
-
- // Attempt to transfer on a busy endpoint, sound like an race condition !
- TU_ASSERT(dev->ep_status[epnum][dir].busy == 0);
-
- // Set busy first since the actual transfer can be complete before hcd_edpt_xfer()
- // could return and USBH task can preempt and clear the busy
- dev->ep_status[epnum][dir].busy = true;
-
- if ( hcd_edpt_xfer(dev->rhport, dev_addr, ep_addr, buffer, total_bytes) )
- {
- TU_LOG2("OK\r\n");
- return true;
- }else
- {
- // HCD error, mark endpoint as ready to allow next transfer
- dev->ep_status[epnum][dir].busy = false;
- dev->ep_status[epnum][dir].claimed = 0;
- TU_LOG2("failed\r\n");
- TU_BREAKPOINT();
- return false;
+ {
+ // Invoke callback if available
+ if (tuh_mount_cb) tuh_mount_cb(dev_addr);
+ }
}
}
-static bool usbh_edpt_control_open(uint8_t dev_addr, uint8_t max_packet_size)
+static void enum_full_complete(void)
{
- TU_LOG2("Open EP0 with Size = %u (addr = %u)\r\n", max_packet_size, dev_addr);
-
- tusb_desc_endpoint_t ep0_desc =
- {
- .bLength = sizeof(tusb_desc_endpoint_t),
- .bDescriptorType = TUSB_DESC_ENDPOINT,
- .bEndpointAddress = 0,
- .bmAttributes = { .xfer = TUSB_XFER_CONTROL },
- .wMaxPacketSize = max_packet_size,
- .bInterval = 0
- };
-
- return hcd_edpt_open(usbh_get_rhport(dev_addr), dev_addr, &ep0_desc);
-}
-
-bool usbh_edpt_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_endpoint_t const * desc_ep)
-{
- usbh_device_t* dev = get_device(dev_addr);
- TU_ASSERT(tu_edpt_validate(desc_ep, (tusb_speed_t) dev->speed));
-
- return hcd_edpt_open(rhport, dev_addr, desc_ep);
-}
-
-bool usbh_edpt_busy(uint8_t dev_addr, uint8_t ep_addr)
-{
- uint8_t const epnum = tu_edpt_number(ep_addr);
- uint8_t const dir = tu_edpt_dir(ep_addr);
-
- usbh_device_t* dev = get_device(dev_addr);
+#if CFG_TUH_HUB
+ // get next hub status
+ if (_dev0.hub_addr) hub_edpt_status_xfer(_dev0.hub_addr);
+#endif
- return dev->ep_status[epnum][dir].busy;
}
-
-
#endif
diff --git a/src/host/usbh.h b/src/host/usbh.h
index 8411cad28..e883ac90b 100644
--- a/src/host/usbh.h
+++ b/src/host/usbh.h
@@ -38,7 +38,48 @@
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
-typedef bool (*tuh_control_complete_cb_t)(uint8_t dev_addr, tusb_control_request_t const * request, xfer_result_t result);
+// forward declaration
+struct tuh_xfer_s;
+typedef struct tuh_xfer_s tuh_xfer_t;
+
+typedef void (*tuh_xfer_cb_t)(tuh_xfer_t* xfer);
+
+// Note1: layout and order of this will be changed in near future
+// it is advised to initialize it using member name
+// Note2: not all field is available/meaningful in callback, some info is not saved by
+// usbh to save SRAM
+struct tuh_xfer_s
+{
+ uint8_t daddr;
+ uint8_t ep_addr;
+
+ xfer_result_t result;
+ uint32_t actual_len; // excluding setup packet
+
+ union
+ {
+ tusb_control_request_t const* setup; // setup packet pointer if control transfer
+ uint32_t buflen; // expected length if not control transfer (not available in callback)
+ };
+
+ uint8_t* buffer; // not available in callback if not control transfer
+ tuh_xfer_cb_t complete_cb;
+ uintptr_t user_data;
+
+ // uint32_t timeout_ms; // place holder, not supported yet
+};
+
+//--------------------------------------------------------------------+
+// APPLICATION CALLBACK
+//--------------------------------------------------------------------+
+
+//TU_ATTR_WEAK uint8_t tuh_attach_cb (tusb_desc_device_t const *desc_device);
+
+// Invoked when device is mounted (configured)
+TU_ATTR_WEAK void tuh_mount_cb (uint8_t daddr);
+
+/// Invoked when device is unmounted (bus reset/unplugged)
+TU_ATTR_WEAK void tuh_umount_cb(uint8_t daddr);
//--------------------------------------------------------------------+
// APPLICATION API
@@ -57,40 +98,132 @@ void tuh_task(void);
extern void hcd_int_handler(uint8_t rhport);
#define tuh_int_handler hcd_int_handler
-bool tuh_vid_pid_get(uint8_t dev_addr, uint16_t* vid, uint16_t* pid);
-tusb_speed_t tuh_speed_get(uint8_t dev_addr);
+bool tuh_vid_pid_get(uint8_t daddr, uint16_t* vid, uint16_t* pid);
+
+tusb_speed_t tuh_speed_get(uint8_t daddr);
// Check if device is connected and configured
-bool tuh_mounted(uint8_t dev_addr);
+bool tuh_mounted(uint8_t daddr);
// Check if device is suspended
-static inline bool tuh_suspended(uint8_t dev_addr)
+TU_ATTR_ALWAYS_INLINE
+static inline bool tuh_suspended(uint8_t daddr)
{
// TODO implement suspend & resume on host
- (void) dev_addr;
+ (void) daddr;
return false;
}
// Check if device is ready to communicate with
TU_ATTR_ALWAYS_INLINE
-static inline bool tuh_ready(uint8_t dev_addr)
+static inline bool tuh_ready(uint8_t daddr)
{
- return tuh_mounted(dev_addr) && !tuh_suspended(dev_addr);
+ return tuh_mounted(daddr) && !tuh_suspended(daddr);
}
-// Carry out control transfer
-bool tuh_control_xfer (uint8_t dev_addr, tusb_control_request_t const* request, void* buffer, tuh_control_complete_cb_t complete_cb);
+//--------------------------------------------------------------------+
+// Transfer API
+//--------------------------------------------------------------------+
+
+// Submit a control transfer
+// - async: complete callback invoked when finished.
+// - sync : blocking if complete callback is NULL.
+bool tuh_control_xfer(tuh_xfer_t* xfer);
+
+// Submit a bulk/interrupt transfer
+// - async: complete callback invoked when finished.
+// - sync : blocking if complete callback is NULL.
+bool tuh_edpt_xfer(tuh_xfer_t* xfer);
+
+// Open an non-control endpoint
+bool tuh_edpt_open(uint8_t dev_addr, tusb_desc_endpoint_t const * desc_ep);
+
+// Set Configuration (control transfer)
+// config_num = 0 will un-configure device. Note: config_num = config_descriptor_index + 1
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_configuration_set(uint8_t daddr, uint8_t config_num,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
//--------------------------------------------------------------------+
-// APPLICATION CALLBACK
+// Descriptors Asynchronous (non-blocking)
//--------------------------------------------------------------------+
-//TU_ATTR_WEAK uint8_t tuh_attach_cb (tusb_desc_device_t const *desc_device);
-// Invoked when device is mounted (configured)
-TU_ATTR_WEAK void tuh_mount_cb (uint8_t dev_addr);
+// Get an descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get(uint8_t daddr, uint8_t type, uint8_t index, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
-/// Invoked when device is unmounted (bus reset/unplugged)
-TU_ATTR_WEAK void tuh_umount_cb(uint8_t dev_addr);
+// Get device descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get_device(uint8_t daddr, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get configuration descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get_configuration(uint8_t daddr, uint8_t index, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get HID report descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get_hid_report(uint8_t daddr, uint8_t itf_num, uint8_t desc_type, uint8_t index, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get string descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+// Blocking if complete callback is NULL, in this case 'user_data' must contain xfer_result_t variable
+bool tuh_descriptor_get_string(uint8_t daddr, uint8_t index, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get manufacturer string descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get_manufacturer_string(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get product string descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get_product_string(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+// Get serial string descriptor (control transfer)
+// true on success, false if there is on-going control transfer or incorrect parameters
+bool tuh_descriptor_get_serial_string(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+//--------------------------------------------------------------------+
+// Descriptors Synchronous (blocking)
+//--------------------------------------------------------------------+
+
+// Sync (blocking) version of tuh_descriptor_get()
+// return transfer result
+uint8_t tuh_descriptor_get_sync(uint8_t daddr, uint8_t type, uint8_t index, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_device()
+// return transfer result
+uint8_t tuh_descriptor_get_device_sync(uint8_t daddr, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_configuration()
+// return transfer result
+uint8_t tuh_descriptor_get_configuration_sync(uint8_t daddr, uint8_t index, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_hid_report()
+// return transfer result
+uint8_t tuh_descriptor_get_hid_report_sync(uint8_t daddr, uint8_t itf_num, uint8_t desc_type, uint8_t index, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_string()
+// return transfer result
+uint8_t tuh_descriptor_get_string_sync(uint8_t daddr, uint8_t index, uint16_t language_id, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_manufacturer_string()
+// return transfer result
+uint8_t tuh_descriptor_get_manufacturer_string_sync(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_product_string()
+// return transfer result
+uint8_t tuh_descriptor_get_product_string_sync(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len);
+
+// Sync (blocking) version of tuh_descriptor_get_serial_string()
+// return transfer result
+uint8_t tuh_descriptor_get_serial_string_sync(uint8_t daddr, uint16_t language_id, void* buffer, uint16_t len);
#ifdef __cplusplus
}
diff --git a/src/host/usbh_classdriver.h b/src/host/usbh_classdriver.h
index 2f9957cc6..c156afea0 100644
--- a/src/host/usbh_classdriver.h
+++ b/src/host/usbh_classdriver.h
@@ -63,16 +63,22 @@ void usbh_int_set(bool enabled);
// USBH Endpoint API
//--------------------------------------------------------------------+
-// Open an endpoint
-bool usbh_edpt_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_endpoint_t const * desc_ep);
+// Submit a usb transfer with callback support, require CFG_TUH_API_EDPT_XFER
+bool usbh_edpt_xfer_with_callback(uint8_t dev_addr, uint8_t ep_addr, uint8_t * buffer, uint16_t total_bytes,
+ tuh_xfer_cb_t complete_cb, uintptr_t user_data);
+
+TU_ATTR_ALWAYS_INLINE
+static inline bool usbh_edpt_xfer(uint8_t dev_addr, uint8_t ep_addr, uint8_t * buffer, uint16_t total_bytes)
+{
+ return usbh_edpt_xfer_with_callback(dev_addr, ep_addr, buffer, total_bytes, NULL, 0);
+}
-// Submit a usb transfer
-bool usbh_edpt_xfer(uint8_t dev_addr, uint8_t ep_addr, uint8_t * buffer, uint16_t total_bytes);
// Claim an endpoint before submitting a transfer.
// If caller does not make any transfer, it must release endpoint for others.
bool usbh_edpt_claim(uint8_t dev_addr, uint8_t ep_addr);
+// Release claimed endpoint without submitting a transfer
bool usbh_edpt_release(uint8_t dev_addr, uint8_t ep_addr);
// Check if endpoint transferring is complete
diff --git a/src/host/usbh_control.c b/src/host/usbh_control.c
deleted file mode 100644
index 1c73d6626..000000000
--- a/src/host/usbh_control.c
+++ /dev/null
@@ -1,145 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2020, Ha Thach (tinyusb.org)
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * This file is part of the TinyUSB stack.
- */
-
-#include "tusb_option.h"
-
-#if CFG_TUH_ENABLED
-
-#include "tusb.h"
-#include "usbh_classdriver.h"
-
-enum
-{
- STAGE_SETUP,
- STAGE_DATA,
- STAGE_ACK
-};
-
-typedef struct
-{
- tusb_control_request_t request TU_ATTR_ALIGNED(4);
-
- uint8_t stage;
- uint8_t* buffer;
- tuh_control_complete_cb_t complete_cb;
-} usbh_control_xfer_t;
-
-static usbh_control_xfer_t _ctrl_xfer;
-
-//CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN
-//static uint8_t _tuh_ctrl_buf[CFG_TUH_ENUMERATION_BUFSIZE];
-
-//--------------------------------------------------------------------+
-// MACRO TYPEDEF CONSTANT ENUM DECLARATION
-//--------------------------------------------------------------------+
-
-bool tuh_control_xfer (uint8_t dev_addr, tusb_control_request_t const* request, void* buffer, tuh_control_complete_cb_t complete_cb)
-{
- // TODO need to claim the endpoint first
- const uint8_t rhport = usbh_get_rhport(dev_addr);
-
- _ctrl_xfer.request = (*request);
- _ctrl_xfer.buffer = buffer;
- _ctrl_xfer.stage = STAGE_SETUP;
- _ctrl_xfer.complete_cb = complete_cb;
-
- TU_LOG2("Control Setup (addr = %u): ", dev_addr);
- TU_LOG2_VAR(request);
- TU_LOG2("\r\n");
-
- // Send setup packet
- if ( hcd_edpt_control_xfer )
- {
- _ctrl_xfer.stage = STAGE_ACK;
- TU_ASSERT( hcd_edpt_control_xfer(rhport, dev_addr, (uint8_t const*) &_ctrl_xfer.request, buffer) );
- }else
- {
- TU_ASSERT( hcd_setup_send(rhport, dev_addr, (uint8_t const*) &_ctrl_xfer.request) );
- }
-
- return true;
-}
-
-static void _xfer_complete(uint8_t dev_addr, xfer_result_t result)
-{
- TU_LOG2("\r\n");
- if (_ctrl_xfer.complete_cb) _ctrl_xfer.complete_cb(dev_addr, &_ctrl_xfer.request, result);
-}
-
-bool usbh_control_xfer_cb (uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes)
-{
- (void) ep_addr;
- (void) xferred_bytes;
-
- const uint8_t rhport = usbh_get_rhport(dev_addr);
-
- tusb_control_request_t const * request = &_ctrl_xfer.request;
-
- if (XFER_RESULT_SUCCESS != result)
- {
- TU_LOG2("Control failed: result = %d\r\n", result);
-
- // terminate transfer if any stage failed
- _xfer_complete(dev_addr, result);
- }else
- {
- switch(_ctrl_xfer.stage)
- {
- case STAGE_SETUP:
- _ctrl_xfer.stage = STAGE_DATA;
- if (request->wLength)
- {
- // DATA stage: initial data toggle is always 1
- hcd_edpt_xfer(rhport, dev_addr, tu_edpt_addr(0, request->bmRequestType_bit.direction), _ctrl_xfer.buffer, request->wLength);
- return true;
- }
- __attribute__((fallthrough));
-
- case STAGE_DATA:
- _ctrl_xfer.stage = STAGE_ACK;
-
- if (request->wLength)
- {
- TU_LOG2("Control data (addr = %u):\r\n", dev_addr);
- TU_LOG2_MEM(_ctrl_xfer.buffer, request->wLength, 2);
- }
-
- // ACK stage: toggle is always 1
- hcd_edpt_xfer(rhport, dev_addr, tu_edpt_addr(0, 1-request->bmRequestType_bit.direction), NULL, 0);
- break;
-
- case STAGE_ACK:
- _xfer_complete(dev_addr, result);
- break;
-
- default: return false;
- }
- }
-
- return true;
-}
-
-#endif