[PATCH 0/3] amdgpu/drm: Documentation updates

[PATCH 0/3] amdgpu/drm: Documentation updates

[Peter Maucher]

Explain difference between gttsize and gartsize
module parameters, and amend related documentation.
Also, amdgpu does support RDNA GPUs.


Peter Maucher (3):
  drm/amdgpu: improve GART and GTT documentation
  drm/amdgpu: add GART and GTT to glossary
  drm/amdgpu: mention RDNA support in docu

 Documentation/gpu/amdgpu/amdgpu-glossary.rst |  6 ++++++
 Documentation/gpu/amdgpu/index.rst           |  2 +-
 drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c      | 11 ++++++-----
 3 files changed, 13 insertions(+), 6 deletions(-)

-- 
2.38.1

[PATCH 1/3] drm/amdgpu: improve GART and GTT documentation

[Peter Maucher]

Document difference between amdgpu.gartsize and amdgpu.gttsize
module parameters, as initially explained by Alex Deucher here:
https://lists.freedesktop.org/archives/dri-devel/2022-October/375358.html

Signed-off-by: Peter Maucher <bellosilicio@gmail.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
index bf2d50c8c92a..d647836ba7b8 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
@@ -230,17 +230,18 @@ module_param_named(vis_vramlimit, amdgpu_vis_vram_limit, int, 0444);
 
 /**
  * DOC: gartsize (uint)
- * Restrict the size of GART in Mib (32, 64, etc.) for testing. The default is -1 (The size depends on asic).
+ * Restrict the size of GART (for kernel use) in Mib (32, 64, etc.) for testing.
+ * The default is -1 (The size depends on asic).
  */
-MODULE_PARM_DESC(gartsize, "Size of GART to setup in megabytes (32, 64, etc., -1=auto)");
+MODULE_PARM_DESC(gartsize, "Size of kernel GART to setup in megabytes (32, 64, etc., -1=auto)");
 module_param_named(gartsize, amdgpu_gart_size, uint, 0600);
 
 /**
  * DOC: gttsize (int)
- * Restrict the size of GTT domain in MiB for testing. The default is -1 (It's VRAM size if 3GB < VRAM < 3/4 RAM,
- * otherwise 3/4 RAM size).
+ * Restrict the size of GTT domain (for userspace usage) in MiB for testing.
+ * The default is -1 (It's VRAM size if 3GB < VRAM < 3/4 RAM, otherwise 3/4 RAM size).
  */
