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 
error_callback(UINT system_level,UINT system_context,UINT error_code)143 static VOID error_callback(UINT system_level, UINT system_context, UINT error_code)
144 {
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_ux_host_class_hid_deactivate_test3_application_define(void *first_unused_memory)
153 #endif
154 {
155 
156 UINT                            status;
157 CHAR *                          stack_pointer;
158 CHAR *                          memory_pointer;
159 
160 
161     /* Inform user.  */
162     printf("Running ux_host_class_hid_deactivate Test 3......................... ");
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, error code: %d\n", __LINE__, status);
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, error code: %d\n", __LINE__, status);
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, error code: %d\n", __LINE__, status);
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, error code: %d\n", __LINE__, status);
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, error code: %d\n", __LINE__, status);
233         test_control_return(1);
234     }
235 
236     /* Initialize the simulated device controller.  */
237     status =  _ux_dcd_sim_slave_initialize();
238 
239     /* Check for error.  */
240     if (status != UX_SUCCESS)
241     {
242 
243         printf("Error on line %d, error code: %d\n", __LINE__, status);
244         test_control_return(1);
245     }
246 
247     /* Register all the USB host controllers available in this system */
248     status =  ux_host_stack_hcd_register(_ux_system_host_hcd_simulator_name, ux_hcd_sim_host_initialize,0,0);
249 
250     /* Check for error.  */
251     if (status != UX_SUCCESS)
252     {
253 
254         printf("Error on line %d, error code: %d\n", __LINE__, status);
255         test_control_return(1);
256     }
257 
258     /* Create the main host simulation thread.  */
259     status =  tx_thread_create(&tx_demo_thread_host_simulation, "tx demo host simulation", tx_demo_thread_host_simulation_entry, 0,
260             stack_pointer, UX_DEMO_STACK_SIZE,
261             20, 20, 1, TX_AUTO_START);
262 
263     /* Check for error.  */
264     if (status != TX_SUCCESS)
265     {
266 
267         printf("Error on line %d, error code: %d\n", __LINE__, status);
268         test_control_return(1);
269     }
270 }
271 
tx_demo_thread_host_simulation_entry(ULONG arg)272 static void  tx_demo_thread_host_simulation_entry(ULONG arg)
273 {
274 
275 UINT                                status;
276 UX_HOST_CLASS_HID_KEYBOARD         *keyboard;
277 UX_HOST_CLASS_COMMAND               command;
278 
279 
280     /* Find the HID class */
281     status = demo_class_hid_get();
282     if (status != UX_SUCCESS)
283     {
284 
285         printf("Error on line %d, error code: %d\n", __LINE__, status);
286         test_control_return(1);
287     }
288 
289     /* Get the HID client */
290     hid_client = hid -> ux_host_class_hid_client;
291 
292     /* Check if the instance of the keyboard is live */
293     while (hid_client -> ux_host_class_hid_client_local_instance == UX_NULL)
294         tx_thread_sleep(10);
295 
296     /* Get the keyboard instance */
297     keyboard =  (UX_HOST_CLASS_HID_KEYBOARD *)hid_client -> ux_host_class_hid_client_local_instance;
298 
299     /**************************************************/
300     /** Test case: _ux_utility_semaphore_get(&hid -> ux_host_class_hid_semaphore, UX_WAIT_FOREVER); fails **/
301     /**************************************************/
302 
303     command.ux_host_class_command_instance = hid;
304 
305     /* Make sure it fails. */
306     hid -> ux_host_class_hid_semaphore.tx_semaphore_id++;
307 
308     status = _ux_host_class_hid_deactivate(&command);
309     if(status != TX_SEMAPHORE_ERROR)
310     {
311 
312         printf("Error on line %d, error code: %d\n", __LINE__, status);
313         test_control_return(1);
314     }
315 
316     /* Restore state. */
317     hid -> ux_host_class_hid_semaphore.tx_semaphore_id--;
318 
319     /* Now disconnect the device.  */
320     _ux_device_stack_disconnect();
321 
322     /* And deinitialize the class.  */
323     status =  ux_device_stack_class_unregister(_ux_system_slave_class_hid_name, ux_device_class_hid_entry);
324 
325     /* Deinitialize the device side of usbx.  */
326     _ux_device_stack_uninitialize();
327 
328     /* And finally the usbx system resources.  */
329     _ux_system_uninitialize();
330 
331     /* Successful test.  */
332     printf("SUCCESS!\n");
333     test_control_return(0);
334 }
335 
demo_thread_hid_callback(UX_SLAVE_CLASS_HID * class,UX_SLAVE_CLASS_HID_EVENT * event)336 static UINT    demo_thread_hid_callback(UX_SLAVE_CLASS_HID *class, UX_SLAVE_CLASS_HID_EVENT *event)
337 {
338     return(UX_SUCCESS);
339 }
340