[linux-2.6-block.git] / include / uapi / linux / media.h

/*
 * 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.
 *
 * 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_MEDIA_H
#define __LINUX_MEDIA_H

#include <linux/ioctl.h>
#include <linux/types.h>
#include <linux/version.h>

#define MEDIA_API_VERSION	KERNEL_VERSION(0, 1, 0)

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];
};

#define MEDIA_ENT_ID_FLAG_NEXT		(1 << 31)

#define MEDIA_ENT_TYPE_SHIFT		16
#define MEDIA_ENT_TYPE_MASK		0x00ff0000
#define MEDIA_ENT_SUBTYPE_MASK		0x0000ffff

#define MEDIA_ENT_T_DEVNODE		(1 << MEDIA_ENT_TYPE_SHIFT)
#define MEDIA_ENT_T_DEVNODE_V4L		(MEDIA_ENT_T_DEVNODE + 1)
#define MEDIA_ENT_T_DEVNODE_FB		(MEDIA_ENT_T_DEVNODE + 2)
#define MEDIA_ENT_T_DEVNODE_ALSA	(MEDIA_ENT_T_DEVNODE + 3)
#define MEDIA_ENT_T_DEVNODE_DVB_FE	(MEDIA_ENT_T_DEVNODE + 4)
#define MEDIA_ENT_T_DEVNODE_DVB_DEMUX	(MEDIA_ENT_T_DEVNODE + 5)
#define MEDIA_ENT_T_DEVNODE_DVB_DVR	(MEDIA_ENT_T_DEVNODE + 6)
#define MEDIA_ENT_T_DEVNODE_DVB_CA	(MEDIA_ENT_T_DEVNODE + 7)
#define MEDIA_ENT_T_DEVNODE_DVB_NET	(MEDIA_ENT_T_DEVNODE + 8)

/* Legacy symbol. Use it to avoid userspace compilation breakages */
#define MEDIA_ENT_T_DEVNODE_DVB		MEDIA_ENT_T_DEVNODE_DVB_FE

#define MEDIA_ENT_T_V4L2_SUBDEV		(2 << MEDIA_ENT_TYPE_SHIFT)
#define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR	(MEDIA_ENT_T_V4L2_SUBDEV + 1)
#define MEDIA_ENT_T_V4L2_SUBDEV_FLASH	(MEDIA_ENT_T_V4L2_SUBDEV + 2)
#define MEDIA_ENT_T_V4L2_SUBDEV_LENS	(MEDIA_ENT_T_V4L2_SUBDEV + 3)
/* A converter of analogue video to its digital representation. */
#define MEDIA_ENT_T_V4L2_SUBDEV_DECODER	(MEDIA_ENT_T_V4L2_SUBDEV + 4)

#define MEDIA_ENT_FL_DEFAULT		(1 << 0)

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 1
		/*
		 * DEPRECATED: previous node specifications. Kept just to
		 * avoid breaking compilation, but media_entity_desc.dev
		 * should be used instead. In particular, alsa and dvb
		 * fields below are wrong: for all devnodes, there should
		 * be just major/minor inside the struct, as this is enough
		 * to represent any devnode, no matter what type.
		 */
		struct {
			__u32 major;
			__u32 minor;
		} v4l;
		struct {
			__u32 major;
			__u32 minor;
		} fb;
		struct {
			__u32 card;
			__u32 device;
			__u32 subdevice;
		} alsa;
		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)

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];
};

#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)

#endif /* __LINUX_MEDIA_H */
Commit	Line	Data
140d8816 LP	1	/*
	2	* Multimedia device API
	3	*
	4	* Copyright (C) 2010 Nokia Corporation
	5	*
	6	* Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
	7	* Sakari Ailus <sakari.ailus@iki.fi>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	21	*/
	22
	23	#ifndef __LINUX_MEDIA_H
	24	#define __LINUX_MEDIA_H
	25
	26	#include <linux/ioctl.h>
	27	#include <linux/types.h>
	28	#include <linux/version.h>
	29
	30	#define MEDIA_API_VERSION KERNEL_VERSION(0, 1, 0)
	31
	32	struct media_device_info {
	33	char driver[16];
	34	char model[32];
	35	char serial[40];
	36	char bus_info[32];
	37	__u32 media_version;
	38	__u32 hw_revision;
	39	__u32 driver_version;
	40	__u32 reserved[31];
	41	};
	42
1651333b LP	43	#define MEDIA_ENT_ID_FLAG_NEXT (1 << 31)
	44
	45	#define MEDIA_ENT_TYPE_SHIFT 16
	46	#define MEDIA_ENT_TYPE_MASK 0x00ff0000
	47	#define MEDIA_ENT_SUBTYPE_MASK 0x0000ffff
	48
	49	#define MEDIA_ENT_T_DEVNODE (1 << MEDIA_ENT_TYPE_SHIFT)
	50	#define MEDIA_ENT_T_DEVNODE_V4L (MEDIA_ENT_T_DEVNODE + 1)
	51	#define MEDIA_ENT_T_DEVNODE_FB (MEDIA_ENT_T_DEVNODE + 2)
	52	#define MEDIA_ENT_T_DEVNODE_ALSA (MEDIA_ENT_T_DEVNODE + 3)
