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