AMD-GFX Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v3 0/5] Expand kernel-doc with more generic details and info about ring buffers
@ 2025-10-20 19:38 Rodrigo Siqueira
  2025-10-20 19:38 ` [PATCH v3 1/5] drm/amdgpu: Expand kernel-doc in amdgpu_ring Rodrigo Siqueira
                   ` (5 more replies)
  0 siblings, 6 replies; 24+ messages in thread
From: Rodrigo Siqueira @ 2025-10-20 19:38 UTC (permalink / raw)
  To: Alex Deucher, Christian König, Timur Kristóf
  Cc: amd-gfx, kernel-dev, Rodrigo Siqueira

Lately, I have been part of multiple discussions around GPU recovery and
other concepts associated with GFX/Compute. Most of the debate is spread
around GitLab issues, emails, and some meeting conversations. This
patchset aims to consolidate all that information into a single
kernel-doc, which can be collaboratively improved and shared with other
people.

In this series, you will find new amdgpu glossary entries, more details
about the IPs' interconnections, and a description of the ring buffer.
This series includes multiple SVG diagrams; for this reason, it might be
good to apply this series locally. However, if you want to check all the
images quickly, check the links below:

- https://people.igalia.com/siqueira/kernel-doc-imgs/v3/amd_overview_block.svg
- https://people.igalia.com/siqueira/kernel-doc-imgs/v3/gfx_pipeline_seq.svg
- https://people.igalia.com/siqueira/kernel-doc-imgs/v3/no_enforce_isolation.svg
- https://people.igalia.com/siqueira/kernel-doc-imgs/v3/enforce_isolation.svg
- https://people.igalia.com/siqueira/kernel-doc-imgs/v3/ring_buffers.svg

Finally, keep in mind that I tried to fill in some gaps between
information, and hopefully, my description matches the reality.

Changes since V2:
 - Remove the unnecessary diagram.
 - Remove the excessive details about hardware behavior that are not
   useful for a driver developer.
 - Remove some wrong information.
 - Rewrite many parts of the ring buffer description.

Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Timur Kristóf <timur.kristof@gmail.com>

Thanks

Rodrigo Siqueira (5):
  drm/amdgpu: Expand kernel-doc in amdgpu_ring
  Documentation/gpu: Add new glossary entries from UMR
  Documentation/gpu: Expand generic block information
  Documentation/gpu: Add more information about GC
  Documentation/gpu: Add documentation about ring buffer

 .../gpu/amdgpu/amd_overview_block.svg         |  674 +++++++
 Documentation/gpu/amdgpu/amdgpu-glossary.rst  |   24 +
 Documentation/gpu/amdgpu/driver-core.rst      |   25 +
 .../gpu/amdgpu/enforce_isolation.svg          |  654 +++++++
 Documentation/gpu/amdgpu/gc/index.rst         |   24 +-
 Documentation/gpu/amdgpu/gfx_pipeline_seq.svg |  413 +++++
 Documentation/gpu/amdgpu/index.rst            |    1 +
 .../gpu/amdgpu/no_enforce_isolation.svg       |  707 +++++++
 Documentation/gpu/amdgpu/ring-buffer.rst      |   91 +
 Documentation/gpu/amdgpu/ring_buffers.svg     | 1633 +++++++++++++++++
 Documentation/gpu/amdgpu/userq.rst            |    2 +
 drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c      |   15 +-
 drivers/gpu/drm/amd/amdgpu/amdgpu_ring.h      |    2 +
 13 files changed, 4251 insertions(+), 14 deletions(-)
 create mode 100644 Documentation/gpu/amdgpu/amd_overview_block.svg
 create mode 100644 Documentation/gpu/amdgpu/enforce_isolation.svg
 create mode 100644 Documentation/gpu/amdgpu/gfx_pipeline_seq.svg
 create mode 100644 Documentation/gpu/amdgpu/no_enforce_isolation.svg
 create mode 100644 Documentation/gpu/amdgpu/ring-buffer.rst
 create mode 100644 Documentation/gpu/amdgpu/ring_buffers.svg

-- 
2.51.0


^ permalink raw reply	[flat|nested] 24+ messages in thread

end of thread, other threads:[~2025-10-28 14:37 UTC | newest]

Thread overview: 24+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-20 19:38 [PATCH v3 0/5] Expand kernel-doc with more generic details and info about ring buffers Rodrigo Siqueira
2025-10-20 19:38 ` [PATCH v3 1/5] drm/amdgpu: Expand kernel-doc in amdgpu_ring Rodrigo Siqueira
2025-10-20 20:30   ` Alex Deucher
2025-10-21  9:23   ` Timur Kristóf
2025-10-21 13:11     ` Rodrigo Siqueira
2025-10-28 13:01   ` Christian König
2025-10-20 19:38 ` [PATCH v3 2/5] Documentation/gpu: Add new glossary entries from UMR Rodrigo Siqueira
2025-10-20 20:17   ` Alex Deucher
2025-10-21  5:16   ` Lazar, Lijo
2025-10-21 13:25     ` Rodrigo Siqueira
2025-10-21 14:46       ` Alex Deucher
2025-10-28 13:10   ` Christian König
2025-10-28 14:36     ` Rodrigo Siqueira
2025-10-20 19:38 ` [PATCH v3 3/5] Documentation/gpu: Expand generic block information Rodrigo Siqueira
2025-10-20 20:28   ` Alex Deucher
2025-10-21  9:30     ` Timur Kristóf
2025-10-21 14:55     ` Rodrigo Siqueira
2025-10-21 21:34       ` Alex Deucher
2025-10-21  5:24   ` Lazar, Lijo
2025-10-20 19:38 ` [PATCH v3 4/5] Documentation/gpu: Add more information about GC Rodrigo Siqueira
2025-10-20 20:30   ` Alex Deucher
2025-10-20 19:38 ` [PATCH v3 5/5] Documentation/gpu: Add documentation about ring buffer Rodrigo Siqueira
2025-10-20 20:53   ` Alex Deucher
2025-10-21 12:52 ` [PATCH v3 0/5] Expand kernel-doc with more generic details and info about ring buffers Alex Deucher

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox