i.MX 8M Mini Yocto 4.0 (Kirkstone)
- Collaboration Admins
This section is a guideline how to build a Linux image for the i.MX 8M Mini based congatec modules, using the Yocto Project 4.0 (Kirkstone). The first section contains Linux Host Machine preparation, Yocto obtaining, and Linux image build. The second section describes how to include the software development tools in the target Linux image, and the third section describes how to build a cross-SDK for the Linux Host Machine.
For more information see the i.MX Yocto Project User's Guide.
1. Linux image build
1.1 Linux Host Machine preparation
Ubuntu 18.04 or newer is recommended
Linux Mint 19 was used as the reference system for this section
The following tools have to be installed
$ sudo apt-get update
$ sudo apt-get install gawk wget git-core 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 repo python3-pip Regarding the repo tool, it may be necessary to use newer version than the one provided via the operating system package above; the following steps are an example how to get access to such a version
$ mkdir -p ~/.bin
$ PATH="${HOME}/.bin:${PATH}"
$ curl <https://storage.googleapis.com/git-repo-downloads/repo> > ~/.bin/repo
$ chmod a+rx ~/.bin/repoLinux Mint 20 Notes:
The package python needs to be installed using apt-get install in addition to the packages mentioned above
The package repo is no longer available, so the direct download as described in the previous paragraph is necessary
1.2 Obtaining Yocto
The Google's repo tool is used to obtain Yocto sources; the tool downloads all necessary files as defined in the provided manifest file. The manifest file therefore determines, among other things, specific version of boot loader and kernel that will be included in the target image.
The congatec Yocto sources and subsequently the manifest file are derived from a NXP GA release version; the mapping is in the table below, together with information about included boot loader and kernel version. In addition to the the base manifest file are available manifest files adding specific functionality above the base NXP GA release. They are also documented in the table.
Kernel Version | U-boot Version | NXP Release Suffix | Repo Manifest File | Derived congatec Releases | Notes |
|---|---|---|---|---|---|
5.15.32-2.0.0 | 2022.4 | 2.0.0 | cgtsx8m__lf-5.15.32-2.0.0.xml | rel_cgtsx8m_23-02-22-0 | The base manifest file |
The repo tool dowloads all files into the working directory, so it is a good idea to create a dedicated directory for the purpose, e.g.
$ mkdir ~/yocto
$ cd ~/yoctoAll manifest files reside on the cgtsx8m__lf-5.15.32-2.0.0 branch of the manifest-imx8-family repository; the repo init command can be instructed to use either the latest version of the provided manifest file (subsection 1.2a) or a specific version, usually tight to a congatec software release (subsection 1.2b).
1.2a Using the latest available version
1.2b Using a specific version
Identification of versions of SW components pertinent to a particular software release is done using Git tag placement inside congatec Git repositories. The Git tag is of the same name as the software release.
The repo tool is not able to use the tag directly, so the commit SHA corresponding to the release tag needs to be used; for convenience we provide a table listing commit SHAs from the manifest-imx8-family repository for the official SW releases.
SW Release | Git Commit SHA String |
|---|---|
rel_cgtsx8m_23-02-22-0 | ef6015073aad1fe61f284b1d8ff9e73d7dbec36a |
1.3 Configuration of the build directory and environment
The downloaded Yocto sources contain imx-setup-release.sh script that is used in this step to configure the build directory and build environment. The script takes three inputs in this example - machine the build is being made for (variable MACHINE), distribution to use (variable DISTRO) and name of the build directory (the -b parameter).
The Machine Identification is module dependent and is to be determined as per the table below; regarding distribution the only option is fsl-imx-xwayland - the one currently supported by NXP.
Module | Machine Identification |
|---|---|
conga-SMX8-Mini Rev B.0 | imx8mm-cgt-sx8m |
conga-SMX8-Mini Rev A.1/A.2 | imx8mm-cgt-sx8m-rev-a |
Note: The configured environment is not persistent; it can be re-configured using command source setup-environment build-dir
1.4. The fsl-image-validation-imx image building
The last step is the image build itself; the bitbake tool does that, taking at least one parameter - the name of the image to build (i.e. the bitbake image name).
The available i.MX images are: core-image-minimal, core-image-base, fsl-image-machine-test, imx-image-core, imx-image-multimedia, and imx-image-full.
After the bitbake finishes, the following files can be found in the tmp/deploy/images/\<Machine Identification\> subdirectory of the build folder.
File Name | Description |
|---|---|
\<bitbake image name\>-\<Machine Identification\>.wic.bz2 | the complete Linux SD card image |
Image | Linux kernel image |
\<Kernel Default DTB\> | the default device tree file |
imx-boot-\<Machine Identification\>-sd.bin | boot container for a SD card |
Note that this table does not contain all files in the subdirectory
2. Include SDK in the target image (optional)
Development tools and libraries can be included in the target Linux image, which makes software development on the module itself possible. Yocto's features tools-sdk and dev-pkgs are available for the purpose - after the build directory and environment are configured (i.e. after the step 1.3), the features need to be added to the EXTRA_IMAGE_FEATURES variable in theconf/local.conf file. An example that shows the default variable after the update follows
The development tools and libraries will be included during the subsequent bitbake run.
3. Build, install, and use the cross-SDK on the Linux Host Machine
The Yocto system is able to build a cross-SDK that can be used for software development on the Linux Host Machine. The command that builds an installation package for the SDK can be invoked after the 1.3 or 1.4 steps.
3.1 Build the cross-SDK installation package
Note: The installation package is located in the tmp/deploy/sdk subdirectory after the build
3.2 Install the SDK
3.2 Source the SDK toolchain
To use the cross-SDK on the Linux Host Machine, the SDK setup file needs to be sourced as follows
Note: The /opt/fsl-imx-wayland is the default destination directory as proposed by the SDK installer