View source for Yocto Linux BSP Ver.A User Guide for RSB-3730 series -Yocto 3.0


{{DISPLAYTITLE:Yocto Linux BSP Ver.A User Guide for iMX8 series -Yocto 3.0}}

== 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. imx8LBVA0016)

<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 
:mx8mm for iMX8MM 
:mx8mp for iMX8MP 
:mx8qm for iMX8QM 
:mx8qxp for iMX8QXP 
:&nbsp; 

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

:imx8mq / imx8mm / imx8qm /imx8qxp /imx8mp 

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

:rom5720 
:rom5721 
:rom7720 
:rom5620 
:rom3620 
:rom5722 
:rsb3720 
:epcr5710 
:rsb3730 

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

:a1 

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

:for example, 

:
::<tt>imx8mqrom5720a1 for ROM-5720 A1</tt> 
::<tt>imx8qmrom7720a1 for ROM-7720 A1</tt> 
::<tt>imx8qxprom5620a1 for ROM-5620 A1</tt> 
::<tt>imx8qxprom3620a1 for ROM-3620 A1</tt> 
::<tt>imx8mmrom5721a1 for ROM-5721 A1</tt> 
::<tt>imx8mprom5722a1 for ROM-5722 A1</tt> 
::<tt>imx8mprsb3720a1 for RSB-3720 A1</tt> 
::<tt>imx8mpepcr5710a1 for EPC-R5710 A1</tt> 
::<tt>imx8mmrsb3730a2 for RSB-3730 A2</tt>   

: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

:2G/4G 

<span style="color:purple">'''${UC}'''</span>&nbsp;: u-boot config

:1G/2G/4G/FSPI_1G/FSPI_2G... 

<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 (VA0033 ~ VA0362: *.wic.bz2; VA0386 ~ latest version: *.sdcard)

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

<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 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 18.04 image from Docker Hub]</span> ===

:<code>$ docker pull advrisc/u18.04-imx8lbv1</code> 

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

:<code>$ docker run --privileged -it --name '''${CONTAINER_NAME}''' -v '''${WORKSPACE}''':/home/adv/adv-release-bsp -v /dev:/dev -v /lib/modules:/lib/modules -v /usr/src:/usr/src advrisc/u18.04-imx8lbv1 /bin/bash</code> 

