refractor ehci_data_t

separate tests for pipe open & pipe xfer

4 files changed, 213 insertions, 90 deletions

diff --git a/tests/test/host/ehci/test_ehci_pipe.c b/tests/test/host/ehci/test_ehci_pipe.c
index 0625cffd4..0805a0139 100644
--- a/tests/test/host/ehci/test_ehci_pipe.c
+++ b/tests/test/host/ehci/test_ehci_pipe.c
@@ -54,11 +54,10 @@ LPC_USB0_Type lpc_usb0;
 LPC_USB1_Type lpc_usb1;
 
 uint8_t const control_max_packet_size = 64;
+uint8_t const hub_addr = 2;
+uint8_t const hub_port = 2;
 uint8_t dev_addr;
-uint8_t hub_addr;
-uint8_t hub_port;
 uint8_t hostid;
-uint8_t xfer_data [100];
 
 ehci_qhd_t *async_head;
 
@@ -82,16 +81,12 @@ void setUp(void)
 
   memclr_(usbh_device_info_pool, sizeof(usbh_device_info_t)*(TUSB_CFG_HOST_DEVICE_MAX+1));
   memclr_(&ehci_data, sizeof(ehci_data_t));
-  memclr_(xfer_data, sizeof(xfer_data));
 
   hcd_init();
 
   dev_addr = 1;
 
   hostid = RANDOM(CONTROLLER_HOST_NUMBER) + TEST_CONTROLLER_HOST_START_INDEX;
-  hub_addr = 2;
-  hub_port = 2;
-
   for (uint8_t i=0; i<TUSB_CFG_HOST_DEVICE_MAX; i++)
   {
     usbh_device_info_pool[i].core_id  = hostid;
@@ -231,78 +226,3 @@ void test_open_bulk_qhd_data(void)
   TEST_ASSERT_FALSE(async_head->next.terminate);
   TEST_ASSERT_EQUAL(EHCI_QUEUE_ELEMENT_QHD, async_head->next.type);
 }
