/* This test concentrates on _ux_host_class_hid_transfer_request_completed()'s raw process handling. */ #include "usbx_test_common_hid.h" #include "ux_host_class_hid_keyboard.h" #include "ux_host_class_hid_mouse.h" static UX_HOST_CLASS_HID_MOUSE *mouse; static UINT callback_error_code; static UINT num_callbacks; static UCHAR hid_mouse_report[] = { 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 0x09, 0x02, // USAGE (Mouse) 0xa1, 0x01, // COLLECTION (Application) 0x09, 0x01, // USAGE (Pointer) 0xa1, 0x00, // COLLECTION (Physical) 0x05, 0x09, // USAGE_PAGE (Button) 0x19, 0x01, // USAGE_MINIMUM (Button 1) 0x29, 0x03, // USAGE_MAXIMUM (Button 3) 0x15, 0x00, // LOGICAL_MINIMUM (0) 0x25, 0x01, // LOGICAL_MAXIMUM (1) 0x95, 0x03, // REPORT_COUNT (3) 0x75, 0x01, // REPORT_SIZE (1) 0x81, 0x02, // INPUT (Data,Var,Abs) 0x95, 0x01, // REPORT_COUNT (1) 0x75, 0x05, // REPORT_SIZE (5) 0x81, 0x03, // INPUT (Cnst,Var,Abs) 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 0x09, 0x30, // USAGE (X) 0x09, 0x31, // USAGE (Y) 0x15, 0x81, // LOGICAL_MINIMUM (-127) 0x25, 0x7f, // LOGICAL_MAXIMUM (127) 0x75, 0x08, // REPORT_SIZE (8) 0x95, 0x02, // REPORT_COUNT (2) 0x81, 0x06, // INPUT (Data,Var,Rel) 0x09, 0x38, // USAGE (Mouse Wheel) 0x15, 0x81, // LOGICAL_MINIMUM (-127) 0x25, 0x7f, // LOGICAL_MAXIMUM (127) 0x75, 0x08, // REPORT_SIZE (8) 0x95, 0x01, // REPORT_COUNT (1) 0x81, 0x06, // INPUT (Data,Var,Rel) 0xc0, // END_COLLECTION 0xc0 // END_COLLECTION }; #define HID_MOUSE_REPORT_LENGTH (sizeof(hid_mouse_report)/sizeof(hid_mouse_report[0])) #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED 52 static UCHAR device_framework_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_MOUSE_REPORT_LENGTH), MSB(HID_MOUSE_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 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_MOUSE_REPORT_LENGTH), MSB(HID_MOUSE_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 }; static VOID error_callback(UINT system_level, UINT system_context, UINT error_code) { if (error_code != UX_BUFFER_OVERFLOW) { printf("Error on line %d\n", __LINE__); test_control_return(1); } callback_error_code = error_code; } /* Define what the initial system looks like. */ #ifdef CTEST void test_application_define(void *first_unused_memory) #else void usbx_hid_transfer_request_completed_raw_test_application_define(void *first_unused_memory) #endif { UINT status; CHAR * stack_pointer; CHAR * memory_pointer; /* Inform user. */ printf("Running HID Transfer Request Completed Raw 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\n", __LINE__); 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_NULL); if (status != UX_SUCCESS) { printf("Error on line %d\n", __LINE__); 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\n", __LINE__); test_control_return(1); } /* Register the HID client(s). */ status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_mouse_name, ux_host_class_hid_mouse_entry); if (status != UX_SUCCESS) { printf("Error on line %d\n", __LINE__); 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\n", __LINE__); test_control_return(1); } /* Initialize the hid class parameters for a mouse. */ hid_parameter.ux_device_class_hid_parameter_report_address = hid_mouse_report; hid_parameter.ux_device_class_hid_parameter_report_length = HID_MOUSE_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\n", __LINE__); 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\n", __LINE__); 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\n", __LINE__); 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\n", __LINE__); test_control_return(1); } /* Create the main demo thread. */ status = tx_thread_create(&tx_demo_thread_slave_simulation, "tx demo slave simulation", tx_demo_thread_slave_simulation_entry, 0, stack_pointer + UX_DEMO_STACK_SIZE, UX_DEMO_STACK_SIZE, 20, 20, 1, TX_AUTO_START); /* Check for error. */ if (status != TX_SUCCESS) { printf("Error on line %d\n", __LINE__); test_control_return(1); } } #define MAX_NUM_CALLBACKS 16 VOID dummy_transfer_request_callback_successful(UX_HOST_CLASS_HID_REPORT_CALLBACK *callback) { static INT expected_value = -1; ULONG actual_value; actual_value = *((ULONG *)callback->ux_host_class_hid_report_callback_buffer); /* If uninitialized, initialize expected_value. */ if (expected_value == -1) expected_value = actual_value; if (actual_value != expected_value) { printf("Error on line %d\n", __LINE__); test_control_return(1); } expected_value++; num_callbacks++; } VOID dummy_transfer_request_callback_failure(UX_HOST_CLASS_HID_REPORT_CALLBACK *callback) { } static void tx_demo_thread_host_simulation_entry(ULONG arg) { UINT status; UX_HOST_CLASS_HID_REPORT_CALLBACK callback; UCHAR buffer[1024]; /* Find the HID class */ status = demo_class_hid_get(); if (status != UX_SUCCESS) { printf("Error on line %d\n", __LINE__); test_control_return(1); } /**************************************************/ /** Test case: successful raw report callback. **/ /**************************************************/ /* Get the HID client */ hid_client = hid -> ux_host_class_hid_client; /* Check if the instance of the keyboard is live */ while (hid_client -> ux_host_class_hid_client_local_instance == UX_NULL) tx_thread_sleep(10); /* Get the mouse instance */ mouse = (UX_HOST_CLASS_HID_MOUSE *)hid_client -> ux_host_class_hid_client_local_instance; /* Initialize the report callback. */ callback.ux_host_class_hid_report_callback_id = 0; callback.ux_host_class_hid_report_callback_function = dummy_transfer_request_callback_successful; callback.ux_host_class_hid_report_callback_buffer = buffer; callback.ux_host_class_hid_report_callback_flags = UX_HOST_CLASS_HID_REPORT_RAW; callback.ux_host_class_hid_report_callback_length = sizeof(buffer); ux_host_class_hid_report_callback_register(hid, &callback); /* Wait until callback has been invoked at least MAX_NUM_CALLBACKS times. */ while(num_callbacks < MAX_NUM_CALLBACKS) tx_thread_sleep(10); #if 0 /* User buffer is not assigned on initialize, see USBX-283 */ /**************************************************/ /** Test case: callback buffer too small. **/ /**************************************************/ /* Change the length to a small value. */ callback.ux_host_class_hid_report_callback_function = dummy_transfer_request_callback_failure; callback.ux_host_class_hid_report_callback_length = 1; ux_host_class_hid_report_callback_register(hid, &callback); /* Wait until we receive the expected error. */ while(callback_error_code != UX_BUFFER_OVERFLOW) tx_thread_sleep(10); #endif /* 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); } static void tx_demo_thread_slave_simulation_entry(ULONG arg) { UX_SLAVE_DEVICE *device; UX_SLAVE_INTERFACE *interface; UX_SLAVE_CLASS_HID *hid; UX_SLAVE_CLASS_HID_EVENT hid_event; UINT i; /* Get the pointer to the device. */ device = &_ux_system_slave -> ux_system_slave_device; /* reset the HID event structure. */ ux_utility_memory_set(&hid_event, 0, sizeof(UX_SLAVE_CLASS_HID_EVENT)); /* Set length of event. */ hid_event.ux_device_class_hid_event_length = 4; *((ULONG *)hid_event.ux_device_class_hid_event_buffer) = 0; while (1) { /* Is the device configured ? */ while (device -> ux_slave_device_state != UX_DEVICE_CONFIGURED) /* Then wait. */ tx_thread_sleep(10); /* Get the interface. We use the first interface, this is a simple device. */ interface = device->ux_slave_device_first_interface; /* From that interface, derive the HID owner. */ hid = interface->ux_slave_interface_class_instance; for (i = 0; i < MAX_NUM_CALLBACKS; i++) { /* Sleep for 1 second. */ ux_utility_thread_sleep(10); /* Set the mouse event. */ ux_device_class_hid_event_set(hid, &hid_event); /* Increment. */ *((ULONG *)hid_event.ux_device_class_hid_event_buffer) += 1; } } }