[mirror_ubuntu-focal-kernel.git] / include / uapi / linux / media.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * Multimedia device 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.
 */

#ifndef __LINUX_MEDIA_H
#define __LINUX_MEDIA_H

#ifndef __KERNEL__
#include <stdint.h>
#endif
#include <linux/ioctl.h>
#include <linux/types.h>

struct media_device_info {
	char driver[16];
	char model[32];
	char serial[40];
	char bus_info[32];
	__u32 media_version;
	__u32 hw_revision;
	__u32 driver_version;
	__u32 reserved[31];
};

/*
 * Base number ranges for entity functions
 *
 * NOTE: Userspace should not rely on these ranges to identify a group
 * of function types, as newer functions can be added with any name within
 * the full u32 range.
 *
 * Some older functions use the MEDIA_ENT_F_OLD_*_BASE range. Do not
 * change this, this is for backwards compatibility. When adding new
 * functions always use MEDIA_ENT_F_BASE.
 */
#define MEDIA_ENT_F_BASE			0x00000000
#define MEDIA_ENT_F_OLD_BASE			0x00010000
#define MEDIA_ENT_F_OLD_SUBDEV_BASE		0x00020000

/*
 * Initial value to be used when a new entity is created
 * Drivers should change it to something useful.
 */
#define MEDIA_ENT_F_UNKNOWN			MEDIA_ENT_F_BASE

/*
 * Subdevs are initialized with MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN in order
 * to preserve backward compatibility. Drivers must change to the proper
 * subdev type before registering the entity.
 */
#define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN		MEDIA_ENT_F_OLD_SUBDEV_BASE

/*
 * DVB entity functions
 */
#define MEDIA_ENT_F_DTV_DEMOD			(MEDIA_ENT_F_BASE + 0x00001)
#define MEDIA_ENT_F_TS_DEMUX			(MEDIA_ENT_F_BASE + 0x00002)
#define MEDIA_ENT_F_DTV_CA			(MEDIA_ENT_F_BASE + 0x00003)
#define MEDIA_ENT_F_DTV_NET_DECAP		(MEDIA_ENT_F_BASE + 0x00004)

/*
 * I/O entity functions
 */
#define MEDIA_ENT_F_IO_V4L			(MEDIA_ENT_F_OLD_BASE + 1)
#define MEDIA_ENT_F_IO_DTV			(MEDIA_ENT_F_BASE + 0x01001)
#define MEDIA_ENT_F_IO_VBI			(MEDIA_ENT_F_BASE + 0x01002)
#define MEDIA_ENT_F_IO_SWRADIO			(MEDIA_ENT_F_BASE + 0x01003)

/*
 * Sensor functions
 */
#define MEDIA_ENT_F_CAM_SENSOR			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
#define MEDIA_ENT_F_FLASH			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
#define MEDIA_ENT_F_LENS			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)

/*
 * Digital TV, analog TV, radio and/or software defined radio tuner functions.
 *
 * It is a responsibility of the master/bridge drivers to add connectors
 * and links for MEDIA_ENT_F_TUNER. Please notice that some old tuners
 * may require the usage of separate I2C chips to decode analog TV signals,
 * when the master/bridge chipset doesn't have its own TV standard decoder.
 * On such cases, the IF-PLL staging is mapped via one or two entities:
 * MEDIA_ENT_F_IF_VID_DECODER and/or MEDIA_ENT_F_IF_AUD_DECODER.
 */
#define MEDIA_ENT_F_TUNER			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)

/*
 * Analog TV IF-PLL decoder functions
 *
 * It is a responsibility of the master/bridge drivers to create links
 * for MEDIA_ENT_F_IF_VID_DECODER and MEDIA_ENT_F_IF_AUD_DECODER.
 */
#define MEDIA_ENT_F_IF_VID_DECODER		(MEDIA_ENT_F_BASE + 0x02001)
#define MEDIA_ENT_F_IF_AUD_DECODER		(MEDIA_ENT_F_BASE + 0x02002)

/*
 * Audio entity functions
 */
#define MEDIA_ENT_F_AUDIO_CAPTURE		(MEDIA_ENT_F_BASE + 0x03001)
#define MEDIA_ENT_F_AUDIO_PLAYBACK		(MEDIA_ENT_F_BASE + 0x03002)
#define MEDIA_ENT_F_AUDIO_MIXER			(MEDIA_ENT_F_BASE + 0x03003)

/*
 * Processing entity functions
 */
#define MEDIA_ENT_F_PROC_VIDEO_COMPOSER		(MEDIA_ENT_F_BASE + 0x4001)
#define MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER	(MEDIA_ENT_F_BASE + 0x4002)
#define MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV	(MEDIA_ENT_F_BASE + 0x4003)
#define MEDIA_ENT_F_PROC_VIDEO_LUT		(MEDIA_ENT_F_BASE + 0x4004)
#define MEDIA_ENT_F_PROC_VIDEO_SCALER		(MEDIA_ENT_F_BASE + 0x4005)
#define MEDIA_ENT_F_PROC_VIDEO_STATISTICS	(MEDIA_ENT_F_BASE + 0x4006)
#define MEDIA_ENT_F_PROC_VIDEO_ENCODER		(MEDIA_ENT_F_BASE + 0x4007)
#define MEDIA_ENT_F_PROC_VIDEO_DECODER		(MEDIA_ENT_F_BASE + 0x4008)

