add test code & hcd_pipe_xfer for bulk transfer

- test cross 4k boundary test for bulk transfer
rename p_qtd_list to p_qtd_list_head

tests/test/host/ehci/test_ehci_pipe.c

@@ -113,7 +113,7 @@ void verify_open_qhd(ehci_qhd_t *p_qhd, uint8_t endpoint_addr, uint16_t max_pack
 
   //------------- HCD -------------//
   TEST_ASSERT(p_qhd->used);
-  TEST_ASSERT_NULL(p_qhd->p_qtd_list);
+  TEST_ASSERT_NULL(p_qhd->p_qtd_list_head);
 }
 
 //--------------------------------------------------------------------+

tests/test/host/ehci/test_ehci_pipe_bulk_xfer.c

@@ -0,0 +1,172 @@
+/*
+ * test_ehci_pipe_bulk_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 [18000]; // 18K to test buffer pointer list
+
+ehci_qhd_t *async_head;
+ehci_qhd_t *p_qhd_bulk;
+pipe_handle_t pipe_hdl_bulk;
+
+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;
+    usbh_device_info_pool[i].speed    = TUSB_SPEED_HIGH;
+  }
+
+  async_head =  get_async_head( hostid );
+  pipe_hdl_bulk = hcd_pipe_open(dev_addr, &desc_ept_bulk_in);
+
+  TEST_ASSERT_EQUAL(dev_addr, pipe_hdl_bulk.dev_addr);
+  TEST_ASSERT_EQUAL(TUSB_XFER_BULK, pipe_hdl_bulk.xfer_type);
+
+  p_qhd_bulk = &ehci_data.device[ dev_addr ].qhd[ pipe_hdl_bulk.index ];
+}
+
+void tearDown(void)
+{
+}
+//--------------------------------------------------------------------+
+// BULK TRANSFER
+//--------------------------------------------------------------------+
+void verify_qtd(ehci_qtd_t *p_qtd, uint8_t p_data[], uint16_t length)
+{
+  TEST_ASSERT_TRUE(p_qtd->alternate.terminate); // not used, always invalid
+
+  //------------- status -------------//
+  TEST_ASSERT_FALSE(p_qtd->pingstate_err);
+  TEST_ASSERT_FALSE(p_qtd->non_hs_split_state);
+  TEST_ASSERT_FALSE(p_qtd->non_hs_period_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);
+
+  TEST_ASSERT_EQUAL(3, p_qtd->cerr);
+  TEST_ASSERT_EQUAL(0, p_qtd->current_page);
+  TEST_ASSERT_EQUAL(length, p_qtd->total_bytes);
+
+  TEST_ASSERT_EQUAL_HEX( p_data, p_qtd->buffer[0] );
+  for(uint8_t i=1; i<5; i++)
+  {
+    TEST_ASSERT_EQUAL_HEX( align4k((uint32_t) (p_data+4096*i)), align4k(p_qtd->buffer[i]) );
+  }
+}
+
+void test_bulk_xfer(void)
+{
+
+  //------------- Code Under Test -------------//
+  hcd_pipe_xfer(pipe_hdl_bulk, xfer_data, sizeof(xfer_data));
+
+  ehci_qtd_t* p_qtd = p_qhd_bulk->p_qtd_list_head;
+  TEST_ASSERT_NOT_NULL(p_qtd);
+
+  verify_qtd( p_qtd, xfer_data, sizeof(xfer_data));
+  TEST_ASSERT_TRUE(p_qtd->used);
+  TEST_ASSERT_TRUE(p_qtd->next.terminate);
+  TEST_ASSERT_EQUAL(EHCI_PID_IN, p_qtd->pid);
+  TEST_ASSERT_TRUE(p_qtd->int_on_complete);
+  TEST_ASSERT_FALSE(p_qtd->data_toggle);
+}
+
+void test_bulk_xfer_double(void)
+{
+  uint8_t data2[100];
+
+  //------------- Code Under Test -------------//
+  hcd_pipe_xfer(pipe_hdl_bulk, xfer_data, sizeof(xfer_data));
+  hcd_pipe_xfer(pipe_hdl_bulk, data2, sizeof(data2));
+
+  ehci_qtd_t* p_qtd = p_qhd_bulk->p_qtd_list_head;
+  TEST_ASSERT_NOT_NULL(p_qtd);
+
+  TEST_ASSERT_FALSE(p_qtd->next.terminate);
+
+}

tests/test/host/ehci/test_ehci_pipe_xfer.c

@@ -157,7 +157,7 @@ void test_control_addr0_xfer_get_check_qhd_qtd_mapping(void)
   p_status = &ehci_data.addr0_qtd[2];
 
   TEST_ASSERT_EQUAL_HEX( p_setup, p_qhd->qtd_overlay.next.address );
-  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
+  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list_head);
   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 );
@@ -175,7 +175,7 @@ void test_control_xfer_get(void)
   hcd_pipe_control_xfer(dev_addr, &request_get_dev_desc, xfer_data);
 
   TEST_ASSERT_EQUAL_HEX( p_setup, p_qhd->qtd_overlay.next.address );
-  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
+  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list_head);
   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 );
@@ -201,6 +201,7 @@ void test_control_xfer_get(void)
   TEST_ASSERT_TRUE(p_status->int_on_complete);
   TEST_ASSERT_TRUE(p_status->data_toggle);
   TEST_ASSERT_EQUAL(EHCI_PID_OUT, p_status->pid);
+  TEST_ASSERT_TRUE(p_status->next.terminate);
 }
 
 void test_control_xfer_set(void)
@@ -219,7 +220,7 @@ void test_control_xfer_set(void)
   hcd_pipe_control_xfer(dev_addr, &request_set_dev_addr, xfer_data);
 
   TEST_ASSERT_EQUAL_HEX( p_setup, p_qhd->qtd_overlay.next.address );
-  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list);
+  TEST_ASSERT_EQUAL_HEX( p_setup  , p_qhd->p_qtd_list_head);
   TEST_ASSERT_EQUAL_HEX( p_status , p_setup->next.address );
   TEST_ASSERT_TRUE( p_status->next.terminate );
 
@@ -228,4 +229,5 @@ void test_control_xfer_set(void)
   TEST_ASSERT_TRUE(p_status->int_on_complete);
   TEST_ASSERT_TRUE(p_status->data_toggle);
   TEST_ASSERT_EQUAL(EHCI_PID_IN, p_status->pid);
+  TEST_ASSERT_TRUE(p_status->next.terminate);
 }

tinyusb/host/ehci/ehci.c

@@ -289,6 +289,9 @@ static void queue_td_init(ehci_qtd_t* p_qtd, uint32_t data_ptr, uint16_t total_b
 {
   memclr_(p_qtd, sizeof(ehci_qtd_t));
 
+  p_qtd->used = 1;
+
+  p_qtd->next.terminate = 1; // init to null
   p_qtd->alternate.terminate = 1; // not used, always set to terminated
   p_qtd->active              = 1;
   p_qtd->cerr                = 3; // TODO 3 consecutive errors tolerance
@@ -297,6 +300,11 @@ static void queue_td_init(ehci_qtd_t* p_qtd, uint32_t data_ptr, uint16_t total_b
 
   p_qtd->buffer[0]           = data_ptr;
 
+  uint8_t i;
+  for(i=1; i<5; i++)
+  {
+    p_qtd->buffer[i] |= align4k( p_qtd->buffer[i-1] ) + 4096;
+  }
 }
 
 tusb_error_t  hcd_pipe_control_xfer(uint8_t dev_addr, tusb_std_request_t const * p_request, uint8_t data[])
@@ -335,7 +343,7 @@ tusb_error_t  hcd_pipe_control_xfer(uint8_t dev_addr, tusb_std_request_t const *
   p_status->next.terminate  = 1;
 
   //------------- hook TD List to Queue Head -------------//
-  p_qhd->p_qtd_list               = p_setup;
+  p_qhd->p_qtd_list_head               = p_setup;
   p_qhd->qtd_overlay.next.address = (uint32_t) p_setup;
 
   return TUSB_ERROR_NONE;
@@ -392,15 +400,29 @@ pipe_handle_t hcd_pipe_open(uint8_t dev_addr, tusb_descriptor_endpoint_t const *
   return (pipe_handle_t) { .dev_addr = dev_addr, .xfer_type = p_endpoint_desc->bmAttributes.xfer, .index = index};
 }
 
-tusb_error_t  hcd_pipe_xfer(pipe_handle_t pipe_hdl, uint8_t buffer[], uint16_t total_byte)
+tusb_error_t  hcd_pipe_xfer(pipe_handle_t pipe_hdl, uint8_t buffer[], uint16_t total_bytes)
 {
+  //------------- pipe handle validate -------------//
+
   //------------- find a free qtd -------------//
-//  uint8_t index=0;
+  uint8_t index=0;
-//  while( index<EHCI_MAX_QTD && ehci_data.device[dev_addr].qtd[index].used )
+  while( index<EHCI_MAX_QTD && ehci_data.device[pipe_hdl.dev_addr].qtd[index].used )
-//  {
+  {
-//    index++;
+    index++;
-//  }
+  }
-//  ASSERT( index < EHCI_MAX_QHD, TUSB_ERROR_EHCI_NOT_ENOUGH_QTD);
+  ASSERT( index < EHCI_MAX_QTD, TUSB_ERROR_EHCI_NOT_ENOUGH_QTD);
+
+  //------------- set up QTD -------------//
+  ehci_qhd_t *p_qhd = &ehci_data.device[pipe_hdl.dev_addr].qhd[index];
+
+  ehci_qtd_t *p_qtd = &ehci_data.device[pipe_hdl.dev_addr].qtd[index];
+  queue_td_init(p_qtd, (uint32_t) buffer, total_bytes);
+  p_qtd->pid = p_qhd->pid_non_control;
+  p_qtd->int_on_complete = 1;
+
+
+  p_qhd->p_qtd_list_head = p_qtd;
+  p_qhd->qtd_overlay.next.address = (uint32_t) p_qtd;
 
   return TUSB_ERROR_NONE;
 }
@@ -461,7 +483,7 @@ static void queue_head_init(ehci_qhd_t *p_qhd, uint8_t dev_addr, uint16_t max_pa
 
   //------------- HCD Management Data -------------//
   p_qhd->used            = 1;
-  p_qhd->p_qtd_list      = NULL;
+  p_qhd->p_qtd_list_head      = NULL;
   p_qhd->pid_non_control = (endpoint_addr & 0x80) ? EHCI_PID_IN : EHCI_PID_OUT; // PID for TD under this endpoint
 
 }

tinyusb/host/ehci/ehci.h

@@ -191,14 +191,17 @@ typedef struct {
 	/// Word 4-11: Transfer Overlay
 	volatile ehci_qtd_t qtd_overlay;
 
-	/// Due to the fact QHD is 32 bytes aligned but occupies only 48 bytes
+	//--------------------------------------------------------------------+
+  /// Due to the fact QHD is 32 bytes aligned but occupies only 48 bytes
 	/// thus there are 16 bytes padding free that we can make use of.
+  //--------------------------------------------------------------------+
 	uint8_t used;
 	uint8_t pid_non_control;
+
 	uint8_t list_index;
 	uint8_t reserved;
 
-	ehci_qtd_t *p_qtd_list;	/* used as TD head to clean up TD chain when transfer done */ // TODO consider using ehci_link_t (terminate bit)
+	ehci_qtd_t *p_qtd_list_head;	// head of the TD list scheduled
 
 	volatile uint32_t status; // TODO will remove volatile after remove all HcdQHD function
 	uint16_t *pActualTransferCount; /* total transferred bytes of a usb request */

tinyusb/host/hcd.h

@@ -80,7 +80,7 @@ tusb_error_t  hcd_pipe_control_xfer(uint8_t dev_addr, tusb_std_request_t const *
 tusb_error_t  hcd_pipe_control_close(uint8_t dev_addr) ATTR_WARN_UNUSED_RESULT;
 
 pipe_handle_t hcd_pipe_open(uint8_t dev_addr, tusb_descriptor_endpoint_t const * endpoint_desc) ATTR_WARN_UNUSED_RESULT;
-tusb_error_t  hcd_pipe_xfer(pipe_handle_t pipe_hdl, uint8_t buffer[], uint16_t total_byte)  ATTR_WARN_UNUSED_RESULT;
+tusb_error_t  hcd_pipe_xfer(pipe_handle_t pipe_hdl, uint8_t buffer[], uint16_t total_bytes)  ATTR_WARN_UNUSED_RESULT;
 tusb_error_t  hcd_pipe_close(pipe_handle_t pipe_hdl) ATTR_WARN_UNUSED_RESULT;
 
 #if 0