From: Sakari Ailus Date: Wed, 16 Aug 2017 12:20:18 +0000 (-0400) Subject: media: docs-rst: media: Document broken frame handling in stream stop for CSI-2 X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=3cdb977ec878b23eb6e3380d262985b6a7c93c54;p=linux.git media: docs-rst: media: Document broken frame handling in stream stop for CSI-2 Some CSI-2 transmitters will finish an ongoing frame whereas others will not. Document that receiver drivers should not assume a particular behaviour but to work in both cases. Signed-off-by: Sakari Ailus Reviewed-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab --- diff --git a/Documentation/media/kapi/csi2.rst b/Documentation/media/kapi/csi2.rst index e33fcb967922d..0560100efca2e 100644 --- a/Documentation/media/kapi/csi2.rst +++ b/Documentation/media/kapi/csi2.rst @@ -51,6 +51,16 @@ not active. Some transmitters do this automatically but some have to be explicitly programmed to do so, and some are unable to do so altogether due to hardware constraints. +Stopping the transmitter +^^^^^^^^^^^^^^^^^^^^^^^^ + +A transmitter stops sending the stream of images as a result of +calling the ``.s_stream()`` callback. Some transmitters may stop the +stream at a frame boundary whereas others stop immediately, +effectively leaving the current frame unfinished. The receiver driver +should not make assumptions either way, but function properly in both +cases. + Receiver drivers ----------------