Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
usbx![]()
common/usbx_device_classes/src/ux_device_class_cdc_ecm_initialize.c
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
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Device CDC_ECM Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_cdc_ecm.h"
#include "ux_device_stack.h"
UX_DEVICE_CLASS_CDC_ECM_NX_ETHERNET_POOL_ALLOCSIZE_ASSERT
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_cdc_ecm_initialize PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function initializes the USB CDC_ECM device. */
/* */
/* INPUT */
/* */
/* command Pointer to cdc_ecm command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_free Free memory */
/* _ux_utility_mutex_create Create Mutex */
/* _ux_utility_mutex_delete Delete Mutex */
/* _ux_utility_event_flags_create Create Flag group */
/* _ux_utility_event_flags_delete Delete Flag group */
/* _ux_device_thread_create Create Thread */
/* _ux_device_thread_delete Delete Thread */
/* nx_packet_pool_create Create NetX packet pool */
/* nx_packet_pool_delete Delete NetX packet pool */
/* */
/* CALLED BY */
/* */
/* USBX Source Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* verified memset and memcpy */
/* cases, used UX prefix to */
/* refer to TX symbols instead */
/* of using them directly, */
/* resulting in version 6.1 */
/* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
/* refined macros names, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
UINT _ux_device_class_cdc_ecm_initialize(UX_SLAVE_CLASS_COMMAND *command)
{
UX_SLAVE_CLASS_CDC_ECM *cdc_ecm;
UX_SLAVE_CLASS_CDC_ECM_PARAMETER *cdc_ecm_parameter;
UX_SLAVE_CLASS *class;
UINT status;
/* Get the class container. */
class = command -> ux_slave_class_command_class_ptr;
/* Create an instance of the device cdc_ecm class. */
cdc_ecm = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_SLAVE_CLASS_CDC_ECM));
/* Check for successful allocation. */
if (cdc_ecm == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Create a mutex to protect the CDC_ECM thread and the application messing up the transmit queue. */
status = _ux_utility_mutex_create(&cdc_ecm -> ux_slave_class_cdc_ecm_mutex, "ux_slave_class_cdc_ecm_mutex");
if (status != UX_SUCCESS)
{
_ux_utility_memory_free(cdc_ecm);
return(UX_MUTEX_ERROR);
}
/* Assume good result. */
status = UX_SUCCESS;
/* Allocate some memory for the bulk out thread stack. */
cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE);
if (cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread_stack == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
/* Allocate some memory for the interrupt thread stack. */
if (status == UX_SUCCESS)
{
cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE);
/* Check for successful allocation. */
if (cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread_stack == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
}
/* Allocate some memory for the bulk in thread stack. */
if (status == UX_SUCCESS)
{
cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE);
/* Check for successful allocation. */
if (cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread_stack == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
}
/* Allocate some packet pool for reception. */
if (status == UX_SUCCESS)
{
/* UX_DEVICE_CLASS_CDC_ECM_NX_ETHERNET_POOL_ALLOCSIZE overflow has been checked by
* UX_DEVICE_CLASS_CDC_ECM_NX_ETHERNET_POOL_ALLOCSIZE_ASSERT outside of function.
*/
cdc_ecm -> ux_slave_class_cdc_ecm_pool_memory =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, UX_DEVICE_CLASS_CDC_ECM_NX_ETHERNET_POOL_ALLOCSIZE);
/* Check for successful allocation. */
if (cdc_ecm -> ux_slave_class_cdc_ecm_pool_memory == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
else
{
/* Create a packet pool. */
status = nx_packet_pool_create(&cdc_ecm -> ux_slave_class_cdc_ecm_packet_pool, "CDC ECM Device Packet Pool",
UX_DEVICE_CLASS_CDC_ECM_NX_PAYLOAD_SIZE, cdc_ecm -> ux_slave_class_cdc_ecm_pool_memory,
UX_DEVICE_CLASS_CDC_ECM_NX_ETHERNET_POOL_ALLOCSIZE);
}
}
/* Interrupt endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the cdc_ecm instance to the new thread. This thread
does not start until we have a instance of the class. */
if (status == UX_SUCCESS)
{
status = _ux_device_thread_create(&cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread , "ux_slave_class_cdc_ecm_interrupt_thread",
_ux_device_class_cdc_ecm_interrupt_thread,
(ULONG) (ALIGN_TYPE) class, (VOID *) cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread_stack ,
UX_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);
}
UX_THREAD_EXTENSION_PTR_SET(&(cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread), class)
/* Check the creation of this 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_ecm instance to the new thread. This thread
does not start until we have a instance of the class. */
status = _ux_device_thread_create(&cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread , "ux_slave_class_cdc_ecm_bulkout_thread",
_ux_device_class_cdc_ecm_bulkout_thread,
(ULONG) (ALIGN_TYPE) class, (VOID *) cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread_stack ,
UX_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
{
UX_THREAD_EXTENSION_PTR_SET(&(cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread), class)
/* Bulk endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the cdc_ecm instance to the new thread. This thread
does not start until we have a instance of the class. */
status = _ux_device_thread_create(&cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread , "ux_slave_class_cdc_ecm_bulkin_thread",
_ux_device_class_cdc_ecm_bulkin_thread,
(ULONG) (ALIGN_TYPE) class, (VOID *) cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread_stack ,
UX_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
{
UX_THREAD_EXTENSION_PTR_SET(&(cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread), class)
/* Create a event flag group for the cdc_ecm class to synchronize with the event interrupt thread. */
status = _ux_utility_event_flags_create(&cdc_ecm -> ux_slave_class_cdc_ecm_event_flags_group, "ux_device_class_cdc_ecm_event_flag");
if (status != UX_SUCCESS)
status = (UX_EVENT_ERROR);
else
{
/* Save the address of the CDC_ECM instance inside the CDC_ECM container. */
class -> ux_slave_class_instance = (VOID *) cdc_ecm;
/* Get the pointer to the application parameters for the cdc_ecm class. */
cdc_ecm_parameter = command -> ux_slave_class_command_parameter;
/* Store the start and stop signals if needed by the application. */
cdc_ecm -> ux_slave_class_cdc_ecm_parameter.ux_slave_class_cdc_ecm_instance_activate = cdc_ecm_parameter -> ux_slave_class_cdc_ecm_instance_activate;
cdc_ecm -> ux_slave_class_cdc_ecm_parameter.ux_slave_class_cdc_ecm_instance_deactivate = cdc_ecm_parameter -> ux_slave_class_cdc_ecm_instance_deactivate;
/* Copy the local node ID. */
_ux_utility_memory_copy(cdc_ecm -> ux_slave_class_cdc_ecm_local_node_id, cdc_ecm_parameter -> ux_slave_class_cdc_ecm_parameter_local_node_id,
UX_DEVICE_CLASS_CDC_ECM_NODE_ID_LENGTH); /* Use case of memcpy is verified. */
/* Copy the remote node ID. */
_ux_utility_memory_copy(cdc_ecm -> ux_slave_class_cdc_ecm_remote_node_id, cdc_ecm_parameter -> ux_slave_class_cdc_ecm_parameter_remote_node_id,
UX_DEVICE_CLASS_CDC_ECM_NODE_ID_LENGTH); /* Use case of memcpy is verified. */
/* Store the rest of the parameters as they are in the local instance. */
_ux_utility_memory_copy(&cdc_ecm -> ux_slave_class_cdc_ecm_parameter, cdc_ecm_parameter, sizeof (UX_SLAVE_CLASS_CDC_ECM_PARAMETER)); /* Use case of memcpy is verified. */
return(UX_SUCCESS);
}
_ux_device_thread_delete(&cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread);
}
_ux_device_thread_delete(&cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread);
}
_ux_device_thread_delete(&cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread);
}
/* Free allocated resources. */
if (cdc_ecm -> ux_slave_class_cdc_ecm_packet_pool.nx_packet_pool_id)
nx_packet_pool_delete(&cdc_ecm -> ux_slave_class_cdc_ecm_packet_pool);
if (cdc_ecm -> ux_slave_class_cdc_ecm_pool_memory)
_ux_utility_memory_free(cdc_ecm -> ux_slave_class_cdc_ecm_pool_memory);
if (cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread_stack)
_ux_utility_memory_free(cdc_ecm -> ux_slave_class_cdc_ecm_bulkin_thread_stack);
if (cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread_stack)
_ux_utility_memory_free(cdc_ecm -> ux_slave_class_cdc_ecm_interrupt_thread_stack);
if (cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread_stack)
_ux_utility_memory_free(cdc_ecm -> ux_slave_class_cdc_ecm_bulkout_thread_stack);
_ux_utility_mutex_delete(&cdc_ecm -> ux_slave_class_cdc_ecm_mutex);
_ux_utility_memory_free(cdc_ecm);
/* Return completion status. */
return(status);
}