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