Latest revision as of 04:21, 20 March 2020

Getting Started

Conventions

${PREBUILT_IMAGE} : compressed prebuilt image (*.img.gz)

${CONTAINER_NAME} : container name (e.g. imx7LBV8870)

${BSP_TARBALL} : BSP tarball (*.tgz)

${BSP_HOME} : home directory of the BSP

${BDIR} : build directory (e.g. build_x11)

${MX7PROC} : i.MX7 Processor

mx7d for iMX7 Dual Core

${IMX7PROC} : i.MX7 Processor

imx7d

${BOARD} : available target boards list below

ebcrm01

${BOARD_REV} : board revision

a1

${MC} : machine code combined with ${IMX7PROC}${BOARD}${BOARD_REV}

for example,

imx7debcrm01a1 for EBC-RM01 A1

${MEM_SIZE} : memory size

2G

${MEM_VENDOR} : memory vendor

IM / Micron

${SD_DEVICE} : device name of SD card in Linux (e.g. /dev/sdf)

${SDCARD_IMAGE} : sdcard image built by bitbake (*.sdcard)

${WORKSPACE} : host workspace folders

${UBOOT} :u-boot version(e.g. 2016.03)

${KERNEL} : linux kernel version(e.g. 4.1.15)

${TOOLCHAIN} : toolchain installed directory(e.g. /opt/fsl-imx-x11/4.1.15-2.0.0)

debug console / serial console

serial terminal program (e.g. minicom, putty, teraterm ...) that serial port is configured to 115200 8N1

terminal console

terminal program (e.g. gnome-terminal, xfce4-terminal ...)

Docker install and setting

If you don't have docker in your system, then you can follow the below  steps to install docker and run it first.

To install Docker Engine on your platform

Please refer to Docker Installation Guide for details

To pull ubuntu 12.04 image from Docker Hub 

$ docker pull advrisc/u12.04-imx6lbv3

$ docker run --name imx7LBV8870  -it advrisc/u12.04-imx6lbv3 /bin/bash

To copy BSP from local filesystem to the container

$ docker cp ${BSP_PACK} imx7LBV8870:/home/adv/ 

To create container

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

Get BSP

You have two methods to put BSP into container created above

Download BSP From GitHub

The following example shows how to download the Advantech Yocto BSP from GitHub.

For this example, a directory called adv-release-bsp is created for the project.

Refer to IoTGateway/BSP/Linux/iMX7/OS Support List new , Official version "imx7LBV8870" is taken as an example :

$ git config --global user.name "Your Name"
$ git config --global user.email you@example.com
$ mkdir adv-release-bsp
$ sudo chown adv:adv adv-release-bsp
$ cd adv-release-bsp
$ repo init -u git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git -b refs/tags/imx7LBV8870 -m imx7LBV8870.xml
$ repo sync

• If you want to get latest bsp

$ git config --global user.name "Your Name"
$ git config --global user.email you@example.com
$ mkdir adv-release-bsp
$ sudo chown adv:adv adv-release-bsp
$ cd adv-release-bsp
$ repo init -u git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git -b imx-4.1-krogoth
$ repo sync

Copy BSP tarball to Container

If you have BSP tarball (eg. imx7LBV8870_2018-10-18.tgz), then you have to copy it into container.

Follow the steps below:

1.Exit container and back to local machine

$ exit

2.Copy BSP tarball to ${WORKSPACE} , and change owner

$ cp imx7LBV8870_2018-10-18.tgz ${WORKSPACE}
$ sudo chown adv:adv ${WORKSPACE}/imx7LBV8870_2018-10-18.tgz 

3.Back to container

$ docker start ${CONTAINER_NAME}
$ docker attach ${CONTAINER_NAME}

4.Unpack BSP tarball

$ tar zxvf imx7LBV8870_2018-10-18.tgz

Introducing BSP

The BSP is based on Yocto Project with Freescale enhanced features for i.MX7, plus specific target board features from Advantech Inc..

The Advantech Yocto Project BSP Release directory contains a "sources" directory, which contains the recipes used to build,

one or more build directories, and a set of scripts used to set up the environment.

The recipes used to build the project come from both the community and Advantech. The Yocto Project layers are downloaded

to the sources directory. This sets up the recipes that are used to build the project.

Naming Rule

The tarball/prebuilt image name is consist of the model name followed by "LB" or "LI" plus version number and released date.

For example, BSP file name: imx7LBV8870_2018-10-18.tgz

which , "LB" is acronym of Linux BSP,

           "V8870" stands for Version 8.870.

For example, Yocto image name: RM01LIV8870_Dual_2018-10-18.img.gz

which "rm01A1" stands for EBC-RM01 A1

          "LI" is acronym for prebuilt Linux Image,

          "Dual" means this image is fit for Dual Core.

BSP Content

Build Instructions

To create one new build environment

Perform the following commands in terminal console

$ cd ${BSP_HOME}

