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

From ESS-WIKI
Jump to: navigation, search
(Created page with "= Yocto Linux BSP Ver.8 User Guide for iMX6 series =")
 
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Yocto Linux BSP Ver.8 User Guide for iMX6 series =
+
{{DISPLAYTITLE:Yocto Linux BSP Ver.9 User Guide for iMX6 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. imx6LBV90019)
 +
 
 +
<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_wayland)
 +
 
 +
<span style="color:purple">'''${MX6PROC}'''</span>&nbsp;: i.MX6 Processor
 +
 
 +
:mx6q for iMX6 Quad Core / Dual Core
 +
:mx6dl for iMX6 Dual Lite / Solo
 +
 
 +
<span style="color:purple">'''${IMX6PROC}'''</span>&nbsp;: i.MX6 Processor
 +
 
 +
:imx6q / imx6dl
 +
 
 +
<span style="color:purple">'''${BOARD}'''</span>&nbsp;: available target boards list below
 +
 
 +
:rom5420/ / rom7421 / ubc220 / rom3420 / rom7420 / rsb4410 / rsb4411 / rsb6410 / ubcds31 / wise3310
 +
 
 +
<span style="color:purple">'''${BOARD_REV}'''</span>&nbsp;: board revision
 +
 
 +
:a1 / a2 / b1
 +
 
 +
<span style="color:purple">'''${MC}'''</span>&nbsp;: machine code combined with <span style="color:purple">'''${IMX6PROC}${BOARD}${BOARD_REV}'''</span>
 +
 
 +
:for example,
 +
 
 +
::<tt>imx6dlrom5420b1 for ROM-5420 B1 Solo</tt>
 +
::<tt>imx6dlrom7421a1 for ROM-7421 A1 Solo</tt>
 +
::<tt>imx6dlrsb3430a1 for RSB-3430 A1 Dual-Lite</tt>
 +
::<tt>imx6dlubc220a1 for UBC-220 A1 Dual-Lite</tt>
 +
::<tt>imx6qprom7421a1 for ROM-7421 A1 Dual/Quad-Plus</tt>
 +
::<tt>imx6qrom3420a1 for ROM-3420 A1 Dual/Quad</tt>
 +
::<tt>imx6qrom5420a1 for ROM-5420 A1 Dual/Quad</tt>
 +
::<tt>imx6qrom5420b1 for ROM-5420 B1 Dual/Quad</tt>
 +
::<tt>imx6qrom7420a1 for ROM-7420 A1 Dual/Quad</tt>
 +
::<tt>imx6qrsb3430a1 for RSB-3430 A1 Dual/Quad</tt>
 +
::<tt>imx6qrsb4410a1 for RSB-4410 A1 Dual</tt>
 +
::<tt>imx6qrsb4410a2 for RSB-4410 A2 Dual</tt><br/>
 +
::<tt>imx6qrsb4411a1 for RSB-4411 A1 Dual/Quad</tt><br/>
 +
::<tt>imx6qrsb6410a1 for RSB-6410 A1 Dual/Quad</tt>
 +
::<tt>imx6qrsb6410a2 for RSB-6410 A2 Dual/Quad</tt>
 +
::<tt>imx6qubcds31a1 for UBC-DS31 A1 Dual</tt>
 +
::<tt>imx6qwise3310a1 for WISE-3310 A1 Dual</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
 +
 
 +
:1G / 2G / 512M
 +
 
 +
<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. 2018.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-wayland/4.14-sumo)
 +
 
 +
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 imx6LBV90019&nbsp;-it advrisc/u16.04-imx8lbv1 /bin/bash</code><br/>
 +
 
 +
=== To copy BSP from local filesystem to the container ===
 +
 
 +
:<code>$ docker cp '''${BSP_PACK}''' imx6LBV90019:/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
 +
 
 +
=== <span style="color:#0070c0">Download BSP From GitHub</span> ===
 +
 
 +
