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