1 /* This test ensures that the parser handles the example keybrd report descriptor
2 from the USB HID report descriptor tool. */
3
4 #include "usbx_test_common_hid.h"
5 #include "ux_host_class_hid_keyboard.h"
6
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
error_callback(UINT system_level,UINT system_context,UINT error_code)139 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
140 {
141
142 /* Failed test. */
143 printf("Error on line %d, system_level: %d, system_context: %d, error code: %d\n", __LINE__, system_level, system_context, error_code);
144 test_control_return(1);
145 }
146
147 /* Define what the initial system looks like. */
148
149 #ifdef CTEST
test_application_define(void * first_unused_memory)150 void test_application_define(void *first_unused_memory)
151 #else
152 void usbx_hid_report_descriptor_example_keybrd_test_application_define(void *first_unused_memory)
153 #endif
154 {
155
156 UINT status;
157 CHAR * stack_pointer;
158 CHAR * memory_pointer;
159 UINT descriptor_size = HID_REPORT_LENGTH;
160
161 /* Inform user. */
162 printf("Running HID Report Descriptor Example keybrd Test................... ");
163
164 /* Initialize the free memory pointer */
165 stack_pointer = (CHAR *) usbx_memory;
166 memory_pointer = stack_pointer + (UX_DEMO_STACK_SIZE * 2);
167
168 /* Initialize USBX. Memory */
169 status = ux_system_initialize(memory_pointer, UX_DEMO_MEMORY_SIZE, UX_NULL,0);
170
171 /* Check for error. */
172 if (status != UX_SUCCESS)
173 {
174
175 printf("Error on line %d\n", __LINE__);
176 test_control_return(1);
177 }
178
179 /* Register the error callback. */
180 _ux_utility_error_callback_register(error_callback);
181
182 /* The code below is required for installing the host portion of USBX */
183 status = ux_host_stack_initialize(UX_NULL);
184 if (status != UX_SUCCESS)
185 {
186
187 printf("Error on line %d\n", __LINE__);
188 test_control_return(1);
189 }
190
191 status = ux_host_stack_class_register(_ux_system_host_class_hid_name, ux_host_class_hid_entry);
192 if (status != UX_SUCCESS)
193 {
194
195 printf("Error on line %d\n", __LINE__);
196 test_control_return(1);
197 }
198
199 /* Register the HID client(s). */
200 status = ux_host_class_hid_client_register(_ux_system_host_class_hid_client_keyboard_name, ux_host_class_hid_keyboard_entry);
201 if (status != UX_SUCCESS)
202 {
203
204 printf("Error on line %d, error code: %d\n", __LINE__, status);
205 test_control_return(1);
206 }
207
208 /* The code below is required for installing the device portion of USBX. No call back for
209 device status change in this example. */
210 status = ux_device_stack_initialize(device_framework_high_speed, DEVICE_FRAMEWORK_LENGTH_HIGH_SPEED,
211 device_framework_full_speed, DEVICE_FRAMEWORK_LENGTH_FULL_SPEED,
212 string_framework, STRING_FRAMEWORK_LENGTH,
213 language_id_framework, LANGUAGE_ID_FRAMEWORK_LENGTH,UX_NULL);
214 if(status!=UX_SUCCESS)
215 {
216
217 printf("Error on line %d\n", __LINE__);
218 test_control_return(1);
219 }
220
221 /* Initialize the hid class parameters. */
222 hid_parameter.ux_device_class_hid_parameter_report_address = hid_report_descriptor;
223 hid_parameter.ux_device_class_hid_parameter_report_length = HID_REPORT_LENGTH;
224 hid_parameter.ux_device_class_hid_parameter_callback = demo_thread_hid_callback;
225
226 /* Initilize the device hid class. The class is connected with interface 2 */
227 status = ux_device_stack_class_register(_ux_system_slave_class_hid_name, ux_device_class_hid_entry,
228 1,2, (VOID *)&hid_parameter);
229 if(status!=UX_SUCCESS)
230 {
231
232 printf("Error on line %d\n", __LINE__);
233 test_control_return(1);
234 }
235
236
237 /* Initialize the simulated device controller. */
238 status = _ux_dcd_sim_slave_initialize();
239
240 /* Check for error. */
241 if (status != UX_SUCCESS)
242 {
243
244 printf("Error on line %d\n", __LINE__);
245 test_control_return(1);
246 }
247
248 /* Register all the USB host controllers available in this system */
249 status = ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
250
251 /* Check for error. */
252 if (status != UX_SUCCESS)
253 {
254
255 printf("Error on line %d\n", __LINE__);
256 test_control_return(1);
257 }
258
259 /* Create the main host simulation thread. */
260 status = tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
261 stack_pointer, UX_DEMO_STACK_SIZE,
262 20, 20, 1, TX_AUTO_START);
263
264 /* Check for error. */
265 if (status != TX_SUCCESS)
266 {
267
268 printf("Error on line %d\n", __LINE__);
269 test_control_return(1);
270 }
271 }
272
273
tx_demo_thread_host_simulation_entry(ULONG arg)274 static void tx_demo_thread_host_simulation_entry(ULONG arg)
275 {
276
277 UINT status;
278 UX_HOST_CLASS_HID_REPORT_GET_ID report_id;
279
280
281 /* Find the HID class */
282 status = demo_class_hid_get();
283 if (status != UX_SUCCESS)
284 {
285
286 printf("Error on line %d\n", __LINE__);
287 test_control_return(1);
288 }
289
290 /* Get the input report descriptor. */
291 report_id.ux_host_class_hid_report_get_report = UX_NULL;
292 report_id.ux_host_class_hid_report_get_type = UX_HOST_CLASS_HID_REPORT_TYPE_INPUT;
293 status = ux_host_class_hid_report_id_get(hid, &report_id);
294 if (status != UX_SUCCESS)
295 {
296
297 printf("Error on line %d\n", __LINE__);
298 test_control_return(1);
299 }
300
301 /* Do minimal error-checking. */
302 if (report_id.ux_host_class_hid_report_get_report == UX_NULL)
303 {
304
305 printf("Error on line %d\n", __LINE__);
306 test_control_return(1);
307 }
308
309 /* Now disconnect the device. */
310 _ux_device_stack_disconnect();
311
312 /* And deinitialize the class. */
313 status = ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
314
315 /* Deinitialize the device side of usbx. */
316 _ux_device_stack_uninitialize();
317
318 /* And finally the usbx system resources. */
319 _ux_system_uninitialize();
320
321 /* Successful test. */
322 printf("SUCCESS!\n");
323 test_control_return(0);
324 }
325
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)326 static UINT demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
327 {
328 return(UX_SUCCESS);
329 }
330