-MODULE_PARM_DESC(gttsize, "Size of the GTT domain in megabytes (-1 = auto)");
+MODULE_PARM_DESC(gttsize, "Size of the GTT userspace domain in megabytes (-1 = auto)");
 module_param_named(gttsize, amdgpu_gtt_size, int, 0600);
 
 /**
-- 
2.38.1

[PATCH 2/3] drm/amdgpu: add GART and GTT to glossary

[Peter Maucher]

GART and GTT are two abbreviations that should be mentioned in the
glossary.

Signed-off-by: Peter Maucher <bellosilicio@gmail.com>
---
 Documentation/gpu/amdgpu/amdgpu-glossary.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/gpu/amdgpu/amdgpu-glossary.rst b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
index 326896e9800d..d86bea7926dc 100644
--- a/Documentation/gpu/amdgpu/amdgpu-glossary.rst
+++ b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
@@ -30,6 +30,12 @@ we have a dedicated glossary for Display Core at
     EOP
       End Of Pipe/Pipeline
 
+    GART
+      Graphics Aperture Table
+
+    GTT
+      Graphics Translation Table, mostly synonymous to GART
+
     GC
       Graphics and Compute
 
-- 
2.38.1

[PATCH 3/3] drm/amdgpu: mention RDNA support in docu

[Peter Maucher]

The amdgpu kernel module has supported RDNA for a while,
mention that in the module description.

Signed-off-by: Peter Maucher <bellosilicio@gmail.com>
---
 Documentation/gpu/amdgpu/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gpu/amdgpu/index.rst b/Documentation/gpu/amdgpu/index.rst
index a24e1cfa7407..bcc0f5c15f93 100644
--- a/Documentation/gpu/amdgpu/index.rst
+++ b/Documentation/gpu/amdgpu/index.rst
@@ -3,7 +3,7 @@
 ==========================
 
 The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core
-Next (GCN) architecture.
+Next (GCN) and Radeon DNA (RDNA) architectures.
 
 .. toctree::
 
-- 
2.38.1

Re: [PATCH 0/3] amdgpu/drm: Documentation updates

[Alex Deucher]

Applied patches 1 and 3.  Patch 2 is not exactly correct, I'll send
out an improved version of patch 2.

Thanks!

Alex

On Thu, Dec 1, 2022 at 10:38 AM Peter Maucher <bellosilicio@gmail.com> wrote:
>
> Explain difference between gttsize and gartsize
> module parameters, and amend related documentation.
> Also, amdgpu does support RDNA GPUs.
>
>
> Peter Maucher (3):
>   drm/amdgpu: improve GART and GTT documentation
>   drm/amdgpu: add GART and GTT to glossary
>   drm/amdgpu: mention RDNA support in docu
>
>  Documentation/gpu/amdgpu/amdgpu-glossary.rst |  6 ++++++
>  Documentation/gpu/amdgpu/index.rst           |  2 +-
>  drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c      | 11 ++++++-----
>  3 files changed, 13 insertions(+), 6 deletions(-)
>
> --
> 2.38.1
>

Re: [PATCH 2/3] drm/amdgpu: add GART and GTT to glossary

[Felix Kuehling]

On 2022-12-01 10:38, Peter Maucher wrote:
> GART and GTT are two abbreviations that should be mentioned in the
> glossary.
>
> Signed-off-by: Peter Maucher <bellosilicio@gmail.com>
> ---
>   Documentation/gpu/amdgpu/amdgpu-glossary.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/Documentation/gpu/amdgpu/amdgpu-glossary.rst b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> index 326896e9800d..d86bea7926dc 100644
> --- a/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> +++ b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> @@ -30,6 +30,12 @@ we have a dedicated glossary for Display Core at
>       EOP
>         End Of Pipe/Pipeline
>   
> +    GART
> +      Graphics Aperture Table

The "R" stands for "Remapping". I've usually seen this as "Graphics 
Address Remapping Table", but "... Aperture ..." would work too.

Regards,
   Felix


> +
> +    GTT
> +      Graphics Translation Table, mostly synonymous to GART
> +
>       GC
>         Graphics and Compute
>   

Re: [PATCH 3/3] drm/amdgpu: mention RDNA support in docu

[Felix Kuehling]

On 2022-12-01 10:38, Peter Maucher wrote:
> The amdgpu kernel module has supported RDNA for a while,
> mention that in the module description.
>
> Signed-off-by: Peter Maucher <bellosilicio@gmail.com>
> ---
>   Documentation/gpu/amdgpu/index.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/gpu/amdgpu/index.rst b/Documentation/gpu/amdgpu/index.rst
> index a24e1cfa7407..bcc0f5c15f93 100644
> --- a/Documentation/gpu/amdgpu/index.rst
> +++ b/Documentation/gpu/amdgpu/index.rst
> @@ -3,7 +3,7 @@
>   ==========================
>   
>   The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core
> -Next (GCN) architecture.
> +Next (GCN) and Radeon DNA (RDNA) architectures.

RDNA is still based on the GCN architecture. If you call out RDNA 
specifically, you'll also have to mention CDNA for completeness. But 
once you go down that route, you'll have to update this again when a new 
marketing name is invented. I'm not sure it's worth it.

Regards,
   Felix


>   
>   .. toctree::
>