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