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