From: Rodrigo Siqueira Jordao <rjordrigo@amd.com> To: "Harry Wentland" <harry.wentland@amd.com>, "Jani Nikula" <jani.nikula@linux.intel.com>, "Daniel Vetter" <daniel@ffwll.ch>, "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>, "Christian König" <christian.koenig@amd.com> Cc: linux-doc@vger.kernel.org, "Mark Yacoub" <markyacoub@chromium.org>, "Marek Olšák" <marek.olsak@amd.com>, roman.li@amd.com, amd-gfx@lists.freedesktop.org, "Roman Gilg" <subdiff@gmail.com>, aurabindo.pillai@amd.com, nicholas.choi@amd.com, dri-devel@lists.freedesktop.org, "Alex Deucher" <alexander.deucher@amd.com>, "Sean Paul" <seanpaul@chromium.org>, qingqing.zhuo@amd.com, "Nicholas Kazlauskas" <nicholas.kazlauskas@amd.com>, bhawanpreet.lakha@amd.com, "Michel Dänzer" <michel@daenzer.net> Subject: Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation Date: Tue, 30 Nov 2021 10:59:51 -0500 [thread overview] Message-ID: <24a1be4c-0186-96ac-b238-059754a9f856@amd.com> (raw) In-Reply-To: <507bfbc5-4be4-9681-c768-efea7c0541d8@amd.com> On 2021-11-30 10:48 a.m., Harry Wentland wrote: > On 2021-11-30 10:46, Rodrigo Siqueira Jordao wrote: >> >> >> On 2021-11-29 7:06 a.m., Jani Nikula wrote: >>> On Fri, 26 Nov 2021, Daniel Vetter <daniel@ffwll.ch> wrote: >>>> On Thu, Nov 25, 2021 at 10:38:25AM -0500, Rodrigo Siqueira wrote: >>>>> 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 >>>> >>>> While we bikeshed names, I think it'd would make sense to call this >>>> overview.rst or intro.rst or similar, since it's meant to contain the >>>> overall toctree for everything amdgpu related (maybe there will be more in >>>> the future). >>> >>> index.rst? >>> >>> >> >> Hi, >> >> Thanks a lot for the suggestions; I will prepare a V2 that addresses all your comments. >> >> Ps.: If there is no objection, I'll rename amdgpu-dc to index as Jani suggested. >> > > SGTM, you mean amdgpu/index.rst, right? Yeah, but I'm also thinking about this new organization: 1. Create an amdgpu folder. 2. Inside amdgpu folder, I want to create a display folder. 3. Move all display documentation to the display folder and keep other amdgpu generic things under amdgpu. 4. Finally, inside the amdgpu folder, I'll create the index.rst for amdgpu, and inside the display folder, I will create a similar file. Does it make sense? Thanks > Harry > >> Thanks. >> >
WARNING: multiple messages have this Message-ID (diff)
From: Rodrigo Siqueira Jordao <rjordrigo@amd.com> To: "Harry Wentland" <harry.wentland@amd.com>, "Jani Nikula" <jani.nikula@linux.intel.com>, "Daniel Vetter" <daniel@ffwll.ch>, "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>, "Christian König" <christian.koenig@amd.com> Cc: linux-doc@vger.kernel.org, "Mark Yacoub" <markyacoub@chromium.org>, "Marek Olšák" <marek.olsak@amd.com>, roman.li@amd.com, amd-gfx@lists.freedesktop.org, "Nicholas Kazlauskas" <nicholas.kazlauskas@amd.com>, "Michel Dänzer" <michel@daenzer.net>, aurabindo.pillai@amd.com, nicholas.choi@amd.com, dri-devel@lists.freedesktop.org, "Alex Deucher" <alexander.deucher@amd.com>, "Sean Paul" <seanpaul@chromium.org>, qingqing.zhuo@amd.com, bhawanpreet.lakha@amd.com, "Roman Gilg" <subdiff@gmail.com> Subject: Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation Date: Tue, 30 Nov 2021 10:59:51 -0500 [thread overview] Message-ID: <24a1be4c-0186-96ac-b238-059754a9f856@amd.com> (raw) In-Reply-To: <507bfbc5-4be4-9681-c768-efea7c0541d8@amd.com> On 2021-11-30 10:48 a.m., Harry Wentland wrote: > On 2021-11-30 10:46, Rodrigo Siqueira Jordao wrote: >> >> >> On 2021-11-29 7:06 a.m., Jani Nikula wrote: >>> On Fri, 26 Nov 2021, Daniel Vetter <daniel@ffwll.ch> wrote: >>>> On Thu, Nov 25, 2021 at 10:38:25AM -0500, Rodrigo Siqueira wrote: >>>>> 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 >>>> >>>> While we bikeshed names, I think it'd would make sense to call this >>>> overview.rst or intro.rst or similar, since it's meant to contain the >>>> overall toctree for everything amdgpu related (maybe there will be more in >>>> the future). >>> >>> index.rst? >>> >>> >> >> Hi, >> >> Thanks a lot for the suggestions; I will prepare a V2 that addresses all your comments. >> >> Ps.: If there is no objection, I'll rename amdgpu-dc to index as Jani suggested. >> > > SGTM, you mean amdgpu/index.rst, right? Yeah, but I'm also thinking about this new organization: 1. Create an amdgpu folder. 2. Inside amdgpu folder, I want to create a display folder. 3. Move all display documentation to the display folder and keep other amdgpu generic things under amdgpu. 4. Finally, inside the amdgpu folder, I'll create the index.rst for amdgpu, and inside the display folder, I will create a similar file. Does it make sense? Thanks > Harry > >> Thanks. >> >
next prev parent reply other threads:[~2021-11-30 16:00 UTC|newest] Thread overview: 51+ 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 ` Rodrigo Siqueira 2021-11-25 15:38 ` [PATCH 1/6] Documentation/gpu: Reorganize DC documentation Rodrigo Siqueira 2021-11-25 15:38 ` Rodrigo Siqueira 2021-11-26 10:35 ` Christian König 2021-11-26 15:40 ` Daniel Vetter 2021-11-26 15:40 ` Daniel Vetter 2021-11-26 15:40 ` Daniel Vetter 2021-11-26 15:42 ` Daniel Vetter 2021-11-26 15:42 ` Daniel Vetter 2021-11-26 15:42 ` Daniel Vetter 2021-11-29 12:06 ` Jani Nikula 2021-11-29 12:06 ` Jani Nikula 2021-11-30 15:46 ` Rodrigo Siqueira Jordao 2021-11-30 15:46 ` Rodrigo Siqueira Jordao 2021-11-30 15:48 ` Harry Wentland 2021-11-30 15:48 ` Harry Wentland 2021-11-30 15:59 ` Rodrigo Siqueira Jordao [this message] 2021-11-30 15:59 ` Rodrigo Siqueira Jordao 2021-11-30 16:03 ` Harry Wentland 2021-11-30 16:03 ` Harry Wentland 2021-11-30 20:38 ` Yann Dirson 2021-11-30 20:38 ` Yann Dirson 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 ` Rodrigo Siqueira 2021-11-25 15:38 ` [PATCH 3/6] Documentation/gpu: Document pipe split visual confirmation Rodrigo Siqueira 2021-11-25 15:38 ` Rodrigo Siqueira 2021-11-25 15:38 ` [PATCH 4/6] Documentation/gpu: How to collect DTN log Rodrigo Siqueira 2021-11-25 15:38 ` 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-25 15:38 ` Rodrigo Siqueira 2021-11-29 20:08 ` Alex Deucher 2021-11-29 20:08 ` Alex Deucher 2021-11-29 20:08 ` Alex Deucher 2021-11-29 20:48 ` ydirson 2021-11-29 20:48 ` ydirson 2021-11-29 20:48 ` ydirson 2021-11-30 10:09 ` Christian König 2021-11-30 10:09 ` Christian König 2021-11-30 10:09 ` Christian König 2021-11-30 14:39 ` Alex Deucher 2021-11-30 14:39 ` Alex Deucher 2021-11-30 14:39 ` Alex Deucher 2021-11-30 15:53 ` Rodrigo Siqueira Jordao 2021-11-30 15:53 ` Rodrigo Siqueira Jordao 2021-11-30 15:53 ` Rodrigo Siqueira Jordao 2021-11-30 19:55 ` Yann Dirson 2021-11-30 19:55 ` Yann Dirson 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=24a1be4c-0186-96ac-b238-059754a9f856@amd.com \ --to=rjordrigo@amd.com \ --cc=Rodrigo.Siqueira@amd.com \ --cc=alexander.deucher@amd.com \ --cc=amd-gfx@lists.freedesktop.org \ --cc=aurabindo.pillai@amd.com \ --cc=bhawanpreet.lakha@amd.com \ --cc=christian.koenig@amd.com \ --cc=daniel@ffwll.ch \ --cc=dri-devel@lists.freedesktop.org \ --cc=harry.wentland@amd.com \ --cc=jani.nikula@linux.intel.com \ --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=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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.