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