== <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 [[IoTGateway/BSP/Linux/iMX8/OS_Support_List|IoTGateway/BSP/Linux/iMX8/OS_Support_List]] , Official version "'''imx8LBVA0209" '''is taken as an example&nbsp;: 
<pre>$ 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 git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git -b imx-linux-zeus -m imx8LBVA0428.xml 
$ repo sync</pre>

: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]  -b imx-linux-zeus -m imx-5.4.70-2.3.0.xml 
 $ repo sync

:If you suffer "server certificate verification failed", you can use the following command to disable SSL verification in git repositories with self-signed certificates. 

 $ export GIT_SSL_NO_VERIFY=1

or

 $ git config --global http.sslverify false

:If you get "The unauthenticated git protocol on port 9418 is no longer supported.", you can try it. 

 $ git config --global url."https://".insteadOf git://

:'''Important&nbsp;: As of March 31, 2023, all source repositories have been migrated to other platforms and the project has been shut down. ** Repo sync will be fail.''' 

:Solution&nbsp;: 

:(1) If you repo current xml file, repo sync is success. Example: 
<pre> $ 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-zeus -m </span>imx-5.4.70-2.3.0.xml </pre>

:(2) If you repo tag version xml file, please follow " [[Yocto3.0_Repo_Fail_SOP|Yocto3.0_Repo_Fail_SOP]] " to modify XML File. Example: 
<pre> $ repo init -u git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git -b imx-linux-zeus -m imx8LBVA0428.xml <- Tag XML</pre>

&nbsp;

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

:If you have BSP tarball (eg. imx8LBVA0029_2019-10-23.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 imx8LBVA0029_2020-10-23.tgz '''${WORKSPACE}'''
 $ sudo chown adv:adv ${WORKSPACE}/imx8LBVA0029_2020-10-23.tgz 

3.Back to container

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

4.Unpack BSP tarball

 $ tar zxvf imx8LBVA0029_2020-10-23.tgz

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

: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_imx8_5.4.24.tar.gz) or (downloads_imx8_5.4.70.tar.gz) from following URL: 

:[https://www.dropbox.com/sh/3z9hh9zht98mzil/AACYhzJkMQq_om6cru9mM-wha/officialbuild/imx8_yocto_bsp_3.0?dl=0&preview=downloads_imx8_5.4.24.tar.gz [downloads_imx8_5.4.24.tar.gz]], <span style="color:#ff0000">'''md5 checksum:'''</span> <span style="color:#ff0000">'''648a6aa9d03be61ee21611b729250319'''</span> 

:[https://www.dropbox.com/sh/3z9hh9zht98mzil/AACYhzJkMQq_om6cru9mM-wha/officialbuild/imx8_yocto_bsp_3.0?dl=0&preview=downloads_imx8_5.4.70.tar.gz [downloads_imx8_5.4.70.tar.gz]], <span style="color:#ff0000">'''md5 checksum:'''</span> <span style="color:#ff0000">'''ec2a0da745e57329a73965f9bd7ff0c9'''</span> 

: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_imx8_5.4.24.tar.gz '''${WORKSPACE}'''
 $ sudo chown adv:adv ${WORKSPACE}/downloads_imx8_5.4.24.tar.gz 

3.Back to container

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

4.Unpack Downloads tarball

 $ tar zxvf downloads_imx8_5.4.24.tar.gz

5.make link to downloads folder

 $ cd adv-release-bsp
 $ ln -s ${WORKSPACE}/downloads_imx8_5.4.24 downloads

== <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.. 
: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: imx8LBVA0010_2019-08-27.tgz''' 
:which , "LB" is acronym of <span style="color:#ff0000">'''L'''</span>inux <span style="color:#ff0000">'''B'''</span>SP, 
:"VA0010" stands for <span style="color:#ff0000">'''V'''</span>ersion <font color="#ff0000">'''A'''</font>.<span style="color:#ff0000">'''0010'''</span>'''.''' 
:<span style="background-color:#dddddd;">For example, </span>'''<span style="background-color:#dddddd;">Yocto image name: '</span>'''''<span style="background-color:#dddddd;">5720A1AIM20LIVA0010_iMX8M_2G_2020-08-27.img.gz'</span>'' 

:which "5720A1" stands for <span style="color:#ff0000">'''ROM-5720 A1'''</span> 
:"LI" is acronym for prebuilt <span style="color:#ff0000">'''L'''</span>inux <span style="color:#ff0000">'''I'''</span>mage 
:"2G" is DDR size 

=== <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-xwayland </code><code>source imx-setup-release.sh -b <span style="color:#7030a0">'''${BDIR}'''</span></code>   
:We can specify u-boot default config like below 
::<code>$ MACHINE=<span style="color:#7030a0">'''${MC}'''</span> </code> <code>UBOOT_CONFIG=<span style="color:#7030a0">'''${UC}'''</span> </code> <code>DISTRO=fsl-imx-xwayland </code><code>source imx-setup-release.sh -b <span style="color:#7030a0">'''${BDIR}'''</span></code> 
::<span style="color:#ff0000">'''Example&nbsp;: MACHINE=imx8mmrsb3730a1 UBOOT_CONFIG=2G DISTRO=fsl-imx-xwayland source imx-setup-release.sh -b 3730'''</span>   
: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 
:Perform the following command in terminal console 
::<code>$ bitbake imx-image-full</code>   
:The file, imx-image-full-<span style="color:#7030a0">'''${MC}'''</span>.wic.bz2 or VA0386 ~ latest version: imx-image-full-<span style="color:#7030a0">'''${MC}'''</span>.rootfs.sdcard, will be located in directory, ./tmp/deploy/images/<span style="color:#7030a0">'''${MC}'''</span>, while building process finished successfully. 

=== <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</code>   
:The below installer will be located in the directory "./tmp/deploy/sdk". 
::<tt>fsl-imx-xwayland-glibc-x86_64-meta-toolchain-aarch64-toolchain-<span style="color:#7030a0">'''${KERNEL}'''</span>-zeus.sh</tt>   

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

