summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2022-12-06 14:02:30 +0100
committerJacopo Mondi <jacopo@jmondi.org>2022-12-09 08:57:41 +0100
commit870a3bde3d1fd8fe416b6d1d3dd5e7b92fbde174 (patch)
tree0f8cf1e5568bb733ddbf84de02b38cc1f766b4b6 /Documentation
parent21c049cbcb66354867712825d642bd9fc6977015 (diff)
android: Allow to override config file path from env
The HAL config file is assumed to be in the LIBCAMERA_SYSCONF_DIR directory, which is defined by the meson build system at compile time. As the filesystem layout on Android installations might be device/build specific, allow to override such assumption using the LIBCAMERA_HAL_CONFIG_PATH environment variable and document its usage. While at it, remove quotes from the error message, as the file path doesn't contain any space. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/environment_variables.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst
index f092cbbd..ef2794f0 100644
--- a/Documentation/environment_variables.rst
+++ b/Documentation/environment_variables.rst
@@ -37,6 +37,12 @@ LIBCAMERA_IPA_MODULE_PATH
Example value: ``${HOME}/.libcamera/lib:/opt/libcamera/vendor/lib``
+LIBCAMERA_HAL_CONFIG_PATH
+ Define custom search location for the Android HAL config file
+ ``camera_hal.yaml`` (`more <HAL config_>`__).
+
+ Example value: ``/system/etc/libcamera``, ``/vendor/etc/libcamera``
+
Further details
---------------
@@ -149,3 +155,15 @@ operation are the installed system path (for example on Debian:
``/usr/local/x86_64-pc-linux-gnu/libcamera``) and the build directory.
With the ``LIBCAMERA_IPA_MODULE_PATH``, you can specify a non-default location
to search for IPA modules.
+
+HAL config
+~~~~~~~~~~
+
+The Android camera HAL requires a configuration file where all built-in cameras
+and their properties are enumerated (pluggable cameras, such as UVC cameras do
+not need to be described there). The HAL configuration file has to be named
+`camera_hal.yaml` and its default location is ``LIBCAMERA_SYSCONF_DIR`` which
+can be overridden by using the ``LIBCAMERA_HAL_CONFIG_PATH`` environment
+variable.
+
+`Examples <https://git.libcamera.org/libcamera/libcamera.git/tree/src/android/data>`__