1 /* This test is designed to test the ux_device_stack_alternate_setting_get. */
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 + 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 /* HID 9+9 + 9+9+7=43 */
144 HID_MOUSE_IFC0_DESC_ALL(1)
145 HID_MOUSE_IFC1_DESC_ALL(1, 0x83)
146 };
147 #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED sizeof(device_framework_full_speed)
148
149 static UCHAR device_framework_high_speed[] = {
150
151 /* Device descriptor */
152 0x12, 0x01, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
153 0x0a, 0x07, 0x25, 0x40, 0x01, 0x00, 0x01, 0x02,
154 0x03, 0x01,
155
156 /* Device qualifier descriptor */
157 0x0a, 0x06, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
158 0x01, 0x00,
159
160 /* Configuration descriptor */
161 CFG_DESC(CFG_DESC_LEN + DPUMP_IFC_DESC_ALL_LEN + HID_MOUSE_IFC0_DESC_ALL_LEN + HID_MOUSE_IFC1_DESC_ALL_LEN, 2, 1)
162 /* DPUMP */
163 DPUMP_IFC_DESC_ALL(0, 0x81, 0x02)
164 /* HID */
165 HID_MOUSE_IFC0_DESC_ALL(1)
166 HID_MOUSE_IFC1_DESC_ALL(1, 0x83)
167 };
168 #define DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED sizeof(device_framework_high_speed)
169
170 /* String Device Framework :
171 Byte 0 and 1 : Word containing the language ID : 0x0904 for US
172 Byte 2 : Byte containing the index of the descriptor
173 Byte 3 : Byte containing the length of the descriptor string
174 */
175
176 static UCHAR string_framework[] = {
177
178 /* Manufacturer string descriptor : Index 1 */
179 0x09, 0x04, 0x01, 0x0c,
180 0x45, 0x78, 0x70, 0x72,0x65, 0x73, 0x20, 0x4c,
181 0x6f, 0x67, 0x69, 0x63,
182
183 /* Product string descriptor : Index 2 */
184 0x09, 0x04, 0x02, 0x0c,
185 0x44, 0x61, 0x74, 0x61, 0x50, 0x75, 0x6d, 0x70,
186 0x44, 0x65, 0x6d, 0x6f,
187
188 /* Serial Number string descriptor : Index 3 */
189 0x09, 0x04, 0x03, 0x04,
190 0x30, 0x30, 0x30, 0x31
191 };
192 #define STRING_FRAMEWORK_LENGTH sizeof(string_framework)
193
194 /* Multiple languages are supported on the device, to add
195 a language besides English, the unicode language code must
196 be appended to the language_id_framework array and the length
197 adjusted accordingly. */
198 static UCHAR language_id_framework[] = {
199
200 /* English. */
201 0x09, 0x04
202 };
203 #define LANGUAGE_ID_FRAMEWORK_LENGTH sizeof(language_id_framework)
204
205 /* Simulation actions. */
206
207 static UX_TEST_SIM_ENTRY_ACTION dcd_endpoint_create_fail[] = {
208 /* function, request to match,
209 port action, port status,
210 request action, request EP, request data, request actual length, request status,
211 status, additional callback,
212 no_return */
213 { UX_DCD_CREATE_ENDPOINT, NULL,
214 UX_FALSE, 0,
215 0 , 0, UX_NULL, 0, 0,
216 UX_ERROR , UX_NULL},
217 { 0 }
218 };
219
220
221 /* Define prototypes for external Host Controller's (HCDs), classes and clients. */
222
223 static VOID ux_test_instance_activate(VOID *dpump_instance);
224 static VOID ux_test_instance_deactivate(VOID *dpump_instance);
225
226 UINT _ux_host_class_dpump_entry(UX_HOST_CLASS_COMMAND *command);
227 UINT ux_hcd_sim_initialize(UX_HCD *hcd);
228 UINT _ux_host_class_dpump_write(UX_HOST_CLASS_DPUMP *dpump, UCHAR * data_pointer,
229 ULONG requested_length, ULONG *actual_length);
230 UINT _ux_host_class_dpump_read (UX_HOST_CLASS_DPUMP *dpump, UCHAR *data_pointer,
231 ULONG requested_length, ULONG *actual_length);
232
233 static TX_THREAD ux_test_thread_simulation_0;
234 static TX_THREAD ux_test_thread_simulation_1;
235 static void ux_test_thread_simulation_0_entry(ULONG);
236 static void ux_test_thread_simulation_1_entry(ULONG);
237
238
239 /* Define the ISR dispatch. */
240
241 extern VOID (*test_isr_dispatch)(void);
242
243
244 /* Prototype for test control return. */
245
246 void test_control_return(UINT status);
247
248
249 /* Define the ISR dispatch routine. */
250
test_isr(void)251 static void test_isr(void)
252 {
253
254 /* For further expansion of interrupt-level testing. */
255 }
256
257
error_callback(UINT system_level,UINT system_context,UINT error_code)258 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
259 {
260 if (!expect_errors)
261 {
262 if (error_code != UX_DEVICE_HANDLE_UNKNOWN)
263 {
264 /* Failed test. */
265 printf("Error on line %d, system_level: %d, system_context: %d, error code: %d\n", __LINE__, system_level, system_context, error_code);
266 test_control_return(1);
267 }
268 }
269 }
270
test_ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND * command)271 static UINT test_ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND *command)
272 {
273 return UX_SUCCESS;
274 // return _ux_device_class_hid_entry(command);
275 }
276
277 /* Define what the initial system looks like. */
278
279 #ifdef CTEST
test_application_define(void * first_unused_memory)280 void test_application_define(void *first_unused_memory)
281 #else
282 void usbx_ux_device_stack_alternate_setting_get_test_application_define(void *first_unused_memory)
283 #endif
284 {
285
286 UINT status;
287 CHAR *stack_pointer;
288 CHAR *memory_pointer;
289 UX_SLAVE_CLASS_DPUMP_PARAMETER parameter;
290 UX_SLAVE_CLASS_HID_PARAMETER hid_parameter;
291
292 /* Initialize the free memory pointer. */
293 stack_pointer = (CHAR *) first_unused_memory;
294 memory_pointer = stack_pointer + (UX_TEST_STACK_SIZE * 2);
295
296 /* Initialize USBX Memory. */
297 status = ux_system_initialize(memory_pointer, UX_TEST_MEMORY_SIZE, UX_NULL, 0);
298
299 /* Check for error. */
300 if (status != UX_SUCCESS)
301 {
302
303 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #1\n");
304 test_control_return(1);
305 }
306
307 /* Register the error callback. */
308 _ux_utility_error_callback_register(error_callback);
309
310 /* The code below is required for installing the host portion of USBX. */
311 status = ux_host_stack_initialize(UX_NULL);
312
313 /* Check for error. */
314 if (status != UX_SUCCESS)
315 {
316
317 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #2\n");
318 test_control_return(1);
319 }
320
321 /* Register all the host class drivers for this USBX implementation. */
322 status = ux_host_stack_class_register(_ux_system_host_class_dpump_name, ux_host_class_dpump_entry);
323
324 /* Check for error. */
325 if (status != UX_SUCCESS)
326 {
327
328 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #3\n");
329 test_control_return(1);
330 }
331
332 /* The code below is required for installing the device portion of USBX */
333 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
334 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
335 string_framework, STRING_FRAMEWORK_LENGTH,
336 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH, UX_NULL);
337
338 /* Check for error. */
339 if (status != UX_SUCCESS)
340 {
341
342 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #5\n");
343 test_control_return(1);
344 }
345
346 /* Set the parameters for callback when insertion/extraction of a Data Pump device. */
347 parameter.ux_slave_class_dpump_instance_activate = ux_test_instance_activate;
348 parameter.ux_slave_class_dpump_instance_deactivate = ux_test_instance_deactivate;
349
350 /* Initialize the device dpump class. The class is connected with interface 0 */
351 status = ux_device_stack_class_register(_ux_system_slave_class_dpump_name, _ux_device_class_dpump_entry,
352 1, 0, ¶meter);
353
354 /* Initialize the hid class parameters. */
355 hid_parameter.ux_device_class_hid_parameter_report_address = hid_mouse_report;
356 hid_parameter.ux_device_class_hid_parameter_report_length = HID_MOUSE_REPORT_LENGTH;
357 hid_parameter.ux_device_class_hid_parameter_callback = UX_NULL;
358 hid_parameter.ux_slave_class_hid_instance_activate = UX_NULL;
359
360 status |= ux_device_stack_class_register(_ux_system_slave_class_hid_name, test_ux_device_class_hid_entry,
361 1, 1, ¶meter);
362 #if UX_MAX_SLAVE_CLASS_DRIVER > 1
363 /* Check for error. */
364 if (status != UX_SUCCESS)
365 {
366
367 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #6\n");
368 test_control_return(1);
369 }
370 #endif
371 /* Initialize the simulated device controller. */
372 status = _ux_test_dcd_sim_slave_initialize();
373
374 /* Check for error. */
375 if (status != UX_SUCCESS)
376 {
377
378 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #7\n");
379 test_control_return(1);
380 }
381
382 /* Register all the USB host controllers available in this system */
383 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, _ux_test_hcd_sim_host_initialize,0,0);
384
385 /* Check for error. */
386 if (status != UX_SUCCESS)
387 {
388
389 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #4\n");
390 test_control_return(1);
391 }
392
393 /* Create the main host simulation thread. */
394 status = tx_thread_create(&ux_test_thread_simulation_0, "test host simulation", ux_test_thread_simulation_0_entry, 0,
395 stack_pointer, UX_TEST_STACK_SIZE,
396 20, 20, 1, TX_AUTO_START);
397
398 /* Check for error. */
399 if (status != TX_SUCCESS)
400 {
401
402 printf("Running ux_device_stack_alternate_setting_get Test.................. ERROR #8\n");
403 test_control_return(1);
404 }
405 }
406
407
ux_test_thread_simulation_0_entry(ULONG arg)408 static void ux_test_thread_simulation_0_entry(ULONG arg)
409 {
410
411 UINT status;
412 UX_SLAVE_DEVICE *device;
413 UX_SLAVE_INTERFACE *interface;
414
415 /* Inform user. */
416 printf("Running ux_device_stack_alternate_setting_get Test.................. ");
417
418 ux_test_dcd_sim_slave_connect(UX_HIGH_SPEED_DEVICE);
419 ux_test_hcd_sim_host_connect(UX_HIGH_SPEED_DEVICE);
420
421 /* Enumeration check. */
422 if (dpump_slave == UX_NULL)
423 {
424
425 printf("ERROR #%d: Enum fail\n", __LINE__);
426 test_control_return(1);
427 }
428
429 /* Slave device. */
430 device = &_ux_system_slave->ux_system_slave_device;
431
432 /* Expect errors so skip them in error handler. */
433 expect_errors = UX_TRUE;
434
435 interface = device -> ux_slave_device_first_interface;
436 device -> ux_slave_device_first_interface = UX_NULL;
437 status = _ux_device_stack_alternate_setting_get(0);
438 if (status == UX_SUCCESS)
439 {
440
441 printf("ERROR #%d: expect error in case no interface\n", __LINE__);
442 error_counter ++;
443 }
444 device -> ux_slave_device_first_interface = interface;
445
446 /* Break on errors. */
447 expect_errors = UX_TRUE;
448
449 /* Sleep for a tick to make sure everything is complete. */
450 tx_thread_sleep(1);
451
452 /* Check for errors from other threads. */
453 if (error_counter)
454 {
455
456 /* Test error. */
457 printf("ERROR #14\n");
458 test_control_return(1);
459 }
460 else
461 {
462
463 /* Successful test. */
464 printf("SUCCESS!\n");
465 test_control_return(0);
466 }
467 }
468
ux_test_instance_activate(VOID * dpump_instance)469 static VOID ux_test_instance_activate(VOID *dpump_instance)
470 {
471
472 /* Save the DPUMP instance. */
473 dpump_slave = (UX_SLAVE_CLASS_DPUMP *) dpump_instance;
474 }
475
ux_test_instance_deactivate(VOID * dpump_instance)476 static VOID ux_test_instance_deactivate(VOID *dpump_instance)
477 {
478
479 /* Reset the DPUMP instance. */
480 dpump_slave = UX_NULL;
481 }
482
483