:To create/continue a build environment 
:Perform the following command in terminal console 
::<code>$ bitbake imx-boot</code>   

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

:To create/continue a build environment 
:If you operate on docker images, please install tmux application before running this command 
::
:::<code>$ sudo apt-get install tmux</code>     
:Type following command to enter tmux 
::
:::<code>$ tmux</code>     
:Perform the following command in terminal console to show up menuconfig 
::
:::<code>$ bitbake linux-imx -c menuconfig</code>     
:After edit menuconfig, type following command to exit tmux windows 
::
:::<code>$ exit</code>     
:to build kernel image 
::
:::<code>$ bitbake linux-imx</code>     
:The two files, Image & Image-<span style="color:#7030a0">'''${IMX8PROC}'''</span>-<span style="color:#7030a0">'''${BOARD}'''</span>-<span style="color:#7030a0">'''${BOARD'''</span>'''<span style="color:#7030a0">_REV</span><span style="color:#7030a0">}</span>'''.dtb, will be located in the directory, ./tmp/deploy/images/<span style="color:#7030a0">'''${MC}'''</span>. 

== <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">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>$ sudo bzcat <span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span> | sudo dd of=<span style="color:#7030a0">'''${SD_DEVICE}'''</span> bs=1M </code> (VA0033 ~ VA0362) 
::<code>$ sudo cat <span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span> | sudo dd of=<span style="color:#7030a0">'''${SD_DEVICE}'''</span> bs=1M </code> (VA0386 ~ latest version) 
::<code>$ sync</code> 
::<code>$ popd</code> 
::<code>Note&nbsp;: ues the .sccard file.</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 

== <span style="color:#0070c0">One step build image</span> ==

Our machine must be pre-installed docker

