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