Introduction

This is the uGuzzi IPA for the libcamera NXP NEO pipeline.

The uGuzzi IPA should be used with a matching version of the libcamera.

Respective versions are associated to NXP BSP quaterly release and is reflected in the branch name that is common to the two components.

How to build with meson?

Prerequisites

• Installation of Meson
• Installation of the Yocto SDK toolchain

Update SDK with compatible version of libcamera

Clone the libcamera version compatible with the release uGuzzi IPA version.

From the cross-build environment, run following script at the root of the libcamera source tree:

#!/bin/bash -ex

SDK=<YOUR_SDK_PATH>

# setup build libcamera
meson setup  --buildtype=plain -Dprefix=/usr build -Dpipelines="nxp/neo" -Dv4l2=true -Dcam=enabled -Dlc-compliance=disabled -Dtest=false -Ddocumentation=disabled -Dqcam=disabled

# build and install libcamera dependencies in SDK sysroots
DESTDIR=${SDK}/sysroots/armv8a-poky-linux ninja -C build install

uGuzzi IPA build instructions

From the cross-build environment, run following script at the root of the uGuzzi IPA source tree:

#!/bin/bash -ex

# setup build uguzzi IPA
meson setup --buildtype=plain -Dprefix=/usr build

# build and install in local directory
DESTDIR=$(realpath .)/install ninja -C build install

How to build with Yocto?

The recipe for uGuzzi IPA is available from the i.MX Yocto Project i.MX BSP Layer meta-imx.

How to enable the uGuzzi IPA?

By default, the IPA loaded by the NXP NEO pipeline is the NXP enablement IPA.

The uGuzzi IPA can be enabled to run on target by setting following environment variable. This variable specifies the IPA module search path used by the pipeline handler on the target:

export LIBCAMERA_IPA_MODULE_PATH="/usr/lib/libcamera/ipa-nxp-neo-uguzzi"

How to configure the uGuzzi IPA?

The IPA can be configured using the configuration file data/config_ipa_uguzzi.yaml.

This file provides configuration, such as specific parameters for each connected camera.

Each camera mode including its resolution and bit depth should be specified in the configuration file with its associated:

• DTP file
• tuning id
• tuning mode

If the camera mode entry doesn't exist, the IPA will fail.

Refer to the description from data/config_ipa_uguzzi.yaml for more details.

How to configure for tuning?

By default, the uGuzzi IPA runs in isolated mode.

However for tuning and development purposes (connection with the Tuning Tool), the isolation mode should be disabled by setting following environment variable to a non-empty string:

export LIBCAMERA_IPA_DISABLE_ISOLATION="yes"

In the non isolated mode, the Live Tuning library can only operate on a single camera, which is, by default, the first one initialized by libcamera. This single camera can also by changed explicitly by the user.

For that purpose, the IPA configuration file data/config_ipa_uguzzi.yaml can be used to specify:

• the single camera to run - this camera should be used by the application.
• the socket port to use for the IP connection between the uGuzzi IPA and the Tuning Tool - if not specified, the port 50000 is used by default.

How to configure logging?

By default, the uGuzzi IPA logs are displayed in the debug console.

It is possible to configure the IPA to redirect the logs into a file by setting following environment variable:

export LIBCAMERA_IPA_UGUZZI_LOG_DIR=”/tmp/”

With this configuration, the files generated are named with the PID of the IPA: <ipa_pid>.log

How to port a new sensor?

Integrating a new sensor into the i.MX95 Camera Software Stack consists essentially in the following tasks:

• Writing a Linux Kernel V4L2 driver for this sensor
• Implement a CamHelper class for the new sensor
• Provide a calibration file that the Neo IPA will consume to manage IPA algorithms
• Declare the sensor in the configuration file with its associated configuration

Please refer to the i.MX95 Camera Porting Guide document for detailed instructions.