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