[mirror_ubuntu-hirsute-kernel.git] / include / media / media-entity.h

/*
 * Media entity
 *
 * 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 _MEDIA_ENTITY_H
#define _MEDIA_ENTITY_H

#include <linux/bitops.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/media.h>

/* Enums used internally at the media controller to represent graphs */

/**
 * enum media_gobj_type - type of a graph object
 *
 * @MEDIA_GRAPH_ENTITY:		Identify a media entity
 * @MEDIA_GRAPH_PAD:		Identify a media pad
 * @MEDIA_GRAPH_LINK:		Identify a media link
 * @MEDIA_GRAPH_INTF_DEVNODE:	Identify a media Kernel API interface via
 *				a device node
 */
enum media_gobj_type {
	MEDIA_GRAPH_ENTITY,
	MEDIA_GRAPH_PAD,
	MEDIA_GRAPH_LINK,
	MEDIA_GRAPH_INTF_DEVNODE,
};

#define MEDIA_BITS_PER_TYPE		8
#define MEDIA_BITS_PER_LOCAL_ID		(32 - MEDIA_BITS_PER_TYPE)
#define MEDIA_LOCAL_ID_MASK		 GENMASK(MEDIA_BITS_PER_LOCAL_ID - 1, 0)

/* Structs to represent the objects that belong to a media graph */

/**
 * struct media_gobj - Define a graph object.
 *
 * @id:		Non-zero object ID identifier. The ID should be unique
 *		inside a media_device, as it is composed by
 *		MEDIA_BITS_PER_TYPE to store the type plus
 *		MEDIA_BITS_PER_LOCAL_ID	to store a per-type ID
 *		(called as "local ID").
 *
 * All objects on the media graph should have this struct embedded
 */
struct media_gobj {
	struct media_device	*mdev;
	u32			id;
};


struct media_pipeline {
};

struct media_link {
	struct media_gobj graph_obj;
	struct media_pad *source;	/* Source pad */
	struct media_pad *sink;		/* Sink pad  */
	struct media_link *reverse;	/* Link in the reverse direction */
	unsigned long flags;		/* Link flags (MEDIA_LNK_FL_*) */
};

struct media_pad {
	struct media_gobj graph_obj;
	struct media_entity *entity;	/* Entity this pad belongs to */
	u16 index;			/* Pad index in the entity pads array */
	unsigned long flags;		/* Pad flags (MEDIA_PAD_FL_*) */
};

/**
 * struct media_entity_operations - Media entity operations
 * @link_setup:		Notify the entity of link changes. The operation can
 *			return an error, in which case link setup will be
 *			cancelled. Optional.
 * @link_validate:	Return whether a link is valid from the entity point of
 *			view. The media_entity_pipeline_start() function
 *			validates all links by calling this operation. Optional.
 */
struct media_entity_operations {
	int (*link_setup)(struct media_entity *entity,
			  const struct media_pad *local,
			  const struct media_pad *remote, u32 flags);
	int (*link_validate)(struct media_link *link);
};

struct media_entity {
	struct media_gobj graph_obj;
	struct list_head list;
	const char *name;		/* Entity name */
	u32 type;			/* Entity type (MEDIA_ENT_T_*) */
	u32 revision;			/* Entity revision, driver specific */
	unsigned long flags;		/* Entity flags (MEDIA_ENT_FL_*) */
	u32 group_id;			/* Entity group ID */

	u16 num_pads;			/* Number of sink and source pads */
	u16 num_links;			/* Number of existing links, both
					 * enabled and disabled */
	u16 num_backlinks;		/* Number of backlinks */
	u16 max_links;			/* Maximum number of links */

	struct media_pad *pads;		/* Pads array (num_pads elements) */
	struct media_link *links;	/* Links array (max_links elements)*/

	const struct media_entity_operations *ops;	/* Entity operations */

	/* Reference counts must never be negative, but are signed integers on
	 * purpose: a simple WARN_ON(<0) check can be used to detect reference
	 * count bugs that would make them negative.
	 */
	int stream_count;		/* Stream count for the entity. */
	int use_count;			/* Use count for the entity. */

	struct media_pipeline *pipe;	/* Pipeline this entity belongs to. */

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

		/* Sub-device specifications */
		/* Nothing needed yet */
	} info;
};

