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