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