Outline ![]()
Files ![]()
loading...
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
/**************************************************************************/
/* */
/* 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 Stack */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_stack_interface_set PORTABLE C */
/* 6.1.9 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sets one alternate setting of one interface and */
/* enable all endpoints associated with this alternate setting. */
/* configuration. */
/* */
/* INPUT */
/* */
/* device_framework Address in device framework */
/* for selected alternate setting*/
/* device_framework_length Length of device framework */
/* alternate_setting_value Alternate setting */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* (ux_slave_dcd_function) DCD dispatch function */
/* _ux_device_stack_interface_start Start interface */
/* _ux_utility_descriptor_parse Parse descriptor */
/* */
/* CALLED BY */
/* */
/* Application */
/* Device Stack */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* optimized based on compile */
/* definitions, */
/* resulting in version 6.1 */
/* 10-15-2021 Chaoqiong Xiao Modified comment(s), */
/* calculated payload size, */
/* resulting in version 6.1.9 */
/* */
/**************************************************************************/
UINT _ux_device_stack_interface_set(UCHAR * device_framework, ULONG device_framework_length,
ULONG alternate_setting_value)
{
UX_SLAVE_DCD *dcd;
UX_SLAVE_DEVICE *device;
UX_SLAVE_TRANSFER *transfer_request;
UX_SLAVE_INTERFACE *interface;
#if !defined(UX_DEVICE_INITIALIZE_FRAMEWORK_SCAN_DISABLE) || UX_MAX_DEVICE_INTERFACES > 1
UX_SLAVE_INTERFACE *interface_link;
ULONG interfaces_pool_number;
#endif
UX_SLAVE_ENDPOINT *endpoint;
UX_SLAVE_ENDPOINT *endpoint_link;
ULONG descriptor_length;
UCHAR descriptor_type;
ULONG endpoints_pool_number;
UINT status;
ULONG max_transfer_length, n_trans;
UX_PARAMETER_NOT_USED(alternate_setting_value);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_STACK_INTERFACE_SET, alternate_setting_value, 0, 0, 0, UX_TRACE_DEVICE_STACK_EVENTS, 0, 0)
/* Get the pointer to the DCD. */
dcd = &_ux_system_slave -> ux_system_slave_dcd;
/* Get the pointer to the device. */
device = &_ux_system_slave -> ux_system_slave_device;
/* Find a free interface in the pool and hook it to the
existing interface. */
interface = device -> ux_slave_device_interfaces_pool;
#if !defined(UX_DEVICE_INITIALIZE_FRAMEWORK_SCAN_DISABLE) || UX_MAX_DEVICE_INTERFACES > 1
interfaces_pool_number = device -> ux_slave_device_interfaces_pool_number;
while (interfaces_pool_number != 0)
{
/* Check if this interface is free. */
if (interface -> ux_slave_interface_status == UX_UNUSED)
break;
/* Try the next interface. */
interface++;
/* Decrement the number of interfaces left to scan in the pool. */
interfaces_pool_number--;
}
/* Did we find a free interface ? */
if (interfaces_pool_number == 0)
return(UX_MEMORY_INSUFFICIENT);
#else
/* Check if this interface is free. */
if (interface -> ux_slave_interface_status != UX_UNUSED)
return(UX_MEMORY_INSUFFICIENT);
#endif
/* Mark this interface as used now. */
interface -> ux_slave_interface_status = UX_USED;
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_DEVICE_OBJECT_TYPE_INTERFACE, interface, 0, 0, 0)
/* Parse the descriptor in something more readable. */
_ux_utility_descriptor_parse(device_framework,
_ux_system_interface_descriptor_structure,
UX_INTERFACE_DESCRIPTOR_ENTRIES,
(UCHAR *) &interface -> ux_slave_interface_descriptor);
#if !defined(UX_DEVICE_INITIALIZE_FRAMEWORK_SCAN_DISABLE) || UX_MAX_DEVICE_INTERFACES > 1
/* Attach this interface to the end of the interface chain. */
if (device -> ux_slave_device_first_interface == UX_NULL)
{
device -> ux_slave_device_first_interface = interface;
}
else
{
/* Multiple interfaces exist, so find the end of the chain. */
interface_link = device -> ux_slave_device_first_interface;
while (interface_link -> ux_slave_interface_next_interface != UX_NULL)
interface_link = interface_link -> ux_slave_interface_next_interface;
interface_link -> ux_slave_interface_next_interface = interface;
}
#else
/* It must be very first one. */
device -> ux_slave_device_first_interface = interface;
#endif
/* Point beyond the interface descriptor. */
device_framework_length -= (ULONG) *device_framework;
device_framework += (ULONG) *device_framework;
/* Parse the device framework and locate endpoint descriptor(s). */
while (device_framework_length != 0)
{
/* Get the length of the current descriptor. */
descriptor_length = (ULONG) *device_framework;
/* And its type. */
descriptor_type = *(device_framework + 1);
/* Check if this is an endpoint descriptor. */
switch(descriptor_type)
{
case UX_ENDPOINT_DESCRIPTOR_ITEM:
/* Find a free endpoint in the pool and hook it to the
existing interface after it's created by DCD. */
endpoint = device -> ux_slave_device_endpoints_pool;
endpoints_pool_number = device -> ux_slave_device_endpoints_pool_number;
while (endpoints_pool_number != 0)
{
/* Check if this endpoint is free. */
if (endpoint -> ux_slave_endpoint_status == UX_UNUSED)
{
/* Mark this endpoint as used now. */
endpoint -> ux_slave_endpoint_status = UX_USED;
break;
}
/* Try the next endpoint. */
endpoint++;
/* Decrement the number of endpoints to scan from the pool. */
endpoints_pool_number--;
}
/* Did we find a free endpoint ? */
if (endpoints_pool_number == 0)
return(UX_MEMORY_INSUFFICIENT);
/* Parse the descriptor in something more readable. */
_ux_utility_descriptor_parse(device_framework,
_ux_system_endpoint_descriptor_structure,
UX_ENDPOINT_DESCRIPTOR_ENTRIES,
(UCHAR *) &endpoint -> ux_slave_endpoint_descriptor);
/* Now we create a transfer request to accept transfer on this endpoint. */
transfer_request = &endpoint -> ux_slave_endpoint_transfer_request;
/* Validate endpoint descriptor wMaxPacketSize. */
UX_ASSERT(endpoint -> ux_slave_endpoint_descriptor.wMaxPacketSize != 0);
/* Calculate endpoint transfer payload max size. */
max_transfer_length =
endpoint -> ux_slave_endpoint_descriptor.wMaxPacketSize &
UX_MAX_PACKET_SIZE_MASK;
if ((_ux_system_slave -> ux_system_slave_speed == UX_HIGH_SPEED_DEVICE) &&
(endpoint -> ux_slave_endpoint_descriptor.bmAttributes & 0x1u))
{
n_trans = endpoint -> ux_slave_endpoint_descriptor.wMaxPacketSize &
UX_MAX_NUMBER_OF_TRANSACTIONS_MASK;
if (n_trans)
{
n_trans >>= UX_MAX_NUMBER_OF_TRANSACTIONS_SHIFT;
n_trans ++;
max_transfer_length *= n_trans;
}
}
/* Validate max transfer size and save it. */
UX_ASSERT(max_transfer_length <= UX_SLAVE_REQUEST_DATA_MAX_LENGTH);
transfer_request -> ux_slave_transfer_request_transfer_length = max_transfer_length;
/* We store the endpoint in the transfer request as well. */
transfer_request -> ux_slave_transfer_request_endpoint = endpoint;
/* By default the timeout is infinite on request. */
transfer_request -> ux_slave_transfer_request_timeout = UX_WAIT_FOREVER;
/* Attach the interface to the endpoint. */
endpoint -> ux_slave_endpoint_interface = interface;
/* Attach the device to the endpoint. */
endpoint -> ux_slave_endpoint_device = device;
/* Create the endpoint at the DCD level. */
status = dcd -> ux_slave_dcd_function(dcd, UX_DCD_CREATE_ENDPOINT, (VOID *) endpoint);
/* Do a sanity check on endpoint creation. */
if (status != UX_SUCCESS)
{
/* Error was returned, endpoint cannot be created. */
endpoint -> ux_slave_endpoint_status = UX_UNUSED;
return(status);
}
/* Attach this endpoint to the end of the endpoint chain. */
if (interface -> ux_slave_interface_first_endpoint == UX_NULL)
{
interface -> ux_slave_interface_first_endpoint = endpoint;
}
else
{
/* Multiple endpoints exist, so find the end of the chain. */
endpoint_link = interface -> ux_slave_interface_first_endpoint;
while (endpoint_link -> ux_slave_endpoint_next_endpoint != UX_NULL)
endpoint_link = endpoint_link -> ux_slave_endpoint_next_endpoint;
endpoint_link -> ux_slave_endpoint_next_endpoint = endpoint;
}
break;
case UX_CONFIGURATION_DESCRIPTOR_ITEM:
case UX_INTERFACE_DESCRIPTOR_ITEM:
/* If the descriptor is a configuration or interface,
we have parsed and mounted all endpoints.
The interface attached to this configuration must be started at the class level. */
status = _ux_device_stack_interface_start(interface);
/* Return the status to the caller. */
return(status);
default:
break;
}
/* Adjust what is left of the device framework. */
device_framework_length -= descriptor_length;
/* Point to the next descriptor. */
device_framework += descriptor_length;
}
/* The interface attached to this configuration must be started at the class
level. */
status = _ux_device_stack_interface_start(interface);
/* Return the status to the caller. */
return(status);
}