pipeline: simple: Update documentation on pipeline setup

After commit 4671911df0 ("pipeline: simple: Use breadth-first search
to setup media pipeline"), the explanation in the SimplePipeline
documentation how the handler tries to find a valid path to capture
device does not reflect the reality anymore. Update the text to the new
situation.

Fixes: 4671911df0 ("pipeline: simple: Use breadth-first search to setup media pipeline")
Signed-off-by: Marian Cichy <m.cichy@pengutronix.de>
Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
Marian Cichy 2021-03-19 17:03:22 +01:00 committed by Laurent Pinchart
parent aade93f503
commit 1a26f79f21

View file

@ -69,11 +69,12 @@ LOG_DEFINE_CATEGORY(SimplePipeline)
* *
* When matching a device, the pipeline handler enumerates all camera sensors * When matching a device, the pipeline handler enumerates all camera sensors
* and attempts, for each of them, to find a path to a video capture video node. * and attempts, for each of them, to find a path to a video capture video node.
* It does so by traversing the media graph, following the first non permanently * It does so by using a breadth-first search to find the shortest path from the
* disabled downstream link. If such a path is found, the pipeline handler * sensor device to a valid capture device. This is guaranteed to produce a
* creates a corresponding SimpleCameraData instance, and stores the media graph * valid path on devices with one only option and is a good heuristic on more
* path in its entities_ list. * complex devices to skip paths that aren't suitable for the simple pipeline
* * handler. For instance, on the IPU-based i.MX6, the shortest path will skip
* encoders and image converters, and it will end in a CSI capture device.
* A more complex graph search algorithm could be implemented if a device that * A more complex graph search algorithm could be implemented if a device that
* would otherwise be compatible with the pipeline handler isn't correctly * would otherwise be compatible with the pipeline handler isn't correctly
* handled by this heuristic. * handled by this heuristic.