1 /* This test ux_host_class_hid_keyboard_thread(). */
2
3 #include "usbx_test_common_hid.h"
4
5 #include "ux_host_class_hid_keyboard.h"
6
7 #include "tx_api.h"
8 #include "tx_thread.h"
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 //if (error_code != )
153 printf("hello");
154 {
155
156 /* Something went wrong. */
157 printf("Error on line %d\n", __LINE__);
158 test_control_return(1);
159 }
160 }
161
162 /* Define what the initial system looks like. */
163
164 #ifdef CTEST
test_application_define(void * first_unused_memory)165 void test_application_define(void *first_unused_memory)
166 #else
167 void usbx_ux_host_class_hid_keyboard_thread_test_application_define(void *first_unused_memory)
168 #endif
169 {
170
171 UINT status;
172 CHAR * stack_pointer;
173 CHAR * memory_pointer;
174 UINT descriptor_size = HID_REPORT_LENGTH;
175
176 /* Inform user. */
177 printf("Running ux_host_class_hid_keyboard_thread Test...................... ");
178
179 /* Initialize the free memory pointer */
180 stack_pointer = (CHAR *) usbx_memory;
181 memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2);
182
183 /* Initialize USBX. Memory */
184 status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0);
185
186 /* Check for error. */
187 if (status != UX_SUCCESS)
188 {
189
190 printf("Error on line %d\n", __LINE__);
191 test_control_return(1);
192 }
193
194 /* Register the error callback. */
195 _ux_utility_error_callback_register(error_callback);
196
197 /* The code below is required for installing the host portion of USBX */
198 status = ux_host_stack_initialize(ux_system_host_change_function);
199 if (status != UX_SUCCESS)
200 {
201
202 printf("Error on line %d\n", __LINE__);
203 test_control_return(1);
204 }
205
206 status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry);
207 if (status != UX_SUCCESS)
208 {
209
210 printf("Error on line %d\n", __LINE__);
211 test_control_return(1);
212 }
213
214 /* Register the HID client(s). */
215 status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry);
216 if (status != UX_SUCCESS)
217 {
218
219 printf("Error on line %d\n", __LINE__);
220 test_control_return(1);
221 }
222
223 /* The code below is required for installing the device portion of USBX. No call back for
224 device status change in this example. */
225 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
226 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
227 string_framework, STRING_FRAMEWORK_LENGTH,
228 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH,UX_NULL);
229 if(status!=UX_SUCCESS)
230 {
231
232 printf("Error on line %d\n", __LINE__);
233 test_control_return(1);
234 }
235
236 /* Initialize the hid class parameters. */
237 hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor;
238 hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH;
239 hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback;
240
241 /* Initilize the device hid class. The class is connected with interface 2 */
242 status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry,
243 1,2, (VOID *)&hid_parameter);
244 if(status!=UX_SUCCESS)
245 {
246
247 printf("Error on line %d\n", __LINE__);
248 test_control_return(1);
249 }
250
251
252 /* Initialize the simulated device controller. */
253 status = _ux_dcd_sim_slave_initialize();
254
255 /* Check for error. */
256 if (status != UX_SUCCESS)
257 {
258
259 printf("Error on line %d\n", __LINE__);
260 test_control_return(1);
261 }
262
263 /* Register all the USB host controllers available in this system */
264 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
265
266 /* Check for error. */
267 if (status != UX_SUCCESS)
268 {
269
270 printf("Error on line %d\n", __LINE__);
271 test_control_return(1);
272 }
273
274 /* Create the main host simulation thread. */
275 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
276 stack_pointer, UX_DEMO_STACK_SIZE,
277 19, 19, 1, TX_AUTO_START);
278
279 /* Check for error. */
280 if (status != TX_SUCCESS)
281 {
282
283 printf("Error on line %d\n", __LINE__);
284 test_control_return(1);
285 }
286 }
287
ux_hcd_sim_host_entry_filter_device_extraction_test(UX_HCD * hcd,UINT function,VOID * parameter)288 static UINT ux_hcd_sim_host_entry_filter_device_extraction_test(UX_HCD *hcd, UINT function, VOID *parameter)
289 {
290
291 UINT status;
292
293 switch(function)
294 {
295 case UX_HCD_GET_PORT_STATUS:
296
297 /* No device on this port. */
298 status = 0;
299
300 /* This is a Full speed device. */
301 status |= UX_PS_DS_FS;
302
303 break;
304
305
306 default:
307
308 status = _ux_hcd_sim_host_entry(hcd, function, parameter);
309 break;
310 }
311
312 return status;
313 }
314
tx_demo_thread_host_simulation_entry(ULONG arg)315 static void tx_demo_thread_host_simulation_entry(ULONG arg)
316 {
317
318 UINT status;
319 UX_HOST_CLASS_HID_KEYBOARD *keyboard;
320 UX_HCD *hcd;
321 ULONG old_time_slice;
322
323 /* Find the HID class */
324 status = demo_class_hid_get();
325 if (status != UX_SUCCESS)
326 {
327
328 printf("Error on line %d; status code: %d\n", __LINE__, status);
329 test_control_return(1);
330 }
331
332 /* Get the HID client */
333 hid_client = hid -> ux_host_class_hid_client;
334
335 /* Check if the instance of the keyboard is live */
336 while (hid_client -> ux_host_class_hid_client_local_instance == UX_NULL)
337 tx_thread_sleep(10);
338
339 /* Get the keyboard instance */
340 keyboard = (UX_HOST_CLASS_HID_KEYBOARD *)hid_client -> ux_host_class_hid_client_local_instance;
341
342 hcd = UX_DEVICE_HCD_GET(hid -> ux_host_class_hid_device);
343
344 /**************************************************/
345 /** Test case: _ux_utility_semaphore_get(&keyboard_instance -> ux_host_class_hid_keyboard_semaphore, UX_WAIT_FOREVER) fails **/
346 /**************************************************/
347
348 /* Give it a time slice; otherwise, this thread will never continue. */
349 status = tx_thread_time_slice_change(&keyboard -> ux_host_class_hid_keyboard_thread, 1, &old_time_slice);
350 if (status != UX_SUCCESS)
351 {
352
353 printf("Error on line %d; status code: %d\n", __LINE__, status);
354 test_control_return(1);
355 }
356
357 /* Make sure keyboard_deactivate() won't terminate the thread, that way it'll be around long enough to call semaphore_get() and fail. */
358 keyboard -> ux_host_class_hid_keyboard_thread.tx_thread_id = TX_THREAD_ID + 1;
359
360 /* Change the HCD entry function to our filter function. */
361 hcd -> ux_hcd_entry_function = ux_hcd_sim_host_entry_filter_device_extraction_test;
362
363 /* Signal port activity to the enum thread. */
364 hcd -> ux_hcd_root_hub_signal[0] = 1;
365
366 /* Signal enum thread. */
367 _ux_utility_semaphore_put(&_ux_system_host -> ux_system_host_enum_semaphore);
368
369 /* Wait for hid class to shut down. */
370 while(hid -> ux_host_class_hid_state == UX_HOST_CLASS_INSTANCE_LIVE)
371 tx_thread_sleep(10);
372
373 /* Restore thread_id to allow thread_delete() to succeed. */
374 keyboard -> ux_host_class_hid_keyboard_thread.tx_thread_id = TX_THREAD_ID;
375
376 /* Terminate the thread. */
377 _ux_utility_thread_delete(&keyboard -> ux_host_class_hid_keyboard_thread);
378
379 /* Now disconnect the device. */
380 _ux_device_stack_disconnect();
381
382 /* And deinitialize the class. */
383 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
384
385 /* Deinitialize the device side of usbx. */
386 _ux_device_stack_uninitialize();
387
388 /* And finally the usbx system resources. */
389 _ux_system_uninitialize();
390
391 /* Successful test. */
392 printf("SUCCESS!\n");
393 test_control_return(0);
394 }
395
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)396 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
397 {
398 return(UX_SUCCESS);
399 }
400