/*
 * Switch and bridge entity functions
 */
#define MEDIA_ENT_F_VID_MUX			(MEDIA_ENT_F_BASE + 0x5001)
#define MEDIA_ENT_F_VID_IF_BRIDGE		(MEDIA_ENT_F_BASE + 0x5002)

/*
 * Video decoder/encoder functions
 */
#define MEDIA_ENT_F_ATV_DECODER			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
#define MEDIA_ENT_F_DV_DECODER			(MEDIA_ENT_F_BASE + 0x6001)
#define MEDIA_ENT_F_DV_ENCODER			(MEDIA_ENT_F_BASE + 0x6002)

/* Entity flags */
#define MEDIA_ENT_FL_DEFAULT			(1 << 0)
#define MEDIA_ENT_FL_CONNECTOR			(1 << 1)

/* OR with the entity id value to find the next entity */
#define MEDIA_ENT_ID_FLAG_NEXT			(1U << 31)

struct media_entity_desc {
	__u32 id;
	char name[32];
	__u32 type;
	__u32 revision;
	__u32 flags;
	__u32 group_id;
	__u16 pads;
	__u16 links;

	__u32 reserved[4];

	union {
		/* Node specifications */
		struct {
			__u32 major;
			__u32 minor;
		} dev;

#if !defined(__KERNEL__)
		/*
		 * TODO: this shouldn't have been added without
		 * actual drivers that use this. When the first real driver
		 * appears that sets this information, special attention
		 * should be given whether this information is 1) enough, and
		 * 2) can deal with udev rules that rename devices. The struct
		 * dev would not be sufficient for this since that does not
		 * contain the subdevice information. In addition, struct dev
		 * can only refer to a single device, and not to multiple (e.g.
		 * pcm and mixer devices).
		 */
		struct {
			__u32 card;
			__u32 device;
			__u32 subdevice;
		} alsa;

		/*
		 * DEPRECATED: previous node specifications. Kept just to
		 * avoid breaking compilation. Use media_entity_desc.dev
		 * instead.
		 */
		struct {
			__u32 major;
			__u32 minor;
		} v4l;
		struct {
			__u32 major;
			__u32 minor;
		} fb;
		int dvb;
#endif

		/* Sub-device specifications */
		/* Nothing needed yet */
		__u8 raw[184];
	};
};

#define MEDIA_PAD_FL_SINK			(1 << 0)
#define MEDIA_PAD_FL_SOURCE			(1 << 1)
#define MEDIA_PAD_FL_MUST_CONNECT		(1 << 2)

struct media_pad_desc {
	__u32 entity;		/* entity ID */
	__u16 index;		/* pad index */
	__u32 flags;		/* pad flags */
	__u32 reserved[2];
};

#define MEDIA_LNK_FL_ENABLED			(1 << 0)
#define MEDIA_LNK_FL_IMMUTABLE			(1 << 1)
#define MEDIA_LNK_FL_DYNAMIC			(1 << 2)

#define MEDIA_LNK_FL_LINK_TYPE			(0xf << 28)
#  define MEDIA_LNK_FL_DATA_LINK		(0 << 28)
#  define MEDIA_LNK_FL_INTERFACE_LINK		(1 << 28)

struct media_link_desc {
	struct media_pad_desc source;
	struct media_pad_desc sink;
	__u32 flags;
	__u32 reserved[2];
};

struct media_links_enum {
	__u32 entity;
	/* Should have enough room for pads elements */
	struct media_pad_desc __user *pads;
	/* Should have enough room for links elements */
	struct media_link_desc __user *links;
	__u32 reserved[4];
};

/* Interface type ranges */

#define MEDIA_INTF_T_DVB_BASE			0x00000100
#define MEDIA_INTF_T_V4L_BASE			0x00000200

/* Interface types */

#define MEDIA_INTF_T_DVB_FE			(MEDIA_INTF_T_DVB_BASE)
#define MEDIA_INTF_T_DVB_DEMUX			(MEDIA_INTF_T_DVB_BASE + 1)
#define MEDIA_INTF_T_DVB_DVR			(MEDIA_INTF_T_DVB_BASE + 2)
#define MEDIA_INTF_T_DVB_CA			(MEDIA_INTF_T_DVB_BASE + 3)
#define MEDIA_INTF_T_DVB_NET			(MEDIA_INTF_T_DVB_BASE + 4)

#define MEDIA_INTF_T_V4L_VIDEO			(MEDIA_INTF_T_V4L_BASE)
#define MEDIA_INTF_T_V4L_VBI			(MEDIA_INTF_T_V4L_BASE + 1)
#define MEDIA_INTF_T_V4L_RADIO			(MEDIA_INTF_T_V4L_BASE + 2)
#define MEDIA_INTF_T_V4L_SUBDEV			(MEDIA_INTF_T_V4L_BASE + 3)
#define MEDIA_INTF_T_V4L_SWRADIO		(MEDIA_INTF_T_V4L_BASE + 4)
#define MEDIA_INTF_T_V4L_TOUCH			(MEDIA_INTF_T_V4L_BASE + 5)

