1 /* This file tests ux_host_class_hid_activate(). */
2
3 #include "usbx_test_common_hid.h"
4 #include "ux_host_class_hid_keyboard.h"
5
6
7 #define DUMMY_USBX_MEMORY_SIZE (64*1024)
8 static UCHAR dummy_usbx_memory[DUMMY_USBX_MEMORY_SIZE];
9
10 static UCHAR hid_report_descriptor[] = {
11
12 0x05, 0x01, // USAGE_PAGE (Generic Desktop)
13 0x09, 0x06, // USAGE (Keyboard)
14 0xa1, 0x01, // COLLECTION (Application)
15 0x05, 0x07, // USAGE_PAGE (Keyboard)
16 0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
17 0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
18 0x15, 0x00, // LOGICAL_MINIMUM (0)
19 0x25, 0x01, // LOGICAL_MAXIMUM (1)
20 0x75, 0x01, // REPORT_SIZE (1)
21 0x95, 0x08, // REPORT_COUNT (8)
22 0x81, 0x02, // INPUT (Data,Var,Abs)
23 0x95, 0x01, // REPORT_COUNT (1)
24 0x75, 0x08, // REPORT_SIZE (8)
25 0x81, 0x03, // INPUT (Cnst,Var,Abs)
26 0x95, 0x05, // REPORT_COUNT (5)
27 0x75, 0x01, // REPORT_SIZE (1)
28 0x05, 0x08, // USAGE_PAGE (LEDs)
29 0x19, 0x01, // USAGE_MINIMUM (Num Lock)
30 0x29, 0x05, // USAGE_MAXIMUM (Kana)
31 0x91, 0x02, // OUTPUT (Data,Var,Abs)
32 0x95, 0x01, // REPORT_COUNT (1)
33 0x75, 0x03, // REPORT_SIZE (3)
34 0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
35 0x95, 0x06, // REPORT_COUNT (6)
36 0x75, 0x08, // REPORT_SIZE (8)
37 0x15, 0x00, // LOGICAL_MINIMUM (0)
38 0x25, 0x65, // LOGICAL_MAXIMUM (101)
39 0x05, 0x07, // USAGE_PAGE (Keyboard)
40 0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
41 0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
42 0x81, 0x00, // INPUT (Data,Ary,Abs)
43 0xc0 // END_COLLECTION
44 };
45 #define HID_REPORT_LENGTH sizeof(hid_report_descriptor)/sizeof(hid_report_descriptor[0])
46
47
48 #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED 52
49 static UCHAR device_framework_full_speed[DEVICE_FRAMEWORK_LENGTH_FULL_SPEED] = {
50
51 /* Device descriptor */
52 0x12, 0x01, 0x10, 0x01, 0x00, 0x00, 0x00, 0x08,
53 0x81, 0x0A, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00,
54 0x00, 0x01,
55
56 /* Configuration descriptor */
57 0x09, 0x02, 0x22, 0x00, 0x01, 0x01, 0x00, 0xc0,
58 0x32,
59
60 /* Interface descriptor */
61 0x09, 0x04, 0x02, 0x00, 0x01, 0x03, 0x00, 0x00,
62 0x00,
63
64 /* HID descriptor */
65 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_REPORT_LENGTH),
66 MSB(HID_REPORT_LENGTH),
67
68 /* Endpoint descriptor (Interrupt) */
69 0x07, 0x05, 0x82, 0x03, 0x08, 0x00, 0x08
70
71 };
72
73
74 #define DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED 62
75 static UCHAR device_framework_high_speed[DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED] = {
76
77 /* Device descriptor */
78 0x12, 0x01, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
79 0x0a, 0x07, 0x25, 0x40, 0x01, 0x00, 0x01, 0x02,
80 0x03, 0x01,
81
82 /* Device qualifier descriptor */
83 0x0a, 0x06, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
84 0x01, 0x00,
85
86 /* Configuration descriptor */
87 0x09, 0x02, 0x22, 0x00, 0x01, 0x01, 0x00, 0xc0,
88 0x32,
89
90 /* Interface descriptor */
91 0x09, 0x04, 0x02, 0x00, 0x01, 0x03, 0x00, 0x00,
92 0x00,
93
94 /* HID descriptor */
95 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_REPORT_LENGTH),
96 MSB(HID_REPORT_LENGTH),
97
98 /* Endpoint descriptor (Interrupt) */
99 0x07, 0x05, 0x82, 0x03, 0x08, 0x00, 0x08
100
101 };
102
103
104 /* String Device Framework :
105 Byte 0 and 1 : Word containing the language ID : 0x0904 for US
106 Byte 2 : Byte containing the index of the descriptor
107 Byte 3 : Byte containing the length of the descriptor string
108 */
109
110 #define STRING_FRAMEWORK_LENGTH 40
111 static UCHAR string_framework[] = {
112
113 /* Manufacturer string descriptor : Index 1 */
114 0x09, 0x04, 0x01, 0x0c,
115 0x45, 0x78, 0x70, 0x72,0x65, 0x73, 0x20, 0x4c,
116 0x6f, 0x67, 0x69, 0x63,
117
118 /* Product string descriptor : Index 2 */
119 0x09, 0x04, 0x02, 0x0c,
120 0x55, 0x53, 0x42, 0x20, 0x4b, 0x65, 0x79, 0x62,
121 0x6f, 0x61, 0x72, 0x64,
122
123 /* Serial Number string descriptor : Index 3 */
124 0x09, 0x04, 0x03, 0x04,
125 0x30, 0x30, 0x30, 0x31
126 };
127
128
129 /* Multiple languages are supported on the device, to add
130 a language besides english, the unicode language code must
131 be appended to the language_id_framework array and the length
132 adjusted accordingly. */
133 #define LANGUAGE_ID_FRAMEWORK_LENGTH 2
134 static UCHAR language_id_framework[] = {
135
136 /* English. */
137 0x09, 0x04
138 };
139
140
141 UINT _ux_hcd_sim_host_entry(UX_HCD *hcd, UINT function, VOID *parameter);
142
143
ux_system_host_change_function(ULONG a,UX_HOST_CLASS * b,VOID * c)144 static UINT ux_system_host_change_function(ULONG a, UX_HOST_CLASS *b, VOID *c)
145 {
146 return 0;
147 }
148
error_callback(UINT system_level,UINT system_context,UINT error_code)149 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
150 {
151 }
152
153 /* Define what the initial system looks like. */
154
155 #ifdef CTEST
test_application_define(void * first_unused_memory)156 void test_application_define(void *first_unused_memory)
157 #else
158 void usbx_ux_host_class_hid_activate_test_application_define(void *first_unused_memory)
159 #endif
160 {
161
162 UINT status;
163 CHAR * stack_pointer;
164 CHAR * memory_pointer;
165
166
167 /* Inform user. */
168 printf("Running ux_host_class_hid_activate Test............................. ");
169
170 /* Initialize the free memory pointer */
171 stack_pointer = (CHAR *) usbx_memory;
172 memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2);
173
174 /* Initialize USBX. Memory */
175 status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0);
176
177 /* Check for error. */
178 if (status != UX_SUCCESS)
179 {
180
181 printf("Error on line %d, error code: %d\n", __LINE__, status);
182 test_control_return(1);
183 }
184
185 /* Register the error callback. */
186 _ux_utility_error_callback_register(error_callback);
187
188 /* The code below is required for installing the host portion of USBX */
189 status = ux_host_stack_initialize(ux_system_host_change_function);
190 if (status != UX_SUCCESS)
191 {
192
193 printf("Error on line %d, error code: %d\n", __LINE__, status);
194 test_control_return(1);
195 }
196
197 status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry);
198 if (status != UX_SUCCESS)
199 {
200
201 printf("Error on line %d, error code: %d\n", __LINE__, status);
202 test_control_return(1);
203 }
204
205 /* Register the HID client(s). */
206 status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry);
207 if (status != UX_SUCCESS)
208 {
209
210 printf("Error on line %d, error code: %d\n", __LINE__, status);
211 test_control_return(1);
212 }
213
214 /* The code below is required for installing the device portion of USBX. No call back for
215 device status change in this example. */
216 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
217 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
218 string_framework, STRING_FRAMEWORK_LENGTH,
219 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH,UX_NULL);
220 if(status!=UX_SUCCESS)
221 {
222
223 printf("Error on line %d, error code: %d\n", __LINE__, status);
224 test_control_return(1);
225 }
226
227 /* Initialize the hid class parameters. */
228 hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor;
229 hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH;
230 hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback;
231
232 /* Initilize the device hid class. The class is connected with interface 2 */
233 status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry,
234 1,2, (VOID *)&hid_parameter);
235 if(status!=UX_SUCCESS)
236 {
237
238 printf("Error on line %d, error code: %d\n", __LINE__, status);
239 test_control_return(1);
240 }
241
242 /* Initialize the simulated device controller. */
243 status = _ux_dcd_sim_slave_initialize();
244
245 /* Check for error. */
246 if (status != UX_SUCCESS)
247 {
248
249 printf("Error on line %d, error code: %d\n", __LINE__, status);
250 test_control_return(1);
251 }
252
253 /* Register all the USB host controllers available in this system */
254 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
255
256 /* Check for error. */
257 if (status != UX_SUCCESS)
258 {
259
260 printf("Error on line %d, error code: %d\n", __LINE__, status);
261 test_control_return(1);
262 }
263
264 /* Create the main host simulation thread. */
265 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
266 stack_pointer, UX_DEMO_STACK_SIZE,
267 20, 20, 1, TX_AUTO_START);
268
269 /* Check for error. */
270 if (status != TX_SUCCESS)
271 {
272
273 printf("Error on line %d, error code: %d\n", __LINE__, status);
274 test_control_return(1);
275 }
276 }
277
tx_demo_thread_host_simulation_entry(ULONG arg)278 static void tx_demo_thread_host_simulation_entry(ULONG arg)
279 {
280
281 UINT status;
282 UX_HOST_CLASS_COMMAND command;
283 UX_HOST_CLASS host_class;
284 UX_DEVICE device;
285 UX_INTERFACE interface;
286 UX_CONFIGURATION configuration;
287 // UX_MEMORY_BLOCK *dummy_memory_block_first = (UX_MEMORY_BLOCK *)dummy_usbx_memory;
288 // UX_MEMORY_BLOCK *original_memory_block = _ux_system -> ux_system_regular_memory_pool_start;
289 UX_HOST_CLASS_HID *hid_instance;
290 TX_SEMAPHORE hid_instance_semaphore_copy;
291 UX_HOST_CLASS *class;
292
293
294 /* Find the HID class */
295 status = demo_class_hid_get();
296 if (status != UX_SUCCESS)
297 {
298
299 printf("Error on line %d, error code: %d\n", __LINE__, status);
300 test_control_return(1);
301 }
302
303 /**************************************************/
304 /** Test case: _ux_utility_semaphore_create() fails **/
305 /**************************************************/
306
307 /* Find the main HID container */
308 status = ux_host_stack_class_get(_ux_system_host_class_hid_name, &class);
309 if (status != UX_SUCCESS)
310 {
311
312 printf("Error on line %d, error code: %d\n", __LINE__, status);
313 test_control_return(1);
314 }
315
316 command.ux_host_class_command_container = hid -> ux_host_class_hid_interface;
317 command.ux_host_class_command_class_ptr = class;
318
319 /* Allocate a hid instance like hid_activate(). */
320 hid_instance = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY,sizeof(UX_HOST_CLASS_HID));
321 if (hid_instance == UX_NULL)
322 {
323
324 printf("Error on line %d\n", __LINE__);
325 test_control_return(1);
326 }
327
328 /* Create the semaphore like keyboard_activate(). */
329 status = _ux_utility_semaphore_create(&hid_instance -> ux_host_class_hid_semaphore, "ux_host_class_hid_semaphore", 1);
330 if (status != UX_SUCCESS)
331 {
332
333 printf("Error on line %d, error code: %d\n", __LINE__, status);
334 test_control_return(1);
335 }
336
337 /* Make a copy of the semaphore. */
338 hid_instance_semaphore_copy = hid_instance -> ux_host_class_hid_semaphore;
339
340 /* Free the memory so keyboard_activate() uses the same memory as us, which will cause threadx to detect a semaphore duplicate. */
341 ux_utility_memory_free(hid_instance);
342
343 status = _ux_host_class_hid_activate(&command);
344 if (status != UX_SEMAPHORE_ERROR)
345 {
346
347 printf("Error on line %d, error code: %d\n", __LINE__, status);
348 test_control_return(1);
349 }
350
351 /* ux_utility_memory_allocate() zero'd out our hid instance semaphore! Good thing we made a copy! */
352 hid_instance -> ux_host_class_hid_semaphore = hid_instance_semaphore_copy;
353
354 /* Restore state for next test. */
355 status = ux_utility_semaphore_delete(&hid_instance -> ux_host_class_hid_semaphore);
356 if (status != UX_SUCCESS)
357 {
358
359 printf("Error on line %d, error code: %d\n", __LINE__, status);
360 test_control_return(1);
361 }
362 #if 0 /* Tested by basic_memory_test */
363 /**************************************************/
364 /** Test case: hid = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY,sizeof(UX_HOST_CLASS_HID)) fails. **/
365 /**************************************************/
366
367 /* Set up the dummy memory block. */
368 dummy_memory_block_first -> ux_memory_block_next = UX_NULL;
369 dummy_memory_block_first -> ux_memory_block_previous = UX_NULL;
370 dummy_memory_block_first -> ux_memory_block_status = UX_MEMORY_UNUSED;
371 dummy_memory_block_first -> ux_memory_block_size = 0;
372 _ux_system -> ux_system_regular_memory_pool_start = dummy_memory_block_first;
373
374 status = _ux_host_class_hid_activate(&command);
375 if (status != UX_MEMORY_INSUFFICIENT)
376 {
377
378 printf("Error on line %d, error code: %d\n", __LINE__, status);
379 test_control_return(1);
380 }
381
382 /* Restore state for next test. */
383 _ux_system -> ux_system_regular_memory_pool_start = original_memory_block;
384 #endif
385 /**************************************************/
386 /** Test case: _ux_host_class_hid_configure() fails. **/
387 /** Why direct: When called normally, the device is already configured (via ux_host_stack_class_interface_scan, which always happens before hid_activate()), so _ux_host_class_hid_configure() returns immediately. **/
388 /**************************************************/
389
390 /* Make sure we pass _ux_host_stack_class_instance_create(). */
391 host_class.ux_host_class_first_instance = UX_NULL;
392
393 /* Make sure _ux_host_class_hid_configure() fails. */
394 device.ux_device_state = ~UX_DEVICE_CONFIGURED;
395 device.ux_device_handle = 0;
396
397 configuration.ux_configuration_device = &device;
398 interface.ux_interface_configuration = &configuration;
399 command.ux_host_class_command_container = &interface;
400 command.ux_host_class_command_class_ptr = &host_class;
401
402 status = _ux_host_class_hid_activate(&command);
403 if (status != UX_CONFIGURATION_HANDLE_UNKNOWN)
404 {
405
406 printf("Error on line %d, error code: %d\n", __LINE__, status);
407 test_control_return(1);
408 }
409
410 /* Now disconnect the device. */
411 _ux_device_stack_disconnect();
412
413 /* And deinitialize the class. */
414 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
415
416 /* Deinitialize the device side of usbx. */
417 _ux_device_stack_uninitialize();
418
419 /* And finally the usbx system resources. */
420 _ux_system_uninitialize();
421
422 /* Successful test. */
423 printf("SUCCESS!\n");
424 test_control_return(0);
425 }
426
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)427 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
428 {
429 return(UX_SUCCESS);
430 }
431
