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