docs/panfrost: Document building Panfrost
authorAlyssa Rosenzweig <alyssa.rosenzweig@collabora.com>
Fri, 18 Dec 2020 00:14:24 +0000 (19:14 -0500)
committerMarge Bot <eric+marge@anholt.net>
Sat, 19 Dec 2020 14:29:44 +0000 (14:29 +0000)
Pretty similar to anything else in Mesa, although kmsro is required and
LLVM is not.

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

docs/drivers/panfrost.rst

index c81104a..10985cb 100644 (file)
@@ -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>`.