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
|
/***************************************************************************
* 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 CDC ACM Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_cdc_acm.h"
#include "ux_device_stack.h"
#if UX_OVERFLOW_CHECK_MULC_ULONG(UX_THREAD_STACK_SIZE, 2)
#error UX_THREAD_STACK_SIZE too large
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_cdc_acm_initialize PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function initializes the USB CDC device. */
/* */
/* INPUT */
/* */
/* command Pointer to cdc acm command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_free Free memory */
/* _ux_utility_mutex_create Create mutex */
/* _ux_device_mutex_delete Delete mutex */
/* */
/* CALLED BY */
/* */
/* USBX Source Code */
/* */
/**************************************************************************/
UINT _ux_device_class_cdc_acm_initialize(UX_SLAVE_CLASS_COMMAND *command)
{
UX_SLAVE_CLASS_CDC_ACM *cdc_acm;
UX_SLAVE_CLASS_CDC_ACM_PARAMETER *cdc_acm_parameter;
UX_SLAVE_CLASS *class_ptr;
#if !defined(UX_DEVICE_STANDALONE)
UINT status;
#endif
/* Get the class container. */
class_ptr = command -> ux_slave_class_command_class_ptr;
/* Create an instance of the device cdc_acm class. */
cdc_acm = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_SLAVE_CLASS_CDC_ACM));
/* Check for successful allocation. */
if (cdc_acm == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Save the address of the CDC instance inside the CDC container. */
class_ptr -> ux_slave_class_instance = (VOID *) cdc_acm;
/* Get the pointer to the application parameters for the cdc_acm class. */
cdc_acm_parameter = command -> ux_slave_class_command_parameter;
/* Store the start and stop signals if needed by the application. */
cdc_acm -> ux_slave_class_cdc_acm_parameter.ux_slave_class_cdc_acm_instance_activate = cdc_acm_parameter -> ux_slave_class_cdc_acm_instance_activate;
cdc_acm -> ux_slave_class_cdc_acm_parameter.ux_slave_class_cdc_acm_instance_deactivate = cdc_acm_parameter -> ux_slave_class_cdc_acm_instance_deactivate;
cdc_acm -> ux_slave_class_cdc_acm_parameter.ux_slave_class_cdc_acm_parameter_change = cdc_acm_parameter -> ux_slave_class_cdc_acm_parameter_change;
#if defined(UX_DEVICE_CLASS_CDC_ACM_OWN_ENDPOINT_BUFFER)
/* Allocate the buffer for the CDC ACM endpoints. */
UX_ASSERT(!UX_DEVICE_CLASS_CDC_ACM_ENDPOINT_BUFFER_SIZE_CALC_OVERFLOW);
cdc_acm -> ux_device_class_cdc_acm_endpoint_buffer = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY,
UX_DEVICE_CLASS_CDC_ACM_ENDPOINT_BUFFER_SIZE);
if (cdc_acm -> ux_device_class_cdc_acm_endpoint_buffer == UX_NULL)
{
/* Free the resources. */
_ux_utility_memory_free(cdc_acm);
/* Return fatal error. */
return(UX_MEMORY_INSUFFICIENT);
}
#endif
#if !defined(UX_DEVICE_STANDALONE)
/* Create the Mutex for each endpoint as multiple threads cannot access each pipe at the same time. */
status = _ux_utility_mutex_create(&cdc_acm -> ux_slave_class_cdc_acm_endpoint_in_mutex, "ux_slave_class_cdc_acm_in_mutex");
/* Check Mutex creation error. */
if(status != UX_SUCCESS)
{
/* Free the resources. */
#if defined(UX_DEVICE_CLASS_CDC_ACM_OWN_ENDPOINT_BUFFER)
_ux_utility_memory_free(cdc_acm -> ux_device_class_cdc_acm_endpoint_buffer);
#endif
_ux_utility_memory_free(cdc_acm);
/* Return fatal error. */
return(UX_MUTEX_ERROR);
}
/* Out Mutex. */
status = _ux_utility_mutex_create(&cdc_acm -> ux_slave_class_cdc_acm_endpoint_out_mutex, "ux_slave_class_cdc_acm_out_mutex");
/* Check Mutex creation error. */
if(status != UX_SUCCESS)
{
/* Delete the endpoint IN mutex. */
_ux_device_mutex_delete(&cdc_acm -> ux_slave_class_cdc_acm_endpoint_in_mutex);
/* Free the resources. */
#if defined(UX_DEVICE_CLASS_CDC_ACM_OWN_ENDPOINT_BUFFER)
_ux_utility_memory_free(cdc_acm -> ux_device_class_cdc_acm_endpoint_buffer);
#endif
_ux_utility_memory_free(cdc_acm);
/* Return fatal error. */
return(UX_MUTEX_ERROR);
}
#endif
/* Update the line coding fields with default values. */
cdc_acm -> ux_slave_class_cdc_acm_baudrate = UX_SLAVE_CLASS_CDC_ACM_LINE_CODING_BAUDRATE;
cdc_acm -> ux_slave_class_cdc_acm_stop_bit = UX_SLAVE_CLASS_CDC_ACM_LINE_CODING_STOP_BIT;
cdc_acm -> ux_slave_class_cdc_acm_parity = UX_SLAVE_CLASS_CDC_ACM_LINE_CODING_PARITY;
cdc_acm -> ux_slave_class_cdc_acm_data_bit = UX_SLAVE_CLASS_CDC_ACM_LINE_CODING_DATA_BIT;
/* Initialize break duration. */
cdc_acm -> ux_slave_class_cdc_acm_break_duration = 0;
#ifndef UX_DEVICE_CLASS_CDC_ACM_TRANSMISSION_DISABLE
#if defined(UX_DEVICE_STANDALONE)
/* Set task function. */
class_ptr -> ux_slave_class_task_function = _ux_device_class_cdc_acm_tasks_run;
#else
/* We need to prepare the 2 threads for sending and receiving. */
/* Allocate some memory for the bulk out and in thread stack. */
cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE * 2);
/* Check for successful allocation. */
if (cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread_stack == UX_NULL)
/* Return the status to the caller. */
status = (UX_MEMORY_INSUFFICIENT);
/* If success, go on to create event flags. */
if (status == UX_SUCCESS)
{
/* Allocate some memory for the bulk in thread stack. */
cdc_acm -> ux_slave_class_cdc_acm_bulkin_thread_stack =
cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread_stack + UX_THREAD_STACK_SIZE;
/* Create a event flag group for the cdc_acm class to synchronize with the application writing event . */
status = _ux_utility_event_flags_create(
&cdc_acm -> ux_slave_class_cdc_acm_event_flags_group,
"ux_device_class_cdc_acm_event_flag");
/* Check status. */
if (status != UX_SUCCESS)
{
status = (UX_EVENT_ERROR);
}
}
/* If success, go on to create bulkin thread. */
if (status == UX_SUCCESS)
{
/* Bulk endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the cdc_acm instance to the new thread. This thread
does not start until we have a instance of the class. */
status = _ux_utility_thread_create(
&cdc_acm -> ux_slave_class_cdc_acm_bulkin_thread,
"ux_slave_class_cdc_acm_bulkin_thread",
_ux_device_class_cdc_acm_bulkin_thread,
(ULONG) (ALIGN_TYPE) cdc_acm,
(VOID *) cdc_acm -> ux_slave_class_cdc_acm_bulkin_thread_stack,
UX_THREAD_STACK_SIZE, UX_THREAD_PRIORITY_CLASS,
UX_THREAD_PRIORITY_CLASS, UX_NO_TIME_SLICE, UX_DONT_START);
/* Check the creation of this thread. */
if (status != UX_SUCCESS)
{
status = (UX_THREAD_ERROR);
}
else
{
UX_THREAD_EXTENSION_PTR_SET(
&(cdc_acm -> ux_slave_class_cdc_acm_bulkin_thread), cdc_acm)
}
}
/* If success, go on to create bulkout thread. */
if (status == UX_SUCCESS)
{
/* Bulk endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the cdc_acm instance to the new thread. This thread
does not start until we have a instance of the class. */
status = _ux_utility_thread_create(
&cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread,
"ux_slave_class_cdc_acm_bulkout_thread",
_ux_device_class_cdc_acm_bulkout_thread,
(ULONG) (ALIGN_TYPE) cdc_acm,
(VOID *) cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread_stack,
UX_THREAD_STACK_SIZE, UX_THREAD_PRIORITY_CLASS,
UX_THREAD_PRIORITY_CLASS, UX_NO_TIME_SLICE, UX_DONT_START);
/* Check the creation of this thread. */
if (status != UX_SUCCESS)
{
status = (UX_THREAD_ERROR);
}
else
{
UX_THREAD_EXTENSION_PTR_SET(
&(cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread), cdc_acm)
}
}
/* Check error. */
if (status != UX_SUCCESS)
{
/* Free resources and return error. */
if (_ux_device_thread_created(&cdc_acm -> ux_slave_class_cdc_acm_bulkin_thread))
_ux_utility_thread_delete(&cdc_acm -> ux_slave_class_cdc_acm_bulkin_thread);
if (_ux_device_event_flags_created(&cdc_acm -> ux_slave_class_cdc_acm_event_flags_group))
_ux_utility_event_flags_delete(&cdc_acm -> ux_slave_class_cdc_acm_event_flags_group);
if (cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread_stack)
_ux_utility_memory_free(cdc_acm -> ux_slave_class_cdc_acm_bulkout_thread_stack);
_ux_device_mutex_delete(&cdc_acm -> ux_slave_class_cdc_acm_endpoint_in_mutex);
_ux_device_mutex_delete(&cdc_acm -> ux_slave_class_cdc_acm_endpoint_out_mutex);
#if defined(UX_DEVICE_CLASS_CDC_ACM_OWN_ENDPOINT_BUFFER)
_ux_utility_memory_free(cdc_acm -> ux_device_class_cdc_acm_endpoint_buffer);
#endif
_ux_utility_memory_free(cdc_acm);
return(status);
}
#endif
#endif
/* Return completion status. */
return(UX_SUCCESS);
}
|
