[linux-block.git] / include / uapi / linux / v4l2-subdev.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * V4L2 subdev userspace API
 *
 * Copyright (C) 2010 Nokia Corporation
 *
 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
 *	     Sakari Ailus <sakari.ailus@iki.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __LINUX_V4L2_SUBDEV_H
#define __LINUX_V4L2_SUBDEV_H

#include <linux/ioctl.h>
#include <linux/types.h>
#include <linux/v4l2-common.h>
#include <linux/v4l2-mediabus.h>

/**
 * enum v4l2_subdev_format_whence - Media bus format type
 * @V4L2_SUBDEV_FORMAT_TRY: try format, for negotiation only
 * @V4L2_SUBDEV_FORMAT_ACTIVE: active format, applied to the device
 */
enum v4l2_subdev_format_whence {
	V4L2_SUBDEV_FORMAT_TRY = 0,
	V4L2_SUBDEV_FORMAT_ACTIVE = 1,
};

/**
 * struct v4l2_subdev_format - Pad-level media bus format
 * @which: format type (from enum v4l2_subdev_format_whence)
 * @pad: pad number, as reported by the media API
 * @format: media bus format (format code and frame size)
 * @reserved: drivers and applications must zero this array
 */
struct v4l2_subdev_format {
	__u32 which;
	__u32 pad;
	struct v4l2_mbus_framefmt format;
	__u32 reserved[8];
};

/**
 * struct v4l2_subdev_crop - Pad-level crop settings
 * @which: format type (from enum v4l2_subdev_format_whence)
 * @pad: pad number, as reported by the media API
 * @rect: pad crop rectangle boundaries
 * @reserved: drivers and applications must zero this array
 */
struct v4l2_subdev_crop {
	__u32 which;
	__u32 pad;
	struct v4l2_rect rect;
	__u32 reserved[8];
};

#define V4L2_SUBDEV_MBUS_CODE_CSC_COLORSPACE	0x00000001
#define V4L2_SUBDEV_MBUS_CODE_CSC_XFER_FUNC	0x00000002
#define V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC	0x00000004
#define V4L2_SUBDEV_MBUS_CODE_CSC_HSV_ENC	V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC
#define V4L2_SUBDEV_MBUS_CODE_CSC_QUANTIZATION	0x00000008

/**
 * struct v4l2_subdev_mbus_code_enum - Media bus format enumeration
 * @pad: pad number, as reported by the media API
 * @index: format index during enumeration
 * @code: format code (MEDIA_BUS_FMT_ definitions)
 * @which: format type (from enum v4l2_subdev_format_whence)
 * @flags: flags set by the driver, (V4L2_SUBDEV_MBUS_CODE_*)
 * @reserved: drivers and applications must zero this array
 */
struct v4l2_subdev_mbus_code_enum {
	__u32 pad;
	__u32 index;
	__u32 code;
	__u32 which;
	__u32 flags;
	__u32 reserved[7];
};

/**
 * struct v4l2_subdev_frame_size_enum - Media bus format enumeration
 * @index: format index during enumeration
 * @pad: pad number, as reported by the media API
 * @code: format code (MEDIA_BUS_FMT_ definitions)
 * @min_width: minimum frame width, in pixels
 * @max_width: maximum frame width, in pixels
 * @min_height: minimum frame height, in pixels
 * @max_height: maximum frame height, in pixels
 * @which: format type (from enum v4l2_subdev_format_whence)
 * @reserved: drivers and applications must zero this array
 */
struct v4l2_subdev_frame_size_enum {
	__u32 index;
	__u32 pad;
	__u32 code;
	__u32 min_width;
	__u32 max_width;
	__u32 min_height;
	__u32 max_height;
	__u32 which;
	__u32 reserved[8];
};

/**
 * struct v4l2_subdev_frame_interval - Pad-level frame rate
 * @pad: pad number, as reported by the media API
 * @interval: frame interval in seconds
 * @reserved: drivers and applications must zero this array
 */
struct v4l2_subdev_frame_interval {
	__u32 pad;
	struct v4l2_fract interval;
	__u32 reserved[9];
};

/**
 * struct v4l2_subdev_frame_interval_enum - Frame interval enumeration
 * @pad: pad number, as reported by the media API
 * @index: frame interval index during enumeration
 * @code: format code (MEDIA_BUS_FMT_ definitions)
 * @width: frame width in pixels
 * @height: frame height in pixels
 * @interval: frame interval in seconds
 * @which: format type (from enum v4l2_subdev_format_whence)
 * @reserved: drivers and applications must zero this array
 */
struct v4l2_subdev_frame_interval_enum {
	__u32 index;
	__u32 pad;
	__u32 code;
	__u32 width;
	__u32 height;
	struct v4l2_fract interval;
	__u32 which;
	__u32 reserved[8];
};