#define MEDIA_INTF_T_ALSA_BASE			0x00000300
#define MEDIA_INTF_T_ALSA_PCM_CAPTURE		(MEDIA_INTF_T_ALSA_BASE)
#define MEDIA_INTF_T_ALSA_PCM_PLAYBACK		(MEDIA_INTF_T_ALSA_BASE + 1)
#define MEDIA_INTF_T_ALSA_CONTROL		(MEDIA_INTF_T_ALSA_BASE + 2)

#if defined(__KERNEL__)

/*
 * Connector functions
 *
 * For now these should not be used in userspace, as some definitions may
 * change.
 *
 * It is the responsibility of the entity drivers to add connectors and links.
 */
#define MEDIA_ENT_F_CONN_RF			(MEDIA_ENT_F_BASE + 0x30001)
#define MEDIA_ENT_F_CONN_SVIDEO			(MEDIA_ENT_F_BASE + 0x30002)
#define MEDIA_ENT_F_CONN_COMPOSITE		(MEDIA_ENT_F_BASE + 0x30003)

#endif

/*
 * MC next gen API definitions
 */

/*
 * Appeared in 4.19.0.
 *
 * The media_version argument comes from the media_version field in
 * struct media_device_info.
 */
#define MEDIA_V2_ENTITY_HAS_FLAGS(media_version) \
	((media_version) >= ((4 << 16) | (19 << 8) | 0))

struct media_v2_entity {
	__u32 id;
	char name[64];
	__u32 function;		/* Main function of the entity */
	__u32 flags;
	__u32 reserved[5];
} __attribute__ ((packed));

/* Should match the specific fields at media_intf_devnode */
struct media_v2_intf_devnode {
	__u32 major;
	__u32 minor;
} __attribute__ ((packed));

struct media_v2_interface {
	__u32 id;
	__u32 intf_type;
	__u32 flags;
	__u32 reserved[9];

	union {
		struct media_v2_intf_devnode devnode;
		__u32 raw[16];
	};
} __attribute__ ((packed));

/*
 * Appeared in 4.19.0.
 *
 * The media_version argument comes from the media_version field in
 * struct media_device_info.
 */
#define MEDIA_V2_PAD_HAS_INDEX(media_version) \
	((media_version) >= ((4 << 16) | (19 << 8) | 0))

struct media_v2_pad {
	__u32 id;
	__u32 entity_id;
	__u32 flags;
	__u32 index;
	__u32 reserved[4];
} __attribute__ ((packed));

struct media_v2_link {
	__u32 id;
	__u32 source_id;
	__u32 sink_id;
	__u32 flags;
	__u32 reserved[6];
} __attribute__ ((packed));

struct media_v2_topology {
	__u64 topology_version;

	__u32 num_entities;
	__u32 reserved1;
	__u64 ptr_entities;

	__u32 num_interfaces;
	__u32 reserved2;
	__u64 ptr_interfaces;

	__u32 num_pads;
	__u32 reserved3;
	__u64 ptr_pads;

	__u32 num_links;
	__u32 reserved4;
	__u64 ptr_links;
} __attribute__ ((packed));

/* ioctls */

#define MEDIA_IOC_DEVICE_INFO	_IOWR('|', 0x00, struct media_device_info)
#define MEDIA_IOC_ENUM_ENTITIES	_IOWR('|', 0x01, struct media_entity_desc)
#define MEDIA_IOC_ENUM_LINKS	_IOWR('|', 0x02, struct media_links_enum)
#define MEDIA_IOC_SETUP_LINK	_IOWR('|', 0x03, struct media_link_desc)
#define MEDIA_IOC_G_TOPOLOGY	_IOWR('|', 0x04, struct media_v2_topology)
#define MEDIA_IOC_REQUEST_ALLOC	_IOR ('|', 0x05, int)

/*
 * These ioctls are called on the request file descriptor as returned
 * by MEDIA_IOC_REQUEST_ALLOC.
 */
#define MEDIA_REQUEST_IOC_QUEUE		_IO('|',  0x80)
#define MEDIA_REQUEST_IOC_REINIT	_IO('|',  0x81)

#ifndef __KERNEL__

/*
 * Legacy symbols used to avoid userspace compilation breakages.
 * Do not use any of this in new applications!
 *
 * Those symbols map the entity function into types and should be
 * used only on legacy programs for legacy hardware. Don't rely
 * on those for MEDIA_IOC_G_TOPOLOGY.
 */
#define MEDIA_ENT_TYPE_SHIFT			16
#define MEDIA_ENT_TYPE_MASK			0x00ff0000
#define MEDIA_ENT_SUBTYPE_MASK			0x0000ffff

#define MEDIA_ENT_T_DEVNODE_UNKNOWN		(MEDIA_ENT_F_OLD_BASE | \
						 MEDIA_ENT_SUBTYPE_MASK)

#define MEDIA_ENT_T_DEVNODE			MEDIA_ENT_F_OLD_BASE
#define MEDIA_ENT_T_DEVNODE_V4L			MEDIA_ENT_F_IO_V4L
#define MEDIA_ENT_T_DEVNODE_FB			(MEDIA_ENT_F_OLD_BASE + 2)
#define MEDIA_ENT_T_DEVNODE_ALSA		(MEDIA_ENT_F_OLD_BASE + 3)
#define MEDIA_ENT_T_DEVNODE_DVB			(MEDIA_ENT_F_OLD_BASE + 4)

