* [PATCH 0/6] Expand display core documentation
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
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.
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 DC glossary
Documentation/gpu/amdgpu-dc.rst | 74 --
.../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 77 ++
Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 29 +
.../gpu/amdgpu-dc/amdgpu-dcn-overview.rst | 168 +++
Documentation/gpu/amdgpu-dc/amdgpu-dm.rst | 42 +
.../gpu/amdgpu-dc/config_example.svg | 414 ++++++
Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++
.../gpu/amdgpu-dc/dc_pipeline_overview.svg | 1125 +++++++++++++++++
.../gpu/amdgpu-dc/global_sync_vblank.svg | 485 +++++++
Documentation/gpu/drivers.rst | 2 +-
10 files changed, 2598 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-dcn-overview.rst
create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dm.rst
create mode 100644 Documentation/gpu/amdgpu-dc/config_example.svg
create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
create mode 100644 Documentation/gpu/amdgpu-dc/dc_pipeline_overview.svg
create mode 100644 Documentation/gpu/amdgpu-dc/global_sync_vblank.svg
--
2.25.1
^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH 0/6] Expand display core documentation
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: Alex Deucher, Christian König, aurabindo.pillai,
qingqing.zhuo, roman.li, nicholas.choi, bhawanpreet.lakha,
linux-doc, amd-gfx, dri-devel
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.
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 DC glossary
Documentation/gpu/amdgpu-dc.rst | 74 --
.../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 77 ++
Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 29 +
.../gpu/amdgpu-dc/amdgpu-dcn-overview.rst | 168 +++
Documentation/gpu/amdgpu-dc/amdgpu-dm.rst | 42 +
.../gpu/amdgpu-dc/config_example.svg | 414 ++++++
Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++
.../gpu/amdgpu-dc/dc_pipeline_overview.svg | 1125 +++++++++++++++++
.../gpu/amdgpu-dc/global_sync_vblank.svg | 485 +++++++
Documentation/gpu/drivers.rst | 2 +-
10 files changed, 2598 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-dcn-overview.rst
create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dm.rst
create mode 100644 Documentation/gpu/amdgpu-dc/config_example.svg
create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
create mode 100644 Documentation/gpu/amdgpu-dc/dc_pipeline_overview.svg
create mode 100644 Documentation/gpu/amdgpu-dc/global_sync_vblank.svg
--
2.25.1
^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-25 15:38 ` Rodrigo Siqueira
@ 2021-11-25 15:38 ` Rodrigo Siqueira
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
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
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: Alex Deucher, Christian König, aurabindo.pillai,
qingqing.zhuo, roman.li, nicholas.choi, bhawanpreet.lakha,
linux-doc, amd-gfx, dri-devel
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
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 2/6] Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry
2021-11-25 15:38 ` Rodrigo Siqueira
@ 2021-11-25 15:38 ` Rodrigo Siqueira
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
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>
---
.../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 34 ++++++++++++++++++-
1 file changed, 33 insertions(+), 1 deletion(-)
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
index bbb8c3fc8eee..532cbbd64863 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-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
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 2/6] Documentation/gpu: Document amdgpu_dm_visual_confirm debugfs entry
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: Alex Deucher, Christian König, aurabindo.pillai,
qingqing.zhuo, roman.li, nicholas.choi, bhawanpreet.lakha,
linux-doc, amd-gfx, dri-devel
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>
---
.../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 34 ++++++++++++++++++-
1 file changed, 33 insertions(+), 1 deletion(-)
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
index bbb8c3fc8eee..532cbbd64863 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-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
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 3/6] Documentation/gpu: Document pipe split visual confirmation
2021-11-25 15:38 ` Rodrigo Siqueira
@ 2021-11-25 15:38 ` Rodrigo Siqueira
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
Display core provides a feature that makes it easy for users to debug
Pipe Split. This commit introduces how to use such a debug option.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
.../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 28 +++++++++++++++++--
1 file changed, 26 insertions(+), 2 deletions(-)
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
index 532cbbd64863..6dbd21f7f59e 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
@@ -2,8 +2,18 @@
Display Core Debug tools
========================
-DC Debugfs
-==========
+DC Visual Confirmation
+======================
+
+Display core provides a feature named visual confirmation, which is a set of
+bars added at the scanout time by the driver to convey some specific
+information. In general, you can enable this debug option by using::
+
+ echo <N> > /sys/kernel/debug/dri/0/amdgpu_dm_visual_confirm
+
+Where `N` is an integer number for some specific scenarios that the developer
+wants to enable, you will see some of these debug cases in the following
+subsection.
Multiple Planes Debug
---------------------
@@ -34,3 +44,17 @@ split configuration.
* 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
+
+Pipe Split Debug
+----------------
+
+Sometimes we need to debug if DCN is splitting pipes correctly, and visual
+confirmation is also handy for this case. Similar to the MPO case, you can use
+the below command to enable visual confirmation::
+
+ echo 1 > /sys/kernel/debug/dri/0/amdgpu_dm_visual_confirm
+
+In this case, if you have a pipe split, you will see one small red bar at the
+bottom of the display covering the entire display width and another bar
+covering the second pipe. In other words, you will see a bit high bar in the
+second pipe.
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 3/6] Documentation/gpu: Document pipe split visual confirmation
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: Alex Deucher, Christian König, aurabindo.pillai,
qingqing.zhuo, roman.li, nicholas.choi, bhawanpreet.lakha,
linux-doc, amd-gfx, dri-devel
Display core provides a feature that makes it easy for users to debug
Pipe Split. This commit introduces how to use such a debug option.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
.../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 28 +++++++++++++++++--
1 file changed, 26 insertions(+), 2 deletions(-)
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
index 532cbbd64863..6dbd21f7f59e 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
@@ -2,8 +2,18 @@
Display Core Debug tools
========================
-DC Debugfs
-==========
+DC Visual Confirmation
+======================
+
+Display core provides a feature named visual confirmation, which is a set of
+bars added at the scanout time by the driver to convey some specific
+information. In general, you can enable this debug option by using::
+
+ echo <N> > /sys/kernel/debug/dri/0/amdgpu_dm_visual_confirm
+
+Where `N` is an integer number for some specific scenarios that the developer
+wants to enable, you will see some of these debug cases in the following
+subsection.
Multiple Planes Debug
---------------------
@@ -34,3 +44,17 @@ split configuration.
* 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
+
+Pipe Split Debug
+----------------
+
+Sometimes we need to debug if DCN is splitting pipes correctly, and visual
+confirmation is also handy for this case. Similar to the MPO case, you can use
+the below command to enable visual confirmation::
+
+ echo 1 > /sys/kernel/debug/dri/0/amdgpu_dm_visual_confirm
+
+In this case, if you have a pipe split, you will see one small red bar at the
+bottom of the display covering the entire display width and another bar
+covering the second pipe. In other words, you will see a bit high bar in the
+second pipe.
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 4/6] Documentation/gpu: How to collect DTN log
2021-11-25 15:38 ` Rodrigo Siqueira
@ 2021-11-25 15:38 ` Rodrigo Siqueira
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
Introduce how to collect DTN log from debugfs.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
index 6dbd21f7f59e..40c55a618918 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
@@ -58,3 +58,20 @@ In this case, if you have a pipe split, you will see one small red bar at the
bottom of the display covering the entire display width and another bar
covering the second pipe. In other words, you will see a bit high bar in the
second pipe.
+
+DTN Debug
+=========
+
+DC (DCN) provides an extensive log that dumps multiple details from our
+hardware configuration. Via debugfs, you can capture those status values by
+using Display Test Next (DTN) log, which can be captured via debugfs by using::
+
+ cat /sys/kernel/debug/dri/0/amdgpu_dm_dtn_log
+
+Since this log is updated accordingly with DCN status, you can also follow the
+change in real-time by using something like::
+
+ sudo watch -d cat /sys/kernel/debug/dri/0/amdgpu_dm_dtn_log
+
+When reporting a bug related to DC, consider attaching this log before and
+after you reproduce the bug.
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 4/6] Documentation/gpu: How to collect DTN log
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: Alex Deucher, Christian König, aurabindo.pillai,
qingqing.zhuo, roman.li, nicholas.choi, bhawanpreet.lakha,
linux-doc, amd-gfx, dri-devel
Introduce how to collect DTN log from debugfs.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
index 6dbd21f7f59e..40c55a618918 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst
@@ -58,3 +58,20 @@ In this case, if you have a pipe split, you will see one small red bar at the
bottom of the display covering the entire display width and another bar
covering the second pipe. In other words, you will see a bit high bar in the
second pipe.
+
+DTN Debug
+=========
+
+DC (DCN) provides an extensive log that dumps multiple details from our
+hardware configuration. Via debugfs, you can capture those status values by
+using Display Test Next (DTN) log, which can be captured via debugfs by using::
+
+ cat /sys/kernel/debug/dri/0/amdgpu_dm_dtn_log
+
+Since this log is updated accordingly with DCN status, you can also follow the
+change in real-time by using something like::
+
+ sudo watch -d cat /sys/kernel/debug/dri/0/amdgpu_dm_dtn_log
+
+When reporting a bug related to DC, consider attaching this log before and
+after you reproduce the bug.
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 5/6] Documentation/gpu: Add basic overview of DC pipeline
2021-11-25 15:38 ` Rodrigo Siqueira
` (4 preceding siblings ...)
(?)
@ 2021-11-25 15:38 ` Rodrigo Siqueira
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
This commit describes how DCN works by providing high-level diagrams
with an explanation of each component. In particular, it details the
Global Sync signals.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 22 +-
.../gpu/amdgpu-dc/amdgpu-dcn-overview.rst | 168 +++
.../gpu/amdgpu-dc/config_example.svg | 414 ++++++
.../gpu/amdgpu-dc/dc_pipeline_overview.svg | 1125 +++++++++++++++++
.../gpu/amdgpu-dc/global_sync_vblank.svg | 485 +++++++
5 files changed, 2203 insertions(+), 11 deletions(-)
create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dcn-overview.rst
create mode 100644 Documentation/gpu/amdgpu-dc/config_example.svg
create mode 100644 Documentation/gpu/amdgpu-dc/dc_pipeline_overview.svg
create mode 100644 Documentation/gpu/amdgpu-dc/global_sync_vblank.svg
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
index 3685b3b1ad64..2e45e83d9a2a 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
@@ -2,28 +2,28 @@
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.
+AMD display engine is partially shared with other operating systems; for this
+reason, our Display Core Driver is divided into 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.
+The display pipe is responsible for "scanning out" a rendered frame from the
+GPU memory (also called VRAM, FrameBuffer, etc.) to a display. In other words,
+it would:
-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`.
+1. Read frame information from memory;
+2. Perform required transformation;
+3. Send pixel data to sink devices.
-To determine if DC is loaded, search dmesg for the following entry:
+If you want to learn more about our driver details, take a look at the below
+table of content:
.. toctree::
+ amdgpu-dcn-overview.rst
amdgpu-dm.rst
amdgpu-dc-debug.rst
-``Display Core initialized with <version number here>``
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dcn-overview.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dcn-overview.rst
new file mode 100644
index 000000000000..47e9a70de8ae
--- /dev/null
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dcn-overview.rst
@@ -0,0 +1,168 @@
+=======================
+Display Core Next (DCN)
+=======================
+
+To equip our readers with the basic knowledge of how AMD Display Core Next
+(DCN) works, we need to start with an overview of the hardware pipeline. Below
+you can see a picture that provides a DCN overview, keep in mind that this is a
+generic diagram, and we have variations per ASIC.
+
+.. kernel-figure:: dc_pipeline_overview.svg
+
+Based on this diagram, we can pass through each block and briefly describe
+them:
+
+* **Display Controller Hub (DCHUB)**: This is the gateway between the Scalable
+ Data Port (SDP) and DCN. This component has multiple features, such as memory
+ arbitration, rotation, and cursor manipulation.
+
+* **Display Pipe and Plane (DPP)**: This block provides pre-blend pixel
+ processing such as color space conversion, linearization of pixel data, tone
+ mapping, and gamut mapping.
+
+* **Multiple Pipe/Plane Combined (MPC)**: This component performs blending of
+ multiple planes, using global or per-pixel alpha.
+
+* **Output Pixel Processing (OPP)**: Process and format pixels to be sent to
+ the display.
+
+* **Output Pipe Timing Combiner (OPTC)**: It generates time output to combine
+ streams or divide capabilities. CRC values are generated in this block.
+
+* **Display Output (DIO)**: Codify the output to the display connected to our
+ GPU.
+
+* **Display Writeback (DWB)**: It provides the ability to write the output of
+ the display pipe back to memory as video frames.
+
+* **DCN Management Unit (DMU)**: It provides registers with access control and
+ interrupts the controller to the SOC host interrupt unit. This block includes
+ the Display Micro-Controller Unit - version B (DMCUB), which is handled via
+ firmware.
+
+* **DCN Clock Generator Block (DCCG)**: It provides the clocks and resets
+ for all of the display controller clock domains.
+
+* **Azalia (AZ)**: Audio engine.
+
+The above diagram is an architecture generalization of DCN, which means that
+every ASIC has variations around this base model. Notice that the display
+pipeline is connected to the Scalable Data Port (SDP) via DCHUB; you can see
+the SDP as the element from our Data Fabric that feeds the display pipe.
+
+Always approach the DCN architecture as something flexible that can be
+configured and reconfigured in multiple ways; in other words, each block can be
+setup or ignored accordingly with userspace demands. For example, if we
+want to drive an 8k@60Hz with a DSC enabled, our DCN may require 4 DPP and 2
+OPP. It is DC's responsibility to drive the best configuration for each
+specific scenario. Orchestrate all of these components together requires a
+sophisticated communication interface which is highlighted in the diagram by
+the edges that connect each block; from the chart, each connection between
+these blocks represents:
+
+1. Pixel data interface (red): Represents the pixel data flow;
+2. Global sync signals (green): It is a set of synchronization signals composed
+ by VStartup, VUpdate, and VReady;
+3. Config interface: Responsible to configure blocks;
+4. Sideband signals: All other signals that do not fit the previous one.
+
+These signals are essential and play an important role in DCN. Nevertheless,
+the Global Sync deserves an extra level of detail described in the next
+section.
+
+All of these components are represented by a data structure named dc_state.
+From DCHUB to MPC, we have a representation called dc_plane; from MPC to OPTC,
+we have dc_stream, and the output (DIO) is handled by dc_link. Keep in mind
+that HUBP accesses a surface using a specific format read from memory, and our
+dc_plane should work to convert all pixels in the plane to something that can
+be sent to the display via dc_stream and dc_link.
+
+Front End and Back End
+----------------------
+
+Display pipeline can be broken down into two components that are usually
+referred as **Front End (FE)** and **Back End (BE)**, where FE consists of:
+
+* DCHUB (Mainly referring to a subcomponent named HUBP)
+* DPP
+* MPC
+
+On the other hand, BE consist of
+
+* OPP
+* OPTC
+* DIO (DP/HDMI stream encoder and link encoder)
+
+OPP and OPTC are two joining blocks between FE and BE. On a side note, this is
+a one-to-one mapping of the link encoder to PHY, but we can configure the DCN
+to choose which link encoder to connect to which PHY. FE's main responsibility
+is to change, blend and compose pixel data, while BE's job is to frame a
+generic pixel stream to a specific display's pixel stream.
+
+Data Flow
+---------
+
+Initially, data is passed in from VRAM through Data Fabric (DF) in native pixel
+formats. Such data format stays through till HUBP in DCHUB, where HUBP unpacks
+different pixel formats and outputs them to DPP in uniform streams through 4
+channels (1 for alpha + 3 for colors).
+
+The Converter and Cursor (CNVC) in DPP would then normalize the data
+representation and convert them to a DCN specific floating-point format (i.e.,
+different from the IEEE floating-point format). In the process, CNVC also
+applies a degamma function to transform the data from non-linear to linear
+space to relax the floating-point calculations following. Data would stay in
+this floating-point format from DPP to OPP.
+
+Starting OPP, because color transformation and blending have been completed
+(i.e alpha can be dropped), and the end sinks do not require the precision and
+dynamic range that floating points provide (i.e. all displays are in integer
+depth format), bit-depth reduction/dithering would kick in. In OPP, we would
+also apply a regamma function to introduce the gamma removed earlier back.
+Eventually, we output data in integer format at DIO.
+
+Global Sync
+-----------
+
+Many DCN registers are double buffered, most importantly the surface address.
+This allows us to updated DCN hardware atomically for page flips, as well as
+for most other updates that don't require enabling or disabling of new pipes.
+
+(Note: There are many scenarios when DC will decide to reserve extra pipes
+in order to support outputs that need a very high pixel clock, or for
+power saving purposes.)
+
+These atomic register updates are driven by global sync signals in DCN. In
+order to understand how atomic updates interact with DCN hardware, and how DCN
+signals page flip and vblank events it is helpful to understand how global sync
+is programmed.
+
+Global sync consists of three signals, VSTARTUP, VUPDATE, and VREADY. These are
+calculated by the Display Mode Library - DML (drivers/gpu/drm/amd/display/dc/dml)
+based on a large number of parameters and ensure our hardware is able to feed
+the DCN pipeline without underflows or hangs in any given system configuration.
+The global sync signals always happen during VBlank, are independent from the
+VSync signal, and do not overlap each other.
+
+VUPDATE is the only signal that is of interest to the rest of the driver stack
+or userspace clients as it signals the point at which hardware latches to
+atomically programmed (i.e. double buffered) registers. Even though it is
+independent of the VSync signal we use VUPDATE to signal the VSync event as it
+provides the best indication of how atomic commits and hardware interact.
+
+Since DCN hardware is double-buffered the DC driver is able to program the
+hardware at any point during the frame.
+
+The below picture illustrates the global sync signals:
+
+.. kernel-figure:: global_sync_vblank.svg
+
+These signals affect core DCN behavior. Programming them incorrectly will lead
+to a number of negative consequences, most of them quite catastrophic.
+
+The following picture shows how global sync allows for a mailbox style of
+updates, i.e. it allows for multiple re-configurations between VUpdate
+events where only the last configuration programmed before the VUpdate signal
+becomes effective.
+
+.. kernel-figure:: config_example.svg
diff --git a/Documentation/gpu/amdgpu-dc/config_example.svg b/Documentation/gpu/amdgpu-dc/config_example.svg
new file mode 100644
index 000000000000..cdac9858601c
--- /dev/null
+++ b/Documentation/gpu/amdgpu-dc/config_example.svg
@@ -0,0 +1,414 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ width="144.63406mm"
+ height="66.596054mm"
+ viewBox="0 0 144.15195 66.596054"
+ version="1.1"
+ id="svg8"
+ inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
+ sodipodi:docname="config_example.svg">
+ <defs
+ id="defs2">
+ <marker
+ inkscape:stockid="Arrow1Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Mend"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path4547"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.4,0,0,-0.4,-4,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Mend-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path4547-6"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.4,0,0,-0.4,-4,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Mend-3-5"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path4547-6-3"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.4,0,0,-0.4,-4,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Mend-3-5-0"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path4547-6-3-6"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.4,0,0,-0.4,-4,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Mend-3-5-7"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path4547-6-3-3"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.4,0,0,-0.4,-4,0)" />
+ </marker>
+ </defs>
+ <sodipodi:namedview
+ id="base"
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1.0"
+ inkscape:pageopacity="0.0"
+ inkscape:pageshadow="2"
+ inkscape:zoom="0.98994949"
+ inkscape:cx="518.91791"
+ inkscape:cy="172.50112"
+ inkscape:document-units="mm"
+ inkscape:current-layer="layer1"
+ showgrid="true"
+ viewbox-width="209.3"
+ inkscape:window-width="3840"
+ inkscape:window-height="1136"
+ inkscape:window-x="0"
+ inkscape:window-y="27"
+ inkscape:window-maximized="1"
+ fit-margin-top="0"
+ fit-margin-left="0"
+ fit-margin-right="0"
+ fit-margin-bottom="0">
+ <inkscape:grid
+ type="xygrid"
+ id="grid817"
+ originx="4.390216"
+ originy="-208.88856" />
+ </sodipodi:namedview>
+ <metadata
+ id="metadata5">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+ <dc:title></dc:title>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(4.4048992,-21.515392)">
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 20.816662,35.062492 h 23.8125 v -5.291667 h 5.291667 v 5.291667 h 10.583334 v -5.291667 h 5.291667 v 5.291667 h 2.645833 v -5.291667 h 5.291667 v 5.291667 h 66.14583"
+ id="path4522"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 20.816662,48.291659 h 7.9375 v -5.291667 h 5.291667 v 5.291667 h 58.208335 v -5.291667 h 5.291666 v 5.291667 h 42.33333"
+ id="path4524"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="m 20.816662,61.520826 h 26.458334 v -5.291667 h 44.979168 v 5.291667 h 47.624996"
+ id="path4526"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="M 20.816662,72.104159 H 139.87916"
+ id="path4528"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="M 20.816662,77.395826 H 139.87916"
+ id="path4530"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="M 20.816662,82.687493 H 139.87916"
+ id="path4532"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.26458335px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ d="M 20.816662,87.97916 H 139.87916"
+ id="path4534"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916668, 0.52916668;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Mend)"
+ d="m 47.274996,29.770826 c 3.836215,14.933158 3.472151,27.586643 0.264583,41.010418"
+ id="path4536"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916669, 0.52916669;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Mend-3)"
+ d="m 63.149996,29.770826 c 3.836214,14.933158 5.059652,27.586642 1.852084,41.010418"
+ id="path4536-7"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.5291667, 0.5291667;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Mend-3-5)"
+ d="m 71.087496,29.770825 c 3.836214,14.933158 5.059652,27.586643 1.852084,41.010419"
+ id="path4536-7-5"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="59.359009"
+ y="24.195677"
+ id="text6572"><tspan
+ sodipodi:role="line"
+ x="59.359009"
+ y="24.195677"
+ style="font-size:3.52777791px;line-height:5.39999962;text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan6574">Configurations</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="46.825508"
+ y="28.542402"
+ id="text6572-6"><tspan
+ sodipodi:role="line"
+ x="46.825508"
+ y="28.542402"
+ style="font-size:3.52777815px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#008000;stroke-width:0.26458335"
+ id="tspan6574-2">A</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="62.8895"
+ y="28.825886"
+ id="text6572-6-2"><tspan
+ sodipodi:role="line"
+ x="62.8895"
+ y="28.825886"
+ style="font-size:3.52777839px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#0000ff;stroke-width:0.26458335"
+ id="tspan6574-2-7">B</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="70.827003"
+ y="29.109362"
+ id="text6572-6-2-3"><tspan
+ sodipodi:role="line"
+ x="70.827003"
+ y="29.109362"
+ style="font-size:3.52777863px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#c87137;stroke-width:0.26458335"
+ id="tspan6574-2-7-6">C</tspan></text>
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916671, 0.52916671;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Mend-3-5-0)"
+ d="m 92.254164,42.999993 c 9.142136,12.745655 4.411987,28.608461 0.529167,38.364584"
+ id="path4536-7-5-2"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 47.274996,72.104159 v 5.291667"
+ id="path8053"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 64.472913,72.10416 v 5.291667"
+ id="path8053-6"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 72.410413,72.10416 v 5.291667"
+ id="path8053-6-1"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 92.254164,82.687494 v 5.291667"
+ id="path8053-6-1-8"
+ inkscape:connector-curvature="0" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="55.802444"
+ y="76.167412"
+ id="text6572-6-7"><tspan
+ sodipodi:role="line"
+ x="55.802444"
+ y="76.167412"
+ style="font-size:3.52777839px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#008000;stroke-width:0.26458335"
+ id="tspan6574-2-9">A</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="68.559143"
+ y="75.883926"
+ id="text6572-6-2-2"><tspan
+ sodipodi:role="line"
+ x="68.559143"
+ y="75.883926"
+ style="font-size:3.52777863px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#0000ff;stroke-width:0.26458335"
+ id="tspan6574-2-7-0">B</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="84.812119"
+ y="75.883911"
+ id="text6572-6-2-3-2"><tspan
+ sodipodi:role="line"
+ x="84.812119"
+ y="75.883911"
+ style="font-size:3.52777863px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#c87137;stroke-width:0.26458335"
+ id="tspan6574-2-7-6-3">C</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="98.513756"
+ y="86.845222"
+ id="text6572-6-2-3-2-7"><tspan
+ sodipodi:role="line"
+ x="98.513756"
+ y="86.845222"
+ style="font-size:3.52777863px;line-height:5.39999962;text-align:center;text-anchor:middle;fill:#c87137;stroke-width:0.26458335"
+ id="tspan6574-2-7-6-3-5">C</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="35.452015"
+ y="75.694931"
+ id="text6572-9"><tspan
+ sodipodi:role="line"
+ x="35.452015"
+ y="75.694931"
+ style="font-size:3.52777815px;line-height:5.39999962;text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan6574-22">Old config</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="55.484753"
+ y="86.656235"
+ id="text6572-9-8"><tspan
+ sodipodi:role="line"
+ x="55.484753"
+ y="86.656235"
+ style="font-size:3.52777839px;line-height:5.39999962;text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan6574-22-9">Old config</tspan></text>
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916671, 0.52916671;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Mend-3-5-7)"
+ d="m 92.254164,42.999993 c 4.233333,4.7625 2.645833,13.229167 0.79375,17.197917"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:10.58333397px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="3.7020128"
+ y="33.550579"
+ id="text6572-1"><tspan
+ sodipodi:role="line"
+ x="3.7020128"
+ y="42.914349"
+ style="font-size:3.52777815px;line-height:5.39999962;text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15310" /></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17500019px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="13.366468"
+ y="46.590767"
+ id="text15316"><tspan
+ sodipodi:role="line"
+ x="13.366468"
+ y="46.590767"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15318">VUpdate</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17500043px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="14.45245"
+ y="29.676321"
+ id="text15316-3"><tspan
+ sodipodi:role="line"
+ id="tspan15314-1"
+ x="14.45245"
+ y="29.676321"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335">Update</tspan><tspan
+ sodipodi:role="line"
+ x="14.45245"
+ y="33.645073"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15318-9">Lock</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17500043px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="7.5676007"
+ y="56.985115"
+ id="text15316-4"><tspan
+ sodipodi:role="line"
+ x="7.5676007"
+ y="56.985115"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15318-7">Register update</tspan><tspan
+ sodipodi:role="line"
+ x="7.5676007"
+ y="60.953865"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15361">Pending Status</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17500043px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="16.074829"
+ y="76.167404"
+ id="text15316-8"><tspan
+ sodipodi:role="line"
+ x="16.074829"
+ y="76.167404"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15318-4">Buf 0</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17500067px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458335"
+ x="16.156994"
+ y="86.089279"
+ id="text15316-8-5"><tspan
+ sodipodi:role="line"
+ x="16.156994"
+ y="86.089279"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458335"
+ id="tspan15318-4-0">Buf 1</tspan></text>
+ </g>
+</svg>
diff --git a/Documentation/gpu/amdgpu-dc/dc_pipeline_overview.svg b/Documentation/gpu/amdgpu-dc/dc_pipeline_overview.svg
new file mode 100644
index 000000000000..9adecebfe65b
--- /dev/null
+++ b/Documentation/gpu/amdgpu-dc/dc_pipeline_overview.svg
@@ -0,0 +1,1125 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ width="1296.7491"
+ height="741.97845"
+ viewBox="0 0 343.0982 196.31514"
+ version="1.1"
+ id="svg8"
+ inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
+ sodipodi:docname="dc_pipeline_overview.svg">
+ <defs
+ id="defs2">
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker8858"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path8616"
+ style="fill:#aa00d4;fill-opacity:1;fill-rule:evenodd;stroke:#aa00d4;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Send"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path8622"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lend"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path8592"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Lend"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path8610"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-1.1,0,0,-1.1,-1.1,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path1200"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-2"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-9"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-2-1"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-9-9"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-2-7"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-9-8"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-4"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-5"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-0"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-3"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-6"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-1"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-2-6"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-9-1"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-0-7"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-3-4"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-6-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-1-0"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-2-8"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-9-6"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path1200-6"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker8858-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path8616-5"
+ style="fill:#00ffcc;fill-opacity:1;fill-rule:evenodd;stroke:#00ffcc;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-3-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-6-56"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-8-0-2"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path1200-9-3-9"
+ style="fill:#008000;fill-opacity:1;fill-rule:evenodd;stroke:#008000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ </defs>
+ <sodipodi:namedview
+ id="base"
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1.0"
+ inkscape:pageopacity="0.0"
+ inkscape:pageshadow="2"
+ inkscape:zoom="2.8"
+ inkscape:cx="603.80172"
+ inkscape:cy="404.14319"
+ inkscape:document-units="mm"
+ inkscape:current-layer="layer1"
+ showgrid="false"
+ inkscape:window-width="3840"
+ inkscape:window-height="2096"
+ inkscape:window-x="0"
+ inkscape:window-y="27"
+ inkscape:window-maximized="1"
+ showguides="false"
+ fit-margin-top="0"
+ fit-margin-left="0"
+ fit-margin-right="0"
+ fit-margin-bottom="0"
+ units="px"
+ inkscape:snap-global="false" />
+ <metadata
+ id="metadata5">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+ <dc:title />
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(419.79645,20.103767)">
+ <path
+ style="fill:#008000;stroke:#008000;stroke-width:0.59275198;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-2-7)"
+ d="m -340.37552,57.5332 h -14.81024"
+ id="path1171-7-1-3-0"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#008000;stroke:#008000;stroke-width:0.59715915;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-4)"
+ d="m -293.23443,57.5332 h -15.03129"
+ id="path1171-7-1-32"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#008000;stroke:#008000;stroke-width:0.59275198;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-0)"
+ d="M -246.45946,57.5332 H -261.2697"
+ id="path1171-7-6"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#008000;stroke:#008000;stroke-width:0.59275198;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-6)"
+ d="m -151.28623,57.5332 h -14.81024"
+ id="path1171-0"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.98222464;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-2-6)"
+ d="m -310.11621,-10.988713 h -35.41856"
+ id="path1171-7-1-3-5"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:1.33745635;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-2-1)"
+ d="M -174.42569,48.441117 V -10.963061 L -277.26548,-11.45916"
+ id="path1171-7-1-3-4"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccc" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.95872593;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3)"
+ d="m -262.79442,87.935594 h 14.32069"
+ id="path1171-7-1"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.97006679;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8)"
+ d="m -309.80088,87.935594 h 14.44587"
+ id="path1171-7"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.96187615;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend)"
+ d="m -356.45657,87.935594 h 14.20296"
+ id="path1171"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.96061862;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-2)"
+ d="m -167.44556,87.935594 h 14.16584"
+ id="path1171-7-1-3"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008000;stroke-width:0.87091714;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-0-7)"
+ d="M -193.82812,48.312503 V 14.168502 l -84.03577,-0.467726"
+ id="path1171-7-6-4"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -133.33998,42.989657 v 5.457081"
+ id="path7149-3-7"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -298.69506,162.44998 v 13.31197"
+ id="path7149"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -242.80131,107.00907 v 9.60171"
+ id="path7040-5-4-7-5-6-9"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -300.34873,107.17445 v 9.6017"
+ id="path7040-5-4-7-5-6"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -359.26293,106.99745 v 9.60171"
+ id="path7040-5-4-7-5"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -369.74543,25.114933 V 37.991587"
+ id="path7040-5-4-7-6"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.91136348;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.91136346, 0.91136346;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -135.17034,93.582486 V 107.10642 H -403.93077 V 37.882965 h 109.60575 V 25.225991"
+ id="path7038"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cccccc" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -231.106,94.010086 V 106.96943"
+ id="path7040"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -278.50224,93.844719 V 106.80406"
+ id="path7040-5"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -325.89848,93.701083 V 106.99115"
+ id="path7040-5-4"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -373.29471,93.899037 V 107.27179"
+ id="path7040-5-4-7"
+ inkscape:connector-curvature="0" />
+ <g
+ id="g934"
+ transform="matrix(0.61872421,0,0,0.61872421,-154.16506,-3.5724799)">
+ <rect
+ ry="2.1052283e-06"
+ y="84.280701"
+ x="-376.383"
+ height="72.786827"
+ width="49.352299"
+ id="rect834"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ <text
+ id="text838"
+ y="95.916664"
+ x="-371.17261"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="stroke-width:0.26458332"
+ y="95.916664"
+ x="-371.17261"
+ id="tspan836"
+ sodipodi:role="line">DCHUB</tspan></text>
+ <text
+ id="text846"
+ y="121.99702"
+ x="-352.74997"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="121.99702"
+ x="-352.74997"
+ id="tspan844"
+ sodipodi:role="line">HUBP</tspan><tspan
+ id="tspan863"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="135.22618"
+ x="-352.74997"
+ sodipodi:role="line">(n)</tspan></text>
+ </g>
+ <g
+ id="g942"
+ transform="matrix(0.61872421,0,0,0.61872421,-158.40385,-3.2216813)">
+ <text
+ id="text838-5"
+ y="116.65257"
+ x="-269.45752"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="116.65257"
+ x="-269.45752"
+ id="tspan836-3"
+ sodipodi:role="line">DPP</tspan><tspan
+ id="tspan936"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="129.88174"
+ x="-269.45752"
+ sodipodi:role="line">(n)</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="83.71373"
+ x="-293.7952"
+ height="72.786827"
+ width="49.352303"
+ id="rect834-5"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1158"
+ transform="matrix(0.61872421,0,0,0.61872421,-154.34048,-6.2618995)">
+ <text
+ id="text838-5-2"
+ y="128.87331"
+ x="-200.18195"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="128.87331"
+ x="-200.18195"
+ sodipodi:role="line">MPC</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="88.627419"
+ x="-224.62555"
+ height="72.786827"
+ width="49.352303"
+ id="rect834-5-2"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1153"
+ transform="matrix(0.61872421,0,0,0.61872421,-108.51628,-6.4957668)">
+ <text
+ id="text838-5-2-7"
+ y="129.2513"
+ x="-120.96272"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-0"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="129.2513"
+ x="-120.96272"
+ sodipodi:role="line">OPTC</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="89.005402"
+ x="-145.62854"
+ height="72.786827"
+ width="49.352306"
+ id="rect834-5-2-9"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1148"
+ transform="matrix(0.61872421,0,0,0.61872421,-105.25474,-7.6650796)">
+ <text
+ id="text838-5-2-7-3"
+ y="131.14117"
+ x="-48.981136"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-0-6"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="131.14117"
+ x="-48.981136"
+ sodipodi:role="line">DIO</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="90.895279"
+ x="-73.435081"
+ height="72.786827"
+ width="49.352306"
+ id="rect834-5-2-9-0"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1133"
+ transform="matrix(0.61872421,0,0,0.61872421,-181.52704,-7.6650796)">
+ <text
+ id="text838-5-2-6"
+ y="241.13223"
+ x="-286.96921"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-2"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="241.13223"
+ x="-286.96921"
+ sodipodi:role="line">DCCG</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="200.88634"
+ x="-311.56009"
+ height="72.786827"
+ width="49.352306"
+ id="rect834-5-2-6"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1138"
+ transform="matrix(0.61872421,0,0,0.61872421,-181.52704,-7.6650796)">
+ <text
+ id="text838-5-2-6-1"
+ y="241.81844"
+ x="-190.55942"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-2-8"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="241.81844"
+ x="-190.55942"
+ sodipodi:role="line">DMU</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="201.6423"
+ x="-215.17615"
+ height="72.786827"
+ width="49.352306"
+ id="rect834-5-2-6-7"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:6.54816437px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.1637041"
+ x="-297.75696"
+ y="109.44505"
+ id="text1063"><tspan
+ sodipodi:role="line"
+ id="tspan1061"
+ x="-297.75696"
+ y="115.23865"
+ style="stroke-width:0.1637041" /></text>
+ <g
+ id="g1143"
+ transform="matrix(0.61872421,0,0,0.61872421,-181.52704,-8.9747125)">
+ <text
+ id="text838-5-2-6-1-9"
+ y="243.02728"
+ x="-99.967323"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-2-8-2"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="243.02728"
+ x="-99.967323"
+ sodipodi:role="line">AZ</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="202.77623"
+ x="-124.83984"
+ height="72.786827"
+ width="49.352306"
+ id="rect834-5-2-6-7-0"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1169"
+ transform="matrix(0.61872421,0,0,0.61872421,-154.16506,1.4555785)">
+ <text
+ id="text838-5-2-6-2"
+ y="5.9612885"
+ x="-348.74365"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-2-3"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="5.9612885"
+ x="-348.74365"
+ sodipodi:role="line">MMHUBBUB</tspan></text>
+ <rect
+ ry="2.1010696e-06"
+ y="-34.142948"
+ x="-384.64743"
+ height="72.643044"
+ width="72.096924"
+ id="rect834-5-2-6-75"
+ style="fill:none;stroke:#000000;stroke-width:1.40378118;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <g
+ id="g1164"
+ transform="matrix(0.61872421,0,0,0.61872421,-154.16506,-7.6650796)">
+ <text
+ id="text838-5-2-6-9"
+ y="13.465075"
+ x="-227.30836"
+ style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ xml:space="preserve"><tspan
+ id="tspan936-1-2-2"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="13.465075"
+ x="-227.30836"
+ sodipodi:role="line">DWB</tspan><tspan
+ id="tspan1128"
+ style="text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ y="26.694241"
+ x="-227.30836"
+ sodipodi:role="line">(n)</tspan></text>
+ <rect
+ ry="2.1052283e-06"
+ y="-19.473768"
+ x="-251.83983"
+ height="72.786827"
+ width="49.352306"
+ id="rect834-5-2-6-2"
+ style="fill:none;stroke:#000000;stroke-width:1.16258347;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.91371936;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:5.48231601, 0.91371934;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -358.95963,161.63019 v 14.12431 h 250.20395 V 43.149938 H -361.845 V 25.478973"
+ id="path7147"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cccccc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -242.92533,161.58513 v 14.05612"
+ id="path7149-3"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -184.37695,42.955607 v 5.457082"
+ id="path7149-3-7-4"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -277.36283,43.141644 v 5.457082"
+ id="path7149-3-7-5"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -325.48437,42.976278 V 48.43336"
+ id="path7149-3-7-2"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112339, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -361.86492,43.141644 v 5.457083"
+ id="path7149-3-7-54"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#008000;stroke:#008000;stroke-width:0.46329758;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-6-3)"
+ d="m -147.58542,-8.2978166 h -9.04766"
+ id="path1171-0-7"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.98222464;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-2-8)"
+ d="m -157.13421,-1.6500501 h 8.66407"
+ id="path1171-7-1-3-8"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.74503672;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.47022031, 0.74503672;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -148.50314,4.9845652 h -7.91265"
+ id="path7149-3-7-8"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852057, 0.81852057;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -157.59442,11.623513 h 10.26991"
+ id="path7040-4"
+ inkscape:connector-curvature="0" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:6.54816437px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.1637041"
+ x="-142.72867"
+ y="-6.9685979"
+ id="text12079"><tspan
+ sodipodi:role="line"
+ id="tspan12077"
+ x="-142.72867"
+ y="-6.9685979"
+ style="font-size:4.80198765px;stroke-width:0.1637041">Global sync</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:6.54816437px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.1637041"
+ x="-142.93031"
+ y="0.13578746"
+ id="text12079-3"><tspan
+ sodipodi:role="line"
+ id="tspan12077-1"
+ x="-142.93031"
+ y="0.13578746"
+ style="font-size:4.80198765px;stroke-width:0.1637041">Pixel data</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:6.54816437px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.1637041"
+ x="-142.77556"
+ y="6.3093324"
+ id="text12079-3-4"><tspan
+ sodipodi:role="line"
+ id="tspan12077-1-9"
+ x="-142.77556"
+ y="6.3093324"
+ style="font-size:4.80198765px;stroke-width:0.1637041">Sideband signal</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:6.54816437px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.1637041"
+ x="-142.72867"
+ y="12.948278"
+ id="text12079-3-4-2"><tspan
+ sodipodi:role="line"
+ id="tspan12077-1-9-0"
+ x="-142.72867"
+ y="12.948278"
+ style="font-size:4.80198765px;stroke-width:0.1637041">Config. Bus</tspan></text>
+ <path
+ style="fill:none;stroke:#aa00d4;stroke-width:1.32291663;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker8858)"
+ d="m -406.68795,73.185276 h 14.20296"
+ id="path1171-75"
+ inkscape:connector-curvature="0" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-420.21503"
+ y="75.065918"
+ id="text8862"><tspan
+ sodipodi:role="line"
+ id="tspan8860"
+ x="-420.21503"
+ y="75.065918"
+ style="font-size:6.3499999px;stroke-width:0.26458332">SDP</tspan></text>
+ <path
+ style="fill:none;stroke:#00ffcc;stroke-width:1.25980031;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker8858-3)"
+ d="m -119.19923,72.243805 h 12.88004"
+ id="path1171-75-6"
+ inkscape:connector-curvature="0" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-104.87327"
+ y="74.54258"
+ id="text8862-2"><tspan
+ sodipodi:role="line"
+ id="tspan8860-9"
+ x="-104.87327"
+ y="74.54258"
+ style="font-size:6.3499999px;stroke-width:0.26458332">Monitor</tspan></text>
+ <g
+ id="g6280"
+ transform="translate(-133.43389,-37.35791)">
+ <text
+ id="text838-5-2-7-6"
+ y="110.67171"
+ x="-97.4758"
+ style="font-style:normal;font-weight:normal;font-size:6.54816437px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.16370411"
+ xml:space="preserve"><tspan
+ id="tspan936-1-0-7"
+ style="text-align:center;text-anchor:middle;stroke-width:0.16370411"
+ y="110.67171"
+ x="-97.4758"
+ sodipodi:role="line">OPP</tspan></text>
+ <rect
+ ry="1.3025557e-06"
+ y="85.770599"
+ x="-112.73714"
+ height="45.034973"
+ width="30.535467"
+ id="rect834-5-2-9-5"
+ style="fill:none;stroke:#000000;stroke-width:0.71931857;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none" />
+ </g>
+ <path
+ style="fill:#008000;stroke:#008000;stroke-width:0.59275198;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-0-2)"
+ d="m -199.6735,57.600919 h -14.81024"
+ id="path1171-7-6-1"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.95872593;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow2Mend-8-3-3)"
+ d="m -214.95012,88.003315 h 14.32069"
+ id="path1171-7-1-2"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#008080;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.81852058, 0.81852058;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -182.99565,94.057598 V 107.01694"
+ id="path7040-7"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.81852055;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.91112344, 0.81852058;stroke-dashoffset:0;stroke-opacity:1"
+ d="m -231.7616,43.563759 v 5.457082"
+ id="path7149-3-7-4-0"
+ inkscape:connector-curvature="0" />
+ <g
+ aria-label="["
+ transform="matrix(0,-1,0.74237844,0,14.567595,39.540924)"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ id="text6872">
+ <path
+ d="m -65.936923,-548.78511 h 8.816294 v 2.79112 h -6.82247 v 176.34952 h 6.82247 v 2.41314 h -8.816294 z"
+ style="font-size:50.79999924px;stroke-width:0.26458332"
+ id="path6874"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccc" />
+ </g>
+ <g
+ aria-label="["
+ transform="rotate(-90,182.49521,-144.01791)"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ id="text6872-3">
+ <path
+ d="m -63.825546,-623.34091 h 7.228794 v 2.26195 h -5.764137 l 0,127.08032 h 5.764137 v 1.88397 h -7.228794 z"
+ style="font-size:50.79999924px;stroke-width:0.26458332"
+ id="path6874-6"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccc" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-359.80389"
+ y="99.104233"
+ id="text6929"><tspan
+ sodipodi:role="line"
+ id="tspan6927"
+ x="-359.80389"
+ y="99.104233"
+ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:5.64444447px;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold';stroke-width:0.26458332">dc_plane</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-223.56163"
+ y="99.142021"
+ id="text6933"><tspan
+ sodipodi:role="line"
+ id="tspan6931"
+ x="-223.56163"
+ y="99.142021"
+ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:5.64444447px;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold';stroke-width:0.26458332">dc_stream</tspan></text>
+ <g
+ aria-label="["
+ transform="matrix(0,1,1,0,153.30551,96.566025)"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ id="text6872-35">
+ <path
+ d="m -65.936923,-545.95029 h 8.816294 v 2.79112 h -6.898066 v 271.78851 h 6.898066 v 2.41314 h -8.816294 z"
+ style="font-size:50.79999924px;stroke-width:0.26458332"
+ id="path6874-62"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccc" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-267.43958"
+ y="28.5028"
+ id="text6933-9"><tspan
+ sodipodi:role="line"
+ id="tspan6931-1"
+ x="-267.43958"
+ y="28.5028"
+ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:5.64444447px;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold';stroke-width:0.26458332">dc_state</tspan></text>
+ <g
+ aria-label="["
+ transform="matrix(0,0.98158883,-1.0187565,0,0,-7.4835468)"
+ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:6.62759447px;line-height:1.25;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.5522995"
+ id="text6973">
+ <path
+ d="m 23.679381,144.30265 h 3.028123 v 1.29445 h -1.820839 v 7.91629 h 1.820839 v 1.29445 h -3.028123 z"
+ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:11.78239059px;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold';stroke-width:0.5522995"
+ id="path6975"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccc" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-142.71655"
+ y="18.955769"
+ id="text6980"><tspan
+ sodipodi:role="line"
+ id="tspan6978"
+ x="-142.71655"
+ y="18.955769"
+ style="font-size:4.58611107px;stroke-width:0.26458332">Code struct</tspan></text>
+ <g
+ aria-label="["
+ transform="rotate(-90,94.826273,-58.762727)"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ id="text6872-35-2">
+ <path
+ d="m -66.881863,-308.95922 h 7.115401 l 0,1.69499 h -5.197173 v 42.03568 h 5.197173 v 1.78948 h -7.115401 z"
+ style="font-size:50.79999924px;stroke-width:0.26458332"
+ id="path6874-62-7"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccc" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-134.09625"
+ y="99.354439"
+ id="text6933-9-0"><tspan
+ sodipodi:role="line"
+ id="tspan6931-1-9"
+ x="-134.09625"
+ y="99.354439"
+ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:5.64444447px;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold';stroke-width:0.26458332">dc_link</tspan></text>
+ <g
+ aria-label="}"
+ transform="rotate(90,-145.27371,-140.09832)"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#3771c8;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ id="text1003">
+ <path
+ d="m 102.58571,58.211269 h 0.86816 c 1.15755,0 3.11267,-0.177767 3.45994,-0.5333 0.35553,-0.355534 1.28925,-1.124479 1.28925,-2.306836 V -61.475482 c 0,-1.289844 0.18603,-2.228288 0.5581,-2.815332 0.37207,-0.587044 0.26105,-0.992187 1.17882,-1.215429 -0.91777,-0.206706 -0.80675,-0.603581 -1.17882,-1.190625 -0.37207,-0.587045 -0.5581,-1.529623 -0.5581,-2.827735 v -3.075781 c 0,-1.174088 -0.93372,-1.938899 -1.28925,-2.294433 -0.34727,-0.363802 -2.30239,-0.545703 -3.45994,-0.545703 h -0.86816 v -1.773536 h 0.78134 c 2.05879,0 4.63403,0.305924 5.32029,0.917774 0.69453,0.60358 1.0418,1.81901 1.0418,3.646289 v 2.976562 c 0,1.231966 0.22324,2.087728 0.66973,2.567285 0.44648,0.471289 5.80035,0.706934 6.97444,0.706934 h 0.76894 v 1.773535 h -0.76894 c -1.17409,0 -6.52796,0.239778 -6.97444,0.719336 -0.44649,0.479557 -0.66973,1.343587 -0.66973,2.59209 V 55.420742 c 0,1.827279 -0.34727,3.046842 -1.0418,3.658691 -0.68626,0.611849 -3.2615,0.917774 -5.32029,0.917774 h -0.78134 z"
+ style="font-size:25.39999962px;fill:#3771c8;stroke-width:0.26458332"
+ id="path1005"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cscsscccsscsccscsscsccscsscscc" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-200.59984"
+ y="129.60852"
+ id="text1010"><tspan
+ sodipodi:role="line"
+ id="tspan1008"
+ x="-200.59984"
+ y="129.60852"
+ style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:6.3499999px;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold Italic';text-align:center;text-anchor:middle;stroke-width:0.26458332">Floating point</tspan><tspan
+ sodipodi:role="line"
+ x="-200.59984"
+ y="137.54602"
+ style="font-size:6.3499999px;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1059">calculation</tspan></text>
+ <g
+ aria-label="}"
+ transform="rotate(90,-94.294068,-92.593178)"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#3771c8;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ id="text1003-5">
+ <path
+ d="m 102.58571,58.211269 h 0.86816 c 1.15755,0 3.11267,-0.177767 3.45994,-0.5333 0.35553,-0.355534 1.10026,-1.124479 1.10026,-2.306836 V -44.637502 c 0,-1.289844 0.18603,-2.228288 0.5581,-2.815332 0.37207,-0.587044 0.45004,-0.992187 1.36781,-1.215429 -0.91777,-0.206706 -0.99574,-0.603581 -1.36781,-1.190625 -0.37207,-0.587045 -0.5581,-1.529623 -0.5581,-2.827735 v -19.913761 c 0,-1.174088 -0.74473,-1.938899 -1.10026,-2.294433 -0.34727,-0.363802 -2.30239,-0.545703 -3.45994,-0.545703 h -0.86816 v -1.773536 h 0.78134 c 2.05879,0 4.63403,0.305924 5.32029,0.917774 0.69453,0.60358 1.0418,1.81901 1.0418,3.646289 v 19.814542 c 0,1.231966 0.22324,2.087728 0.66973,2.567285 0.44648,0.471289 1.25677,0.706934 2.43086,0.706934 h 0.76894 v 1.773535 h -0.76894 c -1.17409,0 -1.98438,0.239778 -2.43086,0.719336 -0.44649,0.479557 -0.66973,1.343587 -0.66973,2.59209 v 99.897013 c 0,1.827279 -0.34727,3.046842 -1.0418,3.658691 -0.68626,0.611849 -3.2615,0.917774 -5.32029,0.917774 h -0.78134 z"
+ style="font-size:25.39999962px;fill:#3771c8;stroke-width:0.26458332"
+ id="path1005-3"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cscsscccsscsccscsscsccscsscscc" />
+ </g>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-137.43764"
+ y="122.46283"
+ id="text1010-5"><tspan
+ sodipodi:role="line"
+ id="tspan1008-6"
+ x="-137.43764"
+ y="122.46283"
+ style="font-size:6.3499999px;text-align:center;text-anchor:middle;stroke-width:0.26458332">bit-depth</tspan><tspan
+ sodipodi:role="line"
+ x="-137.43764"
+ y="130.40033"
+ style="font-size:6.3499999px;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1057">reduction/dither</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#3771c8;fill-opacity:1;stroke:none;stroke-width:0.26458332;"
+ x="21.087883"
+ y="155.64751"
+ id="text1064"
+ transform="rotate(90)"><tspan
+ sodipodi:role="line"
+ id="tspan1062"
+ x="21.087883"
+ y="155.64751"
+ style="font-size:9.87777805px;stroke-width:0.26458332;fill:#3771c8;">}</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-142.71655"
+ y="25.939869"
+ id="text6980-9"><tspan
+ sodipodi:role="line"
+ id="tspan6978-1"
+ x="-142.71655"
+ y="25.939869"
+ style="font-size:4.58611107px;stroke-width:0.26458332">Notes</tspan></text>
+ </g>
+</svg>
diff --git a/Documentation/gpu/amdgpu-dc/global_sync_vblank.svg b/Documentation/gpu/amdgpu-dc/global_sync_vblank.svg
new file mode 100644
index 000000000000..48f5dc4fd5d3
--- /dev/null
+++ b/Documentation/gpu/amdgpu-dc/global_sync_vblank.svg
@@ -0,0 +1,485 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ width="232.24133mm"
+ height="96.174995mm"
+ viewBox="0 0 232.24133 96.174995"
+ version="1.1"
+ id="svg8"
+ inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
+ sodipodi:docname="global_sync_vblank.svg">
+ <defs
+ id="defs2">
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path862"
+ style="fill:#800080;fill-opacity:1;fill-rule:evenodd;stroke:#800080;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Send"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path868"
+ style="fill:#ff00ff;fill-opacity:1;fill-rule:evenodd;stroke:#ff00ff;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Lend"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path856"
+ style="fill:#ff00ff;fill-opacity:1;fill-rule:evenodd;stroke:#ff00ff;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-1.1,0,0,-1.1,-1.1,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker1719"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path1717"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff00ff;fill-opacity:1;fill-rule:evenodd;stroke:#ff00ff;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker1661"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path1659"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff00ff;fill-opacity:1;fill-rule:evenodd;stroke:#ff00ff;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker1311"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend"
+ inkscape:collect="always">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ id="path1309"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker1253"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lstart">
+ <path
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ id="path1251"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lend"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path838"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lstart"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path835"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#ff0000;fill-opacity:1;fill-rule:evenodd;stroke:#ff0000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Send"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path850"
+ d="M 0,0 5,-5 -12.5,0 5,5 Z"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1"
+ transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Sstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Sstart"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path865"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(0.3,0,0,0.3,-0.69,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-2"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path862-3"
+ style="fill:#800080;fill-opacity:1;fill-rule:evenodd;stroke:#800080;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Mend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Mend-2-5"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path862-3-9"
+ style="fill:#800080;fill-opacity:1;fill-rule:evenodd;stroke:#800080;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="scale(-0.6)" />
+ </marker>
+ </defs>
+ <sodipodi:namedview
+ id="base"
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1.0"
+ inkscape:pageopacity="0.0"
+ inkscape:pageshadow="2"
+ inkscape:zoom="1.979899"
+ inkscape:cx="747.52324"
+ inkscape:cy="319.84503"
+ inkscape:document-units="mm"
+ inkscape:current-layer="layer1"
+ showgrid="true"
+ inkscape:window-width="3840"
+ inkscape:window-height="2096"
+ inkscape:window-x="0"
+ inkscape:window-y="27"
+ inkscape:window-maximized="1"
+ fit-margin-top="0"
+ fit-margin-left="0"
+ fit-margin-right="0"
+ fit-margin-bottom="0">
+ <inkscape:grid
+ type="xygrid"
+ id="grid815"
+ originx="15.282997"
+ originy="-184.54792" />
+ </sodipodi:namedview>
+ <metadata
+ id="metadata5">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+ <dc:title />
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(15.282998,-16.277083)">
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="M 15.875,27.125001 V 16.541666 H 26.458333 V 27.125001 H 177.27084 V 16.541666 h 10.58333 v 10.583335 h 29.10416"
+ id="path817"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccccccccc" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="M 15.875,37.708334 H 44.979166 V 48.291667 H 100.54167 V 37.708334 H 206.375 v 10.583333 h 10.58333"
+ id="path819"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 15.875,66.8125 h 97.89583 V 56.229167 h 7.9375 V 66.8125 h 92.60417"
+ id="path821"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 15.875,85.333334 c 0,0 132.29166,0 132.29166,0 V 74.75 h 15.875 v 10.583334 h 47.625"
+ id="path823"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="M 15.875,101.20833 H 187.85416 V 90.625 h 10.58334 v 10.58333 h 10.58333"
+ id="path825"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916667, 0.52916667;stroke-dashoffset:0;stroke-opacity:1"
+ d="M 100.54167,48.291667 V 111.79167"
+ id="path827"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916667, 0.52916667;stroke-dashoffset:0;stroke-opacity:1"
+ d="m 113.77083,66.8125 v 44.97917"
+ id="path829"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:0.52916667, 0.52916667;stroke-dashoffset:0;stroke-opacity:1"
+ d="M 206.375,48.291667 V 109.14583"
+ id="path831"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Lstart);marker-end:url(#Arrow1Lend)"
+ d="m 100.54167,106.5 h 13.22916"
+ id="path833"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:none;stroke:#ff0000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#marker1253);marker-end:url(#marker1311)"
+ d="M 113.77083,106.5 H 206.375"
+ id="path1243"
+ inkscape:connector-curvature="0" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="105.83333"
+ y="111.79166"
+ id="text1405"><tspan
+ sodipodi:role="line"
+ id="tspan1403"
+ x="105.83333"
+ y="111.79166"
+ style="stroke-width:0.26458332">To</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="145.52083"
+ y="111.79166"
+ id="text1409"><tspan
+ sodipodi:role="line"
+ id="tspan1407"
+ x="145.52083"
+ y="111.79166"
+ style="stroke-width:0.26458332">VStartup Period</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="156.01123"
+ y="78.71875"
+ id="text1413"><tspan
+ sodipodi:role="line"
+ x="156.01123"
+ y="78.71875"
+ style="font-weight:bold;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1415">VUpdate</tspan><tspan
+ sodipodi:role="line"
+ x="156.01123"
+ y="82.6875"
+ style="font-weight:bold;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1440">Width</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="173.77611"
+ y="92.703873"
+ id="text1413-3"><tspan
+ sodipodi:role="line"
+ id="tspan1411-6"
+ x="173.77611"
+ y="92.703873"
+ style="font-weight:bold;text-align:center;text-anchor:middle;stroke-width:0.26458332">VReady</tspan><tspan
+ sodipodi:role="line"
+ x="173.77611"
+ y="96.672623"
+ style="font-weight:bold;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1415-7">Offset</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="135.78951"
+ y="70.78125"
+ id="text1413-5"><tspan
+ sodipodi:role="line"
+ x="135.78951"
+ y="70.78125"
+ style="font-weight:bold;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1440-5">VUpdate</tspan><tspan
+ sodipodi:role="line"
+ x="135.78951"
+ y="74.75"
+ style="font-weight:bold;text-align:center;text-anchor:middle;stroke-width:0.26458332"
+ id="tspan1465">Offset</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="137.39433"
+ y="48.291664"
+ id="text1479"><tspan
+ sodipodi:role="line"
+ id="tspan1477"
+ x="137.39433"
+ y="48.291664"
+ style="font-weight:bold;stroke-width:0.26458332">VSTARTUP_START</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-5.4806676"
+ y="22.778271"
+ id="text1479-1"><tspan
+ sodipodi:role="line"
+ id="tspan1477-2"
+ x="-5.4806676"
+ y="22.778271"
+ style="font-weight:bold;font-size:4.93888903px;stroke-width:0.26458332">VSYNC</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-9.3767252"
+ y="45.64584"
+ id="text1479-1-7"><tspan
+ sodipodi:role="line"
+ id="tspan1477-2-0"
+ x="-9.3767252"
+ y="45.64584"
+ style="font-weight:bold;font-size:5.64444447px;stroke-width:0.26458332">VBlank</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-15.310558"
+ y="64.92263"
+ id="text1479-1-7-9"><tspan
+ sodipodi:role="line"
+ id="tspan1477-2-0-3"
+ x="-15.310558"
+ y="64.92263"
+ style="font-weight:bold;font-size:5.64444447px;stroke-width:0.26458332">VStartup</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-14.17781"
+ y="85.144356"
+ id="text1479-1-7-9-6"><tspan
+ sodipodi:role="line"
+ id="tspan1477-2-0-3-0"
+ x="-14.17781"
+ y="85.144356"
+ style="font-weight:bold;font-size:5.64444447px;stroke-width:0.26458332">VUpdate</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:3.17499995px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+ x="-11.052421"
+ y="101.39733"
+ id="text1479-1-7-9-6-6"><tspan
+ sodipodi:role="line"
+ id="tspan1477-2-0-3-0-2"
+ x="-11.052421"
+ y="101.39733"
+ style="font-weight:bold;font-size:5.64444447px;stroke-width:0.26458332">VReady</tspan></text>
+ <g
+ id="g5189"
+ transform="translate(269.875,-14.287499)">
+ <path
+ sodipodi:nodetypes="cc"
+ inkscape:connector-curvature="0"
+ id="path5143"
+ d="m -202.40625,45.645828 3.96875,-7.9375"
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+ <path
+ sodipodi:nodetypes="cc"
+ inkscape:connector-curvature="0"
+ id="path5143-2"
+ d="m -199.76042,45.645828 3.96874,-7.937499"
+ style="fill:none;stroke:#000000;stroke-width:0.52916676;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+ </g>
+ <g
+ id="g5189-3"
+ transform="translate(268.55209,7.9375003)">
+ <path
+ sodipodi:nodetypes="cc"
+ inkscape:connector-curvature="0"
+ id="path5143-6"
+ d="m -202.40625,45.645828 3.96875,-7.9375"
+ style="fill:none;stroke:#000000;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+ <path
+ sodipodi:nodetypes="cc"
+ inkscape:connector-curvature="0"
+ id="path5143-2-1"
+ d="m -199.76042,45.645828 3.96874,-7.937499"
+ style="fill:none;stroke:#000000;stroke-width:0.52916676;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+ </g>
+ </g>
+</svg>
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-25 15:38 ` Rodrigo Siqueira
@ 2021-11-25 15:38 ` Rodrigo Siqueira
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
In the DC driver, we have multiple acronyms that are not obvious most of
the time. This commit introduces a DC glossary in order to make it
easier to navigate through our driver.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++++++++++++++++++
2 files changed, 258 insertions(+), 1 deletion(-)
create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
index 2e45e83d9a2a..15405c43786a 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
@@ -26,4 +26,4 @@ table of content:
amdgpu-dcn-overview.rst
amdgpu-dm.rst
amdgpu-dc-debug.rst
-
+ dc-glossary.rst
diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
new file mode 100644
index 000000000000..48698fc1799f
--- /dev/null
+++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
@@ -0,0 +1,257 @@
+===========
+DC Glossary
+===========
+
+.. glossary::
+
+ ABM
+ Adaptive Backlight Modulation
+
+ APU
+ Accelerated Processing Unit
+
+ ASIC
+ Application-Specific Integrated Circuit
+
+ ASSR
+ Alternate Scrambler Seed Reset
+
+ AZ
+ Azalia (HD audio DMA engine)
+
+ BPC
+ Bits Per Colour/Component
+
+ BPP
+ Bits Per Pixel
+
+ Clocks
+ * PCLK: Pixel Clock
+ * SYMCLK: Symbol Clock
+ * SOCCLK: GPU Engine Clock
+ * DISPCLK: Display Clock
+ * DPPCLK: DPP Clock
+ * DCFCLK: Display Controller Fabric Clock
+ * REFCLK: Real Time Reference Clock
+ * PPLL: Pixel PLL
+ * FCLK: Fabric Clock
+ * MCLK: Memory Clock
+ * CPLIB: Content Protection Library
+
+ CRC
+ Cyclic Redundancy Check
+
+ CRTC
+ Cathode Ray Tube Controller - commonly called "Controller" - Generates
+ raw stream of pixels, clocked at pixel clock
+
+ CVT
+ Coordinated Video Timings
+
+ DAL
+ Display Abstraction layer
+
+ DC (Software)
+ Display Core
+
+ DC (Hardware)
+ Display Controller
+
+ DCC
+ Delta Colour Compression
+
+ DCE
+ Display Controller Engine
+
+ DCHUB
+ Display Controller Hub
+
+ ARB
+ Arbiter
+
+ VTG
+ Vertical Timing Generator
+
+ DCN
+ Display Core Next
+
+ DCCG
+ Display Clock Generator block
+
+ DDC
+ Display Data Channel
+
+ DFS
+ Digital Frequency Synthesizer
+
+ DIO
+ Display IO
+
+ DPP
+ Display Pipes and Planes
+
+ DSC
+ Display Stream Compression (Reduce the amount of bits to represent pixel
+ count while at the same pixel clock)
+
+ dGPU
+ discrete GPU
+
+ DMIF
+ Display Memory Interface
+
+ DML
+ Display Mode Library
+
+ DMCU
+ Display Micro Controller Unit
+
+ DMCUB
+ Display Micro-Controller Unit, version B
+
+ DPCD
+ DisplayPort Configuration Data
+
+ DPM(S)
+ Display Power Management (Signaling)
+
+ DRR
+ Dynamic Refresh Rate
+
+ DWB
+ Display writeback
+
+ ECP
+ Enhanced Content Protection
+
+ FB
+ Frame Buffer
+
+ FBC
+ Frame Buffer Compression
+
+ FEC
+ Forward Error Correction
+
+ FRL
+ Fixed Rate Link
+
+ GCO
+ Graphical Controller Object
+
+ GMC
+ Graphic Memory Controller
+
+ GSL
+ Global Swap Lock
+
+ iGPU
+ integrated GPU
+
+ IH
+ Interrupt Handler
+
+ ISR
+ Interrupt Service Request
+
+ ISV
+ Independent Software Vendor
+
+ KMD
+ Kernel Mode Driver
+
+ LB
+ Line Buffer
+
+ LFC
+ Low Framerate Compensation
+
+ LTTPR
+ Link Training Tunable Phy Repeater
+
+ LUT
+ Lookup Table
+
+ MALL
+ Memory Access at Last Level
+
+ MC
+ Memory Controller
+
+ MPC
+ Multiple pipes and plane combine
+
+ MPO
+ Multi Plane Overlay
+
+ MST
+ Multi Stream Transport
+
+ NBP State
+ Northbridge Power State
+
+ NBIO
+ North Bridge Input/Output
+
+ ODM
+ Output Data Mapping
+
+ OPM
+ Output Protection Manager
+
+ OPP
+ Output Plane Processor
+
+ OPTC
+ Output Pipe Timing Combiner
+
+ OTG
+ Output Timing Generator
+
+ PCON
+ Power Controller
+
+ PGFSM
+ Power Gate Finite State Machine
+
+ PPLib
+ PowerPlay Library
+
+ PSR
+ Panel Self Refresh
+
+ SCL
+ Scaler
+
+ SDP
+ Scalable Data Port
+
+ SMU
+ System Management Unit
+
+ SLS
+ Single Large Surface
+
+ SST
+ Single Stream Transport
+
+ TMDS
+ Transition-Minimized Differential Signaling
+
+ TMZ
+ Trusted Memory Zone
+
+ TTU
+ Time to Underflow
+
+ VRR
+ Variable Refresh Rate
+
+ UVD
+ Unified Video Decoder
+
+ VCE
+ Video Compression Engine
+
+ VCN
+ Video Codec Next
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-25 15:38 ` Rodrigo Siqueira
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira @ 2021-11-25 15:38 UTC (permalink / raw)
To: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen
Cc: Alex Deucher, Christian König, aurabindo.pillai,
qingqing.zhuo, roman.li, nicholas.choi, bhawanpreet.lakha,
linux-doc, amd-gfx, dri-devel
In the DC driver, we have multiple acronyms that are not obvious most of
the time. This commit introduces a DC glossary in order to make it
easier to navigate through our driver.
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++++++++++++++++++
2 files changed, 258 insertions(+), 1 deletion(-)
create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
index 2e45e83d9a2a..15405c43786a 100644
--- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
+++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
@@ -26,4 +26,4 @@ table of content:
amdgpu-dcn-overview.rst
amdgpu-dm.rst
amdgpu-dc-debug.rst
-
+ dc-glossary.rst
diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
new file mode 100644
index 000000000000..48698fc1799f
--- /dev/null
+++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
@@ -0,0 +1,257 @@
+===========
+DC Glossary
+===========
+
+.. glossary::
+
+ ABM
+ Adaptive Backlight Modulation
+
+ APU
+ Accelerated Processing Unit
+
+ ASIC
+ Application-Specific Integrated Circuit
+
+ ASSR
+ Alternate Scrambler Seed Reset
+
+ AZ
+ Azalia (HD audio DMA engine)
+
+ BPC
+ Bits Per Colour/Component
+
+ BPP
+ Bits Per Pixel
+
+ Clocks
+ * PCLK: Pixel Clock
+ * SYMCLK: Symbol Clock
+ * SOCCLK: GPU Engine Clock
+ * DISPCLK: Display Clock
+ * DPPCLK: DPP Clock
+ * DCFCLK: Display Controller Fabric Clock
+ * REFCLK: Real Time Reference Clock
+ * PPLL: Pixel PLL
+ * FCLK: Fabric Clock
+ * MCLK: Memory Clock
+ * CPLIB: Content Protection Library
+
+ CRC
+ Cyclic Redundancy Check
+
+ CRTC
+ Cathode Ray Tube Controller - commonly called "Controller" - Generates
+ raw stream of pixels, clocked at pixel clock
+
+ CVT
+ Coordinated Video Timings
+
+ DAL
+ Display Abstraction layer
+
+ DC (Software)
+ Display Core
+
+ DC (Hardware)
+ Display Controller
+
+ DCC
+ Delta Colour Compression
+
+ DCE
+ Display Controller Engine
+
+ DCHUB
+ Display Controller Hub
+
+ ARB
+ Arbiter
+
+ VTG
+ Vertical Timing Generator
+
+ DCN
+ Display Core Next
+
+ DCCG
+ Display Clock Generator block
+
+ DDC
+ Display Data Channel
+
+ DFS
+ Digital Frequency Synthesizer
+
+ DIO
+ Display IO
+
+ DPP
+ Display Pipes and Planes
+
+ DSC
+ Display Stream Compression (Reduce the amount of bits to represent pixel
+ count while at the same pixel clock)
+
+ dGPU
+ discrete GPU
+
+ DMIF
+ Display Memory Interface
+
+ DML
+ Display Mode Library
+
+ DMCU
+ Display Micro Controller Unit
+
+ DMCUB
+ Display Micro-Controller Unit, version B
+
+ DPCD
+ DisplayPort Configuration Data
+
+ DPM(S)
+ Display Power Management (Signaling)
+
+ DRR
+ Dynamic Refresh Rate
+
+ DWB
+ Display writeback
+
+ ECP
+ Enhanced Content Protection
+
+ FB
+ Frame Buffer
+
+ FBC
+ Frame Buffer Compression
+
+ FEC
+ Forward Error Correction
+
+ FRL
+ Fixed Rate Link
+
+ GCO
+ Graphical Controller Object
+
+ GMC
+ Graphic Memory Controller
+
+ GSL
+ Global Swap Lock
+
+ iGPU
+ integrated GPU
+
+ IH
+ Interrupt Handler
+
+ ISR
+ Interrupt Service Request
+
+ ISV
+ Independent Software Vendor
+
+ KMD
+ Kernel Mode Driver
+
+ LB
+ Line Buffer
+
+ LFC
+ Low Framerate Compensation
+
+ LTTPR
+ Link Training Tunable Phy Repeater
+
+ LUT
+ Lookup Table
+
+ MALL
+ Memory Access at Last Level
+
+ MC
+ Memory Controller
+
+ MPC
+ Multiple pipes and plane combine
+
+ MPO
+ Multi Plane Overlay
+
+ MST
+ Multi Stream Transport
+
+ NBP State
+ Northbridge Power State
+
+ NBIO
+ North Bridge Input/Output
+
+ ODM
+ Output Data Mapping
+
+ OPM
+ Output Protection Manager
+
+ OPP
+ Output Plane Processor
+
+ OPTC
+ Output Pipe Timing Combiner
+
+ OTG
+ Output Timing Generator
+
+ PCON
+ Power Controller
+
+ PGFSM
+ Power Gate Finite State Machine
+
+ PPLib
+ PowerPlay Library
+
+ PSR
+ Panel Self Refresh
+
+ SCL
+ Scaler
+
+ SDP
+ Scalable Data Port
+
+ SMU
+ System Management Unit
+
+ SLS
+ Single Large Surface
+
+ SST
+ Single Stream Transport
+
+ TMDS
+ Transition-Minimized Differential Signaling
+
+ TMZ
+ Trusted Memory Zone
+
+ TTU
+ Time to Underflow
+
+ VRR
+ Variable Refresh Rate
+
+ UVD
+ Unified Video Decoder
+
+ VCE
+ Video Compression Engine
+
+ VCN
+ Video Codec Next
--
2.25.1
^ permalink raw reply related [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-25 15:38 ` Rodrigo Siqueira
(?)
@ 2021-11-26 10:35 ` Christian König
2021-11-26 15:40 ` Daniel Vetter
-1 siblings, 1 reply; 51+ messages in thread
From: Christian König @ 2021-11-26 10:35 UTC (permalink / raw)
To: Rodrigo Siqueira, Simon Ser, Michel Dänzer,
Bas Nieuwenhuizen, Marek Olšák, Roman Gilg,
Nicholas Kazlauskas, Harry Wentland, Mark Yacoub, Sean Paul,
Pekka Paalanen
Cc: linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
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
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-26 10:35 ` Christian König
2021-11-26 15:40 ` Daniel Vetter
@ 2021-11-26 15:40 ` Daniel Vetter
0 siblings, 0 replies; 51+ messages in thread
From: Daniel Vetter @ 2021-11-26 15:40 UTC (permalink / raw)
To: Christian König
Cc: Mark Yacoub, bhawanpreet.lakha, nicholas.choi, linux-doc,
Michel Dänzer, Rodrigo Siqueira, roman.li, amd-gfx,
Nicholas Kazlauskas, Marek Olšák, aurabindo.pillai,
Sean Paul, dri-devel, Alex Deucher, qingqing.zhuo,
Christian König, Roman Gilg
On Fri, Nov 26, 2021 at 11:35:03AM +0100, Christian König wrote:
> 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.
Seconded, I think when driver docs get too big for the single file
approach a directory matching the driver name sounds best. Also at that
point maybe just drop the amdgpu prefix in the .rst files, it's kinda
redundant?
-Daniel
>
> 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
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-26 15:40 ` Daniel Vetter
0 siblings, 0 replies; 51+ messages in thread
From: Daniel Vetter @ 2021-11-26 15:40 UTC (permalink / raw)
To: Christian König
Cc: Mark Yacoub, bhawanpreet.lakha, nicholas.choi, linux-doc,
Simon Ser, Michel Dänzer, Rodrigo Siqueira, roman.li,
amd-gfx, Nicholas Kazlauskas, Marek Olšák,
Pekka Paalanen, aurabindo.pillai, Sean Paul, dri-devel,
Bas Nieuwenhuizen, Alex Deucher, qingqing.zhuo,
Christian König, Harry Wentland, Roman Gilg
On Fri, Nov 26, 2021 at 11:35:03AM +0100, Christian König wrote:
> 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.
Seconded, I think when driver docs get too big for the single file
approach a directory matching the driver name sounds best. Also at that
point maybe just drop the amdgpu prefix in the .rst files, it's kinda
redundant?
-Daniel
>
> 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
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-26 15:40 ` Daniel Vetter
0 siblings, 0 replies; 51+ messages in thread
From: Daniel Vetter @ 2021-11-26 15:40 UTC (permalink / raw)
To: Christian König
Cc: Rodrigo Siqueira, Simon Ser, Michel Dänzer,
Bas Nieuwenhuizen, Marek Olšák, Roman Gilg,
Nicholas Kazlauskas, Harry Wentland, Mark Yacoub, Sean Paul,
Pekka Paalanen, linux-doc, qingqing.zhuo, roman.li, amd-gfx,
aurabindo.pillai, nicholas.choi, dri-devel, Alex Deucher,
bhawanpreet.lakha, Christian König
On Fri, Nov 26, 2021 at 11:35:03AM +0100, Christian König wrote:
> 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.
Seconded, I think when driver docs get too big for the single file
approach a directory matching the driver name sounds best. Also at that
point maybe just drop the amdgpu prefix in the .rst files, it's kinda
redundant?
-Daniel
>
> 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
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-25 15:38 ` Rodrigo Siqueira
(?)
@ 2021-11-26 15:42 ` Daniel Vetter
-1 siblings, 0 replies; 51+ messages in thread
From: Daniel Vetter @ 2021-11-26 15:42 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Mark Yacoub, bhawanpreet.lakha, nicholas.choi, linux-doc,
Michel Dänzer, roman.li, amd-gfx, Nicholas Kazlauskas,
Marek Olšák, aurabindo.pillai, Sean Paul, dri-devel,
Alex Deucher, qingqing.zhuo, Christian König, Roman Gilg
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).
-Daniel
> @@ -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
> --
> 2.25.1
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-26 15:42 ` Daniel Vetter
0 siblings, 0 replies; 51+ messages in thread
From: Daniel Vetter @ 2021-11-26 15:42 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Mark Yacoub, bhawanpreet.lakha, nicholas.choi, linux-doc,
Simon Ser, Michel Dänzer, roman.li, amd-gfx,
Nicholas Kazlauskas, Marek Olšák, Pekka Paalanen,
aurabindo.pillai, Sean Paul, dri-devel, Bas Nieuwenhuizen,
Alex Deucher, qingqing.zhuo, Christian König,
Harry Wentland, Roman Gilg
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).
-Daniel
> @@ -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
> --
> 2.25.1
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-26 15:42 ` Daniel Vetter
0 siblings, 0 replies; 51+ messages in thread
From: Daniel Vetter @ 2021-11-26 15:42 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen,
linux-doc, qingqing.zhuo, roman.li, amd-gfx, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, bhawanpreet.lakha,
Christian König
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).
-Daniel
> @@ -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
> --
> 2.25.1
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-26 15:42 ` Daniel Vetter
@ 2021-11-29 12:06 ` Jani Nikula
-1 siblings, 0 replies; 51+ messages in thread
From: Jani Nikula @ 2021-11-29 12:06 UTC (permalink / raw)
To: Daniel Vetter, Rodrigo Siqueira
Cc: linux-doc, Mark Yacoub, Michel Dänzer, roman.li, amd-gfx,
Christian König, Marek Olšák, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, Sean Paul, qingqing.zhuo,
Roman Gilg, bhawanpreet.lakha, Nicholas Kazlauskas
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?
--
Jani Nikula, Intel Open Source Graphics Center
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-29 12:06 ` Jani Nikula
0 siblings, 0 replies; 51+ messages in thread
From: Jani Nikula @ 2021-11-29 12:06 UTC (permalink / raw)
To: Daniel Vetter, Rodrigo Siqueira
Cc: Mark Yacoub, bhawanpreet.lakha, nicholas.choi, linux-doc,
Michel Dänzer, roman.li, amd-gfx, Nicholas Kazlauskas,
Marek Olšák, aurabindo.pillai, Sean Paul, dri-devel,
Alex Deucher, qingqing.zhuo, Christian König, Roman Gilg
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?
--
Jani Nikula, Intel Open Source Graphics Center
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-25 15:38 ` Rodrigo Siqueira
(?)
@ 2021-11-29 20:08 ` Alex Deucher
-1 siblings, 0 replies; 51+ messages in thread
From: Alex Deucher @ 2021-11-29 20:08 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Mark Yacoub, Bhawanpreet Lakha, nicholas.choi,
Linux Doc Mailing List, Michel Dänzer, Roman Li,
amd-gfx list, Nicholas Kazlauskas, Marek Olšák,
Aurabindo Pillai, Sean Paul, Maling list - DRI developers,
Alex Deucher, Qingqing Zhuo, Christian König, Roman Gilg
On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
<Rodrigo.Siqueira@amd.com> wrote:
>
> In the DC driver, we have multiple acronyms that are not obvious most of
> the time. This commit introduces a DC glossary in order to make it
> easier to navigate through our driver.
>
> Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> ---
> Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++++++++++++++++++
> 2 files changed, 258 insertions(+), 1 deletion(-)
> create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
>
> diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> index 2e45e83d9a2a..15405c43786a 100644
> --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> @@ -26,4 +26,4 @@ table of content:
> amdgpu-dcn-overview.rst
> amdgpu-dm.rst
> amdgpu-dc-debug.rst
> -
> + dc-glossary.rst
> diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> new file mode 100644
> index 000000000000..48698fc1799f
> --- /dev/null
> +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> @@ -0,0 +1,257 @@
> +===========
> +DC Glossary
> +===========
> +
> +.. glossary::
> +
> + ABM
> + Adaptive Backlight Modulation
> +
> + APU
> + Accelerated Processing Unit
> +
> + ASIC
> + Application-Specific Integrated Circuit
> +
> + ASSR
> + Alternate Scrambler Seed Reset
> +
> + AZ
> + Azalia (HD audio DMA engine)
> +
> + BPC
> + Bits Per Colour/Component
> +
> + BPP
> + Bits Per Pixel
> +
> + Clocks
> + * PCLK: Pixel Clock
> + * SYMCLK: Symbol Clock
> + * SOCCLK: GPU Engine Clock
> + * DISPCLK: Display Clock
> + * DPPCLK: DPP Clock
> + * DCFCLK: Display Controller Fabric Clock
> + * REFCLK: Real Time Reference Clock
> + * PPLL: Pixel PLL
> + * FCLK: Fabric Clock
> + * MCLK: Memory Clock
> + * CPLIB: Content Protection Library
CPLIB is not a clock. It should be split out as its own item.
> +
> + CRC
> + Cyclic Redundancy Check
> +
> + CRTC
> + Cathode Ray Tube Controller - commonly called "Controller" - Generates
> + raw stream of pixels, clocked at pixel clock
> +
> + CVT
> + Coordinated Video Timings
> +
> + DAL
> + Display Abstraction layer
> +
> + DC (Software)
> + Display Core
> +
> + DC (Hardware)
> + Display Controller
> +
> + DCC
> + Delta Colour Compression
> +
> + DCE
> + Display Controller Engine
> +
> + DCHUB
> + Display Controller Hub
> +
> + ARB
> + Arbiter
> +
> + VTG
> + Vertical Timing Generator
> +
> + DCN
> + Display Core Next
> +
> + DCCG
> + Display Clock Generator block
> +
> + DDC
> + Display Data Channel
> +
> + DFS
> + Digital Frequency Synthesizer
> +
> + DIO
> + Display IO
> +
> + DPP
> + Display Pipes and Planes
> +
> + DSC
> + Display Stream Compression (Reduce the amount of bits to represent pixel
> + count while at the same pixel clock)
> +
> + dGPU
> + discrete GPU
> +
> + DMIF
> + Display Memory Interface
> +
> + DML
> + Display Mode Library
> +
> + DMCU
> + Display Micro Controller Unit
> +
> + DMCUB
> + Display Micro-Controller Unit, version B
Make Micro Controller vs. Micro-Controller consistent for these.
> +
> + DPCD
> + DisplayPort Configuration Data
> +
> + DPM(S)
> + Display Power Management (Signaling)
> +
> + DRR
> + Dynamic Refresh Rate
> +
> + DWB
> + Display writeback
> +
> + ECP
> + Enhanced Content Protection
> +
> + FB
> + Frame Buffer
> +
> + FBC
> + Frame Buffer Compression
> +
> + FEC
> + Forward Error Correction
> +
> + FRL
> + Fixed Rate Link
> +
> + GCO
> + Graphical Controller Object
> +
> + GMC
> + Graphic Memory Controller
> +
> + GSL
> + Global Swap Lock
> +
> + iGPU
> + integrated GPU
> +
> + IH
> + Interrupt Handler
> +
> + ISR
> + Interrupt Service Request
> +
> + ISV
> + Independent Software Vendor
> +
> + KMD
> + Kernel Mode Driver
> +
> + LB
> + Line Buffer
> +
> + LFC
> + Low Framerate Compensation
> +
> + LTTPR
> + Link Training Tunable Phy Repeater
> +
> + LUT
> + Lookup Table
> +
> + MALL
> + Memory Access at Last Level
> +
> + MC
> + Memory Controller
> +
> + MPC
> + Multiple pipes and plane combine
> +
> + MPO
> + Multi Plane Overlay
> +
> + MST
> + Multi Stream Transport
> +
> + NBP State
> + Northbridge Power State
> +
> + NBIO
> + North Bridge Input/Output
> +
> + ODM
> + Output Data Mapping
> +
> + OPM
> + Output Protection Manager
> +
> + OPP
> + Output Plane Processor
> +
> + OPTC
> + Output Pipe Timing Combiner
> +
> + OTG
> + Output Timing Generator
> +
> + PCON
> + Power Controller
> +
> + PGFSM
> + Power Gate Finite State Machine
> +
> + PPLib
> + PowerPlay Library
Maybe say that powerplay is the power management component.
> +
> + PSR
> + Panel Self Refresh
> +
> + SCL
> + Scaler
> +
> + SDP
> + Scalable Data Port
> +
> + SMU
> + System Management Unit
> +
> + SLS
> + Single Large Surface
> +
> + SST
> + Single Stream Transport
> +
> + TMDS
> + Transition-Minimized Differential Signaling
> +
> + TMZ
> + Trusted Memory Zone
> +
> + TTU
> + Time to Underflow
> +
> + VRR
> + Variable Refresh Rate
> +
> + UVD
> + Unified Video Decoder
> +
> + VCE
> + Video Compression Engine
> +
> + VCN
> + Video Codec Next
> --
> 2.25.1
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-29 20:08 ` Alex Deucher
0 siblings, 0 replies; 51+ messages in thread
From: Alex Deucher @ 2021-11-29 20:08 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Mark Yacoub, Bhawanpreet Lakha, nicholas.choi,
Linux Doc Mailing List, Simon Ser, Michel Dänzer, Roman Li,
amd-gfx list, Nicholas Kazlauskas, Marek Olšák,
Pekka Paalanen, Aurabindo Pillai, Sean Paul,
Maling list - DRI developers, Bas Nieuwenhuizen, Alex Deucher,
Qingqing Zhuo, Christian König, Harry Wentland, Roman Gilg
On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
<Rodrigo.Siqueira@amd.com> wrote:
>
> In the DC driver, we have multiple acronyms that are not obvious most of
> the time. This commit introduces a DC glossary in order to make it
> easier to navigate through our driver.
>
> Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> ---
> Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++++++++++++++++++
> 2 files changed, 258 insertions(+), 1 deletion(-)
> create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
>
> diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> index 2e45e83d9a2a..15405c43786a 100644
> --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> @@ -26,4 +26,4 @@ table of content:
> amdgpu-dcn-overview.rst
> amdgpu-dm.rst
> amdgpu-dc-debug.rst
> -
> + dc-glossary.rst
> diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> new file mode 100644
> index 000000000000..48698fc1799f
> --- /dev/null
> +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> @@ -0,0 +1,257 @@
> +===========
> +DC Glossary
> +===========
> +
> +.. glossary::
> +
> + ABM
> + Adaptive Backlight Modulation
> +
> + APU
> + Accelerated Processing Unit
> +
> + ASIC
> + Application-Specific Integrated Circuit
> +
> + ASSR
> + Alternate Scrambler Seed Reset
> +
> + AZ
> + Azalia (HD audio DMA engine)
> +
> + BPC
> + Bits Per Colour/Component
> +
> + BPP
> + Bits Per Pixel
> +
> + Clocks
> + * PCLK: Pixel Clock
> + * SYMCLK: Symbol Clock
> + * SOCCLK: GPU Engine Clock
> + * DISPCLK: Display Clock
> + * DPPCLK: DPP Clock
> + * DCFCLK: Display Controller Fabric Clock
> + * REFCLK: Real Time Reference Clock
> + * PPLL: Pixel PLL
> + * FCLK: Fabric Clock
> + * MCLK: Memory Clock
> + * CPLIB: Content Protection Library
CPLIB is not a clock. It should be split out as its own item.
> +
> + CRC
> + Cyclic Redundancy Check
> +
> + CRTC
> + Cathode Ray Tube Controller - commonly called "Controller" - Generates
> + raw stream of pixels, clocked at pixel clock
> +
> + CVT
> + Coordinated Video Timings
> +
> + DAL
> + Display Abstraction layer
> +
> + DC (Software)
> + Display Core
> +
> + DC (Hardware)
> + Display Controller
> +
> + DCC
> + Delta Colour Compression
> +
> + DCE
> + Display Controller Engine
> +
> + DCHUB
> + Display Controller Hub
> +
> + ARB
> + Arbiter
> +
> + VTG
> + Vertical Timing Generator
> +
> + DCN
> + Display Core Next
> +
> + DCCG
> + Display Clock Generator block
> +
> + DDC
> + Display Data Channel
> +
> + DFS
> + Digital Frequency Synthesizer
> +
> + DIO
> + Display IO
> +
> + DPP
> + Display Pipes and Planes
> +
> + DSC
> + Display Stream Compression (Reduce the amount of bits to represent pixel
> + count while at the same pixel clock)
> +
> + dGPU
> + discrete GPU
> +
> + DMIF
> + Display Memory Interface
> +
> + DML
> + Display Mode Library
> +
> + DMCU
> + Display Micro Controller Unit
> +
> + DMCUB
> + Display Micro-Controller Unit, version B
Make Micro Controller vs. Micro-Controller consistent for these.
> +
> + DPCD
> + DisplayPort Configuration Data
> +
> + DPM(S)
> + Display Power Management (Signaling)
> +
> + DRR
> + Dynamic Refresh Rate
> +
> + DWB
> + Display writeback
> +
> + ECP
> + Enhanced Content Protection
> +
> + FB
> + Frame Buffer
> +
> + FBC
> + Frame Buffer Compression
> +
> + FEC
> + Forward Error Correction
> +
> + FRL
> + Fixed Rate Link
> +
> + GCO
> + Graphical Controller Object
> +
> + GMC
> + Graphic Memory Controller
> +
> + GSL
> + Global Swap Lock
> +
> + iGPU
> + integrated GPU
> +
> + IH
> + Interrupt Handler
> +
> + ISR
> + Interrupt Service Request
> +
> + ISV
> + Independent Software Vendor
> +
> + KMD
> + Kernel Mode Driver
> +
> + LB
> + Line Buffer
> +
> + LFC
> + Low Framerate Compensation
> +
> + LTTPR
> + Link Training Tunable Phy Repeater
> +
> + LUT
> + Lookup Table
> +
> + MALL
> + Memory Access at Last Level
> +
> + MC
> + Memory Controller
> +
> + MPC
> + Multiple pipes and plane combine
> +
> + MPO
> + Multi Plane Overlay
> +
> + MST
> + Multi Stream Transport
> +
> + NBP State
> + Northbridge Power State
> +
> + NBIO
> + North Bridge Input/Output
> +
> + ODM
> + Output Data Mapping
> +
> + OPM
> + Output Protection Manager
> +
> + OPP
> + Output Plane Processor
> +
> + OPTC
> + Output Pipe Timing Combiner
> +
> + OTG
> + Output Timing Generator
> +
> + PCON
> + Power Controller
> +
> + PGFSM
> + Power Gate Finite State Machine
> +
> + PPLib
> + PowerPlay Library
Maybe say that powerplay is the power management component.
> +
> + PSR
> + Panel Self Refresh
> +
> + SCL
> + Scaler
> +
> + SDP
> + Scalable Data Port
> +
> + SMU
> + System Management Unit
> +
> + SLS
> + Single Large Surface
> +
> + SST
> + Single Stream Transport
> +
> + TMDS
> + Transition-Minimized Differential Signaling
> +
> + TMZ
> + Trusted Memory Zone
> +
> + TTU
> + Time to Underflow
> +
> + VRR
> + Variable Refresh Rate
> +
> + UVD
> + Unified Video Decoder
> +
> + VCE
> + Video Compression Engine
> +
> + VCN
> + Video Codec Next
> --
> 2.25.1
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-29 20:08 ` Alex Deucher
0 siblings, 0 replies; 51+ messages in thread
From: Alex Deucher @ 2021-11-29 20:08 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Simon Ser, Michel Dänzer, Bas Nieuwenhuizen,
Marek Olšák, Roman Gilg, Nicholas Kazlauskas,
Harry Wentland, Mark Yacoub, Sean Paul, Pekka Paalanen,
Linux Doc Mailing List, Qingqing Zhuo, Roman Li, amd-gfx list,
Aurabindo Pillai, nicholas.choi, Maling list - DRI developers,
Alex Deucher, Bhawanpreet Lakha, Christian König
On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
<Rodrigo.Siqueira@amd.com> wrote:
>
> In the DC driver, we have multiple acronyms that are not obvious most of
> the time. This commit introduces a DC glossary in order to make it
> easier to navigate through our driver.
>
> Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> ---
> Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257 ++++++++++++++++++++
> 2 files changed, 258 insertions(+), 1 deletion(-)
> create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
>
> diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> index 2e45e83d9a2a..15405c43786a 100644
> --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> @@ -26,4 +26,4 @@ table of content:
> amdgpu-dcn-overview.rst
> amdgpu-dm.rst
> amdgpu-dc-debug.rst
> -
> + dc-glossary.rst
> diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> new file mode 100644
> index 000000000000..48698fc1799f
> --- /dev/null
> +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> @@ -0,0 +1,257 @@
> +===========
> +DC Glossary
> +===========
> +
> +.. glossary::
> +
> + ABM
> + Adaptive Backlight Modulation
> +
> + APU
> + Accelerated Processing Unit
> +
> + ASIC
> + Application-Specific Integrated Circuit
> +
> + ASSR
> + Alternate Scrambler Seed Reset
> +
> + AZ
> + Azalia (HD audio DMA engine)
> +
> + BPC
> + Bits Per Colour/Component
> +
> + BPP
> + Bits Per Pixel
> +
> + Clocks
> + * PCLK: Pixel Clock
> + * SYMCLK: Symbol Clock
> + * SOCCLK: GPU Engine Clock
> + * DISPCLK: Display Clock
> + * DPPCLK: DPP Clock
> + * DCFCLK: Display Controller Fabric Clock
> + * REFCLK: Real Time Reference Clock
> + * PPLL: Pixel PLL
> + * FCLK: Fabric Clock
> + * MCLK: Memory Clock
> + * CPLIB: Content Protection Library
CPLIB is not a clock. It should be split out as its own item.
> +
> + CRC
> + Cyclic Redundancy Check
> +
> + CRTC
> + Cathode Ray Tube Controller - commonly called "Controller" - Generates
> + raw stream of pixels, clocked at pixel clock
> +
> + CVT
> + Coordinated Video Timings
> +
> + DAL
> + Display Abstraction layer
> +
> + DC (Software)
> + Display Core
> +
> + DC (Hardware)
> + Display Controller
> +
> + DCC
> + Delta Colour Compression
> +
> + DCE
> + Display Controller Engine
> +
> + DCHUB
> + Display Controller Hub
> +
> + ARB
> + Arbiter
> +
> + VTG
> + Vertical Timing Generator
> +
> + DCN
> + Display Core Next
> +
> + DCCG
> + Display Clock Generator block
> +
> + DDC
> + Display Data Channel
> +
> + DFS
> + Digital Frequency Synthesizer
> +
> + DIO
> + Display IO
> +
> + DPP
> + Display Pipes and Planes
> +
> + DSC
> + Display Stream Compression (Reduce the amount of bits to represent pixel
> + count while at the same pixel clock)
> +
> + dGPU
> + discrete GPU
> +
> + DMIF
> + Display Memory Interface
> +
> + DML
> + Display Mode Library
> +
> + DMCU
> + Display Micro Controller Unit
> +
> + DMCUB
> + Display Micro-Controller Unit, version B
Make Micro Controller vs. Micro-Controller consistent for these.
> +
> + DPCD
> + DisplayPort Configuration Data
> +
> + DPM(S)
> + Display Power Management (Signaling)
> +
> + DRR
> + Dynamic Refresh Rate
> +
> + DWB
> + Display writeback
> +
> + ECP
> + Enhanced Content Protection
> +
> + FB
> + Frame Buffer
> +
> + FBC
> + Frame Buffer Compression
> +
> + FEC
> + Forward Error Correction
> +
> + FRL
> + Fixed Rate Link
> +
> + GCO
> + Graphical Controller Object
> +
> + GMC
> + Graphic Memory Controller
> +
> + GSL
> + Global Swap Lock
> +
> + iGPU
> + integrated GPU
> +
> + IH
> + Interrupt Handler
> +
> + ISR
> + Interrupt Service Request
> +
> + ISV
> + Independent Software Vendor
> +
> + KMD
> + Kernel Mode Driver
> +
> + LB
> + Line Buffer
> +
> + LFC
> + Low Framerate Compensation
> +
> + LTTPR
> + Link Training Tunable Phy Repeater
> +
> + LUT
> + Lookup Table
> +
> + MALL
> + Memory Access at Last Level
> +
> + MC
> + Memory Controller
> +
> + MPC
> + Multiple pipes and plane combine
> +
> + MPO
> + Multi Plane Overlay
> +
> + MST
> + Multi Stream Transport
> +
> + NBP State
> + Northbridge Power State
> +
> + NBIO
> + North Bridge Input/Output
> +
> + ODM
> + Output Data Mapping
> +
> + OPM
> + Output Protection Manager
> +
> + OPP
> + Output Plane Processor
> +
> + OPTC
> + Output Pipe Timing Combiner
> +
> + OTG
> + Output Timing Generator
> +
> + PCON
> + Power Controller
> +
> + PGFSM
> + Power Gate Finite State Machine
> +
> + PPLib
> + PowerPlay Library
Maybe say that powerplay is the power management component.
> +
> + PSR
> + Panel Self Refresh
> +
> + SCL
> + Scaler
> +
> + SDP
> + Scalable Data Port
> +
> + SMU
> + System Management Unit
> +
> + SLS
> + Single Large Surface
> +
> + SST
> + Single Stream Transport
> +
> + TMDS
> + Transition-Minimized Differential Signaling
> +
> + TMZ
> + Trusted Memory Zone
> +
> + TTU
> + Time to Underflow
> +
> + VRR
> + Variable Refresh Rate
> +
> + UVD
> + Unified Video Decoder
> +
> + VCE
> + Video Compression Engine
> +
> + VCN
> + Video Codec Next
> --
> 2.25.1
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-29 20:08 ` Alex Deucher
(?)
@ 2021-11-29 20:48 ` ydirson
-1 siblings, 0 replies; 51+ messages in thread
From: ydirson @ 2021-11-29 20:48 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Linux Doc Mailing List, Mark Yacoub, Michel Dänzer,
Roman Li, amd-gfx list, Christian König,
Marek Olšák, Alex Deucher, Aurabindo Pillai,
nicholas choi, Maling list - DRI developers, Sean Paul,
Qingqing Zhuo, Roman Gilg, Bhawanpreet Lakha,
Nicholas Kazlauskas
Hi Rodrigo,
That will really be helpful!
I know drawing the line is a difficult problem (and can even make things
harder when searching), but maybe it would make sense to keep generic
acronyms not specific to amdgpu in a separate list. I bet a number of
them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
LUT), but still have value as not necessarily easy to look up.
Maybe "DC glossary" should just be "Glossary", since quite some entries
help to read adm/amdgpu/ too. Which brings me to the result of my recent
searches as suggested entries:
KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
queue descriptor), EOP (still no clue :)
Maybe some more specific ones just to be spelled out in clear where they
are used ? KCQ (compute queue?), KGQ (gfx queue?)
More suggestions inlined.
Best regards,
--
Yann
> On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
> <Rodrigo.Siqueira@amd.com> wrote:
> >
> > In the DC driver, we have multiple acronyms that are not obvious
> > most of
> > the time. This commit introduces a DC glossary in order to make it
> > easier to navigate through our driver.
> >
> > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > ---
> > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257
> > ++++++++++++++++++++
> > 2 files changed, 258 insertions(+), 1 deletion(-)
> > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
> >
> > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > index 2e45e83d9a2a..15405c43786a 100644
> > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > @@ -26,4 +26,4 @@ table of content:
> > amdgpu-dcn-overview.rst
> > amdgpu-dm.rst
> > amdgpu-dc-debug.rst
> > -
> > + dc-glossary.rst
> > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > new file mode 100644
> > index 000000000000..48698fc1799f
> > --- /dev/null
> > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > @@ -0,0 +1,257 @@
> > +===========
> > +DC Glossary
> > +===========
> > +
> > +.. glossary::
> > +
> > + ABM
> > + Adaptive Backlight Modulation
> > +
> > + APU
> > + Accelerated Processing Unit
> > +
> > + ASIC
> > + Application-Specific Integrated Circuit
> > +
> > + ASSR
> > + Alternate Scrambler Seed Reset
> > +
> > + AZ
> > + Azalia (HD audio DMA engine)
> > +
> > + BPC
> > + Bits Per Colour/Component
> > +
> > + BPP
> > + Bits Per Pixel
> > +
> > + Clocks
> > + * PCLK: Pixel Clock
> > + * SYMCLK: Symbol Clock
> > + * SOCCLK: GPU Engine Clock
> > + * DISPCLK: Display Clock
> > + * DPPCLK: DPP Clock
> > + * DCFCLK: Display Controller Fabric Clock
> > + * REFCLK: Real Time Reference Clock
> > + * PPLL: Pixel PLL
> > + * FCLK: Fabric Clock
> > + * MCLK: Memory Clock
> > + * CPLIB: Content Protection Library
>
> CPLIB is not a clock. It should be split out as its own item.
>
> > +
> > + CRC
> > + Cyclic Redundancy Check
> > +
> > + CRTC
> > + Cathode Ray Tube Controller - commonly called "Controller" -
> > Generates
> > + raw stream of pixels, clocked at pixel clock
> > +
> > + CVT
> > + Coordinated Video Timings
> > +
> > + DAL
> > + Display Abstraction layer
I recall this as the old name for DC, maybe this should be mentioned ?
> > +
> > + DC (Software)
> > + Display Core
> > +
> > + DC (Hardware)
> > + Display Controller
> > +
> > + DCC
> > + Delta Colour Compression
> > +
> > + DCE
> > + Display Controller Engine
> > +
> > + DCHUB
> > + Display Controller Hub
> > +
> > + ARB
> > + Arbiter
> > +
> > + VTG
> > + Vertical Timing Generator
> > +
> > + DCN
> > + Display Core Next
> > +
> > + DCCG
> > + Display Clock Generator block
> > +
> > + DDC
> > + Display Data Channel
> > +
> > + DFS
> > + Digital Frequency Synthesizer
> > +
> > + DIO
> > + Display IO
> > +
> > + DPP
> > + Display Pipes and Planes
> > +
> > + DSC
> > + Display Stream Compression (Reduce the amount of bits to
> > represent pixel
> > + count while at the same pixel clock)
> > +
> > + dGPU
> > + discrete GPU
> > +
> > + DMIF
> > + Display Memory Interface
> > +
> > + DML
> > + Display Mode Library
> > +
> > + DMCU
> > + Display Micro Controller Unit
> > +
> > + DMCUB
> > + Display Micro-Controller Unit, version B
>
> Make Micro Controller vs. Micro-Controller consistent for these.
>
> > +
> > + DPCD
> > + DisplayPort Configuration Data
> > +
> > + DPM(S)
> > + Display Power Management (Signaling)
> > +
> > + DRR
> > + Dynamic Refresh Rate
> > +
> > + DWB
> > + Display writeback
> > +
> > + ECP
> > + Enhanced Content Protection
> > +
> > + FB
> > + Frame Buffer
> > +
> > + FBC
> > + Frame Buffer Compression
> > +
> > + FEC
> > + Forward Error Correction
> > +
> > + FRL
> > + Fixed Rate Link
> > +
> > + GCO
> > + Graphical Controller Object
> > +
> > + GMC
> > + Graphic Memory Controller
> > +
> > + GSL
> > + Global Swap Lock
> > +
> > + iGPU
> > + integrated GPU
> > +
> > + IH
> > + Interrupt Handler
> > +
> > + ISR
> > + Interrupt Service Request
> > +
> > + ISV
> > + Independent Software Vendor
> > +
> > + KMD
> > + Kernel Mode Driver
> > +
> > + LB
> > + Line Buffer
> > +
> > + LFC
> > + Low Framerate Compensation
> > +
> > + LTTPR
> > + Link Training Tunable Phy Repeater
> > +
> > + LUT
> > + Lookup Table
> > +
> > + MALL
> > + Memory Access at Last Level
> > +
> > + MC
> > + Memory Controller
> > +
> > + MPC
> > + Multiple pipes and plane combine
> > +
> > + MPO
> > + Multi Plane Overlay
> > +
> > + MST
> > + Multi Stream Transport
> > +
> > + NBP State
> > + Northbridge Power State
> > +
> > + NBIO
> > + North Bridge Input/Output
> > +
> > + ODM
> > + Output Data Mapping
> > +
> > + OPM
> > + Output Protection Manager
> > +
> > + OPP
> > + Output Plane Processor
> > +
> > + OPTC
> > + Output Pipe Timing Combiner
> > +
> > + OTG
> > + Output Timing Generator
> > +
> > + PCON
> > + Power Controller
> > +
> > + PGFSM
> > + Power Gate Finite State Machine
> > +
> > + PPLib
> > + PowerPlay Library
>
> Maybe say that powerplay is the power management component.
>
> > +
> > + PSR
> > + Panel Self Refresh
> > +
> > + SCL
> > + Scaler
> > +
> > + SDP
> > + Scalable Data Port
> > +
> > + SMU
> > + System Management Unit
> > +
> > + SLS
> > + Single Large Surface
> > +
> > + SST
> > + Single Stream Transport
> > +
> > + TMDS
> > + Transition-Minimized Differential Signaling
> > +
> > + TMZ
> > + Trusted Memory Zone
> > +
> > + TTU
> > + Time to Underflow
> > +
> > + VRR
> > + Variable Refresh Rate
> > +
> > + UVD
> > + Unified Video Decoder
> > +
> > + VCE
> > + Video Compression Engine
> > +
> > + VCN
> > + Video Codec Next
> > --
> > 2.25.1
> >
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-29 20:48 ` ydirson
0 siblings, 0 replies; 51+ messages in thread
From: ydirson @ 2021-11-29 20:48 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Harry Wentland, Linux Doc Mailing List, Mark Yacoub,
Michel Dänzer, Bas Nieuwenhuizen, Roman Li, amd-gfx list,
Christian König, Marek Olšák, Alex Deucher,
Pekka Paalanen, Aurabindo Pillai, nicholas choi,
Maling list - DRI developers, Simon Ser, Alex Deucher, Sean Paul,
Qingqing Zhuo, Roman Gilg, Bhawanpreet Lakha,
Nicholas Kazlauskas
Hi Rodrigo,
That will really be helpful!
I know drawing the line is a difficult problem (and can even make things
harder when searching), but maybe it would make sense to keep generic
acronyms not specific to amdgpu in a separate list. I bet a number of
them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
LUT), but still have value as not necessarily easy to look up.
Maybe "DC glossary" should just be "Glossary", since quite some entries
help to read adm/amdgpu/ too. Which brings me to the result of my recent
searches as suggested entries:
KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
queue descriptor), EOP (still no clue :)
Maybe some more specific ones just to be spelled out in clear where they
are used ? KCQ (compute queue?), KGQ (gfx queue?)
More suggestions inlined.
Best regards,
--
Yann
> On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
> <Rodrigo.Siqueira@amd.com> wrote:
> >
> > In the DC driver, we have multiple acronyms that are not obvious
> > most of
> > the time. This commit introduces a DC glossary in order to make it
> > easier to navigate through our driver.
> >
> > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > ---
> > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257
> > ++++++++++++++++++++
> > 2 files changed, 258 insertions(+), 1 deletion(-)
> > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
> >
> > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > index 2e45e83d9a2a..15405c43786a 100644
> > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > @@ -26,4 +26,4 @@ table of content:
> > amdgpu-dcn-overview.rst
> > amdgpu-dm.rst
> > amdgpu-dc-debug.rst
> > -
> > + dc-glossary.rst
> > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > new file mode 100644
> > index 000000000000..48698fc1799f
> > --- /dev/null
> > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > @@ -0,0 +1,257 @@
> > +===========
> > +DC Glossary
> > +===========
> > +
> > +.. glossary::
> > +
> > + ABM
> > + Adaptive Backlight Modulation
> > +
> > + APU
> > + Accelerated Processing Unit
> > +
> > + ASIC
> > + Application-Specific Integrated Circuit
> > +
> > + ASSR
> > + Alternate Scrambler Seed Reset
> > +
> > + AZ
> > + Azalia (HD audio DMA engine)
> > +
> > + BPC
> > + Bits Per Colour/Component
> > +
> > + BPP
> > + Bits Per Pixel
> > +
> > + Clocks
> > + * PCLK: Pixel Clock
> > + * SYMCLK: Symbol Clock
> > + * SOCCLK: GPU Engine Clock
> > + * DISPCLK: Display Clock
> > + * DPPCLK: DPP Clock
> > + * DCFCLK: Display Controller Fabric Clock
> > + * REFCLK: Real Time Reference Clock
> > + * PPLL: Pixel PLL
> > + * FCLK: Fabric Clock
> > + * MCLK: Memory Clock
> > + * CPLIB: Content Protection Library
>
> CPLIB is not a clock. It should be split out as its own item.
>
> > +
> > + CRC
> > + Cyclic Redundancy Check
> > +
> > + CRTC
> > + Cathode Ray Tube Controller - commonly called "Controller" -
> > Generates
> > + raw stream of pixels, clocked at pixel clock
> > +
> > + CVT
> > + Coordinated Video Timings
> > +
> > + DAL
> > + Display Abstraction layer
I recall this as the old name for DC, maybe this should be mentioned ?
> > +
> > + DC (Software)
> > + Display Core
> > +
> > + DC (Hardware)
> > + Display Controller
> > +
> > + DCC
> > + Delta Colour Compression
> > +
> > + DCE
> > + Display Controller Engine
> > +
> > + DCHUB
> > + Display Controller Hub
> > +
> > + ARB
> > + Arbiter
> > +
> > + VTG
> > + Vertical Timing Generator
> > +
> > + DCN
> > + Display Core Next
> > +
> > + DCCG
> > + Display Clock Generator block
> > +
> > + DDC
> > + Display Data Channel
> > +
> > + DFS
> > + Digital Frequency Synthesizer
> > +
> > + DIO
> > + Display IO
> > +
> > + DPP
> > + Display Pipes and Planes
> > +
> > + DSC
> > + Display Stream Compression (Reduce the amount of bits to
> > represent pixel
> > + count while at the same pixel clock)
> > +
> > + dGPU
> > + discrete GPU
> > +
> > + DMIF
> > + Display Memory Interface
> > +
> > + DML
> > + Display Mode Library
> > +
> > + DMCU
> > + Display Micro Controller Unit
> > +
> > + DMCUB
> > + Display Micro-Controller Unit, version B
>
> Make Micro Controller vs. Micro-Controller consistent for these.
>
> > +
> > + DPCD
> > + DisplayPort Configuration Data
> > +
> > + DPM(S)
> > + Display Power Management (Signaling)
> > +
> > + DRR
> > + Dynamic Refresh Rate
> > +
> > + DWB
> > + Display writeback
> > +
> > + ECP
> > + Enhanced Content Protection
> > +
> > + FB
> > + Frame Buffer
> > +
> > + FBC
> > + Frame Buffer Compression
> > +
> > + FEC
> > + Forward Error Correction
> > +
> > + FRL
> > + Fixed Rate Link
> > +
> > + GCO
> > + Graphical Controller Object
> > +
> > + GMC
> > + Graphic Memory Controller
> > +
> > + GSL
> > + Global Swap Lock
> > +
> > + iGPU
> > + integrated GPU
> > +
> > + IH
> > + Interrupt Handler
> > +
> > + ISR
> > + Interrupt Service Request
> > +
> > + ISV
> > + Independent Software Vendor
> > +
> > + KMD
> > + Kernel Mode Driver
> > +
> > + LB
> > + Line Buffer
> > +
> > + LFC
> > + Low Framerate Compensation
> > +
> > + LTTPR
> > + Link Training Tunable Phy Repeater
> > +
> > + LUT
> > + Lookup Table
> > +
> > + MALL
> > + Memory Access at Last Level
> > +
> > + MC
> > + Memory Controller
> > +
> > + MPC
> > + Multiple pipes and plane combine
> > +
> > + MPO
> > + Multi Plane Overlay
> > +
> > + MST
> > + Multi Stream Transport
> > +
> > + NBP State
> > + Northbridge Power State
> > +
> > + NBIO
> > + North Bridge Input/Output
> > +
> > + ODM
> > + Output Data Mapping
> > +
> > + OPM
> > + Output Protection Manager
> > +
> > + OPP
> > + Output Plane Processor
> > +
> > + OPTC
> > + Output Pipe Timing Combiner
> > +
> > + OTG
> > + Output Timing Generator
> > +
> > + PCON
> > + Power Controller
> > +
> > + PGFSM
> > + Power Gate Finite State Machine
> > +
> > + PPLib
> > + PowerPlay Library
>
> Maybe say that powerplay is the power management component.
>
> > +
> > + PSR
> > + Panel Self Refresh
> > +
> > + SCL
> > + Scaler
> > +
> > + SDP
> > + Scalable Data Port
> > +
> > + SMU
> > + System Management Unit
> > +
> > + SLS
> > + Single Large Surface
> > +
> > + SST
> > + Single Stream Transport
> > +
> > + TMDS
> > + Transition-Minimized Differential Signaling
> > +
> > + TMZ
> > + Trusted Memory Zone
> > +
> > + TTU
> > + Time to Underflow
> > +
> > + VRR
> > + Variable Refresh Rate
> > +
> > + UVD
> > + Unified Video Decoder
> > +
> > + VCE
> > + Video Compression Engine
> > +
> > + VCN
> > + Video Codec Next
> > --
> > 2.25.1
> >
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-29 20:48 ` ydirson
0 siblings, 0 replies; 51+ messages in thread
From: ydirson @ 2021-11-29 20:48 UTC (permalink / raw)
To: Rodrigo Siqueira
Cc: Mark Yacoub, Bhawanpreet Lakha, nicholas choi,
Linux Doc Mailing List, Alex Deucher, Simon Ser,
Michel Dänzer, Roman Li, amd-gfx list, Nicholas Kazlauskas,
Marek Olšák, Pekka Paalanen, Aurabindo Pillai,
Sean Paul, Maling list - DRI developers, Bas Nieuwenhuizen,
Alex Deucher, Qingqing Zhuo, Christian König,
Harry Wentland, Roman Gilg
Hi Rodrigo,
That will really be helpful!
I know drawing the line is a difficult problem (and can even make things
harder when searching), but maybe it would make sense to keep generic
acronyms not specific to amdgpu in a separate list. I bet a number of
them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
LUT), but still have value as not necessarily easy to look up.
Maybe "DC glossary" should just be "Glossary", since quite some entries
help to read adm/amdgpu/ too. Which brings me to the result of my recent
searches as suggested entries:
KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
queue descriptor), EOP (still no clue :)
Maybe some more specific ones just to be spelled out in clear where they
are used ? KCQ (compute queue?), KGQ (gfx queue?)
More suggestions inlined.
Best regards,
--
Yann
> On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
> <Rodrigo.Siqueira@amd.com> wrote:
> >
> > In the DC driver, we have multiple acronyms that are not obvious
> > most of
> > the time. This commit introduces a DC glossary in order to make it
> > easier to navigate through our driver.
> >
> > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > ---
> > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257
> > ++++++++++++++++++++
> > 2 files changed, 258 insertions(+), 1 deletion(-)
> > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
> >
> > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > index 2e45e83d9a2a..15405c43786a 100644
> > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > @@ -26,4 +26,4 @@ table of content:
> > amdgpu-dcn-overview.rst
> > amdgpu-dm.rst
> > amdgpu-dc-debug.rst
> > -
> > + dc-glossary.rst
> > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > new file mode 100644
> > index 000000000000..48698fc1799f
> > --- /dev/null
> > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > @@ -0,0 +1,257 @@
> > +===========
> > +DC Glossary
> > +===========
> > +
> > +.. glossary::
> > +
> > + ABM
> > + Adaptive Backlight Modulation
> > +
> > + APU
> > + Accelerated Processing Unit
> > +
> > + ASIC
> > + Application-Specific Integrated Circuit
> > +
> > + ASSR
> > + Alternate Scrambler Seed Reset
> > +
> > + AZ
> > + Azalia (HD audio DMA engine)
> > +
> > + BPC
> > + Bits Per Colour/Component
> > +
> > + BPP
> > + Bits Per Pixel
> > +
> > + Clocks
> > + * PCLK: Pixel Clock
> > + * SYMCLK: Symbol Clock
> > + * SOCCLK: GPU Engine Clock
> > + * DISPCLK: Display Clock
> > + * DPPCLK: DPP Clock
> > + * DCFCLK: Display Controller Fabric Clock
> > + * REFCLK: Real Time Reference Clock
> > + * PPLL: Pixel PLL
> > + * FCLK: Fabric Clock
> > + * MCLK: Memory Clock
> > + * CPLIB: Content Protection Library
>
> CPLIB is not a clock. It should be split out as its own item.
>
> > +
> > + CRC
> > + Cyclic Redundancy Check
> > +
> > + CRTC
> > + Cathode Ray Tube Controller - commonly called "Controller" -
> > Generates
> > + raw stream of pixels, clocked at pixel clock
> > +
> > + CVT
> > + Coordinated Video Timings
> > +
> > + DAL
> > + Display Abstraction layer
I recall this as the old name for DC, maybe this should be mentioned ?
> > +
> > + DC (Software)
> > + Display Core
> > +
> > + DC (Hardware)
> > + Display Controller
> > +
> > + DCC
> > + Delta Colour Compression
> > +
> > + DCE
> > + Display Controller Engine
> > +
> > + DCHUB
> > + Display Controller Hub
> > +
> > + ARB
> > + Arbiter
> > +
> > + VTG
> > + Vertical Timing Generator
> > +
> > + DCN
> > + Display Core Next
> > +
> > + DCCG
> > + Display Clock Generator block
> > +
> > + DDC
> > + Display Data Channel
> > +
> > + DFS
> > + Digital Frequency Synthesizer
> > +
> > + DIO
> > + Display IO
> > +
> > + DPP
> > + Display Pipes and Planes
> > +
> > + DSC
> > + Display Stream Compression (Reduce the amount of bits to
> > represent pixel
> > + count while at the same pixel clock)
> > +
> > + dGPU
> > + discrete GPU
> > +
> > + DMIF
> > + Display Memory Interface
> > +
> > + DML
> > + Display Mode Library
> > +
> > + DMCU
> > + Display Micro Controller Unit
> > +
> > + DMCUB
> > + Display Micro-Controller Unit, version B
>
> Make Micro Controller vs. Micro-Controller consistent for these.
>
> > +
> > + DPCD
> > + DisplayPort Configuration Data
> > +
> > + DPM(S)
> > + Display Power Management (Signaling)
> > +
> > + DRR
> > + Dynamic Refresh Rate
> > +
> > + DWB
> > + Display writeback
> > +
> > + ECP
> > + Enhanced Content Protection
> > +
> > + FB
> > + Frame Buffer
> > +
> > + FBC
> > + Frame Buffer Compression
> > +
> > + FEC
> > + Forward Error Correction
> > +
> > + FRL
> > + Fixed Rate Link
> > +
> > + GCO
> > + Graphical Controller Object
> > +
> > + GMC
> > + Graphic Memory Controller
> > +
> > + GSL
> > + Global Swap Lock
> > +
> > + iGPU
> > + integrated GPU
> > +
> > + IH
> > + Interrupt Handler
> > +
> > + ISR
> > + Interrupt Service Request
> > +
> > + ISV
> > + Independent Software Vendor
> > +
> > + KMD
> > + Kernel Mode Driver
> > +
> > + LB
> > + Line Buffer
> > +
> > + LFC
> > + Low Framerate Compensation
> > +
> > + LTTPR
> > + Link Training Tunable Phy Repeater
> > +
> > + LUT
> > + Lookup Table
> > +
> > + MALL
> > + Memory Access at Last Level
> > +
> > + MC
> > + Memory Controller
> > +
> > + MPC
> > + Multiple pipes and plane combine
> > +
> > + MPO
> > + Multi Plane Overlay
> > +
> > + MST
> > + Multi Stream Transport
> > +
> > + NBP State
> > + Northbridge Power State
> > +
> > + NBIO
> > + North Bridge Input/Output
> > +
> > + ODM
> > + Output Data Mapping
> > +
> > + OPM
> > + Output Protection Manager
> > +
> > + OPP
> > + Output Plane Processor
> > +
> > + OPTC
> > + Output Pipe Timing Combiner
> > +
> > + OTG
> > + Output Timing Generator
> > +
> > + PCON
> > + Power Controller
> > +
> > + PGFSM
> > + Power Gate Finite State Machine
> > +
> > + PPLib
> > + PowerPlay Library
>
> Maybe say that powerplay is the power management component.
>
> > +
> > + PSR
> > + Panel Self Refresh
> > +
> > + SCL
> > + Scaler
> > +
> > + SDP
> > + Scalable Data Port
> > +
> > + SMU
> > + System Management Unit
> > +
> > + SLS
> > + Single Large Surface
> > +
> > + SST
> > + Single Stream Transport
> > +
> > + TMDS
> > + Transition-Minimized Differential Signaling
> > +
> > + TMZ
> > + Trusted Memory Zone
> > +
> > + TTU
> > + Time to Underflow
> > +
> > + VRR
> > + Variable Refresh Rate
> > +
> > + UVD
> > + Unified Video Decoder
> > +
> > + VCE
> > + Video Compression Engine
> > +
> > + VCN
> > + Video Codec Next
> > --
> > 2.25.1
> >
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-29 20:48 ` ydirson
(?)
@ 2021-11-30 10:09 ` Christian König
-1 siblings, 0 replies; 51+ messages in thread
From: Christian König @ 2021-11-30 10:09 UTC (permalink / raw)
To: ydirson, Rodrigo Siqueira
Cc: Harry Wentland, Linux Doc Mailing List, Mark Yacoub,
Michel Dänzer, Bas Nieuwenhuizen, Roman Li, amd-gfx list,
Christian König, Marek Olšák, Alex Deucher,
Pekka Paalanen, Aurabindo Pillai, nicholas choi,
Maling list - DRI developers, Simon Ser, Alex Deucher, Sean Paul,
Qingqing Zhuo, Roman Gilg, Bhawanpreet Lakha,
Nicholas Kazlauskas
Am 29.11.21 um 21:48 schrieb ydirson@free.fr:
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
End Of Pipe/Pipeline :)
This means that calculations are done, all caches are flushed and all
memory is coherent again.
Usually related to an interrupt send or fence value written.
Christian.
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
>
> More suggestions inlined.
>
> Best regards,
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 10:09 ` Christian König
0 siblings, 0 replies; 51+ messages in thread
From: Christian König @ 2021-11-30 10:09 UTC (permalink / raw)
To: ydirson, Rodrigo Siqueira
Cc: Bhawanpreet Lakha, Linux Doc Mailing List, Mark Yacoub,
Michel Dänzer, Roman Li, amd-gfx list, Roman Gilg,
Marek Olšák, Aurabindo Pillai, nicholas choi,
Maling list - DRI developers, Alex Deucher, Sean Paul,
Qingqing Zhuo, Nicholas Kazlauskas, Christian König
Am 29.11.21 um 21:48 schrieb ydirson@free.fr:
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
End Of Pipe/Pipeline :)
This means that calculations are done, all caches are flushed and all
memory is coherent again.
Usually related to an interrupt send or fence value written.
Christian.
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
>
> More suggestions inlined.
>
> Best regards,
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 10:09 ` Christian König
0 siblings, 0 replies; 51+ messages in thread
From: Christian König @ 2021-11-30 10:09 UTC (permalink / raw)
To: ydirson, Rodrigo Siqueira
Cc: Bhawanpreet Lakha, Simon Ser, Linux Doc Mailing List,
Mark Yacoub, Michel Dänzer, Roman Li, amd-gfx list,
Roman Gilg, Marek Olšák, Alex Deucher, Pekka Paalanen,
Aurabindo Pillai, nicholas choi, Maling list - DRI developers,
Bas Nieuwenhuizen, Alex Deucher, Sean Paul, Qingqing Zhuo,
Nicholas Kazlauskas, Harry Wentland, Christian König
Am 29.11.21 um 21:48 schrieb ydirson@free.fr:
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
End Of Pipe/Pipeline :)
This means that calculations are done, all caches are flushed and all
memory is coherent again.
Usually related to an interrupt send or fence value written.
Christian.
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
>
> More suggestions inlined.
>
> Best regards,
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-29 20:48 ` ydirson
(?)
@ 2021-11-30 14:39 ` Alex Deucher
-1 siblings, 0 replies; 51+ messages in thread
From: Alex Deucher @ 2021-11-30 14:39 UTC (permalink / raw)
To: Yann Dirson
Cc: Rodrigo Siqueira, Mark Yacoub, Bhawanpreet Lakha, nicholas choi,
Linux Doc Mailing List, Simon Ser, Michel Dänzer, Roman Li,
amd-gfx list, Nicholas Kazlauskas, Marek Olšák,
Pekka Paalanen, Aurabindo Pillai, Sean Paul,
Maling list - DRI developers, Bas Nieuwenhuizen, Alex Deucher,
Qingqing Zhuo, Christian König, Harry Wentland, Roman Gilg
On Mon, Nov 29, 2021 at 3:48 PM <ydirson@free.fr> wrote:
>
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
Kernel Compute Queue and Kernel Graphics Queue.
Alex
>
> More suggestions inlined.
>
> Best regards,
> --
> Yann
>
> > On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
> > <Rodrigo.Siqueira@amd.com> wrote:
> > >
> > > In the DC driver, we have multiple acronyms that are not obvious
> > > most of
> > > the time. This commit introduces a DC glossary in order to make it
> > > easier to navigate through our driver.
> > >
> > > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > > ---
> > > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> > > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257
> > > ++++++++++++++++++++
> > > 2 files changed, 258 insertions(+), 1 deletion(-)
> > > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > >
> > > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > index 2e45e83d9a2a..15405c43786a 100644
> > > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > @@ -26,4 +26,4 @@ table of content:
> > > amdgpu-dcn-overview.rst
> > > amdgpu-dm.rst
> > > amdgpu-dc-debug.rst
> > > -
> > > + dc-glossary.rst
> > > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > new file mode 100644
> > > index 000000000000..48698fc1799f
> > > --- /dev/null
> > > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > @@ -0,0 +1,257 @@
> > > +===========
> > > +DC Glossary
> > > +===========
> > > +
> > > +.. glossary::
> > > +
> > > + ABM
> > > + Adaptive Backlight Modulation
> > > +
> > > + APU
> > > + Accelerated Processing Unit
> > > +
> > > + ASIC
> > > + Application-Specific Integrated Circuit
> > > +
> > > + ASSR
> > > + Alternate Scrambler Seed Reset
> > > +
> > > + AZ
> > > + Azalia (HD audio DMA engine)
> > > +
> > > + BPC
> > > + Bits Per Colour/Component
> > > +
> > > + BPP
> > > + Bits Per Pixel
> > > +
> > > + Clocks
> > > + * PCLK: Pixel Clock
> > > + * SYMCLK: Symbol Clock
> > > + * SOCCLK: GPU Engine Clock
> > > + * DISPCLK: Display Clock
> > > + * DPPCLK: DPP Clock
> > > + * DCFCLK: Display Controller Fabric Clock
> > > + * REFCLK: Real Time Reference Clock
> > > + * PPLL: Pixel PLL
> > > + * FCLK: Fabric Clock
> > > + * MCLK: Memory Clock
> > > + * CPLIB: Content Protection Library
> >
> > CPLIB is not a clock. It should be split out as its own item.
> >
> > > +
> > > + CRC
> > > + Cyclic Redundancy Check
> > > +
> > > + CRTC
> > > + Cathode Ray Tube Controller - commonly called "Controller" -
> > > Generates
> > > + raw stream of pixels, clocked at pixel clock
> > > +
> > > + CVT
> > > + Coordinated Video Timings
> > > +
> > > + DAL
> > > + Display Abstraction layer
>
> I recall this as the old name for DC, maybe this should be mentioned ?
>
> > > +
> > > + DC (Software)
> > > + Display Core
> > > +
> > > + DC (Hardware)
> > > + Display Controller
> > > +
> > > + DCC
> > > + Delta Colour Compression
> > > +
> > > + DCE
> > > + Display Controller Engine
> > > +
> > > + DCHUB
> > > + Display Controller Hub
> > > +
> > > + ARB
> > > + Arbiter
> > > +
> > > + VTG
> > > + Vertical Timing Generator
> > > +
> > > + DCN
> > > + Display Core Next
> > > +
> > > + DCCG
> > > + Display Clock Generator block
> > > +
> > > + DDC
> > > + Display Data Channel
> > > +
> > > + DFS
> > > + Digital Frequency Synthesizer
> > > +
> > > + DIO
> > > + Display IO
> > > +
> > > + DPP
> > > + Display Pipes and Planes
> > > +
> > > + DSC
> > > + Display Stream Compression (Reduce the amount of bits to
> > > represent pixel
> > > + count while at the same pixel clock)
> > > +
> > > + dGPU
> > > + discrete GPU
> > > +
> > > + DMIF
> > > + Display Memory Interface
> > > +
> > > + DML
> > > + Display Mode Library
> > > +
> > > + DMCU
> > > + Display Micro Controller Unit
> > > +
> > > + DMCUB
> > > + Display Micro-Controller Unit, version B
> >
> > Make Micro Controller vs. Micro-Controller consistent for these.
> >
> > > +
> > > + DPCD
> > > + DisplayPort Configuration Data
> > > +
> > > + DPM(S)
> > > + Display Power Management (Signaling)
> > > +
> > > + DRR
> > > + Dynamic Refresh Rate
> > > +
> > > + DWB
> > > + Display writeback
> > > +
> > > + ECP
> > > + Enhanced Content Protection
> > > +
> > > + FB
> > > + Frame Buffer
> > > +
> > > + FBC
> > > + Frame Buffer Compression
> > > +
> > > + FEC
> > > + Forward Error Correction
> > > +
> > > + FRL
> > > + Fixed Rate Link
> > > +
> > > + GCO
> > > + Graphical Controller Object
> > > +
> > > + GMC
> > > + Graphic Memory Controller
> > > +
> > > + GSL
> > > + Global Swap Lock
> > > +
> > > + iGPU
> > > + integrated GPU
> > > +
> > > + IH
> > > + Interrupt Handler
> > > +
> > > + ISR
> > > + Interrupt Service Request
> > > +
> > > + ISV
> > > + Independent Software Vendor
> > > +
> > > + KMD
> > > + Kernel Mode Driver
> > > +
> > > + LB
> > > + Line Buffer
> > > +
> > > + LFC
> > > + Low Framerate Compensation
> > > +
> > > + LTTPR
> > > + Link Training Tunable Phy Repeater
> > > +
> > > + LUT
> > > + Lookup Table
> > > +
> > > + MALL
> > > + Memory Access at Last Level
> > > +
> > > + MC
> > > + Memory Controller
> > > +
> > > + MPC
> > > + Multiple pipes and plane combine
> > > +
> > > + MPO
> > > + Multi Plane Overlay
> > > +
> > > + MST
> > > + Multi Stream Transport
> > > +
> > > + NBP State
> > > + Northbridge Power State
> > > +
> > > + NBIO
> > > + North Bridge Input/Output
> > > +
> > > + ODM
> > > + Output Data Mapping
> > > +
> > > + OPM
> > > + Output Protection Manager
> > > +
> > > + OPP
> > > + Output Plane Processor
> > > +
> > > + OPTC
> > > + Output Pipe Timing Combiner
> > > +
> > > + OTG
> > > + Output Timing Generator
> > > +
> > > + PCON
> > > + Power Controller
> > > +
> > > + PGFSM
> > > + Power Gate Finite State Machine
> > > +
> > > + PPLib
> > > + PowerPlay Library
> >
> > Maybe say that powerplay is the power management component.
> >
> > > +
> > > + PSR
> > > + Panel Self Refresh
> > > +
> > > + SCL
> > > + Scaler
> > > +
> > > + SDP
> > > + Scalable Data Port
> > > +
> > > + SMU
> > > + System Management Unit
> > > +
> > > + SLS
> > > + Single Large Surface
> > > +
> > > + SST
> > > + Single Stream Transport
> > > +
> > > + TMDS
> > > + Transition-Minimized Differential Signaling
> > > +
> > > + TMZ
> > > + Trusted Memory Zone
> > > +
> > > + TTU
> > > + Time to Underflow
> > > +
> > > + VRR
> > > + Variable Refresh Rate
> > > +
> > > + UVD
> > > + Unified Video Decoder
> > > +
> > > + VCE
> > > + Video Compression Engine
> > > +
> > > + VCN
> > > + Video Codec Next
> > > --
> > > 2.25.1
> > >
> >
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 14:39 ` Alex Deucher
0 siblings, 0 replies; 51+ messages in thread
From: Alex Deucher @ 2021-11-30 14:39 UTC (permalink / raw)
To: Yann Dirson
Cc: Linux Doc Mailing List, Mark Yacoub, Michel Dänzer,
Rodrigo Siqueira, Roman Li, amd-gfx list, Christian König,
Marek Olšák, Aurabindo Pillai, nicholas choi,
Maling list - DRI developers, Alex Deucher, Sean Paul,
Qingqing Zhuo, Roman Gilg, Bhawanpreet Lakha,
Nicholas Kazlauskas
On Mon, Nov 29, 2021 at 3:48 PM <ydirson@free.fr> wrote:
>
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
Kernel Compute Queue and Kernel Graphics Queue.
Alex
>
> More suggestions inlined.
>
> Best regards,
> --
> Yann
>
> > On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
> > <Rodrigo.Siqueira@amd.com> wrote:
> > >
> > > In the DC driver, we have multiple acronyms that are not obvious
> > > most of
> > > the time. This commit introduces a DC glossary in order to make it
> > > easier to navigate through our driver.
> > >
> > > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > > ---
> > > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> > > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257
> > > ++++++++++++++++++++
> > > 2 files changed, 258 insertions(+), 1 deletion(-)
> > > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > >
> > > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > index 2e45e83d9a2a..15405c43786a 100644
> > > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > @@ -26,4 +26,4 @@ table of content:
> > > amdgpu-dcn-overview.rst
> > > amdgpu-dm.rst
> > > amdgpu-dc-debug.rst
> > > -
> > > + dc-glossary.rst
> > > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > new file mode 100644
> > > index 000000000000..48698fc1799f
> > > --- /dev/null
> > > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > @@ -0,0 +1,257 @@
> > > +===========
> > > +DC Glossary
> > > +===========
> > > +
> > > +.. glossary::
> > > +
> > > + ABM
> > > + Adaptive Backlight Modulation
> > > +
> > > + APU
> > > + Accelerated Processing Unit
> > > +
> > > + ASIC
> > > + Application-Specific Integrated Circuit
> > > +
> > > + ASSR
> > > + Alternate Scrambler Seed Reset
> > > +
> > > + AZ
> > > + Azalia (HD audio DMA engine)
> > > +
> > > + BPC
> > > + Bits Per Colour/Component
> > > +
> > > + BPP
> > > + Bits Per Pixel
> > > +
> > > + Clocks
> > > + * PCLK: Pixel Clock
> > > + * SYMCLK: Symbol Clock
> > > + * SOCCLK: GPU Engine Clock
> > > + * DISPCLK: Display Clock
> > > + * DPPCLK: DPP Clock
> > > + * DCFCLK: Display Controller Fabric Clock
> > > + * REFCLK: Real Time Reference Clock
> > > + * PPLL: Pixel PLL
> > > + * FCLK: Fabric Clock
> > > + * MCLK: Memory Clock
> > > + * CPLIB: Content Protection Library
> >
> > CPLIB is not a clock. It should be split out as its own item.
> >
> > > +
> > > + CRC
> > > + Cyclic Redundancy Check
> > > +
> > > + CRTC
> > > + Cathode Ray Tube Controller - commonly called "Controller" -
> > > Generates
> > > + raw stream of pixels, clocked at pixel clock
> > > +
> > > + CVT
> > > + Coordinated Video Timings
> > > +
> > > + DAL
> > > + Display Abstraction layer
>
> I recall this as the old name for DC, maybe this should be mentioned ?
>
> > > +
> > > + DC (Software)
> > > + Display Core
> > > +
> > > + DC (Hardware)
> > > + Display Controller
> > > +
> > > + DCC
> > > + Delta Colour Compression
> > > +
> > > + DCE
> > > + Display Controller Engine
> > > +
> > > + DCHUB
> > > + Display Controller Hub
> > > +
> > > + ARB
> > > + Arbiter
> > > +
> > > + VTG
> > > + Vertical Timing Generator
> > > +
> > > + DCN
> > > + Display Core Next
> > > +
> > > + DCCG
> > > + Display Clock Generator block
> > > +
> > > + DDC
> > > + Display Data Channel
> > > +
> > > + DFS
> > > + Digital Frequency Synthesizer
> > > +
> > > + DIO
> > > + Display IO
> > > +
> > > + DPP
> > > + Display Pipes and Planes
> > > +
> > > + DSC
> > > + Display Stream Compression (Reduce the amount of bits to
> > > represent pixel
> > > + count while at the same pixel clock)
> > > +
> > > + dGPU
> > > + discrete GPU
> > > +
> > > + DMIF
> > > + Display Memory Interface
> > > +
> > > + DML
> > > + Display Mode Library
> > > +
> > > + DMCU
> > > + Display Micro Controller Unit
> > > +
> > > + DMCUB
> > > + Display Micro-Controller Unit, version B
> >
> > Make Micro Controller vs. Micro-Controller consistent for these.
> >
> > > +
> > > + DPCD
> > > + DisplayPort Configuration Data
> > > +
> > > + DPM(S)
> > > + Display Power Management (Signaling)
> > > +
> > > + DRR
> > > + Dynamic Refresh Rate
> > > +
> > > + DWB
> > > + Display writeback
> > > +
> > > + ECP
> > > + Enhanced Content Protection
> > > +
> > > + FB
> > > + Frame Buffer
> > > +
> > > + FBC
> > > + Frame Buffer Compression
> > > +
> > > + FEC
> > > + Forward Error Correction
> > > +
> > > + FRL
> > > + Fixed Rate Link
> > > +
> > > + GCO
> > > + Graphical Controller Object
> > > +
> > > + GMC
> > > + Graphic Memory Controller
> > > +
> > > + GSL
> > > + Global Swap Lock
> > > +
> > > + iGPU
> > > + integrated GPU
> > > +
> > > + IH
> > > + Interrupt Handler
> > > +
> > > + ISR
> > > + Interrupt Service Request
> > > +
> > > + ISV
> > > + Independent Software Vendor
> > > +
> > > + KMD
> > > + Kernel Mode Driver
> > > +
> > > + LB
> > > + Line Buffer
> > > +
> > > + LFC
> > > + Low Framerate Compensation
> > > +
> > > + LTTPR
> > > + Link Training Tunable Phy Repeater
> > > +
> > > + LUT
> > > + Lookup Table
> > > +
> > > + MALL
> > > + Memory Access at Last Level
> > > +
> > > + MC
> > > + Memory Controller
> > > +
> > > + MPC
> > > + Multiple pipes and plane combine
> > > +
> > > + MPO
> > > + Multi Plane Overlay
> > > +
> > > + MST
> > > + Multi Stream Transport
> > > +
> > > + NBP State
> > > + Northbridge Power State
> > > +
> > > + NBIO
> > > + North Bridge Input/Output
> > > +
> > > + ODM
> > > + Output Data Mapping
> > > +
> > > + OPM
> > > + Output Protection Manager
> > > +
> > > + OPP
> > > + Output Plane Processor
> > > +
> > > + OPTC
> > > + Output Pipe Timing Combiner
> > > +
> > > + OTG
> > > + Output Timing Generator
> > > +
> > > + PCON
> > > + Power Controller
> > > +
> > > + PGFSM
> > > + Power Gate Finite State Machine
> > > +
> > > + PPLib
> > > + PowerPlay Library
> >
> > Maybe say that powerplay is the power management component.
> >
> > > +
> > > + PSR
> > > + Panel Self Refresh
> > > +
> > > + SCL
> > > + Scaler
> > > +
> > > + SDP
> > > + Scalable Data Port
> > > +
> > > + SMU
> > > + System Management Unit
> > > +
> > > + SLS
> > > + Single Large Surface
> > > +
> > > + SST
> > > + Single Stream Transport
> > > +
> > > + TMDS
> > > + Transition-Minimized Differential Signaling
> > > +
> > > + TMZ
> > > + Trusted Memory Zone
> > > +
> > > + TTU
> > > + Time to Underflow
> > > +
> > > + VRR
> > > + Variable Refresh Rate
> > > +
> > > + UVD
> > > + Unified Video Decoder
> > > +
> > > + VCE
> > > + Video Compression Engine
> > > +
> > > + VCN
> > > + Video Codec Next
> > > --
> > > 2.25.1
> > >
> >
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 14:39 ` Alex Deucher
0 siblings, 0 replies; 51+ messages in thread
From: Alex Deucher @ 2021-11-30 14:39 UTC (permalink / raw)
To: Yann Dirson
Cc: Harry Wentland, Linux Doc Mailing List, Mark Yacoub,
Michel Dänzer, Bas Nieuwenhuizen, Rodrigo Siqueira,
Roman Li, amd-gfx list, Christian König,
Marek Olšák, Pekka Paalanen, Aurabindo Pillai,
nicholas choi, Maling list - DRI developers, Simon Ser,
Alex Deucher, Sean Paul, Qingqing Zhuo, Roman Gilg,
Bhawanpreet Lakha, Nicholas Kazlauskas
On Mon, Nov 29, 2021 at 3:48 PM <ydirson@free.fr> wrote:
>
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
Kernel Compute Queue and Kernel Graphics Queue.
Alex
>
> More suggestions inlined.
>
> Best regards,
> --
> Yann
>
> > On Thu, Nov 25, 2021 at 10:40 AM Rodrigo Siqueira
> > <Rodrigo.Siqueira@amd.com> wrote:
> > >
> > > In the DC driver, we have multiple acronyms that are not obvious
> > > most of
> > > the time. This commit introduces a DC glossary in order to make it
> > > easier to navigate through our driver.
> > >
> > > Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> > > ---
> > > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 2 +-
> > > Documentation/gpu/amdgpu-dc/dc-glossary.rst | 257
> > > ++++++++++++++++++++
> > > 2 files changed, 258 insertions(+), 1 deletion(-)
> > > create mode 100644 Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > >
> > > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > index 2e45e83d9a2a..15405c43786a 100644
> > > --- a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst
> > > @@ -26,4 +26,4 @@ table of content:
> > > amdgpu-dcn-overview.rst
> > > amdgpu-dm.rst
> > > amdgpu-dc-debug.rst
> > > -
> > > + dc-glossary.rst
> > > diff --git a/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > new file mode 100644
> > > index 000000000000..48698fc1799f
> > > --- /dev/null
> > > +++ b/Documentation/gpu/amdgpu-dc/dc-glossary.rst
> > > @@ -0,0 +1,257 @@
> > > +===========
> > > +DC Glossary
> > > +===========
> > > +
> > > +.. glossary::
> > > +
> > > + ABM
> > > + Adaptive Backlight Modulation
> > > +
> > > + APU
> > > + Accelerated Processing Unit
> > > +
> > > + ASIC
> > > + Application-Specific Integrated Circuit
> > > +
> > > + ASSR
> > > + Alternate Scrambler Seed Reset
> > > +
> > > + AZ
> > > + Azalia (HD audio DMA engine)
> > > +
> > > + BPC
> > > + Bits Per Colour/Component
> > > +
> > > + BPP
> > > + Bits Per Pixel
> > > +
> > > + Clocks
> > > + * PCLK: Pixel Clock
> > > + * SYMCLK: Symbol Clock
> > > + * SOCCLK: GPU Engine Clock
> > > + * DISPCLK: Display Clock
> > > + * DPPCLK: DPP Clock
> > > + * DCFCLK: Display Controller Fabric Clock
> > > + * REFCLK: Real Time Reference Clock
> > > + * PPLL: Pixel PLL
> > > + * FCLK: Fabric Clock
> > > + * MCLK: Memory Clock
> > > + * CPLIB: Content Protection Library
> >
> > CPLIB is not a clock. It should be split out as its own item.
> >
> > > +
> > > + CRC
> > > + Cyclic Redundancy Check
> > > +
> > > + CRTC
> > > + Cathode Ray Tube Controller - commonly called "Controller" -
> > > Generates
> > > + raw stream of pixels, clocked at pixel clock
> > > +
> > > + CVT
> > > + Coordinated Video Timings
> > > +
> > > + DAL
> > > + Display Abstraction layer
>
> I recall this as the old name for DC, maybe this should be mentioned ?
>
> > > +
> > > + DC (Software)
> > > + Display Core
> > > +
> > > + DC (Hardware)
> > > + Display Controller
> > > +
> > > + DCC
> > > + Delta Colour Compression
> > > +
> > > + DCE
> > > + Display Controller Engine
> > > +
> > > + DCHUB
> > > + Display Controller Hub
> > > +
> > > + ARB
> > > + Arbiter
> > > +
> > > + VTG
> > > + Vertical Timing Generator
> > > +
> > > + DCN
> > > + Display Core Next
> > > +
> > > + DCCG
> > > + Display Clock Generator block
> > > +
> > > + DDC
> > > + Display Data Channel
> > > +
> > > + DFS
> > > + Digital Frequency Synthesizer
> > > +
> > > + DIO
> > > + Display IO
> > > +
> > > + DPP
> > > + Display Pipes and Planes
> > > +
> > > + DSC
> > > + Display Stream Compression (Reduce the amount of bits to
> > > represent pixel
> > > + count while at the same pixel clock)
> > > +
> > > + dGPU
> > > + discrete GPU
> > > +
> > > + DMIF
> > > + Display Memory Interface
> > > +
> > > + DML
> > > + Display Mode Library
> > > +
> > > + DMCU
> > > + Display Micro Controller Unit
> > > +
> > > + DMCUB
> > > + Display Micro-Controller Unit, version B
> >
> > Make Micro Controller vs. Micro-Controller consistent for these.
> >
> > > +
> > > + DPCD
> > > + DisplayPort Configuration Data
> > > +
> > > + DPM(S)
> > > + Display Power Management (Signaling)
> > > +
> > > + DRR
> > > + Dynamic Refresh Rate
> > > +
> > > + DWB
> > > + Display writeback
> > > +
> > > + ECP
> > > + Enhanced Content Protection
> > > +
> > > + FB
> > > + Frame Buffer
> > > +
> > > + FBC
> > > + Frame Buffer Compression
> > > +
> > > + FEC
> > > + Forward Error Correction
> > > +
> > > + FRL
> > > + Fixed Rate Link
> > > +
> > > + GCO
> > > + Graphical Controller Object
> > > +
> > > + GMC
> > > + Graphic Memory Controller
> > > +
> > > + GSL
> > > + Global Swap Lock
> > > +
> > > + iGPU
> > > + integrated GPU
> > > +
> > > + IH
> > > + Interrupt Handler
> > > +
> > > + ISR
> > > + Interrupt Service Request
> > > +
> > > + ISV
> > > + Independent Software Vendor
> > > +
> > > + KMD
> > > + Kernel Mode Driver
> > > +
> > > + LB
> > > + Line Buffer
> > > +
> > > + LFC
> > > + Low Framerate Compensation
> > > +
> > > + LTTPR
> > > + Link Training Tunable Phy Repeater
> > > +
> > > + LUT
> > > + Lookup Table
> > > +
> > > + MALL
> > > + Memory Access at Last Level
> > > +
> > > + MC
> > > + Memory Controller
> > > +
> > > + MPC
> > > + Multiple pipes and plane combine
> > > +
> > > + MPO
> > > + Multi Plane Overlay
> > > +
> > > + MST
> > > + Multi Stream Transport
> > > +
> > > + NBP State
> > > + Northbridge Power State
> > > +
> > > + NBIO
> > > + North Bridge Input/Output
> > > +
> > > + ODM
> > > + Output Data Mapping
> > > +
> > > + OPM
> > > + Output Protection Manager
> > > +
> > > + OPP
> > > + Output Plane Processor
> > > +
> > > + OPTC
> > > + Output Pipe Timing Combiner
> > > +
> > > + OTG
> > > + Output Timing Generator
> > > +
> > > + PCON
> > > + Power Controller
> > > +
> > > + PGFSM
> > > + Power Gate Finite State Machine
> > > +
> > > + PPLib
> > > + PowerPlay Library
> >
> > Maybe say that powerplay is the power management component.
> >
> > > +
> > > + PSR
> > > + Panel Self Refresh
> > > +
> > > + SCL
> > > + Scaler
> > > +
> > > + SDP
> > > + Scalable Data Port
> > > +
> > > + SMU
> > > + System Management Unit
> > > +
> > > + SLS
> > > + Single Large Surface
> > > +
> > > + SST
> > > + Single Stream Transport
> > > +
> > > + TMDS
> > > + Transition-Minimized Differential Signaling
> > > +
> > > + TMZ
> > > + Trusted Memory Zone
> > > +
> > > + TTU
> > > + Time to Underflow
> > > +
> > > + VRR
> > > + Variable Refresh Rate
> > > +
> > > + UVD
> > > + Unified Video Decoder
> > > +
> > > + VCE
> > > + Video Compression Engine
> > > +
> > > + VCN
> > > + Video Codec Next
> > > --
> > > 2.25.1
> > >
> >
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-29 12:06 ` Jani Nikula
@ 2021-11-30 15:46 ` Rodrigo Siqueira Jordao
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:46 UTC (permalink / raw)
To: Jani Nikula, Daniel Vetter, Rodrigo Siqueira, Christian König
Cc: linux-doc, Mark Yacoub, Michel Dänzer, roman.li, amd-gfx,
Marek Olšák, aurabindo.pillai, nicholas.choi,
dri-devel, Alex Deucher, Sean Paul, qingqing.zhuo, Roman Gilg,
bhawanpreet.lakha, Nicholas Kazlauskas
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.
Thanks.
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-30 15:46 ` Rodrigo Siqueira Jordao
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:46 UTC (permalink / raw)
To: Jani Nikula, Daniel Vetter, Rodrigo Siqueira, Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Roman Gilg, aurabindo.pillai, nicholas.choi, dri-devel,
Alex Deucher, Sean Paul, qingqing.zhuo, Nicholas Kazlauskas,
bhawanpreet.lakha, Michel Dänzer
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.
Thanks.
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-30 15:46 ` Rodrigo Siqueira Jordao
@ 2021-11-30 15:48 ` Harry Wentland
-1 siblings, 0 replies; 51+ messages in thread
From: Harry Wentland @ 2021-11-30 15:48 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao, Jani Nikula, Daniel Vetter,
Rodrigo Siqueira, Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Nicholas Kazlauskas, Michel Dänzer, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, Sean Paul, qingqing.zhuo,
bhawanpreet.lakha, Roman Gilg
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?
Harry
> Thanks.
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-30 15:48 ` Harry Wentland
0 siblings, 0 replies; 51+ messages in thread
From: Harry Wentland @ 2021-11-30 15:48 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao, Jani Nikula, Daniel Vetter,
Rodrigo Siqueira, Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Roman Gilg, aurabindo.pillai, nicholas.choi, dri-devel,
Alex Deucher, Sean Paul, qingqing.zhuo, Nicholas Kazlauskas,
bhawanpreet.lakha, Michel Dänzer
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?
Harry
> Thanks.
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-29 20:48 ` ydirson
(?)
@ 2021-11-30 15:53 ` Rodrigo Siqueira Jordao
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:53 UTC (permalink / raw)
To: ydirson, Rodrigo Siqueira, Christian König, Alex Deucher
Cc: Mark Yacoub, Bhawanpreet Lakha, nicholas choi,
Linux Doc Mailing List, Alex Deucher, Simon Ser,
Michel Dänzer, Roman Li, amd-gfx list, Nicholas Kazlauskas,
Marek Olšák, Pekka Paalanen, Aurabindo Pillai,
Sean Paul, Maling list - DRI developers, Bas Nieuwenhuizen,
Qingqing Zhuo, Harry Wentland, Roman Gilg
On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
>
> More suggestions inlined.
>
> Best regards,
>
Hi all,
I'll address all the highlighted problems in the V2. Thanks a lot for
all the feedback.
Yann,
For the generic acronyms, how about keeping it in this patch for now?
After it gets merged, I can prepare a new documentation patch that
creates a glossary for DRM where I move the generic acronyms to the DRM
documentation. I prefer this approach to keep the improvement small and
manageable.
Best Regards
Siqueira
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 15:53 ` Rodrigo Siqueira Jordao
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:53 UTC (permalink / raw)
To: ydirson, Rodrigo Siqueira, Christian König, Alex Deucher
Cc: Linux Doc Mailing List, Mark Yacoub, Michel Dänzer,
Roman Li, amd-gfx list, Roman Gilg, Marek Olšák,
Aurabindo Pillai, nicholas choi, Maling list - DRI developers,
Sean Paul, Qingqing Zhuo, Bhawanpreet Lakha, Nicholas Kazlauskas
On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
>
> More suggestions inlined.
>
> Best regards,
>
Hi all,
I'll address all the highlighted problems in the V2. Thanks a lot for
all the feedback.
Yann,
For the generic acronyms, how about keeping it in this patch for now?
After it gets merged, I can prepare a new documentation patch that
creates a glossary for DRM where I move the generic acronyms to the DRM
documentation. I prefer this approach to keep the improvement small and
manageable.
Best Regards
Siqueira
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 15:53 ` Rodrigo Siqueira Jordao
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:53 UTC (permalink / raw)
To: ydirson, Rodrigo Siqueira, Christian König, Alex Deucher
Cc: Harry Wentland, Linux Doc Mailing List, Mark Yacoub,
Michel Dänzer, Bas Nieuwenhuizen, Roman Li, amd-gfx list,
Roman Gilg, Marek Olšák, Pekka Paalanen,
Aurabindo Pillai, nicholas choi, Maling list - DRI developers,
Simon Ser, Alex Deucher, Sean Paul, Qingqing Zhuo,
Bhawanpreet Lakha, Nicholas Kazlauskas
On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> Hi Rodrigo,
>
> That will really be helpful!
>
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list. I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
>
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too. Which brings me to the result of my recent
> searches as suggested entries:
>
> KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
> queue descriptor), EOP (still no clue :)
>
> Maybe some more specific ones just to be spelled out in clear where they
> are used ? KCQ (compute queue?), KGQ (gfx queue?)
>
> More suggestions inlined.
>
> Best regards,
>
Hi all,
I'll address all the highlighted problems in the V2. Thanks a lot for
all the feedback.
Yann,
For the generic acronyms, how about keeping it in this patch for now?
After it gets merged, I can prepare a new documentation patch that
creates a glossary for DRM where I move the generic acronyms to the DRM
documentation. I prefer this approach to keep the improvement small and
manageable.
Best Regards
Siqueira
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-30 15:48 ` Harry Wentland
@ 2021-11-30 15:59 ` Rodrigo Siqueira Jordao
-1 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:59 UTC (permalink / raw)
To: Harry Wentland, Jani Nikula, Daniel Vetter, Rodrigo Siqueira,
Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Roman Gilg, aurabindo.pillai, nicholas.choi, dri-devel,
Alex Deucher, Sean Paul, qingqing.zhuo, Nicholas Kazlauskas,
bhawanpreet.lakha, Michel Dänzer
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.
>>
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-30 15:59 ` Rodrigo Siqueira Jordao
0 siblings, 0 replies; 51+ messages in thread
From: Rodrigo Siqueira Jordao @ 2021-11-30 15:59 UTC (permalink / raw)
To: Harry Wentland, Jani Nikula, Daniel Vetter, Rodrigo Siqueira,
Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Nicholas Kazlauskas, Michel Dänzer, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, Sean Paul, qingqing.zhuo,
bhawanpreet.lakha, Roman Gilg
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.
>>
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-30 15:59 ` Rodrigo Siqueira Jordao
@ 2021-11-30 16:03 ` Harry Wentland
-1 siblings, 0 replies; 51+ messages in thread
From: Harry Wentland @ 2021-11-30 16:03 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao, Jani Nikula, Daniel Vetter,
Rodrigo Siqueira, Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Roman Gilg, aurabindo.pillai, nicholas.choi, dri-devel,
Alex Deucher, Sean Paul, qingqing.zhuo, Nicholas Kazlauskas,
bhawanpreet.lakha, Michel Dänzer
On 2021-11-30 10:59, Rodrigo Siqueira Jordao wrote:
>
>
> 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?
Makes sense.
Harry
> Thanks
>
>> Harry
>>
>>> Thanks.
>>>
>>
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-30 16:03 ` Harry Wentland
0 siblings, 0 replies; 51+ messages in thread
From: Harry Wentland @ 2021-11-30 16:03 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao, Jani Nikula, Daniel Vetter,
Rodrigo Siqueira, Christian König
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman.li, amd-gfx,
Nicholas Kazlauskas, Michel Dänzer, aurabindo.pillai,
nicholas.choi, dri-devel, Alex Deucher, Sean Paul, qingqing.zhuo,
bhawanpreet.lakha, Roman Gilg
On 2021-11-30 10:59, Rodrigo Siqueira Jordao wrote:
>
>
> 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?
Makes sense.
Harry
> Thanks
>
>> Harry
>>
>>> Thanks.
>>>
>>
>
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
2021-11-30 15:53 ` Rodrigo Siqueira Jordao
(?)
@ 2021-11-30 19:55 ` Yann Dirson
-1 siblings, 0 replies; 51+ messages in thread
From: Yann Dirson @ 2021-11-30 19:55 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao
Cc: Harry Wentland, Linux Doc Mailing List, Mark Yacoub,
Michel Dänzer, Bas Nieuwenhuizen, Roman Li, amd-gfx list,
Roman Gilg, Marek Olšák, Pekka Paalanen,
Aurabindo Pillai, nicholas choi, Maling list - DRI developers,
Simon Ser, Alex Deucher, Sean Paul, Qingqing Zhuo,
Bhawanpreet Lakha, Nicholas Kazlauskas, Rodrigo Siqueira,
Christian König, Alex Deucher
----- Mail original -----
> De: "Rodrigo Siqueira Jordao" <rjordrigo@amd.com>
> À: ydirson@free.fr, "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>, "Christian König" <christian.koenig@amd.com>,
> "Alex Deucher" <alexander.deucher@amd.com>
> Cc: "Harry Wentland" <Harry.Wentland@amd.com>, "Linux Doc Mailing List" <linux-doc@vger.kernel.org>, "Mark Yacoub"
> <markyacoub@chromium.org>, "Michel Dänzer" <michel@daenzer.net>, "Bas Nieuwenhuizen" <bas@basnieuwenhuizen.nl>,
> "Roman Li" <roman.li@amd.com>, "amd-gfx list" <amd-gfx@lists.freedesktop.org>, "Roman Gilg" <subdiff@gmail.com>,
> "Marek Olšák" <marek.olsak@amd.com>, "Pekka Paalanen" <ppaalanen@gmail.com>, "Aurabindo Pillai"
> <aurabindo.pillai@amd.com>, "nicholas choi" <nicholas.choi@amd.com>, "Maling list - DRI developers"
> <dri-devel@lists.freedesktop.org>, "Simon Ser" <contact@emersion.fr>, "Alex Deucher" <alexdeucher@gmail.com>, "Sean
> Paul" <seanpaul@chromium.org>, "Qingqing Zhuo" <qingqing.zhuo@amd.com>, "Bhawanpreet Lakha"
> <bhawanpreet.lakha@amd.com>, "Nicholas Kazlauskas" <nicholas.kazlauskas@amd.com>
> Envoyé: Mardi 30 Novembre 2021 16:53:55
> Objet: Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
>
>
>
> On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> > Hi Rodrigo,
> >
> > That will really be helpful!
> >
> > I know drawing the line is a difficult problem (and can even make
> > things
> > harder when searching), but maybe it would make sense to keep
> > generic
> > acronyms not specific to amdgpu in a separate list. I bet a number
> > of
> > them would be useful in the scope of other drm drivers (e.g. CRTC,
> > DCC,
> > MST), and some are not restricted to the drm subsystem at all (e.g.
> > FEC,
> > LUT), but still have value as not necessarily easy to look up.
> >
> > Maybe "DC glossary" should just be "Glossary", since quite some
> > entries
> > help to read adm/amdgpu/ too. Which brings me to the result of my
> > recent
> > searches as suggested entries:
> >
> > KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD
> > (hardware
> > queue descriptor), EOP (still no clue :)
> >
> > Maybe some more specific ones just to be spelled out in clear where
> > they
> > are used ? KCQ (compute queue?), KGQ (gfx queue?)
> >
> > More suggestions inlined.
> >
> > Best regards,
> >
>
> Hi all,
>
> I'll address all the highlighted problems in the V2. Thanks a lot for
> all the feedback.
>
> Yann,
> For the generic acronyms, how about keeping it in this patch for now?
> After it gets merged, I can prepare a new documentation patch that
> creates a glossary for DRM where I move the generic acronyms to the
> DRM
> documentation. I prefer this approach to keep the improvement small
> and
> manageable.
Sure, especially as the Right Solution(tm) is not necessarily obvious :)
One thing I thought about is that a context could be specified together
with terms. Like "BPP (graphics)", "FEC (CS)", "DMCUB (amdgpu)". Well,
"CS" may not be a good choice but you get the idea: that would keep all
terms together and keep it easy for the reader.
That way it could be easily be generalized at some point by just moving
it to a generic kernel level - provided the solution suits the doc
community at large.
Best regards,
--
Yann
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 19:55 ` Yann Dirson
0 siblings, 0 replies; 51+ messages in thread
From: Yann Dirson @ 2021-11-30 19:55 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao
Cc: Linux Doc Mailing List, Maling list - DRI developers,
Rodrigo Siqueira, amd-gfx list, Aurabindo Pillai, Roman Gilg,
Marek Olšák, Michel Dänzer, Sean Paul,
Bhawanpreet Lakha, Qingqing Zhuo, Roman Li, Nicholas Kazlauskas,
nicholas choi, Mark Yacoub, Alex Deucher, Christian König
----- Mail original -----
> De: "Rodrigo Siqueira Jordao" <rjordrigo@amd.com>
> À: ydirson@free.fr, "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>, "Christian König" <christian.koenig@amd.com>,
> "Alex Deucher" <alexander.deucher@amd.com>
> Cc: "Harry Wentland" <Harry.Wentland@amd.com>, "Linux Doc Mailing List" <linux-doc@vger.kernel.org>, "Mark Yacoub"
> <markyacoub@chromium.org>, "Michel Dänzer" <michel@daenzer.net>, "Bas Nieuwenhuizen" <bas@basnieuwenhuizen.nl>,
> "Roman Li" <roman.li@amd.com>, "amd-gfx list" <amd-gfx@lists.freedesktop.org>, "Roman Gilg" <subdiff@gmail.com>,
> "Marek Olšák" <marek.olsak@amd.com>, "Pekka Paalanen" <ppaalanen@gmail.com>, "Aurabindo Pillai"
> <aurabindo.pillai@amd.com>, "nicholas choi" <nicholas.choi@amd.com>, "Maling list - DRI developers"
> <dri-devel@lists.freedesktop.org>, "Simon Ser" <contact@emersion.fr>, "Alex Deucher" <alexdeucher@gmail.com>, "Sean
> Paul" <seanpaul@chromium.org>, "Qingqing Zhuo" <qingqing.zhuo@amd.com>, "Bhawanpreet Lakha"
> <bhawanpreet.lakha@amd.com>, "Nicholas Kazlauskas" <nicholas.kazlauskas@amd.com>
> Envoyé: Mardi 30 Novembre 2021 16:53:55
> Objet: Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
>
>
>
> On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> > Hi Rodrigo,
> >
> > That will really be helpful!
> >
> > I know drawing the line is a difficult problem (and can even make
> > things
> > harder when searching), but maybe it would make sense to keep
> > generic
> > acronyms not specific to amdgpu in a separate list. I bet a number
> > of
> > them would be useful in the scope of other drm drivers (e.g. CRTC,
> > DCC,
> > MST), and some are not restricted to the drm subsystem at all (e.g.
> > FEC,
> > LUT), but still have value as not necessarily easy to look up.
> >
> > Maybe "DC glossary" should just be "Glossary", since quite some
> > entries
> > help to read adm/amdgpu/ too. Which brings me to the result of my
> > recent
> > searches as suggested entries:
> >
> > KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD
> > (hardware
> > queue descriptor), EOP (still no clue :)
> >
> > Maybe some more specific ones just to be spelled out in clear where
> > they
> > are used ? KCQ (compute queue?), KGQ (gfx queue?)
> >
> > More suggestions inlined.
> >
> > Best regards,
> >
>
> Hi all,
>
> I'll address all the highlighted problems in the V2. Thanks a lot for
> all the feedback.
>
> Yann,
> For the generic acronyms, how about keeping it in this patch for now?
> After it gets merged, I can prepare a new documentation patch that
> creates a glossary for DRM where I move the generic acronyms to the
> DRM
> documentation. I prefer this approach to keep the improvement small
> and
> manageable.
Sure, especially as the Right Solution(tm) is not necessarily obvious :)
One thing I thought about is that a context could be specified together
with terms. Like "BPP (graphics)", "FEC (CS)", "DMCUB (amdgpu)". Well,
"CS" may not be a good choice but you get the idea: that would keep all
terms together and keep it easy for the reader.
That way it could be easily be generalized at some point by just moving
it to a generic kernel level - provided the solution suits the doc
community at large.
Best regards,
--
Yann
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
@ 2021-11-30 19:55 ` Yann Dirson
0 siblings, 0 replies; 51+ messages in thread
From: Yann Dirson @ 2021-11-30 19:55 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao
Cc: Linux Doc Mailing List, Maling list - DRI developers,
Rodrigo Siqueira, amd-gfx list, Aurabindo Pillai, Roman Gilg,
Harry Wentland, Marek Olšák, Michel Dänzer,
Bas Nieuwenhuizen, Alex Deucher, Pekka Paalanen, Sean Paul,
Bhawanpreet Lakha, Simon Ser, Qingqing Zhuo, Roman Li,
Nicholas Kazlauskas, nicholas choi, Mark Yacoub, Alex Deucher,
Christian König
----- Mail original -----
> De: "Rodrigo Siqueira Jordao" <rjordrigo@amd.com>
> À: ydirson@free.fr, "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>, "Christian König" <christian.koenig@amd.com>,
> "Alex Deucher" <alexander.deucher@amd.com>
> Cc: "Harry Wentland" <Harry.Wentland@amd.com>, "Linux Doc Mailing List" <linux-doc@vger.kernel.org>, "Mark Yacoub"
> <markyacoub@chromium.org>, "Michel Dänzer" <michel@daenzer.net>, "Bas Nieuwenhuizen" <bas@basnieuwenhuizen.nl>,
> "Roman Li" <roman.li@amd.com>, "amd-gfx list" <amd-gfx@lists.freedesktop.org>, "Roman Gilg" <subdiff@gmail.com>,
> "Marek Olšák" <marek.olsak@amd.com>, "Pekka Paalanen" <ppaalanen@gmail.com>, "Aurabindo Pillai"
> <aurabindo.pillai@amd.com>, "nicholas choi" <nicholas.choi@amd.com>, "Maling list - DRI developers"
> <dri-devel@lists.freedesktop.org>, "Simon Ser" <contact@emersion.fr>, "Alex Deucher" <alexdeucher@gmail.com>, "Sean
> Paul" <seanpaul@chromium.org>, "Qingqing Zhuo" <qingqing.zhuo@amd.com>, "Bhawanpreet Lakha"
> <bhawanpreet.lakha@amd.com>, "Nicholas Kazlauskas" <nicholas.kazlauskas@amd.com>
> Envoyé: Mardi 30 Novembre 2021 16:53:55
> Objet: Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
>
>
>
> On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> > Hi Rodrigo,
> >
> > That will really be helpful!
> >
> > I know drawing the line is a difficult problem (and can even make
> > things
> > harder when searching), but maybe it would make sense to keep
> > generic
> > acronyms not specific to amdgpu in a separate list. I bet a number
> > of
> > them would be useful in the scope of other drm drivers (e.g. CRTC,
> > DCC,
> > MST), and some are not restricted to the drm subsystem at all (e.g.
> > FEC,
> > LUT), but still have value as not necessarily easy to look up.
> >
> > Maybe "DC glossary" should just be "Glossary", since quite some
> > entries
> > help to read adm/amdgpu/ too. Which brings me to the result of my
> > recent
> > searches as suggested entries:
> >
> > KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD
> > (hardware
> > queue descriptor), EOP (still no clue :)
> >
> > Maybe some more specific ones just to be spelled out in clear where
> > they
> > are used ? KCQ (compute queue?), KGQ (gfx queue?)
> >
> > More suggestions inlined.
> >
> > Best regards,
> >
>
> Hi all,
>
> I'll address all the highlighted problems in the V2. Thanks a lot for
> all the feedback.
>
> Yann,
> For the generic acronyms, how about keeping it in this patch for now?
> After it gets merged, I can prepare a new documentation patch that
> creates a glossary for DRM where I move the generic acronyms to the
> DRM
> documentation. I prefer this approach to keep the improvement small
> and
> manageable.
Sure, especially as the Right Solution(tm) is not necessarily obvious :)
One thing I thought about is that a context could be specified together
with terms. Like "BPP (graphics)", "FEC (CS)", "DMCUB (amdgpu)". Well,
"CS" may not be a good choice but you get the idea: that would keep all
terms together and keep it easy for the reader.
That way it could be easily be generalized at some point by just moving
it to a generic kernel level - provided the solution suits the doc
community at large.
Best regards,
--
Yann
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
2021-11-30 15:59 ` Rodrigo Siqueira Jordao
(?)
@ 2021-11-30 20:38 ` Yann Dirson
-1 siblings, 0 replies; 51+ messages in thread
From: Yann Dirson @ 2021-11-30 20:38 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao
Cc: linux-doc, Mark Yacoub, Marek Olšák, roman li, amd-gfx,
Nicholas Kazlauskas, Michel Dänzer, aurabindo pillai,
nicholas choi, dri-devel, Alex Deucher, Sean Paul, qingqing zhuo,
bhawanpreet lakha, Roman Gilg, Harry Wentland, Jani Nikula,
Daniel Vetter, Rodrigo Siqueira, Christian König
> 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.
Since the source tree has amd/amdgpu/ and amd/display/, wouldn't it
be useful to mirror that layout ?
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-30 20:38 ` Yann Dirson
0 siblings, 0 replies; 51+ messages in thread
From: Yann Dirson @ 2021-11-30 20:38 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao
Cc: Christian König, linux-doc, Mark Yacoub,
Marek Olšák, Rodrigo Siqueira, roman li, amd-gfx,
Roman Gilg, Michel Dänzer, aurabindo pillai, nicholas choi,
dri-devel, Alex Deucher, Sean Paul, qingqing zhuo,
bhawanpreet lakha, Nicholas Kazlauskas
> 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.
Since the source tree has amd/amdgpu/ and amd/display/, wouldn't it
be useful to mirror that layout ?
^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation
@ 2021-11-30 20:38 ` Yann Dirson
0 siblings, 0 replies; 51+ messages in thread
From: Yann Dirson @ 2021-11-30 20:38 UTC (permalink / raw)
To: Rodrigo Siqueira Jordao
Cc: Jani Nikula, Christian König, linux-doc, Mark Yacoub,
Marek Olšák, Rodrigo Siqueira, roman li, amd-gfx,
Roman Gilg, Michel Dänzer, aurabindo pillai, nicholas choi,
dri-devel, Daniel Vetter, Harry Wentland, Alex Deucher,
Sean Paul, qingqing zhuo, bhawanpreet lakha, Nicholas Kazlauskas
> 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.
Since the source tree has amd/amdgpu/ and amd/display/, wouldn't it
be useful to mirror that layout ?
^ permalink raw reply [flat|nested] 51+ messages in thread
end of thread, other threads:[~2021-11-30 20:38 UTC | newest]
Thread overview: 51+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
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
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.