/**
 * struct media_intf_devnode - Define a Kernel API interface
 *
 * @graph_obj:		embedded graph object
 * @type:		Type of the interface as defined at the
 *			uapi/media/media.h header, e. g.
 *			MEDIA_INTF_T_*
 * @flags:		Interface flags as defined at uapi/media/media.h
 */
struct media_interface {
	struct media_gobj		graph_obj;
	u32				type;
	u32				flags;
};

/**
 * struct media_intf_devnode - Define a Kernel API interface via a device node
 *
 * @intf:	embedded interface object
 * @major:	Major number of a device node
 * @minor:	Minor number of a device node
 */
struct media_intf_devnode {
	struct media_interface		intf;
	u32				major;
	u32				minor;
};

static inline u32 media_entity_type(struct media_entity *entity)
{
	return entity->type & MEDIA_ENT_TYPE_MASK;
}

static inline u32 media_entity_subtype(struct media_entity *entity)
{
	return entity->type & MEDIA_ENT_SUBTYPE_MASK;
}

static inline u32 media_entity_id(struct media_entity *entity)
{
	return entity->graph_obj.id;
}

static inline enum media_gobj_type media_type(struct media_gobj *gobj)
{
	return gobj->id >> MEDIA_BITS_PER_LOCAL_ID;
}

static inline u32 media_localid(struct media_gobj *gobj)
{
	return gobj->id & MEDIA_LOCAL_ID_MASK;
}

static inline u32 media_gobj_gen_id(enum media_gobj_type type, u32 local_id)
{
	u32 id;

	id = type << MEDIA_BITS_PER_LOCAL_ID;
	id |= local_id & MEDIA_LOCAL_ID_MASK;

	return id;
}

#define MEDIA_ENTITY_ENUM_MAX_DEPTH	16
#define MEDIA_ENTITY_ENUM_MAX_ID	64

/*
 * The number of pads can't be bigger than the number of entities,
 * as the worse-case scenario is to have one entity linked up to
 * MEDIA_ENTITY_ENUM_MAX_ID - 1 entities.
 */
#define MEDIA_ENTITY_MAX_PADS		(MEDIA_ENTITY_ENUM_MAX_ID - 1)

struct media_entity_graph {
	struct {
		struct media_entity *entity;
		int link;
	} stack[MEDIA_ENTITY_ENUM_MAX_DEPTH];

	DECLARE_BITMAP(entities, MEDIA_ENTITY_ENUM_MAX_ID);
	int top;
};

#define gobj_to_entity(gobj) \
		container_of(gobj, struct media_entity, graph_obj)

#define gobj_to_pad(gobj) \
		container_of(gobj, struct media_pad, graph_obj)

#define gobj_to_link(gobj) \
		container_of(gobj, struct media_link, graph_obj)

#define gobj_to_link(gobj) \
		container_of(gobj, struct media_link, graph_obj)

#define gobj_to_pad(gobj) \
		container_of(gobj, struct media_pad, graph_obj)

#define gobj_to_intf(gobj) \
		container_of(gobj, struct media_interface, graph_obj)

#define intf_to_devnode(intf) \
		container_of(intf, struct media_intf_devnode, intf)

void media_gobj_init(struct media_device *mdev,
		    enum media_gobj_type type,
		    struct media_gobj *gobj);
void media_gobj_remove(struct media_gobj *gobj);

int media_entity_init(struct media_entity *entity, u16 num_pads,
		struct media_pad *pads);
void media_entity_cleanup(struct media_entity *entity);

int media_create_pad_link(struct media_entity *source, u16 source_pad,
		struct media_entity *sink, u16 sink_pad, u32 flags);
void __media_entity_remove_links(struct media_entity *entity);
void media_entity_remove_links(struct media_entity *entity);

int __media_entity_setup_link(struct media_link *link, u32 flags);
int media_entity_setup_link(struct media_link *link, u32 flags);
struct media_link *media_entity_find_link(struct media_pad *source,
		struct media_pad *sink);
struct media_pad *media_entity_remote_pad(struct media_pad *pad);

struct media_entity *media_entity_get(struct media_entity *entity);
void media_entity_put(struct media_entity *entity);

void media_entity_graph_walk_start(struct media_entity_graph *graph,
		struct media_entity *entity);
