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