Build and Install Linux System for SMARC-iMX8MM (Solo, Solo Lite, Dual, Dual Lie, Quad and Quad Lite Core)

This document provides instructions for advanced users how Embedian offers patches and builds a customized version of u-boot and linux kernel for Embedian's SMARC-iMX8MM product platform and how to install the images to bring the evaluation board up and running. 

Our aim is to fully support our hardware through device drivers. We also provide unit tests so that testing a board is easy and custom development can start precisely.

The host Linux machine is recommended Ubuntu 20.04 or 22.04.

Once you have Ubuntu 20.04 or 22.04 LTS running, install the additional required support packages using the following console command:

Availability

SMARC-iMX8MM at Embedian

Carrier Board

SBC-SMART-BEE (module and carrier board) at Embedian

SBC-SMART-MEN (module and carrier board) at Embedian

EVK-STD-CARRIER-S20 (universal carrier board for all SMARC 1.1 and 2.0 modules) at Embedian

Basic Resources

• ARM Cross Compiler
  • ARM: https://developer.arm.com/downloads/-/gnu-a
• Bootloader
  • Das U-Boot – the Universal Boot Loader http://www.denx.de/wiki/U-Boot
  • Source – http://git.denx.de/?p=u-boot.git;a=summary
• Linux Kernel
  • Linus's Mainline tree: http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=summary
  • NXP Linux source tree: git://github.com/nxp-imx/linux-imx.git
  • NXP Yocto BSP meta layer: https://github.com/nxp-imx/meta-imx/meta-bsp
  • Freescale community  BSP release: https://github.com/Freescale/meta-freescale-distro
  • Embedian SMARC-iMX8MM Linux kernel source tree: git@git.embedian.com:developer/smarc-fsl-linux-kernel.git or git@github.com:embedian/smarc-fsl-linux-kernel.git
• ARM based rootfs
  • Debian Squeeze: http://www.debian.org/
    
    

ARM Cross Compiler: GCC

This is a pre-built (32bit) version of Linaro GCC that runs on generic linux, so 64bit users need to make sure they have installed the 32bit libraries for their distribution.

To build Embedian’s SMARC-iMX8MM u-boot and linux kernel, you will need to install the following ARM compiler: 

For u-boot 2022.04, you need to use the following Arm compiler. 

Test:

If this test fails, verify that you have the 32bit libraries installed on your development system.

Generating SSH Keys

We recommend you use SSH keys to establish a secure connection between your computer and Embedian Gitlab server. The steps below will walk you through generating an SSH key and then adding the public key to our Gitlab account.

Step 1. Check for SSH keys

First, we need to check for existing ssh keys on your computer. Open up Git Bash and run:

Check the directory listing to see if you have a file named either id_rsa.pub or id_dsa.pub. If you don't have either of those files go to step 2. Otherwise, you already have an existing keypair, and you can skip to step 3.

Step 2. Generate a new SSH key

To generate a new SSH key, enter the code below. We want the default settings so when asked to enter a file in which to save the key, just press enter.

Step 3. Add your SSH key to Embedian Gitlab Server

Copy the key to your clipboard.

Go to Embedian Git Server. At Profile Setting --> SSH Keys --> Add SSH Key 

Paste your public key and press "Add Key" and your are done.

Boot File: flash.bin

The boot file is called flash.bin. It is made up of some pieces of programs. This section instruct you how to generate flash.bin. 

1. Download the imx-mkimage tool and apply Embedian's patch to accept Embedian's device tree blob.

2. Get and Build the ARM Trusted firmware and copy bl31.bin to imx-mkimage/iMX8M directory.

3. Get the DDR firmware and copy to imx-mkimage/iMX8M/ directory.

4. Clone the U-Boot source code from Embedian Git Server and copy related files to imx-mkimage/iMX8M/ directory.

Download:

For u-boot v2022.04: 

$ git clone git@git.embedian.com:developer/smarc-t335x-uboot.git v2022.04 -b emb_lf_v2022.04

Configure and Build:

Copy u-boot-nodtb.bin spl/u-boot-spl.bin arch/arm/dts/imx8mm-smarc.dtb to imx-mkimage/iMX8M directory and copy tools/mkimage to imx-mkimage/iMX8M/mkimage_uboot

5. Generate flash.bin file.

The flash.bin file will be located at imx-mkimage/iMX8M directory. Go to "Setup SD Card" section to instruct you how to flash this file into SD card.

Linux Kernel

Download:

For 5.15.71 (Based on NXP imx_lf-5.15.y official release):

$ git clone git@git.embedian.com:developer/smarc-fsl-linux-kernel.git v5.15.71 -b emb_imx_lf-5.15.y

Configure and Build:

$ make ARCH=arm CROSS_COMPILE=${CC} distclean

