[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 list_head list;
	union {
		struct media_gobj *gobj0;
		struct media_pad *source;
	};
	union {
		struct media_gobj *gobj1;
		struct media_pad *sink;
	};
	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;	/* must be first field in struct */
	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;	/* must be first field in struct */
	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 */

	struct media_pad *pads;		/* Pads array (num_pads objects) */
	struct list_head links;		/* Pad-to-pad links list */

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