1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Device CCID Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_ccid.h"
#include "ux_device_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_ccid_initialize PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function initializes the USB CCID device. */
/* */
/* INPUT */
/* */
/* command Pointer to ccid command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_free Free memory */
/* _ux_utility_semaphore_create Create semaphore */
/* _ux_utility_semaphore_delete Delete semaphore */
/* _ux_utility_mutex_create Create mutex */
/* _ux_device_mutex_delete Delete mutex */
/* _ux_utility_thread_create Create thread */
/* _ux_utility_thread_delete Delete thread */
/* _ux_utility_event_flags_create Create event flags */
/* _ux_utility_event_flags_delete Delete event flags */
/* */
/* CALLED BY */
/* */
/* USBX Source Code */
/* */
/**************************************************************************/
UINT _ux_device_class_ccid_initialize(UX_SLAVE_CLASS_COMMAND *command)
{
UX_DEVICE_CLASS_CCID *ccid;
UX_DEVICE_CLASS_CCID_RUNNER *runner;
UX_DEVICE_CLASS_CCID_SLOT *slot;
UX_DEVICE_CLASS_CCID_PARAMETER *ccid_parameter;
UX_SLAVE_CLASS *ccid_class;
UINT status;
ULONG memory_size;
ULONG ccid_size, runners_size, slots_size;
ULONG buffer_size, buffers_size;
UCHAR *memory;
ULONG i;
#if !defined(UX_DEVICE_STANDALONE)
ULONG stacks_size;
#endif
/* Get the class container. */
ccid_class = command -> ux_slave_class_command_class_ptr;
/* Get the pointer to the application parameters for the ccid class. */
ccid_parameter = command -> ux_slave_class_command_parameter;
/* Sanity check for parameters.
- number slots < 32
- number busy <= number slots
- message length < max request buffer size
*/
#if !defined(UX_DEVICE_STANDALONE)
UX_ASSERT(ccid_parameter -> ux_device_class_ccid_max_n_slots <= UX_DEVICE_CLASS_CCID_MAX_N_SLOTS);
UX_ASSERT(ccid_parameter -> ux_device_class_ccid_max_n_busy_slots != 0);
UX_ASSERT(ccid_parameter -> ux_device_class_ccid_max_n_busy_slots <=
ccid_parameter -> ux_device_class_ccid_max_n_slots)
#else
/* To optimize only support 1 slot. */
ccid_parameter -> ux_device_class_ccid_max_n_slots = 1;
ccid_parameter -> ux_device_class_ccid_max_n_busy_slots = 1;
#endif
UX_ASSERT(ccid_parameter -> ux_device_class_ccid_max_transfer_length <=
UX_DEVICE_CLASS_CCID_BULK_BUFFER_SIZE);
UX_ASSERT(ccid_parameter->ux_device_class_ccid_handles != UX_NULL);
/* Calculate size for instance (structures already aligned). */
/* Max n_slots 32, considering struct size, no overflow case. */
ccid_size = sizeof(UX_DEVICE_CLASS_CCID);
memory_size = ccid_size;
runners_size = sizeof(UX_DEVICE_CLASS_CCID_RUNNER);
runners_size *= ccid_parameter->ux_device_class_ccid_max_n_busy_slots;
memory_size += runners_size;
slots_size = sizeof(UX_DEVICE_CLASS_CCID_SLOT);
slots_size *= ccid_parameter->ux_device_class_ccid_max_n_slots;
memory_size += slots_size;
buffer_size = ccid_parameter->ux_device_class_ccid_max_transfer_length;
buffer_size += 3u;
buffer_size &= ~3u;
ccid_parameter->ux_device_class_ccid_max_transfer_length = buffer_size;
if (UX_OVERFLOW_CHECK_MULC_ULONG(buffer_size, 2))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
buffers_size = (buffer_size << 1) & 0xFFFFFFFFu;
if (UX_OVERFLOW_CHECK_MULV_ULONG(buffers_size, ccid_parameter->ux_device_class_ccid_max_n_busy_slots))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
buffers_size = (buffers_size * ccid_parameter->ux_device_class_ccid_max_n_busy_slots) & 0xFFFFFFFFu;
if (UX_OVERFLOW_CHECK_ADD_ULONG(memory_size, buffer_size))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
memory_size = (memory_size + buffers_size) & 0xFFFFFFFFu;
#if !defined(UX_DEVICE_STANDALONE)
/* Calculate memory size for stackes. */
stacks_size = ccid_parameter->ux_device_class_ccid_max_n_busy_slots;
if (UX_OVERFLOW_CHECK_MULC_ULONG(stacks_size, UX_DEVICE_CLASS_CCID_RUNNER_THREAD_STACK_SIZE))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
stacks_size *= UX_DEVICE_CLASS_CCID_RUNNER_THREAD_STACK_SIZE;
if (UX_OVERFLOW_CHECK_ADD_ULONG(stacks_size, UX_DEVICE_CLASS_CCID_THREAD_STACK_SIZE))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
stacks_size += UX_DEVICE_CLASS_CCID_THREAD_STACK_SIZE;
if (UX_OVERFLOW_CHECK_ADD_ULONG(stacks_size, UX_DEVICE_CLASS_CCID_NOTIFY_THREAD_STACK_SIZE))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
stacks_size += UX_DEVICE_CLASS_CCID_NOTIFY_THREAD_STACK_SIZE;
if (UX_OVERFLOW_CHECK_ADD_ULONG(memory_size, stacks_size))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_ERROR);
return(UX_ERROR);
}
memory_size = (memory_size + stacks_size) & 0xFFFFFFFFu;
#endif
/* Allocate memory for instance and other resources of the device ccid class. */
memory = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, memory_size);
/* Check for successful allocation. */
if (memory == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Create and save resources for ccid, runners, slots, buffers. */
/* CCID. */
ccid = (UX_DEVICE_CLASS_CCID *)memory;
memory += ccid_size;
#if !defined(UX_DEVICE_STANDALONE)
/* CCID thread. */
status = _ux_utility_thread_create(
&ccid -> ux_device_class_ccid_thread,
"ux_device_class_ccid_thread",
_ux_device_class_ccid_thread_entry,
(ULONG) (ALIGN_TYPE) ccid,
(VOID *) memory,
UX_DEVICE_CLASS_CCID_THREAD_STACK_SIZE, UX_THREAD_PRIORITY_CLASS,
UX_THREAD_PRIORITY_CLASS, UX_NO_TIME_SLICE, UX_DONT_START);
if (status != UX_SUCCESS)
status = UX_THREAD_ERROR;
else
{
ccid -> ux_device_class_ccid_thread_stack = memory;
memory += UX_DEVICE_CLASS_CCID_THREAD_STACK_SIZE;
UX_THREAD_EXTENSION_PTR_SET(&(ccid -> ux_device_class_ccid_thread), ccid);
}
/* CCID Notify thread. */
if (status == UX_SUCCESS)
{
status = _ux_utility_thread_create(
&ccid -> ux_device_class_ccid_notify_thread,
"ux_device_class_ccid_notify_thread",
_ux_device_class_ccid_notify_thread_entry,
(ULONG) (ALIGN_TYPE) ccid,
(VOID *) memory,
UX_DEVICE_CLASS_CCID_NOTIFY_THREAD_STACK_SIZE, UX_THREAD_PRIORITY_CLASS,
UX_THREAD_PRIORITY_CLASS, UX_NO_TIME_SLICE, UX_DONT_START);
if (status != UX_SUCCESS)
status = UX_THREAD_ERROR;
else
{
ccid -> ux_device_class_ccid_notify_thread_stack = memory;
memory += UX_DEVICE_CLASS_CCID_NOTIFY_THREAD_STACK_SIZE;
UX_THREAD_EXTENSION_PTR_SET(&(ccid -> ux_device_class_ccid_notify_thread), ccid);
}
}
#else
/* Set task function. */
ccid_class -> ux_slave_class_task_function = _ux_device_class_ccid_tasks_run;
/* By default status is OK. */
status = UX_SUCCESS;
#endif
/* CCID runners. */
if (status == UX_SUCCESS)
{
ccid -> ux_device_class_ccid_runners = (UX_DEVICE_CLASS_CCID_RUNNER *)memory;
memory += runners_size;
runner = ccid -> ux_device_class_ccid_runners;
for (i = 0; i < ccid_parameter -> ux_device_class_ccid_max_n_busy_slots; i ++)
{
/* Save CCID for runner. */
runner -> ux_device_class_ccid_runner_ccid = ccid;
/* Save runner ID. */
runner -> ux_device_class_ccid_runner_id = (CHAR)i;
/* Runner is free. */
runner -> ux_device_class_ccid_runner_slot = -1;
/* Runner command buffer. */
runner -> ux_device_class_ccid_runner_command = memory;
memory += buffer_size;
/* Runner response buffer. */
runner -> ux_device_class_ccid_runner_response = memory;
memory += buffer_size;
#if !defined(UX_DEVICE_STANDALONE)
/* CCID runners threads. */
status = _ux_utility_thread_create(
&runner -> ux_device_class_ccid_runner_thread,
"ux_device_class_ccid_runner_thread",
_ux_device_class_ccid_runner_thread_entry,
(ULONG) (ALIGN_TYPE) runner,
(VOID *)memory,
UX_DEVICE_CLASS_CCID_RUNNER_THREAD_STACK_SIZE, UX_THREAD_PRIORITY_CLASS,
UX_THREAD_PRIORITY_CLASS, UX_NO_TIME_SLICE, UX_DONT_START);
if (status != UX_SUCCESS)
{
status = UX_THREAD_ERROR;
break;
}
else
{
runner -> ux_device_class_ccid_runner_thread_stack = memory;
memory += UX_DEVICE_CLASS_CCID_RUNNER_THREAD_STACK_SIZE;
UX_THREAD_EXTENSION_PTR_SET(&(runner -> ux_device_class_ccid_runner_thread), runner);
}
#endif
/* Next runner. */
runner ++;
}
}
/* CCID slots. */
if (status == UX_SUCCESS)
{
ccid -> ux_device_class_ccid_slots = (UX_DEVICE_CLASS_CCID_SLOT *)memory;
slot = ccid -> ux_device_class_ccid_slots;
for (i = 0; i < ccid_parameter -> ux_device_class_ccid_max_n_slots; i ++)
{
/* Slot not busy. */
slot -> ux_device_class_ccid_slot_runner = -1;
/* Slot ICC no card. */
slot -> ux_device_class_ccid_slot_icc_status = UX_DEVICE_CLASS_CCID_ICC_NOT_PRESENT;
/* Next slot. */
slot ++;
}
}
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
/* Create endpoint buffers. */
UX_ASSERT(!UX_DEVICE_CLASS_CCID_ENDPOINT_BUFFER_SIZE_CALC_OVERFLOW);
ccid -> ux_device_class_ccid_endpoint_buffer = _ux_utility_memory_allocate(UX_NO_ALIGN,
UX_CACHE_SAFE_MEMORY, UX_DEVICE_CLASS_CCID_INTERRUPT_BUFFER_SIZE + UX_DEVICE_CLASS_CCID_BULK_BUFFER_SIZE * 2);
if (ccid -> ux_device_class_ccid_endpoint_buffer == UX_NULL)
status = UX_MEMORY_INSUFFICIENT;
#endif
#if !defined(UX_DEVICE_STANDALONE)
/* CCID mutexes, semaphore and event flags. */
if (status == UX_SUCCESS)
{
/* Create Event Flags. */
status = _ux_utility_event_flags_create(&ccid -> ux_device_class_ccid_events,
"ux_device_class_ccid_events");
if (status == UX_SUCCESS)
{
/* Bulk IN mutex. */
status = _ux_utility_mutex_create(&ccid -> ux_device_class_ccid_response_mutex,
"ux_device_class_ccid_response_mutex");
if (status == UX_SUCCESS)
{
/* Interrupt IN semaphore. */
status = _ux_utility_semaphore_create(&ccid -> ux_device_class_ccid_notify_semaphore,
"ux_device_class_ccid_notify_semaphore", 0);
if (status == UX_SUCCESS)
{
/* Resource access Mutex. */
status = _ux_utility_mutex_create(&ccid -> ux_device_class_ccid_mutex,
"ux_device_class_ccid_mutex");
if (status != UX_SUCCESS)
status = UX_MUTEX_ERROR;
/* If there is error, allocated semaphore should be deleted. */
if (status != UX_SUCCESS)
_ux_utility_semaphore_delete(&ccid -> ux_device_class_ccid_notify_semaphore);
}
else
status = UX_MUTEX_ERROR;
/* If there is error, allocated mutex should be deleted. */
if (status != UX_SUCCESS)
_ux_device_mutex_delete(&ccid -> ux_device_class_ccid_response_mutex);
}
else
status = UX_MUTEX_ERROR;
/* If there is error, allocated event should be deleted. */
if (status != UX_SUCCESS)
_ux_utility_event_flags_delete(&ccid -> ux_device_class_ccid_events);
}
else
status = UX_EVENT_ERROR;
}
#endif
/* Success case. */
if (status == UX_SUCCESS)
{
/* Save the address of the CDC instance inside the CDC container. */
ccid_class -> ux_slave_class_instance = (VOID *) ccid;
/* Store parameters. */
_ux_utility_memory_copy(&ccid -> ux_device_class_ccid_parameter, ccid_parameter,
sizeof(UX_DEVICE_CLASS_CCID_PARAMETER)); /* Use case of memcpy is verified. */
/* Return success status. */
return(UX_SUCCESS);
}
/* Error cases. */
/* In this case, mutexes and events are not created or has been handled. */
#if !defined(UX_DEVICE_STANDALONE)
/* Check thread states and free them. */
if (ccid -> ux_device_class_ccid_thread_stack)
_ux_utility_thread_delete(&ccid -> ux_device_class_ccid_thread);
for (i = 0; i < ccid_parameter -> ux_device_class_ccid_max_n_busy_slots; i ++)
{
runner = &ccid -> ux_device_class_ccid_runners[i];
if (runner -> ux_device_class_ccid_runner_thread_stack)
_ux_utility_thread_delete(&runner -> ux_device_class_ccid_runner_thread);
}
if (ccid -> ux_device_class_ccid_notify_thread_stack)
_ux_utility_thread_delete(&ccid -> ux_device_class_ccid_notify_thread);
#endif
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
/* Free the endpoint buffers. */
if (ccid -> ux_device_class_ccid_endpoint_buffer)
_ux_utility_memory_free(ccid -> ux_device_class_ccid_endpoint_buffer);
#endif
/* Free the memory. */
_ux_utility_memory_free(ccid);
/* Return completion status. */
return(status);
}
const UX_DEVICE_CLASS_CCID_COMMAND_SETT
_ux_device_class_ccid_command_sett[UX_DEVICE_CLASS_CCID_N_COMMANDS + 1] =
{
{0x62, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x62),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x62), 0},
{0x63, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x63),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x63), 1},
{0x65, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x65),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x65), 2},
{0x6F, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x6F),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x6F), 3},
{0x6C, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x6C),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x6C), 4},
{0x6D, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x6D),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x6D), 5},
{0x61, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x61),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x61), 6},
{0x6B, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x6B),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x6B), 7},
{0x6E, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x6E),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x6E), 8},
{0x6A, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x6A),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x6A), 9},
{0x69, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x69),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x69), 10},
{0x71, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x71),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x71), 11},
{0x72, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x72),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x72), 12},
{0x73, UX_DEVICE_CLASS_CCID_COMMAND_RESP_TYPE(0x73),
UX_DEVICE_CLASS_CCID_COMMAND_FLAGS(0x73), 13},
{0, 0, 0, -1}, /* Command not supported. */
};
|
