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
|
/***************************************************************************
* 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 */
/** */
/** Video Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_video.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_video_frame_parameters_set PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sets the video parameters for the video device. */
/* */
/* INPUT */
/* */
/* video Pointer to video class */
/* frame_format Video format to use */
/* width Video frame width */
/* height Video frame height */
/* frame_interval Video frame interval */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_video_format_data_get Get format data */
/* _ux_host_class_video_frame_data_get Get frame data */
/* _ux_host_stack_transfer_request Process transfer request */
/* _ux_utility_descriptor_parse Parse descriptor */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Release memory block */
/* _ux_host_semaphore_get Get semaphore */
/* _ux_host_semaphore_put Put semaphore */
/* _ux_utility_long_get Read 32-bit value */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _ux_host_class_video_frame_parameters_set(UX_HOST_CLASS_VIDEO *video, ULONG frame_format, ULONG width, ULONG height, ULONG frame_interval)
{
UX_HOST_CLASS_VIDEO_PARAMETER_FORMAT_DATA format_parameter;
UX_HOST_CLASS_VIDEO_PARAMETER_FRAME_DATA frame_parameter;
ULONG format_index;
ULONG frame_index;
UINT status;
ULONG min_frame_interval;
ULONG max_frame_interval;
ULONG frame_interval_step;
ULONG i;
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
UINT streaming_interface;
UCHAR *control_buffer;
ULONG max_payload_size;
/* Find the requested frame format. */
for (format_index = 1; format_index <= video -> ux_host_class_video_number_formats; format_index++)
{
/* Get format data for current format index. */
format_parameter.ux_host_class_video_parameter_format_requested = format_index;
status = _ux_host_class_video_format_data_get(video, &format_parameter);
if (status != UX_SUCCESS)
{
return(status);
}
/* Check if the format type is the one requested. */
if (format_parameter.ux_host_class_video_parameter_format_subtype == frame_format)
{
/* Save number of frames in the video instance. */
video -> ux_host_class_video_number_frames = format_parameter.ux_host_class_video_parameter_number_frame_descriptors;
/* The format is found and break the loop. */
break;
}
}
/* Check if the requested format is found. */
if (format_index > video -> ux_host_class_video_number_formats)
{
return(UX_HOST_CLASS_VIDEO_PARAMETER_ERROR);
}
/* Find the requested frame resolution. */
for (frame_index = 1; frame_index <= video -> ux_host_class_video_number_frames; frame_index++)
{
/* Get frame data for current frame index. */
frame_parameter.ux_host_class_video_parameter_frame_requested = frame_index;
status = _ux_host_class_video_frame_data_get(video, &frame_parameter);
if (status != UX_SUCCESS)
{
return(status);
}
/* Check the frame resolution. */
if (frame_parameter.ux_host_class_video_parameter_frame_width == width &&
frame_parameter.ux_host_class_video_parameter_frame_height == height)
{
/* Save the current frame index. */
video -> ux_host_class_video_current_frame = frame_index;
/* The requested resolution is found, break the loop. */
break;
}
}
/* Check if the requested resolution is found. */
if (frame_index > video -> ux_host_class_video_number_frames)
{
return(UX_HOST_CLASS_VIDEO_PARAMETER_ERROR);
}
/* Initial status for frame interval checking. */
status = UX_HOST_CLASS_VIDEO_PARAMETER_ERROR;
/* Check the frame interval type. */
if (frame_parameter.ux_host_class_video_parameter_frame_interval_type == 0)
{
/* Frame interval type is continuous. */
min_frame_interval = _ux_utility_long_get(frame_parameter.ux_host_class_video_parameter_frame_intervals);
max_frame_interval = _ux_utility_long_get(frame_parameter.ux_host_class_video_parameter_frame_intervals + 4);
frame_interval_step = _ux_utility_long_get(frame_parameter.ux_host_class_video_parameter_frame_intervals + 8);
/* Check if the frame interval is valid. */
if (frame_interval >= min_frame_interval && frame_interval <= max_frame_interval &&
((frame_interval_step == 0) ||
(frame_interval - min_frame_interval) % frame_interval_step == 0))
{
/* Save the frame interval. */
video -> ux_host_class_video_current_frame_interval = frame_interval;
status = UX_SUCCESS;
}
}
else
{
/* Frame interval type is discrete. */
for(i = 0; i < frame_parameter.ux_host_class_video_parameter_frame_interval_type; i++)
{
/* Check if the requested frame interval is valid. */
if (frame_interval == _ux_utility_long_get(frame_parameter.ux_host_class_video_parameter_frame_intervals + i * sizeof(ULONG)))
{
/* Save the frame interval. */
video -> ux_host_class_video_current_frame_interval = frame_interval;
status = UX_SUCCESS;
}
}
}
if (status != UX_SUCCESS)
return(UX_HOST_CLASS_VIDEO_PARAMETER_ERROR);
/* Protect thread reentry to this instance. */
status = _ux_host_semaphore_get(&video -> ux_host_class_video_semaphore, UX_WAIT_FOREVER);
if (status != UX_SUCCESS)
return(status);
/* We need to get the default control endpoint transfer request pointer. */
control_endpoint = &video -> ux_host_class_video_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
/* Get the interface number of the video streaming interface. */
streaming_interface = video -> ux_host_class_video_streaming_interface -> ux_interface_descriptor.bInterfaceNumber;
/* Need to allocate memory for the control_buffer. */
control_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_VIDEO_PROBE_COMMIT_LENGTH);
if (control_buffer == UX_NULL)
{
/* Unprotect thread reentry to this instance. */
_ux_host_semaphore_put(&video -> ux_host_class_video_semaphore);
/* Return error. */
return(UX_MEMORY_INSUFFICIENT);
}
*(control_buffer + UX_HOST_CLASS_VIDEO_PROBE_COMMIT_FORMAT_INDEX) = (UCHAR)format_index;
*(control_buffer + UX_HOST_CLASS_VIDEO_PROBE_COMMIT_FRAME_INDEX) = (UCHAR)frame_index;
_ux_utility_long_put(control_buffer + UX_HOST_CLASS_VIDEO_PROBE_COMMIT_FRAME_INTERVAL, frame_interval);
/* Create a transfer request for the SET_CUR buffer request. */
transfer_request -> ux_transfer_request_data_pointer = control_buffer;
transfer_request -> ux_transfer_request_requested_length = UX_HOST_CLASS_VIDEO_PROBE_COMMIT_LENGTH;
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_VIDEO_SET_CUR;
transfer_request -> ux_transfer_request_type = UX_REQUEST_OUT | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = UX_HOST_CLASS_VIDEO_VS_PROBE_CONTROL << 8;
transfer_request -> ux_transfer_request_index = streaming_interface;
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_request(transfer_request);
/* Check for correct transfer. Buffer may not be all what we asked for. */
if (status == UX_SUCCESS)
{
/* Create a transfer request for the GET_CUR buffer request. */
transfer_request -> ux_transfer_request_data_pointer = control_buffer;
transfer_request -> ux_transfer_request_requested_length = UX_HOST_CLASS_VIDEO_PROBE_COMMIT_LENGTH;
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_VIDEO_GET_CUR;
transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = UX_HOST_CLASS_VIDEO_VS_PROBE_CONTROL << 8;
transfer_request -> ux_transfer_request_index = streaming_interface;
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_request(transfer_request);
}
/* Get the max payload transfer size returned from video device. */
max_payload_size = _ux_utility_long_get(control_buffer + UX_HOST_CLASS_VIDEO_PROBE_COMMIT_MAX_PAYLOAD_TRANSFER_SIZE);
/* Validate if the payload size is inside isochronouse packet payload. */
if (max_payload_size == 0)
status = UX_HOST_CLASS_VIDEO_PARAMETER_ERROR;
else
{
if (video -> ux_host_class_video_device -> ux_device_speed != UX_HIGH_SPEED_DEVICE)
{
if (max_payload_size > 1023)
status = UX_HOST_CLASS_VIDEO_PARAMETER_ERROR;
}
else
{
if (max_payload_size > (1024 * 3))
status = UX_HOST_CLASS_VIDEO_PARAMETER_ERROR;
}
}
/* Free all used resources. */
_ux_utility_memory_free(control_buffer);
/* Unprotect thread reentry to this instance. */
_ux_host_semaphore_put(&video -> ux_host_class_video_semaphore);
/* Check the transfer status. */
if (status == UX_SUCCESS)
{
/* Save the maximum payload size returned by the device. */
video -> ux_host_class_video_current_max_payload_size = max_payload_size;
return(UX_SUCCESS);
}
else
{
/* The probe process failed. Return error. */
return(UX_HOST_CLASS_VIDEO_PARAMETER_ERROR);
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_video_frame_parameters_set PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in video frame parameters set function */
/* call. */
/* */
/* INPUT */
/* */
/* video Pointer to video class */
/* frame_format Video format to use */
/* width Video frame width */
/* height Video frame height */
/* frame_interval Video frame interval */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_video_frame_parameters_set */
/* Video frame parameters set */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_class_video_frame_parameters_set(UX_HOST_CLASS_VIDEO *video, ULONG frame_format, ULONG width, ULONG height, ULONG frame_interval)
{
/* Sanity checks. */
if (video == UX_NULL)
return(UX_INVALID_PARAMETER);
/* Call the actual video frame parameters set function. */
return(_ux_host_class_video_frame_parameters_set(video, frame_format, width, height, frame_interval));
}
|
