blob: e8f01cd8a17d516fc324720478eb4f1fe815fecd [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 */
Antti Palosaari9e9e3922014-06-27 17:42:18 -0300456#define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
Antti Palosaari00419a62014-02-04 23:55:25 -0300457
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300458/* priv field value to indicates that subsequent fields are valid. */
459#define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
460
Laurent Pinchartc96fd462014-05-27 10:12:43 -0300461/* Flags */
462#define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
463
David Howells607ca462012-10-13 10:46:48 +0100464/*
465 * F O R M A T E N U M E R A T I O N
466 */
467struct v4l2_fmtdesc {
468 __u32 index; /* Format number */
469 __u32 type; /* enum v4l2_buf_type */
470 __u32 flags;
471 __u8 description[32]; /* Description string */
472 __u32 pixelformat; /* Format fourcc */
473 __u32 reserved[4];
474};
475
476#define V4L2_FMT_FLAG_COMPRESSED 0x0001
477#define V4L2_FMT_FLAG_EMULATED 0x0002
478
479#if 1
480 /* Experimental Frame Size and frame rate enumeration */
481/*
482 * F R A M E S I Z E E N U M E R A T I O N
483 */
484enum v4l2_frmsizetypes {
485 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
486 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
487 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
488};
489
490struct v4l2_frmsize_discrete {
491 __u32 width; /* Frame width [pixel] */
492 __u32 height; /* Frame height [pixel] */
493};
494
495struct v4l2_frmsize_stepwise {
496 __u32 min_width; /* Minimum frame width [pixel] */
497 __u32 max_width; /* Maximum frame width [pixel] */
498 __u32 step_width; /* Frame width step size [pixel] */
499 __u32 min_height; /* Minimum frame height [pixel] */
500 __u32 max_height; /* Maximum frame height [pixel] */
501 __u32 step_height; /* Frame height step size [pixel] */
502};
503
504struct v4l2_frmsizeenum {
505 __u32 index; /* Frame size number */
506 __u32 pixel_format; /* Pixel format */
507 __u32 type; /* Frame size type the device supports. */
508
509 union { /* Frame size */
510 struct v4l2_frmsize_discrete discrete;
511 struct v4l2_frmsize_stepwise stepwise;
512 };
513
514 __u32 reserved[2]; /* Reserved space for future use */
515};
516
517/*
518 * F R A M E R A T E E N U M E R A T I O N
519 */
520enum v4l2_frmivaltypes {
521 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
522 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
523 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
524};
525
526struct v4l2_frmival_stepwise {
527 struct v4l2_fract min; /* Minimum frame interval [s] */
528 struct v4l2_fract max; /* Maximum frame interval [s] */
529 struct v4l2_fract step; /* Frame interval step size [s] */
530};
531
532struct v4l2_frmivalenum {
533 __u32 index; /* Frame format index */
534 __u32 pixel_format; /* Pixel format */
535 __u32 width; /* Frame width */
536 __u32 height; /* Frame height */
537 __u32 type; /* Frame interval type the device supports. */
538
539 union { /* Frame interval */
540 struct v4l2_fract discrete;
541 struct v4l2_frmival_stepwise stepwise;
542 };
543
544 __u32 reserved[2]; /* Reserved space for future use */
545};
546#endif
547
548/*
549 * T I M E C O D E
550 */
551struct v4l2_timecode {
552 __u32 type;
553 __u32 flags;
554 __u8 frames;
555 __u8 seconds;
556 __u8 minutes;
557 __u8 hours;
558 __u8 userbits[4];
559};
560
561/* Type */
562#define V4L2_TC_TYPE_24FPS 1
563#define V4L2_TC_TYPE_25FPS 2
564#define V4L2_TC_TYPE_30FPS 3
565#define V4L2_TC_TYPE_50FPS 4
566#define V4L2_TC_TYPE_60FPS 5
567
568/* Flags */
569#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
570#define V4L2_TC_FLAG_COLORFRAME 0x0002
571#define V4L2_TC_USERBITS_field 0x000C
572#define V4L2_TC_USERBITS_USERDEFINED 0x0000
573#define V4L2_TC_USERBITS_8BITCHARS 0x0008
574/* The above is based on SMPTE timecodes */
575
576struct v4l2_jpegcompression {
577 int quality;
578
579 int APPn; /* Number of APP segment to be written,
580 * must be 0..15 */
581 int APP_len; /* Length of data in JPEG APPn segment */
582 char APP_data[60]; /* Data in the JPEG APPn segment. */
583
584 int COM_len; /* Length of data in JPEG COM segment */
585 char COM_data[60]; /* Data in JPEG COM segment */
586
587 __u32 jpeg_markers; /* Which markers should go into the JPEG
588 * output. Unless you exactly know what
589 * you do, leave them untouched.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300590 * Including less markers will make the
David Howells607ca462012-10-13 10:46:48 +0100591 * resulting code smaller, but there will
592 * be fewer applications which can read it.
593 * The presence of the APP and COM marker
594 * is influenced by APP_len and COM_len
595 * ONLY, not by this property! */
596
597#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
598#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
599#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
600#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
601#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300602 * always use APP0 */
David Howells607ca462012-10-13 10:46:48 +0100603};
604
605/*
606 * M E M O R Y - M A P P I N G B U F F E R S
607 */
608struct v4l2_requestbuffers {
609 __u32 count;
610 __u32 type; /* enum v4l2_buf_type */
611 __u32 memory; /* enum v4l2_memory */
612 __u32 reserved[2];
613};
614
615/**
616 * struct v4l2_plane - plane info for multi-planar buffers
617 * @bytesused: number of bytes occupied by data in the plane (payload)
618 * @length: size of this plane (NOT the payload) in bytes
619 * @mem_offset: when memory in the associated struct v4l2_buffer is
620 * V4L2_MEMORY_MMAP, equals the offset from the start of
621 * the device memory for this plane (or is a "cookie" that
622 * should be passed to mmap() called on the video node)
623 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
624 * pointing to this plane
Sumit Semwal051c7782012-06-14 10:37:35 -0300625 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
626 * descriptor associated with this plane
David Howells607ca462012-10-13 10:46:48 +0100627 * @data_offset: offset in the plane to the start of data; usually 0,
628 * unless there is a header in front of the data
629 *
630 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
631 * with two planes can have one plane for Y, and another for interleaved CbCr
632 * components. Each plane can reside in a separate memory buffer, or even in
633 * a completely separate memory node (e.g. in embedded devices).
634 */
635struct v4l2_plane {
636 __u32 bytesused;
637 __u32 length;
638 union {
639 __u32 mem_offset;
640 unsigned long userptr;
Sumit Semwal051c7782012-06-14 10:37:35 -0300641 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100642 } m;
643 __u32 data_offset;
644 __u32 reserved[11];
645};
646
647/**
648 * struct v4l2_buffer - video buffer info
649 * @index: id number of the buffer
650 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
651 * multiplanar buffers);
652 * @bytesused: number of bytes occupied by data in the buffer (payload);
653 * unused (set to 0) for multiplanar buffers
654 * @flags: buffer informational flags
655 * @field: enum v4l2_field; field order of the image in the buffer
656 * @timestamp: frame timestamp
657 * @timecode: frame timecode
658 * @sequence: sequence count of this frame
659 * @memory: enum v4l2_memory; the method, in which the actual video data is
660 * passed
661 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
662 * offset from the start of the device memory for this plane,
663 * (or a "cookie" that should be passed to mmap() as offset)
664 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
665 * a userspace pointer pointing to this buffer
Sumit Semwal051c7782012-06-14 10:37:35 -0300666 * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
667 * a userspace file descriptor associated with this buffer
David Howells607ca462012-10-13 10:46:48 +0100668 * @planes: for multiplanar buffers; userspace pointer to the array of plane
669 * info structs for this buffer
670 * @length: size in bytes of the buffer (NOT its payload) for single-plane
671 * buffers (when type != *_MPLANE); number of elements in the
672 * planes array for multi-plane buffers
David Howells607ca462012-10-13 10:46:48 +0100673 *
674 * Contains data exchanged by application and driver using one of the Streaming
675 * I/O methods.
676 */
677struct v4l2_buffer {
678 __u32 index;
679 __u32 type;
680 __u32 bytesused;
681 __u32 flags;
682 __u32 field;
683 struct timeval timestamp;
684 struct v4l2_timecode timecode;
685 __u32 sequence;
686
687 /* memory location */
688 __u32 memory;
689 union {
690 __u32 offset;
691 unsigned long userptr;
692 struct v4l2_plane *planes;
Sumit Semwal051c7782012-06-14 10:37:35 -0300693 __s32 fd;
David Howells607ca462012-10-13 10:46:48 +0100694 } m;
695 __u32 length;
696 __u32 reserved2;
697 __u32 reserved;
698};
699
700/* Flags for 'flags' field */
Sakari Ailus939f1372013-08-25 14:00:43 -0300701/* Buffer is mapped (flag) */
702#define V4L2_BUF_FLAG_MAPPED 0x00000001
703/* Buffer is queued for processing */
704#define V4L2_BUF_FLAG_QUEUED 0x00000002
705/* Buffer is ready */
706#define V4L2_BUF_FLAG_DONE 0x00000004
707/* Image is a keyframe (I-frame) */
708#define V4L2_BUF_FLAG_KEYFRAME 0x00000008
709/* Image is a P-frame */
710#define V4L2_BUF_FLAG_PFRAME 0x00000010
711/* Image is a B-frame */
712#define V4L2_BUF_FLAG_BFRAME 0x00000020
David Howells607ca462012-10-13 10:46:48 +0100713/* Buffer is ready, but the data contained within is corrupted. */
Sakari Ailus939f1372013-08-25 14:00:43 -0300714#define V4L2_BUF_FLAG_ERROR 0x00000040
715/* timecode field is valid */
716#define V4L2_BUF_FLAG_TIMECODE 0x00000100
717/* Buffer is prepared for queuing */
718#define V4L2_BUF_FLAG_PREPARED 0x00000400
David Howells607ca462012-10-13 10:46:48 +0100719/* Cache handling flags */
Sakari Ailus939f1372013-08-25 14:00:43 -0300720#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
721#define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
Sakari Ailus1202ecd2012-10-21 16:02:47 -0300722/* Timestamp type */
Sakari Ailus939f1372013-08-25 14:00:43 -0300723#define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
724#define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
725#define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
726#define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
Sakari Ailus872484c2013-08-25 17:57:03 -0300727/* Timestamp sources. */
728#define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
729#define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
730#define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
David Howells607ca462012-10-13 10:46:48 +0100731
Tomasz Stanislawskib799d092012-06-14 11:32:23 -0300732/**
733 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
734 *
735 * @index: id number of the buffer
736 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
737 * multiplanar buffers);
738 * @plane: index of the plane to be exported, 0 for single plane queues
739 * @flags: flags for newly created file, currently only O_CLOEXEC is
740 * supported, refer to manual of open syscall for more details
741 * @fd: file descriptor associated with DMABUF (set by driver)
742 *
743 * Contains data used for exporting a video buffer as DMABUF file descriptor.
744 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
745 * (identical to the cookie used to mmap() the buffer to userspace). All
746 * reserved fields must be set to zero. The field reserved0 is expected to
747 * become a structure 'type' allowing an alternative layout of the structure
748 * content. Therefore this field should not be used for any other extensions.
749 */
750struct v4l2_exportbuffer {
751 __u32 type; /* enum v4l2_buf_type */
752 __u32 index;
753 __u32 plane;
754 __u32 flags;
755 __s32 fd;
756 __u32 reserved[11];
757};
758
David Howells607ca462012-10-13 10:46:48 +0100759/*
760 * O V E R L A Y P R E V I E W
761 */
762struct v4l2_framebuffer {
763 __u32 capability;
764 __u32 flags;
765/* FIXME: in theory we should pass something like PCI device + memory
766 * region + offset instead of some physical address */
767 void *base;
Laurent Pinchartd52e2382014-05-27 09:41:05 -0300768 struct {
769 __u32 width;
770 __u32 height;
771 __u32 pixelformat;
772 __u32 field; /* enum v4l2_field */
773 __u32 bytesperline; /* for padding, zero if unused */
774 __u32 sizeimage;
775 __u32 colorspace; /* enum v4l2_colorspace */
776 __u32 priv; /* reserved field, set to 0 */
777 } fmt;
David Howells607ca462012-10-13 10:46:48 +0100778};
779/* Flags for the 'capability' field. Read only */
780#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
781#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
782#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
783#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
784#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
785#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
786#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
787#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
788/* Flags for the 'flags' field. */
789#define V4L2_FBUF_FLAG_PRIMARY 0x0001
790#define V4L2_FBUF_FLAG_OVERLAY 0x0002
791#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
792#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
793#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
794#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
795#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
796
797struct v4l2_clip {
798 struct v4l2_rect c;
799 struct v4l2_clip __user *next;
800};
801
802struct v4l2_window {
803 struct v4l2_rect w;
804 __u32 field; /* enum v4l2_field */
805 __u32 chromakey;
806 struct v4l2_clip __user *clips;
807 __u32 clipcount;
808 void __user *bitmap;
809 __u8 global_alpha;
810};
811
812/*
813 * C A P T U R E P A R A M E T E R S
814 */
815struct v4l2_captureparm {
816 __u32 capability; /* Supported modes */
817 __u32 capturemode; /* Current mode */
Kirill Smelkov2e745982012-10-22 14:14:01 -0300818 struct v4l2_fract timeperframe; /* Time per frame in seconds */
David Howells607ca462012-10-13 10:46:48 +0100819 __u32 extendedmode; /* Driver-specific extensions */
820 __u32 readbuffers; /* # of buffers for read */
821 __u32 reserved[4];
822};
823
824/* Flags for 'capability' and 'capturemode' fields */
825#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
826#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
827
828struct v4l2_outputparm {
829 __u32 capability; /* Supported modes */
830 __u32 outputmode; /* Current mode */
831 struct v4l2_fract timeperframe; /* Time per frame in seconds */
832 __u32 extendedmode; /* Driver-specific extensions */
833 __u32 writebuffers; /* # of buffers for write */
834 __u32 reserved[4];
835};
836
837/*
838 * I N P U T I M A G E C R O P P I N G
839 */
840struct v4l2_cropcap {
841 __u32 type; /* enum v4l2_buf_type */
842 struct v4l2_rect bounds;
843 struct v4l2_rect defrect;
844 struct v4l2_fract pixelaspect;
845};
846
847struct v4l2_crop {
848 __u32 type; /* enum v4l2_buf_type */
849 struct v4l2_rect c;
850};
851
852/**
853 * struct v4l2_selection - selection info
854 * @type: buffer type (do not use *_MPLANE types)
855 * @target: Selection target, used to choose one of possible rectangles;
856 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
857 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
858 * @r: coordinates of selection window
859 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
860 *
861 * Hardware may use multiple helper windows to process a video stream.
862 * The structure is used to exchange this selection areas between
863 * an application and a driver.
864 */
865struct v4l2_selection {
866 __u32 type;
867 __u32 target;
868 __u32 flags;
869 struct v4l2_rect r;
870 __u32 reserved[9];
871};
872
873
874/*
875 * A N A L O G V I D E O S T A N D A R D
876 */
877
878typedef __u64 v4l2_std_id;
879
880/* one bit for each */
881#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
882#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
883#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
884#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
885#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
886#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
887#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
888#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
889
890#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
891#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
892#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
893#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
894
895#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
896#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
897#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
898#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
899
900#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
901#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
902#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
903#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
904#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
905#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
906#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
907#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
908
909/* ATSC/HDTV */
910#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
911#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
912
913/* FIXME:
914 Although std_id is 64 bits, there is an issue on PPC32 architecture that
915 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
916 this value to 32 bits.
917 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
918 it should work fine. However, if needed to add more than two standards,
919 v4l2-common.c should be fixed.
920 */
921
922/*
923 * Some macros to merge video standards in order to make live easier for the
924 * drivers and V4L2 applications
925 */
926
927/*
928 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
929 * Missing here.
930 */
931#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
932 V4L2_STD_NTSC_M_JP |\
933 V4L2_STD_NTSC_M_KR)
934/* Secam macros */
935#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
936 V4L2_STD_SECAM_K |\
937 V4L2_STD_SECAM_K1)
938/* All Secam Standards */
939#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
940 V4L2_STD_SECAM_G |\
941 V4L2_STD_SECAM_H |\
942 V4L2_STD_SECAM_DK |\
943 V4L2_STD_SECAM_L |\
944 V4L2_STD_SECAM_LC)
945/* PAL macros */
946#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
947 V4L2_STD_PAL_B1 |\
948 V4L2_STD_PAL_G)
949#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
950 V4L2_STD_PAL_D1 |\
951 V4L2_STD_PAL_K)
952/*
953 * "Common" PAL - This macro is there to be compatible with the old
954 * V4L1 concept of "PAL": /BGDKHI.
Lad, Prabhakarff29feb2013-05-20 06:02:40 -0300955 * Several PAL standards are missing here: /M, /N and /Nc
David Howells607ca462012-10-13 10:46:48 +0100956 */
957#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
958 V4L2_STD_PAL_DK |\
959 V4L2_STD_PAL_H |\
960 V4L2_STD_PAL_I)
961/* Chroma "agnostic" standards */
962#define V4L2_STD_B (V4L2_STD_PAL_B |\
963 V4L2_STD_PAL_B1 |\
964 V4L2_STD_SECAM_B)
965#define V4L2_STD_G (V4L2_STD_PAL_G |\
966 V4L2_STD_SECAM_G)
967#define V4L2_STD_H (V4L2_STD_PAL_H |\
968 V4L2_STD_SECAM_H)
969#define V4L2_STD_L (V4L2_STD_SECAM_L |\
970 V4L2_STD_SECAM_LC)
971#define V4L2_STD_GH (V4L2_STD_G |\
972 V4L2_STD_H)
973#define V4L2_STD_DK (V4L2_STD_PAL_DK |\
974 V4L2_STD_SECAM_DK)
975#define V4L2_STD_BG (V4L2_STD_B |\
976 V4L2_STD_G)
977#define V4L2_STD_MN (V4L2_STD_PAL_M |\
978 V4L2_STD_PAL_N |\
979 V4L2_STD_PAL_Nc |\
980 V4L2_STD_NTSC)
981
982/* Standards where MTS/BTSC stereo could be found */
983#define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
984 V4L2_STD_PAL_M |\
985 V4L2_STD_PAL_N |\
986 V4L2_STD_PAL_Nc)
987
988/* Standards for Countries with 60Hz Line frequency */
989#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
990 V4L2_STD_PAL_60 |\
991 V4L2_STD_NTSC |\
992 V4L2_STD_NTSC_443)
993/* Standards for Countries with 50Hz Line frequency */
994#define V4L2_STD_625_50 (V4L2_STD_PAL |\
995 V4L2_STD_PAL_N |\
996 V4L2_STD_PAL_Nc |\
997 V4L2_STD_SECAM)
998
999#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
1000 V4L2_STD_ATSC_16_VSB)
1001/* Macros with none and all analog standards */
1002#define V4L2_STD_UNKNOWN 0
1003#define V4L2_STD_ALL (V4L2_STD_525_60 |\
1004 V4L2_STD_625_50)
1005
1006struct v4l2_standard {
1007 __u32 index;
1008 v4l2_std_id id;
1009 __u8 name[24];
1010 struct v4l2_fract frameperiod; /* Frames, not fields */
1011 __u32 framelines;
1012 __u32 reserved[4];
1013};
1014
David Howells607ca462012-10-13 10:46:48 +01001015/*
1016 * D V B T T I M I N G S
1017 */
1018
1019/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1020 * @width: total width of the active video in pixels
1021 * @height: total height of the active video in lines
1022 * @interlaced: Interlaced or progressive
1023 * @polarities: Positive or negative polarities
1024 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1025 * @hfrontporch:Horizontal front porch in pixels
1026 * @hsync: Horizontal Sync length in pixels
1027 * @hbackporch: Horizontal back porch in pixels
1028 * @vfrontporch:Vertical front porch in lines
1029 * @vsync: Vertical Sync length in lines
1030 * @vbackporch: Vertical back porch in lines
1031 * @il_vfrontporch:Vertical front porch for the even field
1032 * (aka field 2) of interlaced field formats
1033 * @il_vsync: Vertical Sync length for the even field
1034 * (aka field 2) of interlaced field formats
1035 * @il_vbackporch:Vertical back porch for the even field
1036 * (aka field 2) of interlaced field formats
1037 * @standards: Standards the timing belongs to
1038 * @flags: Flags
1039 * @reserved: Reserved fields, must be zeroed.
1040 *
1041 * A note regarding vertical interlaced timings: height refers to the total
1042 * height of the active video frame (= two fields). The blanking timings refer
1043 * to the blanking of each field. So the height of the total frame is
1044 * calculated as follows:
1045 *
1046 * tot_height = height + vfrontporch + vsync + vbackporch +
1047 * il_vfrontporch + il_vsync + il_vbackporch
1048 *
1049 * The active height of each field is height / 2.
1050 */
1051struct v4l2_bt_timings {
1052 __u32 width;
1053 __u32 height;
1054 __u32 interlaced;
1055 __u32 polarities;
1056 __u64 pixelclock;
1057 __u32 hfrontporch;
1058 __u32 hsync;
1059 __u32 hbackporch;
1060 __u32 vfrontporch;
1061 __u32 vsync;
1062 __u32 vbackporch;
1063 __u32 il_vfrontporch;
1064 __u32 il_vsync;
1065 __u32 il_vbackporch;
1066 __u32 standards;
1067 __u32 flags;
1068 __u32 reserved[14];
1069} __attribute__ ((packed));
1070
1071/* Interlaced or progressive format */
1072#define V4L2_DV_PROGRESSIVE 0
1073#define V4L2_DV_INTERLACED 1
1074
1075/* Polarities. If bit is not set, it is assumed to be negative polarity */
1076#define V4L2_DV_VSYNC_POS_POL 0x00000001
1077#define V4L2_DV_HSYNC_POS_POL 0x00000002
1078
1079/* Timings standards */
1080#define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1081#define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1082#define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1083#define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
1084
1085/* Flags */
1086
1087/* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1088 GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1089 intervals are reduced, allowing a higher resolution over the same
1090 bandwidth. This is a read-only flag. */
1091#define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1092/* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1093 of six. These formats can be optionally played at 1 / 1.001 speed.
1094 This is a read-only flag. */
1095#define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1096/* CEA-861 specific: only valid for video transmitters, the flag is cleared
1097 by receivers.
1098 If the framerate of the format is a multiple of six, then the pixelclock
1099 used to set up the transmitter is divided by 1.001 to make it compatible
1100 with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1101 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1102 such frequencies, then the flag will also be cleared. */
1103#define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1104/* Specific to interlaced formats: if set, then field 1 is really one half-line
1105 longer and field 2 is really one half-line shorter, so each field has
1106 exactly the same number of half-lines. Whether half-lines can be detected
1107 or used depends on the hardware. */
Hans Verkuil292a8782013-03-20 15:26:36 -03001108#define V4L2_DV_FL_HALF_LINE (1 << 3)
David Howells607ca462012-10-13 10:46:48 +01001109
Hans Verkuil7f681272013-07-29 08:40:58 -03001110/* A few useful defines to calculate the total blanking and frame sizes */
1111#define V4L2_DV_BT_BLANKING_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001112 ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001113#define V4L2_DV_BT_FRAME_WIDTH(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001114 ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
Hans Verkuil7f681272013-07-29 08:40:58 -03001115#define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001116 ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1117 (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
Hans Verkuil7f681272013-07-29 08:40:58 -03001118#define V4L2_DV_BT_FRAME_HEIGHT(bt) \
Hans Verkuilaee786a2014-02-27 06:04:57 -03001119 ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
David Howells607ca462012-10-13 10:46:48 +01001120
1121/** struct v4l2_dv_timings - DV timings
1122 * @type: the type of the timings
1123 * @bt: BT656/1120 timings
1124 */
1125struct v4l2_dv_timings {
1126 __u32 type;
1127 union {
1128 struct v4l2_bt_timings bt;
1129 __u32 reserved[32];
1130 };
1131} __attribute__ ((packed));
1132
1133/* Values for the type field */
1134#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1135
1136
1137/** struct v4l2_enum_dv_timings - DV timings enumeration
1138 * @index: enumeration index
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001139 * @pad: the pad number for which to enumerate timings (used with
1140 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001141 * @reserved: must be zeroed
1142 * @timings: the timings for the given index
1143 */
1144struct v4l2_enum_dv_timings {
1145 __u32 index;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001146 __u32 pad;
1147 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001148 struct v4l2_dv_timings timings;
1149};
1150
1151/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1152 * @min_width: width in pixels
1153 * @max_width: width in pixels
1154 * @min_height: height in lines
1155 * @max_height: height in lines
1156 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1157 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1158 * @standards: Supported standards
1159 * @capabilities: Supported capabilities
1160 * @reserved: Must be zeroed
1161 */
1162struct v4l2_bt_timings_cap {
1163 __u32 min_width;
1164 __u32 max_width;
1165 __u32 min_height;
1166 __u32 max_height;
1167 __u64 min_pixelclock;
1168 __u64 max_pixelclock;
1169 __u32 standards;
1170 __u32 capabilities;
1171 __u32 reserved[16];
1172} __attribute__ ((packed));
1173
1174/* Supports interlaced formats */
1175#define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1176/* Supports progressive formats */
1177#define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1178/* Supports CVT/GTF reduced blanking */
1179#define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1180/* Supports custom formats */
1181#define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1182
1183/** struct v4l2_dv_timings_cap - DV timings capabilities
1184 * @type: the type of the timings (same as in struct v4l2_dv_timings)
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001185 * @pad: the pad number for which to query capabilities (used with
1186 * v4l-subdev nodes only)
David Howells607ca462012-10-13 10:46:48 +01001187 * @bt: the BT656/1120 timings capabilities
1188 */
1189struct v4l2_dv_timings_cap {
1190 __u32 type;
Laurent Pinchart0349f6a2014-01-29 10:05:10 -03001191 __u32 pad;
1192 __u32 reserved[2];
David Howells607ca462012-10-13 10:46:48 +01001193 union {
1194 struct v4l2_bt_timings_cap bt;
1195 __u32 raw_data[32];
1196 };
1197};
1198
1199
1200/*
1201 * V I D E O I N P U T S
1202 */
1203struct v4l2_input {
1204 __u32 index; /* Which input */
1205 __u8 name[32]; /* Label */
1206 __u32 type; /* Type of input */
1207 __u32 audioset; /* Associated audios (bitfield) */
1208 __u32 tuner; /* enum v4l2_tuner_type */
1209 v4l2_std_id std;
1210 __u32 status;
1211 __u32 capabilities;
1212 __u32 reserved[3];
1213};
1214
1215/* Values for the 'type' field */
1216#define V4L2_INPUT_TYPE_TUNER 1
1217#define V4L2_INPUT_TYPE_CAMERA 2
1218
1219/* field 'status' - general */
1220#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1221#define V4L2_IN_ST_NO_SIGNAL 0x00000002
1222#define V4L2_IN_ST_NO_COLOR 0x00000004
1223
1224/* field 'status' - sensor orientation */
1225/* If sensor is mounted upside down set both bits */
1226#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1227#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1228
1229/* field 'status' - analog */
1230#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1231#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1232
1233/* field 'status' - digital */
1234#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1235#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1236#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1237
1238/* field 'status' - VCR and set-top box */
1239#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1240#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1241#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1242
1243/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001244#define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1245#define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1246#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1247
1248/*
1249 * V I D E O O U T P U T S
1250 */
1251struct v4l2_output {
1252 __u32 index; /* Which output */
1253 __u8 name[32]; /* Label */
1254 __u32 type; /* Type of output */
1255 __u32 audioset; /* Associated audios (bitfield) */
1256 __u32 modulator; /* Associated modulator */
1257 v4l2_std_id std;
1258 __u32 capabilities;
1259 __u32 reserved[3];
1260};
1261/* Values for the 'type' field */
1262#define V4L2_OUTPUT_TYPE_MODULATOR 1
1263#define V4L2_OUTPUT_TYPE_ANALOG 2
1264#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1265
1266/* capabilities flags */
David Howells607ca462012-10-13 10:46:48 +01001267#define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1268#define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1269#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1270
1271/*
1272 * C O N T R O L S
1273 */
1274struct v4l2_control {
1275 __u32 id;
1276 __s32 value;
1277};
1278
1279struct v4l2_ext_control {
1280 __u32 id;
1281 __u32 size;
1282 __u32 reserved2[1];
1283 union {
1284 __s32 value;
1285 __s64 value64;
1286 char *string;
Hans Verkuildda4a4d2014-06-10 07:30:04 -03001287 __u8 *p_u8;
1288 __u16 *p_u16;
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001289 void *ptr;
David Howells607ca462012-10-13 10:46:48 +01001290 };
1291} __attribute__ ((packed));
1292
1293struct v4l2_ext_controls {
1294 __u32 ctrl_class;
1295 __u32 count;
1296 __u32 error_idx;
1297 __u32 reserved[2];
1298 struct v4l2_ext_control *controls;
1299};
1300
1301#define V4L2_CTRL_ID_MASK (0x0fffffff)
1302#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1303#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
Hans Verkuil5082c242014-06-10 04:14:50 -03001304#define V4L2_CTRL_MAX_DIMS (4)
David Howells607ca462012-10-13 10:46:48 +01001305
1306enum v4l2_ctrl_type {
1307 V4L2_CTRL_TYPE_INTEGER = 1,
1308 V4L2_CTRL_TYPE_BOOLEAN = 2,
1309 V4L2_CTRL_TYPE_MENU = 3,
1310 V4L2_CTRL_TYPE_BUTTON = 4,
1311 V4L2_CTRL_TYPE_INTEGER64 = 5,
1312 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1313 V4L2_CTRL_TYPE_STRING = 7,
1314 V4L2_CTRL_TYPE_BITMASK = 8,
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001315 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
1316
1317 /* Compound types are >= 0x0100 */
1318 V4L2_CTRL_COMPOUND_TYPES = 0x0100,
Hans Verkuildda4a4d2014-06-10 07:30:04 -03001319 V4L2_CTRL_TYPE_U8 = 0x0100,
1320 V4L2_CTRL_TYPE_U16 = 0x0101,
David Howells607ca462012-10-13 10:46:48 +01001321};
1322
1323/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1324struct v4l2_queryctrl {
1325 __u32 id;
1326 __u32 type; /* enum v4l2_ctrl_type */
1327 __u8 name[32]; /* Whatever */
1328 __s32 minimum; /* Note signedness */
1329 __s32 maximum;
1330 __s32 step;
1331 __s32 default_value;
1332 __u32 flags;
1333 __u32 reserved[2];
1334};
1335
Hans Verkuil5082c242014-06-10 04:14:50 -03001336/* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1337struct v4l2_query_ext_ctrl {
1338 __u32 id;
1339 __u32 type;
1340 char name[32];
1341 __s64 minimum;
1342 __s64 maximum;
1343 __u64 step;
1344 __s64 default_value;
1345 __u32 flags;
1346 __u32 elem_size;
1347 __u32 elems;
1348 __u32 nr_of_dims;
1349 __u32 dims[V4L2_CTRL_MAX_DIMS];
1350 __u32 reserved[32];
1351};
1352
David Howells607ca462012-10-13 10:46:48 +01001353/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1354struct v4l2_querymenu {
1355 __u32 id;
1356 __u32 index;
1357 union {
1358 __u8 name[32]; /* Whatever */
1359 __s64 value;
1360 };
1361 __u32 reserved;
1362} __attribute__ ((packed));
1363
1364/* Control flags */
1365#define V4L2_CTRL_FLAG_DISABLED 0x0001
1366#define V4L2_CTRL_FLAG_GRABBED 0x0002
1367#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1368#define V4L2_CTRL_FLAG_UPDATE 0x0008
1369#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1370#define V4L2_CTRL_FLAG_SLIDER 0x0020
1371#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
1372#define V4L2_CTRL_FLAG_VOLATILE 0x0080
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001373#define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
David Howells607ca462012-10-13 10:46:48 +01001374
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001375/* Query flags, to be ORed with the control ID */
David Howells607ca462012-10-13 10:46:48 +01001376#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
Hans Verkuil7e6a6822014-03-27 11:25:45 -03001377#define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
David Howells607ca462012-10-13 10:46:48 +01001378
1379/* User-class control IDs defined by V4L2 */
1380#define V4L2_CID_MAX_CTRLS 1024
1381/* IDs reserved for driver specific controls */
1382#define V4L2_CID_PRIVATE_BASE 0x08000000
1383
1384
David Howells607ca462012-10-13 10:46:48 +01001385/*
1386 * T U N I N G
1387 */
1388struct v4l2_tuner {
1389 __u32 index;
1390 __u8 name[32];
1391 __u32 type; /* enum v4l2_tuner_type */
1392 __u32 capability;
1393 __u32 rangelow;
1394 __u32 rangehigh;
1395 __u32 rxsubchans;
1396 __u32 audmode;
1397 __s32 signal;
1398 __s32 afc;
1399 __u32 reserved[4];
1400};
1401
1402struct v4l2_modulator {
1403 __u32 index;
1404 __u8 name[32];
1405 __u32 capability;
1406 __u32 rangelow;
1407 __u32 rangehigh;
1408 __u32 txsubchans;
1409 __u32 reserved[4];
1410};
1411
1412/* Flags for the 'capability' field */
1413#define V4L2_TUNER_CAP_LOW 0x0001
1414#define V4L2_TUNER_CAP_NORM 0x0002
1415#define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1416#define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
1417#define V4L2_TUNER_CAP_STEREO 0x0010
1418#define V4L2_TUNER_CAP_LANG2 0x0020
1419#define V4L2_TUNER_CAP_SAP 0x0020
1420#define V4L2_TUNER_CAP_LANG1 0x0040
1421#define V4L2_TUNER_CAP_RDS 0x0080
1422#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1423#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
1424#define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
1425#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
Antti Palosaari67f9a112013-12-11 20:27:31 -03001426#define V4L2_TUNER_CAP_1HZ 0x1000
David Howells607ca462012-10-13 10:46:48 +01001427
1428/* Flags for the 'rxsubchans' field */
1429#define V4L2_TUNER_SUB_MONO 0x0001
1430#define V4L2_TUNER_SUB_STEREO 0x0002
1431#define V4L2_TUNER_SUB_LANG2 0x0004
1432#define V4L2_TUNER_SUB_SAP 0x0004
1433#define V4L2_TUNER_SUB_LANG1 0x0008
1434#define V4L2_TUNER_SUB_RDS 0x0010
1435
1436/* Values for the 'audmode' field */
1437#define V4L2_TUNER_MODE_MONO 0x0000
1438#define V4L2_TUNER_MODE_STEREO 0x0001
1439#define V4L2_TUNER_MODE_LANG2 0x0002
1440#define V4L2_TUNER_MODE_SAP 0x0002
1441#define V4L2_TUNER_MODE_LANG1 0x0003
1442#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
1443
1444struct v4l2_frequency {
1445 __u32 tuner;
1446 __u32 type; /* enum v4l2_tuner_type */
1447 __u32 frequency;
1448 __u32 reserved[8];
1449};
1450
1451#define V4L2_BAND_MODULATION_VSB (1 << 1)
1452#define V4L2_BAND_MODULATION_FM (1 << 2)
1453#define V4L2_BAND_MODULATION_AM (1 << 3)
1454
1455struct v4l2_frequency_band {
1456 __u32 tuner;
1457 __u32 type; /* enum v4l2_tuner_type */
1458 __u32 index;
1459 __u32 capability;
1460 __u32 rangelow;
1461 __u32 rangehigh;
1462 __u32 modulation;
1463 __u32 reserved[9];
1464};
1465
1466struct v4l2_hw_freq_seek {
1467 __u32 tuner;
1468 __u32 type; /* enum v4l2_tuner_type */
1469 __u32 seek_upward;
1470 __u32 wrap_around;
1471 __u32 spacing;
1472 __u32 rangelow;
1473 __u32 rangehigh;
1474 __u32 reserved[5];
1475};
1476
1477/*
1478 * R D S
1479 */
1480
1481struct v4l2_rds_data {
1482 __u8 lsb;
1483 __u8 msb;
1484 __u8 block;
1485} __attribute__ ((packed));
1486
1487#define V4L2_RDS_BLOCK_MSK 0x7
1488#define V4L2_RDS_BLOCK_A 0
1489#define V4L2_RDS_BLOCK_B 1
1490#define V4L2_RDS_BLOCK_C 2
1491#define V4L2_RDS_BLOCK_D 3
1492#define V4L2_RDS_BLOCK_C_ALT 4
1493#define V4L2_RDS_BLOCK_INVALID 7
1494
1495#define V4L2_RDS_BLOCK_CORRECTED 0x40
1496#define V4L2_RDS_BLOCK_ERROR 0x80
1497
1498/*
1499 * A U D I O
1500 */
1501struct v4l2_audio {
1502 __u32 index;
1503 __u8 name[32];
1504 __u32 capability;
1505 __u32 mode;
1506 __u32 reserved[2];
1507};
1508
1509/* Flags for the 'capability' field */
1510#define V4L2_AUDCAP_STEREO 0x00001
1511#define V4L2_AUDCAP_AVL 0x00002
1512
1513/* Flags for the 'mode' field */
1514#define V4L2_AUDMODE_AVL 0x00001
1515
1516struct v4l2_audioout {
1517 __u32 index;
1518 __u8 name[32];
1519 __u32 capability;
1520 __u32 mode;
1521 __u32 reserved[2];
1522};
1523
1524/*
1525 * M P E G S E R V I C E S
1526 *
1527 * NOTE: EXPERIMENTAL API
1528 */
1529#if 1
1530#define V4L2_ENC_IDX_FRAME_I (0)
1531#define V4L2_ENC_IDX_FRAME_P (1)
1532#define V4L2_ENC_IDX_FRAME_B (2)
1533#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1534
1535struct v4l2_enc_idx_entry {
1536 __u64 offset;
1537 __u64 pts;
1538 __u32 length;
1539 __u32 flags;
1540 __u32 reserved[2];
1541};
1542
1543#define V4L2_ENC_IDX_ENTRIES (64)
1544struct v4l2_enc_idx {
1545 __u32 entries;
1546 __u32 entries_cap;
1547 __u32 reserved[4];
1548 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1549};
1550
1551
1552#define V4L2_ENC_CMD_START (0)
1553#define V4L2_ENC_CMD_STOP (1)
1554#define V4L2_ENC_CMD_PAUSE (2)
1555#define V4L2_ENC_CMD_RESUME (3)
1556
1557/* Flags for V4L2_ENC_CMD_STOP */
1558#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1559
1560struct v4l2_encoder_cmd {
1561 __u32 cmd;
1562 __u32 flags;
1563 union {
1564 struct {
1565 __u32 data[8];
1566 } raw;
1567 };
1568};
1569
1570/* Decoder commands */
1571#define V4L2_DEC_CMD_START (0)
1572#define V4L2_DEC_CMD_STOP (1)
1573#define V4L2_DEC_CMD_PAUSE (2)
1574#define V4L2_DEC_CMD_RESUME (3)
1575
1576/* Flags for V4L2_DEC_CMD_START */
1577#define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1578
1579/* Flags for V4L2_DEC_CMD_PAUSE */
1580#define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1581
1582/* Flags for V4L2_DEC_CMD_STOP */
1583#define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1584#define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1585
1586/* Play format requirements (returned by the driver): */
1587
1588/* The decoder has no special format requirements */
1589#define V4L2_DEC_START_FMT_NONE (0)
1590/* The decoder requires full GOPs */
1591#define V4L2_DEC_START_FMT_GOP (1)
1592
1593/* The structure must be zeroed before use by the application
1594 This ensures it can be extended safely in the future. */
1595struct v4l2_decoder_cmd {
1596 __u32 cmd;
1597 __u32 flags;
1598 union {
1599 struct {
1600 __u64 pts;
1601 } stop;
1602
1603 struct {
1604 /* 0 or 1000 specifies normal speed,
1605 1 specifies forward single stepping,
1606 -1 specifies backward single stepping,
1607 >1: playback at speed/1000 of the normal speed,
1608 <-1: reverse playback at (-speed/1000) of the normal speed. */
1609 __s32 speed;
1610 __u32 format;
1611 } start;
1612
1613 struct {
1614 __u32 data[16];
1615 } raw;
1616 };
1617};
1618#endif
1619
1620
1621/*
1622 * D A T A S E R V I C E S ( V B I )
1623 *
1624 * Data services API by Michael Schimek
1625 */
1626
1627/* Raw VBI */
1628struct v4l2_vbi_format {
1629 __u32 sampling_rate; /* in 1 Hz */
1630 __u32 offset;
1631 __u32 samples_per_line;
1632 __u32 sample_format; /* V4L2_PIX_FMT_* */
1633 __s32 start[2];
1634 __u32 count[2];
1635 __u32 flags; /* V4L2_VBI_* */
1636 __u32 reserved[2]; /* must be zero */
1637};
1638
1639/* VBI flags */
1640#define V4L2_VBI_UNSYNC (1 << 0)
1641#define V4L2_VBI_INTERLACED (1 << 1)
1642
1643/* Sliced VBI
1644 *
1645 * This implements is a proposal V4L2 API to allow SLICED VBI
1646 * required for some hardware encoders. It should change without
1647 * notice in the definitive implementation.
1648 */
1649
1650struct v4l2_sliced_vbi_format {
1651 __u16 service_set;
1652 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1653 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1654 (equals frame lines 313-336 for 625 line video
1655 standards, 263-286 for 525 line standards) */
1656 __u16 service_lines[2][24];
1657 __u32 io_size;
1658 __u32 reserved[2]; /* must be zero */
1659};
1660
1661/* Teletext World System Teletext
1662 (WST), defined on ITU-R BT.653-2 */
1663#define V4L2_SLICED_TELETEXT_B (0x0001)
1664/* Video Program System, defined on ETS 300 231*/
1665#define V4L2_SLICED_VPS (0x0400)
1666/* Closed Caption, defined on EIA-608 */
1667#define V4L2_SLICED_CAPTION_525 (0x1000)
1668/* Wide Screen System, defined on ITU-R BT1119.1 */
1669#define V4L2_SLICED_WSS_625 (0x4000)
1670
1671#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1672#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
1673
1674struct v4l2_sliced_vbi_cap {
1675 __u16 service_set;
1676 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1677 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
1678 (equals frame lines 313-336 for 625 line video
1679 standards, 263-286 for 525 line standards) */
1680 __u16 service_lines[2][24];
1681 __u32 type; /* enum v4l2_buf_type */
1682 __u32 reserved[3]; /* must be 0 */
1683};
1684
1685struct v4l2_sliced_vbi_data {
1686 __u32 id;
1687 __u32 field; /* 0: first field, 1: second field */
1688 __u32 line; /* 1-23 */
1689 __u32 reserved; /* must be 0 */
1690 __u8 data[48];
1691};
1692
1693/*
1694 * Sliced VBI data inserted into MPEG Streams
1695 */
1696
1697/*
1698 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1699 *
1700 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1701 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1702 * data
1703 *
1704 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1705 * definitions are not included here. See the MPEG-2 specifications for details
1706 * on these headers.
1707 */
1708
1709/* Line type IDs */
1710#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1711#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1712#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1713#define V4L2_MPEG_VBI_IVTV_VPS (7)
1714
1715struct v4l2_mpeg_vbi_itv0_line {
1716 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1717 __u8 data[42]; /* Sliced VBI data for the line */
1718} __attribute__ ((packed));
1719
1720struct v4l2_mpeg_vbi_itv0 {
1721 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1722 struct v4l2_mpeg_vbi_itv0_line line[35];
1723} __attribute__ ((packed));
1724
1725struct v4l2_mpeg_vbi_ITV0 {
1726 struct v4l2_mpeg_vbi_itv0_line line[36];
1727} __attribute__ ((packed));
1728
1729#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1730#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1731
1732struct v4l2_mpeg_vbi_fmt_ivtv {
1733 __u8 magic[4];
1734 union {
1735 struct v4l2_mpeg_vbi_itv0 itv0;
1736 struct v4l2_mpeg_vbi_ITV0 ITV0;
1737 };
1738} __attribute__ ((packed));
1739
1740/*
1741 * A G G R E G A T E S T R U C T U R E S
1742 */
1743
1744/**
1745 * struct v4l2_plane_pix_format - additional, per-plane format definition
1746 * @sizeimage: maximum size in bytes required for data, for which
1747 * this plane will be used
1748 * @bytesperline: distance in bytes between the leftmost pixels in two
1749 * adjacent lines
1750 */
1751struct v4l2_plane_pix_format {
1752 __u32 sizeimage;
1753 __u16 bytesperline;
1754 __u16 reserved[7];
1755} __attribute__ ((packed));
1756
1757/**
1758 * struct v4l2_pix_format_mplane - multiplanar format definition
1759 * @width: image width in pixels
1760 * @height: image height in pixels
1761 * @pixelformat: little endian four character code (fourcc)
1762 * @field: enum v4l2_field; field order (for interlaced video)
1763 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
1764 * @plane_fmt: per-plane information
1765 * @num_planes: number of planes for this format
Laurent Pinchartc96fd462014-05-27 10:12:43 -03001766 * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
David Howells607ca462012-10-13 10:46:48 +01001767 */
1768struct v4l2_pix_format_mplane {
1769 __u32 width;
1770 __u32 height;
1771 __u32 pixelformat;
1772 __u32 field;
1773 __u32 colorspace;
1774
1775 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1776 __u8 num_planes;
Laurent Pinchartc96fd462014-05-27 10:12:43 -03001777 __u8 flags;
1778 __u8 reserved[10];
David Howells607ca462012-10-13 10:46:48 +01001779} __attribute__ ((packed));
1780
1781/**
Antti Palosaari87185c92014-03-10 10:43:24 -03001782 * struct v4l2_sdr_format - SDR format definition
Antti Palosaari6f3073b2013-12-12 13:34:30 -03001783 * @pixelformat: little endian four character code (fourcc)
1784 */
Antti Palosaari87185c92014-03-10 10:43:24 -03001785struct v4l2_sdr_format {
Antti Palosaari6f3073b2013-12-12 13:34:30 -03001786 __u32 pixelformat;
1787 __u8 reserved[28];
1788} __attribute__ ((packed));
1789
1790/**
David Howells607ca462012-10-13 10:46:48 +01001791 * struct v4l2_format - stream data format
1792 * @type: enum v4l2_buf_type; type of the data stream
1793 * @pix: definition of an image format
1794 * @pix_mp: definition of a multiplanar image format
1795 * @win: definition of an overlaid image
1796 * @vbi: raw VBI capture or output parameters
1797 * @sliced: sliced VBI capture or output parameters
1798 * @raw_data: placeholder for future extensions and custom formats
1799 */
1800struct v4l2_format {
1801 __u32 type;
1802 union {
1803 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
1804 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
1805 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1806 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
1807 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
Antti Palosaari87185c92014-03-10 10:43:24 -03001808 struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
David Howells607ca462012-10-13 10:46:48 +01001809 __u8 raw_data[200]; /* user-defined */
1810 } fmt;
1811};
1812
1813/* Stream type-dependent parameters
1814 */
1815struct v4l2_streamparm {
1816 __u32 type; /* enum v4l2_buf_type */
1817 union {
1818 struct v4l2_captureparm capture;
1819 struct v4l2_outputparm output;
1820 __u8 raw_data[200]; /* user-defined */
1821 } parm;
1822};
1823
1824/*
1825 * E V E N T S
1826 */
1827
1828#define V4L2_EVENT_ALL 0
1829#define V4L2_EVENT_VSYNC 1
1830#define V4L2_EVENT_EOS 2
1831#define V4L2_EVENT_CTRL 3
1832#define V4L2_EVENT_FRAME_SYNC 4
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03001833#define V4L2_EVENT_SOURCE_CHANGE 5
Hans Verkuil78ea6112014-01-27 09:26:23 -03001834#define V4L2_EVENT_MOTION_DET 6
David Howells607ca462012-10-13 10:46:48 +01001835#define V4L2_EVENT_PRIVATE_START 0x08000000
1836
1837/* Payload for V4L2_EVENT_VSYNC */
1838struct v4l2_event_vsync {
1839 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1840 __u8 field;
1841} __attribute__ ((packed));
1842
1843/* Payload for V4L2_EVENT_CTRL */
1844#define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
1845#define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
Sylwester Nawrocki2ccbe772013-01-19 15:51:55 -03001846#define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
David Howells607ca462012-10-13 10:46:48 +01001847
1848struct v4l2_event_ctrl {
1849 __u32 changes;
1850 __u32 type;
1851 union {
1852 __s32 value;
1853 __s64 value64;
1854 };
1855 __u32 flags;
1856 __s32 minimum;
1857 __s32 maximum;
1858 __s32 step;
1859 __s32 default_value;
1860};
1861
1862struct v4l2_event_frame_sync {
1863 __u32 frame_sequence;
1864};
1865
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03001866#define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
1867
1868struct v4l2_event_src_change {
1869 __u32 changes;
1870};
1871
Hans Verkuil78ea6112014-01-27 09:26:23 -03001872#define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
1873
1874/**
1875 * struct v4l2_event_motion_det - motion detection event
1876 * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
1877 * frame_sequence field is valid.
1878 * @frame_sequence: the frame sequence number associated with this event.
1879 * @region_mask: which regions detected motion.
1880 */
1881struct v4l2_event_motion_det {
1882 __u32 flags;
1883 __u32 frame_sequence;
1884 __u32 region_mask;
1885};
1886
David Howells607ca462012-10-13 10:46:48 +01001887struct v4l2_event {
1888 __u32 type;
1889 union {
1890 struct v4l2_event_vsync vsync;
1891 struct v4l2_event_ctrl ctrl;
1892 struct v4l2_event_frame_sync frame_sync;
Arun Kumar K3cbe6e52014-05-14 03:59:42 -03001893 struct v4l2_event_src_change src_change;
Hans Verkuil78ea6112014-01-27 09:26:23 -03001894 struct v4l2_event_motion_det motion_det;
David Howells607ca462012-10-13 10:46:48 +01001895 __u8 data[64];
1896 } u;
1897 __u32 pending;
1898 __u32 sequence;
1899 struct timespec timestamp;
1900 __u32 id;
1901 __u32 reserved[8];
1902};
1903
1904#define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
1905#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
1906
1907struct v4l2_event_subscription {
1908 __u32 type;
1909 __u32 id;
1910 __u32 flags;
1911 __u32 reserved[5];
1912};
1913
1914/*
1915 * A D V A N C E D D E B U G G I N G
1916 *
1917 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
1918 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
1919 */
1920
1921/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
1922
Hans Verkuil79b0c642013-03-18 12:16:34 -03001923#define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
Hans Verkuilb71c9982013-05-26 10:03:01 -03001924#define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
1925
1926/* The following four defines are no longer in use */
Hans Verkuil79b0c642013-03-18 12:16:34 -03001927#define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
1928#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
1929#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Lad, Prabhakarff29feb2013-05-20 06:02:40 -03001930#define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
David Howells607ca462012-10-13 10:46:48 +01001931
1932struct v4l2_dbg_match {
1933 __u32 type; /* Match type */
1934 union { /* Match this chip, meaning determined by type */
1935 __u32 addr;
1936 char name[32];
1937 };
1938} __attribute__ ((packed));
1939
1940struct v4l2_dbg_register {
1941 struct v4l2_dbg_match match;
1942 __u32 size; /* register size in bytes */
1943 __u64 reg;
1944 __u64 val;
1945} __attribute__ ((packed));
1946
Hans Verkuil79b0c642013-03-18 12:16:34 -03001947#define V4L2_CHIP_FL_READABLE (1 << 0)
1948#define V4L2_CHIP_FL_WRITABLE (1 << 1)
1949
Hans Verkuil96b03d22013-04-06 06:16:58 -03001950/* VIDIOC_DBG_G_CHIP_INFO */
1951struct v4l2_dbg_chip_info {
Hans Verkuil79b0c642013-03-18 12:16:34 -03001952 struct v4l2_dbg_match match;
1953 char name[32];
1954 __u32 flags;
Hans Verkuilb8399b82013-04-08 11:53:55 -03001955 __u32 reserved[32];
Hans Verkuil79b0c642013-03-18 12:16:34 -03001956} __attribute__ ((packed));
1957
David Howells607ca462012-10-13 10:46:48 +01001958/**
1959 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
1960 * @index: on return, index of the first created buffer
1961 * @count: entry: number of requested buffers,
1962 * return: number of created buffers
1963 * @memory: enum v4l2_memory; buffer memory type
1964 * @format: frame format, for which buffers are requested
1965 * @reserved: future extensions
1966 */
1967struct v4l2_create_buffers {
1968 __u32 index;
1969 __u32 count;
1970 __u32 memory;
1971 struct v4l2_format format;
1972 __u32 reserved[8];
1973};
1974
1975/*
1976 * 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
1977 *
1978 */
1979#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
1980#define VIDIOC_RESERVED _IO('V', 1)
1981#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
1982#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
1983#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
1984#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
1985#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
1986#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
1987#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
1988#define VIDIOC_OVERLAY _IOW('V', 14, int)
1989#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
Tomasz Stanislawskib799d092012-06-14 11:32:23 -03001990#define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
David Howells607ca462012-10-13 10:46:48 +01001991#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
1992#define VIDIOC_STREAMON _IOW('V', 18, int)
1993#define VIDIOC_STREAMOFF _IOW('V', 19, int)
1994#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
1995#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
1996#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
1997#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
1998#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
1999#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
2000#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
2001#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
2002#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
2003#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
2004#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
2005#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
2006#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
2007#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
2008#define VIDIOC_G_INPUT _IOR('V', 38, int)
2009#define VIDIOC_S_INPUT _IOWR('V', 39, int)
Hans Verkuil254a4772014-03-04 07:46:47 -03002010#define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
2011#define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
David Howells607ca462012-10-13 10:46:48 +01002012#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
2013#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
2014#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
2015#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
2016#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
2017#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
2018#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
2019#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
2020#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
2021#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
2022#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
2023#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
2024#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
2025#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
2026#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
2027#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
2028#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
2029#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
2030#define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
2031#define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
2032#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2033#define VIDIOC_LOG_STATUS _IO('V', 70)
2034#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
2035#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
2036#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
David Howells607ca462012-10-13 10:46:48 +01002037#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
2038#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2039#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
2040#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
2041#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
David Howells607ca462012-10-13 10:46:48 +01002042
David Howells607ca462012-10-13 10:46:48 +01002043/* Experimental, meant for debugging, testing and internal use.
2044 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2045 You must be root to use these ioctls. Never use these in applications! */
2046#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
2047#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
2048
David Howells607ca462012-10-13 10:46:48 +01002049#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
2050
David Howells607ca462012-10-13 10:46:48 +01002051#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
2052#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
2053#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
2054#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
2055#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2056
2057/* Experimental, the below two ioctls may change over the next couple of kernel
2058 versions */
2059#define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
2060#define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
2061
2062/* Experimental selection API */
2063#define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
2064#define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
2065
2066/* Experimental, these two ioctls may change over the next couple of kernel
2067 versions. */
2068#define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
2069#define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
2070
2071/* Experimental, these three ioctls may change over the next couple of kernel
2072 versions. */
2073#define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
2074#define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
2075#define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
2076
2077/* Experimental, this ioctl may change over the next couple of kernel
2078 versions. */
2079#define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
2080
Hans Verkuil79b0c642013-03-18 12:16:34 -03002081/* Experimental, meant for debugging, testing and internal use.
2082 Never use these in applications! */
Hans Verkuil96b03d22013-04-06 06:16:58 -03002083#define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
Hans Verkuil79b0c642013-03-18 12:16:34 -03002084
Hans Verkuil5082c242014-06-10 04:14:50 -03002085#define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2086
David Howells607ca462012-10-13 10:46:48 +01002087/* Reminder: when adding new ioctls please add support for them to
2088 drivers/media/video/v4l2-compat-ioctl32.c as well! */
2089
2090#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
2091
2092#endif /* _UAPI__LINUX_VIDEODEV2_H */