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