Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

doc: media: visl: Document tpg_verbose parameter

Also document stable frames and what it means for testing tools.

Signed-off-by: Detlev Casanova <detlev.casanova@collabora.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
[hverkuil: add media: prefix to Subject]

authored by

Detlev Casanova and committed by
Hans Verkuil
ce7e79ac 8901f20b

+10 -2
+10 -2
Documentation/admin-guide/media/visl.rst
··· 49 49 visl_dprintk_frame_start, visl_dprintk_nframes, but controls the dumping of 50 50 buffer data through debugfs instead. 51 51 52 + - tpg_verbose: Write extra information on each output frame to ease debugging 53 + the API. When set to true, the output frames are not stable for a given input 54 + as some information like pointers or queue status will be added to them. 55 + 52 56 What is the default use case for this driver? 53 57 --------------------------------------------- 54 58 ··· 61 57 OUTPUT buffer data is subsequently used to debug a work-in-progress 62 58 implementation. 63 59 64 - Information on reference frames, their timestamps, the status of the OUTPUT and 65 - CAPTURE queues and more can be read directly from the CAPTURE buffers. 60 + Even though no video decoding is actually done, the output frames can be used 61 + against a reference for a given input, except if tpg_verbose is set to true. 62 + 63 + Depending on the tpg_verbose parameter value, information on reference frames, 64 + their timestamps, the status of the OUTPUT and CAPTURE queues and more can be 65 + read directly from the CAPTURE buffers. 66 66 67 67 Supported codecs 68 68 ----------------