include/media/media-entity.h

3  * Media entity
19 #include <linux/media.h>
21 /* Enums used internally at the media controller to represent graphs */
26  * @MEDIA_GRAPH_ENTITY:		Identify a media entity
27  * @MEDIA_GRAPH_PAD:		Identify a media pad
28  * @MEDIA_GRAPH_LINK:		Identify a media link
29  * @MEDIA_GRAPH_INTF_DEVNODE:	Identify a media Kernel API interface via
43 /* Structs to represent the objects that belong to a media graph */
55  * All objects on the media graph should have this struct embedded
66  * struct media_entity_enum - An enumeration of media entities.
78  * struct media_graph - Media graph traversal state
81  *			on the path the media entities to be walked and the
99  * struct media_pipeline - Media pipeline related information
102  * @graph:		Media graph walk during pipeline start / stop
110  * struct media_link - A link object part of a media graph.
112  * @graph_obj:	Embedded structure containing the media object common data
129  * @flags:	Link flags, as defined in uapi/media.h (MEDIA_LNK_FL_*)
151  * enum media_pad_signal_type - type of the signal inside a media pad
179  * struct media_pad - A media pad graph object.
181  * @graph_obj:	Embedded structure containing the media object common data
184  * @sig_type:	Type of the signal inside a media pad
186  *		:ref:`include/uapi/linux/media.h <media_header>`
198  * struct media_entity_operations - Media entity operations
201  *			to map a fwnode to a media pad number. Optional.
224  * enum media_entity_type - Media entity type
233  * Media entity objects are often not instantiated directly, but the media
235  * structures. The media entity type identifies the type of the subclass
236  * structure that implements a media entity instance.
238  * This allows runtime type identification of media entities and safe casting to
239  * the correct object type. For instance, a media entity structure instance
251  * struct media_entity - A media entity graph object.
253  * @graph_obj:	Embedded structure containing the media object common data.
257  *		:ref:`include/uapi/linux/media.h <media_header>`
260  *		:ref:`include/uapi/linux/media.h <media_header>`
321  * struct media_interface - A media interface graph object.
326  *			:ref:`include/uapi/linux/media.h <media_header>`
329  *			:ref:`include/uapi/linux/media.h <media_header>`
344  * struct media_intf_devnode - A media interface via a device node.
359  * media_entity_id() - return the media entity graph object id
369  * media_type() - return the media object type
379  * media_id() - return the media object ID
608  * media graph object. It is called automatically if ``media_*_create``
611  * called before registering the object at the media controller.
618  *  media_gobj_destroy - Stop using a graph object on a media device
623  * that remove/destroy media graph objects.
678  * On success, return the pad number. If the pad was not found or the media
692  *		:ref:`include/uapi/linux/media.h <media_header>`
698  *   Indicates that the link is enabled and can be used to transfer media data.
729  * @flags: Link flags, as defined in include/uapi/linux/media.h.
739  *	used to transfer media data. If multiple links are created and this
784  * __media_entity_setup_link - Configure a media link without locking
809  * When a link is enabled or disabled, the media framework calls the
815  * Media device drivers can be notified of link setup operations by setting the
866  *		     :ref:`include/uapi/linux/media.h <media_header>`
869  * This function can be used to resolve the media pad number from
871  * mappings of media pads.
886  * @graph: Media graph structure that will be used to walk the graph
895  * @graph: Media graph structure that will be used to walk the graph
900  * media_graph_walk_start - Start walking the media graph at a
903  * @graph: Media graph structure that will be used to walk the graph
919  * @graph: Media graph structure
921  * Perform a depth-first traversal of the given media entities graph.
934  * @pipe: Media pipeline to be assigned to all entities in the pipeline.
951  * @pipe: Media pipeline to be assigned to all entities in the pipeline.
986  *		:ref:`include/uapi/linux/media.h <media_header>`
989  *		:ref:`include/uapi/linux/media.h <media_header>`
1022  *		:ref:`include/uapi/linux/media.h <media_header>`