Skip to main content

Yocto Linux BSP Ver.E User Guide for i.MX9 Series — Yocto 4.3 (Nanbield)

Introduction​

This document explains how to set up the build environment, obtain the BSP, build images, create bootable media, and customize software for Advantech boards based on NXP i.MX9 (e.g., i.MX95, AOM-3511). It targets BSP Version E aligned with NXP release L6.6.3-1.0.0 (Yocto 4.3 nanbield).

Getting Started

System Requirements​

  • CPU Cores: Intel® Core™ i7 (≥ 8 cores)
  • Memory: ≥ 16 GB
  • Disk Space: ≥ 500 GB (SSD strongly recommended)

Conventions​

  • ${PREBUILT_IMAGE} — compressed prebuilt image (*.img.gz)
  • ${CONTAINER_NAME} — container name (e.g., imx9LBVE0017)
  • ${BSP_TARBALL} — BSP tarball (*.tgz)
  • ${BSP_HOME} — BSP root directory inside the container
  • ${BDIR} — build directory (e.g., build_xwayland)
  • ${IMX9PROC} — i.MX9 processor code (e.g., imx95 for i.MX95)
  • ${BOARD} — target board (e.g., aom3511)
  • ${BOARD_REV} — board revision (e.g., a1)
  • ${MC} — machine code = ${IMX9PROC}${BOARD}${BOARD_REV}

Example: imx95aom3511a1 for AOM-3511 A1

You can list supported machines after sourcing the environment:

$ source setup-environment
  • ${MEM_SIZE} — memory size (1G / 2G / 4G / 6G / 8G)
  • ${UC} — U-Boot config (1G / 2G / 4G / 6G / 8G / FSPI_1G / FSPI_2G / FSPI_4G / FSPI_6G / FSPI_8G ...)
  • ${SD_DEVICE} — SD device path on host Linux (e.g., /dev/sdf)
  • ${SDCARD_IMAGE} — SD card image built by bitbake (*.wic.zst)
  • ${WORKSPACE} — host workspace folder mapped into the container
  • ${UBOOT} — U-Boot version (e.g., v2023.04_6.6.3-1.0.0)
  • ${KERNEL} — Linux kernel version (e.g., 6.6.3-1.0.0)
  • ${TOOLCHAIN} — toolchain install base (e.g., /opt/fsl-imx-xwayland/6.6-nanbield)

Debug/Serial console: use a terminal tool (minicom/putty/teraterm) configured to 115200 8N1. Terminal console: any terminal emulator (gnome-terminal, xfce4-terminal, etc.).

Docker Install and Settings​

If Docker is not available on your system, please install it first.

Install Docker Engine​

Refer to the official Docker installation guide for your platform.

Pull base image (example)​

$ docker pull advrisc/u20.04-imx8lbv1

The example image is Ubuntu 20.04 and works as a base for i.MX9 builds as well.

Create a container​

$ docker run --privileged -it \
  --name ${CONTAINER_NAME} \
  -v ${WORKSPACE}:/home/adv/adv-release-bsp \
  -v /dev:/dev \
  advrisc/u20.04-imx8lbv1 /bin/bash

Get BSP​

You can obtain the BSP in two ways.

Method A — Download BSP from GitHub​

The following example downloads the Advantech Yocto BSP into the adv-release-bsp directory and checks out nanbield / 6.6.3-1.0.0:

$ git config --global user.name "Your Name"
$ git config --global user.email you@example.com
$ sudo chown adv:adv adv-release-bsp
$ cd adv-release-bsp
$ repo init -u https://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git \
            -b imx-linux-nanbield \
            -m adv-6.6.3-1.0.0.xml
$ repo sync

Troubleshooting:​

  • "server certificate verification failed" (self-signed certs):
export GIT_SSL_NO_VERIFY=1
# or
git config --global http.sslverify false
  • "The unauthenticated git protocol on port 9418 is no longer supported.":
git config --global url."https://".insteadOf git://

Method B — Copy BSP tarball into the container​

If you have a BSP tarball (e.g., imx9LBVE0017_2024-08-21.tgz), copy it into the container workspace.

  1. Exit to host:
exit
  1. Copy into ${WORKSPACE} and fix ownership:
cp imx9LBVE0017_2024-08-21.tgz ${WORKSPACE}
sudo chown adv:adv ${WORKSPACE}/imx9LBVE0017_2024-08-21.tgz
  1. Re-attach to the container:
docker start ${CONTAINER_NAME}
docker attach ${CONTAINER_NAME}
  1. Unpack inside the container:
tar zxvf imx9LBVE0017_2024-08-21.tgz