$ MACHINE=${MC} source fsl-setup-release.sh -b ${BDIR} -e x11

You need to read and accept the EULA.

To continue an exist build environment

Perform the following commands in terminal console

$ cd ${BSP_HOME}

$ source setup-environment ${BDIR}

To build sdcard image

To create/continue a build environment

Perform the following command in terminal console

$ bitbake fsl-image-qt5

The file, fsl-image-qt5-${MC}.sdcard, will be located in directory, ./tmp/deploy/images/${MC}, while building process finished successfully.

To build toolchain installer

To create/continue a build environment

Perform the following command in terminal console

$ bitbake meta-toolchain-qt5

The below installer will be located in the directory "./tmp/deploy/sdk".

fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-${KERNEL}-1.1.0.sh

To build u-boot

To create/continue a build environment

Perform the following command in terminal console

$ bitbake u-boot-imx

The two files, u-boot_crc.bin & u-boot_crc.bin.crc, will be located in the directory, ./tmp/deploy/images/${MC}.

To modify source code and rebuild u-boot

To create/continue a build environment

Perform the following command in terminal console

to modify source code and created a patch file

$ git diff > test.patch

to create "u-boot-imx" directory and copy the "test.patch" file in following path

sources/meta-advantech/meta-fsl-imx6/recipes-bsp/u-boot$

to open "u-boot-imx_2016.03.bbappend" file in following path

sources/meta-advantech/meta-fsl-imx6/recipes-kernel$vi u-boot-imx_2016.03.bbappend

FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"

SRCBRANCH = "imx_v2016.03_4.1.15_2.0.0_ga"

UBOOT_SRC = "..."

SRCREV = "${AUTOREV}"

to add path information of patch file to u-boot-imx_2016.03.bbappend file

SRC_URI += "file://test.patch

to clean u-boot image and code if you modify content of "mx7*.defconfig" file or "Makefile" file in the patch file

$ bitbake u-boot-imx -c cleansstate

to build u-boot image

$ bitbake u-boot-imx

To build linux kernel

To create/continue a build environment

If you operate on docker images, please install tmux application before running this command

$ sudo apt-get install tmux

Type following command to enter tmux

$ tmux

Perform the following command in terminal console to show up menuconfig

$ bitbake linux-imx -c menuconfig

After edit menuconfig, type following command to exit tmux windows

$ exit

to build kernel image

$ bitbake linux-imx

The two files, zImage & zImage-${IMX7PROC}-${BOARD}-${BOARD_REV}.dtb, will be located in the directory, ./tmp/deploy/images/${MC}.

To modify source code and rebuild linux kernel

To create/continue a build environment

Perform the following command in terminal console

to modify source code and created a patch file

$ git diff > test.patch

to create "linux-imx" directory and copy the "test.patch" file in following path 

sources/meta-advantech/meta-fsl-imx6/recipes-kernel/linux/linux-imx$

to open "linux-imx_4.1.15.bbappend" file in following path  (linux-imx_4.1.15.bbappend will check linux-imx folder  )

sources/meta-advantech/meta-fsl-imx6/recipes-kernel/linux/$vi linux-imx_4.1.15.bbappend

FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"

SRCBRANCH = "imx_4.1.15_2.0.0_ga"

KERNEL_SRC = "..."

SRCREV = "${AUTOREV}"

to add path information of patch file to linux-imx_4.1.15.bbappend file

SRC_URI += "file://test.patch

to clean kernel image and code if you modify content of "imx_v7_adv_imx7_defconfig" file or "Makefile" file in the patch file

$ bitbake linux-imx -c cleansstate

to build kernel image

$ bitbake linux-imx

Creating boot-up on-board flash from prebuilt image

To create one boot-up SD card

Perform the following command in terminal console

