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