During Yocto builds, a downloads/ folder caches sources. To reduce fetch failures, reuse a prepared tarball (e.g., downloads_6.6.3_1.1.0.tar).

  1. Exit to host:
exit
  1. Copy the downloads tarball into ${WORKSPACE}:
cp downloads_6.6.3_1.1.0.tar ${WORKSPACE}
sudo chown adv:adv ${WORKSPACE}/downloads_6.6.3_1.1.0.tar
  1. Re-attach to the container:
docker start ${CONTAINER_NAME}
docker attach ${CONTAINER_NAME}
  1. Unpack:
tar zxvf downloads_6.6.3_1.1.0.tar
  1. Link into the BSP tree:
cd adv-release-bsp
ln -s ${WORKSPACE}/downloads_6.6.3_1.1.0 downloads

Introducing BSP​

The BSP is based on the Yocto Project with NXP (Freescale) enhancements for i.MX95, plus Advantech board support. The release directory contains:

  • sources/ — Yocto layers (community + NXP + Advantech)
  • one or more build directories
  • scripts to set up the build environment

Naming Rule​

  • BSP file name: imx9LBVE0017_YYYY-MM-DD.tgz
    • LB = Linux BSP
    • VE0017 = Version E, build 0017
  • Prebuilt image name: 3511A1AIM37LIVE0017_iMX95_8G_YYYY-MM-DD.img.gz
    • 3511A1 = AOM-3511 A1
    • LI = prebuilt Linux Image
    • 8G = DDR size

BSP Content (key items)​

  • sources/meta-advantech/ — Advantech meta-layer
  • sources/meta-fsl-* — NXP (Freescale) meta-layers
  • fsl-setup-release.sh — create a new build environment
  • setup-environment — continue an existing build environment

Build Instructions

Create a New Build Environment​

cd ${BSP_HOME}
MACHINE=${MC} DISTRO=fsl-imx-xwayland source imx-setup-release.sh -b ${BDIR}

To set a default U-Boot config during creation:

MACHINE=${MC} UBOOT_CONFIG=${UC} DISTRO=fsl-imx-xwayland source imx-setup-release.sh -b ${BDIR}

You need to read and accept the EULA.

Accept EULA

Continue an Existing Build Environment​

cd ${BSP_HOME}
source setup-environment ${BDIR}

Build SD Card Image​

bitbake imx-image-full

Results (upon success) in ./tmp/deploy/images/${MC}:

  • imx-image-full-${MC}.wic.zst
  • imx-image-full-${MC}.wic.bmap

Build Toolchain Installer (SDK)​

bitbake meta-toolchain

The installer appears in ./tmp/deploy/sdk/, e.g.:

fsl-imx-xwayland-glibc-x86_64-meta-toolchain-armv8a-imx95-19x19-lpddr5-evk-toolchain-6.6-nanbield.sh

Build Bootloader​

bitbake imx-boot

Build Linux Kernel​

If you are in Docker, install tmux before running menuconfig:

sudo apt-get update
sudo apt-get install -y tmux
tmux
bitbake linux-imx -c menuconfig
# After editing, exit the tmux window:
exit

Build the kernel:

bitbake linux-imx

Resulting files under ./tmp/deploy/images/${MC}:

  • Image
  • Image-${IMX9PROC}-${BOARD}-${BOARD_REV}.dtb

Creating Boot Media

From a Prebuilt Image​

Warning: Double-check ${SD_DEVICE} before running dd.

sudo sh -c 'gunzip -c ${PREBUILT_IMAGE} | dd of=${SD_DEVICE} bs=1M status=progress'
sync

From a Built SD Card Image​

pushd ${BSP_HOME}/${BDIR}/tmp/deploy/images/${MC}
zstd -cd ${SDCARD_IMAGE} | sudo dd of=${SD_DEVICE} bs=1M status=progress
# Or use bmaptool (faster, sparse aware):
sudo bmaptool copy --bmap ${SDCARD_IMAGE/.zst/.bmap} ${SDCARD_IMAGE} ${SD_DEVICE}
sync
popd

Debug Console Information

If you want to see bootloader/kernel messages, prepare:

Hardware​

  • Refer to your product's Debug Port Information for the connector location and pinout (AOM-3511).

Software​

  • Use a serial terminal such as minicom or putty.
  • Baud rate: 115200

Customization

Setting up SDK​

Build the SDK as described above, then run the installer:

cd ${BSP_HOME}/${BDIR}/tmp/deploy/sdk
sudo ./fsl-imx-xwayland-glibc-x86_64-meta-toolchain-armv8a-imx95-19x19-lpddr5-evk-toolchain-6.6-nanbield.sh

