add control xfer for ehci controller fake: ehci_controller_control_xfer_proceed

refractor test code

2 files changed, 469 insertions, 0 deletions

diff --git a/tests/test/host/usbh/test_enum_task.c b/tests/test/host/usbh/test_enum_task.c
new file mode 100644
index 000000000..28a6a3c9e
--- /dev/null
+++ b/tests/test/host/usbh/test_enum_task.c
@@ -0,0 +1,276 @@
+/*
+ * test_enum_task.c
+ *
+ *  Created on: Feb 5, 2013
+ *      Author: hathach
+ */
+
+/*
+ * Software License Agreement (BSD License)
+ * Copyright (c) 2012, hathach (tinyusb.org)
+ * 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 "errors.h"
+#include "descriptor_test.h"
+
+#include "mock_osal.h"
+#include "usbh.h"
+#include "mock_hcd.h"
+#include "usbh_hcd.h"
+
+#include "mock_tusb_callback.h"
+#include "mock_hid_host.h"
+
+extern usbh_device_info_t usbh_devices[TUSB_CFG_HOST_DEVICE_MAX+1];
+extern uint8_t enum_data_buffer[TUSB_CFG_HOST_ENUM_BUFFER_SIZE];
+uint8_t dev_addr;
+
+usbh_enumerate_t const enum_connect = {
+    .core_id  = 0,
+    .hub_addr = 0,
+    .hub_port = 0,
+    .speed    = TUSB_SPEED_FULL
+};
+
+void queue_recv_stub (osal_queue_handle_t const queue_hdl, uint32_t *p_data, uint32_t msec, tusb_error_t *p_error, int num_call);
+void semaphore_wait_success_stub(osal_semaphore_handle_t const sem_hdl, uint32_t msec, tusb_error_t *p_error, int num_call);
+tusb_error_t control_xfer_stub(uint8_t dev_addr, const tusb_std_request_t * const p_request, uint8_t data[], int num_call);
+
+void setUp(void)
+{
+  memclr_(usbh_devices, sizeof(usbh_device_info_t)*(TUSB_CFG_HOST_DEVICE_MAX+1));
+
+  osal_queue_receive_StubWithCallback(queue_recv_stub);
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_success_stub);
+  hcd_pipe_control_xfer_StubWithCallback(control_xfer_stub);
+
+  hcd_port_connect_status_ExpectAndReturn(enum_connect.core_id, true);
+  osal_semaphore_reset_Expect( usbh_devices[0].control.sem_hdl );
+  hcd_pipe_control_open_ExpectAndReturn(0, 8, TUSB_ERROR_NONE);
+}
+
+void tearDown(void)
+{
+}
+
+//--------------------------------------------------------------------+
+// STUB & HELPER
+//--------------------------------------------------------------------+
+void queue_recv_stub (osal_queue_handle_t const queue_hdl, uint32_t *p_data, uint32_t msec, tusb_error_t *p_error, int num_call)
+{
+  (*p_data) = ( *((uint32_t*) &enum_connect) );
+  (*p_error) = TUSB_ERROR_NONE;
+}
+
+void semaphore_wait_success_stub(osal_semaphore_handle_t const sem_hdl, uint32_t msec, tusb_error_t *p_error, int num_call)
+{
+  (*p_error) = TUSB_ERROR_NONE;
+}
+
+#define semaphore_wait_timeout_stub(n) semaphore_wait_timeout_##n
+#define semaphore_wait_timeout(n) \
+  void semaphore_wait_timeout_##n(osal_semaphore_handle_t const sem_hdl, uint32_t msec, tusb_error_t *p_error, int num_call) {\
+    if (num_call >= n)\
+      (*p_error) = TUSB_ERROR_OSAL_TIMEOUT;\
+    else  \
+      (*p_error) = TUSB_ERROR_NONE;\
+  }
+
+semaphore_wait_timeout(0)
+semaphore_wait_timeout(1)
+semaphore_wait_timeout(2)
+semaphore_wait_timeout(3)
+semaphore_wait_timeout(4)
+semaphore_wait_timeout(5)
+semaphore_wait_timeout(6)
+semaphore_wait_timeout(7)
+semaphore_wait_timeout(8)
+
+tusb_error_t control_xfer_stub(uint8_t dev_addr, const tusb_std_request_t * const p_request, uint8_t data[], int num_call)
+{
+  switch (num_call)
+  {
+    case 0: // get 8 bytes of device descriptor
+      TEST_ASSERT_EQUAL(TUSB_REQUEST_GET_DESCRIPTOR, p_request->bRequest);
+      TEST_ASSERT_EQUAL(TUSB_DESC_DEVICE, p_request->wValue >> 8);
+      TEST_ASSERT_EQUAL(8, p_request->wLength);
+      memcpy(data, &desc_device, p_request->wLength);
+    break;
+
+    case 1: // set device address
+      TEST_ASSERT_EQUAL(TUSB_REQUEST_SET_ADDRESS, p_request->bRequest);
+      TEST_ASSERT_EQUAL(p_request->wValue, 1);
+    break;
+
+    case 2: // get full device decriptor for new address
+      TEST_ASSERT_EQUAL(TUSB_REQUEST_GET_DESCRIPTOR, p_request->bRequest);
+      TEST_ASSERT_EQUAL(TUSB_DESC_DEVICE, p_request->wValue >> 8);
+      TEST_ASSERT_EQUAL(18, p_request->wLength);
+      memcpy(data, &desc_device, p_request->wLength);
+    break;
+
+    case 3: // get 9 bytes of configuration descriptor
+      TEST_ASSERT_EQUAL(TUSB_REQUEST_GET_DESCRIPTOR, p_request->bRequest);
+      TEST_ASSERT_EQUAL(TUSB_DESC_CONFIGURATION, p_request->wValue >> 8);
+      TEST_ASSERT_EQUAL(9, p_request->wLength);
+      memcpy(data, &desc_configuration, p_request->wLength);
+    break;
+
+    case 4: // get full-length configuration descriptor
+      TEST_ASSERT_EQUAL(TUSB_REQUEST_GET_DESCRIPTOR, p_request->bRequest);
+      TEST_ASSERT_EQUAL(TUSB_DESC_CONFIGURATION, p_request->wValue >> 8);
+      TEST_ASSERT_EQUAL(desc_configuration.configuration.wTotalLength, p_request->wLength);
+      memcpy(data, &desc_configuration, p_request->wLength);
+    break;
+
+    default:
+      return TUSB_ERROR_OSAL_TIMEOUT;
+  }
+
+  return TUSB_ERROR_NONE;
+}
+
+tusb_error_t hidh_install_stub(uint8_t dev_addr, tusb_descriptor_interface_t const *descriptor, uint16_t *p_length, int num_call)
+{
+  *p_length = sizeof(tusb_descriptor_interface_t) + sizeof(tusb_hid_descriptor_hid_t) + sizeof(tusb_descriptor_endpoint_t);
+  return TUSB_ERROR_NONE;
+}
+
+//--------------------------------------------------------------------+
+// enumeration
+//--------------------------------------------------------------------+
+void test_addr0_failed_dev_desc(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(0));
+  tusbh_device_mount_failed_cb_Expect(TUSB_ERROR_USBH_MOUNT_DEVICE_NOT_RESPOND, NULL);
+
+  usbh_enumeration_task();
+
+  TEST_ASSERT_EQUAL(TUSB_DEVICE_STATE_ADDRESSED, usbh_devices[0].state);
+
+}
+
+void test_addr0_failed_set_address(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(1));
+  hcd_port_reset_Expect( usbh_devices[0].core_id );
+  tusbh_device_mount_failed_cb_Expect(TUSB_ERROR_USBH_MOUNT_DEVICE_NOT_RESPOND, NULL);
+
+  usbh_enumeration_task();
+
+  TEST_ASSERT_EQUAL(TUSB_DEVICE_STATE_ADDRESSED, usbh_devices[0].state);
+  TEST_ASSERT_EQUAL_MEMORY(&desc_device, enum_data_buffer, 8);
+}
+
+void test_enum_failed_get_full_dev_desc(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(2));
+  hcd_port_reset_Expect( usbh_devices[0].core_id );
+  hcd_pipe_control_close_ExpectAndReturn(0, TUSB_ERROR_NONE);
+
+  osal_semaphore_reset_Expect( usbh_devices[0].control.sem_hdl );
+  hcd_pipe_control_open_ExpectAndReturn(1, desc_device.bMaxPacketSize0, TUSB_ERROR_NONE);
+  tusbh_device_mount_failed_cb_Expect(TUSB_ERROR_USBH_MOUNT_DEVICE_NOT_RESPOND, NULL);
+
+  usbh_enumeration_task();
+
+  TEST_ASSERT_EQUAL(TUSB_DEVICE_STATE_ADDRESSED, usbh_devices[1].state);
+  TEST_ASSERT_EQUAL(TUSB_SPEED_FULL, usbh_devices[1].speed);
+  TEST_ASSERT_EQUAL(enum_connect.core_id, usbh_devices[1].core_id);
+  TEST_ASSERT_EQUAL(enum_connect.hub_addr, usbh_devices[1].hub_addr);
+  TEST_ASSERT_EQUAL(enum_connect.hub_port, usbh_devices[1].hub_port);
+}
+
+void test_enum_failed_get_9byte_config_desc(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(3));
+  hcd_port_reset_Expect( usbh_devices[0].core_id );
+  hcd_pipe_control_close_ExpectAndReturn(0, TUSB_ERROR_NONE);
+  osal_semaphore_reset_Expect( usbh_devices[0].control.sem_hdl );
+  hcd_pipe_control_open_ExpectAndReturn(1, desc_device.bMaxPacketSize0, TUSB_ERROR_NONE);
+  tusbh_device_attached_cb_ExpectAndReturn((tusb_descriptor_device_t*) enum_data_buffer, 1);
+  tusbh_device_mount_failed_cb_Expect(TUSB_ERROR_USBH_MOUNT_DEVICE_NOT_RESPOND, NULL);
+
+  usbh_enumeration_task();
+
+  TEST_ASSERT_EQUAL(desc_device.idVendor, usbh_devices[1].vendor_id);
+  TEST_ASSERT_EQUAL(desc_device.idProduct, usbh_devices[1].product_id);
+  TEST_ASSERT_EQUAL(desc_device.bNumConfigurations, usbh_devices[1].configure_count);
+}
+
+void test_enum_failed_get_full_config_desc(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(4));
+  hcd_port_reset_Expect( usbh_devices[0].core_id );
+  hcd_pipe_control_close_ExpectAndReturn(0, TUSB_ERROR_NONE);
+  osal_semaphore_reset_Expect( usbh_devices[0].control.sem_hdl );
+  hcd_pipe_control_open_ExpectAndReturn(1, desc_device.bMaxPacketSize0, TUSB_ERROR_NONE);
+  tusbh_device_attached_cb_ExpectAndReturn((tusb_descriptor_device_t*) enum_data_buffer, 1);
+  tusbh_device_mount_failed_cb_Expect(TUSB_ERROR_USBH_MOUNT_DEVICE_NOT_RESPOND, NULL);
+
+  usbh_enumeration_task();
+}
+
+void class_install_expect(void)
+{
+  hidh_open_subtask_StubWithCallback(hidh_install_stub);
+}
+
+void test_enum_parse_config_desc(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(5));
+  hcd_port_reset_Expect( usbh_devices[0].core_id );
+  hcd_pipe_control_close_ExpectAndReturn(0, TUSB_ERROR_NONE);
+  osal_semaphore_reset_Expect( usbh_devices[0].control.sem_hdl );
+  hcd_pipe_control_open_ExpectAndReturn(1, desc_device.bMaxPacketSize0, TUSB_ERROR_NONE);
+  tusbh_device_attached_cb_ExpectAndReturn((tusb_descriptor_device_t*) enum_data_buffer, 1);
+
+  tusbh_device_mount_failed_cb_Expect(TUSB_ERROR_USBH_MOUNT_DEVICE_NOT_RESPOND, NULL); // fail to set configure
+
+  usbh_enumeration_task();
+
+  TEST_ASSERT_EQUAL(desc_configuration.configuration.bNumInterfaces, usbh_devices[1].interface_count);
+}
+
+void test_enum_set_configure(void)
+{
+  osal_semaphore_wait_StubWithCallback(semaphore_wait_timeout_stub(6));
+  hcd_port_reset_Expect( usbh_devices[0].core_id );
+  hcd_pipe_control_close_ExpectAndReturn(0, TUSB_ERROR_NONE);
+  osal_semaphore_reset_Expect( usbh_devices[0].control.sem_hdl );
+  hcd_pipe_control_open_ExpectAndReturn(1, desc_device.bMaxPacketSize0, TUSB_ERROR_NONE);
+  tusbh_device_attached_cb_ExpectAndReturn((tusb_descriptor_device_t*) enum_data_buffer, 1);
+  class_install_expect();
+
+  tusbh_device_mount_succeed_cb_Expect(1);
+
+  usbh_enumeration_task();
+
+  TEST_ASSERT_EQUAL(TUSB_CLASS_FLAG_HID, usbh_devices[1].flag_supported_class); // TODO change later
+}
diff --git a/tests/test/host/usbh/test_usbh.c b/tests/test/host/usbh/test_usbh.c
new file mode 100644
index 000000000..1058e54d6
--- /dev/null
+++ b/tests/test/host/usbh/test_usbh.c
@@ -0,0 +1,193 @@
+/*
+ * test_usbd_host.c
+ *
+ *  Created on: Jan 21, 2013
+ *      Author: hathach
+ */
+
+/*
+ * Software License Agreement (BSD License)
+ * Copyright (c) 2012, hathach (tinyusb.org)
+ * 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 "errors.h"
+
+#include "mock_osal.h"
+#include "usbh.h"
+#include "mock_hcd.h"
+#include "usbh_hcd.h"
+
+#include "mock_tusb_callback.h"
+#include "mock_hid_host.h"
+
+extern usbh_device_info_t usbh_devices[TUSB_CFG_HOST_DEVICE_MAX+1];
+uint8_t dev_addr;
+void setUp(void)
+{
+  dev_addr = RANDOM(TUSB_CFG_HOST_DEVICE_MAX)+1;
+  memset(usbh_devices, 0, (TUSB_CFG_HOST_DEVICE_MAX+1)*sizeof(usbh_device_info_t));
+}
+
+void tearDown(void)
+{
+}
+
+//--------------------------------------------------------------------+
+// get_status
+//--------------------------------------------------------------------+
+void test_usbh_status_get_fail(void)
+{
+  usbh_devices[dev_addr].state = 0;
+
+  TEST_ASSERT_EQUAL( TUSB_DEVICE_STATE_INVALID_PARAMETER, tusbh_device_get_state(TUSB_CFG_HOST_DEVICE_MAX+1) );
+  TEST_ASSERT_EQUAL( TUSB_DEVICE_STATE_UNPLUG, tusbh_device_get_state(dev_addr) );
+}
+
+void test_usbh_status_get_succeed(void)
+{
+  usbh_devices[dev_addr].state = TUSB_DEVICE_STATE_CONFIGURED;
+  TEST_ASSERT_EQUAL( TUSB_DEVICE_STATE_CONFIGURED, tusbh_device_get_state(dev_addr) );
+}
+
+//--------------------------------------------------------------------+
+// Init
+//--------------------------------------------------------------------+
+void test_usbh_init_hcd_failed(void)
+{
+  hcd_init_IgnoreAndReturn(TUSB_ERROR_HCD_FAILED);
+  TEST_ASSERT_EQUAL(TUSB_ERROR_HCD_FAILED, usbh_init());
+}
+
+void test_usbh_init_enum_task_create_failed(void)
+{
+  hcd_init_ExpectAndReturn(TUSB_ERROR_NONE);
+  for (uint8_t i=0; i<TUSB_CFG_HOST_DEVICE_MAX+1; i++)
+  {
+    osal_semaphore_handle_t sem_hdl_dummy = 0x2233;
+    osal_semaphore_create_IgnoreAndReturn(sem_hdl_dummy);
+  }
+
+  osal_task_create_IgnoreAndReturn(TUSB_ERROR_OSAL_TASK_FAILED);
+  TEST_ASSERT_EQUAL(TUSB_ERROR_OSAL_TASK_FAILED, usbh_init());
+}
+
+void test_usbh_init_enum_queue_create_failed(void)
+{
+  hcd_init_ExpectAndReturn(TUSB_ERROR_NONE);
+  for (uint8_t i=0; i<TUSB_CFG_HOST_DEVICE_MAX+1; i++)
+  {
+    osal_semaphore_handle_t sem_hdl_dummy = 0x2233;
+    osal_semaphore_create_IgnoreAndReturn(sem_hdl_dummy);
+  }
+
+  osal_task_create_IgnoreAndReturn(TUSB_ERROR_NONE);
+  osal_queue_create_IgnoreAndReturn(NULL);
+  TEST_ASSERT_EQUAL(TUSB_ERROR_OSAL_QUEUE_FAILED, usbh_init());
+}
+
+void test_usbh_init_reporter_taks_create_failed(void)
+{
+  TEST_IGNORE();
+}
+
+void test_usbh_init_reporter_queue_create_failed(void)
+{
+  TEST_IGNORE();
+}
+
+void class_init_expect(void)
+{
+  hidh_init_Expect();
+
+  //TODO update more classes
+}
+
+void test_usbh_init_ok(void)
+{
+  osal_queue_handle_t dummy = 0x1122;
+
+  usbh_device_info_t device_info_zero[TUSB_CFG_HOST_DEVICE_MAX+1];
+  memclr_(device_info_zero, sizeof(usbh_device_info_t)*(TUSB_CFG_HOST_DEVICE_MAX+1));
+
+  hcd_init_ExpectAndReturn(TUSB_ERROR_NONE);
+
+  for (uint8_t i=0; i<TUSB_CFG_HOST_DEVICE_MAX+1; i++)
+  {
+    osal_semaphore_handle_t sem_hdl_dummy = 0x2233;
+    osal_semaphore_create_IgnoreAndReturn(sem_hdl_dummy);
+    device_info_zero[i].control.sem_hdl = sem_hdl_dummy;
+  }
+
+  osal_task_create_IgnoreAndReturn(TUSB_ERROR_NONE);
+  osal_queue_create_IgnoreAndReturn(dummy);
+
+  class_init_expect();
+
+  TEST_ASSERT_EQUAL(TUSB_ERROR_NONE, usbh_init());
+
+  TEST_ASSERT_EQUAL_MEMORY(device_info_zero, usbh_devices, sizeof(usbh_device_info_t)*(TUSB_CFG_HOST_DEVICE_MAX+1));
+
+}
+
+void class_close_expect(void)
+{
+  hidh_close_Expect(1);
+}
+
+// device is not mounted before, even the control pipe is not open, do nothing
+void test_usbh_device_unplugged_isr_device_not_previously_mounted(void)
+{
+  uint8_t dev_addr = 1;
+
+  usbh_devices[dev_addr].state   = TUSB_DEVICE_STATE_UNPLUG;
+  usbh_devices[dev_addr].core_id  = 0;
+  usbh_devices[dev_addr].hub_addr = 0;
+  usbh_devices[dev_addr].hub_port = 0;
+
+  usbh_device_unplugged_isr(0);
+}
+
+void test_usbh_device_unplugged_isr(void)
+{
+  uint8_t dev_addr = 1;
+
+  usbh_devices[dev_addr].state = TUSB_DEVICE_STATE_CONFIGURED;
+  usbh_devices[dev_addr].core_id = 0;
+  usbh_devices[dev_addr].hub_addr = 0;
+  usbh_devices[dev_addr].hub_port = 0;
+  usbh_devices[dev_addr].flag_supported_class = TUSB_CLASS_FLAG_HID;
+
+  class_close_expect();
+  hcd_pipe_control_close_ExpectAndReturn(dev_addr, TUSB_ERROR_NONE);
+
+  //------------- Code Under Test -------------//
+  usbh_device_unplugged_isr(0);
+
+  TEST_ASSERT_EQUAL(TUSB_DEVICE_STATE_REMOVING, usbh_devices[dev_addr].state);
+}