#define MEDIA_ENT_T_UNKNOWN			MEDIA_ENT_F_UNKNOWN
#define MEDIA_ENT_T_V4L2_VIDEO			MEDIA_ENT_F_IO_V4L
#define MEDIA_ENT_T_V4L2_SUBDEV			MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
#define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR		MEDIA_ENT_F_CAM_SENSOR
#define MEDIA_ENT_T_V4L2_SUBDEV_FLASH		MEDIA_ENT_F_FLASH
#define MEDIA_ENT_T_V4L2_SUBDEV_LENS		MEDIA_ENT_F_LENS
#define MEDIA_ENT_T_V4L2_SUBDEV_DECODER		MEDIA_ENT_F_ATV_DECODER
#define MEDIA_ENT_T_V4L2_SUBDEV_TUNER		MEDIA_ENT_F_TUNER

#define MEDIA_ENT_F_DTV_DECODER			MEDIA_ENT_F_DV_DECODER

/*
 * There is still no full ALSA support in the media controller. These
 * defines should not have been added and we leave them here only
 * in case some application tries to use these defines.
 *
 * The ALSA defines that are in use have been moved into __KERNEL__
 * scope. As support gets added to these interface types, they should
 * be moved into __KERNEL__ scope with the code that uses them.
 */
#define MEDIA_INTF_T_ALSA_COMPRESS             (MEDIA_INTF_T_ALSA_BASE + 3)
#define MEDIA_INTF_T_ALSA_RAWMIDI              (MEDIA_INTF_T_ALSA_BASE + 4)
#define MEDIA_INTF_T_ALSA_HWDEP                (MEDIA_INTF_T_ALSA_BASE + 5)
#define MEDIA_INTF_T_ALSA_SEQUENCER            (MEDIA_INTF_T_ALSA_BASE + 6)
#define MEDIA_INTF_T_ALSA_TIMER                (MEDIA_INTF_T_ALSA_BASE + 7)

/* Obsolete symbol for media_version, no longer used in the kernel */
#define MEDIA_API_VERSION			((0 << 16) | (1 << 8) | 0)

#endif

#endif /* __LINUX_MEDIA_H */
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
140d8816 LP	2	/*
	3	* Multimedia device 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.
140d8816 LP	18	*/
	19
	20	#ifndef __LINUX_MEDIA_H
	21	#define __LINUX_MEDIA_H
	22
b3b7a9f1 MCC	23	#ifndef __KERNEL__
	24	#include <stdint.h>
	25	#endif
140d8816 LP	26	#include <linux/ioctl.h>
140d8816 LP	27	#include <linux/types.h>
140d8816	28
140d8816 LP	29	struct media_device_info {
	30	char driver[16];
	31	char model[32];
	32	char serial[40];
	33	char bus_info[32];
	34	__u32 media_version;
	35	__u32 hw_revision;
	36	__u32 driver_version;
	37	__u32 reserved[31];
	38	};
	39
32fdc0e1	40	/*
4ca72efa	41	* Base number ranges for entity functions
32fdc0e1	42	*
ed3056f0 HV	43	* NOTE: Userspace should not rely on these ranges to identify a group
	44	* of function types, as newer functions can be added with any name within
	45	* the full u32 range.
	46	*
	47	* Some older functions use the MEDIA_ENT_F_OLD_*_BASE range. Do not
	48	* change this, this is for backwards compatibility. When adding new
	49	* functions always use MEDIA_ENT_F_BASE.
32fdc0e1	50	*/
ed3056f0 HV	51	#define MEDIA_ENT_F_BASE 0x00000000
	52	#define MEDIA_ENT_F_OLD_BASE 0x00010000
	53	#define MEDIA_ENT_F_OLD_SUBDEV_BASE 0x00020000
32fdc0e1 MCC	54
32fdc0e1 MCC	55	/*
ed3056f0 HV	56	* Initial value to be used when a new entity is created
ed3056f0 HV	57	* Drivers should change it to something useful.
32fdc0e1	58	*/
ed3056f0	59	#define MEDIA_ENT_F_UNKNOWN MEDIA_ENT_F_BASE
fa17b46a	60
b50bde4e	61	/*
ed3056f0 HV	62	* Subdevs are initialized with MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN in order
	63	* to preserve backward compatibility. Drivers must change to the proper
	64	* subdev type before registering the entity.
4ca72efa	65	*/
ed3056f0	66	#define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN MEDIA_ENT_F_OLD_SUBDEV_BASE
4ca72efa	67
06131932	68	/*
ed3056f0	69	* DVB entity functions
06131932	70	*/
ed3056f0 HV	71	#define MEDIA_ENT_F_DTV_DEMOD (MEDIA_ENT_F_BASE + 0x00001)
	72	#define MEDIA_ENT_F_TS_DEMUX (MEDIA_ENT_F_BASE + 0x00002)
	73	#define MEDIA_ENT_F_DTV_CA (MEDIA_ENT_F_BASE + 0x00003)
	74	#define MEDIA_ENT_F_DTV_NET_DECAP (MEDIA_ENT_F_BASE + 0x00004)
