Blame view
include/media/media-entity.h
33.5 KB
53e269c10 [media] media: En... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
/* * 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 |
c8d54cd53 [media] media: Ad... |
25 |
#include <linux/bitmap.h> |
2899d35dc [media] media-ent... |
26 |
#include <linux/bug.h> |
0149a2e14 [media] media: In... |
27 |
#include <linux/kernel.h> |
53e269c10 [media] media: En... |
28 |
#include <linux/list.h> |
1651333b0 [media] media: En... |
29 |
#include <linux/media.h> |
53e269c10 [media] media: En... |
30 |
|
ec6e4c950 [media] media: ad... |
31 32 33 34 35 |
/* Enums used internally at the media controller to represent graphs */ /** * enum media_gobj_type - type of a graph object * |
bfab2aacc [media] media: us... |
36 |
* @MEDIA_GRAPH_ENTITY: Identify a media entity |
18710dc67 [media] media: us... |
37 |
* @MEDIA_GRAPH_PAD: Identify a media pad |
6b6a42780 [media] media: us... |
38 |
* @MEDIA_GRAPH_LINK: Identify a media link |
27e543fa8 [media] media: ad... |
39 40 |
* @MEDIA_GRAPH_INTF_DEVNODE: Identify a media Kernel API interface via * a device node |
ec6e4c950 [media] media: ad... |
41 42 |
*/ enum media_gobj_type { |
bfab2aacc [media] media: us... |
43 |
MEDIA_GRAPH_ENTITY, |
18710dc67 [media] media: us... |
44 |
MEDIA_GRAPH_PAD, |
6b6a42780 [media] media: us... |
45 |
MEDIA_GRAPH_LINK, |
27e543fa8 [media] media: ad... |
46 |
MEDIA_GRAPH_INTF_DEVNODE, |
ec6e4c950 [media] media: ad... |
47 48 49 |
}; #define MEDIA_BITS_PER_TYPE 8 |
05b3b77cb [media] media-dev... |
50 51 |
#define MEDIA_BITS_PER_ID (32 - MEDIA_BITS_PER_TYPE) #define MEDIA_ID_MASK GENMASK_ULL(MEDIA_BITS_PER_ID - 1, 0) |
ec6e4c950 [media] media: ad... |
52 53 54 55 56 57 |
/* Structs to represent the objects that belong to a media graph */ /** * struct media_gobj - Define a graph object. * |
48a7c4bac [media] docs-rst:... |
58 |
* @mdev: Pointer to the struct &media_device that owns the object |
ec6e4c950 [media] media: ad... |
59 60 |
* @id: Non-zero object ID identifier. The ID should be unique * inside a media_device, as it is composed by |
05b3b77cb [media] media-dev... |
61 62 |
* %MEDIA_BITS_PER_TYPE to store the type plus * %MEDIA_BITS_PER_ID to store the ID |
c358e80d7 [media] media-ent... |
63 |
* @list: List entry stored in one of the per-type mdev object lists |
ec6e4c950 [media] media: ad... |
64 65 66 67 |
* * All objects on the media graph should have this struct embedded */ struct media_gobj { |
39a956c41 [media] media: ad... |
68 |
struct media_device *mdev; |
ec6e4c950 [media] media: ad... |
69 |
u32 id; |
05bfa9fa1 [media] media: mo... |
70 |
struct list_head list; |
ec6e4c950 [media] media: ad... |
71 |
}; |
c8d54cd53 [media] media: Ad... |
72 |
#define MEDIA_ENTITY_ENUM_MAX_DEPTH 16 |
c8d54cd53 [media] media: Ad... |
73 |
|
c8d54cd53 [media] media: Ad... |
74 75 76 |
/** * struct media_entity_enum - An enumeration of media entities. * |
c8d54cd53 [media] media: Ad... |
77 78 79 80 81 |
* @bmap: Bit map in which each bit represents one entity at struct * media_entity->internal_idx. * @idx_max: Number of bits in bmap */ struct media_entity_enum { |
c8d54cd53 [media] media: Ad... |
82 83 84 |
unsigned long *bmap; int idx_max; }; |
434257f19 [media] media: Ad... |
85 86 87 88 89 90 |
/** * struct media_entity_graph - Media graph traversal state * * @stack: Graph traversal stack; the stack contains information * on the path the media entities to be walked and the * links through which they were reached. |
29d8da02d [media] media: Us... |
91 |
* @ent_enum: Visited entities |
434257f19 [media] media: Ad... |
92 93 |
* @top: The top of the stack */ |
82c682905 [media] media: Mo... |
94 95 96 97 98 |
struct media_entity_graph { struct { struct media_entity *entity; struct list_head *link; } stack[MEDIA_ENTITY_ENUM_MAX_DEPTH]; |
29d8da02d [media] media: Us... |
99 |
struct media_entity_enum ent_enum; |
82c682905 [media] media: Mo... |
100 101 |
int top; }; |
74604b739 [media] doc-rst: ... |
102 |
/** |
5dd8775dc [media] media: Mo... |
103 104 |
* struct media_pipeline - Media pipeline related information * |
74a413307 [media] media: Ke... |
105 106 |
* @streaming_count: Streaming start count - streaming stop count * @graph: Media graph walk during pipeline start / stop |
5dd8775dc [media] media: Mo... |
107 |
*/ |
e02188c90 [media] media: Pi... |
108 |
struct media_pipeline { |
74a413307 [media] media: Ke... |
109 |
int streaming_count; |
5dd8775dc [media] media: Mo... |
110 |
struct media_entity_graph graph; |
e02188c90 [media] media: Pi... |
111 |
}; |
c358e80d7 [media] media-ent... |
112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
/** * struct media_link - A link object part of a media graph. * * @graph_obj: Embedded structure containing the media object common data * @list: Linked list associated with an entity or an interface that * owns the link. * @gobj0: Part of a union. Used to get the pointer for the first * graph_object of the link. * @source: Part of a union. Used only if the first object (gobj0) is * a pad. In that case, it represents the source pad. * @intf: Part of a union. Used only if the first object (gobj0) is * an interface. * @gobj1: Part of a union. Used to get the pointer for the second * graph_object of the link. |
e383ce073 [media] get rid o... |
126 |
* @sink: Part of a union. Used only if the second object (gobj1) is |
c358e80d7 [media] media-ent... |
127 128 129 130 131 132 |
* a pad. In that case, it represents the sink pad. * @entity: Part of a union. Used only if the second object (gobj1) is * an entity. * @reverse: Pointer to the link for the reverse direction of a pad to pad * link. * @flags: Link flags, as defined in uapi/media.h (MEDIA_LNK_FL_*) |
39d1ebc60 [media] media-dev... |
133 |
* @is_backlink: Indicate if the link is a backlink. |
c358e80d7 [media] media-ent... |
134 |
*/ |
53e269c10 [media] media: En... |
135 |
struct media_link { |
6b6a42780 [media] media: us... |
136 |
struct media_gobj graph_obj; |
57208e5e2 [media] media: co... |
137 |
struct list_head list; |
4b8a3c085 [media] media: ma... |
138 139 140 |
union { struct media_gobj *gobj0; struct media_pad *source; |
86e266207 [media] media: ad... |
141 |
struct media_interface *intf; |
4b8a3c085 [media] media: ma... |
142 143 144 145 |
}; union { struct media_gobj *gobj1; struct media_pad *sink; |
86e266207 [media] media: ad... |
146 |
struct media_entity *entity; |
4b8a3c085 [media] media: ma... |
147 |
}; |
c358e80d7 [media] media-ent... |
148 149 |
struct media_link *reverse; unsigned long flags; |
39d1ebc60 [media] media-dev... |
150 |
bool is_backlink; |
53e269c10 [media] media: En... |
151 |
}; |
c358e80d7 [media] media-ent... |
152 153 154 155 156 157 |
/** * struct media_pad - A media pad graph object. * * @graph_obj: Embedded structure containing the media object common data * @entity: Entity this pad belongs to * @index: Pad index in the entity pads array, numbered from 0 to n |
48a7c4bac [media] docs-rst:... |
158 159 160 |
* @flags: Pad flags, as defined in * :ref:`include/uapi/linux/media.h <media_header>` * (seek for ``MEDIA_PAD_FL_*``) |
c358e80d7 [media] media-ent... |
161 |
*/ |
53e269c10 [media] media: En... |
162 |
struct media_pad { |
4b8a3c085 [media] media: ma... |
163 |
struct media_gobj graph_obj; /* must be first field in struct */ |
c358e80d7 [media] media-ent... |
164 165 166 |
struct media_entity *entity; u16 index; unsigned long flags; |
53e269c10 [media] media: En... |
167 |
}; |
5a5394be3 [media] media: en... |
168 169 170 171 172 173 174 175 |
/** * 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. |
5ed470feb [media] media: Im... |
176 |
* |
5b8700e9f [media] doc-rst: ... |
177 178 |
* .. note:: * |
48a7c4bac [media] docs-rst:... |
179 |
* Those these callbacks are called with struct &media_device.graph_mutex |
5b8700e9f [media] doc-rst: ... |
180 |
* mutex held. |
5a5394be3 [media] media: en... |
181 |
*/ |
97548ed4c [media] media: Li... |
182 183 184 185 |
struct media_entity_operations { int (*link_setup)(struct media_entity *entity, const struct media_pad *local, const struct media_pad *remote, u32 flags); |
af88be388 [media] media: Ad... |
186 |
int (*link_validate)(struct media_link *link); |
97548ed4c [media] media: Li... |
187 |
}; |
c358e80d7 [media] media-ent... |
188 |
/** |
b76a2a8cb [media] media: Ad... |
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
* enum media_entity_type - Media entity type * * @MEDIA_ENTITY_TYPE_BASE: * The entity isn't embedded in another subsystem structure. * @MEDIA_ENTITY_TYPE_VIDEO_DEVICE: * The entity is embedded in a struct video_device instance. * @MEDIA_ENTITY_TYPE_V4L2_SUBDEV: * The entity is embedded in a struct v4l2_subdev instance. * * Media entity objects are often not instantiated directly, but the media * entity structure is inherited by (through embedding) other subsystem-specific * structures. The media entity type identifies the type of the subclass * structure that implements a media entity instance. * * This allows runtime type identification of media entities and safe casting to * the correct object type. For instance, a media entity structure instance * embedded in a v4l2_subdev structure instance will have the type |
48a7c4bac [media] docs-rst:... |
206 |
* %MEDIA_ENTITY_TYPE_V4L2_SUBDEV and can safely be cast to a &v4l2_subdev |
b76a2a8cb [media] media: Ad... |
207 208 209 210 211 212 213 214 215 |
* structure using the container_of() macro. */ enum media_entity_type { MEDIA_ENTITY_TYPE_BASE, MEDIA_ENTITY_TYPE_VIDEO_DEVICE, MEDIA_ENTITY_TYPE_V4L2_SUBDEV, }; /** |
c358e80d7 [media] media-ent... |
216 217 218 219 |
* struct media_entity - A media entity graph object. * * @graph_obj: Embedded structure containing the media object common data. * @name: Entity name. |
b76a2a8cb [media] media: Ad... |
220 |
* @obj_type: Type of the object that implements the media_entity. |
48a7c4bac [media] docs-rst:... |
221 222 223 224 225 226 |
* @function: Entity main function, as defined in * :ref:`include/uapi/linux/media.h <media_header>` * (seek for ``MEDIA_ENT_F_*``) * @flags: Entity flags, as defined in * :ref:`include/uapi/linux/media.h <media_header>` * (seek for ``MEDIA_ENT_FL_*``) |
c358e80d7 [media] media-ent... |
227 228 229 |
* @num_pads: Number of sink and source pads. * @num_links: Total number of links, forward and back, enabled and disabled. * @num_backlinks: Number of backlinks |
665faa971 [media] media: In... |
230 231 |
* @internal_idx: An unique internal entity specific number. The numbers are * re-used if entities are unregistered or registered again. |
c358e80d7 [media] media-ent... |
232 233 234 235 236 237 238 239 240 241 242 243 244 |
* @pads: Pads array with the size defined by @num_pads. * @links: List of data links. * @ops: Entity operations. * @stream_count: Stream count for the entity. * @use_count: Use count for the entity. * @pipe: Pipeline this entity belongs to. * @info: Union with devnode information. Kept just for backward * compatibility. * @major: Devnode major number (zero if not applicable). Kept just * for backward compatibility. * @minor: Devnode minor number (zero if not applicable). Kept just * for backward compatibility. * |
48a7c4bac [media] docs-rst:... |
245 246 247 248 249 250 |
* .. note:: * * @stream_count and @use_count 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. |
c358e80d7 [media] media-ent... |
251 |
*/ |
53e269c10 [media] media: En... |
252 |
struct media_entity { |
4b8a3c085 [media] media: ma... |
253 |
struct media_gobj graph_obj; /* must be first field in struct */ |
c358e80d7 [media] media-ent... |
254 |
const char *name; |
b76a2a8cb [media] media: Ad... |
255 |
enum media_entity_type obj_type; |
0e576b76f [media] media-ent... |
256 |
u32 function; |
c358e80d7 [media] media-ent... |
257 |
unsigned long flags; |
53e269c10 [media] media: En... |
258 |
|
c358e80d7 [media] media-ent... |
259 260 261 |
u16 num_pads; u16 num_links; u16 num_backlinks; |
665faa971 [media] media: In... |
262 |
int internal_idx; |
53e269c10 [media] media: En... |
263 |
|
c358e80d7 [media] media-ent... |
264 265 |
struct media_pad *pads; struct list_head links; |
53e269c10 [media] media: En... |
266 |
|
c358e80d7 [media] media-ent... |
267 |
const struct media_entity_operations *ops; |
97548ed4c [media] media: Li... |
268 |
|
c358e80d7 [media] media-ent... |
269 270 |
int stream_count; int use_count; |
503c3d829 [media] media: En... |
271 |
|
c358e80d7 [media] media-ent... |
272 |
struct media_pipeline *pipe; |
e02188c90 [media] media: Pi... |
273 |
|
53e269c10 [media] media: En... |
274 |
union { |
53e269c10 [media] media: En... |
275 276 277 |
struct { u32 major; u32 minor; |
e31a0ba7d [media] media: Fi... |
278 |
} dev; |
fa5034c66 [media] media: fi... |
279 |
} info; |
53e269c10 [media] media: En... |
280 |
}; |
27e543fa8 [media] media: ad... |
281 |
/** |
c358e80d7 [media] media-ent... |
282 |
* struct media_interface - A media interface graph object. |
27e543fa8 [media] media: ad... |
283 284 |
* * @graph_obj: embedded graph object |
86e266207 [media] media: ad... |
285 |
* @links: List of links pointing to graph entities |
48a7c4bac [media] docs-rst:... |
286 287 288 289 290 291 292 293 294 295 |
* @type: Type of the interface as defined in * :ref:`include/uapi/linux/media.h <media_header>` * (seek for ``MEDIA_INTF_T_*``) * @flags: Interface flags as defined in * :ref:`include/uapi/linux/media.h <media_header>` * (seek for ``MEDIA_INTF_FL_*``) * * .. note:: * * Currently, no flags for &media_interface is defined. |
27e543fa8 [media] media: ad... |
296 297 298 |
*/ struct media_interface { struct media_gobj graph_obj; |
86e266207 [media] media: ad... |
299 |
struct list_head links; |
27e543fa8 [media] media: ad... |
300 301 302 303 304 |
u32 type; u32 flags; }; /** |
c358e80d7 [media] media-ent... |
305 |
* struct media_intf_devnode - A media interface via a device node. |
27e543fa8 [media] media: ad... |
306 307 308 309 310 311 312 |
* * @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; |
c398bb644 [media] uapi/medi... |
313 314 |
/* Should match the fields at media_v2_intf_devnode */ |
27e543fa8 [media] media: ad... |
315 316 317 |
u32 major; u32 minor; }; |
60266185d [media] media-ent... |
318 319 320 |
/** * media_entity_id() - return the media entity graph object id * |
48a7c4bac [media] docs-rst:... |
321 |
* @entity: pointer to &media_entity |
60266185d [media] media-ent... |
322 |
*/ |
fa762394f [media] media: cr... |
323 324 |
static inline u32 media_entity_id(struct media_entity *entity) { |
bfab2aacc [media] media: us... |
325 |
return entity->graph_obj.id; |
fa762394f [media] media: cr... |
326 |
} |
60266185d [media] media-ent... |
327 328 329 |
/** * media_type() - return the media object type * |
48a7c4bac [media] docs-rst:... |
330 |
* @gobj: Pointer to the struct &media_gobj graph object |
60266185d [media] media-ent... |
331 |
*/ |
ec6e4c950 [media] media: ad... |
332 333 |
static inline enum media_gobj_type media_type(struct media_gobj *gobj) { |
05b3b77cb [media] media-dev... |
334 |
return gobj->id >> MEDIA_BITS_PER_ID; |
ec6e4c950 [media] media: ad... |
335 |
} |
630c0e80c [media] media-ent... |
336 337 338 |
/** * media_id() - return the media object ID * |
48a7c4bac [media] docs-rst:... |
339 |
* @gobj: Pointer to the struct &media_gobj graph object |
630c0e80c [media] media-ent... |
340 |
*/ |
05b3b77cb [media] media-dev... |
341 |
static inline u32 media_id(struct media_gobj *gobj) |
ec6e4c950 [media] media: ad... |
342 |
{ |
05b3b77cb [media] media-dev... |
343 |
return gobj->id & MEDIA_ID_MASK; |
ec6e4c950 [media] media: ad... |
344 |
} |
630c0e80c [media] media-ent... |
345 346 347 348 |
/** * media_gobj_gen_id() - encapsulates type and ID on at the object ID * * @type: object type as define at enum &media_gobj_type. |
48a7c4bac [media] docs-rst:... |
349 |
* @local_id: next ID, from struct &media_device.id. |
630c0e80c [media] media-ent... |
350 |
*/ |
05b3b77cb [media] media-dev... |
351 |
static inline u32 media_gobj_gen_id(enum media_gobj_type type, u64 local_id) |
ec6e4c950 [media] media: ad... |
352 353 |
{ u32 id; |
05b3b77cb [media] media-dev... |
354 355 |
id = type << MEDIA_BITS_PER_ID; id |= local_id & MEDIA_ID_MASK; |
ec6e4c950 [media] media: ad... |
356 357 358 |
return id; } |
60266185d [media] media-ent... |
359 |
/** |
45b46879a [media] media: Re... |
360 |
* is_media_entity_v4l2_video_device() - Check if the entity is a video_device |
60266185d [media] media-ent... |
361 362 |
* @entity: pointer to entity * |
48a7c4bac [media] docs-rst:... |
363 |
* Return: %true if the entity is an instance of a video_device object and can |
b76a2a8cb [media] media: Ad... |
364 |
* safely be cast to a struct video_device using the container_of() macro, or |
48a7c4bac [media] docs-rst:... |
365 |
* %false otherwise. |
60266185d [media] media-ent... |
366 |
*/ |
45b46879a [media] media: Re... |
367 |
static inline bool is_media_entity_v4l2_video_device(struct media_entity *entity) |
fa17b46a6 [media] media: ad... |
368 |
{ |
b76a2a8cb [media] media: Ad... |
369 |
return entity && entity->obj_type == MEDIA_ENTITY_TYPE_VIDEO_DEVICE; |
fa17b46a6 [media] media: ad... |
370 |
} |
60266185d [media] media-ent... |
371 |
/** |
b76a2a8cb [media] media: Ad... |
372 |
* is_media_entity_v4l2_subdev() - Check if the entity is a v4l2_subdev |
60266185d [media] media-ent... |
373 374 |
* @entity: pointer to entity * |
48a7c4bac [media] docs-rst:... |
375 376 377 |
* Return: %true if the entity is an instance of a &v4l2_subdev object and can * safely be cast to a struct &v4l2_subdev using the container_of() macro, or * %false otherwise. |
60266185d [media] media-ent... |
378 |
*/ |
fa17b46a6 [media] media: ad... |
379 380 |
static inline bool is_media_entity_v4l2_subdev(struct media_entity *entity) { |
b76a2a8cb [media] media: Ad... |
381 |
return entity && entity->obj_type == MEDIA_ENTITY_TYPE_V4L2_SUBDEV; |
fa17b46a6 [media] media: ad... |
382 |
} |
92777994a [media] move docu... |
383 384 385 386 387 388 389 390 |
/** * __media_entity_enum_init - Initialise an entity enumeration * * @ent_enum: Entity enumeration to be initialised * @idx_max: Maximum number of entities in the enumeration * * Return: Returns zero on success or a negative error code. */ |
c8d54cd53 [media] media: Ad... |
391 392 |
__must_check int __media_entity_enum_init(struct media_entity_enum *ent_enum, int idx_max); |
92777994a [media] move docu... |
393 394 395 396 397 398 399 |
/** * media_entity_enum_cleanup - Release resources of an entity enumeration * * @ent_enum: Entity enumeration to be released */ void media_entity_enum_cleanup(struct media_entity_enum *ent_enum); |
a5ccc48a7 [media] media: En... |
400 |
|
c8d54cd53 [media] media: Ad... |
401 402 403 |
/** * media_entity_enum_zero - Clear the entire enum * |
03e493388 [media] media-ent... |
404 |
* @ent_enum: Entity enumeration to be cleared |
ef69ee1bc [media] media-ent... |
405 |
*/ |
c8d54cd53 [media] media: Ad... |
406 407 408 409 410 411 412 413 |
static inline void media_entity_enum_zero(struct media_entity_enum *ent_enum) { bitmap_zero(ent_enum->bmap, ent_enum->idx_max); } /** * media_entity_enum_set - Mark a single entity in the enum * |
03e493388 [media] media-ent... |
414 |
* @ent_enum: Entity enumeration |
c8d54cd53 [media] media: Ad... |
415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
* @entity: Entity to be marked */ static inline void media_entity_enum_set(struct media_entity_enum *ent_enum, struct media_entity *entity) { if (WARN_ON(entity->internal_idx >= ent_enum->idx_max)) return; __set_bit(entity->internal_idx, ent_enum->bmap); } /** * media_entity_enum_clear - Unmark a single entity in the enum * |
03e493388 [media] media-ent... |
429 |
* @ent_enum: Entity enumeration |
c8d54cd53 [media] media: Ad... |
430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
* @entity: Entity to be unmarked */ static inline void media_entity_enum_clear(struct media_entity_enum *ent_enum, struct media_entity *entity) { if (WARN_ON(entity->internal_idx >= ent_enum->idx_max)) return; __clear_bit(entity->internal_idx, ent_enum->bmap); } /** * media_entity_enum_test - Test whether the entity is marked * |
03e493388 [media] media-ent... |
444 |
* @ent_enum: Entity enumeration |
c8d54cd53 [media] media: Ad... |
445 446 |
* @entity: Entity to be tested * |
48a7c4bac [media] docs-rst:... |
447 |
* Returns %true if the entity was marked. |
c8d54cd53 [media] media: Ad... |
448 449 450 451 452 453 454 455 456 457 458 |
*/ static inline bool media_entity_enum_test(struct media_entity_enum *ent_enum, struct media_entity *entity) { if (WARN_ON(entity->internal_idx >= ent_enum->idx_max)) return true; return test_bit(entity->internal_idx, ent_enum->bmap); } /** |
e383ce073 [media] get rid o... |
459 460 |
* media_entity_enum_test_and_set - Test whether the entity is marked, * and mark it |
c8d54cd53 [media] media: Ad... |
461 |
* |
03e493388 [media] media-ent... |
462 |
* @ent_enum: Entity enumeration |
c8d54cd53 [media] media: Ad... |
463 464 |
* @entity: Entity to be tested * |
48a7c4bac [media] docs-rst:... |
465 |
* Returns %true if the entity was marked, and mark it before doing so. |
c8d54cd53 [media] media: Ad... |
466 |
*/ |
03e493388 [media] media-ent... |
467 468 469 |
static inline bool media_entity_enum_test_and_set(struct media_entity_enum *ent_enum, struct media_entity *entity) |
c8d54cd53 [media] media: Ad... |
470 471 472 473 474 475 476 477 |
{ if (WARN_ON(entity->internal_idx >= ent_enum->idx_max)) return true; return __test_and_set_bit(entity->internal_idx, ent_enum->bmap); } /** |
03e493388 [media] media-ent... |
478 |
* media_entity_enum_empty - Test whether the entire enum is empty |
c8d54cd53 [media] media: Ad... |
479 |
* |
03e493388 [media] media-ent... |
480 |
* @ent_enum: Entity enumeration |
c8d54cd53 [media] media: Ad... |
481 |
* |
48a7c4bac [media] docs-rst:... |
482 |
* Return: %true if the entity was empty. |
c8d54cd53 [media] media: Ad... |
483 484 485 486 487 488 489 490 491 |
*/ static inline bool media_entity_enum_empty(struct media_entity_enum *ent_enum) { return bitmap_empty(ent_enum->bmap, ent_enum->idx_max); } /** * media_entity_enum_intersects - Test whether two enums intersect * |
03e493388 [media] media-ent... |
492 493 |
* @ent_enum1: First entity enumeration * @ent_enum2: Second entity enumeration |
c8d54cd53 [media] media: Ad... |
494 |
* |
48a7c4bac [media] docs-rst:... |
495 496 |
* Return: %true if entity enumerations @ent_enum1 and @ent_enum2 intersect, * otherwise %false. |
c8d54cd53 [media] media: Ad... |
497 498 499 500 501 502 503 504 505 506 |
*/ static inline bool media_entity_enum_intersects( struct media_entity_enum *ent_enum1, struct media_entity_enum *ent_enum2) { WARN_ON(ent_enum1->idx_max != ent_enum2->idx_max); return bitmap_intersects(ent_enum1->bmap, ent_enum2->bmap, min(ent_enum1->idx_max, ent_enum2->idx_max)); } |
ef69ee1bc [media] media-ent... |
507 |
|
48a7c4bac [media] docs-rst:... |
508 509 510 511 512 513 |
/** * gobj_to_entity - returns the struct &media_entity pointer from the * @gobj contained on it. * * @gobj: Pointer to the struct &media_gobj graph object */ |
ec6e4c950 [media] media: ad... |
514 515 |
#define gobj_to_entity(gobj) \ container_of(gobj, struct media_entity, graph_obj) |
48a7c4bac [media] docs-rst:... |
516 |
/** |
e383ce073 [media] get rid o... |
517 |
* gobj_to_pad - returns the struct &media_pad pointer from the |
48a7c4bac [media] docs-rst:... |
518 519 520 521 |
* @gobj contained on it. * * @gobj: Pointer to the struct &media_gobj graph object */ |
39a956c41 [media] media: ad... |
522 523 |
#define gobj_to_pad(gobj) \ container_of(gobj, struct media_pad, graph_obj) |
48a7c4bac [media] docs-rst:... |
524 |
/** |
e383ce073 [media] get rid o... |
525 |
* gobj_to_link - returns the struct &media_link pointer from the |
48a7c4bac [media] docs-rst:... |
526 527 528 529 |
* @gobj contained on it. * * @gobj: Pointer to the struct &media_gobj graph object */ |
39a956c41 [media] media: ad... |
530 531 |
#define gobj_to_link(gobj) \ container_of(gobj, struct media_link, graph_obj) |
48a7c4bac [media] docs-rst:... |
532 |
/** |
e383ce073 [media] get rid o... |
533 |
* gobj_to_intf - returns the struct &media_interface pointer from the |
48a7c4bac [media] docs-rst:... |
534 535 536 537 |
* @gobj contained on it. * * @gobj: Pointer to the struct &media_gobj graph object */ |
27e543fa8 [media] media: ad... |
538 539 |
#define gobj_to_intf(gobj) \ container_of(gobj, struct media_interface, graph_obj) |
48a7c4bac [media] docs-rst:... |
540 |
/** |
e383ce073 [media] get rid o... |
541 |
* intf_to_devnode - returns the struct media_intf_devnode pointer from the |
48a7c4bac [media] docs-rst:... |
542 543 544 545 |
* @intf contained on it. * * @intf: Pointer to struct &media_intf_devnode */ |
27e543fa8 [media] media: ad... |
546 547 |
#define intf_to_devnode(intf) \ container_of(intf, struct media_intf_devnode, intf) |
1fc25d30a [media] media-ent... |
548 549 550 |
/** * media_gobj_create - Initialize a graph object * |
48a7c4bac [media] docs-rst:... |
551 |
* @mdev: Pointer to the &media_device that contains the object |
1fc25d30a [media] media-ent... |
552 |
* @type: Type of the object |
48a7c4bac [media] docs-rst:... |
553 |
* @gobj: Pointer to the struct &media_gobj graph object |
1fc25d30a [media] media-ent... |
554 |
* |
48a7c4bac [media] docs-rst:... |
555 556 557 558 559 |
* This routine initializes the embedded struct &media_gobj inside a * media graph object. It is called automatically if ``media_*_create`` * function calls are used. However, if the object (entity, link, pad, * interface) is embedded on some other object, this function should be * called before registering the object at the media controller. |
1fc25d30a [media] media-ent... |
560 |
*/ |
c350ef830 [media] media_ent... |
561 |
void media_gobj_create(struct media_device *mdev, |
ec6e4c950 [media] media: ad... |
562 563 |
enum media_gobj_type type, struct media_gobj *gobj); |
1fc25d30a [media] media-ent... |
564 565 566 567 |
/** * media_gobj_destroy - Stop using a graph object on a media device * |
48a7c4bac [media] docs-rst:... |
568 |
* @gobj: Pointer to the struct &media_gobj graph object |
1fc25d30a [media] media-ent... |
569 570 571 572 |
* * This should be called by all routines like media_device_unregister() * that remove/destroy media graph objects. */ |
c350ef830 [media] media_ent... |
573 |
void media_gobj_destroy(struct media_gobj *gobj); |
ec6e4c950 [media] media: ad... |
574 |
|
db7ee32aa [media] media-dev... |
575 576 577 578 |
/** * media_entity_pads_init() - Initialize the entity pads * * @entity: entity where the pads belong |
1fc25d30a [media] media-ent... |
579 580 581 582 |
* @num_pads: total number of sink and source pads * @pads: Array of @num_pads pads. * * The pads array is managed by the entity driver and passed to |
48a7c4bac [media] docs-rst:... |
583 584 |
* media_entity_pads_init() where its pointer will be stored in the * &media_entity structure. |
db7ee32aa [media] media-dev... |
585 586 |
* * If no pads are needed, drivers could either directly fill |
48a7c4bac [media] docs-rst:... |
587 |
* &media_entity->num_pads with 0 and &media_entity->pads with %NULL or call |
db7ee32aa [media] media-dev... |
588 589 590 591 592 593 594 595 596 |
* this function that will do the same. * * As the number of pads is known in advance, the pads array is not allocated * dynamically but is managed by the entity driver. Most drivers will embed the * pads array in a driver-specific structure, avoiding dynamic allocation. * * Drivers must set the direction of every pad in the pads array before calling * media_entity_pads_init(). The function will initialize the other pads fields. */ |
ab22e77cd [media] media fra... |
597 |
int media_entity_pads_init(struct media_entity *entity, u16 num_pads, |
57208e5e2 [media] media: co... |
598 |
struct media_pad *pads); |
f1fd3289e [media] media-ent... |
599 |
|
db7ee32aa [media] media-dev... |
600 601 602 603 604 605 606 607 |
/** * media_entity_cleanup() - free resources associated with an entity * * @entity: entity where the pads belong * * This function must be called during the cleanup phase after unregistering * the entity (currently, it does nothing). */ |
f1fd3289e [media] media-ent... |
608 |
static inline void media_entity_cleanup(struct media_entity *entity) {}; |
e02188c90 [media] media: Pi... |
609 |
|
db7ee32aa [media] media-dev... |
610 611 612 613 614 615 616 |
/** * media_create_pad_link() - creates a link between two entities. * * @source: pointer to &media_entity of the source pad. * @source_pad: number of the source pad in the pads array * @sink: pointer to &media_entity of the sink pad. * @sink_pad: number of the sink pad in the pads array. |
48a7c4bac [media] docs-rst:... |
617 618 619 |
* @flags: Link flags, as defined in * :ref:`include/uapi/linux/media.h <media_header>` * ( seek for ``MEDIA_LNK_FL_*``) |
db7ee32aa [media] media-dev... |
620 621 |
* * Valid values for flags: |
db7ee32aa [media] media-dev... |
622 |
* |
48a7c4bac [media] docs-rst:... |
623 624 625 626 |
* %MEDIA_LNK_FL_ENABLED * Indicates that the link is enabled and can be used to transfer media data. * When two or more links target a sink pad, only one of them can be * enabled at a time. |
74604b739 [media] doc-rst: ... |
627 |
* |
48a7c4bac [media] docs-rst:... |
628 629 630 631 |
* %MEDIA_LNK_FL_IMMUTABLE * Indicates that the link enabled state can't be modified at runtime. If * %MEDIA_LNK_FL_IMMUTABLE is set, then %MEDIA_LNK_FL_ENABLED must also be * set, since an immutable link is always enabled. |
db7ee32aa [media] media-dev... |
632 |
* |
74604b739 [media] doc-rst: ... |
633 |
* .. note:: |
db7ee32aa [media] media-dev... |
634 |
* |
74604b739 [media] doc-rst: ... |
635 636 |
* Before calling this function, media_entity_pads_init() and * media_device_register_entity() should be called previously for both ends. |
db7ee32aa [media] media-dev... |
637 |
*/ |
77328043d [media] media-ent... |
638 639 640 |
__must_check int media_create_pad_link(struct media_entity *source, u16 source_pad, struct media_entity *sink, u16 sink_pad, u32 flags); |
b01cc9ce7 [media] media-ent... |
641 642 643 644 645 646 647 648 |
/** * media_create_pad_links() - creates a link between two entities. * * @mdev: Pointer to the media_device that contains the object * @source_function: Function of the source entities. Used only if @source is * NULL. * @source: pointer to &media_entity of the source pad. If NULL, it will use |
48a7c4bac [media] docs-rst:... |
649 |
* all entities that matches the @sink_function. |
b01cc9ce7 [media] media-ent... |
650 651 652 |
* @source_pad: number of the source pad in the pads array * @sink_function: Function of the sink entities. Used only if @sink is NULL. * @sink: pointer to &media_entity of the sink pad. If NULL, it will use |
48a7c4bac [media] docs-rst:... |
653 |
* all entities that matches the @sink_function. |
b01cc9ce7 [media] media-ent... |
654 655 |
* @sink_pad: number of the sink pad in the pads array. * @flags: Link flags, as defined in include/uapi/linux/media.h. |
48a7c4bac [media] docs-rst:... |
656 |
* @allow_both_undefined: if %true, then both @source and @sink can be NULL. |
b01cc9ce7 [media] media-ent... |
657 658 |
* In such case, it will create a crossbar between all entities that * matches @source_function to all entities that matches @sink_function. |
48a7c4bac [media] docs-rst:... |
659 |
* If %false, it will return 0 and won't create any link if both @source |
b01cc9ce7 [media] media-ent... |
660 661 662 |
* and @sink are NULL. * * Valid values for flags: |
74604b739 [media] doc-rst: ... |
663 |
* |
b01cc9ce7 [media] media-ent... |
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 |
* A %MEDIA_LNK_FL_ENABLED flag indicates that the link is enabled and can be * used to transfer media data. If multiple links are created and this * flag is passed as an argument, only the first created link will have * this flag. * * A %MEDIA_LNK_FL_IMMUTABLE flag indicates that the link enabled state can't * be modified at runtime. If %MEDIA_LNK_FL_IMMUTABLE is set, then * %MEDIA_LNK_FL_ENABLED must also be set since an immutable link is * always enabled. * * It is common for some devices to have multiple source and/or sink entities * of the same type that should be linked. While media_create_pad_link() * creates link by link, this function is meant to allow 1:n, n:1 and even * cross-bar (n:n) links. * |
48a7c4bac [media] docs-rst:... |
679 680 681 682 683 |
* .. note:: * * Before calling this function, media_entity_pads_init() and * media_device_register_entity() should be called previously for the * entities to be linked. |
b01cc9ce7 [media] media-ent... |
684 685 686 687 688 689 690 691 692 693 |
*/ int media_create_pad_links(const struct media_device *mdev, const u32 source_function, struct media_entity *source, const u16 source_pad, const u32 sink_function, struct media_entity *sink, const u16 sink_pad, u32 flags, const bool allow_both_undefined); |
7349cec14 [media] media: Ad... |
694 |
void __media_entity_remove_links(struct media_entity *entity); |
db7ee32aa [media] media-dev... |
695 696 697 698 699 700 |
/** * media_entity_remove_links() - remove all links associated with an entity * * @entity: pointer to &media_entity * |
74604b739 [media] doc-rst: ... |
701 702 703 704 |
* .. note:: * * This is called automatically when an entity is unregistered via * media_device_register_entity(). |
db7ee32aa [media] media-dev... |
705 |
*/ |
7349cec14 [media] media: Ad... |
706 |
void media_entity_remove_links(struct media_entity *entity); |
1fc25d30a [media] media-ent... |
707 708 709 710 711 712 713 714 715 716 717 718 719 720 |
/** * __media_entity_setup_link - Configure a media link without locking * @link: The link being configured * @flags: Link configuration flags * * The bulk of link setup is handled by the two entities connected through the * link. This function notifies both entities of the link configuration change. * * If the link is immutable or if the current and new configuration are * identical, return immediately. * * The user is expected to hold link->source->parent->mutex. If not, * media_entity_setup_link() should be used instead. */ |
97548ed4c [media] media: Li... |
721 |
int __media_entity_setup_link(struct media_link *link, u32 flags); |
db7ee32aa [media] media-dev... |
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 |
/** * media_entity_setup_link() - changes the link flags properties in runtime * * @link: pointer to &media_link * @flags: the requested new link flags * * The only configurable property is the %MEDIA_LNK_FL_ENABLED link flag * flag to enable/disable a link. Links marked with the * %MEDIA_LNK_FL_IMMUTABLE link flag can not be enabled or disabled. * * When a link is enabled or disabled, the media framework calls the * link_setup operation for the two entities at the source and sink of the * link, in that order. If the second link_setup call fails, another * link_setup call is made on the first entity to restore the original link * flags. * * Media device drivers can be notified of link setup operations by setting the |
48a7c4bac [media] docs-rst:... |
740 |
* &media_device.link_notify pointer to a callback function. If provided, the |
db7ee32aa [media] media-dev... |
741 742 743 744 745 746 747 748 749 |
* notification callback will be called before enabling and after disabling * links. * * Entity drivers must implement the link_setup operation if any of their links * is non-immutable. The operation must either configure the hardware or store * the configuration information to be applied later. * * Link configuration must not have any side effect on other links. If an * enabled link at a sink pad prevents another link at the same pad from |
48a7c4bac [media] docs-rst:... |
750 |
* being enabled, the link_setup operation must return %-EBUSY and can't |
db7ee32aa [media] media-dev... |
751 752 |
* implicitly disable the first enabled link. * |
74604b739 [media] doc-rst: ... |
753 754 755 756 757 |
* .. note:: * * The valid values of the flags for the link is the same as described * on media_create_pad_link(), for pad to pad links or the same as described * on media_create_intf_link(), for interface to entity links. |
db7ee32aa [media] media-dev... |
758 |
*/ |
97548ed4c [media] media: Li... |
759 |
int media_entity_setup_link(struct media_link *link, u32 flags); |
1fc25d30a [media] media-ent... |
760 761 762 763 764 765 |
/** * media_entity_find_link - Find a link between two pads * @source: Source pad * @sink: Sink pad * |
48a7c4bac [media] docs-rst:... |
766 767 |
* Return: returns a pointer to the link between the two entities. If no * such link exists, return %NULL. |
1fc25d30a [media] media-ent... |
768 |
*/ |
97548ed4c [media] media: Li... |
769 770 |
struct media_link *media_entity_find_link(struct media_pad *source, struct media_pad *sink); |
1fc25d30a [media] media-ent... |
771 772 773 774 775 776 777 778 |
/** * media_entity_remote_pad - Find the pad at the remote end of a link * @pad: Pad at the local end of the link * * Search for a remote pad connected to the given pad by iterating over all * links originating or terminating at that pad until an enabled link is found. * |
48a7c4bac [media] docs-rst:... |
779 780 |
* Return: returns a pointer to the pad at the remote end of the first found * enabled link, or %NULL if no enabled link has been found. |
1fc25d30a [media] media-ent... |
781 |
*/ |
1bddf1b3a [media] media: Re... |
782 |
struct media_pad *media_entity_remote_pad(struct media_pad *pad); |
53e269c10 [media] media: En... |
783 |
|
1fc25d30a [media] media-ent... |
784 785 786 787 788 789 790 |
/** * media_entity_get - Get a reference to the parent module * * @entity: The entity * * Get a reference to the parent media device module. * |
48a7c4bac [media] docs-rst:... |
791 |
* The function will return immediately if @entity is %NULL. |
1fc25d30a [media] media-ent... |
792 |
* |
48a7c4bac [media] docs-rst:... |
793 |
* Return: returns a pointer to the entity on success or %NULL on failure. |
1fc25d30a [media] media-ent... |
794 |
*/ |
503c3d829 [media] media: En... |
795 |
struct media_entity *media_entity_get(struct media_entity *entity); |
1fc25d30a [media] media-ent... |
796 |
|
48a7c4bac [media] docs-rst:... |
797 798 799 800 801 802 |
/** * media_entity_graph_walk_init - Allocate resources used by graph walk. * * @graph: Media graph structure that will be used to walk the graph * @mdev: Pointer to the &media_device that contains the object */ |
e03d22033 [media] media: Am... |
803 804 |
__must_check int media_entity_graph_walk_init( struct media_entity_graph *graph, struct media_device *mdev); |
aa360d3de [media] DocBook: ... |
805 806 807 808 809 810 |
/** * media_entity_graph_walk_cleanup - Release resources used by graph walk. * * @graph: Media graph structure that will be used to walk the graph */ |
e03d22033 [media] media: Am... |
811 |
void media_entity_graph_walk_cleanup(struct media_entity_graph *graph); |
1fc25d30a [media] media-ent... |
812 813 814 815 816 817 818 |
/** * media_entity_put - Release the reference to the parent module * * @entity: The entity * * Release the reference count acquired by media_entity_get(). * |
48a7c4bac [media] docs-rst:... |
819 |
* The function will return immediately if @entity is %NULL. |
1fc25d30a [media] media-ent... |
820 |
*/ |
503c3d829 [media] media: En... |
821 |
void media_entity_put(struct media_entity *entity); |
1fc25d30a [media] media-ent... |
822 |
/** |
48a7c4bac [media] docs-rst:... |
823 824 825 |
* media_entity_graph_walk_start - Start walking the media graph at a * given entity * |
1fc25d30a [media] media-ent... |
826 827 828 |
* @graph: Media graph structure that will be used to walk the graph * @entity: Starting entity * |
e03d22033 [media] media: Am... |
829 830 831 832 833 834 835 |
* Before using this function, media_entity_graph_walk_init() must be * used to allocate resources used for walking the graph. This * function initializes the graph traversal structure to walk the * entities graph starting at the given entity. The traversal * structure must not be modified by the caller during graph * traversal. After the graph walk, the resources must be released * using media_entity_graph_walk_cleanup(). |
1fc25d30a [media] media-ent... |
836 |
*/ |
a5ccc48a7 [media] media: En... |
837 |
void media_entity_graph_walk_start(struct media_entity_graph *graph, |
e03d22033 [media] media: Am... |
838 |
struct media_entity *entity); |
1fc25d30a [media] media-ent... |
839 840 841 842 843 844 845 846 847 848 |
/** * media_entity_graph_walk_next - Get the next entity in the graph * @graph: Media graph structure * * Perform a depth-first traversal of the given media entities graph. * * The graph structure must have been previously initialized with a call to * media_entity_graph_walk_start(). * |
48a7c4bac [media] docs-rst:... |
849 850 |
* Return: returns the next entity in the graph or %NULL if the whole graph * have been traversed. |
1fc25d30a [media] media-ent... |
851 |
*/ |
a5ccc48a7 [media] media: En... |
852 853 |
struct media_entity * media_entity_graph_walk_next(struct media_entity_graph *graph); |
1fc25d30a [media] media-ent... |
854 855 856 857 858 859 860 |
/** * media_entity_pipeline_start - Mark a pipeline as streaming * @entity: Starting entity * @pipe: Media pipeline to be assigned to all entities in the pipeline. * * Mark all entities connected to a given entity through enabled links, either |
48a7c4bac [media] docs-rst:... |
861 862 |
* directly or indirectly, as streaming. The given pipeline object is assigned * to every entity in the pipeline and stored in the media_entity pipe field. |
1fc25d30a [media] media-ent... |
863 864 865 866 867 868 |
* * Calls to this function can be nested, in which case the same number of * media_entity_pipeline_stop() calls will be required to stop streaming. The * pipeline pointer must be identical for all nested calls to * media_entity_pipeline_start(). */ |
af88be388 [media] media: Ad... |
869 870 |
__must_check int media_entity_pipeline_start(struct media_entity *entity, struct media_pipeline *pipe); |
fb49f2043 [media] media: Me... |
871 872 873 874 875 876 |
/** * __media_entity_pipeline_start - Mark a pipeline as streaming * * @entity: Starting entity * @pipe: Media pipeline to be assigned to all entities in the pipeline. * |
74604b739 [media] doc-rst: ... |
877 |
* ..note:: This is the non-locking version of media_entity_pipeline_start() |
fb49f2043 [media] media: Me... |
878 879 880 |
*/ __must_check int __media_entity_pipeline_start(struct media_entity *entity, struct media_pipeline *pipe); |
1fc25d30a [media] media-ent... |
881 882 883 884 885 886 887 |
/** * media_entity_pipeline_stop - Mark a pipeline as not streaming * @entity: Starting entity * * Mark all entities connected to a given entity through enabled links, either * directly or indirectly, as not streaming. The media_entity pipe field is |
48a7c4bac [media] docs-rst:... |
888 |
* reset to %NULL. |
1fc25d30a [media] media-ent... |
889 890 891 892 893 |
* * If multiple calls to media_entity_pipeline_start() have been made, the same * number of calls to this function are required to mark the pipeline as not * streaming. */ |
e02188c90 [media] media: Pi... |
894 |
void media_entity_pipeline_stop(struct media_entity *entity); |
a5ccc48a7 [media] media: En... |
895 |
|
db7ee32aa [media] media-dev... |
896 |
/** |
fb49f2043 [media] media: Me... |
897 898 899 900 |
* __media_entity_pipeline_stop - Mark a pipeline as not streaming * * @entity: Starting entity * |
74604b739 [media] doc-rst: ... |
901 |
* .. note:: This is the non-locking version of media_entity_pipeline_stop() |
fb49f2043 [media] media: Me... |
902 903 904 905 |
*/ void __media_entity_pipeline_stop(struct media_entity *entity); /** |
db7ee32aa [media] media-dev... |
906 907 908 |
* media_devnode_create() - creates and initializes a device node interface * * @mdev: pointer to struct &media_device |
48a7c4bac [media] docs-rst:... |
909 910 911 912 913 914 |
* @type: type of the interface, as given by * :ref:`include/uapi/linux/media.h <media_header>` * ( seek for ``MEDIA_INTF_T_*``) macros. * @flags: Interface flags, as defined in * :ref:`include/uapi/linux/media.h <media_header>` * ( seek for ``MEDIA_INTF_FL_*``) |
db7ee32aa [media] media-dev... |
915 916 917 918 919 |
* @major: Device node major number. * @minor: Device node minor number. * * Return: if succeeded, returns a pointer to the newly allocated * &media_intf_devnode pointer. |
48a7c4bac [media] docs-rst:... |
920 921 922 923 |
* * .. note:: * * Currently, no flags for &media_interface is defined. |
db7ee32aa [media] media-dev... |
924 |
*/ |
5e5387df0 [media] media-ent... |
925 926 927 |
struct media_intf_devnode * __must_check media_devnode_create(struct media_device *mdev, u32 type, u32 flags, |
0b3b72df9 [media] media_ent... |
928 |
u32 major, u32 minor); |
db7ee32aa [media] media-dev... |
929 930 931 932 933 934 935 936 |
/** * media_devnode_remove() - removes a device node interface * * @devnode: pointer to &media_intf_devnode to be freed. * * When a device node interface is removed, all links to it are automatically * removed. */ |
27e543fa8 [media] media: ad... |
937 |
void media_devnode_remove(struct media_intf_devnode *devnode); |
5e5387df0 [media] media-ent... |
938 |
struct media_link * |
db7ee32aa [media] media-dev... |
939 940 941 942 943 944 |
/** * media_create_intf_link() - creates a link between an entity and an interface * * @entity: pointer to %media_entity * @intf: pointer to %media_interface |
48a7c4bac [media] docs-rst:... |
945 946 947 |
* @flags: Link flags, as defined in * :ref:`include/uapi/linux/media.h <media_header>` * ( seek for ``MEDIA_LNK_FL_*``) |
db7ee32aa [media] media-dev... |
948 949 950 |
* * * Valid values for flags: |
db7ee32aa [media] media-dev... |
951 |
* |
48a7c4bac [media] docs-rst:... |
952 953 954 955 956 957 |
* %MEDIA_LNK_FL_ENABLED * Indicates that the interface is connected to the entity hardware. * That's the default value for interfaces. An interface may be disabled if * the hardware is busy due to the usage of some other interface that it is * currently controlling the hardware. * |
74604b739 [media] doc-rst: ... |
958 959 960 961 962 963 |
* A typical example is an hybrid TV device that handle only one type of * stream on a given time. So, when the digital TV is streaming, * the V4L2 interfaces won't be enabled, as such device is not able to * also stream analog TV or radio. * * .. note:: |
db7ee32aa [media] media-dev... |
964 |
* |
74604b739 [media] doc-rst: ... |
965 966 967 |
* Before calling this function, media_devnode_create() should be called for * the interface and media_device_register_entity() should be called for the * interface that will be part of the link. |
db7ee32aa [media] media-dev... |
968 |
*/ |
5e5387df0 [media] media-ent... |
969 970 971 |
__must_check media_create_intf_link(struct media_entity *entity, struct media_interface *intf, u32 flags); |
60266185d [media] media-ent... |
972 973 974 975 976 |
/** * __media_remove_intf_link() - remove a single interface link * * @link: pointer to &media_link. * |
74604b739 [media] doc-rst: ... |
977 |
* .. note:: This is an unlocked version of media_remove_intf_link() |
60266185d [media] media-ent... |
978 |
*/ |
d47109fa4 [media] media-dev... |
979 |
void __media_remove_intf_link(struct media_link *link); |
60266185d [media] media-ent... |
980 981 982 983 984 985 |
/** * media_remove_intf_link() - remove a single interface link * * @link: pointer to &media_link. * |
74604b739 [media] doc-rst: ... |
986 |
* .. note:: Prefer to use this one, instead of __media_remove_intf_link() |
60266185d [media] media-ent... |
987 |
*/ |
86e266207 [media] media: ad... |
988 |
void media_remove_intf_link(struct media_link *link); |
60266185d [media] media-ent... |
989 990 991 992 993 994 |
/** * __media_remove_intf_links() - remove all links associated with an interface * * @intf: pointer to &media_interface * |
74604b739 [media] doc-rst: ... |
995 |
* .. note:: This is an unlocked version of media_remove_intf_links(). |
60266185d [media] media-ent... |
996 |
*/ |
7c4696a91 [media] media-ent... |
997 |
void __media_remove_intf_links(struct media_interface *intf); |
92777994a [media] move docu... |
998 |
|
db7ee32aa [media] media-dev... |
999 1000 1001 1002 1003 |
/** * media_remove_intf_links() - remove all links associated with an interface * * @intf: pointer to &media_interface * |
f58cad224 [media] media-ent... |
1004 |
* .. note:: |
60266185d [media] media-ent... |
1005 |
* |
f58cad224 [media] media-ent... |
1006 1007 |
* #) This is called automatically when an entity is unregistered via * media_device_register_entity() and by media_devnode_remove(). |
60266185d [media] media-ent... |
1008 |
* |
f58cad224 [media] media-ent... |
1009 |
* #) Prefer to use this one, instead of __media_remove_intf_links(). |
db7ee32aa [media] media-dev... |
1010 |
*/ |
7c4696a91 [media] media-ent... |
1011 |
void media_remove_intf_links(struct media_interface *intf); |
48a7c4bac [media] docs-rst:... |
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 |
/** * media_entity_call - Calls a struct media_entity_operations operation on * an entity * * @entity: entity where the @operation will be called * @operation: type of the operation. Should be the name of a member of * struct &media_entity_operations. * * This helper function will check if @operation is not %NULL. On such case, * it will issue a call to @operation\(@entity, @args\). */ |
97548ed4c [media] media: Li... |
1023 1024 1025 |
#define media_entity_call(entity, operation, args...) \ (((entity)->ops && (entity)->ops->operation) ? \ (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD) |
53e269c10 [media] media: En... |
1026 |
#endif |