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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
/***************************************************************************
* 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 */
/** */
/** Audio Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_audio.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_audio_activate PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function activates the audio class. It may be called twice by */
/* the same device if there is a audio control interface to this */
/* device. */
/* */
/* INPUT */
/* */
/* command Pointer to command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_audio_configure Configure the audio class */
/* _ux_host_class_audio_descriptor_get Get audio descriptor */
/* _ux_host_class_audio_device_controls_list_get Get controls list */
/* _ux_host_class_audio_device_type_get Get device type */
/* _ux_host_class_audio_streaming_terminal_get Get streaming terminal */
/* _ux_host_stack_class_instance_create Create class instance */
/* _ux_host_stack_class_instance_destroy Destroy class instance */
/* _ux_utility_memory_allocate Allocate a memory block */
/* _ux_host_mutex_create Create protection mutex */
/* */
/* CALLED BY */
/* */
/* Audio Class */
/* */
/**************************************************************************/
UINT _ux_host_class_audio_activate(UX_HOST_CLASS_COMMAND *command)
{
UX_INTERFACE *interface_ptr;
UX_HOST_CLASS_AUDIO *audio;
#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)
UX_HOST_CLASS_AUDIO_AC *ac;
UX_ENDPOINT *endp;
UX_TRANSFER *trans;
UCHAR *desc;
UCHAR *iad;
UCHAR *uac10_ifd;
UCHAR *uac10_acd;
UCHAR desc_type;
UCHAR desc_length;
ULONG pos;
ULONG as_count;
#endif
UINT status;
/* The audio is always activated by the interface descriptor and not the
device descriptor. */
interface_ptr = (UX_INTERFACE *) command -> ux_host_class_command_container;
/* Check the subclass of the new device. If it is a Audio Control Interface,
we don't need to create an instance of this function. When we get the streaming interface,
we will search the audio control interface for the device. */
if (interface_ptr -> ux_interface_descriptor.bInterfaceSubClass == UX_HOST_CLASS_AUDIO_SUBCLASS_CONTROL)
{
#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)
/* Allocate memory for AC instance. */
ac = (UX_HOST_CLASS_AUDIO_AC *) _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_HOST_CLASS_AUDIO_AC));
if (ac == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Get descriptor to check AC/AS interfaces layouts. */
ac -> ux_host_class_audio_device = interface_ptr -> ux_interface_configuration -> ux_configuration_device;
status = _ux_host_class_audio_descriptor_get((UX_HOST_CLASS_AUDIO *)ac);
if (status != UX_SUCCESS)
{
_ux_utility_memory_free(ac);
return(status);
}
/* Search for IAD or UAC1.0 AC header descriptor. */
as_count = 0;
iad = UX_NULL;
uac10_acd = UX_NULL;
desc = ac -> ux_host_class_audio_configuration_descriptor;
for (pos = 0; pos < ac -> ux_host_class_audio_configuration_descriptor_length;)
{
/* Get bLength@0, bDescriptorType@1. */
desc_length = *(desc);
desc_type = *(desc + 1);
/* Check length error. */
if (desc_length < 2)
{
_ux_utility_memory_free(ac);
return(UX_DESCRIPTOR_CORRUPTED);
}
/* Check descriptor type. */
switch(desc_type)
{
case UX_INTERFACE_ASSOCIATION_DESCRIPTOR_ITEM:
/* Check bFirstInterface@2, must match AC interface if exist. */
if (desc[2] == interface_ptr -> ux_interface_descriptor.bInterfaceNumber)
iad = desc;
break;
case UX_INTERFACE_DESCRIPTOR_ITEM:
/* Check bInterfaceNumber@2, if no IAD. */
if (desc[2] == interface_ptr -> ux_interface_descriptor.bInterfaceNumber)
uac10_ifd = desc;
else
uac10_ifd = UX_NULL;
break;
case UX_HOST_CLASS_AUDIO_CS_INTERFACE:
/* Check bDescriptorSubtype@3, if inside correct interface. */
if (uac10_ifd)
{
if (desc[2] == UX_HOST_CLASS_AUDIO_CS_HEADER)
uac10_acd = desc;
}
break;
default:
break;
} /* switch(desc_type) */
/* Check if IAD exists. */
if (iad)
{
/* In this case, bFirstInterface@2 is AC, followed ASes. */
/* Use bInterfaceCount@3. */
if (iad[3] <= 1)
{
_ux_utility_memory_free(ac);
return(UX_DESCRIPTOR_CORRUPTED);
}
as_count = (ULONG)iad[3] - 1;
break;
}
/* Check if AC header exists. */
if (uac10_acd)
{
/* In this case, bInCollection@7 is AS count. */
if (desc[7] < 1 || (8 + desc[7]) != desc[0])
{
_ux_utility_memory_free(ac);
return(UX_DESCRIPTOR_CORRUPTED);
}
as_count = (ULONG)uac10_acd[7];
break;
}
/* Move pos and descriptor pointer. */
pos += desc_length;
desc += desc_length;
}
/* If there are too many ASes, reallocate memory. */
if (as_count > 2)
{
_ux_utility_memory_free(ac);
/* as_count - 2 < 255 - 2, so (as_count - 2) * sizeof(UX_HOST_CLASS_AUDIO*) does not overflow. */
/* sizeof(UX_HOST_CLASS_AUDIO_AC) is not big (< 255), total memory size calculation does not overflow. */
ac = (UX_HOST_CLASS_AUDIO_AC *) _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY,
sizeof(UX_HOST_CLASS_AUDIO_AC) + (as_count - 2) * sizeof(UX_HOST_CLASS_AUDIO*));
if (ac == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
}
/* Get interrupt endpoint. */
endp = interface_ptr -> ux_interface_first_endpoint;
while(endp)
{
if (((endp -> ux_endpoint_descriptor.bmAttributes & UX_MASK_ENDPOINT_TYPE) ==
UX_INTERRUPT_ENDPOINT) &&
((endp -> ux_endpoint_descriptor.bEndpointAddress & UX_ENDPOINT_DIRECTION)))
{
ac -> ux_host_class_audio_interrupt_endpoint = endp;
trans = &endp -> ux_endpoint_transfer_request;
/* Allocate buffer. */
trans -> ux_transfer_request_data_pointer =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY,
trans -> ux_transfer_request_packet_length);
if (trans -> ux_transfer_request_data_pointer == UX_NULL)
{
_ux_utility_memory_free(ac);
return(UX_MEMORY_INSUFFICIENT);
}
/* This transfer always have the IN direction. */
trans -> ux_transfer_request_type = UX_REQUEST_IN;
/* This transfer always try read a full packet. */
trans -> ux_transfer_request_requested_length =
trans -> ux_transfer_request_packet_length;
break;
}
endp = endp -> ux_endpoint_next_endpoint;
}
/* If there is no interrupt endpoint, that's fine. */
/* Fill the fields. */
ac -> ux_host_class_audio_class = command -> ux_host_class_command_class_ptr;
ac -> ux_host_class_audio_interface = interface_ptr;
ac -> ux_host_class_audio_device = interface_ptr -> ux_interface_configuration -> ux_configuration_device;
ac -> ux_host_class_audio_configuration_descriptor = ac -> ux_host_class_audio_device -> ux_device_packed_configuration;
ac -> ux_host_class_audio_configuration_descriptor_length = interface_ptr -> ux_interface_configuration -> ux_configuration_descriptor.wTotalLength;
ac -> ux_host_class_audio_as_count = as_count;
/* Link to interface and class. */
interface_ptr -> ux_interface_class_instance = (VOID *)ac;
_ux_host_stack_class_instance_create(ac -> ux_host_class_audio_class, (VOID *)ac);
/* If all is fine and the AC is mounted, we may need to inform the application
if a function has been programmed in the system structure. */
if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
_ux_system_host -> ux_system_host_change_function(UX_DEVICE_INSERTION, ac -> ux_host_class_audio_class, (VOID *) ac);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_AUDIO_ACTIVATE, ac, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, ac, 0, 0, 0)
#endif
return(UX_SUCCESS);
}
/* Obtain memory for this class instance. */
audio = (UX_HOST_CLASS_AUDIO *) _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_HOST_CLASS_AUDIO));
if (audio == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Store the class container into this instance. */
audio -> ux_host_class_audio_class = command -> ux_host_class_command_class_ptr;
/* Store the interface container into the audio class instance. */
audio -> ux_host_class_audio_streaming_interface = interface_ptr;
/* Store the device container into the audio class instance. */
audio -> ux_host_class_audio_device = interface_ptr -> ux_interface_configuration -> ux_configuration_device;
/* This instance of the device must also be stored in the interface container. */
interface_ptr -> ux_interface_class_instance = (VOID *) audio;
/* Create this class instance. */
_ux_host_stack_class_instance_create(audio -> ux_host_class_audio_class, (VOID *) audio);
/* Configure the audio. */
status = _ux_host_class_audio_configure(audio);
/* Get the audio descriptor (all the class specific stuff) and memorize them
as we will need these descriptors to change settings. */
if (status == UX_SUCCESS)
status = _ux_host_class_audio_descriptor_get(audio);
/* Locate the audio device streaming terminal. */
if (status == UX_SUCCESS)
status = _ux_host_class_audio_streaming_terminal_get(audio);
/* Get the audio device type. Here we only support input and output devices. */
if (status == UX_SUCCESS)
status = _ux_host_class_audio_device_type_get(audio);
/* Get the audio device controls. */
#if !defined(UX_HOST_CLASS_AUDIO_DISABLE_CONTROLS)
if (status == UX_SUCCESS)
status = _ux_host_class_audio_device_controls_list_get(audio);
#endif
/* Create the mutex to protect multiple threads from accessing the same
audio instance. */
if (status == UX_SUCCESS)
{
status = _ux_host_mutex_create(&audio -> ux_host_class_audio_mutex, "ux_hot_class_audio_mutex");
if (status != UX_SUCCESS)
status = UX_MUTEX_ERROR;
}
#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)
/* Find AC and link it if there is no error. */
if (status == UX_SUCCESS)
{
ac = (UX_HOST_CLASS_AUDIO_AC *)audio -> ux_host_class_audio_class -> ux_host_class_first_instance;
while(ac)
{
/* Check interface number to see if it's right AC. */
if ((ac -> ux_host_class_audio_interface -> ux_interface_configuration ==
interface_ptr -> ux_interface_configuration) &&
(ac -> ux_host_class_audio_interface -> ux_interface_descriptor.bInterfaceNumber ==
audio -> ux_host_class_audio_control_interface_number) &&
(ac -> ux_host_class_audio_interface -> ux_interface_descriptor.bInterfaceClass ==
UX_HOST_CLASS_AUDIO_CLASS) &&
(ac -> ux_host_class_audio_interface -> ux_interface_descriptor.bInterfaceSubClass ==
UX_HOST_CLASS_AUDIO_SUBCLASS_CONTROL))
{
/* Save AS to AC controlled list. */
for (pos = 0; pos < ac -> ux_host_class_audio_as_count; pos ++)
{
if (ac -> ux_host_class_audio_as[pos] == UX_NULL)
{
/* This AC is for current AS. */
audio -> ux_host_class_audio_ac = ac;
audio -> ux_host_class_audio_ac_as = pos;
ac -> ux_host_class_audio_as[pos] = audio;
break;
}
}
/* If there is no place for AS, something wrong. */
if (pos >= ac -> ux_host_class_audio_as_count)
{
status = UX_DESCRIPTOR_CORRUPTED;
break;
}
}
/* If AC is found and linked, done. */
if (audio -> ux_host_class_audio_ac != UX_NULL)
break;
/* If there is error, break. */
if (status != UX_SUCCESS)
break;
/* Check next AC/AS. */
ac = (UX_HOST_CLASS_AUDIO_AC *)ac -> ux_host_class_audio_next_instance;
}
}
#endif
/* Activate is done success. */
if (status == UX_SUCCESS)
{
/* Mark the audio as live now. */
audio -> ux_host_class_audio_state = UX_HOST_CLASS_INSTANCE_LIVE;
/* If all is fine and the device is mounted, we may need to inform the application
if a function has been programmed in the system structure. */
if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
{
/* Call system change function. */
_ux_system_host -> ux_system_host_change_function(UX_DEVICE_INSERTION, audio -> ux_host_class_audio_class, (VOID *) audio);
}
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_AUDIO_ACTIVATE, audio, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, audio, 0, 0, 0)
/* Return completion status. */
return(UX_SUCCESS);
}
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, status);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, status, audio, 0, 0, UX_TRACE_ERRORS, 0, 0)
#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)
/* When there is error, AC is not linked (last possible error), no need to unlink. */
#endif
/* Error, destroy the class instance. */
_ux_host_stack_class_instance_destroy(audio -> ux_host_class_audio_class, (VOID *) audio);
/* Free resources. */
#if defined(UX_HOST_CLASS_AUDIO_FEEDBACK_SUPPORT)
if (audio -> ux_host_class_audio_feedback_endpoint -> ux_endpoint_transfer_request.ux_transfer_request_data_pointer)
_ux_utility_memory_free(audio -> ux_host_class_audio_feedback_endpoint -> ux_endpoint_transfer_request.ux_transfer_request_data_pointer);
#endif
_ux_utility_memory_free(audio);
/* Unlink instance from interface. */
interface_ptr -> ux_interface_class_instance = UX_NULL;
/* Return the error. */
return(status);
}
|
