summaryrefslogtreecommitdiff
path: root/common/usbx_device_classes/src/ux_device_class_video_control_request.c
blob: 2451b239e3ce6f0a6afff4ff2ca8100b2c816244 (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
229
230
231
232
233
234
/***************************************************************************
 * 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 Video Class                                                  */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define UX_SOURCE_CODE


/* Include necessary system files.  */

#include "ux_api.h"
#include "ux_device_class_video.h"
#include "ux_device_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_video_control_request              PORTABLE C      */
/*                                                           6.1.11       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function manages the based sent by the host on the control     */
/*    endpoints with a CLASS or VENDOR SPECIFIC type.                     */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                               Pointer to class command      */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_device_stack_endpoint_stall       Endpoint stall                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Device Video Class                                                  */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_video_control_request(UX_SLAVE_CLASS_COMMAND *command)
{

UX_SLAVE_TRANSFER             *transfer_request;
UX_SLAVE_DEVICE               *device;
UX_SLAVE_CLASS                *class_inst;
UX_DEVICE_CLASS_VIDEO         *video;
UX_DEVICE_CLASS_VIDEO_STREAM  *stream;
ULONG                         stream_index;
UCHAR                         request_type;
UCHAR                         request;
UCHAR                         index_low;
ULONG                         value_cs;
UCHAR                         *buffer;
UINT                          status;


    /* Get the class container.  */
    class_inst =  command -> ux_slave_class_command_class_ptr;

    /* Get the video instance from this class container.  */
    video =  (UX_DEVICE_CLASS_VIDEO *) class_inst -> ux_slave_class_instance;

    /* Get the pointer to the device.  */
    device =  &_ux_system_slave -> ux_system_slave_device;

    /* Get the pointer to the transfer request associated with the control endpoint.  */
    transfer_request =  &device -> ux_slave_device_control_endpoint.ux_slave_endpoint_transfer_request;

    /* Get bmRequestType, wValue and wIndex low byte.  */
    request_type = transfer_request -> ux_slave_transfer_request_setup[UX_SETUP_REQUEST_TYPE];
    request = transfer_request -> ux_slave_transfer_request_setup[UX_SETUP_REQUEST];
    value_cs = transfer_request -> ux_slave_transfer_request_setup[UX_SETUP_VALUE + 1];
    index_low = transfer_request -> ux_slave_transfer_request_setup[UX_SETUP_INDEX];
    buffer = transfer_request -> ux_slave_transfer_request_data_pointer;

    /* Check request target (only target interface is supported now).  */
    if ((request_type & UX_REQUEST_TARGET) != UX_REQUEST_TARGET_INTERFACE)
        return(UX_ERROR);

    /* Check request interface (wIndex low) of control.  */
    if (index_low == video -> ux_device_class_video_interface -> ux_slave_interface_descriptor.bInterfaceNumber)
    {

        /* Check control selector.  */
        switch(value_cs)
        {
        case UX_DEVICE_CLASS_VIDEO_VC_REQUEST_ERROR_CODE_CONTROL:

            /* Must have at least 1 byte buffer.  */
            if (transfer_request->ux_slave_transfer_request_requested_length < 1)
                return(UX_ERROR);

            /* GET_CUR.  */
            if (request == UX_DEVICE_CLASS_VIDEO_GET_CUR)
            {

                /* Fill bRequestErrorCode.  */
                *buffer = (UCHAR)video -> ux_device_class_video_error;

                /* Send data.  */
                status = _ux_device_stack_transfer_request(transfer_request, 1, 1);
                return(status);
            }

            /* GET_INFO.  */
            if (request == UX_DEVICE_CLASS_VIDEO_GET_INFO)
            {

                /* Support GET_CUR | GET_INFO.  */
                *buffer = UX_DEVICE_CLASS_VIDEO_INFO_GET_REQUEST_SUPPORT;

                /* Send data.  */
                status = _ux_device_stack_transfer_request(transfer_request, 1, 1);
                return(status);
            }

            /* Request not expected.  */
            return(UX_ERROR);

        default:
            break;
        }

        /* By default it's not handled.  */
        status = UX_ERROR;

        /* Invoke callback.  */
        if (video -> ux_device_class_video_callbacks.ux_device_class_video_request != UX_NULL)
        {

            /* Handled by callback.  */
            status = video -> ux_device_class_video_callbacks.ux_device_class_video_request(video, transfer_request);
        }
        return(status);
    }

    /* Check request index of stream.  */
    stream = video -> ux_device_class_video_streams;
    for (stream_index = 0; stream_index < video -> ux_device_class_video_streams_nb; stream_index ++)
    {

        /* No stream.  */
        if (stream -> ux_device_class_video_stream_interface == UX_NULL)
            break;

        /* Check interface number.  */
        if (index_low == stream -> ux_device_class_video_stream_interface ->
                                ux_slave_interface_descriptor.bInterfaceNumber)
        {

            /* Check control selector.  */
            switch(value_cs)
            {
            case UX_DEVICE_CLASS_VIDEO_VS_STREAM_ERROR_CODE_CONTROL:

                /* Must have at least 1 byte buffer.  */
                if (transfer_request->ux_slave_transfer_request_requested_length < 1)
                    return(UX_ERROR);

                /* GET_CUR.  */
                if (request == UX_DEVICE_CLASS_VIDEO_GET_CUR)
                {

                    /* Fill bRequestErrorCode.  */
                    *buffer = (UCHAR)stream -> ux_device_class_video_stream_error;

                    /* Send data.  */
                    status = _ux_device_stack_transfer_request(transfer_request, 1, 1);
                    return(status);
                }

                /* GET_INFO.  */
                if (request == UX_DEVICE_CLASS_VIDEO_GET_INFO)
                {

                    /* Support GET_CUR | GET_INFO.  */
                    *buffer = UX_DEVICE_CLASS_VIDEO_INFO_GET_REQUEST_SUPPORT;

                    /* Send data.  */
                    status = _ux_device_stack_transfer_request(transfer_request, 1, 1);
                    return(status);
                }

                /* Request not expected.  */
                return(UX_ERROR);

            default:
                break;
            }

            /* By default it's not handled.  */
            status = UX_ERROR;

            /* Invoke callback.  */
            if (stream -> ux_device_class_video_stream_callbacks.ux_device_class_video_stream_request != UX_NULL)
            {

                /* Handled by callback.  */
                status = stream -> ux_device_class_video_stream_callbacks.ux_device_class_video_stream_request(stream, transfer_request);
            }
            return(status);
        }

        /* Next stream.  */
        stream ++;
    }

    /* Not handled.  */
    return(UX_ERROR);
}