include/media/media-entity.h

3  * Media entity
19 #include <linux/media.h>
23 /* Enums used internally at the media controller to represent graphs */
28  * @MEDIA_GRAPH_ENTITY:		Identify a media entity
29  * @MEDIA_GRAPH_PAD:		Identify a media pad
30  * @MEDIA_GRAPH_LINK:		Identify a media link
31  * @MEDIA_GRAPH_INTF_DEVNODE:	Identify a media Kernel API interface via
45 /* Structs to represent the objects that belong to a media graph */
57  * All objects on the media graph should have this struct embedded
68  * struct media_entity_enum - An enumeration of media entities.
80  * struct media_graph - Media graph traversal state
83  *			on the path the media entities to be walked and the
101  * struct media_pipeline - Media pipeline related information
103  * @allocated:		Media pipeline allocated and freed by the framework
104  * @mdev:		The media device the pipeline is part of
106  * @start_count:	Media pipeline start - stop count
116  * struct media_pipeline_pad - A pad part of a media pipeline
120  * @pad:		The media pad
122  * This structure associate a pad with a media pipeline. Instances of
154  * struct media_link - A link object part of a media graph.
156  * @graph_obj:	Embedded structure containing the media object common data
173  * @flags:	Link flags, as defined in uapi/media.h (MEDIA_LNK_FL_*)
195  * enum media_pad_signal_type - type of the signal inside a media pad
223  * struct media_pad - A media pad graph object.
225  * @graph_obj:	Embedded structure containing the media object common data
229  * @sig_type:	Type of the signal inside a media pad
231  *		:ref:`include/uapi/linux/media.h <media_header>`
252  * struct media_entity_operations - Media entity operations
255  *			to map a fwnode to a media pad number. Optional.
290  * enum media_entity_type - Media entity type
299  * Media entity objects are often not instantiated directly, but the media
301  * structures. The media entity type identifies the type of the subclass
302  * structure that implements a media entity instance.
304  * This allows runtime type identification of media entities and safe casting to
305  * the correct object type. For instance, a media entity structure instance
317  * struct media_entity - A media entity graph object.
319  * @graph_obj:	Embedded structure containing the media object common data.
323  *		:ref:`include/uapi/linux/media.h <media_header>`
326  *		:ref:`include/uapi/linux/media.h <media_header>`
385  * Iterate on all pads in a media entity.
393  * struct media_interface - A media interface graph object.
398  *			:ref:`include/uapi/linux/media.h <media_header>`
401  *			:ref:`include/uapi/linux/media.h <media_header>`
416  * struct media_intf_devnode - A media interface via a device node.
431  * media_entity_id() - return the media entity graph object id
441  * media_type() - return the media object type
451  * media_id() - return the media object ID
506  * @mdev: The related media device
680  * media graph object. It is called automatically if ``media_*_create``
683  * called before registering the object at the media controller.
690  *  media_gobj_destroy - Stop using a graph object on a media device
695  * that remove/destroy media graph objects.
754  * On success, return the pad number. If the pad was not found or the media
768  *		:ref:`include/uapi/linux/media.h <media_header>`
774  *   Indicates that the link is enabled and can be used to transfer media data.
805  * @flags: Link flags, as defined in include/uapi/linux/media.h.
815  *	used to transfer media data. If multiple links are created and this
860  * __media_entity_setup_link - Configure a media link without locking
885  * When a link is enabled or disabled, the media framework calls the
891  * Media device drivers can be notified of link setup operations by setting the
1032  * media_entity_pipeline - Get the media pipeline an entity is part of
1037  * This function returns the media pipeline that an entity has been associated
1052  * media_pad_pipeline - Get the media pipeline a pad is part of
1055  * This function returns the media pipeline that a pad has been associated
1070  *		     :ref:`include/uapi/linux/media.h <media_header>`
1073  * This function can be used to resolve the media pad number from
1075  * mappings of media pads.
1090  * @graph: Media graph structure that will be used to walk the graph
1106  * @graph: Media graph structure that will be used to walk the graph
1113  * media_graph_walk_start - Start walking the media graph at a
1116  * @graph: Media graph structure that will be used to walk the graph
1134  * @graph: Media graph structure
1138  * Perform a depth-first traversal of the given media entities graph.
1151  * @pipe: Media pipeline to be assigned to all pads in the pipeline.
1168  * @pipe: Media pipeline to be assigned to all pads in the pipeline.
1204  * media_pipeline_for_each_pad - Iterate on all pads in a media pipeline
1209  * Iterate on all pads in a media pipeline. This is only valid after the
1251  * media_pipeline_for_each_entity - Iterate on all entities in a media pipeline
1256  * Iterate on all entities in a media pipeline. This is only valid after the
1286  *		:ref:`include/uapi/linux/media.h <media_header>`
1289  *		:ref:`include/uapi/linux/media.h <media_header>`
1321  *		:ref:`include/uapi/linux/media.h <media_header>`