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
|
/***************************************************************************
* 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 RNDIS Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_rndis.h"
#include "ux_device_stack.h"
UX_DEVICE_CLASS_RNDIS_NX_ETHERNET_POOL_ALLOCSIZE_ASSERT
/* Define list of supported OIDs (ends with zero-terminator) */
ULONG ux_device_class_rndis_oid_supported_list[UX_DEVICE_CLASS_RNDIS_OID_SUPPORTED_LIST_LENGTH + 1] =
{
/* Mandatory general OIDs. */
UX_DEVICE_CLASS_RNDIS_OID_GEN_SUPPORTED_LIST,
UX_DEVICE_CLASS_RNDIS_OID_GEN_HARDWARE_STATUS,
UX_DEVICE_CLASS_RNDIS_OID_GEN_MEDIA_SUPPORTED,
UX_DEVICE_CLASS_RNDIS_OID_GEN_MEDIA_IN_USE,
UX_DEVICE_CLASS_RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE,
UX_DEVICE_CLASS_RNDIS_OID_GEN_LINK_SPEED,
UX_DEVICE_CLASS_RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE,
UX_DEVICE_CLASS_RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE,
UX_DEVICE_CLASS_RNDIS_OID_GEN_VENDOR_ID,
UX_DEVICE_CLASS_RNDIS_OID_GEN_VENDOR_DESCRIPTION,
UX_DEVICE_CLASS_RNDIS_OID_GEN_VENDOR_DRIVER_VERSION,
UX_DEVICE_CLASS_RNDIS_OID_GEN_CURRENT_PACKET_FILTER,
UX_DEVICE_CLASS_RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE,
UX_DEVICE_CLASS_RNDIS_OID_GEN_MAC_OPTIONS,
UX_DEVICE_CLASS_RNDIS_OID_GEN_MEDIA_CONNECT_STATUS,
UX_DEVICE_CLASS_RNDIS_OID_GEN_PHYSICAL_MEDIUM,
UX_DEVICE_CLASS_RNDIS_OID_GEN_RNDIS_CONFIG_PARAMETER,
/* Mandatory statistical OIDs. */
UX_DEVICE_CLASS_RNDIS_OID_GEN_XMIT_OK,
UX_DEVICE_CLASS_RNDIS_OID_GEN_RCV_OK,
UX_DEVICE_CLASS_RNDIS_OID_GEN_XMIT_ERROR,
UX_DEVICE_CLASS_RNDIS_OID_GEN_RCV_ERROR,
UX_DEVICE_CLASS_RNDIS_OID_GEN_RCV_NO_BUFFER,
/* Mandatory 802.3 OIDs. */
UX_DEVICE_CLASS_RNDIS_OID_802_3_PERMANENT_ADDRESS,
UX_DEVICE_CLASS_RNDIS_OID_802_3_CURRENT_ADDRESS,
UX_DEVICE_CLASS_RNDIS_OID_802_3_MULTICAST_LIST,
UX_DEVICE_CLASS_RNDIS_OID_802_3_MAC_OPTIONS,
UX_DEVICE_CLASS_RNDIS_OID_802_3_MAXIMUM_LIST_SIZE,
/* Mandatory 802.3 statistical OIDs. */
UX_DEVICE_CLASS_RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT,
UX_DEVICE_CLASS_RNDIS_OID_802_3_XMIT_ONE_COLLISION,
UX_DEVICE_CLASS_RNDIS_OID_802_3_XMIT_MORE_COLLISIONS,
0,
};
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_rndis_initialize PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function initializes the USB RNDIS device. */
/* */
/* INPUT */
/* */
/* command Pointer to rndis command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_copy Copy memory */
/* _ux_utility_memory_free Free memory */
/* _ux_utility_event_flags_create Create Flag group */
/* _ux_utility_event_flags_delete Delete Flag group */
/* _ux_utility_mutex_create Create mutex */
/* _ux_device_mutex_delete Delete mutex */
/* _ux_device_semaphore_create Create semaphore */
/* _ux_device_semaphore_delete Delete semaphore */
/* _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 */
/* */
/**************************************************************************/
UINT _ux_device_class_rndis_initialize(UX_SLAVE_CLASS_COMMAND *command)
{
#if defined(UX_DEVICE_STANDALONE)
UX_PARAMETER_NOT_USED(command);
return(UX_FUNCTION_NOT_SUPPORTED);
#else
UX_SLAVE_CLASS_RNDIS *rndis;
UX_SLAVE_CLASS_RNDIS_PARAMETER *rndis_parameter;
UX_SLAVE_CLASS *class_ptr;
UINT status = UX_SUCCESS;
/* Compile option checks. */
UX_ASSERT(UX_DEVICE_CLASS_RNDIS_MAX_CONTROL_RESPONSE_LENGTH <= UX_SLAVE_REQUEST_CONTROL_MAX_LENGTH);
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 0
UX_ASSERT(UX_DEVICE_CLASS_RNDIS_BULKOUT_BUFFER_SIZE <= UX_SLAVE_REQUEST_DATA_MAX_LENGTH);
UX_ASSERT(UX_DEVICE_CLASS_RNDIS_BULKIN_BUFFER_SIZE <= UX_SLAVE_REQUEST_DATA_MAX_LENGTH);
UX_ASSERT(UX_DEVICE_CLASS_RNDIS_INTERRUPTIN_BUFFER_SIZE <= UX_SLAVE_REQUEST_DATA_MAX_LENGTH);
#endif
/* Get the class container. */
class_ptr = command -> ux_slave_class_command_class_ptr;
/* Create an instance of the device rndis class. */
rndis = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_SLAVE_CLASS_RNDIS));
/* Check for successful allocation. */
if (rndis == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Save the address of the RNDIS instance inside the RNDIS container. */
class_ptr -> ux_slave_class_instance = (VOID *) rndis;
/* Get the pointer to the application parameters for the rndis class. */
rndis_parameter = command -> ux_slave_class_command_parameter;
/* Store the start and stop signals if needed by the application. */
rndis -> ux_slave_class_rndis_parameter.ux_slave_class_rndis_instance_activate = rndis_parameter -> ux_slave_class_rndis_instance_activate;
rndis -> ux_slave_class_rndis_parameter.ux_slave_class_rndis_instance_deactivate = rndis_parameter -> ux_slave_class_rndis_instance_deactivate;
/* Save the Netx IP passed by the application. */
rndis -> ux_slave_class_rndis_nx_ip = rndis_parameter -> ux_slave_class_rndis_parameter_nx_ip;
/* Save the Netx IP address passed by the application. */
rndis -> ux_slave_class_rndis_nx_ip_address = rndis_parameter -> ux_slave_class_rndis_parameter_nx_ip_address;
/* Save the Netx IP address network mask passed by the application. */
rndis -> ux_slave_class_rndis_nx_ip_network_mask = rndis_parameter -> ux_slave_class_rndis_parameter_nx_ip_network_mask;
/* Copy the local node ID. */
_ux_utility_memory_copy(rndis -> ux_slave_class_rndis_local_node_id, rndis_parameter -> ux_slave_class_rndis_parameter_local_node_id,
UX_DEVICE_CLASS_RNDIS_NODE_ID_LENGTH); /* Use case of memcpy is verified. */
/* Copy the remote node ID. */
_ux_utility_memory_copy(rndis -> ux_slave_class_rndis_remote_node_id, rndis_parameter -> ux_slave_class_rndis_parameter_remote_node_id,
UX_DEVICE_CLASS_RNDIS_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(&rndis -> ux_slave_class_rndis_parameter, rndis_parameter, sizeof (UX_SLAVE_CLASS_RNDIS_PARAMETER)); /* Use case of memcpy is verified. */
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
/* Allocate memory for endpoints. */
UX_ASSERT(!UX_DEVICE_CLASS_RNDIS_ENDPOINT_BUFFER_SIZE_CALC_OVERFLOW);
rndis -> ux_device_class_rndis_endpoint_buffer = _ux_utility_memory_allocate(
UX_NO_ALIGN,UX_CACHE_SAFE_MEMORY,
UX_DEVICE_CLASS_RNDIS_ENDPOINT_BUFFER_SIZE);
if (rndis -> ux_device_class_rndis_endpoint_buffer == UX_NULL)
status = UX_MEMORY_INSUFFICIENT;
#else
status = UX_SUCCESS;
#endif
/* Create a mutex to protect the RNDIS thread and the application messing up the transmit queue. */
if (status == UX_SUCCESS)
{
status = _ux_utility_mutex_create(&rndis -> ux_slave_class_rndis_mutex, "ux_slave_class_rndis_mutex");
if (status != UX_SUCCESS)
status = UX_MUTEX_ERROR;
}
/* Allocate some memory for the interrupt thread stack. */
if (status == UX_SUCCESS)
{
rndis -> ux_slave_class_rndis_interrupt_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE);
/* Check for successful allocation. */
if (rndis -> ux_slave_class_rndis_interrupt_thread_stack == UX_NULL)
/* Set status to memory insufficient. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Interrupt endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the rndis 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(&rndis -> ux_slave_class_rndis_interrupt_thread , "ux_slave_class_rndis_interrupt_thread",
_ux_device_class_rndis_interrupt_thread,
(ULONG) (ALIGN_TYPE) class_ptr, (VOID *) rndis -> ux_slave_class_rndis_interrupt_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;
}
UX_THREAD_EXTENSION_PTR_SET(&(rndis -> ux_slave_class_rndis_interrupt_thread), class_ptr)
/* Allocate some memory for the bulk out thread stack. */
if (status == UX_SUCCESS)
{
rndis -> ux_slave_class_rndis_bulkout_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE);
/* Check for successful allocation. */
if (rndis -> ux_slave_class_rndis_bulkout_thread_stack == UX_NULL)
status = UX_MEMORY_INSUFFICIENT;
}
/* Bulk endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the rndis 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(&rndis -> ux_slave_class_rndis_bulkout_thread , "ux_slave_class_rndis_bulkout_thread",
_ux_device_class_rndis_bulkout_thread,
(ULONG) (ALIGN_TYPE) class_ptr, (VOID *) rndis -> ux_slave_class_rndis_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;
}
UX_THREAD_EXTENSION_PTR_SET(&(rndis -> ux_slave_class_rndis_bulkout_thread), class_ptr)
/* Allocate some memory for the bulk in thread stack. */
if (status == UX_SUCCESS)
{
rndis -> ux_slave_class_rndis_bulkin_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_THREAD_STACK_SIZE);
/* Check for successful allocation. */
if (rndis -> ux_slave_class_rndis_bulkin_thread_stack == UX_NULL)
status = UX_MEMORY_INSUFFICIENT;
}
/* Bulk endpoint treatment needs to be running in a different thread. So start
a new thread. We pass a pointer to the rndis 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(&rndis -> ux_slave_class_rndis_bulkin_thread , "ux_slave_class_rndis_bulkin_thread",
_ux_device_class_rndis_bulkin_thread,
(ULONG) (ALIGN_TYPE) class_ptr, (VOID *) rndis -> ux_slave_class_rndis_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;
}
UX_THREAD_EXTENSION_PTR_SET(&(rndis -> ux_slave_class_rndis_bulkin_thread), class_ptr)
/* Create a event flag group for the rndis class to synchronize with the event interrupt thread. */
if (status == UX_SUCCESS)
{
status = _ux_utility_event_flags_create(&rndis -> ux_slave_class_rndis_event_flags_group, "ux_device_class_rndis_event_flag");
/* Check status. */
if (status != UX_SUCCESS)
status = UX_EVENT_ERROR;
}
/* Create a semaphore for protecting the driver entry. */
if (status == UX_SUCCESS)
{
status = _ux_device_semaphore_create(&rndis -> ux_slave_class_rndis_semaphore, "ux_device_class_rndis_semaphore", 1);
if (status == UX_SUCCESS)
/* Return success. */
return(UX_SUCCESS);
/* Semaphore creation error. */
status = UX_SEMAPHORE_ERROR;
}
/* Failed! Free up resources. */
/* Delete semaphore for protecting the driver entry. */
if (_ux_device_semaphore_created(&rndis -> ux_slave_class_rndis_semaphore))
_ux_device_semaphore_delete(&rndis -> ux_slave_class_rndis_semaphore);
/* Delete rndis -> ux_slave_class_rndis_event_flags_group. */
if (_ux_device_event_flags_created(&rndis -> ux_slave_class_rndis_event_flags_group))
_ux_utility_event_flags_delete(&rndis -> ux_slave_class_rndis_event_flags_group);
/* Delete rndis -> ux_slave_class_rndis_bulkin_thread. */
if (_ux_device_thread_created(&rndis -> ux_slave_class_rndis_bulkin_thread))
_ux_device_thread_delete(&rndis -> ux_slave_class_rndis_bulkin_thread);
/* Free rndis -> ux_slave_class_rndis_bulkin_thread_stack. */
if (rndis -> ux_slave_class_rndis_bulkin_thread_stack)
_ux_utility_memory_free(rndis -> ux_slave_class_rndis_bulkin_thread_stack);
/* Delete rndis -> ux_slave_class_rndis_bulkout_thread. */
if (_ux_device_thread_created(&rndis -> ux_slave_class_rndis_bulkout_thread))
_ux_device_thread_delete(&rndis -> ux_slave_class_rndis_bulkout_thread);
/* Free rndis -> ux_slave_class_rndis_bulkout_thread_stack. */
if (rndis -> ux_slave_class_rndis_bulkout_thread_stack)
_ux_utility_memory_free(rndis -> ux_slave_class_rndis_bulkout_thread_stack);
/* Delete rndis -> ux_slave_class_rndis_interrupt_thread. */
if (_ux_device_thread_created(&rndis -> ux_slave_class_rndis_interrupt_thread))
_ux_device_thread_delete(&rndis -> ux_slave_class_rndis_interrupt_thread);
/* Free rndis -> ux_slave_class_rndis_interrupt_thread_stack. */
if (rndis -> ux_slave_class_rndis_interrupt_thread_stack)
_ux_utility_memory_free(rndis -> ux_slave_class_rndis_interrupt_thread_stack);
/* Delete rndis -> ux_slave_class_rndis_mutex. */
if (_ux_device_mutex_created(&rndis -> ux_slave_class_rndis_mutex))
_ux_device_mutex_delete(&rndis -> ux_slave_class_rndis_mutex);
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
if (rndis -> ux_device_class_rndis_endpoint_buffer != UX_NULL)
_ux_utility_memory_free(rndis -> ux_device_class_rndis_endpoint_buffer);
#endif
/* Free memory for rndis instance. */
_ux_utility_memory_free(rndis);
/* Return completion status. */
return(status);
#endif
}
|
