blob: 5697735be433e1e91bb68a86ab16a5abda40ad74 [file] [log] [blame]
Laurent Pinchart53e269c2009-12-09 08:40:00 -03001/*
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
Laurent Pinchart5c7b25b2013-06-07 12:45:11 -030023#include <linux/bitmap.h>
Laurent Pinchart53e269c2009-12-09 08:40:00 -030024#include <linux/module.h>
25#include <linux/slab.h>
26#include <media/media-entity.h>
Laurent Pinchart503c3d822010-03-07 15:04:59 -030027#include <media/media-device.h>
Laurent Pinchart53e269c2009-12-09 08:40:00 -030028
29/**
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -030030 * dev_dbg_obj - Prints in debug mode a change on some object
31 *
32 * @event_name: Name of the event to report. Could be __func__
33 * @gobj: Pointer to the object
34 *
35 * Enabled only if DEBUG or CONFIG_DYNAMIC_DEBUG. Otherwise, it
36 * won't produce any code.
37 */
38static inline const char *gobj_type(enum media_gobj_type type)
39{
40 switch (type) {
41 case MEDIA_GRAPH_ENTITY:
42 return "entity";
43 case MEDIA_GRAPH_PAD:
44 return "pad";
45 case MEDIA_GRAPH_LINK:
46 return "link";
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -030047 case MEDIA_GRAPH_INTF_DEVNODE:
48 return "intf-devnode";
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -030049 default:
50 return "unknown";
51 }
52}
53
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -030054static inline const char *intf_type(struct media_interface *intf)
55{
56 switch (intf->type) {
57 case MEDIA_INTF_T_DVB_FE:
58 return "frontend";
59 case MEDIA_INTF_T_DVB_DEMUX:
60 return "demux";
61 case MEDIA_INTF_T_DVB_DVR:
62 return "DVR";
63 case MEDIA_INTF_T_DVB_CA:
64 return "CA";
65 case MEDIA_INTF_T_DVB_NET:
66 return "dvbnet";
67 case MEDIA_INTF_T_V4L_VIDEO:
68 return "video";
69 case MEDIA_INTF_T_V4L_VBI:
70 return "vbi";
71 case MEDIA_INTF_T_V4L_RADIO:
72 return "radio";
73 case MEDIA_INTF_T_V4L_SUBDEV:
74 return "v4l2-subdev";
75 case MEDIA_INTF_T_V4L_SWRADIO:
76 return "swradio";
77 default:
78 return "unknown-intf";
79 }
80};
81
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -030082static void dev_dbg_obj(const char *event_name, struct media_gobj *gobj)
83{
84#if defined(DEBUG) || defined (CONFIG_DYNAMIC_DEBUG)
85 switch (media_type(gobj)) {
86 case MEDIA_GRAPH_ENTITY:
87 dev_dbg(gobj->mdev->dev,
88 "%s: id 0x%08x entity#%d: '%s'\n",
89 event_name, gobj->id, media_localid(gobj),
90 gobj_to_entity(gobj)->name);
91 break;
92 case MEDIA_GRAPH_LINK:
93 {
94 struct media_link *link = gobj_to_link(gobj);
95
96 dev_dbg(gobj->mdev->dev,
Mauro Carvalho Chehab3c0e2662015-08-21 08:45:34 -030097 "%s: id 0x%08x link#%d: %s#%d ==> %s#%d\n",
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -030098 event_name, gobj->id, media_localid(gobj),
99
Mauro Carvalho Chehab3c0e2662015-08-21 08:45:34 -0300100 gobj_type(media_type(link->gobj0)),
101 media_localid(link->gobj0),
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300102
Mauro Carvalho Chehab3c0e2662015-08-21 08:45:34 -0300103 gobj_type(media_type(link->gobj1)),
104 media_localid(link->gobj1));
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300105 break;
106 }
107 case MEDIA_GRAPH_PAD:
108 {
109 struct media_pad *pad = gobj_to_pad(gobj);
110
111 dev_dbg(gobj->mdev->dev,
Mauro Carvalho Chehab6c24d462015-08-21 18:26:42 -0300112 "%s: id 0x%08x %s%spad#%d: '%s':%d\n",
113 event_name, gobj->id,
114 pad->flags & MEDIA_PAD_FL_SINK ? " sink " : "",
115 pad->flags & MEDIA_PAD_FL_SOURCE ? "source " : "",
116 media_localid(gobj),
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300117 pad->entity->name, pad->index);
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300118 break;
119 }
120 case MEDIA_GRAPH_INTF_DEVNODE:
121 {
122 struct media_interface *intf = gobj_to_intf(gobj);
123 struct media_intf_devnode *devnode = intf_to_devnode(intf);
124
125 dev_dbg(gobj->mdev->dev,
126 "%s: id 0x%08x intf_devnode#%d: %s - major: %d, minor: %d\n",
127 event_name, gobj->id, media_localid(gobj),
128 intf_type(intf),
129 devnode->major, devnode->minor);
130 break;
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300131 }
132 }
133#endif
134}
135
136/**
Mauro Carvalho Chehabec6e4c92015-08-25 10:28:36 -0300137 * media_gobj_init - Initialize a graph object
138 *
139 * @mdev: Pointer to the media_device that contains the object
140 * @type: Type of the object
141 * @gobj: Pointer to the object
142 *
143 * This routine initializes the embedded struct media_gobj inside a
144 * media graph object. It is called automatically if media_*_create()
145 * calls are used. However, if the object (entity, link, pad, interface)
146 * is embedded on some other object, this function should be called before
147 * registering the object at the media controller.
148 */
149void media_gobj_init(struct media_device *mdev,
150 enum media_gobj_type type,
151 struct media_gobj *gobj)
152{
Mauro Carvalho Chehab8f6d3682015-08-19 20:18:35 -0300153 BUG_ON(!mdev);
154
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300155 gobj->mdev = mdev;
156
Mauro Carvalho Chehabbfab2aac2015-08-14 12:47:48 -0300157 /* Create a per-type unique object ID */
158 switch (type) {
159 case MEDIA_GRAPH_ENTITY:
160 gobj->id = media_gobj_gen_id(type, ++mdev->entity_id);
161 break;
Mauro Carvalho Chehab18710dc2015-08-14 12:50:08 -0300162 case MEDIA_GRAPH_PAD:
163 gobj->id = media_gobj_gen_id(type, ++mdev->pad_id);
164 break;
Mauro Carvalho Chehab6b6a4272015-08-14 12:54:36 -0300165 case MEDIA_GRAPH_LINK:
166 gobj->id = media_gobj_gen_id(type, ++mdev->link_id);
167 break;
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300168 case MEDIA_GRAPH_INTF_DEVNODE:
169 gobj->id = media_gobj_gen_id(type, ++mdev->intf_devnode_id);
170 break;
Mauro Carvalho Chehabbfab2aac2015-08-14 12:47:48 -0300171 }
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300172 dev_dbg_obj(__func__, gobj);
Mauro Carvalho Chehabec6e4c92015-08-25 10:28:36 -0300173}
174
175/**
176 * media_gobj_remove - Stop using a graph object on a media device
177 *
178 * @graph_obj: Pointer to the object
179 *
180 * This should be called at media_device_unregister_*() routines
181 */
182void media_gobj_remove(struct media_gobj *gobj)
183{
Mauro Carvalho Chehab39a956c2015-08-13 14:42:42 -0300184 dev_dbg_obj(__func__, gobj);
Mauro Carvalho Chehabec6e4c92015-08-25 10:28:36 -0300185}
186
187/**
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300188 * media_entity_init - Initialize a media entity
189 *
190 * @num_pads: Total number of sink and source pads.
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300191 * @pads: Array of 'num_pads' pads.
192 *
193 * The total number of pads is an intrinsic property of entities known by the
194 * entity driver, while the total number of links depends on hardware design
195 * and is an extrinsic property unknown to the entity driver. However, in most
Mauro Carvalho Chehab18095102015-08-06 09:25:57 -0300196 * use cases the number of links can safely be assumed to be equal to or
197 * larger than the number of pads.
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300198 *
Mauro Carvalho Chehab18095102015-08-06 09:25:57 -0300199 * For those reasons the links array can be preallocated based on the number
200 * of pads and will be reallocated later if extra links need to be created.
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300201 *
202 * This function allocates a links array with enough space to hold at least
Mauro Carvalho Chehab18095102015-08-06 09:25:57 -0300203 * 'num_pads' elements. The media_entity::max_links field will be set to the
204 * number of allocated elements.
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300205 *
206 * The pads array is managed by the entity driver and passed to
207 * media_entity_init() where its pointer will be stored in the entity structure.
208 */
209int
210media_entity_init(struct media_entity *entity, u16 num_pads,
Mauro Carvalho Chehab18095102015-08-06 09:25:57 -0300211 struct media_pad *pads)
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300212{
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300213 unsigned int i;
214
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300215 entity->group_id = 0;
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300216 entity->num_links = 0;
217 entity->num_backlinks = 0;
218 entity->num_pads = num_pads;
219 entity->pads = pads;
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300220
221 for (i = 0; i < num_pads; i++) {
222 pads[i].entity = entity;
223 pads[i].index = i;
224 }
225
226 return 0;
227}
228EXPORT_SYMBOL_GPL(media_entity_init);
229
230void
231media_entity_cleanup(struct media_entity *entity)
232{
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300233 struct media_link *link, *tmp;
234
235 list_for_each_entry_safe(link, tmp, &entity->links, list) {
236 media_gobj_remove(&link->graph_obj);
237 list_del(&link->list);
238 kfree(link);
239 }
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300240}
241EXPORT_SYMBOL_GPL(media_entity_cleanup);
242
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300243/* -----------------------------------------------------------------------------
244 * Graph traversal
245 */
246
247static struct media_entity *
248media_entity_other(struct media_entity *entity, struct media_link *link)
249{
250 if (link->source->entity == entity)
251 return link->sink->entity;
252 else
253 return link->source->entity;
254}
255
256/* push an entity to traversal stack */
257static void stack_push(struct media_entity_graph *graph,
258 struct media_entity *entity)
259{
260 if (graph->top == MEDIA_ENTITY_ENUM_MAX_DEPTH - 1) {
261 WARN_ON(1);
262 return;
263 }
264 graph->top++;
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300265 graph->stack[graph->top].link = (&entity->links)->next;
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300266 graph->stack[graph->top].entity = entity;
267}
268
269static struct media_entity *stack_pop(struct media_entity_graph *graph)
270{
271 struct media_entity *entity;
272
273 entity = graph->stack[graph->top].entity;
274 graph->top--;
275
276 return entity;
277}
278
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300279#define link_top(en) ((en)->stack[(en)->top].link)
280#define stack_top(en) ((en)->stack[(en)->top].entity)
281
282/**
283 * media_entity_graph_walk_start - Start walking the media graph at a given entity
284 * @graph: Media graph structure that will be used to walk the graph
285 * @entity: Starting entity
286 *
287 * This function initializes the graph traversal structure to walk the entities
288 * graph starting at the given entity. The traversal structure must not be
289 * modified by the caller during graph traversal. When done the structure can
290 * safely be freed.
291 */
292void media_entity_graph_walk_start(struct media_entity_graph *graph,
293 struct media_entity *entity)
294{
295 graph->top = 0;
296 graph->stack[graph->top].entity = NULL;
Laurent Pinchart5c7b25b2013-06-07 12:45:11 -0300297 bitmap_zero(graph->entities, MEDIA_ENTITY_ENUM_MAX_ID);
298
Mauro Carvalho Chehabfa762392015-08-14 10:42:05 -0300299 if (WARN_ON(media_entity_id(entity) >= MEDIA_ENTITY_ENUM_MAX_ID))
Laurent Pinchart5c7b25b2013-06-07 12:45:11 -0300300 return;
301
Mauro Carvalho Chehabfa762392015-08-14 10:42:05 -0300302 __set_bit(media_entity_id(entity), graph->entities);
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300303 stack_push(graph, entity);
304}
305EXPORT_SYMBOL_GPL(media_entity_graph_walk_start);
306
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300307
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300308/**
309 * media_entity_graph_walk_next - Get the next entity in the graph
310 * @graph: Media graph structure
311 *
312 * Perform a depth-first traversal of the given media entities graph.
313 *
314 * The graph structure must have been previously initialized with a call to
315 * media_entity_graph_walk_start().
316 *
317 * Return the next entity in the graph or NULL if the whole graph have been
318 * traversed.
319 */
320struct media_entity *
321media_entity_graph_walk_next(struct media_entity_graph *graph)
322{
323 if (stack_top(graph) == NULL)
324 return NULL;
325
326 /*
327 * Depth first search. Push entity to stack and continue from
328 * top of the stack until no more entities on the level can be
329 * found.
330 */
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300331 while (link_top(graph) != &(stack_top(graph)->links)) {
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300332 struct media_entity *entity = stack_top(graph);
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300333 struct media_link *link;
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300334 struct media_entity *next;
335
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300336 link = list_entry(link_top(graph), typeof(*link), list);
337
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300338 /* The link is not enabled so we do not follow. */
339 if (!(link->flags & MEDIA_LNK_FL_ENABLED)) {
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300340 link_top(graph) = link_top(graph)->next;
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300341 continue;
342 }
343
344 /* Get the entity in the other end of the link . */
345 next = media_entity_other(entity, link);
Mauro Carvalho Chehabfa762392015-08-14 10:42:05 -0300346 if (WARN_ON(media_entity_id(next) >= MEDIA_ENTITY_ENUM_MAX_ID))
Laurent Pinchart5c7b25b2013-06-07 12:45:11 -0300347 return NULL;
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300348
Laurent Pinchart5c7b25b2013-06-07 12:45:11 -0300349 /* Has the entity already been visited? */
Mauro Carvalho Chehabfa762392015-08-14 10:42:05 -0300350 if (__test_and_set_bit(media_entity_id(next), graph->entities)) {
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300351 link_top(graph) = link_top(graph)->next;
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300352 continue;
353 }
354
355 /* Push the new entity to stack and start over. */
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300356 link_top(graph) = link_top(graph)->next;
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300357 stack_push(graph, next);
358 }
359
360 return stack_pop(graph);
361}
362EXPORT_SYMBOL_GPL(media_entity_graph_walk_next);
363
364/* -----------------------------------------------------------------------------
Laurent Pincharte02188c2010-08-25 09:00:41 -0300365 * Pipeline management
366 */
367
368/**
369 * media_entity_pipeline_start - Mark a pipeline as streaming
370 * @entity: Starting entity
371 * @pipe: Media pipeline to be assigned to all entities in the pipeline.
372 *
373 * Mark all entities connected to a given entity through enabled links, either
374 * directly or indirectly, as streaming. The given pipeline object is assigned to
375 * every entity in the pipeline and stored in the media_entity pipe field.
376 *
377 * Calls to this function can be nested, in which case the same number of
378 * media_entity_pipeline_stop() calls will be required to stop streaming. The
379 * pipeline pointer must be identical for all nested calls to
380 * media_entity_pipeline_start().
381 */
Sakari Ailusaf88be32012-01-11 06:25:15 -0300382__must_check int media_entity_pipeline_start(struct media_entity *entity,
383 struct media_pipeline *pipe)
Laurent Pincharte02188c2010-08-25 09:00:41 -0300384{
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300385 struct media_device *mdev = entity->graph_obj.mdev;
Laurent Pincharte02188c2010-08-25 09:00:41 -0300386 struct media_entity_graph graph;
Sakari Ailusaf88be32012-01-11 06:25:15 -0300387 struct media_entity *entity_err = entity;
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300388 struct media_link *link;
Sakari Ailusaf88be32012-01-11 06:25:15 -0300389 int ret;
Laurent Pincharte02188c2010-08-25 09:00:41 -0300390
391 mutex_lock(&mdev->graph_mutex);
392
393 media_entity_graph_walk_start(&graph, entity);
394
395 while ((entity = media_entity_graph_walk_next(&graph))) {
Mauro Carvalho Chehabef69ee12015-10-01 18:07:53 -0300396 DECLARE_BITMAP(active, MEDIA_ENTITY_MAX_PADS);
397 DECLARE_BITMAP(has_no_links, MEDIA_ENTITY_MAX_PADS);
Sakari Ailusaf88be32012-01-11 06:25:15 -0300398
Laurent Pincharte02188c2010-08-25 09:00:41 -0300399 entity->stream_count++;
400 WARN_ON(entity->pipe && entity->pipe != pipe);
401 entity->pipe = pipe;
Sakari Ailusaf88be32012-01-11 06:25:15 -0300402
403 /* Already streaming --- no need to check. */
404 if (entity->stream_count > 1)
405 continue;
406
407 if (!entity->ops || !entity->ops->link_validate)
408 continue;
409
Sakari Ailusde49c282013-10-13 08:00:26 -0300410 bitmap_zero(active, entity->num_pads);
411 bitmap_fill(has_no_links, entity->num_pads);
412
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300413 list_for_each_entry(link, &entity->links, list) {
Sakari Ailusde49c282013-10-13 08:00:26 -0300414 struct media_pad *pad = link->sink->entity == entity
415 ? link->sink : link->source;
Sakari Ailusaf88be32012-01-11 06:25:15 -0300416
Sakari Ailusde49c282013-10-13 08:00:26 -0300417 /* Mark that a pad is connected by a link. */
418 bitmap_clear(has_no_links, pad->index, 1);
Sakari Ailusaf88be32012-01-11 06:25:15 -0300419
Sakari Ailusde49c282013-10-13 08:00:26 -0300420 /*
421 * Pads that either do not need to connect or
422 * are connected through an enabled link are
423 * fine.
424 */
425 if (!(pad->flags & MEDIA_PAD_FL_MUST_CONNECT) ||
426 link->flags & MEDIA_LNK_FL_ENABLED)
427 bitmap_set(active, pad->index, 1);
428
429 /*
430 * Link validation will only take place for
431 * sink ends of the link that are enabled.
432 */
433 if (link->sink != pad ||
434 !(link->flags & MEDIA_LNK_FL_ENABLED))
Sakari Ailusaf88be32012-01-11 06:25:15 -0300435 continue;
436
437 ret = entity->ops->link_validate(link);
Sakari Ailusfab9d302014-10-28 20:35:04 -0300438 if (ret < 0 && ret != -ENOIOCTLCMD) {
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300439 dev_dbg(entity->graph_obj.mdev->dev,
Sakari Ailusfab9d302014-10-28 20:35:04 -0300440 "link validation failed for \"%s\":%u -> \"%s\":%u, error %d\n",
Sakari Ailus823ea2a2015-02-12 11:43:11 -0200441 link->source->entity->name,
442 link->source->index,
443 entity->name, link->sink->index, ret);
Sakari Ailusaf88be32012-01-11 06:25:15 -0300444 goto error;
Sakari Ailusfab9d302014-10-28 20:35:04 -0300445 }
Sakari Ailusaf88be32012-01-11 06:25:15 -0300446 }
Sakari Ailusde49c282013-10-13 08:00:26 -0300447
448 /* Either no links or validated links are fine. */
449 bitmap_or(active, active, has_no_links, entity->num_pads);
450
451 if (!bitmap_full(active, entity->num_pads)) {
452 ret = -EPIPE;
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300453 dev_dbg(entity->graph_obj.mdev->dev,
Sakari Ailusfab9d302014-10-28 20:35:04 -0300454 "\"%s\":%u must be connected by an enabled link\n",
455 entity->name,
Sakari Ailus094f1ca2014-11-03 17:55:51 -0300456 (unsigned)find_first_zero_bit(
457 active, entity->num_pads));
Sakari Ailusde49c282013-10-13 08:00:26 -0300458 goto error;
459 }
Laurent Pincharte02188c2010-08-25 09:00:41 -0300460 }
461
462 mutex_unlock(&mdev->graph_mutex);
Sakari Ailusaf88be32012-01-11 06:25:15 -0300463
464 return 0;
465
466error:
467 /*
468 * Link validation on graph failed. We revert what we did and
469 * return the error.
470 */
471 media_entity_graph_walk_start(&graph, entity_err);
472
473 while ((entity_err = media_entity_graph_walk_next(&graph))) {
474 entity_err->stream_count--;
475 if (entity_err->stream_count == 0)
476 entity_err->pipe = NULL;
477
478 /*
479 * We haven't increased stream_count further than this
480 * so we quit here.
481 */
482 if (entity_err == entity)
483 break;
484 }
485
486 mutex_unlock(&mdev->graph_mutex);
487
488 return ret;
Laurent Pincharte02188c2010-08-25 09:00:41 -0300489}
490EXPORT_SYMBOL_GPL(media_entity_pipeline_start);
491
492/**
493 * media_entity_pipeline_stop - Mark a pipeline as not streaming
494 * @entity: Starting entity
495 *
496 * Mark all entities connected to a given entity through enabled links, either
497 * directly or indirectly, as not streaming. The media_entity pipe field is
498 * reset to NULL.
499 *
500 * If multiple calls to media_entity_pipeline_start() have been made, the same
501 * number of calls to this function are required to mark the pipeline as not
502 * streaming.
503 */
504void media_entity_pipeline_stop(struct media_entity *entity)
505{
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300506 struct media_device *mdev = entity->graph_obj.mdev;
Laurent Pincharte02188c2010-08-25 09:00:41 -0300507 struct media_entity_graph graph;
508
509 mutex_lock(&mdev->graph_mutex);
510
511 media_entity_graph_walk_start(&graph, entity);
512
513 while ((entity = media_entity_graph_walk_next(&graph))) {
514 entity->stream_count--;
515 if (entity->stream_count == 0)
516 entity->pipe = NULL;
517 }
518
519 mutex_unlock(&mdev->graph_mutex);
520}
521EXPORT_SYMBOL_GPL(media_entity_pipeline_stop);
522
523/* -----------------------------------------------------------------------------
Laurent Pinchart503c3d822010-03-07 15:04:59 -0300524 * Module use count
525 */
526
527/*
528 * media_entity_get - Get a reference to the parent module
529 * @entity: The entity
530 *
531 * Get a reference to the parent media device module.
532 *
533 * The function will return immediately if @entity is NULL.
534 *
535 * Return a pointer to the entity on success or NULL on failure.
536 */
537struct media_entity *media_entity_get(struct media_entity *entity)
538{
539 if (entity == NULL)
540 return NULL;
541
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300542 if (entity->graph_obj.mdev->dev &&
543 !try_module_get(entity->graph_obj.mdev->dev->driver->owner))
Laurent Pinchart503c3d822010-03-07 15:04:59 -0300544 return NULL;
545
546 return entity;
547}
548EXPORT_SYMBOL_GPL(media_entity_get);
549
550/*
551 * media_entity_put - Release the reference to the parent module
552 * @entity: The entity
553 *
554 * Release the reference count acquired by media_entity_get().
555 *
556 * The function will return immediately if @entity is NULL.
557 */
558void media_entity_put(struct media_entity *entity)
559{
560 if (entity == NULL)
561 return;
562
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300563 if (entity->graph_obj.mdev->dev)
564 module_put(entity->graph_obj.mdev->dev->driver->owner);
Laurent Pinchart503c3d822010-03-07 15:04:59 -0300565}
566EXPORT_SYMBOL_GPL(media_entity_put);
567
568/* -----------------------------------------------------------------------------
Sakari Ailusa5ccc482010-03-07 16:14:14 -0300569 * Links management
570 */
571
Mauro Carvalho Chehab23615de2015-08-20 08:21:35 -0300572static struct media_link *media_add_link(struct list_head *head)
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300573{
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300574 struct media_link *link;
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300575
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300576 link = kzalloc(sizeof(*link), GFP_KERNEL);
577 if (link == NULL)
578 return NULL;
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300579
Mauro Carvalho Chehab23615de2015-08-20 08:21:35 -0300580 list_add_tail(&link->list, head);
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300581
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300582 return link;
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300583}
584
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300585static void __media_entity_remove_link(struct media_entity *entity,
586 struct media_link *link);
587
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300588int
Mauro Carvalho Chehab8df00a12015-08-07 08:14:38 -0300589media_create_pad_link(struct media_entity *source, u16 source_pad,
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300590 struct media_entity *sink, u16 sink_pad, u32 flags)
591{
592 struct media_link *link;
593 struct media_link *backlink;
594
595 BUG_ON(source == NULL || sink == NULL);
596 BUG_ON(source_pad >= source->num_pads);
597 BUG_ON(sink_pad >= sink->num_pads);
598
Mauro Carvalho Chehab23615de2015-08-20 08:21:35 -0300599 link = media_add_link(&source->links);
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300600 if (link == NULL)
601 return -ENOMEM;
602
603 link->source = &source->pads[source_pad];
604 link->sink = &sink->pads[sink_pad];
605 link->flags = flags;
606
Mauro Carvalho Chehab6b6a4272015-08-14 12:54:36 -0300607 /* Initialize graph object embedded at the new link */
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300608 media_gobj_init(source->graph_obj.mdev, MEDIA_GRAPH_LINK,
609 &link->graph_obj);
Mauro Carvalho Chehab6b6a4272015-08-14 12:54:36 -0300610
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300611 /* Create the backlink. Backlinks are used to help graph traversal and
612 * are not reported to userspace.
613 */
Mauro Carvalho Chehab23615de2015-08-20 08:21:35 -0300614 backlink = media_add_link(&sink->links);
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300615 if (backlink == NULL) {
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300616 __media_entity_remove_link(source, link);
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300617 return -ENOMEM;
618 }
619
620 backlink->source = &source->pads[source_pad];
621 backlink->sink = &sink->pads[sink_pad];
622 backlink->flags = flags;
623
Mauro Carvalho Chehab6b6a4272015-08-14 12:54:36 -0300624 /* Initialize graph object embedded at the new link */
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300625 media_gobj_init(sink->graph_obj.mdev, MEDIA_GRAPH_LINK,
626 &backlink->graph_obj);
Mauro Carvalho Chehab6b6a4272015-08-14 12:54:36 -0300627
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300628 link->reverse = backlink;
629 backlink->reverse = link;
630
631 sink->num_backlinks++;
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300632 sink->num_links++;
633 source->num_links++;
Laurent Pinchart53e269c2009-12-09 08:40:00 -0300634
635 return 0;
636}
Mauro Carvalho Chehab8df00a12015-08-07 08:14:38 -0300637EXPORT_SYMBOL_GPL(media_create_pad_link);
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300638
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300639static void __media_entity_remove_link(struct media_entity *entity,
640 struct media_link *link)
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300641{
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300642 struct media_link *rlink, *tmp;
643 struct media_entity *remote;
644 unsigned int r = 0;
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300645
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300646 if (link->source->entity == entity)
647 remote = link->sink->entity;
648 else
649 remote = link->source->entity;
650
651 list_for_each_entry_safe(rlink, tmp, &remote->links, list) {
652 if (rlink != link->reverse) {
653 r++;
654 continue;
655 }
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300656
657 if (link->source->entity == entity)
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300658 remote->num_backlinks--;
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300659
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300660 if (--remote->num_links == 0)
661 break;
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300662
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300663 /* Remove the remote link */
664 list_del(&rlink->list);
665 kfree(rlink);
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300666 }
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300667 list_del(&link->list);
668 kfree(link);
669}
670
671void __media_entity_remove_links(struct media_entity *entity)
672{
673 struct media_link *link, *tmp;
674
675 list_for_each_entry_safe(link, tmp, &entity->links, list)
676 __media_entity_remove_link(entity, link);
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300677
678 entity->num_links = 0;
679 entity->num_backlinks = 0;
680}
681EXPORT_SYMBOL_GPL(__media_entity_remove_links);
682
683void media_entity_remove_links(struct media_entity *entity)
684{
685 /* Do nothing if the entity is not registered. */
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300686 if (entity->graph_obj.mdev == NULL)
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300687 return;
688
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300689 mutex_lock(&entity->graph_obj.mdev->graph_mutex);
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300690 __media_entity_remove_links(entity);
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300691 mutex_unlock(&entity->graph_obj.mdev->graph_mutex);
Sylwester Nawrocki7349cec2013-05-09 08:29:32 -0300692}
693EXPORT_SYMBOL_GPL(media_entity_remove_links);
694
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300695static int __media_entity_setup_link_notify(struct media_link *link, u32 flags)
696{
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300697 int ret;
698
699 /* Notify both entities. */
700 ret = media_entity_call(link->source->entity, link_setup,
701 link->source, link->sink, flags);
702 if (ret < 0 && ret != -ENOIOCTLCMD)
703 return ret;
704
705 ret = media_entity_call(link->sink->entity, link_setup,
706 link->sink, link->source, flags);
707 if (ret < 0 && ret != -ENOIOCTLCMD) {
708 media_entity_call(link->source->entity, link_setup,
709 link->source, link->sink, link->flags);
710 return ret;
711 }
712
Laurent Pinchart7a6f0b22011-03-11 11:34:35 -0300713 link->flags = flags;
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300714 link->reverse->flags = link->flags;
715
716 return 0;
717}
718
719/**
720 * __media_entity_setup_link - Configure a media link
721 * @link: The link being configured
722 * @flags: Link configuration flags
723 *
724 * The bulk of link setup is handled by the two entities connected through the
725 * link. This function notifies both entities of the link configuration change.
726 *
727 * If the link is immutable or if the current and new configuration are
728 * identical, return immediately.
729 *
730 * The user is expected to hold link->source->parent->mutex. If not,
731 * media_entity_setup_link() should be used instead.
732 */
733int __media_entity_setup_link(struct media_link *link, u32 flags)
734{
Laurent Pinchart7a6f0b22011-03-11 11:34:35 -0300735 const u32 mask = MEDIA_LNK_FL_ENABLED;
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300736 struct media_device *mdev;
737 struct media_entity *source, *sink;
738 int ret = -EBUSY;
739
740 if (link == NULL)
741 return -EINVAL;
742
Laurent Pinchart7a6f0b22011-03-11 11:34:35 -0300743 /* The non-modifiable link flags must not be modified. */
744 if ((link->flags & ~mask) != (flags & ~mask))
745 return -EINVAL;
746
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300747 if (link->flags & MEDIA_LNK_FL_IMMUTABLE)
748 return link->flags == flags ? 0 : -EINVAL;
749
750 if (link->flags == flags)
751 return 0;
752
753 source = link->source->entity;
754 sink = link->sink->entity;
755
Laurent Pincharte02188c2010-08-25 09:00:41 -0300756 if (!(link->flags & MEDIA_LNK_FL_DYNAMIC) &&
757 (source->stream_count || sink->stream_count))
758 return -EBUSY;
759
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300760 mdev = source->graph_obj.mdev;
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300761
Sylwester Nawrocki813f5c02013-05-31 10:37:26 -0300762 if (mdev->link_notify) {
763 ret = mdev->link_notify(link, flags,
764 MEDIA_DEV_NOTIFY_PRE_LINK_CH);
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300765 if (ret < 0)
766 return ret;
767 }
768
769 ret = __media_entity_setup_link_notify(link, flags);
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300770
Sylwester Nawrocki813f5c02013-05-31 10:37:26 -0300771 if (mdev->link_notify)
772 mdev->link_notify(link, flags, MEDIA_DEV_NOTIFY_POST_LINK_CH);
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300773
774 return ret;
775}
776
777int media_entity_setup_link(struct media_link *link, u32 flags)
778{
779 int ret;
780
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300781 mutex_lock(&link->source->entity->graph_obj.mdev->graph_mutex);
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300782 ret = __media_entity_setup_link(link, flags);
Javier Martinez Canillasd10c9892015-08-19 12:35:21 -0300783 mutex_unlock(&link->source->entity->graph_obj.mdev->graph_mutex);
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300784
785 return ret;
786}
787EXPORT_SYMBOL_GPL(media_entity_setup_link);
788
789/**
790 * media_entity_find_link - Find a link between two pads
791 * @source: Source pad
792 * @sink: Sink pad
793 *
794 * Return a pointer to the link between the two entities. If no such link
795 * exists, return NULL.
796 */
797struct media_link *
798media_entity_find_link(struct media_pad *source, struct media_pad *sink)
799{
800 struct media_link *link;
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300801
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300802 list_for_each_entry(link, &source->entity->links, list) {
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300803 if (link->source->entity == source->entity &&
804 link->source->index == source->index &&
805 link->sink->entity == sink->entity &&
806 link->sink->index == sink->index)
807 return link;
808 }
809
810 return NULL;
811}
812EXPORT_SYMBOL_GPL(media_entity_find_link);
813
814/**
Andrzej Hajda1bddf1b2013-06-03 05:16:13 -0300815 * media_entity_remote_pad - Find the pad at the remote end of a link
816 * @pad: Pad at the local end of the link
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300817 *
Andrzej Hajda1bddf1b2013-06-03 05:16:13 -0300818 * Search for a remote pad connected to the given pad by iterating over all
819 * links originating or terminating at that pad until an enabled link is found.
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300820 *
821 * Return a pointer to the pad at the remote end of the first found enabled
822 * link, or NULL if no enabled link has been found.
823 */
Andrzej Hajda1bddf1b2013-06-03 05:16:13 -0300824struct media_pad *media_entity_remote_pad(struct media_pad *pad)
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300825{
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300826 struct media_link *link;
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300827
Mauro Carvalho Chehab57208e52015-08-07 06:55:40 -0300828 list_for_each_entry(link, &pad->entity->links, list) {
Laurent Pinchart97548ed2009-12-09 08:40:03 -0300829 if (!(link->flags & MEDIA_LNK_FL_ENABLED))
830 continue;
831
832 if (link->source == pad)
833 return link->sink;
834
835 if (link->sink == pad)
836 return link->source;
837 }
838
839 return NULL;
840
841}
Andrzej Hajda1bddf1b2013-06-03 05:16:13 -0300842EXPORT_SYMBOL_GPL(media_entity_remote_pad);
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300843
844
Mauro Carvalho Chehab1283f842015-08-28 15:43:36 -0300845static void media_interface_init(struct media_device *mdev,
846 struct media_interface *intf,
847 u32 gobj_type,
848 u32 intf_type, u32 flags)
849{
850 intf->type = intf_type;
851 intf->flags = flags;
852 INIT_LIST_HEAD(&intf->links);
853
854 media_gobj_init(mdev, gobj_type, &intf->graph_obj);
Mauro Carvalho Chehab57cf79b2015-08-21 09:23:22 -0300855
856 list_add_tail(&intf->list, &mdev->interfaces);
Mauro Carvalho Chehab1283f842015-08-28 15:43:36 -0300857}
858
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300859/* Functions related to the media interface via device nodes */
860
861struct media_intf_devnode *media_devnode_create(struct media_device *mdev,
862 u32 type, u32 flags,
863 u32 major, u32 minor,
864 gfp_t gfp_flags)
865{
866 struct media_intf_devnode *devnode;
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300867
868 devnode = kzalloc(sizeof(*devnode), gfp_flags);
869 if (!devnode)
870 return NULL;
871
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300872 devnode->major = major;
873 devnode->minor = minor;
874
Mauro Carvalho Chehab1283f842015-08-28 15:43:36 -0300875 media_interface_init(mdev, &devnode->intf, MEDIA_GRAPH_INTF_DEVNODE,
876 type, flags);
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300877
878 return devnode;
879}
880EXPORT_SYMBOL_GPL(media_devnode_create);
881
882void media_devnode_remove(struct media_intf_devnode *devnode)
883{
884 media_gobj_remove(&devnode->intf.graph_obj);
Mauro Carvalho Chehab57cf79b2015-08-21 09:23:22 -0300885 list_del(&devnode->intf.list);
Mauro Carvalho Chehab27e543f2015-08-20 09:07:34 -0300886 kfree(devnode);
887}
888EXPORT_SYMBOL_GPL(media_devnode_remove);
Mauro Carvalho Chehab86e26622015-08-07 10:36:25 -0300889
890struct media_link *media_create_intf_link(struct media_entity *entity,
891 struct media_interface *intf,
892 u32 flags)
893{
894 struct media_link *link;
895
896 link = media_add_link(&intf->links);
897 if (link == NULL)
898 return NULL;
899
900 link->intf = intf;
901 link->entity = entity;
902 link->flags = flags;
903
904 /* Initialize graph object embedded at the new link */
905 media_gobj_init(intf->graph_obj.mdev, MEDIA_GRAPH_LINK,
906 &link->graph_obj);
907
908 return link;
909}
910EXPORT_SYMBOL_GPL(media_create_intf_link);
911
912
913static void __media_remove_intf_link(struct media_link *link)
914{
915 media_gobj_remove(&link->graph_obj);
916 kfree(link);
917}
918
919void media_remove_intf_link(struct media_link *link)
920{
921 mutex_lock(&link->graph_obj.mdev->graph_mutex);
922 __media_remove_intf_link(link);
923 mutex_unlock(&link->graph_obj.mdev->graph_mutex);
924}
925EXPORT_SYMBOL_GPL(media_remove_intf_link);