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

source code of include/linux/videodev2.h