summaryrefslogtreecommitdiff
path: root/common/usbx_host_classes/src/ux_host_class_audio_control_request.c
blob: 81ca403825ad9e136e76b2afacc652ff85b444b6 (plain)
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
/***************************************************************************
 * 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_request                PORTABLE C      */
/*                                                           6.1.12       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function issue audio specific control request.                 */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    audio                                 Pointer to audio class        */
/*    streaming_control                     0 for control requests        */
/*                                          1 for streaming requests      */
/*    request_type                          bmRequestType                 */
/*    request                               bRequest                      */
/*    request_value                         wValue can be:                */
/*                                          (CS << 8)  | CN or            */
/*                                          (ICN << 8) | OCN or           */
/*                                          (MU_MIXER_CONTROL << 8) | MCN */
/*                                          or other specific value.      */
/*    spec_id                               Entity/Language ID (if used)  */
/*    parameter                             Pointer to request parameters */
/*    parameter_size                        Request parameters length     */
/*    actual_size                           Actual processed size         */
/*                                                                        */
/*  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_mutex_on                     Get mutex                     */
/*    _ux_host_mutex_off                    Release mutex                 */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*    Audio Class                                                         */
/*                                                                        */
/**************************************************************************/
UINT    _ux_host_class_audio_control_request(UX_HOST_CLASS_AUDIO *audio,
                        UINT streaming_control,
                        UINT request_type, UINT request,
                        UINT request_value,
                        UINT spec_id,
                        UCHAR *parameter, ULONG parameter_size, ULONG *actual_size)
{

UX_ENDPOINT     *control_endpoint;
UX_TRANSFER     *transfer_request;
ULONG           request_index = 0;
UINT            status;


    /* Ensure the instance is valid.  */
    if (_ux_host_stack_class_instance_verify(_ux_system_host_class_audio_name, (VOID *) audio) != UX_SUCCESS)
    {

        /* Error trap. */
        _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_INSTANCE_UNKNOWN);

        /* 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);
    }

    /* Check request settings.  */
    switch(request_type & UX_REQUEST_TARGET)
    {
    case UX_REQUEST_TARGET_INTERFACE:
        request_index = streaming_control ?
                        audio -> ux_host_class_audio_streaming_interface -> ux_interface_descriptor.bInterfaceNumber :
                        audio -> ux_host_class_audio_control_interface_number;
        break;
    case UX_REQUEST_TARGET_ENDPOINT:
        request_index = audio -> ux_host_class_audio_isochronous_endpoint -> ux_endpoint_descriptor.bEndpointAddress;
        break;
    default:
        return(UX_INVALID_PARAMETER);
    }

    /* 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;

    /* 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_host_mutex_off(&audio -> ux_host_class_audio_mutex);
        return(status);
    }

    /* Create a transfer request for the specific setting.  */
    transfer_request -> ux_transfer_request_data_pointer =      parameter;
    transfer_request -> ux_transfer_request_requested_length =  parameter_size;
    transfer_request -> ux_transfer_request_function =          request;
    transfer_request -> ux_transfer_request_type =              request_type;
    transfer_request -> ux_transfer_request_value =             request_value;
    transfer_request -> ux_transfer_request_index =             request_index | (spec_id << 8);

    /* Send request to HCD layer.  */
    status =  _ux_host_stack_transfer_request(transfer_request);

    /* Save actual size.  */
    if (actual_size)
        *actual_size = transfer_request -> ux_transfer_request_actual_length;

    /* Unprotect thread reentry to this instance.  */
    _ux_host_mutex_off(&audio -> ux_host_class_audio_mutex);

    /* Return completion status.  */
    return(status);
}


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _uxe_host_class_audio_control_request               PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks errors in audio control request function call. */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    audio                                 Pointer to audio class        */
/*    streaming_control                     0 for control requests        */
/*                                          1 for streaming requests      */
/*    request_type                          bmRequestType                 */
/*    request                               bRequest                      */
/*    request_value                         wValue can be:                */
/*                                          (CS << 8)  | CN or            */
/*                                          (ICN << 8) | OCN or           */
/*                                          (MU_MIXER_CONTROL << 8) | MCN */
/*                                          or other specific value.      */
/*    spec_id                               Entity/Language ID (if used)  */
/*    parameter                             Pointer to request parameters */
/*    parameter_size                        Request parameters length     */
/*    actual_size                           Actual processed size         */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Status                                                              */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_class_audio_control_request  Get audio control request     */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*    Audio Class                                                         */
/*                                                                        */
/**************************************************************************/
UINT    _uxe_host_class_audio_control_request(UX_HOST_CLASS_AUDIO *audio,
                        UINT streaming_control,
                        UINT request_type, UINT request,
                        UINT request_value,
                        UINT spec_id,
                        UCHAR *parameter, ULONG parameter_size, ULONG *actual_size)
{

    /* Sanity check.  */
    if ((audio == UX_NULL))
        return(UX_INVALID_PARAMETER);

    /* Invoke audio control request function.  */
    return(_ux_host_class_audio_control_request(audio,
                            streaming_control,
                            request_type, request, request_value,
                            spec_id, parameter, parameter_size, actual_size));
}