Follow prompts: choose install path or press Enter for default, then confirm Proceed [y/n]?.

(Reference download link for SDK if provided: [downloads_SDK])

Setting up SDK

Setting up Cross-Compiling Environment​

After SDK installation, source the toolchain environment:

source ${TOOLCHAIN}/environment-setup-aarch64-poky-linux

Build U-Boot in a Standalone Environment​

Configure U-Boot​

make ${IMX9PROC}_${BOARD}${BOARD_REV}_${MEM_SIZE}_defconfig
# e.g.
make imx95_aom3511a1_8G_defconfig

Build U-Boot​

make -j$(nproc)

Build imx-boot Image using imx-mkimage (i.MX95)​

  1. Obtain the imx-boot tarball for your product (example for AOM-3511):
tar zxvf 3511A1AIM37LIVE0017_iMX95_8G_imx-boot.tgz
cd 3511A1AIM37LIVE0017_iMX95_8G_imx-boot/
  1. Copy necessary artifacts into the imx-mkimage folder:
cp u-boot.bin spl/u-boot-spl.bin arch/arm/dts/imx95-aom3511-a1.dtb tools/mkimage \
   /path/to/imx-mkimage/iMX9/
  1. Build flash.bin:
cd /path/to/imx-mkimage
make SOC=iMX95 OEI=YES flash_all

Flash imx-boot​

  • Using uuu to eMMC:
cp flash.bin ~/mfgtools/uuu/
cd ~/mfgtools/uuu
sudo ./uuu -b emmc flash.bin
  • Or write raw to device (example /dev/sdd, adjust as needed):
sudo dd if=flash.bin of=/dev/sdd bs=1K seek=32 conv=fsync
sync

Building & Updating Kernel / Modules / DTB Manually​

Ensure your cross-compile environment is sourced (see Setting up Cross-Compiling Environment).

Get Linux-imx Sources​

If not already available, obtain the sources per your workflow. (Reference: [adv_6.6.3_1.0.0])

Configure the Kernel​

cd linux-imx
make distclean
make imx_v8_adv_defconfig
make menuconfig

Build Kernel Image​

make -j$(nproc) Image

If you encounter link-flags issues, try:

unset LDFLAGS
make -j$(nproc) Image

The kernel Image is at: ./arch/arm64/boot/

Build Kernel Modules​

make -j$(nproc) modules
make modules_install INSTALL_MOD_PATH=~/temp/rootfs

Build Device Tree Blob​

make -j$(nproc) freescale/${IMX9PROC}-${BOARD}-${BOARD_REV}.dtb
# e.g.
make -j$(nproc) freescale/imx95-aom3511-a1.dtb

DTBs are at: ./arch/arm64/boot/dts/freescale/

Replace Kernel & DTB on Target Media​

  • Copy Image to the appropriate /boot (or partition) on SD/eMMC.
  • Copy ${IMX9PROC}-${BOARD}-${BOARD_REV}.dtb to the device's DTB directory on SD/eMMC. (Exact paths depend on your image layout and bootloader configuration.)

Improve Boot Speed

Bootloader​

  1. Boot delay

Disable boot delay in U-Boot:

setenv bootdelay 0
saveenv
reset
  1. Disable console output

Reducing console messages accelerates boot.

  • Kernel quiet mode in bootargs (example):
setenv mmcargs 'setenv bootargs ${jh_clk} console=${console} modprobe.blacklist=${modprobe_blacklist} root=${mmcroot} video=HDMI-A-1:${videores} quiet'
saveenv
reset
  • Or disable console entirely:
setenv console
saveenv
reset

Rootfs​

Optimize services and startup scripts based on your application.

Services​

Disable unneeded services:

sudo systemctl disable <service-name>
# e.g.
sudo systemctl disable boottimes

System Recovery

This section provides procedures to restore the eMMC image.

For more information, refer to the NXP mfgtools (UUU) wiki.

Reflash eMMC from Boot SD Card​

  1. Download mksd-linux.sh: https://github.com/ADVANTECH-Corp/RISC_tools_scripts/blob/mickledore/imx8/mksd-linux.sh

  2. Download "Product_AIM_Release_version"_flash_tool.tgz and unzip it.

  3. Copy mksd-linux.sh into the mk_inand folder.

  4. Run mksd-linux.sh and follow on-screen prompts to reflash from SD to eMMC.

Document version: Ver.E (Yocto 4.3 — nanbield, kernel 6.6.3-1.0.0, i.MX95 / AOM-3511).