Mesa (master): docs/panfrost: Document building Panfrost

[GitLab Mirror]

Module: Mesa
Branch: master
Commit: 2a7c881c1400ff2404d106dd922c2d77d0bceca9
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=2a7c881c1400ff2404d106dd922c2d77d0bceca9

Author: Alyssa Rosenzweig <alyssa.rosenzweig at collabora.com>
Date:   Thu Dec 17 19:14:24 2020 -0500

docs/panfrost: Document building Panfrost

Pretty similar to anything else in Mesa, although kmsro is required and
LLVM is not.

Signed-off-by: Alyssa Rosenzweig <alyssa.rosenzweig at collabora.com>
Reviewed-by: Adam Jackson <ajax at redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8148>

---

 docs/drivers/panfrost.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/docs/drivers/panfrost.rst b/docs/drivers/panfrost.rst
index c81104a95a0..10985cbf17d 100644
--- a/docs/drivers/panfrost.rst
+++ b/docs/drivers/panfrost.rst
@@ -29,3 +29,27 @@ Work to enable OpenGL ES 3.1 and OpenGL 3.1 is on-going for architectures v5
 and later (Mali T760 and newer).
 
 Other graphics APIs (Vulkan, OpenCL) are not supported at this time.
+
+Building
+--------
+
+Panfrost's OpenGL support is a Gallium driver. Since Mali GPUs are
+3D-only and do not include a display controller, Mesa must be
+additionally built with kmsro support which supports a number of display
+controllers commonly paired with Mali GPUs. If your board with a Panfrost
+supported GPU has a display controller with mainline Linux support not
+supported by kmsro, it's easy to add support, see the commit
+``cff7de4bb597e9`` as an example.
+
+LLVM is *not* required by Panfrost's compilers. LLVM support in Mesa can
+safely be disabled for most OpenGL ES users with Panfrost.
+
+Build with meson like ``meson . build/ -Ddri-drivers= -Dvulkan-drivers=
+-Dgallium-drivers=panfrost,kmsro -Dllvm=false`` for a build directory
+``build``.
+
+Building for Android via the legacy ``Android.mk`` system is not officially
+supported but reportedly works. Your mileage may vary.
+
+For general information on building Mesa, read :doc:`the install documentation
+<install>`.