Last edited one month ago

X-LINUX-ISP Tool

Applicable for STM32MP21x lines, STM32MP25x lines


This article provides information about the X-LINUX-ISP Tool, its installation, and how to use it.

1. Description[edit | edit source]

The X-LINUX-ISP Tool is a small binary designed to provide users with useful information about the X-LINUX-ISP Expansion Package.

It is the entry point to install the packages of X-LINUX-ISP on top of the OpenSTLinux Starter Package. It provides information about the X-LINUX-ISP version and its supported features.

2. X-LINUX-ISP Tool installation[edit | edit source]

Warning white.png Warning
The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.
    apt-get install x-linux-isp-tool

3. How to use X-LINUX-ISP Tool[edit | edit source]

Usage:	x-linux-isp -[option]

-v --version            : Shows X-LINUX-ISP current version if it is installed
-f --supported-features : Prints all supported frameworks in this X-LINUX-ISP version
-l --list               : Prints installed and ready-to-install packages
-i --install <pkg>      : Installs X-LINUX-ISP package
-r --remove  <pkg>      : Removes X-LINUX-ISP package
-h --help               : Shows this help

3.1. Usage example[edit | edit source]

  • To show the current version of X-LINUX-ISP:
 x-linux-isp -v

Console output :

X-LINUX-ISP version: 6.1.0
  • To display X-LINUX-ISP features:
 x-linux-isp -f

Console output :

ISP software:
  * libcamera with the support of the DCMIPP ISP Image Processing Algorithm
    (IPA) integrating Auto Exposure (AE) and Auto White Balance (AWB) and all
    ISP controls
  * libcamerasrc gstreamer plugin supporting DCMIPP ISP properties

Application examples:
  * Simple ISP preview :
    * Python™ example taking advantage of libcamera and libcamerasrc gstreamer
      plugin for easy prototyping

Utilities:
  * X-LINUX-ISP tool suite provides tools for software information and ISP
    packages management.
  * STM32 ISP IQTune application (running on the target) used to tune the ISP
    by providing communication services between the host and the device

Find more information on the wiki page: https://wiki.st.com/stm32mpu/wiki/Category:X-LINUX-ISP_expansion_package
  • To list of the packages of X-LINUX-ISP:
 x-linux-isp -l

Console output :

 [upgradable]     libcamera-stm32mp-gst
 [upgradable]     libcamera-stm32mp
 [upgradable]     kernel-module-videobuf2-dma-sg-6.6.78

 [not installed]  stm32-isp-iqtune-application-python
 [not installed]  simple-isp-preview-python
 [not installed]  packagegroup-x-linux-isp-iqtune
 [not installed]  packagegroup-x-linux-isp
 [not installed]  usbotg-gadget-acm-config
 [not installed]  packagegroup-x-linux-isp-libcamera
 [not installed]  usbotg-gadget-acm-uvc-config
 [not installed]  gstreamer1.0-plugins-bad-uvcgadget
 [not installed]  evision-lib
Info white.png Information
[upgradable] means that the component is already installed but a newer version exists. Libcamera is already installed with the OpenSTLinux started package but does not include all ISP image quality feature. An upgrade is needed.
Warning DB.png Important
To have all ISP image quality functionalities available, some Linux kernel modules may need to be upgraded.

That's why, when for the first time you request to update some X-LINUX-ISP package, you may get a message saying that some Linux kernel modules need to be reloaded. Example:

Kernel module videobuf2_dma_sg need to be reloaded: reload on going... 

Kernel module videobuf2_dma_sg reload successfully done.
  • To install packages of X-LINUX-ISP:
 x-linux-isp -i <package>

Console output :

 x-linux-isp -i packagegroup-x-linux-isp
Reading package lists... Done
Reading package lists... Done
Building dependency tree... Done
The following additional packages will be installed:
  evision-lib gstreamer1.0-plugins-bad-uvcgadget gstreamer1.0-python kernel-module-videobuf2-dma-sg-6.6.78 libcamera-stm32mp
  libcamera-stm32mp-gst packagegroup-x-linux-isp-iqtune packagegroup-x-linux-isp-libcamera python3-pyserial simple-isp-preview-python
  stm32-isp-iqtune-application-python usbotg-gadget-acm-config usbotg-gadget-acm-uvc-config
The following NEW packages will be installed:
  evision-lib gstreamer1.0-plugins-bad-uvcgadget gstreamer1.0-python packagegroup-x-linux-isp packagegroup-x-linux-isp-iqtune
  packagegroup-x-linux-isp-libcamera python3-pyserial simple-isp-preview-python stm32-isp-iqtune-application-python
  usbotg-gadget-acm-config usbotg-gadget-acm-uvc-config
The following packages will be upgraded:
  kernel-module-videobuf2-dma-sg-6.6.78 libcamera-stm32mp libcamera-stm32mp-gst
3 upgraded, 11 newly installed, 0 to remove and 19 not upgraded.
Need to get 941 kB of archives.
After this operation, 0 B of additional disk space will be used.

The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA).
The detailed content licenses can be found at https://wiki.st.com/stm32mpu/wiki/OpenSTLinux_licenses.

https://www.st.com/resource/en/additional_license_terms/additional-license-terms-for-x-linux-isp.html

Selecting previously unselected package evision-lib.
(Reading database ... 15920 files and directories currently installed.)
Preparing to unpack .../00-evision-lib_1.0.7-r0_arm64.deb ...
Unpacking evision-lib (1.0.7-r0) ....
...
...
...
packagegroup-x-linux-isp has been installed successfully.

Kernel module videobuf2_dma_sg need to be reloaded: reload on going... 

Kernel module videobuf2_dma_sg reload successfully done.