From: "Christian König" <ckoenig.leichtzumerken@gmail.com>
To: "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>,
"Simon Ser" <contact@emersion.fr>,
"Michel Dänzer" <michel@daenzer.net>,
"Bas Nieuwenhuizen" <bas@basnieuwenhuizen.nl>,
"Marek Olšák" <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>
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 König" <christian.koenig@amd.com>
Subject: Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
Date: Fri, 26 Nov 2021 11:35:03 +0100 [thread overview]
Message-ID: <aa16c8ca-1126-0f6f-c201-362a2abc2341@gmail.com> (raw)
In-Reply-To: <20211125153830.1352994-2-Rodrigo.Siqueira@amd.com>
Just a general comment. Could you name the new subdirectory "amdgpu"
instead?
DC is just a component of the amdgpu driver and I think it would sooner
or later make sense to group together the amdgpu documentation in one
folder.
Regards,
Christian.
Am 25.11.21 um 16:38 schrieb Rodrigo Siqueira:
> Display core documentation is not well organized, and it is hard to find
> information due to the lack of sections. This commit reorganizes the
> documentation layout, and it is preparation work for future changes.
>
> Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> ---
> Documentation/gpu/amdgpu-dc.rst | 74 -------------------
> .../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 4 +
> Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 29 ++++++++
> Documentation/gpu/amdgpu-dc/amdgpu-dm.rst | 42 +++++++++++
> Documentation/gpu/drivers.rst | 2 +-
> 5 files changed, 76 insertions(+), 75 deletions(-)
> delete mode 100644 Documentation/gpu/amdgpu-dc.rst
> create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
> create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dm.rst
>
> diff --git a/Documentation/gpu/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc.rst
> deleted file mode 100644
> index f7ff7e1309de..000000000000
> --- a/Documentation/gpu/amdgpu-dc.rst
> +++ /dev/null
> @@ -1,74 +0,0 @@
> -===================================
> -drm/amd/display - Display Core (DC)
> -===================================
> -
> -*placeholder - general description of supported platforms, what dc is, etc.*
> -
> -Because it is partially shared with other operating systems, the Display Core
> -Driver is divided in two pieces.
> -
> -1. **Display Core (DC)** contains the OS-agnostic components. Things like
> - hardware programming and resource management are handled here.
> -2. **Display Manager (DM)** contains the OS-dependent components. Hooks to the
> - amdgpu base driver and DRM are implemented here.
> -
> -It doesn't help that the entire package is frequently referred to as DC. But
> -with the context in mind, it should be clear.
> -
> -When CONFIG_DRM_AMD_DC is enabled, DC will be initialized by default for
> -supported ASICs. To force disable, set `amdgpu.dc=0` on kernel command line.
> -Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`.
> -
> -To determine if DC is loaded, search dmesg for the following entry:
> -
> -``Display Core initialized with <version number here>``
> -
> -AMDgpu Display Manager
> -======================
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :doc: overview
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> - :internal:
> -
> -Lifecycle
> ----------
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :doc: DM Lifecycle
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :functions: dm_hw_init dm_hw_fini
> -
> -Interrupts
> -----------
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
> - :doc: overview
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
> - :internal:
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq
> -
> -Atomic Implementation
> ----------------------
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :doc: atomic
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail
> -
> -Display Core
> -============
> -
> -**WIP**
> -
> -FreeSync Video
> ---------------
> -
> -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> - :doc: FreeSync Video
> diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
> new file mode 100644
> index 000000000000..bbb8c3fc8eee
> --- /dev/null
> +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
> @@ -0,0 +1,4 @@
> +Display Core Debug tools
> +========================
> +
> +TODO
> diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> new file mode 100644
> index 000000000000..3685b3b1ad64
> --- /dev/null
> +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> @@ -0,0 +1,29 @@
> +===================================
> +drm/amd/display - Display Core (DC)
> +===================================
> +
> +*placeholder - general description of supported platforms, what dc is, etc.*
> +
> +Because it is partially shared with other operating systems, the Display Core
> +Driver is divided in two pieces.
> +
> +1. **Display Core (DC)** contains the OS-agnostic components. Things like
> + hardware programming and resource management are handled here.
> +2. **Display Manager (DM)** contains the OS-dependent components. Hooks to the
> + amdgpu base driver and DRM are implemented here.
> +
> +It doesn't help that the entire package is frequently referred to as DC. But
> +with the context in mind, it should be clear.
> +
> +When CONFIG_DRM_AMD_DC is enabled, DC will be initialized by default for
> +supported ASICs. To force disable, set `amdgpu.dc=0` on kernel command line.
> +Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`.
> +
> +To determine if DC is loaded, search dmesg for the following entry:
> +
> +.. toctree::
> +
> + amdgpu-dm.rst
> + amdgpu-dc-debug.rst
> +
> +``Display Core initialized with <version number here>``
> diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dm.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dm.rst
> new file mode 100644
> index 000000000000..7ce31f89d9a0
> --- /dev/null
> +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dm.rst
> @@ -0,0 +1,42 @@
> +======================
> +AMDgpu Display Manager
> +======================
> +
> +.. contents:: Table of Contents
> + :depth: 3
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> + :doc: overview
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> + :internal:
> +
> +Lifecycle
> +=========
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> + :doc: DM Lifecycle
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> + :functions: dm_hw_init dm_hw_fini
> +
> +Interrupts
> +==========
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
> + :doc: overview
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
> + :internal:
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> + :functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq
> +
> +Atomic Implementation
> +=====================
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> + :doc: atomic
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
> + :functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail
> diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
> index b4a0ed3ca961..dffe52d837cd 100644
> --- a/Documentation/gpu/drivers.rst
> +++ b/Documentation/gpu/drivers.rst
> @@ -5,7 +5,7 @@ GPU Driver Documentation
> .. toctree::
>
> amdgpu
> - amdgpu-dc
> + amdgpu-dc/amdgpu-dc
> i915
> mcde
> meson
next prev parent reply other threads:[~2021-11-26 10:35 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-25 15:38 [PATCH 0/6] Expand display core documentation Rodrigo Siqueira
2021-11-25 15:38 ` [PATCH 1/6] Documentation/gpu: Reorganize DC documentation Rodrigo Siqueira
2021-11-26 10:35 ` Christian König [this message]
2021-11-26 15:40 ` Daniel Vetter
2021-11-26 15:42 ` Daniel Vetter
2021-11-29 12:06 ` Jani Nikula
2021-11-30 15:46 ` Rodrigo Siqueira Jordao
2021-11-30 15:48 ` Harry Wentland
2021-11-30 15:59 ` Rodrigo Siqueira Jordao
2021-11-30 16:03 ` Harry Wentland
2021-11-30 20:38 ` Yann Dirson
2021-11-25 15:38 ` [PATCH 2/6] Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry Rodrigo Siqueira
2021-11-25 15:38 ` [PATCH 3/6] Documentation/gpu: Document pipe split visual confirmation Rodrigo Siqueira
2021-11-25 15:38 ` [PATCH 4/6] Documentation/gpu: How to collect DTN log Rodrigo Siqueira
2021-11-25 15:38 ` [PATCH 5/6] Documentation/gpu: Add basic overview of DC pipeline Rodrigo Siqueira
2021-11-25 15:38 ` [PATCH 6/6] Documentation/gpu: Add DC glossary Rodrigo Siqueira
2021-11-29 20:08 ` Alex Deucher
2021-11-29 20:48 ` ydirson
2021-11-30 10:09 ` Christian König
2021-11-30 14:39 ` Alex Deucher
2021-11-30 15:53 ` Rodrigo Siqueira Jordao
2021-11-30 19:55 ` Yann Dirson
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=aa16c8ca-1126-0f6f-c201-362a2abc2341@gmail.com \
--to=ckoenig.leichtzumerken@gmail.com \
--cc=Harry.Wentland@amd.com \
--cc=Rodrigo.Siqueira@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=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 \
/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;
as well as URLs for NNTP newsgroup(s).