kernel/include/uapi/linux/videodev2.h

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