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