: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_Yocto_2.5|IoTGateway/BSP/Linux/iMX6/OS_Support_List_Yocto_2.5]] , Official version "'''imx6LBV90019"&nbsp;'''is taken as&nbsp;an example&nbsp;:<br/>
 +
 
 +
$ 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 git://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git] -b '''refs/tags/imx6LBV90019''' -m '''imx6LBV90019'''.xml
 +
$ repo sync
 +
 
 +
: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.98-2.0.0_ga.xml</span>
 +
$ repo sync
 +
 
 +
=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===
 +
 
 +
TBD
 +
 
 +
== <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.MX6, 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: imx6LBV90006_2019-07-06.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;"V90006" stands for <span style="color:#ff0000">'''V'''</span>ersion <font color="#ff0000">'''9'''</font>.<span style="color:#ff0000">'''0006'''</span>
 +
 
 +
:For example, '''Yocto image name: 7421A1LIV90006_DualPlus_2019-07-06.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: 3420A1LIV90008_DualQuad_2019-07-08.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: U220A1LIV90009_DualLiteSolo_2019-07-09.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-xwayland </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-validation-imx</code><br/>
 +
:The file, <code>fsl-image-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-wayland-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> ===
 +
 
 +
:To create/continue a build environment
 +
:Perform the following command in terminal console
 +
::<code>$ bitbake u-boot-imx</code>
 +
:The two files, u-boot_crc.bin & u-boot_crc.bin.crc, will be located in the directory, ./tmp/deploy/images/<span style="color:#7030a0">'''${MC}'''</span>
 +
 
 +
=== <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, zImage & zImage-<span style="color:#7030a0">'''${IMX6PROC}'''</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">To modify source code and rebuild linux kernel</span> ===
 +
 
 +
TBD
 +
 
 +
== <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> ===
 +
 
 +
TBD
 +
 
 +
== <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> ==
 +
 
 +
TBD
 +
 
 +
== <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-</code><tt>wayland</tt><code>-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-cortexa9hf-neon-poky-linux-gnueabi</code>
 +
 
 +
== <span style="color:#0070c0">Building & updating u-boot manually</span> ==
 +
 
 +