struct media_entity *
media_entity_graph_walk_next(struct media_entity_graph *graph);
__must_check int media_entity_pipeline_start(struct media_entity *entity,
					     struct media_pipeline *pipe);
void media_entity_pipeline_stop(struct media_entity *entity);

struct media_intf_devnode *media_devnode_create(struct media_device *mdev,
						u32 type, u32 flags,
						u32 major, u32 minor,
						gfp_t gfp_flags);
void media_devnode_remove(struct media_intf_devnode *devnode);
#define media_entity_call(entity, operation, args...)			\
	(((entity)->ops && (entity)->ops->operation) ?			\
	 (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)

#endif
Commit	Line	Data
53e269c1 LP	1	/*
	2	* Media entity
	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 _MEDIA_ENTITY_H
	24	#define _MEDIA_ENTITY_H
	25
5c7b25b9	26	#include <linux/bitops.h>
0149a2e1	27	#include <linux/kernel.h>
53e269c1	28	#include <linux/list.h>
1651333b	29	#include <linux/media.h>
53e269c1	30
ec6e4c95 MCC	31	/* Enums used internally at the media controller to represent graphs */
	32
	33	/**
	34	* enum media_gobj_type - type of a graph object
	35	*
bfab2aac	36	* @MEDIA_GRAPH_ENTITY: Identify a media entity
18710dc6	37	* @MEDIA_GRAPH_PAD: Identify a media pad
6b6a4278	38	* @MEDIA_GRAPH_LINK: Identify a media link
27e543fa MCC	39	* @MEDIA_GRAPH_INTF_DEVNODE: Identify a media Kernel API interface via
27e543fa MCC	40	* a device node
ec6e4c95 MCC	41	*/
ec6e4c95 MCC	42	enum media_gobj_type {
bfab2aac	43	MEDIA_GRAPH_ENTITY,
18710dc6	44	MEDIA_GRAPH_PAD,
6b6a4278	45	MEDIA_GRAPH_LINK,
27e543fa	46	MEDIA_GRAPH_INTF_DEVNODE,
ec6e4c95 MCC	47	};
	48
	49	#define MEDIA_BITS_PER_TYPE 8
	50	#define MEDIA_BITS_PER_LOCAL_ID (32 - MEDIA_BITS_PER_TYPE)
	51	#define MEDIA_LOCAL_ID_MASK GENMASK(MEDIA_BITS_PER_LOCAL_ID - 1, 0)
	52
	53	/* Structs to represent the objects that belong to a media graph */
	54
	55	/**
	56	* struct media_gobj - Define a graph object.
	57	*
	58	* @id: Non-zero object ID identifier. The ID should be unique
	59	* inside a media_device, as it is composed by
	60	* MEDIA_BITS_PER_TYPE to store the type plus
	61	* MEDIA_BITS_PER_LOCAL_ID to store a per-type ID
	62	* (called as "local ID").
	63	*
	64	* All objects on the media graph should have this struct embedded
	65	*/
	66	struct media_gobj {
39a956c4	67	struct media_device *mdev;
ec6e4c95 MCC	68	u32 id;
	69	};
	70
	71
e02188c9 LP	72	struct media_pipeline {
	73	};
	74
53e269c1	75	struct media_link {
6b6a4278	76	struct media_gobj graph_obj;
53e269c1 LP	77	struct media_pad source; / Source pad */
	78	struct media_pad sink; / Sink pad */
	79	struct media_link reverse; / Link in the reverse direction */
	80	unsigned long flags; /* Link flags (MEDIA_LNK_FL_) /
	81	};
	82
	83	struct media_pad {
18710dc6	84	struct media_gobj graph_obj;
53e269c1 LP	85	struct media_entity entity; / Entity this pad belongs to */
	86	u16 index; /* Pad index in the entity pads array */
	87	unsigned long flags; /* Pad flags (MEDIA_PAD_FL_) /
	88	};
	89
5a5394be LP	90	/**
	91	* struct media_entity_operations - Media entity operations
	92	* @link_setup: Notify the entity of link changes. The operation can
	93	* return an error, in which case link setup will be
	94	* cancelled. Optional.
	95	* @link_validate: Return whether a link is valid from the entity point of
	96	* view. The media_entity_pipeline_start() function
	97	* validates all links by calling this operation. Optional.
	98	*/
97548ed4 LP	99	struct media_entity_operations {
	100	int (link_setup)(struct media_entity entity,
	101	const struct media_pad *local,
	102	const struct media_pad *remote, u32 flags);
af88be38	103	int (link_validate)(struct media_link link);
97548ed4 LP	104	};
97548ed4 LP	105
53e269c1	106	struct media_entity {
bfab2aac	107	struct media_gobj graph_obj;
53e269c1	108	struct list_head list;
53e269c1 LP	109	const char name; / Entity name */
	110	u32 type; /* Entity type (MEDIA_ENT_T_) /
	111	u32 revision; /* Entity revision, driver specific */
	112	unsigned long flags; /* Entity flags (MEDIA_ENT_FL_) /
	113	u32 group_id; /* Entity group ID */
	114
	115	u16 num_pads; /* Number of sink and source pads */
	116	u16 num_links; /* Number of existing links, both
	117	* enabled and disabled */
	118	u16 num_backlinks; /* Number of backlinks */
	119	u16 max_links; /* Maximum number of links */
	120
	121	struct media_pad pads; / Pads array (num_pads elements) */
	122	struct media_link links; / Links array (max_links elements)*/
	123
97548ed4 LP	124	const struct media_entity_operations ops; / Entity operations */
97548ed4 LP	125
503c3d82 LP	126	/* Reference counts must never be negative, but are signed integers on
	127	* purpose: a simple WARN_ON(<0) check can be used to detect reference
	128	* count bugs that would make them negative.
	129	*/
e02188c9	130	int stream_count; /* Stream count for the entity. */
503c3d82 LP	131	int use_count; /* Use count for the entity. */
503c3d82 LP	132
e02188c9 LP	133	struct media_pipeline pipe; / Pipeline this entity belongs to. */
e02188c9 LP	134
53e269c1 LP	135	union {
	136	/* Node specifications */
	137	struct {
	138	u32 major;
	139	u32 minor;
e31a0ba7	140	} dev;
53e269c1 LP	141
	142	/* Sub-device specifications */
	143	/* Nothing needed yet */
fa5034c6	144	} info;
53e269c1 LP	145	};
53e269c1 LP	146
27e543fa MCC	147	/**
	148	* struct media_intf_devnode - Define a Kernel API interface
	149	*
	150	* @graph_obj: embedded graph object
	151	* @type: Type of the interface as defined at the
	152	* uapi/media/media.h header, e. g.
	153	* MEDIA_INTF_T_*
	154	* @flags: Interface flags as defined at uapi/media/media.h
	155	*/
	156	struct media_interface {
	157	struct media_gobj graph_obj;
	158	u32 type;
	159	u32 flags;
	160	};
	161
	162	/**
	163	* struct media_intf_devnode - Define a Kernel API interface via a device node
	164	*
	165	* @intf: embedded interface object
	166	* @major: Major number of a device node
	167	* @minor: Minor number of a device node
	168	*/
	169	struct media_intf_devnode {
	170	struct media_interface intf;
	171	u32 major;
	172	u32 minor;
	173	};
	174
53e269c1 LP	175	static inline u32 media_entity_type(struct media_entity *entity)
	176	{
	177	return entity->type & MEDIA_ENT_TYPE_MASK;
	178	}
	179
	180	static inline u32 media_entity_subtype(struct media_entity *entity)
	181	{
	182	return entity->type & MEDIA_ENT_SUBTYPE_MASK;
	183	}
	184
fa762394 MCC	185	static inline u32 media_entity_id(struct media_entity *entity)
fa762394 MCC	186	{
bfab2aac	187	return entity->graph_obj.id;
fa762394 MCC	188	}
fa762394 MCC	189
ec6e4c95 MCC	190	static inline enum media_gobj_type media_type(struct media_gobj *gobj)
	191	{
	192	return gobj->id >> MEDIA_BITS_PER_LOCAL_ID;
	193	}
	194
	195	static inline u32 media_localid(struct media_gobj *gobj)
	196	{
	197	return gobj->id & MEDIA_LOCAL_ID_MASK;
	198	}
	199
	200	static inline u32 media_gobj_gen_id(enum media_gobj_type type, u32 local_id)
	201	{
	202	u32 id;
	203
	204	id = type << MEDIA_BITS_PER_LOCAL_ID;
	205	id \|= local_id & MEDIA_LOCAL_ID_MASK;
	206
	207	return id;
	208	}
	209
a5ccc48a	210	#define MEDIA_ENTITY_ENUM_MAX_DEPTH 16
5c7b25b9	211	#define MEDIA_ENTITY_ENUM_MAX_ID 64
a5ccc48a	212
ef69ee1b MCC	213	/*
	214	* The number of pads can't be bigger than the number of entities,
	215	* as the worse-case scenario is to have one entity linked up to
	216	* MEDIA_ENTITY_ENUM_MAX_ID - 1 entities.
	217	*/
	218	#define MEDIA_ENTITY_MAX_PADS (MEDIA_ENTITY_ENUM_MAX_ID - 1)
	219
a5ccc48a SA	220	struct media_entity_graph {
	221	struct {
	222	struct media_entity *entity;
	223	int link;
	224	} stack[MEDIA_ENTITY_ENUM_MAX_DEPTH];
5c7b25b9 LP	225
5c7b25b9 LP	226	DECLARE_BITMAP(entities, MEDIA_ENTITY_ENUM_MAX_ID);
a5ccc48a SA	227	int top;
	228	};
	229
ec6e4c95 MCC	230	#define gobj_to_entity(gobj) \
	231	container_of(gobj, struct media_entity, graph_obj)
	232
39a956c4 MCC	233	#define gobj_to_pad(gobj) \
	234	container_of(gobj, struct media_pad, graph_obj)
	235
	236	#define gobj_to_link(gobj) \
	237	container_of(gobj, struct media_link, graph_obj)
	238
27e543fa MCC	239	#define gobj_to_link(gobj) \
	240	container_of(gobj, struct media_link, graph_obj)
	241
	242	#define gobj_to_pad(gobj) \
	243	container_of(gobj, struct media_pad, graph_obj)
	244
	245	#define gobj_to_intf(gobj) \
	246	container_of(gobj, struct media_interface, graph_obj)
	247
	248	#define intf_to_devnode(intf) \
	249	container_of(intf, struct media_intf_devnode, intf)
	250
ec6e4c95 MCC	251	void media_gobj_init(struct media_device *mdev,
	252	enum media_gobj_type type,
	253	struct media_gobj *gobj);
	254	void media_gobj_remove(struct media_gobj *gobj);
	255
53e269c1	256	int media_entity_init(struct media_entity *entity, u16 num_pads,
18095107	257	struct media_pad *pads);
53e269c1	258	void media_entity_cleanup(struct media_entity *entity);
e02188c9	259
8df00a15	260	int media_create_pad_link(struct media_entity *source, u16 source_pad,
53e269c1	261	struct media_entity *sink, u16 sink_pad, u32 flags);
7349cec1 SN	262	void __media_entity_remove_links(struct media_entity *entity);
	263	void media_entity_remove_links(struct media_entity *entity);
	264
97548ed4 LP	265	int __media_entity_setup_link(struct media_link *link, u32 flags);
	266	int media_entity_setup_link(struct media_link *link, u32 flags);
	267	struct media_link media_entity_find_link(struct media_pad source,
	268	struct media_pad *sink);
1bddf1b3	269	struct media_pad media_entity_remote_pad(struct media_pad pad);
53e269c1	270
503c3d82 LP	271	struct media_entity media_entity_get(struct media_entity entity);
	272	void media_entity_put(struct media_entity *entity);
	273
a5ccc48a SA	274	void media_entity_graph_walk_start(struct media_entity_graph *graph,
	275	struct media_entity *entity);
	276	struct media_entity *
	277	media_entity_graph_walk_next(struct media_entity_graph *graph);
af88be38 SA	278	__must_check int media_entity_pipeline_start(struct media_entity *entity,
af88be38 SA	279	struct media_pipeline *pipe);
e02188c9	280	void media_entity_pipeline_stop(struct media_entity *entity);
a5ccc48a	281
27e543fa MCC	282	struct media_intf_devnode media_devnode_create(struct media_device mdev,
	283	u32 type, u32 flags,
	284	u32 major, u32 minor,
	285	gfp_t gfp_flags);
	286	void media_devnode_remove(struct media_intf_devnode *devnode);
97548ed4 LP	287	#define media_entity_call(entity, operation, args...) \
	288	(((entity)->ops && (entity)->ops->operation) ? \
	289	(entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)
	290
53e269c1	291	#endif