8c755c29	75
7a2eba12	76	/*
ed3056f0	77	* I/O entity functions
7a2eba12	78	*/
ed3056f0 HV	79	#define MEDIA_ENT_F_IO_V4L (MEDIA_ENT_F_OLD_BASE + 1)
	80	#define MEDIA_ENT_F_IO_DTV (MEDIA_ENT_F_BASE + 0x01001)
	81	#define MEDIA_ENT_F_IO_VBI (MEDIA_ENT_F_BASE + 0x01002)
	82	#define MEDIA_ENT_F_IO_SWRADIO (MEDIA_ENT_F_BASE + 0x01003)
7a2eba12	83
1179aab1	84	/*
ed3056f0	85	* Sensor functions
1179aab1	86	*/
ed3056f0 HV	87	#define MEDIA_ENT_F_CAM_SENSOR (MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
	88	#define MEDIA_ENT_F_FLASH (MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
	89	#define MEDIA_ENT_F_LENS (MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
1179aab1	90
4ca72efa	91	/*
ed3056f0	92	* Digital TV, analog TV, radio and/or software defined radio tuner functions.
4ca72efa	93	*
06131932 MCC	94	* It is a responsibility of the master/bridge drivers to add connectors
	95	* and links for MEDIA_ENT_F_TUNER. Please notice that some old tuners
	96	* may require the usage of separate I2C chips to decode analog TV signals,
	97	* when the master/bridge chipset doesn't have its own TV standard decoder.
	98	* On such cases, the IF-PLL staging is mapped via one or two entities:
	99	* MEDIA_ENT_F_IF_VID_DECODER and/or MEDIA_ENT_F_IF_AUD_DECODER.
b3109d66	100	*/
ed3056f0	101	#define MEDIA_ENT_F_TUNER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
4ca72efa	102
ed3056f0 HV	103	/*
	104	* Analog TV IF-PLL decoder functions
	105	*
	106	* It is a responsibility of the master/bridge drivers to create links
	107	* for MEDIA_ENT_F_IF_VID_DECODER and MEDIA_ENT_F_IF_AUD_DECODER.
	108	*/
	109	#define MEDIA_ENT_F_IF_VID_DECODER (MEDIA_ENT_F_BASE + 0x02001)
	110	#define MEDIA_ENT_F_IF_AUD_DECODER (MEDIA_ENT_F_BASE + 0x02002)
49a11518	111
ed3056f0 HV	112	/*
	113	* Audio entity functions
	114	*/
	115	#define MEDIA_ENT_F_AUDIO_CAPTURE (MEDIA_ENT_F_BASE + 0x03001)
	116	#define MEDIA_ENT_F_AUDIO_PLAYBACK (MEDIA_ENT_F_BASE + 0x03002)
	117	#define MEDIA_ENT_F_AUDIO_MIXER (MEDIA_ENT_F_BASE + 0x03003)
4ca72efa MCC	118
4ca72efa MCC	119	/*
ed3056f0	120	* Processing entity functions
4ca72efa	121	*/
ed3056f0 HV	122	#define MEDIA_ENT_F_PROC_VIDEO_COMPOSER (MEDIA_ENT_F_BASE + 0x4001)
	123	#define MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER (MEDIA_ENT_F_BASE + 0x4002)
	124	#define MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV (MEDIA_ENT_F_BASE + 0x4003)
	125	#define MEDIA_ENT_F_PROC_VIDEO_LUT (MEDIA_ENT_F_BASE + 0x4004)
	126	#define MEDIA_ENT_F_PROC_VIDEO_SCALER (MEDIA_ENT_F_BASE + 0x4005)
	127	#define MEDIA_ENT_F_PROC_VIDEO_STATISTICS (MEDIA_ENT_F_BASE + 0x4006)
45841a97 HV	128	#define MEDIA_ENT_F_PROC_VIDEO_ENCODER (MEDIA_ENT_F_BASE + 0x4007)
45841a97 HV	129	#define MEDIA_ENT_F_PROC_VIDEO_DECODER (MEDIA_ENT_F_BASE + 0x4008)
6c2c188f	130
ed3056f0 HV	131	/*
	132	* Switch and bridge entity functions
	133	*/
	134	#define MEDIA_ENT_F_VID_MUX (MEDIA_ENT_F_BASE + 0x5001)
	135	#define MEDIA_ENT_F_VID_IF_BRIDGE (MEDIA_ENT_F_BASE + 0x5002)
32fdc0e1	136
f2399f75 HV	137	/*
	138	* Video decoder/encoder functions
	139	*/
	140	#define MEDIA_ENT_F_ATV_DECODER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
	141	#define MEDIA_ENT_F_DV_DECODER (MEDIA_ENT_F_BASE + 0x6001)
	142	#define MEDIA_ENT_F_DV_ENCODER (MEDIA_ENT_F_BASE + 0x6002)
	143
49a11518	144	/* Entity flags */
ed3056f0 HV	145	#define MEDIA_ENT_FL_DEFAULT (1 << 0)
	146	#define MEDIA_ENT_FL_CONNECTOR (1 << 1)
	147
	148	/* OR with the entity id value to find the next entity */
