1 #include "usbx_test_common_hid.h"
2 #include "ux_host_class_hid_keyboard.h"
3
4
5 #define DUMMY_USBX_MEMORY_SIZE (64*1024)
6 static UCHAR dummy_usbx_memory[DUMMY_USBX_MEMORY_SIZE];
7
8 static UINT device_removed;
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
147 if(a == UX_DEVICE_REMOVAL)
148 {
149 device_removed = 1;
150 }
151
152 return 0;
153 }
154
error_callback(UINT system_level,UINT system_context,UINT error_code)155 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
156 {
157 }
158
159 /* Define what the initial system looks like. */
160
161 #ifdef CTEST
test_application_define(void * first_unused_memory)162 void test_application_define(void *first_unused_memory)
163 #else
164 void usbx_ux_host_class_hid_deactivate_test2_application_define(void *first_unused_memory)
165 #endif
166 {
167
168 UINT status;
169 CHAR * stack_pointer;
170 CHAR * memory_pointer;
171
172
173 /* Inform user. */
174 printf("Running ux_host_class_hid_deactivate Test 2......................... ");
175
176 /* Initialize the free memory pointer */
177 stack_pointer = (CHAR *) usbx_memory;
178 memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2);
179
180 /* Initialize USBX. Memory */
181 status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0);
182
183 /* Check for error. */
184 if (status != UX_SUCCESS)
185 {
186
187 printf("Error on line %d, error code: %d\n", __LINE__, status);
188 test_control_return(1);
189 }
190
191 /* Register the error callback. */
192 _ux_utility_error_callback_register(error_callback);
193
194 /* The code below is required for installing the host portion of USBX */
195 status = ux_host_stack_initialize(ux_system_host_change_function);
196 if (status != UX_SUCCESS)
197 {
198
199 printf("Error on line %d, error code: %d\n", __LINE__, status);
200 test_control_return(1);
201 }
202
203 status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry);
204 if (status != UX_SUCCESS)
205 {
206
207 printf("Error on line %d, error code: %d\n", __LINE__, status);
208 test_control_return(1);
209 }
210
211 /* Register the HID client(s). */
212 status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry);
213 if (status != UX_SUCCESS)
214 {
215
216 printf("Error on line %d, error code: %d\n", __LINE__, status);
217 test_control_return(1);
218 }
219
220 /* The code below is required for installing the device portion of USBX. No call back for
221 device status change in this example. */
222 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
223 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
224 string_framework, STRING_FRAMEWORK_LENGTH,
225 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH,UX_NULL);
226 if(status!=UX_SUCCESS)
227 {
228
229 printf("Error on line %d, error code: %d\n", __LINE__, status);
230 test_control_return(1);
231 }
232
233 /* Initialize the hid class parameters. */
234 hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor;
235 hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH;
236 hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback;
237
238 /* Initilize the device hid class. The class is connected with interface 2 */
239 status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry,
240 1,2, (VOID *)&hid_parameter);
241 if(status!=UX_SUCCESS)
242 {
243
244 printf("Error on line %d, error code: %d\n", __LINE__, status);
245 test_control_return(1);
246 }
247
248 /* Initialize the simulated device controller. */
249 status = _ux_dcd_sim_slave_initialize();
250
251 /* Check for error. */
252 if (status != UX_SUCCESS)
253 {
254
255 printf("Error on line %d, error code: %d\n", __LINE__, status);
256 test_control_return(1);
257 }
258
259 /* Register all the USB host controllers available in this system */
260 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
261
262 /* Check for error. */
263 if (status != UX_SUCCESS)
264 {
265
266 printf("Error on line %d, error code: %d\n", __LINE__, status);
267 test_control_return(1);
268 }
269
270 /* Create the main host simulation thread. */
271 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
272 stack_pointer, UX_DEMO_STACK_SIZE,
273 20, 20, 1, TX_AUTO_START);
274
275 /* Check for error. */
276 if (status != TX_SUCCESS)
277 {
278
279 printf("Error on line %d, error code: %d\n", __LINE__, status);
280 test_control_return(1);
281 }
282 }
283
ux_hcd_sim_host_entry_filter_device_extraction_test(UX_HCD * hcd,UINT function,VOID * parameter)284 static UINT ux_hcd_sim_host_entry_filter_device_extraction_test(UX_HCD *hcd, UINT function, VOID *parameter)
285 {
286
287 UINT status;
288
289 switch(function)
290 {
291 case UX_HCD_GET_PORT_STATUS:
292
293 /* No device on this port. */
294 status = 0;
295
296 /* This is a Full speed device. */
297 status |= UX_PS_DS_FS;
298
299 break;
300
301
302 default:
303
304 status = _ux_hcd_sim_host_entry(hcd, function, parameter);
305 break;
306 }
307
308 return status;
309 }
310
tx_demo_thread_host_simulation_entry(ULONG arg)311 static void tx_demo_thread_host_simulation_entry(ULONG arg)
312 {
313
314 UINT status;
315 UX_HCD *hcd;
316
317
318 /* Find the HID class */
319 status = demo_class_hid_get();
320 if (status != UX_SUCCESS)
321 {
322
323 printf("Error on line %d, error code: %d\n", __LINE__, status);
324 test_control_return(1);
325 }
326
327 /**************************************************/
328 /** Test case: if (transfer_request -> ux_transfer_request_data_pointer != UX_NULL) failure **/
329 /** Why direct: there doesn't seem to be a way to set ux_transfer_request_data_pointer to null... **/
330 /**************************************************/
331
332 /* Set data pointer to null */
333 hid -> ux_host_class_hid_interrupt_endpoint -> ux_endpoint_transfer_request.ux_transfer_request_data_pointer = UX_NULL;
334
335 /* Retrieve hcd */
336 hcd = UX_DEVICE_HCD_GET(hid -> ux_host_class_hid_device);
337
338 /* Change the HCD entry function to our filter function. */
339 hcd -> ux_hcd_entry_function = ux_hcd_sim_host_entry_filter_device_extraction_test;
340
341 /* Signal port activity to the enum thread. */
342 hcd -> ux_hcd_root_hub_signal[0] = 1;
343
344 /* Signal enum thread. */
345 _ux_utility_semaphore_put(&_ux_system_host -> ux_system_host_enum_semaphore);
346
347 /* Wait for device removed signal. */
348 while(!device_removed)
349 tx_thread_sleep(10);
350
351 /* Now disconnect the device. */
352 _ux_device_stack_disconnect();
353
354 /* And deinitialize the class. */
355 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
356
357 /* Deinitialize the device side of usbx. */
358 _ux_device_stack_uninitialize();
359
360 /* And finally the usbx system resources. */
361 _ux_system_uninitialize();
362
363 /* Successful test. */
364 printf("SUCCESS!\n");
365 test_control_return(0);
366 }
367
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)368 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
369 {
370 return(UX_SUCCESS);
371 }
372
