improve hub: retry if hub interrupt endpoint failed

bump up pio-usb to latest

1 files changed, 84 insertions, 96 deletions

diff --git a/src/host/hub.c b/src/host/hub.c
index e97014443..611bf71be 100644
--- a/src/host/hub.c
+++ b/src/host/hub.c
@@ -40,29 +40,37 @@
 //--------------------------------------------------------------------+
 // MACRO CONSTANT TYPEDEF
 //--------------------------------------------------------------------+
-typedef struct
-{
+typedef struct {
   uint8_t itf_num;
   uint8_t ep_in;
-  uint8_t port_count;
+
+  // from hub descriptor
+  uint8_t bNbrPorts;
+  // uint8_t bPwrOn2PwrGood;
+  // uint16_t wHubCharacteristics;
 
   CFG_TUH_MEM_ALIGN uint8_t status_change;
   CFG_TUH_MEM_ALIGN hub_port_status_response_t port_status;
   CFG_TUH_MEM_ALIGN hub_status_response_t hub_status;
 } hub_interface_t;
 
-CFG_TUH_MEM_SECTION static hub_interface_t hub_data[CFG_TUH_HUB];
-CFG_TUH_MEM_SECTION CFG_TUH_MEM_ALIGN static uint8_t _hub_buffer[sizeof(descriptor_hub_desc_t)];
+typedef struct {
+  TUH_EPBUF_DEF(buf, CFG_TUH_HUB_BUFSIZE);
+} hub_epbuf_t;
 
-TU_ATTR_ALWAYS_INLINE
-static inline hub_interface_t* get_itf(uint8_t dev_addr)
-{
-  return &hub_data[dev_addr-1-CFG_TUH_DEVICE_MAX];
+CFG_TUH_MEM_SECTION static hub_interface_t hub_itfs[CFG_TUH_HUB];
+CFG_TUH_MEM_SECTION static hub_epbuf_t hub_epbufs[CFG_TUH_HUB];
+
+TU_ATTR_ALWAYS_INLINE static inline hub_interface_t* get_hub_itf(uint8_t daddr) {
+  return &hub_itfs[daddr-1-CFG_TUH_DEVICE_MAX];
 }
 
-#if CFG_TUSB_DEBUG >= 2
-static char const* const _hub_feature_str[] =
-{
+TU_ATTR_ALWAYS_INLINE static inline uint8_t* get_hub_epbuf(uint8_t daddr) {
+  return hub_epbufs[daddr-1-CFG_TUH_DEVICE_MAX].buf;
+}
+
+#if CFG_TUSB_DEBUG >= HUB_DEBUG
+static char const* const _hub_feature_str[] = {
   [HUB_FEATURE_PORT_CONNECTION          ] = "PORT_CONNECTION",
   [HUB_FEATURE_PORT_ENABLE              ] = "PORT_ENABLE",
   [HUB_FEATURE_PORT_SUSPEND             ] = "PORT_SUSPEND",
@@ -84,12 +92,9 @@ 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_xfer_cb_t complete_cb, uintptr_t user_data)
-{
-  tusb_control_request_t const request =
-  {
-    .bmRequestType_bit =
-    {
+                            tuh_xfer_cb_t complete_cb, uintptr_t user_data) {
+  tusb_control_request_t const request = {
+    .bmRequestType_bit = {
       .recipient = (hub_port == 0) ? TUSB_REQ_RCPT_DEVICE : TUSB_REQ_RCPT_OTHER,
       .type      = TUSB_REQ_TYPE_CLASS,
       .direction = TUSB_DIR_OUT
@@ -100,8 +105,7 @@ bool hub_port_clear_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
     .wLength  = 0
   };
 
-  tuh_xfer_t xfer =
-  {
+  tuh_xfer_t xfer = {
     .daddr       = hub_addr,
     .ep_addr     = 0,
     .setup       = &request,
@@ -110,7 +114,7 @@ bool hub_port_clear_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
     .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_LOG_DRV("HUB Clear Feature: %s, addr = %u port = %u\r\n", _hub_feature_str[feature], hub_addr, hub_port);
   TU_ASSERT( tuh_control_xfer(&xfer) );
   return true;
 }
@@ -142,7 +146,7 @@ bool hub_port_set_feature(uint8_t hub_addr, uint8_t hub_port, uint8_t feature,
     .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_LOG_DRV("HUB Set Feature: %s, addr = %u port = %u\r\n", _hub_feature_str[feature], hub_addr, hub_port);
   TU_ASSERT( tuh_control_xfer(&xfer) );
   return true;
 }
@@ -174,7 +178,7 @@ bool hub_port_get_status(uint8_t hub_addr, uint8_t hub_port, void* resp,
     .user_data   = user_data
   };
 
-  TU_LOG2("HUB Get Port Status: addr = %u port = %u\r\n", hub_addr, hub_port);
+  TU_LOG_DRV("HUB Get Port Status: addr = %u port = %u\r\n", hub_addr, hub_port);
   TU_VERIFY( tuh_control_xfer(&xfer) );
   return true;
 }
@@ -183,7 +187,7 @@ bool hub_port_get_status(uint8_t hub_addr, uint8_t hub_port, void* resp,
 // CLASS-USBH API (don't require to verify parameters)
 //--------------------------------------------------------------------+
 bool hub_init(void) {
-  tu_memclr(hub_data, sizeof(hub_data));
+  tu_memclr(hub_itfs, sizeof(hub_itfs));
   return true;
 }
 
@@ -191,40 +195,32 @@ bool hub_deinit(void) {
   return true;
 }
 
-bool hub_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *itf_desc, uint16_t max_len)
-{
+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);
+  TU_VERIFY(itf_desc->bInterfaceProtocol <= 1); // not support multiple TT yet
 
-  // hub driver does not support multiple TT yet
-  TU_VERIFY(itf_desc->bInterfaceProtocol <= 1);
-
-  // msc driver length is fixed
   uint16_t const drv_len = sizeof(tusb_desc_interface_t) + sizeof(tusb_desc_endpoint_t);
   TU_ASSERT(drv_len <= max_len);
 
-  //------------- Interrupt Status endpoint -------------//
+  // Interrupt Status endpoint
   tusb_desc_endpoint_t const *desc_ep = (tusb_desc_endpoint_t const *) tu_desc_next(itf_desc);
-
   TU_ASSERT(TUSB_DESC_ENDPOINT  == desc_ep->bDescriptorType &&
             TUSB_XFER_INTERRUPT == desc_ep->bmAttributes.xfer, 0);
-
   TU_ASSERT(tuh_edpt_open(dev_addr, desc_ep));
 
-  hub_interface_t* p_hub = get_itf(dev_addr);
-
+  hub_interface_t* p_hub = get_hub_itf(dev_addr);
   p_hub->itf_num = itf_desc->bInterfaceNumber;
   p_hub->ep_in   = desc_ep->bEndpointAddress;
 
   return true;
 }
 
-void hub_close(uint8_t dev_addr)
-{
+void hub_close(uint8_t dev_addr) {
   TU_VERIFY(dev_addr > CFG_TUH_DEVICE_MAX, );
-  hub_interface_t* p_hub = get_itf(dev_addr);
+  hub_interface_t* p_hub = get_hub_itf(dev_addr);
 
   if (p_hub->ep_in) {
     TU_LOG_DRV("  HUB close addr = %d\r\n", dev_addr);
@@ -232,30 +228,24 @@ void hub_close(uint8_t dev_addr)
   }
 }
 
-bool hub_edpt_status_xfer(uint8_t dev_addr)
-{
-  hub_interface_t* hub_itf = get_itf(dev_addr);
+bool hub_edpt_status_xfer(uint8_t dev_addr) {
+  hub_interface_t* hub_itf = get_hub_itf(dev_addr);
   return usbh_edpt_xfer(dev_addr, hub_itf->ep_in, &hub_itf->status_change, 1);
 }
 
-
 //--------------------------------------------------------------------+
 // Set Configure
 //--------------------------------------------------------------------+
-
 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)
-{
-  hub_interface_t* p_hub = get_itf(dev_addr);
+bool hub_set_config(uint8_t dev_addr, uint8_t itf_num) {
+  hub_interface_t* p_hub = get_hub_itf(dev_addr);
   TU_ASSERT(itf_num == p_hub->itf_num);
 
   // Get Hub Descriptor
-  tusb_control_request_t const request =
-  {
-    .bmRequestType_bit =
-    {
+  tusb_control_request_t const request = {
+    .bmRequestType_bit = {
       .recipient = TUSB_REQ_RCPT_DEVICE,
       .type      = TUSB_REQ_TYPE_CLASS,
       .direction = TUSB_DIR_IN
@@ -263,34 +253,31 @@ bool hub_set_config(uint8_t dev_addr, uint8_t itf_num)
     .bRequest = HUB_REQUEST_GET_DESCRIPTOR,
     .wValue   = 0,
     .wIndex   = 0,
-    .wLength  = sizeof(descriptor_hub_desc_t)
+    .wLength  = sizeof(hub_desc_cs_t)
   };
 
-  tuh_xfer_t xfer =
-  {
+  tuh_xfer_t xfer = {
     .daddr       = dev_addr,
     .ep_addr     = 0,
     .setup       = &request,
-    .buffer      = _hub_buffer,
+    .buffer      = get_hub_epbuf(dev_addr),
     .complete_cb = config_set_port_power,
     .user_data    = 0
   };
 
-  TU_ASSERT( tuh_control_xfer(&xfer) );
-
+  TU_ASSERT(tuh_control_xfer(&xfer));
   return true;
 }
 
-static void config_set_port_power (tuh_xfer_t* xfer)
-{
+static void config_set_port_power (tuh_xfer_t* xfer) {
   TU_ASSERT(XFER_RESULT_SUCCESS == xfer->result, );
 
   uint8_t const daddr = xfer->daddr;
-  hub_interface_t* p_hub = get_itf(daddr);
+  hub_interface_t* p_hub = get_hub_itf(daddr);
 
   // only use number of ports in hub descriptor
-  descriptor_hub_desc_t const* desc_hub = (descriptor_hub_desc_t const*) _hub_buffer;
-  p_hub->port_count = desc_hub->bNbrPorts;
+  hub_desc_cs_t const* desc_hub = (hub_desc_cs_t const*) get_hub_epbuf(daddr);
+  p_hub->bNbrPorts = desc_hub->bNbrPorts;
 
   // May need to GET_STATUS
 
@@ -299,14 +286,13 @@ static void config_set_port_power (tuh_xfer_t* xfer)
   hub_port_set_feature(daddr, hub_port, HUB_FEATURE_PORT_POWER, config_port_power_complete, 0);
 }
 
-static void config_port_power_complete (tuh_xfer_t* xfer)
-{
+static void config_port_power_complete (tuh_xfer_t* xfer) {
   TU_ASSERT(XFER_RESULT_SUCCESS == xfer->result, );
 
   uint8_t const daddr = xfer->daddr;
-  hub_interface_t* p_hub = get_itf(daddr);
+  hub_interface_t* p_hub = get_hub_itf(daddr);
 
-  if (xfer->setup->wIndex == p_hub->port_count)
+  if (xfer->setup->wIndex == p_hub->bNbrPorts)
   {
     // All ports are power -> queue notification status endpoint and
     // complete the SET CONFIGURATION
@@ -334,46 +320,48 @@ static void connection_port_reset_complete (tuh_xfer_t* xfer);
 bool hub_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
   (void) xferred_bytes; // TODO can be more than 1 for hub with lots of ports
   (void) ep_addr;
-  TU_VERIFY(result == XFER_RESULT_SUCCESS);
 
-  hub_interface_t* p_hub = get_itf(dev_addr);
+  if (result == XFER_RESULT_SUCCESS) {
+    hub_interface_t* p_hub = get_hub_itf(dev_addr);
 
-  uint8_t const status_change = p_hub->status_change;
-  TU_LOG2("  Hub Status Change = 0x%02X\r\n", status_change);
+    uint8_t const status_change = p_hub->status_change;
+    TU_LOG_DRV("  Hub Status Change = 0x%02X\r\n", status_change);
 
-  if ( status_change == 0 ) {
-    // The status change event was neither for the hub, nor for any of its ports.
-    // This shouldn't happen, but it does with some devices.
-    // Initiate the next interrupt poll here.
-    return hub_edpt_status_xfer(dev_addr);
-  }
+    if ( status_change == 0 ) {
+      // The status change event was neither for the hub, nor for any of its ports.
+      // This shouldn't happen, but it does with some devices. Initiate the next interrupt poll here.
+      return hub_edpt_status_xfer(dev_addr);
+    }
 
-  if (tu_bit_test(status_change, 0)) {
-    // Hub bit 0 is for the hub device events
-    if (hub_port_get_status(dev_addr, 0, &p_hub->hub_status, hub_get_status_complete, 0) == false) {
-      //Hub status control transfer failed, retry
-      hub_edpt_status_xfer(dev_addr);
+    if (tu_bit_test(status_change, 0)) {
+      // Hub bit 0 is for the hub device events
+      if (hub_port_get_status(dev_addr, 0, &p_hub->hub_status, hub_get_status_complete, 0) == false) {
+        //Hub status control transfer failed, retry
+        hub_edpt_status_xfer(dev_addr);
+      }
     }
-  }
-  else {
-    // Hub bits 1 to n are hub port events
-    for (uint8_t port=1; port <= p_hub->port_count; port++) {
-      if ( tu_bit_test(status_change, port) ) {
-        if (hub_port_get_status(dev_addr, port, &p_hub->port_status, hub_port_get_status_complete, 0) == false) {
-          //Hub status control transfer failed, retry
-          hub_edpt_status_xfer(dev_addr);
+    else {
+      // Hub bits 1 to n are hub port events
+      for (uint8_t port=1; port <= p_hub->bNbrPorts; port++) {
+        if ( tu_bit_test(status_change, port) ) {
+          if (hub_port_get_status(dev_addr, port, &p_hub->port_status, hub_port_get_status_complete, 0) == false) {
+            //Hub status control transfer failed, retry
+            hub_edpt_status_xfer(dev_addr);
+          }
+          break;
         }
-        break;
       }
     }
+  } else {
+    TU_LOG_DRV("  Hub Status Change: failed, retry\r\n");
+    hub_edpt_status_xfer(dev_addr); // retry
   }
 
   // NOTE: next status transfer is queued by usbh.c after handling this request
   return true;
 }
 
-static void hub_clear_feature_complete_stub(tuh_xfer_t* xfer)
-{
+static void hub_clear_feature_complete_stub(tuh_xfer_t* xfer) {
   TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
   hub_edpt_status_xfer(xfer->daddr);
 }
@@ -383,15 +371,15 @@ static void hub_get_status_complete (tuh_xfer_t* xfer)
   TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
 
   uint8_t const daddr = xfer->daddr;
-  hub_interface_t* p_hub = get_itf(daddr);
+  hub_interface_t* p_hub = get_hub_itf(daddr);
   uint8_t const port_num = (uint8_t) tu_le16toh(xfer->setup->wIndex);
   TU_ASSERT(port_num == 0 , );
 
-  TU_LOG2("HUB Got hub status, addr = %u, status = %04x\r\n", daddr, p_hub->hub_status.change.value);
+  TU_LOG_DRV("HUB Got hub status, addr = %u, status = %04x\r\n", daddr, p_hub->hub_status.change.value);
 
   if (p_hub->hub_status.change.local_power_source)
   {
-    TU_LOG2("HUB Local Power Change, addr = %u\r\n", daddr);
+    TU_LOG_DRV("HUB Local Power Change, addr = %u\r\n", daddr);
     hub_port_clear_feature(daddr, port_num, HUB_FEATURE_HUB_LOCAL_POWER_CHANGE, hub_clear_feature_complete_stub, 0);
   }
   else if (p_hub->hub_status.change.over_current)
@@ -406,7 +394,7 @@ static void hub_port_get_status_complete (tuh_xfer_t* xfer)
   TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
 
   uint8_t const daddr = xfer->daddr;
-  hub_interface_t* p_hub = get_itf(daddr);
+  hub_interface_t* p_hub = get_hub_itf(daddr);
   uint8_t const port_num = (uint8_t) tu_le16toh(xfer->setup->wIndex);
 
   // Connection change
@@ -453,7 +441,7 @@ static void connection_clear_conn_change_complete (tuh_xfer_t* xfer)
   TU_ASSERT(xfer->result == XFER_RESULT_SUCCESS, );
 
   uint8_t const daddr = xfer->daddr;
-  hub_interface_t* p_hub = get_itf(daddr);
+  hub_interface_t* p_hub = get_hub_itf(daddr);
   uint8_t const port_num = (uint8_t) tu_le16toh(xfer->setup->wIndex);
 
   if ( p_hub->port_status.status.connection )