:The cross compiling environment has been set up. (ref. [[#Setting_up_cross_compiling_environment|Setting up cross compiling environment]])
 +
 
 +
:You have two methods to put BSP into container created above
 +
 
 +
=== <span style="color:#0070c0">Download BSP From GitHub</span> ===
 +
 
 +
:The following example shows how to download the Advantech Yocto BSP from GitHub.
 +
 
 +
$ git clone [https://github.com/ADVANTECH-Corp/uboot-imx6.git 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
 +
 
 +
=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===
 +
 
 +
TBD
 +
 
 +
=== <span style="color:#0070c0">Config u-boot</span> ===
 +
 
 +
$make '''${MX6PROC}${BOARD}${BOARD_REV}'''_'''${MEM_SIZE}'''_defconfig
 +
 
 +
eg.
 +
 
 +
$make mx6qrom7420a1_1G_defconfig
 +
 
 +
=== <span style="color:#0070c0">Build u-boot</span> ===
 +
 
 +
$make -j4
 +
 
 +
=== <span style="color:#0070c0">Replace u-boot</span> ===
 +
 
 +
:Perform the following command to transfer to exist boot-up SD card
 +
 
 +
$ dd if=u-boot_crc.bin.crc of='''${SD_DEVICE}''' bs=512 seek=2 conv=fsync
 +
$ dd if=u-boot_crc.bin of='''${SD_DEVICE}''' bs=512 seek=3 conv=fsync
 +
 
 +
:Perform the following command to transfer to on-board flash
 +
 
 +
$ dd if=u-boot_crc.bin.crc of=/dev/mmcblk0 bs=512 seek=2 conv=fsync
 +
$ dd if=u-boot_crc.bin of=/dev/mmcblk0 bs=512 seek=3 conv=fsync
 +
 
 +
== <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]])
 +
 
 +
:You have two methods to put BSP into container created above
 +
 
 +
=== <span style="color:#0070c0">Download BSP From GitHub</span> ===
 +
 
 +
:The following example shows how to download the Advantech Yocto BSP from GitHub.
 +
 
 +
$ git clone [https://github.com/ADVANTECH-Corp/uboot-imx6.git https://github.com/ADVANTECH-Corp/linux-imx6.git]
 +
$ cd linux-imx6
 +
$ git checkout -t remotes/origin/imx_4.14.98_2.0.0_ga
 +
 
 +
=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===
 +
 
 +
TBD
 +
 
 +
=== <span style="color:#0070c0">Config kernel</span> ===
 +
 
 +
:Configure linux kernel
 +
 
 +
$make distclean
 +
$make imx_v7_adv_defconfig
 +
$make menuconfig
 +
 
 +
If you get error ,when you "make imx_v7_adv_defconfig" , you need to insatall "libncurses*"
 +
 
 +
$apt-get install libncurses*
 +
 
 +
[[File:Error.JPG|imx_v7_adv_defconfig_error]]
 +
 
 +
=== <span style="color:#0070c0">Build kernel</span> ===
 +
 
 +
: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 <span style="color:#7030a0">'''${IMX6PROC}'''</span>-<span style="color:#7030a0">'''${BOARD}'''</span>-<span style="color:#7030a0">'''${BOARD_REV}'''</span>.dtb
 +
 
 +
:The device tree blob, <span style="color:#7030a0">'''${IMX6PROC}'''</span>-<span style="color:#7030a0">'''${BOARD}'''</span>-<span style="color:#7030a0">'''${BOARD_REV}'''</span>.dtb, is located in the directory "./arch/arm/boot/dts/".
 +
 
 +
=== <span style="color:#0070c0">Replace kernel & dts</span> ===
 +
 
 +
:Replace kernel
 +
::copy zImage to SDcard or emmc
 +
:Replace dtb file
 +
::copy dtb file to SDcard or emmc
 +
 
 +
== <span style="color:#0070c0">Improve boot speed</span> ==
 +
 
 +
​TBD
 +
 
 +
= System Recovery =
 +
 
 +
TBD
 +
 
 +
= Package List =
 +
 
 +
TBD

Latest revision as of 05:25, 5 September 2019


Contents

Getting Started

Conventions

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

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

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

${BSP_HOME} : home directory of the BSP

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

${MX6PROC} : i.MX6 Processor

mx6q for iMX6 Quad Core / Dual Core
mx6dl for iMX6 Dual Lite / Solo

${IMX6PROC} : i.MX6 Processor

imx6q / imx6dl

${BOARD} : available target boards list below

rom5420/ / rom7421 / ubc220 / rom3420 / rom7420 / rsb4410 / rsb4411 / rsb6410 / ubcds31 / wise3310

${BOARD_REV} : board revision

a1 / a2 / b1

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

for example,
imx6dlrom5420b1 for ROM-5420 B1 Solo
imx6dlrom7421a1 for ROM-7421 A1 Solo
imx6dlrsb3430a1 for RSB-3430 A1 Dual-Lite
imx6dlubc220a1 for UBC-220 A1 Dual-Lite
imx6qprom7421a1 for ROM-7421 A1 Dual/Quad-Plus
imx6qrom3420a1 for ROM-3420 A1 Dual/Quad
imx6qrom5420a1 for ROM-5420 A1 Dual/Quad
imx6qrom5420b1 for ROM-5420 B1 Dual/Quad
imx6qrom7420a1 for ROM-7420 A1 Dual/Quad
imx6qrsb3430a1 for RSB-3430 A1 Dual/Quad
imx6qrsb4410a1 for RSB-4410 A1 Dual
imx6qrsb4410a2 for RSB-4410 A2 Dual
imx6qrsb4411a1 for RSB-4411 A1 Dual/Quad
imx6qrsb6410a1 for RSB-6410 A1 Dual/Quad
imx6qrsb6410a2 for RSB-6410 A2 Dual/Quad
imx6qubcds31a1 for UBC-DS31 A1 Dual
imx6qwise3310a1 for WISE-3310 A1 Dual
You can also use the command below to check supported machines on BSP
$ source setup-environment

${MEM_SIZE} : memory size

1G / 2G / 512M

${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. 2018.03)

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

${TOOLCHAIN} : toolchain installed directory(e.g. /opt/fsl-imx-wayland/4.14-sumo)

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 imx6LBV90019 -it advrisc/u16.04-imx8lbv1 /bin/bash

To copy BSP from local filesystem to the container

$ docker cp ${BSP_PACK} imx6LBV90019:/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/iMX6/OS_Support_List_Yocto_2.5 , Official version "imx6LBV90019" 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/imx6LBV90019 -m imx6LBV90019.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

TBD

Downloads tarball

TBD

Introducing BSP

The BSP is based on Yocto Project with Freescale enhanced features for i.MX6, 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: imx6LBV90006_2019-07-06.tgz
which , "LB" is acronym of Linux BSP,
           "V90006" stands for Version 9.0006
For example, Yocto image name: 7421A1LIV90006_DualPlus_2019-07-06.img.gz
which "7421A1" stands for ROM-7421 A1
          "LI" is acronym for prebuilt Linux Image,
          "DualPlus" means this image is fit for Dual Plus Core/Quad Plus Core.
For example, Yocto image name: 3420A1LIV90008_DualQuad_2019-07-08.img.gz
which "3420A1" stands for ROM-3420 A1
          "LI" is acronym for prebuilt Linux Image,
          "DualQuad" means this image is fit for Dual Core/Quad Core.
For example, Yocto image name: U220A1LIV90009_DualLiteSolo_2019-07-09.img.gz
which "U220A1" stands for UBC-220 A1
          "LI" is acronym for prebuilt Linux Image,
          "DualLiteSolo" means this image is fit for Dual Lite Core/Solo Core.

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-validation-imx
The file, fsl-image-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-qt5
The below installer will be located in the directory "./tmp/deploy/sdk".
fsl-imx-wayland-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 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-${IMX6PROC}-${BOARD}-${BOARD_REV}.dtb, will be located in the directory, ./tmp/deploy/images/${MC}.

To modify source code and rebuild linux kernel

TBD

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

TBD

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

TBD

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-wayland-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-cortexa9hf-neon-poky-linux-gnueabi

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 ${MX6PROC}${BOARD}${BOARD_REV}_${MEM_SIZE}_defconfig

eg.

$make mx6qrom7420a1_1G_defconfig

Build u-boot

$make -j4

Replace u-boot

Perform the following command to transfer to exist boot-up SD card
$ dd if=u-boot_crc.bin.crc of=${SD_DEVICE} bs=512 seek=2 conv=fsync
$ dd if=u-boot_crc.bin of=${SD_DEVICE} bs=512 seek=3 conv=fsync
Perform the following command to transfer to on-board flash
$ dd if=u-boot_crc.bin.crc of=/dev/mmcblk0 bs=512 seek=2 conv=fsync
$ dd if=u-boot_crc.bin of=/dev/mmcblk0 bs=512 seek=3 conv=fsync

Building & updating kernel/modules/dtb 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/linux-imx6.git
$ cd linux-imx6
$ git checkout -t remotes/origin/imx_4.14.98_2.0.0_ga

Copy BSP tarball to Container

TBD

Config kernel

Configure linux kernel
$make distclean
$make imx_v7_adv_defconfig
$make menuconfig

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

$apt-get install libncurses*

imx_v7_adv_defconfig_error

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 ${IMX6PROC}-${BOARD}-${BOARD_REV}.dtb
The device tree blob, ${IMX6PROC}-${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

Improve boot speed

​TBD

System Recovery

TBD

Package List

TBD