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 v2 0/6] Expand display core documentation Date: Thu, 2 Dec 2021 11:01:26 -0500 [thread overview] Message-ID: <20211202160132.2263330-1-Rodrigo.Siqueira@amd.com> (raw) Display Core (DC) is one of the components under amdgpu, and it has multiple features directly related to the KMS API. Unfortunately, we don't have enough documentation about DC in the upstream, which makes the life of some external contributors a little bit more challenging. For these reasons, this patchset reworks part of the DC documentation and introduces a new set of details on how the display core works on DCN IP. Another improvement that this documentation effort tries to bring is making explicit some of our hardware-specific details to guide user-space developers better. In my view, it is easier to review this series if you apply it in your local kernel and build the HTML version (make htmldocs). I'm suggesting this approach because I added a few SVG diagrams that will be easier to see in the HTML version. If you cannot build the documentation, try to open the SVG images while reviewing the content. In summary, in this series, you will find: 1. Patch 1: Re-arrange of display core documentation. This is preparation work for the other patches, but it is also a way to expand this documentation. 2. Patch 2 to 4: Document some common debug options related to display. 3. Patch 5: This patch provides an overview of how our display core next works and a brief explanation of each component. 4. Patch 6: We use a lot of acronyms in our driver; for this reason, we exposed a glossary with common terms used by display core. Please let us know what you think we can improve in this series and what kind of content you want to see for the next series. Changes since V1: - Group amdgpu documentation together. - Create index pages. - Mirror display folder in the documentation. - Divide glossary based on driver context. - Make terms more consistent and update CPLIB - Add new acronyms to the glossary Thanks Siqueira Rodrigo Siqueira (6): Documentation/gpu: Reorganize DC documentation Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry Documentation/gpu: Document pipe split visual confirmation Documentation/gpu: How to collect DTN log Documentation/gpu: Add basic overview of DC pipeline Documentation/gpu: Add amdgpu and dc glossary Documentation/gpu/amdgpu-dc.rst | 74 -- Documentation/gpu/amdgpu/amdgpu-glossary.rst | 47 + .../gpu/amdgpu/display/config_example.svg | 414 ++++++ Documentation/gpu/amdgpu/display/dc-debug.rst | 77 ++ .../gpu/amdgpu/display/dc-glossary.rst | 243 ++++ .../amdgpu/display/dc_pipeline_overview.svg | 1125 +++++++++++++++++ .../gpu/amdgpu/display/dcn-overview.rst | 168 +++ .../gpu/amdgpu/display/display-manager.rst | 42 + .../gpu/amdgpu/display/global_sync_vblank.svg | 485 +++++++ Documentation/gpu/amdgpu/display/index.rst | 29 + .../gpu/{amdgpu.rst => amdgpu/index.rst} | 25 +- Documentation/gpu/drivers.rst | 3 +- 12 files changed, 2653 insertions(+), 79 deletions(-) delete mode 100644 Documentation/gpu/amdgpu-dc.rst create mode 100644 Documentation/gpu/amdgpu/amdgpu-glossary.rst create mode 100644 Documentation/gpu/amdgpu/display/config_example.svg create mode 100644 Documentation/gpu/amdgpu/display/dc-debug.rst create mode 100644 Documentation/gpu/amdgpu/display/dc-glossary.rst create mode 100644 Documentation/gpu/amdgpu/display/dc_pipeline_overview.svg create mode 100644 Documentation/gpu/amdgpu/display/dcn-overview.rst create mode 100644 Documentation/gpu/amdgpu/display/display-manager.rst create mode 100644 Documentation/gpu/amdgpu/display/global_sync_vblank.svg create mode 100644 Documentation/gpu/amdgpu/display/index.rst rename Documentation/gpu/{amdgpu.rst => amdgpu/index.rst} (95%) -- 2.25.1
WARNING: multiple messages have this Message-ID (diff)
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 v2 0/6] Expand display core documentation Date: Thu, 2 Dec 2021 11:01:26 -0500 [thread overview] Message-ID: <20211202160132.2263330-1-Rodrigo.Siqueira@amd.com> (raw) Display Core (DC) is one of the components under amdgpu, and it has multiple features directly related to the KMS API. Unfortunately, we don't have enough documentation about DC in the upstream, which makes the life of some external contributors a little bit more challenging. For these reasons, this patchset reworks part of the DC documentation and introduces a new set of details on how the display core works on DCN IP. Another improvement that this documentation effort tries to bring is making explicit some of our hardware-specific details to guide user-space developers better. In my view, it is easier to review this series if you apply it in your local kernel and build the HTML version (make htmldocs). I'm suggesting this approach because I added a few SVG diagrams that will be easier to see in the HTML version. If you cannot build the documentation, try to open the SVG images while reviewing the content. In summary, in this series, you will find: 1. Patch 1: Re-arrange of display core documentation. This is preparation work for the other patches, but it is also a way to expand this documentation. 2. Patch 2 to 4: Document some common debug options related to display. 3. Patch 5: This patch provides an overview of how our display core next works and a brief explanation of each component. 4. Patch 6: We use a lot of acronyms in our driver; for this reason, we exposed a glossary with common terms used by display core. Please let us know what you think we can improve in this series and what kind of content you want to see for the next series. Changes since V1: - Group amdgpu documentation together. - Create index pages. - Mirror display folder in the documentation. - Divide glossary based on driver context. - Make terms more consistent and update CPLIB - Add new acronyms to the glossary Thanks Siqueira Rodrigo Siqueira (6): Documentation/gpu: Reorganize DC documentation Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry Documentation/gpu: Document pipe split visual confirmation Documentation/gpu: How to collect DTN log Documentation/gpu: Add basic overview of DC pipeline Documentation/gpu: Add amdgpu and dc glossary Documentation/gpu/amdgpu-dc.rst | 74 -- Documentation/gpu/amdgpu/amdgpu-glossary.rst | 47 + .../gpu/amdgpu/display/config_example.svg | 414 ++++++ Documentation/gpu/amdgpu/display/dc-debug.rst | 77 ++ .../gpu/amdgpu/display/dc-glossary.rst | 243 ++++ .../amdgpu/display/dc_pipeline_overview.svg | 1125 +++++++++++++++++ .../gpu/amdgpu/display/dcn-overview.rst | 168 +++ .../gpu/amdgpu/display/display-manager.rst | 42 + .../gpu/amdgpu/display/global_sync_vblank.svg | 485 +++++++ Documentation/gpu/amdgpu/display/index.rst | 29 + .../gpu/{amdgpu.rst => amdgpu/index.rst} | 25 +- Documentation/gpu/drivers.rst | 3 +- 12 files changed, 2653 insertions(+), 79 deletions(-) delete mode 100644 Documentation/gpu/amdgpu-dc.rst create mode 100644 Documentation/gpu/amdgpu/amdgpu-glossary.rst create mode 100644 Documentation/gpu/amdgpu/display/config_example.svg create mode 100644 Documentation/gpu/amdgpu/display/dc-debug.rst create mode 100644 Documentation/gpu/amdgpu/display/dc-glossary.rst create mode 100644 Documentation/gpu/amdgpu/display/dc_pipeline_overview.svg create mode 100644 Documentation/gpu/amdgpu/display/dcn-overview.rst create mode 100644 Documentation/gpu/amdgpu/display/display-manager.rst create mode 100644 Documentation/gpu/amdgpu/display/global_sync_vblank.svg create mode 100644 Documentation/gpu/amdgpu/display/index.rst rename Documentation/gpu/{amdgpu.rst => amdgpu/index.rst} (95%) -- 2.25.1
next reply other threads:[~2021-12-02 16:02 UTC|newest] Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-12-02 16:01 Rodrigo Siqueira [this message] 2021-12-02 16:01 ` [PATCH v2 0/6] Expand display core documentation Rodrigo Siqueira 2021-12-02 16:01 ` [PATCH v2 1/6] Documentation/gpu: Reorganize DC documentation Rodrigo Siqueira 2021-12-02 16:01 ` Rodrigo Siqueira 2021-12-02 16:01 ` [PATCH v2 2/6] Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry Rodrigo Siqueira 2021-12-02 16:01 ` Rodrigo Siqueira 2021-12-02 16:01 ` [PATCH v2 3/6] Documentation/gpu: Document pipe split visual confirmation Rodrigo Siqueira 2021-12-02 16:01 ` Rodrigo Siqueira 2021-12-02 16:01 ` [PATCH v2 4/6] Documentation/gpu: How to collect DTN log Rodrigo Siqueira 2021-12-02 16:01 ` Rodrigo Siqueira 2021-12-02 16:01 ` [PATCH v2 5/6] Documentation/gpu: Add basic overview of DC pipeline Rodrigo Siqueira 2021-12-03 21:06 ` Yann Dirson 2021-12-03 21:06 ` Yann Dirson 2021-12-03 21:06 ` Yann Dirson 2021-12-02 16:01 ` [PATCH v2 6/6] Documentation/gpu: Add amdgpu and dc glossary Rodrigo Siqueira 2021-12-02 16:01 ` Rodrigo Siqueira 2021-12-07 18:19 ` Daniel Vetter 2021-12-07 18:19 ` Daniel Vetter 2021-12-07 18:19 ` Daniel Vetter 2021-12-07 19:49 ` Yann Dirson 2021-12-07 19:49 ` Yann Dirson 2021-12-07 19:49 ` Yann Dirson 2021-12-08 15:46 ` Rodrigo Siqueira Jordao 2021-12-08 15:46 ` Rodrigo Siqueira Jordao 2021-12-08 15:46 ` Rodrigo Siqueira Jordao 2021-12-08 16:16 ` Yann Dirson 2021-12-08 16:16 ` Yann Dirson 2021-12-08 16:16 ` Yann Dirson 2021-12-08 16:29 ` Rodrigo Siqueira Jordao 2021-12-08 16:29 ` Rodrigo Siqueira Jordao 2021-12-08 16:29 ` 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=20211202160132.2263330-1-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: 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.