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
|
/***************************************************************************
* 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 */
/** */
/** Host Stack */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_stack_interfaces_scan PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function scans all the interfaces and alternate settings for */
/* particular configuration. */
/* */
/* INPUT */
/* */
/* configuration Where the interface(s) will */
/* be attached */
/* descriptor Contains the entire descriptor*/
/* for this configuration */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _ux_utility_descriptor_parse Parse interface descriptor */
/* _ux_host_stack_new_interface_create Create new interface */
/* */
/* CALLED BY */
/* */
/* USBX Components */
/* */
/**************************************************************************/
UINT _ux_host_stack_interfaces_scan(UX_CONFIGURATION *configuration, UCHAR * descriptor)
{
ULONG total_configuration_length;
UINT descriptor_length;
UINT descriptor_type;
ULONG status;
ULONG interface_association_descriptor_present;
ULONG interface_in_iad_count;
UX_INTERFACE_ASSOCIATION_DESCRIPTOR interface_association;
/* Retrieve the size of all the configuration descriptor. */
total_configuration_length = configuration -> ux_configuration_descriptor.wTotalLength;
/* Set the IAD to false. */
interface_association_descriptor_present = UX_FALSE;
/* Set the IAD interface count to zero. */
interface_in_iad_count = 0;
/* Scan the entire descriptor and search for interfaces. We should also ensure that
the descriptor is valid by verifying the length of each descriptor scanned. */
while (total_configuration_length)
{
/* Gather the length and type of the descriptor. */
descriptor_length = *descriptor;
descriptor_type = *(descriptor + 1);
/* Make sure this descriptor has at least the minimum length. */
if (descriptor_length < 3)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_ENUMERATOR, UX_DESCRIPTOR_CORRUPTED);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_DESCRIPTOR_CORRUPTED, descriptor, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_DESCRIPTOR_CORRUPTED);
}
/* Check the type for an interface association descriptor. */
if (descriptor_type == UX_INTERFACE_ASSOCIATION_DESCRIPTOR_ITEM)
{
/* Parse the interface association descriptor and make it machine independent. */
_ux_utility_descriptor_parse(descriptor,
_ux_system_interface_association_descriptor_structure,
UX_INTERFACE_ASSOCIATION_DESCRIPTOR_ENTRIES,
(UCHAR *) &interface_association);
/* Retrieve the CLASS/SUBCLASS from descriptor and store it in the configuration instance. */
configuration -> ux_configuration_iad_class = interface_association.bFunctionClass;
configuration -> ux_configuration_iad_subclass = interface_association.bFunctionSubClass;
configuration -> ux_configuration_iad_protocol = interface_association.bFunctionProtocol;
/* We have an IAD. */
interface_association_descriptor_present = UX_TRUE;
/* Memorize the number of interfaces attached to this IAD. */
interface_in_iad_count = interface_association.bInterfaceCount;
}
/* Check the type for an interface descriptor. */
if (descriptor_type == UX_INTERFACE_DESCRIPTOR_ITEM)
{
/* We have found an interface descriptor. This descriptor contains at least
the default alternate setting (with value 0) and may have others. */
status = _ux_host_stack_new_interface_create(configuration, descriptor, total_configuration_length);
/* Are we within an IAD ? */
if (interface_association_descriptor_present == UX_TRUE)
{
/* Decrement the number of interfaces attached here. */
interface_in_iad_count--;
/* Are we at the end of the interface count ? */
if (interface_in_iad_count == 0)
{
/* Set the IAD to false now. */
interface_association_descriptor_present = UX_FALSE;
/* Reset the IAD Class/Subclass/Protocol. */
configuration -> ux_configuration_iad_class = 0;
configuration -> ux_configuration_iad_subclass = 0;
configuration -> ux_configuration_iad_protocol = 0;
}
}
/* Check return status. */
if(status != UX_SUCCESS)
return(status);
}
/* Check the type for an OTG descriptor. */
if (descriptor_type == UX_OTG_DESCRIPTOR_ITEM)
/* Retrieve the bmAttributes for SRP/HNP support. */
configuration -> ux_configuration_otg_capabilities = (ULONG) *(descriptor + UX_OTG_BM_ATTRIBUTES);
/* Verify if the descriptor is still valid. */
if (descriptor_length > total_configuration_length)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_ENUMERATOR, UX_DESCRIPTOR_CORRUPTED);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_DESCRIPTOR_CORRUPTED, descriptor, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_DESCRIPTOR_CORRUPTED);
}
/* Jump to the next descriptor if we have not reached the end. */
descriptor += descriptor_length;
/* And adjust the length left to parse in the descriptor. */
total_configuration_length -= descriptor_length;
}
/* Return successful completion. */
return(UX_SUCCESS);
}
|
