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