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