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 32
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 *
982 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
983 * with two planes can have one plane for Y, and another for interleaved CbCr
984 * components. Each plane can reside in a separate memory buffer, or even in
985 * a completely separate memory node (e.g. in embedded devices).
986 */
987 struct v4l2_plane {
988 __u32 bytesused;
989 __u32 length;
990 union {
991 __u32 mem_offset;
992 unsigned long userptr;
993 __s32 fd;
994 } m;
995 __u32 data_offset;
996 __u32 reserved[11];
997 };
998
999 /**
1000 * struct v4l2_buffer - video buffer info
1001 * @index: id number of the buffer
1002 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
1003 * multiplanar buffers);
1004 * @bytesused: number of bytes occupied by data in the buffer (payload);
1005 * unused (set to 0) for multiplanar buffers
1006 * @flags: buffer informational flags
1007 * @field: enum v4l2_field; field order of the image in the buffer
1008 * @timestamp: frame timestamp
1009 * @timecode: frame timecode
1010 * @sequence: sequence count of this frame
1011 * @memory: enum v4l2_memory; the method, in which the actual video data is
1012 * passed
1013 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
1014 * offset from the start of the device memory for this plane,
1015 * (or a "cookie" that should be passed to mmap() as offset)
1016 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
1017 * a userspace pointer pointing to this buffer
1018 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
1019 * a userspace file descriptor associated with this buffer
1020 * @planes: for multiplanar buffers; userspace pointer to the array of plane
1021 * info structs for this buffer
1022 * @length: size in bytes of the buffer (NOT its payload) for single-plane
1023 * buffers (when type != *_MPLANE); number of elements in the
1024 * planes array for multi-plane buffers
1025 * @request_fd: fd of the request that this buffer should use
1026 *
1027 * Contains data exchanged by application and driver using one of the Streaming
1028 * I/O methods.
1029 */
1030 struct v4l2_buffer {
1031 __u32 index;
1032 __u32 type;
1033 __u32 bytesused;
1034 __u32 flags;
1035 __u32 field;
1036 #ifdef __KERNEL__
1037 struct __kernel_v4l2_timeval timestamp;
1038 #else
1039 struct timeval timestamp;
1040 #endif
1041 struct v4l2_timecode timecode;
1042 __u32 sequence;
1043
1044 /* memory location */
1045 __u32 memory;
1046 union {
1047 __u32 offset;
1048 unsigned long userptr;
1049 struct v4l2_plane *planes;
1050 __s32 fd;
1051 } m;
1052 __u32 length;
1053 __u32 reserved2;
1054 union {
1055 __s32 request_fd;
1056 __u32 reserved;
1057 };
1058 };
1059
1060 #ifndef __KERNEL__
1061 /**
1062 * v4l2_timeval_to_ns - Convert timeval to nanoseconds
1063 * @ts: pointer to the timeval variable to be converted
1064 *
1065 * Returns the scalar nanosecond representation of the timeval
1066 * parameter.
1067 */
v4l2_timeval_to_ns(const struct timeval * tv)1068 static inline __u64 v4l2_timeval_to_ns(const struct timeval *tv)
1069 {
1070 return (__u64)tv->tv_sec * 1000000000ULL + tv->tv_usec * 1000;
1071 }
1072 #endif
1073
1074 /* Flags for 'flags' field */
1075 /* Buffer is mapped (flag) */
1076 #define V4L2_BUF_FLAG_MAPPED 0x00000001
1077 /* Buffer is queued for processing */
1078 #define V4L2_BUF_FLAG_QUEUED 0x00000002
1079 /* Buffer is ready */
1080 #define V4L2_BUF_FLAG_DONE 0x00000004
1081 /* Image is a keyframe (I-frame) */
1082 #define V4L2_BUF_FLAG_KEYFRAME 0x00000008
1083 /* Image is a P-frame */
1084 #define V4L2_BUF_FLAG_PFRAME 0x00000010
1085 /* Image is a B-frame */
1086 #define V4L2_BUF_FLAG_BFRAME 0x00000020
1087 /* Buffer is ready, but the data contained within is corrupted. */
1088 #define V4L2_BUF_FLAG_ERROR 0x00000040
1089 /* Buffer is added to an unqueued request */
1090 #define V4L2_BUF_FLAG_IN_REQUEST 0x00000080
1091 /* timecode field is valid */
1092 #define V4L2_BUF_FLAG_TIMECODE 0x00000100
1093 /* Don't return the capture buffer until OUTPUT timestamp changes */
1094 #define V4L2_BUF_FLAG_M2M_HOLD_CAPTURE_BUF 0x00000200
1095 /* Buffer is prepared for queuing */
1096 #define V4L2_BUF_FLAG_PREPARED 0x00000400
1097 /* Cache handling flags */
1098 #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
1099 #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
1100 /* Timestamp type */
1101 #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
1102 #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
1103 #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
1104 #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
1105 /* Timestamp sources. */
1106 #define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
1107 #define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
1108 #define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
1109 /* mem2mem encoder/decoder */
1110 #define V4L2_BUF_FLAG_LAST 0x00100000
1111 /* request_fd is valid */
1112 #define V4L2_BUF_FLAG_REQUEST_FD 0x00800000
1113
1114 /**
1115 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
1116 *
1117 * @index: id number of the buffer
1118 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
1119 * multiplanar buffers);
1120 * @plane: index of the plane to be exported, 0 for single plane queues
1121 * @flags: flags for newly created file, currently only O_CLOEXEC is
1122 * supported, refer to manual of open syscall for more details
1123 * @fd: file descriptor associated with DMABUF (set by driver)
1124 *
1125 * Contains data used for exporting a video buffer as DMABUF file descriptor.
1126 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
1127 * (identical to the cookie used to mmap() the buffer to userspace). All
1128 * reserved fields must be set to zero. The field reserved0 is expected to
1129 * become a structure 'type' allowing an alternative layout of the structure
1130 * content. Therefore this field should not be used for any other extensions.
1131 */
1132 struct v4l2_exportbuffer {
1133 __u32 type; /* enum v4l2_buf_type */
1134 __u32 index;
1135 __u32 plane;
1136 __u32 flags;
1137 __s32 fd;
1138 __u32 reserved[11];
1139 };
1140
1141 /*
1142 * O V E R L A Y P R E V I E W
1143 */
1144 struct v4l2_framebuffer {
1145 __u32 capability;
1146 __u32 flags;
1147 /* FIXME: in theory we should pass something like PCI device + memory
1148 * region + offset instead of some physical address */
1149 void *base;
1150 struct {
1151 __u32 width;
1152 __u32 height;
1153 __u32 pixelformat;
1154 __u32 field; /* enum v4l2_field */
1155 __u32 bytesperline; /* for padding, zero if unused */
1156 __u32 sizeimage;
1157 __u32 colorspace; /* enum v4l2_colorspace */
1158 __u32 priv; /* reserved field, set to 0 */
1159 } fmt;
1160 };
1161 /* Flags for the 'capability' field. Read only */
1162 #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
1163 #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
1164 #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
1165 #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
1166 #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
1167 #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
1168 #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
1169 #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
1170 /* Flags for the 'flags' field. */
1171 #define V4L2_FBUF_FLAG_PRIMARY 0x0001
1172 #define V4L2_FBUF_FLAG_OVERLAY 0x0002
1173 #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
1174 #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
1175 #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
1176 #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
1177 #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
1178
1179 struct v4l2_clip {
1180 struct v4l2_rect c;
1181 struct v4l2_clip __user *next;
1182 };
1183
1184 struct v4l2_window {
1185 struct v4l2_rect w;
1186 __u32 field; /* enum v4l2_field */
1187 __u32 chromakey;
1188 struct v4l2_clip __user *clips;
1189 __u32 clipcount;
1190 void __user *bitmap;
1191 __u8 global_alpha;
1192 };
1193
1194 /*
1195 * C A P T U R E P A R A M E T E R S
1196 */
1197 struct v4l2_captureparm {
1198 __u32 capability; /* Supported modes */
1199 __u32 capturemode; /* Current mode */
1200 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1201 __u32 extendedmode; /* Driver-specific extensions */
1202 __u32 readbuffers; /* # of buffers for read */
1203 __u32 reserved[4];
1204 };
1205
1206 /* Flags for 'capability' and 'capturemode' fields */
1207 #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
1208 #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
1209
1210 struct v4l2_outputparm {
1211 __u32 capability; /* Supported modes */
1212 __u32 outputmode; /* Current mode */
1213 struct v4l2_fract timeperframe; /* Time per frame in seconds */
1214 __u32 extendedmode; /* Driver-specific extensions */
1215 __u32 writebuffers; /* # of buffers for write */
1216 __u32 reserved[4];
1217 };
1218
1219 /*
1220 * I N P U T I M A G E C R O P P I N G
1221 */
1222 struct v4l2_cropcap {
1223 __u32 type; /* enum v4l2_buf_type */
1224 struct v4l2_rect bounds;
1225 struct v4l2_rect defrect;
1226 struct v4l2_fract pixelaspect;
1227 };
1228
1229 struct v4l2_crop {
1230 __u32 type; /* enum v4l2_buf_type */
1231 struct v4l2_rect c;
1232 };
1233
1234 /**
1235 * struct v4l2_selection - selection info
1236 * @type: buffer type (do not use *_MPLANE types)
1237 * @target: Selection target, used to choose one of possible rectangles;
1238 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
1239 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1240 * @r: coordinates of selection window
1241 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
1242 *
1243 * Hardware may use multiple helper windows to process a video stream.
1244 * The structure is used to exchange this selection areas between
1245 * an application and a driver.
1246 */
1247 struct v4l2_selection {
1248 __u32 type;
1249 __u32 target;
1250 __u32 flags;
1251 struct v4l2_rect r;
1252 __u32 reserved[9];
1253 };
1254
1255
1256 /*
1257 * A N A L O G V I D E O S T A N D A R D
1258 */
1259
1260 typedef __u64 v4l2_std_id;
1261
1262 /*
1263 * Attention: Keep the V4L2_STD_* bit definitions in sync with
1264 * include/dt-bindings/display/sdtv-standards.h SDTV_STD_* bit definitions.
1265 */
1266 /* one bit for each */
1267 #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
1268 #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
1269 #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
1270 #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
1271 #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
1272 #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
1273 #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
1274 #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
1275
1276 #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
1277 #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
1278 #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
1279 #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
1280
1281 #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
1282 #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
1283 #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
1284 #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
1285
1286 #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
1287 #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
1288 #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
1289 #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
1290 #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
1291 #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
1292 #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
1293 #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
1294
1295 /* ATSC/HDTV */
1296 #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
1297 #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
1298
1299 /* FIXME:
1300 Although std_id is 64 bits, there is an issue on PPC32 architecture that
1301 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1302 this value to 32 bits.
1303 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1304 it should work fine. However, if needed to add more than two standards,
1305 v4l2-common.c should be fixed.
1306 */
1307
1308 /*
1309 * Some macros to merge video standards in order to make live easier for the
1310 * drivers and V4L2 applications
1311 */
1312
1313 /*
1314 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1315 * Missing here.
1316 */
1317 #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
1318 V4L2_STD_NTSC_M_JP |\
1319 V4L2_STD_NTSC_M_KR)
1320 /* Secam macros */
1321 #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
1322 V4L2_STD_SECAM_K |\
1323 V4L2_STD_SECAM_K1)
1324 /* All Secam Standards */
1325 #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
1326 V4L2_STD_SECAM_G |\
1327 V4L2_STD_SECAM_H |\
1328 V4L2_STD_SECAM_DK |\
1329 V4L2_STD_SECAM_L |\
1330 V4L2_STD_SECAM_LC)
1331 /* PAL macros */
1332 #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
1333 V4L2_STD_PAL_B1 |\
1334 V4L2_STD_PAL_G)
1335 #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
1336 V4L2_STD_PAL_D1 |\
1337 V4L2_STD_PAL_K)
1338 /*
1339 * "Common" PAL - This macro is there to be compatible with the old
1340 * V4L1 concept of "PAL": /BGDKHI.
1341 * Several PAL standards are missing here: /M, /N and /Nc
1342 */
1343 #define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
1344 V4L2_STD_PAL_DK |\
1345 V4L2_STD_PAL_H |\
1346 V4L2_STD_PAL_I)
1347 /* Chroma "agnostic" standards */
1348 #define V4L2_STD_B (V4L2_STD_PAL_B |\
1349 V4L2_STD_PAL_B1 |\
1350 V4L2_STD_SECAM_B)
1351 #define V4L2_STD_G (V4L2_STD_PAL_G |\
1352 V4L2_STD_SECAM_G)
1353 #define V4L2_STD_H (V4L2_STD_PAL_H |\
1354 V4L2_STD_SECAM_H)
1355 #define V4L2_STD_L (V4L2_STD_SECAM_L |\
1356 V4L2_STD_SECAM_LC)
1357 #define V4L2_STD_GH (V4L2_STD_G |\
1358 V4L2_STD_H)
1359 #define V4L2_STD_DK (V4L2_STD_PAL_DK |\
1360 V4L2_STD_SECAM_DK)
1361 #define V4L2_STD_BG (V4L2_STD_B |\
1362 V4L2_STD_G)
1363 #define V4L2_STD_MN (V4L2_STD_PAL_M |\
1364 V4L2_STD_PAL_N |\
1365 V4L2_STD_PAL_Nc |\
1366 V4L2_STD_NTSC)
1367
1368 /* Standards where MTS/BTSC stereo could be found */
1369 #define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
1370 V4L2_STD_PAL_M |\
1371 V4L2_STD_PAL_N |\
1372 V4L2_STD_PAL_Nc)
1373
1374 /* Standards for Countries with 60Hz Line frequency */
1375 #define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
1376 V4L2_STD_PAL_60 |\
1377 V4L2_STD_NTSC |\
1378 V4L2_STD_NTSC_443)
1379 /* Standards for Countries with 50Hz Line frequency */
1380 #define V4L2_STD_625_50 (V4L2_STD_PAL |\
1381 V4L2_STD_PAL_N |\
1382 V4L2_STD_PAL_Nc |\
1383 V4L2_STD_SECAM)
1384
1385 #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1386 V4L2_STD_ATSC_16_VSB)
1387 /* Macros with none and all analog standards */
1388 #define V4L2_STD_UNKNOWN 0
1389 #define V4L2_STD_ALL (V4L2_STD_525_60 |\
1390 V4L2_STD_625_50)
1391
1392 struct v4l2_standard {
1393 __u32 index;
1394 v4l2_std_id id;
1395 __u8 name[24];
1396 struct v4l2_fract frameperiod; /* Frames, not fields */
1397 __u32 framelines;
1398 __u32 reserved[4];
1399 };
1400
1401 /*
1402 * D V B T T I M I N G S
1403 */
1404
1405 /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1406 * @width: total width of the active video in pixels
1407 * @height: total height of the active video in lines
1408 * @interlaced: Interlaced or progressive
1409 * @polarities: Positive or negative polarities
1410 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1411 * @hfrontporch:Horizontal front porch in pixels
1412 * @hsync: Horizontal Sync length in pixels
1413 * @hbackporch: Horizontal back porch in pixels
1414 * @vfrontporch:Vertical front porch in lines
1415 * @vsync: Vertical Sync length in lines
1416 * @vbackporch: Vertical back porch in lines
1417 * @il_vfrontporch:Vertical front porch for the even field
1418 * (aka field 2) of interlaced field formats
1419 * @il_vsync: Vertical Sync length for the even field
1420 * (aka field 2) of interlaced field formats
1421 * @il_vbackporch:Vertical back porch for the even field
1422 * (aka field 2) of interlaced field formats
1423 * @standards: Standards the timing belongs to
1424 * @flags: Flags
1425 * @picture_aspect: The picture aspect ratio (hor/vert).
1426 * @cea861_vic: VIC code as per the CEA-861 standard.
1427 * @hdmi_vic: VIC code as per the HDMI standard.
1428 * @reserved: Reserved fields, must be zeroed.
1429 *
1430 * A note regarding vertical interlaced timings: height refers to the total
1431 * height of the active video frame (= two fields). The blanking timings refer
1432 * to the blanking of each field. So the height of the total frame is
1433 * calculated as follows:
1434 *
1435 * tot_height = height + vfrontporch + vsync + vbackporch +
1436 * il_vfrontporch + il_vsync + il_vbackporch
1437 *
1438 * The active height of each field is height / 2.
1439 */
1440 struct v4l2_bt_timings {
1441 __u32 width;
1442 __u32 height;
1443 __u32 interlaced;
1444 __u32 polarities;
1445 __u64 pixelclock;
1446 __u32 hfrontporch;
1447 __u32 hsync;
1448 __u32 hbackporch;
1449 __u32 vfrontporch;
1450 __u32 vsync;
1451 __u32 vbackporch;
1452 __u32 il_vfrontporch;
1453 __u32 il_vsync;
1454 __u32 il_vbackporch;
1455 __u32 standards;
1456 __u32 flags;
1457 struct v4l2_fract picture_aspect;
1458 __u8 cea861_vic;
1459 __u8 hdmi_vic;
1460 __u8 reserved[46];
1461 } __attribute__ ((packed));
1462
1463 /* Interlaced or progressive format */
1464 #define V4L2_DV_PROGRESSIVE 0
1465 #define V4L2_DV_INTERLACED 1
1466
1467 /* Polarities. If bit is not set, it is assumed to be negative polarity */
1468 #define V4L2_DV_VSYNC_POS_POL 0x00000001
1469 #define V4L2_DV_HSYNC_POS_POL 0x00000002
1470
1471 /* Timings standards */
1472 #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1473 #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1474 #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1475 #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1476 #define V4L2_DV_BT_STD_SDI (1 << 4) /* SDI Timings */
1477
1478 /* Flags */
1479
1480 /*
1481 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1482 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1483 * intervals are reduced, allowing a higher resolution over the same
1484 * bandwidth. This is a read-only flag.
1485 */
1486 #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1487 /*
1488 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1489 * of six. These formats can be optionally played at 1 / 1.001 speed.
1490 * This is a read-only flag.
1491 */
1492 #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1493 /*
1494 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1495 * by receivers.
1496 * If the framerate of the format is a multiple of six, then the pixelclock
1497 * used to set up the transmitter is divided by 1.001 to make it compatible
1498 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1499 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1500 * such frequencies, then the flag will also be cleared.
1501 */
1502 #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1503 /*
1504 * Specific to interlaced formats: if set, then field 1 is really one half-line
1505 * longer and field 2 is really one half-line shorter, so each field has
1506 * exactly the same number of half-lines. Whether half-lines can be detected
1507 * or used depends on the hardware.
1508 */
1509 #define V4L2_DV_FL_HALF_LINE (1 << 3)
1510 /*
1511 * If set, then this is a Consumer Electronics (CE) video format. Such formats
1512 * differ from other formats (commonly called IT formats) in that if RGB
1513 * encoding is used then by default the RGB values use limited range (i.e.
1514 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1515 * except for the 640x480 format are CE formats.
1516 */
1517 #define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
1518 /* Some formats like SMPTE-125M have an interlaced signal with a odd
1519 * total height. For these formats, if this flag is set, the first
1520 * field has the extra line. If not, it is the second field.
1521 */
1522 #define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE (1 << 5)
1523 /*
1524 * If set, then the picture_aspect field is valid. Otherwise assume that the
1525 * pixels are square, so the picture aspect ratio is the same as the width to
1526 * height ratio.
1527 */
1528 #define V4L2_DV_FL_HAS_PICTURE_ASPECT (1 << 6)
1529 /*
1530 * If set, then the cea861_vic field is valid and contains the Video
1531 * Identification Code as per the CEA-861 standard.
1532 */
1533 #define V4L2_DV_FL_HAS_CEA861_VIC (1 << 7)
1534 /*
1535 * If set, then the hdmi_vic field is valid and contains the Video
1536 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1537 * InfoFrame).
1538 */
1539 #define V4L2_DV_FL_HAS_HDMI_VIC (1 << 8)
1540 /*
1541 * CEA-861 specific: only valid for video receivers.
1542 * If set, then HW can detect the difference between regular FPS and
1543 * 1000/1001 FPS. Note: This flag is only valid for HDMI VIC codes with
1544 * the V4L2_DV_FL_CAN_REDUCE_FPS flag set.
1545 */
1546 #define V4L2_DV_FL_CAN_DETECT_REDUCED_FPS (1 << 9)
1547
1548 /* A few useful defines to calculate the total blanking and frame sizes */
1549 #define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1550 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1551 #define V4L2_DV_BT_FRAME_WIDTH(bt) \
1552 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1553 #define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1554 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1555 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
1556 #define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1557 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1558
1559 /** struct v4l2_dv_timings - DV timings
1560 * @type: the type of the timings
1561 * @bt: BT656/1120 timings
1562 */
1563 struct v4l2_dv_timings {
1564 __u32 type;
1565 union {
1566 struct v4l2_bt_timings bt;
1567 __u32 reserved[32];
1568 };
1569 } __attribute__ ((packed));
1570
1571 /* Values for the type field */
1572 #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1573
1574
1575 /** struct v4l2_enum_dv_timings - DV timings enumeration
1576 * @index: enumeration index
1577 * @pad: the pad number for which to enumerate timings (used with
1578 * v4l-subdev nodes only)
1579 * @reserved: must be zeroed
1580 * @timings: the timings for the given index
1581 */
1582 struct v4l2_enum_dv_timings {
1583 __u32 index;
1584 __u32 pad;
1585 __u32 reserved[2];
1586 struct v4l2_dv_timings timings;
1587 };
1588
1589 /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1590 * @min_width: width in pixels
1591 * @max_width: width in pixels
1592 * @min_height: height in lines
1593 * @max_height: height in lines
1594 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1595 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1596 * @standards: Supported standards
1597 * @capabilities: Supported capabilities
1598 * @reserved: Must be zeroed
1599 */
1600 struct v4l2_bt_timings_cap {
1601 __u32 min_width;
1602 __u32 max_width;
1603 __u32 min_height;
1604 __u32 max_height;
1605 __u64 min_pixelclock;
1606 __u64 max_pixelclock;
1607 __u32 standards;
1608 __u32 capabilities;
1609 __u32 reserved[16];
1610 } __attribute__ ((packed));
1611
1612 /* Supports interlaced formats */
1613 #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1614 /* Supports progressive formats */
1615 #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1616 /* Supports CVT/GTF reduced blanking */
1617 #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1618 /* Supports custom formats */
1619 #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1620
1621 /** struct v4l2_dv_timings_cap - DV timings capabilities
1622 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1623 * @pad: the pad number for which to query capabilities (used with
1624 * v4l-subdev nodes only)
1625 * @bt: the BT656/1120 timings capabilities
1626 */
1627 struct v4l2_dv_timings_cap {
1628 __u32 type;
1629 __u32 pad;
1630 __u32 reserved[2];
1631 union {
1632 struct v4l2_bt_timings_cap bt;
1633 __u32 raw_data[32];
1634 };
1635 };
1636
1637
1638 /*
1639 * V I D E O I N P U T S
1640 */
1641 struct v4l2_input {
1642 __u32 index; /* Which input */
1643 __u8 name[32]; /* Label */
1644 __u32 type; /* Type of input */
1645 __u32 audioset; /* Associated audios (bitfield) */
1646 __u32 tuner; /* enum v4l2_tuner_type */
1647 v4l2_std_id std;
1648 __u32 status;
1649 __u32 capabilities;
1650 __u32 reserved[3];
1651 };
1652
1653 /* Values for the 'type' field */
1654 #define V4L2_INPUT_TYPE_TUNER 1
1655 #define V4L2_INPUT_TYPE_CAMERA 2
1656 #define V4L2_INPUT_TYPE_TOUCH 3
1657
1658 /* field 'status' - general */
1659 #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1660 #define V4L2_IN_ST_NO_SIGNAL 0x00000002
1661 #define V4L2_IN_ST_NO_COLOR 0x00000004
1662
1663 /* field 'status' - sensor orientation */
1664 /* If sensor is mounted upside down set both bits */
1665 #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1666 #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1667
1668 /* field 'status' - analog */
1669 #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1670 #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1671 #define V4L2_IN_ST_NO_V_LOCK 0x00000400 /* No vertical sync lock */
1672 #define V4L2_IN_ST_NO_STD_LOCK 0x00000800 /* No standard format lock */
1673
1674 /* field 'status' - digital */
1675 #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1676 #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1677 #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1678
1679 /* field 'status' - VCR and set-top box */
1680 #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1681 #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1682 #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1683
1684 /* capabilities flags */
1685 #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1686 #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1687 #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1688 #define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1689
1690 /*
1691 * V I D E O O U T P U T S
1692 */
1693 struct v4l2_output {
1694 __u32 index; /* Which output */
1695 __u8 name[32]; /* Label */
1696 __u32 type; /* Type of output */
1697 __u32 audioset; /* Associated audios (bitfield) */
1698 __u32 modulator; /* Associated modulator */
1699 v4l2_std_id std;
1700 __u32 capabilities;
1701 __u32 reserved[3];
1702 };
1703 /* Values for the 'type' field */
1704 #define V4L2_OUTPUT_TYPE_MODULATOR 1
1705 #define V4L2_OUTPUT_TYPE_ANALOG 2
1706 #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1707
1708 /* capabilities flags */
1709 #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1710 #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1711 #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1712 #define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
1713
1714 /*
1715 * C O N T R O L S
1716 */
1717 struct v4l2_control {
1718 __u32 id;
1719 __s32 value;
1720 };
1721
1722 struct v4l2_ext_control {
1723 __u32 id;
1724 __u32 size;
1725 __u32 reserved2[1];
1726 union {
1727 __s32 value;
1728 __s64 value64;
1729 char __user *string;
1730 __u8 __user *p_u8;
1731 __u16 __user *p_u16;
1732 __u32 __user *p_u32;
1733 struct v4l2_area __user *p_area;
1734 void __user *ptr;
1735 };
1736 } __attribute__ ((packed));
1737
1738 struct v4l2_ext_controls {
1739 union {
1740 #ifndef __KERNEL__
1741 __u32 ctrl_class;
1742 #endif
1743 __u32 which;
1744 };
1745 __u32 count;
1746 __u32 error_idx;
1747 __s32 request_fd;
1748 __u32 reserved[1];
1749 struct v4l2_ext_control *controls;
1750 };
1751
1752 #define V4L2_CTRL_ID_MASK (0x0fffffff)
1753 #ifndef __KERNEL__
1754 #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1755 #endif
1756 #define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
1757 #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1758 #define V4L2_CTRL_MAX_DIMS (4)
1759 #define V4L2_CTRL_WHICH_CUR_VAL 0
1760 #define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
1761 #define V4L2_CTRL_WHICH_REQUEST_VAL 0x0f010000
1762
1763 enum v4l2_ctrl_type {
1764 V4L2_CTRL_TYPE_INTEGER = 1,
1765 V4L2_CTRL_TYPE_BOOLEAN = 2,
1766 V4L2_CTRL_TYPE_MENU = 3,
1767 V4L2_CTRL_TYPE_BUTTON = 4,
1768 V4L2_CTRL_TYPE_INTEGER64 = 5,
1769 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1770 V4L2_CTRL_TYPE_STRING = 7,
1771 V4L2_CTRL_TYPE_BITMASK = 8,
1772 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1773
1774 /* Compound types are >= 0x0100 */
1775 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
1776 V4L2_CTRL_TYPE_U8 = 0x0100,
1777 V4L2_CTRL_TYPE_U16 = 0x0101,
1778 V4L2_CTRL_TYPE_U32 = 0x0102,
1779 V4L2_CTRL_TYPE_AREA = 0x0106,
1780 };
1781
1782 /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1783 struct v4l2_queryctrl {
1784 __u32 id;
1785 __u32 type; /* enum v4l2_ctrl_type */
1786 __u8 name[32]; /* Whatever */
1787 __s32 minimum; /* Note signedness */
1788 __s32 maximum;
1789 __s32 step;
1790 __s32 default_value;
1791 __u32 flags;
1792 __u32 reserved[2];
1793 };
1794
1795 /* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1796 struct v4l2_query_ext_ctrl {
1797 __u32 id;
1798 __u32 type;
1799 char name[32];
1800 __s64 minimum;
1801 __s64 maximum;
1802 __u64 step;
1803 __s64 default_value;
1804 __u32 flags;
1805 __u32 elem_size;
1806 __u32 elems;
1807 __u32 nr_of_dims;
1808 __u32 dims[V4L2_CTRL_MAX_DIMS];
1809 __u32 reserved[32];
1810 };
1811
1812 /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1813 struct v4l2_querymenu {
1814 __u32 id;
1815 __u32 index;
1816 union {
1817 __u8 name[32]; /* Whatever */
1818 __s64 value;
1819 };
1820 __u32 reserved;
1821 } __attribute__ ((packed));
1822
1823 /* Control flags */
1824 #define V4L2_CTRL_FLAG_DISABLED 0x0001
1825 #define V4L2_CTRL_FLAG_GRABBED 0x0002
1826 #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1827 #define V4L2_CTRL_FLAG_UPDATE 0x0008
1828 #define V4L2_CTRL_FLAG_INACTIVE 0x0010
1829 #define V4L2_CTRL_FLAG_SLIDER 0x0020
1830 #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1831 #define V4L2_CTRL_FLAG_VOLATILE 0x0080
1832 #define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
1833 #define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
1834 #define V4L2_CTRL_FLAG_MODIFY_LAYOUT 0x0400
1835
1836 /* Query flags, to be ORed with the control ID */
1837 #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1838 #define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
1839
1840 /* User-class control IDs defined by V4L2 */
1841 #define V4L2_CID_MAX_CTRLS 1024
1842 /* IDs reserved for driver specific controls */
1843 #define V4L2_CID_PRIVATE_BASE 0x08000000
1844
1845
1846 /*
1847 * T U N I N G
1848 */
1849 struct v4l2_tuner {
1850 __u32 index;
1851 __u8 name[32];
1852 __u32 type; /* enum v4l2_tuner_type */
1853 __u32 capability;
1854 __u32 rangelow;
1855 __u32 rangehigh;
1856 __u32 rxsubchans;
1857 __u32 audmode;
1858 __s32 signal;
1859 __s32 afc;
1860 __u32 reserved[4];
1861 };
1862
1863 struct v4l2_modulator {
1864 __u32 index;
1865 __u8 name[32];
1866 __u32 capability;
1867 __u32 rangelow;
1868 __u32 rangehigh;
1869 __u32 txsubchans;
1870 __u32 type; /* enum v4l2_tuner_type */
1871 __u32 reserved[3];
1872 };
1873
1874 /* Flags for the 'capability' field */
1875 #define V4L2_TUNER_CAP_LOW 0x0001
1876 #define V4L2_TUNER_CAP_NORM 0x0002
1877 #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1878 #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1879 #define V4L2_TUNER_CAP_STEREO 0x0010
1880 #define V4L2_TUNER_CAP_LANG2 0x0020
1881 #define V4L2_TUNER_CAP_SAP 0x0020
1882 #define V4L2_TUNER_CAP_LANG1 0x0040
1883 #define V4L2_TUNER_CAP_RDS 0x0080
1884 #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1885 #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1886 #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1887 #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
1888 #define V4L2_TUNER_CAP_1HZ 0x1000
1889
1890 /* Flags for the 'rxsubchans' field */
1891 #define V4L2_TUNER_SUB_MONO 0x0001
1892 #define V4L2_TUNER_SUB_STEREO 0x0002
1893 #define V4L2_TUNER_SUB_LANG2 0x0004
1894 #define V4L2_TUNER_SUB_SAP 0x0004
1895 #define V4L2_TUNER_SUB_LANG1 0x0008
1896 #define V4L2_TUNER_SUB_RDS 0x0010
1897
1898 /* Values for the 'audmode' field */
1899 #define V4L2_TUNER_MODE_MONO 0x0000
1900 #define V4L2_TUNER_MODE_STEREO 0x0001
1901 #define V4L2_TUNER_MODE_LANG2 0x0002
1902 #define V4L2_TUNER_MODE_SAP 0x0002
1903 #define V4L2_TUNER_MODE_LANG1 0x0003
1904 #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1905
1906 struct v4l2_frequency {
1907 __u32 tuner;
1908 __u32 type; /* enum v4l2_tuner_type */
1909 __u32 frequency;
1910 __u32 reserved[8];
1911 };
1912
1913 #define V4L2_BAND_MODULATION_VSB (1 << 1)
1914 #define V4L2_BAND_MODULATION_FM (1 << 2)
1915 #define V4L2_BAND_MODULATION_AM (1 << 3)
1916
1917 struct v4l2_frequency_band {
1918 __u32 tuner;
1919 __u32 type; /* enum v4l2_tuner_type */
1920 __u32 index;
1921 __u32 capability;
1922 __u32 rangelow;
1923 __u32 rangehigh;
1924 __u32 modulation;
1925 __u32 reserved[9];
1926 };
1927
1928 struct v4l2_hw_freq_seek {
1929 __u32 tuner;
1930 __u32 type; /* enum v4l2_tuner_type */
1931 __u32 seek_upward;
1932 __u32 wrap_around;
1933 __u32 spacing;
1934 __u32 rangelow;
1935 __u32 rangehigh;
1936 __u32 reserved[5];
1937 };
1938
1939 /*
1940 * R D S
1941 */
1942
1943 struct v4l2_rds_data {
1944 __u8 lsb;
1945 __u8 msb;
1946 __u8 block;
1947 } __attribute__ ((packed));
1948
1949 #define V4L2_RDS_BLOCK_MSK 0x7
1950 #define V4L2_RDS_BLOCK_A 0
1951 #define V4L2_RDS_BLOCK_B 1
1952 #define V4L2_RDS_BLOCK_C 2
1953 #define V4L2_RDS_BLOCK_D 3
1954 #define V4L2_RDS_BLOCK_C_ALT 4
1955 #define V4L2_RDS_BLOCK_INVALID 7
1956
1957 #define V4L2_RDS_BLOCK_CORRECTED 0x40
1958 #define V4L2_RDS_BLOCK_ERROR 0x80
1959
1960 /*
1961 * A U D I O
1962 */
1963 struct v4l2_audio {
1964 __u32 index;
1965 __u8 name[32];
1966 __u32 capability;
1967 __u32 mode;
1968 __u32 reserved[2];
1969 };
1970
1971 /* Flags for the 'capability' field */
1972 #define V4L2_AUDCAP_STEREO 0x00001
1973 #define V4L2_AUDCAP_AVL 0x00002
1974
1975 /* Flags for the 'mode' field */
1976 #define V4L2_AUDMODE_AVL 0x00001
1977
1978 struct v4l2_audioout {
1979 __u32 index;
1980 __u8 name[32];
1981 __u32 capability;
1982 __u32 mode;
1983 __u32 reserved[2];
1984 };
1985
1986 /*
1987 * M P E G S E R V I C E S
1988 */
1989 #if 1
1990 #define V4L2_ENC_IDX_FRAME_I (0)
1991 #define V4L2_ENC_IDX_FRAME_P (1)
1992 #define V4L2_ENC_IDX_FRAME_B (2)
1993 #define V4L2_ENC_IDX_FRAME_MASK (0xf)
1994
1995 struct v4l2_enc_idx_entry {
1996 __u64 offset;
1997 __u64 pts;
1998 __u32 length;
1999 __u32 flags;
2000 __u32 reserved[2];
2001 };
2002
2003 #define V4L2_ENC_IDX_ENTRIES (64)
2004 struct v4l2_enc_idx {
2005 __u32 entries;
2006 __u32 entries_cap;
2007 __u32 reserved[4];
2008 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
2009 };
2010
2011
2012 #define V4L2_ENC_CMD_START (0)
2013 #define V4L2_ENC_CMD_STOP (1)
2014 #define V4L2_ENC_CMD_PAUSE (2)
2015 #define V4L2_ENC_CMD_RESUME (3)
2016
2017 /* Flags for V4L2_ENC_CMD_STOP */
2018 #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
2019
2020 struct v4l2_encoder_cmd {
2021 __u32 cmd;
2022 __u32 flags;
2023 union {
2024 struct {
2025 __u32 data[8];
2026 } raw;
2027 };
2028 };
2029
2030 /* Decoder commands */
2031 #define V4L2_DEC_CMD_START (0)
2032 #define V4L2_DEC_CMD_STOP (1)
2033 #define V4L2_DEC_CMD_PAUSE (2)
2034 #define V4L2_DEC_CMD_RESUME (3)
2035 #define V4L2_DEC_CMD_FLUSH (4)
2036
2037 /* Flags for V4L2_DEC_CMD_START */
2038 #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
2039
2040 /* Flags for V4L2_DEC_CMD_PAUSE */
2041 #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
2042
2043 /* Flags for V4L2_DEC_CMD_STOP */
2044 #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
2045 #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
2046
2047 /* Play format requirements (returned by the driver): */
2048
2049 /* The decoder has no special format requirements */
2050 #define V4L2_DEC_START_FMT_NONE (0)
2051 /* The decoder requires full GOPs */
2052 #define V4L2_DEC_START_FMT_GOP (1)
2053
2054 /* The structure must be zeroed before use by the application
2055 This ensures it can be extended safely in the future. */
2056 struct v4l2_decoder_cmd {
2057 __u32 cmd;
2058 __u32 flags;
2059 union {
2060 struct {
2061 __u64 pts;
2062 } stop;
2063
2064 struct {
2065 /* 0 or 1000 specifies normal speed,
2066 1 specifies forward single stepping,
2067 -1 specifies backward single stepping,
2068 >1: playback at speed/1000 of the normal speed,
2069 <-1: reverse playback at (-speed/1000) of the normal speed. */
2070 __s32 speed;
2071 __u32 format;
2072 } start;
2073
2074 struct {
2075 __u32 data[16];
2076 } raw;
2077 };
2078 };
2079 #endif
2080
2081
2082 /*
2083 * D A T A S E R V I C E S ( V B I )
2084 *
2085 * Data services API by Michael Schimek
2086 */
2087
2088 /* Raw VBI */
2089 struct v4l2_vbi_format {
2090 __u32 sampling_rate; /* in 1 Hz */
2091 __u32 offset;
2092 __u32 samples_per_line;
2093 __u32 sample_format; /* V4L2_PIX_FMT_* */
2094 __s32 start[2];
2095 __u32 count[2];
2096 __u32 flags; /* V4L2_VBI_* */
2097 __u32 reserved[2]; /* must be zero */
2098 };
2099
2100 /* VBI flags */
2101 #define V4L2_VBI_UNSYNC (1 << 0)
2102 #define V4L2_VBI_INTERLACED (1 << 1)
2103
2104 /* ITU-R start lines for each field */
2105 #define V4L2_VBI_ITU_525_F1_START (1)
2106 #define V4L2_VBI_ITU_525_F2_START (264)
2107 #define V4L2_VBI_ITU_625_F1_START (1)
2108 #define V4L2_VBI_ITU_625_F2_START (314)
2109
2110 /* Sliced VBI
2111 *
2112 * This implements is a proposal V4L2 API to allow SLICED VBI
2113 * required for some hardware encoders. It should change without
2114 * notice in the definitive implementation.
2115 */
2116
2117 struct v4l2_sliced_vbi_format {
2118 __u16 service_set;
2119 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2120 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2121 (equals frame lines 313-336 for 625 line video
2122 standards, 263-286 for 525 line standards) */
2123 __u16 service_lines[2][24];
2124 __u32 io_size;
2125 __u32 reserved[2]; /* must be zero */
2126 };
2127
2128 /* Teletext World System Teletext
2129 (WST), defined on ITU-R BT.653-2 */
2130 #define V4L2_SLICED_TELETEXT_B (0x0001)
2131 /* Video Program System, defined on ETS 300 231*/
2132 #define V4L2_SLICED_VPS (0x0400)
2133 /* Closed Caption, defined on EIA-608 */
2134 #define V4L2_SLICED_CAPTION_525 (0x1000)
2135 /* Wide Screen System, defined on ITU-R BT1119.1 */
2136 #define V4L2_SLICED_WSS_625 (0x4000)
2137
2138 #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
2139 #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
2140
2141 struct v4l2_sliced_vbi_cap {
2142 __u16 service_set;
2143 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2144 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2145 (equals frame lines 313-336 for 625 line video
2146 standards, 263-286 for 525 line standards) */
2147 __u16 service_lines[2][24];
2148 __u32 type; /* enum v4l2_buf_type */
2149 __u32 reserved[3]; /* must be 0 */
2150 };
2151
2152 struct v4l2_sliced_vbi_data {
2153 __u32 id;
2154 __u32 field; /* 0: first field, 1: second field */
2155 __u32 line; /* 1-23 */
2156 __u32 reserved; /* must be 0 */
2157 __u8 data[48];
2158 };
2159
2160 /*
2161 * Sliced VBI data inserted into MPEG Streams
2162 */
2163
2164 /*
2165 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
2166 *
2167 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
2168 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
2169 * data
2170 *
2171 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
2172 * definitions are not included here. See the MPEG-2 specifications for details
2173 * on these headers.
2174 */
2175
2176 /* Line type IDs */
2177 #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
2178 #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
2179 #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
2180 #define V4L2_MPEG_VBI_IVTV_VPS (7)
2181
2182 struct v4l2_mpeg_vbi_itv0_line {
2183 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
2184 __u8 data[42]; /* Sliced VBI data for the line */
2185 } __attribute__ ((packed));
2186
2187 struct v4l2_mpeg_vbi_itv0 {
2188 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
2189 struct v4l2_mpeg_vbi_itv0_line line[35];
2190 } __attribute__ ((packed));
2191
2192 struct v4l2_mpeg_vbi_ITV0 {
2193 struct v4l2_mpeg_vbi_itv0_line line[36];
2194 } __attribute__ ((packed));
2195
2196 #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
2197 #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
2198
2199 struct v4l2_mpeg_vbi_fmt_ivtv {
2200 __u8 magic[4];
2201 union {
2202 struct v4l2_mpeg_vbi_itv0 itv0;
2203 struct v4l2_mpeg_vbi_ITV0 ITV0;
2204 };
2205 } __attribute__ ((packed));
2206
2207 /*
2208 * A G G R E G A T E S T R U C T U R E S
2209 */
2210
2211 /**
2212 * struct v4l2_plane_pix_format - additional, per-plane format definition
2213 * @sizeimage: maximum size in bytes required for data, for which
2214 * this plane will be used
2215 * @bytesperline: distance in bytes between the leftmost pixels in two
2216 * adjacent lines
2217 */
2218 struct v4l2_plane_pix_format {
2219 __u32 sizeimage;
2220 __u32 bytesperline;
2221 __u16 reserved[6];
2222 } __attribute__ ((packed));
2223
2224 /**
2225 * struct v4l2_pix_format_mplane - multiplanar format definition
2226 * @width: image width in pixels
2227 * @height: image height in pixels
2228 * @pixelformat: little endian four character code (fourcc)
2229 * @field: enum v4l2_field; field order (for interlaced video)
2230 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
2231 * @plane_fmt: per-plane information
2232 * @num_planes: number of planes for this format
2233 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
2234 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
2235 * @quantization: enum v4l2_quantization, colorspace quantization
2236 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
2237 */
2238 struct v4l2_pix_format_mplane {
2239 __u32 width;
2240 __u32 height;
2241 __u32 pixelformat;
2242 __u32 field;
2243 __u32 colorspace;
2244
2245 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
2246 __u8 num_planes;
2247 __u8 flags;
2248 union {
2249 __u8 ycbcr_enc;
2250 __u8 hsv_enc;
2251 };
2252 __u8 quantization;
2253 __u8 xfer_func;
2254 __u8 reserved[7];
2255 } __attribute__ ((packed));
2256
2257 /**
2258 * struct v4l2_sdr_format - SDR format definition
2259 * @pixelformat: little endian four character code (fourcc)
2260 * @buffersize: maximum size in bytes required for data
2261 */
2262 struct v4l2_sdr_format {
2263 __u32 pixelformat;
2264 __u32 buffersize;
2265 __u8 reserved[24];
2266 } __attribute__ ((packed));
2267
2268 /**
2269 * struct v4l2_meta_format - metadata format definition
2270 * @dataformat: little endian four character code (fourcc)
2271 * @buffersize: maximum size in bytes required for data
2272 */
2273 struct v4l2_meta_format {
2274 __u32 dataformat;
2275 __u32 buffersize;
2276 } __attribute__ ((packed));
2277
2278 /**
2279 * struct v4l2_format - stream data format
2280 * @type: enum v4l2_buf_type; type of the data stream
2281 * @pix: definition of an image format
2282 * @pix_mp: definition of a multiplanar image format
2283 * @win: definition of an overlaid image
2284 * @vbi: raw VBI capture or output parameters
2285 * @sliced: sliced VBI capture or output parameters
2286 * @raw_data: placeholder for future extensions and custom formats
2287 */
2288 struct v4l2_format {
2289 __u32 type;
2290 union {
2291 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2292 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2293 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2294 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
2295 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
2296 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
2297 struct v4l2_meta_format meta; /* V4L2_BUF_TYPE_META_CAPTURE */
2298 __u8 raw_data[200]; /* user-defined */
2299 } fmt;
2300 };
2301
2302 /* Stream type-dependent parameters
2303 */
2304 struct v4l2_streamparm {
2305 __u32 type; /* enum v4l2_buf_type */
2306 union {
2307 struct v4l2_captureparm capture;
2308 struct v4l2_outputparm output;
2309 __u8 raw_data[200]; /* user-defined */
2310 } parm;
2311 };
2312
2313 /*
2314 * E V E N T S
2315 */
2316
2317 #define V4L2_EVENT_ALL 0
2318 #define V4L2_EVENT_VSYNC 1
2319 #define V4L2_EVENT_EOS 2
2320 #define V4L2_EVENT_CTRL 3
2321 #define V4L2_EVENT_FRAME_SYNC 4
2322 #define V4L2_EVENT_SOURCE_CHANGE 5
2323 #define V4L2_EVENT_MOTION_DET 6
2324 #define V4L2_EVENT_PRIVATE_START 0x08000000
2325
2326 /* Payload for V4L2_EVENT_VSYNC */
2327 struct v4l2_event_vsync {
2328 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2329 __u8 field;
2330 } __attribute__ ((packed));
2331
2332 /* Payload for V4L2_EVENT_CTRL */
2333 #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
2334 #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
2335 #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
2336
2337 struct v4l2_event_ctrl {
2338 __u32 changes;
2339 __u32 type;
2340 union {
2341 __s32 value;
2342 __s64 value64;
2343 };
2344 __u32 flags;
2345 __s32 minimum;
2346 __s32 maximum;
2347 __s32 step;
2348 __s32 default_value;
2349 };
2350
2351 struct v4l2_event_frame_sync {
2352 __u32 frame_sequence;
2353 };
2354
2355 #define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
2356
2357 struct v4l2_event_src_change {
2358 __u32 changes;
2359 };
2360
2361 #define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2362
2363 /**
2364 * struct v4l2_event_motion_det - motion detection event
2365 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2366 * frame_sequence field is valid.
2367 * @frame_sequence: the frame sequence number associated with this event.
2368 * @region_mask: which regions detected motion.
2369 */
2370 struct v4l2_event_motion_det {
2371 __u32 flags;
2372 __u32 frame_sequence;
2373 __u32 region_mask;
2374 };
2375
2376 struct v4l2_event {
2377 __u32 type;
2378 union {
2379 struct v4l2_event_vsync vsync;
2380 struct v4l2_event_ctrl ctrl;
2381 struct v4l2_event_frame_sync frame_sync;
2382 struct v4l2_event_src_change src_change;
2383 struct v4l2_event_motion_det motion_det;
2384 __u8 data[64];
2385 } u;
2386 __u32 pending;
2387 __u32 sequence;
2388 #ifdef __KERNEL__
2389 struct __kernel_timespec timestamp;
2390 #else
2391 struct timespec timestamp;
2392 #endif
2393 __u32 id;
2394 __u32 reserved[8];
2395 };
2396
2397 #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
2398 #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
2399
2400 struct v4l2_event_subscription {
2401 __u32 type;
2402 __u32 id;
2403 __u32 flags;
2404 __u32 reserved[5];
2405 };
2406
2407 /*
2408 * A D V A N C E D D E B U G G I N G
2409 *
2410 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2411 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2412 */
2413
2414 /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2415
2416 #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
2417 #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
2418
2419 /* The following four defines are no longer in use */
2420 #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2421 #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
2422 #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
2423 #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
2424
2425 struct v4l2_dbg_match {
2426 __u32 type; /* Match type */
2427 union { /* Match this chip, meaning determined by type */
2428 __u32 addr;
2429 char name[32];
2430 };
2431 } __attribute__ ((packed));
2432
2433 struct v4l2_dbg_register {
2434 struct v4l2_dbg_match match;
2435 __u32 size; /* register size in bytes */
2436 __u64 reg;
2437 __u64 val;
2438 } __attribute__ ((packed));
2439
2440 #define V4L2_CHIP_FL_READABLE (1 << 0)
2441 #define V4L2_CHIP_FL_WRITABLE (1 << 1)
2442
2443 /* VIDIOC_DBG_G_CHIP_INFO */
2444 struct v4l2_dbg_chip_info {
2445 struct v4l2_dbg_match match;
2446 char name[32];
2447 __u32 flags;
2448 __u32 reserved[32];
2449 } __attribute__ ((packed));
2450
2451 /**
2452 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2453 * @index: on return, index of the first created buffer
2454 * @count: entry: number of requested buffers,
2455 * return: number of created buffers
2456 * @memory: enum v4l2_memory; buffer memory type
2457 * @format: frame format, for which buffers are requested
2458 * @capabilities: capabilities of this buffer type.
2459 * @reserved: future extensions
2460 */
2461 struct v4l2_create_buffers {
2462 __u32 index;
2463 __u32 count;
2464 __u32 memory;
2465 struct v4l2_format format;
2466 __u32 capabilities;
2467 __u32 reserved[7];
2468 };
2469
2470 /*
2471 * 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
2472 *
2473 */
2474 #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
2475 #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
2476 #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
2477 #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
2478 #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
2479 #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
2480 #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
2481 #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
2482 #define VIDIOC_OVERLAY _IOW('V', 14, int)
2483 #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
2484 #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
2485 #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
2486 #define VIDIOC_STREAMON _IOW('V', 18, int)
2487 #define VIDIOC_STREAMOFF _IOW('V', 19, int)
2488 #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
2489 #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
2490 #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
2491 #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
2492 #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
2493 #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2494 #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2495 #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2496 #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2497 #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2498 #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2499 #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2500 #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2501 #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2502 #define VIDIOC_G_INPUT _IOR('V', 38, int)
2503 #define VIDIOC_S_INPUT _IOWR('V', 39, int)
2504 #define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2505 #define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
2506 #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2507 #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2508 #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2509 #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2510 #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2511 #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2512 #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2513 #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2514 #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2515 #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2516 #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2517 #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2518 #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2519 #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2520 #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2521 #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2522 #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2523 #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2524 #define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2525 #define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2526 #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2527 #define VIDIOC_LOG_STATUS _IO('V', 70)
2528 #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2529 #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2530 #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
2531 #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2532 #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2533 #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2534 #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2535 #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
2536
2537 /*
2538 * Experimental, meant for debugging, testing and internal use.
2539 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2540 * You must be root to use these ioctls. Never use these in applications!
2541 */
2542 #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2543 #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2544
2545 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2546 #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2547 #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2548 #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2549 #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2550 #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2551 #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2552 #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2553 #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2554 #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2555 #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2556 #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2557 #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2558 #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2559 #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2560 #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2561
2562 /*
2563 * Experimental, meant for debugging, testing and internal use.
2564 * Never use this in applications!
2565 */
2566 #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
2567
2568 #define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2569
2570 /* Reminder: when adding new ioctls please add support for them to
2571 drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
2572
2573 #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2574
2575 #endif /* _UAPI__LINUX_VIDEODEV2_H */
2576
