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