View source for IoTGateway/BSP/Linux/iMX8/Yocto LBV9 User Guide

{{DISPLAYTITLE:Yocto Linux BSP Ver.9 User Guide for iMX8 series}} <!--
{| align="right"
 | <span class="fck_mw_magic" _fck_mw_customtag="true" _fck_mw_tagname="TOC" _fck_mw_tagtype="c">_</span>
 |}
-->

= Getting Started =

== <span style="color:#0070c0">Conventions</span> ==

<span style="color:purple">'''${PREBUILT_IMAGE}'''</span>&nbsp;: compressed prebuilt image (*.img.gz)

<span style="color:purple">'''${CONTAINER_NAME}'''</span>&nbsp;: container name (e.g. imx8LBV9040)

<span style="color:purple">'''${BSP_TARBALL}'''</span>&nbsp;: BSP tarball (*.tgz)

<span style="color:purple">'''${BSP_HOME}'''</span>&nbsp;: home directory of the BSP

<span style="color:purple">'''${BDIR}'''</span>&nbsp;: build directory (e.g. build_x11)

<span style="color:purple">'''${MX8PROC}'''</span>&nbsp;: i.MX8 Processor

:mx8mq for iMX8M Dual Core<br/>
:<br/>

<span style="color:purple">'''${IMX8PROC}'''</span>&nbsp;: i.MX8 Processor

:imx8mq<br/>

<span style="color:purple">'''${BOARD}'''</span>&nbsp;: available target boards list below

:rom5720<br/>

<span style="color:purple">'''${BOARD_REV}'''</span>&nbsp;: board revision

:a1<br/>

<span style="color:purple">'''${MC}'''</span>&nbsp;: machine code combined with <span style="color:purple">'''${IMX8PROC}${BOARD}${BOARD_REV}'''</span>

:for example,<br/>

::<tt>imx8mqrom5720a1 for ROM-5720 A1</tt><br/>

:You can also use the command below to check supported machines on BSP
::<code>$ source setup-environment</code>

<span style="color:purple">'''${MEM_SIZE}'''</span>&nbsp;: memory size

:&nbsp;2G<br/>

<span style="color:purple">'''${SD_DEVICE}'''</span>&nbsp;: device name of SD card in Linux (e.g. /dev/sdf)

<span style="color:purple">'''${SDCARD_IMAGE}'''</span>&nbsp;: sdcard image built by bitbake (*.sdcard)

<span style="color:purple">'''${WORKSPACE}'''</span>&nbsp;:&nbsp;host workspace folders

<span style="color:purple">'''${UBOOT}'''</span>&nbsp;:u-boot version(e.g. 2016.03)

<span style="color:purple">'''${KERNEL}'''</span>&nbsp;: linux kernel version(e.g. 4.1.15)

<span style="color:purple">'''${TOOLCHAIN}'''</span>&nbsp;: 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 ...)

== <font color="#0070c0">Docker install and setting</font> ==

<span style="font-size:larger">'''<span style="color:#0070c0">If you don't have docker in your system, then you can follow the below &nbsp;steps to install docker and run it first.</span>'''</span>

=== <span style="color:#0070c0">To install Docker Engine on your platform</span> ===

