[PATCH 0/6] Documentation/gpu/amdgpu: Add documentation about Pipes, Queues, MES, and others

[Alex Deucher]

Applied the series with some minor clarifications per the comments and
my proof reading.

Thanks!

Alex

On Tue, Mar 25, 2025 at 1:27 PM Rodrigo Siqueira <siqueira at igalia.com> wrote:
>
> Hi,
>
> This patchset came from my endeavor to understand better how some of the
> amdgpu components operate; in particular, I was focused on the ideas
> behind Pipes, Hardware Queues, MES, and Ring Buffers. In some way, this
> series is an attempt to put multiple pieces of information spread around
> many different places in an organized way in the amdgpu kernel-doc. In
> particular, the following links were crucial to create this series:
>
> * https://lore.kernel.org/amd-gfx/CADnq5_Pcz2x4aJzKbVrN3jsZhD6sTydtDw=6PaN4O3m4t+Grtg@mail.gmail.com/T/#m9a670b55ab20e0f7c46c80f802a0a4be255a719d
> * https://gitlab.freedesktop.org/mesa/mesa/-/issues/11759
> * https://www.x.org/docs/AMD/old/R5xx_Acceleration_v1.5.pdf
> * https://gpuopen.com/videos/graphics-pipeline/
>
> The first part of this series just updates the amdgpu-glossary with some
> new acronyms (some of them useful for other patches). The next two
> patches are just some basic organization to improve the documentation
> flow. The last part describes pipes, hardware queues, ring buffers, and
> MES.
>
> Thanks
> Siqueira
>
> Rodrigo Siqueira (6):
>   Documentation/gpu: Add new acronyms
>   Documentation/gpu: Change index order to show driver core first
>   Documentation/gpu: Create a documentation entry just for hardware info
>   Documentation/gpu: Add explanation about AMD Pipes and Queues
>   Documentation/gpu: Create a GC entry in the amdgpu documentation
>   Documentation/gpu: Add an intro about MES
>
>  .../gpu/amdgpu/amd-hardware-list-info.rst     |   23 +
>  Documentation/gpu/amdgpu/amdgpu-glossary.rst  |   36 +
>  Documentation/gpu/amdgpu/driver-core.rst      |   77 +-
>  Documentation/gpu/amdgpu/driver-misc.rst      |   17 -
>  Documentation/gpu/amdgpu/gc/index.rst         |   53 +
>  Documentation/gpu/amdgpu/gc/mes.rst           |   38 +
>  Documentation/gpu/amdgpu/index.rst            |    4 +-
>  .../gpu/amdgpu/pipe_and_queue_abstraction.svg | 1279 +++++++++++++++++
>  8 files changed, 1485 insertions(+), 42 deletions(-)
>  create mode 100644 Documentation/gpu/amdgpu/amd-hardware-list-info.rst
>  create mode 100644 Documentation/gpu/amdgpu/gc/index.rst
>  create mode 100644 Documentation/gpu/amdgpu/gc/mes.rst
>  create mode 100644 Documentation/gpu/amdgpu/pipe_and_queue_abstraction.svg
>
> --
> 2.49.0
>