View source for VisionSOM imx-meta-somlabs-honister

{{PageHeader|VisionSOM imx-meta-somlabs layer for iMX Yocto Honister}} __toc__

This tutorial explains how to build the iMX Yocto Honister system for the VisionSOM modules. The Yocto system uses the following kernel and u-boot repositories:

* kernel (5.15.5): https://github.com/SoMLabs/somlabs-linux-imx/tree/somlabs_imx_5.15.5-1.0.0
* u-boot (2021.04): https://github.com/SoMLabs/somlabs-uboot-imx/tree/somlabs-imx_v2021.04_5.15.5-1.0.0

== Introduction ==

Meta-somlabs is a layer providing the SoMLabs modules and carrier boards hardware support for Yocto-based NXP Linux system.

== Host system prerequisites ==

This tutorial was prepared for the Ubuntu 18.04.5 LTS host operating system. All of the files required for system image compilation may require up to 120 GB of the disk space. The SDK build requires additional 25 GB (145 GB in total).

The following packages need to be installed before the building process:

<pre>
sudo apt-get install gawk wget git diffstat unzip texinfo gcc-multilib build-essential chrpath socat libsdl1.2-dev xterm sed cvs subversion coreutils texi2html docbook-utils python-pysqlite2 help2man make gcc g++ desktop-file-utils libgl1-mesa-dev libglu1-mesa-dev mercurial autoconf automake groff curl lzop asciidoc u-boot-tools liblz4-tool zstd
</pre>

The source code will be obtained using git, so it needs to be configured by setting the user name and email with correctly set values:

<pre>
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
</pre>

A new repo tool version is also required. It may be downloaded directly from the project site. The repo binary needs to be available in the system PATH variable and have the execution privilege:

<pre>
wget https://storage.googleapis.com/git-repo-downloads/repo
sudo mv repo /usr/bin/repo
sudo chmod a+x /usr/bin/repo
</pre>

== System image ==

This layer should be used in order to build the system image. This layer adds a new example image called somlabs-image. It includes the SoMLabs demo application using the GTK and GStreamer libraries.

== Building the system image ==

The general description of the building process is described in the iMX Yocto Project User's Guide document:

https://www.nxp.com/docs/en/user-guide/IMXLXYOCTOUG.pdf

The summary of required steps including the meta-somlabs layer is shown below:

<pre>
mkdir imx-yocto-bsp
cd imx-yocto-bsp
repo init -u https://github.com/SoMLabs/imx-meta-somlabs -b honister -m imx-somlabs-5.15.5-1.0.0.xml
repo sync
</pre>

System building may be configured for one of the available machine configurations:

* visioncb-6ull-std - VisionCB-6ULL-STD board with VisionSOM-6ULL modules
* visionsom-8mm-cb - VisionCB-8M board family with VisionSOM-8Mmini modules
* starsom-cb-6ull - StarCB-6ULL board with StarSOM-6ULL modules
* starsbc-6ull - StarSBC-6ULL board with or without the COMM shield

The following system distributions were tested on SoMLabs modules:

* fsl-imx-fb - distribution without graphical environment for 6ULL modules
* fsl-imx-xwayland - distribution with xwayland

System building may be started by the following commands (the first one needs to be called from the ''imx-yocto-bsp'' directory):

<pre>
DISTRO=<SELECTED_DISTRIBUTION> MACHINE=<SELECTED_MACHINE> source imx-somlabs-setup-release.sh -b <BUILD_DIRECTORY>
bitbake somlabs-image
</pre>

The system image is located in the somlabs-image-<SELECTED_MACHINE>.wic.bz2 file in the tmp/deploy/images/<SELECTED_MACHINE> directory. It should be extracted and installed on a SD-card:

<pre>
bunzip2 -dkf somlabs-image-<SELECTED_MACHINE>.wic.bz2 
sudo dd if=somlabs-image-<SELECTED_MACHINE>.wic of=/dev/sdX bs=1M
</pre>

The instruction for the eMMC memory image installation may be found on the following wiki pages:

* VisionSOM-6ULL: https://wiki.somlabs.com/index.php/Writing_VisionSOM-6ULL_system_image_to_eMMC_memory
* VisionSOM-8MM: https://wiki.somlabs.com/index.php/Writing_VisionSOM-8MM_system_image_to_eMMC_memory