[PATCH v2 0/2] drm: add overview diagram for drm stack

[PATCH v2 0/2] drm: add overview diagram for drm stack

[Abdulrasaq Lawani]

Signed-off-by: Abdulrasaq Lawani <abdulrasaqolawani@gmail.com>
---
Changes in v2:
- Update the overview diagram to display correctly by putting in a literal block.
- Also update the overview section diagram to a higher order.
- Ensured docs are successfully rendering by building for htmldocs and pdfdocs.
- Rendered pages are okay on html and pdf.
- Link to v1: https://lore.kernel.org/r/20250522-drm-doc-updates-v1-1-d1efd54740bd@gmail.com

---
Abdulrasaq Lawani (2):
      drm: add overview diagram for drm stack
      drm: add overview diagram for drm stack

 Documentation/gpu/introduction.rst | 40 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)
---
base-commit: 4d07f5440d7afee27dada528aaf5230e760531cb
change-id: 20250522-drm-doc-updates-3686f6d48122

Best regards,
-- 
Abdulrasaq Lawani <abdulrasaqolawani@gmail.com>

[PATCH v2 1/2] drm: add overview diagram for drm stack

[Abdulrasaq Lawani]

Add an overview diagram of Linux DRM architecture for
graphics and compute to introduction.rst
---
 Documentation/gpu/introduction.rst | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/Documentation/gpu/introduction.rst b/Documentation/gpu/introduction.rst
index 3cd0c8860b949408ed570d3f9384edd5f03df002..91bb0efc96d69921a122c5265b1431fa18110a7a 100644
--- a/Documentation/gpu/introduction.rst
+++ b/Documentation/gpu/introduction.rst
@@ -14,7 +14,43 @@ including the TTM memory manager, output configuration and mode setting,
 and the new vblank internals, in addition to all the regular features
 found in current kernels.
 
-[Insert diagram of typical DRM stack here]
+Overview of the Linux DRM Architecture
+-----------------------------------------------
++-----------------------------+
+|     User-space Apps         |
+| (Games, Browsers, ML, etc.) |
++-----------------------------+
+              |
+              v
++---------------------------------------+
+|    Graphics APIs   |   Compute APIs   |
+|  (OpenGL, Vulkan)  |  (OpenCL, CUDA)  |
++---------------------------------------+
+          |                   |
+          v                   v
++---------------------+  +-----------------------+
+|  User-space Driver  |  |    Compute Runtime    |
+|  (Mesa, AMD/NVIDIA) |  |  (OpenCL, CUDA, ROCm) |
++---------------------+  +-----------------------+
+          |                   |
+          +--------+----------+
+                   |
+                   v
+        +-----------------------+
+        |   libdrm (DRM API)    |
+        +-----------------------+
+                   |
+                   v
++-------------------------------------------+
+|     Kernel DRM/KMS Driver (i915, amdgpu,  |
+|     nouveau, etc.)                        |
++-------------------------------------------+
+        |                       |
+        v                       v
++----------------+     +-------------------+
+| GPU Display HW |     | GPU Compute Units |
++----------------+     +-------------------+
+
 
 Style Guidelines
 ================

-- 
2.43.0

[PATCH v2 2/2] drm: add overview diagram for drm stack

[Abdulrasaq Lawani]

Put overview diagram into a literal block
and set its section title to a higher order
---
 Documentation/gpu/introduction.rst | 72 ++++++++++++++++++++------------------
 1 file changed, 37 insertions(+), 35 deletions(-)

diff --git a/Documentation/gpu/introduction.rst b/Documentation/gpu/introduction.rst
index 91bb0efc96d69921a122c5265b1431fa18110a7a..2653048ad4bb0ecbc2b676295440442dddbabae6 100644
--- a/Documentation/gpu/introduction.rst
+++ b/Documentation/gpu/introduction.rst
@@ -15,41 +15,43 @@ and the new vblank internals, in addition to all the regular features
 found in current kernels.
 
 Overview of the Linux DRM Architecture
