1 /* This tests ensures that when the device stalls the default endpoint upon an invalid request, it is unstalled after sending a valid request. */
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 if (error_code != UX_TRANSFER_STALLED)
153 {
154
155 /* Failed test. */
156 printf("Error on line %d, system_level: %d, system_context: %d, error code: %d\n", __LINE__, system_level, system_context, error_code);
157 test_control_return(1);
158 }
159 }
160
161 /* Define what the initial system looks like. */
162 #ifdef CTEST
test_application_define(void * first_unused_memory)163 void test_application_define(void *first_unused_memory)
164 #else
165 void usbx_control_transfer_stall_test(void *first_unused_memory)
166 #endif
167 {
168
169 UINT status;
170 CHAR * stack_pointer;
171 CHAR * memory_pointer;
172
173
174 /* Inform user. */
175 printf("Running Control Transfer Stall test....................... ");
176
177 /* Initialize the free memory pointer */
178 stack_pointer = (CHAR *) usbx_memory;
179 memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2);
180
181 /* Initialize USBX. Memory */
182 status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0);
183
184 /* Check for error. */
185 if (status != UX_SUCCESS)
186 {
187
188 printf("Error on line %d, error code: %d\n", __LINE__, status);
189 test_control_return(1);
190 }
191
192 /* Register the error callback. */
193 _ux_utility_error_callback_register(error_callback);
194
195 /* The code below is required for installing the host portion of USBX */
196 status = ux_host_stack_initialize(ux_system_host_change_function);
197 if (status != UX_SUCCESS)
198 {
199
200 printf("Error on line %d, error code: %d\n", __LINE__, status);
201 test_control_return(1);
202 }
203
204 status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry);
205 if (status != UX_SUCCESS)
206 {
207
208 printf("Error on line %d, error code: %d\n", __LINE__, status);
209 test_control_return(1);
210 }
211
212 /* Register the HID client(s). */
213 status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry);
214 if (status != UX_SUCCESS)
215 {
216
217 printf("Error on line %d, error code: %d\n", __LINE__, status);
218 test_control_return(1);
219 }
220
221 /* The code below is required for installing the device portion of USBX. No call back for
222 device status change in this example. */
223 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
224 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
225 string_framework, STRING_FRAMEWORK_LENGTH,
226 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH,UX_NULL);
227 if(status!=UX_SUCCESS)
228 {
229
230 printf("Error on line %d, error code: %d\n", __LINE__, status);
231 test_control_return(1);
232 }
233
234 /* Initialize the hid class parameters. */
235 hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor;
236 hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH;
237 hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback;
238
239 /* Initilize the device hid class. The class is connected with interface 2 */
240 status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry,
241 1,2, (VOID *)&hid_parameter);
242 if(status!=UX_SUCCESS)
243 {
244
245 printf("Error on line %d, error code: %d\n", __LINE__, status);
246 test_control_return(1);
247 }
248
249 /* Initialize the simulated device controller. */
250 status = _ux_dcd_sim_slave_initialize();
251
252 /* Check for error. */
253 if (status != UX_SUCCESS)
254 {
255
256 printf("Error on line %d, error code: %d\n", __LINE__, status);
257 test_control_return(1);
258 }
259
260 /* Register all the USB host controllers available in this system */
261 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
262
263 /* Check for error. */
264 if (status != UX_SUCCESS)
265 {
266
267 printf("Error on line %d, error code: %d\n", __LINE__, status);
268 test_control_return(1);
269 }
270
271 /* Create the main host simulation thread. */
272 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
273 stack_pointer, UX_DEMO_STACK_SIZE,
274 20, 20, 1, TX_AUTO_START);
275
276 /* Check for error. */
277 if (status != TX_SUCCESS)
278 {
279
280 printf("Error on line %d, error code: %d\n", __LINE__, status);
281 test_control_return(1);
282 }
283 }
284
tx_demo_thread_host_simulation_entry(ULONG arg)285 static void tx_demo_thread_host_simulation_entry(ULONG arg)
286 {
287
288 UINT status;
289 UX_HOST_CLASS_HID_KEYBOARD *keyboard;
290 UX_ENDPOINT *endpoint;
291 UX_TRANSFER *transfer_request;
292 UCHAR descriptor[1024];
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 /* Get the HID client */
304 hid_client = hid -> ux_host_class_hid_client;
305
306 /* Check if the instance of the keyboard is live */
307 while (hid_client -> ux_host_class_hid_client_local_instance == UX_NULL)
308 tx_thread_sleep(10);
309
310 /* Get the keyboard instance */
311 keyboard = (UX_HOST_CLASS_HID_KEYBOARD *)hid_client -> ux_host_class_hid_client_local_instance;
312
313 /* Get default endpoint. */
314 endpoint = &hid->ux_host_class_hid_device->ux_device_control_endpoint;
315
316 /* Get the transfer request. */
317 transfer_request = &endpoint->ux_endpoint_transfer_request;
318
319 /* Stall the default endpoint by sending it an invalid request. */
320
321 /* Create a transfer request for an invalid request. */
322 transfer_request -> ux_transfer_request_data_pointer = descriptor;
323 transfer_request -> ux_transfer_request_requested_length = 0x09;
324 transfer_request -> ux_transfer_request_function = UX_GET_DESCRIPTOR;
325 transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_DEVICE;
326 transfer_request -> ux_transfer_request_value = 0xffff << 8;
327 transfer_request -> ux_transfer_request_index = 0x02;
328
329 /* Send request to HCD layer. */
330 status = ux_host_stack_transfer_request(transfer_request);
331 if (status != UX_TRANSFER_STALLED)
332 {
333
334 printf("Error on line %d, error code: %d\n", __LINE__, status);
335 test_control_return(1);
336 }
337
338 /* Now send it a valid request. */
339
340 /* Create a transfer request for a valid request. */
341 transfer_request -> ux_transfer_request_data_pointer = descriptor;
342 transfer_request -> ux_transfer_request_requested_length = UX_CONFIGURATION_DESCRIPTOR_LENGTH;
343 transfer_request -> ux_transfer_request_function = UX_GET_DESCRIPTOR;
344 transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_STANDARD | UX_REQUEST_TARGET_DEVICE;
345 transfer_request -> ux_transfer_request_value = UX_CONFIGURATION_DESCRIPTOR_ITEM << 8;
346 transfer_request -> ux_transfer_request_index = 0x02;
347
348 /* Send request to HCD layer. */
349 status = ux_host_stack_transfer_request(transfer_request);
350 if (status != UX_SUCCESS)
351 {
352
353 printf("Error on line %d, error code: %d\n", __LINE__, status);
354 test_control_return(1);
355 }
356
357 /* Now disconnect the device. */
358 _ux_device_stack_disconnect();
359
360 /* And deinitialize the class. */
361 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
362
363 /* Deinitialize the device side of usbx. */
364 _ux_device_stack_uninitialize();
365
366 /* And finally the usbx system resources. */
367 _ux_system_uninitialize();
368
369 /* Successful test. */
370 printf("SUCCESS!\n");
371 test_control_return(0);
372 }
373
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)374 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
375 {
376 return(UX_SUCCESS);
377 }
378
