4 * Copyright (C) 2010 Nokia Corporation
6 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7 * Sakari Ailus <sakari.ailus@iki.fi>
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.
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.
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
23 #ifndef _MEDIA_ENTITY_H
24 #define _MEDIA_ENTITY_H
26 #include <linux/list.h>
27 #include <linux/media.h>
29 struct media_pipeline {
33 struct media_pad *source; /* Source pad */
34 struct media_pad *sink; /* Sink pad */
35 struct media_link *reverse; /* Link in the reverse direction */
36 unsigned long flags; /* Link flags (MEDIA_LNK_FL_*) */
40 struct media_entity *entity; /* Entity this pad belongs to */
41 u16 index; /* Pad index in the entity pads array */
42 unsigned long flags; /* Pad flags (MEDIA_PAD_FL_*) */
45 struct media_entity_operations {
46 int (*link_setup)(struct media_entity *entity,
47 const struct media_pad *local,
48 const struct media_pad *remote, u32 flags);
52 struct list_head list;
53 struct media_device *parent; /* Media device this entity belongs to*/
54 u32 id; /* Entity ID, unique in the parent media
56 const char *name; /* Entity name */
57 u32 type; /* Entity type (MEDIA_ENT_T_*) */
58 u32 revision; /* Entity revision, driver specific */
59 unsigned long flags; /* Entity flags (MEDIA_ENT_FL_*) */
60 u32 group_id; /* Entity group ID */
62 u16 num_pads; /* Number of sink and source pads */
63 u16 num_links; /* Number of existing links, both
64 * enabled and disabled */
65 u16 num_backlinks; /* Number of backlinks */
66 u16 max_links; /* Maximum number of links */
68 struct media_pad *pads; /* Pads array (num_pads elements) */
69 struct media_link *links; /* Links array (max_links elements)*/
71 const struct media_entity_operations *ops; /* Entity operations */
73 /* Reference counts must never be negative, but are signed integers on
74 * purpose: a simple WARN_ON(<0) check can be used to detect reference
75 * count bugs that would make them negative.
77 int stream_count; /* Stream count for the entity. */
78 int use_count; /* Use count for the entity. */
80 struct media_pipeline *pipe; /* Pipeline this entity belongs to. */
83 /* Node specifications */
99 /* Sub-device specifications */
100 /* Nothing needed yet */
104 static inline u32 media_entity_type(struct media_entity *entity)
106 return entity->type & MEDIA_ENT_TYPE_MASK;
109 static inline u32 media_entity_subtype(struct media_entity *entity)
111 return entity->type & MEDIA_ENT_SUBTYPE_MASK;
114 #define MEDIA_ENTITY_ENUM_MAX_DEPTH 16
116 struct media_entity_graph {
118 struct media_entity *entity;
120 } stack[MEDIA_ENTITY_ENUM_MAX_DEPTH];
124 int media_entity_init(struct media_entity *entity, u16 num_pads,
125 struct media_pad *pads, u16 extra_links);
126 void media_entity_cleanup(struct media_entity *entity);
128 int media_entity_create_link(struct media_entity *source, u16 source_pad,
129 struct media_entity *sink, u16 sink_pad, u32 flags);
130 int __media_entity_setup_link(struct media_link *link, u32 flags);
131 int media_entity_setup_link(struct media_link *link, u32 flags);
132 struct media_link *media_entity_find_link(struct media_pad *source,
133 struct media_pad *sink);
134 struct media_pad *media_entity_remote_source(struct media_pad *pad);
136 struct media_entity *media_entity_get(struct media_entity *entity);
137 void media_entity_put(struct media_entity *entity);
139 void media_entity_graph_walk_start(struct media_entity_graph *graph,
140 struct media_entity *entity);
141 struct media_entity *
142 media_entity_graph_walk_next(struct media_entity_graph *graph);
143 void media_entity_pipeline_start(struct media_entity *entity,
144 struct media_pipeline *pipe);
145 void media_entity_pipeline_stop(struct media_entity *entity);
147 #define media_entity_call(entity, operation, args...) \
148 (((entity)->ops && (entity)->ops->operation) ? \
149 (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)