1/*
2 *  Video for Linux Two header file
3 *
4 *  Copyright (C) 1999-2012 the contributors
5 *  Copyright (c) 2016-2017, The Linux Foundation. All rights reserved.
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 http://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) | (1 << 31))
84
85/*
86 *	E N U M S
87 */
88enum 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
134enum v4l2_buf_type {
135	V4L2_BUF_TYPE_VIDEO_CAPTURE        = 1,
136	V4L2_BUF_TYPE_VIDEO_OUTPUT         = 2,
137	V4L2_BUF_TYPE_VIDEO_OVERLAY        = 3,
138	V4L2_BUF_TYPE_VBI_CAPTURE          = 4,
139	V4L2_BUF_TYPE_VBI_OUTPUT           = 5,
140	V4L2_BUF_TYPE_SLICED_VBI_CAPTURE   = 6,
141	V4L2_BUF_TYPE_SLICED_VBI_OUTPUT    = 7,
142#if 1
143	/* Experimental */
144	V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
145#endif
146	V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
147	V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE  = 10,
148	V4L2_BUF_TYPE_SDR_CAPTURE          = 11,
149	/* Deprecated, do not use */
150	V4L2_BUF_TYPE_PRIVATE              = 0x80,
151};
152
153#define V4L2_TYPE_IS_MULTIPLANAR(type)			\
154	((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE	\
155	 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
156
157#define V4L2_TYPE_IS_OUTPUT(type)				\
158	((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT			\
159	 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE		\
160	 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY		\
161	 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY	\
162	 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT			\
163	 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT)
164
165enum v4l2_tuner_type {
166	V4L2_TUNER_RADIO	     = 1,
167	V4L2_TUNER_ANALOG_TV	     = 2,
168	V4L2_TUNER_DIGITAL_TV	     = 3,
169	V4L2_TUNER_ADC               = 4,
170	V4L2_TUNER_RF                = 5,
171};
172
173enum v4l2_memory {
174	V4L2_MEMORY_MMAP             = 1,
175	V4L2_MEMORY_USERPTR          = 2,
176	V4L2_MEMORY_OVERLAY          = 3,
177	V4L2_MEMORY_DMABUF           = 4,
178};
179
180/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
181enum v4l2_colorspace {
182	/* ITU-R 601 -- broadcast NTSC/PAL */
183	V4L2_COLORSPACE_SMPTE170M     = 1,
184
185	/* 1125-Line (US) HDTV */
186	V4L2_COLORSPACE_SMPTE240M     = 2,
187
188	/* HD and modern captures. */
189	V4L2_COLORSPACE_REC709        = 3,
190
191	/* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
192	V4L2_COLORSPACE_BT878         = 4,
193
194	/* These should be useful.  Assume 601 extents. */
195	V4L2_COLORSPACE_470_SYSTEM_M  = 5,
196	V4L2_COLORSPACE_470_SYSTEM_BG = 6,
197
198	/* I know there will be cameras that send this.  So, this is
199	 * unspecified chromaticities and full 0-255 on each of the
200	 * Y'CbCr components
201	 */
202	V4L2_COLORSPACE_JPEG          = 7,
203
204	/* For RGB colourspaces, this is probably a good start. */
205	V4L2_COLORSPACE_SRGB          = 8,
206};
207
208enum v4l2_priority {
209	V4L2_PRIORITY_UNSET       = 0,  /* not initialized */
210	V4L2_PRIORITY_BACKGROUND  = 1,
211	V4L2_PRIORITY_INTERACTIVE = 2,
212	V4L2_PRIORITY_RECORD      = 3,
213	V4L2_PRIORITY_DEFAULT     = V4L2_PRIORITY_INTERACTIVE,
214};
215
216struct v4l2_rect {
217	__s32   left;
218	__s32   top;
219	__u32   width;
220	__u32   height;
221};
222
223struct v4l2_fract {
224	__u32   numerator;
225	__u32   denominator;
226};
227
228/**
229  * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
230  *
231  * @driver:	   name of the driver module (e.g. "bttv")
232  * @card:	   name of the card (e.g. "Hauppauge WinTV")
233  * @bus_info:	   name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
234  * @version:	   KERNEL_VERSION
235  * @capabilities: capabilities of the physical device as a whole
236  * @device_caps:  capabilities accessed via this particular device (node)
237  * @reserved:	   reserved fields for future extensions
238  */
239struct v4l2_capability {
240	__u8	driver[16];
241	__u8	card[32];
242	__u8	bus_info[32];
243	__u32   version;
244	__u32	capabilities;
245	__u32	device_caps;
246	__u32	reserved[3];
247};
248
249/* Values for 'capabilities' field */
250#define V4L2_CAP_VIDEO_CAPTURE		0x00000001  /* Is a video capture device */
251#define V4L2_CAP_VIDEO_OUTPUT		0x00000002  /* Is a video output device */
252#define V4L2_CAP_VIDEO_OVERLAY		0x00000004  /* Can do video overlay */
253#define V4L2_CAP_VBI_CAPTURE		0x00000010  /* Is a raw VBI capture device */
254#define V4L2_CAP_VBI_OUTPUT		0x00000020  /* Is a raw VBI output device */
255#define V4L2_CAP_SLICED_VBI_CAPTURE	0x00000040  /* Is a sliced VBI capture device */
256#define V4L2_CAP_SLICED_VBI_OUTPUT	0x00000080  /* Is a sliced VBI output device */
257#define V4L2_CAP_RDS_CAPTURE		0x00000100  /* RDS data capture */
258#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY	0x00000200  /* Can do video output overlay */
259#define V4L2_CAP_HW_FREQ_SEEK		0x00000400  /* Can do hardware frequency seek  */
260#define V4L2_CAP_RDS_OUTPUT		0x00000800  /* Is an RDS encoder */
261
262/* Is a video capture device that supports multiplanar formats */
263#define V4L2_CAP_VIDEO_CAPTURE_MPLANE	0x00001000
264/* Is a video output device that supports multiplanar formats */
265#define V4L2_CAP_VIDEO_OUTPUT_MPLANE	0x00002000
266/* Is a video mem-to-mem device that supports multiplanar formats */
267#define V4L2_CAP_VIDEO_M2M_MPLANE	0x00004000
268/* Is a video mem-to-mem device */
269#define V4L2_CAP_VIDEO_M2M		0x00008000
270
271#define V4L2_CAP_TUNER			0x00010000  /* has a tuner */
272#define V4L2_CAP_AUDIO			0x00020000  /* has audio support */
273#define V4L2_CAP_RADIO			0x00040000  /* is a radio device */
274#define V4L2_CAP_MODULATOR		0x00080000  /* has a modulator */
275
276#define V4L2_CAP_SDR_CAPTURE		0x00100000  /* Is a SDR capture device */
277#define V4L2_CAP_EXT_PIX_FORMAT		0x00200000  /* Supports the extended pixel format */
278
279#define V4L2_CAP_READWRITE              0x01000000  /* read/write systemcalls */
280#define V4L2_CAP_ASYNCIO                0x02000000  /* async I/O */
281#define V4L2_CAP_STREAMING              0x04000000  /* streaming I/O ioctls */
282
283#define V4L2_CAP_DEVICE_CAPS            0x80000000  /* sets device capabilities field */
284
285/*
286 *	V I D E O   I M A G E   F O R M A T
287 */
288struct v4l2_pix_format {
289	__u32         		width;
290	__u32			height;
291	__u32			pixelformat;
292	__u32			field;		/* enum v4l2_field */
293	__u32            	bytesperline;	/* for padding, zero if unused */
294	__u32          		sizeimage;
295	__u32			colorspace;	/* enum v4l2_colorspace */
296	__u32			priv;		/* private data, depends on pixelformat */
297	__u32			flags;		/* format flags (V4L2_PIX_FMT_FLAG_*) */
298};
299
300/*      Pixel format         FOURCC                          depth  Description  */
301
302/* RGB formats */
303#define V4L2_PIX_FMT_RGB332  v4l2_fourcc('R', 'G', 'B', '1') /*  8  RGB-3-3-2     */
304#define V4L2_PIX_FMT_RGB444  v4l2_fourcc('R', '4', '4', '4') /* 16  xxxxrrrr ggggbbbb */
305#define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16  aaaarrrr ggggbbbb */
306#define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16  xxxxrrrr ggggbbbb */
307#define V4L2_PIX_FMT_RGB555  v4l2_fourcc('R', 'G', 'B', 'O') /* 16  RGB-5-5-5     */
308#define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16  ARGB-1-5-5-5  */
309#define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16  XRGB-1-5-5-5  */
310#define V4L2_PIX_FMT_RGB565  v4l2_fourcc('R', 'G', 'B', 'P') /* 16  RGB-5-6-5     */
311#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16  RGB-5-5-5 BE  */
312#define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16  ARGB-5-5-5 BE */
313#define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16  XRGB-5-5-5 BE */
314#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16  RGB-5-6-5 BE  */
315#define V4L2_PIX_FMT_BGR666  v4l2_fourcc('B', 'G', 'R', 'H') /* 18  BGR-6-6-6	  */
316#define V4L2_PIX_FMT_BGR24   v4l2_fourcc('B', 'G', 'R', '3') /* 24  BGR-8-8-8     */
317#define V4L2_PIX_FMT_RGB24   v4l2_fourcc('R', 'G', 'B', '3') /* 24  RGB-8-8-8     */
318#define V4L2_PIX_FMT_BGR32   v4l2_fourcc('B', 'G', 'R', '4') /* 32  BGR-8-8-8-8   */
319#define V4L2_PIX_FMT_ABGR32  v4l2_fourcc('A', 'R', '2', '4') /* 32  BGRA-8-8-8-8  */
320#define V4L2_PIX_FMT_XBGR32  v4l2_fourcc('X', 'R', '2', '4') /* 32  BGRX-8-8-8-8  */
321#define V4L2_PIX_FMT_RGB32   v4l2_fourcc('R', 'G', 'B', '4') /* 32  RGB-8-8-8-8   */
322#define V4L2_PIX_FMT_ARGB32  v4l2_fourcc('B', 'A', '2', '4') /* 32  ARGB-8-8-8-8  */
323#define V4L2_PIX_FMT_XRGB32  v4l2_fourcc('B', 'X', '2', '4') /* 32  XRGB-8-8-8-8  */
324
325/* UBWC 32-bit RGBA8888 */
326#define V4L2_PIX_FMT_RGBA8888_UBWC   v4l2_fourcc('Q', 'R', 'G', 'B')
327
328/* Grey formats */
329#define V4L2_PIX_FMT_GREY    v4l2_fourcc('G', 'R', 'E', 'Y') /*  8  Greyscale     */
330#define V4L2_PIX_FMT_Y4      v4l2_fourcc('Y', '0', '4', ' ') /*  4  Greyscale     */
331#define V4L2_PIX_FMT_Y6      v4l2_fourcc('Y', '0', '6', ' ') /*  6  Greyscale     */
332#define V4L2_PIX_FMT_Y10     v4l2_fourcc('Y', '1', '0', ' ') /* 10  Greyscale     */
333#define V4L2_PIX_FMT_Y12     v4l2_fourcc('Y', '1', '2', ' ') /* 12  Greyscale     */
334#define V4L2_PIX_FMT_Y16     v4l2_fourcc('Y', '1', '6', ' ') /* 16  Greyscale     */
335
336/* Grey bit-packed formats */
337#define V4L2_PIX_FMT_Y10BPACK    v4l2_fourcc('Y', '1', '0', 'B') /* 10  Greyscale bit-packed */
338
339/* Palette formats */
340#define V4L2_PIX_FMT_PAL8    v4l2_fourcc('P', 'A', 'L', '8') /*  8  8-bit palette */
341
342/* Chrominance formats */
343#define V4L2_PIX_FMT_UV8     v4l2_fourcc('U', 'V', '8', ' ') /*  8  UV 4:4 */
344
345/* Luminance+Chrominance formats */
346#define V4L2_PIX_FMT_YVU410  v4l2_fourcc('Y', 'V', 'U', '9') /*  9  YVU 4:1:0     */
347#define V4L2_PIX_FMT_YVU420  v4l2_fourcc('Y', 'V', '1', '2') /* 12  YVU 4:2:0     */
348#define V4L2_PIX_FMT_YUYV    v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16  YUV 4:2:2     */
349#define V4L2_PIX_FMT_YYUV    v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16  YUV 4:2:2     */
350#define V4L2_PIX_FMT_YVYU    v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
351#define V4L2_PIX_FMT_UYVY    v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16  YUV 4:2:2     */
352#define V4L2_PIX_FMT_VYUY    v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16  YUV 4:2:2     */
353#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16  YVU422 planar */
354#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16  YVU411 planar */
355#define V4L2_PIX_FMT_Y41P    v4l2_fourcc('Y', '4', '1', 'P') /* 12  YUV 4:1:1     */
356#define V4L2_PIX_FMT_YUV444  v4l2_fourcc('Y', '4', '4', '4') /* 16  xxxxyyyy uuuuvvvv */
357#define V4L2_PIX_FMT_YUV555  v4l2_fourcc('Y', 'U', 'V', 'O') /* 16  YUV-5-5-5     */
358#define V4L2_PIX_FMT_YUV565  v4l2_fourcc('Y', 'U', 'V', 'P') /* 16  YUV-5-6-5     */
359#define V4L2_PIX_FMT_YUV32   v4l2_fourcc('Y', 'U', 'V', '4') /* 32  YUV-8-8-8-8   */
360#define V4L2_PIX_FMT_YUV410  v4l2_fourcc('Y', 'U', 'V', '9') /*  9  YUV 4:1:0     */
361#define V4L2_PIX_FMT_YUV420  v4l2_fourcc('Y', 'U', '1', '2') /* 12  YUV 4:2:0     */
362#define V4L2_PIX_FMT_HI240   v4l2_fourcc('H', 'I', '2', '4') /*  8  8-bit color   */
363#define V4L2_PIX_FMT_HM12    v4l2_fourcc('H', 'M', '1', '2') /*  8  YUV 4:2:0 16x16 macroblocks */
364#define V4L2_PIX_FMT_M420    v4l2_fourcc('M', '4', '2', '0') /* 12  YUV 4:2:0 2 lines y, 1 line uv interleaved */
365
366/* two planes -- one Y, one Cr + Cb interleaved  */
367#define V4L2_PIX_FMT_NV12    v4l2_fourcc('N', 'V', '1', '2') /* 12  Y/CbCr 4:2:0  */
368#define V4L2_PIX_FMT_NV21    v4l2_fourcc('N', 'V', '2', '1') /* 12  Y/CrCb 4:2:0  */
369#define V4L2_PIX_FMT_NV16    v4l2_fourcc('N', 'V', '1', '6') /* 16  Y/CbCr 4:2:2  */
370#define V4L2_PIX_FMT_NV61    v4l2_fourcc('N', 'V', '6', '1') /* 16  Y/CrCb 4:2:2  */
371#define V4L2_PIX_FMT_NV24    v4l2_fourcc('N', 'V', '2', '4') /* 24  Y/CbCr 4:4:4  */
372#define V4L2_PIX_FMT_NV42    v4l2_fourcc('N', 'V', '4', '2') /* 24  Y/CrCb 4:4:4  */
373
374/* UBWC 8-bit Y/CbCr 4:2:0  */
375#define V4L2_PIX_FMT_NV12_UBWC        v4l2_fourcc('Q', '1', '2', '8')
376/* UBWC 10-bit Y/CbCr 4:2:0 */
377#define V4L2_PIX_FMT_NV12_TP10_UBWC   v4l2_fourcc('Q', '1', '2', 'A')
378
379/* two non contiguous planes - one Y, one Cr + Cb interleaved  */
380#define V4L2_PIX_FMT_NV12M   v4l2_fourcc('N', 'M', '1', '2') /* 12  Y/CbCr 4:2:0  */
381#define V4L2_PIX_FMT_NV21M   v4l2_fourcc('N', 'M', '2', '1') /* 21  Y/CrCb 4:2:0  */
382#define V4L2_PIX_FMT_NV16M   v4l2_fourcc('N', 'M', '1', '6') /* 16  Y/CbCr 4:2:2  */
383#define V4L2_PIX_FMT_NV61M   v4l2_fourcc('N', 'M', '6', '1') /* 16  Y/CrCb 4:2:2  */
384#define V4L2_PIX_FMT_NV12MT  v4l2_fourcc('T', 'M', '1', '2') /* 12  Y/CbCr 4:2:0 64x32 macroblocks */
385#define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12  Y/CbCr 4:2:0 16x16 macroblocks */
386
387/* three non contiguous planes - Y, Cb, Cr */
388#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12  YUV420 planar */
389#define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12  YVU420 planar */
390
391/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
392#define V4L2_PIX_FMT_SBGGR8  v4l2_fourcc('B', 'A', '8', '1') /*  8  BGBG.. GRGR.. */
393#define V4L2_PIX_FMT_SGBRG8  v4l2_fourcc('G', 'B', 'R', 'G') /*  8  GBGB.. RGRG.. */
394#define V4L2_PIX_FMT_SGRBG8  v4l2_fourcc('G', 'R', 'B', 'G') /*  8  GRGR.. BGBG.. */
395#define V4L2_PIX_FMT_SRGGB8  v4l2_fourcc('R', 'G', 'G', 'B') /*  8  RGRG.. GBGB.. */
396#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10  BGBG.. GRGR.. */
397#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10  GBGB.. RGRG.. */
398#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10  GRGR.. BGBG.. */
399#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10  RGRG.. GBGB.. */
400#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12  BGBG.. GRGR.. */
401#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12  GBGB.. RGRG.. */
402#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12  GRGR.. BGBG.. */
403#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12  RGRG.. GBGB.. */
404#define V4L2_PIX_FMT_SBGGRPLAIN16 v4l2_fourcc('B', 'G', '1', '6')/*  16 BGBG.. GRGR.. */
405#define V4L2_PIX_FMT_SGBRGPLAIN16 v4l2_fourcc('G', 'B', '1', '6')/*  16 GBGB.. RGRG.. */
406#define V4L2_PIX_FMT_SGRBGPLAIN16 v4l2_fourcc('G', 'R', '1', '6')/*  16 GRGR.. BGBG.. */
407#define V4L2_PIX_FMT_SRGGBPLAIN16 v4l2_fourcc('R', 'G', '1', '6')/*  16 RGRG.. GBGB.. */
408	/* 10bit raw bayer a-law compressed to 8 bits */
409#define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
410#define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
411#define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
412#define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
413	/* 10bit raw bayer DPCM compressed to 8 bits */
414#define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
415#define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
416#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
417#define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
418	/* 10bit raw bayer DPCM compressed to 6 bits */
419#define V4L2_PIX_FMT_SBGGR10DPCM6 v4l2_fourcc('b', 'B', 'A', '6')
420#define V4L2_PIX_FMT_SGBRG10DPCM6 v4l2_fourcc('b', 'G', 'A', '6')
421#define V4L2_PIX_FMT_SGRBG10DPCM6 v4l2_fourcc('B', 'D', '1', '6')
422#define V4L2_PIX_FMT_SRGGB10DPCM6 v4l2_fourcc('b', 'R', 'A', '6')
423
424	/*
425	 * 10bit raw bayer, expanded to 16 bits
426	 * xxxxrrrrrrrrrrxxxxgggggggggg xxxxggggggggggxxxxbbbbbbbbbb...
427	 */
428#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16  BGBG.. GRGR.. */
429
430/* compressed formats */
431#define V4L2_PIX_FMT_MJPEG    v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG   */
432#define V4L2_PIX_FMT_JPEG     v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG     */
433#define V4L2_PIX_FMT_DV       v4l2_fourcc('d', 'v', 's', 'd') /* 1394          */
434#define V4L2_PIX_FMT_MPEG     v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
435#define V4L2_PIX_FMT_H264     v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
436#define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
437#define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
438#define V4L2_PIX_FMT_H263     v4l2_fourcc('H', '2', '6', '3') /* H263          */
439#define V4L2_PIX_FMT_MPEG1    v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES     */
440#define V4L2_PIX_FMT_MPEG2    v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES     */
441#define V4L2_PIX_FMT_MPEG4    v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
442#define V4L2_PIX_FMT_XVID     v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid           */
443#define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
444#define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
445#define V4L2_PIX_FMT_VP8      v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
446#define V4L2_PIX_FMT_VP9      v4l2_fourcc('V', 'P', '9', '0') /* VP9 */
447#define V4L2_PIX_FMT_DIVX_311  v4l2_fourcc('D', 'I', 'V', '3') /* DIVX311     */
448#define V4L2_PIX_FMT_DIVX      v4l2_fourcc('D', 'I', 'V', 'X') /* DIVX        */
449#define V4L2_PIX_FMT_HEVC v4l2_fourcc('H', 'E', 'V', 'C') /* for HEVC stream */
450#define V4L2_PIX_FMT_HEVC_HYBRID v4l2_fourcc('H', 'V', 'C', 'H')
451
452/*  Vendor-specific formats   */
453#define V4L2_PIX_FMT_CPIA1    v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
454#define V4L2_PIX_FMT_WNVA     v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
455#define V4L2_PIX_FMT_SN9C10X  v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
456#define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
457#define V4L2_PIX_FMT_PWC1     v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
458#define V4L2_PIX_FMT_PWC2     v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
459#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
460#define V4L2_PIX_FMT_SPCA501  v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
461#define V4L2_PIX_FMT_SPCA505  v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
462#define V4L2_PIX_FMT_SPCA508  v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
463#define V4L2_PIX_FMT_SPCA561  v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
464#define V4L2_PIX_FMT_PAC207   v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
465#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
466#define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
467#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
468#define V4L2_PIX_FMT_SQ905C   v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
469#define V4L2_PIX_FMT_PJPG     v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
470#define V4L2_PIX_FMT_OV511    v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
471#define V4L2_PIX_FMT_OV518    v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
472#define V4L2_PIX_FMT_STV0680  v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
473#define V4L2_PIX_FMT_TM6000   v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
474#define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
475#define V4L2_PIX_FMT_KONICA420  v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
476#define V4L2_PIX_FMT_JPGL	v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
477#define V4L2_PIX_FMT_SE401      v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
478#define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
479
480/* SDR formats - used only for Software Defined Radio devices */
481#define V4L2_SDR_FMT_CU8          v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
482#define V4L2_SDR_FMT_CU16LE       v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
483#define V4L2_SDR_FMT_CS8          v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
484#define V4L2_SDR_FMT_CS14LE       v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
485#define V4L2_SDR_FMT_RU12LE       v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
486
487/* priv field value to indicates that subsequent fields are valid. */
488#define V4L2_PIX_FMT_PRIV_MAGIC		0xfeedcafe
489
490/* Flags */
491#define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA	0x00000001
492
493/*
494 *	F O R M A T   E N U M E R A T I O N
495 */
496struct v4l2_fmtdesc {
497	__u32		    index;             /* Format number      */
498	__u32		    type;              /* enum v4l2_buf_type */
499	__u32               flags;
500	__u8		    description[32];   /* Description string */
501	__u32		    pixelformat;       /* Format fourcc      */
502	__u32		    reserved[4];
503};
504
505#define V4L2_FMT_FLAG_COMPRESSED 0x0001
506#define V4L2_FMT_FLAG_EMULATED   0x0002
507
508#if 1
509	/* Experimental Frame Size and frame rate enumeration */
510/*
511 *	F R A M E   S I Z E   E N U M E R A T I O N
512 */
513enum v4l2_frmsizetypes {
514	V4L2_FRMSIZE_TYPE_DISCRETE	= 1,
515	V4L2_FRMSIZE_TYPE_CONTINUOUS	= 2,
516	V4L2_FRMSIZE_TYPE_STEPWISE	= 3,
517};
518
519struct v4l2_frmsize_discrete {
520	__u32			width;		/* Frame width [pixel] */
521	__u32			height;		/* Frame height [pixel] */
522};
523
524struct v4l2_frmsize_stepwise {
525	__u32			min_width;	/* Minimum frame width [pixel] */
526	__u32			max_width;	/* Maximum frame width [pixel] */
527	__u32			step_width;	/* Frame width step size [pixel] */
528	__u32			min_height;	/* Minimum frame height [pixel] */
529	__u32			max_height;	/* Maximum frame height [pixel] */
530	__u32			step_height;	/* Frame height step size [pixel] */
531};
532
533struct v4l2_frmsizeenum {
534	__u32			index;		/* Frame size number */
535	__u32			pixel_format;	/* Pixel format */
536	__u32			type;		/* Frame size type the device supports. */
537
538	union {					/* Frame size */
539		struct v4l2_frmsize_discrete	discrete;
540		struct v4l2_frmsize_stepwise	stepwise;
541	};
542
543	__u32   reserved[2];			/* Reserved space for future use */
544};
545
546/*
547 *	F R A M E   R A T E   E N U M E R A T I O N
548 */
549enum v4l2_frmivaltypes {
550	V4L2_FRMIVAL_TYPE_DISCRETE	= 1,
551	V4L2_FRMIVAL_TYPE_CONTINUOUS	= 2,
552	V4L2_FRMIVAL_TYPE_STEPWISE	= 3,
553};
554
555struct v4l2_frmival_stepwise {
556	struct v4l2_fract	min;		/* Minimum frame interval [s] */
557	struct v4l2_fract	max;		/* Maximum frame interval [s] */
558	struct v4l2_fract	step;		/* Frame interval step size [s] */
559};
560
561struct v4l2_frmivalenum {
562	__u32			index;		/* Frame format index */
563	__u32			pixel_format;	/* Pixel format */
564	__u32			width;		/* Frame width */
565	__u32			height;		/* Frame height */
566	__u32			type;		/* Frame interval type the device supports. */
567
568	union {					/* Frame interval */
569		struct v4l2_fract		discrete;
570		struct v4l2_frmival_stepwise	stepwise;
571	};
572
573	__u32	reserved[2];			/* Reserved space for future use */
574};
575#endif
576
577/*
578 *	T I M E C O D E
579 */
580struct v4l2_timecode {
581	__u32	type;
582	__u32	flags;
583	__u8	frames;
584	__u8	seconds;
585	__u8	minutes;
586	__u8	hours;
587	__u8	userbits[4];
588};
589
590/*  Type  */
591#define V4L2_TC_TYPE_24FPS		1
592#define V4L2_TC_TYPE_25FPS		2
593#define V4L2_TC_TYPE_30FPS		3
594#define V4L2_TC_TYPE_50FPS		4
595#define V4L2_TC_TYPE_60FPS		5
596
597/*  Flags  */
598#define V4L2_TC_FLAG_DROPFRAME		0x0001 /* "drop-frame" mode */
599#define V4L2_TC_FLAG_COLORFRAME		0x0002
600#define V4L2_TC_USERBITS_field		0x000C
601#define V4L2_TC_USERBITS_USERDEFINED	0x0000
602#define V4L2_TC_USERBITS_8BITCHARS	0x0008
603/* The above is based on SMPTE timecodes */
604
605struct v4l2_jpegcompression {
606	int quality;
607
608	int  APPn;              /* Number of APP segment to be written,
609				 * must be 0..15 */
610	int  APP_len;           /* Length of data in JPEG APPn segment */
611	char APP_data[60];      /* Data in the JPEG APPn segment. */
612
613	int  COM_len;           /* Length of data in JPEG COM segment */
614	char COM_data[60];      /* Data in JPEG COM segment */
615
616	__u32 jpeg_markers;     /* Which markers should go into the JPEG
617				 * output. Unless you exactly know what
618				 * you do, leave them untouched.
619				 * Including less markers will make the
620				 * resulting code smaller, but there will
621				 * be fewer applications which can read it.
622				 * The presence of the APP and COM marker
623				 * is influenced by APP_len and COM_len
624				 * ONLY, not by this property! */
625
626#define V4L2_JPEG_MARKER_DHT (1<<3)    /* Define Huffman Tables */
627#define V4L2_JPEG_MARKER_DQT (1<<4)    /* Define Quantization Tables */
628#define V4L2_JPEG_MARKER_DRI (1<<5)    /* Define Restart Interval */
629#define V4L2_JPEG_MARKER_COM (1<<6)    /* Comment segment */
630#define V4L2_JPEG_MARKER_APP (1<<7)    /* App segment, driver will
631					* always use APP0 */
632};
633
634/*
635 *	M E M O R Y - M A P P I N G   B U F F E R S
636 */
637struct v4l2_requestbuffers {
638	__u32			count;
639	__u32			type;		/* enum v4l2_buf_type */
640	__u32			memory;		/* enum v4l2_memory */
641	__u32			reserved[2];
642};
643
644/**
645 * struct v4l2_plane - plane info for multi-planar buffers
646 * @bytesused:		number of bytes occupied by data in the plane (payload)
647 * @length:		size of this plane (NOT the payload) in bytes
648 * @mem_offset:		when memory in the associated struct v4l2_buffer is
649 *			V4L2_MEMORY_MMAP, equals the offset from the start of
650 *			the device memory for this plane (or is a "cookie" that
651 *			should be passed to mmap() called on the video node)
652 * @userptr:		when memory is V4L2_MEMORY_USERPTR, a userspace pointer
653 *			pointing to this plane
654 * @fd:			when memory is V4L2_MEMORY_DMABUF, a userspace file
655 *			descriptor associated with this plane
656 * @data_offset:	offset in the plane to the start of data; usually 0,
657 *			unless there is a header in front of the data
658 *
659 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
660 * with two planes can have one plane for Y, and another for interleaved CbCr
661 * components. Each plane can reside in a separate memory buffer, or even in
662 * a completely separate memory node (e.g. in embedded devices).
663 */
664struct v4l2_plane {
665	__u32			bytesused;
666	__u32			length;
667	union {
668		__u32		mem_offset;
669		unsigned long	userptr;
670		__s32		fd;
671	} m;
672	__u32			data_offset;
673	__u32			reserved[11];
674};
675
676/**
677 * struct v4l2_buffer - video buffer info
678 * @index:	id number of the buffer
679 * @type:	enum v4l2_buf_type; buffer type (type == *_MPLANE for
680 *		multiplanar buffers);
681 * @bytesused:	number of bytes occupied by data in the buffer (payload);
682 *		unused (set to 0) for multiplanar buffers
683 * @flags:	buffer informational flags
684 * @field:	enum v4l2_field; field order of the image in the buffer
685 * @timestamp:	frame timestamp
686 * @timecode:	frame timecode
687 * @sequence:	sequence count of this frame
688 * @memory:	enum v4l2_memory; the method, in which the actual video data is
689 *		passed
690 * @offset:	for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
691 *		offset from the start of the device memory for this plane,
692 *		(or a "cookie" that should be passed to mmap() as offset)
693 * @userptr:	for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
694 *		a userspace pointer pointing to this buffer
695 * @fd:		for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
696 *		a userspace file descriptor associated with this buffer
697 * @planes:	for multiplanar buffers; userspace pointer to the array of plane
698 *		info structs for this buffer
699 * @length:	size in bytes of the buffer (NOT its payload) for single-plane
700 *		buffers (when type != *_MPLANE); number of elements in the
701 *		planes array for multi-plane buffers
702 *
703 * Contains data exchanged by application and driver using one of the Streaming
704 * I/O methods.
705 */
706struct v4l2_buffer {
707	__u32			index;
708	__u32			type;
709	__u32			bytesused;
710	__u32			flags;
711	__u32			field;
712	struct timeval		timestamp;
713	struct v4l2_timecode	timecode;
714	__u32			sequence;
715
716	/* memory location */
717	__u32			memory;
718	union {
719		__u32           offset;
720		unsigned long   userptr;
721		struct v4l2_plane *planes;
722		__s32		fd;
723	} m;
724	__u32			length;
725	__u32			reserved2;
726	__u32			reserved;
727};
728
729/*  Flags for 'flags' field */
730/* Buffer is mapped (flag) */
731#define V4L2_BUF_FLAG_MAPPED			0x00000001
732/* Buffer is queued for processing */
733#define V4L2_BUF_FLAG_QUEUED			0x00000002
734/* Buffer is ready */
735#define V4L2_BUF_FLAG_DONE			0x00000004
736/* Image is a keyframe (I-frame) */
737#define V4L2_BUF_FLAG_KEYFRAME			0x00000008
738/* Image is a P-frame */
739#define V4L2_BUF_FLAG_PFRAME			0x00000010
740/* Image is a B-frame */
741#define V4L2_BUF_FLAG_BFRAME			0x00000020
742/* Buffer is ready, but the data contained within is corrupted. */
743#define V4L2_BUF_FLAG_ERROR			0x00000040
744/* timecode field is valid */
745#define V4L2_BUF_FLAG_TIMECODE			0x00000100
746/* Buffer is prepared for queuing */
747#define V4L2_BUF_FLAG_PREPARED			0x00000400
748/* Cache handling flags */
749#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE	0x00000800
750#define V4L2_BUF_FLAG_NO_CACHE_CLEAN		0x00001000
751/* Timestamp type */
752#define V4L2_BUF_FLAG_TIMESTAMP_MASK		0x0000e000
753#define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN		0x00000000
754#define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC	0x00002000
755#define V4L2_BUF_FLAG_TIMESTAMP_COPY		0x00004000
756/* Timestamp sources. */
757#define V4L2_BUF_FLAG_TSTAMP_SRC_MASK		0x00070000
758#define V4L2_BUF_FLAG_TSTAMP_SRC_EOF		0x00000000
759#define V4L2_BUF_FLAG_TSTAMP_SRC_SOE		0x00010000
760/* Vendor extensions */
761#define V4L2_QCOM_BUF_FLAG_CODECCONFIG		0x00020000
762#define V4L2_QCOM_BUF_FLAG_EOSEQ		0x00040000
763#define V4L2_QCOM_BUF_TIMESTAMP_INVALID		0x00080000
764#define V4L2_QCOM_BUF_FLAG_IDRFRAME		0x00100000
765#define V4L2_QCOM_BUF_FLAG_DECODEONLY		0x00200000
766#define V4L2_QCOM_BUF_DATA_CORRUPT		0x00400000
767#define V4L2_QCOM_BUF_DROP_FRAME		0x00800000
768#define V4L2_QCOM_BUF_INPUT_UNSUPPORTED		0x01000000
769#define V4L2_QCOM_BUF_FLAG_EOS			0x02000000
770#define V4L2_QCOM_BUF_FLAG_READONLY		0x04000000
771#define V4L2_MSM_VIDC_BUF_START_CODE_NOT_FOUND	0x08000000
772#define V4L2_MSM_BUF_FLAG_YUV_601_709_CLAMP	0x10000000
773#define V4L2_MSM_BUF_FLAG_MBAFF			0x20000000
774#define V4L2_MSM_BUF_FLAG_DEFER			0x40000000
775
776/**
777 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
778 *
779 * @index:	id number of the buffer
780 * @type:	enum v4l2_buf_type; buffer type (type == *_MPLANE for
781 *		multiplanar buffers);
782 * @plane:	index of the plane to be exported, 0 for single plane queues
783 * @flags:	flags for newly created file, currently only O_CLOEXEC is
784 *		supported, refer to manual of open syscall for more details
785 * @fd:		file descriptor associated with DMABUF (set by driver)
786 *
787 * Contains data used for exporting a video buffer as DMABUF file descriptor.
788 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
789 * (identical to the cookie used to mmap() the buffer to userspace). All
790 * reserved fields must be set to zero. The field reserved0 is expected to
791 * become a structure 'type' allowing an alternative layout of the structure
792 * content. Therefore this field should not be used for any other extensions.
793 */
794struct v4l2_exportbuffer {
795	__u32		type; /* enum v4l2_buf_type */
796	__u32		index;
797	__u32		plane;
798	__u32		flags;
799	__s32		fd;
800	__u32		reserved[11];
801};
802
803/*
804 *	O V E R L A Y   P R E V I E W
805 */
806struct v4l2_framebuffer {
807	__u32			capability;
808	__u32			flags;
809/* FIXME: in theory we should pass something like PCI device + memory
810 * region + offset instead of some physical address */
811	void                    *base;
812	struct {
813		__u32		width;
814		__u32		height;
815		__u32		pixelformat;
816		__u32		field;		/* enum v4l2_field */
817		__u32		bytesperline;	/* for padding, zero if unused */
818		__u32		sizeimage;
819		__u32		colorspace;	/* enum v4l2_colorspace */
820		__u32		priv;		/* reserved field, set to 0 */
821	} fmt;
822};
823/*  Flags for the 'capability' field. Read only */
824#define V4L2_FBUF_CAP_EXTERNOVERLAY	0x0001
825#define V4L2_FBUF_CAP_CHROMAKEY		0x0002
826#define V4L2_FBUF_CAP_LIST_CLIPPING     0x0004
827#define V4L2_FBUF_CAP_BITMAP_CLIPPING	0x0008
828#define V4L2_FBUF_CAP_LOCAL_ALPHA	0x0010
829#define V4L2_FBUF_CAP_GLOBAL_ALPHA	0x0020
830#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA	0x0040
831#define V4L2_FBUF_CAP_SRC_CHROMAKEY	0x0080
832/*  Flags for the 'flags' field. */
833#define V4L2_FBUF_FLAG_PRIMARY		0x0001
834#define V4L2_FBUF_FLAG_OVERLAY		0x0002
835#define V4L2_FBUF_FLAG_CHROMAKEY	0x0004
836#define V4L2_FBUF_FLAG_LOCAL_ALPHA	0x0008
837#define V4L2_FBUF_FLAG_GLOBAL_ALPHA	0x0010
838#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA	0x0020
839#define V4L2_FBUF_FLAG_SRC_CHROMAKEY	0x0040
840
841struct v4l2_clip {
842	struct v4l2_rect        c;
843	struct v4l2_clip	__user *next;
844};
845
846struct v4l2_window {
847	struct v4l2_rect        w;
848	__u32			field;	 /* enum v4l2_field */
849	__u32			chromakey;
850	struct v4l2_clip	__user *clips;
851	__u32			clipcount;
852	void			__user *bitmap;
853	__u8                    global_alpha;
854};
855
856/*
857 *	C A P T U R E   P A R A M E T E R S
858 */
859struct v4l2_captureparm {
860	__u32		   capability;	  /*  Supported modes */
861	__u32		   capturemode;	  /*  Current mode */
862	struct v4l2_fract  timeperframe;  /*  Time per frame in seconds */
863	__u32		   extendedmode;  /*  Driver-specific extensions */
864	__u32              readbuffers;   /*  # of buffers for read */
865	__u32		   reserved[4];
866};
867
868/*  Flags for 'capability' and 'capturemode' fields */
869#define V4L2_MODE_HIGHQUALITY	0x0001	/*  High quality imaging mode */
870#define V4L2_CAP_TIMEPERFRAME	0x1000	/*  timeperframe field is supported */
871#define V4L2_CAP_QCOM_FRAMESKIP	0x2000	/*  frame skipping is supported */
872
873struct v4l2_qcom_frameskip {
874	__u64		   maxframeinterval;
875	__u8		   fpsvariance;
876};
877
878struct v4l2_outputparm {
879	__u32		   capability;	 /*  Supported modes */
880	__u32		   outputmode;	 /*  Current mode */
881	struct v4l2_fract  timeperframe; /*  Time per frame in seconds */
882	__u32		   extendedmode; /*  Driver-specific extensions */
883	__u32              writebuffers; /*  # of buffers for write */
884	__u32		   reserved[4];
885};
886
887/*
888 *	I N P U T   I M A G E   C R O P P I N G
889 */
890struct v4l2_cropcap {
891	__u32			type;	/* enum v4l2_buf_type */
892	struct v4l2_rect        bounds;
893	struct v4l2_rect        defrect;
894	struct v4l2_fract       pixelaspect;
895};
896
897struct v4l2_crop {
898	__u32			type;	/* enum v4l2_buf_type */
899	struct v4l2_rect        c;
900};
901
902/**
903 * struct v4l2_selection - selection info
904 * @type:	buffer type (do not use *_MPLANE types)
905 * @target:	Selection target, used to choose one of possible rectangles;
906 *		defined in v4l2-common.h; V4L2_SEL_TGT_* .
907 * @flags:	constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
908 * @r:		coordinates of selection window
909 * @reserved:	for future use, rounds structure size to 64 bytes, set to zero
910 *
911 * Hardware may use multiple helper windows to process a video stream.
912 * The structure is used to exchange this selection areas between
913 * an application and a driver.
914 */
915struct v4l2_selection {
916	__u32			type;
917	__u32			target;
918	__u32                   flags;
919	struct v4l2_rect        r;
920	__u32                   reserved[9];
921};
922
923
924/*
925 *      A N A L O G   V I D E O   S T A N D A R D
926 */
927
928typedef __u64 v4l2_std_id;
929
930/* one bit for each */
931#define V4L2_STD_PAL_B          ((v4l2_std_id)0x00000001)
932#define V4L2_STD_PAL_B1         ((v4l2_std_id)0x00000002)
933#define V4L2_STD_PAL_G          ((v4l2_std_id)0x00000004)
934#define V4L2_STD_PAL_H          ((v4l2_std_id)0x00000008)
935#define V4L2_STD_PAL_I          ((v4l2_std_id)0x00000010)
936#define V4L2_STD_PAL_D          ((v4l2_std_id)0x00000020)
937#define V4L2_STD_PAL_D1         ((v4l2_std_id)0x00000040)
938#define V4L2_STD_PAL_K          ((v4l2_std_id)0x00000080)
939
940#define V4L2_STD_PAL_M          ((v4l2_std_id)0x00000100)
941#define V4L2_STD_PAL_N          ((v4l2_std_id)0x00000200)
942#define V4L2_STD_PAL_Nc         ((v4l2_std_id)0x00000400)
943#define V4L2_STD_PAL_60         ((v4l2_std_id)0x00000800)
944
945#define V4L2_STD_NTSC_M         ((v4l2_std_id)0x00001000)	/* BTSC */
946#define V4L2_STD_NTSC_M_JP      ((v4l2_std_id)0x00002000)	/* EIA-J */
947#define V4L2_STD_NTSC_443       ((v4l2_std_id)0x00004000)
948#define V4L2_STD_NTSC_M_KR      ((v4l2_std_id)0x00008000)	/* FM A2 */
949
950#define V4L2_STD_SECAM_B        ((v4l2_std_id)0x00010000)
951#define V4L2_STD_SECAM_D        ((v4l2_std_id)0x00020000)
952#define V4L2_STD_SECAM_G        ((v4l2_std_id)0x00040000)
953#define V4L2_STD_SECAM_H        ((v4l2_std_id)0x00080000)
954#define V4L2_STD_SECAM_K        ((v4l2_std_id)0x00100000)
955#define V4L2_STD_SECAM_K1       ((v4l2_std_id)0x00200000)
956#define V4L2_STD_SECAM_L        ((v4l2_std_id)0x00400000)
957#define V4L2_STD_SECAM_LC       ((v4l2_std_id)0x00800000)
958
959/* ATSC/HDTV */
960#define V4L2_STD_ATSC_8_VSB     ((v4l2_std_id)0x01000000)
961#define V4L2_STD_ATSC_16_VSB    ((v4l2_std_id)0x02000000)
962
963/* FIXME:
964   Although std_id is 64 bits, there is an issue on PPC32 architecture that
965   makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
966   this value to 32 bits.
967   As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
968   it should work fine. However, if needed to add more than two standards,
969   v4l2-common.c should be fixed.
970 */
971
972/*
973 * Some macros to merge video standards in order to make live easier for the
974 * drivers and V4L2 applications
975 */
976
977/*
978 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
979 * Missing here.
980 */
981#define V4L2_STD_NTSC           (V4L2_STD_NTSC_M	|\
982				 V4L2_STD_NTSC_M_JP     |\
983				 V4L2_STD_NTSC_M_KR)
984/* Secam macros */
985#define V4L2_STD_SECAM_DK      	(V4L2_STD_SECAM_D	|\
986				 V4L2_STD_SECAM_K	|\
987				 V4L2_STD_SECAM_K1)
988/* All Secam Standards */
989#define V4L2_STD_SECAM		(V4L2_STD_SECAM_B	|\
990				 V4L2_STD_SECAM_G	|\
991				 V4L2_STD_SECAM_H	|\
992				 V4L2_STD_SECAM_DK	|\
993				 V4L2_STD_SECAM_L       |\
994				 V4L2_STD_SECAM_LC)
995/* PAL macros */
996#define V4L2_STD_PAL_BG		(V4L2_STD_PAL_B		|\
997				 V4L2_STD_PAL_B1	|\
998				 V4L2_STD_PAL_G)
999#define V4L2_STD_PAL_DK		(V4L2_STD_PAL_D		|\
1000				 V4L2_STD_PAL_D1	|\
1001				 V4L2_STD_PAL_K)
1002/*
1003 * "Common" PAL - This macro is there to be compatible with the old
1004 * V4L1 concept of "PAL": /BGDKHI.
1005 * Several PAL standards are missing here: /M, /N and /Nc
1006 */
1007#define V4L2_STD_PAL		(V4L2_STD_PAL_BG	|\
1008				 V4L2_STD_PAL_DK	|\
1009				 V4L2_STD_PAL_H		|\
1010				 V4L2_STD_PAL_I)
1011/* Chroma "agnostic" standards */
1012#define V4L2_STD_B		(V4L2_STD_PAL_B		|\
1013				 V4L2_STD_PAL_B1	|\
1014				 V4L2_STD_SECAM_B)
1015#define V4L2_STD_G		(V4L2_STD_PAL_G		|\
1016				 V4L2_STD_SECAM_G)
1017#define V4L2_STD_H		(V4L2_STD_PAL_H		|\
1018				 V4L2_STD_SECAM_H)
1019#define V4L2_STD_L		(V4L2_STD_SECAM_L	|\
1020				 V4L2_STD_SECAM_LC)
1021#define V4L2_STD_GH		(V4L2_STD_G		|\
1022				 V4L2_STD_H)
1023#define V4L2_STD_DK		(V4L2_STD_PAL_DK	|\
1024				 V4L2_STD_SECAM_DK)
1025#define V4L2_STD_BG		(V4L2_STD_B		|\
1026				 V4L2_STD_G)
1027#define V4L2_STD_MN		(V4L2_STD_PAL_M		|\
1028				 V4L2_STD_PAL_N		|\
1029				 V4L2_STD_PAL_Nc	|\
1030				 V4L2_STD_NTSC)
1031
1032/* Standards where MTS/BTSC stereo could be found */
1033#define V4L2_STD_MTS		(V4L2_STD_NTSC_M	|\
1034				 V4L2_STD_PAL_M		|\
1035				 V4L2_STD_PAL_N		|\
1036				 V4L2_STD_PAL_Nc)
1037
1038/* Standards for Countries with 60Hz Line frequency */
1039#define V4L2_STD_525_60		(V4L2_STD_PAL_M		|\
1040				 V4L2_STD_PAL_60	|\
1041				 V4L2_STD_NTSC		|\
1042				 V4L2_STD_NTSC_443)
1043/* Standards for Countries with 50Hz Line frequency */
1044#define V4L2_STD_625_50		(V4L2_STD_PAL		|\
1045				 V4L2_STD_PAL_N		|\
1046				 V4L2_STD_PAL_Nc	|\
1047				 V4L2_STD_SECAM)
1048
1049#define V4L2_STD_ATSC           (V4L2_STD_ATSC_8_VSB    |\
1050				 V4L2_STD_ATSC_16_VSB)
1051/* Macros with none and all analog standards */
1052#define V4L2_STD_UNKNOWN        0
1053#define V4L2_STD_ALL            (V4L2_STD_525_60	|\
1054				 V4L2_STD_625_50)
1055
1056struct v4l2_standard {
1057	__u32		     index;
1058	v4l2_std_id          id;
1059	__u8		     name[24];
1060	struct v4l2_fract    frameperiod; /* Frames, not fields */
1061	__u32		     framelines;
1062	__u32		     reserved[4];
1063};
1064
1065/*
1066 *	D V 	B T	T I M I N G S
1067 */
1068
1069/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1070 * @width:	total width of the active video in pixels
1071 * @height:	total height of the active video in lines
1072 * @interlaced:	Interlaced or progressive
1073 * @polarities:	Positive or negative polarities
1074 * @pixelclock:	Pixel clock in HZ. Ex. 74.25MHz->74250000
1075 * @hfrontporch:Horizontal front porch in pixels
1076 * @hsync:	Horizontal Sync length in pixels
1077 * @hbackporch:	Horizontal back porch in pixels
1078 * @vfrontporch:Vertical front porch in lines
1079 * @vsync:	Vertical Sync length in lines
1080 * @vbackporch:	Vertical back porch in lines
1081 * @il_vfrontporch:Vertical front porch for the even field
1082 *		(aka field 2) of interlaced field formats
1083 * @il_vsync:	Vertical Sync length for the even field
1084 *		(aka field 2) of interlaced field formats
1085 * @il_vbackporch:Vertical back porch for the even field
1086 *		(aka field 2) of interlaced field formats
1087 * @standards:	Standards the timing belongs to
1088 * @flags:	Flags
1089 * @reserved:	Reserved fields, must be zeroed.
1090 *
1091 * A note regarding vertical interlaced timings: height refers to the total
1092 * height of the active video frame (= two fields). The blanking timings refer
1093 * to the blanking of each field. So the height of the total frame is
1094 * calculated as follows:
1095 *
1096 * tot_height = height + vfrontporch + vsync + vbackporch +
1097 *                       il_vfrontporch + il_vsync + il_vbackporch
1098 *
1099 * The active height of each field is height / 2.
1100 */
1101struct v4l2_bt_timings {
1102	__u32	width;
1103	__u32	height;
1104	__u32	interlaced;
1105	__u32	polarities;
1106	__u64	pixelclock;
1107	__u32	hfrontporch;
1108	__u32	hsync;
1109	__u32	hbackporch;
1110	__u32	vfrontporch;
1111	__u32	vsync;
1112	__u32	vbackporch;
1113	__u32	il_vfrontporch;
1114	__u32	il_vsync;
1115	__u32	il_vbackporch;
1116	__u32	standards;
1117	__u32	flags;
1118	__u32	reserved[14];
1119} __attribute__ ((packed));
1120
1121/* Interlaced or progressive format */
1122#define	V4L2_DV_PROGRESSIVE	0
1123#define	V4L2_DV_INTERLACED	1
1124
1125/* Polarities. If bit is not set, it is assumed to be negative polarity */
1126#define V4L2_DV_VSYNC_POS_POL	0x00000001
1127#define V4L2_DV_HSYNC_POS_POL	0x00000002
1128
1129/* Timings standards */
1130#define V4L2_DV_BT_STD_CEA861	(1 << 0)  /* CEA-861 Digital TV Profile */
1131#define V4L2_DV_BT_STD_DMT	(1 << 1)  /* VESA Discrete Monitor Timings */
1132#define V4L2_DV_BT_STD_CVT	(1 << 2)  /* VESA Coordinated Video Timings */
1133#define V4L2_DV_BT_STD_GTF	(1 << 3)  /* VESA Generalized Timings Formula */
1134
1135/* Flags */
1136
1137/* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1138   GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1139   intervals are reduced, allowing a higher resolution over the same
1140   bandwidth. This is a read-only flag. */
1141#define V4L2_DV_FL_REDUCED_BLANKING		(1 << 0)
1142/* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1143   of six. These formats can be optionally played at 1 / 1.001 speed.
1144   This is a read-only flag. */
1145#define V4L2_DV_FL_CAN_REDUCE_FPS		(1 << 1)
1146/* CEA-861 specific: only valid for video transmitters, the flag is cleared
1147   by receivers.
1148   If the framerate of the format is a multiple of six, then the pixelclock
1149   used to set up the transmitter is divided by 1.001 to make it compatible
1150   with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1151   29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1152   such frequencies, then the flag will also be cleared. */
1153#define V4L2_DV_FL_REDUCED_FPS			(1 << 2)
1154/* Specific to interlaced formats: if set, then field 1 is really one half-line
1155   longer and field 2 is really one half-line shorter, so each field has
1156   exactly the same number of half-lines. Whether half-lines can be detected
1157   or used depends on the hardware. */
1158#define V4L2_DV_FL_HALF_LINE			(1 << 3)
1159
1160/* A few useful defines to calculate the total blanking and frame sizes */
1161#define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1162	((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1163#define V4L2_DV_BT_FRAME_WIDTH(bt) \
1164	((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1165#define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1166	((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1167	 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
1168#define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1169	((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1170
1171/** struct v4l2_dv_timings - DV timings
1172 * @type:	the type of the timings
1173 * @bt:	BT656/1120 timings
1174 */
1175struct v4l2_dv_timings {
1176	__u32 type;
1177	union {
1178		struct v4l2_bt_timings	bt;
1179		__u32	reserved[32];
1180	};
1181} __attribute__ ((packed));
1182
1183/* Values for the type field */
1184#define V4L2_DV_BT_656_1120	0	/* BT.656/1120 timing type */
1185
1186
1187/** struct v4l2_enum_dv_timings - DV timings enumeration
1188 * @index:	enumeration index
1189 * @pad:	the pad number for which to enumerate timings (used with
1190 *		v4l-subdev nodes only)
1191 * @reserved:	must be zeroed
1192 * @timings:	the timings for the given index
1193 */
1194struct v4l2_enum_dv_timings {
1195	__u32 index;
1196	__u32 pad;
1197	__u32 reserved[2];
1198	struct v4l2_dv_timings timings;
1199};
1200
1201/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1202 * @min_width:		width in pixels
1203 * @max_width:		width in pixels
1204 * @min_height:		height in lines
1205 * @max_height:		height in lines
1206 * @min_pixelclock:	Pixel clock in HZ. Ex. 74.25MHz->74250000
1207 * @max_pixelclock:	Pixel clock in HZ. Ex. 74.25MHz->74250000
1208 * @standards:		Supported standards
1209 * @capabilities:	Supported capabilities
1210 * @reserved:		Must be zeroed
1211 */
1212struct v4l2_bt_timings_cap {
1213	__u32	min_width;
1214	__u32	max_width;
1215	__u32	min_height;
1216	__u32	max_height;
1217	__u64	min_pixelclock;
1218	__u64	max_pixelclock;
1219	__u32	standards;
1220	__u32	capabilities;
1221	__u32	reserved[16];
1222} __attribute__ ((packed));
1223
1224/* Supports interlaced formats */
1225#define V4L2_DV_BT_CAP_INTERLACED	(1 << 0)
1226/* Supports progressive formats */
1227#define V4L2_DV_BT_CAP_PROGRESSIVE	(1 << 1)
1228/* Supports CVT/GTF reduced blanking */
1229#define V4L2_DV_BT_CAP_REDUCED_BLANKING	(1 << 2)
1230/* Supports custom formats */
1231#define V4L2_DV_BT_CAP_CUSTOM		(1 << 3)
1232
1233/** struct v4l2_dv_timings_cap - DV timings capabilities
1234 * @type:	the type of the timings (same as in struct v4l2_dv_timings)
1235 * @pad:	the pad number for which to query capabilities (used with
1236 *		v4l-subdev nodes only)
1237 * @bt:		the BT656/1120 timings capabilities
1238 */
1239struct v4l2_dv_timings_cap {
1240	__u32 type;
1241	__u32 pad;
1242	__u32 reserved[2];
1243	union {
1244		struct v4l2_bt_timings_cap bt;
1245		__u32 raw_data[32];
1246	};
1247};
1248
1249
1250/*
1251 *	V I D E O   I N P U T S
1252 */
1253struct v4l2_input {
1254	__u32	     index;		/*  Which input */
1255	__u8	     name[32];		/*  Label */
1256	__u32	     type;		/*  Type of input */
1257	__u32	     audioset;		/*  Associated audios (bitfield) */
1258	__u32        tuner;             /*  enum v4l2_tuner_type */
1259	v4l2_std_id  std;
1260	__u32	     status;
1261	__u32	     capabilities;
1262	__u32	     reserved[3];
1263};
1264
1265/*  Values for the 'type' field */
1266#define V4L2_INPUT_TYPE_TUNER		1
1267#define V4L2_INPUT_TYPE_CAMERA		2
1268
1269/* field 'status' - general */
1270#define V4L2_IN_ST_NO_POWER    0x00000001  /* Attached device is off */
1271#define V4L2_IN_ST_NO_SIGNAL   0x00000002
1272#define V4L2_IN_ST_NO_COLOR    0x00000004
1273
1274/* field 'status' - sensor orientation */
1275/* If sensor is mounted upside down set both bits */
1276#define V4L2_IN_ST_HFLIP       0x00000010 /* Frames are flipped horizontally */
1277#define V4L2_IN_ST_VFLIP       0x00000020 /* Frames are flipped vertically */
1278
1279/* field 'status' - analog */
1280#define V4L2_IN_ST_NO_H_LOCK   0x00000100  /* No horizontal sync lock */
1281#define V4L2_IN_ST_COLOR_KILL  0x00000200  /* Color killer is active */
1282
1283/* field 'status' - digital */
1284#define V4L2_IN_ST_NO_SYNC     0x00010000  /* No synchronization lock */
1285#define V4L2_IN_ST_NO_EQU      0x00020000  /* No equalizer lock */
1286#define V4L2_IN_ST_NO_CARRIER  0x00040000  /* Carrier recovery failed */
1287
1288/* field 'status' - VCR and set-top box */
1289#define V4L2_IN_ST_MACROVISION 0x01000000  /* Macrovision detected */
1290#define V4L2_IN_ST_NO_ACCESS   0x02000000  /* Conditional access denied */
1291#define V4L2_IN_ST_VTR         0x04000000  /* VTR time constant */
1292
1293/* capabilities flags */
1294#define V4L2_IN_CAP_DV_TIMINGS		0x00000002 /* Supports S_DV_TIMINGS */
1295#define V4L2_IN_CAP_CUSTOM_TIMINGS	V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1296#define V4L2_IN_CAP_STD			0x00000004 /* Supports S_STD */
1297
1298/*
1299 *	V I D E O   O U T P U T S
1300 */
1301struct v4l2_output {
1302	__u32	     index;		/*  Which output */
1303	__u8	     name[32];		/*  Label */
1304	__u32	     type;		/*  Type of output */
1305	__u32	     audioset;		/*  Associated audios (bitfield) */
1306	__u32	     modulator;         /*  Associated modulator */
1307	v4l2_std_id  std;
1308	__u32	     capabilities;
1309	__u32	     reserved[3];
1310};
1311/*  Values for the 'type' field */
1312#define V4L2_OUTPUT_TYPE_MODULATOR		1
1313#define V4L2_OUTPUT_TYPE_ANALOG			2
1314#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY	3
1315
1316/* capabilities flags */
1317#define V4L2_OUT_CAP_DV_TIMINGS		0x00000002 /* Supports S_DV_TIMINGS */
1318#define V4L2_OUT_CAP_CUSTOM_TIMINGS	V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1319#define V4L2_OUT_CAP_STD		0x00000004 /* Supports S_STD */
1320
1321/*
1322 *	C O N T R O L S
1323 */
1324struct v4l2_control {
1325	__u32		     id;
1326	__s32		     value;
1327};
1328
1329struct v4l2_ext_control {
1330	__u32 id;
1331	__u32 size;
1332	__u32 reserved2[1];
1333	union {
1334		__s32 value;
1335		__s64 value64;
1336		char __user *string;
1337		__u8 __user *p_u8;
1338		__u16 __user *p_u16;
1339		__u32 __user *p_u32;
1340		void __user *ptr;
1341	};
1342} __attribute__ ((packed));
1343
1344struct v4l2_ext_controls {
1345	__u32 ctrl_class;
1346	__u32 count;
1347	__u32 error_idx;
1348	__u32 reserved[2];
1349	struct v4l2_ext_control *controls;
1350};
1351
1352#define V4L2_CTRL_ID_MASK      	  (0x0fffffff)
1353#define V4L2_CTRL_ID2CLASS(id)    ((id) & 0x0fff0000UL)
1354#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1355#define V4L2_CTRL_MAX_DIMS	  (4)
1356
1357enum v4l2_ctrl_type {
1358	V4L2_CTRL_TYPE_INTEGER	     = 1,
1359	V4L2_CTRL_TYPE_BOOLEAN	     = 2,
1360	V4L2_CTRL_TYPE_MENU	     = 3,
1361	V4L2_CTRL_TYPE_BUTTON	     = 4,
1362	V4L2_CTRL_TYPE_INTEGER64     = 5,
1363	V4L2_CTRL_TYPE_CTRL_CLASS    = 6,
1364	V4L2_CTRL_TYPE_STRING        = 7,
1365	V4L2_CTRL_TYPE_BITMASK       = 8,
1366	V4L2_CTRL_TYPE_INTEGER_MENU  = 9,
1367
1368	/* Compound types are >= 0x0100 */
1369	V4L2_CTRL_COMPOUND_TYPES     = 0x0100,
1370	V4L2_CTRL_TYPE_U8	     = 0x0100,
1371	V4L2_CTRL_TYPE_U16	     = 0x0101,
1372	V4L2_CTRL_TYPE_U32	     = 0x0102,
1373};
1374
1375/*  Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1376struct v4l2_queryctrl {
1377	__u32		     id;
1378	__u32		     type;	/* enum v4l2_ctrl_type */
1379	__u8		     name[32];	/* Whatever */
1380	__s32		     minimum;	/* Note signedness */
1381	__s32		     maximum;
1382	__s32		     step;
1383	__s32		     default_value;
1384	__u32                flags;
1385	__u32		     reserved[2];
1386};
1387
1388/*  Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1389struct v4l2_query_ext_ctrl {
1390	__u32		     id;
1391	__u32		     type;
1392	char		     name[32];
1393	__s64		     minimum;
1394	__s64		     maximum;
1395	__u64		     step;
1396	__s64		     default_value;
1397	__u32                flags;
1398	__u32                elem_size;
1399	__u32                elems;
1400	__u32                nr_of_dims;
1401	__u32                dims[V4L2_CTRL_MAX_DIMS];
1402	__u32		     reserved[32];
1403};
1404
1405/*  Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1406struct v4l2_querymenu {
1407	__u32		id;
1408	__u32		index;
1409	union {
1410		__u8	name[32];	/* Whatever */
1411		__s64	value;
1412	};
1413	__u32		reserved;
1414} __attribute__ ((packed));
1415
1416/*  Control flags  */
1417#define V4L2_CTRL_FLAG_DISABLED		0x0001
1418#define V4L2_CTRL_FLAG_GRABBED		0x0002
1419#define V4L2_CTRL_FLAG_READ_ONLY 	0x0004
1420#define V4L2_CTRL_FLAG_UPDATE 		0x0008
1421#define V4L2_CTRL_FLAG_INACTIVE 	0x0010
1422#define V4L2_CTRL_FLAG_SLIDER 		0x0020
1423#define V4L2_CTRL_FLAG_WRITE_ONLY 	0x0040
1424#define V4L2_CTRL_FLAG_VOLATILE		0x0080
1425#define V4L2_CTRL_FLAG_HAS_PAYLOAD	0x0100
1426
1427/*  Query flags, to be ORed with the control ID */
1428#define V4L2_CTRL_FLAG_NEXT_CTRL	0x80000000
1429#define V4L2_CTRL_FLAG_NEXT_COMPOUND	0x40000000
1430
1431/*  User-class control IDs defined by V4L2 */
1432#define V4L2_CID_MAX_CTRLS		1024
1433/*  IDs reserved for driver specific controls */
1434#define V4L2_CID_PRIVATE_BASE		0x08000000
1435
1436
1437/*
1438 *	T U N I N G
1439 */
1440struct v4l2_tuner {
1441	__u32                   index;
1442	__u8			name[32];
1443	__u32			type;	/* enum v4l2_tuner_type */
1444	__u32			capability;
1445	__u32			rangelow;
1446	__u32			rangehigh;
1447	__u32			rxsubchans;
1448	__u32			audmode;
1449	__s32			signal;
1450	__s32			afc;
1451	__u32			reserved[4];
1452};
1453
1454struct v4l2_modulator {
1455	__u32			index;
1456	__u8			name[32];
1457	__u32			capability;
1458	__u32			rangelow;
1459	__u32			rangehigh;
1460	__u32			txsubchans;
1461	__u32			reserved[4];
1462};
1463
1464/*  Flags for the 'capability' field */
1465#define V4L2_TUNER_CAP_LOW		0x0001
1466#define V4L2_TUNER_CAP_NORM		0x0002
1467#define V4L2_TUNER_CAP_HWSEEK_BOUNDED	0x0004
1468#define V4L2_TUNER_CAP_HWSEEK_WRAP	0x0008
1469#define V4L2_TUNER_CAP_STEREO		0x0010
1470#define V4L2_TUNER_CAP_LANG2		0x0020
1471#define V4L2_TUNER_CAP_SAP		0x0020
1472#define V4L2_TUNER_CAP_LANG1		0x0040
1473#define V4L2_TUNER_CAP_RDS		0x0080
1474#define V4L2_TUNER_CAP_RDS_BLOCK_IO	0x0100
1475#define V4L2_TUNER_CAP_RDS_CONTROLS	0x0200
1476#define V4L2_TUNER_CAP_FREQ_BANDS	0x0400
1477#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM	0x0800
1478#define V4L2_TUNER_CAP_1HZ		0x1000
1479
1480/*  Flags for the 'rxsubchans' field */
1481#define V4L2_TUNER_SUB_MONO		0x0001
1482#define V4L2_TUNER_SUB_STEREO		0x0002
1483#define V4L2_TUNER_SUB_LANG2		0x0004
1484#define V4L2_TUNER_SUB_SAP		0x0004
1485#define V4L2_TUNER_SUB_LANG1		0x0008
1486#define V4L2_TUNER_SUB_RDS		0x0010
1487
1488/*  Values for the 'audmode' field */
1489#define V4L2_TUNER_MODE_MONO		0x0000
1490#define V4L2_TUNER_MODE_STEREO		0x0001
1491#define V4L2_TUNER_MODE_LANG2		0x0002
1492#define V4L2_TUNER_MODE_SAP		0x0002
1493#define V4L2_TUNER_MODE_LANG1		0x0003
1494#define V4L2_TUNER_MODE_LANG1_LANG2	0x0004
1495
1496struct v4l2_frequency {
1497	__u32	tuner;
1498	__u32	type;	/* enum v4l2_tuner_type */
1499	__u32	frequency;
1500	__u32	reserved[8];
1501};
1502
1503#define V4L2_BAND_MODULATION_VSB	(1 << 1)
1504#define V4L2_BAND_MODULATION_FM		(1 << 2)
1505#define V4L2_BAND_MODULATION_AM		(1 << 3)
1506
1507struct v4l2_frequency_band {
1508	__u32	tuner;
1509	__u32	type;	/* enum v4l2_tuner_type */
1510	__u32	index;
1511	__u32	capability;
1512	__u32	rangelow;
1513	__u32	rangehigh;
1514	__u32	modulation;
1515	__u32	reserved[9];
1516};
1517
1518struct v4l2_hw_freq_seek {
1519	__u32	tuner;
1520	__u32	type;	/* enum v4l2_tuner_type */
1521	__u32	seek_upward;
1522	__u32	wrap_around;
1523	__u32	spacing;
1524	__u32	rangelow;
1525	__u32	rangehigh;
1526	__u32	reserved[5];
1527};
1528
1529/*
1530 *	R D S
1531 */
1532
1533struct v4l2_rds_data {
1534	__u8 	lsb;
1535	__u8 	msb;
1536	__u8 	block;
1537} __attribute__ ((packed));
1538
1539#define V4L2_RDS_BLOCK_MSK 	 0x7
1540#define V4L2_RDS_BLOCK_A 	 0
1541#define V4L2_RDS_BLOCK_B 	 1
1542#define V4L2_RDS_BLOCK_C 	 2
1543#define V4L2_RDS_BLOCK_D 	 3
1544#define V4L2_RDS_BLOCK_C_ALT 	 4
1545#define V4L2_RDS_BLOCK_INVALID 	 7
1546
1547#define V4L2_RDS_BLOCK_CORRECTED 0x40
1548#define V4L2_RDS_BLOCK_ERROR 	 0x80
1549
1550/*
1551 *	A U D I O
1552 */
1553struct v4l2_audio {
1554	__u32	index;
1555	__u8	name[32];
1556	__u32	capability;
1557	__u32	mode;
1558	__u32	reserved[2];
1559};
1560
1561/*  Flags for the 'capability' field */
1562#define V4L2_AUDCAP_STEREO		0x00001
1563#define V4L2_AUDCAP_AVL			0x00002
1564
1565/*  Flags for the 'mode' field */
1566#define V4L2_AUDMODE_AVL		0x00001
1567
1568struct v4l2_audioout {
1569	__u32	index;
1570	__u8	name[32];
1571	__u32	capability;
1572	__u32	mode;
1573	__u32	reserved[2];
1574};
1575
1576/*
1577 *	M P E G   S E R V I C E S
1578 *
1579 *	NOTE: EXPERIMENTAL API
1580 */
1581#if 1
1582#define V4L2_ENC_IDX_FRAME_I    (0)
1583#define V4L2_ENC_IDX_FRAME_P    (1)
1584#define V4L2_ENC_IDX_FRAME_B    (2)
1585#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1586
1587struct v4l2_enc_idx_entry {
1588	__u64 offset;
1589	__u64 pts;
1590	__u32 length;
1591	__u32 flags;
1592	__u32 reserved[2];
1593};
1594
1595#define V4L2_ENC_IDX_ENTRIES (64)
1596struct v4l2_enc_idx {
1597	__u32 entries;
1598	__u32 entries_cap;
1599	__u32 reserved[4];
1600	struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1601};
1602
1603
1604#define V4L2_ENC_CMD_START      (0)
1605#define V4L2_ENC_CMD_STOP       (1)
1606#define V4L2_ENC_CMD_PAUSE      (2)
1607#define V4L2_ENC_CMD_RESUME     (3)
1608#define V4L2_ENC_QCOM_CMD_FLUSH  (4)
1609
1610/* Flags for V4L2_ENC_CMD_STOP */
1611#define V4L2_ENC_CMD_STOP_AT_GOP_END    (1 << 0)
1612
1613struct v4l2_encoder_cmd {
1614	__u32 cmd;
1615	__u32 flags;
1616	union {
1617		struct {
1618			__u32 data[8];
1619		} raw;
1620	};
1621};
1622
1623/* Decoder commands */
1624#define V4L2_DEC_CMD_START       (0)
1625#define V4L2_DEC_CMD_STOP        (1)
1626#define V4L2_DEC_CMD_PAUSE       (2)
1627#define V4L2_DEC_CMD_RESUME      (3)
1628#define V4L2_DEC_QCOM_CMD_FLUSH  (4)
1629#define V4L2_DEC_QCOM_CMD_RECONFIG_HINT  (5)
1630
1631/* Flags for V4L2_DEC_CMD_START */
1632#define V4L2_DEC_CMD_START_MUTE_AUDIO	(1 << 0)
1633
1634/* Flags for V4L2_DEC_CMD_PAUSE */
1635#define V4L2_DEC_CMD_PAUSE_TO_BLACK	(1 << 0)
1636
1637/* Flags for V4L2_DEC_CMD_STOP */
1638#define V4L2_DEC_CMD_STOP_TO_BLACK	(1 << 0)
1639#define V4L2_DEC_CMD_STOP_IMMEDIATELY	(1 << 1)
1640
1641/* Flags for V4L2_DEC_QCOM_CMD_FLUSH */
1642#define V4L2_DEC_QCOM_CMD_FLUSH_OUTPUT  (1 << 0)
1643#define V4L2_DEC_QCOM_CMD_FLUSH_CAPTURE (1 << 1)
1644
1645#define V4L2_QCOM_CMD_FLUSH_OUTPUT  (1 << 0)
1646#define V4L2_QCOM_CMD_FLUSH_CAPTURE (1 << 1)
1647
1648/* Play format requirements (returned by the driver): */
1649
1650/* The decoder has no special format requirements */
1651#define V4L2_DEC_START_FMT_NONE		(0)
1652/* The decoder requires full GOPs */
1653#define V4L2_DEC_START_FMT_GOP		(1)
1654
1655/* The structure must be zeroed before use by the application
1656   This ensures it can be extended safely in the future. */
1657struct v4l2_decoder_cmd {
1658	__u32 cmd;
1659	__u32 flags;
1660	union {
1661		struct {
1662			__u64 pts;
1663		} stop;
1664
1665		struct {
1666			/* 0 or 1000 specifies normal speed,
1667			   1 specifies forward single stepping,
1668			   -1 specifies backward single stepping,
1669			   >1: playback at speed/1000 of the normal speed,
1670			   <-1: reverse playback at (-speed/1000) of the normal speed. */
1671			__s32 speed;
1672			__u32 format;
1673		} start;
1674
1675		struct {
1676			__u32 data[16];
1677		} raw;
1678	};
1679};
1680#endif
1681
1682
1683/*
1684 *	D A T A   S E R V I C E S   ( V B I )
1685 *
1686 *	Data services API by Michael Schimek
1687 */
1688
1689/* Raw VBI */
1690struct v4l2_vbi_format {
1691	__u32	sampling_rate;		/* in 1 Hz */
1692	__u32	offset;
1693	__u32	samples_per_line;
1694	__u32	sample_format;		/* V4L2_PIX_FMT_* */
1695	__s32	start[2];
1696	__u32	count[2];
1697	__u32	flags;			/* V4L2_VBI_* */
1698	__u32	reserved[2];		/* must be zero */
1699};
1700
1701/*  VBI flags  */
1702#define V4L2_VBI_UNSYNC		(1 << 0)
1703#define V4L2_VBI_INTERLACED	(1 << 1)
1704
1705/* ITU-R start lines for each field */
1706#define V4L2_VBI_ITU_525_F1_START (1)
1707#define V4L2_VBI_ITU_525_F2_START (264)
1708#define V4L2_VBI_ITU_625_F1_START (1)
1709#define V4L2_VBI_ITU_625_F2_START (314)
1710
1711/* Sliced VBI
1712 *
1713 *    This implements is a proposal V4L2 API to allow SLICED VBI
1714 * required for some hardware encoders. It should change without
1715 * notice in the definitive implementation.
1716 */
1717
1718struct v4l2_sliced_vbi_format {
1719	__u16   service_set;
1720	/* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1721	   service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1722				 (equals frame lines 313-336 for 625 line video
1723				  standards, 263-286 for 525 line standards) */
1724	__u16   service_lines[2][24];
1725	__u32   io_size;
1726	__u32   reserved[2];            /* must be zero */
1727};
1728
1729/* Teletext World System Teletext
1730   (WST), defined on ITU-R BT.653-2 */
1731#define V4L2_SLICED_TELETEXT_B          (0x0001)
1732/* Video Program System, defined on ETS 300 231*/
1733#define V4L2_SLICED_VPS                 (0x0400)
1734/* Closed Caption, defined on EIA-608 */
1735#define V4L2_SLICED_CAPTION_525         (0x1000)
1736/* Wide Screen System, defined on ITU-R BT1119.1 */
1737#define V4L2_SLICED_WSS_625             (0x4000)
1738
1739#define V4L2_SLICED_VBI_525             (V4L2_SLICED_CAPTION_525)
1740#define V4L2_SLICED_VBI_625             (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1741
1742struct v4l2_sliced_vbi_cap {
1743	__u16   service_set;
1744	/* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1745	   service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1746				 (equals frame lines 313-336 for 625 line video
1747				  standards, 263-286 for 525 line standards) */
1748	__u16   service_lines[2][24];
1749	__u32	type;		/* enum v4l2_buf_type */
1750	__u32   reserved[3];    /* must be 0 */
1751};
1752
1753struct v4l2_sliced_vbi_data {
1754	__u32   id;
1755	__u32   field;          /* 0: first field, 1: second field */
1756	__u32   line;           /* 1-23 */
1757	__u32   reserved;       /* must be 0 */
1758	__u8    data[48];
1759};
1760
1761/*
1762 * Sliced VBI data inserted into MPEG Streams
1763 */
1764
1765/*
1766 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1767 *
1768 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1769 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1770 * data
1771 *
1772 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1773 * definitions are not included here.  See the MPEG-2 specifications for details
1774 * on these headers.
1775 */
1776
1777/* Line type IDs */
1778#define V4L2_MPEG_VBI_IVTV_TELETEXT_B     (1)
1779#define V4L2_MPEG_VBI_IVTV_CAPTION_525    (4)
1780#define V4L2_MPEG_VBI_IVTV_WSS_625        (5)
1781#define V4L2_MPEG_VBI_IVTV_VPS            (7)
1782
1783struct v4l2_mpeg_vbi_itv0_line {
1784	__u8 id;	/* One of V4L2_MPEG_VBI_IVTV_* above */
1785	__u8 data[42];	/* Sliced VBI data for the line */
1786} __attribute__ ((packed));
1787
1788struct v4l2_mpeg_vbi_itv0 {
1789	__le32 linemask[2]; /* Bitmasks of VBI service lines present */
1790	struct v4l2_mpeg_vbi_itv0_line line[35];
1791} __attribute__ ((packed));
1792
1793struct v4l2_mpeg_vbi_ITV0 {
1794	struct v4l2_mpeg_vbi_itv0_line line[36];
1795} __attribute__ ((packed));
1796
1797#define V4L2_MPEG_VBI_IVTV_MAGIC0	"itv0"
1798#define V4L2_MPEG_VBI_IVTV_MAGIC1	"ITV0"
1799
1800struct v4l2_mpeg_vbi_fmt_ivtv {
1801	__u8 magic[4];
1802	union {
1803		struct v4l2_mpeg_vbi_itv0 itv0;
1804		struct v4l2_mpeg_vbi_ITV0 ITV0;
1805	};
1806} __attribute__ ((packed));
1807
1808/*
1809 *	A G G R E G A T E   S T R U C T U R E S
1810 */
1811
1812/**
1813 * struct v4l2_plane_pix_format - additional, per-plane format definition
1814 * @sizeimage:		maximum size in bytes required for data, for which
1815 *			this plane will be used
1816 * @bytesperline:	distance in bytes between the leftmost pixels in two
1817 *			adjacent lines
1818 */
1819struct v4l2_plane_pix_format {
1820	__u32		sizeimage;
1821	__u16		bytesperline;
1822	__u16		reserved[7];
1823} __attribute__ ((packed));
1824
1825/**
1826 * struct v4l2_pix_format_mplane - multiplanar format definition
1827 * @width:		image width in pixels
1828 * @height:		image height in pixels
1829 * @pixelformat:	little endian four character code (fourcc)
1830 * @field:		enum v4l2_field; field order (for interlaced video)
1831 * @colorspace:		enum v4l2_colorspace; supplemental to pixelformat
1832 * @plane_fmt:		per-plane information
1833 * @num_planes:		number of planes for this format
1834 * @flags:		format flags (V4L2_PIX_FMT_FLAG_*)
1835 */
1836struct v4l2_pix_format_mplane {
1837	__u32				width;
1838	__u32				height;
1839	__u32				pixelformat;
1840	__u32				field;
1841	__u32				colorspace;
1842
1843	struct v4l2_plane_pix_format	plane_fmt[VIDEO_MAX_PLANES];
1844	__u8				num_planes;
1845	__u8				flags;
1846	__u8				reserved[10];
1847} __attribute__ ((packed));
1848
1849/**
1850 * struct v4l2_sdr_format - SDR format definition
1851 * @pixelformat:	little endian four character code (fourcc)
1852 * @buffersize:		maximum size in bytes required for data
1853 */
1854struct v4l2_sdr_format {
1855	__u32				pixelformat;
1856	__u32				buffersize;
1857	__u8				reserved[24];
1858} __attribute__ ((packed));
1859
1860/**
1861 * struct v4l2_format - stream data format
1862 * @type:	enum v4l2_buf_type; type of the data stream
1863 * @pix:	definition of an image format
1864 * @pix_mp:	definition of a multiplanar image format
1865 * @win:	definition of an overlaid image
1866 * @vbi:	raw VBI capture or output parameters
1867 * @sliced:	sliced VBI capture or output parameters
1868 * @raw_data:	placeholder for future extensions and custom formats
1869 */
1870struct v4l2_format {
1871	__u32	 type;
1872	union {
1873		struct v4l2_pix_format		pix;     /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
1874		struct v4l2_pix_format_mplane	pix_mp;  /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
1875		struct v4l2_window		win;     /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1876		struct v4l2_vbi_format		vbi;     /* V4L2_BUF_TYPE_VBI_CAPTURE */
1877		struct v4l2_sliced_vbi_format	sliced;  /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
1878		struct v4l2_sdr_format		sdr;     /* V4L2_BUF_TYPE_SDR_CAPTURE */
1879		__u8	raw_data[200];                   /* user-defined */
1880	} fmt;
1881};
1882
1883/*	Stream type-dependent parameters
1884 */
1885struct v4l2_streamparm {
1886	__u32	 type;			/* enum v4l2_buf_type */
1887	union {
1888		struct v4l2_captureparm	capture;
1889		struct v4l2_outputparm	output;
1890		__u8	raw_data[200];  /* user-defined */
1891	} parm;
1892};
1893
1894/*
1895 *	E V E N T S
1896 */
1897
1898#define V4L2_EVENT_ALL				0
1899#define V4L2_EVENT_VSYNC			1
1900#define V4L2_EVENT_EOS				2
1901#define V4L2_EVENT_CTRL				3
1902#define V4L2_EVENT_FRAME_SYNC			4
1903#define V4L2_EVENT_SOURCE_CHANGE		5
1904#define V4L2_EVENT_MOTION_DET			6
1905#define V4L2_EVENT_PRIVATE_START		0x08000000
1906
1907#define V4L2_EVENT_BITDEPTH_FLAG	0x1
1908#define V4L2_EVENT_PICSTRUCT_FLAG	0x2
1909#define V4L2_EVENT_COLOUR_SPACE_FLAG    0x4
1910
1911#define V4L2_EVENT_MSM_VIDC_START	(V4L2_EVENT_PRIVATE_START + 0x00001000)
1912#define V4L2_EVENT_MSM_VIDC_FLUSH_DONE	(V4L2_EVENT_MSM_VIDC_START + 1)
1913#define V4L2_EVENT_MSM_VIDC_PORT_SETTINGS_CHANGED_SUFFICIENT	\
1914		(V4L2_EVENT_MSM_VIDC_START + 2)
1915#define V4L2_EVENT_MSM_VIDC_PORT_SETTINGS_CHANGED_INSUFFICIENT	\
1916		(V4L2_EVENT_MSM_VIDC_START + 3)
1917/*
1918 * Bitdepth changed insufficient is deprecated now, however retaining
1919 * to prevent changing the values of the other macros after bitdepth
1920 */
1921#define V4L2_EVENT_MSM_VIDC_PORT_SETTINGS_BITDEPTH_CHANGED_INSUFFICIENT \
1922		(V4L2_EVENT_MSM_VIDC_START + 4)
1923#define V4L2_EVENT_MSM_VIDC_SYS_ERROR	(V4L2_EVENT_MSM_VIDC_START + 5)
1924#define V4L2_EVENT_MSM_VIDC_RELEASE_BUFFER_REFERENCE \
1925		(V4L2_EVENT_MSM_VIDC_START + 6)
1926#define V4L2_EVENT_MSM_VIDC_RELEASE_UNQUEUED_BUFFER \
1927		(V4L2_EVENT_MSM_VIDC_START + 7)
1928#define V4L2_EVENT_MSM_VIDC_HW_OVERLOAD (V4L2_EVENT_MSM_VIDC_START + 8)
1929#define V4L2_EVENT_MSM_VIDC_MAX_CLIENTS (V4L2_EVENT_MSM_VIDC_START + 9)
1930#define V4L2_EVENT_MSM_VIDC_HW_UNSUPPORTED (V4L2_EVENT_MSM_VIDC_START + 10)
1931
1932#define V4L2_EVENT_MSM_BA_PRIVATE_EVENT_BASE	\
1933		(V4L2_EVENT_PRIVATE_START + 0x00005000)
1934#define V4L2_EVENT_MSM_BA_START	V4L2_EVENT_MSM_BA_PRIVATE_EVENT_BASE
1935#define V4L2_EVENT_MSM_BA_DEVICE_AVAILABLE	(V4L2_EVENT_MSM_BA_START + 1)
1936#define V4L2_EVENT_MSM_BA_DEVICE_UNAVAILABLE	\
1937		(V4L2_EVENT_MSM_BA_START + 2)
1938#define V4L2_EVENT_MSM_BA_PORT_SETTINGS_CHANGED	\
1939		(V4L2_EVENT_MSM_BA_START + 3)
1940#define V4L2_EVENT_MSM_BA_SIGNAL_IN_LOCK	\
1941		(V4L2_EVENT_MSM_BA_START + 4)
1942#define V4L2_EVENT_MSM_BA_SIGNAL_LOST_LOCK	\
1943		(V4L2_EVENT_MSM_BA_START + 5)
1944#define V4L2_EVENT_MSM_BA_SOURCE_CHANGE	\
1945		(V4L2_EVENT_MSM_BA_START + 6)
1946#define V4L2_EVENT_MSM_BA_HDMI_HPD	\
1947		(V4L2_EVENT_MSM_BA_START + 7)
1948#define V4L2_EVENT_MSM_BA_HDMI_CEC_MESSAGE	\
1949		(V4L2_EVENT_MSM_BA_START + 8)
1950#define V4L2_EVENT_MSM_BA_CP	\
1951		(V4L2_EVENT_MSM_BA_START + 9)
1952#define V4L2_EVENT_MSM_BA_CABLE_DETECT	\
1953		(V4L2_EVENT_MSM_BA_START + 10)
1954#define V4L2_EVENT_MSM_BA_ERROR	\
1955		(V4L2_EVENT_MSM_BA_START + 11)
1956
1957/* Payload for V4L2_EVENT_VSYNC */
1958struct v4l2_event_vsync {
1959	/* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1960	__u8 field;
1961} __attribute__ ((packed));
1962
1963/* Payload for V4L2_EVENT_CTRL */
1964#define V4L2_EVENT_CTRL_CH_VALUE		(1 << 0)
1965#define V4L2_EVENT_CTRL_CH_FLAGS		(1 << 1)
1966#define V4L2_EVENT_CTRL_CH_RANGE		(1 << 2)
1967
1968struct v4l2_event_ctrl {
1969	__u32 changes;
1970	__u32 type;
1971	union {
1972		__s32 value;
1973		__s64 value64;
1974	};
1975	__u32 flags;
1976	__s32 minimum;
1977	__s32 maximum;
1978	__s32 step;
1979	__s32 default_value;
1980};
1981
1982struct v4l2_event_frame_sync {
1983	__u32 frame_sequence;
1984};
1985
1986#define V4L2_EVENT_SRC_CH_RESOLUTION		(1 << 0)
1987
1988struct v4l2_event_src_change {
1989	__u32 changes;
1990};
1991
1992#define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ	(1 << 0)
1993
1994/**
1995 * struct v4l2_event_motion_det - motion detection event
1996 * @flags:             if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
1997 *                     frame_sequence field is valid.
1998 * @frame_sequence:    the frame sequence number associated with this event.
1999 * @region_mask:       which regions detected motion.
2000 */
2001struct v4l2_event_motion_det {
2002	__u32 flags;
2003	__u32 frame_sequence;
2004	__u32 region_mask;
2005};
2006
2007struct v4l2_event {
2008	__u32				type;
2009	union {
2010		struct v4l2_event_vsync		vsync;
2011		struct v4l2_event_ctrl		ctrl;
2012		struct v4l2_event_frame_sync	frame_sync;
2013		struct v4l2_event_src_change	src_change;
2014		struct v4l2_event_motion_det	motion_det;
2015		__u8				data[64];
2016	} u;
2017	__u32				pending;
2018	__u32				sequence;
2019	struct timespec			timestamp;
2020	__u32				id;
2021	__u32				reserved[8];
2022};
2023
2024#define V4L2_EVENT_SUB_FL_SEND_INITIAL		(1 << 0)
2025#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK	(1 << 1)
2026
2027struct v4l2_event_subscription {
2028	__u32				type;
2029	__u32				id;
2030	__u32				flags;
2031	__u32				reserved[5];
2032};
2033
2034/*
2035 *	A D V A N C E D   D E B U G G I N G
2036 *
2037 *	NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2038 *	FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2039 */
2040
2041/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2042
2043#define V4L2_CHIP_MATCH_BRIDGE      0  /* Match against chip ID on the bridge (0 for the bridge) */
2044#define V4L2_CHIP_MATCH_SUBDEV      4  /* Match against subdev index */
2045
2046/* The following four defines are no longer in use */
2047#define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2048#define V4L2_CHIP_MATCH_I2C_DRIVER  1  /* Match against I2C driver name */
2049#define V4L2_CHIP_MATCH_I2C_ADDR    2  /* Match against I2C 7-bit address */
2050#define V4L2_CHIP_MATCH_AC97        3  /* Match against ancillary AC97 chip */
2051
2052struct v4l2_dbg_match {
2053	__u32 type; /* Match type */
2054	union {     /* Match this chip, meaning determined by type */
2055		__u32 addr;
2056		char name[32];
2057	};
2058} __attribute__ ((packed));
2059
2060struct v4l2_dbg_register {
2061	struct v4l2_dbg_match match;
2062	__u32 size;	/* register size in bytes */
2063	__u64 reg;
2064	__u64 val;
2065} __attribute__ ((packed));
2066
2067#define V4L2_CHIP_FL_READABLE (1 << 0)
2068#define V4L2_CHIP_FL_WRITABLE (1 << 1)
2069
2070/* VIDIOC_DBG_G_CHIP_INFO */
2071struct v4l2_dbg_chip_info {
2072	struct v4l2_dbg_match match;
2073	char name[32];
2074	__u32 flags;
2075	__u32 reserved[32];
2076} __attribute__ ((packed));
2077
2078/**
2079 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2080 * @index:	on return, index of the first created buffer
2081 * @count:	entry: number of requested buffers,
2082 *		return: number of created buffers
2083 * @memory:	enum v4l2_memory; buffer memory type
2084 * @format:	frame format, for which buffers are requested
2085 * @reserved:	future extensions
2086 */
2087struct v4l2_create_buffers {
2088	__u32			index;
2089	__u32			count;
2090	__u32			memory;
2091	struct v4l2_format	format;
2092	__u32			reserved[8];
2093};
2094
2095/*
2096 *	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
2097 *
2098 */
2099#define VIDIOC_QUERYCAP		 _IOR('V',  0, struct v4l2_capability)
2100#define VIDIOC_RESERVED		  _IO('V',  1)
2101#define VIDIOC_ENUM_FMT         _IOWR('V',  2, struct v4l2_fmtdesc)
2102#define VIDIOC_G_FMT		_IOWR('V',  4, struct v4l2_format)
2103#define VIDIOC_S_FMT		_IOWR('V',  5, struct v4l2_format)
2104#define VIDIOC_REQBUFS		_IOWR('V',  8, struct v4l2_requestbuffers)
2105#define VIDIOC_QUERYBUF		_IOWR('V',  9, struct v4l2_buffer)
2106#define VIDIOC_G_FBUF		 _IOR('V', 10, struct v4l2_framebuffer)
2107#define VIDIOC_S_FBUF		 _IOW('V', 11, struct v4l2_framebuffer)
2108#define VIDIOC_OVERLAY		 _IOW('V', 14, int)
2109#define VIDIOC_QBUF		_IOWR('V', 15, struct v4l2_buffer)
2110#define VIDIOC_EXPBUF		_IOWR('V', 16, struct v4l2_exportbuffer)
2111#define VIDIOC_DQBUF		_IOWR('V', 17, struct v4l2_buffer)
2112#define VIDIOC_STREAMON		 _IOW('V', 18, int)
2113#define VIDIOC_STREAMOFF	 _IOW('V', 19, int)
2114#define VIDIOC_G_PARM		_IOWR('V', 21, struct v4l2_streamparm)
2115#define VIDIOC_S_PARM		_IOWR('V', 22, struct v4l2_streamparm)
2116#define VIDIOC_G_STD		 _IOR('V', 23, v4l2_std_id)
2117#define VIDIOC_S_STD		 _IOW('V', 24, v4l2_std_id)
2118#define VIDIOC_ENUMSTD		_IOWR('V', 25, struct v4l2_standard)
2119#define VIDIOC_ENUMINPUT	_IOWR('V', 26, struct v4l2_input)
2120#define VIDIOC_G_CTRL		_IOWR('V', 27, struct v4l2_control)
2121#define VIDIOC_S_CTRL		_IOWR('V', 28, struct v4l2_control)
2122#define VIDIOC_G_TUNER		_IOWR('V', 29, struct v4l2_tuner)
2123#define VIDIOC_S_TUNER		 _IOW('V', 30, struct v4l2_tuner)
2124#define VIDIOC_G_AUDIO		 _IOR('V', 33, struct v4l2_audio)
2125#define VIDIOC_S_AUDIO		 _IOW('V', 34, struct v4l2_audio)
2126#define VIDIOC_QUERYCTRL	_IOWR('V', 36, struct v4l2_queryctrl)
2127#define VIDIOC_QUERYMENU	_IOWR('V', 37, struct v4l2_querymenu)
2128#define VIDIOC_G_INPUT		 _IOR('V', 38, int)
2129#define VIDIOC_S_INPUT		_IOWR('V', 39, int)
2130#define VIDIOC_G_EDID		_IOWR('V', 40, struct v4l2_edid)
2131#define VIDIOC_S_EDID		_IOWR('V', 41, struct v4l2_edid)
2132#define VIDIOC_G_OUTPUT		 _IOR('V', 46, int)
2133#define VIDIOC_S_OUTPUT		_IOWR('V', 47, int)
2134#define VIDIOC_ENUMOUTPUT	_IOWR('V', 48, struct v4l2_output)
2135#define VIDIOC_G_AUDOUT		 _IOR('V', 49, struct v4l2_audioout)
2136#define VIDIOC_S_AUDOUT		 _IOW('V', 50, struct v4l2_audioout)
2137#define VIDIOC_G_MODULATOR	_IOWR('V', 54, struct v4l2_modulator)
2138#define VIDIOC_S_MODULATOR	 _IOW('V', 55, struct v4l2_modulator)
2139#define VIDIOC_G_FREQUENCY	_IOWR('V', 56, struct v4l2_frequency)
2140#define VIDIOC_S_FREQUENCY	 _IOW('V', 57, struct v4l2_frequency)
2141#define VIDIOC_CROPCAP		_IOWR('V', 58, struct v4l2_cropcap)
2142#define VIDIOC_G_CROP		_IOWR('V', 59, struct v4l2_crop)
2143#define VIDIOC_S_CROP		 _IOW('V', 60, struct v4l2_crop)
2144#define VIDIOC_G_JPEGCOMP	 _IOR('V', 61, struct v4l2_jpegcompression)
2145#define VIDIOC_S_JPEGCOMP	 _IOW('V', 62, struct v4l2_jpegcompression)
2146#define VIDIOC_QUERYSTD      	 _IOR('V', 63, v4l2_std_id)
2147#define VIDIOC_TRY_FMT      	_IOWR('V', 64, struct v4l2_format)
2148#define VIDIOC_ENUMAUDIO	_IOWR('V', 65, struct v4l2_audio)
2149#define VIDIOC_ENUMAUDOUT	_IOWR('V', 66, struct v4l2_audioout)
2150#define VIDIOC_G_PRIORITY	 _IOR('V', 67, __u32) /* enum v4l2_priority */
2151#define VIDIOC_S_PRIORITY	 _IOW('V', 68, __u32) /* enum v4l2_priority */
2152#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2153#define VIDIOC_LOG_STATUS         _IO('V', 70)
2154#define VIDIOC_G_EXT_CTRLS	_IOWR('V', 71, struct v4l2_ext_controls)
2155#define VIDIOC_S_EXT_CTRLS	_IOWR('V', 72, struct v4l2_ext_controls)
2156#define VIDIOC_TRY_EXT_CTRLS	_IOWR('V', 73, struct v4l2_ext_controls)
2157#define VIDIOC_ENUM_FRAMESIZES	_IOWR('V', 74, struct v4l2_frmsizeenum)
2158#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2159#define VIDIOC_G_ENC_INDEX       _IOR('V', 76, struct v4l2_enc_idx)
2160#define VIDIOC_ENCODER_CMD      _IOWR('V', 77, struct v4l2_encoder_cmd)
2161#define VIDIOC_TRY_ENCODER_CMD  _IOWR('V', 78, struct v4l2_encoder_cmd)
2162
2163/* Experimental, meant for debugging, testing and internal use.
2164   Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2165   You must be root to use these ioctls. Never use these in applications! */
2166#define	VIDIOC_DBG_S_REGISTER 	 _IOW('V', 79, struct v4l2_dbg_register)
2167#define	VIDIOC_DBG_G_REGISTER 	_IOWR('V', 80, struct v4l2_dbg_register)
2168
2169#define VIDIOC_S_HW_FREQ_SEEK	 _IOW('V', 82, struct v4l2_hw_freq_seek)
2170
2171#define	VIDIOC_S_DV_TIMINGS	_IOWR('V', 87, struct v4l2_dv_timings)
2172#define	VIDIOC_G_DV_TIMINGS	_IOWR('V', 88, struct v4l2_dv_timings)
2173#define	VIDIOC_DQEVENT		 _IOR('V', 89, struct v4l2_event)
2174#define	VIDIOC_SUBSCRIBE_EVENT	 _IOW('V', 90, struct v4l2_event_subscription)
2175#define	VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2176
2177/* Experimental, the below two ioctls may change over the next couple of kernel
2178   versions */
2179#define VIDIOC_CREATE_BUFS	_IOWR('V', 92, struct v4l2_create_buffers)
2180#define VIDIOC_PREPARE_BUF	_IOWR('V', 93, struct v4l2_buffer)
2181
2182/* Experimental selection API */
2183#define VIDIOC_G_SELECTION	_IOWR('V', 94, struct v4l2_selection)
2184#define VIDIOC_S_SELECTION	_IOWR('V', 95, struct v4l2_selection)
2185
2186/* Experimental, these two ioctls may change over the next couple of kernel
2187   versions. */
2188#define VIDIOC_DECODER_CMD	_IOWR('V', 96, struct v4l2_decoder_cmd)
2189#define VIDIOC_TRY_DECODER_CMD	_IOWR('V', 97, struct v4l2_decoder_cmd)
2190
2191/* Experimental, these three ioctls may change over the next couple of kernel
2192   versions. */
2193#define VIDIOC_ENUM_DV_TIMINGS  _IOWR('V', 98, struct v4l2_enum_dv_timings)
2194#define VIDIOC_QUERY_DV_TIMINGS  _IOR('V', 99, struct v4l2_dv_timings)
2195#define VIDIOC_DV_TIMINGS_CAP   _IOWR('V', 100, struct v4l2_dv_timings_cap)
2196
2197/* Experimental, this ioctl may change over the next couple of kernel
2198   versions. */
2199#define VIDIOC_ENUM_FREQ_BANDS	_IOWR('V', 101, struct v4l2_frequency_band)
2200
2201/* Experimental, meant for debugging, testing and internal use.
2202   Never use these in applications! */
2203#define VIDIOC_DBG_G_CHIP_INFO  _IOWR('V', 102, struct v4l2_dbg_chip_info)
2204
2205#define VIDIOC_QUERY_EXT_CTRL	_IOWR('V', 103, struct v4l2_query_ext_ctrl)
2206
2207/* Reminder: when adding new ioctls please add support for them to
2208   drivers/media/video/v4l2-compat-ioctl32.c as well! */
2209
2210#define BASE_VIDIOC_PRIVATE	192		/* 192-255 are private */
2211
2212/* HDMI rx provide ioctls */
2213#define VIDIOC_HDMI_RX_CEC_S_LOGICAL _IOW('V', BASE_VIDIOC_PRIVATE + 0, int)
2214#define VIDIOC_HDMI_RX_CEC_CLEAR_LOGICAL _IO('V', BASE_VIDIOC_PRIVATE + 1)
2215#define VIDIOC_HDMI_RX_CEC_G_PHYSICAL _IOR('V', BASE_VIDIOC_PRIVATE + 2, int)
2216#define VIDIOC_HDMI_RX_CEC_G_CONNECTED _IOR('V', BASE_VIDIOC_PRIVATE + 3, int)
2217#define VIDIOC_HDMI_RX_CEC_S_ENABLE _IOR('V', BASE_VIDIOC_PRIVATE + 4, int)
2218
2219#endif /* _UAPI__LINUX_VIDEODEV2_H */
2220