linux/include/uapi/linux/videodev2.h
<<
>>
Prefs
   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 */
  88enum v4l2_field {
  89        V4L2_FIELD_ANY           = 0, /* driver can choose from none,
  90                                         top, bottom, interlaced
  91                                         depending on whatever it thinks
  92                                         is approximate ... */
  93        V4L2_FIELD_NONE          = 1, /* this device has no fields ... */
  94        V4L2_FIELD_TOP           = 2, /* top field only */
  95        V4L2_FIELD_BOTTOM        = 3, /* bottom field only */
  96        V4L2_FIELD_INTERLACED    = 4, /* both fields interlaced */
  97        V4L2_FIELD_SEQ_TB        = 5, /* both fields sequential into one
  98                                         buffer, top-bottom order */
  99        V4L2_FIELD_SEQ_BT        = 6, /* same as above + bottom-top order */
 100        V4L2_FIELD_ALTERNATE     = 7, /* both fields alternating into
 101                                         separate buffers */
 102        V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
 103                                         first and the top field is
 104                                         transmitted first */
 105        V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
 106                                         first and the bottom field is
 107                                         transmitted first */
 108};
 109#define V4L2_FIELD_HAS_TOP(field)       \
 110        ((field) == V4L2_FIELD_TOP      ||\
 111         (field) == V4L2_FIELD_INTERLACED ||\
 112         (field) == V4L2_FIELD_INTERLACED_TB ||\
 113         (field) == V4L2_FIELD_INTERLACED_BT ||\
 114         (field) == V4L2_FIELD_SEQ_TB   ||\
 115         (field) == V4L2_FIELD_SEQ_BT)
 116#define V4L2_FIELD_HAS_BOTTOM(field)    \
 117        ((field) == V4L2_FIELD_BOTTOM   ||\
 118         (field) == V4L2_FIELD_INTERLACED ||\
 119         (field) == V4L2_FIELD_INTERLACED_TB ||\
 120         (field) == V4L2_FIELD_INTERLACED_BT ||\
 121         (field) == V4L2_FIELD_SEQ_TB   ||\
 122         (field) == V4L2_FIELD_SEQ_BT)
 123#define V4L2_FIELD_HAS_BOTH(field)      \
 124        ((field) == V4L2_FIELD_INTERLACED ||\
 125         (field) == V4L2_FIELD_INTERLACED_TB ||\
 126         (field) == V4L2_FIELD_INTERLACED_BT ||\
 127         (field) == V4L2_FIELD_SEQ_TB ||\
 128         (field) == V4L2_FIELD_SEQ_BT)
 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
 141enum 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
 174enum 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
 185enum 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/ */
 193enum 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
 259enum 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
 300enum 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 */
 352enum 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
 372enum 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
 405enum 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
 413struct v4l2_rect {
 414        __s32   left;
 415        __s32   top;
 416        __u32   width;
 417        __u32   height;
 418};
 419
 420struct 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  */
 436struct 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 */
 490struct 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 */
 768struct 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#define V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM     0x0004
 780#define V4L2_FMT_FLAG_DYN_RESOLUTION            0x0008
 781
 782        /* Frame Size and frame rate enumeration */
 783/*
 784 *      F R A M E   S I Z E   E N U M E R A T I O N
 785 */
 786enum v4l2_frmsizetypes {
 787        V4L2_FRMSIZE_TYPE_DISCRETE      = 1,
 788        V4L2_FRMSIZE_TYPE_CONTINUOUS    = 2,
 789        V4L2_FRMSIZE_TYPE_STEPWISE      = 3,
 790};
 791
 792struct v4l2_frmsize_discrete {
 793        __u32                   width;          /* Frame width [pixel] */
 794        __u32                   height;         /* Frame height [pixel] */
 795};
 796
 797struct v4l2_frmsize_stepwise {
 798        __u32                   min_width;      /* Minimum frame width [pixel] */
 799        __u32                   max_width;      /* Maximum frame width [pixel] */
 800        __u32                   step_width;     /* Frame width step size [pixel] */
 801        __u32                   min_height;     /* Minimum frame height [pixel] */
 802        __u32                   max_height;     /* Maximum frame height [pixel] */
 803        __u32                   step_height;    /* Frame height step size [pixel] */
 804};
 805
 806struct v4l2_frmsizeenum {
 807        __u32                   index;          /* Frame size number */
 808        __u32                   pixel_format;   /* Pixel format */
 809        __u32                   type;           /* Frame size type the device supports. */
 810
 811        union {                                 /* Frame size */
 812                struct v4l2_frmsize_discrete    discrete;
 813                struct v4l2_frmsize_stepwise    stepwise;
 814        };
 815
 816        __u32   reserved[2];                    /* Reserved space for future use */
 817};
 818
 819/*
 820 *      F R A M E   R A T E   E N U M E R A T I O N
 821 */
 822enum v4l2_frmivaltypes {
 823        V4L2_FRMIVAL_TYPE_DISCRETE      = 1,
 824        V4L2_FRMIVAL_TYPE_CONTINUOUS    = 2,
 825        V4L2_FRMIVAL_TYPE_STEPWISE      = 3,
 826};
 827
 828struct v4l2_frmival_stepwise {
 829        struct v4l2_fract       min;            /* Minimum frame interval [s] */
 830        struct v4l2_fract       max;            /* Maximum frame interval [s] */
 831        struct v4l2_fract       step;           /* Frame interval step size [s] */
 832};
 833
 834struct v4l2_frmivalenum {
 835        __u32                   index;          /* Frame format index */
 836        __u32                   pixel_format;   /* Pixel format */
 837        __u32                   width;          /* Frame width */
 838        __u32                   height;         /* Frame height */
 839        __u32                   type;           /* Frame interval type the device supports. */
 840
 841        union {                                 /* Frame interval */
 842                struct v4l2_fract               discrete;
 843                struct v4l2_frmival_stepwise    stepwise;
 844        };
 845
 846        __u32   reserved[2];                    /* Reserved space for future use */
 847};
 848
 849/*
 850 *      T I M E C O D E
 851 */
 852struct v4l2_timecode {
 853        __u32   type;
 854        __u32   flags;
 855        __u8    frames;
 856        __u8    seconds;
 857        __u8    minutes;
 858        __u8    hours;
 859        __u8    userbits[4];
 860};
 861
 862/*  Type  */
 863#define V4L2_TC_TYPE_24FPS              1
 864#define V4L2_TC_TYPE_25FPS              2
 865#define V4L2_TC_TYPE_30FPS              3
 866#define V4L2_TC_TYPE_50FPS              4
 867#define V4L2_TC_TYPE_60FPS              5
 868
 869/*  Flags  */
 870#define V4L2_TC_FLAG_DROPFRAME          0x0001 /* "drop-frame" mode */
 871#define V4L2_TC_FLAG_COLORFRAME         0x0002
 872#define V4L2_TC_USERBITS_field          0x000C
 873#define V4L2_TC_USERBITS_USERDEFINED    0x0000
 874#define V4L2_TC_USERBITS_8BITCHARS      0x0008
 875/* The above is based on SMPTE timecodes */
 876
 877struct v4l2_jpegcompression {
 878        int quality;
 879
 880        int  APPn;              /* Number of APP segment to be written,
 881                                 * must be 0..15 */
 882        int  APP_len;           /* Length of data in JPEG APPn segment */
 883        char APP_data[60];      /* Data in the JPEG APPn segment. */
 884
 885        int  COM_len;           /* Length of data in JPEG COM segment */
 886        char COM_data[60];      /* Data in JPEG COM segment */
 887
 888        __u32 jpeg_markers;     /* Which markers should go into the JPEG
 889                                 * output. Unless you exactly know what
 890                                 * you do, leave them untouched.
 891                                 * Including less markers will make the
 892                                 * resulting code smaller, but there will
 893                                 * be fewer applications which can read it.
 894                                 * The presence of the APP and COM marker
 895                                 * is influenced by APP_len and COM_len
 896                                 * ONLY, not by this property! */
 897
 898#define V4L2_JPEG_MARKER_DHT (1<<3)    /* Define Huffman Tables */
 899#define V4L2_JPEG_MARKER_DQT (1<<4)    /* Define Quantization Tables */
 900#define V4L2_JPEG_MARKER_DRI (1<<5)    /* Define Restart Interval */
 901#define V4L2_JPEG_MARKER_COM (1<<6)    /* Comment segment */
 902#define V4L2_JPEG_MARKER_APP (1<<7)    /* App segment, driver will
 903                                        * always use APP0 */
 904};
 905
 906/*
 907 *      M E M O R Y - M A P P I N G   B U F F E R S
 908 */
 909struct v4l2_requestbuffers {
 910        __u32                   count;
 911        __u32                   type;           /* enum v4l2_buf_type */
 912        __u32                   memory;         /* enum v4l2_memory */
 913        __u32                   capabilities;
 914        __u32                   reserved[1];
 915};
 916
 917/* capabilities for struct v4l2_requestbuffers and v4l2_create_buffers */
 918#define V4L2_BUF_CAP_SUPPORTS_MMAP      (1 << 0)
 919#define V4L2_BUF_CAP_SUPPORTS_USERPTR   (1 << 1)
 920#define V4L2_BUF_CAP_SUPPORTS_DMABUF    (1 << 2)
 921#define V4L2_BUF_CAP_SUPPORTS_REQUESTS  (1 << 3)
 922#define V4L2_BUF_CAP_SUPPORTS_ORPHANED_BUFS (1 << 4)
 923
 924/**
 925 * struct v4l2_plane - plane info for multi-planar buffers
 926 * @bytesused:          number of bytes occupied by data in the plane (payload)
 927 * @length:             size of this plane (NOT the payload) in bytes
 928 * @mem_offset:         when memory in the associated struct v4l2_buffer is
 929 *                      V4L2_MEMORY_MMAP, equals the offset from the start of
 930 *                      the device memory for this plane (or is a "cookie" that
 931 *                      should be passed to mmap() called on the video node)
 932 * @userptr:            when memory is V4L2_MEMORY_USERPTR, a userspace pointer
 933 *                      pointing to this plane
 934 * @fd:                 when memory is V4L2_MEMORY_DMABUF, a userspace file
 935 *                      descriptor associated with this plane
 936 * @data_offset:        offset in the plane to the start of data; usually 0,
 937 *                      unless there is a header in front of the data
 938 *
 939 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
 940 * with two planes can have one plane for Y, and another for interleaved CbCr
 941 * components. Each plane can reside in a separate memory buffer, or even in
 942 * a completely separate memory node (e.g. in embedded devices).
 943 */
 944struct v4l2_plane {
 945        __u32                   bytesused;
 946        __u32                   length;
 947        union {
 948                __u32           mem_offset;
 949                unsigned long   userptr;
 950                __s32           fd;
 951        } m;
 952        __u32                   data_offset;
 953        __u32                   reserved[11];
 954};
 955
 956/**
 957 * struct v4l2_buffer - video buffer info
 958 * @index:      id number of the buffer
 959 * @type:       enum v4l2_buf_type; buffer type (type == *_MPLANE for
 960 *              multiplanar buffers);
 961 * @bytesused:  number of bytes occupied by data in the buffer (payload);
 962 *              unused (set to 0) for multiplanar buffers
 963 * @flags:      buffer informational flags
 964 * @field:      enum v4l2_field; field order of the image in the buffer
 965 * @timestamp:  frame timestamp
 966 * @timecode:   frame timecode
 967 * @sequence:   sequence count of this frame
 968 * @memory:     enum v4l2_memory; the method, in which the actual video data is
 969 *              passed
 970 * @offset:     for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
 971 *              offset from the start of the device memory for this plane,
 972 *              (or a "cookie" that should be passed to mmap() as offset)
 973 * @userptr:    for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
 974 *              a userspace pointer pointing to this buffer
 975 * @fd:         for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
 976 *              a userspace file descriptor associated with this buffer
 977 * @planes:     for multiplanar buffers; userspace pointer to the array of plane
 978 *              info structs for this buffer
 979 * @length:     size in bytes of the buffer (NOT its payload) for single-plane
 980 *              buffers (when type != *_MPLANE); number of elements in the
 981 *              planes array for multi-plane buffers
 982 * @request_fd: fd of the request that this buffer should use
 983 *
 984 * Contains data exchanged by application and driver using one of the Streaming
 985 * I/O methods.
 986 */
 987struct v4l2_buffer {
 988        __u32                   index;
 989        __u32                   type;
 990        __u32                   bytesused;
 991        __u32                   flags;
 992        __u32                   field;
 993        struct timeval          timestamp;
 994        struct v4l2_timecode    timecode;
 995        __u32                   sequence;
 996
 997        /* memory location */
 998        __u32                   memory;
 999        union {
1000                __u32           offset;
1001                unsigned long   userptr;
1002                struct v4l2_plane *planes;
1003                __s32           fd;
1004        } m;
1005        __u32                   length;
1006        __u32                   reserved2;
1007        union {
1008                __s32           request_fd;
1009                __u32           reserved;
1010        };
1011};
1012
1013/**
1014 * v4l2_timeval_to_ns - Convert timeval to nanoseconds
1015 * @ts:         pointer to the timeval variable to be converted
1016 *
1017 * Returns the scalar nanosecond representation of the timeval
1018 * parameter.
1019 */
1020static inline __u64 v4l2_timeval_to_ns(const struct timeval *tv)
1021{
1022        return (__u64)tv->tv_sec * 1000000000ULL + tv->tv_usec * 1000;
1023}
1024
1025/*  Flags for 'flags' field */
1026/* Buffer is mapped (flag) */
1027#define V4L2_BUF_FLAG_MAPPED                    0x00000001
1028/* Buffer is queued for processing */
1029#define V4L2_BUF_FLAG_QUEUED                    0x00000002
1030/* Buffer is ready */
1031#define V4L2_BUF_FLAG_DONE                      0x00000004
1032/* Image is a keyframe (I-frame) */
1033#define V4L2_BUF_FLAG_KEYFRAME                  0x00000008
1034/* Image is a P-frame */
1035#define V4L2_BUF_FLAG_PFRAME                    0x00000010
1036/* Image is a B-frame */
1037#define V4L2_BUF_FLAG_BFRAME                    0x00000020
1038/* Buffer is ready, but the data contained within is corrupted. */
1039#define V4L2_BUF_FLAG_ERROR                     0x00000040
1040/* Buffer is added to an unqueued request */
1041#define V4L2_BUF_FLAG_IN_REQUEST                0x00000080
1042/* timecode field is valid */
1043#define V4L2_BUF_FLAG_TIMECODE                  0x00000100
1044/* Buffer is prepared for queuing */
1045#define V4L2_BUF_FLAG_PREPARED                  0x00000400
1046/* Cache handling flags */
1047#define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE       0x00000800
1048#define V4L2_BUF_FLAG_NO_CACHE_CLEAN            0x00001000
1049/* Timestamp type */
1050#define V4L2_BUF_FLAG_TIMESTAMP_MASK            0x0000e000
1051#define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN         0x00000000
1052#define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC       0x00002000
1053#define V4L2_BUF_FLAG_TIMESTAMP_COPY            0x00004000
1054/* Timestamp sources. */
1055#define V4L2_BUF_FLAG_TSTAMP_SRC_MASK           0x00070000
1056#define V4L2_BUF_FLAG_TSTAMP_SRC_EOF            0x00000000
1057#define V4L2_BUF_FLAG_TSTAMP_SRC_SOE            0x00010000
1058/* mem2mem encoder/decoder */
1059#define V4L2_BUF_FLAG_LAST                      0x00100000
1060/* request_fd is valid */
1061#define V4L2_BUF_FLAG_REQUEST_FD                0x00800000
1062
1063/**
1064 * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
1065 *
1066 * @index:      id number of the buffer
1067 * @type:       enum v4l2_buf_type; buffer type (type == *_MPLANE for
1068 *              multiplanar buffers);
1069 * @plane:      index of the plane to be exported, 0 for single plane queues
1070 * @flags:      flags for newly created file, currently only O_CLOEXEC is
1071 *              supported, refer to manual of open syscall for more details
1072 * @fd:         file descriptor associated with DMABUF (set by driver)
1073 *
1074 * Contains data used for exporting a video buffer as DMABUF file descriptor.
1075 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
1076 * (identical to the cookie used to mmap() the buffer to userspace). All
1077 * reserved fields must be set to zero. The field reserved0 is expected to
1078 * become a structure 'type' allowing an alternative layout of the structure
1079 * content. Therefore this field should not be used for any other extensions.
1080 */
1081struct v4l2_exportbuffer {
1082        __u32           type; /* enum v4l2_buf_type */
1083        __u32           index;
1084        __u32           plane;
1085        __u32           flags;
1086        __s32           fd;
1087        __u32           reserved[11];
1088};
1089
1090/*
1091 *      O V E R L A Y   P R E V I E W
1092 */
1093struct v4l2_framebuffer {
1094        __u32                   capability;
1095        __u32                   flags;
1096/* FIXME: in theory we should pass something like PCI device + memory
1097 * region + offset instead of some physical address */
1098        void                    *base;
1099        struct {
1100                __u32           width;
1101                __u32           height;
1102                __u32           pixelformat;
1103                __u32           field;          /* enum v4l2_field */
1104                __u32           bytesperline;   /* for padding, zero if unused */
1105                __u32           sizeimage;
1106                __u32           colorspace;     /* enum v4l2_colorspace */
1107                __u32           priv;           /* reserved field, set to 0 */
1108        } fmt;
1109};
1110/*  Flags for the 'capability' field. Read only */
1111#define V4L2_FBUF_CAP_EXTERNOVERLAY     0x0001
1112#define V4L2_FBUF_CAP_CHROMAKEY         0x0002
1113#define V4L2_FBUF_CAP_LIST_CLIPPING     0x0004
1114#define V4L2_FBUF_CAP_BITMAP_CLIPPING   0x0008
1115#define V4L2_FBUF_CAP_LOCAL_ALPHA       0x0010
1116#define V4L2_FBUF_CAP_GLOBAL_ALPHA      0x0020
1117#define V4L2_FBUF_CAP_LOCAL_INV_ALPHA   0x0040
1118#define V4L2_FBUF_CAP_SRC_CHROMAKEY     0x0080
1119/*  Flags for the 'flags' field. */
1120#define V4L2_FBUF_FLAG_PRIMARY          0x0001
1121#define V4L2_FBUF_FLAG_OVERLAY          0x0002
1122#define V4L2_FBUF_FLAG_CHROMAKEY        0x0004
1123#define V4L2_FBUF_FLAG_LOCAL_ALPHA      0x0008
1124#define V4L2_FBUF_FLAG_GLOBAL_ALPHA     0x0010
1125#define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA  0x0020
1126#define V4L2_FBUF_FLAG_SRC_CHROMAKEY    0x0040
1127
1128struct v4l2_clip {
1129        struct v4l2_rect        c;
1130        struct v4l2_clip        __user *next;
1131};
1132
1133struct v4l2_window {
1134        struct v4l2_rect        w;
1135        __u32                   field;   /* enum v4l2_field */
1136        __u32                   chromakey;
1137        struct v4l2_clip        __user *clips;
1138        __u32                   clipcount;
1139        void                    __user *bitmap;
1140        __u8                    global_alpha;
1141};
1142
1143/*
1144 *      C A P T U R E   P A R A M E T E R S
1145 */
1146struct v4l2_captureparm {
1147        __u32              capability;    /*  Supported modes */
1148        __u32              capturemode;   /*  Current mode */
1149        struct v4l2_fract  timeperframe;  /*  Time per frame in seconds */
1150        __u32              extendedmode;  /*  Driver-specific extensions */
1151        __u32              readbuffers;   /*  # of buffers for read */
1152        __u32              reserved[4];
1153};
1154
1155/*  Flags for 'capability' and 'capturemode' fields */
1156#define V4L2_MODE_HIGHQUALITY   0x0001  /*  High quality imaging mode */
1157#define V4L2_CAP_TIMEPERFRAME   0x1000  /*  timeperframe field is supported */
1158
1159struct v4l2_outputparm {
1160        __u32              capability;   /*  Supported modes */
1161        __u32              outputmode;   /*  Current mode */
1162        struct v4l2_fract  timeperframe; /*  Time per frame in seconds */
1163        __u32              extendedmode; /*  Driver-specific extensions */
1164        __u32              writebuffers; /*  # of buffers for write */
1165        __u32              reserved[4];
1166};
1167
1168/*
1169 *      I N P U T   I M A G E   C R O P P I N G
1170 */
1171struct v4l2_cropcap {
1172        __u32                   type;   /* enum v4l2_buf_type */
1173        struct v4l2_rect        bounds;
1174        struct v4l2_rect        defrect;
1175        struct v4l2_fract       pixelaspect;
1176};
1177
1178struct v4l2_crop {
1179        __u32                   type;   /* enum v4l2_buf_type */
1180        struct v4l2_rect        c;
1181};
1182
1183/**
1184 * struct v4l2_selection - selection info
1185 * @type:       buffer type (do not use *_MPLANE types)
1186 * @target:     Selection target, used to choose one of possible rectangles;
1187 *              defined in v4l2-common.h; V4L2_SEL_TGT_* .
1188 * @flags:      constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
1189 * @r:          coordinates of selection window
1190 * @reserved:   for future use, rounds structure size to 64 bytes, set to zero
1191 *
1192 * Hardware may use multiple helper windows to process a video stream.
1193 * The structure is used to exchange this selection areas between
1194 * an application and a driver.
1195 */
1196struct v4l2_selection {
1197        __u32                   type;
1198        __u32                   target;
1199        __u32                   flags;
1200        struct v4l2_rect        r;
1201        __u32                   reserved[9];
1202};
1203
1204
1205/*
1206 *      A N A L O G   V I D E O   S T A N D A R D
1207 */
1208
1209typedef __u64 v4l2_std_id;
1210
1211/* one bit for each */
1212#define V4L2_STD_PAL_B          ((v4l2_std_id)0x00000001)
1213#define V4L2_STD_PAL_B1         ((v4l2_std_id)0x00000002)
1214#define V4L2_STD_PAL_G          ((v4l2_std_id)0x00000004)
1215#define V4L2_STD_PAL_H          ((v4l2_std_id)0x00000008)
1216#define V4L2_STD_PAL_I          ((v4l2_std_id)0x00000010)
1217#define V4L2_STD_PAL_D          ((v4l2_std_id)0x00000020)
1218#define V4L2_STD_PAL_D1         ((v4l2_std_id)0x00000040)
1219#define V4L2_STD_PAL_K          ((v4l2_std_id)0x00000080)
1220
1221#define V4L2_STD_PAL_M          ((v4l2_std_id)0x00000100)
1222#define V4L2_STD_PAL_N          ((v4l2_std_id)0x00000200)
1223#define V4L2_STD_PAL_Nc         ((v4l2_std_id)0x00000400)
1224#define V4L2_STD_PAL_60         ((v4l2_std_id)0x00000800)
1225
1226#define V4L2_STD_NTSC_M         ((v4l2_std_id)0x00001000)       /* BTSC */
1227#define V4L2_STD_NTSC_M_JP      ((v4l2_std_id)0x00002000)       /* EIA-J */
1228#define V4L2_STD_NTSC_443       ((v4l2_std_id)0x00004000)
1229#define V4L2_STD_NTSC_M_KR      ((v4l2_std_id)0x00008000)       /* FM A2 */
1230
1231#define V4L2_STD_SECAM_B        ((v4l2_std_id)0x00010000)
1232#define V4L2_STD_SECAM_D        ((v4l2_std_id)0x00020000)
1233#define V4L2_STD_SECAM_G        ((v4l2_std_id)0x00040000)
1234#define V4L2_STD_SECAM_H        ((v4l2_std_id)0x00080000)
1235#define V4L2_STD_SECAM_K        ((v4l2_std_id)0x00100000)
1236#define V4L2_STD_SECAM_K1       ((v4l2_std_id)0x00200000)
1237#define V4L2_STD_SECAM_L        ((v4l2_std_id)0x00400000)
1238#define V4L2_STD_SECAM_LC       ((v4l2_std_id)0x00800000)
1239
1240/* ATSC/HDTV */
1241#define V4L2_STD_ATSC_8_VSB     ((v4l2_std_id)0x01000000)
1242#define V4L2_STD_ATSC_16_VSB    ((v4l2_std_id)0x02000000)
1243
1244/* FIXME:
1245   Although std_id is 64 bits, there is an issue on PPC32 architecture that
1246   makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
1247   this value to 32 bits.
1248   As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
1249   it should work fine. However, if needed to add more than two standards,
1250   v4l2-common.c should be fixed.
1251 */
1252
1253/*
1254 * Some macros to merge video standards in order to make live easier for the
1255 * drivers and V4L2 applications
1256 */
1257
1258/*
1259 * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
1260 * Missing here.
1261 */
1262#define V4L2_STD_NTSC           (V4L2_STD_NTSC_M        |\
1263                                 V4L2_STD_NTSC_M_JP     |\
1264                                 V4L2_STD_NTSC_M_KR)
1265/* Secam macros */
1266#define V4L2_STD_SECAM_DK       (V4L2_STD_SECAM_D       |\
1267                                 V4L2_STD_SECAM_K       |\
1268                                 V4L2_STD_SECAM_K1)
1269/* All Secam Standards */
1270#define V4L2_STD_SECAM          (V4L2_STD_SECAM_B       |\
1271                                 V4L2_STD_SECAM_G       |\
1272                                 V4L2_STD_SECAM_H       |\
1273                                 V4L2_STD_SECAM_DK      |\
1274                                 V4L2_STD_SECAM_L       |\
1275                                 V4L2_STD_SECAM_LC)
1276/* PAL macros */
1277#define V4L2_STD_PAL_BG         (V4L2_STD_PAL_B         |\
1278                                 V4L2_STD_PAL_B1        |\
1279                                 V4L2_STD_PAL_G)
1280#define V4L2_STD_PAL_DK         (V4L2_STD_PAL_D         |\
1281                                 V4L2_STD_PAL_D1        |\
1282                                 V4L2_STD_PAL_K)
1283/*
1284 * "Common" PAL - This macro is there to be compatible with the old
1285 * V4L1 concept of "PAL": /BGDKHI.
1286 * Several PAL standards are missing here: /M, /N and /Nc
1287 */
1288#define V4L2_STD_PAL            (V4L2_STD_PAL_BG        |\
1289                                 V4L2_STD_PAL_DK        |\
1290                                 V4L2_STD_PAL_H         |\
1291                                 V4L2_STD_PAL_I)
1292/* Chroma "agnostic" standards */
1293#define V4L2_STD_B              (V4L2_STD_PAL_B         |\
1294                                 V4L2_STD_PAL_B1        |\
1295                                 V4L2_STD_SECAM_B)
1296#define V4L2_STD_G              (V4L2_STD_PAL_G         |\
1297                                 V4L2_STD_SECAM_G)
1298#define V4L2_STD_H              (V4L2_STD_PAL_H         |\
1299                                 V4L2_STD_SECAM_H)
1300#define V4L2_STD_L              (V4L2_STD_SECAM_L       |\
1301                                 V4L2_STD_SECAM_LC)
1302#define V4L2_STD_GH             (V4L2_STD_G             |\
1303                                 V4L2_STD_H)
1304#define V4L2_STD_DK             (V4L2_STD_PAL_DK        |\
1305                                 V4L2_STD_SECAM_DK)
1306#define V4L2_STD_BG             (V4L2_STD_B             |\
1307                                 V4L2_STD_G)
1308#define V4L2_STD_MN             (V4L2_STD_PAL_M         |\
1309                                 V4L2_STD_PAL_N         |\
1310                                 V4L2_STD_PAL_Nc        |\
1311                                 V4L2_STD_NTSC)
1312
1313/* Standards where MTS/BTSC stereo could be found */
1314#define V4L2_STD_MTS            (V4L2_STD_NTSC_M        |\
1315                                 V4L2_STD_PAL_M         |\
1316                                 V4L2_STD_PAL_N         |\
1317                                 V4L2_STD_PAL_Nc)
1318
1319/* Standards for Countries with 60Hz Line frequency */
1320#define V4L2_STD_525_60         (V4L2_STD_PAL_M         |\
1321                                 V4L2_STD_PAL_60        |\
1322                                 V4L2_STD_NTSC          |\
1323                                 V4L2_STD_NTSC_443)
1324/* Standards for Countries with 50Hz Line frequency */
1325#define V4L2_STD_625_50         (V4L2_STD_PAL           |\
1326                                 V4L2_STD_PAL_N         |\
1327                                 V4L2_STD_PAL_Nc        |\
1328                                 V4L2_STD_SECAM)
1329
1330#define V4L2_STD_ATSC           (V4L2_STD_ATSC_8_VSB    |\
1331                                 V4L2_STD_ATSC_16_VSB)
1332/* Macros with none and all analog standards */
1333#define V4L2_STD_UNKNOWN        0
1334#define V4L2_STD_ALL            (V4L2_STD_525_60        |\
1335                                 V4L2_STD_625_50)
1336
1337struct v4l2_standard {
1338        __u32                index;
1339        v4l2_std_id          id;
1340        __u8                 name[24];
1341        struct v4l2_fract    frameperiod; /* Frames, not fields */
1342        __u32                framelines;
1343        __u32                reserved[4];
1344};
1345
1346/*
1347 *      D V     B T     T I M I N G S
1348 */
1349
1350/** struct v4l2_bt_timings - BT.656/BT.1120 timing data
1351 * @width:      total width of the active video in pixels
1352 * @height:     total height of the active video in lines
1353 * @interlaced: Interlaced or progressive
1354 * @polarities: Positive or negative polarities
1355 * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
1356 * @hfrontporch:Horizontal front porch in pixels
1357 * @hsync:      Horizontal Sync length in pixels
1358 * @hbackporch: Horizontal back porch in pixels
1359 * @vfrontporch:Vertical front porch in lines
1360 * @vsync:      Vertical Sync length in lines
1361 * @vbackporch: Vertical back porch in lines
1362 * @il_vfrontporch:Vertical front porch for the even field
1363 *              (aka field 2) of interlaced field formats
1364 * @il_vsync:   Vertical Sync length for the even field
1365 *              (aka field 2) of interlaced field formats
1366 * @il_vbackporch:Vertical back porch for the even field
1367 *              (aka field 2) of interlaced field formats
1368 * @standards:  Standards the timing belongs to
1369 * @flags:      Flags
1370 * @picture_aspect: The picture aspect ratio (hor/vert).
1371 * @cea861_vic: VIC code as per the CEA-861 standard.
1372 * @hdmi_vic:   VIC code as per the HDMI standard.
1373 * @reserved:   Reserved fields, must be zeroed.
1374 *
1375 * A note regarding vertical interlaced timings: height refers to the total
1376 * height of the active video frame (= two fields). The blanking timings refer
1377 * to the blanking of each field. So the height of the total frame is
1378 * calculated as follows:
1379 *
1380 * tot_height = height + vfrontporch + vsync + vbackporch +
1381 *                       il_vfrontporch + il_vsync + il_vbackporch
1382 *
1383 * The active height of each field is height / 2.
1384 */
1385struct v4l2_bt_timings {
1386        __u32   width;
1387        __u32   height;
1388        __u32   interlaced;
1389        __u32   polarities;
1390        __u64   pixelclock;
1391        __u32   hfrontporch;
1392        __u32   hsync;
1393        __u32   hbackporch;
1394        __u32   vfrontporch;
1395        __u32   vsync;
1396        __u32   vbackporch;
1397        __u32   il_vfrontporch;
1398        __u32   il_vsync;
1399        __u32   il_vbackporch;
1400        __u32   standards;
1401        __u32   flags;
1402        struct v4l2_fract picture_aspect;
1403        __u8    cea861_vic;
1404        __u8    hdmi_vic;
1405        __u8    reserved[46];
1406} __attribute__ ((packed));
1407
1408/* Interlaced or progressive format */
1409#define V4L2_DV_PROGRESSIVE     0
1410#define V4L2_DV_INTERLACED      1
1411
1412/* Polarities. If bit is not set, it is assumed to be negative polarity */
1413#define V4L2_DV_VSYNC_POS_POL   0x00000001
1414#define V4L2_DV_HSYNC_POS_POL   0x00000002
1415
1416/* Timings standards */
1417#define V4L2_DV_BT_STD_CEA861   (1 << 0)  /* CEA-861 Digital TV Profile */
1418#define V4L2_DV_BT_STD_DMT      (1 << 1)  /* VESA Discrete Monitor Timings */
1419#define V4L2_DV_BT_STD_CVT      (1 << 2)  /* VESA Coordinated Video Timings */
1420#define V4L2_DV_BT_STD_GTF      (1 << 3)  /* VESA Generalized Timings Formula */
1421#define V4L2_DV_BT_STD_SDI      (1 << 4)  /* SDI Timings */
1422
1423/* Flags */
1424
1425/*
1426 * CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
1427 * GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
1428 * intervals are reduced, allowing a higher resolution over the same
1429 * bandwidth. This is a read-only flag.
1430 */
1431#define V4L2_DV_FL_REDUCED_BLANKING             (1 << 0)
1432/*
1433 * CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
1434 * of six. These formats can be optionally played at 1 / 1.001 speed.
1435 * This is a read-only flag.
1436 */
1437#define V4L2_DV_FL_CAN_REDUCE_FPS               (1 << 1)
1438/*
1439 * CEA-861 specific: only valid for video transmitters, the flag is cleared
1440 * by receivers.
1441 * If the framerate of the format is a multiple of six, then the pixelclock
1442 * used to set up the transmitter is divided by 1.001 to make it compatible
1443 * with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
1444 * 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
1445 * such frequencies, then the flag will also be cleared.
1446 */
1447#define V4L2_DV_FL_REDUCED_FPS                  (1 << 2)
1448/*
1449 * Specific to interlaced formats: if set, then field 1 is really one half-line
1450 * longer and field 2 is really one half-line shorter, so each field has
1451 * exactly the same number of half-lines. Whether half-lines can be detected
1452 * or used depends on the hardware.
1453 */
1454#define V4L2_DV_FL_HALF_LINE                    (1 << 3)
1455/*
1456 * If set, then this is a Consumer Electronics (CE) video format. Such formats
1457 * differ from other formats (commonly called IT formats) in that if RGB
1458 * encoding is used then by default the RGB values use limited range (i.e.
1459 * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
1460 * except for the 640x480 format are CE formats.
1461 */
1462#define V4L2_DV_FL_IS_CE_VIDEO                  (1 << 4)
1463/* Some formats like SMPTE-125M have an interlaced signal with a odd
1464 * total height. For these formats, if this flag is set, the first
1465 * field has the extra line. If not, it is the second field.
1466 */
1467#define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE       (1 << 5)
1468/*
1469 * If set, then the picture_aspect field is valid. Otherwise assume that the
1470 * pixels are square, so the picture aspect ratio is the same as the width to
1471 * height ratio.
1472 */
1473#define V4L2_DV_FL_HAS_PICTURE_ASPECT           (1 << 6)
1474/*
1475 * If set, then the cea861_vic field is valid and contains the Video
1476 * Identification Code as per the CEA-861 standard.
1477 */
1478#define V4L2_DV_FL_HAS_CEA861_VIC               (1 << 7)
1479/*
1480 * If set, then the hdmi_vic field is valid and contains the Video
1481 * Identification Code as per the HDMI standard (HDMI Vendor Specific
1482 * InfoFrame).
1483 */
1484#define V4L2_DV_FL_HAS_HDMI_VIC                 (1 << 8)
1485/*
1486 * CEA-861 specific: only valid for video receivers.
1487 * If set, then HW can detect the difference between regular FPS and
1488 * 1000/1001 FPS. Note: This flag is only valid for HDMI VIC codes with
1489 * the V4L2_DV_FL_CAN_REDUCE_FPS flag set.
1490 */
1491#define V4L2_DV_FL_CAN_DETECT_REDUCED_FPS       (1 << 9)
1492
1493/* A few useful defines to calculate the total blanking and frame sizes */
1494#define V4L2_DV_BT_BLANKING_WIDTH(bt) \
1495        ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
1496#define V4L2_DV_BT_FRAME_WIDTH(bt) \
1497        ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
1498#define V4L2_DV_BT_BLANKING_HEIGHT(bt) \
1499        ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \
1500         (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
1501#define V4L2_DV_BT_FRAME_HEIGHT(bt) \
1502        ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
1503
1504/** struct v4l2_dv_timings - DV timings
1505 * @type:       the type of the timings
1506 * @bt: BT656/1120 timings
1507 */
1508struct v4l2_dv_timings {
1509        __u32 type;
1510        union {
1511                struct v4l2_bt_timings  bt;
1512                __u32   reserved[32];
1513        };
1514} __attribute__ ((packed));
1515
1516/* Values for the type field */
1517#define V4L2_DV_BT_656_1120     0       /* BT.656/1120 timing type */
1518
1519
1520/** struct v4l2_enum_dv_timings - DV timings enumeration
1521 * @index:      enumeration index
1522 * @pad:        the pad number for which to enumerate timings (used with
1523 *              v4l-subdev nodes only)
1524 * @reserved:   must be zeroed
1525 * @timings:    the timings for the given index
1526 */
1527struct v4l2_enum_dv_timings {
1528        __u32 index;
1529        __u32 pad;
1530        __u32 reserved[2];
1531        struct v4l2_dv_timings timings;
1532};
1533
1534/** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
1535 * @min_width:          width in pixels
1536 * @max_width:          width in pixels
1537 * @min_height:         height in lines
1538 * @max_height:         height in lines
1539 * @min_pixelclock:     Pixel clock in HZ. Ex. 74.25MHz->74250000
1540 * @max_pixelclock:     Pixel clock in HZ. Ex. 74.25MHz->74250000
1541 * @standards:          Supported standards
1542 * @capabilities:       Supported capabilities
1543 * @reserved:           Must be zeroed
1544 */
1545struct v4l2_bt_timings_cap {
1546        __u32   min_width;
1547        __u32   max_width;
1548        __u32   min_height;
1549        __u32   max_height;
1550        __u64   min_pixelclock;
1551        __u64   max_pixelclock;
1552        __u32   standards;
1553        __u32   capabilities;
1554        __u32   reserved[16];
1555} __attribute__ ((packed));
1556
1557/* Supports interlaced formats */
1558#define V4L2_DV_BT_CAP_INTERLACED       (1 << 0)
1559/* Supports progressive formats */
1560#define V4L2_DV_BT_CAP_PROGRESSIVE      (1 << 1)
1561/* Supports CVT/GTF reduced blanking */
1562#define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
1563/* Supports custom formats */
1564#define V4L2_DV_BT_CAP_CUSTOM           (1 << 3)
1565
1566/** struct v4l2_dv_timings_cap - DV timings capabilities
1567 * @type:       the type of the timings (same as in struct v4l2_dv_timings)
1568 * @pad:        the pad number for which to query capabilities (used with
1569 *              v4l-subdev nodes only)
1570 * @bt:         the BT656/1120 timings capabilities
1571 */
1572struct v4l2_dv_timings_cap {
1573        __u32 type;
1574        __u32 pad;
1575        __u32 reserved[2];
1576        union {
1577                struct v4l2_bt_timings_cap bt;
1578                __u32 raw_data[32];
1579        };
1580};
1581
1582
1583/*
1584 *      V I D E O   I N P U T S
1585 */
1586struct v4l2_input {
1587        __u32        index;             /*  Which input */
1588        __u8         name[32];          /*  Label */
1589        __u32        type;              /*  Type of input */
1590        __u32        audioset;          /*  Associated audios (bitfield) */
1591        __u32        tuner;             /*  enum v4l2_tuner_type */
1592        v4l2_std_id  std;
1593        __u32        status;
1594        __u32        capabilities;
1595        __u32        reserved[3];
1596};
1597
1598/*  Values for the 'type' field */
1599#define V4L2_INPUT_TYPE_TUNER           1
1600#define V4L2_INPUT_TYPE_CAMERA          2
1601#define V4L2_INPUT_TYPE_TOUCH           3
1602
1603/* field 'status' - general */
1604#define V4L2_IN_ST_NO_POWER    0x00000001  /* Attached device is off */
1605#define V4L2_IN_ST_NO_SIGNAL   0x00000002
1606#define V4L2_IN_ST_NO_COLOR    0x00000004
1607
1608/* field 'status' - sensor orientation */
1609/* If sensor is mounted upside down set both bits */
1610#define V4L2_IN_ST_HFLIP       0x00000010 /* Frames are flipped horizontally */
1611#define V4L2_IN_ST_VFLIP       0x00000020 /* Frames are flipped vertically */
1612
1613/* field 'status' - analog */
1614#define V4L2_IN_ST_NO_H_LOCK   0x00000100  /* No horizontal sync lock */
1615#define V4L2_IN_ST_COLOR_KILL  0x00000200  /* Color killer is active */
1616#define V4L2_IN_ST_NO_V_LOCK   0x00000400  /* No vertical sync lock */
1617#define V4L2_IN_ST_NO_STD_LOCK 0x00000800  /* No standard format lock */
1618
1619/* field 'status' - digital */
1620#define V4L2_IN_ST_NO_SYNC     0x00010000  /* No synchronization lock */
1621#define V4L2_IN_ST_NO_EQU      0x00020000  /* No equalizer lock */
1622#define V4L2_IN_ST_NO_CARRIER  0x00040000  /* Carrier recovery failed */
1623
1624/* field 'status' - VCR and set-top box */
1625#define V4L2_IN_ST_MACROVISION 0x01000000  /* Macrovision detected */
1626#define V4L2_IN_ST_NO_ACCESS   0x02000000  /* Conditional access denied */
1627#define V4L2_IN_ST_VTR         0x04000000  /* VTR time constant */
1628
1629/* capabilities flags */
1630#define V4L2_IN_CAP_DV_TIMINGS          0x00000002 /* Supports S_DV_TIMINGS */
1631#define V4L2_IN_CAP_CUSTOM_TIMINGS      V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
1632#define V4L2_IN_CAP_STD                 0x00000004 /* Supports S_STD */
1633#define V4L2_IN_CAP_NATIVE_SIZE         0x00000008 /* Supports setting native size */
1634
1635/*
1636 *      V I D E O   O U T P U T S
1637 */
1638struct v4l2_output {
1639        __u32        index;             /*  Which output */
1640        __u8         name[32];          /*  Label */
1641        __u32        type;              /*  Type of output */
1642        __u32        audioset;          /*  Associated audios (bitfield) */
1643        __u32        modulator;         /*  Associated modulator */
1644        v4l2_std_id  std;
1645        __u32        capabilities;
1646        __u32        reserved[3];
1647};
1648/*  Values for the 'type' field */
1649#define V4L2_OUTPUT_TYPE_MODULATOR              1
1650#define V4L2_OUTPUT_TYPE_ANALOG                 2
1651#define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY       3
1652
1653/* capabilities flags */
1654#define V4L2_OUT_CAP_DV_TIMINGS         0x00000002 /* Supports S_DV_TIMINGS */
1655#define V4L2_OUT_CAP_CUSTOM_TIMINGS     V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
1656#define V4L2_OUT_CAP_STD                0x00000004 /* Supports S_STD */
1657#define V4L2_OUT_CAP_NATIVE_SIZE        0x00000008 /* Supports setting native size */
1658
1659/*
1660 *      C O N T R O L S
1661 */
1662struct v4l2_control {
1663        __u32                id;
1664        __s32                value;
1665};
1666
1667struct v4l2_ext_control {
1668        __u32 id;
1669        __u32 size;
1670        __u32 reserved2[1];
1671        union {
1672                __s32 value;
1673                __s64 value64;
1674                char __user *string;
1675                __u8 __user *p_u8;
1676                __u16 __user *p_u16;
1677                __u32 __user *p_u32;
1678                void __user *ptr;
1679        };
1680} __attribute__ ((packed));
1681
1682struct v4l2_ext_controls {
1683        union {
1684#ifndef __KERNEL__
1685                __u32 ctrl_class;
1686#endif
1687                __u32 which;
1688        };
1689        __u32 count;
1690        __u32 error_idx;
1691        __s32 request_fd;
1692        __u32 reserved[1];
1693        struct v4l2_ext_control *controls;
1694};
1695
1696#define V4L2_CTRL_ID_MASK         (0x0fffffff)
1697#ifndef __KERNEL__
1698#define V4L2_CTRL_ID2CLASS(id)    ((id) & 0x0fff0000UL)
1699#endif
1700#define V4L2_CTRL_ID2WHICH(id)    ((id) & 0x0fff0000UL)
1701#define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
1702#define V4L2_CTRL_MAX_DIMS        (4)
1703#define V4L2_CTRL_WHICH_CUR_VAL   0
1704#define V4L2_CTRL_WHICH_DEF_VAL   0x0f000000
1705#define V4L2_CTRL_WHICH_REQUEST_VAL 0x0f010000
1706
1707enum v4l2_ctrl_type {
1708        V4L2_CTRL_TYPE_INTEGER       = 1,
1709        V4L2_CTRL_TYPE_BOOLEAN       = 2,
1710        V4L2_CTRL_TYPE_MENU          = 3,
1711        V4L2_CTRL_TYPE_BUTTON        = 4,
1712        V4L2_CTRL_TYPE_INTEGER64     = 5,
1713        V4L2_CTRL_TYPE_CTRL_CLASS    = 6,
1714        V4L2_CTRL_TYPE_STRING        = 7,
1715        V4L2_CTRL_TYPE_BITMASK       = 8,
1716        V4L2_CTRL_TYPE_INTEGER_MENU  = 9,
1717
1718        /* Compound types are >= 0x0100 */
1719        V4L2_CTRL_COMPOUND_TYPES     = 0x0100,
1720        V4L2_CTRL_TYPE_U8            = 0x0100,
1721        V4L2_CTRL_TYPE_U16           = 0x0101,
1722        V4L2_CTRL_TYPE_U32           = 0x0102,
1723};
1724
1725/*  Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
1726struct v4l2_queryctrl {
1727        __u32                id;
1728        __u32                type;      /* enum v4l2_ctrl_type */
1729        __u8                 name[32];  /* Whatever */
1730        __s32                minimum;   /* Note signedness */
1731        __s32                maximum;
1732        __s32                step;
1733        __s32                default_value;
1734        __u32                flags;
1735        __u32                reserved[2];
1736};
1737
1738/*  Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
1739struct v4l2_query_ext_ctrl {
1740        __u32                id;
1741        __u32                type;
1742        char                 name[32];
1743        __s64                minimum;
1744        __s64                maximum;
1745        __u64                step;
1746        __s64                default_value;
1747        __u32                flags;
1748        __u32                elem_size;
1749        __u32                elems;
1750        __u32                nr_of_dims;
1751        __u32                dims[V4L2_CTRL_MAX_DIMS];
1752        __u32                reserved[32];
1753};
1754
1755/*  Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
1756struct v4l2_querymenu {
1757        __u32           id;
1758        __u32           index;
1759        union {
1760                __u8    name[32];       /* Whatever */
1761                __s64   value;
1762        };
1763        __u32           reserved;
1764} __attribute__ ((packed));
1765
1766/*  Control flags  */
1767#define V4L2_CTRL_FLAG_DISABLED         0x0001
1768#define V4L2_CTRL_FLAG_GRABBED          0x0002
1769#define V4L2_CTRL_FLAG_READ_ONLY        0x0004
1770#define V4L2_CTRL_FLAG_UPDATE           0x0008
1771#define V4L2_CTRL_FLAG_INACTIVE         0x0010
1772#define V4L2_CTRL_FLAG_SLIDER           0x0020
1773#define V4L2_CTRL_FLAG_WRITE_ONLY       0x0040
1774#define V4L2_CTRL_FLAG_VOLATILE         0x0080
1775#define V4L2_CTRL_FLAG_HAS_PAYLOAD      0x0100
1776#define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
1777#define V4L2_CTRL_FLAG_MODIFY_LAYOUT    0x0400
1778
1779/*  Query flags, to be ORed with the control ID */
1780#define V4L2_CTRL_FLAG_NEXT_CTRL        0x80000000
1781#define V4L2_CTRL_FLAG_NEXT_COMPOUND    0x40000000
1782
1783/*  User-class control IDs defined by V4L2 */
1784#define V4L2_CID_MAX_CTRLS              1024
1785/*  IDs reserved for driver specific controls */
1786#define V4L2_CID_PRIVATE_BASE           0x08000000
1787
1788
1789/*
1790 *      T U N I N G
1791 */
1792struct v4l2_tuner {
1793        __u32                   index;
1794        __u8                    name[32];
1795        __u32                   type;   /* enum v4l2_tuner_type */
1796        __u32                   capability;
1797        __u32                   rangelow;
1798        __u32                   rangehigh;
1799        __u32                   rxsubchans;
1800        __u32                   audmode;
1801        __s32                   signal;
1802        __s32                   afc;
1803        __u32                   reserved[4];
1804};
1805
1806struct v4l2_modulator {
1807        __u32                   index;
1808        __u8                    name[32];
1809        __u32                   capability;
1810        __u32                   rangelow;
1811        __u32                   rangehigh;
1812        __u32                   txsubchans;
1813        __u32                   type;   /* enum v4l2_tuner_type */
1814        __u32                   reserved[3];
1815};
1816
1817/*  Flags for the 'capability' field */
1818#define V4L2_TUNER_CAP_LOW              0x0001
1819#define V4L2_TUNER_CAP_NORM             0x0002
1820#define V4L2_TUNER_CAP_HWSEEK_BOUNDED   0x0004
1821#define V4L2_TUNER_CAP_HWSEEK_WRAP      0x0008
1822#define V4L2_TUNER_CAP_STEREO           0x0010
1823#define V4L2_TUNER_CAP_LANG2            0x0020
1824#define V4L2_TUNER_CAP_SAP              0x0020
1825#define V4L2_TUNER_CAP_LANG1            0x0040
1826#define V4L2_TUNER_CAP_RDS              0x0080
1827#define V4L2_TUNER_CAP_RDS_BLOCK_IO     0x0100
1828#define V4L2_TUNER_CAP_RDS_CONTROLS     0x0200
1829#define V4L2_TUNER_CAP_FREQ_BANDS       0x0400
1830#define V4L2_TUNER_CAP_HWSEEK_PROG_LIM  0x0800
1831#define V4L2_TUNER_CAP_1HZ              0x1000
1832
1833/*  Flags for the 'rxsubchans' field */
1834#define V4L2_TUNER_SUB_MONO             0x0001
1835#define V4L2_TUNER_SUB_STEREO           0x0002
1836#define V4L2_TUNER_SUB_LANG2            0x0004
1837#define V4L2_TUNER_SUB_SAP              0x0004
1838#define V4L2_TUNER_SUB_LANG1            0x0008
1839#define V4L2_TUNER_SUB_RDS              0x0010
1840
1841/*  Values for the 'audmode' field */
1842#define V4L2_TUNER_MODE_MONO            0x0000
1843#define V4L2_TUNER_MODE_STEREO          0x0001
1844#define V4L2_TUNER_MODE_LANG2           0x0002
1845#define V4L2_TUNER_MODE_SAP             0x0002
1846#define V4L2_TUNER_MODE_LANG1           0x0003
1847#define V4L2_TUNER_MODE_LANG1_LANG2     0x0004
1848
1849struct v4l2_frequency {
1850        __u32   tuner;
1851        __u32   type;   /* enum v4l2_tuner_type */
1852        __u32   frequency;
1853        __u32   reserved[8];
1854};
1855
1856#define V4L2_BAND_MODULATION_VSB        (1 << 1)
1857#define V4L2_BAND_MODULATION_FM         (1 << 2)
1858#define V4L2_BAND_MODULATION_AM         (1 << 3)
1859
1860struct v4l2_frequency_band {
1861        __u32   tuner;
1862        __u32   type;   /* enum v4l2_tuner_type */
1863        __u32   index;
1864        __u32   capability;
1865        __u32   rangelow;
1866        __u32   rangehigh;
1867        __u32   modulation;
1868        __u32   reserved[9];
1869};
1870
1871struct v4l2_hw_freq_seek {
1872        __u32   tuner;
1873        __u32   type;   /* enum v4l2_tuner_type */
1874        __u32   seek_upward;
1875        __u32   wrap_around;
1876        __u32   spacing;
1877        __u32   rangelow;
1878        __u32   rangehigh;
1879        __u32   reserved[5];
1880};
1881
1882/*
1883 *      R D S
1884 */
1885
1886struct v4l2_rds_data {
1887        __u8    lsb;
1888        __u8    msb;
1889        __u8    block;
1890} __attribute__ ((packed));
1891
1892#define V4L2_RDS_BLOCK_MSK       0x7
1893#define V4L2_RDS_BLOCK_A         0
1894#define V4L2_RDS_BLOCK_B         1
1895#define V4L2_RDS_BLOCK_C         2
1896#define V4L2_RDS_BLOCK_D         3
1897#define V4L2_RDS_BLOCK_C_ALT     4
1898#define V4L2_RDS_BLOCK_INVALID   7
1899
1900#define V4L2_RDS_BLOCK_CORRECTED 0x40
1901#define V4L2_RDS_BLOCK_ERROR     0x80
1902
1903/*
1904 *      A U D I O
1905 */
1906struct v4l2_audio {
1907        __u32   index;
1908        __u8    name[32];
1909        __u32   capability;
1910        __u32   mode;
1911        __u32   reserved[2];
1912};
1913
1914/*  Flags for the 'capability' field */
1915#define V4L2_AUDCAP_STEREO              0x00001
1916#define V4L2_AUDCAP_AVL                 0x00002
1917
1918/*  Flags for the 'mode' field */
1919#define V4L2_AUDMODE_AVL                0x00001
1920
1921struct v4l2_audioout {
1922        __u32   index;
1923        __u8    name[32];
1924        __u32   capability;
1925        __u32   mode;
1926        __u32   reserved[2];
1927};
1928
1929/*
1930 *      M P E G   S E R V I C E S
1931 */
1932#if 1
1933#define V4L2_ENC_IDX_FRAME_I    (0)
1934#define V4L2_ENC_IDX_FRAME_P    (1)
1935#define V4L2_ENC_IDX_FRAME_B    (2)
1936#define V4L2_ENC_IDX_FRAME_MASK (0xf)
1937
1938struct v4l2_enc_idx_entry {
1939        __u64 offset;
1940        __u64 pts;
1941        __u32 length;
1942        __u32 flags;
1943        __u32 reserved[2];
1944};
1945
1946#define V4L2_ENC_IDX_ENTRIES (64)
1947struct v4l2_enc_idx {
1948        __u32 entries;
1949        __u32 entries_cap;
1950        __u32 reserved[4];
1951        struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
1952};
1953
1954
1955#define V4L2_ENC_CMD_START      (0)
1956#define V4L2_ENC_CMD_STOP       (1)
1957#define V4L2_ENC_CMD_PAUSE      (2)
1958#define V4L2_ENC_CMD_RESUME     (3)
1959
1960/* Flags for V4L2_ENC_CMD_STOP */
1961#define V4L2_ENC_CMD_STOP_AT_GOP_END    (1 << 0)
1962
1963struct v4l2_encoder_cmd {
1964        __u32 cmd;
1965        __u32 flags;
1966        union {
1967                struct {
1968                        __u32 data[8];
1969                } raw;
1970        };
1971};
1972
1973/* Decoder commands */
1974#define V4L2_DEC_CMD_START       (0)
1975#define V4L2_DEC_CMD_STOP        (1)
1976#define V4L2_DEC_CMD_PAUSE       (2)
1977#define V4L2_DEC_CMD_RESUME      (3)
1978
1979/* Flags for V4L2_DEC_CMD_START */
1980#define V4L2_DEC_CMD_START_MUTE_AUDIO   (1 << 0)
1981
1982/* Flags for V4L2_DEC_CMD_PAUSE */
1983#define V4L2_DEC_CMD_PAUSE_TO_BLACK     (1 << 0)
1984
1985/* Flags for V4L2_DEC_CMD_STOP */
1986#define V4L2_DEC_CMD_STOP_TO_BLACK      (1 << 0)
1987#define V4L2_DEC_CMD_STOP_IMMEDIATELY   (1 << 1)
1988
1989/* Play format requirements (returned by the driver): */
1990
1991/* The decoder has no special format requirements */
1992#define V4L2_DEC_START_FMT_NONE         (0)
1993/* The decoder requires full GOPs */
1994#define V4L2_DEC_START_FMT_GOP          (1)
1995
1996/* The structure must be zeroed before use by the application
1997   This ensures it can be extended safely in the future. */
1998struct v4l2_decoder_cmd {
1999        __u32 cmd;
2000        __u32 flags;
2001        union {
2002                struct {
2003                        __u64 pts;
2004                } stop;
2005
2006                struct {
2007                        /* 0 or 1000 specifies normal speed,
2008                           1 specifies forward single stepping,
2009                           -1 specifies backward single stepping,
2010                           >1: playback at speed/1000 of the normal speed,
2011                           <-1: reverse playback at (-speed/1000) of the normal speed. */
2012                        __s32 speed;
2013                        __u32 format;
2014                } start;
2015
2016                struct {
2017                        __u32 data[16];
2018                } raw;
2019        };
2020};
2021#endif
2022
2023
2024/*
2025 *      D A T A   S E R V I C E S   ( V B I )
2026 *
2027 *      Data services API by Michael Schimek
2028 */
2029
2030/* Raw VBI */
2031struct v4l2_vbi_format {
2032        __u32   sampling_rate;          /* in 1 Hz */
2033        __u32   offset;
2034        __u32   samples_per_line;
2035        __u32   sample_format;          /* V4L2_PIX_FMT_* */
2036        __s32   start[2];
2037        __u32   count[2];
2038        __u32   flags;                  /* V4L2_VBI_* */
2039        __u32   reserved[2];            /* must be zero */
2040};
2041
2042/*  VBI flags  */
2043#define V4L2_VBI_UNSYNC         (1 << 0)
2044#define V4L2_VBI_INTERLACED     (1 << 1)
2045
2046/* ITU-R start lines for each field */
2047#define V4L2_VBI_ITU_525_F1_START (1)
2048#define V4L2_VBI_ITU_525_F2_START (264)
2049#define V4L2_VBI_ITU_625_F1_START (1)
2050#define V4L2_VBI_ITU_625_F2_START (314)
2051
2052/* Sliced VBI
2053 *
2054 *    This implements is a proposal V4L2 API to allow SLICED VBI
2055 * required for some hardware encoders. It should change without
2056 * notice in the definitive implementation.
2057 */
2058
2059struct v4l2_sliced_vbi_format {
2060        __u16   service_set;
2061        /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2062           service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2063                                 (equals frame lines 313-336 for 625 line video
2064                                  standards, 263-286 for 525 line standards) */
2065        __u16   service_lines[2][24];
2066        __u32   io_size;
2067        __u32   reserved[2];            /* must be zero */
2068};
2069
2070/* Teletext World System Teletext
2071   (WST), defined on ITU-R BT.653-2 */
2072#define V4L2_SLICED_TELETEXT_B          (0x0001)
2073/* Video Program System, defined on ETS 300 231*/
2074#define V4L2_SLICED_VPS                 (0x0400)
2075/* Closed Caption, defined on EIA-608 */
2076#define V4L2_SLICED_CAPTION_525         (0x1000)
2077/* Wide Screen System, defined on ITU-R BT1119.1 */
2078#define V4L2_SLICED_WSS_625             (0x4000)
2079
2080#define V4L2_SLICED_VBI_525             (V4L2_SLICED_CAPTION_525)
2081#define V4L2_SLICED_VBI_625             (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
2082
2083struct v4l2_sliced_vbi_cap {
2084        __u16   service_set;
2085        /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
2086           service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
2087                                 (equals frame lines 313-336 for 625 line video
2088                                  standards, 263-286 for 525 line standards) */
2089        __u16   service_lines[2][24];
2090        __u32   type;           /* enum v4l2_buf_type */
2091        __u32   reserved[3];    /* must be 0 */
2092};
2093
2094struct v4l2_sliced_vbi_data {
2095        __u32   id;
2096        __u32   field;          /* 0: first field, 1: second field */
2097        __u32   line;           /* 1-23 */
2098        __u32   reserved;       /* must be 0 */
2099        __u8    data[48];
2100};
2101
2102/*
2103 * Sliced VBI data inserted into MPEG Streams
2104 */
2105
2106/*
2107 * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
2108 *
2109 * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
2110 * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
2111 * data
2112 *
2113 * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
2114 * definitions are not included here.  See the MPEG-2 specifications for details
2115 * on these headers.
2116 */
2117
2118/* Line type IDs */
2119#define V4L2_MPEG_VBI_IVTV_TELETEXT_B     (1)
2120#define V4L2_MPEG_VBI_IVTV_CAPTION_525    (4)
2121#define V4L2_MPEG_VBI_IVTV_WSS_625        (5)
2122#define V4L2_MPEG_VBI_IVTV_VPS            (7)
2123
2124struct v4l2_mpeg_vbi_itv0_line {
2125        __u8 id;        /* One of V4L2_MPEG_VBI_IVTV_* above */
2126        __u8 data[42];  /* Sliced VBI data for the line */
2127} __attribute__ ((packed));
2128
2129struct v4l2_mpeg_vbi_itv0 {
2130        __le32 linemask[2]; /* Bitmasks of VBI service lines present */
2131        struct v4l2_mpeg_vbi_itv0_line line[35];
2132} __attribute__ ((packed));
2133
2134struct v4l2_mpeg_vbi_ITV0 {
2135        struct v4l2_mpeg_vbi_itv0_line line[36];
2136} __attribute__ ((packed));
2137
2138#define V4L2_MPEG_VBI_IVTV_MAGIC0       "itv0"
2139#define V4L2_MPEG_VBI_IVTV_MAGIC1       "ITV0"
2140
2141struct v4l2_mpeg_vbi_fmt_ivtv {
2142        __u8 magic[4];
2143        union {
2144                struct v4l2_mpeg_vbi_itv0 itv0;
2145                struct v4l2_mpeg_vbi_ITV0 ITV0;
2146        };
2147} __attribute__ ((packed));
2148
2149/*
2150 *      A G G R E G A T E   S T R U C T U R E S
2151 */
2152
2153/**
2154 * struct v4l2_plane_pix_format - additional, per-plane format definition
2155 * @sizeimage:          maximum size in bytes required for data, for which
2156 *                      this plane will be used
2157 * @bytesperline:       distance in bytes between the leftmost pixels in two
2158 *                      adjacent lines
2159 */
2160struct v4l2_plane_pix_format {
2161        __u32           sizeimage;
2162        __u32           bytesperline;
2163        __u16           reserved[6];
2164} __attribute__ ((packed));
2165
2166/**
2167 * struct v4l2_pix_format_mplane - multiplanar format definition
2168 * @width:              image width in pixels
2169 * @height:             image height in pixels
2170 * @pixelformat:        little endian four character code (fourcc)
2171 * @field:              enum v4l2_field; field order (for interlaced video)
2172 * @colorspace:         enum v4l2_colorspace; supplemental to pixelformat
2173 * @plane_fmt:          per-plane information
2174 * @num_planes:         number of planes for this format
2175 * @flags:              format flags (V4L2_PIX_FMT_FLAG_*)
2176 * @ycbcr_enc:          enum v4l2_ycbcr_encoding, Y'CbCr encoding
2177 * @quantization:       enum v4l2_quantization, colorspace quantization
2178 * @xfer_func:          enum v4l2_xfer_func, colorspace transfer function
2179 */
2180struct v4l2_pix_format_mplane {
2181        __u32                           width;
2182        __u32                           height;
2183        __u32                           pixelformat;
2184        __u32                           field;
2185        __u32                           colorspace;
2186
2187        struct v4l2_plane_pix_format    plane_fmt[VIDEO_MAX_PLANES];
2188        __u8                            num_planes;
2189        __u8                            flags;
2190         union {
2191                __u8                            ycbcr_enc;
2192                __u8                            hsv_enc;
2193        };
2194        __u8                            quantization;
2195        __u8                            xfer_func;
2196        __u8                            reserved[7];
2197} __attribute__ ((packed));
2198
2199/**
2200 * struct v4l2_sdr_format - SDR format definition
2201 * @pixelformat:        little endian four character code (fourcc)
2202 * @buffersize:         maximum size in bytes required for data
2203 */
2204struct v4l2_sdr_format {
2205        __u32                           pixelformat;
2206        __u32                           buffersize;
2207        __u8                            reserved[24];
2208} __attribute__ ((packed));
2209
2210/**
2211 * struct v4l2_meta_format - metadata format definition
2212 * @dataformat:         little endian four character code (fourcc)
2213 * @buffersize:         maximum size in bytes required for data
2214 */
2215struct v4l2_meta_format {
2216        __u32                           dataformat;
2217        __u32                           buffersize;
2218} __attribute__ ((packed));
2219
2220/**
2221 * struct v4l2_format - stream data format
2222 * @type:       enum v4l2_buf_type; type of the data stream
2223 * @pix:        definition of an image format
2224 * @pix_mp:     definition of a multiplanar image format
2225 * @win:        definition of an overlaid image
2226 * @vbi:        raw VBI capture or output parameters
2227 * @sliced:     sliced VBI capture or output parameters
2228 * @raw_data:   placeholder for future extensions and custom formats
2229 */
2230struct v4l2_format {
2231        __u32    type;
2232        union {
2233                struct v4l2_pix_format          pix;     /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
2234                struct v4l2_pix_format_mplane   pix_mp;  /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
2235                struct v4l2_window              win;     /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
2236                struct v4l2_vbi_format          vbi;     /* V4L2_BUF_TYPE_VBI_CAPTURE */
2237                struct v4l2_sliced_vbi_format   sliced;  /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
2238                struct v4l2_sdr_format          sdr;     /* V4L2_BUF_TYPE_SDR_CAPTURE */
2239                struct v4l2_meta_format         meta;    /* V4L2_BUF_TYPE_META_CAPTURE */
2240                __u8    raw_data[200];                   /* user-defined */
2241        } fmt;
2242};
2243
2244/*      Stream type-dependent parameters
2245 */
2246struct v4l2_streamparm {
2247        __u32    type;                  /* enum v4l2_buf_type */
2248        union {
2249                struct v4l2_captureparm capture;
2250                struct v4l2_outputparm  output;
2251                __u8    raw_data[200];  /* user-defined */
2252        } parm;
2253};
2254
2255/*
2256 *      E V E N T S
2257 */
2258
2259#define V4L2_EVENT_ALL                          0
2260#define V4L2_EVENT_VSYNC                        1
2261#define V4L2_EVENT_EOS                          2
2262#define V4L2_EVENT_CTRL                         3
2263#define V4L2_EVENT_FRAME_SYNC                   4
2264#define V4L2_EVENT_SOURCE_CHANGE                5
2265#define V4L2_EVENT_MOTION_DET                   6
2266#define V4L2_EVENT_PRIVATE_START                0x08000000
2267
2268/* Payload for V4L2_EVENT_VSYNC */
2269struct v4l2_event_vsync {
2270        /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
2271        __u8 field;
2272} __attribute__ ((packed));
2273
2274/* Payload for V4L2_EVENT_CTRL */
2275#define V4L2_EVENT_CTRL_CH_VALUE                (1 << 0)
2276#define V4L2_EVENT_CTRL_CH_FLAGS                (1 << 1)
2277#define V4L2_EVENT_CTRL_CH_RANGE                (1 << 2)
2278
2279struct v4l2_event_ctrl {
2280        __u32 changes;
2281        __u32 type;
2282        union {
2283                __s32 value;
2284                __s64 value64;
2285        };
2286        __u32 flags;
2287        __s32 minimum;
2288        __s32 maximum;
2289        __s32 step;
2290        __s32 default_value;
2291};
2292
2293struct v4l2_event_frame_sync {
2294        __u32 frame_sequence;
2295};
2296
2297#define V4L2_EVENT_SRC_CH_RESOLUTION            (1 << 0)
2298
2299struct v4l2_event_src_change {
2300        __u32 changes;
2301};
2302
2303#define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
2304
2305/**
2306 * struct v4l2_event_motion_det - motion detection event
2307 * @flags:             if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
2308 *                     frame_sequence field is valid.
2309 * @frame_sequence:    the frame sequence number associated with this event.
2310 * @region_mask:       which regions detected motion.
2311 */
2312struct v4l2_event_motion_det {
2313        __u32 flags;
2314        __u32 frame_sequence;
2315        __u32 region_mask;
2316};
2317
2318struct v4l2_event {
2319        __u32                           type;
2320        union {
2321                struct v4l2_event_vsync         vsync;
2322                struct v4l2_event_ctrl          ctrl;
2323                struct v4l2_event_frame_sync    frame_sync;
2324                struct v4l2_event_src_change    src_change;
2325                struct v4l2_event_motion_det    motion_det;
2326                __u8                            data[64];
2327        } u;
2328        __u32                           pending;
2329        __u32                           sequence;
2330        struct timespec                 timestamp;
2331        __u32                           id;
2332        __u32                           reserved[8];
2333};
2334
2335#define V4L2_EVENT_SUB_FL_SEND_INITIAL          (1 << 0)
2336#define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK        (1 << 1)
2337
2338struct v4l2_event_subscription {
2339        __u32                           type;
2340        __u32                           id;
2341        __u32                           flags;
2342        __u32                           reserved[5];
2343};
2344
2345/*
2346 *      A D V A N C E D   D E B U G G I N G
2347 *
2348 *      NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
2349 *      FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
2350 */
2351
2352/* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
2353
2354#define V4L2_CHIP_MATCH_BRIDGE      0  /* Match against chip ID on the bridge (0 for the bridge) */
2355#define V4L2_CHIP_MATCH_SUBDEV      4  /* Match against subdev index */
2356
2357/* The following four defines are no longer in use */
2358#define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
2359#define V4L2_CHIP_MATCH_I2C_DRIVER  1  /* Match against I2C driver name */
2360#define V4L2_CHIP_MATCH_I2C_ADDR    2  /* Match against I2C 7-bit address */
2361#define V4L2_CHIP_MATCH_AC97        3  /* Match against ancillary AC97 chip */
2362
2363struct v4l2_dbg_match {
2364        __u32 type; /* Match type */
2365        union {     /* Match this chip, meaning determined by type */
2366                __u32 addr;
2367                char name[32];
2368        };
2369} __attribute__ ((packed));
2370
2371struct v4l2_dbg_register {
2372        struct v4l2_dbg_match match;
2373        __u32 size;     /* register size in bytes */
2374        __u64 reg;
2375        __u64 val;
2376} __attribute__ ((packed));
2377
2378#define V4L2_CHIP_FL_READABLE (1 << 0)
2379#define V4L2_CHIP_FL_WRITABLE (1 << 1)
2380
2381/* VIDIOC_DBG_G_CHIP_INFO */
2382struct v4l2_dbg_chip_info {
2383        struct v4l2_dbg_match match;
2384        char name[32];
2385        __u32 flags;
2386        __u32 reserved[32];
2387} __attribute__ ((packed));
2388
2389/**
2390 * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
2391 * @index:      on return, index of the first created buffer
2392 * @count:      entry: number of requested buffers,
2393 *              return: number of created buffers
2394 * @memory:     enum v4l2_memory; buffer memory type
2395 * @format:     frame format, for which buffers are requested
2396 * @capabilities: capabilities of this buffer type.
2397 * @reserved:   future extensions
2398 */
2399struct v4l2_create_buffers {
2400        __u32                   index;
2401        __u32                   count;
2402        __u32                   memory;
2403        struct v4l2_format      format;
2404        __u32                   capabilities;
2405        __u32                   reserved[7];
2406};
2407
2408/*
2409 *      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
2410 *
2411 */
2412#define VIDIOC_QUERYCAP          _IOR('V',  0, struct v4l2_capability)
2413#define VIDIOC_ENUM_FMT         _IOWR('V',  2, struct v4l2_fmtdesc)
2414#define VIDIOC_G_FMT            _IOWR('V',  4, struct v4l2_format)
2415#define VIDIOC_S_FMT            _IOWR('V',  5, struct v4l2_format)
2416#define VIDIOC_REQBUFS          _IOWR('V',  8, struct v4l2_requestbuffers)
2417#define VIDIOC_QUERYBUF         _IOWR('V',  9, struct v4l2_buffer)
2418#define VIDIOC_G_FBUF            _IOR('V', 10, struct v4l2_framebuffer)
2419#define VIDIOC_S_FBUF            _IOW('V', 11, struct v4l2_framebuffer)
2420#define VIDIOC_OVERLAY           _IOW('V', 14, int)
2421#define VIDIOC_QBUF             _IOWR('V', 15, struct v4l2_buffer)
2422#define VIDIOC_EXPBUF           _IOWR('V', 16, struct v4l2_exportbuffer)
2423#define VIDIOC_DQBUF            _IOWR('V', 17, struct v4l2_buffer)
2424#define VIDIOC_STREAMON          _IOW('V', 18, int)
2425#define VIDIOC_STREAMOFF         _IOW('V', 19, int)
2426#define VIDIOC_G_PARM           _IOWR('V', 21, struct v4l2_streamparm)
2427#define VIDIOC_S_PARM           _IOWR('V', 22, struct v4l2_streamparm)
2428#define VIDIOC_G_STD             _IOR('V', 23, v4l2_std_id)
2429#define VIDIOC_S_STD             _IOW('V', 24, v4l2_std_id)
2430#define VIDIOC_ENUMSTD          _IOWR('V', 25, struct v4l2_standard)
2431#define VIDIOC_ENUMINPUT        _IOWR('V', 26, struct v4l2_input)
2432#define VIDIOC_G_CTRL           _IOWR('V', 27, struct v4l2_control)
2433#define VIDIOC_S_CTRL           _IOWR('V', 28, struct v4l2_control)
2434#define VIDIOC_G_TUNER          _IOWR('V', 29, struct v4l2_tuner)
2435#define VIDIOC_S_TUNER           _IOW('V', 30, struct v4l2_tuner)
2436#define VIDIOC_G_AUDIO           _IOR('V', 33, struct v4l2_audio)
2437#define VIDIOC_S_AUDIO           _IOW('V', 34, struct v4l2_audio)
2438#define VIDIOC_QUERYCTRL        _IOWR('V', 36, struct v4l2_queryctrl)
2439#define VIDIOC_QUERYMENU        _IOWR('V', 37, struct v4l2_querymenu)
2440#define VIDIOC_G_INPUT           _IOR('V', 38, int)
2441#define VIDIOC_S_INPUT          _IOWR('V', 39, int)
2442#define VIDIOC_G_EDID           _IOWR('V', 40, struct v4l2_edid)
2443#define VIDIOC_S_EDID           _IOWR('V', 41, struct v4l2_edid)
2444#define VIDIOC_G_OUTPUT          _IOR('V', 46, int)
2445#define VIDIOC_S_OUTPUT         _IOWR('V', 47, int)
2446#define VIDIOC_ENUMOUTPUT       _IOWR('V', 48, struct v4l2_output)
2447#define VIDIOC_G_AUDOUT          _IOR('V', 49, struct v4l2_audioout)
2448#define VIDIOC_S_AUDOUT          _IOW('V', 50, struct v4l2_audioout)
2449#define VIDIOC_G_MODULATOR      _IOWR('V', 54, struct v4l2_modulator)
2450#define VIDIOC_S_MODULATOR       _IOW('V', 55, struct v4l2_modulator)
2451#define VIDIOC_G_FREQUENCY      _IOWR('V', 56, struct v4l2_frequency)
2452#define VIDIOC_S_FREQUENCY       _IOW('V', 57, struct v4l2_frequency)
2453#define VIDIOC_CROPCAP          _IOWR('V', 58, struct v4l2_cropcap)
2454#define VIDIOC_G_CROP           _IOWR('V', 59, struct v4l2_crop)
2455#define VIDIOC_S_CROP            _IOW('V', 60, struct v4l2_crop)
2456#define VIDIOC_G_JPEGCOMP        _IOR('V', 61, struct v4l2_jpegcompression)
2457#define VIDIOC_S_JPEGCOMP        _IOW('V', 62, struct v4l2_jpegcompression)
2458#define VIDIOC_QUERYSTD          _IOR('V', 63, v4l2_std_id)
2459#define VIDIOC_TRY_FMT          _IOWR('V', 64, struct v4l2_format)
2460#define VIDIOC_ENUMAUDIO        _IOWR('V', 65, struct v4l2_audio)
2461#define VIDIOC_ENUMAUDOUT       _IOWR('V', 66, struct v4l2_audioout)
2462#define VIDIOC_G_PRIORITY        _IOR('V', 67, __u32) /* enum v4l2_priority */
2463#define VIDIOC_S_PRIORITY        _IOW('V', 68, __u32) /* enum v4l2_priority */
2464#define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
2465#define VIDIOC_LOG_STATUS         _IO('V', 70)
2466#define VIDIOC_G_EXT_CTRLS      _IOWR('V', 71, struct v4l2_ext_controls)
2467#define VIDIOC_S_EXT_CTRLS      _IOWR('V', 72, struct v4l2_ext_controls)
2468#define VIDIOC_TRY_EXT_CTRLS    _IOWR('V', 73, struct v4l2_ext_controls)
2469#define VIDIOC_ENUM_FRAMESIZES  _IOWR('V', 74, struct v4l2_frmsizeenum)
2470#define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
2471#define VIDIOC_G_ENC_INDEX       _IOR('V', 76, struct v4l2_enc_idx)
2472#define VIDIOC_ENCODER_CMD      _IOWR('V', 77, struct v4l2_encoder_cmd)
2473#define VIDIOC_TRY_ENCODER_CMD  _IOWR('V', 78, struct v4l2_encoder_cmd)
2474
2475/*
2476 * Experimental, meant for debugging, testing and internal use.
2477 * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
2478 * You must be root to use these ioctls. Never use these in applications!
2479 */
2480#define VIDIOC_DBG_S_REGISTER    _IOW('V', 79, struct v4l2_dbg_register)
2481#define VIDIOC_DBG_G_REGISTER   _IOWR('V', 80, struct v4l2_dbg_register)
2482
2483#define VIDIOC_S_HW_FREQ_SEEK    _IOW('V', 82, struct v4l2_hw_freq_seek)
2484#define VIDIOC_S_DV_TIMINGS     _IOWR('V', 87, struct v4l2_dv_timings)
2485#define VIDIOC_G_DV_TIMINGS     _IOWR('V', 88, struct v4l2_dv_timings)
2486#define VIDIOC_DQEVENT           _IOR('V', 89, struct v4l2_event)
2487#define VIDIOC_SUBSCRIBE_EVENT   _IOW('V', 90, struct v4l2_event_subscription)
2488#define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
2489#define VIDIOC_CREATE_BUFS      _IOWR('V', 92, struct v4l2_create_buffers)
2490#define VIDIOC_PREPARE_BUF      _IOWR('V', 93, struct v4l2_buffer)
2491#define VIDIOC_G_SELECTION      _IOWR('V', 94, struct v4l2_selection)
2492#define VIDIOC_S_SELECTION      _IOWR('V', 95, struct v4l2_selection)
2493#define VIDIOC_DECODER_CMD      _IOWR('V', 96, struct v4l2_decoder_cmd)
2494#define VIDIOC_TRY_DECODER_CMD  _IOWR('V', 97, struct v4l2_decoder_cmd)
2495#define VIDIOC_ENUM_DV_TIMINGS  _IOWR('V', 98, struct v4l2_enum_dv_timings)
2496#define VIDIOC_QUERY_DV_TIMINGS  _IOR('V', 99, struct v4l2_dv_timings)
2497#define VIDIOC_DV_TIMINGS_CAP   _IOWR('V', 100, struct v4l2_dv_timings_cap)
2498#define VIDIOC_ENUM_FREQ_BANDS  _IOWR('V', 101, struct v4l2_frequency_band)
2499
2500/*
2501 * Experimental, meant for debugging, testing and internal use.
2502 * Never use this in applications!
2503 */
2504#define VIDIOC_DBG_G_CHIP_INFO  _IOWR('V', 102, struct v4l2_dbg_chip_info)
2505
2506#define VIDIOC_QUERY_EXT_CTRL   _IOWR('V', 103, struct v4l2_query_ext_ctrl)
2507
2508/* Reminder: when adding new ioctls please add support for them to
2509   drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
2510
2511#define BASE_VIDIOC_PRIVATE     192             /* 192-255 are private */
2512
2513#endif /* _UAPI__LINUX_VIDEODEV2_H */
2514