/**
 * struct v4l2_subdev_selection - selection info
 *
 * @which: either V4L2_SUBDEV_FORMAT_ACTIVE or V4L2_SUBDEV_FORMAT_TRY
 * @pad: pad number, as reported by the media API
 * @target: Selection target, used to choose one of possible rectangles,
 *	    defined in v4l2-common.h; V4L2_SEL_TGT_* .
 * @flags: constraint flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
 * @r: coordinates of the selection window
 * @reserved: for future use, set to zero for now
 *
 * Hardware may use multiple helper windows to process a video stream.
 * The structure is used to exchange this selection areas between
 * an application and a driver.
 */
struct v4l2_subdev_selection {
	__u32 which;
	__u32 pad;
	__u32 target;
	__u32 flags;
	struct v4l2_rect r;
	__u32 reserved[8];
};

/**
 * struct v4l2_subdev_capability - subdev capabilities
 * @version: the driver versioning number
 * @capabilities: the subdev capabilities, see V4L2_SUBDEV_CAP_*
 * @reserved: for future use, set to zero for now
 */
struct v4l2_subdev_capability {
	__u32 version;
	__u32 capabilities;
	__u32 reserved[14];
};

/* The v4l2 sub-device video device node is registered in read-only mode. */
#define V4L2_SUBDEV_CAP_RO_SUBDEV		0x00000001

/* Backwards compatibility define --- to be removed */
#define v4l2_subdev_edid v4l2_edid

#define VIDIOC_SUBDEV_QUERYCAP			_IOR('V',  0, struct v4l2_subdev_capability)
#define VIDIOC_SUBDEV_G_FMT			_IOWR('V',  4, struct v4l2_subdev_format)
#define VIDIOC_SUBDEV_S_FMT			_IOWR('V',  5, struct v4l2_subdev_format)
#define VIDIOC_SUBDEV_G_FRAME_INTERVAL		_IOWR('V', 21, struct v4l2_subdev_frame_interval)
#define VIDIOC_SUBDEV_S_FRAME_INTERVAL		_IOWR('V', 22, struct v4l2_subdev_frame_interval)
#define VIDIOC_SUBDEV_ENUM_MBUS_CODE		_IOWR('V',  2, struct v4l2_subdev_mbus_code_enum)
#define VIDIOC_SUBDEV_ENUM_FRAME_SIZE		_IOWR('V', 74, struct v4l2_subdev_frame_size_enum)
#define VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL	_IOWR('V', 75, struct v4l2_subdev_frame_interval_enum)
#define VIDIOC_SUBDEV_G_CROP			_IOWR('V', 59, struct v4l2_subdev_crop)
#define VIDIOC_SUBDEV_S_CROP			_IOWR('V', 60, struct v4l2_subdev_crop)
#define VIDIOC_SUBDEV_G_SELECTION		_IOWR('V', 61, struct v4l2_subdev_selection)
#define VIDIOC_SUBDEV_S_SELECTION		_IOWR('V', 62, struct v4l2_subdev_selection)
/* The following ioctls are identical to the ioctls in videodev2.h */
#define VIDIOC_SUBDEV_G_STD			_IOR('V', 23, v4l2_std_id)
#define VIDIOC_SUBDEV_S_STD			_IOW('V', 24, v4l2_std_id)
#define VIDIOC_SUBDEV_ENUMSTD			_IOWR('V', 25, struct v4l2_standard)
#define VIDIOC_SUBDEV_G_EDID			_IOWR('V', 40, struct v4l2_edid)
#define VIDIOC_SUBDEV_S_EDID			_IOWR('V', 41, struct v4l2_edid)
#define VIDIOC_SUBDEV_QUERYSTD			_IOR('V', 63, v4l2_std_id)
#define VIDIOC_SUBDEV_S_DV_TIMINGS		_IOWR('V', 87, struct v4l2_dv_timings)
#define VIDIOC_SUBDEV_G_DV_TIMINGS		_IOWR('V', 88, struct v4l2_dv_timings)
#define VIDIOC_SUBDEV_ENUM_DV_TIMINGS		_IOWR('V', 98, struct v4l2_enum_dv_timings)
#define VIDIOC_SUBDEV_QUERY_DV_TIMINGS		_IOR('V', 99, struct v4l2_dv_timings)
#define VIDIOC_SUBDEV_DV_TIMINGS_CAP		_IOWR('V', 100, struct v4l2_dv_timings_cap)

#endif
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
333c8b97 LP	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>
5689b288	29	#include <linux/v4l2-common.h>
333c8b97 LP	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	*/
	37	enum 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)
