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