Commit b5163545 authored by Laurent Pinchart's avatar Laurent Pinchart Committed by Mauro Carvalho Chehab
Browse files

media: mc: entity: Fix minor issues in comments and documentation 



Commit ae219872 ("media: mc: entity: Rewrite
media_pipeline_start()") incorrectly referred to entity instead of pad
in a comment, and forgot to update a second comment accordingly when
moving the pipe from entity to pad. Furthermore, it didn't properly
reflow the documentation text it updated.

Fix those small issues.

Fixes: ae219872 ("media: mc: entity: Rewrite media_pipeline_start()")
Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: default avatarTomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Signed-off-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@kernel.org>
parent a967a3a7

Documentation/driver-api/media/mc-core.rst

+4 −6
Original line number Diff line number Diff line
@@ -232,12 +232,10 @@ prevent link states from being modified during streaming by calling 


The function will mark all the pads which are part of the pipeline as streaming.



The struct media_pipeline instance pointed to by

the pipe argument will be stored in every pad in the pipeline.

Drivers should embed the struct media_pipeline

in higher-level pipeline structures and can then access the

pipeline through the struct media_pad

pipe field.

The struct media_pipeline instance pointed to by the pipe argument will be

stored in every pad in the pipeline. Drivers should embed the struct

media_pipeline in higher-level pipeline structures and can then access the

pipeline through the struct media_pad pipe field.



Calls to :c:func:`media_pipeline_start()` can be nested.

The pipeline pointer must be identical for all nested calls to the function.

drivers/media/mc/mc-entity.c

+3 −3
Original line number Diff line number Diff line
@@ -724,8 +724,8 @@ __must_check int __media_pipeline_start(struct media_pad *pad, 
	lockdep_assert_held(&mdev->graph_mutex);



	/*

	 * If the entity is already part of a pipeline, that pipeline must

	 * be the same as the pipe given to media_pipeline_start().

	 * If the pad is already part of a pipeline, that pipeline must be the

	 * same as the pipe given to media_pipeline_start().

	 */

	if (WARN_ON(pad->pipe && pad->pipe != pipe))

		return -EINVAL;
@@ -919,7 +919,7 @@ __must_check int media_pipeline_alloc_start(struct media_pad *pad) 
	mutex_lock(&mdev->graph_mutex);



	/*

	 * Is the entity already part of a pipeline? If not, we need to allocate

	 * Is the pad already part of a pipeline? If not, we need to allocate

	 * a pipe.

	 */

	pipe = media_pad_pipeline(pad);