f12b81e4	47	* @reserved: drivers and applications must zero this array
333c8b97 LP	48	*/
	49	struct v4l2_subdev_format {
	50	__u32 which;
	51	__u32 pad;
	52	struct v4l2_mbus_framefmt format;
	53	__u32 reserved[8];
	54	};
	55
f6a5cb1b AK	56	/**
	57	* struct v4l2_subdev_crop - Pad-level crop settings
	58	* @which: format type (from enum v4l2_subdev_format_whence)
	59	* @pad: pad number, as reported by the media API
	60	* @rect: pad crop rectangle boundaries
f12b81e4	61	* @reserved: drivers and applications must zero this array
f6a5cb1b AK	62	*/
	63	struct v4l2_subdev_crop {
	64	__u32 which;
	65	__u32 pad;
	66	struct v4l2_rect rect;
	67	__u32 reserved[8];
	68	};
	69
62aacfa9 DH	70	#define V4L2_SUBDEV_MBUS_CODE_CSC_COLORSPACE 0x00000001
	71	#define V4L2_SUBDEV_MBUS_CODE_CSC_XFER_FUNC 0x00000002
	72	#define V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC 0x00000004
	73	#define V4L2_SUBDEV_MBUS_CODE_CSC_HSV_ENC V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC
	74	#define V4L2_SUBDEV_MBUS_CODE_CSC_QUANTIZATION 0x00000008
	75
333c8b97 LP	76	/**
	77	* struct v4l2_subdev_mbus_code_enum - Media bus format enumeration
	78	* @pad: pad number, as reported by the media API
	79	* @index: format index during enumeration
32b32ce8	80	* @code: format code (MEDIA_BUS_FMT_ definitions)
e1c47e73	81	* @which: format type (from enum v4l2_subdev_format_whence)
62aacfa9	82	* @flags: flags set by the driver, (V4L2_SUBDEV_MBUS_CODE_*)
f12b81e4	83	* @reserved: drivers and applications must zero this array
333c8b97 LP	84	*/
	85	struct v4l2_subdev_mbus_code_enum {
	86	__u32 pad;
	87	__u32 index;
	88	__u32 code;
e1c47e73	89	__u32 which;
62aacfa9 DH	90	__u32 flags;
62aacfa9 DH	91	__u32 reserved[7];
333c8b97 LP	92	};
	93
	94	/**
	95	* struct v4l2_subdev_frame_size_enum - Media bus format enumeration
333c8b97	96	* @index: format index during enumeration
f12b81e4	97	* @pad: pad number, as reported by the media API
32b32ce8	98	* @code: format code (MEDIA_BUS_FMT_ definitions)
f12b81e4 HV	99	* @min_width: minimum frame width, in pixels
	100	* @max_width: maximum frame width, in pixels
	101	* @min_height: minimum frame height, in pixels
	102	* @max_height: maximum frame height, in pixels
e1c47e73	103	* @which: format type (from enum v4l2_subdev_format_whence)
f12b81e4	104	* @reserved: drivers and applications must zero this array
333c8b97 LP	105	*/
	106	struct v4l2_subdev_frame_size_enum {
	107	__u32 index;
	108	__u32 pad;
	109	__u32 code;
	110	__u32 min_width;
	111	__u32 max_width;
	112	__u32 min_height;
	113	__u32 max_height;
e1c47e73 HV	114	__u32 which;
e1c47e73 HV	115	__u32 reserved[8];
333c8b97 LP	116	};
333c8b97 LP	117
35c3017a LP	118	/**
	119	* struct v4l2_subdev_frame_interval - Pad-level frame rate
	120	* @pad: pad number, as reported by the media API
	121	* @interval: frame interval in seconds
f12b81e4	122	* @reserved: drivers and applications must zero this array
35c3017a LP	123	*/
	124	struct v4l2_subdev_frame_interval {
	125	__u32 pad;
	126	struct v4l2_fract interval;
	127	__u32 reserved[9];
	128	};
	129
	130	/**
	131	* struct v4l2_subdev_frame_interval_enum - Frame interval enumeration
	132	* @pad: pad number, as reported by the media API
	133	* @index: frame interval index during enumeration
32b32ce8	134	* @code: format code (MEDIA_BUS_FMT_ definitions)
35c3017a LP	135	* @width: frame width in pixels
	136	* @height: frame height in pixels
	137	* @interval: frame interval in seconds
e1c47e73	138	* @which: format type (from enum v4l2_subdev_format_whence)
f12b81e4	139	* @reserved: drivers and applications must zero this array
35c3017a LP	140	*/
	141	struct v4l2_subdev_frame_interval_enum {
	142	__u32 index;
	143	__u32 pad;
	144	__u32 code;
	145	__u32 width;
	146	__u32 height;
	147	struct v4l2_fract interval;
e1c47e73 HV	148	__u32 which;
e1c47e73 HV	149	__u32 reserved[8];
35c3017a LP	150	};
35c3017a LP	151
ae184cda SA	152	/**
	153	* struct v4l2_subdev_selection - selection info
	154	*
	155	* @which: either V4L2_SUBDEV_FORMAT_ACTIVE or V4L2_SUBDEV_FORMAT_TRY
	156	* @pad: pad number, as reported by the media API
5689b288 SA	157	* @target: Selection target, used to choose one of possible rectangles,
5689b288 SA	158	* defined in v4l2-common.h; V4L2_SEL_TGT_* .
563df3d0	159	* @flags: constraint flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
ae184cda SA	160	* @r: coordinates of the selection window
	161	* @reserved: for future use, set to zero for now
	162	*
	163	* Hardware may use multiple helper windows to process a video stream.
	164	* The structure is used to exchange this selection areas between
	165	* an application and a driver.
	166	*/
	167	struct v4l2_subdev_selection {
	168	__u32 which;
	169	__u32 pad;
	170	__u32 target;
	171	__u32 flags;
	172	struct v4l2_rect r;
	173	__u32 reserved[8];
	174	};
	175
