Debian Codegraph @

contrib/freebsd/include/linux/videodev2.h

raw
1 /* SPDX-License-Identifier: ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) */
2 /*
3 * Video for Linux Two header file
4 *
5 * Copyright (C) 1999-2012 the contributors
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * Alternatively you can redistribute this file under the terms of the
18 * BSD license as stated below:
19 *
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
22 * are met:
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in
27 * the documentation and/or other materials provided with the
28 * distribution.
29 * 3. The names of its contributors may not be used to endorse or promote
30 * products derived from this software without specific prior written
31 * permission.
32 *
33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
36 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
39 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
40 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
41 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
42 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
43 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 *
45 * Header file for v4l or V4L2 drivers and applications
46 * with public API.
47 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
48 * no #if __KERNEL tests are allowed here
49 *
50 * See https://linuxtv.org for more info
51 *
52 * Author: Bill Dirks <[email protected]>
53 * Justin Schoeman
54 * Hans Verkuil <[email protected]>
55 * et al.
56 */
57 #ifndef __LINUX_VIDEODEV2_H
58 #define __LINUX_VIDEODEV2_H
59
60 #include <stdint.h>
61 #include <sys/time.h>
62 #include <sys/types.h>
63 #include <sys/ioctl.h>
64
65 #ifndef HAVE_LINUX_INTEGER_TYPES
66 /* XXX remove when depending software has been updated */
67 #ifndef __u64
68 typedef uint64_t __u64;
69 #endif
70 #ifndef __u32
71 typedef uint32_t __u32;
72 #endif
73 #ifndef __u16
74 typedef uint16_t __u16;
75 #endif
76 #ifndef __u8
77 typedef uint8_t __u8;
78 #endif
79
80 #ifndef __s64
81 typedef int64_t __s64;
82 #endif
83 #ifndef __s32
84 typedef int32_t __s32;
85 #endif
86 #ifndef __s16
87 typedef int16_t __s16;
88 #endif
89 #ifndef __s8
90 typedef int8_t __s8;
91 #endif
92 #endif
93
94 #ifdef __KERNEL__
95 #include <linux/ioctl.h>
96 #include <linux/types.h>
97 #endif
98 #include <linux/v4l2-common.h>
99 #include <linux/v4l2-controls.h>
100
101 /*
102 * Common stuff for both V4L1 and V4L2
103 * Moved from videodev.h
104 */
105 #define VIDEO_MAX_FRAME 32
106 #define VIDEO_MAX_PLANES 8
107
108 /*
109 * M I S C E L L A N E O U S
110 */
111
112 /* Four-character-code (FOURCC) */
113 #define v4l2_fourcc(a, b, c, d)\
114 ((uint32_t)(a) | ((uint32_t)(b) << 8) | ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
115 #define v4l2_fourcc_be(a, b, c, d) (v4l2_fourcc(a, b, c, d) | (1U << 31))
116
117 /*
118 * E N U M S
119 */
120 enum v4l2_field {
121 V4L2_FIELD_ANY = 0, /* driver can choose from none,
122 top, bottom, interlaced
123 depending on whatever it thinks
124 is approximate ... */
125 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
126 V4L2_FIELD_TOP = 2, /* top field only */
127 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
128 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
129 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
130 buffer, top-bottom order */
131 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
132 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
133 separate buffers */
134 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
135 first and the top field is
136 transmitted first */
137 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
138 first and the bottom field is
139 transmitted first */
140 };
141 #define V4L2_FIELD_HAS_TOP(field) \
142 ((field) == V4L2_FIELD_TOP ||\
143 (field) == V4L2_FIELD_INTERLACED ||\
144 (field) == V4L2_FIELD_INTERLACED_TB ||\
145 (field) == V4L2_FIELD_INTERLACED_BT ||\
146 (field) == V4L2_FIELD_SEQ_TB ||\
147 (field) == V4L2_FIELD_SEQ_BT)
148 #define V4L2_FIELD_HAS_BOTTOM(field) \
149 ((field) == V4L2_FIELD_BOTTOM ||\
150 (field) == V4L2_FIELD_INTERLACED ||\
151 (field) == V4L2_FIELD_INTERLACED_TB ||\
152 (field) == V4L2_FIELD_INTERLACED_BT ||\
153 (field) == V4L2_FIELD_SEQ_TB ||\
154 (field) == V4L2_FIELD_SEQ_BT)
155 #define V4L2_FIELD_HAS_BOTH(field) \
156 ((field) == V4L2_FIELD_INTERLACED ||\
157 (field) == V4L2_FIELD_INTERLACED_TB ||\
158 (field) == V4L2_FIELD_INTERLACED_BT ||\
159 (field) == V4L2_FIELD_SEQ_TB ||\
160 (field) == V4L2_FIELD_SEQ_BT)
161 #define V4L2_FIELD_HAS_T_OR_B(field) \
162 ((field) == V4L2_FIELD_BOTTOM ||\
163 (field) == V4L2_FIELD_TOP ||\
164 (field) == V4L2_FIELD_ALTERNATE)
165 #define V4L2_FIELD_IS_INTERLACED(field) \
166 ((field) == V4L2_FIELD_INTERLACED ||\
167 (field) == V4L2_FIELD_INTERLACED_TB ||\
168 (field) == V4L2_FIELD_INTERLACED_BT)
169 #define V4L2_FIELD_IS_SEQUENTIAL(field) \
170 ((field) == V4L2_FIELD_SEQ_TB ||\
171 (field) == V4L2_FIELD_SEQ_BT)
172
173 enum v4l2_buf_type {
174 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
175 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
176 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
177 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
178 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
179 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
180 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
181 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
182 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
183 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
184 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
185 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
186 V4L2_BUF_TYPE_META_CAPTURE = 13,
187 V4L2_BUF_TYPE_META_OUTPUT = 14,
188 /*
189 * Note: V4L2_TYPE_IS_VALID and V4L2_TYPE_IS_OUTPUT must
190 * be updated if a new type is added.
191 */
192 /* Deprecated, do not use */
193 V4L2_BUF_TYPE_PRIVATE = 0x80,
194 };
195
196 #define V4L2_TYPE_IS_VALID(type) \
197 ((type) >= V4L2_BUF_TYPE_VIDEO_CAPTURE &&\
198 (type) <= V4L2_BUF_TYPE_META_OUTPUT)
199
200 #define V4L2_TYPE_IS_MULTIPLANAR(type) \
201 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
202 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
203
204 #define V4L2_TYPE_IS_OUTPUT(type) \
205 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
206 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
207 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
208 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
209 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
210 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT \
211 || (type) == V4L2_BUF_TYPE_META_OUTPUT)
212
213 #define V4L2_TYPE_IS_CAPTURE(type) \
214 (V4L2_TYPE_IS_VALID(type) && !V4L2_TYPE_IS_OUTPUT(type))
215
216 enum v4l2_tuner_type {
217 V4L2_TUNER_RADIO = 1,
218 V4L2_TUNER_ANALOG_TV = 2,
219 V4L2_TUNER_DIGITAL_TV = 3,
220 V4L2_TUNER_SDR = 4,
221 V4L2_TUNER_RF = 5,
222 };
223
224 /* Deprecated, do not use */
225 #define V4L2_TUNER_ADC V4L2_TUNER_SDR
226
227 enum v4l2_memory {
228 V4L2_MEMORY_MMAP = 1,
229 V4L2_MEMORY_USERPTR = 2,
230 V4L2_MEMORY_OVERLAY = 3,
231 V4L2_MEMORY_DMABUF = 4,
232 };
233
234 /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
235 enum v4l2_colorspace {
236 /*
237 * Default colorspace, i.e. let the driver figure it out.
238 * Can only be used with video capture.
239 */
240 V4L2_COLORSPACE_DEFAULT = 0,
241
242 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
243 V4L2_COLORSPACE_SMPTE170M = 1,
244
245 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
246 V4L2_COLORSPACE_SMPTE240M = 2,
247
248 /* Rec.709: used for HDTV */
249 V4L2_COLORSPACE_REC709 = 3,
250
251 /*
252 * Deprecated, do not use. No driver will ever return this. This was
253 * based on a misunderstanding of the bt878 datasheet.
254 */
255 V4L2_COLORSPACE_BT878 = 4,
256
257 /*
258 * NTSC 1953 colorspace. This only makes sense when dealing with
259 * really, really old NTSC recordings. Superseded by SMPTE 170M.
260 */
261 V4L2_COLORSPACE_470_SYSTEM_M = 5,
262
263 /*
264 * EBU Tech 3213 PAL/SECAM colorspace.
265 */
266 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
267
268 /*
269 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
270 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
271 */
272 V4L2_COLORSPACE_JPEG = 7,
273
274 /* For RGB colorspaces such as produces by most webcams. */
275 V4L2_COLORSPACE_SRGB = 8,
276
277 /* opRGB colorspace */
278 V4L2_COLORSPACE_OPRGB = 9,
279
280 /* BT.2020 colorspace, used for UHDTV. */
281 V4L2_COLORSPACE_BT2020 = 10,
282
283 /* Raw colorspace: for RAW unprocessed images */
284 V4L2_COLORSPACE_RAW = 11,
285
286 /* DCI-P3 colorspace, used by cinema projectors */
287 V4L2_COLORSPACE_DCI_P3 = 12,
288
289 };
290
291 /*
292 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
293 * This depends on whether this is a SDTV image (use SMPTE 170M), an
294 * HDTV image (use Rec. 709), or something else (use sRGB).
295 */
296 #define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
297 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
298 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
299
300 enum v4l2_xfer_func {
301 /*
302 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
303 * for the various colorspaces:
304 *
305 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
306 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
307 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
308 *
309 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
310 *
311 * V4L2_COLORSPACE_OPRGB: V4L2_XFER_FUNC_OPRGB
312 *
313 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
314 *
315 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
316 *
317 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
318 */
319 V4L2_XFER_FUNC_DEFAULT = 0,
320 V4L2_XFER_FUNC_709 = 1,
321 V4L2_XFER_FUNC_SRGB = 2,
322 V4L2_XFER_FUNC_OPRGB = 3,
323 V4L2_XFER_FUNC_SMPTE240M = 4,
324 V4L2_XFER_FUNC_NONE = 5,
325 V4L2_XFER_FUNC_DCI_P3 = 6,
326 V4L2_XFER_FUNC_SMPTE2084 = 7,
327 };
328
329 /*
330 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
331 * This depends on the colorspace.
332 */
333 #define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
334 ((colsp) == V4L2_COLORSPACE_OPRGB ? V4L2_XFER_FUNC_OPRGB : \
335 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
336 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
337 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
338 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
339 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
340
341 enum v4l2_ycbcr_encoding {
342 /*
343 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
344 * various colorspaces:
345 *
346 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
347 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_SRGB,
348 * V4L2_COLORSPACE_OPRGB and V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
349 *
350 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
351 *
352 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
353 *
354 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
355 */
356 V4L2_YCBCR_ENC_DEFAULT = 0,
357
358 /* ITU-R 601 -- SDTV */
359 V4L2_YCBCR_ENC_601 = 1,
360
361 /* Rec. 709 -- HDTV */
362 V4L2_YCBCR_ENC_709 = 2,
363
364 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
365 V4L2_YCBCR_ENC_XV601 = 3,
366
367 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
368 V4L2_YCBCR_ENC_XV709 = 4,
369
370 /*
371 * sYCC (Y'CbCr encoding of sRGB), identical to ENC_601. It was added
372 * originally due to a misunderstanding of the sYCC standard. It should
373 * not be used, instead use V4L2_YCBCR_ENC_601.
374 */
375 V4L2_YCBCR_ENC_SYCC = 5,
376
377 /* BT.2020 Non-constant Luminance Y'CbCr */
378 V4L2_YCBCR_ENC_BT2020 = 6,
379
380 /* BT.2020 Constant Luminance Y'CbcCrc */
381 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
382
383 /* SMPTE 240M -- Obsolete HDTV */
384 V4L2_YCBCR_ENC_SMPTE240M = 8,
385 };
386
387 /*
388 * enum v4l2_hsv_encoding values should not collide with the ones from
389 * enum v4l2_ycbcr_encoding.
390 */
391 enum v4l2_hsv_encoding {
392
393 /* Hue mapped to 0 - 179 */
394 V4L2_HSV_ENC_180 = 128,
395
396 /* Hue mapped to 0-255 */
397 V4L2_HSV_ENC_256 = 129,
398 };
399
400 /*
401 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
402 * This depends on the colorspace.
403 */
404 #define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
405 (((colsp) == V4L2_COLORSPACE_REC709 || \
406 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
407 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
408 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
409 V4L2_YCBCR_ENC_601)))
410
411 enum v4l2_quantization {
412 /*
413 * The default for R'G'B' quantization is always full range.
414 * For Y'CbCr the quantization is always limited range, except
415 * for COLORSPACE_JPEG: this is full range.
416 */
417 V4L2_QUANTIZATION_DEFAULT = 0,
418 V4L2_QUANTIZATION_FULL_RANGE = 1,
419 V4L2_QUANTIZATION_LIM_RANGE = 2,
420 };
421
422 /*
423 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
424 * This depends on whether the image is RGB or not, the colorspace.
425 * The Y'CbCr encoding is not used anymore, but is still there for backwards
426 * compatibility.
427 */
428 #define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb_or_hsv, colsp, ycbcr_enc) \
429 (((is_rgb_or_hsv) || (colsp) == V4L2_COLORSPACE_JPEG) ? \
430 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE)
431
432 /*
433 * Deprecated names for opRGB colorspace (IEC 61966-2-5)
434 *
435 * WARNING: Please don't use these deprecated defines in your code, as
436 * there is a chance we have to remove them in the future.
437 */
438 #define V4L2_COLORSPACE_ADOBERGB V4L2_COLORSPACE_OPRGB
439 #define V4L2_XFER_FUNC_ADOBERGB V4L2_XFER_FUNC_OPRGB
440
441 enum v4l2_priority {
442 V4L2_PRIORITY_UNSET = 0, /* not initialized */
443 V4L2_PRIORITY_BACKGROUND = 1,
444 V4L2_PRIORITY_INTERACTIVE = 2,
445 V4L2_PRIORITY_RECORD = 3,
446 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
447 };
448
449 struct v4l2_rect {
450 int32_t left;
451 int32_t top;
452 uint32_t width;
453 uint32_t height;
454 };
455
456 struct v4l2_fract {
457 uint32_t numerator;
458 uint32_t denominator;
459 };
460
461 struct v4l2_area {
462 uint32_t width;
463 uint32_t height;
464 };
465
466 /**
467 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
468 *
469 * @driver: name of the driver module (e.g. "bttv")
470 * @card: name of the card (e.g. "Hauppauge WinTV")
471 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
472 * @version: KERNEL_VERSION
473 * @capabilities: capabilities of the physical device as a whole
474 * @device_caps: capabilities accessed via this particular device (node)
475 * @reserved: reserved fields for future extensions
476 */
477 struct v4l2_capability {
478 uint8_t driver[16];
479 uint8_t card[32];
480 uint8_t bus_info[32];
481 uint32_t version;
482 uint32_t capabilities;
483 uint32_t device_caps;
484 uint32_t reserved[3];
485 };
486
487 /* Values for 'capabilities' field */
488 #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
489 #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
490 #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
491 #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
492 #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
493 #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
494 #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
495 #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
496 #define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
497 #define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
498 #define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
499
500 /* Is a video capture device that supports multiplanar formats */
501 #define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
502 /* Is a video output device that supports multiplanar formats */
503 #define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
504 /* Is a video mem-to-mem device that supports multiplanar formats */
505 #define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
506 /* Is a video mem-to-mem device */
507 #define V4L2_CAP_VIDEO_M2M 0x00008000
508
509 #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
510 #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
511 #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
512 #define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
513
514 #define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
515 #define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
516 #define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
517 #define V4L2_CAP_META_CAPTURE 0x00800000 /* Is a metadata capture device */
518
519 #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
520 #define V4L2_CAP_EDID 0x02000000 /* Is an EDID-only device */
521 #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
522 #define V4L2_CAP_META_OUTPUT 0x08000000 /* Is a metadata output device */
523
524 #define V4L2_CAP_TOUCH 0x10000000 /* Is a touch device */
525
526 #define V4L2_CAP_IO_MC 0x20000000 /* Is input/output controlled by the media controller */
527
528 #define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
529
530 /*
531 * V I D E O I M A G E F O R M A T
532 */
533 struct v4l2_pix_format {
534 uint32_t width;
535 uint32_t height;
536 uint32_t pixelformat;
537 uint32_t field; /* enum v4l2_field */
538 uint32_t bytesperline; /* for padding, zero if unused */
539 uint32_t sizeimage;
540 uint32_t colorspace; /* enum v4l2_colorspace */
541 uint32_t priv; /* private data, depends on pixelformat */
542 uint32_t flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
543 union {
544 /* enum v4l2_ycbcr_encoding */
545 uint32_t ycbcr_enc;
546 /* enum v4l2_hsv_encoding */
547 uint32_t hsv_enc;
548 };
549 uint32_t quantization; /* enum v4l2_quantization */
550 uint32_t xfer_func; /* enum v4l2_xfer_func */
551 };
552
553 /* Pixel format FOURCC depth Description */
554
555 /* RGB formats (1 or 2 bytes per pixel) */
556 #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
557 #define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
558 #define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
559 #define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
560 #define V4L2_PIX_FMT_RGBA444 v4l2_fourcc('R', 'A', '1', '2') /* 16 rrrrgggg bbbbaaaa */
561 #define V4L2_PIX_FMT_RGBX444 v4l2_fourcc('R', 'X', '1', '2') /* 16 rrrrgggg bbbbxxxx */
562 #define V4L2_PIX_FMT_ABGR444 v4l2_fourcc('A', 'B', '1', '2') /* 16 aaaabbbb ggggrrrr */
563 #define V4L2_PIX_FMT_XBGR444 v4l2_fourcc('X', 'B', '1', '2') /* 16 xxxxbbbb ggggrrrr */
564 #define V4L2_PIX_FMT_BGRA444 v4l2_fourcc('G', 'A', '1', '2') /* 16 bbbbgggg rrrraaaa */
565 #define V4L2_PIX_FMT_BGRX444 v4l2_fourcc('B', 'X', '1', '2') /* 16 bbbbgggg rrrrxxxx */
566 #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
567 #define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
568 #define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
569 #define V4L2_PIX_FMT_RGBA555 v4l2_fourcc('R', 'A', '1', '5') /* 16 RGBA-5-5-5-1 */
570 #define V4L2_PIX_FMT_RGBX555 v4l2_fourcc('R', 'X', '1', '5') /* 16 RGBX-5-5-5-1 */
571 #define V4L2_PIX_FMT_ABGR555 v4l2_fourcc('A', 'B', '1', '5') /* 16 ABGR-1-5-5-5 */
572 #define V4L2_PIX_FMT_XBGR555 v4l2_fourcc('X', 'B', '1', '5') /* 16 XBGR-1-5-5-5 */
573 #define V4L2_PIX_FMT_BGRA555 v4l2_fourcc('B', 'A', '1', '5') /* 16 BGRA-5-5-5-1 */
574 #define V4L2_PIX_FMT_BGRX555 v4l2_fourcc('B', 'X', '1', '5') /* 16 BGRX-5-5-5-1 */
575 #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
576 #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
577 #define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
578 #define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
579 #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
580
581 /* RGB formats (3 or 4 bytes per pixel) */
582 #define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
583 #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
584 #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
585 #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
586 #define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
587 #define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
588 #define V4L2_PIX_FMT_BGRA32 v4l2_fourcc('R', 'A', '2', '4') /* 32 ABGR-8-8-8-8 */
589 #define V4L2_PIX_FMT_BGRX32 v4l2_fourcc('R', 'X', '2', '4') /* 32 XBGR-8-8-8-8 */
590 #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
591 #define V4L2_PIX_FMT_RGBA32 v4l2_fourcc('A', 'B', '2', '4') /* 32 RGBA-8-8-8-8 */
592 #define V4L2_PIX_FMT_RGBX32 v4l2_fourcc('X', 'B', '2', '4') /* 32 RGBX-8-8-8-8 */
593 #define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
594 #define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
595 #define V4L2_PIX_FMT_RGBX1010102 v4l2_fourcc('R', 'X', '3', '0') /* 32 RGBX-10-10-10-2 */
596 #define V4L2_PIX_FMT_RGBA1010102 v4l2_fourcc('R', 'A', '3', '0') /* 32 RGBA-10-10-10-2 */
597 #define V4L2_PIX_FMT_ARGB2101010 v4l2_fourcc('A', 'R', '3', '0') /* 32 ARGB-2-10-10-10 */
598
599 /* RGB formats (6 or 8 bytes per pixel) */
600 #define V4L2_PIX_FMT_BGR48_12 v4l2_fourcc('B', '3', '1', '2') /* 48 BGR 12-bit per component */
601 #define V4L2_PIX_FMT_BGR48 v4l2_fourcc('B', 'G', 'R', '6') /* 48 BGR 16-bit per component */
602 #define V4L2_PIX_FMT_RGB48 v4l2_fourcc('R', 'G', 'B', '6') /* 48 RGB 16-bit per component */
603 #define V4L2_PIX_FMT_ABGR64_12 v4l2_fourcc('B', '4', '1', '2') /* 64 BGRA 12-bit per component */
604
605 /* Grey formats */
606 #define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
607 #define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
608 #define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
609 #define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
610 #define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
611 #define V4L2_PIX_FMT_Y012 v4l2_fourcc('Y', '0', '1', '2') /* 12 Greyscale */
612 #define V4L2_PIX_FMT_Y14 v4l2_fourcc('Y', '1', '4', ' ') /* 14 Greyscale */
613 #define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
614 #define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
615
616 /* Grey bit-packed formats */
617 #define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
618 #define V4L2_PIX_FMT_Y10P v4l2_fourcc('Y', '1', '0', 'P') /* 10 Greyscale, MIPI RAW10 packed */
619 #define V4L2_PIX_FMT_IPU3_Y10 v4l2_fourcc('i', 'p', '3', 'y') /* IPU3 packed 10-bit greyscale */
620 #define V4L2_PIX_FMT_Y12P v4l2_fourcc('Y', '1', '2', 'P') /* 12 Greyscale, MIPI RAW12 packed */
621 #define V4L2_PIX_FMT_Y14P v4l2_fourcc('Y', '1', '4', 'P') /* 14 Greyscale, MIPI RAW14 packed */
622
623 /* Palette formats */
624 #define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
625
626 /* Chrominance formats */
627 #define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
628
629 /* Luminance+Chrominance formats */
630 #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
631 #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
632 #define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
633 #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
634 #define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
635 #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
636 #define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
637 #define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
638 #define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
639 #define V4L2_PIX_FMT_YUV24 v4l2_fourcc('Y', 'U', 'V', '3') /* 24 YUV-8-8-8 */
640 #define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
641 #define V4L2_PIX_FMT_AYUV32 v4l2_fourcc('A', 'Y', 'U', 'V') /* 32 AYUV-8-8-8-8 */
642 #define V4L2_PIX_FMT_XYUV32 v4l2_fourcc('X', 'Y', 'U', 'V') /* 32 XYUV-8-8-8-8 */
643 #define V4L2_PIX_FMT_VUYA32 v4l2_fourcc('V', 'U', 'Y', 'A') /* 32 VUYA-8-8-8-8 */
644 #define V4L2_PIX_FMT_VUYX32 v4l2_fourcc('V', 'U', 'Y', 'X') /* 32 VUYX-8-8-8-8 */
645 #define V4L2_PIX_FMT_YUVA32 v4l2_fourcc('Y', 'U', 'V', 'A') /* 32 YUVA-8-8-8-8 */
646 #define V4L2_PIX_FMT_YUVX32 v4l2_fourcc('Y', 'U', 'V', 'X') /* 32 YUVX-8-8-8-8 */
647 #define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
648 #define V4L2_PIX_FMT_YUV48_12 v4l2_fourcc('Y', '3', '1', '2') /* 48 YUV 4:4:4 12-bit per component */
649
650 /*
651 * YCbCr packed format. For each Y2xx format, xx bits of valid data occupy the MSBs
652 * of the 16 bit components, and 16-xx bits of zero padding occupy the LSBs.
653 */
654 #define V4L2_PIX_FMT_Y210 v4l2_fourcc('Y', '2', '1', '0') /* 32 YUYV 4:2:2 */
655 #define V4L2_PIX_FMT_Y212 v4l2_fourcc('Y', '2', '1', '2') /* 32 YUYV 4:2:2 */
656 #define V4L2_PIX_FMT_Y216 v4l2_fourcc('Y', '2', '1', '6') /* 32 YUYV 4:2:2 */
657
658 /* two planes -- one Y, one Cr + Cb interleaved */
659 #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
660 #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
661 #define V4L2_PIX_FMT_NV15 v4l2_fourcc('N', 'V', '1', '5') /* 15 Y/CbCr 4:2:0 10-bit packed */
662 #define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
663 #define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
664 #define V4L2_PIX_FMT_NV20 v4l2_fourcc('N', 'V', '2', '0') /* 20 Y/CbCr 4:2:2 10-bit packed */
665 #define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
666 #define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
667 #define V4L2_PIX_FMT_P010 v4l2_fourcc('P', '0', '1', '0') /* 24 Y/CbCr 4:2:0 10-bit per component */
668 #define V4L2_PIX_FMT_P012 v4l2_fourcc('P', '0', '1', '2') /* 24 Y/CbCr 4:2:0 12-bit per component */
669
670 /* two non contiguous planes - one Y, one Cr + Cb interleaved */
671 #define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
672 #define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
673 #define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
674 #define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
675 #define V4L2_PIX_FMT_P012M v4l2_fourcc('P', 'M', '1', '2') /* 24 Y/CbCr 4:2:0 12-bit per component */
676
677 /* three planes - Y Cb, Cr */
678 #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
679 #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
680 #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 12 YVU411 planar */
681 #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
682 #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
683 #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
684
685 /* three non contiguous planes - Y, Cb, Cr */
686 #define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
687 #define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
688 #define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
689 #define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
690 #define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
691 #define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
692
693 /* Tiled YUV formats */
694 #define V4L2_PIX_FMT_NV12_4L4 v4l2_fourcc('V', 'T', '1', '2') /* 12 Y/CbCr 4:2:0 4x4 tiles */
695 #define V4L2_PIX_FMT_NV12_16L16 v4l2_fourcc('H', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 tiles */
696 #define V4L2_PIX_FMT_NV12_32L32 v4l2_fourcc('S', 'T', '1', '2') /* 12 Y/CbCr 4:2:0 32x32 tiles */
697 #define V4L2_PIX_FMT_NV15_4L4 v4l2_fourcc('V', 'T', '1', '5') /* 15 Y/CbCr 4:2:0 10-bit 4x4 tiles */
698 #define V4L2_PIX_FMT_P010_4L4 v4l2_fourcc('T', '0', '1', '0') /* 12 Y/CbCr 4:2:0 10-bit 4x4 macroblocks */
699 #define V4L2_PIX_FMT_NV12_8L128 v4l2_fourcc('A', 'T', '1', '2') /* Y/CbCr 4:2:0 8x128 tiles */
700 #define V4L2_PIX_FMT_NV12_10BE_8L128 v4l2_fourcc_be('A', 'X', '1', '2') /* Y/CbCr 4:2:0 10-bit 8x128 tiles */
701
702 /* Tiled YUV formats, non contiguous planes */
703 #define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 tiles */
704 #define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 tiles */
705 #define V4L2_PIX_FMT_NV12M_8L128 v4l2_fourcc('N', 'A', '1', '2') /* Y/CbCr 4:2:0 8x128 tiles */
706 #define V4L2_PIX_FMT_NV12M_10BE_8L128 v4l2_fourcc_be('N', 'T', '1', '2') /* Y/CbCr 4:2:0 10-bit 8x128 tiles */
707
708 /* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
709 #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
710 #define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
711 #define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
712 #define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
713 #define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
714 #define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
715 #define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
716 #define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
717 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
718 #define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
719 #define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
720 #define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
721 #define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
722 /* 10bit raw bayer a-law compressed to 8 bits */
723 #define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
724 #define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
725 #define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
726 #define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
727 /* 10bit raw bayer DPCM compressed to 8 bits */
728 #define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
729 #define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
730 #define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
731 #define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
732 #define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
733 #define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
734 #define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
735 #define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
736 /* 12bit raw bayer packed, 3 bytes for every 2 pixels */
737 #define V4L2_PIX_FMT_SBGGR12P v4l2_fourcc('p', 'B', 'C', 'C')
738 #define V4L2_PIX_FMT_SGBRG12P v4l2_fourcc('p', 'G', 'C', 'C')
739 #define V4L2_PIX_FMT_SGRBG12P v4l2_fourcc('p', 'g', 'C', 'C')
740 #define V4L2_PIX_FMT_SRGGB12P v4l2_fourcc('p', 'R', 'C', 'C')
741 #define V4L2_PIX_FMT_SBGGR14 v4l2_fourcc('B', 'G', '1', '4') /* 14 BGBG.. GRGR.. */
742 #define V4L2_PIX_FMT_SGBRG14 v4l2_fourcc('G', 'B', '1', '4') /* 14 GBGB.. RGRG.. */
743 #define V4L2_PIX_FMT_SGRBG14 v4l2_fourcc('G', 'R', '1', '4') /* 14 GRGR.. BGBG.. */
744 #define V4L2_PIX_FMT_SRGGB14 v4l2_fourcc('R', 'G', '1', '4') /* 14 RGRG.. GBGB.. */
745 /* 14bit raw bayer packed, 7 bytes for every 4 pixels */
746 #define V4L2_PIX_FMT_SBGGR14P v4l2_fourcc('p', 'B', 'E', 'E')
747 #define V4L2_PIX_FMT_SGBRG14P v4l2_fourcc('p', 'G', 'E', 'E')
748 #define V4L2_PIX_FMT_SGRBG14P v4l2_fourcc('p', 'g', 'E', 'E')
749 #define V4L2_PIX_FMT_SRGGB14P v4l2_fourcc('p', 'R', 'E', 'E')
750 #define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
751 #define V4L2_PIX_FMT_SGBRG16 v4l2_fourcc('G', 'B', '1', '6') /* 16 GBGB.. RGRG.. */
752 #define V4L2_PIX_FMT_SGRBG16 v4l2_fourcc('G', 'R', '1', '6') /* 16 GRGR.. BGBG.. */
753 #define V4L2_PIX_FMT_SRGGB16 v4l2_fourcc('R', 'G', '1', '6') /* 16 RGRG.. GBGB.. */
754
755 /* HSV formats */
756 #define V4L2_PIX_FMT_HSV24 v4l2_fourcc('H', 'S', 'V', '3')
757 #define V4L2_PIX_FMT_HSV32 v4l2_fourcc('H', 'S', 'V', '4')
758
759 /* compressed formats */
760 #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
761 #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
762 #define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
763 #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
764 #define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
765 #define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
766 #define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
767 #define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
768 #define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
769 #define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
770 #define V4L2_PIX_FMT_MPEG2_SLICE v4l2_fourcc('M', 'G', '2', 'S') /* MPEG-2 parsed slice data */
771 #define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
772 #define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
773 #define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
774 #define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
775 #define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
776 #define V4L2_PIX_FMT_VP8_FRAME v4l2_fourcc('V', 'P', '8', 'F') /* VP8 parsed frame */
777 #define V4L2_PIX_FMT_VP9 v4l2_fourcc('V', 'P', '9', '0') /* VP9 */
778 #define V4L2_PIX_FMT_VP9_FRAME v4l2_fourcc('V', 'P', '9', 'F') /* VP9 parsed frame */
779 #define V4L2_PIX_FMT_HEVC v4l2_fourcc('H', 'E', 'V', 'C') /* HEVC aka H.265 */
780 #define V4L2_PIX_FMT_FWHT v4l2_fourcc('F', 'W', 'H', 'T') /* Fast Walsh Hadamard Transform (vicodec) */
781 #define V4L2_PIX_FMT_FWHT_STATELESS v4l2_fourcc('S', 'F', 'W', 'H') /* Stateless FWHT (vicodec) */
782 #define V4L2_PIX_FMT_H264_SLICE v4l2_fourcc('S', '2', '6', '4') /* H264 parsed slices */
783 #define V4L2_PIX_FMT_HEVC_SLICE v4l2_fourcc('S', '2', '6', '5') /* HEVC parsed slices */
784 #define V4L2_PIX_FMT_AV1_FRAME v4l2_fourcc('A', 'V', '1', 'F') /* AV1 parsed frame */
785 #define V4L2_PIX_FMT_SPK v4l2_fourcc('S', 'P', 'K', '0') /* Sorenson Spark */
786 #define V4L2_PIX_FMT_RV30 v4l2_fourcc('R', 'V', '3', '0') /* RealVideo 8 */
787 #define V4L2_PIX_FMT_RV40 v4l2_fourcc('R', 'V', '4', '0') /* RealVideo 9 & 10 */
788
789 /* Vendor-specific formats */
790 #define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
791 #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
792 #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
793 #define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
794 #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
795 #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
796 #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
797 #define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
798 #define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
799 #define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
800 #define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
801 #define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
802 #define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
803 #define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
804 #define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
805 #define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
806 #define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
807 #define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
808 #define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
809 #define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
810 #define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
811 #define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
812 #define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
813 #define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
814 #define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
815 #define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
816 #define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
817 #define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
818 #define V4L2_PIX_FMT_Y16I v4l2_fourcc('Y', '1', '6', 'I') /* Greyscale 16-bit L/R interleaved */
819 #define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
820 #define V4L2_PIX_FMT_MT21C v4l2_fourcc('M', 'T', '2', '1') /* Mediatek compressed block mode */
821 #define V4L2_PIX_FMT_MM21 v4l2_fourcc('M', 'M', '2', '1') /* Mediatek 8-bit block mode, two non-contiguous planes */
822 #define V4L2_PIX_FMT_MT2110T v4l2_fourcc('M', 'T', '2', 'T') /* Mediatek 10-bit block tile mode */
823 #define V4L2_PIX_FMT_MT2110R v4l2_fourcc('M', 'T', '2', 'R') /* Mediatek 10-bit block raster mode */
824 #define V4L2_PIX_FMT_INZI v4l2_fourcc('I', 'N', 'Z', 'I') /* Intel Planar Greyscale 10-bit and Depth 16-bit */
825 #define V4L2_PIX_FMT_CNF4 v4l2_fourcc('C', 'N', 'F', '4') /* Intel 4-bit packed depth confidence information */
826 #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* BTTV 8-bit dithered RGB */
827 #define V4L2_PIX_FMT_QC08C v4l2_fourcc('Q', '0', '8', 'C') /* Qualcomm 8-bit compressed */
828 #define V4L2_PIX_FMT_QC10C v4l2_fourcc('Q', '1', '0', 'C') /* Qualcomm 10-bit compressed */
829 #define V4L2_PIX_FMT_AJPG v4l2_fourcc('A', 'J', 'P', 'G') /* Aspeed JPEG */
830 #define V4L2_PIX_FMT_HEXTILE v4l2_fourcc('H', 'X', 'T', 'L') /* Hextile compressed */
831
832 /* 10bit raw packed, 32 bytes for every 25 pixels, last LSB 6 bits unused */
833 #define V4L2_PIX_FMT_IPU3_SBGGR10 v4l2_fourcc('i', 'p', '3', 'b') /* IPU3 packed 10-bit BGGR bayer */
834 #define V4L2_PIX_FMT_IPU3_SGBRG10 v4l2_fourcc('i', 'p', '3', 'g') /* IPU3 packed 10-bit GBRG bayer */
835 #define V4L2_PIX_FMT_IPU3_SGRBG10 v4l2_fourcc('i', 'p', '3', 'G') /* IPU3 packed 10-bit GRBG bayer */
836 #define V4L2_PIX_FMT_IPU3_SRGGB10 v4l2_fourcc('i', 'p', '3', 'r') /* IPU3 packed 10-bit RGGB bayer */
837
838 /* Raspberry Pi PiSP compressed formats. */
839 #define V4L2_PIX_FMT_PISP_COMP1_RGGB v4l2_fourcc('P', 'C', '1', 'R') /* PiSP 8-bit mode 1 compressed RGGB bayer */
840 #define V4L2_PIX_FMT_PISP_COMP1_GRBG v4l2_fourcc('P', 'C', '1', 'G') /* PiSP 8-bit mode 1 compressed GRBG bayer */
841 #define V4L2_PIX_FMT_PISP_COMP1_GBRG v4l2_fourcc('P', 'C', '1', 'g') /* PiSP 8-bit mode 1 compressed GBRG bayer */
842 #define V4L2_PIX_FMT_PISP_COMP1_BGGR v4l2_fourcc('P', 'C', '1', 'B') /* PiSP 8-bit mode 1 compressed BGGR bayer */
843 #define V4L2_PIX_FMT_PISP_COMP1_MONO v4l2_fourcc('P', 'C', '1', 'M') /* PiSP 8-bit mode 1 compressed monochrome */
844 #define V4L2_PIX_FMT_PISP_COMP2_RGGB v4l2_fourcc('P', 'C', '2', 'R') /* PiSP 8-bit mode 2 compressed RGGB bayer */
845 #define V4L2_PIX_FMT_PISP_COMP2_GRBG v4l2_fourcc('P', 'C', '2', 'G') /* PiSP 8-bit mode 2 compressed GRBG bayer */
846 #define V4L2_PIX_FMT_PISP_COMP2_GBRG v4l2_fourcc('P', 'C', '2', 'g') /* PiSP 8-bit mode 2 compressed GBRG bayer */
847 #define V4L2_PIX_FMT_PISP_COMP2_BGGR v4l2_fourcc('P', 'C', '2', 'B') /* PiSP 8-bit mode 2 compressed BGGR bayer */
848 #define V4L2_PIX_FMT_PISP_COMP2_MONO v4l2_fourcc('P', 'C', '2', 'M') /* PiSP 8-bit mode 2 compressed monochrome */
849
850 /* Renesas RZ/V2H CRU packed formats. 64-bit units with contiguous pixels */
851 #define V4L2_PIX_FMT_RAW_CRU10 v4l2_fourcc('C', 'R', '1', '0')
852 #define V4L2_PIX_FMT_RAW_CRU12 v4l2_fourcc('C', 'R', '1', '2')
853 #define V4L2_PIX_FMT_RAW_CRU14 v4l2_fourcc('C', 'R', '1', '4')
854 #define V4L2_PIX_FMT_RAW_CRU20 v4l2_fourcc('C', 'R', '2', '0')
855
856 /* SDR formats - used only for Software Defined Radio devices */
857 #define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
858 #define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
859 #define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
860 #define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
861 #define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
862 #define V4L2_SDR_FMT_PCU16BE v4l2_fourcc('P', 'C', '1', '6') /* planar complex u16be */
863 #define V4L2_SDR_FMT_PCU18BE v4l2_fourcc('P', 'C', '1', '8') /* planar complex u18be */
864 #define V4L2_SDR_FMT_PCU20BE v4l2_fourcc('P', 'C', '2', '0') /* planar complex u20be */
865
866 /* Touch formats - used for Touch devices */
867 #define V4L2_TCH_FMT_DELTA_TD16 v4l2_fourcc('T', 'D', '1', '6') /* 16-bit signed deltas */
868 #define V4L2_TCH_FMT_DELTA_TD08 v4l2_fourcc('T', 'D', '0', '8') /* 8-bit signed deltas */
869 #define V4L2_TCH_FMT_TU16 v4l2_fourcc('T', 'U', '1', '6') /* 16-bit unsigned touch data */
870 #define V4L2_TCH_FMT_TU08 v4l2_fourcc('T', 'U', '0', '8') /* 8-bit unsigned touch data */
871
872 /* Meta-data formats */
873 #define V4L2_META_FMT_VSP1_HGO v4l2_fourcc('V', 'S', 'P', 'H') /* R-Car VSP1 1-D Histogram */
874 #define V4L2_META_FMT_VSP1_HGT v4l2_fourcc('V', 'S', 'P', 'T') /* R-Car VSP1 2-D Histogram */
875 #define V4L2_META_FMT_UVC v4l2_fourcc('U', 'V', 'C', 'H') /* UVC Payload Header metadata */
876 #define V4L2_META_FMT_D4XX v4l2_fourcc('D', '4', 'X', 'X') /* D4XX Payload Header metadata */
877 #define V4L2_META_FMT_UVC_MSXU_1_5 v4l2_fourcc('U', 'V', 'C', 'M') /* UVC MSXU metadata */
878 #define V4L2_META_FMT_VIVID v4l2_fourcc('V', 'I', 'V', 'D') /* Vivid Metadata */
879
880 /* Vendor specific - used for RK_ISP1 camera sub-system */
881 #define V4L2_META_FMT_RK_ISP1_PARAMS v4l2_fourcc('R', 'K', '1', 'P') /* Rockchip ISP1 3A Parameters */
882 #define V4L2_META_FMT_RK_ISP1_STAT_3A v4l2_fourcc('R', 'K', '1', 'S') /* Rockchip ISP1 3A Statistics */
883 #define V4L2_META_FMT_RK_ISP1_EXT_PARAMS v4l2_fourcc('R', 'K', '1', 'E') /* Rockchip ISP1 3a Extensible Parameters */
884
885 /* Vendor specific - used for C3_ISP */
886 #define V4L2_META_FMT_C3ISP_PARAMS v4l2_fourcc('C', '3', 'P', 'M') /* Amlogic C3 ISP Parameters */
887 #define V4L2_META_FMT_C3ISP_STATS v4l2_fourcc('C', '3', 'S', 'T') /* Amlogic C3 ISP Statistics */
888
889 /* Vendor specific - used for RaspberryPi PiSP */
890 #define V4L2_META_FMT_RPI_BE_CFG v4l2_fourcc('R', 'P', 'B', 'C') /* PiSP BE configuration */
891 #define V4L2_META_FMT_RPI_FE_CFG v4l2_fourcc('R', 'P', 'F', 'C') /* PiSP FE configuration */
892 #define V4L2_META_FMT_RPI_FE_STATS v4l2_fourcc('R', 'P', 'F', 'S') /* PiSP FE stats */
893
894
895 /* priv field value to indicates that subsequent fields are valid. */
896 #define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
897
898 /* Flags */
899 #define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
900 #define V4L2_PIX_FMT_FLAG_SET_CSC 0x00000002
901
902 /*
903 * F O R M A T E N U M E R A T I O N
904 */
905 struct v4l2_fmtdesc {
906 uint32_t index; /* Format number */
907 uint32_t type; /* enum v4l2_buf_type */
908 uint32_t flags;
909 uint8_t description[32]; /* Description string */
910 uint32_t pixelformat; /* Format fourcc */
911 uint32_t mbus_code; /* Media bus code */
912 uint32_t reserved[3];
913 };
914
915 #define V4L2_FMT_FLAG_COMPRESSED 0x0001
916 #define V4L2_FMT_FLAG_EMULATED 0x0002
917 #define V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM 0x0004
918 #define V4L2_FMT_FLAG_DYN_RESOLUTION 0x0008
919 #define V4L2_FMT_FLAG_ENC_CAP_FRAME_INTERVAL 0x0010
920 #define V4L2_FMT_FLAG_CSC_COLORSPACE 0x0020
921 #define V4L2_FMT_FLAG_CSC_XFER_FUNC 0x0040
922 #define V4L2_FMT_FLAG_CSC_YCBCR_ENC 0x0080
923 #define V4L2_FMT_FLAG_CSC_HSV_ENC V4L2_FMT_FLAG_CSC_YCBCR_ENC
924 #define V4L2_FMT_FLAG_CSC_QUANTIZATION 0x0100
925 #define V4L2_FMT_FLAG_META_LINE_BASED 0x0200
926
927 /* Format description flag, to be ORed with the index */
928 #define V4L2_FMTDESC_FLAG_ENUM_ALL 0x80000000
929
930 /* Frame Size and frame rate enumeration */
931 /*
932 * F R A M E S I Z E E N U M E R A T I O N
933 */
934 enum v4l2_frmsizetypes {
935 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
936 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
937 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
938 };
939
940 struct v4l2_frmsize_discrete {
941 uint32_t width; /* Frame width [pixel] */
942 uint32_t height; /* Frame height [pixel] */
943 };
944
945 struct v4l2_frmsize_stepwise {
946 uint32_t min_width; /* Minimum frame width [pixel] */
947 uint32_t max_width; /* Maximum frame width [pixel] */
948 uint32_t step_width; /* Frame width step size [pixel] */
949 uint32_t min_height; /* Minimum frame height [pixel] */
950 uint32_t max_height; /* Maximum frame height [pixel] */
951 uint32_t step_height; /* Frame height step size [pixel] */
952 };
953
954 struct v4l2_frmsizeenum {
955 uint32_t index; /* Frame size number */
956 uint32_t pixel_format; /* Pixel format */
957 uint32_t type; /* Frame size type the device supports. */
958
959 union { /* Frame size */
960 struct v4l2_frmsize_discrete discrete;
961 struct v4l2_frmsize_stepwise stepwise;
962 };
963
964 uint32_t reserved[2]; /* Reserved space for future use */
965 };
966
967 /*
968 * F R A M E R A T E E N U M E R A T I O N
969 */
970 enum v4l2_frmivaltypes {
971 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
972 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
973 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
974 };
975
976 struct v4l2_frmival_stepwise {
977 struct v4l2_fract min; /* Minimum frame interval [s] */
978 struct v4l2_fract max; /* Maximum frame interval [s] */
979 struct v4l2_fract step; /* Frame interval step size [s] */
980 };
981
982 struct v4l2_frmivalenum {
983 uint32_t index; /* Frame format index */
984 uint32_t pixel_format; /* Pixel format */
985 uint32_t width; /* Frame width */
986 uint32_t height; /* Frame height */
987 uint32_t type; /* Frame interval type the device supports. */
988
989 union { /* Frame interval */
990 struct v4l2_fract discrete;
991 struct v4l2_frmival_stepwise stepwise;
992 };
993
994 uint32_t reserved[2]; /* Reserved space for future use */
995 };
996
997 /*
998 * T I M E C O D E
999 */
1000 struct v4l2_timecode {
1001 uint32_t type;
1002 uint32_t flags;
1003 uint8_t frames;
1004 uint8_t seconds;
1005 uint8_t minutes;
1006 uint8_t hours;
1007 uint8_t userbits[4];
1008 };
1009
1010 /* Type */
1011 #define V4L2_TC_TYPE_24FPS 1
1012 #define V4L2_TC_TYPE_25FPS 2
1013 #define V4L2_TC_TYPE_30FPS 3
1014 #define V4L2_TC_TYPE_50FPS 4
1015 #define V4L2_TC_TYPE_60FPS 5
1016
1017 /* Flags */
1018 #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
1019 #define V4L2_TC_FLAG_COLORFRAME 0x0002
1020 #define V4L2_TC_USERBITS_field 0x000C
1021 #define V4L2_TC_USERBITS_USERDEFINED 0x0000
1022 #define V4L2_TC_USERBITS_8BITCHARS 0x0008
1023 /* The above is based on SMPTE timecodes */
1024
1025 struct v4l2_jpegcompression {
1026 int quality;
1027
1028 int APPn; /* Number of APP segment to be written,
1029 * must be 0..15 */
1030 int APP_len; /* Length of data in JPEG APPn segment */
1031 char APP_data[60]; /* Data in the JPEG APPn segment. */
1032
1033 int COM_len; /* Length of data in JPEG COM segment */
1034 char COM_data[60]; /* Data in JPEG COM segment */
1035
1036 uint32_t jpeg_markers; /* Which markers should go into the JPEG
1037 * output. Unless you exactly know what
1038 * you do, leave them untouched.
1039 * Including less markers will make the
1040 * resulting code smaller, but there will
1041 * be fewer applications which can read it.
1042 * The presence of the APP and COM marker
1043 * is influenced by APP_len and COM_len
1044 * ONLY, not by this property! */
1045
1046 #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
1047 #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
1048 #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
1049 #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
1050 #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
1051 * always use APP0 */
1052 };
1053
1054 /*
1055 * M E M O R Y - M A P P I N G B U F F E R S
1056 */
1057
1058
1059 struct v4l2_requestbuffers {
1060 uint32_t count;
1061 uint32_t type; /* enum v4l2_buf_type */
1062 uint32_t memory; /* enum v4l2_memory */
1063 uint32_t capabilities;
1064 uint8_t flags;
1065 uint8_t reserved[3];
1066 };
1067
1068 #define V4L2_MEMORY_FLAG_NON_COHERENT (1 << 0)
1069
1070 /* capabilities for struct v4l2_requestbuffers and v4l2_create_buffers */
1071 #define V4L2_BUF_CAP_SUPPORTS_MMAP (1 << 0)
1072 #define V4L2_BUF_CAP_SUPPORTS_USERPTR (1 << 1)
1073 #define V4L2_BUF_CAP_SUPPORTS_DMABUF (1 << 2)
1074 #define V4L2_BUF_CAP_SUPPORTS_REQUESTS (1 << 3)
1075 #define V4L2_BUF_CAP_SUPPORTS_ORPHANED_BUFS (1 << 4)
1076 #define V4L2_BUF_CAP_SUPPORTS_M2M_HOLD_CAPTURE_BUF (1 << 5)
1077 #define V4L2_BUF_CAP_SUPPORTS_MMAP_CACHE_HINTS (1 << 6)
1078 #define V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS (1 << 7)
1079 #define V4L2_BUF_CAP_SUPPORTS_REMOVE_BUFS (1 << 8)
1080
1081 /**
1082 * struct v4l2_plane - plane info for multi-planar buffers
1083 * @bytesused: number of bytes occupied by data in the plane (payload)
1084 * @length: size of this plane (NOT the payload) in bytes
1085 * @m.mem_offset: when memory in the associated struct v4l2_buffer is
1086 * V4L2_MEMORY_MMAP, equals the offset from the start of
1087 * the device memory for this plane (or is a "cookie" that
1088 * should be passed to mmap() called on the video node)
1089 * @m.userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
1090 * pointing to this plane
1091 * @m.fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
1092 * descriptor associated with this plane
1093 * @m: union of @mem_offset, @userptr and @fd
1094 * @data_offset: offset in the plane to the start of data; usually 0,
1095 * unless there is a header in front of the data
1096 * @reserved: drivers and applications must zero this array
1097 *
1098 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
1099 * with two planes can have one plane for Y, and another for interleaved CbCr
1100 * components. Each plane can reside in a separate memory buffer, or even in
1101 * a completely separate memory node (e.g. in embedded devices).
1102 */
1103 struct v4l2_plane {
1104 uint32_t bytesused;
1105 uint32_t length;
1106 union {
1107 uint32_t mem_offset;
1108 unsigned long userptr;
1109 int32_t fd;
1110 } m;
1111 uint32_t data_offset;
1112 uint32_t reserved[11];
1113 };
1114
1115 /**
1116 * struct v4l2_buffer - video buffer info
1117 * @index: id number of the buffer
1118 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
1119 * multiplanar buffers);
1120 * @bytesused: number of bytes occupied by data in the buffer (payload);
1121 * unused (set to 0) for multiplanar buffers
1122 * @flags: buffer informational flags
1123 * @field: enum v4l2_field; field order of the image in the buffer
1124 * @timestamp: frame timestamp
1125 * @timecode: frame timecode
1126 * @sequence: sequence count of this frame
1127 * @memory: enum v4l2_memory; the method, in which the actual video data is
1128 * passed
1129 * @m.offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
1130 * offset from the start of the device memory for this plane,
1131 * (or a "cookie" that should be passed to mmap() as offset)
1132 * @m.userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
1133 * a userspace pointer pointing to this buffer
1134 * @m.fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
1135 * a userspace file descriptor associated with this buffer
1136 * @m.planes: for multiplanar buffers; userspace pointer to the array of plane
1137 * info structs for this buffer
1138 * @m: union of @offset, @userptr, @planes and @fd
1139 * @length: size in bytes of the buffer (NOT its payload) for single-plane
1140 * buffers (when type != *_MPLANE); number of elements in the
1141 * planes array for multi-plane buffers
1142 * @reserved2: drivers and applications must zero this field
1143 * @request_fd: fd of the request that this buffer should use
1144 * @reserved: for backwards compatibility with applications that do not know
1145 * about @request_fd
1146 *
1147 * Contains data exchanged by application and driver using one of the Streaming
1148 * I/O methods.
1149 */
1150 struct v4l2_buffer {
1151 uint32_t index;
1152 uint32_t type;
1153 uint32_t bytesused;
1154 uint32_t flags;
1155 uint32_t field;
1156 struct timeval timestamp;
1157 struct v4l2_timecode timecode;
1158 uint32_t sequence;
1159
1160 /* memory location */
1161 uint32_t memory;
1162 union {
1163 uint32_t offset;
1164 unsigned long userptr;
1165 struct v4l2_plane *planes;
1166 int32_t fd;
1167 } m;
1168 uint32_t length;
1169 uint32_t reserved2;
1170 union {
1171 int32_t request_fd;
1172 uint32_t reserved;
1173 };
1174 };
1175
1176 /**
1177 * v4l2_timeval_to_ns - Convert timeval to nanoseconds
1178 * @tv: pointer to the timeval variable to be converted
1179 *
1180 * Returns the scalar nanosecond representation of the timeval
1181 * parameter.
1182 */
1183 static __inline__ uint64_t v4l2_timeval_to_ns(const struct timeval *tv)
1184 {
1185 return (uint64_t)tv->tv_sec * 1000000000ULL + tv->tv_usec * 1000;
1186 }
1187
1188 /* Flags for 'flags' field */
1189 /* Buffer is mapped (flag) */
1190 #define V4L2_BUF_FLAG_MAPPED 0x00000001
1191 /* Buffer is queued for processing */
1192 #define V4L2_BUF_FLAG_QUEUED 0x00000002
1193 /* Buffer is ready */
1194 #define V4L2_BUF_FLAG_DONE 0x00000004
1195 /* Image is a keyframe (I-frame) */
1196 #define V4L2_BUF_FLAG_KEYFRAME 0x00000008
1197 /* Image is a P-frame */
1198 #define V4L2_BUF_FLAG_PFRAME 0x00000010
1199 /* Image is a B-frame */
1200 #define V4L2_BUF_FLAG_BFRAME 0x00000020
1201 /* Buffer is ready, but the data contained within is corrupted. */
1202 #define V4L2_BUF_FLAG_ERROR 0x00000040
1203 /* Buffer is added to an unqueued request */
1204 #define V4L2_BUF_FLAG_IN_REQUEST 0x00000080
1205 /* timecode field is valid */
1206 #define V4L2_BUF_FLAG_TIMECODE 0x00000100
1207 /* Don't return the capture buffer until OUTPUT timestamp changes */
1208 #define V4L2_BUF_FLAG_M2M_HOLD_CAPTURE_BUF 0x00000200
1209 /* Buffer is prepared for queuing */
1210 #define V4L2_BUF_FLAG_PREPARED 0x00000400
1211 /* Cache handling flags */
1212 #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
1213 #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
1214 /* Timestamp type */
1215 #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
1216 #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
1217 #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
1218 #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
1219 /* Timestamp sources. */
1220 #define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
1221 #define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
1222 #define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
1223 /* mem2mem encoder/decoder */
1224 #define V4L2_BUF_FLAG_LAST 0x00100000
1225 /* request_fd is valid */
1226 #define V4L2_BUF_FLAG_REQUEST_FD 0x00800000
1227
1228 /**
1229 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
1230 *
1231 * @index: id number of the buffer
1232 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
1233 * multiplanar buffers);
1234 * @plane: index of the plane to be exported, 0 for single plane queues
1235 * @flags: flags for newly created file, currently only O_CLOEXEC is
1236 * supported, refer to manual of open syscall for more details
1237 * @fd: file descriptor associated with DMABUF (set by driver)
1238 * @reserved: drivers and applications must zero this array
1239 *
1240 * Contains data used for exporting a video buffer as DMABUF file descriptor.
1241 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
1242 * (identical to the cookie used to mmap() the buffer to userspace). All
1243 * reserved fields must be set to zero. The field reserved0 is expected to
1244 * become a structure 'type' allowing an alternative layout of the structure
1245 * content. Therefore this field should not be used for any other extensions.
1246 */
1247 struct v4l2_exportbuffer {
1248 uint32_t type; /* enum v4l2_buf_type */
1249 uint32_t index;
1250 uint32_t plane;
1251 uint32_t flags;
1252 int32_t fd;
1253 uint32_t reserved[11];
1254 };
1255
1256 /*
1257 * O V E R L A Y P R E V I E W
1258 */
1259 struct v4l2_framebuffer {
1260 uint32_t capability;
1261 uint32_t flags;
1262 /* FIXME: in theory we should pass something like PCI device + memory
1263 * region + offset instead of some physical address */
1264 void *base;
1265 struct {
1266 uint32_t width;
1267 uint32_t height;
1268 uint32_t pixelformat;
1269 uint32_t field; /* enum v4l2_field */
1270 uint32_t bytesperline; /* for padding, zero if unused */
1271 uint32_t sizeimage;
1272 uint32_t colorspace; /* enum v4l2_colorspace */
1273 uint32_t priv; /* reserved field, set to 0 */
1274 } fmt;
1275 };
1276 /* Flags for the 'capability' field. Read only */
1277 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
1278 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
1279 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
1280 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
1281 #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
1282 #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
1283 #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
1284 #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
1285 /* Flags for the 'flags' field. */
1286 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
1287 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
1288 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
1289 #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
1290 #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
1291 #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
1292 #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
1293
1294 struct v4l2_clip {
1295 struct v4l2_rect c;
1296 struct v4l2_clip *next;
1297 };
1298
1299 struct v4l2_window {
1300 struct v4l2_rect w;
1301 uint32_t field; /* enum v4l2_field */
1302 uint32_t chromakey;
1303 struct v4l2_clip *clips;
1304 uint32_t clipcount;
1305 void *bitmap;
1306 uint8_t global_alpha;
1307 };
1308
1309 /*
1310 * C A P T U R E P A R A M E T E R S
1311 */
1312 struct v4l2_captureparm {
1313 uint32_t capability; /* Supported modes */
1314 uint32_t capturemode; /* Current mode */
1315 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1316 uint32_t extendedmode; /* Driver-specific extensions */
1317 uint32_t readbuffers; /* # of buffers for read */
1318 uint32_t reserved[4];
1319 };
1320
1321 /* Flags for 'capability' and 'capturemode' fields */
1322 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1323 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1324
1325 struct v4l2_outputparm {
1326 uint32_t capability; /* Supported modes */
1327 uint32_t outputmode; /* Current mode */
1328 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1329 uint32_t extendedmode; /* Driver-specific extensions */
1330 uint32_t writebuffers; /* # of buffers for write */
1331 uint32_t reserved[4];
1332 };
1333
1334 /*
1335 * I N P U T I M A G E C R O P P I N G
1336 */
1337 struct v4l2_cropcap {
1338 uint32_t type; /* enum v4l2_buf_type */
1339 struct v4l2_rect bounds;
1340 struct v4l2_rect defrect;
1341 struct v4l2_fract pixelaspect;
1342 };
1343
1344 struct v4l2_crop {
1345 uint32_t type; /* enum v4l2_buf_type */
1346 struct v4l2_rect c;
1347 };
1348
1349 /**
1350 * struct v4l2_selection - selection info
1351 * @type: buffer type (do not use *_MPLANE types)
1352 * @target: Selection target, used to choose one of possible rectangles;
1353 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1354 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1355 * @r: coordinates of selection window
1356 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1357 *
1358 * Hardware may use multiple helper windows to process a video stream.
1359 * The structure is used to exchange this selection areas between
1360 * an application and a driver.
1361 */
1362 struct v4l2_selection {
1363 uint32_t type;
1364 uint32_t target;
1365 uint32_t flags;
1366 struct v4l2_rect r;
1367 uint32_t reserved[9];
1368 };
1369
1370
1371 /*
1372 * A N A L O G V I D E O S T A N D A R D
1373 */
1374
1375 typedef uint64_t v4l2_std_id;
1376
1377 /*
1378 * Attention: Keep the V4L2_STD_* bit definitions in sync with
1379 * include/dt-bindings/display/sdtv-standards.h SDTV_STD_* bit definitions.
1380 */
1381 /* one bit for each */
1382 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1383 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1384 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1385 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1386 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1387 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1388 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1389 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1390
1391 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1392 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1393 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1394 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1395
1396 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1397 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1398 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1399 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1400
1401 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1402 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1403 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1404 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1405 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1406 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1407 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1408 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1409
1410 /* ATSC/HDTV */
1411 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1412 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1413
1414 /* FIXME:
1415 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1416 makes switch(uint64_t) to break. So, there's a hack on v4l2-common.c rounding
1417 this value to 32 bits.
1418 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1419 it should work fine. However, if needed to add more than two standards,
1420 v4l2-common.c should be fixed.
1421 */
1422
1423 /*
1424 * Some macros to merge video standards in order to make live easier for the
1425 * drivers and V4L2 applications
1426 */
1427
1428 /*
1429 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1430 * Missing here.
1431 */
1432 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1433 V4L2_STD_NTSC_M_JP |\
1434 V4L2_STD_NTSC_M_KR)
1435 /* Secam macros */
1436 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1437 V4L2_STD_SECAM_K |\
1438 V4L2_STD_SECAM_K1)
1439 /* All Secam Standards */
1440 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1441 V4L2_STD_SECAM_G |\
1442 V4L2_STD_SECAM_H |\
1443 V4L2_STD_SECAM_DK |\
1444 V4L2_STD_SECAM_L |\
1445 V4L2_STD_SECAM_LC)
1446 /* PAL macros */
1447 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1448 V4L2_STD_PAL_B1 |\
1449 V4L2_STD_PAL_G)
1450 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1451 V4L2_STD_PAL_D1 |\
1452 V4L2_STD_PAL_K)
1453 /*
1454 * "Common" PAL - This macro is there to be compatible with the old
1455 * V4L1 concept of "PAL": /BGDKHI.
1456 * Several PAL standards are missing here: /M, /N and /Nc
1457 */
1458 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1459 V4L2_STD_PAL_DK |\
1460 V4L2_STD_PAL_H |\
1461 V4L2_STD_PAL_I)
1462 /* Chroma "agnostic" standards */
1463 #define V4L2_STD_B (V4L2_STD_PAL_B |\
1464 V4L2_STD_PAL_B1 |\
1465 V4L2_STD_SECAM_B)
1466 #define V4L2_STD_G (V4L2_STD_PAL_G |\
1467 V4L2_STD_SECAM_G)
1468 #define V4L2_STD_H (V4L2_STD_PAL_H |\
1469 V4L2_STD_SECAM_H)
1470 #define V4L2_STD_L (V4L2_STD_SECAM_L |\
1471 V4L2_STD_SECAM_LC)
1472 #define V4L2_STD_GH (V4L2_STD_G |\
1473 V4L2_STD_H)
1474 #define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1475 V4L2_STD_SECAM_DK)
1476 #define V4L2_STD_BG (V4L2_STD_B |\
1477 V4L2_STD_G)
1478 #define V4L2_STD_MN (V4L2_STD_PAL_M |\
1479 V4L2_STD_PAL_N |\
1480 V4L2_STD_PAL_Nc |\
1481 V4L2_STD_NTSC)
1482
1483 /* Standards where MTS/BTSC stereo could be found */
1484 #define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1485 V4L2_STD_PAL_M |\
1486 V4L2_STD_PAL_N |\
1487 V4L2_STD_PAL_Nc)
1488
1489 /* Standards for Countries with 60Hz Line frequency */
1490 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1491 V4L2_STD_PAL_60 |\
1492 V4L2_STD_NTSC |\
1493 V4L2_STD_NTSC_443)
1494 /* Standards for Countries with 50Hz Line frequency */
1495 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
1496 V4L2_STD_PAL_N |\
1497 V4L2_STD_PAL_Nc |\
1498 V4L2_STD_SECAM)
1499
1500 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1501 V4L2_STD_ATSC_16_VSB)
1502 /* Macros with none and all analog standards */
1503 #define V4L2_STD_UNKNOWN 0
1504 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
1505 V4L2_STD_625_50)
1506
1507 struct v4l2_standard {
1508 uint32_t index;
1509 v4l2_std_id id;
1510 uint8_t name[24];
1511 struct v4l2_fract frameperiod; /* Frames, not fields */
1512 uint32_t framelines;
1513 uint32_t reserved[4];
1514 };
1515
1516 /*
1517 * D V B T T I M I N G S
1518 */
1519
1520 /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1521 * @width: total width of the active video in pixels
1522 * @height: total height of the active video in lines
1523 * @interlaced: Interlaced or progressive
1524 * @polarities: Positive or negative polarities
1525 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1526 * @hfrontporch:Horizontal front porch in pixels
1527 * @hsync: Horizontal Sync length in pixels
1528 * @hbackporch: Horizontal back porch in pixels
1529 * @vfrontporch:Vertical front porch in lines
1530 * @vsync: Vertical Sync length in lines
1531 * @vbackporch: Vertical back porch in lines
1532 * @il_vfrontporch:Vertical front porch for the even field
1533 * (aka field 2) of interlaced field formats
1534 * @il_vsync: Vertical Sync length for the even field
1535 * (aka field 2) of interlaced field formats
1536 * @il_vbackporch:Vertical back porch for the even field
1537 * (aka field 2) of interlaced field formats
1538 * @standards: Standards the timing belongs to
1539 * @flags: Flags
1540 * @picture_aspect: The picture aspect ratio (hor/vert).
1541 * @cea861_vic: VIC code as per the CEA-861 standard.
1542 * @hdmi_vic: VIC code as per the HDMI standard.
1543 * @reserved: Reserved fields, must be zeroed.
1544 *
1545 * A note regarding vertical interlaced timings: height refers to the total
1546 * height of the active video frame (= two fields). The blanking timings refer
1547 * to the blanking of each field. So the height of the total frame is
1548 * calculated as follows:
1549 *
1550 * tot_height = height + vfrontporch + vsync + vbackporch +
1551 * il_vfrontporch + il_vsync + il_vbackporch
1552 *
1553 * The active height of each field is height / 2.
1554 */
1555 struct v4l2_bt_timings {
1556 uint32_t width;
1557 uint32_t height;
1558 uint32_t interlaced;
1559 uint32_t polarities;
1560 uint64_t pixelclock;
1561 uint32_t hfrontporch;
1562 uint32_t hsync;
1563 uint32_t hbackporch;
1564 uint32_t vfrontporch;
1565 uint32_t vsync;
1566 uint32_t vbackporch;
1567 uint32_t il_vfrontporch;
1568 uint32_t il_vsync;
1569 uint32_t il_vbackporch;
1570 uint32_t standards;
1571 uint32_t flags;
1572 struct v4l2_fract picture_aspect;
1573 uint8_t cea861_vic;
1574 uint8_t hdmi_vic;
1575 uint8_t reserved[46];
1576 } __attribute__ ((packed));
1577
1578 /* Interlaced or progressive format */
1579 #define V4L2_DV_PROGRESSIVE 0
1580 #define V4L2_DV_INTERLACED 1
1581
1582 /* Polarities. If bit is not set, it is assumed to be negative polarity */
1583 #define V4L2_DV_VSYNC_POS_POL 0x00000001
1584 #define V4L2_DV_HSYNC_POS_POL 0x00000002
1585
1586 /* Timings standards */
1587 #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1588 #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1589 #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1590 #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1591 #define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
1592
1593 /* Flags */
1594
1595 /*
1596 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1597 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1598 * intervals are reduced, allowing a higher resolution over the same
1599 * bandwidth. This is a read-only flag.
1600 */
1601 #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1602 /*
1603 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1604 * of six. These formats can be optionally played at 1 / 1.001 speed.
1605 * This is a read-only flag.
1606 */
1607 #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1608 /*
1609 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1610 * by receivers.
1611 * If the framerate of the format is a multiple of six, then the pixelclock
1612 * used to set up the transmitter is divided by 1.001 to make it compatible
1613 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1614 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1615 * such frequencies, then the flag will also be cleared.
1616 */
1617 #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1618 /*
1619 * Specific to interlaced formats: if set, then field 1 is really one half-line
1620 * longer and field 2 is really one half-line shorter, so each field has
1621 * exactly the same number of half-lines. Whether half-lines can be detected
1622 * or used depends on the hardware.
1623 */
1624 #define V4L2_DV_FL_HALF_LINE (1 << 3)
1625 /*
1626 * If set, then this is a Consumer Electronics (CE) video format. Such formats
1627 * differ from other formats (commonly called IT formats) in that if RGB
1628 * encoding is used then by default the RGB values use limited range (i.e.
1629 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1630 * except for the 640x480 format are CE formats.
1631 */
1632 #define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
1633 /* Some formats like SMPTE-125M have an interlaced signal with a odd
1634 * total height. For these formats, if this flag is set, the first
1635 * field has the extra line. If not, it is the second field.
1636 */
1637 #define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
1638 /*
1639 * If set, then the picture_aspect field is valid. Otherwise assume that the
1640 * pixels are square, so the picture aspect ratio is the same as the width to
1641 * height ratio.
1642 */
1643 #define V4L2_DV_FL_HAS_PICTURE_ASPECT (1 << 6)
1644 /*
1645 * If set, then the cea861_vic field is valid and contains the Video
1646 * Identification Code as per the CEA-861 standard.
1647 */
1648 #define V4L2_DV_FL_HAS_CEA861_VIC (1 << 7)
1649 /*
1650 * If set, then the hdmi_vic field is valid and contains the Video
1651 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1652 * InfoFrame).
1653 */
1654 #define V4L2_DV_FL_HAS_HDMI_VIC (1 << 8)
1655 /*
1656 * CEA-861 specific: only valid for video receivers.
1657 * If set, then HW can detect the difference between regular FPS and
1658 * 1000/1001 FPS. Note: This flag is only valid for HDMI VIC codes with
1659 * the V4L2_DV_FL_CAN_REDUCE_FPS flag set.
1660 */
1661 #define V4L2_DV_FL_CAN_DETECT_REDUCED_FPS (1 << 9)
1662
1663 /* A few useful defines to calculate the total blanking and frame sizes */
1664 #define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1665 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1666 #define V4L2_DV_BT_FRAME_WIDTH(bt) \
1667 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1668 #define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1669 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1670 ((bt)->interlaced ? \
1671 ((bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch) : 0))
1672 #define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1673 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1674
1675 /** struct v4l2_dv_timings - DV timings
1676 * @type: the type of the timings
1677 * @bt: BT656/1120 timings
1678 */
1679 struct v4l2_dv_timings {
1680 uint32_t type;
1681 union {
1682 struct v4l2_bt_timings bt;
1683 uint32_t reserved[32];
1684 };
1685 } __attribute__ ((packed));
1686
1687 /* Values for the type field */
1688 #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1689
1690
1691 /** struct v4l2_enum_dv_timings - DV timings enumeration
1692 * @index: enumeration index
1693 * @pad: the pad number for which to enumerate timings (used with
1694 * v4l-subdev nodes only)
1695 * @reserved: must be zeroed
1696 * @timings: the timings for the given index
1697 */
1698 struct v4l2_enum_dv_timings {
1699 uint32_t index;
1700 uint32_t pad;
1701 uint32_t reserved[2];
1702 struct v4l2_dv_timings timings;
1703 };
1704
1705 /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1706 * @min_width: width in pixels
1707 * @max_width: width in pixels
1708 * @min_height: height in lines
1709 * @max_height: height in lines
1710 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1711 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1712 * @standards: Supported standards
1713 * @capabilities: Supported capabilities
1714 * @reserved: Must be zeroed
1715 */
1716 struct v4l2_bt_timings_cap {
1717 uint32_t min_width;
1718 uint32_t max_width;
1719 uint32_t min_height;
1720 uint32_t max_height;
1721 uint64_t min_pixelclock;
1722 uint64_t max_pixelclock;
1723 uint32_t standards;
1724 uint32_t capabilities;
1725 uint32_t reserved[16];
1726 } __attribute__ ((packed));
1727
1728 /* Supports interlaced formats */
1729 #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1730 /* Supports progressive formats */
1731 #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1732 /* Supports CVT/GTF reduced blanking */
1733 #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1734 /* Supports custom formats */
1735 #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1736
1737 /** struct v4l2_dv_timings_cap - DV timings capabilities
1738 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1739 * @pad: the pad number for which to query capabilities (used with
1740 * v4l-subdev nodes only)
1741 * @bt: the BT656/1120 timings capabilities
1742 */
1743 struct v4l2_dv_timings_cap {
1744 uint32_t type;
1745 uint32_t pad;
1746 uint32_t reserved[2];
1747 union {
1748 struct v4l2_bt_timings_cap bt;
1749 uint32_t raw_data[32];
1750 };
1751 };
1752
1753
1754 /*
1755 * V I D E O I N P U T S
1756 */
1757 struct v4l2_input {
1758 uint32_t index; /* Which input */
1759 uint8_t name[32]; /* Label */
1760 uint32_t type; /* Type of input */
1761 uint32_t audioset; /* Associated audios (bitfield) */
1762 uint32_t tuner; /* Tuner index */
1763 v4l2_std_id std;
1764 uint32_t status;
1765 uint32_t capabilities;
1766 uint32_t reserved[3];
1767 };
1768
1769 /* Values for the 'type' field */
1770 #define V4L2_INPUT_TYPE_TUNER 1
1771 #define V4L2_INPUT_TYPE_CAMERA 2
1772 #define V4L2_INPUT_TYPE_TOUCH 3
1773
1774 /* field 'status' - general */
1775 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1776 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
1777 #define V4L2_IN_ST_NO_COLOR 0x00000004
1778
1779 /* field 'status' - sensor orientation */
1780 /* If sensor is mounted upside down set both bits */
1781 #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1782 #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1783
1784 /* field 'status' - analog */
1785 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1786 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1787 #define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1788 #define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
1789
1790 /* field 'status' - digital */
1791 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1792 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1793 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1794
1795 /* field 'status' - VCR and set-top box */
1796 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1797 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1798 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1799
1800 /* capabilities flags */
1801 #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1802 #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1803 #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1804 #define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1805
1806 /*
1807 * V I D E O O U T P U T S
1808 */
1809 struct v4l2_output {
1810 uint32_t index; /* Which output */
1811 uint8_t name[32]; /* Label */
1812 uint32_t type; /* Type of output */
1813 uint32_t audioset; /* Associated audios (bitfield) */
1814 uint32_t modulator; /* Associated modulator */
1815 v4l2_std_id std;
1816 uint32_t capabilities;
1817 uint32_t reserved[3];
1818 };
1819 /* Values for the 'type' field */
1820 #define V4L2_OUTPUT_TYPE_MODULATOR 1
1821 #define V4L2_OUTPUT_TYPE_ANALOG 2
1822 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1823
1824 /* capabilities flags */
1825 #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1826 #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1827 #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1828 #define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1829
1830 /*
1831 * C O N T R O L S
1832 */
1833 struct v4l2_control {
1834 uint32_t id;
1835 int32_t value;
1836 };
1837
1838 struct v4l2_ext_control {
1839 uint32_t id;
1840 uint32_t size;
1841 uint32_t reserved2[1];
1842 union {
1843 int32_t value;
1844 int64_t value64;
1845 char *string;
1846 uint8_t *p_u8;
1847 uint16_t *p_u16;
1848 uint32_t *p_u32;
1849 int32_t *p_s32;
1850 int64_t *p_s64;
1851 struct v4l2_area *p_area;
1852 struct v4l2_rect *p_rect;
1853 struct v4l2_ctrl_h264_sps *p_h264_sps;
1854 struct v4l2_ctrl_h264_pps *p_h264_pps;
1855 struct v4l2_ctrl_h264_scaling_matrix *p_h264_scaling_matrix;
1856 struct v4l2_ctrl_h264_pred_weights *p_h264_pred_weights;
1857 struct v4l2_ctrl_h264_slice_params *p_h264_slice_params;
1858 struct v4l2_ctrl_h264_decode_params *p_h264_decode_params;
1859 struct v4l2_ctrl_fwht_params *p_fwht_params;
1860 struct v4l2_ctrl_vp8_frame *p_vp8_frame;
1861 struct v4l2_ctrl_mpeg2_sequence *p_mpeg2_sequence;
1862 struct v4l2_ctrl_mpeg2_picture *p_mpeg2_picture;
1863 struct v4l2_ctrl_mpeg2_quantisation *p_mpeg2_quantisation;
1864 struct v4l2_ctrl_vp9_compressed_hdr *p_vp9_compressed_hdr_probs;
1865 struct v4l2_ctrl_vp9_frame *p_vp9_frame;
1866 struct v4l2_ctrl_hevc_sps *p_hevc_sps;
1867 struct v4l2_ctrl_hevc_pps *p_hevc_pps;
1868 struct v4l2_ctrl_hevc_slice_params *p_hevc_slice_params;
1869 struct v4l2_ctrl_hevc_scaling_matrix *p_hevc_scaling_matrix;
1870 struct v4l2_ctrl_hevc_decode_params *p_hevc_decode_params;
1871 struct v4l2_ctrl_av1_sequence *p_av1_sequence;
1872 struct v4l2_ctrl_av1_tile_group_entry *p_av1_tile_group_entry;
1873 struct v4l2_ctrl_av1_frame *p_av1_frame;
1874 struct v4l2_ctrl_av1_film_grain *p_av1_film_grain;
1875 struct v4l2_ctrl_hdr10_cll_info *p_hdr10_cll_info;
1876 struct v4l2_ctrl_hdr10_mastering_display *p_hdr10_mastering_display;
1877 void *ptr;
1878 } __attribute__ ((packed));
1879 } __attribute__ ((packed));
1880
1881 struct v4l2_ext_controls {
1882 union {
1883 uint32_t ctrl_class;
1884 uint32_t which;
1885 };
1886 uint32_t count;
1887 uint32_t error_idx;
1888 int32_t request_fd;
1889 uint32_t reserved[1];
1890 struct v4l2_ext_control *controls;
1891 };
1892
1893 #define V4L2_CTRL_ID_MASK (0x0fffffff)
1894 #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1895 #define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
1896 #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1897 #define V4L2_CTRL_MAX_DIMS (4)
1898 #define V4L2_CTRL_WHICH_CUR_VAL 0
1899 #define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
1900 #define V4L2_CTRL_WHICH_REQUEST_VAL 0x0f010000
1901 #define V4L2_CTRL_WHICH_MIN_VAL 0x0f020000
1902 #define V4L2_CTRL_WHICH_MAX_VAL 0x0f030000
1903
1904 enum v4l2_ctrl_type {
1905 V4L2_CTRL_TYPE_INTEGER = 1,
1906 V4L2_CTRL_TYPE_BOOLEAN = 2,
1907 V4L2_CTRL_TYPE_MENU = 3,
1908 V4L2_CTRL_TYPE_BUTTON = 4,
1909 V4L2_CTRL_TYPE_INTEGER64 = 5,
1910 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1911 V4L2_CTRL_TYPE_STRING = 7,
1912 V4L2_CTRL_TYPE_BITMASK = 8,
1913 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1914
1915 /* Compound types are >= 0x0100 */
1916 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
1917 V4L2_CTRL_TYPE_U8 = 0x0100,
1918 V4L2_CTRL_TYPE_U16 = 0x0101,
1919 V4L2_CTRL_TYPE_U32 = 0x0102,
1920 V4L2_CTRL_TYPE_AREA = 0x0106,
1921 V4L2_CTRL_TYPE_RECT = 0x0107,
1922
1923 V4L2_CTRL_TYPE_HDR10_CLL_INFO = 0x0110,
1924 V4L2_CTRL_TYPE_HDR10_MASTERING_DISPLAY = 0x0111,
1925
1926 V4L2_CTRL_TYPE_H264_SPS = 0x0200,
1927 V4L2_CTRL_TYPE_H264_PPS = 0x0201,
1928 V4L2_CTRL_TYPE_H264_SCALING_MATRIX = 0x0202,
1929 V4L2_CTRL_TYPE_H264_SLICE_PARAMS = 0x0203,
1930 V4L2_CTRL_TYPE_H264_DECODE_PARAMS = 0x0204,
1931 V4L2_CTRL_TYPE_H264_PRED_WEIGHTS = 0x0205,
1932
1933 V4L2_CTRL_TYPE_FWHT_PARAMS = 0x0220,
1934
1935 V4L2_CTRL_TYPE_VP8_FRAME = 0x0240,
1936
1937 V4L2_CTRL_TYPE_MPEG2_QUANTISATION = 0x0250,
1938 V4L2_CTRL_TYPE_MPEG2_SEQUENCE = 0x0251,
1939 V4L2_CTRL_TYPE_MPEG2_PICTURE = 0x0252,
1940
1941 V4L2_CTRL_TYPE_VP9_COMPRESSED_HDR = 0x0260,
1942 V4L2_CTRL_TYPE_VP9_FRAME = 0x0261,
1943
1944 V4L2_CTRL_TYPE_HEVC_SPS = 0x0270,
1945 V4L2_CTRL_TYPE_HEVC_PPS = 0x0271,
1946 V4L2_CTRL_TYPE_HEVC_SLICE_PARAMS = 0x0272,
1947 V4L2_CTRL_TYPE_HEVC_SCALING_MATRIX = 0x0273,
1948 V4L2_CTRL_TYPE_HEVC_DECODE_PARAMS = 0x0274,
1949
1950 V4L2_CTRL_TYPE_AV1_SEQUENCE = 0x280,
1951 V4L2_CTRL_TYPE_AV1_TILE_GROUP_ENTRY = 0x281,
1952 V4L2_CTRL_TYPE_AV1_FRAME = 0x282,
1953 V4L2_CTRL_TYPE_AV1_FILM_GRAIN = 0x283,
1954 };
1955
1956 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1957 struct v4l2_queryctrl {
1958 uint32_t id;
1959 uint32_t type; /* enum v4l2_ctrl_type */
1960 uint8_t name[32]; /* Whatever */
1961 int32_t minimum; /* Note signedness */
1962 int32_t maximum;
1963 int32_t step;
1964 int32_t default_value;
1965 uint32_t flags;
1966 uint32_t reserved[2];
1967 };
1968
1969 /* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1970 struct v4l2_query_ext_ctrl {
1971 uint32_t id;
1972 uint32_t type;
1973 char name[32];
1974 int64_t minimum;
1975 int64_t maximum;
1976 uint64_t step;
1977 int64_t default_value;
1978 uint32_t flags;
1979 uint32_t elem_size;
1980 uint32_t elems;
1981 uint32_t nr_of_dims;
1982 uint32_t dims[V4L2_CTRL_MAX_DIMS];
1983 uint32_t reserved[32];
1984 };
1985
1986 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1987 struct v4l2_querymenu {
1988 uint32_t id;
1989 uint32_t index;
1990 union {
1991 uint8_t name[32]; /* Whatever */
1992 int64_t value;
1993 };
1994 uint32_t reserved;
1995 } __attribute__ ((packed));
1996
1997 /* Control flags */
1998 #define V4L2_CTRL_FLAG_DISABLED 0x0001
1999 #define V4L2_CTRL_FLAG_GRABBED 0x0002
2000 #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
2001 #define V4L2_CTRL_FLAG_UPDATE 0x0008
2002 #define V4L2_CTRL_FLAG_INACTIVE 0x0010
2003 #define V4L2_CTRL_FLAG_SLIDER 0x0020
2004 #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
2005 #define V4L2_CTRL_FLAG_VOLATILE 0x0080
2006 #define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
2007 #define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
2008 #define V4L2_CTRL_FLAG_MODIFY_LAYOUT 0x0400
2009 #define V4L2_CTRL_FLAG_DYNAMIC_ARRAY 0x0800
2010 #define V4L2_CTRL_FLAG_HAS_WHICH_MIN_MAX 0x1000
2011
2012 /* Query flags, to be ORed with the control ID */
2013 #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
2014 #define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
2015
2016 /* User-class control IDs defined by V4L2 */
2017 #define V4L2_CID_MAX_CTRLS 1024
2018 /* IDs reserved for driver specific controls */
2019 #define V4L2_CID_PRIVATE_BASE 0x08000000
2020
2021
2022 /*
2023 * T U N I N G
2024 */
2025 struct v4l2_tuner {
2026 uint32_t index;
2027 uint8_t name[32];
2028 uint32_t type; /* enum v4l2_tuner_type */
2029 uint32_t capability;
2030 uint32_t rangelow;
2031 uint32_t rangehigh;
2032 uint32_t rxsubchans;
2033 uint32_t audmode;
2034 int32_t signal;
2035 int32_t afc;
2036 uint32_t reserved[4];
2037 };
2038
2039 struct v4l2_modulator {
2040 uint32_t index;
2041 uint8_t name[32];
2042 uint32_t capability;
2043 uint32_t rangelow;
2044 uint32_t rangehigh;
2045 uint32_t txsubchans;
2046 uint32_t type; /* enum v4l2_tuner_type */
2047 uint32_t reserved[3];
2048 };
2049
2050 /* Flags for the 'capability' field */
2051 #define V4L2_TUNER_CAP_LOW 0x0001
2052 #define V4L2_TUNER_CAP_NORM 0x0002
2053 #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
2054 #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
2055 #define V4L2_TUNER_CAP_STEREO 0x0010
2056 #define V4L2_TUNER_CAP_LANG2 0x0020
2057 #define V4L2_TUNER_CAP_SAP 0x0020
2058 #define V4L2_TUNER_CAP_LANG1 0x0040
2059 #define V4L2_TUNER_CAP_RDS 0x0080
2060 #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
2061 #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
2062 #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
2063 #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
2064 #define V4L2_TUNER_CAP_1HZ 0x1000
2065
2066 /* Flags for the 'rxsubchans' field */
2067 #define V4L2_TUNER_SUB_MONO 0x0001
2068 #define V4L2_TUNER_SUB_STEREO 0x0002
2069 #define V4L2_TUNER_SUB_LANG2 0x0004
2070 #define V4L2_TUNER_SUB_SAP 0x0004
2071 #define V4L2_TUNER_SUB_LANG1 0x0008
2072 #define V4L2_TUNER_SUB_RDS 0x0010
2073
2074 /* Values for the 'audmode' field */
2075 #define V4L2_TUNER_MODE_MONO 0x0000
2076 #define V4L2_TUNER_MODE_STEREO 0x0001
2077 #define V4L2_TUNER_MODE_LANG2 0x0002
2078 #define V4L2_TUNER_MODE_SAP 0x0002
2079 #define V4L2_TUNER_MODE_LANG1 0x0003
2080 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
2081
2082 struct v4l2_frequency {
2083 uint32_t tuner;
2084 uint32_t type; /* enum v4l2_tuner_type */
2085 uint32_t frequency;
2086 uint32_t reserved[8];
2087 };
2088
2089 #define V4L2_BAND_MODULATION_VSB (1 << 1)
2090 #define V4L2_BAND_MODULATION_FM (1 << 2)
2091 #define V4L2_BAND_MODULATION_AM (1 << 3)
2092
2093 struct v4l2_frequency_band {
2094 uint32_t tuner;
2095 uint32_t type; /* enum v4l2_tuner_type */
2096 uint32_t index;
2097 uint32_t capability;
2098 uint32_t rangelow;
2099 uint32_t rangehigh;
2100 uint32_t modulation;
2101 uint32_t reserved[9];
2102 };
2103
2104 struct v4l2_hw_freq_seek {
2105 uint32_t tuner;
2106 uint32_t type; /* enum v4l2_tuner_type */
2107 uint32_t seek_upward;
2108 uint32_t wrap_around;
2109 uint32_t spacing;
2110 uint32_t rangelow;
2111 uint32_t rangehigh;
2112 uint32_t reserved[5];
2113 };
2114
2115 /*
2116 * R D S
2117 */
2118
2119 struct v4l2_rds_data {
2120 uint8_t lsb;
2121 uint8_t msb;
2122 uint8_t block;
2123 } __attribute__ ((packed));
2124
2125 #define V4L2_RDS_BLOCK_MSK 0x7
2126 #define V4L2_RDS_BLOCK_A 0
2127 #define V4L2_RDS_BLOCK_B 1
2128 #define V4L2_RDS_BLOCK_C 2
2129 #define V4L2_RDS_BLOCK_D 3
2130 #define V4L2_RDS_BLOCK_C_ALT 4
2131 #define V4L2_RDS_BLOCK_INVALID 7
2132
2133 #define V4L2_RDS_BLOCK_CORRECTED 0x40
2134 #define V4L2_RDS_BLOCK_ERROR 0x80
2135
2136 /*
2137 * A U D I O
2138 */
2139 struct v4l2_audio {
2140 uint32_t index;
2141 uint8_t name[32];
2142 uint32_t capability;
2143 uint32_t mode;
2144 uint32_t reserved[2];
2145 };
2146
2147 /* Flags for the 'capability' field */
2148 #define V4L2_AUDCAP_STEREO 0x00001
2149 #define V4L2_AUDCAP_AVL 0x00002
2150
2151 /* Flags for the 'mode' field */
2152 #define V4L2_AUDMODE_AVL 0x00001
2153
2154 struct v4l2_audioout {
2155 uint32_t index;
2156 uint8_t name[32];
2157 uint32_t capability;
2158 uint32_t mode;
2159 uint32_t reserved[2];
2160 };
2161
2162 /*
2163 * M P E G S E R V I C E S
2164 */
2165 #if 1
2166 #define V4L2_ENC_IDX_FRAME_I (0)
2167 #define V4L2_ENC_IDX_FRAME_P (1)
2168 #define V4L2_ENC_IDX_FRAME_B (2)
2169 #define V4L2_ENC_IDX_FRAME_MASK (0xf)
2170
2171 struct v4l2_enc_idx_entry {
2172 uint64_t offset;
2173 uint64_t pts;
2174 uint32_t length;
2175 uint32_t flags;
2176 uint32_t reserved[2];
2177 };
2178
2179 #define V4L2_ENC_IDX_ENTRIES (64)
2180 struct v4l2_enc_idx {
2181 uint32_t entries;
2182 uint32_t entries_cap;
2183 uint32_t reserved[4];
2184 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
2185 };
2186
2187
2188 #define V4L2_ENC_CMD_START (0)
2189 #define V4L2_ENC_CMD_STOP (1)
2190 #define V4L2_ENC_CMD_PAUSE (2)
2191 #define V4L2_ENC_CMD_RESUME (3)
2192
2193 /* Flags for V4L2_ENC_CMD_STOP */
2194 #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
2195
2196 struct v4l2_encoder_cmd {
2197 uint32_t cmd;
2198 uint32_t flags;
2199 union {
2200 struct {
2201 uint32_t data[8];
2202 } raw;
2203 };
2204 };
2205
2206 /* Decoder commands */
2207 #define V4L2_DEC_CMD_START (0)
2208 #define V4L2_DEC_CMD_STOP (1)
2209 #define V4L2_DEC_CMD_PAUSE (2)
2210 #define V4L2_DEC_CMD_RESUME (3)
2211 #define V4L2_DEC_CMD_FLUSH (4)
2212
2213 /* Flags for V4L2_DEC_CMD_START */
2214 #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
2215
2216 /* Flags for V4L2_DEC_CMD_PAUSE */
2217 #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
2218
2219 /* Flags for V4L2_DEC_CMD_STOP */
2220 #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
2221 #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
2222
2223 /* Play format requirements (returned by the driver): */
2224
2225 /* The decoder has no special format requirements */
2226 #define V4L2_DEC_START_FMT_NONE (0)
2227 /* The decoder requires full GOPs */
2228 #define V4L2_DEC_START_FMT_GOP (1)
2229
2230 /* The structure must be zeroed before use by the application
2231 This ensures it can be extended safely in the future. */
2232 struct v4l2_decoder_cmd {
2233 uint32_t cmd;
2234 uint32_t flags;
2235 union {
2236 struct {
2237 uint64_t pts;
2238 } stop;
2239
2240 struct {
2241 /* 0 or 1000 specifies normal speed,
2242 1 specifies forward single stepping,
2243 -1 specifies backward single stepping,
2244 >1: playback at speed/1000 of the normal speed,
2245 <-1: reverse playback at (-speed/1000) of the normal speed. */
2246 int32_t speed;
2247 uint32_t format;
2248 } start;
2249
2250 struct {
2251 uint32_t data[16];
2252 } raw;
2253 };
2254 };
2255 #endif
2256
2257
2258 /*
2259 * D A T A S E R V I C E S ( V B I )
2260 *
2261 * Data services API by Michael Schimek
2262 */
2263
2264 /* Raw VBI */
2265 struct v4l2_vbi_format {
2266 uint32_t sampling_rate; /* in 1 Hz */
2267 uint32_t offset;
2268 uint32_t samples_per_line;
2269 uint32_t sample_format; /* V4L2_PIX_FMT_* */
2270 int32_t start[2];
2271 uint32_t count[2];
2272 uint32_t flags; /* V4L2_VBI_* */
2273 uint32_t reserved[2]; /* must be zero */
2274 };
2275
2276 /* VBI flags */
2277 #define V4L2_VBI_UNSYNC (1 << 0)
2278 #define V4L2_VBI_INTERLACED (1 << 1)
2279
2280 /* ITU-R start lines for each field */
2281 #define V4L2_VBI_ITU_525_F1_START (1)
2282 #define V4L2_VBI_ITU_525_F2_START (264)
2283 #define V4L2_VBI_ITU_625_F1_START (1)
2284 #define V4L2_VBI_ITU_625_F2_START (314)
2285
2286 /* Sliced VBI
2287 *
2288 * This implements is a proposal V4L2 API to allow SLICED VBI
2289 * required for some hardware encoders. It should change without
2290 * notice in the definitive implementation.
2291 */
2292
2293 struct v4l2_sliced_vbi_format {
2294 uint16_t service_set;
2295 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2296 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2297 (equals frame lines 313-336 for 625 line video
2298 standards, 263-286 for 525 line standards) */
2299 uint16_t service_lines[2][24];
2300 uint32_t io_size;
2301 uint32_t reserved[2]; /* must be zero */
2302 };
2303
2304 /* Teletext World System Teletext
2305 (WST), defined on ITU-R BT.653-2 */
2306 #define V4L2_SLICED_TELETEXT_B (0x0001)
2307 /* Video Program System, defined on ETS 300 231*/
2308 #define V4L2_SLICED_VPS (0x0400)
2309 /* Closed Caption, defined on EIA-608 */
2310 #define V4L2_SLICED_CAPTION_525 (0x1000)
2311 /* Wide Screen System, defined on ITU-R BT1119.1 */
2312 #define V4L2_SLICED_WSS_625 (0x4000)
2313
2314 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
2315 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
2316
2317 struct v4l2_sliced_vbi_cap {
2318 uint16_t service_set;
2319 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2320 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2321 (equals frame lines 313-336 for 625 line video
2322 standards, 263-286 for 525 line standards) */
2323 uint16_t service_lines[2][24];
2324 uint32_t type; /* enum v4l2_buf_type */
2325 uint32_t reserved[3]; /* must be 0 */
2326 };
2327
2328 struct v4l2_sliced_vbi_data {
2329 uint32_t id;
2330 uint32_t field; /* 0: first field, 1: second field */
2331 uint32_t line; /* 1-23 */
2332 uint32_t reserved; /* must be 0 */
2333 uint8_t data[48];
2334 };
2335
2336 /*
2337 * Sliced VBI data inserted into MPEG Streams
2338 */
2339
2340 /*
2341 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
2342 *
2343 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
2344 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
2345 * data
2346 *
2347 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
2348 * definitions are not included here. See the MPEG-2 specifications for details
2349 * on these headers.
2350 */
2351
2352 /* Line type IDs */
2353 #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
2354 #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
2355 #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
2356 #define V4L2_MPEG_VBI_IVTV_VPS (7)
2357
2358 struct v4l2_mpeg_vbi_itv0_line {
2359 uint8_t id; /* One of V4L2_MPEG_VBI_IVTV_* above */
2360 uint8_t data[42]; /* Sliced VBI data for the line */
2361 } __attribute__ ((packed));
2362
2363 struct v4l2_mpeg_vbi_itv0 {
2364 uint32_t linemask[2]; /* Bitmasks of VBI service lines present */
2365 struct v4l2_mpeg_vbi_itv0_line line[35];
2366 } __attribute__ ((packed));
2367
2368 struct v4l2_mpeg_vbi_ITV0 {
2369 struct v4l2_mpeg_vbi_itv0_line line[36];
2370 } __attribute__ ((packed));
2371
2372 #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
2373 #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
2374
2375 struct v4l2_mpeg_vbi_fmt_ivtv {
2376 uint8_t magic[4];
2377 union {
2378 struct v4l2_mpeg_vbi_itv0 itv0;
2379 struct v4l2_mpeg_vbi_ITV0 ITV0;
2380 };
2381 } __attribute__ ((packed));
2382
2383 /*
2384 * A G G R E G A T E S T R U C T U R E S
2385 */
2386
2387 /**
2388 * struct v4l2_plane_pix_format - additional, per-plane format definition
2389 * @sizeimage: maximum size in bytes required for data, for which
2390 * this plane will be used
2391 * @bytesperline: distance in bytes between the leftmost pixels in two
2392 * adjacent lines
2393 * @reserved: drivers and applications must zero this array
2394 */
2395 struct v4l2_plane_pix_format {
2396 uint32_t sizeimage;
2397 uint32_t bytesperline;
2398 uint16_t reserved[6];
2399 } __attribute__ ((packed));
2400
2401 /**
2402 * struct v4l2_pix_format_mplane - multiplanar format definition
2403 * @width: image width in pixels
2404 * @height: image height in pixels
2405 * @pixelformat: little endian four character code (fourcc)
2406 * @field: enum v4l2_field; field order (for interlaced video)
2407 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
2408 * @plane_fmt: per-plane information
2409 * @num_planes: number of planes for this format
2410 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
2411 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
2412 * @hsv_enc: enum v4l2_hsv_encoding, HSV encoding
2413 * @quantization: enum v4l2_quantization, colorspace quantization
2414 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
2415 * @reserved: drivers and applications must zero this array
2416 */
2417 struct v4l2_pix_format_mplane {
2418 uint32_t width;
2419 uint32_t height;
2420 uint32_t pixelformat;
2421 uint32_t field;
2422 uint32_t colorspace;
2423
2424 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2425 uint8_t num_planes;
2426 uint8_t flags;
2427 union {
2428 uint8_t ycbcr_enc;
2429 uint8_t hsv_enc;
2430 };
2431 uint8_t quantization;
2432 uint8_t xfer_func;
2433 uint8_t reserved[7];
2434 } __attribute__ ((packed));
2435
2436 /**
2437 * struct v4l2_sdr_format - SDR format definition
2438 * @pixelformat: little endian four character code (fourcc)
2439 * @buffersize: maximum size in bytes required for data
2440 * @reserved: drivers and applications must zero this array
2441 */
2442 struct v4l2_sdr_format {
2443 uint32_t pixelformat;
2444 uint32_t buffersize;
2445 uint8_t reserved[24];
2446 } __attribute__ ((packed));
2447
2448 /**
2449 * struct v4l2_meta_format - metadata format definition
2450 * @dataformat: little endian four character code (fourcc)
2451 * @buffersize: maximum size in bytes required for data
2452 * @width: number of data units of data per line (valid for line
2453 * based formats only, see format documentation)
2454 * @height: number of lines of data per buffer (valid for line based
2455 * formats only)
2456 * @bytesperline: offset between the beginnings of two adjacent lines in
2457 * bytes (valid for line based formats only)
2458 */
2459 struct v4l2_meta_format {
2460 uint32_t dataformat;
2461 uint32_t buffersize;
2462 uint32_t width;
2463 uint32_t height;
2464 uint32_t bytesperline;
2465 } __attribute__ ((packed));
2466
2467 /**
2468 * struct v4l2_format - stream data format
2469 * @type: enum v4l2_buf_type; type of the data stream
2470 * @fmt.pix: definition of an image format
2471 * @fmt.pix_mp: definition of a multiplanar image format
2472 * @fmt.win: definition of an overlaid image
2473 * @fmt.vbi: raw VBI capture or output parameters
2474 * @fmt.sliced: sliced VBI capture or output parameters
2475 * @fmt.raw_data: placeholder for future extensions and custom formats
2476 * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr,
2477 * @meta and @raw_data
2478 */
2479 struct v4l2_format {
2480 uint32_t type;
2481 union {
2482 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2483 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2484 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2485 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2486 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
2487 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
2488 struct v4l2_meta_format meta; /* V4L2_BUF_TYPE_META_CAPTURE */
2489 uint8_t raw_data[200]; /* user-defined */
2490 } fmt;
2491 };
2492
2493 /* Stream type-dependent parameters
2494 */
2495 struct v4l2_streamparm {
2496 uint32_t type; /* enum v4l2_buf_type */
2497 union {
2498 struct v4l2_captureparm capture;
2499 struct v4l2_outputparm output;
2500 uint8_t raw_data[200]; /* user-defined */
2501 } parm;
2502 };
2503
2504 /*
2505 * E V E N T S
2506 */
2507
2508 #define V4L2_EVENT_ALL 0
2509 #define V4L2_EVENT_VSYNC 1
2510 #define V4L2_EVENT_EOS 2
2511 #define V4L2_EVENT_CTRL 3
2512 #define V4L2_EVENT_FRAME_SYNC 4
2513 #define V4L2_EVENT_SOURCE_CHANGE 5
2514 #define V4L2_EVENT_MOTION_DET 6
2515 #define V4L2_EVENT_PRIVATE_START 0x08000000
2516
2517 /* Payload for V4L2_EVENT_VSYNC */
2518 struct v4l2_event_vsync {
2519 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2520 uint8_t field;
2521 } __attribute__ ((packed));
2522
2523 /* Payload for V4L2_EVENT_CTRL */
2524 #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2525 #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
2526 #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
2527 #define V4L2_EVENT_CTRL_CH_DIMENSIONS (1 << 3)
2528
2529 struct v4l2_event_ctrl {
2530 uint32_t changes;
2531 uint32_t type;
2532 union {
2533 int32_t value;
2534 int64_t value64;
2535 };
2536 uint32_t flags;
2537 int32_t minimum;
2538 int32_t maximum;
2539 int32_t step;
2540 int32_t default_value;
2541 };
2542
2543 struct v4l2_event_frame_sync {
2544 uint32_t frame_sequence;
2545 };
2546
2547 #define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2548
2549 struct v4l2_event_src_change {
2550 uint32_t changes;
2551 };
2552
2553 #define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2554
2555 /**
2556 * struct v4l2_event_motion_det - motion detection event
2557 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2558 * frame_sequence field is valid.
2559 * @frame_sequence: the frame sequence number associated with this event.
2560 * @region_mask: which regions detected motion.
2561 */
2562 struct v4l2_event_motion_det {
2563 uint32_t flags;
2564 uint32_t frame_sequence;
2565 uint32_t region_mask;
2566 };
2567
2568 struct v4l2_event {
2569 uint32_t type;
2570 union {
2571 struct v4l2_event_vsync vsync;
2572 struct v4l2_event_ctrl ctrl;
2573 struct v4l2_event_frame_sync frame_sync;
2574 struct v4l2_event_src_change src_change;
2575 struct v4l2_event_motion_det motion_det;
2576 uint8_t data[64];
2577 } u;
2578 uint32_t pending;
2579 uint32_t sequence;
2580 struct timespec timestamp;
2581 uint32_t id;
2582 uint32_t reserved[8];
2583 };
2584
2585 #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2586 #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2587
2588 struct v4l2_event_subscription {
2589 uint32_t type;
2590 uint32_t id;
2591 uint32_t flags;
2592 uint32_t reserved[5];
2593 };
2594
2595 /*
2596 * A D V A N C E D D E B U G G I N G
2597 *
2598 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2599 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2600 */
2601
2602 /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2603
2604 #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
2605 #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2606
2607 /* The following four defines are no longer in use */
2608 #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2609 #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2610 #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
2611 #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
2612
2613 struct v4l2_dbg_match {
2614 uint32_t type; /* Match type */
2615 union { /* Match this chip, meaning determined by type */
2616 uint32_t addr;
2617 char name[32];
2618 };
2619 } __attribute__ ((packed));
2620
2621 struct v4l2_dbg_register {
2622 struct v4l2_dbg_match match;
2623 uint32_t size; /* register size in bytes */
2624 uint64_t reg;
2625 uint64_t val;
2626 } __attribute__ ((packed));
2627
2628 #define V4L2_CHIP_FL_READABLE (1 << 0)
2629 #define V4L2_CHIP_FL_WRITABLE (1 << 1)
2630
2631 /* VIDIOC_DBG_G_CHIP_INFO */
2632 struct v4l2_dbg_chip_info {
2633 struct v4l2_dbg_match match;
2634 char name[32];
2635 uint32_t flags;
2636 uint32_t reserved[32];
2637 } __attribute__ ((packed));
2638
2639 /**
2640 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2641 * @index: on return, index of the first created buffer
2642 * @count: entry: number of requested buffers,
2643 * return: number of created buffers
2644 * @memory: enum v4l2_memory; buffer memory type
2645 * @format: frame format, for which buffers are requested
2646 * @capabilities: capabilities of this buffer type.
2647 * @flags: additional buffer management attributes (ignored unless the
2648 * queue has V4L2_BUF_CAP_SUPPORTS_MMAP_CACHE_HINTS capability
2649 * and configured for MMAP streaming I/O).
2650 * @max_num_buffers: if V4L2_BUF_CAP_SUPPORTS_MAX_NUM_BUFFERS capability flag is set
2651 * this field indicate the maximum possible number of buffers
2652 * for this queue.
2653 * @reserved: future extensions
2654 */
2655 struct v4l2_create_buffers {
2656 uint32_t index;
2657 uint32_t count;
2658 uint32_t memory;
2659 struct v4l2_format format;
2660 uint32_t capabilities;
2661 uint32_t flags;
2662 uint32_t max_num_buffers;
2663 uint32_t reserved[5];
2664 };
2665
2666 /**
2667 * struct v4l2_remove_buffers - VIDIOC_REMOVE_BUFS argument
2668 * @index: the first buffer to be removed
2669 * @count: number of buffers to removed
2670 * @type: enum v4l2_buf_type
2671 * @reserved: future extensions
2672 */
2673 struct v4l2_remove_buffers {
2674 uint32_t index;
2675 uint32_t count;
2676 uint32_t type;
2677 uint32_t reserved[13];
2678 };
2679
2680 /*
2681 * I O C T L C O D E S F O R V I D E O D E V I C E S
2682 *
2683 */
2684 #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2685 #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2686 #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2687 #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2688 #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2689 #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2690 #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2691 #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2692 #define VIDIOC_OVERLAY _IOW('V', 14, int)
2693 #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
2694 #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
2695 #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2696 #define VIDIOC_STREAMON _IOW('V', 18, int)
2697 #define VIDIOC_STREAMOFF _IOW('V', 19, int)
2698 #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2699 #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2700 #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2701 #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2702 #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2703 #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2704 #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2705 #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2706 #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2707 #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2708 #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2709 #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2710 #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2711 #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2712 #define VIDIOC_G_INPUT _IOR('V', 38, int)
2713 #define VIDIOC_S_INPUT _IOWR('V', 39, int)
2714 #define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2715 #define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
2716 #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2717 #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2718 #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2719 #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2720 #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2721 #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2722 #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2723 #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2724 #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2725 #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2726 #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2727 #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2728 #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2729 #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2730 #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2731 #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2732 #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2733 #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2734 #define VIDIOC_G_PRIORITY _IOR('V', 67, uint32_t) /* enum v4l2_priority */
2735 #define VIDIOC_S_PRIORITY _IOW('V', 68, uint32_t) /* enum v4l2_priority */
2736 #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2737 #define VIDIOC_LOG_STATUS _IO('V', 70)
2738 #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2739 #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2740 #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
2741 #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2742 #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2743 #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2744 #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2745 #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
2746
2747 /*
2748 * Experimental, meant for debugging, testing and internal use.
2749 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2750 * You must be root to use these ioctls. Never use these in applications!
2751 */
2752 #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2753 #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2754
2755 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2756 #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2757 #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2758 #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2759 #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2760 #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2761 #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2762 #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2763 #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2764 #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2765 #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2766 #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2767 #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2768 #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2769 #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2770 #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2771
2772 /*
2773 * Experimental, meant for debugging, testing and internal use.
2774 * Never use this in applications!
2775 */
2776 #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
2777
2778 #define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2779 #define VIDIOC_REMOVE_BUFS _IOWR('V', 104, struct v4l2_remove_buffers)
2780
2781
2782 /* Reminder: when adding new ioctls please add support for them to
2783 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
2784
2785 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2786
2787 /* Deprecated definitions kept for backwards compatibility */
2788 #define V4L2_PIX_FMT_HM12 V4L2_PIX_FMT_NV12_16L16
2789 #define V4L2_PIX_FMT_SUNXI_TILED_NV12 V4L2_PIX_FMT_NV12_32L32
2790 /*
2791 * This capability was never implemented, anyone using this cap should drop it
2792 * from their code.
2793 */
2794 #define V4L2_CAP_ASYNCIO 0x02000000
2795
2796 #endif /* __LINUX_VIDEODEV2_H */