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