/***************************************************************************/ /* Copyright (c) 2024 Microsoft Corporation */ /* Copyright (c) 2026 Eclipse ThreadX contributors */ /* */ /* This program and the accompanying materials are made available under */ /* the terms of the MIT License which is available at */ /* https://opensource.org/licenses/MIT. */ /* */ /* SPDX-License-Identifier: MIT */ /***************************************************************************/ /* This test is designed to test the simple dpump host/device class operation. */ #include #include "tx_api.h" #include "ux_api.h" #include "ux_system.h" #include "ux_utility.h" #include "fx_api.h" #include "ux_device_class_cdc_acm.h" #include "ux_device_stack.h" #include "ux_host_class_cdc_acm.h" #include "ux_test_dcd_sim_slave.h" #include "ux_test_hcd_sim_host.h" #include "ux_test_utility_sim.h" /* Define constants. */ #define UX_DEMO_DEBUG_SIZE (4096*8) #define UX_DEMO_STACK_SIZE 1024 #define UX_DEMO_BUFFER_SIZE (UX_SLAVE_REQUEST_DATA_MAX_LENGTH + 1) #define UX_DEMO_XMIT_BUFFER_SIZE 512 #define UX_DEMO_RECEPTION_BUFFER_SIZE 512 #define UX_DEMO_FILE_BUFFER_SIZE 512 #define UX_DEMO_RECEPTION_BLOCK_SIZE 64 #define UX_DEMO_MEMORY_SIZE (64*1024) #define UX_DEMO_FILE_SIZE (128 * 1024) #define UX_RAM_DISK_MEMORY (256 * 1024) /* Define local/extern function prototypes. */ static VOID test_thread_entry(ULONG); static TX_THREAD tx_test_thread_host_simulation; static TX_THREAD tx_test_thread_slave_simulation; static VOID tx_test_thread_host_simulation_entry(ULONG); static VOID tx_test_thread_slave_simulation_entry(ULONG); static VOID ux_test_hcd_entry_should_not_be_called(UX_TEST_ACTION *action, VOID *params); static VOID ux_test_hcd_entry_disconnect(UX_TEST_ACTION *action, VOID *params); static VOID ux_test_hcd_entry_set_cfg(UX_TEST_ACTION *action, VOID *params); /* Define global data structures. */ static UCHAR usbx_memory[UX_DEMO_MEMORY_SIZE + (UX_DEMO_STACK_SIZE * 4)]; static UX_DEVICE *device = UX_NULL; static UX_HOST_CLASS_CDC_ACM *host_cdc_acm = UX_NULL; static ULONG enum_counter; static ULONG error_counter; static ULONG error_callback_counter; static ULONG set_cfg_counter; static ULONG rsc_mem_alloc_cnt_on_set_cfg; static ULONG rsc_mem_free_on_set_cfg; static ULONG rsc_sem_on_set_cfg; static ULONG rsc_sem_get_on_set_cfg; static ULONG rsc_mutex_on_set_cfg; static ULONG rsc_enum_sem_usage; static ULONG rsc_enum_sem_get_count; static ULONG rsc_enum_mutex_usage; static ULONG rsc_enum_mem_usage; static ULONG rsc_enum_mem_alloc_count; static ULONG rsc_test_sem_usage; static ULONG rsc_test_sem_get_count; static ULONG rsc_test_mutex_usage; static ULONG rsc_test_mem_alloc_count; static UX_SLAVE_CLASS_CDC_ACM *device_cdc_acm = UX_NULL; static UX_SLAVE_CLASS_CDC_ACM_PARAMETER device_cdc_acm_parameter; /* Define device framework. */ #define _W0(w) ( (w) & 0xFF) #define _W1(w) (((w) >> 8) & 0xFF) #define _CONFIGURATION_DESCRIPTOR(total_len, n_ifc, cfg_val) \ 0x09, 0x02, _W0(total_len), _W1(total_len), (n_ifc), (cfg_val), \ 0x00, 0xc0, 0x32, #define _INTERFACE_DESCRIPTOR(ifc_n, alt, n_ep, cls, sub, protocol) \ 0x09, 0x04, (ifc_n), (alt), (n_ep), (cls), (sub), (protocol), 0x00, #define _ENDPOINT_DESCRIPTOR(addr, attr, pktsize, interval) \ 0x07, 0x05, (addr), (attr), _W0(pktsize), _W1(pktsize), (interval), #define _CFG_TOTAL_LEN (9 +8 +9 +5+4+5+5 +7 +9 +7+7) #define STRING_FRAMEWORK_LENGTH 47 #define LANGUAGE_ID_FRAMEWORK_LENGTH 2 static unsigned char device_framework_full_speed[] = { /* Device descriptor 18 bytes 0xEF bDeviceClass: Composite class code 0x02 bDeviceSubclass: class sub code 0x00 bDeviceProtocol: Device protocol idVendor & idProduct - http://www.linux-usb.org/usb.ids */ 0x12, 0x01, 0x10, 0x01, 0x00, 0x00, 0x00, 0x08, 0x84, 0x84, 0x00, 0x00, 0x00, 0x01, 0x01, 0x02, 0x03, 0x01, _CONFIGURATION_DESCRIPTOR(_CFG_TOTAL_LEN, 2, 1) /* Interface association descriptor. 8 bytes. */ 0x08, 0x0b, 0x00, 0x02, 0x02, 0x02, 0x00, 0x00, _INTERFACE_DESCRIPTOR(0, 0, 1, 0x02, 0x02, 0x01) /* Header Functional Descriptor 5 bytes */ 0x05, 0x24, 0x00, 0x10, 0x01, /* ACM Functional Descriptor 4 bytes */ 0x04, 0x24, 0x02, 0x0f, /* Union Functional Descriptor 5 bytes */ 0x05, 0x24, 0x06, 0x00, /* Master interface */ 0x01, /* Slave interface */ /* Call Management Functional Descriptor 5 bytes */ 0x05, 0x24, 0x01, 0x03, 0x01, /* Data interface */ _ENDPOINT_DESCRIPTOR(0x83, 0x03, 8, 0x0a) _INTERFACE_DESCRIPTOR(1, 0, 2, 0x0a, 0x00, 0x00) _ENDPOINT_DESCRIPTOR(0x01, 0x02, 64, 0x00) _ENDPOINT_DESCRIPTOR(0x82, 0x02, 64, 0x00) }; #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED sizeof(device_framework_full_speed) #define DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED sizeof(device_framework_full_speed) #define device_framework_high_speed device_framework_full_speed static unsigned char string_framework[] = { /* Manufacturer string descriptor : Index 1 - "AzureRTOS" */ 0x09, 0x04, 0x01, 9, 'A','z','u','r','e','R','T','O','S', /* Product string descriptor : Index 2 - "Printer device" */ 0x09, 0x04, 0x02, 14, 'P','r','i','n','t','e','r',' ','d','e','v','i','c','e', /* Serial Number string descriptor : Index 3 - "0001" */ 0x09, 0x04, 0x03, 0x04, 0x30, 0x30, 0x30, 0x31 }; /* Multiple languages are supported on the device, to add a language besides english, the unicode language code must be appended to the language_id_framework array and the length adjusted accordingly. */ static unsigned char language_id_framework[] = { /* English. */ 0x09, 0x04 }; static UX_TEST_SETUP _SetConfigure = UX_TEST_SETUP_SetConfigure; /* Test interactions */ static UX_TEST_HCD_SIM_ACTION log_on_SetCfg[] = { /* function, request to match, port action, port status, request action, request EP, request data, request actual length, request status, status, additional callback, no_return */ { UX_HCD_TRANSFER_REQUEST, &_SetConfigure, UX_FALSE, UX_TEST_PORT_STATUS_DISC, UX_TEST_SETUP_MATCH_REQ, 0, UX_NULL, 0, 0, UX_SUCCESS, ux_test_hcd_entry_set_cfg, UX_TRUE}, /* Invoke callback & continue */ { 0 } }; /* Define the ISR dispatch. */ extern VOID (*test_isr_dispatch)(void); /* Prototype for test control return. */ void test_control_return(UINT status); /* Define the ISR dispatch routine. */ static void test_isr(void) { /* For further expansion of interrupt-level testing. */ } static UINT test_slave_change_function(ULONG change) { return 0; } #include "ux_host_stack.h" static UINT _test_state_to_disconnect = UX_HOST_STACK_ENUM_WAIT; static VOID _test_standalone_dev_retry_with_buffer(VOID) { UX_DEVICE *dev; UX_TRANSFER *trans; /* Check device state and allocated buffer. */ if (!_ux_system_host) return; dev = &_ux_system_host->ux_system_host_device_array[0]; trans = dev->ux_device_enum_trans; if ((dev->ux_device_enum_state == _test_state_to_disconnect) && (trans) && (trans->ux_transfer_request_data_pointer)) { /* Memory allocated, disconnect device to see if memory is double freed. */ ux_test_dcd_sim_slave_disconnect(); ux_test_hcd_sim_host_disconnect(); } } static UINT test_host_change_function(ULONG event, UX_HOST_CLASS *cls, VOID *inst) { UX_HOST_CLASS_CDC_ACM *cdc_acm_inst = (UX_HOST_CLASS_CDC_ACM *) inst; switch(event) { case UX_DEVICE_INSERTION: host_cdc_acm = cdc_acm_inst; break; case UX_DEVICE_REMOVAL: if (host_cdc_acm == cdc_acm_inst) host_cdc_acm = UX_NULL; break; case UX_DEVICE_CONNECTION: device = (UX_DEVICE *)inst; break; case UX_DEVICE_DISCONNECTION: if ((VOID *)device == inst) device = UX_NULL; break; #if defined(UX_HOST_STANDALONE) case UX_STANDALONE_WAIT_BACKGROUND_TASK: tx_thread_relinquish(); _test_standalone_dev_retry_with_buffer(); break; #endif default: break; } return 0; } static VOID test_cdc_acm_instance_activate(VOID *dummy_instance) { if (device_cdc_acm == UX_NULL) device_cdc_acm = (UX_SLAVE_CLASS_CDC_ACM *)dummy_instance; } static VOID test_cdc_acm_instance_deactivate(VOID *dummy_instance) { if ((VOID*)device_cdc_acm == dummy_instance) device_cdc_acm = UX_NULL; } static VOID test_ux_error_callback(UINT system_level, UINT system_context, UINT error_code) { printf("ERROR #%d: 0x%x, 0x%x, 0x%x\n", __LINE__, system_level, system_context, error_code); UX_TEST_ASSERT(!( (system_context == UX_SYSTEM_CONTEXT_UTILITY) && (error_code == UX_MEMORY_CORRUPTED))); /* fail on UX_MEMORY_CORRUPTED */ error_callback_counter ++; } static VOID ux_test_hcd_entry_set_cfg(UX_TEST_ACTION *action, VOID *params) { set_cfg_counter ++; rsc_mem_free_on_set_cfg = ux_test_regular_memory_free(); rsc_mem_alloc_cnt_on_set_cfg = ux_test_utility_sim_mem_alloc_count(); rsc_sem_on_set_cfg = ux_test_utility_sim_sem_create_count(); rsc_enum_sem_get_count = ux_test_utility_sim_sem_get_count(); rsc_mutex_on_set_cfg = ux_test_utility_sim_mutex_create_count(); } /* Define what the initial system looks like. */ #ifdef CTEST void test_application_define(void *first_unused_memory) #else void usbx_msrc_81691_standalone_host_stack_enum_double_free_test_application_define(void *first_unused_memory) #endif { UINT status; CHAR * stack_pointer; CHAR * memory_pointer; printf("Running MSRC 81691 - Standalone Host Stack Enum Double Free Test.... "); #if !defined(UX_HOST_STANDALONE) printf("Skip\n"); test_control_return(0); return; #endif /* Reset testing counts. */ ux_test_utility_sim_mem_alloc_log_enable(UX_TRUE); ux_test_utility_sim_mem_alloc_count_reset(); ux_test_utility_sim_mutex_create_count_reset(); ux_test_utility_sim_sem_create_count_reset(); ux_test_utility_sim_sem_get_count_reset(); /* Reset error generations */ ux_test_utility_sim_sem_error_generation_stop(); ux_test_utility_sim_mutex_error_generation_stop(); ux_test_utility_sim_sem_get_error_generation_stop(); /* Initialize the free memory pointer */ stack_pointer = (CHAR *) usbx_memory; memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 4); /* Initialize USBX Memory */ status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0); UX_TEST_CHECK_SUCCESS(status); /* Register the error callback. */ _ux_utility_error_callback_register(test_ux_error_callback); /* The code below is required for installing the host portion of USBX */ status = ux_host_stack_initialize(test_host_change_function); UX_TEST_CHECK_SUCCESS(status); /* Register CDC_ACM class. */ status = ux_host_stack_class_register(_ux_system_host_class_cdc_acm_name, ux_host_class_cdc_acm_entry); UX_TEST_CHECK_SUCCESS(status); /* The code below is required for installing the device portion of USBX. No call back for device status change in this example. */ status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED, device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED, string_framework, STRING_FRAMEWORK_LENGTH, language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH, test_slave_change_function); UX_TEST_CHECK_SUCCESS(status); /* Set the parameters for callback when insertion/extraction of a cdc_acm device. */ _ux_utility_memory_set(&device_cdc_acm_parameter, 0, sizeof(device_cdc_acm_parameter)); device_cdc_acm_parameter.ux_slave_class_cdc_acm_instance_activate = test_cdc_acm_instance_activate; device_cdc_acm_parameter.ux_slave_class_cdc_acm_instance_deactivate = test_cdc_acm_instance_deactivate; /* Initialize the device cdc class. This class owns both interfaces starting with 0. */ status = ux_device_stack_class_register(_ux_system_slave_class_cdc_acm_name, ux_device_class_cdc_acm_entry, 1, 0, &device_cdc_acm_parameter); /* Initialize the simulated device controller. */ status = _ux_test_dcd_sim_slave_initialize(); UX_TEST_CHECK_SUCCESS(status); /* Register all the USB host controllers available in this system */ status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, _ux_test_hcd_sim_host_initialize,0,0); UX_TEST_CHECK_SUCCESS(status); /* Modify bMaxPacketSize0 to generate retrying. */ device_framework_full_speed[7] = 0x00; _test_state_to_disconnect = UX_HOST_STACK_ENUM_WAIT; /* Create the main host simulation thread. */ status = tx_thread_create(&tx_test_thread_host_simulation, "tx test host simulation", tx_test_thread_host_simulation_entry, 0, stack_pointer, UX_DEMO_STACK_SIZE, 20, 20, 1, TX_AUTO_START); UX_TEST_ASSERT(status == TX_SUCCESS); /* Create the main slave simulation thread. */ stack_pointer += UX_DEMO_STACK_SIZE; status = tx_thread_create(&tx_test_thread_slave_simulation, "tx test slave simulation", tx_test_thread_slave_simulation_entry, 0, stack_pointer, UX_DEMO_STACK_SIZE, 20, 20, 1, TX_AUTO_START); UX_TEST_ASSERT(status == TX_SUCCESS); } static UINT _test_check_host_connection_error(VOID) { if (device_cdc_acm && host_cdc_acm) return(UX_SUCCESS); if (error_callback_counter >= 3) return(UX_SUCCESS); return(UX_ERROR); } static UINT _test_check_host_connection_success(VOID) { if (device_cdc_acm && host_cdc_acm) return(UX_SUCCESS); return(UX_ERROR); } static UINT _test_check_host_disconnection_success(VOID) { if (device_cdc_acm == UX_NULL && host_cdc_acm == UX_NULL) return(UX_SUCCESS); return(UX_ERROR); } void tx_test_thread_host_simulation_entry(ULONG arg) { UINT status; ULONG test_n; ULONG mem_free; ULONG loop; ULONG parameter_u32[64/4]; USHORT *parameter_u16 = (USHORT*)parameter_u32; UCHAR *parameter_u8 = (UCHAR*)parameter_u32; stepinfo("\n"); stepinfo(">>>>>>>>>>>>>>>> Test connect\n"); ux_test_dcd_sim_slave_connect(UX_FULL_SPEED_DEVICE); ux_test_hcd_sim_host_connect(UX_FULL_SPEED_DEVICE); status = ux_test_sleep_break_on_error(10000, _test_check_host_connection_success); UX_TEST_ASSERT(status == UX_SUCCESS); /* Test disconnect. */ stepinfo(">>>>>>>>>>>>>>>> Test disconnect\n"); ux_test_dcd_sim_slave_disconnect(); ux_test_hcd_sim_host_disconnect(); if (host_cdc_acm != UX_NULL) { printf("ERROR #13: instance not removed when disconnect"); test_control_return(1); } /* Finally disconnect the device. */ ux_device_stack_disconnect(); /* And deinitialize the class. */ status = ux_device_stack_class_unregister(_ux_system_slave_class_cdc_acm_name, _ux_device_class_cdc_acm_entry); /* Deinitialize the device side of usbx. */ _ux_device_stack_uninitialize(); /* And finally the usbx system resources. */ _ux_system_uninitialize(); /* Successful test. */ printf("SUCCESS!\n"); test_control_return(0); } void tx_test_thread_slave_simulation_entry(ULONG arg) { while(1) { #if defined(UX_DEVICE_STANDALONE) ux_system_tasks_run(); tx_thread_relinquish(); #else /* Sleep so ThreadX on Win32 will delete this thread. */ tx_thread_sleep(10); #endif } }