blob: 1b72a38b7c8c8789e002df4228872afa3d9a409e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Michael Schimekb1e7df12007-02-07 09:15:01 -03002 * Video for Linux Two header file
3 *
Hans Verkuil8e19b342012-09-03 09:05:10 -03004 * Copyright (C) 1999-2012 the contributors
Michael Schimekb1e7df12007-02-07 09:15:01 -03005 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 *
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030044 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 *
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030049 * See http://linuxtv.org for more info
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 *
Mauro Carvalho Chehab43db48d2007-01-09 11:20:59 -030051 * Author: Bill Dirks <bill@thedirks.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * Justin Schoeman
Michael Schimekb1e7df12007-02-07 09:15:01 -030053 * Hans Verkuil <hverkuil@xs4all.nl>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * et al.
55 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030056#ifndef __LINUX_VIDEODEV2_H
57#define __LINUX_VIDEODEV2_H
David Woodhouse5e6b83e2008-08-16 11:55:04 +010058
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030059#ifdef __KERNEL__
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030060#include <linux/time.h> /* need struct timeval */
Mauro Carvalho Chehab89a58c82006-06-17 07:57:03 -030061#else
Hans Verkuil3d58ffe2007-07-18 18:41:08 -030062#include <sys/time.h>
Eric Sesterhenn845f16a2006-06-06 11:20:08 -030063#endif
David Woodhouse5e6b83e2008-08-16 11:55:04 +010064#include <linux/compiler.h>
Jiri Slaby83db33a2008-02-13 20:04:49 -030065#include <linux/ioctl.h>
David Mosberger-Tangc003d462006-05-26 10:28:13 -030066#include <linux/types.h>
Sakari Ailus5689b282012-05-18 09:31:18 -030067#include <linux/v4l2-common.h>
Hans Verkuil8e19b342012-09-03 09:05:10 -030068#include <linux/v4l2-controls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080070/*
71 * Common stuff for both V4L1 and V4L2
72 * Moved from videodev.h
73 */
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080074#define VIDEO_MAX_FRAME 32
Pawel Osciakf8f39142010-07-29 14:44:25 -030075#define VIDEO_MAX_PLANES 8
Mauro Carvalho Chehab79436632005-11-08 21:37:49 -080076
Hans Verkuilc1d7f4f2008-07-26 08:33:47 -030077#ifndef __KERNEL__
78
79/* These defines are V4L1 specific and should not be used with the V4L2 API!
80 They will be removed from this header in the future. */
81
Michael Schimekc12097f2005-11-08 21:38:24 -080082#define VID_TYPE_CAPTURE 1 /* Can capture */
83#define VID_TYPE_TUNER 2 /* Can tune */
84#define VID_TYPE_TELETEXT 4 /* Does teletext */
85#define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
86#define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
87#define VID_TYPE_CLIPPING 32 /* Can clip */
88#define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
89#define VID_TYPE_SCALES 128 /* Scalable */
90#define VID_TYPE_MONOCHROME 256 /* Monochrome only */
91#define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
92#define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
93#define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
94#define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
95#define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
Hans Verkuilc1d7f4f2008-07-26 08:33:47 -030096#endif
Michael Schimekc12097f2005-11-08 21:38:24 -080097
Linus Torvalds1da177e2005-04-16 15:20:36 -070098/*
99 * M I S C E L L A N E O U S
100 */
101
102/* Four-character-code (FOURCC) */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300103#define v4l2_fourcc(a, b, c, d)\
104 ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106/*
107 * E N U M S
108 */
109enum v4l2_field {
Hans Verkuilb2787842007-04-27 12:31:02 -0300110 V4L2_FIELD_ANY = 0, /* driver can choose from none,
111 top, bottom, interlaced
112 depending on whatever it thinks
113 is approximate ... */
114 V4L2_FIELD_NONE = 1, /* this device has no fields ... */
115 V4L2_FIELD_TOP = 2, /* top field only */
116 V4L2_FIELD_BOTTOM = 3, /* bottom field only */
117 V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
118 V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
119 buffer, top-bottom order */
120 V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
121 V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
122 separate buffers */
123 V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
124 first and the top field is
125 transmitted first */
126 V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
127 first and the bottom field is
128 transmitted first */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129};
130#define V4L2_FIELD_HAS_TOP(field) \
131 ((field) == V4L2_FIELD_TOP ||\
132 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300133 (field) == V4L2_FIELD_INTERLACED_TB ||\
134 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 (field) == V4L2_FIELD_SEQ_TB ||\
136 (field) == V4L2_FIELD_SEQ_BT)
137#define V4L2_FIELD_HAS_BOTTOM(field) \
138 ((field) == V4L2_FIELD_BOTTOM ||\
139 (field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300140 (field) == V4L2_FIELD_INTERLACED_TB ||\
141 (field) == V4L2_FIELD_INTERLACED_BT ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 (field) == V4L2_FIELD_SEQ_TB ||\
143 (field) == V4L2_FIELD_SEQ_BT)
144#define V4L2_FIELD_HAS_BOTH(field) \
145 ((field) == V4L2_FIELD_INTERLACED ||\
Hans Verkuilb2787842007-04-27 12:31:02 -0300146 (field) == V4L2_FIELD_INTERLACED_TB ||\
147 (field) == V4L2_FIELD_INTERLACED_BT ||\
148 (field) == V4L2_FIELD_SEQ_TB ||\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 (field) == V4L2_FIELD_SEQ_BT)
150
151enum v4l2_buf_type {
Hans Verkuilb2787842007-04-27 12:31:02 -0300152 V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
153 V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
154 V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
155 V4L2_BUF_TYPE_VBI_CAPTURE = 4,
156 V4L2_BUF_TYPE_VBI_OUTPUT = 5,
157 V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
158 V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
159#if 1
160 /* Experimental */
161 V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
162#endif
Pawel Osciakf8f39142010-07-29 14:44:25 -0300163 V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
164 V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
Hans Verkuilb2787842007-04-27 12:31:02 -0300165 V4L2_BUF_TYPE_PRIVATE = 0x80,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166};
167
Pawel Osciakf8f39142010-07-29 14:44:25 -0300168#define V4L2_TYPE_IS_MULTIPLANAR(type) \
169 ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE \
170 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
171
172#define V4L2_TYPE_IS_OUTPUT(type) \
173 ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT \
174 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE \
175 || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY \
176 || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY \
177 || (type) == V4L2_BUF_TYPE_VBI_OUTPUT \
178 || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT)
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180enum v4l2_tuner_type {
181 V4L2_TUNER_RADIO = 1,
182 V4L2_TUNER_ANALOG_TV = 2,
183 V4L2_TUNER_DIGITAL_TV = 3,
184};
185
186enum v4l2_memory {
187 V4L2_MEMORY_MMAP = 1,
188 V4L2_MEMORY_USERPTR = 2,
189 V4L2_MEMORY_OVERLAY = 3,
190};
191
192/* see also http://vektor.theorem.ca/graphics/ycbcr/ */
193enum v4l2_colorspace {
194 /* ITU-R 601 -- broadcast NTSC/PAL */
195 V4L2_COLORSPACE_SMPTE170M = 1,
196
197 /* 1125-Line (US) HDTV */
198 V4L2_COLORSPACE_SMPTE240M = 2,
199
200 /* HD and modern captures. */
201 V4L2_COLORSPACE_REC709 = 3,
202
203 /* broken BT878 extents (601, luma range 16-253 instead of 16-235) */
204 V4L2_COLORSPACE_BT878 = 4,
205
206 /* These should be useful. Assume 601 extents. */
207 V4L2_COLORSPACE_470_SYSTEM_M = 5,
208 V4L2_COLORSPACE_470_SYSTEM_BG = 6,
209
210 /* I know there will be cameras that send this. So, this is
211 * unspecified chromaticities and full 0-255 on each of the
212 * Y'CbCr components
213 */
214 V4L2_COLORSPACE_JPEG = 7,
215
216 /* For RGB colourspaces, this is probably a good start. */
217 V4L2_COLORSPACE_SRGB = 8,
218};
219
220enum v4l2_priority {
221 V4L2_PRIORITY_UNSET = 0, /* not initialized */
222 V4L2_PRIORITY_BACKGROUND = 1,
223 V4L2_PRIORITY_INTERACTIVE = 2,
224 V4L2_PRIORITY_RECORD = 3,
225 V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
226};
227
228struct v4l2_rect {
229 __s32 left;
230 __s32 top;
231 __s32 width;
232 __s32 height;
233};
234
235struct v4l2_fract {
236 __u32 numerator;
237 __u32 denominator;
238};
239
Hans Verkuil583aa3a2012-01-11 06:45:05 -0300240/**
241 * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
242 *
243 * @driver: name of the driver module (e.g. "bttv")
244 * @card: name of the card (e.g. "Hauppauge WinTV")
245 * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
246 * @version: KERNEL_VERSION
247 * @capabilities: capabilities of the physical device as a whole
248 * @device_caps: capabilities accessed via this particular device (node)
249 * @reserved: reserved fields for future extensions
250 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300251struct v4l2_capability {
Hans Verkuil583aa3a2012-01-11 06:45:05 -0300252 __u8 driver[16];
253 __u8 card[32];
254 __u8 bus_info[32];
255 __u32 version;
256 __u32 capabilities;
257 __u32 device_caps;
258 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259};
260
261/* Values for 'capabilities' field */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800262#define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
263#define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
264#define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
265#define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
266#define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700267#define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
268#define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800269#define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
Hans Verkuil1f137602007-05-29 08:18:37 -0300270#define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -0300271#define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
Hans Verkuil6ace40e2009-06-20 09:50:39 -0300272#define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Pawel Osciakf8f39142010-07-29 14:44:25 -0300274/* Is a video capture device that supports multiplanar formats */
275#define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
276/* Is a video output device that supports multiplanar formats */
277#define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
Sylwester Nawrockif0476a82012-07-26 09:30:00 -0300278/* Is a video mem-to-mem device that supports multiplanar formats */
279#define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
280/* Is a video mem-to-mem device */
281#define V4L2_CAP_VIDEO_M2M 0x00008000
Pawel Osciakf8f39142010-07-29 14:44:25 -0300282
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800283#define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
284#define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
285#define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
Hans Verkuil6ace40e2009-06-20 09:50:39 -0300286#define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -0700288#define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
289#define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
290#define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Hans Verkuil583aa3a2012-01-11 06:45:05 -0300292#define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294/*
295 * V I D E O I M A G E F O R M A T
296 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300297struct v4l2_pix_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800298 __u32 width;
299 __u32 height;
300 __u32 pixelformat;
Sakari Ailus6016af82012-05-10 02:02:07 -0300301 __u32 field; /* enum v4l2_field */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 __u32 bytesperline; /* for padding, zero if unused */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800303 __u32 sizeimage;
Sakari Ailus6016af82012-05-10 02:02:07 -0300304 __u32 colorspace; /* enum v4l2_colorspace */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 __u32 priv; /* private data, depends on pixelformat */
306};
307
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300308/* Pixel format FOURCC depth Description */
309
310/* RGB formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300311#define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
312#define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
313#define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
314#define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
315#define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
316#define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
Sylwester Nawrocki5fd8f732010-08-03 09:50:29 -0300317#define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300318#define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
319#define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
320#define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
321#define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300322
323/* Grey formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300324#define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
Hans Verkuilb3e212d2010-03-22 04:52:21 -0300325#define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
326#define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300327#define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
Michael Jonesd924de02011-03-29 05:19:06 -0300328#define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300329#define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300330
Antonio Ospite8bb36c22011-04-07 12:45:51 -0300331/* Grey bit-packed formats */
332#define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
333
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300334/* Palette formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300335#define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300336
337/* Luminance+Chrominance formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300338#define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
339#define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
340#define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300341#define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
342#define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300343#define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
Robert Jarzmik69acdf12008-11-04 21:59:37 -0300344#define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300345#define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
346#define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
347#define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
348#define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
349#define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
350#define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
351#define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300352#define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
353#define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
354#define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
355#define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
Hans de Goede0e59fd02011-05-11 09:56:20 -0300356#define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
358/* two planes -- one Y, one Cr + Cb interleaved */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300359#define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
360#define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
Magnus Damm91962fa2008-12-18 11:45:00 -0300361#define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
362#define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
Laurent Pinchart0b9eabd2011-12-13 14:02:27 +0100363#define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
364#define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Sylwester Nawrocki4a3c9b42010-12-28 12:32:39 -0300366/* two non contiguous planes - one Y, one Cr + Cb interleaved */
367#define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
368#define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
369
370/* three non contiguous planes - Y, Cb, Cr */
371#define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
Shaik Ameer Basha8ab02382012-07-31 10:44:02 -0300372#define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
Sylwester Nawrocki4a3c9b42010-12-28 12:32:39 -0300373
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300374/* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300375#define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
376#define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
Mauro Carvalho Chehab509dd022009-06-30 16:07:26 -0300377#define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
Guennadi Liakhovetskiee811522009-12-11 11:15:06 -0300378#define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
379#define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
380#define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
381#define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
382#define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
Laurent Pinchart39187e12010-12-23 11:14:50 -0300383#define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
384#define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
385#define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
386#define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300387 /* 10bit raw bayer DPCM compressed to 8 bits */
Sakari Ailus440f0fa2011-12-28 06:17:26 -0300388#define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
389#define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
Sergio Aguirre733d7102008-10-18 12:26:47 -0300390#define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
Sakari Ailus440f0fa2011-12-28 06:17:26 -0300391#define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
Mauro Carvalho Chehab65dd2f92009-06-30 16:14:17 -0300392 /*
393 * 10bit raw bayer, expanded to 16 bits
394 * xxxxrrrrrrrrrrxxxxgggggggggg xxxxggggggggggxxxxbbbbbbbbbb...
395 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300396#define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398/* compressed formats */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300399#define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
400#define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
401#define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
Kamil Debski4fa64da2011-07-04 13:25:50 -0300402#define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
403#define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
404#define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
405#define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
406#define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
407#define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
408#define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 ES */
409#define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
410#define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
411#define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413/* Vendor-specific formats */
Hans de Goede54e8bc52010-01-14 09:37:18 -0300414#define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300415#define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
416#define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
Brian Johnson26e744b2009-07-19 05:52:58 -0300417#define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300418#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
419#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
420#define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
421#define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
Mauro Carvalho Chehab9fa0f6d2008-07-27 08:55:17 -0300422#define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
423#define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300424#define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
425#define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
Kyle Guinn553d0d82009-01-16 05:28:38 -0300426#define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
Theodore Kilgorefe3449a2011-12-13 18:09:15 -0300427#define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
Theodore Kilgore5bdd00b2009-12-25 05:16:32 -0300428#define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
Theodore Kilgore14a19c02009-03-25 07:13:13 -0300429#define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
Jean-Francois Moinef75c4952008-09-03 16:47:35 -0300430#define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
Hans de Goede1876bb92009-06-14 06:45:50 -0300431#define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
Hans de Goede49809d62009-06-07 12:10:39 -0300432#define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
Hans de Goede21f1b932009-10-23 06:50:12 -0300433#define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
Mauro Carvalho Chehab9701dc92009-09-14 09:42:41 -0300434#define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
Hans de Goede1f33de02010-09-05 16:05:22 -0300435#define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
Hans de Goedeb517af72010-09-05 16:30:30 -0300436#define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
Jean-François Moinece5b2ac2011-03-14 08:49:28 -0300437#define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
Hans de Goede21144ea2011-06-05 08:32:27 -0300438#define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
440/*
441 * F O R M A T E N U M E R A T I O N
442 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300443struct v4l2_fmtdesc {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800444 __u32 index; /* Format number */
Sakari Ailus6016af82012-05-10 02:02:07 -0300445 __u32 type; /* enum v4l2_buf_type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 __u32 flags;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800447 __u8 description[32]; /* Description string */
448 __u32 pixelformat; /* Format fourcc */
449 __u32 reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450};
451
452#define V4L2_FMT_FLAG_COMPRESSED 0x0001
Hans de Goede1e3c1f72009-08-31 11:32:46 -0300453#define V4L2_FMT_FLAG_EMULATED 0x0002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300455#if 1
456 /* Experimental Frame Size and frame rate enumeration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457/*
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300458 * F R A M E S I Z E E N U M E R A T I O N
459 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300460enum v4l2_frmsizetypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300461 V4L2_FRMSIZE_TYPE_DISCRETE = 1,
462 V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
463 V4L2_FRMSIZE_TYPE_STEPWISE = 3,
464};
465
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300466struct v4l2_frmsize_discrete {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300467 __u32 width; /* Frame width [pixel] */
468 __u32 height; /* Frame height [pixel] */
469};
470
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300471struct v4l2_frmsize_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300472 __u32 min_width; /* Minimum frame width [pixel] */
473 __u32 max_width; /* Maximum frame width [pixel] */
474 __u32 step_width; /* Frame width step size [pixel] */
475 __u32 min_height; /* Minimum frame height [pixel] */
476 __u32 max_height; /* Maximum frame height [pixel] */
477 __u32 step_height; /* Frame height step size [pixel] */
478};
479
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300480struct v4l2_frmsizeenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300481 __u32 index; /* Frame size number */
482 __u32 pixel_format; /* Pixel format */
483 __u32 type; /* Frame size type the device supports. */
484
485 union { /* Frame size */
486 struct v4l2_frmsize_discrete discrete;
487 struct v4l2_frmsize_stepwise stepwise;
488 };
489
490 __u32 reserved[2]; /* Reserved space for future use */
491};
492
493/*
494 * F R A M E R A T E E N U M E R A T I O N
495 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300496enum v4l2_frmivaltypes {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300497 V4L2_FRMIVAL_TYPE_DISCRETE = 1,
498 V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
499 V4L2_FRMIVAL_TYPE_STEPWISE = 3,
500};
501
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300502struct v4l2_frmival_stepwise {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300503 struct v4l2_fract min; /* Minimum frame interval [s] */
504 struct v4l2_fract max; /* Maximum frame interval [s] */
505 struct v4l2_fract step; /* Frame interval step size [s] */
506};
507
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300508struct v4l2_frmivalenum {
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300509 __u32 index; /* Frame format index */
510 __u32 pixel_format; /* Pixel format */
511 __u32 width; /* Frame width */
512 __u32 height; /* Frame height */
513 __u32 type; /* Frame interval type the device supports. */
514
515 union { /* Frame interval */
516 struct v4l2_fract discrete;
517 struct v4l2_frmival_stepwise stepwise;
518 };
519
520 __u32 reserved[2]; /* Reserved space for future use */
521};
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -0300522#endif
Laurent Pinchart92b2db02006-09-28 13:42:05 -0300523
524/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 * T I M E C O D E
526 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300527struct v4l2_timecode {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 __u32 type;
529 __u32 flags;
530 __u8 frames;
531 __u8 seconds;
532 __u8 minutes;
533 __u8 hours;
534 __u8 userbits[4];
535};
536
537/* Type */
538#define V4L2_TC_TYPE_24FPS 1
539#define V4L2_TC_TYPE_25FPS 2
540#define V4L2_TC_TYPE_30FPS 3
541#define V4L2_TC_TYPE_50FPS 4
542#define V4L2_TC_TYPE_60FPS 5
543
544/* Flags */
545#define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
546#define V4L2_TC_FLAG_COLORFRAME 0x0002
547#define V4L2_TC_USERBITS_field 0x000C
548#define V4L2_TC_USERBITS_USERDEFINED 0x0000
549#define V4L2_TC_USERBITS_8BITCHARS 0x0008
550/* The above is based on SMPTE timecodes */
551
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300552struct v4l2_jpegcompression {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 int quality;
554
555 int APPn; /* Number of APP segment to be written,
556 * must be 0..15 */
557 int APP_len; /* Length of data in JPEG APPn segment */
558 char APP_data[60]; /* Data in the JPEG APPn segment. */
559
560 int COM_len; /* Length of data in JPEG COM segment */
561 char COM_data[60]; /* Data in JPEG COM segment */
562
563 __u32 jpeg_markers; /* Which markers should go into the JPEG
564 * output. Unless you exactly know what
565 * you do, leave them untouched.
566 * Inluding less markers will make the
567 * resulting code smaller, but there will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200568 * be fewer applications which can read it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 * The presence of the APP and COM marker
570 * is influenced by APP_len and COM_len
571 * ONLY, not by this property! */
572
573#define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
574#define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
575#define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
576#define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
577#define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -0800578 * allways use APP0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579};
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581/*
582 * M E M O R Y - M A P P I N G B U F F E R S
583 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300584struct v4l2_requestbuffers {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800585 __u32 count;
Sakari Ailus6016af82012-05-10 02:02:07 -0300586 __u32 type; /* enum v4l2_buf_type */
587 __u32 memory; /* enum v4l2_memory */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800588 __u32 reserved[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589};
590
Pawel Osciakf8f39142010-07-29 14:44:25 -0300591/**
592 * struct v4l2_plane - plane info for multi-planar buffers
593 * @bytesused: number of bytes occupied by data in the plane (payload)
594 * @length: size of this plane (NOT the payload) in bytes
595 * @mem_offset: when memory in the associated struct v4l2_buffer is
596 * V4L2_MEMORY_MMAP, equals the offset from the start of
597 * the device memory for this plane (or is a "cookie" that
598 * should be passed to mmap() called on the video node)
599 * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
600 * pointing to this plane
601 * @data_offset: offset in the plane to the start of data; usually 0,
602 * unless there is a header in front of the data
603 *
604 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
605 * with two planes can have one plane for Y, and another for interleaved CbCr
606 * components. Each plane can reside in a separate memory buffer, or even in
607 * a completely separate memory node (e.g. in embedded devices).
608 */
609struct v4l2_plane {
610 __u32 bytesused;
611 __u32 length;
612 union {
613 __u32 mem_offset;
614 unsigned long userptr;
615 } m;
616 __u32 data_offset;
617 __u32 reserved[11];
618};
619
620/**
621 * struct v4l2_buffer - video buffer info
622 * @index: id number of the buffer
Sakari Ailus6016af82012-05-10 02:02:07 -0300623 * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
624 * multiplanar buffers);
Pawel Osciakf8f39142010-07-29 14:44:25 -0300625 * @bytesused: number of bytes occupied by data in the buffer (payload);
626 * unused (set to 0) for multiplanar buffers
627 * @flags: buffer informational flags
Sakari Ailus6016af82012-05-10 02:02:07 -0300628 * @field: enum v4l2_field; field order of the image in the buffer
Pawel Osciakf8f39142010-07-29 14:44:25 -0300629 * @timestamp: frame timestamp
630 * @timecode: frame timecode
631 * @sequence: sequence count of this frame
Sakari Ailus6016af82012-05-10 02:02:07 -0300632 * @memory: enum v4l2_memory; the method, in which the actual video data is
633 * passed
Pawel Osciakf8f39142010-07-29 14:44:25 -0300634 * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
635 * offset from the start of the device memory for this plane,
636 * (or a "cookie" that should be passed to mmap() as offset)
637 * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
638 * a userspace pointer pointing to this buffer
639 * @planes: for multiplanar buffers; userspace pointer to the array of plane
640 * info structs for this buffer
641 * @length: size in bytes of the buffer (NOT its payload) for single-plane
642 * buffers (when type != *_MPLANE); number of elements in the
643 * planes array for multi-plane buffers
644 * @input: input number from which the video data has has been captured
645 *
646 * Contains data exchanged by application and driver using one of the Streaming
647 * I/O methods.
648 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300649struct v4l2_buffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 __u32 index;
Sakari Ailus6016af82012-05-10 02:02:07 -0300651 __u32 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 __u32 bytesused;
653 __u32 flags;
Sakari Ailus6016af82012-05-10 02:02:07 -0300654 __u32 field;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 struct timeval timestamp;
656 struct v4l2_timecode timecode;
657 __u32 sequence;
658
659 /* memory location */
Sakari Ailus6016af82012-05-10 02:02:07 -0300660 __u32 memory;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 union {
662 __u32 offset;
663 unsigned long userptr;
Pawel Osciakf8f39142010-07-29 14:44:25 -0300664 struct v4l2_plane *planes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 } m;
666 __u32 length;
Sakari Ailus2b719d72012-05-02 09:40:03 -0300667 __u32 reserved2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 __u32 reserved;
669};
670
671/* Flags for 'flags' field */
672#define V4L2_BUF_FLAG_MAPPED 0x0001 /* Buffer is mapped (flag) */
673#define V4L2_BUF_FLAG_QUEUED 0x0002 /* Buffer is queued for processing */
674#define V4L2_BUF_FLAG_DONE 0x0004 /* Buffer is ready */
675#define V4L2_BUF_FLAG_KEYFRAME 0x0008 /* Image is a keyframe (I-frame) */
676#define V4L2_BUF_FLAG_PFRAME 0x0010 /* Image is a P-frame */
677#define V4L2_BUF_FLAG_BFRAME 0x0020 /* Image is a B-frame */
Pawel Osciakbc0f7f12010-04-28 04:05:21 -0300678/* Buffer is ready, but the data contained within is corrupted. */
679#define V4L2_BUF_FLAG_ERROR 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680#define V4L2_BUF_FLAG_TIMECODE 0x0100 /* timecode field is valid */
Guennadi Liakhovetski21501582011-09-28 11:34:06 -0300681#define V4L2_BUF_FLAG_PREPARED 0x0400 /* Buffer is prepared for queuing */
682/* Cache handling flags */
683#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x0800
684#define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x1000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
686/*
687 * O V E R L A Y P R E V I E W
688 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300689struct v4l2_framebuffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 __u32 capability;
691 __u32 flags;
692/* FIXME: in theory we should pass something like PCI device + memory
693 * region + offset instead of some physical address */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300694 void *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 struct v4l2_pix_format fmt;
696};
697/* Flags for the 'capability' field. Read only */
698#define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
699#define V4L2_FBUF_CAP_CHROMAKEY 0x0002
700#define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
701#define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
Hans Verkuilb2787842007-04-27 12:31:02 -0300702#define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
703#define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300704#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300705#define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706/* Flags for the 'flags' field. */
707#define V4L2_FBUF_FLAG_PRIMARY 0x0001
708#define V4L2_FBUF_FLAG_OVERLAY 0x0002
709#define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
Hans Verkuilb2787842007-04-27 12:31:02 -0300710#define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
711#define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
Hans Verkuilb6cfe6a2007-06-04 04:55:36 -0300712#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
Vaibhav Hiremathd8008562009-11-10 13:46:36 -0300713#define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300715struct v4l2_clip {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 struct v4l2_rect c;
Al Viro5b1a43d2006-02-01 05:24:20 -0500717 struct v4l2_clip __user *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718};
719
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300720struct v4l2_window {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 struct v4l2_rect w;
Sakari Ailus6016af82012-05-10 02:02:07 -0300722 __u32 field; /* enum v4l2_field */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 __u32 chromakey;
724 struct v4l2_clip __user *clips;
725 __u32 clipcount;
726 void __user *bitmap;
Hans Verkuilb2787842007-04-27 12:31:02 -0300727 __u8 global_alpha;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728};
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730/*
731 * C A P T U R E P A R A M E T E R S
732 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300733struct v4l2_captureparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 __u32 capability; /* Supported modes */
735 __u32 capturemode; /* Current mode */
736 struct v4l2_fract timeperframe; /* Time per frame in .1us units */
737 __u32 extendedmode; /* Driver-specific extensions */
738 __u32 readbuffers; /* # of buffers for read */
739 __u32 reserved[4];
740};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -0300741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742/* Flags for 'capability' and 'capturemode' fields */
743#define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
744#define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
745
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300746struct v4l2_outputparm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 __u32 capability; /* Supported modes */
748 __u32 outputmode; /* Current mode */
749 struct v4l2_fract timeperframe; /* Time per frame in seconds */
750 __u32 extendedmode; /* Driver-specific extensions */
751 __u32 writebuffers; /* # of buffers for write */
752 __u32 reserved[4];
753};
754
755/*
756 * I N P U T I M A G E C R O P P I N G
757 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758struct v4l2_cropcap {
Sakari Ailus6016af82012-05-10 02:02:07 -0300759 __u32 type; /* enum v4l2_buf_type */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800760 struct v4l2_rect bounds;
761 struct v4l2_rect defrect;
762 struct v4l2_fract pixelaspect;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763};
764
765struct v4l2_crop {
Sakari Ailus6016af82012-05-10 02:02:07 -0300766 __u32 type; /* enum v4l2_buf_type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 struct v4l2_rect c;
768};
769
Tomasz Stanislawski0e8caac2011-08-10 10:37:47 -0300770/**
771 * struct v4l2_selection - selection info
772 * @type: buffer type (do not use *_MPLANE types)
Sakari Ailus5689b282012-05-18 09:31:18 -0300773 * @target: Selection target, used to choose one of possible rectangles;
774 * defined in v4l2-common.h; V4L2_SEL_TGT_* .
Sakari Ailus563df3d2012-06-13 16:01:10 -0300775 * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
Tomasz Stanislawski0e8caac2011-08-10 10:37:47 -0300776 * @r: coordinates of selection window
777 * @reserved: for future use, rounds structure size to 64 bytes, set to zero
778 *
Sylwester Nawrocki9080d5d2012-03-09 06:46:28 -0300779 * Hardware may use multiple helper windows to process a video stream.
Tomasz Stanislawski0e8caac2011-08-10 10:37:47 -0300780 * The structure is used to exchange this selection areas between
781 * an application and a driver.
782 */
783struct v4l2_selection {
784 __u32 type;
785 __u32 target;
786 __u32 flags;
787 struct v4l2_rect r;
788 __u32 reserved[9];
789};
790
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792/*
793 * A N A L O G V I D E O S T A N D A R D
794 */
795
796typedef __u64 v4l2_std_id;
797
798/* one bit for each */
799#define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
800#define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
801#define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
802#define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
803#define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
804#define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
805#define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
806#define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
807
808#define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
809#define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
810#define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
811#define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
812
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300813#define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
814#define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800815#define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300816#define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
818#define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
819#define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
820#define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
821#define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
822#define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
823#define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
824#define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
Mauro Carvalho Chehab800d3c62005-11-13 16:07:48 -0800825#define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827/* ATSC/HDTV */
828#define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
829#define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
830
Mauro Carvalho Chehab412297d2007-01-07 08:51:05 -0300831/* FIXME:
832 Although std_id is 64 bits, there is an issue on PPC32 architecture that
833 makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
834 this value to 32 bits.
835 As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
836 it should work fine. However, if needed to add more than two standards,
837 v4l2-common.c should be fixed.
838 */
839
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300840/*
841 * Some macros to merge video standards in order to make live easier for the
842 * drivers and V4L2 applications
843 */
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200844
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300845/*
846 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
847 * Missing here.
848 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849#define V4L2_STD_NTSC (V4L2_STD_NTSC_M |\
Hans Verkuild97a11e2006-02-07 06:48:40 -0200850 V4L2_STD_NTSC_M_JP |\
851 V4L2_STD_NTSC_M_KR)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300852/* Secam macros */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853#define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |\
854 V4L2_STD_SECAM_K |\
855 V4L2_STD_SECAM_K1)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300856/* All Secam Standards */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857#define V4L2_STD_SECAM (V4L2_STD_SECAM_B |\
858 V4L2_STD_SECAM_G |\
859 V4L2_STD_SECAM_H |\
860 V4L2_STD_SECAM_DK |\
Mauro Carvalho Chehabf3c59872006-01-09 15:25:00 -0200861 V4L2_STD_SECAM_L |\
862 V4L2_STD_SECAM_LC)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300863/* PAL macros */
864#define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |\
865 V4L2_STD_PAL_B1 |\
866 V4L2_STD_PAL_G)
867#define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |\
868 V4L2_STD_PAL_D1 |\
869 V4L2_STD_PAL_K)
870/*
871 * "Common" PAL - This macro is there to be compatible with the old
872 * V4L1 concept of "PAL": /BGDKHI.
873 * Several PAL standards are mising here: /M, /N and /Nc
874 */
875#define V4L2_STD_PAL (V4L2_STD_PAL_BG |\
876 V4L2_STD_PAL_DK |\
877 V4L2_STD_PAL_H |\
878 V4L2_STD_PAL_I)
879/* Chroma "agnostic" standards */
880#define V4L2_STD_B (V4L2_STD_PAL_B |\
881 V4L2_STD_PAL_B1 |\
882 V4L2_STD_SECAM_B)
883#define V4L2_STD_G (V4L2_STD_PAL_G |\
884 V4L2_STD_SECAM_G)
885#define V4L2_STD_H (V4L2_STD_PAL_H |\
886 V4L2_STD_SECAM_H)
887#define V4L2_STD_L (V4L2_STD_SECAM_L |\
888 V4L2_STD_SECAM_LC)
889#define V4L2_STD_GH (V4L2_STD_G |\
890 V4L2_STD_H)
891#define V4L2_STD_DK (V4L2_STD_PAL_DK |\
892 V4L2_STD_SECAM_DK)
893#define V4L2_STD_BG (V4L2_STD_B |\
894 V4L2_STD_G)
895#define V4L2_STD_MN (V4L2_STD_PAL_M |\
896 V4L2_STD_PAL_N |\
897 V4L2_STD_PAL_Nc |\
898 V4L2_STD_NTSC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300900/* Standards where MTS/BTSC stereo could be found */
901#define V4L2_STD_MTS (V4L2_STD_NTSC_M |\
902 V4L2_STD_PAL_M |\
903 V4L2_STD_PAL_N |\
904 V4L2_STD_PAL_Nc)
905
906/* Standards for Countries with 60Hz Line frequency */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907#define V4L2_STD_525_60 (V4L2_STD_PAL_M |\
908 V4L2_STD_PAL_60 |\
Tyler Traffordf1bcef82005-11-08 21:38:46 -0800909 V4L2_STD_NTSC |\
910 V4L2_STD_NTSC_443)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300911/* Standards for Countries with 50Hz Line frequency */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912#define V4L2_STD_625_50 (V4L2_STD_PAL |\
913 V4L2_STD_PAL_N |\
914 V4L2_STD_PAL_Nc |\
915 V4L2_STD_SECAM)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300916
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917#define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |\
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800918 V4L2_STD_ATSC_16_VSB)
Mauro Carvalho Chehab8d6c0b22011-10-04 16:33:14 -0300919/* Macros with none and all analog standards */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920#define V4L2_STD_UNKNOWN 0
921#define V4L2_STD_ALL (V4L2_STD_525_60 |\
922 V4L2_STD_625_50)
923
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -0300924struct v4l2_standard {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800925 __u32 index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 v4l2_std_id id;
927 __u8 name[24];
928 struct v4l2_fract frameperiod; /* Frames, not fields */
929 __u32 framelines;
930 __u32 reserved[4];
931};
932
Hans Verkuil75916fd2012-05-01 05:29:07 -0300933/* The DV Preset API is deprecated in favor of the DV Timings API.
934 New drivers shouldn't use this anymore! */
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936/*
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300937 * V I D E O T I M I N G S D V P R E S E T
938 */
939struct v4l2_dv_preset {
940 __u32 preset;
941 __u32 reserved[4];
942};
943
944/*
945 * D V P R E S E T S E N U M E R A T I O N
946 */
947struct v4l2_dv_enum_preset {
948 __u32 index;
949 __u32 preset;
950 __u8 name[32]; /* Name of the preset timing */
951 __u32 width;
952 __u32 height;
953 __u32 reserved[4];
954};
955
956/*
957 * D V P R E S E T V A L U E S
958 */
959#define V4L2_DV_INVALID 0
960#define V4L2_DV_480P59_94 1 /* BT.1362 */
961#define V4L2_DV_576P50 2 /* BT.1362 */
962#define V4L2_DV_720P24 3 /* SMPTE 296M */
963#define V4L2_DV_720P25 4 /* SMPTE 296M */
964#define V4L2_DV_720P30 5 /* SMPTE 296M */
965#define V4L2_DV_720P50 6 /* SMPTE 296M */
966#define V4L2_DV_720P59_94 7 /* SMPTE 274M */
967#define V4L2_DV_720P60 8 /* SMPTE 274M/296M */
968#define V4L2_DV_1080I29_97 9 /* BT.1120/ SMPTE 274M */
969#define V4L2_DV_1080I30 10 /* BT.1120/ SMPTE 274M */
970#define V4L2_DV_1080I25 11 /* BT.1120 */
971#define V4L2_DV_1080I50 12 /* SMPTE 296M */
972#define V4L2_DV_1080I60 13 /* SMPTE 296M */
973#define V4L2_DV_1080P24 14 /* SMPTE 296M */
974#define V4L2_DV_1080P25 15 /* SMPTE 296M */
975#define V4L2_DV_1080P30 16 /* SMPTE 296M */
976#define V4L2_DV_1080P50 17 /* BT.1120 */
977#define V4L2_DV_1080P60 18 /* BT.1120 */
978
979/*
980 * D V B T T I M I N G S
981 */
982
Hans Verkuil06bba752012-04-24 09:25:18 -0300983/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
984 * @width: total width of the active video in pixels
985 * @height: total height of the active video in lines
986 * @interlaced: Interlaced or progressive
987 * @polarities: Positive or negative polarities
988 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
989 * @hfrontporch:Horizontal front porch in pixels
990 * @hsync: Horizontal Sync length in pixels
991 * @hbackporch: Horizontal back porch in pixels
992 * @vfrontporch:Vertical front porch in lines
993 * @vsync: Vertical Sync length in lines
994 * @vbackporch: Vertical back porch in lines
995 * @il_vfrontporch:Vertical front porch for the even field
996 * (aka field 2) of interlaced field formats
997 * @il_vsync: Vertical Sync length for the even field
998 * (aka field 2) of interlaced field formats
999 * @il_vbackporch:Vertical back porch for the even field
1000 * (aka field 2) of interlaced field formats
1001 * @standards: Standards the timing belongs to
1002 * @flags: Flags
1003 * @reserved: Reserved fields, must be zeroed.
1004 *
1005 * A note regarding vertical interlaced timings: height refers to the total
1006 * height of the active video frame (= two fields). The blanking timings refer
1007 * to the blanking of each field. So the height of the total frame is
1008 * calculated as follows:
1009 *
1010 * tot_height = height + vfrontporch + vsync + vbackporch +
1011 * il_vfrontporch + il_vsync + il_vbackporch
1012 *
1013 * The active height of each field is height / 2.
1014 */
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001015struct v4l2_bt_timings {
Hans Verkuil06bba752012-04-24 09:25:18 -03001016 __u32 width;
1017 __u32 height;
1018 __u32 interlaced;
1019 __u32 polarities;
1020 __u64 pixelclock;
1021 __u32 hfrontporch;
1022 __u32 hsync;
1023 __u32 hbackporch;
1024 __u32 vfrontporch;
1025 __u32 vsync;
1026 __u32 vbackporch;
1027 __u32 il_vfrontporch;
1028 __u32 il_vsync;
1029 __u32 il_vbackporch;
1030 __u32 standards;
1031 __u32 flags;
1032 __u32 reserved[14];
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001033} __attribute__ ((packed));
1034
1035/* Interlaced or progressive format */
1036#define V4L2_DV_PROGRESSIVE 0
1037#define V4L2_DV_INTERLACED 1
1038
1039/* Polarities. If bit is not set, it is assumed to be negative polarity */
1040#define V4L2_DV_VSYNC_POS_POL 0x00000001
1041#define V4L2_DV_HSYNC_POS_POL 0x00000002
1042
Hans Verkuil06bba752012-04-24 09:25:18 -03001043/* Timings standards */
1044#define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
1045#define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
1046#define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
1047#define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001048
Hans Verkuil06bba752012-04-24 09:25:18 -03001049/* Flags */
1050
1051/* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1052 GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1053 intervals are reduced, allowing a higher resolution over the same
1054 bandwidth. This is a read-only flag. */
1055#define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
1056/* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1057 of six. These formats can be optionally played at 1 / 1.001 speed.
1058 This is a read-only flag. */
1059#define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
1060/* CEA-861 specific: only valid for video transmitters, the flag is cleared
1061 by receivers.
1062 If the framerate of the format is a multiple of six, then the pixelclock
1063 used to set up the transmitter is divided by 1.001 to make it compatible
1064 with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1065 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1066 such frequencies, then the flag will also be cleared. */
1067#define V4L2_DV_FL_REDUCED_FPS (1 << 2)
1068/* Specific to interlaced formats: if set, then field 1 is really one half-line
1069 longer and field 2 is really one half-line shorter, so each field has
1070 exactly the same number of half-lines. Whether half-lines can be detected
1071 or used depends on the hardware. */
1072#define V4L2_DV_FL_HALF_LINE (1 << 0)
1073
1074
1075/** struct v4l2_dv_timings - DV timings
1076 * @type: the type of the timings
1077 * @bt: BT656/1120 timings
1078 */
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001079struct v4l2_dv_timings {
1080 __u32 type;
1081 union {
1082 struct v4l2_bt_timings bt;
1083 __u32 reserved[32];
1084 };
1085} __attribute__ ((packed));
1086
1087/* Values for the type field */
1088#define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
1089
Hans Verkuil06bba752012-04-24 09:25:18 -03001090
1091/** struct v4l2_enum_dv_timings - DV timings enumeration
1092 * @index: enumeration index
1093 * @reserved: must be zeroed
1094 * @timings: the timings for the given index
1095 */
1096struct v4l2_enum_dv_timings {
1097 __u32 index;
1098 __u32 reserved[3];
1099 struct v4l2_dv_timings timings;
1100};
1101
1102/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1103 * @min_width: width in pixels
1104 * @max_width: width in pixels
1105 * @min_height: height in lines
1106 * @max_height: height in lines
1107 * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1108 * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1109 * @standards: Supported standards
1110 * @capabilities: Supported capabilities
1111 * @reserved: Must be zeroed
1112 */
1113struct v4l2_bt_timings_cap {
1114 __u32 min_width;
1115 __u32 max_width;
1116 __u32 min_height;
1117 __u32 max_height;
1118 __u64 min_pixelclock;
1119 __u64 max_pixelclock;
1120 __u32 standards;
1121 __u32 capabilities;
1122 __u32 reserved[16];
1123} __attribute__ ((packed));
1124
1125/* Supports interlaced formats */
1126#define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
1127/* Supports progressive formats */
1128#define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
1129/* Supports CVT/GTF reduced blanking */
1130#define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1131/* Supports custom formats */
1132#define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
1133
1134/** struct v4l2_dv_timings_cap - DV timings capabilities
1135 * @type: the type of the timings (same as in struct v4l2_dv_timings)
1136 * @bt: the BT656/1120 timings capabilities
1137 */
1138struct v4l2_dv_timings_cap {
1139 __u32 type;
1140 __u32 reserved[3];
1141 union {
1142 struct v4l2_bt_timings_cap bt;
1143 __u32 raw_data[32];
1144 };
1145};
1146
1147
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001148/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 * V I D E O I N P U T S
1150 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001151struct v4l2_input {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 __u32 index; /* Which input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001153 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 __u32 type; /* Type of input */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001155 __u32 audioset; /* Associated audios (bitfield) */
Sakari Ailus6016af82012-05-10 02:02:07 -03001156 __u32 tuner; /* enum v4l2_tuner_type */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 v4l2_std_id std;
1158 __u32 status;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001159 __u32 capabilities;
1160 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163/* Values for the 'type' field */
1164#define V4L2_INPUT_TYPE_TUNER 1
1165#define V4L2_INPUT_TYPE_CAMERA 2
1166
1167/* field 'status' - general */
1168#define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
1169#define V4L2_IN_ST_NO_SIGNAL 0x00000002
1170#define V4L2_IN_ST_NO_COLOR 0x00000004
1171
Adam Bakerdfa76fa2009-03-29 19:17:10 -03001172/* field 'status' - sensor orientation */
1173/* If sensor is mounted upside down set both bits */
1174#define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
1175#define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
1176
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177/* field 'status' - analog */
1178#define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
1179#define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
1180
1181/* field 'status' - digital */
1182#define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
1183#define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
1184#define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
1185
1186/* field 'status' - VCR and set-top box */
1187#define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
1188#define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
1189#define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
1190
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001191/* capabilities flags */
1192#define V4L2_IN_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
1193#define V4L2_IN_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1194#define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
1195
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196/*
1197 * V I D E O O U T P U T S
1198 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001199struct v4l2_output {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 __u32 index; /* Which output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001201 __u8 name[32]; /* Label */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 __u32 type; /* Type of output */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001203 __u32 audioset; /* Associated audios (bitfield) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 __u32 modulator; /* Associated modulator */
1205 v4l2_std_id std;
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001206 __u32 capabilities;
1207 __u32 reserved[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208};
1209/* Values for the 'type' field */
1210#define V4L2_OUTPUT_TYPE_MODULATOR 1
1211#define V4L2_OUTPUT_TYPE_ANALOG 2
1212#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
1213
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001214/* capabilities flags */
1215#define V4L2_OUT_CAP_PRESETS 0x00000001 /* Supports S_DV_PRESET */
1216#define V4L2_OUT_CAP_CUSTOM_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
1217#define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
1218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219/*
1220 * C O N T R O L S
1221 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001222struct v4l2_control {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 __u32 id;
1224 __s32 value;
1225};
1226
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001227struct v4l2_ext_control {
Hans Verkuil4f341712006-06-18 13:27:19 -03001228 __u32 id;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001229 __u32 size;
1230 __u32 reserved2[1];
Hans Verkuil4f341712006-06-18 13:27:19 -03001231 union {
1232 __s32 value;
1233 __s64 value64;
Hans Verkuil6b5a9492009-08-11 18:47:18 -03001234 char *string;
Hans Verkuil4f341712006-06-18 13:27:19 -03001235 };
Mauro Carvalho Chehabf251d232006-07-22 08:20:07 -03001236} __attribute__ ((packed));
Hans Verkuil4f341712006-06-18 13:27:19 -03001237
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001238struct v4l2_ext_controls {
Hans Verkuil4f341712006-06-18 13:27:19 -03001239 __u32 ctrl_class;
1240 __u32 count;
1241 __u32 error_idx;
1242 __u32 reserved[2];
1243 struct v4l2_ext_control *controls;
1244};
1245
Hans Verkuil4f341712006-06-18 13:27:19 -03001246#define V4L2_CTRL_ID_MASK (0x0fffffff)
1247#define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
1248#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1249
Hans Verkuilea64f8c2010-04-06 06:53:57 -03001250enum v4l2_ctrl_type {
1251 V4L2_CTRL_TYPE_INTEGER = 1,
1252 V4L2_CTRL_TYPE_BOOLEAN = 2,
1253 V4L2_CTRL_TYPE_MENU = 3,
1254 V4L2_CTRL_TYPE_BUTTON = 4,
1255 V4L2_CTRL_TYPE_INTEGER64 = 5,
1256 V4L2_CTRL_TYPE_CTRL_CLASS = 6,
1257 V4L2_CTRL_TYPE_STRING = 7,
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001258 V4L2_CTRL_TYPE_BITMASK = 8,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001259 V4L2_CTRL_TYPE_INTEGER_MENU = 9,
Hans Verkuilea64f8c2010-04-06 06:53:57 -03001260};
1261
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262/* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001263struct v4l2_queryctrl {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001264 __u32 id;
Sakari Ailus6016af82012-05-10 02:02:07 -03001265 __u32 type; /* enum v4l2_ctrl_type */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 __u8 name[32]; /* Whatever */
1267 __s32 minimum; /* Note signedness */
1268 __s32 maximum;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001269 __s32 step;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 __s32 default_value;
1271 __u32 flags;
1272 __u32 reserved[2];
1273};
1274
1275/* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001276struct v4l2_querymenu {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 __u32 id;
1278 __u32 index;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001279 union {
1280 __u8 name[32]; /* Whatever */
1281 __s64 value;
1282 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 __u32 reserved;
Hans Verkuile245afe2012-04-17 08:41:58 -03001284} __attribute__ ((packed));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285
1286/* Control flags */
1287#define V4L2_CTRL_FLAG_DISABLED 0x0001
1288#define V4L2_CTRL_FLAG_GRABBED 0x0002
Hans Verkuil4f341712006-06-18 13:27:19 -03001289#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
1290#define V4L2_CTRL_FLAG_UPDATE 0x0008
1291#define V4L2_CTRL_FLAG_INACTIVE 0x0010
1292#define V4L2_CTRL_FLAG_SLIDER 0x0020
Hans Verkuil1a367f32009-02-20 05:55:39 -03001293#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
Hans Verkuil74a45792011-08-26 07:31:13 -03001294#define V4L2_CTRL_FLAG_VOLATILE 0x0080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Hans Verkuil4f341712006-06-18 13:27:19 -03001296/* Query flag, to be ORed with the control ID */
1297#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
1298
1299/* User-class control IDs defined by V4L2 */
Dan Carpenter6c061082012-01-05 02:27:57 -03001300#define V4L2_CID_MAX_CTRLS 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301/* IDs reserved for driver specific controls */
1302#define V4L2_CID_PRIVATE_BASE 0x08000000
1303
Sakari Ailusc643ee12012-02-02 20:17:54 -03001304
Hans Verkuil777f4f82012-07-05 10:58:06 -03001305/* DV-class control IDs defined by V4L2 */
1306#define V4L2_CID_DV_CLASS_BASE (V4L2_CTRL_CLASS_DV | 0x900)
1307#define V4L2_CID_DV_CLASS (V4L2_CTRL_CLASS_DV | 1)
1308
1309#define V4L2_CID_DV_TX_HOTPLUG (V4L2_CID_DV_CLASS_BASE + 1)
1310#define V4L2_CID_DV_TX_RXSENSE (V4L2_CID_DV_CLASS_BASE + 2)
1311#define V4L2_CID_DV_TX_EDID_PRESENT (V4L2_CID_DV_CLASS_BASE + 3)
1312#define V4L2_CID_DV_TX_MODE (V4L2_CID_DV_CLASS_BASE + 4)
1313enum v4l2_dv_tx_mode {
1314 V4L2_DV_TX_MODE_DVI_D = 0,
1315 V4L2_DV_TX_MODE_HDMI = 1,
1316};
1317#define V4L2_CID_DV_TX_RGB_RANGE (V4L2_CID_DV_CLASS_BASE + 5)
1318enum v4l2_dv_rgb_range {
1319 V4L2_DV_RGB_RANGE_AUTO = 0,
1320 V4L2_DV_RGB_RANGE_LIMITED = 1,
1321 V4L2_DV_RGB_RANGE_FULL = 2,
1322};
1323
1324#define V4L2_CID_DV_RX_POWER_PRESENT (V4L2_CID_DV_CLASS_BASE + 100)
1325#define V4L2_CID_DV_RX_RGB_RANGE (V4L2_CID_DV_CLASS_BASE + 101)
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327/*
1328 * T U N I N G
1329 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001330struct v4l2_tuner {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 __u32 index;
1332 __u8 name[32];
Sakari Ailus6016af82012-05-10 02:02:07 -03001333 __u32 type; /* enum v4l2_tuner_type */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 __u32 capability;
1335 __u32 rangelow;
1336 __u32 rangehigh;
1337 __u32 rxsubchans;
1338 __u32 audmode;
1339 __s32 signal;
1340 __s32 afc;
1341 __u32 reserved[4];
1342};
1343
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001344struct v4l2_modulator {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 __u32 index;
1346 __u8 name[32];
1347 __u32 capability;
1348 __u32 rangelow;
1349 __u32 rangehigh;
1350 __u32 txsubchans;
1351 __u32 reserved[4];
1352};
1353
1354/* Flags for the 'capability' field */
1355#define V4L2_TUNER_CAP_LOW 0x0001
1356#define V4L2_TUNER_CAP_NORM 0x0002
Hans Verkuil6aeec0e2012-05-27 06:54:29 -03001357#define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
1358#define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359#define V4L2_TUNER_CAP_STEREO 0x0010
1360#define V4L2_TUNER_CAP_LANG2 0x0020
1361#define V4L2_TUNER_CAP_SAP 0x0020
1362#define V4L2_TUNER_CAP_LANG1 0x0040
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001363#define V4L2_TUNER_CAP_RDS 0x0080
Matti Aaltonen44a81552010-10-07 10:16:11 -03001364#define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
1365#define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
Hans Verkuil3d687b42012-07-05 06:04:04 -03001366#define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
Hans de Goedee0a9b172012-07-12 16:55:45 -03001367#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
1369/* Flags for the 'rxsubchans' field */
1370#define V4L2_TUNER_SUB_MONO 0x0001
1371#define V4L2_TUNER_SUB_STEREO 0x0002
1372#define V4L2_TUNER_SUB_LANG2 0x0004
1373#define V4L2_TUNER_SUB_SAP 0x0004
1374#define V4L2_TUNER_SUB_LANG1 0x0008
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001375#define V4L2_TUNER_SUB_RDS 0x0010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377/* Values for the 'audmode' field */
1378#define V4L2_TUNER_MODE_MONO 0x0000
1379#define V4L2_TUNER_MODE_STEREO 0x0001
1380#define V4L2_TUNER_MODE_LANG2 0x0002
1381#define V4L2_TUNER_MODE_SAP 0x0002
1382#define V4L2_TUNER_MODE_LANG1 0x0003
Hans Verkuil301e22d2006-03-18 17:15:00 -03001383#define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001385struct v4l2_frequency {
Hans Verkuil3d687b42012-07-05 06:04:04 -03001386 __u32 tuner;
1387 __u32 type; /* enum v4l2_tuner_type */
1388 __u32 frequency;
1389 __u32 reserved[8];
1390};
1391
1392#define V4L2_BAND_MODULATION_VSB (1 << 1)
1393#define V4L2_BAND_MODULATION_FM (1 << 2)
1394#define V4L2_BAND_MODULATION_AM (1 << 3)
1395
1396struct v4l2_frequency_band {
1397 __u32 tuner;
1398 __u32 type; /* enum v4l2_tuner_type */
1399 __u32 index;
1400 __u32 capability;
1401 __u32 rangelow;
1402 __u32 rangehigh;
1403 __u32 modulation;
1404 __u32 reserved[9];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405};
1406
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001407struct v4l2_hw_freq_seek {
Hans Verkuil3d687b42012-07-05 06:04:04 -03001408 __u32 tuner;
1409 __u32 type; /* enum v4l2_tuner_type */
1410 __u32 seek_upward;
1411 __u32 wrap_around;
1412 __u32 spacing;
Hans de Goedee0a9b172012-07-12 16:55:45 -03001413 __u32 rangelow;
1414 __u32 rangehigh;
1415 __u32 reserved[5];
Tobias Lorenz1d0ba5f2008-05-26 18:40:46 -03001416};
1417
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418/*
Hans Verkuilef5b5b72009-06-20 05:37:27 -03001419 * R D S
1420 */
1421
1422struct v4l2_rds_data {
1423 __u8 lsb;
1424 __u8 msb;
1425 __u8 block;
1426} __attribute__ ((packed));
1427
1428#define V4L2_RDS_BLOCK_MSK 0x7
1429#define V4L2_RDS_BLOCK_A 0
1430#define V4L2_RDS_BLOCK_B 1
1431#define V4L2_RDS_BLOCK_C 2
1432#define V4L2_RDS_BLOCK_D 3
1433#define V4L2_RDS_BLOCK_C_ALT 4
1434#define V4L2_RDS_BLOCK_INVALID 7
1435
1436#define V4L2_RDS_BLOCK_CORRECTED 0x40
1437#define V4L2_RDS_BLOCK_ERROR 0x80
1438
1439/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 * A U D I O
1441 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001442struct v4l2_audio {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 __u32 index;
1444 __u8 name[32];
1445 __u32 capability;
1446 __u32 mode;
1447 __u32 reserved[2];
1448};
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -03001449
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450/* Flags for the 'capability' field */
1451#define V4L2_AUDCAP_STEREO 0x00001
1452#define V4L2_AUDCAP_AVL 0x00002
1453
1454/* Flags for the 'mode' field */
1455#define V4L2_AUDMODE_AVL 0x00001
1456
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001457struct v4l2_audioout {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 __u32 index;
1459 __u8 name[32];
1460 __u32 capability;
1461 __u32 mode;
1462 __u32 reserved[2];
1463};
1464
1465/*
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001466 * M P E G S E R V I C E S
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001467 *
1468 * NOTE: EXPERIMENTAL API
1469 */
1470#if 1
1471#define V4L2_ENC_IDX_FRAME_I (0)
1472#define V4L2_ENC_IDX_FRAME_P (1)
1473#define V4L2_ENC_IDX_FRAME_B (2)
1474#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1475
1476struct v4l2_enc_idx_entry {
1477 __u64 offset;
1478 __u64 pts;
1479 __u32 length;
1480 __u32 flags;
1481 __u32 reserved[2];
1482};
1483
1484#define V4L2_ENC_IDX_ENTRIES (64)
1485struct v4l2_enc_idx {
1486 __u32 entries;
1487 __u32 entries_cap;
1488 __u32 reserved[4];
1489 struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1490};
Hans Verkuilada6ecd2007-02-18 14:56:22 -03001491
1492
1493#define V4L2_ENC_CMD_START (0)
1494#define V4L2_ENC_CMD_STOP (1)
1495#define V4L2_ENC_CMD_PAUSE (2)
1496#define V4L2_ENC_CMD_RESUME (3)
1497
1498/* Flags for V4L2_ENC_CMD_STOP */
1499#define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
1500
1501struct v4l2_encoder_cmd {
1502 __u32 cmd;
1503 __u32 flags;
1504 union {
1505 struct {
1506 __u32 data[8];
1507 } raw;
1508 };
1509};
1510
Hans Verkuila45c0ad2011-11-24 09:53:43 -03001511/* Decoder commands */
1512#define V4L2_DEC_CMD_START (0)
1513#define V4L2_DEC_CMD_STOP (1)
1514#define V4L2_DEC_CMD_PAUSE (2)
1515#define V4L2_DEC_CMD_RESUME (3)
1516
1517/* Flags for V4L2_DEC_CMD_START */
1518#define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
1519
1520/* Flags for V4L2_DEC_CMD_PAUSE */
1521#define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
1522
1523/* Flags for V4L2_DEC_CMD_STOP */
1524#define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
1525#define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
1526
1527/* Play format requirements (returned by the driver): */
1528
1529/* The decoder has no special format requirements */
1530#define V4L2_DEC_START_FMT_NONE (0)
1531/* The decoder requires full GOPs */
1532#define V4L2_DEC_START_FMT_GOP (1)
1533
1534/* The structure must be zeroed before use by the application
1535 This ensures it can be extended safely in the future. */
1536struct v4l2_decoder_cmd {
1537 __u32 cmd;
1538 __u32 flags;
1539 union {
1540 struct {
1541 __u64 pts;
1542 } stop;
1543
1544 struct {
1545 /* 0 or 1000 specifies normal speed,
1546 1 specifies forward single stepping,
1547 -1 specifies backward single stepping,
1548 >1: playback at speed/1000 of the normal speed,
1549 <-1: reverse playback at (-speed/1000) of the normal speed. */
1550 __s32 speed;
1551 __u32 format;
1552 } start;
1553
1554 struct {
1555 __u32 data[16];
1556 } raw;
1557 };
1558};
Hans Verkuildb6eb5b2007-02-18 14:05:02 -03001559#endif
1560
1561
1562/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 * D A T A S E R V I C E S ( V B I )
1564 *
1565 * Data services API by Michael Schimek
1566 */
1567
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001568/* Raw VBI */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001569struct v4l2_vbi_format {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 __u32 sampling_rate; /* in 1 Hz */
1571 __u32 offset;
1572 __u32 samples_per_line;
1573 __u32 sample_format; /* V4L2_PIX_FMT_* */
1574 __s32 start[2];
1575 __u32 count[2];
1576 __u32 flags; /* V4L2_VBI_* */
1577 __u32 reserved[2]; /* must be zero */
1578};
1579
1580/* VBI flags */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001581#define V4L2_VBI_UNSYNC (1 << 0)
1582#define V4L2_VBI_INTERLACED (1 << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001584/* Sliced VBI
1585 *
1586 * This implements is a proposal V4L2 API to allow SLICED VBI
1587 * required for some hardware encoders. It should change without
1588 * notice in the definitive implementation.
1589 */
1590
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001591struct v4l2_sliced_vbi_format {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001592 __u16 service_set;
1593 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1594 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001595 (equals frame lines 313-336 for 625 line video
1596 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001597 __u16 service_lines[2][24];
1598 __u32 io_size;
1599 __u32 reserved[2]; /* must be zero */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001600};
1601
Mauro Carvalho Chehab4d0dddb2006-01-23 17:11:07 -02001602/* Teletext World System Teletext
1603 (WST), defined on ITU-R BT.653-2 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001604#define V4L2_SLICED_TELETEXT_B (0x0001)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001605/* Video Program System, defined on ETS 300 231*/
Hans Verkuil9bc74002006-03-29 18:02:51 -03001606#define V4L2_SLICED_VPS (0x0400)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001607/* Closed Caption, defined on EIA-608 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001608#define V4L2_SLICED_CAPTION_525 (0x1000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001609/* Wide Screen System, defined on ITU-R BT1119.1 */
Hans Verkuil9bc74002006-03-29 18:02:51 -03001610#define V4L2_SLICED_WSS_625 (0x4000)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001611
Hans Verkuil9bc74002006-03-29 18:02:51 -03001612#define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
1613#define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
Mauro Carvalho Chehab6ac48b42006-01-23 17:11:05 -02001614
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001615struct v4l2_sliced_vbi_cap {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001616 __u16 service_set;
1617 /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
1618 service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
Mauro Carvalho Chehabf2421ca2005-11-08 21:37:45 -08001619 (equals frame lines 313-336 for 625 line video
1620 standards, 263-286 for 525 line standards) */
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001621 __u16 service_lines[2][24];
Sakari Ailus6016af82012-05-10 02:02:07 -03001622 __u32 type; /* enum v4l2_buf_type */
Hans Verkuil1739ade2006-08-26 03:05:17 -03001623 __u32 reserved[3]; /* must be 0 */
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001624};
1625
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001626struct v4l2_sliced_vbi_data {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -08001627 __u32 id;
1628 __u32 field; /* 0: first field, 1: second field */
1629 __u32 line; /* 1-23 */
1630 __u32 reserved; /* must be 0 */
1631 __u8 data[48];
Mauro Carvalho Chehab9db45502005-09-13 01:25:40 -07001632};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
1634/*
Andy Walls6273fda2009-03-14 17:06:07 -03001635 * Sliced VBI data inserted into MPEG Streams
1636 */
1637
1638/*
1639 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
1640 *
1641 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
1642 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
1643 * data
1644 *
1645 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
1646 * definitions are not included here. See the MPEG-2 specifications for details
1647 * on these headers.
1648 */
1649
1650/* Line type IDs */
1651#define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
1652#define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
1653#define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
1654#define V4L2_MPEG_VBI_IVTV_VPS (7)
1655
1656struct v4l2_mpeg_vbi_itv0_line {
1657 __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
1658 __u8 data[42]; /* Sliced VBI data for the line */
1659} __attribute__ ((packed));
1660
1661struct v4l2_mpeg_vbi_itv0 {
1662 __le32 linemask[2]; /* Bitmasks of VBI service lines present */
1663 struct v4l2_mpeg_vbi_itv0_line line[35];
1664} __attribute__ ((packed));
1665
1666struct v4l2_mpeg_vbi_ITV0 {
1667 struct v4l2_mpeg_vbi_itv0_line line[36];
1668} __attribute__ ((packed));
1669
1670#define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
1671#define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
1672
1673struct v4l2_mpeg_vbi_fmt_ivtv {
1674 __u8 magic[4];
1675 union {
1676 struct v4l2_mpeg_vbi_itv0 itv0;
1677 struct v4l2_mpeg_vbi_ITV0 ITV0;
1678 };
1679} __attribute__ ((packed));
1680
1681/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 * A G G R E G A T E S T R U C T U R E S
1683 */
1684
Pawel Osciakf8f39142010-07-29 14:44:25 -03001685/**
1686 * struct v4l2_plane_pix_format - additional, per-plane format definition
1687 * @sizeimage: maximum size in bytes required for data, for which
1688 * this plane will be used
1689 * @bytesperline: distance in bytes between the leftmost pixels in two
1690 * adjacent lines
1691 */
1692struct v4l2_plane_pix_format {
1693 __u32 sizeimage;
1694 __u16 bytesperline;
1695 __u16 reserved[7];
1696} __attribute__ ((packed));
1697
1698/**
1699 * struct v4l2_pix_format_mplane - multiplanar format definition
1700 * @width: image width in pixels
1701 * @height: image height in pixels
1702 * @pixelformat: little endian four character code (fourcc)
Sakari Ailus6016af82012-05-10 02:02:07 -03001703 * @field: enum v4l2_field; field order (for interlaced video)
1704 * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
Pawel Osciakf8f39142010-07-29 14:44:25 -03001705 * @plane_fmt: per-plane information
1706 * @num_planes: number of planes for this format
1707 */
1708struct v4l2_pix_format_mplane {
1709 __u32 width;
1710 __u32 height;
1711 __u32 pixelformat;
Sakari Ailus6016af82012-05-10 02:02:07 -03001712 __u32 field;
1713 __u32 colorspace;
Pawel Osciakf8f39142010-07-29 14:44:25 -03001714
1715 struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
1716 __u8 num_planes;
1717 __u8 reserved[11];
1718} __attribute__ ((packed));
1719
1720/**
1721 * struct v4l2_format - stream data format
Sakari Ailus6016af82012-05-10 02:02:07 -03001722 * @type: enum v4l2_buf_type; type of the data stream
Pawel Osciakf8f39142010-07-29 14:44:25 -03001723 * @pix: definition of an image format
1724 * @pix_mp: definition of a multiplanar image format
1725 * @win: definition of an overlaid image
1726 * @vbi: raw VBI capture or output parameters
1727 * @sliced: sliced VBI capture or output parameters
1728 * @raw_data: placeholder for future extensions and custom formats
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001730struct v4l2_format {
Sakari Ailus6016af82012-05-10 02:02:07 -03001731 __u32 type;
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001732 union {
1733 struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
Pawel Osciakf8f39142010-07-29 14:44:25 -03001734 struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001735 struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
1736 struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
1737 struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
1738 __u8 raw_data[200]; /* user-defined */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 } fmt;
1740};
1741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742/* Stream type-dependent parameters
1743 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001744struct v4l2_streamparm {
Sakari Ailus6016af82012-05-10 02:02:07 -03001745 __u32 type; /* enum v4l2_buf_type */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001746 union {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 struct v4l2_captureparm capture;
1748 struct v4l2_outputparm output;
1749 __u8 raw_data[200]; /* user-defined */
1750 } parm;
1751};
1752
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753/*
Sakari Ailusfda10212010-02-24 19:19:05 -03001754 * E V E N T S
1755 */
1756
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001757#define V4L2_EVENT_ALL 0
1758#define V4L2_EVENT_VSYNC 1
1759#define V4L2_EVENT_EOS 2
Hans Verkuil6e239392011-06-07 11:13:44 -03001760#define V4L2_EVENT_CTRL 3
Sakari Ailuseab00a02011-07-18 08:40:03 -03001761#define V4L2_EVENT_FRAME_SYNC 4
Hans Verkuil1bcaf4b2010-03-27 14:09:52 -03001762#define V4L2_EVENT_PRIVATE_START 0x08000000
1763
1764/* Payload for V4L2_EVENT_VSYNC */
1765struct v4l2_event_vsync {
1766 /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
1767 __u8 field;
1768} __attribute__ ((packed));
1769
Hans Verkuil6e239392011-06-07 11:13:44 -03001770/* Payload for V4L2_EVENT_CTRL */
1771#define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
1772#define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
1773
1774struct v4l2_event_ctrl {
1775 __u32 changes;
1776 __u32 type;
1777 union {
1778 __s32 value;
1779 __s64 value64;
1780 };
1781 __u32 flags;
1782 __s32 minimum;
1783 __s32 maximum;
1784 __s32 step;
1785 __s32 default_value;
1786};
1787
Sakari Ailuseab00a02011-07-18 08:40:03 -03001788struct v4l2_event_frame_sync {
1789 __u32 frame_sequence;
1790};
1791
Sakari Ailusfda10212010-02-24 19:19:05 -03001792struct v4l2_event {
1793 __u32 type;
1794 union {
Sakari Ailuseab00a02011-07-18 08:40:03 -03001795 struct v4l2_event_vsync vsync;
1796 struct v4l2_event_ctrl ctrl;
1797 struct v4l2_event_frame_sync frame_sync;
1798 __u8 data[64];
Sakari Ailusfda10212010-02-24 19:19:05 -03001799 } u;
1800 __u32 pending;
1801 __u32 sequence;
1802 struct timespec timestamp;
Hans Verkuil6e239392011-06-07 11:13:44 -03001803 __u32 id;
1804 __u32 reserved[8];
Sakari Ailusfda10212010-02-24 19:19:05 -03001805};
1806
Hans Verkuil60c07322011-06-29 08:56:22 -03001807#define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
1808#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
Hans Verkuil6e239392011-06-07 11:13:44 -03001809
Sakari Ailusfda10212010-02-24 19:19:05 -03001810struct v4l2_event_subscription {
1811 __u32 type;
Hans Verkuil6e239392011-06-07 11:13:44 -03001812 __u32 id;
1813 __u32 flags;
1814 __u32 reserved[5];
Sakari Ailusfda10212010-02-24 19:19:05 -03001815};
1816
Sakari Ailusfda10212010-02-24 19:19:05 -03001817/*
Trent Piepho52ebc762007-01-23 22:38:13 -03001818 * A D V A N C E D D E B U G G I N G
Hans Verkuilf3502b82007-02-23 21:16:01 -03001819 *
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001820 * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
1821 * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
Trent Piepho52ebc762007-01-23 22:38:13 -03001822 */
1823
1824/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001825
Hans Verkuilf3502b82007-02-23 21:16:01 -03001826#define V4L2_CHIP_MATCH_HOST 0 /* Match against chip ID on host (0 for the host) */
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001827#define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
Hans Verkuilf3502b82007-02-23 21:16:01 -03001828#define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
Mauro Carvalho Chehab531c98e2008-12-22 13:18:27 -03001829#define V4L2_CHIP_MATCH_AC97 3 /* Match against anciliary AC97 chip */
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001830
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001831struct v4l2_dbg_match {
1832 __u32 type; /* Match type */
1833 union { /* Match this chip, meaning determined by type */
1834 __u32 addr;
1835 char name[32];
1836 };
1837} __attribute__ ((packed));
1838
1839struct v4l2_dbg_register {
1840 struct v4l2_dbg_match match;
1841 __u32 size; /* register size in bytes */
Trent Piephoe7b58f52007-01-30 22:47:18 -03001842 __u64 reg;
Hans Verkuilf3d092b2007-02-23 20:55:14 -03001843 __u64 val;
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001844} __attribute__ ((packed));
Trent Piepho52ebc762007-01-23 22:38:13 -03001845
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001846/* VIDIOC_DBG_G_CHIP_IDENT */
1847struct v4l2_dbg_chip_ident {
1848 struct v4l2_dbg_match match;
1849 __u32 ident; /* chip identifier as specified in <media/v4l2-chip-ident.h> */
1850 __u32 revision; /* chip revision, chip specific */
1851} __attribute__ ((packed));
1852
Guennadi Liakhovetski09362ec2011-09-07 18:07:23 -03001853/**
1854 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
1855 * @index: on return, index of the first created buffer
1856 * @count: entry: number of requested buffers,
1857 * return: number of created buffers
Sakari Ailus6016af82012-05-10 02:02:07 -03001858 * @memory: enum v4l2_memory; buffer memory type
Guennadi Liakhovetski09362ec2011-09-07 18:07:23 -03001859 * @format: frame format, for which buffers are requested
1860 * @reserved: future extensions
1861 */
Guennadi Liakhovetski21501582011-09-28 11:34:06 -03001862struct v4l2_create_buffers {
Guennadi Liakhovetski09362ec2011-09-07 18:07:23 -03001863 __u32 index;
Guennadi Liakhovetski21501582011-09-28 11:34:06 -03001864 __u32 count;
Sakari Ailus6016af82012-05-10 02:02:07 -03001865 __u32 memory;
Guennadi Liakhovetski09362ec2011-09-07 18:07:23 -03001866 struct v4l2_format format;
Guennadi Liakhovetski21501582011-09-28 11:34:06 -03001867 __u32 reserved[8];
1868};
1869
Trent Piepho52ebc762007-01-23 22:38:13 -03001870/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 * 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
1872 *
1873 */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001874#define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
1875#define VIDIOC_RESERVED _IO('V', 1)
1876#define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
1877#define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
1878#define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
1879#define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
1880#define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
1881#define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
1882#define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
1883#define VIDIOC_OVERLAY _IOW('V', 14, int)
1884#define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
1885#define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
1886#define VIDIOC_STREAMON _IOW('V', 18, int)
1887#define VIDIOC_STREAMOFF _IOW('V', 19, int)
1888#define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
1889#define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
1890#define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
1891#define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
1892#define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
1893#define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
1894#define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
1895#define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
1896#define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
1897#define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
1898#define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
1899#define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
1900#define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
1901#define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
1902#define VIDIOC_G_INPUT _IOR('V', 38, int)
1903#define VIDIOC_S_INPUT _IOWR('V', 39, int)
1904#define VIDIOC_G_OUTPUT _IOR('V', 46, int)
1905#define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
1906#define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
1907#define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
1908#define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
1909#define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
1910#define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
1911#define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
1912#define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
1913#define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
1914#define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
1915#define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
1916#define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
1917#define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
1918#define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
1919#define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
1920#define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
1921#define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
Sakari Ailus6016af82012-05-10 02:02:07 -03001922#define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
1923#define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001924#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
1925#define VIDIOC_LOG_STATUS _IO('V', 70)
1926#define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
1927#define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
1928#define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001929#if 1
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001930#define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
1931#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
1932#define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
1933#define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
1934#define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
Mauro Carvalho Chehabdcc29cb2006-09-28 13:48:26 -03001935#endif
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001936
1937#if 1
1938/* Experimental, meant for debugging, testing and internal use.
1939 Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
1940 You must be root to use these ioctls. Never use these in applications! */
1941#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
1942#define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
1943
1944/* Experimental, meant for debugging, testing and internal use.
1945 Never use this ioctl in applications! */
1946#define VIDIOC_DBG_G_CHIP_IDENT _IOWR('V', 81, struct v4l2_dbg_chip_ident)
Hans Verkuilaecde8b2008-12-30 07:14:19 -03001947#endif
1948
Mauro Carvalho Chehab9993e512008-07-26 13:53:46 -03001949#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
Hans Verkuil75916fd2012-05-01 05:29:07 -03001950
1951/* These four DV Preset ioctls are deprecated in favor of the DV Timings
1952 ioctls. */
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001953#define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset)
1954#define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset)
1955#define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)
1956#define VIDIOC_QUERY_DV_PRESET _IOR('V', 86, struct v4l2_dv_preset)
1957#define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
1958#define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
Sakari Ailusfda10212010-02-24 19:19:05 -03001959#define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
1960#define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
1961#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
Muralidharan Karicherib6456c02009-11-19 12:00:31 -03001962
Guennadi Liakhovetski21501582011-09-28 11:34:06 -03001963/* Experimental, the below two ioctls may change over the next couple of kernel
1964 versions */
1965#define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
1966#define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
1967
Tomasz Stanislawski0e8caac2011-08-10 10:37:47 -03001968/* Experimental selection API */
1969#define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
1970#define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
1971
Hans Verkuila45c0ad2011-11-24 09:53:43 -03001972/* Experimental, these two ioctls may change over the next couple of kernel
1973 versions. */
1974#define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
1975#define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
1976
Hans Verkuil06bba752012-04-24 09:25:18 -03001977/* Experimental, these three ioctls may change over the next couple of kernel
1978 versions. */
Hans Verkuil1761a1102012-06-07 11:20:31 -03001979#define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
1980#define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
1981#define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
Hans Verkuil06bba752012-04-24 09:25:18 -03001982
Hans Verkuil3d687b42012-07-05 06:04:04 -03001983/* Experimental, this ioctl may change over the next couple of kernel
1984 versions. */
1985#define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
1986
Hans Verkuil92f45ba2008-12-21 10:35:25 -03001987/* Reminder: when adding new ioctls please add support for them to
1988 drivers/media/video/v4l2-compat-ioctl32.c as well! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
1991
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992#endif /* __LINUX_VIDEODEV2_H */