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
|
/***************************************************************************
* 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_control_value_set PORTABLE C */
/* 6.1.12 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function updates the dynamic feature values for a single audio */
/* control on either the master channel or a specific channel. */
/* */
/* Note only control value of BYTE, WORD and DWORD (<4) is supported. */
/* E.g., Graphic Equalizer Control is not supported. */
/* */
/* Note it's not recommended for supporting audio device with complex */
/* pinout scheme, where ux_host_class_audio_descriptors_parse can be */
/* used to build audio pinout scheme, and settings can be changed by */
/* ux_host_class_audio_control_request or ux_host_class_audio_feature */
/* functions. */
/* */
/* INPUT */
/* */
/* audio Pointer to audio class */
/* audio_control Pointer to audio control */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_class_instance_verify Verify instance is valid */
/* _ux_host_stack_transfer_request Process transfer request */
/* _ux_host_semaphore_get Get semaphore */
/* _ux_host_semaphore_put Release semaphore */
/* _ux_host_mutex_on Get mutex */
/* _ux_host_mutex_off Release mutex */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Release memory block */
/* _ux_utility_short_put Write 16-bit value */
/* */
/* CALLED BY */
/* */
/* Application */
/* Audio Class */
/* */
/**************************************************************************/
UINT _ux_host_class_audio_control_value_set(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_CONTROL *audio_control)
{
#if defined(UX_HOST_CLASS_AUDIO_DISABLE_CONTROLS)
UX_PARAMETER_NOT_USED(audio);
UX_PARAMETER_NOT_USED(audio_control);
return(UX_FUNCTION_NOT_SUPPORTED);
#else
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
UINT status;
UCHAR * control_buffer;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_AUDIO_CONTROL_VALUE_SET, audio, audio_control, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Ensure the instance is valid. */
if (_ux_host_stack_class_instance_verify(_ux_system_host_class_audio_name, (VOID *) audio) != UX_SUCCESS)
{
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, audio, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
}
/* Protect thread reentry to this instance. */
_ux_host_mutex_on(&audio -> ux_host_class_audio_mutex);
/* We need to get the default control endpoint transfer request pointer. */
control_endpoint = &audio -> ux_host_class_audio_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
/* Need to allocate memory for the control buffer. */
control_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, 4);
if (control_buffer == UX_NULL)
{
/* Unprotect thread reentry to this instance. */
_ux_host_mutex_off(&audio -> ux_host_class_audio_mutex);
/* Return an error. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Protect the control endpoint semaphore here. It will be unprotected in the
transfer request function. */
status = _ux_host_semaphore_get(&audio -> ux_host_class_audio_device -> ux_device_protection_semaphore, UX_WAIT_FOREVER);
/* Check for status. */
if (status != UX_SUCCESS)
{
/* Something went wrong. */
_ux_utility_memory_free(control_buffer);
_ux_host_mutex_off(&audio -> ux_host_class_audio_mutex);
return(status);
}
/* The buffer should be aligned. Returned data is little endian so DWord can be used
to copy any returned data of BYTE/WORD/DWORD. */
_ux_utility_long_put(control_buffer, audio_control -> ux_host_class_audio_control_cur);
#if defined(UX_HOST_CLASS_AUDIO_2_SUPPORT)
if (_ux_host_class_audio_protocol_get(audio) == UX_HOST_CLASS_AUDIO_PROTOCOL_IP_VERSION_02_00)
{
/* Size RANGE Size
D1..0: Mute 1 2+1*3=5
D3..2: Volume 2 2+2*3=8
D5..4: Bass 1
D7..6: Mid 1
D9..8: Treble 1
D11..10: Graphic Equalizer 4+NrBits
D13..12: Automatic Gain 1
D15..14: Delay 4 2+4*3=14
D17..16: Bass Boost 1
D19..18: Loudness 1
D21..20: Input Gain 2
D23..22: Input Gain Pad 2
D25..24: Phase Inverter 1
D27..26: Underflow 1
D29..28: Overflow 1
*/
if (audio_control -> ux_host_class_audio_control == UX_CLASS_AUDIO20_FU_DELAY_CONTROL)
transfer_request -> ux_transfer_request_requested_length = 4;
else if ((audio_control -> ux_host_class_audio_control == UX_CLASS_AUDIO20_FU_VOLUME_CONTROL) ||
(audio_control -> ux_host_class_audio_control == UX_CLASS_AUDIO20_FU_INPUT_GAIN_CONTROL) ||
(audio_control -> ux_host_class_audio_control == UX_CLASS_AUDIO20_FU_INPUT_GAIN_PAD_CONTROL))
transfer_request -> ux_transfer_request_requested_length = 2;
else if ((audio_control -> ux_host_class_audio_control != UX_CLASS_AUDIO20_FU_GRAPHIC_EQUALIZER_CONTROL) &&
(audio_control -> ux_host_class_audio_control <= 14))
transfer_request -> ux_transfer_request_requested_length = 1;
else
{
/* Something went wrong. */
_ux_utility_memory_free(control_buffer);
_ux_host_semaphore_put(&audio -> ux_host_class_audio_device -> ux_device_protection_semaphore);
_ux_host_mutex_off(&audio -> ux_host_class_audio_mutex);
return(UX_INVALID_PARAMETER);
}
}
else
#endif
{
/* Size
D0: Mute 1
D1: Volume 2
D2: Bass 1
D3: Mid 1
D4: Treble 1
D5: Graphic Equalizer 4+NrBits
D6: Automatic Gain 1
D7: Delay 2
D8: Bass Boost 1
D9: Loudness 1
*/
if ((audio_control -> ux_host_class_audio_control == UX_HOST_CLASS_AUDIO_MUTE_CONTROL) ||
(audio_control -> ux_host_class_audio_control == UX_HOST_CLASS_AUDIO_DELAY_CONTROL))
transfer_request -> ux_transfer_request_requested_length = 2;
else if ((audio_control -> ux_host_class_audio_control <= 9) &&
(audio_control -> ux_host_class_audio_control != UX_HOST_CLASS_AUDIO_GRAPHIC_EQUALIZER_CONTROL))
transfer_request -> ux_transfer_request_requested_length = 1;
else
{
/* Something went wrong. */
_ux_utility_memory_free(control_buffer);
_ux_host_semaphore_put(&audio -> ux_host_class_audio_device -> ux_device_protection_semaphore);
_ux_host_mutex_off(&audio -> ux_host_class_audio_mutex);
return(UX_INVALID_PARAMETER);
}
}
/* Create a transfer request for the SET_CUR request. */
transfer_request -> ux_transfer_request_data_pointer = control_buffer;
#if defined(UX_HOST_CLASS_AUDIO_2_SUPPORT)
transfer_request -> ux_transfer_request_function = (_ux_host_class_audio_protocol_get(audio) == UX_HOST_CLASS_AUDIO_PROTOCOL_IP_VERSION_02_00) ?
UX_CLASS_AUDIO20_CUR :
UX_HOST_CLASS_AUDIO_SET_CUR;
#else
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_AUDIO_SET_CUR;
#endif
transfer_request -> ux_transfer_request_type = UX_REQUEST_OUT | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = audio_control -> ux_host_class_audio_control_channel | (audio_control -> ux_host_class_audio_control << 8);
transfer_request -> ux_transfer_request_index = audio -> ux_host_class_audio_control_interface_number | (audio -> ux_host_class_audio_feature_unit_id << 8);
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_request(transfer_request);
/* Free all used resources. */
_ux_utility_memory_free(control_buffer);
/* Unprotect thread reentry to this instance. */
_ux_host_mutex_off(&audio -> ux_host_class_audio_mutex);
/* Return completion status. */
return(status);
#endif
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_audio_control_value_set PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in audio control value set function */
/* call. */
/* */
/* INPUT */
/* */
/* audio Pointer to audio class */
/* audio_control Pointer to audio control */
/* */
/* OUTPUT */
/* */
/* Status */
/* */
/* CALLS */
/* */
/* _uxe_host_class_audio_control_value_set */
/* Set audio control value */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_class_audio_control_value_set(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_CONTROL *audio_control)
{
if ((audio == UX_NULL) || (audio_control == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Invoke audio control set function. */
return(_ux_host_class_audio_control_value_set(audio, audio_control));
}
|