$ make ARCH=arm CROSS_COMPILE=${CC} emb_imx_v8_defconfig

$ make ARCH=arm CROSS_COMPILE=${CC} Image modules dtbs

All available DTB files are listed in the table below.

Root File System

Ubuntu ARM64 18.04: 

Ubuntu 18.04 Download:

$ wget -c ftp://ftp.embedian.com/public/dev/minfs/ubuntu/bionic/ubuntu-minimal-imx8mm-18.04-arm64.tar.gz

Verify:

$ md5sum ubuntu-minimal-imx8mm-18.04-arm64.tar.gz

78b861b57259b37bdf5efd60836ffa56  ubuntu-minimal-imx8mm-18.04-arm64.tar.gz

Yocto Kirkstone Build Root File System:

Find the yocto pre-built root file systems here at Embedian's ftp site based on your module CPU variants.

Setup SD Card

For these instruction, we are assuming: DISK=/dev/mmcblk0, "lsblk" is very useful for determining the device id.

Erase SD card:

Create Partition Layout:

With util-linux v2.26, sfdisk was rewritten and is now based on libfdisk.

Create Partitions:

Format Partitions:

Mount Partitions:

On some systems, these partitions may be auto-mounted...

Install Boot File

If on-module eMMC Flash is empty

In some cases, when eMMC flash is erased or the u-boot is under development, we need a way to boot from SD card first. Users need to shunt cross the TEST# pin to ground. In this way, SMARC-iMX8MM will always boot up from SD card. 

Fuse flash.bin to the SD card. 

If on-module eMMC Flash is not empty

The flash.bin is pre-installed in on-module eMMC flash at factory default. SMARC-iMX8MM is designed to always boot up from on-module eMMC flash and to load Image, device tree blob and root file systems based on the setting of BOOT_SEL. If users need to fuse your own flash.bin or perform u-boot upgrade. This section will instruct you how to do that.

Copy flash.bin to the second partition home directory of your SD card and boot into SD card. Go to home directory and you should see flash.bin file (The flash.bin file is located at imx-mkimage/iMX8M/ directory). 

Fuse flash.bin to the on-module eMMC flash. (The eMMC flash is emulated as /dev/mmcblk0 in SMARC-iMX8MM)

uEnv.txt based bootscript

Create "uEnv.txt" boot script: ($ vim uEnv.txt)

Copy uEnv.txt to the boot partition:

Install Kernel Image

Copy Image to the boot partition:

Install Kernel Device Tree Binary

All available DTB files are listed in the table below.

Install Root File System and Kernel Modules

Copy Root File System:

Yocto Pre-Built Rootfs:

Ubuntu 18.04:

Copy Kernel Modules:

Networking:

Edit: /etc/network/interfaces

Add:

Remove SD card:

Setup eMMC

Setting up eMMC usually is the last step at development stage after the development work is done at your SD card or NFS environments. From software point of view, eMMC is nothing but a non-removable SD card on board. For SMARC-iMX8MM, the SD card is always emulated as /dev/mmcblk1 and on-module eMMC is always emulated as /dev/mmcblk0. Setting up eMMC now is nothing but changing the device descriptor. 

This section gives a step-by-step procedure to setup eMMC flash. Users can write a shell script your own at production to simplify the steps.

First, we need to backup the final firmware from your SD card or NFS.

Prepare for eMMC binaries from SD card (or NFS):

Insert SD card into your Linux PC. For these instructions, we are assuming: DISK=/dev/mmcblk0, "lsblk" is very useful for determining the device id.

For these instruction, we are assuming: DISK=/dev/mmcblk0, "lsblk" is very useful for determining the device id.

Mount Partitions:

On some systems, these partitions may be auto-mounted...

Copy Image to rootfs partition:

Copy uEnv.txt to rootfs partition:

Copy and paste the following contents to /media/rootfs/home/root ($ sudo vim /media/rootfs/home/root/uEnv.txt)

Copy device tree blob to rootfs partition:

$ sudo cp -v /media/boot/dtbs/imx8mm-smarc.dtb /media/rootfs/home/root/imx8mm-smarc.dtb

Copy boot file to rootfs partition:

Copy real rootfs to rootfs partition:

Yocto Built Root File Systems

Ubuntu 18.04 Root File Systems

Unmount SD card.

It is safe to remove SD card now.

Copy Binaries to eMMC from SD card:

Insert this SD card into your SMARC-iMX8MM device and boot into SD card.

Now it will be almost the same as you did when setup your SD card, but the eMMC device descriptor is /dev/mmcblk0 now.

Erase SD card:

Create Partition Layout:

Format Partitions:

Mount Partitions:

Install binaries for partition 1

Copy uEnv.txt/Image/*.dtb to the boot partition

Install Kernel Device Tree Binary

Install Root File System