1 /* This test is designed to test the ux_device_stack_endpoint_stall. */
2
3 #include <stdio.h>
4 #include "tx_api.h"
5 #include "ux_api.h"
6 #include "ux_system.h"
7 #include "ux_utility.h"
8
9 #include "ux_host_stack.h"
10 #include "ux_device_stack.h"
11
12 #include "ux_device_class_cdc_acm.h"
13 #include "ux_host_class_cdc_acm.h"
14
15 #include "ux_host_class_dpump.h"
16 #include "ux_device_class_dpump.h"
17
18 #include "ux_host_class_hid.h"
19 #include "ux_device_class_hid.h"
20
21 #include "ux_host_class_storage.h"
22 #include "ux_device_class_storage.h"
23
24 #include "ux_test_dcd_sim_slave.h"
25 #include "ux_test_hcd_sim_host.h"
26 #include "ux_test_utility_sim.h"
27
28
29 /* Define USBX test constants. */
30
31 #define UX_TEST_STACK_SIZE 4096
32 #define UX_TEST_BUFFER_SIZE 2048
33 #define UX_TEST_RUN 1
34 #define UX_TEST_MEMORY_SIZE (64*1024)
35
36 /* HID mouse related descriptors */
37
38 static UCHAR hid_mouse_report[] = {
39
40 0x05, 0x01, // USAGE_PAGE (Generic Desktop)
41 0x09, 0x02, // USAGE (Mouse)
42 0xa1, 0x01, // COLLECTION (Application)
43 0x09, 0x01, // USAGE (Pointer)
44 0xa1, 0x00, // COLLECTION (Physical)
45 0x05, 0x09, // USAGE_PAGE (Button)
46 0x19, 0x01, // USAGE_MINIMUM (Button 1)
47 0x29, 0x03, // USAGE_MAXIMUM (Button 3)
48 0x15, 0x00, // LOGICAL_MINIMUM (0)
49 0x25, 0x01, // LOGICAL_MAXIMUM (1)
50 0x95, 0x03, // REPORT_COUNT (3)
51 0x75, 0x01, // REPORT_SIZE (1)
52 0x81, 0x02, // INPUT (Data,Var,Abs)
53 0x95, 0x01, // REPORT_COUNT (1)
54 0x75, 0x05, // REPORT_SIZE (5)
55 0x81, 0x03, // INPUT (Cnst,Var,Abs)
56 0x05, 0x01, // USAGE_PAGE (Generic Desktop)
57 0x09, 0x30, // USAGE (X)
58 0x09, 0x31, // USAGE (Y)
59 0x15, 0x81, // LOGICAL_MINIMUM (-127)
60 0x25, 0x7f, // LOGICAL_MAXIMUM (127)
61 0x75, 0x08, // REPORT_SIZE (8)
62 0x95, 0x02, // REPORT_COUNT (2)
63 0x81, 0x06, // INPUT (Data,Var,Rel)
64 0x09, 0x38, // USAGE (Mouse Wheel)
65 0x15, 0x81, // LOGICAL_MINIMUM (-127)
66 0x25, 0x7f, // LOGICAL_MAXIMUM (127)
67 0x75, 0x08, // REPORT_SIZE (8)
68 0x95, 0x01, // REPORT_COUNT (1)
69 0x81, 0x06, // INPUT (Data,Var,Rel)
70 0xc0, // END_COLLECTION
71 0xc0 // END_COLLECTION
72 };
73 #define HID_MOUSE_REPORT_LENGTH (sizeof(hid_mouse_report)/sizeof(hid_mouse_report[0]))
74
75 #define LSB(x) (x & 0x00ff)
76 #define MSB(x) ((x & 0xff00) >> 8)
77
78 /* Configuration descriptor 9 bytes */
79 #define CFG_DESC(wTotalLength, bNumInterfaces, bConfigurationValue)\
80 /* Configuration 1 descriptor 9 bytes */\
81 0x09, 0x02, LSB(wTotalLength), MSB(wTotalLength),\
82 (bNumInterfaces), (bConfigurationValue), 0x00,\
83 0x40, 0x00,
84 #define CFG_DESC_LEN 9
85
86 /* DPUMP interface descriptors 9+7+7=23 bytes. */
87 #define DPUMP_IFC_DESC_ALL(ifc, bulk_in_epa, bulk_out_epa) \
88 /* Interface descriptor */\
89 0x09, 0x04, (ifc), 0x00, 0x02, 0x99, 0x99, 0x99, 0x00,\
90 /* Endpoint descriptor (Bulk Out) */\
91 0x07, 0x05, (bulk_out_epa), 0x02, 0x40, 0x00, 0x00,\
92 /* Endpoint descriptor (Bulk In) */\
93 0x07, 0x05, (bulk_in_epa), 0x02, 0x40, 0x00, 0x00,
94 #define DPUMP_IFC_DESC_ALL_LEN 23
95
96 /* HID Mouse interface descriptors 9+9=18 bytes */
97 #define HID_MOUSE_IFC0_DESC_ALL(ifc) \
98 /* Interface descriptor */\
99 0x09, 0x04, (ifc), 0x00, 0x00, 0x03, 0x00, 0x00, 0x00,\
100 /* HID descriptor */\
101 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_MOUSE_REPORT_LENGTH),\
102 MSB(HID_MOUSE_REPORT_LENGTH),
103 #define HID_MOUSE_IFC0_DESC_ALL_LEN 18
104
105 /* HID Mouse interface descriptors 9+9+7=25 bytes */
106 #define HID_MOUSE_IFC1_DESC_ALL(ifc, interrupt_epa) \
107 /* Interface descriptor */\
108 0x09, 0x04, (ifc), 0x01, 0x01, 0x03, 0x00, 0x00, 0x00,\
109 /* HID descriptor */\
110 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_MOUSE_REPORT_LENGTH),\
111 MSB(HID_MOUSE_REPORT_LENGTH),\
112 /* Endpoint descriptor (Interrupt) */\
113 0x07, 0x05, (interrupt_epa), 0x03, 0x08, 0x00, 0x08,
114 #define HID_MOUSE_IFC1_DESC_ALL_LEN 25
115
116 /* Define the counters used in the test application... */
117
118 static ULONG thread_0_counter;
119 static ULONG thread_1_counter;
120 static ULONG error_counter;
121
122 static UCHAR expect_errors = UX_FALSE;
123
124
125 /* Define USBX test global variables. */
126
127 static UX_HOST_CLASS *class_driver;
128 static UX_HOST_CLASS_DPUMP *dpump;
129 static UX_SLAVE_CLASS_DPUMP *dpump_slave = UX_NULL;
130
131
132 static UCHAR device_framework_full_speed[] = {
133
134 /* Device descriptor 18 bytes */
135 0x12, 0x01, 0x10, 0x01, 0x00, 0x00, 0x00, 0x08,
136 0xec, 0x08, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00,
137 0x00, 0x01,
138
139 /* Configuration descriptor 9 bytes */
140 CFG_DESC(CFG_DESC_LEN + 2*DPUMP_IFC_DESC_ALL_LEN + HID_MOUSE_IFC0_DESC_ALL_LEN + HID_MOUSE_IFC1_DESC_ALL_LEN, 2, 1)
141 /* DPUMP 9+9+7 =25 */
142 DPUMP_IFC_DESC_ALL(0, 0x81, 0x02)
143 DPUMP_IFC_DESC_ALL(1, 0x83, 0x04)
144 /* HID 9+9 + 9+9+7=43 */
145 HID_MOUSE_IFC0_DESC_ALL(2)
146 HID_MOUSE_IFC1_DESC_ALL(2, 0x85)
147 };
148 #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED sizeof(device_framework_full_speed)
149
150 static UCHAR device_framework_high_speed[] = {
151
152 /* Device descriptor */
153 0x12, 0x01, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
154 0x0a, 0x07, 0x25, 0x40, 0x01, 0x00, 0x01, 0x02,
155 0x03, 0x01,
156
157 /* Device qualifier descriptor */
158 0x0a, 0x06, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
159 0x01, 0x00,
160
161 /* Configuration descriptor */
162 CFG_DESC(CFG_DESC_LEN + 2*DPUMP_IFC_DESC_ALL_LEN + HID_MOUSE_IFC0_DESC_ALL_LEN + HID_MOUSE_IFC1_DESC_ALL_LEN, 2, 1)
163 /* DPUMP 9+9+7 =25 */
164 DPUMP_IFC_DESC_ALL(0, 0x81, 0x02)
165 DPUMP_IFC_DESC_ALL(1, 0x83, 0x04)
166 /* HID 9+9 + 9+9+7=43 */
167 HID_MOUSE_IFC0_DESC_ALL(2)
168 HID_MOUSE_IFC1_DESC_ALL(2, 0x85)
169 };
170 #define DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED sizeof(device_framework_high_speed)
171
172 /* String Device Framework :
173 Byte 0 and 1 : Word containing the language ID : 0x0904 for US
174 Byte 2 : Byte containing the index of the descriptor
175 Byte 3 : Byte containing the length of the descriptor string
176 */
177
178 static UCHAR string_framework[] = {
179
180 /* Manufacturer string descriptor : Index 1 */
181 0x09, 0x04, 0x01, 0x0c,
182 0x45, 0x78, 0x70, 0x72,0x65, 0x73, 0x20, 0x4c,
183 0x6f, 0x67, 0x69, 0x63,
184
185 /* Product string descriptor : Index 2 */
186 0x09, 0x04, 0x02, 0x0c,
187 0x44, 0x61, 0x74, 0x61, 0x50, 0x75, 0x6d, 0x70,
188 0x44, 0x65, 0x6d, 0x6f,
189
190 /* Serial Number string descriptor : Index 3 */
191 0x09, 0x04, 0x03, 0x04,
192 0x30, 0x30, 0x30, 0x31
193 };
194 #define STRING_FRAMEWORK_LENGTH sizeof(string_framework)
195
196 /* Multiple languages are supported on the device, to add
197 a language besides English, the unicode language code must
198 be appended to the language_id_framework array and the length
199 adjusted accordingly. */
200 static UCHAR language_id_framework[] = {
201
202 /* English. */
203 0x09, 0x04
204 };
205 #define LANGUAGE_ID_FRAMEWORK_LENGTH sizeof(language_id_framework)
206
207
208 /* Define prototypes for external Host Controller's (HCDs), classes and clients. */
209
210 static VOID ux_test_instance_activate(VOID *dpump_instance);
211 static VOID ux_test_instance_deactivate(VOID *dpump_instance);
212
213 UINT _ux_host_class_dpump_entry(UX_HOST_CLASS_COMMAND *command);
214 UINT ux_hcd_sim_initialize(UX_HCD *hcd);
215 UINT _ux_host_class_dpump_write(UX_HOST_CLASS_DPUMP *dpump, UCHAR * data_pointer,
216 ULONG requested_length, ULONG *actual_length);
217 UINT _ux_host_class_dpump_read (UX_HOST_CLASS_DPUMP *dpump, UCHAR *data_pointer,
218 ULONG requested_length, ULONG *actual_length);
219
220 static TX_THREAD ux_test_thread_simulation_0;
221 static TX_THREAD ux_test_thread_simulation_1;
222 static void ux_test_thread_simulation_0_entry(ULONG);
223 static void ux_test_thread_simulation_1_entry(ULONG);
224
225
226 /* Define the ISR dispatch. */
227
228 extern VOID (*test_isr_dispatch)(void);
229
230
231 /* Prototype for test control return. */
232
233 void test_control_return(UINT status);
234
235
236 /* Define the ISR dispatch routine. */
237
test_isr(void)238 static void test_isr(void)
239 {
240
241 /* For further expansion of interrupt-level testing. */
242 }
243
244
error_callback(UINT system_level,UINT system_context,UINT error_code)245 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
246 {
247 if (!expect_errors)
248 {
249 if (error_code != UX_DEVICE_HANDLE_UNKNOWN)
250 {
251 /* Failed test. */
252 printf("Error on line %d, system_level: %d, system_context: %d, error code: %d\n", __LINE__, system_level, system_context, error_code);
253 test_control_return(1);
254 }
255 }
256 }
257
test_ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND * command)258 static UINT test_ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND *command)
259 {
260 return UX_SUCCESS;
261 // return _ux_device_class_hid_entry(command);
262 }
263
264 /* Define what the initial system looks like. */
265
266 #ifdef CTEST
test_application_define(void * first_unused_memory)267 void test_application_define(void *first_unused_memory)
268 #else
269 void usbx_ux_device_stack_endpoint_stall_test_application_define(void *first_unused_memory)
270 #endif
271 {
272
273 UINT status;
274 CHAR *stack_pointer;
275 CHAR *memory_pointer;
276 UX_SLAVE_CLASS_DPUMP_PARAMETER parameter;
277 UX_SLAVE_CLASS_HID_PARAMETER hid_parameter;
278
279
280 /* Inform user. */
281 printf("Running ux_device_stack_endpoint_stall Test......................... ");
282
283 /* Initialize the free memory pointer. */
284 stack_pointer = (CHAR *) first_unused_memory;
285 memory_pointer = stack_pointer + (UX_TEST_STACK_SIZE * 2);
286
287 /* Initialize USBX Memory. */
288 status = ux_system_initialize(memory_pointer, UX_TEST_MEMORY_SIZE, UX_NULL, 0);
289
290 /* Check for error. */
291 if (status != UX_SUCCESS)
292 {
293
294 printf("ERROR #1\n");
295 test_control_return(1);
296 }
297
298 /* Register the error callback. */
299 _ux_utility_error_callback_register(error_callback);
300
301 /* The code below is required for installing the host portion of USBX. */
302 status = ux_host_stack_initialize(UX_NULL);
303
304 /* Check for error. */
305 if (status != UX_SUCCESS)
306 {
307
308 printf("ERROR #2\n");
309 test_control_return(1);
310 }
311
312 /* Register all the host class drivers for this USBX implementation. */
313 status = ux_host_stack_class_register(_ux_system_host_class_dpump_name, ux_host_class_dpump_entry);
314
315 /* Check for error. */
316 if (status != UX_SUCCESS)
317 {
318
319 printf("ERROR #3\n");
320 test_control_return(1);
321 }
322
323 /* The code below is required for installing the device portion of USBX */
324 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
325 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
326 string_framework, STRING_FRAMEWORK_LENGTH,
327 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH, UX_NULL);
328
329 /* Check for error. */
330 if (status != UX_SUCCESS)
331 {
332
333 printf("ERROR #5\n");
334 test_control_return(1);
335 }
336
337 /* Set the parameters for callback when insertion/extraction of a Data Pump device. */
338 parameter.ux_slave_class_dpump_instance_activate = ux_test_instance_activate;
339 parameter.ux_slave_class_dpump_instance_deactivate = ux_test_instance_deactivate;
340
341 /* Initialize the device dpump class. The class is connected with interface 0 */
342 status = ux_device_stack_class_register(_ux_system_slave_class_dpump_name, _ux_device_class_dpump_entry,
343 1, 0, ¶meter);
344 status |= ux_device_stack_class_register(_ux_system_slave_class_dpump_name, _ux_device_class_dpump_entry,
345 1, 1, ¶meter);
346
347 /* Initialize the hid class parameters. */
348 hid_parameter.ux_device_class_hid_parameter_report_address = hid_mouse_report;
349 hid_parameter.ux_device_class_hid_parameter_report_length = HID_MOUSE_REPORT_LENGTH;
350 hid_parameter.ux_device_class_hid_parameter_callback = UX_NULL;
351 hid_parameter.ux_slave_class_hid_instance_activate = UX_NULL;
352
353 status |= ux_device_stack_class_register(_ux_system_slave_class_hid_name, test_ux_device_class_hid_entry,
354 1, 2, ¶meter);
355 #if UX_MAX_SLAVE_CLASS_DRIVER > 1
356 /* Check for error. */
357 if (status != UX_SUCCESS)
358 {
359
360 printf("ERROR #6\n");
361 test_control_return(1);
362 }
363 #endif
364 /* Initialize the simulated device controller. */
365 status = _ux_test_dcd_sim_slave_initialize();
366
367 /* Check for error. */
368 if (status != UX_SUCCESS)
369 {
370
371 printf("ERROR #7\n");
372 test_control_return(1);
373 }
374
375 /* Register all the USB host controllers available in this system */
376 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, _ux_test_hcd_sim_host_initialize,0,0);
377
378 /* Check for error. */
379 if (status != UX_SUCCESS)
380 {
381
382 printf("ERROR #4\n");
383 test_control_return(1);
384 }
385
386 /* Create the main host simulation thread. */
387 status = tx_thread_create(&ux_test_thread_simulation_0, "test host simulation", ux_test_thread_simulation_0_entry, 0,
388 stack_pointer, UX_TEST_STACK_SIZE,
389 20, 20, 1, TX_AUTO_START);
390
391 /* Check for error. */
392 if (status != TX_SUCCESS)
393 {
394
395 printf("ERROR #8\n");
396 test_control_return(1);
397 }
398 }
399
400
ux_test_thread_simulation_0_entry(ULONG arg)401 static void ux_test_thread_simulation_0_entry(ULONG arg)
402 {
403
404 UINT status;
405 UX_SLAVE_DEVICE *device;
406 UX_SLAVE_INTERFACE *interface;
407 UX_SLAVE_ENDPOINT *endpoint;
408
409
410 ux_test_dcd_sim_slave_connect(UX_HIGH_SPEED_DEVICE);
411 ux_test_hcd_sim_host_connect(UX_HIGH_SPEED_DEVICE);
412
413 /* Enumeration check. */
414 if (dpump_slave == UX_NULL)
415 {
416 printf("ERROR #%d: Enum fail\n", __LINE__);
417 test_control_return(1);
418 }
419
420 /* Slave device. */
421 device = &_ux_system_slave->ux_system_slave_device;
422
423 /* Confirm first interfaces are connected. */
424 interface = device->ux_slave_device_first_interface;
425
426 /* Get endpoint. */
427 endpoint = interface->ux_slave_interface_first_endpoint;
428
429 if (endpoint == UX_NULL)
430 {
431 printf("ERROR #%d: endpoint not available\n", __LINE__);
432 test_control_return(1);
433 }
434
435 ux_test_hcd_sim_host_disconnect();
436 ux_test_dcd_sim_slave_disconnect();
437
438 status = ux_device_stack_endpoint_stall(endpoint);
439 if (status != UX_ERROR)
440 {
441 printf("ERROR #%d: code 0x%x\n", __LINE__, status);
442 error_counter ++;
443 }
444
445 /* Sleep for a tick to make sure everything is complete. */
446 tx_thread_sleep(1);
447
448 /* Check for errors from other threads. */
449 if (error_counter)
450 {
451
452 /* Test error. */
453 printf("ERROR #14\n");
454 test_control_return(1);
455 }
456 else
457 {
458
459 /* Successful test. */
460 printf("SUCCESS!\n");
461 test_control_return(0);
462 }
463 }
464
ux_test_instance_activate(VOID * dpump_instance)465 static VOID ux_test_instance_activate(VOID *dpump_instance)
466 {
467
468 /* Save the DPUMP instance. */
469 dpump_slave = (UX_SLAVE_CLASS_DPUMP *) dpump_instance;
470 }
471
ux_test_instance_deactivate(VOID * dpump_instance)472 static VOID ux_test_instance_deactivate(VOID *dpump_instance)
473 {
474
475 /* Reset the DPUMP instance. */
476 dpump_slave = UX_NULL;
477 }
478
479