6446ec6c HV	176	/**
	177	* struct v4l2_subdev_capability - subdev capabilities
	178	* @version: the driver versioning number
	179	* @capabilities: the subdev capabilities, see V4L2_SUBDEV_CAP_*
	180	* @reserved: for future use, set to zero for now
	181	*/
	182	struct v4l2_subdev_capability {
	183	__u32 version;
	184	__u32 capabilities;
	185	__u32 reserved[14];
	186	};
	187
	188	/* The v4l2 sub-device video device node is registered in read-only mode. */
a53e3c18	189	#define V4L2_SUBDEV_CAP_RO_SUBDEV 0x00000001
6446ec6c	190
254a4777 HV	191	/* Backwards compatibility define --- to be removed */
254a4777 HV	192	#define v4l2_subdev_edid v4l2_edid
777f4f85	193
6446ec6c	194	#define VIDIOC_SUBDEV_QUERYCAP _IOR('V', 0, struct v4l2_subdev_capability)
c4fa146c LP	195	#define VIDIOC_SUBDEV_G_FMT _IOWR('V', 4, struct v4l2_subdev_format)
	196	#define VIDIOC_SUBDEV_S_FMT _IOWR('V', 5, struct v4l2_subdev_format)
	197	#define VIDIOC_SUBDEV_G_FRAME_INTERVAL _IOWR('V', 21, struct v4l2_subdev_frame_interval)
	198	#define VIDIOC_SUBDEV_S_FRAME_INTERVAL _IOWR('V', 22, struct v4l2_subdev_frame_interval)
	199	#define VIDIOC_SUBDEV_ENUM_MBUS_CODE _IOWR('V', 2, struct v4l2_subdev_mbus_code_enum)
	200	#define VIDIOC_SUBDEV_ENUM_FRAME_SIZE _IOWR('V', 74, struct v4l2_subdev_frame_size_enum)
	201	#define VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL _IOWR('V', 75, struct v4l2_subdev_frame_interval_enum)
	202	#define VIDIOC_SUBDEV_G_CROP _IOWR('V', 59, struct v4l2_subdev_crop)
	203	#define VIDIOC_SUBDEV_S_CROP _IOWR('V', 60, struct v4l2_subdev_crop)
	204	#define VIDIOC_SUBDEV_G_SELECTION _IOWR('V', 61, struct v4l2_subdev_selection)
	205	#define VIDIOC_SUBDEV_S_SELECTION _IOWR('V', 62, struct v4l2_subdev_selection)
9cfd65e8	206	/* The following ioctls are identical to the ioctls in videodev2.h */
56ab8cdb NS	207	#define VIDIOC_SUBDEV_G_STD _IOR('V', 23, v4l2_std_id)
	208	#define VIDIOC_SUBDEV_S_STD _IOW('V', 24, v4l2_std_id)
	209	#define VIDIOC_SUBDEV_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
c4fa146c LP	210	#define VIDIOC_SUBDEV_G_EDID _IOWR('V', 40, struct v4l2_edid)
c4fa146c LP	211	#define VIDIOC_SUBDEV_S_EDID _IOWR('V', 41, struct v4l2_edid)
56ab8cdb	212	#define VIDIOC_SUBDEV_QUERYSTD _IOR('V', 63, v4l2_std_id)
9cfd65e8 LP	213	#define VIDIOC_SUBDEV_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
	214	#define VIDIOC_SUBDEV_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
	215	#define VIDIOC_SUBDEV_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
	216	#define VIDIOC_SUBDEV_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
	217	#define VIDIOC_SUBDEV_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
333c8b97 LP	218
333c8b97 LP	219	#endif