docs: add a minimal docs page for radv
authorErik Faye-Lund <kusmabite@gmail.com>
Mon, 21 Mar 2022 19:33:25 +0000 (20:33 +0100)
committerMarge Bot <emma+marge@anholt.net>
Thu, 24 Mar 2022 10:08:45 +0000 (10:08 +0000)
RADV is the last driver in Mesa that doesn't have a webpage somewhere
that we can link to from mesa3d.org. So let's make a minimal docs article
for it where we link to relevant information elsewhere.

Reviewed-by: Timur Kristóf <timur.kristof@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/15494>

docs/drivers/radv.rst [new file with mode: 0644]
docs/envvars.rst
docs/index.rst

diff --git a/docs/drivers/radv.rst b/docs/drivers/radv.rst
new file mode 100644 (file)
index 0000000..29a9046
--- /dev/null
@@ -0,0 +1,23 @@
+RADV
+====
+
+RADV is a Vulkan driver for AMD GCN/RDNA GPUs.
+
+Debugging
+---------
+
+For a list of environment variables to debug RADV, please see
+:ref:`radv env-vars` for a list.
+
+Hardware Documentation
+----------------------
+
+You can find a list of documentation for the various generations of
+AMD hardware on the `X.Org wiki
+<https://www.x.org/wiki/RadeonFeature/#documentation>`_.
+
+ACO
+---
+
+ACO is the shader-compiler used in RADV. You read its documentation
+`here <https://gitlab.freedesktop.org/mesa/mesa/-/blob/main/src/amd/compiler/README.md>`_.
index 09467bc..1e8daba 100644 (file)
@@ -600,6 +600,9 @@ VC4 driver environment variables
    ``dump``
       write a GPU command stream trace file (VC4 simulator only)
 
+
+.. _radv env-vars:
+
 RADV driver environment variables
 ---------------------------------
 
index 3f4c74b..d92d98c 100644 (file)
@@ -89,6 +89,7 @@ Linux, FreeBSD, and other operating systems.
    drivers/lima
    drivers/llvmpipe
    drivers/panfrost
+   drivers/radv
    drivers/svga3d
    drivers/v3d
    drivers/vc4