mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
247 lines
10 KiB
C
247 lines
10 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/task.h"
|
|
#include "esp_err.h"
|
|
#include "esp_log.h"
|
|
#include "test_usb_mock_classes.h"
|
|
#include "test_usb_common.h"
|
|
#include "msc_client.h"
|
|
#include "usb/usb_host.h"
|
|
#include "unity.h"
|
|
#include "test_utils.h"
|
|
|
|
/*
|
|
Implementation of an asynchronous MSC client used for USB Host disconnection test.
|
|
|
|
- The MSC client will:
|
|
- Register itself as a client
|
|
- Receive USB_HOST_CLIENT_EVENT_NEW_DEV event message, and open the device
|
|
- Allocate IN and OUT transfer objects for MSC SCSI transfers
|
|
- Trigger a single MSC SCSI transfer
|
|
- Split the data stage into multiple transfers (so that the endpoint multiple queued up transfers)
|
|
- Cause a disconnection mid-way through the data stage
|
|
- All of the transfers should be automatically deqeueud
|
|
- Then a USB_HOST_CLIENT_EVENT_DEV_GONE event should occur afterwards
|
|
- Free transfer objects
|
|
- Close device
|
|
- Deregister MSC client
|
|
*/
|
|
|
|
#define MAX(x,y) (((x) >= (y)) ? (x) : (y))
|
|
#define MSC_CLIENT_MAX_EVENT_MSGS 5
|
|
|
|
typedef enum {
|
|
TEST_STAGE_WAIT_CONN,
|
|
TEST_STAGE_DEV_OPEN,
|
|
TEST_STAGE_MSC_RESET,
|
|
TEST_STAGE_MSC_CBW,
|
|
TEST_STAGE_MSC_DATA_DCONN,
|
|
TEST_STAGE_DEV_CLOSE,
|
|
} test_stage_t;
|
|
|
|
typedef struct {
|
|
msc_client_test_param_t test_param;
|
|
test_stage_t cur_stage;
|
|
test_stage_t next_stage;
|
|
uint8_t dev_addr_to_open;
|
|
usb_host_client_handle_t client_hdl;
|
|
usb_device_handle_t dev_hdl;
|
|
int num_data_transfers;
|
|
int event_count;
|
|
} msc_client_obj_t;
|
|
|
|
static void msc_reset_cbw_transfer_cb(usb_transfer_t *transfer)
|
|
{
|
|
msc_client_obj_t *msc_obj = (msc_client_obj_t *)transfer->context;
|
|
//We expect the reset and CBW transfers to complete with no issues
|
|
TEST_ASSERT_EQUAL(USB_TRANSFER_STATUS_COMPLETED, transfer->status);
|
|
TEST_ASSERT_EQUAL(transfer->num_bytes, transfer->actual_num_bytes);
|
|
switch (msc_obj->cur_stage) {
|
|
case TEST_STAGE_MSC_RESET:
|
|
msc_obj->next_stage = TEST_STAGE_MSC_CBW;
|
|
break;
|
|
case TEST_STAGE_MSC_CBW:
|
|
msc_obj->next_stage = TEST_STAGE_MSC_DATA_DCONN;
|
|
break;
|
|
default:
|
|
abort();
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void msc_data_transfer_cb(usb_transfer_t *transfer)
|
|
{
|
|
//The data stage should have either completed, or failed due to the disconnection.
|
|
TEST_ASSERT(transfer->status == USB_TRANSFER_STATUS_COMPLETED || transfer->status == USB_TRANSFER_STATUS_NO_DEVICE);
|
|
if (transfer->status == USB_TRANSFER_STATUS_COMPLETED) {
|
|
TEST_ASSERT_EQUAL(transfer->num_bytes, transfer->actual_num_bytes);
|
|
} else {
|
|
TEST_ASSERT_EQUAL(0, transfer->actual_num_bytes);
|
|
}
|
|
msc_client_obj_t *msc_obj = (msc_client_obj_t *)transfer->context;
|
|
msc_obj->event_count++;
|
|
//If all transfers dequeued and device gone event occurred. Go to next stage
|
|
if (msc_obj->event_count >= msc_obj->num_data_transfers + 1) {
|
|
msc_obj->next_stage = TEST_STAGE_DEV_CLOSE;
|
|
}
|
|
}
|
|
|
|
static void msc_client_event_cb(const usb_host_client_event_msg_t *event_msg, void *arg)
|
|
{
|
|
msc_client_obj_t *msc_obj = (msc_client_obj_t *)arg;
|
|
switch (event_msg->event) {
|
|
case USB_HOST_CLIENT_EVENT_NEW_DEV:
|
|
TEST_ASSERT_EQUAL(TEST_STAGE_WAIT_CONN, msc_obj->cur_stage);
|
|
msc_obj->next_stage = TEST_STAGE_DEV_OPEN;
|
|
msc_obj->dev_addr_to_open = event_msg->new_dev.address;
|
|
break;
|
|
case USB_HOST_CLIENT_EVENT_DEV_GONE:
|
|
msc_obj->event_count++;
|
|
//If all transfers dequeued and device gone event occurred. Go to next stage
|
|
if (msc_obj->event_count >= msc_obj->num_data_transfers + 1) {
|
|
msc_obj->next_stage = TEST_STAGE_DEV_CLOSE;
|
|
}
|
|
break;
|
|
default:
|
|
abort(); //Should never occur in this test
|
|
break;
|
|
}
|
|
}
|
|
|
|
void msc_client_async_dconn_task(void *arg)
|
|
{
|
|
msc_client_obj_t msc_obj;
|
|
memcpy(&msc_obj.test_param, arg, sizeof(msc_client_test_param_t));
|
|
msc_obj.cur_stage = TEST_STAGE_WAIT_CONN;
|
|
msc_obj.next_stage = TEST_STAGE_WAIT_CONN;
|
|
msc_obj.dev_addr_to_open = 0;
|
|
msc_obj.client_hdl = NULL;
|
|
msc_obj.dev_hdl = NULL;
|
|
msc_obj.num_data_transfers = msc_obj.test_param.num_sectors_per_xfer / MOCK_MSC_SCSI_SECTOR_SIZE;
|
|
msc_obj.event_count = 0;
|
|
|
|
//Register client
|
|
usb_host_client_config_t client_config = {
|
|
.client_event_callback = msc_client_event_cb,
|
|
.callback_arg = (void *)&msc_obj,
|
|
.max_num_event_msg = MSC_CLIENT_MAX_EVENT_MSGS,
|
|
};
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_client_register(&client_config, &msc_obj.client_hdl));
|
|
|
|
//Allocate transfers
|
|
usb_transfer_t *xfer_out; //Must be large enough to contain CBW and MSC reset control transfer
|
|
usb_transfer_t *xfer_in[msc_obj.num_data_transfers]; //We manually split the data stage into multiple transfers
|
|
size_t xfer_out_size = MAX(sizeof(mock_msc_bulk_cbw_t), sizeof(usb_setup_packet_t));
|
|
size_t xfer_in_size = MOCK_MSC_SCSI_SECTOR_SIZE;
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_alloc(xfer_out_size, 0, &xfer_out));
|
|
xfer_out->context = (void *)&msc_obj;
|
|
for (int i = 0; i < msc_obj.num_data_transfers; i++) {
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_alloc(xfer_in_size, 0, &xfer_in[i]));
|
|
xfer_in[i]->context = (void *)&msc_obj;
|
|
}
|
|
|
|
//Wait to be started by main thread
|
|
ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
|
|
ESP_LOGD(MSC_CLIENT_TAG, "Starting");
|
|
|
|
bool exit_loop = false;
|
|
bool skip_event_handling = false;
|
|
while (!exit_loop) {
|
|
if (!skip_event_handling) {
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_client_handle_events(msc_obj.client_hdl, portMAX_DELAY));
|
|
}
|
|
skip_event_handling = false;
|
|
if (msc_obj.cur_stage == msc_obj.next_stage) {
|
|
continue;
|
|
}
|
|
msc_obj.cur_stage = msc_obj.next_stage;
|
|
|
|
switch (msc_obj.cur_stage) {
|
|
case TEST_STAGE_DEV_OPEN: {
|
|
ESP_LOGD(MSC_CLIENT_TAG, "Open");
|
|
//Open the device
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_device_open(msc_obj.client_hdl, msc_obj.dev_addr_to_open, &msc_obj.dev_hdl));
|
|
//Target our transfers to the device
|
|
xfer_out->device_handle = msc_obj.dev_hdl;
|
|
xfer_out->callback = msc_reset_cbw_transfer_cb;
|
|
for (int i = 0; i < msc_obj.num_data_transfers; i++) {
|
|
xfer_in[i]->device_handle = msc_obj.dev_hdl;
|
|
xfer_in[i]->callback = msc_data_transfer_cb;
|
|
}
|
|
//Check the VID/PID of the opened device
|
|
const usb_device_desc_t *device_desc;
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_get_device_descriptor(msc_obj.dev_hdl, &device_desc));
|
|
TEST_ASSERT_EQUAL(msc_obj.test_param.idVendor, device_desc->idVendor);
|
|
TEST_ASSERT_EQUAL(msc_obj.test_param.idProduct, device_desc->idProduct);
|
|
//Claim the MSC interface
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_interface_claim(msc_obj.client_hdl, msc_obj.dev_hdl, MOCK_MSC_SCSI_INTF_NUMBER, MOCK_MSC_SCSI_INTF_ALT_SETTING));
|
|
msc_obj.next_stage = TEST_STAGE_MSC_RESET;
|
|
skip_event_handling = true; //Need to execute TEST_STAGE_MSC_RESET
|
|
break;
|
|
}
|
|
case TEST_STAGE_MSC_RESET: {
|
|
ESP_LOGD(MSC_CLIENT_TAG, "MSC Reset");
|
|
//Send an MSC SCSI interface reset
|
|
MOCK_MSC_SCSI_REQ_INIT_RESET((usb_setup_packet_t *)xfer_out->data_buffer, MOCK_MSC_SCSI_INTF_NUMBER);
|
|
xfer_out->num_bytes = sizeof(usb_setup_packet_t);
|
|
xfer_out->bEndpointAddress = 0;
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_submit_control(msc_obj.client_hdl, xfer_out));
|
|
//Next stage set from transfer callback
|
|
break;
|
|
}
|
|
case TEST_STAGE_MSC_CBW: {
|
|
ESP_LOGD(MSC_CLIENT_TAG, "CBW");
|
|
mock_msc_scsi_init_cbw((mock_msc_bulk_cbw_t *)xfer_out->data_buffer, true, 0, msc_obj.test_param.num_sectors_per_xfer, msc_obj.test_param.msc_scsi_xfer_tag);
|
|
xfer_out->num_bytes = sizeof(mock_msc_bulk_cbw_t);
|
|
xfer_out->bEndpointAddress = MOCK_MSC_SCSI_BULK_OUT_EP_ADDR;
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_submit(xfer_out));
|
|
//Next stage set from transfer callback
|
|
break;
|
|
}
|
|
case TEST_STAGE_MSC_DATA_DCONN: {
|
|
ESP_LOGD(MSC_CLIENT_TAG, "Data and disconnect");
|
|
//Setup the Data IN transfers
|
|
for (int i = 0; i < msc_obj.num_data_transfers; i++) {
|
|
xfer_in[i]->num_bytes = usb_round_up_to_mps(MOCK_MSC_SCSI_SECTOR_SIZE, MOCK_MSC_SCSI_BULK_EP_MPS);
|
|
xfer_in[i]->bEndpointAddress = MOCK_MSC_SCSI_BULK_IN_EP_ADDR;
|
|
}
|
|
//Submit those transfers
|
|
for (int i = 0; i < msc_obj.num_data_transfers; i++) {
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_submit(xfer_in[i]));
|
|
}
|
|
//Trigger a disconnect
|
|
test_usb_force_conn_state(false, 0);
|
|
//Next stage set from transfer callback
|
|
break;
|
|
}
|
|
case TEST_STAGE_DEV_CLOSE: {
|
|
ESP_LOGD(MSC_CLIENT_TAG, "Close");
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_interface_release(msc_obj.client_hdl, msc_obj.dev_hdl, MOCK_MSC_SCSI_INTF_NUMBER));
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_device_close(msc_obj.client_hdl, msc_obj.dev_hdl));
|
|
exit_loop = true;
|
|
break;
|
|
}
|
|
default:
|
|
abort();
|
|
break;
|
|
}
|
|
}
|
|
//Free transfers
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_free(xfer_out));
|
|
for (int i = 0; i < msc_obj.num_data_transfers; i++) {
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_transfer_free(xfer_in[i]));
|
|
}
|
|
//Deregister the client
|
|
TEST_ASSERT_EQUAL(ESP_OK, usb_host_client_deregister(msc_obj.client_hdl));
|
|
ESP_LOGD(MSC_CLIENT_TAG, "Done");
|
|
vTaskDelete(NULL);
|
|
}
|