-
-//--------------------------------------------------------------------+
-// CONTROL TRANSFER
-//--------------------------------------------------------------------+
-tusb_std_request_t request_get_dev_desc =
-{
-    .bmRequestType = { .direction = TUSB_DIR_DEV_TO_HOST, .type = TUSB_REQUEST_TYPE_STANDARD, .recipient = TUSB_REQUEST_RECIPIENT_DEVICE },
-    .bRequest = TUSB_REQUEST_GET_DESCRIPTOR,
-    .wValue   = (TUSB_DESC_DEVICE << 8),
-    .wLength  = 18
-};
-
-void test_control_xfer_get(void)
-{
-  ehci_qhd_t * const p_qhd = &ehci_data.device[dev_addr].control.qhd;
-  hcd_pipe_control_open(dev_addr, control_max_packet_size);
-
-  //------------- Code Under TEST -------------//
-  hcd_pipe_control_xfer(dev_addr, &request_get_dev_desc, xfer_data);
-
-  ehci_qtd_t *p_setup  = &ehci_data.device[dev_addr].control.qtd[0];
-  ehci_qtd_t *p_data   = &ehci_data.device[dev_addr].control.qtd[1];
-  ehci_qtd_t *p_status = &ehci_data.device[dev_addr].control.qtd[2];
-
-  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
-  TEST_ASSERT_EQUAL_HEX( p_data   , p_setup->next.address);
-  TEST_ASSERT_EQUAL_HEX( p_status , p_data->next.address );
-  TEST_ASSERT_TRUE( p_status->next.terminate );
-}
-
-void test_control_addr0_xfer_get(void)
-{
-  dev_addr = 0;
-  ehci_qhd_t * const p_qhd = async_head;
-  hcd_pipe_control_open(dev_addr, control_max_packet_size);
-
-  //------------- Code Under TEST -------------//
-  hcd_pipe_control_xfer(dev_addr, &request_get_dev_desc, xfer_data);
-
-  ehci_qtd_t *p_setup  = &ehci_data.controller.addr0_qtd[0];
-  ehci_qtd_t *p_data   = &ehci_data.controller.addr0_qtd[1];
-  ehci_qtd_t *p_status = &ehci_data.controller.addr0_qtd[2];
-
-  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
-  TEST_ASSERT_EQUAL_HEX( p_data   , p_setup->next.address);
-  TEST_ASSERT_EQUAL_HEX( p_status , p_data->next.address );
-  TEST_ASSERT_TRUE( p_status->next.terminate );
-}
-
-
-void test_control_xfer_set(void)
-{
-  tusb_std_request_t request_set_dev_addr =
-  {
-      .bmRequestType = { .direction = TUSB_DIR_HOST_TO_DEV, .type = TUSB_REQUEST_TYPE_STANDARD, .recipient = TUSB_REQUEST_RECIPIENT_DEVICE },
-      .bRequest = TUSB_REQUEST_SET_ADDRESS,
-      .wValue   = 3
-  };
-
-  ehci_qhd_t * const p_qhd = &ehci_data.device[dev_addr].control.qhd;
-  hcd_pipe_control_open(dev_addr, control_max_packet_size);
-
-  //------------- Code Under TEST -------------//
-  hcd_pipe_control_xfer(dev_addr, &request_set_dev_addr, xfer_data);
-
-  ehci_qtd_t *p_setup  = &ehci_data.device[dev_addr].control.qtd[0];
-  ehci_qtd_t *p_data   = &ehci_data.device[dev_addr].control.qtd[1];
-  ehci_qtd_t *p_status = &ehci_data.device[dev_addr].control.qtd[2];
-
-  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
-  TEST_ASSERT_EQUAL_HEX( p_status , p_setup->next.address );
-  TEST_ASSERT_TRUE( p_status->next.terminate );
-}
-
-
diff --git a/tests/test/host/ehci/test_ehci_pipe_xfer.c b/tests/test/host/ehci/test_ehci_pipe_xfer.c
new file mode 100644
index 000000000..d84d08f1a
--- /dev/null
+++ b/tests/test/host/ehci/test_ehci_pipe_xfer.c
@@ -0,0 +1,197 @@
+/*
+ * test_ehci_pipe_xfer.c
+ *
+ *  Created on: Feb 27, 2013
+ *      Author: hathach
+ */
+
+/*
+ * Software License Agreement (BSD License)
+ * Copyright (c) 2012, hathach (tinyusb.net)
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+ * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+ * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+ * OF SUCH DAMAGE.
+ *
+ * This file is part of the tiny usb stack.
+ */
+
+#include "unity.h"
+#include "tusb_option.h"
+#include "errors.h"
+#include "binary.h"
+
+#include "hal.h"
+#include "mock_osal.h"
+#include "hcd.h"
+#include "usbh_hcd.h"
+#include "ehci.h"
+#include "test_ehci.h"
+
+extern ehci_data_t ehci_data;
+usbh_device_info_t usbh_device_info_pool[TUSB_CFG_HOST_DEVICE_MAX+1];
+
+LPC_USB0_Type lpc_usb0;
+LPC_USB1_Type lpc_usb1;
+
+uint8_t const control_max_packet_size = 64;
+uint8_t const hub_addr = 2;
+uint8_t const hub_port = 2;
+uint8_t dev_addr;
+uint8_t hostid;
+uint8_t xfer_data [100];
+
+ehci_qhd_t *async_head;
+
+ehci_qtd_t *p_setup;
+ehci_qtd_t *p_data;
+ehci_qtd_t *p_status;
+
+tusb_descriptor_endpoint_t const desc_ept_bulk_in =
+{
+    .bLength          = sizeof(tusb_descriptor_endpoint_t),
+    .bDescriptorType  = TUSB_DESC_ENDPOINT,
+    .bEndpointAddress = 0x81,
+    .bmAttributes     = { .xfer = TUSB_XFER_BULK },
+    .wMaxPacketSize   = 512,
+    .bInterval        = 0
+};
+
+//--------------------------------------------------------------------+
+// Setup/Teardown + helper declare
+//--------------------------------------------------------------------+
+void setUp(void)
+{
+  memclr_(&lpc_usb0, sizeof(LPC_USB0_Type));
+  memclr_(&lpc_usb1, sizeof(LPC_USB1_Type));
+
+  memclr_(usbh_device_info_pool, sizeof(usbh_device_info_t)*(TUSB_CFG_HOST_DEVICE_MAX+1));
+  memclr_(&ehci_data, sizeof(ehci_data_t));
+  memclr_(xfer_data, sizeof(xfer_data));
+
+  hcd_init();
+
+  dev_addr = 1;
+
+  hostid = RANDOM(CONTROLLER_HOST_NUMBER) + TEST_CONTROLLER_HOST_START_INDEX;
+  for (uint8_t i=0; i<TUSB_CFG_HOST_DEVICE_MAX; i++)
+  {
+    usbh_device_info_pool[i].core_id  = hostid;
+    usbh_device_info_pool[i].hub_addr = hub_addr;
+    usbh_device_info_pool[i].hub_port = hub_port;
+  }
+
+  async_head =  get_async_head( hostid );
+
+  p_setup  = &ehci_data.device[dev_addr].control.qtd[0];
+  p_data   = &ehci_data.device[dev_addr].control.qtd[1];
+  p_status = &ehci_data.device[dev_addr].control.qtd[2];
+}
+
+void tearDown(void)
+{
+}
+//--------------------------------------------------------------------+
+// CONTROL TRANSFER
+//--------------------------------------------------------------------+
+tusb_std_request_t request_get_dev_desc =
+{
+    .bmRequestType = { .direction = TUSB_DIR_DEV_TO_HOST, .type = TUSB_REQUEST_TYPE_STANDARD, .recipient = TUSB_REQUEST_RECIPIENT_DEVICE },
+    .bRequest = TUSB_REQUEST_GET_DESCRIPTOR,
+    .wValue   = (TUSB_DESC_DEVICE << 8),
+    .wLength  = 18
+};
+
+void test_control_addr0_xfer_get_check_qhd_qtd_mapping(void)
+{
+  dev_addr = 0;
+  ehci_qhd_t * const p_qhd = async_head;
+  hcd_pipe_control_open(dev_addr, control_max_packet_size);
+
+  //------------- Code Under TEST -------------//
+  hcd_pipe_control_xfer(dev_addr, &request_get_dev_desc, xfer_data);
+
+  p_setup  = &ehci_data.addr0.qtd[0];
+  p_data   = &ehci_data.addr0.qtd[1];
+  p_status = &ehci_data.addr0.qtd[2];
+
+  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
+  TEST_ASSERT_EQUAL_HEX( p_data   , p_setup->next.address);
+  TEST_ASSERT_EQUAL_HEX( p_status , p_data->next.address );
+  TEST_ASSERT_TRUE( p_status->next.terminate );
+}
+
+void test_control_xfer_get(void)
+{
+  ehci_qhd_t * const p_qhd = &ehci_data.device[dev_addr].control.qhd;
+  hcd_pipe_control_open(dev_addr, control_max_packet_size);
+
+  //------------- Code Under TEST -------------//
+  hcd_pipe_control_xfer(dev_addr, &request_get_dev_desc, xfer_data);
+
+  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
+  TEST_ASSERT_EQUAL_HEX( p_data   , p_setup->next.address);
+  TEST_ASSERT_EQUAL_HEX( p_status , p_data->next.address );
+  TEST_ASSERT_TRUE( p_status->next.terminate );
+
+//  ehci_qtd_t *p_qtd = p_setup;
+//  TEST_ASSERT_TRUE(p_qtd->alternate.terminate); // not used, always invalid
+//  TEST_ASSERT_FALSE(p_qtd->pingstate_err);
+//  TEST_ASSERT_FALSE(p_qtd->split_state);
+//  TEST_ASSERT_FALSE(p_qtd->missed_uframe);
+//  TEST_ASSERT_FALSE(p_qtd->xact_err);
+//  TEST_ASSERT_FALSE(p_qtd->babble_err);
+//  TEST_ASSERT_FALSE(p_qtd->buffer_err);
+//  TEST_ASSERT_FALSE(p_qtd->halted);
+//  TEST_ASSERT_TRUE(p_qtd->active);
+//  // error count
+//  TEST_ASSERT_EQUAL(0, p_qtd->current_page);
+//  TEST_ASSERT_FALSE(p_qtd->int_on_complete);
+//  TEST_ASSERT_EQUAL(8, p_qtd->total_bytes);
+//  TEST_ASSERT_FALSE(p_qtd->data_toggle);
+//
+////  TEST_ASSERT_EQUAL_HEX(request)
+//
+//  TEST_ASSERT_EQUAL(EHCI_PID_SETUP, p_qtd->pid);
+}
+
+void test_control_xfer_set(void)
+{
+  tusb_std_request_t request_set_dev_addr =
+  {
+      .bmRequestType = { .direction = TUSB_DIR_HOST_TO_DEV, .type = TUSB_REQUEST_TYPE_STANDARD, .recipient = TUSB_REQUEST_RECIPIENT_DEVICE },
+      .bRequest = TUSB_REQUEST_SET_ADDRESS,
+      .wValue   = 3
+  };
+
+  ehci_qhd_t * const p_qhd = &ehci_data.device[dev_addr].control.qhd;
+  hcd_pipe_control_open(dev_addr, control_max_packet_size);
+
+  //------------- Code Under TEST -------------//
+  hcd_pipe_control_xfer(dev_addr, &request_set_dev_addr, xfer_data);
+
+  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
+  TEST_ASSERT_EQUAL_HEX( p_status , p_setup->next.address );
+  TEST_ASSERT_TRUE( p_status->next.terminate );
+}
+
+
diff --git a/tinyusb/host/ehci/ehci.c b/tinyusb/host/ehci/ehci.c
index c50511041..d592567e3 100644
--- a/tinyusb/host/ehci/ehci.c
+++ b/tinyusb/host/ehci/ehci.c
@@ -101,13 +101,13 @@ STATIC_ INLINE_ uint8_t hostid_to_data_idx(uint8_t hostid)
 STATIC_ INLINE_ ehci_qhd_t* const get_async_head(uint8_t hostid) ATTR_ALWAYS_INLINE ATTR_PURE ATTR_WARN_UNUSED_RESULT;
 STATIC_ INLINE_ ehci_qhd_t* const get_async_head(uint8_t hostid)
 {
-  return &ehci_data.controller.async_head[hostid_to_data_idx(hostid)];
+  return &ehci_data.async_head[ hostid_to_data_idx(hostid) ];
 }
 
 STATIC_ INLINE_ ehci_qhd_t* const get_period_head(uint8_t hostid) ATTR_ALWAYS_INLINE ATTR_PURE ATTR_WARN_UNUSED_RESULT;
 STATIC_ INLINE_ ehci_qhd_t* const get_period_head(uint8_t hostid)
 {
-  return &ehci_data.controller.period_head[hostid_to_data_idx(hostid)];
+  return &ehci_data.period_head[ hostid_to_data_idx(hostid) ];
 }
 
 tusb_error_t hcd_controller_init(uint8_t hostid) ATTR_WARN_UNUSED_RESULT;
