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 UCHAR hid_report_descriptor[] = {
9
10 0x05, 0x01, // USAGE_PAGE (Generic Desktop)
11 0x09, 0x06, // USAGE (Keyboard)
12 0xa1, 0x01, // COLLECTION (Application)
13 0x05, 0x07, // USAGE_PAGE (Keyboard)
14 0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
15 0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
16 0x15, 0x00, // LOGICAL_MINIMUM (0)
17 0x25, 0x01, // LOGICAL_MAXIMUM (1)
18 0x75, 0x01, // REPORT_SIZE (1)
19 0x95, 0x08, // REPORT_COUNT (8)
20 0x81, 0x02, // INPUT (Data,Var,Abs)
21 0x95, 0x01, // REPORT_COUNT (1)
22 0x75, 0x08, // REPORT_SIZE (8)
23 0x81, 0x03, // INPUT (Cnst,Var,Abs)
24 0x95, 0x05, // REPORT_COUNT (5)
25 0x75, 0x01, // REPORT_SIZE (1)
26 0x05, 0x08, // USAGE_PAGE (LEDs)
27 0x19, 0x01, // USAGE_MINIMUM (Num Lock)
28 0x29, 0x05, // USAGE_MAXIMUM (Kana)
29 0x91, 0x02, // OUTPUT (Data,Var,Abs)
30 0x95, 0x01, // REPORT_COUNT (1)
31 0x75, 0x03, // REPORT_SIZE (3)
32 0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
33 0x95, 0x06, // REPORT_COUNT (6)
34 0x75, 0x08, // REPORT_SIZE (8)
35 0x15, 0x00, // LOGICAL_MINIMUM (0)
36 0x25, 0x65, // LOGICAL_MAXIMUM (101)
37 0x05, 0x07, // USAGE_PAGE (Keyboard)
38 0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
39 0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
40 0x81, 0x00, // INPUT (Data,Ary,Abs)
41 0xc0 // END_COLLECTION
42 };
43 #define HID_REPORT_LENGTH sizeof(hid_report_descriptor)/sizeof(hid_report_descriptor[0])
44
45
46 #define DEVICE_FRAMEWORK_LENGTH_FULL_SPEED 52
47 static UCHAR device_framework_full_speed[DEVICE_FRAMEWORK_LENGTH_FULL_SPEED] = {
48
49 /* Device descriptor */
50 0x12, 0x01, 0x10, 0x01, 0x00, 0x00, 0x00, 0x08,
51 0x81, 0x0A, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00,
52 0x00, 0x01,
53
54 /* Configuration descriptor */
55 0x09, 0x02, 0x22, 0x00, 0x01, 0x01, 0x00, 0xc0,
56 0x32,
57
58 /* Interface descriptor */
59 0x09, 0x04, 0x02, 0x00, 0x01, 0x03, 0x00, 0x00,
60 0x00,
61
62 /* HID descriptor */
63 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_REPORT_LENGTH),
64 MSB(HID_REPORT_LENGTH),
65
66 /* Endpoint descriptor (Interrupt) */
67 0x07, 0x05, 0x82, 0x03, 0x08, 0x00, 0x08
68
69 };
70
71
72 #define DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED 62
73 static UCHAR device_framework_high_speed[DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED] = {
74
75 /* Device descriptor */
76 0x12, 0x01, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
77 0x0a, 0x07, 0x25, 0x40, 0x01, 0x00, 0x01, 0x02,
78 0x03, 0x01,
79
80 /* Device qualifier descriptor */
81 0x0a, 0x06, 0x00, 0x02, 0x00, 0x00, 0x00, 0x40,
82 0x01, 0x00,
83
84 /* Configuration descriptor */
85 0x09, 0x02, 0x22, 0x00, 0x01, 0x01, 0x00, 0xc0,
86 0x32,
87
88 /* Interface descriptor */
89 0x09, 0x04, 0x02, 0x00, 0x01, 0x03, 0x00, 0x00,
90 0x00,
91
92 /* HID descriptor */
93 0x09, 0x21, 0x10, 0x01, 0x21, 0x01, 0x22, LSB(HID_REPORT_LENGTH),
94 MSB(HID_REPORT_LENGTH),
95
96 /* Endpoint descriptor (Interrupt) */
97 0x07, 0x05, 0x82, 0x03, 0x08, 0x00, 0x08
98
99 };
100
101
102 /* String Device Framework :
103 Byte 0 and 1 : Word containing the language ID : 0x0904 for US
104 Byte 2 : Byte containing the index of the descriptor
105 Byte 3 : Byte containing the length of the descriptor string
106 */
107
108 #define STRING_FRAMEWORK_LENGTH 40
109 static UCHAR string_framework[] = {
110
111 /* Manufacturer string descriptor : Index 1 */
112 0x09, 0x04, 0x01, 0x0c,
113 0x45, 0x78, 0x70, 0x72,0x65, 0x73, 0x20, 0x4c,
114 0x6f, 0x67, 0x69, 0x63,
115
116 /* Product string descriptor : Index 2 */
117 0x09, 0x04, 0x02, 0x0c,
118 0x55, 0x53, 0x42, 0x20, 0x4b, 0x65, 0x79, 0x62,
119 0x6f, 0x61, 0x72, 0x64,
120
121 /* Serial Number string descriptor : Index 3 */
122 0x09, 0x04, 0x03, 0x04,
123 0x30, 0x30, 0x30, 0x31
124 };
125
126
127 /* Multiple languages are supported on the device, to add
128 a language besides english, the unicode language code must
129 be appended to the language_id_framework array and the length
130 adjusted accordingly. */
131 #define LANGUAGE_ID_FRAMEWORK_LENGTH 2
132 static UCHAR language_id_framework[] = {
133
134 /* English. */
135 0x09, 0x04
136 };
137
138
139 UINT _ux_hcd_sim_host_entry(UX_HCD *hcd, UINT function, VOID *parameter);
140
141
ux_system_host_change_function(ULONG a,UX_HOST_CLASS * b,VOID * c)142 static UINT ux_system_host_change_function(ULONG a, UX_HOST_CLASS *b, VOID *c)
143 {
144 return 0;
145 }
146
error_callback(UINT system_level,UINT system_context,UINT error_code)147 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
148 {
149 }
150
151 /* Define what the initial system looks like. */
152
153 #ifdef CTEST
test_application_define(void * first_unused_memory)154 void test_application_define(void *first_unused_memory)
155 #else
156 void usbx_ux_host_class_hid_client_register_test2_application_define(void *first_unused_memory)
157 #endif
158 {
159
160 UINT status;
161 CHAR * stack_pointer;
162 CHAR * memory_pointer;
163
164
165 /* Inform user. */
166 printf("Running ux_host_class_hid_client_register Test2..................... ");
167
168 /* Initialize the free memory pointer */
169 stack_pointer = (CHAR *) usbx_memory;
170 memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2);
171
172 /* Initialize USBX. Memory */
173 status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0);
174
175 /* Check for error. */
176 if (status != UX_SUCCESS)
177 {
178
179 printf("Error on line %d, error code: %d\n", __LINE__, status);
180 test_control_return(1);
181 }
182
183 /* Register the error callback. */
184 _ux_utility_error_callback_register(error_callback);
185
186 /* The code below is required for installing the host portion of USBX */
187 status = ux_host_stack_initialize(ux_system_host_change_function);
188 if (status != UX_SUCCESS)
189 {
190
191 printf("Error on line %d, error code: %d\n", __LINE__, status);
192 test_control_return(1);
193 }
194
195 status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry);
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 /* The code below is required for installing the device portion of USBX. No call back for
204 device status change in this example. */
205 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
206 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
207 string_framework, STRING_FRAMEWORK_LENGTH,
208 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH,UX_NULL);
209 if(status!=UX_SUCCESS)
210 {
211
212 printf("Error on line %d, error code: %d\n", __LINE__, status);
213 test_control_return(1);
214 }
215
216 /* Initialize the hid class parameters. */
217 hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor;
218 hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH;
219 hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback;
220
221 /* Initilize the device hid class. The class is connected with interface 2 */
222 status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry,
223 1,2, (VOID *)&hid_parameter);
224 if(status!=UX_SUCCESS)
225 {
226
227 printf("Error on line %d, error code: %d\n", __LINE__, status);
228 test_control_return(1);
229 }
230
231 /* Initialize the simulated device controller. */
232 status = _ux_dcd_sim_slave_initialize();
233
234 /* Check for error. */
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 /* Register all the USB host controllers available in this system */
243 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
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 /* Create the main host simulation thread. */
254 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
255 stack_pointer, UX_DEMO_STACK_SIZE,
256 20, 20, 1, TX_AUTO_START);
257
258 /* Check for error. */
259 if (status != TX_SUCCESS)
260 {
261
262 printf("Error on line %d, error code: %d\n", __LINE__, status);
263 test_control_return(1);
264 }
265 }
266
tx_demo_thread_host_simulation_entry(ULONG arg)267 static void tx_demo_thread_host_simulation_entry(ULONG arg)
268 {
269
270 UINT status;
271 UX_MEMORY_BLOCK *dummy_memory_block_first = (UX_MEMORY_BLOCK *)dummy_usbx_memory;
272 UX_MEMORY_BLOCK *original_memory_block = (UX_MEMORY_BLOCK*)_ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start;
273 UCHAR invalid_name[UX_HOST_CLASS_HID_MAX_CLIENT_NAME_LENGTH+2];
274
275 /* Find the HID class */
276 status = demo_class_hid_get();
277 if (status != UX_SUCCESS)
278 {
279
280 printf("Error on line %d, error code: %d\n", __LINE__, status);
281 test_control_return(1);
282 }
283
284 /**************************************************/
285 /** Test case: corrupt hid_client_name **/
286 /**************************************************/
287 _ux_utility_memory_set(invalid_name, ' ', sizeof(invalid_name));
288 _ux_utility_memory_copy(invalid_name, _ux_system_host_class_hid_client_keyboard_name, 33);
289 status = _ux_host_class_hid_client_register(invalid_name, ux_host_class_hid_keyboard_entry);
290 if (status != UX_ERROR)
291 {
292
293 printf("Error on line %d, error code: %d\n", __LINE__, status);
294 test_control_return(1);
295 }
296
297
298 /**************************************************/
299 /** Test case: class -> ux_host_class_client = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY,
300 sizeof(UX_HOST_CLASS_HID_CLIENT)*UX_HOST_CLASS_HID_MAX_CLIENTS); fails **/
301 /**************************************************/
302
303 /* Set up the dummy memory block. */
304 dummy_memory_block_first -> ux_memory_block_next = UX_NULL;
305 dummy_memory_block_first -> ux_memory_byte_pool = UX_NULL;
306 // dummy_memory_block_first -> ux_memory_block_previous = UX_NULL;
307 // dummy_memory_block_first -> ux_memory_block_status = UX_MEMORY_UNUSED;
308 // dummy_memory_block_first -> ux_memory_block_size = 0;
309 _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start = (UCHAR*)dummy_memory_block_first;
310
311 status = _ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry);
312 if (status != UX_MEMORY_INSUFFICIENT)
313 {
314
315 printf("Error on line %d, error code: %d\n", __LINE__, status);
316 test_control_return(1);
317 }
318
319 /* Restore state for next test. */
320 _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start = (UCHAR*)original_memory_block;
321
322 /* Now disconnect the device. */
323 _ux_device_stack_disconnect();
324
325 /* And deinitialize the class. */
326 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
327
328 /* Deinitialize the device side of usbx. */
329 _ux_device_stack_uninitialize();
330
331 /* And finally the usbx system resources. */
332 _ux_system_uninitialize();
333
334 /* Successful test. */
335 printf("SUCCESS!\n");
336 test_control_return(0);
337 }
338
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)339 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
340 {
341 return(UX_SUCCESS);
342 }
343
