LXR linux/include/uapi/linux/v4l2-subdev.h

   1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   2/*
   3 * V4L2 subdev userspace API
   4 *
   5 * Copyright (C) 2010 Nokia Corporation
   6 *
   7 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
   8 *           Sakari Ailus <sakari.ailus@iki.fi>
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License version 2 as
  12 * published by the Free Software Foundation.
  13 *
  14 * This program is distributed in the hope that it will be useful,
  15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 * GNU General Public License for more details.
  18 *
  19 * You should have received a copy of the GNU General Public License
  20 * along with this program; if not, write to the Free Software
  21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22 */
  23
  24#ifndef __LINUX_V4L2_SUBDEV_H
  25#define __LINUX_V4L2_SUBDEV_H
  26
  27#include <linux/ioctl.h>
  28#include <linux/types.h>
  29#include <linux/v4l2-common.h>
  30#include <linux/v4l2-mediabus.h>
  31
  32/**
  33 * enum v4l2_subdev_format_whence - Media bus format type
  34 * @V4L2_SUBDEV_FORMAT_TRY: try format, for negotiation only
  35 * @V4L2_SUBDEV_FORMAT_ACTIVE: active format, applied to the device
  36 */
  37enum v4l2_subdev_format_whence {
  38        V4L2_SUBDEV_FORMAT_TRY = 0,
  39        V4L2_SUBDEV_FORMAT_ACTIVE = 1,
  40};
  41
  42/**
  43 * struct v4l2_subdev_format - Pad-level media bus format
  44 * @which: format type (from enum v4l2_subdev_format_whence)
  45 * @pad: pad number, as reported by the media API
  46 * @format: media bus format (format code and frame size)
  47 */
  48struct v4l2_subdev_format {
  49        __u32 which;
  50        __u32 pad;
  51        struct v4l2_mbus_framefmt format;
  52        __u32 reserved[8];
  53};
  54
  55/**
  56 * struct v4l2_subdev_crop - Pad-level crop settings
  57 * @which: format type (from enum v4l2_subdev_format_whence)
  58 * @pad: pad number, as reported by the media API
  59 * @rect: pad crop rectangle boundaries
  60 */
  61struct v4l2_subdev_crop {
  62        __u32 which;
  63        __u32 pad;
  64        struct v4l2_rect rect;
  65        __u32 reserved[8];
  66};
  67
  68#define V4L2_SUBDEV_MBUS_CODE_CSC_COLORSPACE    0x00000001
  69#define V4L2_SUBDEV_MBUS_CODE_CSC_XFER_FUNC     0x00000002
  70#define V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC     0x00000004
  71#define V4L2_SUBDEV_MBUS_CODE_CSC_HSV_ENC       V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC
  72#define V4L2_SUBDEV_MBUS_CODE_CSC_QUANTIZATION  0x00000008
  73
  74/**
  75 * struct v4l2_subdev_mbus_code_enum - Media bus format enumeration
  76 * @pad: pad number, as reported by the media API
  77 * @index: format index during enumeration
  78 * @code: format code (MEDIA_BUS_FMT_ definitions)
  79 * @which: format type (from enum v4l2_subdev_format_whence)
  80 * @flags: flags set by the driver, (V4L2_SUBDEV_MBUS_CODE_*)
  81 */
  82struct v4l2_subdev_mbus_code_enum {
  83        __u32 pad;
  84        __u32 index;
  85        __u32 code;
  86        __u32 which;
  87        __u32 flags;
  88        __u32 reserved[7];
  89};
  90
  91/**
  92 * struct v4l2_subdev_frame_size_enum - Media bus format enumeration
  93 * @pad: pad number, as reported by the media API
  94 * @index: format index during enumeration
  95 * @code: format code (MEDIA_BUS_FMT_ definitions)
  96 * @which: format type (from enum v4l2_subdev_format_whence)
  97 */
  98struct v4l2_subdev_frame_size_enum {
  99        __u32 index;
 100        __u32 pad;
 101        __u32 code;
 102        __u32 min_width;
 103        __u32 max_width;
 104        __u32 min_height;
 105        __u32 max_height;
 106        __u32 which;
 107        __u32 reserved[8];
 108};
 109
 110/**
 111 * struct v4l2_subdev_frame_interval - Pad-level frame rate
 112 * @pad: pad number, as reported by the media API
 113 * @interval: frame interval in seconds
 114 */
 115struct v4l2_subdev_frame_interval {
 116        __u32 pad;
 117        struct v4l2_fract interval;
 118        __u32 reserved[9];
 119};
 120
 121/**
 122 * struct v4l2_subdev_frame_interval_enum - Frame interval enumeration
 123 * @pad: pad number, as reported by the media API
 124 * @index: frame interval index during enumeration
 125 * @code: format code (MEDIA_BUS_FMT_ definitions)
 126 * @width: frame width in pixels
 127 * @height: frame height in pixels
 128 * @interval: frame interval in seconds
 129 * @which: format type (from enum v4l2_subdev_format_whence)
 130 */
 131struct v4l2_subdev_frame_interval_enum {
 132        __u32 index;
 133        __u32 pad;
 134        __u32 code;
 135        __u32 width;
 136        __u32 height;
 137        struct v4l2_fract interval;
 138        __u32 which;
 139        __u32 reserved[8];
 140};
 141
 142/**
 143 * struct v4l2_subdev_selection - selection info
 144 *
 145 * @which: either V4L2_SUBDEV_FORMAT_ACTIVE or V4L2_SUBDEV_FORMAT_TRY
 146 * @pad: pad number, as reported by the media API
 147 * @target: Selection target, used to choose one of possible rectangles,
 148 *          defined in v4l2-common.h; V4L2_SEL_TGT_* .
 149 * @flags: constraint flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
 150 * @r: coordinates of the selection window
 151 * @reserved: for future use, set to zero for now
 152 *
 153 * Hardware may use multiple helper windows to process a video stream.
 154 * The structure is used to exchange this selection areas between
 155 * an application and a driver.
 156 */
 157struct v4l2_subdev_selection {
 158        __u32 which;
 159        __u32 pad;
 160        __u32 target;
 161        __u32 flags;
 162        struct v4l2_rect r;
 163        __u32 reserved[8];
 164};
 165
 166/**
 167 * struct v4l2_subdev_capability - subdev capabilities
 168 * @version: the driver versioning number
 169 * @capabilities: the subdev capabilities, see V4L2_SUBDEV_CAP_*
 170 * @reserved: for future use, set to zero for now
 171 */
 172struct v4l2_subdev_capability {
 173        __u32 version;
 174        __u32 capabilities;
 175        __u32 reserved[14];
 176};
 177
 178/* The v4l2 sub-device video device node is registered in read-only mode. */
 179#define V4L2_SUBDEV_CAP_RO_SUBDEV               BIT(0)
 180
 181/* Backwards compatibility define --- to be removed */
 182#define v4l2_subdev_edid v4l2_edid
 183
 184#define VIDIOC_SUBDEV_QUERYCAP                  _IOR('V',  0, struct v4l2_subdev_capability)
 185#define VIDIOC_SUBDEV_G_FMT                     _IOWR('V',  4, struct v4l2_subdev_format)
 186#define VIDIOC_SUBDEV_S_FMT                     _IOWR('V',  5, struct v4l2_subdev_format)
 187#define VIDIOC_SUBDEV_G_FRAME_INTERVAL          _IOWR('V', 21, struct v4l2_subdev_frame_interval)
 188#define VIDIOC_SUBDEV_S_FRAME_INTERVAL          _IOWR('V', 22, struct v4l2_subdev_frame_interval)
 189#define VIDIOC_SUBDEV_ENUM_MBUS_CODE            _IOWR('V',  2, struct v4l2_subdev_mbus_code_enum)
 190#define VIDIOC_SUBDEV_ENUM_FRAME_SIZE           _IOWR('V', 74, struct v4l2_subdev_frame_size_enum)
 191#define VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL       _IOWR('V', 75, struct v4l2_subdev_frame_interval_enum)
 192#define VIDIOC_SUBDEV_G_CROP                    _IOWR('V', 59, struct v4l2_subdev_crop)
 193#define VIDIOC_SUBDEV_S_CROP                    _IOWR('V', 60, struct v4l2_subdev_crop)
 194#define VIDIOC_SUBDEV_G_SELECTION               _IOWR('V', 61, struct v4l2_subdev_selection)
 195#define VIDIOC_SUBDEV_S_SELECTION               _IOWR('V', 62, struct v4l2_subdev_selection)
 196/* The following ioctls are identical to the ioctls in videodev2.h */
 197#define VIDIOC_SUBDEV_G_STD                     _IOR('V', 23, v4l2_std_id)
 198#define VIDIOC_SUBDEV_S_STD                     _IOW('V', 24, v4l2_std_id)
 199#define VIDIOC_SUBDEV_ENUMSTD                   _IOWR('V', 25, struct v4l2_standard)
 200#define VIDIOC_SUBDEV_G_EDID                    _IOWR('V', 40, struct v4l2_edid)
 201#define VIDIOC_SUBDEV_S_EDID                    _IOWR('V', 41, struct v4l2_edid)
 202#define VIDIOC_SUBDEV_QUERYSTD                  _IOR('V', 63, v4l2_std_id)
 203#define VIDIOC_SUBDEV_S_DV_TIMINGS              _IOWR('V', 87, struct v4l2_dv_timings)
 204#define VIDIOC_SUBDEV_G_DV_TIMINGS              _IOWR('V', 88, struct v4l2_dv_timings)
 205#define VIDIOC_SUBDEV_ENUM_DV_TIMINGS           _IOWR('V', 98, struct v4l2_enum_dv_timings)
 206#define VIDIOC_SUBDEV_QUERY_DV_TIMINGS          _IOR('V', 99, struct v4l2_dv_timings)
 207#define VIDIOC_SUBDEV_DV_TIMINGS_CAP            _IOWR('V', 100, struct v4l2_dv_timings_cap)
 208
 209#endif
 210