------------------------------------------------
-+-----------------------------+
-|     User-space Apps         |
-| (Games, Browsers, ML, etc.) |
-+-----------------------------+
-              |
-              v
-+---------------------------------------+
-|    Graphics APIs   |   Compute APIs   |
-|  (OpenGL, Vulkan)  |  (OpenCL, CUDA)  |
-+---------------------------------------+
-          |                   |
-          v                   v
-+---------------------+  +-----------------------+
-|  User-space Driver  |  |    Compute Runtime    |
-|  (Mesa, AMD/NVIDIA) |  |  (OpenCL, CUDA, ROCm) |
-+---------------------+  +-----------------------+
-          |                   |
-          +--------+----------+
-                   |
-                   v
-        +-----------------------+
-        |   libdrm (DRM API)    |
-        +-----------------------+
-                   |
-                   v
-+-------------------------------------------+
-|     Kernel DRM/KMS Driver (i915, amdgpu,  |
-|     nouveau, etc.)                        |
-+-------------------------------------------+
-        |                       |
-        v                       v
-+----------------+     +-------------------+
-| GPU Display HW |     | GPU Compute Units |
-+----------------+     +-------------------+
+======================================
+::
+
+        +-----------------------------+
+        |     User-space Apps         |
+        | (Games, Browsers, ML, etc.) |
+        +-----------------------------+
+                      |
+                      v
+        +---------------------------------------+
+        |    Graphics APIs   |   Compute APIs   |
+        |  (OpenGL, Vulkan)  |  (OpenCL, CUDA)  |
+        +---------------------------------------+
+                |                   |
+                v                   v
+        +---------------------+  +-----------------------+
+        |  User-space Driver  |  |    Compute Runtime    |
+        |  (Mesa, AMD/NVIDIA) |  |  (OpenCL, CUDA, ROCm) |
+        +---------------------+  +-----------------------+
+                |                   |
+                +--------+----------+
+                         |
+                         v
+                +-----------------------+
+                |   libdrm (DRM API)    |
+                +-----------------------+
+                          |
+                          v
+        +-------------------------------------------+
+        |     Kernel DRM/KMS Driver (i915, amdgpu,  |
+        |     nouveau, etc.)                        |
+        +-------------------------------------------+
+                |                       |
+                v                       v
+        +----------------+     +-------------------+
+        | GPU Display HW |     | GPU Compute Units |
+        +----------------+     +-------------------+
 
 
 Style Guidelines

-- 
2.43.0

Re: [PATCH v2 2/2] drm: add overview diagram for drm stack

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 3994 bytes --]

On Fri, May 23, 2025 at 03:52:26PM -0400, Abdulrasaq Lawani wrote:
> diff --git a/Documentation/gpu/introduction.rst b/Documentation/gpu/introduction.rst
> index 91bb0efc96d69921a122c5265b1431fa18110a7a..2653048ad4bb0ecbc2b676295440442dddbabae6 100644
> --- a/Documentation/gpu/introduction.rst
> +++ b/Documentation/gpu/introduction.rst
> @@ -15,41 +15,43 @@ and the new vblank internals, in addition to all the regular features
>  found in current kernels.
>  
>  Overview of the Linux DRM Architecture
> ------------------------------------------------
> -+-----------------------------+
> -|     User-space Apps         |
> -| (Games, Browsers, ML, etc.) |
> -+-----------------------------+
> -              |
> -              v
> -+---------------------------------------+
> -|    Graphics APIs   |   Compute APIs   |
> -|  (OpenGL, Vulkan)  |  (OpenCL, CUDA)  |
> -+---------------------------------------+
> -          |                   |
> -          v                   v
> -+---------------------+  +-----------------------+
> -|  User-space Driver  |  |    Compute Runtime    |
> -|  (Mesa, AMD/NVIDIA) |  |  (OpenCL, CUDA, ROCm) |
> -+---------------------+  +-----------------------+
> -          |                   |
> -          +--------+----------+
> -                   |
> -                   v
> -        +-----------------------+
> -        |   libdrm (DRM API)    |
> -        +-----------------------+
> -                   |
> -                   v
> -+-------------------------------------------+
> -|     Kernel DRM/KMS Driver (i915, amdgpu,  |
> -|     nouveau, etc.)                        |
> -+-------------------------------------------+
> -        |                       |
> -        v                       v
> -+----------------+     +-------------------+
> -| GPU Display HW |     | GPU Compute Units |
> -+----------------+     +-------------------+
> +======================================

Why promoting the section heading?

> +::
> +
> +        +-----------------------------+
> +        |     User-space Apps         |
> +        | (Games, Browsers, ML, etc.) |
> +        +-----------------------------+
> +                      |
> +                      v
> +        +---------------------------------------+
> +        |    Graphics APIs   |   Compute APIs   |
> +        |  (OpenGL, Vulkan)  |  (OpenCL, CUDA)  |
> +        +---------------------------------------+
> +                |                   |
> +                v                   v
> +        +---------------------+  +-----------------------+
> +        |  User-space Driver  |  |    Compute Runtime    |
> +        |  (Mesa, AMD/NVIDIA) |  |  (OpenCL, CUDA, ROCm) |
> +        +---------------------+  +-----------------------+
> +                |                   |
> +                +--------+----------+
> +                         |
> +                         v
> +                +-----------------------+
> +                |   libdrm (DRM API)    |
> +                +-----------------------+
> +                          |
> +                          v
> +        +-------------------------------------------+
> +        |     Kernel DRM/KMS Driver (i915, amdgpu,  |
> +        |     nouveau, etc.)                        |
> +        +-------------------------------------------+
> +                |                       |
> +                v                       v
> +        +----------------+     +-------------------+
> +        | GPU Display HW |     | GPU Compute Units |
> +        +----------------+     +-------------------+
>  

This is not how reviews from v1 should be addressed. Instead of making
separate commit for review suggestions, you need to squash them into affected
commit(s) in v1. In this case, there should be only one resulting patch. Don't
forget to send it as v3.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]