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 | ||
5c7b25b9 | 23 | #include <linux/bitmap.h> |
53e269c1 LP |
24 | #include <linux/module.h> |
25 | #include <linux/slab.h> | |
26 | #include <media/media-entity.h> | |
503c3d82 | 27 | #include <media/media-device.h> |
53e269c1 | 28 | |
39a956c4 MCC |
29 | /** |
30 | * 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 | */ | |
38 | static 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"; | |
27e543fa MCC |
47 | case MEDIA_GRAPH_INTF_DEVNODE: |
48 | return "intf-devnode"; | |
39a956c4 MCC |
49 | default: |
50 | return "unknown"; | |
51 | } | |
52 | } | |
53 | ||
27e543fa MCC |
54 | static 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 | ||
39a956c4 MCC |
82 | static 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, | |
3c0e266f | 97 | "%s: id 0x%08x link#%d: %s#%d ==> %s#%d\n", |
39a956c4 MCC |
98 | event_name, gobj->id, media_localid(gobj), |
99 | ||
3c0e266f MCC |
100 | gobj_type(media_type(link->gobj0)), |
101 | media_localid(link->gobj0), | |
39a956c4 | 102 | |
3c0e266f MCC |
103 | gobj_type(media_type(link->gobj1)), |
104 | media_localid(link->gobj1)); | |
39a956c4 MCC |
105 | break; |
106 | } | |
107 | case MEDIA_GRAPH_PAD: | |
108 | { | |
109 | struct media_pad *pad = gobj_to_pad(gobj); | |
110 | ||
111 | dev_dbg(gobj->mdev->dev, | |
6c24d460 MCC |
112 | "%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), | |
39a956c4 | 117 | pad->entity->name, pad->index); |
27e543fa MCC |
118 | 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; | |
39a956c4 MCC |
131 | } |
132 | } | |
133 | #endif | |
134 | } | |
135 | ||
ec6e4c95 MCC |
136 | /** |
137 | * 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 | */ | |
149 | void media_gobj_init(struct media_device *mdev, | |
150 | enum media_gobj_type type, | |
151 | struct media_gobj *gobj) | |
152 | { | |
8f6d368f MCC |
153 | BUG_ON(!mdev); |
154 | ||
39a956c4 MCC |
155 | gobj->mdev = mdev; |
156 | ||
bfab2aac MCC |
157 | /* 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); | |
05bfa9fa | 161 | list_add_tail(&gobj->list, &mdev->entities); |
bfab2aac | 162 | break; |
18710dc6 MCC |
163 | case MEDIA_GRAPH_PAD: |
164 | gobj->id = media_gobj_gen_id(type, ++mdev->pad_id); | |
9155d859 | 165 | list_add_tail(&gobj->list, &mdev->pads); |
18710dc6 | 166 | break; |
6b6a4278 MCC |
167 | case MEDIA_GRAPH_LINK: |
168 | gobj->id = media_gobj_gen_id(type, ++mdev->link_id); | |
9155d859 | 169 | list_add_tail(&gobj->list, &mdev->links); |
6b6a4278 | 170 | break; |
27e543fa MCC |
171 | case MEDIA_GRAPH_INTF_DEVNODE: |
172 | gobj->id = media_gobj_gen_id(type, ++mdev->intf_devnode_id); | |
9155d859 | 173 | list_add_tail(&gobj->list, &mdev->interfaces); |
27e543fa | 174 | break; |
bfab2aac | 175 | } |
39a956c4 | 176 | dev_dbg_obj(__func__, gobj); |
ec6e4c95 MCC |
177 | } |
178 | ||
179 | /** | |
180 | * media_gobj_remove - Stop using a graph object on a media device | |
181 | * | |
182 | * @graph_obj: Pointer to the object | |
183 | * | |
184 | * This should be called at media_device_unregister_*() routines | |
185 | */ | |
186 | void media_gobj_remove(struct media_gobj *gobj) | |
187 | { | |
39a956c4 | 188 | dev_dbg_obj(__func__, gobj); |
9155d859 MCC |
189 | |
190 | /* Remove the object from mdev list */ | |
191 | list_del(&gobj->list); | |
ec6e4c95 MCC |
192 | } |
193 | ||
53e269c1 LP |
194 | /** |
195 | * media_entity_init - Initialize a media entity | |
196 | * | |
197 | * @num_pads: Total number of sink and source pads. | |
53e269c1 LP |
198 | * @pads: Array of 'num_pads' pads. |
199 | * | |
200 | * The total number of pads is an intrinsic property of entities known by the | |
201 | * entity driver, while the total number of links depends on hardware design | |
202 | * and is an extrinsic property unknown to the entity driver. However, in most | |
18095107 MCC |
203 | * use cases the number of links can safely be assumed to be equal to or |
204 | * larger than the number of pads. | |
53e269c1 | 205 | * |
18095107 MCC |
206 | * For those reasons the links array can be preallocated based on the number |
207 | * of pads and will be reallocated later if extra links need to be created. | |
53e269c1 LP |
208 | * |
209 | * This function allocates a links array with enough space to hold at least | |
18095107 MCC |
210 | * 'num_pads' elements. The media_entity::max_links field will be set to the |
211 | * number of allocated elements. | |
53e269c1 LP |
212 | * |
213 | * The pads array is managed by the entity driver and passed to | |
214 | * media_entity_init() where its pointer will be stored in the entity structure. | |
215 | */ | |
216 | int | |
217 | media_entity_init(struct media_entity *entity, u16 num_pads, | |
18095107 | 218 | struct media_pad *pads) |
53e269c1 | 219 | { |
53e269c1 LP |
220 | unsigned int i; |
221 | ||
53e269c1 | 222 | entity->group_id = 0; |
53e269c1 LP |
223 | entity->num_links = 0; |
224 | entity->num_backlinks = 0; | |
225 | entity->num_pads = num_pads; | |
226 | entity->pads = pads; | |
53e269c1 LP |
227 | |
228 | for (i = 0; i < num_pads; i++) { | |
229 | pads[i].entity = entity; | |
230 | pads[i].index = i; | |
231 | } | |
232 | ||
233 | return 0; | |
234 | } | |
235 | EXPORT_SYMBOL_GPL(media_entity_init); | |
236 | ||
237 | void | |
238 | media_entity_cleanup(struct media_entity *entity) | |
239 | { | |
57208e5e MCC |
240 | struct media_link *link, *tmp; |
241 | ||
242 | list_for_each_entry_safe(link, tmp, &entity->links, list) { | |
243 | media_gobj_remove(&link->graph_obj); | |
244 | list_del(&link->list); | |
245 | kfree(link); | |
246 | } | |
53e269c1 LP |
247 | } |
248 | EXPORT_SYMBOL_GPL(media_entity_cleanup); | |
249 | ||
a5ccc48a SA |
250 | /* ----------------------------------------------------------------------------- |
251 | * Graph traversal | |
252 | */ | |
253 | ||
254 | static struct media_entity * | |
255 | media_entity_other(struct media_entity *entity, struct media_link *link) | |
256 | { | |
257 | if (link->source->entity == entity) | |
258 | return link->sink->entity; | |
259 | else | |
260 | return link->source->entity; | |
261 | } | |
262 | ||
263 | /* push an entity to traversal stack */ | |
264 | static void stack_push(struct media_entity_graph *graph, | |
265 | struct media_entity *entity) | |
266 | { | |
267 | if (graph->top == MEDIA_ENTITY_ENUM_MAX_DEPTH - 1) { | |
268 | WARN_ON(1); | |
269 | return; | |
270 | } | |
271 | graph->top++; | |
57208e5e | 272 | graph->stack[graph->top].link = (&entity->links)->next; |
a5ccc48a SA |
273 | graph->stack[graph->top].entity = entity; |
274 | } | |
275 | ||
276 | static struct media_entity *stack_pop(struct media_entity_graph *graph) | |
277 | { | |
278 | struct media_entity *entity; | |
279 | ||
280 | entity = graph->stack[graph->top].entity; | |
281 | graph->top--; | |
282 | ||
283 | return entity; | |
284 | } | |
285 | ||
a5ccc48a SA |
286 | #define link_top(en) ((en)->stack[(en)->top].link) |
287 | #define stack_top(en) ((en)->stack[(en)->top].entity) | |
288 | ||
289 | /** | |
290 | * media_entity_graph_walk_start - Start walking the media graph at a given entity | |
291 | * @graph: Media graph structure that will be used to walk the graph | |
292 | * @entity: Starting entity | |
293 | * | |
294 | * This function initializes the graph traversal structure to walk the entities | |
295 | * graph starting at the given entity. The traversal structure must not be | |
296 | * modified by the caller during graph traversal. When done the structure can | |
297 | * safely be freed. | |
298 | */ | |
299 | void media_entity_graph_walk_start(struct media_entity_graph *graph, | |
300 | struct media_entity *entity) | |
301 | { | |
302 | graph->top = 0; | |
303 | graph->stack[graph->top].entity = NULL; | |
5c7b25b9 LP |
304 | bitmap_zero(graph->entities, MEDIA_ENTITY_ENUM_MAX_ID); |
305 | ||
fa762394 | 306 | if (WARN_ON(media_entity_id(entity) >= MEDIA_ENTITY_ENUM_MAX_ID)) |
5c7b25b9 LP |
307 | return; |
308 | ||
fa762394 | 309 | __set_bit(media_entity_id(entity), graph->entities); |
a5ccc48a SA |
310 | stack_push(graph, entity); |
311 | } | |
312 | EXPORT_SYMBOL_GPL(media_entity_graph_walk_start); | |
313 | ||
57208e5e | 314 | |
a5ccc48a SA |
315 | /** |
316 | * media_entity_graph_walk_next - Get the next entity in the graph | |
317 | * @graph: Media graph structure | |
318 | * | |
319 | * Perform a depth-first traversal of the given media entities graph. | |
320 | * | |
321 | * The graph structure must have been previously initialized with a call to | |
322 | * media_entity_graph_walk_start(). | |
323 | * | |
324 | * Return the next entity in the graph or NULL if the whole graph have been | |
325 | * traversed. | |
326 | */ | |
327 | struct media_entity * | |
328 | media_entity_graph_walk_next(struct media_entity_graph *graph) | |
329 | { | |
330 | if (stack_top(graph) == NULL) | |
331 | return NULL; | |
332 | ||
333 | /* | |
334 | * Depth first search. Push entity to stack and continue from | |
335 | * top of the stack until no more entities on the level can be | |
336 | * found. | |
337 | */ | |
57208e5e | 338 | while (link_top(graph) != &(stack_top(graph)->links)) { |
a5ccc48a | 339 | struct media_entity *entity = stack_top(graph); |
57208e5e | 340 | struct media_link *link; |
a5ccc48a SA |
341 | struct media_entity *next; |
342 | ||
57208e5e MCC |
343 | link = list_entry(link_top(graph), typeof(*link), list); |
344 | ||
a5ccc48a SA |
345 | /* The link is not enabled so we do not follow. */ |
346 | if (!(link->flags & MEDIA_LNK_FL_ENABLED)) { | |
57208e5e | 347 | link_top(graph) = link_top(graph)->next; |
a5ccc48a SA |
348 | continue; |
349 | } | |
350 | ||
351 | /* Get the entity in the other end of the link . */ | |
352 | next = media_entity_other(entity, link); | |
fa762394 | 353 | if (WARN_ON(media_entity_id(next) >= MEDIA_ENTITY_ENUM_MAX_ID)) |
5c7b25b9 | 354 | return NULL; |
a5ccc48a | 355 | |
5c7b25b9 | 356 | /* Has the entity already been visited? */ |
fa762394 | 357 | if (__test_and_set_bit(media_entity_id(next), graph->entities)) { |
57208e5e | 358 | link_top(graph) = link_top(graph)->next; |
a5ccc48a SA |
359 | continue; |
360 | } | |
361 | ||
362 | /* Push the new entity to stack and start over. */ | |
57208e5e | 363 | link_top(graph) = link_top(graph)->next; |
a5ccc48a SA |
364 | stack_push(graph, next); |
365 | } | |
366 | ||
367 | return stack_pop(graph); | |
368 | } | |
369 | EXPORT_SYMBOL_GPL(media_entity_graph_walk_next); | |
370 | ||
e02188c9 LP |
371 | /* ----------------------------------------------------------------------------- |
372 | * Pipeline management | |
373 | */ | |
374 | ||
375 | /** | |
376 | * media_entity_pipeline_start - Mark a pipeline as streaming | |
377 | * @entity: Starting entity | |
378 | * @pipe: Media pipeline to be assigned to all entities in the pipeline. | |
379 | * | |
380 | * Mark all entities connected to a given entity through enabled links, either | |
381 | * directly or indirectly, as streaming. The given pipeline object is assigned to | |
382 | * every entity in the pipeline and stored in the media_entity pipe field. | |
383 | * | |
384 | * Calls to this function can be nested, in which case the same number of | |
385 | * media_entity_pipeline_stop() calls will be required to stop streaming. The | |
386 | * pipeline pointer must be identical for all nested calls to | |
387 | * media_entity_pipeline_start(). | |
388 | */ | |
af88be38 SA |
389 | __must_check int media_entity_pipeline_start(struct media_entity *entity, |
390 | struct media_pipeline *pipe) | |
e02188c9 | 391 | { |
d10c9894 | 392 | struct media_device *mdev = entity->graph_obj.mdev; |
e02188c9 | 393 | struct media_entity_graph graph; |
af88be38 | 394 | struct media_entity *entity_err = entity; |
57208e5e | 395 | struct media_link *link; |
af88be38 | 396 | int ret; |
e02188c9 LP |
397 | |
398 | mutex_lock(&mdev->graph_mutex); | |
399 | ||
400 | media_entity_graph_walk_start(&graph, entity); | |
401 | ||
402 | while ((entity = media_entity_graph_walk_next(&graph))) { | |
ef69ee1b MCC |
403 | DECLARE_BITMAP(active, MEDIA_ENTITY_MAX_PADS); |
404 | DECLARE_BITMAP(has_no_links, MEDIA_ENTITY_MAX_PADS); | |
af88be38 | 405 | |
e02188c9 LP |
406 | entity->stream_count++; |
407 | WARN_ON(entity->pipe && entity->pipe != pipe); | |
408 | entity->pipe = pipe; | |
af88be38 SA |
409 | |
410 | /* Already streaming --- no need to check. */ | |
411 | if (entity->stream_count > 1) | |
412 | continue; | |
413 | ||
414 | if (!entity->ops || !entity->ops->link_validate) | |
415 | continue; | |
416 | ||
de49c285 SA |
417 | bitmap_zero(active, entity->num_pads); |
418 | bitmap_fill(has_no_links, entity->num_pads); | |
419 | ||
57208e5e | 420 | list_for_each_entry(link, &entity->links, list) { |
de49c285 SA |
421 | struct media_pad *pad = link->sink->entity == entity |
422 | ? link->sink : link->source; | |
423 | ||
424 | /* Mark that a pad is connected by a link. */ | |
425 | bitmap_clear(has_no_links, pad->index, 1); | |
426 | ||
427 | /* | |
428 | * Pads that either do not need to connect or | |
429 | * are connected through an enabled link are | |
430 | * fine. | |
431 | */ | |
432 | if (!(pad->flags & MEDIA_PAD_FL_MUST_CONNECT) || | |
433 | link->flags & MEDIA_LNK_FL_ENABLED) | |
434 | bitmap_set(active, pad->index, 1); | |
435 | ||
436 | /* | |
437 | * Link validation will only take place for | |
438 | * sink ends of the link that are enabled. | |
439 | */ | |
440 | if (link->sink != pad || | |
441 | !(link->flags & MEDIA_LNK_FL_ENABLED)) | |
af88be38 SA |
442 | continue; |
443 | ||
444 | ret = entity->ops->link_validate(link); | |
fab9d30b | 445 | if (ret < 0 && ret != -ENOIOCTLCMD) { |
d10c9894 | 446 | dev_dbg(entity->graph_obj.mdev->dev, |
fab9d30b | 447 | "link validation failed for \"%s\":%u -> \"%s\":%u, error %d\n", |
823ea2a6 SA |
448 | link->source->entity->name, |
449 | link->source->index, | |
450 | entity->name, link->sink->index, ret); | |
af88be38 | 451 | goto error; |
fab9d30b | 452 | } |
af88be38 | 453 | } |
de49c285 SA |
454 | |
455 | /* Either no links or validated links are fine. */ | |
456 | bitmap_or(active, active, has_no_links, entity->num_pads); | |
457 | ||
458 | if (!bitmap_full(active, entity->num_pads)) { | |
459 | ret = -EPIPE; | |
d10c9894 | 460 | dev_dbg(entity->graph_obj.mdev->dev, |
fab9d30b SA |
461 | "\"%s\":%u must be connected by an enabled link\n", |
462 | entity->name, | |
094f1ca5 SA |
463 | (unsigned)find_first_zero_bit( |
464 | active, entity->num_pads)); | |
de49c285 SA |
465 | goto error; |
466 | } | |
e02188c9 LP |
467 | } |
468 | ||
469 | mutex_unlock(&mdev->graph_mutex); | |
af88be38 SA |
470 | |
471 | return 0; | |
472 | ||
473 | error: | |
474 | /* | |
475 | * Link validation on graph failed. We revert what we did and | |
476 | * return the error. | |
477 | */ | |
478 | media_entity_graph_walk_start(&graph, entity_err); | |
479 | ||
480 | while ((entity_err = media_entity_graph_walk_next(&graph))) { | |
481 | entity_err->stream_count--; | |
482 | if (entity_err->stream_count == 0) | |
483 | entity_err->pipe = NULL; | |
484 | ||
485 | /* | |
486 | * We haven't increased stream_count further than this | |
487 | * so we quit here. | |
488 | */ | |
489 | if (entity_err == entity) | |
490 | break; | |
491 | } | |
492 | ||
493 | mutex_unlock(&mdev->graph_mutex); | |
494 | ||
495 | return ret; | |
e02188c9 LP |
496 | } |
497 | EXPORT_SYMBOL_GPL(media_entity_pipeline_start); | |
498 | ||
499 | /** | |
500 | * media_entity_pipeline_stop - Mark a pipeline as not streaming | |
501 | * @entity: Starting entity | |
502 | * | |
503 | * Mark all entities connected to a given entity through enabled links, either | |
504 | * directly or indirectly, as not streaming. The media_entity pipe field is | |
505 | * reset to NULL. | |
506 | * | |
507 | * If multiple calls to media_entity_pipeline_start() have been made, the same | |
508 | * number of calls to this function are required to mark the pipeline as not | |
509 | * streaming. | |
510 | */ | |
511 | void media_entity_pipeline_stop(struct media_entity *entity) | |
512 | { | |
d10c9894 | 513 | struct media_device *mdev = entity->graph_obj.mdev; |
e02188c9 LP |
514 | struct media_entity_graph graph; |
515 | ||
516 | mutex_lock(&mdev->graph_mutex); | |
517 | ||
518 | media_entity_graph_walk_start(&graph, entity); | |
519 | ||
520 | while ((entity = media_entity_graph_walk_next(&graph))) { | |
521 | entity->stream_count--; | |
522 | if (entity->stream_count == 0) | |
523 | entity->pipe = NULL; | |
524 | } | |
525 | ||
526 | mutex_unlock(&mdev->graph_mutex); | |
527 | } | |
528 | EXPORT_SYMBOL_GPL(media_entity_pipeline_stop); | |
529 | ||
503c3d82 LP |
530 | /* ----------------------------------------------------------------------------- |
531 | * Module use count | |
532 | */ | |
533 | ||
534 | /* | |
535 | * media_entity_get - Get a reference to the parent module | |
536 | * @entity: The entity | |
537 | * | |
538 | * Get a reference to the parent media device module. | |
539 | * | |
540 | * The function will return immediately if @entity is NULL. | |
541 | * | |
542 | * Return a pointer to the entity on success or NULL on failure. | |
543 | */ | |
544 | struct media_entity *media_entity_get(struct media_entity *entity) | |
545 | { | |
546 | if (entity == NULL) | |
547 | return NULL; | |
548 | ||
d10c9894 JMC |
549 | if (entity->graph_obj.mdev->dev && |
550 | !try_module_get(entity->graph_obj.mdev->dev->driver->owner)) | |
503c3d82 LP |
551 | return NULL; |
552 | ||
553 | return entity; | |
554 | } | |
555 | EXPORT_SYMBOL_GPL(media_entity_get); | |
556 | ||
557 | /* | |
558 | * media_entity_put - Release the reference to the parent module | |
559 | * @entity: The entity | |
560 | * | |
561 | * Release the reference count acquired by media_entity_get(). | |
562 | * | |
563 | * The function will return immediately if @entity is NULL. | |
564 | */ | |
565 | void media_entity_put(struct media_entity *entity) | |
566 | { | |
567 | if (entity == NULL) | |
568 | return; | |
569 | ||
d10c9894 JMC |
570 | if (entity->graph_obj.mdev->dev) |
571 | module_put(entity->graph_obj.mdev->dev->driver->owner); | |
503c3d82 LP |
572 | } |
573 | EXPORT_SYMBOL_GPL(media_entity_put); | |
574 | ||
a5ccc48a SA |
575 | /* ----------------------------------------------------------------------------- |
576 | * Links management | |
577 | */ | |
578 | ||
23615de5 | 579 | static struct media_link *media_add_link(struct list_head *head) |
53e269c1 | 580 | { |
57208e5e | 581 | struct media_link *link; |
53e269c1 | 582 | |
57208e5e MCC |
583 | link = kzalloc(sizeof(*link), GFP_KERNEL); |
584 | if (link == NULL) | |
585 | return NULL; | |
53e269c1 | 586 | |
23615de5 | 587 | list_add_tail(&link->list, head); |
53e269c1 | 588 | |
57208e5e | 589 | return link; |
53e269c1 LP |
590 | } |
591 | ||
57208e5e MCC |
592 | static void __media_entity_remove_link(struct media_entity *entity, |
593 | struct media_link *link); | |
594 | ||
53e269c1 | 595 | int |
8df00a15 | 596 | media_create_pad_link(struct media_entity *source, u16 source_pad, |
53e269c1 LP |
597 | struct media_entity *sink, u16 sink_pad, u32 flags) |
598 | { | |
599 | struct media_link *link; | |
600 | struct media_link *backlink; | |
601 | ||
602 | BUG_ON(source == NULL || sink == NULL); | |
603 | BUG_ON(source_pad >= source->num_pads); | |
604 | BUG_ON(sink_pad >= sink->num_pads); | |
605 | ||
23615de5 | 606 | link = media_add_link(&source->links); |
53e269c1 LP |
607 | if (link == NULL) |
608 | return -ENOMEM; | |
609 | ||
610 | link->source = &source->pads[source_pad]; | |
611 | link->sink = &sink->pads[sink_pad]; | |
612 | link->flags = flags; | |
613 | ||
6b6a4278 | 614 | /* Initialize graph object embedded at the new link */ |
d10c9894 JMC |
615 | media_gobj_init(source->graph_obj.mdev, MEDIA_GRAPH_LINK, |
616 | &link->graph_obj); | |
6b6a4278 | 617 | |
53e269c1 LP |
618 | /* Create the backlink. Backlinks are used to help graph traversal and |
619 | * are not reported to userspace. | |
620 | */ | |
23615de5 | 621 | backlink = media_add_link(&sink->links); |
53e269c1 | 622 | if (backlink == NULL) { |
57208e5e | 623 | __media_entity_remove_link(source, link); |
53e269c1 LP |
624 | return -ENOMEM; |
625 | } | |
626 | ||
627 | backlink->source = &source->pads[source_pad]; | |
628 | backlink->sink = &sink->pads[sink_pad]; | |
629 | backlink->flags = flags; | |
630 | ||
6b6a4278 | 631 | /* Initialize graph object embedded at the new link */ |
d10c9894 JMC |
632 | media_gobj_init(sink->graph_obj.mdev, MEDIA_GRAPH_LINK, |
633 | &backlink->graph_obj); | |
6b6a4278 | 634 | |
53e269c1 LP |
635 | link->reverse = backlink; |
636 | backlink->reverse = link; | |
637 | ||
638 | sink->num_backlinks++; | |
57208e5e MCC |
639 | sink->num_links++; |
640 | source->num_links++; | |
53e269c1 LP |
641 | |
642 | return 0; | |
643 | } | |
8df00a15 | 644 | EXPORT_SYMBOL_GPL(media_create_pad_link); |
97548ed4 | 645 | |
57208e5e MCC |
646 | static void __media_entity_remove_link(struct media_entity *entity, |
647 | struct media_link *link) | |
7349cec1 | 648 | { |
57208e5e MCC |
649 | struct media_link *rlink, *tmp; |
650 | struct media_entity *remote; | |
651 | unsigned int r = 0; | |
652 | ||
653 | if (link->source->entity == entity) | |
654 | remote = link->sink->entity; | |
655 | else | |
656 | remote = link->source->entity; | |
7349cec1 | 657 | |
57208e5e MCC |
658 | list_for_each_entry_safe(rlink, tmp, &remote->links, list) { |
659 | if (rlink != link->reverse) { | |
660 | r++; | |
661 | continue; | |
662 | } | |
7349cec1 SN |
663 | |
664 | if (link->source->entity == entity) | |
57208e5e | 665 | remote->num_backlinks--; |
7349cec1 | 666 | |
57208e5e MCC |
667 | if (--remote->num_links == 0) |
668 | break; | |
7349cec1 | 669 | |
57208e5e MCC |
670 | /* Remove the remote link */ |
671 | list_del(&rlink->list); | |
672 | kfree(rlink); | |
673 | } | |
674 | list_del(&link->list); | |
675 | kfree(link); | |
676 | } | |
7349cec1 | 677 | |
57208e5e MCC |
678 | void __media_entity_remove_links(struct media_entity *entity) |
679 | { | |
680 | struct media_link *link, *tmp; | |
7349cec1 | 681 | |
57208e5e MCC |
682 | list_for_each_entry_safe(link, tmp, &entity->links, list) |
683 | __media_entity_remove_link(entity, link); | |
7349cec1 SN |
684 | |
685 | entity->num_links = 0; | |
686 | entity->num_backlinks = 0; | |
687 | } | |
688 | EXPORT_SYMBOL_GPL(__media_entity_remove_links); | |
689 | ||
690 | void media_entity_remove_links(struct media_entity *entity) | |
691 | { | |
692 | /* Do nothing if the entity is not registered. */ | |
d10c9894 | 693 | if (entity->graph_obj.mdev == NULL) |
7349cec1 SN |
694 | return; |
695 | ||
d10c9894 | 696 | mutex_lock(&entity->graph_obj.mdev->graph_mutex); |
7349cec1 | 697 | __media_entity_remove_links(entity); |
d10c9894 | 698 | mutex_unlock(&entity->graph_obj.mdev->graph_mutex); |
7349cec1 SN |
699 | } |
700 | EXPORT_SYMBOL_GPL(media_entity_remove_links); | |
701 | ||
97548ed4 LP |
702 | static int __media_entity_setup_link_notify(struct media_link *link, u32 flags) |
703 | { | |
97548ed4 LP |
704 | int ret; |
705 | ||
706 | /* Notify both entities. */ | |
707 | ret = media_entity_call(link->source->entity, link_setup, | |
708 | link->source, link->sink, flags); | |
709 | if (ret < 0 && ret != -ENOIOCTLCMD) | |
710 | return ret; | |
711 | ||
712 | ret = media_entity_call(link->sink->entity, link_setup, | |
713 | link->sink, link->source, flags); | |
714 | if (ret < 0 && ret != -ENOIOCTLCMD) { | |
715 | media_entity_call(link->source->entity, link_setup, | |
716 | link->source, link->sink, link->flags); | |
717 | return ret; | |
718 | } | |
719 | ||
7a6f0b22 | 720 | link->flags = flags; |
97548ed4 LP |
721 | link->reverse->flags = link->flags; |
722 | ||
723 | return 0; | |
724 | } | |
725 | ||
726 | /** | |
727 | * __media_entity_setup_link - Configure a media link | |
728 | * @link: The link being configured | |
729 | * @flags: Link configuration flags | |
730 | * | |
731 | * The bulk of link setup is handled by the two entities connected through the | |
732 | * link. This function notifies both entities of the link configuration change. | |
733 | * | |
734 | * If the link is immutable or if the current and new configuration are | |
735 | * identical, return immediately. | |
736 | * | |
737 | * The user is expected to hold link->source->parent->mutex. If not, | |
738 | * media_entity_setup_link() should be used instead. | |
739 | */ | |
740 | int __media_entity_setup_link(struct media_link *link, u32 flags) | |
741 | { | |
7a6f0b22 | 742 | const u32 mask = MEDIA_LNK_FL_ENABLED; |
97548ed4 LP |
743 | struct media_device *mdev; |
744 | struct media_entity *source, *sink; | |
745 | int ret = -EBUSY; | |
746 | ||
747 | if (link == NULL) | |
748 | return -EINVAL; | |
749 | ||
7a6f0b22 LP |
750 | /* The non-modifiable link flags must not be modified. */ |
751 | if ((link->flags & ~mask) != (flags & ~mask)) | |
752 | return -EINVAL; | |
753 | ||
97548ed4 LP |
754 | if (link->flags & MEDIA_LNK_FL_IMMUTABLE) |
755 | return link->flags == flags ? 0 : -EINVAL; | |
756 | ||
757 | if (link->flags == flags) | |
758 | return 0; | |
759 | ||
760 | source = link->source->entity; | |
761 | sink = link->sink->entity; | |
762 | ||
e02188c9 LP |
763 | if (!(link->flags & MEDIA_LNK_FL_DYNAMIC) && |
764 | (source->stream_count || sink->stream_count)) | |
765 | return -EBUSY; | |
766 | ||
d10c9894 | 767 | mdev = source->graph_obj.mdev; |
97548ed4 | 768 | |
813f5c0a SN |
769 | if (mdev->link_notify) { |
770 | ret = mdev->link_notify(link, flags, | |
771 | MEDIA_DEV_NOTIFY_PRE_LINK_CH); | |
97548ed4 LP |
772 | if (ret < 0) |
773 | return ret; | |
774 | } | |
775 | ||
776 | ret = __media_entity_setup_link_notify(link, flags); | |
97548ed4 | 777 | |
813f5c0a SN |
778 | if (mdev->link_notify) |
779 | mdev->link_notify(link, flags, MEDIA_DEV_NOTIFY_POST_LINK_CH); | |
97548ed4 LP |
780 | |
781 | return ret; | |
782 | } | |
783 | ||
784 | int media_entity_setup_link(struct media_link *link, u32 flags) | |
785 | { | |
786 | int ret; | |
787 | ||
d10c9894 | 788 | mutex_lock(&link->source->entity->graph_obj.mdev->graph_mutex); |
97548ed4 | 789 | ret = __media_entity_setup_link(link, flags); |
d10c9894 | 790 | mutex_unlock(&link->source->entity->graph_obj.mdev->graph_mutex); |
97548ed4 LP |
791 | |
792 | return ret; | |
793 | } | |
794 | EXPORT_SYMBOL_GPL(media_entity_setup_link); | |
795 | ||
796 | /** | |
797 | * media_entity_find_link - Find a link between two pads | |
798 | * @source: Source pad | |
799 | * @sink: Sink pad | |
800 | * | |
801 | * Return a pointer to the link between the two entities. If no such link | |
802 | * exists, return NULL. | |
803 | */ | |
804 | struct media_link * | |
805 | media_entity_find_link(struct media_pad *source, struct media_pad *sink) | |
806 | { | |
807 | struct media_link *link; | |
97548ed4 | 808 | |
57208e5e | 809 | list_for_each_entry(link, &source->entity->links, list) { |
97548ed4 LP |
810 | if (link->source->entity == source->entity && |
811 | link->source->index == source->index && | |
812 | link->sink->entity == sink->entity && | |
813 | link->sink->index == sink->index) | |
814 | return link; | |
815 | } | |
816 | ||
817 | return NULL; | |
818 | } | |
819 | EXPORT_SYMBOL_GPL(media_entity_find_link); | |
820 | ||
821 | /** | |
1bddf1b3 AH |
822 | * media_entity_remote_pad - Find the pad at the remote end of a link |
823 | * @pad: Pad at the local end of the link | |
97548ed4 | 824 | * |
1bddf1b3 AH |
825 | * Search for a remote pad connected to the given pad by iterating over all |
826 | * links originating or terminating at that pad until an enabled link is found. | |
97548ed4 LP |
827 | * |
828 | * Return a pointer to the pad at the remote end of the first found enabled | |
829 | * link, or NULL if no enabled link has been found. | |
830 | */ | |
1bddf1b3 | 831 | struct media_pad *media_entity_remote_pad(struct media_pad *pad) |
97548ed4 | 832 | { |
57208e5e | 833 | struct media_link *link; |
97548ed4 | 834 | |
57208e5e | 835 | list_for_each_entry(link, &pad->entity->links, list) { |
97548ed4 LP |
836 | if (!(link->flags & MEDIA_LNK_FL_ENABLED)) |
837 | continue; | |
838 | ||
839 | if (link->source == pad) | |
840 | return link->sink; | |
841 | ||
842 | if (link->sink == pad) | |
843 | return link->source; | |
844 | } | |
845 | ||
846 | return NULL; | |
847 | ||
848 | } | |
1bddf1b3 | 849 | EXPORT_SYMBOL_GPL(media_entity_remote_pad); |
27e543fa MCC |
850 | |
851 | ||
1283f849 MCC |
852 | static void media_interface_init(struct media_device *mdev, |
853 | struct media_interface *intf, | |
854 | u32 gobj_type, | |
855 | u32 intf_type, u32 flags) | |
856 | { | |
857 | intf->type = intf_type; | |
858 | intf->flags = flags; | |
859 | INIT_LIST_HEAD(&intf->links); | |
860 | ||
861 | media_gobj_init(mdev, gobj_type, &intf->graph_obj); | |
862 | } | |
863 | ||
27e543fa MCC |
864 | /* Functions related to the media interface via device nodes */ |
865 | ||
866 | struct media_intf_devnode *media_devnode_create(struct media_device *mdev, | |
867 | u32 type, u32 flags, | |
868 | u32 major, u32 minor, | |
869 | gfp_t gfp_flags) | |
870 | { | |
871 | struct media_intf_devnode *devnode; | |
27e543fa MCC |
872 | |
873 | devnode = kzalloc(sizeof(*devnode), gfp_flags); | |
874 | if (!devnode) | |
875 | return NULL; | |
876 | ||
27e543fa MCC |
877 | devnode->major = major; |
878 | devnode->minor = minor; | |
879 | ||
1283f849 MCC |
880 | media_interface_init(mdev, &devnode->intf, MEDIA_GRAPH_INTF_DEVNODE, |
881 | type, flags); | |
27e543fa MCC |
882 | |
883 | return devnode; | |
884 | } | |
885 | EXPORT_SYMBOL_GPL(media_devnode_create); | |
886 | ||
887 | void media_devnode_remove(struct media_intf_devnode *devnode) | |
888 | { | |
889 | media_gobj_remove(&devnode->intf.graph_obj); | |
890 | kfree(devnode); | |
891 | } | |
892 | EXPORT_SYMBOL_GPL(media_devnode_remove); | |
86e26620 MCC |
893 | |
894 | struct media_link *media_create_intf_link(struct media_entity *entity, | |
895 | struct media_interface *intf, | |
896 | u32 flags) | |
897 | { | |
898 | struct media_link *link; | |
899 | ||
900 | link = media_add_link(&intf->links); | |
901 | if (link == NULL) | |
902 | return NULL; | |
903 | ||
904 | link->intf = intf; | |
905 | link->entity = entity; | |
906 | link->flags = flags; | |
907 | ||
908 | /* Initialize graph object embedded at the new link */ | |
909 | media_gobj_init(intf->graph_obj.mdev, MEDIA_GRAPH_LINK, | |
910 | &link->graph_obj); | |
911 | ||
912 | return link; | |
913 | } | |
914 | EXPORT_SYMBOL_GPL(media_create_intf_link); | |
915 | ||
916 | ||
917 | static void __media_remove_intf_link(struct media_link *link) | |
918 | { | |
919 | media_gobj_remove(&link->graph_obj); | |
920 | kfree(link); | |
921 | } | |
922 | ||
923 | void media_remove_intf_link(struct media_link *link) | |
924 | { | |
925 | mutex_lock(&link->graph_obj.mdev->graph_mutex); | |
926 | __media_remove_intf_link(link); | |
927 | mutex_unlock(&link->graph_obj.mdev->graph_mutex); | |
928 | } | |
929 | EXPORT_SYMBOL_GPL(media_remove_intf_link); |