Download the following script can quickly build our image.

 $ wget [https://raw.githubusercontent.com/ADVANTECH-Corp/RISC_tools_scripts/zeus/imx8/adv_imx8_build.sh https://raw.githubusercontent.com/ADVANTECH-Corp/RISC_tools_scripts/zeus/imx8/adv_imx8_build.sh]
 $ sudo chmod a+x adv_imx8_build.sh

Build image

 $ sudo ./adv_imx8_build.sh ${BOARD}
 $ sudo ./adv_imx8_build.sh rom5720

Our image will be in workspace folder.

 workspace/${BDIR}/tmp/deploy/images/${MC}

Then refer to [http://ess-wiki.advantech.com.tw/view/IoTGateway/BSP/Linux/iMX8/Yocto_LBVA_User_Guide#Creating_boot-up_on-board_flash_from_built_sdcard_image Creating_boot-up_on-board_flash_from_built_sdcard_image] to build SD card.

= 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/meta-fsl-imx/recipes-fsl/images</code>   
:Add following line to fsl-image-adv.inc 
::<code>IMAGE_INSTALL += " tcf-agent openssh-sftp-server "</code>   
:[[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_User_Guide#To_continue_an_exist_build_environment|Continue an exist build environment]] and [[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_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>   

*Method 1(Suggest): Add following one line to local.conf 

 CORE_IMAGE_EXTRA_INSTALL += "chromium-ozone-wayland"

*Method 2: 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),"''

:[[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_User_Guide#To_continue_an_exist_build_environment|Continue an exist build environment]] and [[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_User_Guide#To_build_sdcard_image|build sdcard image]] 

&nbsp;

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

:Put the following in <span style="color:#7030a0">'''${BSP_HOME}'''</span>/<span style="color:#7030a0">'''${BDIR'''</span>'''<span style="color:#7030a0">}</span>'''/conf/local.conf 

:
::<code>IMAGE_INSTALL_append += "packagegroup-qt5-webengine"</code>   

:[[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_User_Guide#To_continue_an_exist_build_environment|Continue an exist build environment]] and [[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_User_Guide#To_build_sdcard_image|build sdcard image]] 

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

:Please follow the section,[[IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_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-xwayland-glibc-x86_64-meta-toolchain-aarch64-toolchain-5.4-zeus.sh</code>   
: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">Build U-Boot in standalone environment</span> ==

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

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

eg.

 make imx8mm_rom5721a1_2G_defconfig

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

 make -j4

== <span style="color:#0070c0">Build imx-boot image by using imx-mkimage</span> ==

Get imx-boot tarball from our server Here we take rom5721 as an example:

 tar zxvf 5721A1AIM20LIVA0118_iMX8MM_imx-boot.tgz 
 cd 5721A1AIM20LIVA0118_iMX8MM_imx-boot/ 

In this folder , we have two script as below: Copy necessary files to imx-mkimage folder

 ./cp_uboot.sh ${uboot path} ${IMX8PROC}

Make imx-boot image

 ./mk_imx-boot.sh ${IMX8PROC}

eg.

 ./cp_uboot.sh ../uboot-imx6 '''imx8m'''
 ./mk_imx-boot.sh '''imx8mm'''

==== <span style="color:#0070c0">Replace imx-boot</span> ====

: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.Mx 8QuadXPlus A0, i.MX 8M Quad, and i.MX 8M Mini 
::32 - for iMX 8M PLUS, i.MAX 8QuadXPlus B0/C0 and i.Mx 8QuadMax B0 
::&nbsp;   

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

:The cross compiling environment has been set up. (ref. [[#Setting_up_cross_compiling_environment|Setting up cross compiling environment]]) 

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

Refer to [http://ess-wiki.advantech.com.tw/view/IoTGateway/BSP/Linux/iMX8/Yocto_LBV9_User_Guide#Copy_BSP_tarball_to_Container Copy_BSP_tarball_to_Container] , <span style="color:#ff0000">copy kernel tarball </span>to ${WORKSPACE} and back to container

change owner & unpack tarball

 $ sudo chown adv:adv imx8LBVA0029_2019-10-23_linux-imx.tgz
 $ tar zxvf imx8LBVA0029_2019-10-23_linux-imx.tgz

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

:Configure linux kernel 

 $ cd linux-imx
 $ make distclean
 $ make imx_v8_adv_defconfig
 $ make menuconfig

:Start building linux kernel 

 $ make -j4 Image

:When you get error like below 

[[File:Imx8 error.jpg|RTENOTITLE]]

:run command then rebuild 

 $ unset LDFLAGS 

&nbsp;

:The kernel image file, Image, is located in the directory "./arch/arm64/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 freescale/<span style="color:#7030a0">'''${IMX8PROC}'''</span>-<span style="color:#7030a0">'''${BOARD}'''</span>-<span style="color:#7030a0">'''${BOARD_REV}'''</span>.dtb
 eg.
 $ make -j4 freescale/imx8mq-rom5720-a1.dtb

:The device tree blob, <span style="color:#7030a0">'''${IMX8PROC}'''</span>-<span style="color:#7030a0">'''${BOARD}'''</span>-<span style="color:#7030a0">'''${BOARD_REV}'''</span>.dtb, is located in the directory "./arch/arm64/boot/dts/freescale/". 

=== <span style="color:#0070c0">Replace kernel & dts</span> ===

:Replace kernel 
::copy Image to SDcard or emmc   
:Replace dtb file 
::copy dtb file to SDcard or emmc   

== <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 ${jh_clk} console=${console} modprobe.blacklist=${modprobe.blacklist} root=${mmcroot} video=HDMI-A-1:${videores} '''quiet'''
 env save
 reset

Or

:Disable debug port 

(1) Yocto machine setting:

modify /sources/meta-advantech/meta-fsl-imx/conf/machine$/${MC}.conf

 SERIAL_CONSOLES = ";"

(2) Uboot parameter setting:

*For the imx8mq, imx8mm, imx8mp: 

 setenv console disabled
 env save
 reset

*For the imx8qm, imx8qxp: 

 setenv console disabled
 setenv earlycon disabled
 setenv mmcargs setenv bootargs console=${console},${baudrate} earlycon=${earlycon},${baudrate} root=${mmcroot}
 env save
 reset

*Rootfs 

:TBD 

*Services 

1. Using '''systemctl disable ''' remove ,we can remove unnecessary services.

 systemctl disable <services>

eg.

 systemctl disable boottimes

= System Recovery =

This section provides detail procedures of restoring the eMMC image.

If you destroy the onboard flash image by accident, you can recover a system following these steps.

*Recovery by SD card 

1.Copy 5720A1AIM20LIVA0022_iMX8M_flash_tool.tgz package to your desktop.

2.Insert SD card to PC

3.Make a bootable sd card

 # tar zxvf 5720A1AIM20LIVA0022_iMX8M_2G_flash_tool.tgz
 # cd 5720A1AIM20LIVA0022_iMX8M_2G_flash_tool/mk_inand/
 # sudo ./mksd-linux.sh /dev/sdg

4.Insert SD card and copy 5720A1AIM20LIVA0022_iMX8M_flash_tool to USB disk

5.Insert USB disk and SD card then Boot from SD

6.Enter usb disk folder, make a bootable emmc

 # cd /run/media/sda1/
 # cd 5720A1AIM20LIVA0022_iMX8M_2G_flash_tool/mk_inand/
 # sudo ./mksd-linux.sh /dev/mmcblk0

&nbsp;

*Recovery by UUU tool 

1.Download uuu tool from ([https://github.com/ADVANTECH-Corp/uuu/releases/tag/v20210429 https://github.com/ADVANTECH-Corp/uuu/releases/tag/v20210429])

2.burn command

*For Linux 

  sudo ./uuu

*For Windows 

  uuu.exe 

2.Create a folder with files as below:

 1.uuu
 2.imx-boot-imx8mqrom5720a1-sd.bin-flash_evk
 3.fsl-image-validation-imx-imx8mqrom5720a1-20190917152605.rootfs.sdcard
 4.Image_dtb.uuu
 5.rootfs.uuu

3.Connect otg cable from PC to device

4.Set the correct boot mode(ROM-5722/ROM5720/ROM5721/ROM5620: 1,2,3-off 4-on, ROM7720: 1,2,3,4,5,6-off or 1,2,4,5,6-off 3-on), then power on

5.Perform the following command:

'''PS.If you want to burn uboot to mmcblk0 instead of mmcblk0boot0, u-boot must be updated to version 20191101,'''

 1.Burn uboot to emmc
    a)replace uboot in mmcblk0boot0
        sudo ./uuu -b '''emmc''' imx-boot-imx8mqrom5720a1-sd.bin-flash_evk
    b)replace uboot in mmcblk0
        sudo ./uuu -b '''emmc_adv''' imx-boot-imx8mqrom5720a1-sd.bin-flash_evk
 2.Burn rootfs image to emmc
    a)replace uboot in mmcblk0boot0
        sudo ./uuu -b '''emmc_all''' imx-boot-imx8mqrom5720a1-sd.bin-flash_evk fsl-image-validation-imx-imx8mqrom5720a1-20190917152605.rootfs.sdcard
    b)replace uboot in mmcblk0
        sudo ./uuu -b '''emmc_all_adv''' imx-boot-imx8mqrom5720a1-sd.bin-flash_evk fsl-image-validation-imx-imx8mqrom5720a1-20190917152605.rootfs.sdcard

6.uuu tool will start recovery image to emmc.

7.If we want to burn separately into emmc

    a)replace Image and dtb
        Step 1: rename Image and dtb 
                  _Image
                  _board.dtb
        Step 2: 
                  sudo ./uuu Image_dtb.uuu
    b)replace rootfs
        Step 1: rename rootfs tarball
                  _rootfs.tar.bz2
        Step 2: 
                  sudo ./uuu rootfs.uuu

8.For more usage ([https://github.com/NXPmicro/mfgtools/wiki https://github.com/NXPmicro/mfgtools/wiki])

&nbsp;

= Package List =

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

 bitbake -g imx-image-full && cat task-depends.dot | grep -v -e '-native' | grep -v digraph | grep -v -e '-image' | awk '{print $1}' | sort | uniq

:[[:File:20191025.txt|20191025 Package List]] 

Show all recipes (include non-installed packages)

 bitbake -s

:[[:File:package_version_20191025.txt|20191025 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-validation-imx-<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:rpm_board_20191025.txt|20191025 RPM on Board List]] 

= Device Tree Source file select =

We can setup different dts file on bootloader to enable different devices.

eg.

 setenv fdt_file '''adv-imx8mm-rom5721-a1-dsi2dp'''.dtb
 env save
 boot 

== RSB-3730 ==

*Display 
**LVDS 
***g070vw01 
****imx8mm-rsb3730-a2-dsi2lvds-800x480.dtb   
***g215hv01 
****imx8mm-rsb3730-a2-dsi2lvds-1920x1080.dtb     
**DSI 
***g101uan2.0 
****imx8mm-rsb3730-a2-dsi-auog101uan02.dtb       

= Burn-in Test =

= About bottom board setting =

== The disable pin of PCIE ==

You should config disable pin follow your bottom board.
<syntaxhighlight lang="c">
&pcie0{
        pinctrl-names = "default";
        pinctrl-0 = <&pinctrl_pcie0>;
        //disable-gpio = <&tca9538 0 GPIO_ACTIVE_LOW>; <---
        reset-gpio = <&gpio1 13 GPIO_ACTIVE_LOW>;
        ext_osc = <1>;
        status = "okay";
};
</syntaxhighlight>

== Fix no sound issue probability when the HDMI plug in/out ==

You can use the following patch to fix this issue:

[http://ess-wiki.advantech.com.tw/wiki/images/5/59/0001-imx865-hdmi-enable-overflow-workaround-for-imx865-hd.patch [0001-imx865-hdmi-enable-overflow-workaround-for-imx865-hd.patch]]

&nbsp;
<syntaxhighlight lang="c">
From 9ca13642ff1367cb32c15f82d2c077f2f7c0e8f1 Mon Sep 17 00:00:00 2001
From: Sandor Yu <Sandor.yu@nxp.com>
Date: Mon, 25 Oct 2021 16:13:37 +0800
Subject: [PATCH] imx865: hdmi: enable overflow workaround for imx865 hdmi

Signed-off-by: Sandor Yu <Sandor.yu@nxp.com>
---
 drivers/gpu/drm/bridge/synopsys/dw-hdmi.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/bridge/synopsys/dw-hdmi.c b/drivers/gpu/drm/bridge/synopsys/dw-hdmi.c
index b48cdaa493b7..b53e2efed3bf 100644
--- a/drivers/gpu/drm/bridge/synopsys/dw-hdmi.c
+++ b/drivers/gpu/drm/bridge/synopsys/dw-hdmi.c
@@ -2220,6 +2220,7 @@ static void dw_hdmi_clear_overflow(struct dw_hdmi *hdmi)
 	case 0x201a:
 	case 0x211a:
 	case 0x212a:
+	case 0x213a:
 		count = 1;
 		break;
 	default:
-- 
2.17.1
</syntaxhighlight>

= How to get the MAC, Serial Number, and Manufacture Date in the QSPI flash =

MAC 0:
<syntaxhighlight lang="c">
READ_DATA=`dd if=/dev/mtdblock0 bs=1 skip=$((0xd0000)) count=6 2> /dev/null | hexdump -e '16/1 "%02x " "\n"' | sed 's/ /:/g' | cut -c 1-17`
echo $READ_DATA
</syntaxhighlight>

MAC 1:
<syntaxhighlight lang="c">
READ_DATA=`dd if=/dev/mtdblock0 bs=1 skip=$((0xd0400)) count=6 2> /dev/null | hexdump -e '16/1 "%02x " "\n"' | sed 's/ /:/g' | cut -c 1-17`
echo $READ_DATA
</syntaxhighlight>

Serial Number:
<syntaxhighlight lang="c">
READ_DATA=`dd if=/dev/mtdblock0 bs=1 skip=$((0xd0006)) count=10 2> /dev/null | cut -c 1-10`
echo $READ_DATA
</syntaxhighlight>

Manufacture Date:
<syntaxhighlight lang="c">
READ_DATA=`dd if=/dev/mtdblock0 bs=1 skip=$((0xd0010)) count=14 2> /dev/null | cut -c 1-14`
READ_DATA=`echo $READ_DATA | cut -c 1-4`-`echo $READ_DATA | cut -c 5-6`-`echo $READ_DATA | cut -c 7-8`_`echo $READ_DATA | cut -c 9-10`-`echo $READ_DATA | cut -c 11-12`-`echo $READ_DATA | cut -c 13-14`
echo $READ_DATA</syntaxhighlight>