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
|
/***************************************************************************
* 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_configure PORTABLE C */
/* 6.1.11 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function calls the USBX stack to do a SET_CONFIGURATION to */
/* the device. Once the device is configured, its interface(s) will */
/* be activated. */
/* */
/* INPUT */
/* */
/* audio Pointer to audio class */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_configuration_interface_get Get interface */
/* _ux_host_stack_device_configuration_get Get configuration */
/* _ux_host_stack_device_configuration_select Select configuration */
/* */
/* CALLED BY */
/* */
/* Audio Class */
/* */
/**************************************************************************/
UINT _ux_host_class_audio_configure(UX_HOST_CLASS_AUDIO *audio)
{
UINT status;
UX_CONFIGURATION *configuration;
UX_INTERFACE *interface;
ULONG interface_number;
#if UX_MAX_DEVICES > 1
UX_DEVICE *parent_device;
#endif
/* If the device has been configured already, we don't need to do it
again. */
if (audio -> ux_host_class_audio_device -> ux_device_state == UX_DEVICE_CONFIGURED)
return(UX_SUCCESS);
/* An audio device normally has one configuration. So retrieve the 1st configuration
only. */
status = _ux_host_stack_device_configuration_get(audio -> ux_host_class_audio_device, 0, &configuration);
if (status != UX_SUCCESS)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONFIGURATION_HANDLE_UNKNOWN);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONFIGURATION_HANDLE_UNKNOWN, audio -> ux_host_class_audio_device, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_CONFIGURATION_HANDLE_UNKNOWN);
}
#if UX_MAX_DEVICES > 1
/* Check the audio power source and check the parent power source for
incompatible connections. */
if (audio -> ux_host_class_audio_device -> ux_device_power_source == UX_DEVICE_BUS_POWERED)
{
/* Get parent device. */
parent_device = audio -> ux_host_class_audio_device -> ux_device_parent;
/* If the device is NULL, the parent is the root audio and we don't have to worry
if the parent is not the root audio, check for its power source. */
if ((parent_device != UX_NULL) && (parent_device -> ux_device_power_source == UX_DEVICE_BUS_POWERED))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONNECTION_INCOMPATIBLE);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONNECTION_INCOMPATIBLE, audio, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_CONNECTION_INCOMPATIBLE);
}
}
#endif
/* We have the valid configuration. Ask the USBX stack to set this configuration */
status = _ux_host_stack_device_configuration_select(configuration);
if (status != 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 -> ux_host_class_audio_device, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(status);
}
/* Start with interface number 0. */
interface_number = 0;
/* We only need to retrieve the audio streaming interface. */
do
{
/* Pickup interface. */
status = _ux_host_stack_configuration_interface_get(configuration, (UINT) interface_number, 0, &interface);
/* Check completion status. */
if (status == UX_SUCCESS)
{
/* Check the type of interface we have found - is it streaming? */
if (interface -> ux_interface_descriptor.bInterfaceSubClass == UX_HOST_CLASS_AUDIO_SUBCLASS_STREAMING)
{
audio -> ux_host_class_audio_streaming_interface = interface;
audio -> ux_host_class_audio_streaming_interface -> ux_interface_class_instance = (VOID *)audio;
break;
}
}
} while(status == UX_SUCCESS);
/* After we have parsed the audio interfaces, ensure the streaming interfaces is resent. */
if (audio -> ux_host_class_audio_streaming_interface == UX_NULL)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_INTERFACE_HANDLE_UNKNOWN);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_INTERFACE_HANDLE_UNKNOWN, interface, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* We get here when we could not locate the interface(s) handle */
return(UX_INTERFACE_HANDLE_UNKNOWN);
}
else
{
return(UX_SUCCESS);
}
}
|