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
|
/***************************************************************************
* 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 Audio Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_audio.h"
#include "ux_device_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_audio_change PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function changes the interface of the Audio device */
/* */
/* INPUT */
/* */
/* command Pointer to audio command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_thread_resume Resume a suspended thread */
/* _ux_system_error_handler System error trap */
/* */
/* CALLED BY */
/* */
/* Device Audio Class */
/* */
/**************************************************************************/
UINT _ux_device_class_audio_change(UX_SLAVE_CLASS_COMMAND *command)
{
UX_DEVICE_CLASS_AUDIO *audio;
UX_DEVICE_CLASS_AUDIO_STREAM *stream;
UX_SLAVE_CLASS *class_ptr;
UX_SLAVE_INTERFACE *interface_ptr;
UX_SLAVE_ENDPOINT *endpoint;
UCHAR *frame_buffer;
ULONG stream_index;
ULONG endpoint_dir;
/* Get the class container. */
class_ptr = command -> ux_slave_class_command_class_ptr;
/* Get the class instance in the container. */
audio = (UX_DEVICE_CLASS_AUDIO *) class_ptr -> ux_slave_class_instance;
/* Get the interface that owns this instance. */
interface_ptr = (UX_SLAVE_INTERFACE *) command -> ux_slave_class_command_interface;
/* Get the interface number (base 0). */
if (audio -> ux_device_class_audio_interface)
{
/* If IAD used, calculate stream index based on interface number. */
stream_index = interface_ptr -> ux_slave_interface_descriptor.bInterfaceNumber;
stream_index -= audio -> ux_device_class_audio_interface -> ux_slave_interface_descriptor.bInterfaceNumber;
stream_index --;
}
else
/* One stream for one driver! */
stream_index = 0;
/* Get the stream instance. */
stream = &audio -> ux_device_class_audio_streams[stream_index];
/* Update the interface. */
stream -> ux_device_class_audio_stream_interface = interface_ptr;
/* If the interface to mount has a non zero alternate setting, the class is really active with
the endpoints active. If the interface reverts to alternate setting 0, it needs to have
the pending transactions terminated. */
if (interface_ptr -> ux_slave_interface_descriptor.bAlternateSetting != 0)
{
/* Locate the endpoints. ISO IN(write)/OUT(read) for Streaming Interface. */
endpoint = interface_ptr -> ux_slave_interface_first_endpoint;
/* Parse all endpoints. */
#if defined(UX_DEVICE_STANDALONE)
endpoint_dir = (stream -> ux_device_class_audio_stream_task_function ==
_ux_device_class_audio_read_task_function) ?
UX_ENDPOINT_OUT: UX_ENDPOINT_IN;
#else
endpoint_dir = (_ux_device_thread_entry(&stream -> ux_device_class_audio_stream_thread) ==
_ux_device_class_audio_read_thread_entry) ?
UX_ENDPOINT_OUT : UX_ENDPOINT_IN;
#endif
stream -> ux_device_class_audio_stream_endpoint = UX_NULL;
#if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
stream -> ux_device_class_audio_stream_feedback = UX_NULL;
#endif
while(endpoint != UX_NULL)
{
/* Check the endpoint attributes. */
if((endpoint -> ux_slave_endpoint_descriptor.bmAttributes &
UX_DEVICE_CLASS_AUDIO_EP_TRANSFER_TYPE_MASK) == UX_ISOCHRONOUS_ENDPOINT)
{
/* Check the endpoint direction. */
if ((endpoint->ux_slave_endpoint_descriptor.bEndpointAddress &
UX_ENDPOINT_DIRECTION) == endpoint_dir)
{
/* We found the data endpoint, check its size. */
if (endpoint -> ux_slave_endpoint_transfer_request.ux_slave_transfer_request_transfer_length > stream -> ux_device_class_audio_stream_frame_buffer_size - 8)
{
/* Error trap! */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_MEMORY_INSUFFICIENT);
/* Frame buffer too small for endpoints. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Save it. */
stream -> ux_device_class_audio_stream_endpoint = endpoint;
}
#if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
else
{
/* We found the feedback endpoint, check its size. */
if (endpoint -> ux_slave_endpoint_transfer_request.ux_slave_transfer_request_transfer_length <
(_ux_system_slave->ux_system_slave_speed == UX_HIGH_SPEED_DEVICE ? 4 : 3))
{
/* Error trap! */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_MEMORY_INSUFFICIENT);
/* Frame buffer too small for endpoints. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Set request length, uses full packet for OUT to avoid possible overflow. */
endpoint -> ux_slave_endpoint_transfer_request.ux_slave_transfer_request_requested_length =
endpoint_dir == UX_ENDPOINT_OUT ?
endpoint -> ux_slave_endpoint_transfer_request.ux_slave_transfer_request_transfer_length :
((_ux_system_slave -> ux_system_slave_speed == UX_HIGH_SPEED_DEVICE) ?
UX_FEEDBACK_SIZE_HIGH_SPEED : UX_FEEDBACK_SIZE_FULL_SPEED);
/* Save it. */
stream -> ux_device_class_audio_stream_feedback = endpoint;
}
#endif
}
/* Check if done. */
if (stream -> ux_device_class_audio_stream_endpoint
#if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
&& stream -> ux_device_class_audio_stream_feedback
#endif
)
break;
/* Next endpoint. */
endpoint = endpoint -> ux_slave_endpoint_next_endpoint;
}
/* Now check if all endpoints have been found. */
if (stream -> ux_device_class_audio_stream_endpoint == UX_NULL)
{
/* Error trap! */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_DESCRIPTOR_CORRUPTED);
/* Not all endpoints have been found. Major error, do not proceed. */
return(UX_DESCRIPTOR_CORRUPTED);
}
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
#if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
if (stream -> ux_device_class_audio_stream_feedback)
stream -> ux_device_class_audio_stream_feedback ->
ux_slave_endpoint_transfer_request.ux_slave_transfer_request_data_pointer =
stream -> ux_device_class_audio_stream_feedback_buffer;
#endif
#endif
#if defined(UX_DEVICE_STANDALONE)
/* Reset background transfer state. */
stream -> ux_device_class_audio_stream_task_state = UX_STATE_RESET;
#endif
/* Now reset payload buffer error count. */
stream -> ux_device_class_audio_stream_buffer_error_count = 0;
/* Now reset frame buffers. */
frame_buffer = stream -> ux_device_class_audio_stream_buffer;
while(frame_buffer < stream -> ux_device_class_audio_stream_buffer + stream -> ux_device_class_audio_stream_buffer_size)
{
/* Reset header information. */
*((ULONG *) frame_buffer ) = 0;
*((ULONG *)(frame_buffer + 4)) = 0;
/* Next. */
frame_buffer += stream -> ux_device_class_audio_stream_frame_buffer_size;
}
stream -> ux_device_class_audio_stream_transfer_pos = stream -> ux_device_class_audio_stream_access_pos;
#if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT) && !defined(UX_DEVICE_STANDALONE)
/* If feedback supported, resume the thread. */
if (stream -> ux_device_class_audio_stream_feedback_thread_stack)
_ux_utility_thread_resume(&stream -> ux_device_class_audio_stream_feedback_thread);
#endif
}
else
{
/* There is no data endpoint. */
stream -> ux_device_class_audio_stream_endpoint = UX_NULL;
#if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
stream -> ux_device_class_audio_stream_feedback = UX_NULL;
#endif
/* In this case, we are reverting to the Alternate Setting 0. We need to terminate the pending transactions. */
/* Endpoints actually aborted and destroyed before change command. */
/*
_ux_device_stack_transfer_all_request_abort(stream -> ux_device_class_audio_stream_endpoint, UX_TRANSFER_APPLICATION_RESET);
*/
}
/* Invoke stream change callback. */
if (stream -> ux_device_class_audio_stream_callbacks.ux_device_class_audio_stream_change)
stream -> ux_device_class_audio_stream_callbacks.ux_device_class_audio_stream_change(stream, interface_ptr -> ux_slave_interface_descriptor.bAlternateSetting);
/* Return completion status. */
return(UX_SUCCESS);
}
|