$ gunzip -c ${PREBUILT_IMAGE | dd of=${SD_DEVICE} bs=1M

# sync

To transfer whole system to on-board flash (eMMC)

Boot up from SD card

Perform the following commands in debug console

# cd /mk_inand

# ./mksd-linux.sh /dev/mmcblk0

press y followed by Enter, if following message shows up:

While "[Done]" shows up means the transferring is finished.

Creating boot-up on-board flash from built sdcard image

To create one boot-up SD card

Perform the following commands in terminal console

$ pushd ${BSP_HOME}/${BDIR}/tmp/deploy/images/${MC}

$ dd if=${SDCARD_IMAGE} of=${SD_DEVICE} bs=1M

$ sync

$ popd

To transfer whole system to on-board flash

Boot up from SD card

Insert USB stick that contains ${SDCARD_IMAGE}, USB stick will be auto mounted to /run/media/sda1.

Perform the following commands in debug console

# umount /dev/mmcblk2p?

# cd /run/media/sda1

# dd if=${SDCARD_IMAGE} of=/dev/mmcblk2 bs=4M conv=fsync

# P2START=$(fdisk -lu | grep mmcblk2p2 | awk '{print $2}')

# echo -e "d\n2\nn\np\n2\n${P2START}\n\nw\n" | fdisk -u /dev/mmcblk2

# umount /dev/mmcblk2p2

# e2fsck -f -y /dev/mmcblk2p2

# resize2fs /dev/mmcblk2p2

# poweroff

Debug console information

If you want to see debug message from device, you need to prepare for hardware device and software tool.

Preparing for hardware device

• The following URL provides information about the debug port slot and the debug port line for each device

Debug Port Information

Preparing for software tool

• You need to prepare the debug console tool. For example: "minicom" tool or "putty" tool.
• Baud rate: 115200

Customization

Package addition

To add tcf-agent & openssh-sftp-server

Navigate to the directory where fsl-image-adv.inc located

$ cd ${BSP_HOME}/sources/meta-advantech/recipes-fsl/images

Add following line to fsl-image-adv.inc

IMAGE_INSTALL += " tcf-agent openssh-sftp-server "

Continue an exist build environment and build sdcard image

Setting up SDK

Please follow the section,To build toolchain installer, to build one toolchain installer

Perform the following command in terminal console

$ cd ${BSP_HOME}/${BDIR}/tmp/deploy/sdk

$ sudo ./fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-${KERNEL}-1.1.0.sh

Enter new installed directory or just press Enter to use default directory.

While Proceed[y/n]? shows up, please enter the correct one.

Waiting for the SDK installed (while the following messages show up completely)

Setting up cross compiling environment

SDK has been set up (ref.Setting up SDK)

Perform the following command in terminal console

$ source ${TOOLCHAIN}/environment-setup-cortexa9hf-vfp-neon-poky-linux-gnueabi

Building & updating u-boot manually

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)

Copy BSP tarball to Container

• If you have an official version of u-boot source code, you can refer to Copy_BSP_tarball_to_Container , copy u-boot tarball to ${WORKSPACE} and back to container change owner & unpack tarball

$ sudo chown adv:adv imx7LBV8870_2018-10-18_uboot-imx7.tgz
$ tar zxvf imx7LBV8870_2018-10-18_uboot-imx7.tgz

• If you want to get latest u-boot source code by following information

$ git clone https://github.com/ADVANTECH-Corp/uboot-imx6.git -b imx_v2016.03_4.1.15_2.0.0_ga

Config u-boot

$make ${MX7PROC}${BOARD}${BOARD_REV}_${MEM_SIZE}_${MEM_VENDOR}_defconfig

eg.

$make mx7debcrm01a1_2G_IM_defconfig

Build u-boot

$make -j4

Replace u-boot

Perform the following command to transfer u-boot image to exist boot-up SD card

$ dd if=u-boot.imx of=${SD_DEVICE} bs=512 seek=2 conv=fsync

Perform the following command to transfer u-boot image to on-board flash(eMMC)

$ dd if=u-boot.imx of=/dev/mmcblk0 bs=512 seek=2 conv=fsync

Download the qspi-header.tar.gz file. Copy the qspi-header.tar.gz file to the device. Perform the following command to transfer u-boot image to first qspi

$ tar zxvf qspi-header.tar.gz
$ flash_erase /dev/mtd0 0 16
$ dd if=qspi-header of=/dev/mtd0 bs=1k seek=0
$ dd if=u-boot.imx of=/dev/mtd0 bs=512 seek=2 conv=fsync

Building & updating kernel/modules/dtb manually

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)

Copy BSP tarball to Container

• If you have an official version of kernel source code, you can refer to Copy_BSP_tarball_to_Container , copy kernel tarball to ${WORKSPACE} and back to container change owner & unpack tarball

$ sudo chown adv:adv imx7LBV8870_2018-10-18_linux-imx7.tgz
$ tar zxvf imx7LBV8870_2018-10-18_linux-imx7.tgz

• If you want to get latest kernel source code by the following information

$ git clone https://github.com/ADVANTECH-Corp/linux-imx6.git -b imx_4.1.15_2.0.0_ga

Config kernel

Configure linux kernel

$cd linux-imx6
$make distclean
$make imx_v7_adv_imx7_defconfig
$make menuconfig

If you get error ,when you "make imx_v7_adv_imx7_defconfig" , you need to insatall "libncurses*"

$apt-get install libncurses*

Build kernel

Start building linux kernel

$ make -j4 zImage

The kernel image file, zImage, is located in the directory "./arch/arm/boot/".

Start building kernel modules

$ make -j4 modules

Copy all modules to a temporary rootfs directory, "~/temp/rootfs"

$ make modules_install INSTALL_MOD_PATH=~/temp/rootfs

Building device tree blob

$ make -j4 ${IMX7PROC}-${BOARD}-${BOARD_REV}.dtb

The device tree blob, ${IMX7PROC}-${BOARD}-${BOARD_REV}.dtb, is located in the directory "./arch/arm/boot/dts/".

Replace kernel & dts

Replace kernel

copy zImage to SDcard or emmc

Replace dtb file

copy dtb file to SDcard or emmc