:Please refer to [https://docs.docker.com/engine/installation/ Docker Installation Guide] for details

=== <span style="color:#0070c0">To pull [https://hub.docker.com/r/advrisc/u12.04-imx6lbv3/ ubuntu 16.04 image from Docker Hub]&nbsp;</span> ===

:<code>$ docker pull advrisc/u16.04-imx8lbv1</code><br/>
:<code>$ docker run --name imx8LBV9200&nbsp;&nbsp;-it advrisc/u16.04-imx8lbv1 /bin/bash</code><br/>

=== To copy BSP from local filesystem to the container ===

:<code>$ docker cp '''${BSP_PACK}''' imx8LBV9200:/home/adv/&nbsp;</code><br/>

=== <span style="color:#0070c0">To&nbsp;create&nbsp;container</span> ===

:<code>$ docker run --privileged -it --name '''${CONTAINER_NAME}'''&nbsp;-v '''${WORKSPACE}''':/home/adv/adv-release-bsp -v /dev:/dev&nbsp;advrisc/u16.04-imx8lbv1 /bin/bash</code><br/>

== <span style="color:#0070c0">Get BSP</span> ==

: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&nbsp;[[IoTGateway/BSP/Linux/iMX6/OS_Support_List_new|IoTGateway/BSP/Linux/iMX8/OS Support List new]] , Official version "'''imx8LBV9040"&nbsp;'''is taken as&nbsp;an example&nbsp;:<br/>

 TBD

:If you want to get latest bsp

 $ repo init -u [git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git]  <span>-b imx-linux-sumo -m imx-4.14.78-1.0.0_ga.xml</span> 
 $ repo sync

=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===

:If you have BSP tarball (eg. imx8LBV9040_2017-01-16.tgz), then you have to copy it into container.<br/>

Follow the steps below:

1.Exit container and back to local machine

 $ exit

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

 $ cp imx6LBV8040_2017-01-16.tgz '''${WORKSPACE}'''
 $ sudo chown adv:adv ${WORKSPACE}/imx6LBV8040_2017-01-16.tgz&nbsp;

3.Back to container

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

4.Unpack BSP tarball

 $ tar zxvf imx6LBV8040_2017-01-16.tgz

== <span style="color:#0070c0">Downloads tarball</span> ==

TBD

== <span style="color:#0070c0">Introducing BSP</span> ==

:The BSP is based on Yocto Project with Freescale enhanced features for i.MX8, plus specific target board features from Advantech Inc..<br/>
: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.

=== <span style="color:#0070c0">Naming Rule</span> ===

: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: imx8LBV9040_2017-01-16.tgz'''<br/>
:which , "LB" is acronym of <span style="color:#ff0000">'''L'''</span>inux <span style="color:#ff0000">'''B'''</span>SP,<br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;"V8040" stands for <span style="color:#ff0000">'''V'''</span>ersion <font color="#ff0000">'''8'''</font>.<span style="color:#ff0000">'''040'''</span><nowiki>.</nowiki>














:For example, '''Yocto image name: 7421A1LIV8040_DualPlus_2017-01-16.img.gz'''<br/>
:which "7421A1" stands for <span style="color:#ff0000">'''ROM-7421 A1'''</span><br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LI" is acronym for prebuilt <span style="color:#ff0000">'''L'''</span>inux <span style="color:#ff0000">'''I'''</span>mage,<br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "DualPlus" means this image is fit for Dual Plus Core/Quad Plus Core.

:For example, '''Yocto image name: 3420A1LIV8050_DualQuad_2017-01-17.img.gz'''<br/>
:which "3420A1" stands for <span style="color:#ff0000">'''ROM-3420 A1'''</span><br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LI" is acronym for prebuilt <span style="color:#ff0000">'''L'''</span>inux <span style="color:#ff0000">'''I'''</span>mage,<br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "DualQuad" means this image is fit for Dual Core/Quad Core.

:For example, '''Yocto image name: U220A1LIV8080_DualLiteSolo_2017-02-08.img.gz'''<br/>
:which "U220A1" stands for <span style="color:#ff0000">'''UBC-220 A1'''</span><br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LI" is acronym for prebuilt <span style="color:#ff0000">'''L'''</span>inux <span style="color:#ff0000">'''I'''</span>mage,<br/>
:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "DualLiteSolo" means this image is fit for Dual Lite Core/Solo Core.

=== <span style="color:#0070c0">BSP Content</span> ===
<div style="margin-left:0.499cm; margin-right:0cm">The description of some important folders list below:</div><div style="margin-left:1.499cm; margin-right:0cm">'''sources/'''</div><div style="margin-left:1.998cm; margin-right:0cm">'''meta-advantech/'''&nbsp;: meta layer by Advantech</div><div style="margin-left:1.998cm; margin-right:0cm">'''meta-fsl-*/'''&nbsp;: meta layer by Freescale</div><div style="margin-left:1.499cm; margin-right:0cm">'''fsl-setup-release.sh'''&nbsp;: to create one new build environment</div><div style="margin-left:1.499cm; margin-right:0cm">'''setup-environment'''&nbsp;: to continue an exist build environment</div>
== <span style="color:#0070c0">Build Instructions</span> ==

=== <span style="color:#0070c0">To create one new build environment</span> ===

:Perform the following commands in terminal console
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span></code>
::<code>$ MACHINE=<span style="color:#7030a0">'''${MC}'''</span> </code> <code>DISTRO=fsl-imx-wayland </code><code>source fsl-setup-release.sh -b <span style="color:#7030a0">'''${BDIR}'''</span> </code><br/>
:You need to read and accept the EULA.
:[[File:Accept EULA.png|RTENOTITLE]]

=== <span style="color:#0070c0">To continue an exist build environment</span> ===

:Perform the following commands in terminal console
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span></code>
::<code>$ source setup-environment <span style="color:#7030a0">'''${BDIR}'''</span></code>

=== <span style="color:#0070c0">To build sdcard image</span> ===

:To create/continue a build environment<br/>
:Perform the following command in terminal console
::<code>$ bitbake fsl-image-qt5-validation-imx</code><br/>
:The file, <code>fsl-image-qt5-validation-imx</code>-<span style="color:#7030a0">'''${MC}'''</span>.sdcard, will be located in directory, ./tmp/deploy/images/<span style="color:#7030a0">'''${MC}'''</span>, while building process finished successfully.<br/>

=== <span style="color:#0070c0">To build toolchain installer</span> ===

:To create/continue a build environment
:Perform the following command in terminal console
::<code>$ bitbake meta-toolchain-qt5</code><br/>
:The below installer will be located in the directory "./tmp/deploy/sdk".
::<tt>fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-<span style="color:#7030a0">'''${KERNEL}'''</span>-1.1.0.sh</tt><br/>

=== <span style="color:#0070c0">To build u-boot</span> ===

<code>TBD</code>

=== <span style="color:#0070c0">To build linux kernel</span> ===

<code>TBD</code>

=== <span style="color:#0070c0">To modify source code and rebuild linux kernel</span> ===

:<code>TBD</code><br/>

== <span style="color:#0070c0">Creating boot-up on-board flash from prebuilt image</span> ==

=== <span style="color:#0070c0">To create one boot-up SD card</span> ===

:Perform the following command in terminal console
::<code>$ gunzip -c '''<span style="color:#7030a0">${PREBUILT_IMAGE</span>''' | dd of=<span style="color:#7030a0">'''${SD_DEVICE}'''</span> bs=1M</code>
::<code># sync</code>

=== <span style="color:#0070c0">To transfer whole system to on-board flash</span> ===

:Boot up from SD card
:Perform the following commands in debug console
::<code># cd /mk_inand</code>
::<code># ./mksd-linux.sh /dev/mmcblk0</code>
:press y followed by Enter, if following message shows up:
::[[File:All data will be destroyed.png|RTENOTITLE]]
:While "[Done]" shows up means the transferring is finished.

== <span style="color:#0070c0">Creating boot-up on-board flash from built sdcard image</span> ==

=== <span style="color:#0070c0">To create one boot-up SD card</span> ===

:Perform the following commands in terminal console
::<code>$ pushd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/<span style="color:#7030a0">'''${BDIR}'''</span>/tmp/deploy/images/<span style="color:#7030a0">'''${MC}'''</span></code>
::<code>$ dd if=<span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span> of=<span style="color:#7030a0">'''${SD_DEVICE}'''</span> bs=1M</code>
::<code>$ sync</code>
::<code>$ popd</code>

=== <span style="color:#0070c0">To transfer whole system to on-board flash</span> ===

:Boot up from SD card
:Insert USB stick that contains <span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span>, USB stick will be auto mounted to /run/media/sda1.
:Perform the following commands in debug console
::<code># umount /dev/mmcblk0p?</code>
::<code># cd /run/media/sda1</code>
::<code># dd if=<span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span> of=/dev/mmcblk0 bs=4M conv=fsync</code>
::<code># P2START=$(fdisk -lu | grep mmcblk0p2 | awk '{print $2}')</code>
::<code># echo -e "d\n2\nn\np\n2\n<span style="color:#7030a0">'''${P2START}'''</span>\n\nw\n" | fdisk -u /dev/mmcblk0</code>
::<code># umount /dev/mmcblk0p2</code>
::<code># e2fsck -f -y /dev/mmcblk0p2</code>
::<code># resize2fs /dev/mmcblk0p2</code>
::<code># poweroff</code>

== <span style="color:#0070c0">Debug console information</span> ==

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

=== <span style="color:#0070c0">Preparing for hardware device</span> ===

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

[[Debug_Port_Information#i.MX6|Debug Port Information]]

=== <span style="color:#0070c0">Preparing for software tool</span> ===

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

= Customization =

== <span style="color:#0070c0">Package addition</span> ==

=== <span style="color:#0070c0">To add tcf-agent & openssh-sftp-server</span> ===

:Navigate to the directory where fsl-image-adv.inc located
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/sources/meta-advantech/recipes-fsl/images</code>
:Add following line to fsl-image-adv.inc
::<code>IMAGE_INSTALL += " tcf-agent openssh-sftp-server "</code>
:[[IoTGateway/BSP/Linux/iMX6/Yocto_LBV5_User_Guide#To_continue_an_exist_build_environment|Continue an exist build environment]] and [[IoTGateway/BSP/Linux/iMX6/Yocto_LBV5_User_Guide#To_build_sdcard_image|build sdcard image]]

=== <span style="color:#0070c0">To add chromium browser</span> ===

:Navigate to the directory where local.conf located
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/<span style="color:#7030a0">'''${BDIR'''</span>'''<span style="color:#7030a0">}</span>'''/conf</code>
:Add following two lines to local.conf
::<code>CORE_IMAGE_EXTRA_INSTALL += "chromium"</code>
::<code>LICENSE_FLAGS_WHITELIST="commercial"</code>
:[[#To_continue_an_exist_build_environment|Continue an exist build environment]] and [[#To_build_sdcard_image|build sdcard image]]

== <span style="color:#0070c0">Setting up SDK</span> ==

:Please follow the section,[[IoTGateway/BSP/Linux/iMX6/Yocto_LBV5_User_Guide#To_build_toolchain_installer|<span style="color:#FF0000">To build toolchain installer</span>]], to build one toolchain installer
:Perform the following command in terminal console
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/<span style="color:#7030a0">'''${BDIR}'''</span>/tmp/deploy/sdk</code>
::<code>$ sudo ./fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-<span style="color:#7030a0">'''${KERNEL}'''</span>-1.1.0.sh</code><br/>
:Enter new installed directory or just press <code>Enter</code> to use default directory.
:While <code>Proceed[y/n]?</code> shows up, please enter the correct one.
:Waiting for the SDK installed (while the following messages show up completely)
::[[File:Setting up sdk 3.png|RTENOTITLE]]

== <span style="color:#0070c0">Setting up cross compiling environment</span> ==

:SDK has been set up (ref.[[#Setting_up_SDK|<span style="color:#FF0000">Setting up SDK</span>]])
:Perform the following command in terminal console
::<code>$ source <span style="color:#7030a0">'''${TOOLCHAIN}'''</span>/environment-setup-aarch64-poky-linux</code>

== <span style="color:#0070c0">Building & updating u-boot manually</span> ==

TBD

== <span style="color:#0070c0">Building & updating kernel/modules/dtb manually</span> ==

TBD

== <span style="color:#0070c0">Improve boot speed</span> ==

*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|Creating boot-up on-board flash from prebuilt image]] / [[#Creating_boot-up_on-board_flash_from_built_sdcard_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:[[:File:BSP_package1.docx|Package List]]

Show all recipes (include non-installed packages)

 bitbake -s

File:[[:File:BSP_package2.docx|Package Version List]]

You can also check <span style="color:purple">'''${BDIR}'''</span>/tmp/deploy/images/<span style="color:purple">'''${MC}'''</span>/fsl-image-qt5-<span style="color:purple">'''${MC}'''</span>.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:[[:File:Onboard_package.docx|Package List]]