1 /* This file tests the ux_host_class_hid_keyboard_entry API. */
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 != )
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_entry_test_application_define(void *first_unused_memory)
168 #endif
169 {
170
171 UINT status;
172 CHAR * stack_pointer;
173 CHAR * memory_pointer;
174
175
176 /* Inform user. */
177 printf("Running ux_host_class_hid_keyboard_entry 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, error code: 0x%x\n", __LINE__, status);
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, error code: 0x%x\n", __LINE__, status);
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, error code: 0x%x\n", __LINE__, status);
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, error code: 0x%x\n", __LINE__, status);
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, error code: 0x%x\n", __LINE__, status);
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, error code: 0x%x\n", __LINE__, status);
248 test_control_return(1);
249 }
250
251 /* Initialize the simulated device controller. */
252 status = _ux_dcd_sim_slave_initialize();
253
254 /* Check for error. */
255 if (status != UX_SUCCESS)
256 {
257
258 printf("Error on line %d, error code: 0x%x\n", __LINE__, status);
259 test_control_return(1);
260 }
261
262 /* Register all the USB host controllers available in this system */
263 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
264
265 /* Check for error. */
266 if (status != UX_SUCCESS)
267 {
268
269 printf("Error on line %d, error code: 0x%x\n", __LINE__, status);
270 test_control_return(1);
271 }
272
273 /* Create the main host simulation thread. */
274 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
275 stack_pointer, UX_DEMO_STACK_SIZE,
276 20, 20, 1, TX_AUTO_START);
277
278 /* Check for error. */
279 if (status != TX_SUCCESS)
280 {
281
282 printf("Error on line %d, error code: 0x%x\n", __LINE__, status);
283 test_control_return(1);
284 }
285 }
286
tx_demo_thread_host_simulation_entry(ULONG arg)287 static void tx_demo_thread_host_simulation_entry(ULONG arg)
288 {
289
290 UINT status;
291 UX_HOST_CLASS_HID_CLIENT_COMMAND client_command;
292
293 /* Find the HID class */
294 status = demo_class_hid_get();
295 if (status != UX_SUCCESS)
296 {
297
298 printf("Error on line %d, error code: 0x%x\n", __LINE__, status);
299 test_control_return(1);
300 }
301
302 /**************************************************/
303 /** Test case: no match in switch (command -> ux_host_class_hid_client_command_request). **/
304 /**************************************************/
305
306 /* Set to unknown command request. */
307 client_command.ux_host_class_hid_client_command_request = 0xdeadbeef;
308
309 status = _ux_host_class_hid_keyboard_entry(&client_command);
310 if (status != UX_ERROR)
311 {
312
313 printf("Error on line %d, error code: 0x%x\n", __LINE__, status);
314 test_control_return(1);
315 }
316
317 /**************************************************/
318 /** Test case: ux_host_class_hid_client_command_page/ux_host_class_hid_client_command_usage error. **/
319 /**************************************************/
320
321 /* Set to unknown command request. */
322 client_command.ux_host_class_hid_client_command_request = UX_HOST_CLASS_COMMAND_QUERY;
323 client_command.ux_host_class_hid_client_command_page = UX_HOST_CLASS_HID_PAGE_GENERIC_DESKTOP_CONTROLS;
324 client_command.ux_host_class_hid_client_command_usage = UX_HOST_CLASS_HID_GENERIC_DESKTOP_KEYBOARD + 1;
325
326 status = _ux_host_class_hid_keyboard_entry(&client_command);
327 if (status != UX_NO_CLASS_MATCH)
328 {
329
330 printf("Error on line %d, error code: 0x%x\n", __LINE__, status);
331 test_control_return(1);
332 }
333
334 /* Now disconnect the device. */
335 _ux_device_stack_disconnect();
336
337 /* And deinitialize the class. */
338 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
339
340 /* Deinitialize the device side of usbx. */
341 _ux_device_stack_uninitialize();
342
343 /* And finally the usbx system resources. */
344 _ux_system_uninitialize();
345
346 /* Successful test. */
347 printf("SUCCESS!\n");
348 test_control_return(0);
349 }
350
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)351 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
352 {
353 return(UX_SUCCESS);
354 }
355
