blob: 94f123f3e04e03307b4d662f13f6d2e0edacabfb [file] [log] [blame]
David Howells607ca462012-10-13 10:46:48 +01001/*
2 * Video for Linux Two header file
3 *
4 * Copyright (C) 1999-2012 the contributors
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * Alternatively you can redistribute this file under the terms of the
17 * BSD license as stated below:
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in
26 * the documentation and/or other materials provided with the
27 * distribution.
28 * 3. The names of its contributors may not be used to endorse or promote
29 * products derived from this software without specific prior written
30 * permission.
31 *
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
38 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
39 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
40 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 *
44 * Header file for v4l or V4L2 drivers and applications
45 * with public API.
46 * All kernel-specific stuff were moved to media/v4l2-dev.h, so
47 * no #if __KERNEL tests are allowed here
48 *
Mauro Carvalho Chehab991ce922015-12-04 10:38:59 -020049 * See https://linuxtv.org for more info
David Howells607ca462012-10-13 10:46:48 +010050 *
51 * Author: Bill Dirks <bill@thedirks.org>
52 * Justin Schoeman
53 * Hans Verkuil <hverkuil@xs4all.nl>
54 * et al.
55 */
56#ifndef _UAPI__LINUX_VIDEODEV2_H
57#define _UAPI__LINUX_VIDEODEV2_H
58
59#ifndef __KERNEL__
60#include <sys/time.h>
61#endif
62#include <linux/compiler.h>
63#include <linux/ioctl.h>
64#include <linux/types.h>
65#include <linux/v4l2-common.h>
66#include <linux/v4l2-controls.h>
67
68/*
69 * Common stuff for both V4L1 and V4L2
70 * Moved from videodev.h
71 */
72#define VIDEO_MAX_FRAME 32
73#define VIDEO_MAX_PLANES 8
74
David Howells607ca462012-10-13 10:46:48 +010075/*
76 * M I S C E L L A N E O U S
77 */
78
79/* Four-character-code (FOURCC) */
80#define v4l2_fourcc(a, b, c, d)\
81 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
Laurent Pinchartfcc0d3d2014-07-21 17:06:33 -030082#define v4l2_fourcc_be(a, b, c, d) (v4l2_fourcc(a, b, c, d) | (1 << 31))
David Howells607ca462012-10-13 10:46:48 +010083
84/*
85 * E N U M S
86 */
87enum v4l2_field {
88 V4L2_FIELD_ANY = 0, /* driver can choose from none,
89 top, bottom, interlaced
90 depending on whatever it thinks
91 is approximate ... */
92 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
93 V4L2_FIELD_TOP = 2, /* top field only */
94 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
95 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
96 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
97 buffer, top-bottom order */
98 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
99 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
100 separate buffers */
101 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
102 first and the top field is
103 transmitted first */
104 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
105 first and the bottom field is
106 transmitted first */
107};
108#define V4L2_FIELD_HAS_TOP(field) \
109 ((field) == V4L2_FIELD_TOP ||\
110 (field) == V4L2_FIELD_INTERLACED ||\
111 (field) == V4L2_FIELD_INTERLACED_TB ||\
112 (field) == V4L2_FIELD_INTERLACED_BT ||\
113 (field) == V4L2_FIELD_SEQ_TB ||\
114 (field) == V4L2_FIELD_SEQ_BT)
115#define V4L2_FIELD_HAS_BOTTOM(field) \
116 ((field) == V4L2_FIELD_BOTTOM ||\
117 (field) == V4L2_FIELD_INTERLACED ||\
118 (field) == V4L2_FIELD_INTERLACED_TB ||\
119 (field) == V4L2_FIELD_INTERLACED_BT ||\
120 (field) == V4L2_FIELD_SEQ_TB ||\
121 (field) == V4L2_FIELD_SEQ_BT)
122#define V4L2_FIELD_HAS_BOTH(field) \
123 ((field) == V4L2_FIELD_INTERLACED ||\
124 (field) == V4L2_FIELD_INTERLACED_TB ||\
125 (field) == V4L2_FIELD_INTERLACED_BT ||\
126 (field) == V4L2_FIELD_SEQ_TB ||\
127 (field) == V4L2_FIELD_SEQ_BT)
Hans Verkuile34c4db2014-02-26 18:22:05 -0300128#define V4L2_FIELD_HAS_T_OR_B(field) \
129 ((field) == V4L2_FIELD_BOTTOM ||\
130 (field) == V4L2_FIELD_TOP ||\
131 (field) == V4L2_FIELD_ALTERNATE)
David Howells607ca462012-10-13 10:46:48 +0100132
133enum v4l2_buf_type {
134 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
135 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
136 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
137 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
138 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
139 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
140 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
David Howells607ca462012-10-13 10:46:48 +0100141 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
David Howells607ca462012-10-13 10:46:48 +0100142 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
143 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
Antti Palosaari6f3073b2013-12-12 13:34:30 -0300144 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
Antti Palosaari9effc722015-10-10 13:51:00 -0300145 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
David Howells607ca462012-10-13 10:46:48 +0100146 /* Deprecated, do not use */
147 V4L2_BUF_TYPE_PRIVATE = 0x80,
148};
149
150#define V4L2_TYPE_IS_MULTIPLANAR(type) \
151 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
152 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
153
154#define V4L2_TYPE_IS_OUTPUT(type) \
155 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
156 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
157 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
158 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
159 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
Antti Palosaari9effc722015-10-10 13:51:00 -0300160 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
161 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT)
David Howells607ca462012-10-13 10:46:48 +0100162
163enum v4l2_tuner_type {
164 V4L2_TUNER_RADIO = 1,
165 V4L2_TUNER_ANALOG_TV = 2,
166 V4L2_TUNER_DIGITAL_TV = 3,
Antti Palosaarif3c3ece2015-10-10 13:50:57 -0300167 V4L2_TUNER_SDR = 4,
Antti Palosaari84099a22013-12-11 20:24:02 -0300168 V4L2_TUNER_RF = 5,
David Howells607ca462012-10-13 10:46:48 +0100169};
170
Antti Palosaarif3c3ece2015-10-10 13:50:57 -0300171/* Deprecated, do not use */
172#define V4L2_TUNER_ADC V4L2_TUNER_SDR
173
David Howells607ca462012-10-13 10:46:48 +0100174enum v4l2_memory {
175 V4L2_MEMORY_MMAP = 1,
176 V4L2_MEMORY_USERPTR = 2,
177 V4L2_MEMORY_OVERLAY = 3,
Sumit Semwal051c7782012-06-14 10:37:35 -0300178 V4L2_MEMORY_DMABUF = 4,
David Howells607ca462012-10-13 10:46:48 +0100179};
180
181/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
182enum v4l2_colorspace {
Hans Verkuile01dfc02015-05-15 09:29:05 -0300183 /*
184 * Default colorspace, i.e. let the driver figure it out.
185 * Can only be used with video capture.
186 */
187 V4L2_COLORSPACE_DEFAULT = 0,
188
Hans Verkuild5735d62014-11-17 09:06:42 -0300189 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
David Howells607ca462012-10-13 10:46:48 +0100190 V4L2_COLORSPACE_SMPTE170M = 1,
191
Hans Verkuild5735d62014-11-17 09:06:42 -0300192 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
David Howells607ca462012-10-13 10:46:48 +0100193 V4L2_COLORSPACE_SMPTE240M = 2,
194
Hans Verkuild5735d62014-11-17 09:06:42 -0300195 /* Rec.709: used for HDTV */
David Howells607ca462012-10-13 10:46:48 +0100196 V4L2_COLORSPACE_REC709 = 3,
197
Hans Verkuild5735d62014-11-17 09:06:42 -0300198 /*
199 * Deprecated, do not use. No driver will ever return this. This was
200 * based on a misunderstanding of the bt878 datasheet.
201 */
David Howells607ca462012-10-13 10:46:48 +0100202 V4L2_COLORSPACE_BT878 = 4,
203
Hans Verkuild5735d62014-11-17 09:06:42 -0300204 /*
205 * NTSC 1953 colorspace. This only makes sense when dealing with
206 * really, really old NTSC recordings. Superseded by SMPTE 170M.
207 */
David Howells607ca462012-10-13 10:46:48 +0100208 V4L2_COLORSPACE_470_SYSTEM_M = 5,
Hans Verkuild5735d62014-11-17 09:06:42 -0300209
210 /*
211 * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
212 * dealing with really old PAL/SECAM recordings. Superseded by
213 * SMPTE 170M.
214 */
David Howells607ca462012-10-13 10:46:48 +0100215 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
216
Hans Verkuild5735d62014-11-17 09:06:42 -0300217 /*
218 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
219 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
David Howells607ca462012-10-13 10:46:48 +0100220 */
221 V4L2_COLORSPACE_JPEG = 7,
222
Hans Verkuild5735d62014-11-17 09:06:42 -0300223 /* For RGB colorspaces such as produces by most webcams. */
David Howells607ca462012-10-13 10:46:48 +0100224 V4L2_COLORSPACE_SRGB = 8,
Hans Verkuild5735d62014-11-17 09:06:42 -0300225
226 /* AdobeRGB colorspace */
227 V4L2_COLORSPACE_ADOBERGB = 9,
228
229 /* BT.2020 colorspace, used for UHDTV. */
230 V4L2_COLORSPACE_BT2020 = 10,
Hans Verkuiladdad102015-05-15 09:29:07 -0300231
232 /* Raw colorspace: for RAW unprocessed images */
233 V4L2_COLORSPACE_RAW = 11,
Hans Verkuil529a79602015-09-13 13:41:29 -0300234
235 /* DCI-P3 colorspace, used by cinema projectors */
236 V4L2_COLORSPACE_DCI_P3 = 12,
Hans Verkuild5735d62014-11-17 09:06:42 -0300237};
238
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300239/*
240 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
241 * This depends on whether this is a SDTV image (use SMPTE 170M), an
242 * HDTV image (use Rec. 709), or something else (use sRGB).
243 */
244#define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
245 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
246 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
247
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300248enum v4l2_xfer_func {
249 /*
250 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
251 * for the various colorspaces:
252 *
253 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
254 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
255 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
256 *
257 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
258 *
259 * V4L2_COLORSPACE_ADOBERGB: V4L2_XFER_FUNC_ADOBERGB
260 *
261 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
262 *
263 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
Hans Verkuil529a79602015-09-13 13:41:29 -0300264 *
265 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300266 */
267 V4L2_XFER_FUNC_DEFAULT = 0,
268 V4L2_XFER_FUNC_709 = 1,
269 V4L2_XFER_FUNC_SRGB = 2,
270 V4L2_XFER_FUNC_ADOBERGB = 3,
271 V4L2_XFER_FUNC_SMPTE240M = 4,
272 V4L2_XFER_FUNC_NONE = 5,
Hans Verkuil529a79602015-09-13 13:41:29 -0300273 V4L2_XFER_FUNC_DCI_P3 = 6,
Hans Verkuil2bdd2802015-09-13 16:15:18 -0300274 V4L2_XFER_FUNC_SMPTE2084 = 7,
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300275};
276
277/*
278 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
279 * This depends on the colorspace.
280 */
281#define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
Hans Verkuilf8d55562015-06-15 10:52:40 -0300282 ((colsp) == V4L2_COLORSPACE_ADOBERGB ? V4L2_XFER_FUNC_ADOBERGB : \
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300283 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
Hans Verkuil529a79602015-09-13 13:41:29 -0300284 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
285 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
286 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
287 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300288
Hans Verkuild5735d62014-11-17 09:06:42 -0300289enum v4l2_ycbcr_encoding {
290 /*
291 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
292 * various colorspaces:
293 *
294 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
Hans Verkuiladca8c82016-08-04 06:01:48 -0300295 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_SRGB,
296 * V4L2_COLORSPACE_ADOBERGB and V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
Hans Verkuild5735d62014-11-17 09:06:42 -0300297 *
Hans Verkuil529a79602015-09-13 13:41:29 -0300298 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
Hans Verkuild5735d62014-11-17 09:06:42 -0300299 *
Hans Verkuild5735d62014-11-17 09:06:42 -0300300 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
301 *
302 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
303 */
304 V4L2_YCBCR_ENC_DEFAULT = 0,
305
306 /* ITU-R 601 -- SDTV */
307 V4L2_YCBCR_ENC_601 = 1,
308
309 /* Rec. 709 -- HDTV */
310 V4L2_YCBCR_ENC_709 = 2,
311
312 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
313 V4L2_YCBCR_ENC_XV601 = 3,
314
315 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
316 V4L2_YCBCR_ENC_XV709 = 4,
317
Hans Verkuiladca8c82016-08-04 06:01:48 -0300318#ifndef __KERNEL__
319 /*
320 * sYCC (Y'CbCr encoding of sRGB), identical to ENC_601. It was added
321 * originally due to a misunderstanding of the sYCC standard. It should
322 * not be used, instead use V4L2_YCBCR_ENC_601.
323 */
Hans Verkuild5735d62014-11-17 09:06:42 -0300324 V4L2_YCBCR_ENC_SYCC = 5,
Hans Verkuiladca8c82016-08-04 06:01:48 -0300325#endif
Hans Verkuild5735d62014-11-17 09:06:42 -0300326
327 /* BT.2020 Non-constant Luminance Y'CbCr */
328 V4L2_YCBCR_ENC_BT2020 = 6,
329
330 /* BT.2020 Constant Luminance Y'CbcCrc */
331 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
332
333 /* SMPTE 240M -- Obsolete HDTV */
334 V4L2_YCBCR_ENC_SMPTE240M = 8,
335};
336
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300337/*
338 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
339 * This depends on the colorspace.
340 */
341#define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
Hans Verkuil529a79602015-09-13 13:41:29 -0300342 (((colsp) == V4L2_COLORSPACE_REC709 || \
343 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300344 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
345 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
346 V4L2_YCBCR_ENC_601)))
347
Hans Verkuild5735d62014-11-17 09:06:42 -0300348enum v4l2_quantization {
349 /*
Hans Verkuilaa05b972015-03-08 04:53:32 -0300350 * The default for R'G'B' quantization is always full range, except
351 * for the BT2020 colorspace. For Y'CbCr the quantization is always
Hans Verkuil7e0739c2016-08-04 05:51:12 -0300352 * limited range, except for COLORSPACE_JPEG, SRGB, ADOBERGB,
353 * XV601 or XV709: those are full range.
Hans Verkuild5735d62014-11-17 09:06:42 -0300354 */
355 V4L2_QUANTIZATION_DEFAULT = 0,
356 V4L2_QUANTIZATION_FULL_RANGE = 1,
357 V4L2_QUANTIZATION_LIM_RANGE = 2,
David Howells607ca462012-10-13 10:46:48 +0100358};
359
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300360/*
361 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
362 * This depends on whether the image is RGB or not, the colorspace and the
363 * Y'CbCr encoding.
364 */
365#define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb, colsp, ycbcr_enc) \
366 (((is_rgb) && (colsp) == V4L2_COLORSPACE_BT2020) ? V4L2_QUANTIZATION_LIM_RANGE : \
367 (((is_rgb) || (ycbcr_enc) == V4L2_YCBCR_ENC_XV601 || \
Hans Verkuil7e0739c2016-08-04 05:51:12 -0300368 (ycbcr_enc) == V4L2_YCBCR_ENC_XV709 || (colsp) == V4L2_COLORSPACE_JPEG) || \
369 (colsp) == V4L2_COLORSPACE_ADOBERGB || (colsp) == V4L2_COLORSPACE_SRGB ? \
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300370 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
371
David Howells607ca462012-10-13 10:46:48 +0100372enum v4l2_priority {
373 V4L2_PRIORITY_UNSET = 0, /* not initialized */
374 V4L2_PRIORITY_BACKGROUND = 1,
375 V4L2_PRIORITY_INTERACTIVE = 2,
376 V4L2_PRIORITY_RECORD = 3,
377 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
378};
379
380struct v4l2_rect {
381 __s32 left;
382 __s32 top;
Ricardo Ribaldaf90580c2013-11-26 05:31:42 -0300383 __u32 width;
384 __u32 height;
David Howells607ca462012-10-13 10:46:48 +0100385};
386
387struct v4l2_fract {
388 __u32 numerator;
389 __u32 denominator;
390};
391
392/**
393 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
394 *
395 * @driver: name of the driver module (e.g. "bttv")
396 * @card: name of the card (e.g. "Hauppauge WinTV")
397 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
398 * @version: KERNEL_VERSION
399 * @capabilities: capabilities of the physical device as a whole
400 * @device_caps: capabilities accessed via this particular device (node)
401 * @reserved: reserved fields for future extensions
402 */
403struct v4l2_capability {
404 __u8 driver[16];
405 __u8 card[32];
406 __u8 bus_info[32];
407 __u32 version;
408 __u32 capabilities;
409 __u32 device_caps;
410 __u32 reserved[3];
411};
412
413/* Values for 'capabilities' field */
414#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
415#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
416#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
417#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
418#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
419#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
420#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
421#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
422#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
423#define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
424#define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
425
426/* Is a video capture device that supports multiplanar formats */
427#define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
428/* Is a video output device that supports multiplanar formats */
429#define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
430/* Is a video mem-to-mem device that supports multiplanar formats */
431#define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
432/* Is a video mem-to-mem device */
433#define V4L2_CAP_VIDEO_M2M 0x00008000
434
435#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
436#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
437#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
438#define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
439
Antti Palosaaric9c54f72013-12-17 17:41:12 -0300440#define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300441#define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
Antti Palosaari9effc722015-10-10 13:51:00 -0300442#define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
Antti Palosaaric9c54f72013-12-17 17:41:12 -0300443
David Howells607ca462012-10-13 10:46:48 +0100444#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
445#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
446#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
447
Nick Dyerb2fe22d2016-07-18 18:10:30 -0300448#define V4L2_CAP_TOUCH 0x10000000 /* Is a touch device */
449
David Howells607ca462012-10-13 10:46:48 +0100450#define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
451
452/*
453 * V I D E O I M A G E F O R M A T
454 */
455struct v4l2_pix_format {
456 __u32 width;
457 __u32 height;
458 __u32 pixelformat;
459 __u32 field; /* enum v4l2_field */
460 __u32 bytesperline; /* for padding, zero if unused */
461 __u32 sizeimage;
462 __u32 colorspace; /* enum v4l2_colorspace */
463 __u32 priv; /* private data, depends on pixelformat */
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300464 __u32 flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
Hans Verkuild5735d62014-11-17 09:06:42 -0300465 __u32 ycbcr_enc; /* enum v4l2_ycbcr_encoding */
466 __u32 quantization; /* enum v4l2_quantization */
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300467 __u32 xfer_func; /* enum v4l2_xfer_func */
David Howells607ca462012-10-13 10:46:48 +0100468};
469
470/* Pixel format FOURCC depth Description */
471
472/* RGB formats */
473#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
474#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300475#define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
476#define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
David Howells607ca462012-10-13 10:46:48 +0100477#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300478#define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
479#define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
David Howells607ca462012-10-13 10:46:48 +0100480#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
481#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
Laurent Pinchartfcc0d3d2014-07-21 17:06:33 -0300482#define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
483#define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
David Howells607ca462012-10-13 10:46:48 +0100484#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
485#define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
486#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
487#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
488#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300489#define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
490#define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100491#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300492#define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
493#define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100494
495/* Grey formats */
496#define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
497#define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
498#define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
499#define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
500#define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
501#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Ricardo Ribalda2e5e4352015-05-04 05:07:30 -0300502#define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
David Howells607ca462012-10-13 10:46:48 +0100503
504/* Grey bit-packed formats */
505#define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
506
507/* Palette formats */
508#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
509
Manjunath Hadli05ad6fc2012-10-18 07:58:02 -0300510/* Chrominance formats */
511#define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
512
David Howells607ca462012-10-13 10:46:48 +0100513/* Luminance+Chrominance formats */
David Howells607ca462012-10-13 10:46:48 +0100514#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
515#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
516#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
517#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
518#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
David Howells607ca462012-10-13 10:46:48 +0100519#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
520#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
521#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
522#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
523#define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100524#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
525#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
526#define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
527
528/* two planes -- one Y, one Cr + Cb interleaved */
529#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
530#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
531#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
532#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
533#define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
534#define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
535
536/* two non contiguous planes - one Y, one Cr + Cb interleaved */
537#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
538#define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
Laurent Pinchart84930542013-06-26 09:46:42 -0300539#define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
540#define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
David Howells607ca462012-10-13 10:46:48 +0100541#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
542#define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
543
Laurent Pinchart79c8d082016-06-15 20:27:58 -0300544/* three planes - Y Cb, Cr */
545#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
546#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
Laurent Pinchartab46f6d2016-06-15 20:35:36 -0300547#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 12 YVU411 planar */
Laurent Pinchart79c8d082016-06-15 20:27:58 -0300548#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
549#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
550#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
551
David Howells607ca462012-10-13 10:46:48 +0100552/* three non contiguous planes - Y, Cb, Cr */
553#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
554#define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
Laurent Pinchartd65fae92015-11-11 22:02:00 -0200555#define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
556#define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
557#define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
558#define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
David Howells607ca462012-10-13 10:46:48 +0100559
560/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
561#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
562#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
563#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
564#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
565#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
566#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
567#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
568#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Aviv Greenberg4353e362014-12-03 08:14:09 -0300569 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
570#define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
571#define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
572#define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
573#define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
Manjunath Hadli05ad6fc2012-10-18 07:58:02 -0300574 /* 10bit raw bayer a-law compressed to 8 bits */
575#define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
576#define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
577#define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
578#define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
David Howells607ca462012-10-13 10:46:48 +0100579 /* 10bit raw bayer DPCM compressed to 8 bits */
580#define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
581#define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
582#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
583#define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
Sakari Ailuscbb77bc2014-12-07 20:17:49 -0300584#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
585#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
586#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
587#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
David Howells607ca462012-10-13 10:46:48 +0100588#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
589
590/* compressed formats */
591#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
592#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
593#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
594#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
595#define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
596#define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
597#define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
598#define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
599#define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
600#define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
Ismael Lucenoadf62712013-04-18 08:16:08 -0300601#define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
David Howells607ca462012-10-13 10:46:48 +0100602#define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
603#define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
604#define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
605#define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
606
607/* Vendor-specific formats */
608#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
609#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
610#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
611#define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
612#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
613#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
614#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
615#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
616#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
617#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
618#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
619#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
620#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
621#define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
622#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
623#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
624#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
625#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
626#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
627#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
628#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
629#define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
630#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
631#define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
632#define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
633#define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
Aviv Greenberg5d8d8db2016-02-03 15:08:52 -0200634#define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
635#define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
636#define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
David Howells607ca462012-10-13 10:46:48 +0100637
Antti Palosaari00419a62014-02-04 23:55:25 -0300638/* SDR formats - used only for Software Defined Radio devices */
639#define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
640#define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
Antti Palosaaric0c03882014-07-11 13:25:14 -0300641#define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
Antti Palosaari5c5be572014-07-11 16:35:47 -0300642#define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
Antti Palosaari9e9e3922014-06-27 17:42:18 -0300643#define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
Antti Palosaari00419a62014-02-04 23:55:25 -0300644
Nick Dyerb2fe22d2016-07-18 18:10:30 -0300645/* Touch formats - used for Touch devices */
646#define V4L2_TCH_FMT_DELTA_TD16 v4l2_fourcc('T', 'D', '1', '6') /* 16-bit signed deltas */
647#define V4L2_TCH_FMT_DELTA_TD08 v4l2_fourcc('T', 'D', '0', '8') /* 8-bit signed deltas */
648#define V4L2_TCH_FMT_TU16 v4l2_fourcc('T', 'U', '1', '6') /* 16-bit unsigned touch data */
649#define V4L2_TCH_FMT_TU08 v4l2_fourcc('T', 'U', '0', '8') /* 8-bit unsigned touch data */
650
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300651/* priv field value to indicates that subsequent fields are valid. */
652#define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
653
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300654/* Flags */
655#define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
656
David Howells607ca462012-10-13 10:46:48 +0100657/*
658 * F O R M A T E N U M E R A T I O N
659 */
660struct v4l2_fmtdesc {
661 __u32 index; /* Format number */
662 __u32 type; /* enum v4l2_buf_type */
663 __u32 flags;
664 __u8 description[32]; /* Description string */
665 __u32 pixelformat; /* Format fourcc */
666 __u32 reserved[4];
667};
668
669#define V4L2_FMT_FLAG_COMPRESSED 0x0001
670#define V4L2_FMT_FLAG_EMULATED 0x0002
671
Hans Verkuil57c759872016-04-22 06:06:58 -0300672 /* Frame Size and frame rate enumeration */
David Howells607ca462012-10-13 10:46:48 +0100673/*
674 * F R A M E S I Z E E N U M E R A T I O N
675 */
676enum v4l2_frmsizetypes {
677 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
678 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
679 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
680};
681
682struct v4l2_frmsize_discrete {
683 __u32 width; /* Frame width [pixel] */
684 __u32 height; /* Frame height [pixel] */
685};
686
687struct v4l2_frmsize_stepwise {
688 __u32 min_width; /* Minimum frame width [pixel] */
689 __u32 max_width; /* Maximum frame width [pixel] */
690 __u32 step_width; /* Frame width step size [pixel] */
691 __u32 min_height; /* Minimum frame height [pixel] */
692 __u32 max_height; /* Maximum frame height [pixel] */
693 __u32 step_height; /* Frame height step size [pixel] */
694};
695
696struct v4l2_frmsizeenum {
697 __u32 index; /* Frame size number */
698 __u32 pixel_format; /* Pixel format */
699 __u32 type; /* Frame size type the device supports. */
700
701 union { /* Frame size */
702 struct v4l2_frmsize_discrete discrete;
703 struct v4l2_frmsize_stepwise stepwise;
704 };
705
706 __u32 reserved[2]; /* Reserved space for future use */
707};
708
709/*
710 * F R A M E R A T E E N U M E R A T I O N
711 */
712enum v4l2_frmivaltypes {
713 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
714 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
715 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
716};
717
718struct v4l2_frmival_stepwise {
719 struct v4l2_fract min; /* Minimum frame interval [s] */
720 struct v4l2_fract max; /* Maximum frame interval [s] */
721 struct v4l2_fract step; /* Frame interval step size [s] */
722};
723
724struct v4l2_frmivalenum {
725 __u32 index; /* Frame format index */
726 __u32 pixel_format; /* Pixel format */
727 __u32 width; /* Frame width */
728 __u32 height; /* Frame height */
729 __u32 type; /* Frame interval type the device supports. */
730
731 union { /* Frame interval */
732 struct v4l2_fract discrete;
733 struct v4l2_frmival_stepwise stepwise;
734 };
735
736 __u32 reserved[2]; /* Reserved space for future use */
737};
David Howells607ca462012-10-13 10:46:48 +0100738
739/*
740 * T I M E C O D E
741 */
742struct v4l2_timecode {
743 __u32 type;
744 __u32 flags;
745 __u8 frames;
746 __u8 seconds;
747 __u8 minutes;
748 __u8 hours;
749 __u8 userbits[4];
750};
751
752/* Type */
753#define V4L2_TC_TYPE_24FPS 1
754#define V4L2_TC_TYPE_25FPS 2
755#define V4L2_TC_TYPE_30FPS 3
756#define V4L2_TC_TYPE_50FPS 4
757#define V4L2_TC_TYPE_60FPS 5
758
759/* Flags */
760#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
761#define V4L2_TC_FLAG_COLORFRAME 0x0002
762#define V4L2_TC_USERBITS_field 0x000C
763#define V4L2_TC_USERBITS_USERDEFINED 0x0000
764#define V4L2_TC_USERBITS_8BITCHARS 0x0008
765/* The above is based on SMPTE timecodes */
766
767struct v4l2_jpegcompression {
768 int quality;
769
770 int APPn; /* Number of APP segment to be written,
771 * must be 0..15 */
772 int APP_len; /* Length of data in JPEG APPn segment */
773 char APP_data[60]; /* Data in the JPEG APPn segment. */
774
775 int COM_len; /* Length of data in JPEG COM segment */
776 char COM_data[60]; /* Data in JPEG COM segment */
777
778 __u32 jpeg_markers; /* Which markers should go into the JPEG
779 * output. Unless you exactly know what
780 * you do, leave them untouched.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300781 * Including less markers will make the
David Howells607ca462012-10-13 10:46:48 +0100782 * resulting code smaller, but there will
783 * be fewer applications which can read it.
784 * The presence of the APP and COM marker
785 * is influenced by APP_len and COM_len
786 * ONLY, not by this property! */
787
788#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
789#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
790#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
791#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
792#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300793 * always use APP0 */
David Howells607ca462012-10-13 10:46:48 +0100794};
795
796/*
797 * M E M O R Y - M A P P I N G B U F F E R S
798 */
799struct v4l2_requestbuffers {
800 __u32 count;
801 __u32 type; /* enum v4l2_buf_type */
802 __u32 memory; /* enum v4l2_memory */
803 __u32 reserved[2];
804};
805
806/**
807 * struct v4l2_plane - plane info for multi-planar buffers
808 * @bytesused: number of bytes occupied by data in the plane (payload)
809 * @length: size of this plane (NOT the payload) in bytes
810 * @mem_offset: when memory in the associated struct v4l2_buffer is
811 * V4L2_MEMORY_MMAP, equals the offset from the start of
812 * the device memory for this plane (or is a "cookie" that
813 * should be passed to mmap() called on the video node)
814 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
815 * pointing to this plane
Sumit Semwal051c7782012-06-14 10:37:35 -0300816 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
817 * descriptor associated with this plane
David Howells607ca462012-10-13 10:46:48 +0100818 * @data_offset: offset in the plane to the start of data; usually 0,
819 * unless there is a header in front of the data
820 *
821 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
822 * with two planes can have one plane for Y, and another for interleaved CbCr
823 * components. Each plane can reside in a separate memory buffer, or even in
824 * a completely separate memory node (e.g. in embedded devices).
825 */
826struct v4l2_plane {
827 __u32 bytesused;
828 __u32 length;
829 union {
830 __u32 mem_offset;
831 unsigned long userptr;
Sumit Semwal051c7782012-06-14 10:37:35 -0300832 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100833 } m;
834 __u32 data_offset;
835 __u32 reserved[11];
836};
837
838/**
839 * struct v4l2_buffer - video buffer info
840 * @index: id number of the buffer
841 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
842 * multiplanar buffers);
843 * @bytesused: number of bytes occupied by data in the buffer (payload);
844 * unused (set to 0) for multiplanar buffers
845 * @flags: buffer informational flags
846 * @field: enum v4l2_field; field order of the image in the buffer
847 * @timestamp: frame timestamp
848 * @timecode: frame timecode
849 * @sequence: sequence count of this frame
850 * @memory: enum v4l2_memory; the method, in which the actual video data is
851 * passed
852 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
853 * offset from the start of the device memory for this plane,
854 * (or a "cookie" that should be passed to mmap() as offset)
855 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
856 * a userspace pointer pointing to this buffer
Sumit Semwal051c7782012-06-14 10:37:35 -0300857 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
858 * a userspace file descriptor associated with this buffer
David Howells607ca462012-10-13 10:46:48 +0100859 * @planes: for multiplanar buffers; userspace pointer to the array of plane
860 * info structs for this buffer
861 * @length: size in bytes of the buffer (NOT its payload) for single-plane
862 * buffers (when type != *_MPLANE); number of elements in the
863 * planes array for multi-plane buffers
David Howells607ca462012-10-13 10:46:48 +0100864 *
865 * Contains data exchanged by application and driver using one of the Streaming
866 * I/O methods.
867 */
868struct v4l2_buffer {
869 __u32 index;
870 __u32 type;
871 __u32 bytesused;
872 __u32 flags;
873 __u32 field;
874 struct timeval timestamp;
875 struct v4l2_timecode timecode;
876 __u32 sequence;
877
878 /* memory location */
879 __u32 memory;
880 union {
881 __u32 offset;
882 unsigned long userptr;
883 struct v4l2_plane *planes;
Sumit Semwal051c7782012-06-14 10:37:35 -0300884 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100885 } m;
886 __u32 length;
887 __u32 reserved2;
888 __u32 reserved;
889};
890
891/* Flags for 'flags' field */
Sakari Ailus939f1372013-08-25 14:00:43 -0300892/* Buffer is mapped (flag) */
893#define V4L2_BUF_FLAG_MAPPED 0x00000001
894/* Buffer is queued for processing */
895#define V4L2_BUF_FLAG_QUEUED 0x00000002
896/* Buffer is ready */
897#define V4L2_BUF_FLAG_DONE 0x00000004
898/* Image is a keyframe (I-frame) */
899#define V4L2_BUF_FLAG_KEYFRAME 0x00000008
900/* Image is a P-frame */
901#define V4L2_BUF_FLAG_PFRAME 0x00000010
902/* Image is a B-frame */
903#define V4L2_BUF_FLAG_BFRAME 0x00000020
David Howells607ca462012-10-13 10:46:48 +0100904/* Buffer is ready, but the data contained within is corrupted. */
Sakari Ailus939f1372013-08-25 14:00:43 -0300905#define V4L2_BUF_FLAG_ERROR 0x00000040
906/* timecode field is valid */
907#define V4L2_BUF_FLAG_TIMECODE 0x00000100
908/* Buffer is prepared for queuing */
909#define V4L2_BUF_FLAG_PREPARED 0x00000400
David Howells607ca462012-10-13 10:46:48 +0100910/* Cache handling flags */
Sakari Ailus939f1372013-08-25 14:00:43 -0300911#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
912#define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
Sakari Ailus1202ecd2012-10-21 16:02:47 -0300913/* Timestamp type */
Sakari Ailus939f1372013-08-25 14:00:43 -0300914#define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
915#define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
916#define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
917#define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
Sakari Ailus872484c2013-08-25 17:57:03 -0300918/* Timestamp sources. */
919#define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
920#define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
921#define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
Peter Seidererdc199242015-05-04 07:51:05 -0300922/* mem2mem encoder/decoder */
923#define V4L2_BUF_FLAG_LAST 0x00100000
David Howells607ca462012-10-13 10:46:48 +0100924
Tomasz Stanislawskib799d092012-06-14 11:32:23 -0300925/**
926 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
927 *
928 * @index: id number of the buffer
929 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
930 * multiplanar buffers);
931 * @plane: index of the plane to be exported, 0 for single plane queues
932 * @flags: flags for newly created file, currently only O_CLOEXEC is
933 * supported, refer to manual of open syscall for more details
934 * @fd: file descriptor associated with DMABUF (set by driver)
935 *
936 * Contains data used for exporting a video buffer as DMABUF file descriptor.
937 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
938 * (identical to the cookie used to mmap() the buffer to userspace). All
939 * reserved fields must be set to zero. The field reserved0 is expected to
940 * become a structure 'type' allowing an alternative layout of the structure
941 * content. Therefore this field should not be used for any other extensions.
942 */
943struct v4l2_exportbuffer {
944 __u32 type; /* enum v4l2_buf_type */
945 __u32 index;
946 __u32 plane;
947 __u32 flags;
948 __s32 fd;
949 __u32 reserved[11];
950};
951
David Howells607ca462012-10-13 10:46:48 +0100952/*
953 * O V E R L A Y P R E V I E W
954 */
955struct v4l2_framebuffer {
956 __u32 capability;
957 __u32 flags;
958/* FIXME: in theory we should pass something like PCI device + memory
959 * region + offset instead of some physical address */
960 void *base;
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300961 struct {
962 __u32 width;
963 __u32 height;
964 __u32 pixelformat;
965 __u32 field; /* enum v4l2_field */
966 __u32 bytesperline; /* for padding, zero if unused */
967 __u32 sizeimage;
968 __u32 colorspace; /* enum v4l2_colorspace */
969 __u32 priv; /* reserved field, set to 0 */
970 } fmt;
David Howells607ca462012-10-13 10:46:48 +0100971};
972/* Flags for the 'capability' field. Read only */
973#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
974#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
975#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
976#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
977#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
978#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
979#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
980#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
981/* Flags for the 'flags' field. */
982#define V4L2_FBUF_FLAG_PRIMARY 0x0001
983#define V4L2_FBUF_FLAG_OVERLAY 0x0002
984#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
985#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
986#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
987#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
988#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
989
990struct v4l2_clip {
991 struct v4l2_rect c;
992 struct v4l2_clip __user *next;
993};
994
995struct v4l2_window {
996 struct v4l2_rect w;
997 __u32 field; /* enum v4l2_field */
998 __u32 chromakey;
999 struct v4l2_clip __user *clips;
1000 __u32 clipcount;
1001 void __user *bitmap;
1002 __u8 global_alpha;
1003};
1004
1005/*
1006 * C A P T U R E P A R A M E T E R S
1007 */
1008struct v4l2_captureparm {
1009 __u32 capability; /* Supported modes */
1010 __u32 capturemode; /* Current mode */
Kirill Smelkov2e745982012-10-22 14:14:01 -03001011 struct v4l2_fract timeperframe; /* Time per frame in seconds */
David Howells607ca462012-10-13 10:46:48 +01001012 __u32 extendedmode; /* Driver-specific extensions */
1013 __u32 readbuffers; /* # of buffers for read */
1014 __u32 reserved[4];
1015};
1016
1017/* Flags for 'capability' and 'capturemode' fields */
1018#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1019#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1020
1021struct v4l2_outputparm {
1022 __u32 capability; /* Supported modes */
1023 __u32 outputmode; /* Current mode */
1024 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1025 __u32 extendedmode; /* Driver-specific extensions */
1026 __u32 writebuffers; /* # of buffers for write */
1027 __u32 reserved[4];
1028};
1029
1030/*
1031 * I N P U T I M A G E C R O P P I N G
1032 */
1033struct v4l2_cropcap {
1034 __u32 type; /* enum v4l2_buf_type */
1035 struct v4l2_rect bounds;
1036 struct v4l2_rect defrect;
1037 struct v4l2_fract pixelaspect;
1038};
1039
1040struct v4l2_crop {
1041 __u32 type; /* enum v4l2_buf_type */
1042 struct v4l2_rect c;
1043};
1044
1045/**
1046 * struct v4l2_selection - selection info
1047 * @type: buffer type (do not use *_MPLANE types)
1048 * @target: Selection target, used to choose one of possible rectangles;
1049 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1050 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1051 * @r: coordinates of selection window
1052 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1053 *
1054 * Hardware may use multiple helper windows to process a video stream.
1055 * The structure is used to exchange this selection areas between
1056 * an application and a driver.
1057 */
1058struct v4l2_selection {
1059 __u32 type;
1060 __u32 target;
1061 __u32 flags;
1062 struct v4l2_rect r;
1063 __u32 reserved[9];
1064};
1065
1066
1067/*
1068 * A N A L O G V I D E O S T A N D A R D
1069 */
1070
1071typedef __u64 v4l2_std_id;
1072
1073/* one bit for each */
1074#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1075#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1076#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1077#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1078#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1079#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1080#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1081#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1082
1083#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1084#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1085#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1086#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1087
1088#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1089#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1090#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1091#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1092
1093#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1094#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1095#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1096#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1097#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1098#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1099#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1100#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1101
1102/* ATSC/HDTV */
1103#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1104#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1105
1106/* FIXME:
1107 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1108 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1109 this value to 32 bits.
1110 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1111 it should work fine. However, if needed to add more than two standards,
1112 v4l2-common.c should be fixed.
1113 */
1114
1115/*
1116 * Some macros to merge video standards in order to make live easier for the
1117 * drivers and V4L2 applications
1118 */
1119
1120/*
1121 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1122 * Missing here.
1123 */
1124#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1125 V4L2_STD_NTSC_M_JP |\
1126 V4L2_STD_NTSC_M_KR)
1127/* Secam macros */
1128#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1129 V4L2_STD_SECAM_K |\
1130 V4L2_STD_SECAM_K1)
1131/* All Secam Standards */
1132#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1133 V4L2_STD_SECAM_G |\
1134 V4L2_STD_SECAM_H |\
1135 V4L2_STD_SECAM_DK |\
1136 V4L2_STD_SECAM_L |\
1137 V4L2_STD_SECAM_LC)
1138/* PAL macros */
1139#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1140 V4L2_STD_PAL_B1 |\
1141 V4L2_STD_PAL_G)
1142#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1143 V4L2_STD_PAL_D1 |\
1144 V4L2_STD_PAL_K)
1145/*
1146 * "Common" PAL - This macro is there to be compatible with the old
1147 * V4L1 concept of "PAL": /BGDKHI.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03001148 * Several PAL standards are missing here: /M, /N and /Nc
David Howells607ca462012-10-13 10:46:48 +01001149 */
1150#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1151 V4L2_STD_PAL_DK |\
1152 V4L2_STD_PAL_H |\
1153 V4L2_STD_PAL_I)
1154/* Chroma "agnostic" standards */
1155#define V4L2_STD_B (V4L2_STD_PAL_B |\
1156 V4L2_STD_PAL_B1 |\
1157 V4L2_STD_SECAM_B)
1158#define V4L2_STD_G (V4L2_STD_PAL_G |\
1159 V4L2_STD_SECAM_G)
1160#define V4L2_STD_H (V4L2_STD_PAL_H |\
1161 V4L2_STD_SECAM_H)
1162#define V4L2_STD_L (V4L2_STD_SECAM_L |\
1163 V4L2_STD_SECAM_LC)
1164#define V4L2_STD_GH (V4L2_STD_G |\
1165 V4L2_STD_H)
1166#define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1167 V4L2_STD_SECAM_DK)
1168#define V4L2_STD_BG (V4L2_STD_B |\
1169 V4L2_STD_G)
1170#define V4L2_STD_MN (V4L2_STD_PAL_M |\
1171 V4L2_STD_PAL_N |\
1172 V4L2_STD_PAL_Nc |\
1173 V4L2_STD_NTSC)
1174
1175/* Standards where MTS/BTSC stereo could be found */
1176#define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1177 V4L2_STD_PAL_M |\
1178 V4L2_STD_PAL_N |\
1179 V4L2_STD_PAL_Nc)
1180
1181/* Standards for Countries with 60Hz Line frequency */
1182#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1183 V4L2_STD_PAL_60 |\
1184 V4L2_STD_NTSC |\
1185 V4L2_STD_NTSC_443)
1186/* Standards for Countries with 50Hz Line frequency */
1187#define V4L2_STD_625_50 (V4L2_STD_PAL |\
1188 V4L2_STD_PAL_N |\
1189 V4L2_STD_PAL_Nc |\
1190 V4L2_STD_SECAM)
1191
1192#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1193 V4L2_STD_ATSC_16_VSB)
1194/* Macros with none and all analog standards */
1195#define V4L2_STD_UNKNOWN 0
1196#define V4L2_STD_ALL (V4L2_STD_525_60 |\
1197 V4L2_STD_625_50)
1198
1199struct v4l2_standard {
1200 __u32 index;
1201 v4l2_std_id id;
1202 __u8 name[24];
1203 struct v4l2_fract frameperiod; /* Frames, not fields */
1204 __u32 framelines;
1205 __u32 reserved[4];
1206};
1207
David Howells607ca462012-10-13 10:46:48 +01001208/*
1209 * D V B T T I M I N G S
1210 */
1211
1212/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1213 * @width: total width of the active video in pixels
1214 * @height: total height of the active video in lines
1215 * @interlaced: Interlaced or progressive
1216 * @polarities: Positive or negative polarities
1217 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1218 * @hfrontporch:Horizontal front porch in pixels
1219 * @hsync: Horizontal Sync length in pixels
1220 * @hbackporch: Horizontal back porch in pixels
1221 * @vfrontporch:Vertical front porch in lines
1222 * @vsync: Vertical Sync length in lines
1223 * @vbackporch: Vertical back porch in lines
1224 * @il_vfrontporch:Vertical front porch for the even field
1225 * (aka field 2) of interlaced field formats
1226 * @il_vsync: Vertical Sync length for the even field
1227 * (aka field 2) of interlaced field formats
1228 * @il_vbackporch:Vertical back porch for the even field
1229 * (aka field 2) of interlaced field formats
1230 * @standards: Standards the timing belongs to
1231 * @flags: Flags
1232 * @reserved: Reserved fields, must be zeroed.
1233 *
1234 * A note regarding vertical interlaced timings: height refers to the total
1235 * height of the active video frame (= two fields). The blanking timings refer
1236 * to the blanking of each field. So the height of the total frame is
1237 * calculated as follows:
1238 *
1239 * tot_height = height + vfrontporch + vsync + vbackporch +
1240 * il_vfrontporch + il_vsync + il_vbackporch
1241 *
1242 * The active height of each field is height / 2.
1243 */
1244struct v4l2_bt_timings {
1245 __u32 width;
1246 __u32 height;
1247 __u32 interlaced;
1248 __u32 polarities;
1249 __u64 pixelclock;
1250 __u32 hfrontporch;
1251 __u32 hsync;
1252 __u32 hbackporch;
1253 __u32 vfrontporch;
1254 __u32 vsync;
1255 __u32 vbackporch;
1256 __u32 il_vfrontporch;
1257 __u32 il_vsync;
1258 __u32 il_vbackporch;
1259 __u32 standards;
1260 __u32 flags;
1261 __u32 reserved[14];
1262} __attribute__ ((packed));
1263
1264/* Interlaced or progressive format */
1265#define V4L2_DV_PROGRESSIVE 0
1266#define V4L2_DV_INTERLACED 1
1267
1268/* Polarities. If bit is not set, it is assumed to be negative polarity */
1269#define V4L2_DV_VSYNC_POS_POL 0x00000001
1270#define V4L2_DV_HSYNC_POS_POL 0x00000002
1271
1272/* Timings standards */
1273#define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1274#define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1275#define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1276#define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
Charles-Antoine Couret7389e6e2016-09-15 12:29:50 -03001277#define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
David Howells607ca462012-10-13 10:46:48 +01001278
1279/* Flags */
1280
1281/* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1282 GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1283 intervals are reduced, allowing a higher resolution over the same
1284 bandwidth. This is a read-only flag. */
1285#define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1286/* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1287 of six. These formats can be optionally played at 1 / 1.001 speed.
1288 This is a read-only flag. */
1289#define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1290/* CEA-861 specific: only valid for video transmitters, the flag is cleared
1291 by receivers.
1292 If the framerate of the format is a multiple of six, then the pixelclock
1293 used to set up the transmitter is divided by 1.001 to make it compatible
1294 with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1295 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1296 such frequencies, then the flag will also be cleared. */
1297#define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1298/* Specific to interlaced formats: if set, then field 1 is really one half-line
1299 longer and field 2 is really one half-line shorter, so each field has
1300 exactly the same number of half-lines. Whether half-lines can be detected
1301 or used depends on the hardware. */
Hans Verkuil292a8782013-03-20 15:26:36 -03001302#define V4L2_DV_FL_HALF_LINE (1 << 3)
Hans Verkuil5ce65d12015-03-20 14:05:03 -03001303/* If set, then this is a Consumer Electronics (CE) video format. Such formats
1304 * differ from other formats (commonly called IT formats) in that if RGB
1305 * encoding is used then by default the RGB values use limited range (i.e.
1306 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1307 * except for the 640x480 format are CE formats. */
1308#define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
Charles-Antoine Couret7389e6e2016-09-15 12:29:50 -03001309/* Some formats like SMPTE-125M have an interlaced signal with a odd
1310 * total height. For these formats, if this flag is set, the first
1311 * field has the extra line. If not, it is the second field.
1312 */
1313#define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
David Howells607ca462012-10-13 10:46:48 +01001314
Hans Verkuil7f681272013-07-29 08:40:58 -03001315/* A few useful defines to calculate the total blanking and frame sizes */
1316#define V4L2_DV_BT_BLANKING_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001317 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001318#define V4L2_DV_BT_FRAME_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001319 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
Hans Verkuil7f681272013-07-29 08:40:58 -03001320#define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001321 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1322 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001323#define V4L2_DV_BT_FRAME_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001324 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
David Howells607ca462012-10-13 10:46:48 +01001325
1326/** struct v4l2_dv_timings - DV timings
1327 * @type: the type of the timings
1328 * @bt: BT656/1120 timings
1329 */
1330struct v4l2_dv_timings {
1331 __u32 type;
1332 union {
1333 struct v4l2_bt_timings bt;
1334 __u32 reserved[32];
1335 };
1336} __attribute__ ((packed));
1337
1338/* Values for the type field */
1339#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1340
1341
1342/** struct v4l2_enum_dv_timings - DV timings enumeration
1343 * @index: enumeration index
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001344 * @pad: the pad number for which to enumerate timings (used with
1345 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001346 * @reserved: must be zeroed
1347 * @timings: the timings for the given index
1348 */
1349struct v4l2_enum_dv_timings {
1350 __u32 index;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001351 __u32 pad;
1352 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001353 struct v4l2_dv_timings timings;
1354};
1355
1356/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1357 * @min_width: width in pixels
1358 * @max_width: width in pixels
1359 * @min_height: height in lines
1360 * @max_height: height in lines
1361 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1362 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1363 * @standards: Supported standards
1364 * @capabilities: Supported capabilities
1365 * @reserved: Must be zeroed
1366 */
1367struct v4l2_bt_timings_cap {
1368 __u32 min_width;
1369 __u32 max_width;
1370 __u32 min_height;
1371 __u32 max_height;
1372 __u64 min_pixelclock;
1373 __u64 max_pixelclock;
1374 __u32 standards;
1375 __u32 capabilities;
1376 __u32 reserved[16];
1377} __attribute__ ((packed));
1378
1379/* Supports interlaced formats */
1380#define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1381/* Supports progressive formats */
1382#define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1383/* Supports CVT/GTF reduced blanking */
1384#define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1385/* Supports custom formats */
1386#define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1387
1388/** struct v4l2_dv_timings_cap - DV timings capabilities
1389 * @type: the type of the timings (same as in struct v4l2_dv_timings)
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001390 * @pad: the pad number for which to query capabilities (used with
1391 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001392 * @bt: the BT656/1120 timings capabilities
1393 */
1394struct v4l2_dv_timings_cap {
1395 __u32 type;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001396 __u32 pad;
1397 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001398 union {
1399 struct v4l2_bt_timings_cap bt;
1400 __u32 raw_data[32];
1401 };
1402};
1403
1404
1405/*
1406 * V I D E O I N P U T S
1407 */
1408struct v4l2_input {
1409 __u32 index; /* Which input */
1410 __u8 name[32]; /* Label */
1411 __u32 type; /* Type of input */
1412 __u32 audioset; /* Associated audios (bitfield) */
1413 __u32 tuner; /* enum v4l2_tuner_type */
1414 v4l2_std_id std;
1415 __u32 status;
1416 __u32 capabilities;
1417 __u32 reserved[3];
1418};
1419
1420/* Values for the 'type' field */
1421#define V4L2_INPUT_TYPE_TUNER 1
1422#define V4L2_INPUT_TYPE_CAMERA 2
Nick Dyerb2fe22d2016-07-18 18:10:30 -03001423#define V4L2_INPUT_TYPE_TOUCH 3
David Howells607ca462012-10-13 10:46:48 +01001424
1425/* field 'status' - general */
1426#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1427#define V4L2_IN_ST_NO_SIGNAL 0x00000002
1428#define V4L2_IN_ST_NO_COLOR 0x00000004
1429
1430/* field 'status' - sensor orientation */
1431/* If sensor is mounted upside down set both bits */
1432#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1433#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1434
1435/* field 'status' - analog */
1436#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1437#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
Charles-Antoine Couret7389e6e2016-09-15 12:29:50 -03001438#define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1439#define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
David Howells607ca462012-10-13 10:46:48 +01001440
1441/* field 'status' - digital */
1442#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1443#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1444#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1445
1446/* field 'status' - VCR and set-top box */
1447#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1448#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1449#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1450
1451/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001452#define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1453#define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1454#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
Sakari Ailus8af03452014-11-18 02:27:00 -03001455#define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
David Howells607ca462012-10-13 10:46:48 +01001456
1457/*
1458 * V I D E O O U T P U T S
1459 */
1460struct v4l2_output {
1461 __u32 index; /* Which output */
1462 __u8 name[32]; /* Label */
1463 __u32 type; /* Type of output */
1464 __u32 audioset; /* Associated audios (bitfield) */
1465 __u32 modulator; /* Associated modulator */
1466 v4l2_std_id std;
1467 __u32 capabilities;
1468 __u32 reserved[3];
1469};
1470/* Values for the 'type' field */
1471#define V4L2_OUTPUT_TYPE_MODULATOR 1
1472#define V4L2_OUTPUT_TYPE_ANALOG 2
1473#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1474
1475/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001476#define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1477#define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1478#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
Sakari Ailus8af03452014-11-18 02:27:00 -03001479#define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
David Howells607ca462012-10-13 10:46:48 +01001480
1481/*
1482 * C O N T R O L S
1483 */
1484struct v4l2_control {
1485 __u32 id;
1486 __s32 value;
1487};
1488
1489struct v4l2_ext_control {
1490 __u32 id;
1491 __u32 size;
1492 __u32 reserved2[1];
1493 union {
1494 __s32 value;
1495 __s64 value64;
Hans Verkuileadf9e22014-08-21 16:49:16 -03001496 char __user *string;
1497 __u8 __user *p_u8;
1498 __u16 __user *p_u16;
1499 __u32 __user *p_u32;
1500 void __user *ptr;
David Howells607ca462012-10-13 10:46:48 +01001501 };
1502} __attribute__ ((packed));
1503
1504struct v4l2_ext_controls {
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001505 union {
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001506#ifndef __KERNEL__
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001507 __u32 ctrl_class;
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001508#endif
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001509 __u32 which;
1510 };
David Howells607ca462012-10-13 10:46:48 +01001511 __u32 count;
1512 __u32 error_idx;
1513 __u32 reserved[2];
1514 struct v4l2_ext_control *controls;
1515};
1516
1517#define V4L2_CTRL_ID_MASK (0x0fffffff)
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001518#ifndef __KERNEL__
David Howells607ca462012-10-13 10:46:48 +01001519#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001520#endif
1521#define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
David Howells607ca462012-10-13 10:46:48 +01001522#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
Hans Verkuil5082c242014-06-10 04:14:50 -03001523#define V4L2_CTRL_MAX_DIMS (4)
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001524#define V4L2_CTRL_WHICH_CUR_VAL 0
1525#define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
David Howells607ca462012-10-13 10:46:48 +01001526
1527enum v4l2_ctrl_type {
1528 V4L2_CTRL_TYPE_INTEGER = 1,
1529 V4L2_CTRL_TYPE_BOOLEAN = 2,
1530 V4L2_CTRL_TYPE_MENU = 3,
1531 V4L2_CTRL_TYPE_BUTTON = 4,
1532 V4L2_CTRL_TYPE_INTEGER64 = 5,
1533 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1534 V4L2_CTRL_TYPE_STRING = 7,
1535 V4L2_CTRL_TYPE_BITMASK = 8,
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001536 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1537
1538 /* Compound types are >= 0x0100 */
1539 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
Hans Verkuildda4a4d2014-06-10 07:30:04 -03001540 V4L2_CTRL_TYPE_U8 = 0x0100,
1541 V4L2_CTRL_TYPE_U16 = 0x0101,
Hans Verkuil811c5082014-07-21 10:45:37 -03001542 V4L2_CTRL_TYPE_U32 = 0x0102,
David Howells607ca462012-10-13 10:46:48 +01001543};
1544
1545/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1546struct v4l2_queryctrl {
1547 __u32 id;
1548 __u32 type; /* enum v4l2_ctrl_type */
1549 __u8 name[32]; /* Whatever */
1550 __s32 minimum; /* Note signedness */
1551 __s32 maximum;
1552 __s32 step;
1553 __s32 default_value;
1554 __u32 flags;
1555 __u32 reserved[2];
1556};
1557
Hans Verkuil5082c242014-06-10 04:14:50 -03001558/* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1559struct v4l2_query_ext_ctrl {
1560 __u32 id;
1561 __u32 type;
1562 char name[32];
1563 __s64 minimum;
1564 __s64 maximum;
1565 __u64 step;
1566 __s64 default_value;
1567 __u32 flags;
1568 __u32 elem_size;
1569 __u32 elems;
1570 __u32 nr_of_dims;
1571 __u32 dims[V4L2_CTRL_MAX_DIMS];
1572 __u32 reserved[32];
1573};
1574
David Howells607ca462012-10-13 10:46:48 +01001575/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1576struct v4l2_querymenu {
1577 __u32 id;
1578 __u32 index;
1579 union {
1580 __u8 name[32]; /* Whatever */
1581 __s64 value;
1582 };
1583 __u32 reserved;
1584} __attribute__ ((packed));
1585
1586/* Control flags */
1587#define V4L2_CTRL_FLAG_DISABLED 0x0001
1588#define V4L2_CTRL_FLAG_GRABBED 0x0002
1589#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1590#define V4L2_CTRL_FLAG_UPDATE 0x0008
1591#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1592#define V4L2_CTRL_FLAG_SLIDER 0x0020
1593#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1594#define V4L2_CTRL_FLAG_VOLATILE 0x0080
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001595#define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
Ricardo Ribaldab6e5b8f2015-03-20 10:45:43 -03001596#define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
David Howells607ca462012-10-13 10:46:48 +01001597
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001598/* Query flags, to be ORed with the control ID */
David Howells607ca462012-10-13 10:46:48 +01001599#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001600#define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
David Howells607ca462012-10-13 10:46:48 +01001601
1602/* User-class control IDs defined by V4L2 */
1603#define V4L2_CID_MAX_CTRLS 1024
1604/* IDs reserved for driver specific controls */
1605#define V4L2_CID_PRIVATE_BASE 0x08000000
1606
1607
David Howells607ca462012-10-13 10:46:48 +01001608/*
1609 * T U N I N G
1610 */
1611struct v4l2_tuner {
1612 __u32 index;
1613 __u8 name[32];
1614 __u32 type; /* enum v4l2_tuner_type */
1615 __u32 capability;
1616 __u32 rangelow;
1617 __u32 rangehigh;
1618 __u32 rxsubchans;
1619 __u32 audmode;
1620 __s32 signal;
1621 __s32 afc;
1622 __u32 reserved[4];
1623};
1624
1625struct v4l2_modulator {
1626 __u32 index;
1627 __u8 name[32];
1628 __u32 capability;
1629 __u32 rangelow;
1630 __u32 rangehigh;
1631 __u32 txsubchans;
Antti Palosaari4124a3c2015-10-10 13:51:02 -03001632 __u32 type; /* enum v4l2_tuner_type */
1633 __u32 reserved[3];
David Howells607ca462012-10-13 10:46:48 +01001634};
1635
1636/* Flags for the 'capability' field */
1637#define V4L2_TUNER_CAP_LOW 0x0001
1638#define V4L2_TUNER_CAP_NORM 0x0002
1639#define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1640#define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1641#define V4L2_TUNER_CAP_STEREO 0x0010
1642#define V4L2_TUNER_CAP_LANG2 0x0020
1643#define V4L2_TUNER_CAP_SAP 0x0020
1644#define V4L2_TUNER_CAP_LANG1 0x0040
1645#define V4L2_TUNER_CAP_RDS 0x0080
1646#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1647#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1648#define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1649#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
Antti Palosaari67f9a112013-12-11 20:27:31 -03001650#define V4L2_TUNER_CAP_1HZ 0x1000
David Howells607ca462012-10-13 10:46:48 +01001651
1652/* Flags for the 'rxsubchans' field */
1653#define V4L2_TUNER_SUB_MONO 0x0001
1654#define V4L2_TUNER_SUB_STEREO 0x0002
1655#define V4L2_TUNER_SUB_LANG2 0x0004
1656#define V4L2_TUNER_SUB_SAP 0x0004
1657#define V4L2_TUNER_SUB_LANG1 0x0008
1658#define V4L2_TUNER_SUB_RDS 0x0010
1659
1660/* Values for the 'audmode' field */
1661#define V4L2_TUNER_MODE_MONO 0x0000
1662#define V4L2_TUNER_MODE_STEREO 0x0001
1663#define V4L2_TUNER_MODE_LANG2 0x0002
1664#define V4L2_TUNER_MODE_SAP 0x0002
1665#define V4L2_TUNER_MODE_LANG1 0x0003
1666#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1667
1668struct v4l2_frequency {
1669 __u32 tuner;
1670 __u32 type; /* enum v4l2_tuner_type */
1671 __u32 frequency;
1672 __u32 reserved[8];
1673};
1674
1675#define V4L2_BAND_MODULATION_VSB (1 << 1)
1676#define V4L2_BAND_MODULATION_FM (1 << 2)
1677#define V4L2_BAND_MODULATION_AM (1 << 3)
1678
1679struct v4l2_frequency_band {
1680 __u32 tuner;
1681 __u32 type; /* enum v4l2_tuner_type */
1682 __u32 index;
1683 __u32 capability;
1684 __u32 rangelow;
1685 __u32 rangehigh;
1686 __u32 modulation;
1687 __u32 reserved[9];
1688};
1689
1690struct v4l2_hw_freq_seek {
1691 __u32 tuner;
1692 __u32 type; /* enum v4l2_tuner_type */
1693 __u32 seek_upward;
1694 __u32 wrap_around;
1695 __u32 spacing;
1696 __u32 rangelow;
1697 __u32 rangehigh;
1698 __u32 reserved[5];
1699};
1700
1701/*
1702 * R D S
1703 */
1704
1705struct v4l2_rds_data {
1706 __u8 lsb;
1707 __u8 msb;
1708 __u8 block;
1709} __attribute__ ((packed));
1710
1711#define V4L2_RDS_BLOCK_MSK 0x7
1712#define V4L2_RDS_BLOCK_A 0
1713#define V4L2_RDS_BLOCK_B 1
1714#define V4L2_RDS_BLOCK_C 2
1715#define V4L2_RDS_BLOCK_D 3
1716#define V4L2_RDS_BLOCK_C_ALT 4
1717#define V4L2_RDS_BLOCK_INVALID 7
1718
1719#define V4L2_RDS_BLOCK_CORRECTED 0x40
1720#define V4L2_RDS_BLOCK_ERROR 0x80
1721
1722/*
1723 * A U D I O
1724 */
1725struct v4l2_audio {
1726 __u32 index;
1727 __u8 name[32];
1728 __u32 capability;
1729 __u32 mode;
1730 __u32 reserved[2];
1731};
1732
1733/* Flags for the 'capability' field */
1734#define V4L2_AUDCAP_STEREO 0x00001
1735#define V4L2_AUDCAP_AVL 0x00002
1736
1737/* Flags for the 'mode' field */
1738#define V4L2_AUDMODE_AVL 0x00001
1739
1740struct v4l2_audioout {
1741 __u32 index;
1742 __u8 name[32];
1743 __u32 capability;
1744 __u32 mode;
1745 __u32 reserved[2];
1746};
1747
1748/*
1749 * M P E G S E R V I C E S
David Howells607ca462012-10-13 10:46:48 +01001750 */
1751#if 1
1752#define V4L2_ENC_IDX_FRAME_I (0)
1753#define V4L2_ENC_IDX_FRAME_P (1)
1754#define V4L2_ENC_IDX_FRAME_B (2)
1755#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1756
1757struct v4l2_enc_idx_entry {
1758 __u64 offset;
1759 __u64 pts;
1760 __u32 length;
1761 __u32 flags;
1762 __u32 reserved[2];
1763};
1764
1765#define V4L2_ENC_IDX_ENTRIES (64)
1766struct v4l2_enc_idx {
1767 __u32 entries;
1768 __u32 entries_cap;
1769 __u32 reserved[4];
1770 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1771};
1772
1773
1774#define V4L2_ENC_CMD_START (0)
1775#define V4L2_ENC_CMD_STOP (1)
1776#define V4L2_ENC_CMD_PAUSE (2)
1777#define V4L2_ENC_CMD_RESUME (3)
1778
1779/* Flags for V4L2_ENC_CMD_STOP */
1780#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1781
1782struct v4l2_encoder_cmd {
1783 __u32 cmd;
1784 __u32 flags;
1785 union {
1786 struct {
1787 __u32 data[8];
1788 } raw;
1789 };
1790};
1791
1792/* Decoder commands */
1793#define V4L2_DEC_CMD_START (0)
1794#define V4L2_DEC_CMD_STOP (1)
1795#define V4L2_DEC_CMD_PAUSE (2)
1796#define V4L2_DEC_CMD_RESUME (3)
1797
1798/* Flags for V4L2_DEC_CMD_START */
1799#define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1800
1801/* Flags for V4L2_DEC_CMD_PAUSE */
1802#define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1803
1804/* Flags for V4L2_DEC_CMD_STOP */
1805#define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1806#define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1807
1808/* Play format requirements (returned by the driver): */
1809
1810/* The decoder has no special format requirements */
1811#define V4L2_DEC_START_FMT_NONE (0)
1812/* The decoder requires full GOPs */
1813#define V4L2_DEC_START_FMT_GOP (1)
1814
1815/* The structure must be zeroed before use by the application
1816 This ensures it can be extended safely in the future. */
1817struct v4l2_decoder_cmd {
1818 __u32 cmd;
1819 __u32 flags;
1820 union {
1821 struct {
1822 __u64 pts;
1823 } stop;
1824
1825 struct {
1826 /* 0 or 1000 specifies normal speed,
1827 1 specifies forward single stepping,
1828 -1 specifies backward single stepping,
1829 >1: playback at speed/1000 of the normal speed,
1830 <-1: reverse playback at (-speed/1000) of the normal speed. */
1831 __s32 speed;
1832 __u32 format;
1833 } start;
1834
1835 struct {
1836 __u32 data[16];
1837 } raw;
1838 };
1839};
1840#endif
1841
1842
1843/*
1844 * D A T A S E R V I C E S ( V B I )
1845 *
1846 * Data services API by Michael Schimek
1847 */
1848
1849/* Raw VBI */
1850struct v4l2_vbi_format {
1851 __u32 sampling_rate; /* in 1 Hz */
1852 __u32 offset;
1853 __u32 samples_per_line;
1854 __u32 sample_format; /* V4L2_PIX_FMT_* */
1855 __s32 start[2];
1856 __u32 count[2];
1857 __u32 flags; /* V4L2_VBI_* */
1858 __u32 reserved[2]; /* must be zero */
1859};
1860
1861/* VBI flags */
1862#define V4L2_VBI_UNSYNC (1 << 0)
1863#define V4L2_VBI_INTERLACED (1 << 1)
1864
Hans Verkuil273886b2014-07-18 02:58:41 -03001865/* ITU-R start lines for each field */
1866#define V4L2_VBI_ITU_525_F1_START (1)
1867#define V4L2_VBI_ITU_525_F2_START (264)
1868#define V4L2_VBI_ITU_625_F1_START (1)
1869#define V4L2_VBI_ITU_625_F2_START (314)
1870
David Howells607ca462012-10-13 10:46:48 +01001871/* Sliced VBI
1872 *
1873 * This implements is a proposal V4L2 API to allow SLICED VBI
1874 * required for some hardware encoders. It should change without
1875 * notice in the definitive implementation.
1876 */
1877
1878struct v4l2_sliced_vbi_format {
1879 __u16 service_set;
1880 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1881 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1882 (equals frame lines 313-336 for 625 line video
1883 standards, 263-286 for 525 line standards) */
1884 __u16 service_lines[2][24];
1885 __u32 io_size;
1886 __u32 reserved[2]; /* must be zero */
1887};
1888
1889/* Teletext World System Teletext
1890 (WST), defined on ITU-R BT.653-2 */
1891#define V4L2_SLICED_TELETEXT_B (0x0001)
1892/* Video Program System, defined on ETS 300 231*/
1893#define V4L2_SLICED_VPS (0x0400)
1894/* Closed Caption, defined on EIA-608 */
1895#define V4L2_SLICED_CAPTION_525 (0x1000)
1896/* Wide Screen System, defined on ITU-R BT1119.1 */
1897#define V4L2_SLICED_WSS_625 (0x4000)
1898
1899#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1900#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1901
1902struct v4l2_sliced_vbi_cap {
1903 __u16 service_set;
1904 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1905 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1906 (equals frame lines 313-336 for 625 line video
1907 standards, 263-286 for 525 line standards) */
1908 __u16 service_lines[2][24];
1909 __u32 type; /* enum v4l2_buf_type */
1910 __u32 reserved[3]; /* must be 0 */
1911};
1912
1913struct v4l2_sliced_vbi_data {
1914 __u32 id;
1915 __u32 field; /* 0: first field, 1: second field */
1916 __u32 line; /* 1-23 */
1917 __u32 reserved; /* must be 0 */
1918 __u8 data[48];
1919};
1920
1921/*
1922 * Sliced VBI data inserted into MPEG Streams
1923 */
1924
1925/*
1926 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1927 *
1928 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1929 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1930 * data
1931 *
1932 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1933 * definitions are not included here. See the MPEG-2 specifications for details
1934 * on these headers.
1935 */
1936
1937/* Line type IDs */
1938#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1939#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1940#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1941#define V4L2_MPEG_VBI_IVTV_VPS (7)
1942
1943struct v4l2_mpeg_vbi_itv0_line {
1944 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1945 __u8 data[42]; /* Sliced VBI data for the line */
1946} __attribute__ ((packed));
1947
1948struct v4l2_mpeg_vbi_itv0 {
1949 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1950 struct v4l2_mpeg_vbi_itv0_line line[35];
1951} __attribute__ ((packed));
1952
1953struct v4l2_mpeg_vbi_ITV0 {
1954 struct v4l2_mpeg_vbi_itv0_line line[36];
1955} __attribute__ ((packed));
1956
1957#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1958#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1959
1960struct v4l2_mpeg_vbi_fmt_ivtv {
1961 __u8 magic[4];
1962 union {
1963 struct v4l2_mpeg_vbi_itv0 itv0;
1964 struct v4l2_mpeg_vbi_ITV0 ITV0;
1965 };
1966} __attribute__ ((packed));
1967
1968/*
1969 * A G G R E G A T E S T R U C T U R E S
1970 */
1971
1972/**
1973 * struct v4l2_plane_pix_format - additional, per-plane format definition
1974 * @sizeimage: maximum size in bytes required for data, for which
1975 * this plane will be used
1976 * @bytesperline: distance in bytes between the leftmost pixels in two
1977 * adjacent lines
1978 */
1979struct v4l2_plane_pix_format {
1980 __u32 sizeimage;
Hans Verkuilcc7d2df2015-03-15 14:30:25 -03001981 __u32 bytesperline;
1982 __u16 reserved[6];
David Howells607ca462012-10-13 10:46:48 +01001983} __attribute__ ((packed));
1984
1985/**
1986 * struct v4l2_pix_format_mplane - multiplanar format definition
1987 * @width: image width in pixels
1988 * @height: image height in pixels
1989 * @pixelformat: little endian four character code (fourcc)
1990 * @field: enum v4l2_field; field order (for interlaced video)
1991 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
1992 * @plane_fmt: per-plane information
1993 * @num_planes: number of planes for this format
Laurent Pinchartc96fd462014-05-27 10:12:43 -03001994 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
Hans Verkuild5735d62014-11-17 09:06:42 -03001995 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
1996 * @quantization: enum v4l2_quantization, colorspace quantization
Hans Verkuil74fdcb22015-04-28 08:49:09 -03001997 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
David Howells607ca462012-10-13 10:46:48 +01001998 */
1999struct v4l2_pix_format_mplane {
2000 __u32 width;
2001 __u32 height;
2002 __u32 pixelformat;
2003 __u32 field;
2004 __u32 colorspace;
2005
2006 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2007 __u8 num_planes;
Laurent Pinchartc96fd462014-05-27 10:12:43 -03002008 __u8 flags;
Hans Verkuild5735d62014-11-17 09:06:42 -03002009 __u8 ycbcr_enc;
2010 __u8 quantization;
Hans Verkuil74fdcb22015-04-28 08:49:09 -03002011 __u8 xfer_func;
2012 __u8 reserved[7];
David Howells607ca462012-10-13 10:46:48 +01002013} __attribute__ ((packed));
2014
2015/**
Antti Palosaari87185c92014-03-10 10:43:24 -03002016 * struct v4l2_sdr_format - SDR format definition
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002017 * @pixelformat: little endian four character code (fourcc)
Antti Palosaariaaa968b2014-07-18 15:28:24 -03002018 * @buffersize: maximum size in bytes required for data
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002019 */
Antti Palosaari87185c92014-03-10 10:43:24 -03002020struct v4l2_sdr_format {
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002021 __u32 pixelformat;
Antti Palosaariaaa968b2014-07-18 15:28:24 -03002022 __u32 buffersize;
2023 __u8 reserved[24];
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002024} __attribute__ ((packed));
2025
2026/**
David Howells607ca462012-10-13 10:46:48 +01002027 * struct v4l2_format - stream data format
2028 * @type: enum v4l2_buf_type; type of the data stream
2029 * @pix: definition of an image format
2030 * @pix_mp: definition of a multiplanar image format
2031 * @win: definition of an overlaid image
2032 * @vbi: raw VBI capture or output parameters
2033 * @sliced: sliced VBI capture or output parameters
2034 * @raw_data: placeholder for future extensions and custom formats
2035 */
2036struct v4l2_format {
2037 __u32 type;
2038 union {
2039 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2040 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2041 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2042 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2043 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
Antti Palosaari87185c92014-03-10 10:43:24 -03002044 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
David Howells607ca462012-10-13 10:46:48 +01002045 __u8 raw_data[200]; /* user-defined */
2046 } fmt;
2047};
2048
2049/* Stream type-dependent parameters
2050 */
2051struct v4l2_streamparm {
2052 __u32 type; /* enum v4l2_buf_type */
2053 union {
2054 struct v4l2_captureparm capture;
2055 struct v4l2_outputparm output;
2056 __u8 raw_data[200]; /* user-defined */
2057 } parm;
2058};
2059
2060/*
2061 * E V E N T S
2062 */
2063
2064#define V4L2_EVENT_ALL 0
2065#define V4L2_EVENT_VSYNC 1
2066#define V4L2_EVENT_EOS 2
2067#define V4L2_EVENT_CTRL 3
2068#define V4L2_EVENT_FRAME_SYNC 4
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002069#define V4L2_EVENT_SOURCE_CHANGE 5
Hans Verkuil78ea6112014-01-27 09:26:23 -03002070#define V4L2_EVENT_MOTION_DET 6
David Howells607ca462012-10-13 10:46:48 +01002071#define V4L2_EVENT_PRIVATE_START 0x08000000
2072
2073/* Payload for V4L2_EVENT_VSYNC */
2074struct v4l2_event_vsync {
2075 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2076 __u8 field;
2077} __attribute__ ((packed));
2078
2079/* Payload for V4L2_EVENT_CTRL */
2080#define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2081#define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
Sylwester Nawrocki2ccbe772013-01-19 15:51:55 -03002082#define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
David Howells607ca462012-10-13 10:46:48 +01002083
2084struct v4l2_event_ctrl {
2085 __u32 changes;
2086 __u32 type;
2087 union {
2088 __s32 value;
2089 __s64 value64;
2090 };
2091 __u32 flags;
2092 __s32 minimum;
2093 __s32 maximum;
2094 __s32 step;
2095 __s32 default_value;
2096};
2097
2098struct v4l2_event_frame_sync {
2099 __u32 frame_sequence;
2100};
2101
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002102#define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2103
2104struct v4l2_event_src_change {
2105 __u32 changes;
2106};
2107
Hans Verkuil78ea6112014-01-27 09:26:23 -03002108#define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2109
2110/**
2111 * struct v4l2_event_motion_det - motion detection event
2112 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2113 * frame_sequence field is valid.
2114 * @frame_sequence: the frame sequence number associated with this event.
2115 * @region_mask: which regions detected motion.
2116 */
2117struct v4l2_event_motion_det {
2118 __u32 flags;
2119 __u32 frame_sequence;
2120 __u32 region_mask;
2121};
2122
David Howells607ca462012-10-13 10:46:48 +01002123struct v4l2_event {
2124 __u32 type;
2125 union {
2126 struct v4l2_event_vsync vsync;
2127 struct v4l2_event_ctrl ctrl;
2128 struct v4l2_event_frame_sync frame_sync;
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002129 struct v4l2_event_src_change src_change;
Hans Verkuil78ea6112014-01-27 09:26:23 -03002130 struct v4l2_event_motion_det motion_det;
David Howells607ca462012-10-13 10:46:48 +01002131 __u8 data[64];
2132 } u;
2133 __u32 pending;
2134 __u32 sequence;
2135 struct timespec timestamp;
2136 __u32 id;
2137 __u32 reserved[8];
2138};
2139
2140#define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2141#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2142
2143struct v4l2_event_subscription {
2144 __u32 type;
2145 __u32 id;
2146 __u32 flags;
2147 __u32 reserved[5];
2148};
2149
2150/*
2151 * A D V A N C E D D E B U G G I N G
2152 *
2153 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2154 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2155 */
2156
2157/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2158
Hans Verkuil79b0c642013-03-18 12:16:34 -03002159#define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
Hans Verkuilb71c9982013-05-26 10:03:01 -03002160#define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2161
2162/* The following four defines are no longer in use */
Hans Verkuil79b0c642013-03-18 12:16:34 -03002163#define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2164#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2165#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03002166#define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
David Howells607ca462012-10-13 10:46:48 +01002167
2168struct v4l2_dbg_match {
2169 __u32 type; /* Match type */
2170 union { /* Match this chip, meaning determined by type */
2171 __u32 addr;
2172 char name[32];
2173 };
2174} __attribute__ ((packed));
2175
2176struct v4l2_dbg_register {
2177 struct v4l2_dbg_match match;
2178 __u32 size; /* register size in bytes */
2179 __u64 reg;
2180 __u64 val;
2181} __attribute__ ((packed));
2182
Hans Verkuil79b0c642013-03-18 12:16:34 -03002183#define V4L2_CHIP_FL_READABLE (1 << 0)
2184#define V4L2_CHIP_FL_WRITABLE (1 << 1)
2185
Hans Verkuil96b03d22013-04-06 06:16:58 -03002186/* VIDIOC_DBG_G_CHIP_INFO */
2187struct v4l2_dbg_chip_info {
Hans Verkuil79b0c642013-03-18 12:16:34 -03002188 struct v4l2_dbg_match match;
2189 char name[32];
2190 __u32 flags;
Hans Verkuilb8399b82013-04-08 11:53:55 -03002191 __u32 reserved[32];
Hans Verkuil79b0c642013-03-18 12:16:34 -03002192} __attribute__ ((packed));
2193
David Howells607ca462012-10-13 10:46:48 +01002194/**
2195 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2196 * @index: on return, index of the first created buffer
2197 * @count: entry: number of requested buffers,
2198 * return: number of created buffers
2199 * @memory: enum v4l2_memory; buffer memory type
2200 * @format: frame format, for which buffers are requested
2201 * @reserved: future extensions
2202 */
2203struct v4l2_create_buffers {
2204 __u32 index;
2205 __u32 count;
2206 __u32 memory;
2207 struct v4l2_format format;
2208 __u32 reserved[8];
2209};
2210
2211/*
2212 * 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
2213 *
2214 */
2215#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2216#define VIDIOC_RESERVED _IO('V', 1)
2217#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2218#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2219#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2220#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2221#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2222#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2223#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2224#define VIDIOC_OVERLAY _IOW('V', 14, int)
2225#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
Tomasz Stanislawskib799d092012-06-14 11:32:23 -03002226#define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
David Howells607ca462012-10-13 10:46:48 +01002227#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2228#define VIDIOC_STREAMON _IOW('V', 18, int)
2229#define VIDIOC_STREAMOFF _IOW('V', 19, int)
2230#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2231#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2232#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2233#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2234#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2235#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2236#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2237#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2238#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2239#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2240#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2241#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2242#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2243#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2244#define VIDIOC_G_INPUT _IOR('V', 38, int)
2245#define VIDIOC_S_INPUT _IOWR('V', 39, int)
Hans Verkuil254a4772014-03-04 07:46:47 -03002246#define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2247#define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
David Howells607ca462012-10-13 10:46:48 +01002248#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2249#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2250#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2251#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2252#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2253#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2254#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2255#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2256#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2257#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2258#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2259#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2260#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2261#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2262#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2263#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2264#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2265#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2266#define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2267#define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2268#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2269#define VIDIOC_LOG_STATUS _IO('V', 70)
2270#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2271#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2272#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
David Howells607ca462012-10-13 10:46:48 +01002273#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2274#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2275#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2276#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2277#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
David Howells607ca462012-10-13 10:46:48 +01002278
Hans Verkuil57c759872016-04-22 06:06:58 -03002279/*
2280 * Experimental, meant for debugging, testing and internal use.
2281 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2282 * You must be root to use these ioctls. Never use these in applications!
2283 */
David Howells607ca462012-10-13 10:46:48 +01002284#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2285#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2286
David Howells607ca462012-10-13 10:46:48 +01002287#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
David Howells607ca462012-10-13 10:46:48 +01002288#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2289#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2290#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2291#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2292#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
David Howells607ca462012-10-13 10:46:48 +01002293#define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2294#define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
David Howells607ca462012-10-13 10:46:48 +01002295#define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2296#define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
David Howells607ca462012-10-13 10:46:48 +01002297#define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2298#define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
David Howells607ca462012-10-13 10:46:48 +01002299#define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2300#define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2301#define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
David Howells607ca462012-10-13 10:46:48 +01002302#define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2303
Hans Verkuil57c759872016-04-22 06:06:58 -03002304/*
2305 * Experimental, meant for debugging, testing and internal use.
2306 * Never use this in applications!
2307 */
Hans Verkuil96b03d22013-04-06 06:16:58 -03002308#define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
Hans Verkuil79b0c642013-03-18 12:16:34 -03002309
Hans Verkuil5082c242014-06-10 04:14:50 -03002310#define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2311
David Howells607ca462012-10-13 10:46:48 +01002312/* Reminder: when adding new ioctls please add support for them to
Ricardo Ribaldad9e7d222015-08-21 10:19:20 -03002313 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
David Howells607ca462012-10-13 10:46:48 +01002314
2315#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2316
2317#endif /* _UAPI__LINUX_VIDEODEV2_H */