/* This file tests ux_host_class_hid_descriptor_parse() */ #include "usbx_test_common_hid.h" #include "ux_host_class_hid_keyboard.h" #define DUMMY_USBX_MEMORY_SIZE (64*1024) static UCHAR dummy_usbx_memory[DUMMY_USBX_MEMORY_SIZE]; static UCHAR hid_report_descriptor[] = { 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 0x09, 0x06, // USAGE (Keyboard) 0xa1, 0x01, // COLLECTION (Application) 0x05, 0x07, // USAGE_PAGE (Keyboard) 0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl) 0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI) 0x15, 0x00, // LOGICAL_MINIMUM (0) 0x25, 0x01, // LOGICAL_MAXIMUM (1) 0x75, 0x01, // REPORT_SIZE (1) 0x95, 0x08, // REPORT_COUNT (8) 0x81, 0x02, // INPUT (Data,Var,Abs) 0x95, 0x01, // REPORT_COUNT (1) 0x75, 0x08, // REPORT_SIZE (8) 0x81, 0x03, // INPUT (Cnst,Var,Abs) 0x95, 0x05, // REPORT_COUNT (5) 0x75, 0x01, // REPORT_SIZE (1) 0x05, 0x08, // USAGE_PAGE (LEDs) 0x19, 0x01, // USAGE_MINIMUM (Num Lock) 0x29, 0x05, // USAGE_MAXIMUM (Kana) 0x91, 0x02, // OUTPUT (Data,Var,Abs) 0x95, 0x01, // REPORT_COUNT (1) 0x75, 0x03, // REPORT_SIZE (3) 0x91, 0x03, // OUTPUT (Cnst,Var,Abs) 0x95, 0x06, // REPORT_COUNT (6) 0x75, 0x08, // REPORT_SIZE (8) 0x15, 0x00, // LOGICAL_MINIMUM (0) 0x25, 0x65, // LOGICAL_MAXIMUM (101) 0x05, 0x07, // USAGE_PAGE (Keyboard) 0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated)) 0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application) 0x81, 0x00, // INPUT (Data,Ary,Abs) 0xc0 // END_COLLECTION }; #define HID_REPORT_LENGTH sizeof(hid_report_descriptor)/sizeof(hid_report_descriptor[0]) #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED 52 static UCHAR device_framework_full_speed[DEVICE_FRAMEWORK_LENGTH_FULL_SPEED] = { /* Device descriptor */ 0x12, 0x01, 0x10, 0x01, 0x00, 0x00, 0x00, 0x08, 0x81, 0x0A, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, /* Configuration descriptor */ 0x09, 0x02, 0x22, 0x00, 0x01, 0x01, 0x00, 0xc0, 0x32, /* Interface descriptor */ 0x09, 0x04, 0x02, 0x00, 0x01, 0x03, 0x00, 0x00, 0x00, /* HID descriptor */ 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_REPORT_LENGTH), MSB(HID_REPORT_LENGTH), /* Endpoint descriptor (Interrupt) */ 0x07, 0x05, 0x82, 0x03, 0x08, 0x00, 0x08 }; #define DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED 62 static UCHAR device_framework_high_speed[DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED] = { /* Device descriptor */ 0x12, 0x01, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40, 0x0a, 0x07, 0x25, 0x40, 0x01, 0x00, 0x01, 0x02, 0x03, 0x01, /* Device qualifier descriptor */ 0x0a, 0x06, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40, 0x01, 0x00, /* Configuration descriptor */ 0x09, 0x02, 0x22, 0x00, 0x01, 0x01, 0x00, 0xc0, 0x32, /* Interface descriptor */ 0x09, 0x04, 0x02, 0x00, 0x01, 0x03, 0x00, 0x00, 0x00, /* HID descriptor */ 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_REPORT_LENGTH), MSB(HID_REPORT_LENGTH), /* Endpoint descriptor (Interrupt) */ 0x07, 0x05, 0x82, 0x03, 0x08, 0x00, 0x08 }; /* String Device Framework : Byte 0 and 1 : Word containing the language ID : 0x0904 for US Byte 2 : Byte containing the index of the descriptor Byte 3 : Byte containing the length of the descriptor string */ #define STRING_FRAMEWORK_LENGTH 40 static UCHAR string_framework[] = { /* Manufacturer string descriptor : Index 1 */ 0x09, 0x04, 0x01, 0x0c, 0x45, 0x78, 0x70, 0x72,0x65, 0x73, 0x20, 0x4c, 0x6f, 0x67, 0x69, 0x63, /* Product string descriptor : Index 2 */ 0x09, 0x04, 0x02, 0x0c, 0x55, 0x53, 0x42, 0x20, 0x4b, 0x65, 0x79, 0x62, 0x6f, 0x61, 0x72, 0x64, /* Serial Number string descriptor : Index 3 */ 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. */ #define LANGUAGE_ID_FRAMEWORK_LENGTH 2 static UCHAR language_id_framework[] = { /* English. */ 0x09, 0x04 }; UINT _ux_hcd_sim_host_entry(UX_HCD *hcd, UINT function, VOID *parameter); static UINT ux_system_host_change_function(ULONG a, UX_HOST_CLASS *b, VOID *c) { return 0; } static VOID error_callback(UINT system_level, UINT system_context, UINT error_code) { } /* Define what the initial system looks like. */ #ifdef CTEST void test_application_define(void *first_unused_memory) #else void usbx_ux_host_class_hid_descriptor_parse_test_application_define(void *first_unused_memory) #endif { UINT status; CHAR * stack_pointer; CHAR * memory_pointer; /* Inform user. */ printf("Running ux_host_class_hid_descriptor_parse Test..................... "); /* Initialize the free memory pointer */ stack_pointer = (CHAR *) usbx_memory; memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2); /* Initialize USBX. Memory */ status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0); /* Check for error. */ if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Register the error callback. */ _ux_utility_error_callback_register(error_callback); /* The code below is required for installing the host portion of USBX */ status = ux_host_stack_initialize(ux_system_host_change_function); if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry); if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Register the HID client(s). */ status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry); if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* 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,UX_NULL); if(status!=UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Initialize the hid class parameters. */ hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor; hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH; hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback; /* Initilize the device hid class. The class is connected with interface 2 */ status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry, 1,2, (VOID *)&hid_parameter); if(status!=UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Initialize the simulated device controller. */ status = _ux_dcd_sim_slave_initialize(); /* Check for error. */ if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Register all the USB host controllers available in this system */ status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0); /* Check for error. */ if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Create the main host simulation thread. */ status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0, stack_pointer, UX_DEMO_STACK_SIZE, 20, 20, 1, TX_AUTO_START); /* Check for error. */ if (status != TX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } } static UINT ux_hcd_sim_host_entry_filter(UX_HCD *hcd, UINT function, VOID *parameter) { UINT status; switch(function) { case UX_HCD_TRANSFER_REQUEST: status = UX_ERROR; break; default: status = _ux_hcd_sim_host_entry(hcd, function, parameter); break; } return status; } static UINT ux_hcd_sim_host_entry_filter_descriptor_too_small_test(UX_HCD *hcd, UINT function, VOID *parameter) { UINT status; UX_TRANSFER *transfer_request; switch(function) { case UX_HCD_TRANSFER_REQUEST: transfer_request = (UX_TRANSFER *)parameter; /* Set the total configuration length to be greater than 0. */ transfer_request -> ux_transfer_request_data_pointer[2] = 0x01; /* Set the first descriptor length to be less than 3. */ transfer_request -> ux_transfer_request_data_pointer[0] = 0x00; transfer_request -> ux_transfer_request_actual_length = transfer_request -> ux_transfer_request_requested_length; status = UX_SUCCESS; break; default: status = _ux_hcd_sim_host_entry(hcd, function, parameter); break; } return status; } static UINT ux_hcd_sim_host_entry_filter_descriptor_too_large_test(UX_HCD *hcd, UINT function, VOID *parameter) { UINT status; UX_TRANSFER *transfer_request; switch(function) { case UX_HCD_TRANSFER_REQUEST: transfer_request = (UX_TRANSFER *)parameter; /* Set the total configuration length to be greater than 0. */ transfer_request -> ux_transfer_request_data_pointer[2] = 0x01; /* Set the first descriptor length to be greater than the total configuration length and at least 3. */ transfer_request -> ux_transfer_request_data_pointer[0] = 0x03; transfer_request -> ux_transfer_request_actual_length = transfer_request -> ux_transfer_request_requested_length; status = UX_SUCCESS; break; default: status = _ux_hcd_sim_host_entry(hcd, function, parameter); break; } return status; } static void tx_demo_thread_host_simulation_entry(ULONG arg) { UINT status; UX_HCD *hcd; ALIGN_TYPE tmp; // UX_MEMORY_BLOCK *dummy_memory_block_first = (UX_MEMORY_BLOCK *)dummy_usbx_memory; // UX_MEMORY_BLOCK *original_regular_memory_block = _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start; // UX_MEMORY_BLOCK *original_cache_safe_memory_block = _ux_system -> ux_system_cache_safe_memory_pool_start; /* Find the HID class */ status = demo_class_hid_get(); if (status != UX_SUCCESS) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } #if 0 /* Covered in basic memory tests. */ /**************************************************/ /** Test case: descriptor = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_CONFIGURATION_DESCRIPTOR_LENGTH); fails **/ /**************************************************/ /* Set up the dummy memory block. */ dummy_memory_block_first -> ux_memory_block_next = UX_NULL; dummy_memory_block_first -> ux_memory_block_previous = UX_NULL; dummy_memory_block_first -> ux_memory_block_status = UX_MEMORY_UNUSED; dummy_memory_block_first -> ux_memory_block_size = 0; _ux_system -> ux_system_regular_memory_pool_start = dummy_memory_block_first; _ux_system -> ux_system_cache_safe_memory_pool_start = dummy_memory_block_first; status = _ux_host_class_hid_descriptor_parse(hid); if (status != UX_MEMORY_INSUFFICIENT) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Restore state for next test. */ _ux_system -> ux_system_regular_memory_pool_start = original_regular_memory_block; _ux_system -> ux_system_cache_safe_memory_pool_start = original_cache_safe_memory_block; #endif /**************************************************/ /** Test case: ux_host_stack_transfer_request() failed. **/ /** Why direct: To fail normally, I'd have to replace the entry function and somehow distinguish GET_DESCRIPTOR requests. **/ /**************************************************/ /* Replace the entry function. */ hcd = UX_DEVICE_HCD_GET(hid -> ux_host_class_hid_device); tmp = (ALIGN_TYPE)hcd -> ux_hcd_entry_function; hcd -> ux_hcd_entry_function = ux_hcd_sim_host_entry_filter; status = _ux_host_class_hid_descriptor_parse(hid); if(status != UX_DESCRIPTOR_CORRUPTED) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Restore state for next test. */ hcd -> ux_hcd_entry_function = (UINT (*) (struct UX_HCD_STRUCT *, UINT, VOID *))tmp; /**************************************************/ /** Test case: if (descriptor_length < 3) **/ /** Why direct: To fail normally, I'd have to replace the entry function and somehow distinguish GET_DESCRIPTOR requests OR pass a malformed descriptor, but then the device stack would've errored out before. **/ /**************************************************/ /* Replace the entry function. */ hcd = UX_DEVICE_HCD_GET(hid -> ux_host_class_hid_device); tmp = (ALIGN_TYPE)hcd -> ux_hcd_entry_function; hcd -> ux_hcd_entry_function = ux_hcd_sim_host_entry_filter_descriptor_too_small_test; status = _ux_host_class_hid_descriptor_parse(hid); if(status != UX_DESCRIPTOR_CORRUPTED) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Restore state for next test. */ hcd -> ux_hcd_entry_function = (UINT (*) (struct UX_HCD_STRUCT *, UINT, VOID *))tmp; /**************************************************/ /** Test case: descriptor length larger than total configuration descriptor length. **/ /** Why direct: To fail normally, I'd have to replace the entry function and somehow distinguish GET_DESCRIPTOR requests OR pass a malformed descriptor, but then the device stack would've errored out before. **/ /**************************************************/ /* Replace the entry function. */ hcd = UX_DEVICE_HCD_GET(hid -> ux_host_class_hid_device); tmp = (ALIGN_TYPE)hcd -> ux_hcd_entry_function; hcd -> ux_hcd_entry_function = ux_hcd_sim_host_entry_filter_descriptor_too_large_test; status = _ux_host_class_hid_descriptor_parse(hid); if(status != UX_DESCRIPTOR_CORRUPTED) { printf("Error on line %d, error code: %d\n", __LINE__, status); test_control_return(1); } /* Restore state for next test. */ hcd -> ux_hcd_entry_function = (UINT (*) (struct UX_HCD_STRUCT *, UINT, VOID *))tmp; /* Now disconnect the device. */ _ux_device_stack_disconnect(); /* And deinitialize the class. */ status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_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); } static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event) { return(UX_SUCCESS); }