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