1
10
13
14
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
108
109
110
111
112
113
115
116
117
118
119
120
121
122
123
124
126
127
128
129
130
131
132
138
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
307
308
309
310
311
312
313
316
317
318
319
320
321
322
323
324
325
326
327
328
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
389
396
402
410
411
412
413
417
418
419
420
421
422
429
430
431
432
433
434
440
441
442
443
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
476
477
478
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
507
511
515
519
520
521
522
523
530
531
532
533
534
535
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
600
601
602
603
604
605
611
612
613
614
615
616
617
618
619
620
621
623
624
625
626
627
628
...
...
...
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_hid.h"
#include "ux_host_stack.h"
#if defined(UX_HOST_STANDALONE)
#define UX_HOST_CLASS_HID_ENUM_HID_DESC_READ (UX_STATE_WAIT)
#define UX_HOST_CLASS_HID_ENUM_HID_DESC_PARSE (UX_STATE_CLASS_STEP + 1)
#define UX_HOST_CLASS_HID_ENUM_REPORT_DESC_READ (UX_STATE_CLASS_STEP + 2)
#define UX_HOST_CLASS_HID_ENUM_REPORT_DESC_PARSE (UX_STATE_CLASS_STEP + 3)
#define UX_HOST_CLASS_HID_ENUM_CLIENT_SEARCH (UX_STATE_CLASS_STEP + 4)
#define UX_HOST_CLASS_HID_ENUM_CLIENT_ACTIVATE_WAIT (UX_STATE_CLASS_STEP + 6)
#define UX_HOST_CLASS_HID_ENUM_TRANSFER_WAIT (UX_STATE_CLASS_STEP + 7)
#define UX_HOST_CLASS_HID_ENUM_ERROR (UX_STATE_CLASS_STEP + 8)
#define UX_HOST_CLASS_HID_ENUM_DONE (UX_STATE_CLASS_STEP + 9)
9 defines
static inline UINT _ux_host_class_hid_activate_wait(UX_HOST_CLASS_COMMAND *command);/* ... */
#endif
...
...
UINT _ux_host_class_hid_entry(UX_HOST_CLASS_COMMAND *command)
{
UINT status;
INT scan_index;
UX_HOST_CLASS_HID_CLIENT *client;
UX_HOST_CLASS_HID_CLIENT_COMMAND client_command;
/* ... */
switch (command -> ux_host_class_command_request)
{
case UX_HOST_CLASS_COMMAND_QUERY:
/* ... */
if ((command -> ux_host_class_command_usage == UX_HOST_CLASS_COMMAND_USAGE_CSP) &&
(command -> ux_host_class_command_class == UX_HOST_CLASS_HID_CLASS))
return(UX_SUCCESS);
else
return(UX_NO_CLASS_MATCH);
case UX_HOST_CLASS_COMMAND_QUERY:
case UX_HOST_CLASS_COMMAND_ACTIVATE:
/* ... */
status = _ux_host_class_hid_activate(command);
return(status);
#if defined(UX_HOST_STANDALONE)case UX_HOST_CLASS_COMMAND_ACTIVATE:
case UX_HOST_CLASS_COMMAND_ACTIVATE_WAIT:
status = _ux_host_class_hid_activate_wait(command);
return(status);/* ... */
#endif
case UX_HOST_CLASS_COMMAND_ACTIVATE_WAIT:
case UX_HOST_CLASS_COMMAND_DEACTIVATE:
/* ... */
status = _ux_host_class_hid_deactivate(command);
return(status);
case UX_HOST_CLASS_COMMAND_DEACTIVATE:
case UX_HOST_CLASS_COMMAND_DESTROY:
if (command -> ux_host_class_command_class_ptr -> ux_host_class_client != UX_NULL)
{
client = command -> ux_host_class_command_class_ptr -> ux_host_class_client;
for (scan_index = 0; scan_index < UX_HOST_CLASS_HID_MAX_CLIENTS; scan_index ++)
{
client_command.ux_host_class_hid_client_command_request = UX_HOST_CLASS_COMMAND_DESTROY;
client_command.ux_host_class_hid_client_command_container = (VOID *)command -> ux_host_class_command_class_ptr;
client -> ux_host_class_hid_client_handler(&client_command);
}for (scan_index = 0; scan_index < UX_HOST_CLASS_HID_MAX_CLIENTS; scan_index ++) { ... }
_ux_utility_memory_free(command -> ux_host_class_command_class_ptr -> ux_host_class_client);
command -> ux_host_class_command_class_ptr -> ux_host_class_client = UX_NULL;
}if (command -> ux_host_class_command_class_ptr -> ux_host_class_client != UX_NULL) { ... }
return(UX_SUCCESS);
case UX_HOST_CLASS_COMMAND_DESTROY:
default:
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_FUNCTION_NOT_SUPPORTED);
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_FUNCTION_NOT_SUPPORTED);default
}switch (command -> ux_host_class_command_request) { ... }
}{ ... }
#if defined(UX_HOST_STANDALONE)
static inline VOID _ux_host_class_hid_descriptor_read(UX_HOST_CLASS_HID *hid)
{
UX_INTERFACE *interface;
UX_CONFIGURATION *configuration;
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
control_endpoint = &hid -> ux_host_class_hid_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
interface = hid -> ux_host_class_hid_interface;
configuration = interface -> ux_interface_configuration;
hid -> ux_host_class_hid_allocated = _ux_utility_memory_allocate(
UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY,
configuration -> ux_configuration_descriptor.wTotalLength);
if (hid -> ux_host_class_hid_allocated == UX_NULL)
{
hid -> ux_host_class_hid_status = UX_MEMORY_INSUFFICIENT;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_ERROR;
return;
}if (hid -> ux_host_class_hid_allocated == UX_NULL) { ... }
transfer_request -> ux_transfer_request_data_pointer = hid -> ux_host_class_hid_allocated;
transfer_request -> ux_transfer_request_requested_length = configuration -> ux_configuration_descriptor.wTotalLength;
transfer_request -> ux_transfer_request_function = UX_GET_DESCRIPTOR;
transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_STANDARD | UX_REQUEST_TARGET_DEVICE;
transfer_request -> ux_transfer_request_value = UX_CONFIGURATION_DESCRIPTOR_ITEM << 8;
transfer_request -> ux_transfer_request_index = 0;
UX_TRANSFER_STATE_RESET(transfer_request);
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_TRANSFER_WAIT;
hid -> ux_host_class_hid_next_state = UX_HOST_CLASS_HID_ENUM_HID_DESC_PARSE;
}_ux_host_class_hid_descriptor_read (UX_HOST_CLASS_HID *hid) { ... }
static inline VOID _ux_host_class_hid_report_descriptor_read(UX_HOST_CLASS_HID *hid)
{
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
control_endpoint = &hid -> ux_host_class_hid_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
hid -> ux_host_class_hid_allocated = _ux_utility_memory_allocate(
UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY,
hid -> ux_host_class_hid_descriptor.wItemLength);
if (hid -> ux_host_class_hid_allocated == UX_NULL)
{
hid -> ux_host_class_hid_status = UX_MEMORY_INSUFFICIENT;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_ERROR;
return;
}if (hid -> ux_host_class_hid_allocated == UX_NULL) { ... }
transfer_request -> ux_transfer_request_data_pointer = hid -> ux_host_class_hid_allocated;
transfer_request -> ux_transfer_request_requested_length = hid -> ux_host_class_hid_descriptor.wItemLength;
transfer_request -> ux_transfer_request_function = UX_GET_DESCRIPTOR;
transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_STANDARD | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = UX_HOST_CLASS_HID_REPORT_DESCRIPTOR << 8;
transfer_request -> ux_transfer_request_index = hid -> ux_host_class_hid_interface -> ux_interface_descriptor.bInterfaceNumber;
UX_TRANSFER_STATE_RESET(transfer_request);
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_TRANSFER_WAIT;
hid -> ux_host_class_hid_next_state = UX_HOST_CLASS_HID_ENUM_REPORT_DESC_PARSE;
}_ux_host_class_hid_report_descriptor_read (UX_HOST_CLASS_HID *hid) { ... }
static inline VOID _ux_host_class_hid_hid_descriptor_parse(UX_HOST_CLASS_HID *hid)
{
UX_DEVICE *device;
UX_TRANSFER *transfer;
UCHAR *descriptor;
UINT descriptor_length;
UINT descriptor_type;
UINT descriptor_2;
ULONG total_length;
ULONG interface_number;
UINT interface_found = UX_FALSE;
device = hid -> ux_host_class_hid_device;
transfer = &device -> ux_device_control_endpoint.ux_endpoint_transfer_request;
interface_number = hid -> ux_host_class_hid_interface ->
ux_interface_descriptor.bInterfaceNumber;
descriptor = transfer -> ux_transfer_request_data_pointer;
total_length = transfer -> ux_transfer_request_actual_length;
/* ... */
while(total_length)
{
descriptor_length = *descriptor;
descriptor_type = *(descriptor + 1);
descriptor_2 = *(descriptor + 2);
if (descriptor_length < 3)
break;
switch(descriptor_type)
{
case UX_INTERFACE_DESCRIPTOR_ITEM:
interface_found = (interface_number == descriptor_2) ? UX_TRUE : UX_FALSE;
break;
case UX_INTERFACE_DESCRIPTOR_ITEM:
case UX_HOST_CLASS_HID_DESCRIPTOR:
if (!interface_found)
break;
/* ... */
_ux_utility_descriptor_parse(descriptor,
_ux_system_hid_descriptor_structure, UX_HID_DESCRIPTOR_ENTRIES,
(UCHAR *) &hid -> ux_host_class_hid_descriptor);
_ux_utility_memory_free(hid -> ux_host_class_hid_allocated);
hid -> ux_host_class_hid_allocated = UX_NULL;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_REPORT_DESC_READ;
return;
case UX_HOST_CLASS_HID_DESCRIPTOR:
default:
break;default
}switch (descriptor_type) { ... }
if (descriptor_length > total_length)
break;
descriptor += descriptor_length;
total_length -= descriptor_length;
}while (total_length) { ... }
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_DESCRIPTOR_CORRUPTED);
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_DESCRIPTOR_CORRUPTED, descriptor, 0, 0, UX_TRACE_ERRORS, 0, 0)
hid -> ux_host_class_hid_status = UX_DESCRIPTOR_CORRUPTED;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_ERROR;
}_ux_host_class_hid_hid_descriptor_parse (UX_HOST_CLASS_HID *hid) { ... }
static inline VOID _ux_host_class_hid_report_descriptor_parse(UX_HOST_CLASS_HID *hid)
{
UX_DEVICE *device;
UX_TRANSFER *transfer;
UCHAR *descriptor;
ULONG length;
UX_HOST_CLASS_HID_ITEM item;
UINT status;
device = hid -> ux_host_class_hid_device;
transfer = &device -> ux_device_control_endpoint.ux_endpoint_transfer_request;
descriptor = hid -> ux_host_class_hid_allocated;
length = transfer -> ux_transfer_request_actual_length;
while (length)
{
_ux_host_class_hid_report_item_analyse(descriptor, &item);
descriptor += item.ux_host_class_hid_item_report_format;
switch (item.ux_host_class_hid_item_report_type)
{
case UX_HOST_CLASS_HID_TYPE_GLOBAL:
status = _ux_host_class_hid_global_item_parse(hid, &item, descriptor);
break;
case UX_HOST_CLASS_HID_TYPE_GLOBAL:
case UX_HOST_CLASS_HID_TYPE_MAIN:
status = _ux_host_class_hid_main_item_parse(hid, &item, descriptor);
break;
case UX_HOST_CLASS_HID_TYPE_MAIN:
case UX_HOST_CLASS_HID_TYPE_LOCAL:
status = _ux_host_class_hid_local_item_parse(hid, &item, descriptor);
break;
case UX_HOST_CLASS_HID_TYPE_LOCAL:
default:
/* ... */
status = UX_DESCRIPTOR_CORRUPTED;
break;default
}switch (item.ux_host_class_hid_item_report_type) { ... }
if (status != UX_SUCCESS)
{
break;
}if (status != UX_SUCCESS) { ... }
descriptor += item.ux_host_class_hid_item_report_length;
if (length < item.ux_host_class_hid_item_report_length)
{
status = (UX_DESCRIPTOR_CORRUPTED);
break;
}if (length < item.ux_host_class_hid_item_report_length) { ... }
length -= (ULONG)(item.ux_host_class_hid_item_report_length + item.ux_host_class_hid_item_report_format);
}while (length) { ... }
if (status != UX_SUCCESS)
{
hid -> ux_host_class_hid_status = status;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_ERROR;
return;
}if (status != UX_SUCCESS) { ... }
status = _ux_host_class_hid_interrupt_endpoint_search(hid);
if (status != UX_SUCCESS)
{
hid -> ux_host_class_hid_status = status;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_ERROR;
return;
}if (status != UX_SUCCESS) { ... }
_ux_utility_memory_free(hid -> ux_host_class_hid_allocated);
hid -> ux_host_class_hid_allocated = UX_NULL;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_CLIENT_SEARCH;
}_ux_host_class_hid_report_descriptor_parse (UX_HOST_CLASS_HID *hid) { ... }
static inline VOID _ux_host_class_hid_client_activate_wait(UX_HOST_CLASS_HID *hid)
{
UX_HOST_CLASS_HID_CLIENT_COMMAND hid_client_command;
UINT status;
hid_client_command.ux_host_class_hid_client_command_instance = hid;
hid_client_command.ux_host_class_hid_client_command_request = UX_HOST_CLASS_COMMAND_ACTIVATE_WAIT;
status = hid -> ux_host_class_hid_client -> ux_host_class_hid_client_handler(&hid_client_command);
if (status < UX_STATE_NEXT)
{
hid -> ux_host_class_hid_client = UX_NULL;
hid -> ux_host_class_hid_status = UX_DEVICE_ENUMERATION_FAILURE;
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_ERROR;
return;
}if (status < UX_STATE_NEXT) { ... }
if (status == UX_STATE_NEXT)
{
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_DONE;
return;
}if (status == UX_STATE_NEXT) { ... }
return;
}_ux_host_class_hid_client_activate_wait (UX_HOST_CLASS_HID *hid) { ... }
static inline UINT _ux_host_class_hid_activate_wait(UX_HOST_CLASS_COMMAND *command)
{
UX_INTERFACE *interface;
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer;
UX_HOST_CLASS_HID *hid;
UINT status;
interface = (UX_INTERFACE *)command -> ux_host_class_command_container;
hid = (UX_HOST_CLASS_HID *) interface -> ux_interface_class_instance;
switch(hid -> ux_host_class_hid_enum_state)
{
case UX_HOST_CLASS_HID_ENUM_HID_DESC_READ :
_ux_host_class_hid_descriptor_read(hid);
break;
case UX_HOST_CLASS_HID_ENUM_HID_DESC_READ :
case UX_HOST_CLASS_HID_ENUM_HID_DESC_PARSE :
_ux_host_class_hid_hid_descriptor_parse(hid);
break;
case UX_HOST_CLASS_HID_ENUM_HID_DESC_PARSE :
case UX_HOST_CLASS_HID_ENUM_REPORT_DESC_READ :
_ux_host_class_hid_report_descriptor_read(hid);
break;
case UX_HOST_CLASS_HID_ENUM_REPORT_DESC_READ :
case UX_HOST_CLASS_HID_ENUM_REPORT_DESC_PARSE :
_ux_host_class_hid_report_descriptor_parse(hid);
break;
case UX_HOST_CLASS_HID_ENUM_REPORT_DESC_PARSE :
case UX_HOST_CLASS_HID_ENUM_CLIENT_SEARCH :
status = _ux_host_class_hid_client_search(hid);
if (status != UX_SUCCESS)
{
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_DONE;
break;
}if (status != UX_SUCCESS) { ... }
hid -> ux_host_class_hid_enum_state = UX_HOST_CLASS_HID_ENUM_CLIENT_ACTIVATE_WAIT;
case UX_HOST_CLASS_HID_ENUM_CLIENT_SEARCH :
case UX_HOST_CLASS_HID_ENUM_CLIENT_ACTIVATE_WAIT :
_ux_host_class_hid_client_activate_wait(hid);
break;
case UX_HOST_CLASS_HID_ENUM_CLIENT_ACTIVATE_WAIT :
case UX_HOST_CLASS_HID_ENUM_TRANSFER_WAIT :
control_endpoint = &hid -> ux_host_class_hid_device -> ux_device_control_endpoint;
transfer = &control_endpoint -> ux_endpoint_transfer_request;
status = _ux_host_stack_transfer_run(transfer);
if (status <= UX_STATE_NEXT)
{
if (transfer -> ux_transfer_request_completion_code != UX_SUCCESS)
{
hid -> ux_host_class_hid_status = transfer -> ux_transfer_request_completion_code;
hid -> ux_host_class_hid_enum_state = UX_STATE_EXIT;
break;
}if (transfer -> ux_transfer_request_completion_code != UX_SUCCESS) { ... }
hid -> ux_host_class_hid_enum_state = hid -> ux_host_class_hid_next_state;
break;
}if (status <= UX_STATE_NEXT) { ... }
break;
case UX_HOST_CLASS_HID_ENUM_TRANSFER_WAIT :
case UX_HOST_CLASS_HID_ENUM_ERROR :
if (hid -> ux_host_class_hid_interrupt_endpoint &&
hid -> ux_host_class_hid_interrupt_endpoint -> ux_endpoint_transfer_request.ux_transfer_request_data_pointer)
_ux_utility_memory_free(hid -> ux_host_class_hid_interrupt_endpoint -> ux_endpoint_transfer_request.ux_transfer_request_data_pointer);
_ux_host_class_hid_instance_clean(hid);
_ux_host_stack_class_instance_destroy(hid -> ux_host_class_hid_class, (VOID *) hid);
interface -> ux_interface_class_instance = UX_NULL;
if (hid -> ux_host_class_hid_allocated)
_ux_utility_memory_free(hid -> ux_host_class_hid_allocated);
_ux_utility_memory_free(hid);
return(UX_STATE_NEXT);
case UX_HOST_CLASS_HID_ENUM_ERROR :
case UX_HOST_CLASS_HID_ENUM_DONE :
if (hid -> ux_host_class_hid_allocated)
{
_ux_utility_memory_free(hid -> ux_host_class_hid_allocated);
hid -> ux_host_class_hid_allocated = UX_NULL;
}if (hid -> ux_host_class_hid_allocated) { ... }
hid -> ux_host_class_hid_state = UX_HOST_CLASS_INSTANCE_LIVE;
if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
{
_ux_system_host -> ux_system_host_change_function(UX_DEVICE_INSERTION, hid -> ux_host_class_hid_class, (VOID *) hid);
}if (_ux_system_host -> ux_system_host_change_function != UX_NULL) { ... }
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_HID_ACTIVATE, hid, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, hid, 0, 0, 0)
hid -> ux_host_class_hid_enum_state = UX_STATE_IDLE;
return(UX_STATE_NEXT);
case UX_HOST_CLASS_HID_ENUM_DONE :
default:
return(UX_STATE_NEXT);default
}switch (hid -> ux_host_class_hid_enum_state) { ... }
return(UX_STATE_WAIT);
}_ux_host_class_hid_activate_wait (UX_HOST_CLASS_COMMAND *command) { ... }
/* ... */#endif...