include/media/media-entity.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
26  * enum media_gobj_type - type of a graph object
30  * @MEDIA_GRAPH_LINK:		Identify a media link
42 #define MEDIA_BITS_PER_ID		(32 - MEDIA_BITS_PER_TYPE)
43 #define MEDIA_ID_MASK			 GENMASK_ULL(MEDIA_BITS_PER_ID - 1, 0)
48  * struct media_gobj - Define a graph object.
51  * @id:		Non-zero object ID identifier. The ID should be unique
55  * @list:	List entry stored in one of the per-type mdev object lists
68  * struct media_entity_enum - An enumeration of media entities.
71  *		media_entity->internal_idx.
80  * struct media_graph - Media graph traversal state
86  * @stack.link:		pointer to &struct list_head.
93 		struct list_head *link;  member
101  * struct media_pipeline - Media pipeline related information
106  * @start_count:	Media pipeline start - stop count
116  * struct media_pipeline_pad - A pad part of a media pipeline
134  * struct media_pipeline_pad_iter - Iterator for media_pipeline_for_each_pad
143  * struct media_pipeline_entity_iter - Iterator for media_pipeline_for_each_entity
154  * struct media_link - A link object part of a media graph.
158  *		owns the link.
160  *		graph_object of the link.
166  *		graph_object of the link.
171  * @reverse:	Pointer to the link for the reverse direction of a pad to pad
172  *		link.
173  * @flags:	Link flags, as defined in uapi/media.h (MEDIA_LNK_FL_*)
174  * @is_backlink: Indicate if the link is a backlink.
195  * enum media_pad_signal_type - type of the signal inside a media pad
198  *	Default signal. Use this when all inputs or all outputs are
201  *	The pad contains an analog signal. It can be Radio Frequency,
202  *	Intermediate Frequency, a baseband signal or sub-carriers.
203  *	Tuner inputs, IF-PLL demodulators, composite and s-video signals
206  *	Contains a digital video signal, with can be a bitstream of samples
210  *	Contains an Intermediate Frequency analog signal from an audio
211  *	sub-carrier or an audio bitstream. IF signals are provided by tuners
223  * struct media_pad - A media pad graph object.
229  * @sig_type:	Type of the signal inside a media pad
252  * struct media_entity_operations - Media entity operations
256  * @link_setup:		Notify the entity of link changes. The operation can
257  *			return an error, in which case link setup will be
259  * @link_validate:	Return whether a link is valid from the entity point of
267  *			guaranteed to not both be sinks or sources. Never call
284 	int (*link_validate)(struct media_link *link);
290  * enum media_entity_type - Media entity type
300  * entity structure is inherited by (through embedding) other subsystem-specific
317  * struct media_entity - A media entity graph object.
332  *		re-used if entities are unregistered or registered again.
377  * media_entity_for_each_pad - Iterate on all pads in an entity
384 	for (iter = (entity)->pads;				\
385 	     iter < &(entity)->pads[(entity)->num_pads];	\
389  * struct media_interface - A media interface graph object.
412  * struct media_intf_devnode - A media interface via a device node.
427  * media_entity_id() - return the media entity graph object id
433 	return entity->graph_obj.id;  in media_entity_id()
437  * media_type() - return the media object type
443 	return gobj->id >> MEDIA_BITS_PER_ID;  in media_type()
447  * media_id() - return the media object ID
453 	return gobj->id & MEDIA_ID_MASK;  in media_id()
457  * media_gobj_gen_id() - encapsulates type and ID on at the object ID
473  * is_media_entity_v4l2_video_device() - Check if the entity is a video_device
482 	return entity && entity->obj_type == MEDIA_ENTITY_TYPE_VIDEO_DEVICE;  in is_media_entity_v4l2_video_device()
486  * is_media_entity_v4l2_subdev() - Check if the entity is a v4l2_subdev
495 	return entity && entity->obj_type == MEDIA_ENTITY_TYPE_V4L2_SUBDEV;  in is_media_entity_v4l2_subdev()
499  * media_entity_enum_init - Initialise an entity enumeration
510  * media_entity_enum_cleanup - Release resources of an entity enumeration
517  * media_entity_enum_zero - Clear the entire enum
523 	bitmap_zero(ent_enum->bmap, ent_enum->idx_max);  in media_entity_enum_zero()
527  * media_entity_enum_set - Mark a single entity in the enum
535 	if (WARN_ON(entity->internal_idx >= ent_enum->idx_max))  in media_entity_enum_set()
538 	__set_bit(entity->internal_idx, ent_enum->bmap);  in media_entity_enum_set()
542  * media_entity_enum_clear - Unmark a single entity in the enum
550 	if (WARN_ON(entity->internal_idx >= ent_enum->idx_max))  in media_entity_enum_clear()
553 	__clear_bit(entity->internal_idx, ent_enum->bmap);  in media_entity_enum_clear()
557  * media_entity_enum_test - Test whether the entity is marked
567 	if (WARN_ON(entity->internal_idx >= ent_enum->idx_max))  in media_entity_enum_test()
570 	return test_bit(entity->internal_idx, ent_enum->bmap);  in media_entity_enum_test()
574  * media_entity_enum_test_and_set - Test whether the entity is marked,
586 	if (WARN_ON(entity->internal_idx >= ent_enum->idx_max))  in media_entity_enum_test_and_set()
589 	return __test_and_set_bit(entity->internal_idx, ent_enum->bmap);  in media_entity_enum_test_and_set()
593  * media_entity_enum_empty - Test whether the entire enum is empty
601 	return bitmap_empty(ent_enum->bmap, ent_enum->idx_max);  in media_entity_enum_empty()
605  * media_entity_enum_intersects - Test whether two enums intersect
617 	WARN_ON(ent_enum1->idx_max != ent_enum2->idx_max);  in media_entity_enum_intersects()
619 	return bitmap_intersects(ent_enum1->bmap, ent_enum2->bmap,  in media_entity_enum_intersects()
620 				 min(ent_enum1->idx_max, ent_enum2->idx_max));  in media_entity_enum_intersects()
624  * gobj_to_entity - returns the struct &media_entity pointer from the
633  * gobj_to_pad - returns the struct &media_pad pointer from the
642  * gobj_to_link - returns the struct &media_link pointer from the
651  * gobj_to_intf - returns the struct &media_interface pointer from the
660  * intf_to_devnode - returns the struct media_intf_devnode pointer from the
669  *  media_gobj_create - Initialize a graph object
677  * function calls are used. However, if the object (entity, link, pad,
686  *  media_gobj_destroy - Stop using a graph object on a media device
696  * media_entity_pads_init() - Initialize the entity pads
707  * &media_entity->num_pads with 0 and &media_entity->pads with %NULL or call
712  * pads array in a driver-specific structure, avoiding dynamic allocation.
721  * media_entity_cleanup() - free resources associated with an entity
730  * valid and is a no-op.
739  * media_get_pad_index() - retrieves a pad index from an entity
743  * @sig_type:	type of signal of the pad to be search
751  * entity is a NULL pointer, return -EINVAL.
757  * media_create_pad_link() - creates a link between two entities.
763  * @flags:	Link flags, as defined in
770  *   Indicates that the link is enabled and can be used to transfer media data.
775  *   Indicates that the link enabled state can't be modified at runtime. If
777  *   set, since an immutable link is always enabled.
789  * media_create_pad_links() - creates a link between two entities.
801  * @flags: Link flags, as defined in include/uapi/linux/media.h.
805  *	If %false, it will return 0 and won't create any link if both @source
810  * A %MEDIA_LNK_FL_ENABLED flag indicates that the link is enabled and can be
812  *	flag is passed as an argument, only the first created link will have
815  * A %MEDIA_LNK_FL_IMMUTABLE flag indicates that the link enabled state can't
817  *	%MEDIA_LNK_FL_ENABLED must also be set since an immutable link is
822  * creates link by link, this function is meant to allow 1:n, n:1 and even
823  * cross-bar (n:n) links.
844  * media_entity_remove_links() - remove all links associated with an entity
856  * __media_entity_setup_link - Configure a media link without locking
857  * @link: The link being configured
858  * @flags: Link configuration flags
860  * The bulk of link setup is handled by the two entities connected through the
861  * link. This function notifies both entities of the link configuration change.
863  * If the link is immutable or if the current and new configuration are
866  * The user is expected to hold link->source->parent->mutex. If not,
869 int __media_entity_setup_link(struct media_link *link, u32 flags);
872  * media_entity_setup_link() - changes the link flags properties in runtime
874  * @link:	pointer to &media_link
875  * @flags:	the requested new link flags
877  * The only configurable property is the %MEDIA_LNK_FL_ENABLED link flag
878  * to enable/disable a link. Links marked with the
879  * %MEDIA_LNK_FL_IMMUTABLE link flag can not be enabled or disabled.
881  * When a link is enabled or disabled, the media framework calls the
883  * link, in that order. If the second link_setup call fails, another
884  * link_setup call is made on the first entity to restore the original link
887  * Media device drivers can be notified of link setup operations by setting the
893  * is non-immutable. The operation must either configure the hardware or store
896  * Link configuration must not have any side effect on other links. If an
897  * enabled link at a sink pad prevents another link at the same pad from
898  * being enabled, the link_setup operation must return %-EBUSY and can't
899  * implicitly disable the first enabled link.
903  *    The valid values of the flags for the link is the same as described
907 int media_entity_setup_link(struct media_link *link, u32 flags);
910  * media_entity_find_link - Find a link between two pads
914  * Return: returns a pointer to the link between the two entities. If no
915  * such link exists, return %NULL.
921  * media_pad_remote_pad_first - Find the first pad at the remote end of a link
922  * @pad: Pad at the local end of the link
925  * links originating or terminating at that pad until an enabled link is found.
928  * enabled link, or %NULL if no enabled link has been found.
933  * media_pad_remote_pad_unique - Find a remote pad connected to a pad
937  * link. If multiple (or no) remote pads are found, an error is returned.
945  * * -ENOTUNIQ - Multiple links are enabled
946  * * -ENOLINK - No connected pad found
951  * media_entity_remote_pad_unique - Find a remote pad connected to an entity
956  * enabled link. If multiple (or no) remote pads match these criteria, an error
965  * * -ENOTUNIQ - Multiple links are enabled
966  * * -ENOLINK - No connected pad found
973  * media_entity_remote_source_pad_unique - Find a remote source pad connected to
978  * enabled link. If multiple (or no) remote pads match these criteria, an error
987  * * -ENOTUNIQ - Multiple links are enabled
988  * * -ENOLINK - No connected pad found
997  * media_pad_is_streaming - Test if a pad is part of a streaming pipeline
1005 	return pad->pipe;  in media_pad_is_streaming()
1009  * media_entity_is_streaming - Test if an entity is part of a streaming pipeline
1028  * media_entity_pipeline - Get the media pipeline an entity is part of
1048  * media_pad_pipeline - Get the media pipeline a pad is part of
1061  * media_entity_get_fwnode_pad - Get pad number from fwnode
1084  * media_graph_walk_init - Allocate resources used by graph walk.
1100  * media_graph_walk_cleanup - Release resources used by graph walk.
1109  * media_graph_walk_start - Start walking the media graph at a
1129  * media_graph_walk_next - Get the next entity in the graph
1134  * Perform a depth-first traversal of the given media entities graph.
1145  * media_pipeline_start - Mark a pipeline as streaming
1161  * __media_pipeline_start - Mark a pipeline as streaming
1166  * ..note:: This is the non-locking version of media_pipeline_start()
1172  * media_pipeline_stop - Mark a pipeline as not streaming
1186  * __media_pipeline_stop - Mark a pipeline as not streaming
1190  * .. note:: This is the non-locking version of media_pipeline_stop()
1200  * media_pipeline_for_each_pad - Iterate on all pads in a media pipeline
1215  * media_pipeline_entity_iter_init - Initialize a pipeline entity iterator
1233  * media_pipeline_entity_iter_cleanup - Destroy a pipeline entity iterator
1247  * media_pipeline_for_each_entity - Iterate on all entities in a media pipeline
1265  * media_pipeline_alloc_start - Mark a pipeline as streaming
1278  * media_devnode_create() - creates and initializes a device node interface
1302  * media_devnode_remove() - removes a device node interface
1312  * media_create_intf_link() - creates a link between an entity and an interface
1316  * @flags:	Link flags, as defined in
1338  *    interface that will be part of the link.
1345  * __media_remove_intf_link() - remove a single interface link
1347  * @link:	pointer to &media_link.
1351 void __media_remove_intf_link(struct media_link *link);
1354  * media_remove_intf_link() - remove a single interface link
1356  * @link:	pointer to &media_link.
1360 void media_remove_intf_link(struct media_link *link);
1363  * __media_remove_intf_links() - remove all links associated with an interface
1372  * media_remove_intf_links() - remove all links associated with an interface
1386  * media_entity_call - Calls a struct media_entity_operations operation on
1398 	(((entity)->ops && (entity)->ops->operation) ?			\
1399 	 (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)
1402  * media_create_ancillary_link() - create an ancillary link between two
1408  * Create an ancillary link between two entities, indicating that they
1414  * the new link.
1421  * __media_entity_next_link() - Iterate through a &media_entity's links
1424  * @link:	pointer to a &media_link to hold the iterated values
1427  * Return the next link against an entity matching a specific link type. This
1432 					    struct media_link *link,
1436  * for_each_media_entity_data_link() - Iterate through an entity's data links
1439  * @link:	pointer to a &media_link to hold the iterated values
1443 #define for_each_media_entity_data_link(entity, link)			\  argument
1444 	for (link = __media_entity_next_link(entity, NULL,		\
1446 	     link;							\
1447 	     link = __media_entity_next_link(entity, link,		\