1d20f9f6 MCC	53	#define MEDIA_ENT_T_DEVNODE_DVB_FE (MEDIA_ENT_T_DEVNODE + 4)
	54	#define MEDIA_ENT_T_DEVNODE_DVB_DEMUX (MEDIA_ENT_T_DEVNODE + 5)
	55	#define MEDIA_ENT_T_DEVNODE_DVB_DVR (MEDIA_ENT_T_DEVNODE + 6)
	56	#define MEDIA_ENT_T_DEVNODE_DVB_CA (MEDIA_ENT_T_DEVNODE + 7)
	57	#define MEDIA_ENT_T_DEVNODE_DVB_NET (MEDIA_ENT_T_DEVNODE + 8)
	58
	59	/* Legacy symbol. Use it to avoid userspace compilation breakages */
	60	#define MEDIA_ENT_T_DEVNODE_DVB MEDIA_ENT_T_DEVNODE_DVB_FE
1651333b LP	61
	62	#define MEDIA_ENT_T_V4L2_SUBDEV (2 << MEDIA_ENT_TYPE_SHIFT)
	63	#define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR (MEDIA_ENT_T_V4L2_SUBDEV + 1)
	64	#define MEDIA_ENT_T_V4L2_SUBDEV_FLASH (MEDIA_ENT_T_V4L2_SUBDEV + 2)
	65	#define MEDIA_ENT_T_V4L2_SUBDEV_LENS (MEDIA_ENT_T_V4L2_SUBDEV + 3)
e64171b9 MH	66	/* A converter of analogue video to its digital representation. */
e64171b9 MH	67	#define MEDIA_ENT_T_V4L2_SUBDEV_DECODER (MEDIA_ENT_T_V4L2_SUBDEV + 4)
1651333b LP	68
	69	#define MEDIA_ENT_FL_DEFAULT (1 << 0)
	70
	71	struct media_entity_desc {
	72	__u32 id;
	73	char name[32];
	74	__u32 type;
	75	__u32 revision;
	76	__u32 flags;
	77	__u32 group_id;
	78	__u16 pads;
	79	__u16 links;
	80
	81	__u32 reserved[4];
	82
	83	union {
	84	/* Node specifications */
e31a0ba7 MCC	85	struct {
	86	__u32 major;
	87	__u32 minor;
	88	} dev;
	89
	90	#if 1
	91	/*
	92	* DEPRECATED: previous node specifications. Kept just to
	93	* avoid breaking compilation, but media_entity_desc.dev
	94	* should be used instead. In particular, alsa and dvb
	95	* fields below are wrong: for all devnodes, there should
	96	* be just major/minor inside the struct, as this is enough
	97	* to represent any devnode, no matter what type.
	98	*/
1651333b LP	99	struct {
	100	__u32 major;
	101	__u32 minor;
	102	} v4l;
	103	struct {
	104	__u32 major;
	105	__u32 minor;
	106	} fb;
	107	struct {
	108	__u32 card;
	109	__u32 device;
	110	__u32 subdevice;
	111	} alsa;
	112	int dvb;
e31a0ba7	113	#endif
1651333b LP	114
	115	/* Sub-device specifications */
	116	/* Nothing needed yet */
	117	__u8 raw[184];
	118	};
	119	};
	120
	121	#define MEDIA_PAD_FL_SINK (1 << 0)
	122	#define MEDIA_PAD_FL_SOURCE (1 << 1)
d0700c51	123	#define MEDIA_PAD_FL_MUST_CONNECT (1 << 2)
1651333b LP	124
	125	struct media_pad_desc {
	126	__u32 entity; /* entity ID */
	127	__u16 index; /* pad index */
	128	__u32 flags; /* pad flags */
	129	__u32 reserved[2];
	130	};
	131
	132	#define MEDIA_LNK_FL_ENABLED (1 << 0)
	133	#define MEDIA_LNK_FL_IMMUTABLE (1 << 1)
e02188c9	134	#define MEDIA_LNK_FL_DYNAMIC (1 << 2)
1651333b LP	135
	136	struct media_link_desc {
	137	struct media_pad_desc source;
	138	struct media_pad_desc sink;
	139	__u32 flags;
	140	__u32 reserved[2];
	141	};
	142
	143	struct media_links_enum {
	144	__u32 entity;
	145	/* Should have enough room for pads elements */
	146	struct media_pad_desc __user *pads;
	147	/* Should have enough room for links elements */
	148	struct media_link_desc __user *links;
	149	__u32 reserved[4];
	150	};
	151
474966ee LP	152	#define MEDIA_IOC_DEVICE_INFO _IOWR('\|', 0x00, struct media_device_info)
	153	#define MEDIA_IOC_ENUM_ENTITIES _IOWR('\|', 0x01, struct media_entity_desc)
	154	#define MEDIA_IOC_ENUM_LINKS _IOWR('\|', 0x02, struct media_links_enum)
	155	#define MEDIA_IOC_SETUP_LINK _IOWR('\|', 0x03, struct media_link_desc)
140d8816 LP	156
140d8816 LP	157	#endif /* __LINUX_MEDIA_H */