Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3cdb977e authored by Sakari Ailus's avatar Sakari Ailus Committed by Mauro Carvalho Chehab
Browse files

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: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent c6721526

Documentation/media/kapi/csi2.rst

+10 −0
Original line number Diff line number Diff line
@@ -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

----------------