5ca004d1	149	#define MEDIA_ENT_ID_FLAG_NEXT (1U << 31)
1651333b LP	150
	151	struct media_entity_desc {
	152	__u32 id;
	153	char name[32];
	154	__u32 type;
	155	__u32 revision;
	156	__u32 flags;
	157	__u32 group_id;
	158	__u16 pads;
	159	__u16 links;
	160
	161	__u32 reserved[4];
	162
	163	union {
	164	/* Node specifications */
e31a0ba7 MCC	165	struct {
	166	__u32 major;
	167	__u32 minor;
	168	} dev;
	169
ed3056f0	170	#if !defined(__KERNEL__)
7e182f78 HV	171	/*
	172	* TODO: this shouldn't have been added without
	173	* actual drivers that use this. When the first real driver
	174	* appears that sets this information, special attention
	175	* should be given whether this information is 1) enough, and
	176	* 2) can deal with udev rules that rename devices. The struct
	177	* dev would not be sufficient for this since that does not
	178	* contain the subdevice information. In addition, struct dev
	179	* can only refer to a single device, and not to multiple (e.g.
	180	* pcm and mixer devices).
7e182f78 HV	181	*/
	182	struct {
	183	__u32 card;
	184	__u32 device;
	185	__u32 subdevice;
	186	} alsa;
7e182f78	187
e31a0ba7 MCC	188	/*
e31a0ba7 MCC	189	* DEPRECATED: previous node specifications. Kept just to
ed3056f0 HV	190	* avoid breaking compilation. Use media_entity_desc.dev
ed3056f0 HV	191	* instead.
e31a0ba7	192	*/
1651333b LP	193	struct {
	194	__u32 major;
	195	__u32 minor;
	196	} v4l;
	197	struct {
	198	__u32 major;
	199	__u32 minor;
	200	} fb;
1651333b	201	int dvb;
e31a0ba7	202	#endif
1651333b LP	203
	204	/* Sub-device specifications */
	205	/* Nothing needed yet */
	206	__u8 raw[184];
	207	};
	208	};
	209
ed3056f0 HV	210	#define MEDIA_PAD_FL_SINK (1 << 0)
	211	#define MEDIA_PAD_FL_SOURCE (1 << 1)
	212	#define MEDIA_PAD_FL_MUST_CONNECT (1 << 2)
1651333b LP	213
	214	struct media_pad_desc {
	215	__u32 entity; /* entity ID */
	216	__u16 index; /* pad index */
	217	__u32 flags; /* pad flags */
	218	__u32 reserved[2];
	219	};
	220
ed3056f0 HV	221	#define MEDIA_LNK_FL_ENABLED (1 << 0)
	222	#define MEDIA_LNK_FL_IMMUTABLE (1 << 1)
	223	#define MEDIA_LNK_FL_DYNAMIC (1 << 2)
1651333b	224
ed3056f0 HV	225	#define MEDIA_LNK_FL_LINK_TYPE (0xf << 28)
	226	# define MEDIA_LNK_FL_DATA_LINK (0 << 28)
	227	# define MEDIA_LNK_FL_INTERFACE_LINK (1 << 28)
c398bb64	228
1651333b LP	229	struct media_link_desc {
	230	struct media_pad_desc source;
	231	struct media_pad_desc sink;
	232	__u32 flags;
	233	__u32 reserved[2];
	234	};
	235
	236	struct media_links_enum {
	237	__u32 entity;
	238	/* Should have enough room for pads elements */
	239	struct media_pad_desc __user *pads;
	240	/* Should have enough room for links elements */
	241	struct media_link_desc __user *links;
	242	__u32 reserved[4];
	243	};
	244
a1d2510e MCC	245	/* Interface type ranges */
a1d2510e MCC	246
ed3056f0 HV	247	#define MEDIA_INTF_T_DVB_BASE 0x00000100
ed3056f0 HV	248	#define MEDIA_INTF_T_V4L_BASE 0x00000200
a1d2510e MCC	249
	250	/* Interface types */
	251
ed3056f0 HV	252	#define MEDIA_INTF_T_DVB_FE (MEDIA_INTF_T_DVB_BASE)
	253	#define MEDIA_INTF_T_DVB_DEMUX (MEDIA_INTF_T_DVB_BASE + 1)
	254	#define MEDIA_INTF_T_DVB_DVR (MEDIA_INTF_T_DVB_BASE + 2)
	255	#define MEDIA_INTF_T_DVB_CA (MEDIA_INTF_T_DVB_BASE + 3)
	256	#define MEDIA_INTF_T_DVB_NET (MEDIA_INTF_T_DVB_BASE + 4)
	257
	258	#define MEDIA_INTF_T_V4L_VIDEO (MEDIA_INTF_T_V4L_BASE)
	259	#define MEDIA_INTF_T_V4L_VBI (MEDIA_INTF_T_V4L_BASE + 1)
	260	#define MEDIA_INTF_T_V4L_RADIO (MEDIA_INTF_T_V4L_BASE + 2)
	261	#define MEDIA_INTF_T_V4L_SUBDEV (MEDIA_INTF_T_V4L_BASE + 3)
	262	#define MEDIA_INTF_T_V4L_SWRADIO (MEDIA_INTF_T_V4L_BASE + 4)
	263	#define MEDIA_INTF_T_V4L_TOUCH (MEDIA_INTF_T_V4L_BASE + 5)
	264