@@ -337,7 +337,7 @@ static inline ehci_qhd_t* const get_control_qhd(uint8_t dev_addr)
 static inline ehci_qtd_t* get_control_qtds(uint8_t dev_addr)
 {
   return (dev_addr == 0) ?
-      ehci_data.controller.addr0_qtd :
+      ehci_data.addr0.qtd :
       ehci_data.device[ dev_addr ].control.qtd;
 
 }
diff --git a/tinyusb/host/ehci/ehci.h b/tinyusb/host/ehci/ehci.h
index 74099c15d..6a0f39886 100644
--- a/tinyusb/host/ehci/ehci.h
+++ b/tinyusb/host/ehci/ehci.h
@@ -435,21 +435,27 @@ typedef volatile struct {
 // EHCI Data Organization
 //--------------------------------------------------------------------+
 typedef struct {
+  //------------- Static Async/Period List Head, Each for one controller -------------//
+  ehci_qhd_t async_head[CONTROLLER_HOST_NUMBER]; /// head qhd of async list, also is used as control endpoint for address 0
+  ehci_qhd_t period_head[CONTROLLER_HOST_NUMBER];
 
+  //------------- Data for Address 0 -------------//
   struct {
-    ehci_qhd_t async_head[CONTROLLER_HOST_NUMBER]; /// head qhd of async list, also is used as control endpoint for address 0
-    ehci_qhd_t period_head[CONTROLLER_HOST_NUMBER];
-    ehci_qtd_t addr0_qtd[3];
-  }controller; ///< Static Interrupt Queue Head
+    // qhd: addr0 use async head (dummy) as Queue Head
+    ehci_qtd_t qtd[3];
+    tusb_std_request_t request;
+  } addr0;
 
   struct {
-//  ehci_itd_t  itd[EHCI_MAX_ITD]   ; ///< Iso Transfer Pool
     struct {
       ehci_qhd_t qhd;
       ehci_qtd_t qtd[3];
+      tusb_std_request_t request;
     }control;
+
     ehci_qhd_t  qhd[EHCI_MAX_QHD]   ; ///< Queue Head Pool
     ehci_qtd_t  qtd[EHCI_MAX_QTD]   ; ///< Queue Element Transfer Pool
+//  ehci_itd_t  itd[EHCI_MAX_ITD]   ; ///< Iso Transfer Pool
 //  ehci_sitd_t sitd[EHCI_MAX_SITD] ; ///< Split (FS) Isochronous Transfer Pool
   }device[TUSB_CFG_HOST_DEVICE_MAX];