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