e377d3e9 SK	265	#define MEDIA_INTF_T_ALSA_BASE 0x00000300
	266	#define MEDIA_INTF_T_ALSA_PCM_CAPTURE (MEDIA_INTF_T_ALSA_BASE)
	267	#define MEDIA_INTF_T_ALSA_PCM_PLAYBACK (MEDIA_INTF_T_ALSA_BASE + 1)
	268	#define MEDIA_INTF_T_ALSA_CONTROL (MEDIA_INTF_T_ALSA_BASE + 2)
	269
ed3056f0	270	#if defined(__KERNEL__)
5af557a6	271
c398bb64	272	/*
ed3056f0	273	* Connector functions
c398bb64	274	*
ed3056f0 HV	275	* For now these should not be used in userspace, as some definitions may
ed3056f0 HV	276	* change.
c398bb64	277	*
ed3056f0	278	* It is the responsibility of the entity drivers to add connectors and links.
c398bb64	279	*/
ed3056f0 HV	280	#define MEDIA_ENT_F_CONN_RF (MEDIA_ENT_F_BASE + 0x30001)
	281	#define MEDIA_ENT_F_CONN_SVIDEO (MEDIA_ENT_F_BASE + 0x30002)
	282	#define MEDIA_ENT_F_CONN_COMPOSITE (MEDIA_ENT_F_BASE + 0x30003)
c398bb64	283
ed3056f0 HV	284	#endif
	285
	286	/*
	287	* MC next gen API definitions
	288	*/
333a6515	289
588f4ee7 HV	290	/*
	291	* Appeared in 4.19.0.
	292	*
	293	* The media_version argument comes from the media_version field in
	294	* struct media_device_info.
	295	*/
	296	#define MEDIA_V2_ENTITY_HAS_FLAGS(media_version) \
	297	((media_version) >= ((4 << 16) \| (19 << 8) \| 0))
	298
c398bb64 MCC	299	struct media_v2_entity {
c398bb64 MCC	300	__u32 id;
ed3056f0	301	char name[64];
d87cdb88	302	__u32 function; /* Main function of the entity */
588f4ee7 HV	303	__u32 flags;
588f4ee7 HV	304	__u32 reserved[5];
fbe093ac	305	} __attribute__ ((packed));
c398bb64 MCC	306
	307	/* Should match the specific fields at media_intf_devnode */
	308	struct media_v2_intf_devnode {
	309	__u32 major;
	310	__u32 minor;
fbe093ac	311	} __attribute__ ((packed));
c398bb64 MCC	312
	313	struct media_v2_interface {
	314	__u32 id;
	315	__u32 intf_type;
	316	__u32 flags;
	317	__u32 reserved[9];
	318
	319	union {
	320	struct media_v2_intf_devnode devnode;
	321	__u32 raw[16];
	322	};
fbe093ac	323	} __attribute__ ((packed));
c398bb64	324
30b914c8 HV	325	/*
	326	* Appeared in 4.19.0.
	327	*
	328	* The media_version argument comes from the media_version field in
	329	* struct media_device_info.
	330	*/
	331	#define MEDIA_V2_PAD_HAS_INDEX(media_version) \
	332	((media_version) >= ((4 << 16) \| (19 << 8) \| 0))
	333
c398bb64 MCC	334	struct media_v2_pad {
	335	__u32 id;
	336	__u32 entity_id;
	337	__u32 flags;
30b914c8 HV	338	__u32 index;
30b914c8 HV	339	__u32 reserved[4];
fbe093ac	340	} __attribute__ ((packed));
c398bb64 MCC	341
	342	struct media_v2_link {
	343	__u32 id;
	344	__u32 source_id;
	345	__u32 sink_id;
	346	__u32 flags;
fbe093ac SA	347	__u32 reserved[6];
fbe093ac SA	348	} __attribute__ ((packed));
c398bb64 MCC	349
c398bb64 MCC	350	struct media_v2_topology {
b3b7a9f1	351	__u64 topology_version;
c398bb64	352
7c9d6731 MCC	353	__u32 num_entities;
7c9d6731 MCC	354	__u32 reserved1;
b3b7a9f1	355	__u64 ptr_entities;
c398bb64	356
7c9d6731 MCC	357	__u32 num_interfaces;
7c9d6731 MCC	358	__u32 reserved2;
b3b7a9f1	359	__u64 ptr_interfaces;
c398bb64	360
7c9d6731 MCC	361	__u32 num_pads;
7c9d6731 MCC	362	__u32 reserved3;
b3b7a9f1	363	__u64 ptr_pads;
c398bb64	364
7c9d6731 MCC	365	__u32 num_links;
7c9d6731 MCC	366	__u32 reserved4;
b3b7a9f1	367	__u64 ptr_links;
fbe093ac	368	} __attribute__ ((packed));
c398bb64 MCC	369
c398bb64 MCC	370	/* ioctls */
a1d2510e	371
ed3056f0 HV	372	#define MEDIA_IOC_DEVICE_INFO _IOWR('\|', 0x00, struct media_device_info)
	373	#define MEDIA_IOC_ENUM_ENTITIES _IOWR('\|', 0x01, struct media_entity_desc)
	374	#define MEDIA_IOC_ENUM_LINKS _IOWR('\|', 0x02, struct media_links_enum)
	375	#define MEDIA_IOC_SETUP_LINK _IOWR('\|', 0x03, struct media_link_desc)
	376	#define MEDIA_IOC_G_TOPOLOGY _IOWR('\|', 0x04, struct media_v2_topology)
