blob: 65f4449dd56e437c97764c1759c14bd4e9b4da70 [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,
141#if 1
142 /* Experimental */
143 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
144#endif
145 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
146 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
Antti Palosaari6f3073b2013-12-12 13:34:30 -0300147 V4L2_BUF_TYPE_SDR_CAPTURE = 11,
Antti Palosaari9effc722015-10-10 13:51:00 -0300148 V4L2_BUF_TYPE_SDR_OUTPUT = 12,
David Howells607ca462012-10-13 10:46:48 +0100149 /* Deprecated, do not use */
150 V4L2_BUF_TYPE_PRIVATE = 0x80,
151};
152
153#define V4L2_TYPE_IS_MULTIPLANAR(type) \
154 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
155 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
156
157#define V4L2_TYPE_IS_OUTPUT(type) \
158 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
159 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
160 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
161 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
162 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
Antti Palosaari9effc722015-10-10 13:51:00 -0300163 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT \
164 || (type) == V4L2_BUF_TYPE_SDR_OUTPUT)
David Howells607ca462012-10-13 10:46:48 +0100165
166enum v4l2_tuner_type {
167 V4L2_TUNER_RADIO = 1,
168 V4L2_TUNER_ANALOG_TV = 2,
169 V4L2_TUNER_DIGITAL_TV = 3,
Antti Palosaarif3c3ece2015-10-10 13:50:57 -0300170 V4L2_TUNER_SDR = 4,
Antti Palosaari84099a22013-12-11 20:24:02 -0300171 V4L2_TUNER_RF = 5,
David Howells607ca462012-10-13 10:46:48 +0100172};
173
Antti Palosaarif3c3ece2015-10-10 13:50:57 -0300174/* Deprecated, do not use */
175#define V4L2_TUNER_ADC V4L2_TUNER_SDR
176
David Howells607ca462012-10-13 10:46:48 +0100177enum v4l2_memory {
178 V4L2_MEMORY_MMAP = 1,
179 V4L2_MEMORY_USERPTR = 2,
180 V4L2_MEMORY_OVERLAY = 3,
Sumit Semwal051c7782012-06-14 10:37:35 -0300181 V4L2_MEMORY_DMABUF = 4,
David Howells607ca462012-10-13 10:46:48 +0100182};
183
184/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
185enum v4l2_colorspace {
Hans Verkuile01dfc02015-05-15 09:29:05 -0300186 /*
187 * Default colorspace, i.e. let the driver figure it out.
188 * Can only be used with video capture.
189 */
190 V4L2_COLORSPACE_DEFAULT = 0,
191
Hans Verkuild5735d62014-11-17 09:06:42 -0300192 /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
David Howells607ca462012-10-13 10:46:48 +0100193 V4L2_COLORSPACE_SMPTE170M = 1,
194
Hans Verkuild5735d62014-11-17 09:06:42 -0300195 /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
David Howells607ca462012-10-13 10:46:48 +0100196 V4L2_COLORSPACE_SMPTE240M = 2,
197
Hans Verkuild5735d62014-11-17 09:06:42 -0300198 /* Rec.709: used for HDTV */
David Howells607ca462012-10-13 10:46:48 +0100199 V4L2_COLORSPACE_REC709 = 3,
200
Hans Verkuild5735d62014-11-17 09:06:42 -0300201 /*
202 * Deprecated, do not use. No driver will ever return this. This was
203 * based on a misunderstanding of the bt878 datasheet.
204 */
David Howells607ca462012-10-13 10:46:48 +0100205 V4L2_COLORSPACE_BT878 = 4,
206
Hans Verkuild5735d62014-11-17 09:06:42 -0300207 /*
208 * NTSC 1953 colorspace. This only makes sense when dealing with
209 * really, really old NTSC recordings. Superseded by SMPTE 170M.
210 */
David Howells607ca462012-10-13 10:46:48 +0100211 V4L2_COLORSPACE_470_SYSTEM_M = 5,
Hans Verkuild5735d62014-11-17 09:06:42 -0300212
213 /*
214 * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
215 * dealing with really old PAL/SECAM recordings. Superseded by
216 * SMPTE 170M.
217 */
David Howells607ca462012-10-13 10:46:48 +0100218 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
219
Hans Verkuild5735d62014-11-17 09:06:42 -0300220 /*
221 * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
222 * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
David Howells607ca462012-10-13 10:46:48 +0100223 */
224 V4L2_COLORSPACE_JPEG = 7,
225
Hans Verkuild5735d62014-11-17 09:06:42 -0300226 /* For RGB colorspaces such as produces by most webcams. */
David Howells607ca462012-10-13 10:46:48 +0100227 V4L2_COLORSPACE_SRGB = 8,
Hans Verkuild5735d62014-11-17 09:06:42 -0300228
229 /* AdobeRGB colorspace */
230 V4L2_COLORSPACE_ADOBERGB = 9,
231
232 /* BT.2020 colorspace, used for UHDTV. */
233 V4L2_COLORSPACE_BT2020 = 10,
Hans Verkuiladdad102015-05-15 09:29:07 -0300234
235 /* Raw colorspace: for RAW unprocessed images */
236 V4L2_COLORSPACE_RAW = 11,
Hans Verkuil529a79602015-09-13 13:41:29 -0300237
238 /* DCI-P3 colorspace, used by cinema projectors */
239 V4L2_COLORSPACE_DCI_P3 = 12,
Hans Verkuild5735d62014-11-17 09:06:42 -0300240};
241
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300242/*
243 * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
244 * This depends on whether this is a SDTV image (use SMPTE 170M), an
245 * HDTV image (use Rec. 709), or something else (use sRGB).
246 */
247#define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv) \
248 ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M : \
249 ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
250
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300251enum v4l2_xfer_func {
252 /*
253 * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
254 * for the various colorspaces:
255 *
256 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
257 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
258 * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
259 *
260 * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
261 *
262 * V4L2_COLORSPACE_ADOBERGB: V4L2_XFER_FUNC_ADOBERGB
263 *
264 * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
265 *
266 * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
Hans Verkuil529a79602015-09-13 13:41:29 -0300267 *
268 * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300269 */
270 V4L2_XFER_FUNC_DEFAULT = 0,
271 V4L2_XFER_FUNC_709 = 1,
272 V4L2_XFER_FUNC_SRGB = 2,
273 V4L2_XFER_FUNC_ADOBERGB = 3,
274 V4L2_XFER_FUNC_SMPTE240M = 4,
275 V4L2_XFER_FUNC_NONE = 5,
Hans Verkuil529a79602015-09-13 13:41:29 -0300276 V4L2_XFER_FUNC_DCI_P3 = 6,
Hans Verkuil2bdd2802015-09-13 16:15:18 -0300277 V4L2_XFER_FUNC_SMPTE2084 = 7,
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300278};
279
280/*
281 * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
282 * This depends on the colorspace.
283 */
284#define V4L2_MAP_XFER_FUNC_DEFAULT(colsp) \
Hans Verkuilf8d55562015-06-15 10:52:40 -0300285 ((colsp) == V4L2_COLORSPACE_ADOBERGB ? V4L2_XFER_FUNC_ADOBERGB : \
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300286 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M : \
Hans Verkuil529a79602015-09-13 13:41:29 -0300287 ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 : \
288 ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE : \
289 ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ? \
290 V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300291
Hans Verkuild5735d62014-11-17 09:06:42 -0300292enum v4l2_ycbcr_encoding {
293 /*
294 * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
295 * various colorspaces:
296 *
297 * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
298 * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_ADOBERGB and
299 * V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
300 *
Hans Verkuil529a79602015-09-13 13:41:29 -0300301 * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
Hans Verkuild5735d62014-11-17 09:06:42 -0300302 *
303 * V4L2_COLORSPACE_SRGB: V4L2_YCBCR_ENC_SYCC
304 *
305 * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
306 *
307 * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
308 */
309 V4L2_YCBCR_ENC_DEFAULT = 0,
310
311 /* ITU-R 601 -- SDTV */
312 V4L2_YCBCR_ENC_601 = 1,
313
314 /* Rec. 709 -- HDTV */
315 V4L2_YCBCR_ENC_709 = 2,
316
317 /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
318 V4L2_YCBCR_ENC_XV601 = 3,
319
320 /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
321 V4L2_YCBCR_ENC_XV709 = 4,
322
323 /* sYCC (Y'CbCr encoding of sRGB) */
324 V4L2_YCBCR_ENC_SYCC = 5,
325
326 /* BT.2020 Non-constant Luminance Y'CbCr */
327 V4L2_YCBCR_ENC_BT2020 = 6,
328
329 /* BT.2020 Constant Luminance Y'CbcCrc */
330 V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
331
332 /* SMPTE 240M -- Obsolete HDTV */
333 V4L2_YCBCR_ENC_SMPTE240M = 8,
334};
335
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300336/*
337 * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
338 * This depends on the colorspace.
339 */
340#define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp) \
Hans Verkuil529a79602015-09-13 13:41:29 -0300341 (((colsp) == V4L2_COLORSPACE_REC709 || \
342 (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 : \
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300343 ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 : \
344 ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M : \
345 V4L2_YCBCR_ENC_601)))
346
Hans Verkuild5735d62014-11-17 09:06:42 -0300347enum v4l2_quantization {
348 /*
Hans Verkuilaa05b972015-03-08 04:53:32 -0300349 * The default for R'G'B' quantization is always full range, except
350 * for the BT2020 colorspace. For Y'CbCr the quantization is always
351 * limited range, except for COLORSPACE_JPEG, SYCC, XV601 or XV709:
352 * those are full range.
Hans Verkuild5735d62014-11-17 09:06:42 -0300353 */
354 V4L2_QUANTIZATION_DEFAULT = 0,
355 V4L2_QUANTIZATION_FULL_RANGE = 1,
356 V4L2_QUANTIZATION_LIM_RANGE = 2,
David Howells607ca462012-10-13 10:46:48 +0100357};
358
Hans Verkuil3818c4d2015-05-15 09:29:09 -0300359/*
360 * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
361 * This depends on whether the image is RGB or not, the colorspace and the
362 * Y'CbCr encoding.
363 */
364#define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb, colsp, ycbcr_enc) \
365 (((is_rgb) && (colsp) == V4L2_COLORSPACE_BT2020) ? V4L2_QUANTIZATION_LIM_RANGE : \
366 (((is_rgb) || (ycbcr_enc) == V4L2_YCBCR_ENC_XV601 || \
367 (ycbcr_enc) == V4L2_YCBCR_ENC_XV709 || (colsp) == V4L2_COLORSPACE_JPEG) ? \
368 V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
369
David Howells607ca462012-10-13 10:46:48 +0100370enum v4l2_priority {
371 V4L2_PRIORITY_UNSET = 0, /* not initialized */
372 V4L2_PRIORITY_BACKGROUND = 1,
373 V4L2_PRIORITY_INTERACTIVE = 2,
374 V4L2_PRIORITY_RECORD = 3,
375 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
376};
377
378struct v4l2_rect {
379 __s32 left;
380 __s32 top;
Ricardo Ribaldaf90580c2013-11-26 05:31:42 -0300381 __u32 width;
382 __u32 height;
David Howells607ca462012-10-13 10:46:48 +0100383};
384
385struct v4l2_fract {
386 __u32 numerator;
387 __u32 denominator;
388};
389
390/**
391 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
392 *
393 * @driver: name of the driver module (e.g. "bttv")
394 * @card: name of the card (e.g. "Hauppauge WinTV")
395 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
396 * @version: KERNEL_VERSION
397 * @capabilities: capabilities of the physical device as a whole
398 * @device_caps: capabilities accessed via this particular device (node)
399 * @reserved: reserved fields for future extensions
400 */
401struct v4l2_capability {
402 __u8 driver[16];
403 __u8 card[32];
404 __u8 bus_info[32];
405 __u32 version;
406 __u32 capabilities;
407 __u32 device_caps;
408 __u32 reserved[3];
409};
410
411/* Values for 'capabilities' field */
412#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
413#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
414#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
415#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
416#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
417#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
418#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
419#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
420#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
421#define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
422#define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
423
424/* Is a video capture device that supports multiplanar formats */
425#define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
426/* Is a video output device that supports multiplanar formats */
427#define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
428/* Is a video mem-to-mem device that supports multiplanar formats */
429#define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
430/* Is a video mem-to-mem device */
431#define V4L2_CAP_VIDEO_M2M 0x00008000
432
433#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
434#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
435#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
436#define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
437
Antti Palosaaric9c54f72013-12-17 17:41:12 -0300438#define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300439#define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
Antti Palosaari9effc722015-10-10 13:51:00 -0300440#define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
Antti Palosaaric9c54f72013-12-17 17:41:12 -0300441
David Howells607ca462012-10-13 10:46:48 +0100442#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
443#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
444#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
445
446#define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
447
448/*
449 * V I D E O I M A G E F O R M A T
450 */
451struct v4l2_pix_format {
452 __u32 width;
453 __u32 height;
454 __u32 pixelformat;
455 __u32 field; /* enum v4l2_field */
456 __u32 bytesperline; /* for padding, zero if unused */
457 __u32 sizeimage;
458 __u32 colorspace; /* enum v4l2_colorspace */
459 __u32 priv; /* private data, depends on pixelformat */
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300460 __u32 flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
Hans Verkuild5735d62014-11-17 09:06:42 -0300461 __u32 ycbcr_enc; /* enum v4l2_ycbcr_encoding */
462 __u32 quantization; /* enum v4l2_quantization */
Hans Verkuil74fdcb22015-04-28 08:49:09 -0300463 __u32 xfer_func; /* enum v4l2_xfer_func */
David Howells607ca462012-10-13 10:46:48 +0100464};
465
466/* Pixel format FOURCC depth Description */
467
468/* RGB formats */
469#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
470#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300471#define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
472#define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
David Howells607ca462012-10-13 10:46:48 +0100473#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300474#define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
475#define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
David Howells607ca462012-10-13 10:46:48 +0100476#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
477#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
Laurent Pinchartfcc0d3d2014-07-21 17:06:33 -0300478#define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
479#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 +0100480#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
481#define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
482#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
483#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
484#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300485#define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
486#define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100487#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
Laurent Pinchart977ff0e2014-05-21 22:07:55 -0300488#define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
489#define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
David Howells607ca462012-10-13 10:46:48 +0100490
491/* Grey formats */
492#define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
493#define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
494#define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
495#define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
496#define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
497#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Ricardo Ribalda2e5e4352015-05-04 05:07:30 -0300498#define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
David Howells607ca462012-10-13 10:46:48 +0100499
500/* Grey bit-packed formats */
501#define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
502
503/* Palette formats */
504#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
505
Manjunath Hadli05ad6fc2012-10-18 07:58:02 -0300506/* Chrominance formats */
507#define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
508
David Howells607ca462012-10-13 10:46:48 +0100509/* Luminance+Chrominance formats */
510#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
511#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
512#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
513#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
514#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
515#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
516#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
517#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
518#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
519#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 */
524#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
525#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
526#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
527#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
528#define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
529
530/* two planes -- one Y, one Cr + Cb interleaved */
531#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
532#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
533#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
534#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
535#define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
536#define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
537
538/* two non contiguous planes - one Y, one Cr + Cb interleaved */
539#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
540#define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
Laurent Pinchart84930542013-06-26 09:46:42 -0300541#define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
542#define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
David Howells607ca462012-10-13 10:46:48 +0100543#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
544#define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
545
546/* three non contiguous planes - Y, Cb, Cr */
547#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
548#define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
549
550/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
551#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
552#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
553#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
554#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
555#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
556#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
557#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
558#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Aviv Greenberg4353e362014-12-03 08:14:09 -0300559 /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
560#define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
561#define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
562#define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
563#define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
Manjunath Hadli05ad6fc2012-10-18 07:58:02 -0300564 /* 10bit raw bayer a-law compressed to 8 bits */
565#define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
566#define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
567#define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
568#define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
David Howells607ca462012-10-13 10:46:48 +0100569 /* 10bit raw bayer DPCM compressed to 8 bits */
570#define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
571#define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
572#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
573#define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
Sakari Ailuscbb77bc2014-12-07 20:17:49 -0300574#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
575#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
576#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
577#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
David Howells607ca462012-10-13 10:46:48 +0100578#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
579
580/* compressed formats */
581#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
582#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
583#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
584#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
585#define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
586#define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
587#define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
588#define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
589#define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
590#define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
Ismael Lucenoadf62712013-04-18 08:16:08 -0300591#define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
David Howells607ca462012-10-13 10:46:48 +0100592#define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
593#define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
594#define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
595#define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
596
597/* Vendor-specific formats */
598#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
599#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
600#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
601#define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
602#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
603#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
604#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
605#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
606#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
607#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
608#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
609#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
610#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
611#define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
612#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
613#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
614#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
615#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
616#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
617#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
618#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
619#define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
620#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
621#define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
622#define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
623#define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
Aviv Greenberg120c41d2015-10-16 08:48:51 -0300624#define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
625#define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
626#define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
David Howells607ca462012-10-13 10:46:48 +0100627
Antti Palosaari00419a62014-02-04 23:55:25 -0300628/* SDR formats - used only for Software Defined Radio devices */
629#define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
630#define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
Antti Palosaaric0c03882014-07-11 13:25:14 -0300631#define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
Antti Palosaari5c5be572014-07-11 16:35:47 -0300632#define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
Antti Palosaari9e9e3922014-06-27 17:42:18 -0300633#define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
Antti Palosaari00419a62014-02-04 23:55:25 -0300634
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300635/* priv field value to indicates that subsequent fields are valid. */
636#define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
637
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300638/* Flags */
639#define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
640
David Howells607ca462012-10-13 10:46:48 +0100641/*
642 * F O R M A T E N U M E R A T I O N
643 */
644struct v4l2_fmtdesc {
645 __u32 index; /* Format number */
646 __u32 type; /* enum v4l2_buf_type */
647 __u32 flags;
648 __u8 description[32]; /* Description string */
649 __u32 pixelformat; /* Format fourcc */
650 __u32 reserved[4];
651};
652
653#define V4L2_FMT_FLAG_COMPRESSED 0x0001
654#define V4L2_FMT_FLAG_EMULATED 0x0002
655
656#if 1
657 /* Experimental Frame Size and frame rate enumeration */
658/*
659 * F R A M E S I Z E E N U M E R A T I O N
660 */
661enum v4l2_frmsizetypes {
662 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
663 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
664 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
665};
666
667struct v4l2_frmsize_discrete {
668 __u32 width; /* Frame width [pixel] */
669 __u32 height; /* Frame height [pixel] */
670};
671
672struct v4l2_frmsize_stepwise {
673 __u32 min_width; /* Minimum frame width [pixel] */
674 __u32 max_width; /* Maximum frame width [pixel] */
675 __u32 step_width; /* Frame width step size [pixel] */
676 __u32 min_height; /* Minimum frame height [pixel] */
677 __u32 max_height; /* Maximum frame height [pixel] */
678 __u32 step_height; /* Frame height step size [pixel] */
679};
680
681struct v4l2_frmsizeenum {
682 __u32 index; /* Frame size number */
683 __u32 pixel_format; /* Pixel format */
684 __u32 type; /* Frame size type the device supports. */
685
686 union { /* Frame size */
687 struct v4l2_frmsize_discrete discrete;
688 struct v4l2_frmsize_stepwise stepwise;
689 };
690
691 __u32 reserved[2]; /* Reserved space for future use */
692};
693
694/*
695 * F R A M E R A T E E N U M E R A T I O N
696 */
697enum v4l2_frmivaltypes {
698 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
699 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
700 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
701};
702
703struct v4l2_frmival_stepwise {
704 struct v4l2_fract min; /* Minimum frame interval [s] */
705 struct v4l2_fract max; /* Maximum frame interval [s] */
706 struct v4l2_fract step; /* Frame interval step size [s] */
707};
708
709struct v4l2_frmivalenum {
710 __u32 index; /* Frame format index */
711 __u32 pixel_format; /* Pixel format */
712 __u32 width; /* Frame width */
713 __u32 height; /* Frame height */
714 __u32 type; /* Frame interval type the device supports. */
715
716 union { /* Frame interval */
717 struct v4l2_fract discrete;
718 struct v4l2_frmival_stepwise stepwise;
719 };
720
721 __u32 reserved[2]; /* Reserved space for future use */
722};
723#endif
724
725/*
726 * T I M E C O D E
727 */
728struct v4l2_timecode {
729 __u32 type;
730 __u32 flags;
731 __u8 frames;
732 __u8 seconds;
733 __u8 minutes;
734 __u8 hours;
735 __u8 userbits[4];
736};
737
738/* Type */
739#define V4L2_TC_TYPE_24FPS 1
740#define V4L2_TC_TYPE_25FPS 2
741#define V4L2_TC_TYPE_30FPS 3
742#define V4L2_TC_TYPE_50FPS 4
743#define V4L2_TC_TYPE_60FPS 5
744
745/* Flags */
746#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
747#define V4L2_TC_FLAG_COLORFRAME 0x0002
748#define V4L2_TC_USERBITS_field 0x000C
749#define V4L2_TC_USERBITS_USERDEFINED 0x0000
750#define V4L2_TC_USERBITS_8BITCHARS 0x0008
751/* The above is based on SMPTE timecodes */
752
753struct v4l2_jpegcompression {
754 int quality;
755
756 int APPn; /* Number of APP segment to be written,
757 * must be 0..15 */
758 int APP_len; /* Length of data in JPEG APPn segment */
759 char APP_data[60]; /* Data in the JPEG APPn segment. */
760
761 int COM_len; /* Length of data in JPEG COM segment */
762 char COM_data[60]; /* Data in JPEG COM segment */
763
764 __u32 jpeg_markers; /* Which markers should go into the JPEG
765 * output. Unless you exactly know what
766 * you do, leave them untouched.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300767 * Including less markers will make the
David Howells607ca462012-10-13 10:46:48 +0100768 * resulting code smaller, but there will
769 * be fewer applications which can read it.
770 * The presence of the APP and COM marker
771 * is influenced by APP_len and COM_len
772 * ONLY, not by this property! */
773
774#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
775#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
776#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
777#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
778#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300779 * always use APP0 */
David Howells607ca462012-10-13 10:46:48 +0100780};
781
782/*
783 * M E M O R Y - M A P P I N G B U F F E R S
784 */
785struct v4l2_requestbuffers {
786 __u32 count;
787 __u32 type; /* enum v4l2_buf_type */
788 __u32 memory; /* enum v4l2_memory */
789 __u32 reserved[2];
790};
791
792/**
793 * struct v4l2_plane - plane info for multi-planar buffers
794 * @bytesused: number of bytes occupied by data in the plane (payload)
795 * @length: size of this plane (NOT the payload) in bytes
796 * @mem_offset: when memory in the associated struct v4l2_buffer is
797 * V4L2_MEMORY_MMAP, equals the offset from the start of
798 * the device memory for this plane (or is a "cookie" that
799 * should be passed to mmap() called on the video node)
800 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
801 * pointing to this plane
Sumit Semwal051c7782012-06-14 10:37:35 -0300802 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
803 * descriptor associated with this plane
David Howells607ca462012-10-13 10:46:48 +0100804 * @data_offset: offset in the plane to the start of data; usually 0,
805 * unless there is a header in front of the data
806 *
807 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
808 * with two planes can have one plane for Y, and another for interleaved CbCr
809 * components. Each plane can reside in a separate memory buffer, or even in
810 * a completely separate memory node (e.g. in embedded devices).
811 */
812struct v4l2_plane {
813 __u32 bytesused;
814 __u32 length;
815 union {
816 __u32 mem_offset;
817 unsigned long userptr;
Sumit Semwal051c7782012-06-14 10:37:35 -0300818 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100819 } m;
820 __u32 data_offset;
821 __u32 reserved[11];
822};
823
824/**
825 * struct v4l2_buffer - video buffer info
826 * @index: id number of the buffer
827 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
828 * multiplanar buffers);
829 * @bytesused: number of bytes occupied by data in the buffer (payload);
830 * unused (set to 0) for multiplanar buffers
831 * @flags: buffer informational flags
832 * @field: enum v4l2_field; field order of the image in the buffer
833 * @timestamp: frame timestamp
834 * @timecode: frame timecode
835 * @sequence: sequence count of this frame
836 * @memory: enum v4l2_memory; the method, in which the actual video data is
837 * passed
838 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
839 * offset from the start of the device memory for this plane,
840 * (or a "cookie" that should be passed to mmap() as offset)
841 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
842 * a userspace pointer pointing to this buffer
Sumit Semwal051c7782012-06-14 10:37:35 -0300843 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
844 * a userspace file descriptor associated with this buffer
David Howells607ca462012-10-13 10:46:48 +0100845 * @planes: for multiplanar buffers; userspace pointer to the array of plane
846 * info structs for this buffer
847 * @length: size in bytes of the buffer (NOT its payload) for single-plane
848 * buffers (when type != *_MPLANE); number of elements in the
849 * planes array for multi-plane buffers
David Howells607ca462012-10-13 10:46:48 +0100850 *
851 * Contains data exchanged by application and driver using one of the Streaming
852 * I/O methods.
853 */
854struct v4l2_buffer {
855 __u32 index;
856 __u32 type;
857 __u32 bytesused;
858 __u32 flags;
859 __u32 field;
860 struct timeval timestamp;
861 struct v4l2_timecode timecode;
862 __u32 sequence;
863
864 /* memory location */
865 __u32 memory;
866 union {
867 __u32 offset;
868 unsigned long userptr;
869 struct v4l2_plane *planes;
Sumit Semwal051c7782012-06-14 10:37:35 -0300870 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100871 } m;
872 __u32 length;
873 __u32 reserved2;
874 __u32 reserved;
875};
876
877/* Flags for 'flags' field */
Sakari Ailus939f1372013-08-25 14:00:43 -0300878/* Buffer is mapped (flag) */
879#define V4L2_BUF_FLAG_MAPPED 0x00000001
880/* Buffer is queued for processing */
881#define V4L2_BUF_FLAG_QUEUED 0x00000002
882/* Buffer is ready */
883#define V4L2_BUF_FLAG_DONE 0x00000004
884/* Image is a keyframe (I-frame) */
885#define V4L2_BUF_FLAG_KEYFRAME 0x00000008
886/* Image is a P-frame */
887#define V4L2_BUF_FLAG_PFRAME 0x00000010
888/* Image is a B-frame */
889#define V4L2_BUF_FLAG_BFRAME 0x00000020
David Howells607ca462012-10-13 10:46:48 +0100890/* Buffer is ready, but the data contained within is corrupted. */
Sakari Ailus939f1372013-08-25 14:00:43 -0300891#define V4L2_BUF_FLAG_ERROR 0x00000040
892/* timecode field is valid */
893#define V4L2_BUF_FLAG_TIMECODE 0x00000100
894/* Buffer is prepared for queuing */
895#define V4L2_BUF_FLAG_PREPARED 0x00000400
David Howells607ca462012-10-13 10:46:48 +0100896/* Cache handling flags */
Sakari Ailus939f1372013-08-25 14:00:43 -0300897#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
898#define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
Sakari Ailus1202ecd2012-10-21 16:02:47 -0300899/* Timestamp type */
Sakari Ailus939f1372013-08-25 14:00:43 -0300900#define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
901#define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
902#define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
903#define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
Sakari Ailus872484c2013-08-25 17:57:03 -0300904/* Timestamp sources. */
905#define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
906#define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
907#define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
Peter Seidererdc199242015-05-04 07:51:05 -0300908/* mem2mem encoder/decoder */
909#define V4L2_BUF_FLAG_LAST 0x00100000
David Howells607ca462012-10-13 10:46:48 +0100910
Tomasz Stanislawskib799d09a2012-06-14 11:32:23 -0300911/**
912 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
913 *
914 * @index: id number of the buffer
915 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
916 * multiplanar buffers);
917 * @plane: index of the plane to be exported, 0 for single plane queues
918 * @flags: flags for newly created file, currently only O_CLOEXEC is
919 * supported, refer to manual of open syscall for more details
920 * @fd: file descriptor associated with DMABUF (set by driver)
921 *
922 * Contains data used for exporting a video buffer as DMABUF file descriptor.
923 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
924 * (identical to the cookie used to mmap() the buffer to userspace). All
925 * reserved fields must be set to zero. The field reserved0 is expected to
926 * become a structure 'type' allowing an alternative layout of the structure
927 * content. Therefore this field should not be used for any other extensions.
928 */
929struct v4l2_exportbuffer {
930 __u32 type; /* enum v4l2_buf_type */
931 __u32 index;
932 __u32 plane;
933 __u32 flags;
934 __s32 fd;
935 __u32 reserved[11];
936};
937
David Howells607ca462012-10-13 10:46:48 +0100938/*
939 * O V E R L A Y P R E V I E W
940 */
941struct v4l2_framebuffer {
942 __u32 capability;
943 __u32 flags;
944/* FIXME: in theory we should pass something like PCI device + memory
945 * region + offset instead of some physical address */
946 void *base;
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300947 struct {
948 __u32 width;
949 __u32 height;
950 __u32 pixelformat;
951 __u32 field; /* enum v4l2_field */
952 __u32 bytesperline; /* for padding, zero if unused */
953 __u32 sizeimage;
954 __u32 colorspace; /* enum v4l2_colorspace */
955 __u32 priv; /* reserved field, set to 0 */
956 } fmt;
David Howells607ca462012-10-13 10:46:48 +0100957};
958/* Flags for the 'capability' field. Read only */
959#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
960#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
961#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
962#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
963#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
964#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
965#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
966#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
967/* Flags for the 'flags' field. */
968#define V4L2_FBUF_FLAG_PRIMARY 0x0001
969#define V4L2_FBUF_FLAG_OVERLAY 0x0002
970#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
971#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
972#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
973#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
974#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
975
976struct v4l2_clip {
977 struct v4l2_rect c;
978 struct v4l2_clip __user *next;
979};
980
981struct v4l2_window {
982 struct v4l2_rect w;
983 __u32 field; /* enum v4l2_field */
984 __u32 chromakey;
985 struct v4l2_clip __user *clips;
986 __u32 clipcount;
987 void __user *bitmap;
988 __u8 global_alpha;
989};
990
991/*
992 * C A P T U R E P A R A M E T E R S
993 */
994struct v4l2_captureparm {
995 __u32 capability; /* Supported modes */
996 __u32 capturemode; /* Current mode */
Kirill Smelkov2e745982012-10-22 14:14:01 -0300997 struct v4l2_fract timeperframe; /* Time per frame in seconds */
David Howells607ca462012-10-13 10:46:48 +0100998 __u32 extendedmode; /* Driver-specific extensions */
999 __u32 readbuffers; /* # of buffers for read */
1000 __u32 reserved[4];
1001};
1002
1003/* Flags for 'capability' and 'capturemode' fields */
1004#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1005#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1006
1007struct v4l2_outputparm {
1008 __u32 capability; /* Supported modes */
1009 __u32 outputmode; /* Current mode */
1010 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1011 __u32 extendedmode; /* Driver-specific extensions */
1012 __u32 writebuffers; /* # of buffers for write */
1013 __u32 reserved[4];
1014};
1015
1016/*
1017 * I N P U T I M A G E C R O P P I N G
1018 */
1019struct v4l2_cropcap {
1020 __u32 type; /* enum v4l2_buf_type */
1021 struct v4l2_rect bounds;
1022 struct v4l2_rect defrect;
1023 struct v4l2_fract pixelaspect;
1024};
1025
1026struct v4l2_crop {
1027 __u32 type; /* enum v4l2_buf_type */
1028 struct v4l2_rect c;
1029};
1030
1031/**
1032 * struct v4l2_selection - selection info
1033 * @type: buffer type (do not use *_MPLANE types)
1034 * @target: Selection target, used to choose one of possible rectangles;
1035 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1036 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1037 * @r: coordinates of selection window
1038 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1039 *
1040 * Hardware may use multiple helper windows to process a video stream.
1041 * The structure is used to exchange this selection areas between
1042 * an application and a driver.
1043 */
1044struct v4l2_selection {
1045 __u32 type;
1046 __u32 target;
1047 __u32 flags;
1048 struct v4l2_rect r;
1049 __u32 reserved[9];
1050};
1051
1052
1053/*
1054 * A N A L O G V I D E O S T A N D A R D
1055 */
1056
1057typedef __u64 v4l2_std_id;
1058
1059/* one bit for each */
1060#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1061#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1062#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1063#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1064#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1065#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1066#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1067#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1068
1069#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1070#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1071#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1072#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1073
1074#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1075#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1076#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1077#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1078
1079#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1080#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1081#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1082#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1083#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1084#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1085#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1086#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1087
1088/* ATSC/HDTV */
1089#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1090#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1091
1092/* FIXME:
1093 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1094 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1095 this value to 32 bits.
1096 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1097 it should work fine. However, if needed to add more than two standards,
1098 v4l2-common.c should be fixed.
1099 */
1100
1101/*
1102 * Some macros to merge video standards in order to make live easier for the
1103 * drivers and V4L2 applications
1104 */
1105
1106/*
1107 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1108 * Missing here.
1109 */
1110#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1111 V4L2_STD_NTSC_M_JP |\
1112 V4L2_STD_NTSC_M_KR)
1113/* Secam macros */
1114#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1115 V4L2_STD_SECAM_K |\
1116 V4L2_STD_SECAM_K1)
1117/* All Secam Standards */
1118#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1119 V4L2_STD_SECAM_G |\
1120 V4L2_STD_SECAM_H |\
1121 V4L2_STD_SECAM_DK |\
1122 V4L2_STD_SECAM_L |\
1123 V4L2_STD_SECAM_LC)
1124/* PAL macros */
1125#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1126 V4L2_STD_PAL_B1 |\
1127 V4L2_STD_PAL_G)
1128#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1129 V4L2_STD_PAL_D1 |\
1130 V4L2_STD_PAL_K)
1131/*
1132 * "Common" PAL - This macro is there to be compatible with the old
1133 * V4L1 concept of "PAL": /BGDKHI.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03001134 * Several PAL standards are missing here: /M, /N and /Nc
David Howells607ca462012-10-13 10:46:48 +01001135 */
1136#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1137 V4L2_STD_PAL_DK |\
1138 V4L2_STD_PAL_H |\
1139 V4L2_STD_PAL_I)
1140/* Chroma "agnostic" standards */
1141#define V4L2_STD_B (V4L2_STD_PAL_B |\
1142 V4L2_STD_PAL_B1 |\
1143 V4L2_STD_SECAM_B)
1144#define V4L2_STD_G (V4L2_STD_PAL_G |\
1145 V4L2_STD_SECAM_G)
1146#define V4L2_STD_H (V4L2_STD_PAL_H |\
1147 V4L2_STD_SECAM_H)
1148#define V4L2_STD_L (V4L2_STD_SECAM_L |\
1149 V4L2_STD_SECAM_LC)
1150#define V4L2_STD_GH (V4L2_STD_G |\
1151 V4L2_STD_H)
1152#define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1153 V4L2_STD_SECAM_DK)
1154#define V4L2_STD_BG (V4L2_STD_B |\
1155 V4L2_STD_G)
1156#define V4L2_STD_MN (V4L2_STD_PAL_M |\
1157 V4L2_STD_PAL_N |\
1158 V4L2_STD_PAL_Nc |\
1159 V4L2_STD_NTSC)
1160
1161/* Standards where MTS/BTSC stereo could be found */
1162#define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1163 V4L2_STD_PAL_M |\
1164 V4L2_STD_PAL_N |\
1165 V4L2_STD_PAL_Nc)
1166
1167/* Standards for Countries with 60Hz Line frequency */
1168#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1169 V4L2_STD_PAL_60 |\
1170 V4L2_STD_NTSC |\
1171 V4L2_STD_NTSC_443)
1172/* Standards for Countries with 50Hz Line frequency */
1173#define V4L2_STD_625_50 (V4L2_STD_PAL |\
1174 V4L2_STD_PAL_N |\
1175 V4L2_STD_PAL_Nc |\
1176 V4L2_STD_SECAM)
1177
1178#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1179 V4L2_STD_ATSC_16_VSB)
1180/* Macros with none and all analog standards */
1181#define V4L2_STD_UNKNOWN 0
1182#define V4L2_STD_ALL (V4L2_STD_525_60 |\
1183 V4L2_STD_625_50)
1184
1185struct v4l2_standard {
1186 __u32 index;
1187 v4l2_std_id id;
1188 __u8 name[24];
1189 struct v4l2_fract frameperiod; /* Frames, not fields */
1190 __u32 framelines;
1191 __u32 reserved[4];
1192};
1193
David Howells607ca462012-10-13 10:46:48 +01001194/*
1195 * D V B T T I M I N G S
1196 */
1197
1198/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1199 * @width: total width of the active video in pixels
1200 * @height: total height of the active video in lines
1201 * @interlaced: Interlaced or progressive
1202 * @polarities: Positive or negative polarities
1203 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1204 * @hfrontporch:Horizontal front porch in pixels
1205 * @hsync: Horizontal Sync length in pixels
1206 * @hbackporch: Horizontal back porch in pixels
1207 * @vfrontporch:Vertical front porch in lines
1208 * @vsync: Vertical Sync length in lines
1209 * @vbackporch: Vertical back porch in lines
1210 * @il_vfrontporch:Vertical front porch for the even field
1211 * (aka field 2) of interlaced field formats
1212 * @il_vsync: Vertical Sync length for the even field
1213 * (aka field 2) of interlaced field formats
1214 * @il_vbackporch:Vertical back porch for the even field
1215 * (aka field 2) of interlaced field formats
1216 * @standards: Standards the timing belongs to
1217 * @flags: Flags
1218 * @reserved: Reserved fields, must be zeroed.
1219 *
1220 * A note regarding vertical interlaced timings: height refers to the total
1221 * height of the active video frame (= two fields). The blanking timings refer
1222 * to the blanking of each field. So the height of the total frame is
1223 * calculated as follows:
1224 *
1225 * tot_height = height + vfrontporch + vsync + vbackporch +
1226 * il_vfrontporch + il_vsync + il_vbackporch
1227 *
1228 * The active height of each field is height / 2.
1229 */
1230struct v4l2_bt_timings {
1231 __u32 width;
1232 __u32 height;
1233 __u32 interlaced;
1234 __u32 polarities;
1235 __u64 pixelclock;
1236 __u32 hfrontporch;
1237 __u32 hsync;
1238 __u32 hbackporch;
1239 __u32 vfrontporch;
1240 __u32 vsync;
1241 __u32 vbackporch;
1242 __u32 il_vfrontporch;
1243 __u32 il_vsync;
1244 __u32 il_vbackporch;
1245 __u32 standards;
1246 __u32 flags;
1247 __u32 reserved[14];
1248} __attribute__ ((packed));
1249
1250/* Interlaced or progressive format */
1251#define V4L2_DV_PROGRESSIVE 0
1252#define V4L2_DV_INTERLACED 1
1253
1254/* Polarities. If bit is not set, it is assumed to be negative polarity */
1255#define V4L2_DV_VSYNC_POS_POL 0x00000001
1256#define V4L2_DV_HSYNC_POS_POL 0x00000002
1257
1258/* Timings standards */
1259#define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1260#define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1261#define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1262#define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1263
1264/* Flags */
1265
1266/* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1267 GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1268 intervals are reduced, allowing a higher resolution over the same
1269 bandwidth. This is a read-only flag. */
1270#define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1271/* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1272 of six. These formats can be optionally played at 1 / 1.001 speed.
1273 This is a read-only flag. */
1274#define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1275/* CEA-861 specific: only valid for video transmitters, the flag is cleared
1276 by receivers.
1277 If the framerate of the format is a multiple of six, then the pixelclock
1278 used to set up the transmitter is divided by 1.001 to make it compatible
1279 with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1280 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1281 such frequencies, then the flag will also be cleared. */
1282#define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1283/* Specific to interlaced formats: if set, then field 1 is really one half-line
1284 longer and field 2 is really one half-line shorter, so each field has
1285 exactly the same number of half-lines. Whether half-lines can be detected
1286 or used depends on the hardware. */
Hans Verkuil292a8782013-03-20 15:26:36 -03001287#define V4L2_DV_FL_HALF_LINE (1 << 3)
Hans Verkuil5ce65d12015-03-20 14:05:03 -03001288/* If set, then this is a Consumer Electronics (CE) video format. Such formats
1289 * differ from other formats (commonly called IT formats) in that if RGB
1290 * encoding is used then by default the RGB values use limited range (i.e.
1291 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1292 * except for the 640x480 format are CE formats. */
1293#define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
David Howells607ca462012-10-13 10:46:48 +01001294
Hans Verkuil7f681272013-07-29 08:40:58 -03001295/* A few useful defines to calculate the total blanking and frame sizes */
1296#define V4L2_DV_BT_BLANKING_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001297 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001298#define V4L2_DV_BT_FRAME_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001299 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
Hans Verkuil7f681272013-07-29 08:40:58 -03001300#define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001301 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1302 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001303#define V4L2_DV_BT_FRAME_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001304 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
David Howells607ca462012-10-13 10:46:48 +01001305
1306/** struct v4l2_dv_timings - DV timings
1307 * @type: the type of the timings
1308 * @bt: BT656/1120 timings
1309 */
1310struct v4l2_dv_timings {
1311 __u32 type;
1312 union {
1313 struct v4l2_bt_timings bt;
1314 __u32 reserved[32];
1315 };
1316} __attribute__ ((packed));
1317
1318/* Values for the type field */
1319#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1320
1321
1322/** struct v4l2_enum_dv_timings - DV timings enumeration
1323 * @index: enumeration index
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001324 * @pad: the pad number for which to enumerate timings (used with
1325 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001326 * @reserved: must be zeroed
1327 * @timings: the timings for the given index
1328 */
1329struct v4l2_enum_dv_timings {
1330 __u32 index;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001331 __u32 pad;
1332 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001333 struct v4l2_dv_timings timings;
1334};
1335
1336/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1337 * @min_width: width in pixels
1338 * @max_width: width in pixels
1339 * @min_height: height in lines
1340 * @max_height: height in lines
1341 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1342 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1343 * @standards: Supported standards
1344 * @capabilities: Supported capabilities
1345 * @reserved: Must be zeroed
1346 */
1347struct v4l2_bt_timings_cap {
1348 __u32 min_width;
1349 __u32 max_width;
1350 __u32 min_height;
1351 __u32 max_height;
1352 __u64 min_pixelclock;
1353 __u64 max_pixelclock;
1354 __u32 standards;
1355 __u32 capabilities;
1356 __u32 reserved[16];
1357} __attribute__ ((packed));
1358
1359/* Supports interlaced formats */
1360#define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1361/* Supports progressive formats */
1362#define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1363/* Supports CVT/GTF reduced blanking */
1364#define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1365/* Supports custom formats */
1366#define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1367
1368/** struct v4l2_dv_timings_cap - DV timings capabilities
1369 * @type: the type of the timings (same as in struct v4l2_dv_timings)
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001370 * @pad: the pad number for which to query capabilities (used with
1371 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001372 * @bt: the BT656/1120 timings capabilities
1373 */
1374struct v4l2_dv_timings_cap {
1375 __u32 type;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001376 __u32 pad;
1377 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001378 union {
1379 struct v4l2_bt_timings_cap bt;
1380 __u32 raw_data[32];
1381 };
1382};
1383
1384
1385/*
1386 * V I D E O I N P U T S
1387 */
1388struct v4l2_input {
1389 __u32 index; /* Which input */
1390 __u8 name[32]; /* Label */
1391 __u32 type; /* Type of input */
1392 __u32 audioset; /* Associated audios (bitfield) */
1393 __u32 tuner; /* enum v4l2_tuner_type */
1394 v4l2_std_id std;
1395 __u32 status;
1396 __u32 capabilities;
1397 __u32 reserved[3];
1398};
1399
1400/* Values for the 'type' field */
1401#define V4L2_INPUT_TYPE_TUNER 1
1402#define V4L2_INPUT_TYPE_CAMERA 2
1403
1404/* field 'status' - general */
1405#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1406#define V4L2_IN_ST_NO_SIGNAL 0x00000002
1407#define V4L2_IN_ST_NO_COLOR 0x00000004
1408
1409/* field 'status' - sensor orientation */
1410/* If sensor is mounted upside down set both bits */
1411#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1412#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1413
1414/* field 'status' - analog */
1415#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1416#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1417
1418/* field 'status' - digital */
1419#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1420#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1421#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1422
1423/* field 'status' - VCR and set-top box */
1424#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1425#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1426#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1427
1428/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001429#define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1430#define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1431#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
Sakari Ailus8af03452014-11-18 02:27:00 -03001432#define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
David Howells607ca462012-10-13 10:46:48 +01001433
1434/*
1435 * V I D E O O U T P U T S
1436 */
1437struct v4l2_output {
1438 __u32 index; /* Which output */
1439 __u8 name[32]; /* Label */
1440 __u32 type; /* Type of output */
1441 __u32 audioset; /* Associated audios (bitfield) */
1442 __u32 modulator; /* Associated modulator */
1443 v4l2_std_id std;
1444 __u32 capabilities;
1445 __u32 reserved[3];
1446};
1447/* Values for the 'type' field */
1448#define V4L2_OUTPUT_TYPE_MODULATOR 1
1449#define V4L2_OUTPUT_TYPE_ANALOG 2
1450#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1451
1452/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001453#define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1454#define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1455#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
Sakari Ailus8af03452014-11-18 02:27:00 -03001456#define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
David Howells607ca462012-10-13 10:46:48 +01001457
1458/*
1459 * C O N T R O L S
1460 */
1461struct v4l2_control {
1462 __u32 id;
1463 __s32 value;
1464};
1465
1466struct v4l2_ext_control {
1467 __u32 id;
1468 __u32 size;
1469 __u32 reserved2[1];
1470 union {
1471 __s32 value;
1472 __s64 value64;
Hans Verkuileadf9e22014-08-21 16:49:16 -03001473 char __user *string;
1474 __u8 __user *p_u8;
1475 __u16 __user *p_u16;
1476 __u32 __user *p_u32;
1477 void __user *ptr;
David Howells607ca462012-10-13 10:46:48 +01001478 };
1479} __attribute__ ((packed));
1480
1481struct v4l2_ext_controls {
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001482 union {
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001483#ifndef __KERNEL__
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001484 __u32 ctrl_class;
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001485#endif
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001486 __u32 which;
1487 };
David Howells607ca462012-10-13 10:46:48 +01001488 __u32 count;
1489 __u32 error_idx;
1490 __u32 reserved[2];
1491 struct v4l2_ext_control *controls;
1492};
1493
1494#define V4L2_CTRL_ID_MASK (0x0fffffff)
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001495#ifndef __KERNEL__
David Howells607ca462012-10-13 10:46:48 +01001496#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
Ricardo Ribalda0f8017b2015-10-29 08:10:28 -02001497#endif
1498#define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
David Howells607ca462012-10-13 10:46:48 +01001499#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
Hans Verkuil5082c242014-06-10 04:14:50 -03001500#define V4L2_CTRL_MAX_DIMS (4)
Ricardo Ribalda35ec2a22015-10-29 08:10:27 -02001501#define V4L2_CTRL_WHICH_CUR_VAL 0
1502#define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
David Howells607ca462012-10-13 10:46:48 +01001503
1504enum v4l2_ctrl_type {
1505 V4L2_CTRL_TYPE_INTEGER = 1,
1506 V4L2_CTRL_TYPE_BOOLEAN = 2,
1507 V4L2_CTRL_TYPE_MENU = 3,
1508 V4L2_CTRL_TYPE_BUTTON = 4,
1509 V4L2_CTRL_TYPE_INTEGER64 = 5,
1510 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1511 V4L2_CTRL_TYPE_STRING = 7,
1512 V4L2_CTRL_TYPE_BITMASK = 8,
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001513 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1514
1515 /* Compound types are >= 0x0100 */
1516 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
Hans Verkuildda4a4d2014-06-10 07:30:04 -03001517 V4L2_CTRL_TYPE_U8 = 0x0100,
1518 V4L2_CTRL_TYPE_U16 = 0x0101,
Hans Verkuil811c5082014-07-21 10:45:37 -03001519 V4L2_CTRL_TYPE_U32 = 0x0102,
David Howells607ca462012-10-13 10:46:48 +01001520};
1521
1522/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1523struct v4l2_queryctrl {
1524 __u32 id;
1525 __u32 type; /* enum v4l2_ctrl_type */
1526 __u8 name[32]; /* Whatever */
1527 __s32 minimum; /* Note signedness */
1528 __s32 maximum;
1529 __s32 step;
1530 __s32 default_value;
1531 __u32 flags;
1532 __u32 reserved[2];
1533};
1534
Hans Verkuil5082c242014-06-10 04:14:50 -03001535/* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1536struct v4l2_query_ext_ctrl {
1537 __u32 id;
1538 __u32 type;
1539 char name[32];
1540 __s64 minimum;
1541 __s64 maximum;
1542 __u64 step;
1543 __s64 default_value;
1544 __u32 flags;
1545 __u32 elem_size;
1546 __u32 elems;
1547 __u32 nr_of_dims;
1548 __u32 dims[V4L2_CTRL_MAX_DIMS];
1549 __u32 reserved[32];
1550};
1551
David Howells607ca462012-10-13 10:46:48 +01001552/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1553struct v4l2_querymenu {
1554 __u32 id;
1555 __u32 index;
1556 union {
1557 __u8 name[32]; /* Whatever */
1558 __s64 value;
1559 };
1560 __u32 reserved;
1561} __attribute__ ((packed));
1562
1563/* Control flags */
1564#define V4L2_CTRL_FLAG_DISABLED 0x0001
1565#define V4L2_CTRL_FLAG_GRABBED 0x0002
1566#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1567#define V4L2_CTRL_FLAG_UPDATE 0x0008
1568#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1569#define V4L2_CTRL_FLAG_SLIDER 0x0020
1570#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1571#define V4L2_CTRL_FLAG_VOLATILE 0x0080
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001572#define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
Ricardo Ribaldab6e5b8f2015-03-20 10:45:43 -03001573#define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
David Howells607ca462012-10-13 10:46:48 +01001574
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001575/* Query flags, to be ORed with the control ID */
David Howells607ca462012-10-13 10:46:48 +01001576#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001577#define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
David Howells607ca462012-10-13 10:46:48 +01001578
1579/* User-class control IDs defined by V4L2 */
1580#define V4L2_CID_MAX_CTRLS 1024
1581/* IDs reserved for driver specific controls */
1582#define V4L2_CID_PRIVATE_BASE 0x08000000
1583
1584
David Howells607ca462012-10-13 10:46:48 +01001585/*
1586 * T U N I N G
1587 */
1588struct v4l2_tuner {
1589 __u32 index;
1590 __u8 name[32];
1591 __u32 type; /* enum v4l2_tuner_type */
1592 __u32 capability;
1593 __u32 rangelow;
1594 __u32 rangehigh;
1595 __u32 rxsubchans;
1596 __u32 audmode;
1597 __s32 signal;
1598 __s32 afc;
1599 __u32 reserved[4];
1600};
1601
1602struct v4l2_modulator {
1603 __u32 index;
1604 __u8 name[32];
1605 __u32 capability;
1606 __u32 rangelow;
1607 __u32 rangehigh;
1608 __u32 txsubchans;
Antti Palosaari4124a3c2015-10-10 13:51:02 -03001609 __u32 type; /* enum v4l2_tuner_type */
1610 __u32 reserved[3];
David Howells607ca462012-10-13 10:46:48 +01001611};
1612
1613/* Flags for the 'capability' field */
1614#define V4L2_TUNER_CAP_LOW 0x0001
1615#define V4L2_TUNER_CAP_NORM 0x0002
1616#define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1617#define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1618#define V4L2_TUNER_CAP_STEREO 0x0010
1619#define V4L2_TUNER_CAP_LANG2 0x0020
1620#define V4L2_TUNER_CAP_SAP 0x0020
1621#define V4L2_TUNER_CAP_LANG1 0x0040
1622#define V4L2_TUNER_CAP_RDS 0x0080
1623#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1624#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1625#define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1626#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
Antti Palosaari67f9a112013-12-11 20:27:31 -03001627#define V4L2_TUNER_CAP_1HZ 0x1000
David Howells607ca462012-10-13 10:46:48 +01001628
1629/* Flags for the 'rxsubchans' field */
1630#define V4L2_TUNER_SUB_MONO 0x0001
1631#define V4L2_TUNER_SUB_STEREO 0x0002
1632#define V4L2_TUNER_SUB_LANG2 0x0004
1633#define V4L2_TUNER_SUB_SAP 0x0004
1634#define V4L2_TUNER_SUB_LANG1 0x0008
1635#define V4L2_TUNER_SUB_RDS 0x0010
1636
1637/* Values for the 'audmode' field */
1638#define V4L2_TUNER_MODE_MONO 0x0000
1639#define V4L2_TUNER_MODE_STEREO 0x0001
1640#define V4L2_TUNER_MODE_LANG2 0x0002
1641#define V4L2_TUNER_MODE_SAP 0x0002
1642#define V4L2_TUNER_MODE_LANG1 0x0003
1643#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1644
1645struct v4l2_frequency {
1646 __u32 tuner;
1647 __u32 type; /* enum v4l2_tuner_type */
1648 __u32 frequency;
1649 __u32 reserved[8];
1650};
1651
1652#define V4L2_BAND_MODULATION_VSB (1 << 1)
1653#define V4L2_BAND_MODULATION_FM (1 << 2)
1654#define V4L2_BAND_MODULATION_AM (1 << 3)
1655
1656struct v4l2_frequency_band {
1657 __u32 tuner;
1658 __u32 type; /* enum v4l2_tuner_type */
1659 __u32 index;
1660 __u32 capability;
1661 __u32 rangelow;
1662 __u32 rangehigh;
1663 __u32 modulation;
1664 __u32 reserved[9];
1665};
1666
1667struct v4l2_hw_freq_seek {
1668 __u32 tuner;
1669 __u32 type; /* enum v4l2_tuner_type */
1670 __u32 seek_upward;
1671 __u32 wrap_around;
1672 __u32 spacing;
1673 __u32 rangelow;
1674 __u32 rangehigh;
1675 __u32 reserved[5];
1676};
1677
1678/*
1679 * R D S
1680 */
1681
1682struct v4l2_rds_data {
1683 __u8 lsb;
1684 __u8 msb;
1685 __u8 block;
1686} __attribute__ ((packed));
1687
1688#define V4L2_RDS_BLOCK_MSK 0x7
1689#define V4L2_RDS_BLOCK_A 0
1690#define V4L2_RDS_BLOCK_B 1
1691#define V4L2_RDS_BLOCK_C 2
1692#define V4L2_RDS_BLOCK_D 3
1693#define V4L2_RDS_BLOCK_C_ALT 4
1694#define V4L2_RDS_BLOCK_INVALID 7
1695
1696#define V4L2_RDS_BLOCK_CORRECTED 0x40
1697#define V4L2_RDS_BLOCK_ERROR 0x80
1698
1699/*
1700 * A U D I O
1701 */
1702struct v4l2_audio {
1703 __u32 index;
1704 __u8 name[32];
1705 __u32 capability;
1706 __u32 mode;
1707 __u32 reserved[2];
1708};
1709
1710/* Flags for the 'capability' field */
1711#define V4L2_AUDCAP_STEREO 0x00001
1712#define V4L2_AUDCAP_AVL 0x00002
1713
1714/* Flags for the 'mode' field */
1715#define V4L2_AUDMODE_AVL 0x00001
1716
1717struct v4l2_audioout {
1718 __u32 index;
1719 __u8 name[32];
1720 __u32 capability;
1721 __u32 mode;
1722 __u32 reserved[2];
1723};
1724
1725/*
1726 * M P E G S E R V I C E S
1727 *
1728 * NOTE: EXPERIMENTAL API
1729 */
1730#if 1
1731#define V4L2_ENC_IDX_FRAME_I (0)
1732#define V4L2_ENC_IDX_FRAME_P (1)
1733#define V4L2_ENC_IDX_FRAME_B (2)
1734#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1735
1736struct v4l2_enc_idx_entry {
1737 __u64 offset;
1738 __u64 pts;
1739 __u32 length;
1740 __u32 flags;
1741 __u32 reserved[2];
1742};
1743
1744#define V4L2_ENC_IDX_ENTRIES (64)
1745struct v4l2_enc_idx {
1746 __u32 entries;
1747 __u32 entries_cap;
1748 __u32 reserved[4];
1749 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1750};
1751
1752
1753#define V4L2_ENC_CMD_START (0)
1754#define V4L2_ENC_CMD_STOP (1)
1755#define V4L2_ENC_CMD_PAUSE (2)
1756#define V4L2_ENC_CMD_RESUME (3)
1757
1758/* Flags for V4L2_ENC_CMD_STOP */
1759#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1760
1761struct v4l2_encoder_cmd {
1762 __u32 cmd;
1763 __u32 flags;
1764 union {
1765 struct {
1766 __u32 data[8];
1767 } raw;
1768 };
1769};
1770
1771/* Decoder commands */
1772#define V4L2_DEC_CMD_START (0)
1773#define V4L2_DEC_CMD_STOP (1)
1774#define V4L2_DEC_CMD_PAUSE (2)
1775#define V4L2_DEC_CMD_RESUME (3)
1776
1777/* Flags for V4L2_DEC_CMD_START */
1778#define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1779
1780/* Flags for V4L2_DEC_CMD_PAUSE */
1781#define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1782
1783/* Flags for V4L2_DEC_CMD_STOP */
1784#define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1785#define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1786
1787/* Play format requirements (returned by the driver): */
1788
1789/* The decoder has no special format requirements */
1790#define V4L2_DEC_START_FMT_NONE (0)
1791/* The decoder requires full GOPs */
1792#define V4L2_DEC_START_FMT_GOP (1)
1793
1794/* The structure must be zeroed before use by the application
1795 This ensures it can be extended safely in the future. */
1796struct v4l2_decoder_cmd {
1797 __u32 cmd;
1798 __u32 flags;
1799 union {
1800 struct {
1801 __u64 pts;
1802 } stop;
1803
1804 struct {
1805 /* 0 or 1000 specifies normal speed,
1806 1 specifies forward single stepping,
1807 -1 specifies backward single stepping,
1808 >1: playback at speed/1000 of the normal speed,
1809 <-1: reverse playback at (-speed/1000) of the normal speed. */
1810 __s32 speed;
1811 __u32 format;
1812 } start;
1813
1814 struct {
1815 __u32 data[16];
1816 } raw;
1817 };
1818};
1819#endif
1820
1821
1822/*
1823 * D A T A S E R V I C E S ( V B I )
1824 *
1825 * Data services API by Michael Schimek
1826 */
1827
1828/* Raw VBI */
1829struct v4l2_vbi_format {
1830 __u32 sampling_rate; /* in 1 Hz */
1831 __u32 offset;
1832 __u32 samples_per_line;
1833 __u32 sample_format; /* V4L2_PIX_FMT_* */
1834 __s32 start[2];
1835 __u32 count[2];
1836 __u32 flags; /* V4L2_VBI_* */
1837 __u32 reserved[2]; /* must be zero */
1838};
1839
1840/* VBI flags */
1841#define V4L2_VBI_UNSYNC (1 << 0)
1842#define V4L2_VBI_INTERLACED (1 << 1)
1843
Hans Verkuil273886b2014-07-18 02:58:41 -03001844/* ITU-R start lines for each field */
1845#define V4L2_VBI_ITU_525_F1_START (1)
1846#define V4L2_VBI_ITU_525_F2_START (264)
1847#define V4L2_VBI_ITU_625_F1_START (1)
1848#define V4L2_VBI_ITU_625_F2_START (314)
1849
David Howells607ca462012-10-13 10:46:48 +01001850/* Sliced VBI
1851 *
1852 * This implements is a proposal V4L2 API to allow SLICED VBI
1853 * required for some hardware encoders. It should change without
1854 * notice in the definitive implementation.
1855 */
1856
1857struct v4l2_sliced_vbi_format {
1858 __u16 service_set;
1859 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1860 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1861 (equals frame lines 313-336 for 625 line video
1862 standards, 263-286 for 525 line standards) */
1863 __u16 service_lines[2][24];
1864 __u32 io_size;
1865 __u32 reserved[2]; /* must be zero */
1866};
1867
1868/* Teletext World System Teletext
1869 (WST), defined on ITU-R BT.653-2 */
1870#define V4L2_SLICED_TELETEXT_B (0x0001)
1871/* Video Program System, defined on ETS 300 231*/
1872#define V4L2_SLICED_VPS (0x0400)
1873/* Closed Caption, defined on EIA-608 */
1874#define V4L2_SLICED_CAPTION_525 (0x1000)
1875/* Wide Screen System, defined on ITU-R BT1119.1 */
1876#define V4L2_SLICED_WSS_625 (0x4000)
1877
1878#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1879#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1880
1881struct v4l2_sliced_vbi_cap {
1882 __u16 service_set;
1883 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1884 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1885 (equals frame lines 313-336 for 625 line video
1886 standards, 263-286 for 525 line standards) */
1887 __u16 service_lines[2][24];
1888 __u32 type; /* enum v4l2_buf_type */
1889 __u32 reserved[3]; /* must be 0 */
1890};
1891
1892struct v4l2_sliced_vbi_data {
1893 __u32 id;
1894 __u32 field; /* 0: first field, 1: second field */
1895 __u32 line; /* 1-23 */
1896 __u32 reserved; /* must be 0 */
1897 __u8 data[48];
1898};
1899
1900/*
1901 * Sliced VBI data inserted into MPEG Streams
1902 */
1903
1904/*
1905 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1906 *
1907 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1908 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1909 * data
1910 *
1911 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1912 * definitions are not included here. See the MPEG-2 specifications for details
1913 * on these headers.
1914 */
1915
1916/* Line type IDs */
1917#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1918#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1919#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1920#define V4L2_MPEG_VBI_IVTV_VPS (7)
1921
1922struct v4l2_mpeg_vbi_itv0_line {
1923 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1924 __u8 data[42]; /* Sliced VBI data for the line */
1925} __attribute__ ((packed));
1926
1927struct v4l2_mpeg_vbi_itv0 {
1928 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1929 struct v4l2_mpeg_vbi_itv0_line line[35];
1930} __attribute__ ((packed));
1931
1932struct v4l2_mpeg_vbi_ITV0 {
1933 struct v4l2_mpeg_vbi_itv0_line line[36];
1934} __attribute__ ((packed));
1935
1936#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1937#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1938
1939struct v4l2_mpeg_vbi_fmt_ivtv {
1940 __u8 magic[4];
1941 union {
1942 struct v4l2_mpeg_vbi_itv0 itv0;
1943 struct v4l2_mpeg_vbi_ITV0 ITV0;
1944 };
1945} __attribute__ ((packed));
1946
1947/*
1948 * A G G R E G A T E S T R U C T U R E S
1949 */
1950
1951/**
1952 * struct v4l2_plane_pix_format - additional, per-plane format definition
1953 * @sizeimage: maximum size in bytes required for data, for which
1954 * this plane will be used
1955 * @bytesperline: distance in bytes between the leftmost pixels in two
1956 * adjacent lines
1957 */
1958struct v4l2_plane_pix_format {
1959 __u32 sizeimage;
Hans Verkuilcc7d2df2015-03-15 14:30:25 -03001960 __u32 bytesperline;
1961 __u16 reserved[6];
David Howells607ca462012-10-13 10:46:48 +01001962} __attribute__ ((packed));
1963
1964/**
1965 * struct v4l2_pix_format_mplane - multiplanar format definition
1966 * @width: image width in pixels
1967 * @height: image height in pixels
1968 * @pixelformat: little endian four character code (fourcc)
1969 * @field: enum v4l2_field; field order (for interlaced video)
1970 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
1971 * @plane_fmt: per-plane information
1972 * @num_planes: number of planes for this format
Laurent Pinchartc96fd462014-05-27 10:12:43 -03001973 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
Hans Verkuild5735d62014-11-17 09:06:42 -03001974 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
1975 * @quantization: enum v4l2_quantization, colorspace quantization
Hans Verkuil74fdcb22015-04-28 08:49:09 -03001976 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
David Howells607ca462012-10-13 10:46:48 +01001977 */
1978struct v4l2_pix_format_mplane {
1979 __u32 width;
1980 __u32 height;
1981 __u32 pixelformat;
1982 __u32 field;
1983 __u32 colorspace;
1984
1985 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1986 __u8 num_planes;
Laurent Pinchartc96fd462014-05-27 10:12:43 -03001987 __u8 flags;
Hans Verkuild5735d62014-11-17 09:06:42 -03001988 __u8 ycbcr_enc;
1989 __u8 quantization;
Hans Verkuil74fdcb22015-04-28 08:49:09 -03001990 __u8 xfer_func;
1991 __u8 reserved[7];
David Howells607ca462012-10-13 10:46:48 +01001992} __attribute__ ((packed));
1993
1994/**
Antti Palosaari87185c92014-03-10 10:43:24 -03001995 * struct v4l2_sdr_format - SDR format definition
Antti Palosaari6f3073b2013-12-12 13:34:30 -03001996 * @pixelformat: little endian four character code (fourcc)
Antti Palosaariaaa968b2014-07-18 15:28:24 -03001997 * @buffersize: maximum size in bytes required for data
Antti Palosaari6f3073b2013-12-12 13:34:30 -03001998 */
Antti Palosaari87185c92014-03-10 10:43:24 -03001999struct v4l2_sdr_format {
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002000 __u32 pixelformat;
Antti Palosaariaaa968b2014-07-18 15:28:24 -03002001 __u32 buffersize;
2002 __u8 reserved[24];
Antti Palosaari6f3073b2013-12-12 13:34:30 -03002003} __attribute__ ((packed));
2004
2005/**
David Howells607ca462012-10-13 10:46:48 +01002006 * struct v4l2_format - stream data format
2007 * @type: enum v4l2_buf_type; type of the data stream
2008 * @pix: definition of an image format
2009 * @pix_mp: definition of a multiplanar image format
2010 * @win: definition of an overlaid image
2011 * @vbi: raw VBI capture or output parameters
2012 * @sliced: sliced VBI capture or output parameters
2013 * @raw_data: placeholder for future extensions and custom formats
2014 */
2015struct v4l2_format {
2016 __u32 type;
2017 union {
2018 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2019 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2020 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2021 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2022 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
Antti Palosaari87185c92014-03-10 10:43:24 -03002023 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
David Howells607ca462012-10-13 10:46:48 +01002024 __u8 raw_data[200]; /* user-defined */
2025 } fmt;
2026};
2027
2028/* Stream type-dependent parameters
2029 */
2030struct v4l2_streamparm {
2031 __u32 type; /* enum v4l2_buf_type */
2032 union {
2033 struct v4l2_captureparm capture;
2034 struct v4l2_outputparm output;
2035 __u8 raw_data[200]; /* user-defined */
2036 } parm;
2037};
2038
2039/*
2040 * E V E N T S
2041 */
2042
2043#define V4L2_EVENT_ALL 0
2044#define V4L2_EVENT_VSYNC 1
2045#define V4L2_EVENT_EOS 2
2046#define V4L2_EVENT_CTRL 3
2047#define V4L2_EVENT_FRAME_SYNC 4
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002048#define V4L2_EVENT_SOURCE_CHANGE 5
Hans Verkuil78ea6112014-01-27 09:26:23 -03002049#define V4L2_EVENT_MOTION_DET 6
David Howells607ca462012-10-13 10:46:48 +01002050#define V4L2_EVENT_PRIVATE_START 0x08000000
2051
2052/* Payload for V4L2_EVENT_VSYNC */
2053struct v4l2_event_vsync {
2054 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2055 __u8 field;
2056} __attribute__ ((packed));
2057
2058/* Payload for V4L2_EVENT_CTRL */
2059#define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2060#define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
Sylwester Nawrocki2ccbe772013-01-19 15:51:55 -03002061#define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
David Howells607ca462012-10-13 10:46:48 +01002062
2063struct v4l2_event_ctrl {
2064 __u32 changes;
2065 __u32 type;
2066 union {
2067 __s32 value;
2068 __s64 value64;
2069 };
2070 __u32 flags;
2071 __s32 minimum;
2072 __s32 maximum;
2073 __s32 step;
2074 __s32 default_value;
2075};
2076
2077struct v4l2_event_frame_sync {
2078 __u32 frame_sequence;
2079};
2080
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002081#define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2082
2083struct v4l2_event_src_change {
2084 __u32 changes;
2085};
2086
Hans Verkuil78ea6112014-01-27 09:26:23 -03002087#define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2088
2089/**
2090 * struct v4l2_event_motion_det - motion detection event
2091 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2092 * frame_sequence field is valid.
2093 * @frame_sequence: the frame sequence number associated with this event.
2094 * @region_mask: which regions detected motion.
2095 */
2096struct v4l2_event_motion_det {
2097 __u32 flags;
2098 __u32 frame_sequence;
2099 __u32 region_mask;
2100};
2101
David Howells607ca462012-10-13 10:46:48 +01002102struct v4l2_event {
2103 __u32 type;
2104 union {
2105 struct v4l2_event_vsync vsync;
2106 struct v4l2_event_ctrl ctrl;
2107 struct v4l2_event_frame_sync frame_sync;
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03002108 struct v4l2_event_src_change src_change;
Hans Verkuil78ea6112014-01-27 09:26:23 -03002109 struct v4l2_event_motion_det motion_det;
David Howells607ca462012-10-13 10:46:48 +01002110 __u8 data[64];
2111 } u;
2112 __u32 pending;
2113 __u32 sequence;
2114 struct timespec timestamp;
2115 __u32 id;
2116 __u32 reserved[8];
2117};
2118
2119#define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2120#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2121
2122struct v4l2_event_subscription {
2123 __u32 type;
2124 __u32 id;
2125 __u32 flags;
2126 __u32 reserved[5];
2127};
2128
2129/*
2130 * A D V A N C E D D E B U G G I N G
2131 *
2132 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2133 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2134 */
2135
2136/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2137
Hans Verkuil79b0c642013-03-18 12:16:34 -03002138#define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
Hans Verkuilb71c9982013-05-26 10:03:01 -03002139#define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2140
2141/* The following four defines are no longer in use */
Hans Verkuil79b0c642013-03-18 12:16:34 -03002142#define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2143#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2144#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03002145#define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
David Howells607ca462012-10-13 10:46:48 +01002146
2147struct v4l2_dbg_match {
2148 __u32 type; /* Match type */
2149 union { /* Match this chip, meaning determined by type */
2150 __u32 addr;
2151 char name[32];
2152 };
2153} __attribute__ ((packed));
2154
2155struct v4l2_dbg_register {
2156 struct v4l2_dbg_match match;
2157 __u32 size; /* register size in bytes */
2158 __u64 reg;
2159 __u64 val;
2160} __attribute__ ((packed));
2161
Hans Verkuil79b0c642013-03-18 12:16:34 -03002162#define V4L2_CHIP_FL_READABLE (1 << 0)
2163#define V4L2_CHIP_FL_WRITABLE (1 << 1)
2164
Hans Verkuil96b03d22013-04-06 06:16:58 -03002165/* VIDIOC_DBG_G_CHIP_INFO */
2166struct v4l2_dbg_chip_info {
Hans Verkuil79b0c642013-03-18 12:16:34 -03002167 struct v4l2_dbg_match match;
2168 char name[32];
2169 __u32 flags;
Hans Verkuilb8399b82013-04-08 11:53:55 -03002170 __u32 reserved[32];
Hans Verkuil79b0c642013-03-18 12:16:34 -03002171} __attribute__ ((packed));
2172
David Howells607ca462012-10-13 10:46:48 +01002173/**
2174 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2175 * @index: on return, index of the first created buffer
2176 * @count: entry: number of requested buffers,
2177 * return: number of created buffers
2178 * @memory: enum v4l2_memory; buffer memory type
2179 * @format: frame format, for which buffers are requested
2180 * @reserved: future extensions
2181 */
2182struct v4l2_create_buffers {
2183 __u32 index;
2184 __u32 count;
2185 __u32 memory;
2186 struct v4l2_format format;
2187 __u32 reserved[8];
2188};
2189
2190/*
2191 * 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
2192 *
2193 */
2194#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2195#define VIDIOC_RESERVED _IO('V', 1)
2196#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2197#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2198#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2199#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2200#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2201#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2202#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2203#define VIDIOC_OVERLAY _IOW('V', 14, int)
2204#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
Tomasz Stanislawskib799d09a2012-06-14 11:32:23 -03002205#define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
David Howells607ca462012-10-13 10:46:48 +01002206#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2207#define VIDIOC_STREAMON _IOW('V', 18, int)
2208#define VIDIOC_STREAMOFF _IOW('V', 19, int)
2209#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2210#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2211#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2212#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2213#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2214#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2215#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2216#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2217#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2218#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2219#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2220#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2221#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2222#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2223#define VIDIOC_G_INPUT _IOR('V', 38, int)
2224#define VIDIOC_S_INPUT _IOWR('V', 39, int)
Hans Verkuil254a4772014-03-04 07:46:47 -03002225#define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2226#define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
David Howells607ca462012-10-13 10:46:48 +01002227#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2228#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2229#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2230#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2231#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2232#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2233#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2234#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2235#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2236#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2237#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2238#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2239#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2240#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2241#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2242#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2243#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2244#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2245#define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2246#define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2247#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2248#define VIDIOC_LOG_STATUS _IO('V', 70)
2249#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2250#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2251#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
David Howells607ca462012-10-13 10:46:48 +01002252#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2253#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2254#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2255#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2256#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
David Howells607ca462012-10-13 10:46:48 +01002257
David Howells607ca462012-10-13 10:46:48 +01002258/* Experimental, meant for debugging, testing and internal use.
2259 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2260 You must be root to use these ioctls. Never use these in applications! */
2261#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2262#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2263
David Howells607ca462012-10-13 10:46:48 +01002264#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2265
David Howells607ca462012-10-13 10:46:48 +01002266#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2267#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2268#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2269#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2270#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2271
2272/* Experimental, the below two ioctls may change over the next couple of kernel
2273 versions */
2274#define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2275#define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2276
2277/* Experimental selection API */
2278#define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2279#define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2280
2281/* Experimental, these two ioctls may change over the next couple of kernel
2282 versions. */
2283#define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2284#define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2285
2286/* Experimental, these three ioctls may change over the next couple of kernel
2287 versions. */
2288#define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2289#define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2290#define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2291
2292/* Experimental, this ioctl may change over the next couple of kernel
2293 versions. */
2294#define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2295
Hans Verkuil79b0c642013-03-18 12:16:34 -03002296/* Experimental, meant for debugging, testing and internal use.
2297 Never use these in applications! */
Hans Verkuil96b03d22013-04-06 06:16:58 -03002298#define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
Hans Verkuil79b0c642013-03-18 12:16:34 -03002299
Hans Verkuil5082c242014-06-10 04:14:50 -03002300#define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2301
David Howells607ca462012-10-13 10:46:48 +01002302/* Reminder: when adding new ioctls please add support for them to
Ricardo Ribaldad9e7d222015-08-21 10:19:20 -03002303 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
David Howells607ca462012-10-13 10:46:48 +01002304
2305#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2306
2307#endif /* _UAPI__LINUX_VIDEODEV2_H */