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