66431c0b HV	377	#define MEDIA_IOC_REQUEST_ALLOC _IOR ('\|', 0x05, int)
	378
	379	/*
	380	* These ioctls are called on the request file descriptor as returned
	381	* by MEDIA_IOC_REQUEST_ALLOC.
	382	*/
	383	#define MEDIA_REQUEST_IOC_QUEUE _IO('\|', 0x80)
	384	#define MEDIA_REQUEST_IOC_REINIT _IO('\|', 0x81)
ed3056f0	385
e1a98c16	386	#ifndef __KERNEL__
ed3056f0 HV	387
	388	/*
	389	* Legacy symbols used to avoid userspace compilation breakages.
	390	* Do not use any of this in new applications!
	391	*
	392	* Those symbols map the entity function into types and should be
	393	* used only on legacy programs for legacy hardware. Don't rely
	394	* on those for MEDIA_IOC_G_TOPOLOGY.
	395	*/
	396	#define MEDIA_ENT_TYPE_SHIFT 16
	397	#define MEDIA_ENT_TYPE_MASK 0x00ff0000
	398	#define MEDIA_ENT_SUBTYPE_MASK 0x0000ffff
	399
	400	#define MEDIA_ENT_T_DEVNODE_UNKNOWN (MEDIA_ENT_F_OLD_BASE \| \
	401	MEDIA_ENT_SUBTYPE_MASK)
	402
	403	#define MEDIA_ENT_T_DEVNODE MEDIA_ENT_F_OLD_BASE
	404	#define MEDIA_ENT_T_DEVNODE_V4L MEDIA_ENT_F_IO_V4L
	405	#define MEDIA_ENT_T_DEVNODE_FB (MEDIA_ENT_F_OLD_BASE + 2)
	406	#define MEDIA_ENT_T_DEVNODE_ALSA (MEDIA_ENT_F_OLD_BASE + 3)
	407	#define MEDIA_ENT_T_DEVNODE_DVB (MEDIA_ENT_F_OLD_BASE + 4)
	408
	409	#define MEDIA_ENT_T_UNKNOWN MEDIA_ENT_F_UNKNOWN
	410	#define MEDIA_ENT_T_V4L2_VIDEO MEDIA_ENT_F_IO_V4L
	411	#define MEDIA_ENT_T_V4L2_SUBDEV MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
	412	#define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR MEDIA_ENT_F_CAM_SENSOR
	413	#define MEDIA_ENT_T_V4L2_SUBDEV_FLASH MEDIA_ENT_F_FLASH
	414	#define MEDIA_ENT_T_V4L2_SUBDEV_LENS MEDIA_ENT_F_LENS
	415	#define MEDIA_ENT_T_V4L2_SUBDEV_DECODER MEDIA_ENT_F_ATV_DECODER
	416	#define MEDIA_ENT_T_V4L2_SUBDEV_TUNER MEDIA_ENT_F_TUNER
	417
d272bc92 HV	418	#define MEDIA_ENT_F_DTV_DECODER MEDIA_ENT_F_DV_DECODER
d272bc92 HV	419
ed3056f0	420	/*
e377d3e9	421	* There is still no full ALSA support in the media controller. These
ed3056f0 HV	422	* defines should not have been added and we leave them here only
ed3056f0 HV	423	* in case some application tries to use these defines.
e377d3e9 SK	424	*
	425	* The ALSA defines that are in use have been moved into __KERNEL__
	426	* scope. As support gets added to these interface types, they should
	427	* be moved into __KERNEL__ scope with the code that uses them.
ed3056f0	428	*/
e377d3e9 SK	429	#define MEDIA_INTF_T_ALSA_COMPRESS (MEDIA_INTF_T_ALSA_BASE + 3)
	430	#define MEDIA_INTF_T_ALSA_RAWMIDI (MEDIA_INTF_T_ALSA_BASE + 4)
	431	#define MEDIA_INTF_T_ALSA_HWDEP (MEDIA_INTF_T_ALSA_BASE + 5)
	432	#define MEDIA_INTF_T_ALSA_SEQUENCER (MEDIA_INTF_T_ALSA_BASE + 6)
	433	#define MEDIA_INTF_T_ALSA_TIMER (MEDIA_INTF_T_ALSA_BASE + 7)
ed3056f0 HV	434
ed3056f0 HV	435	/* Obsolete symbol for media_version, no longer used in the kernel */
87e1a881	436	#define MEDIA_API_VERSION ((0 << 16) \| (1 << 8) \| 0)
ed3056f0 HV	437
ed3056f0 HV	438	#endif
140d8816 LP	439
140d8816 LP	440	#endif /* __LINUX_MEDIA_H */