Difference between revisions of "IoTGateway/BSP/Linux/iMX8/Yocto LBV9 User Guide"

From ESS-WIKI
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 399: Line 399:
  
 
:1. download the following files:
 
:1. download the following files:
::(1) arm cross toolchain: [[Media:How_To_ECG-SW_Wiki.pptx|gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar.bz2]]
+
::(1) arm cross toolchain: [https://launchpad.net/gcc-arm-embedded/4.9/4.9-2015-q3-update gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar.bz2]
 
:::(Ref. [[Media:sc_fw_port.pdf|sc_fw_port.pdf]] in the imx-scfw-porting-kit)
 
:::(Ref. [[Media:sc_fw_port.pdf|sc_fw_port.pdf]] in the imx-scfw-porting-kit)
::(2) imx-atf(Yocto - imx-atf_2.0.bb): [[Media:How_To_ECG-SW_Wiki.pptx|bl31.bin]]
+
::(2) imx-atf(Yocto - imx-atf_2.0.bb): [[Media:bl31.zip|bl31.bin]]
::(3) firmware-imx(Yocto - firmware-imx_8.1.bb): [[Media:How_To_ECG-SW_Wiki.pptx|mx8qm-ahab-container.img]]
+
::(3) firmware-imx(Yocto - firmware-imx_8.1.bb): [[Media:mx8qm-ahab-container.zip|mx8qm-ahab-container.img]]
::(4) imx-sc-firmware(Yocto - imx-sc-firmware_1.2.bb): [[Media:How_To_ECG-SW_Wiki.pptx|scfw_tcm.bin]]
+
::(4) imx-sc-firmware(Yocto - imx-sc-firmware_1.2.bb): [[Media:scfw_tcm.zip|scfw_tcm.bin]]
 
:::(Ref. [[Media:sc_fw_port.pdf|sc_fw_port.pdf]] in the imx-scfw-porting-kit)
 
:::(Ref. [[Media:sc_fw_port.pdf|sc_fw_port.pdf]] in the imx-scfw-porting-kit)
  

Latest revision as of 08:45, 8 October 2019


Getting Started

Conventions

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

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

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

${BSP_HOME} : home directory of the BSP

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

${MX8PROC} : i.MX8 Processor

mx8mq for iMX8M Dual Core
mx8qm for iMX8QM
mx8qxp for iMX8QXP

${IMX8PROC} : i.MX8 Processor

imx8mq / imx8qm /imx8qxp

${BOARD} : available target boards list below

rom5720

${BOARD_REV} : board revision

a1

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

for example,
imx8mqrom5720a1 for ROM-5720 A1
imx8qmrom7720a1 for ROM-7720 A1
imx8qxprom5620a1 for ROM-5620 A1
You can also use the command below to check supported machines on BSP
$ source setup-environment

${MEM_SIZE} : memory size

 2G/4G

${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 16.04 image from Docker Hub 

$ docker pull advrisc/u16.04-imx8lbv1
$ docker run --name imx8LBV90010  -it advrisc/u16.04-imx8lbv1 /bin/bash

To copy BSP from local filesystem to the container

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

To create container

$ docker run --privileged -it --name ${CONTAINER_NAME} -v ${WORKSPACE}:/home/adv/adv-release-bsp -v /dev:/dev advrisc/u16.04-imx8lbv1 /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/iMX8/OS Support List new , Official version "imx8LBV90010" 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/imx8LBV90010 -m imx8LBV90010.xml 
$ repo sync
If you want to get latest bsp
$ repo init -u git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git  -b imx-linux-sumo -m imx-4.14.98-2.0.0_ga.xml 
$ repo sync

Copy BSP tarball to Container

If you have BSP tarball (eg. imx8LBV90010_2017-01-16.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 imx8LBV90010_2017-01-16.tgz ${WORKSPACE}
$ sudo chown adv:adv ${WORKSPACE}/imx8LBV90010_2017-01-16.tgz 

3.Back to container

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

4.Unpack BSP tarball

$ tar zxvf imx8LBV90010_2017-01-16.tgz

Downloads tarball

Not necessarily step
During building  Yocto image , it will generate downloads folder which includes all packages we need , but it usually can't fetch normally, so we keep this downloads folder. Then we can reduce some fetch failed issue.
You can get Downloads tarball (downloads_sumo.tar.gz) from following URL:
https://www.dropbox.com/s/s3zs3txzk4116d6/downloads_sumo.tar.gz?dl=0
If you get downloads tarball, you can copy to your ${WORKSPACE}

Follow the steps below:

1.Exit container and back to local machine

$ exit

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

$ cp downloads_sumo.tar.gz ${WORKSPACE}
$ sudo chown adv:adv ${WORKSPACE}/downloads_sumo.tar.gz 

3.Back to container

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

4.Unpack Downloads tarball

$ tar zxvf downloads_sumo.tar.gz

5.make link to downloads folder

$ cd adv-release-bsp
$ ln -s ${WORKSPACE}/downloads_sumo downloads

Introducing BSP

The BSP is based on Yocto Project with Freescale enhanced features for i.MX8, 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: imx8LBV90010_2019-08-27.tgz
which , "LB" is acronym of Linux BSP,
           "V90010" stands for Version 9.0010.
For example, Yocto image name: '5720A1AIM20LIV90010_iMX8M_2019-08-27.img.gz'
which "5720A1" stands for ROM-5720 A1
          "LI" is acronym for prebuilt Linux Image


BSP Content

The description of some important folders list below:
sources/
meta-advantech/ : meta layer by Advantech
meta-fsl-*/ : meta layer by Freescale
fsl-setup-release.sh : to create one new build environment
setup-environment : to continue an exist build environment

Build Instructions

To create one new build environment

Perform the following commands in terminal console
$ cd ${BSP_HOME}
$ MACHINE=${MC} DISTRO=fsl-imx-xwayland source fsl-setup-release.sh -b ${BDIR}
You need to read and accept the EULA.
RTENOTITLE

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-validation-imx
The file, fsl-image-qt5-validation-imx-${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
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

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-${IMX8PROC}-${BOARD}-${BOARD_REV}.dtb, will be located in the directory, ./tmp/deploy/images/${MC}.

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

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:
RTENOTITLE
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/mmcblk0p?
# cd /run/media/sda1
# dd if=${SDCARD_IMAGE} of=/dev/mmcblk0 bs=4M conv=fsync
# P2START=$(fdisk -lu | grep mmcblk0p2 | awk '{print $2}')
# echo -e "d\n2\nn\np\n2\n${P2START}\n\nw\n" | fdisk -u /dev/mmcblk0
# umount /dev/mmcblk0p2
# e2fsck -f -y /dev/mmcblk0p2
# resize2fs /dev/mmcblk0p2
# 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

To add chromium browser

Navigate to the directory where local.conf located
$ cd ${BSP_HOME}/${BDIR}/conf
Add following two lines to local.conf
IMAGE_INSTALL_append = \
   "${@bb.utils.contains('DISTRO_FEATURES', 'wayland', ' chromium-ozone-wayland libexif', \
       bb.utils.contains('DISTRO_FEATURES',     'x11', ' chromium-x11 libexif', \
                                                        , d), d)}"
LICENSE_FLAGS_WHITELIST = \
   "${@bb.utils.contains('DISTRO_FEATURES', 'wayland', 'commercial', \
       bb.utils.contains('DISTRO_FEATURES',     'x11', 'commercial', \
                                                       , d),"
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)
RTENOTITLE

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-aarch64-poky-linux

Building & updating u-boot manually

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)
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.
$ git clone https://github.com/ADVANTECH-Corp/uboot-imx6.git
$ cd uboot-imx6
$ git checkout -t remotes/origin/imx_v2018.03_4.14.98_2.0.0_ga

Copy BSP tarball to Container

TBD

Config u-boot

$make ${MX8PROC}${BOARD}${BOARD_REV}_${MEM_SIZE}_defconfig

eg.

$make imx8qm_rom7720a1_4G_defconfig

Build u-boot

$make -j4

Build flash.bin

For the ROM7720:

1. download the following files:
(1) arm cross toolchain: gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar.bz2
(Ref. sc_fw_port.pdf in the imx-scfw-porting-kit)
(2) imx-atf(Yocto - imx-atf_2.0.bb): bl31.bin
(3) firmware-imx(Yocto - firmware-imx_8.1.bb): mx8qm-ahab-container.img
(4) imx-sc-firmware(Yocto - imx-sc-firmware_1.2.bb): scfw_tcm.bin
(Ref. sc_fw_port.pdf in the imx-scfw-porting-kit)
2. decompress the toolchain:
$ tar xvf gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar.bz2 -C ~
3. export toolchain:
$ export TOOLS=~
4. download imx-mkimage:
$ git clone https://source.codeaurora.org/external/imx/imx-mkimage.git -b imx_4.14.98_2.0.0_ga
$ cd ~/imx-mkimage
5. copy the bl31.bin, mx8qm-ahab-container.img, scfw_tcm.bin and u-boot.bin to the iMX8QM/
6. build the flash.bin:
$ make clean
$ make SOC=iMX8QM flash

Replace u-boot

Perform the following command to transfer to exist boot-up SD card
$ dd if=flash.bin of=${SD_DEVICE} bs=1K seek=<offset> conv=fsync
Perform the following command to transfer to on-board flash
$ dd if=flash.bin of=/dev/mmcblk0 bs=1K seek=<offset> conv=fsync
Where offset is:
33 - for i.MAX 8QuadMax A0, i.MAX 8QuadXPlus A0, i.MAX 8M Quad, and i.MAX 8M Mini
32 - for i.MAX 8QuadXPlus B0 and i.MAX 8QuadMax B0

Building & updating kernel/modules/dtb manually

TBD

Improve boot speed

  • Bootloader

1.bootdelay time

We can cancel the bootdelay time by setting bootloader environment value.
setenv bootdelay 0
env save
reset

2.Disable console

Disable debug message output can also improve boot speed

Disable kernel message

setenv mmcargs setenv bootargs console=${console},${baudrate} ${smp} root=${mmcroot} ${bootargs} quiet
env save
reset

Or

Disable debug port
setenv console
env save
reset
  • Rootfs

1.Use smaller rootfs

We can speed up boot times by using a smaller rootfs instead of fsl-image-qt5 image

eg. core-image-full-cmdline, core-image-minimal

bitbake core-image-full-cmdline

It's a console-only image with more full-featured Linux system functionality installed.

And replace the original fsl-image-qt5 rootfs.

  • Services

1. Using update-rc.d remove ,we can remove unnecessary services.

update-rc.d -f <basename> remove

System Recovery

Please refer to Creating boot-up on-board flash from prebuilt image / sdcard image to create a boot-up SD card and transfer whole system to on-board flash.

Package List

In BSP, list all packages which will be built in the image

bitbake -g fsl-image-qt5 && cat pn-depends.dot | grep -v -e '-native' | grep -v digraph | grep -v -e '-image' \
| awk '{print $1}' | sort | uniq

File:Package List

Show all recipes (include non-installed packages)

bitbake -s

File:Package Version List

You can also check ${BDIR}/tmp/deploy/images/${MC}/fsl-image-qt5-${MC}.manifest

It will show the same content with checking by rpm tool on target board.

On target board, list all packages by rpm tool

rpm -qa --root / --dbpath /var/lib/rpm | sort

File:Package List