public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
To: Simon Ser <contact@emersion.fr>,
	Michel Daenzer <michel@daenzer.net>,
	"Bas Nieuwenhuizen" <bas@basnieuwenhuizen.nl>,
	Marek Olsak <marek.olsak@amd.com>, Roman Gilg <subdiff@gmail.com>,
	Nicholas Kazlauskas <nicholas.kazlauskas@amd.com>,
	Harry Wentland <Harry.Wentland@amd.com>,
	"Mark Yacoub" <markyacoub@chromium.org>,
	Sean Paul <seanpaul@chromium.org>,
	"Pekka Paalanen" <ppaalanen@gmail.com>,
	Yann Dirson <ydirson@free.fr>, Daniel Vetter <daniel@ffwll.ch>
Cc: <linux-doc@vger.kernel.org>, <qingqing.zhuo@amd.com>,
	<roman.li@amd.com>, <amd-gfx@lists.freedesktop.org>,
	<aurabindo.pillai@amd.com>, <nicholas.choi@amd.com>,
	<dri-devel@lists.freedesktop.org>,
	Alex Deucher <alexander.deucher@amd.com>,
	<bhawanpreet.lakha@amd.com>,
	Christian Koenig <christian.koenig@amd.com>
Subject: [PATCH v4 2/6] Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry
Date: Thu, 9 Dec 2021 09:20:43 -0500	[thread overview]
Message-ID: <20211209142047.728572-3-Rodrigo.Siqueira@amd.com> (raw)
In-Reply-To: <20211209142047.728572-1-Rodrigo.Siqueira@amd.com>

Display core provides a feature that makes it easy for users to debug
Multiple planes by enabling a visual notification at the bottom of each
plane. This commit introduces how to use such a feature.

Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
 Documentation/gpu/amdgpu/display/dc-debug.rst | 34 ++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/Documentation/gpu/amdgpu/display/dc-debug.rst b/Documentation/gpu/amdgpu/display/dc-debug.rst
index bbb8c3fc8eee..532cbbd64863 100644
--- a/Documentation/gpu/amdgpu/display/dc-debug.rst
+++ b/Documentation/gpu/amdgpu/display/dc-debug.rst
@@ -1,4 +1,36 @@
+========================
 Display Core Debug tools
 ========================
 
-TODO
+DC Debugfs
+==========
+
+Multiple Planes Debug
+---------------------
+
+If you want to enable or debug multiple planes in a specific user-space
+application, you can leverage a debug feature named visual confirm. For
+enabling it, you will need::
+
+  echo 1 > /sys/kernel/debug/dri/0/amdgpu_dm_visual_confirm
+
+You need to reload your GUI to see the visual confirmation. When the plane
+configuration changes or a full update occurs there will be a colored bar at
+the bottom of each hardware plane being drawn on the screen.
+
+* The color indicates the format - For example, red is AR24 and green is NV12
+* The height of the bar indicates the index of the plane
+* Pipe split can be observed if there are two bars with a difference in height
+  covering the same plane
+
+Consider the video playback case in which a video is played in a specific
+plane, and the desktop is drawn in another plane. The video plane should
+feature one or two green bars at the bottom of the video depending on pipe
+split configuration.
+
+* There should **not** be any visual corruption
+* There should **not** be any underflow or screen flashes
+* There should **not** be any black screens
+* There should **not** be any cursor corruption
+* Multiple plane **may** be briefly disabled during window transitions or
+  resizing but should come back after the action has finished
-- 
2.25.1


  parent reply	other threads:[~2021-12-09 14:21 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-09 14:20 [PATCH v4 0/6] Expand display core documentation Rodrigo Siqueira
2021-12-09 14:20 ` [PATCH v4 1/6] Documentation/gpu: Reorganize DC documentation Rodrigo Siqueira
2021-12-09 14:20 ` Rodrigo Siqueira [this message]
2021-12-09 14:20 ` [PATCH v4 3/6] Documentation/gpu: Document pipe split visual confirmation Rodrigo Siqueira
2021-12-09 14:20 ` [PATCH v4 4/6] Documentation/gpu: How to collect DTN log Rodrigo Siqueira
2021-12-09 14:20 ` [PATCH v4 6/6] Documentation/gpu: Add amdgpu and dc glossary Rodrigo Siqueira
2021-12-09 16:26 ` [PATCH v4 0/6] Expand display core documentation Harry Wentland
2021-12-09 21:04   ` Yann Dirson
2021-12-10 22:20     ` Rodrigo Siqueira Jordao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211209142047.728572-3-Rodrigo.Siqueira@amd.com \
    --to=rodrigo.siqueira@amd.com \
    --cc=Harry.Wentland@amd.com \
    --cc=alexander.deucher@amd.com \
    --cc=amd-gfx@lists.freedesktop.org \
    --cc=aurabindo.pillai@amd.com \
    --cc=bas@basnieuwenhuizen.nl \
    --cc=bhawanpreet.lakha@amd.com \
    --cc=christian.koenig@amd.com \
    --cc=contact@emersion.fr \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=marek.olsak@amd.com \
    --cc=markyacoub@chromium.org \
    --cc=michel@daenzer.net \
    --cc=nicholas.choi@amd.com \
    --cc=nicholas.kazlauskas@amd.com \
    --cc=ppaalanen@gmail.com \
    --cc=qingqing.zhuo@amd.com \
    --cc=roman.li@amd.com \
    --cc=seanpaul@chromium.org \
    --cc=subdiff@gmail.com \
    --cc=ydirson@free.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox