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

From ESS-WIKI
Jump to: navigation, search
(Add a chapter about getting BSP)
Line 6: Line 6:
 
-->
 
-->
  
=Getting Started=
+
= Getting Started =
==<span style="color:#0070c0;">Conventions</span>==
 
<span style="color:purple">'''${PREBUILT_IMAGE}'''</span> : compressed prebuilt image (*.img.gz)
 
  
<span style="color:purple">'''${BSP_TARBALL}'''</span> : BSP tarball (*.tgz)
+
== <span style="color:#0070c0;">Conventions</span> ==
  
<span style="color:purple">'''${BSP_HOME}'''</span> : home directory of the BSP
+
<span style="color:purple">'''${PREBUILT_IMAGE}'''</span>&nbsp;: compressed prebuilt image (*.img.gz)
  
<span style="color:purple">'''${BDIR}'''</span> : build directory (e.g. build_x11)
+
<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">'''${MX6PROC}'''</span>&nbsp;: i.MX6 Processor
  
<span style="color:purple">'''${MX6PROC}'''</span> : i.MX6 Processor
 
 
:mx6q for iMX6 Quad Core / Dual Core
 
:mx6q for iMX6 Quad Core / Dual Core
 
:mx6dl for iMX6 Dual Lite / Solo
 
:mx6dl for iMX6 Dual Lite / Solo
  
<span style="color:purple">'''${IMX6PROC}'''</span> : i.MX6 Processor
+
<span style="color:purple">'''${IMX6PROC}'''</span>&nbsp;: i.MX6 Processor
 +
 
 
:imx6q / imx6dl
 
:imx6q / imx6dl
  
<span style="color:purple">'''${BOARD}'''</span> : available target boards list below
+
<span style="color:purple">'''${BOARD}'''</span>&nbsp;: available target boards list below
 +
 
 
:ubc220 / rom3420 / rom5420 / rom7420 / rsb4410 / ubcds31
 
:ubc220 / rom3420 / rom5420 / rom7420 / rsb4410 / ubcds31
  
<span style="color:purple">'''${BOARD_REV}'''</span> : board revision
+
<span style="color:purple">'''${BOARD_REV}'''</span>&nbsp;: board revision
:a1 / a2 / b1  
+
 
 +
:a1 / a2 / b1
 +
 
 +
<span style="color:purple">'''${MC}'''</span>&nbsp;: machine code combined with <span style="color:purple">'''${IMX6PROC}${BOARD}${BOARD_REV}'''</span>
  
<span style="color:purple">'''${MC}'''</span> : machine code combined with <span style="color:purple">'''${IMX6PROC}${BOARD}${BOARD_REV}'''</span>
 
 
:for example,
 
:for example,
<tt>
 
::imx6dlubc220a1 for UBC-220 A1
 
::imx6qrom3420a1 for ROM-3420 A1
 
::imx6qrom5420b1 for ROM-5420 B1
 
::imx6qrsb4410a2 for RSB-4410 A2
 
</tt>
 
  
<span style="color:purple">'''${MEM_SIZE}'''</span> : memory size
+
 
 +
 
 +
::<tt>imx6dlubc220a1 for UBC-220 A1</tt>
 +
::<tt>imx6qrom3420a1 for ROM-3420 A1</tt>
 +
::<tt>imx6qrom5420b1 for ROM-5420 B1</tt>
 +
::<tt>imx6qrsb4410a2 for RSB-4410 A2</tt>
 +
 
 +
 
 +
 
 +
<span style="color:purple">'''${MEM_SIZE}'''</span>&nbsp;: memory size
 +
 
 
:1G / 2G / 512M
 
:1G / 2G / 512M
  
<span style="color:purple">'''${SD_DEVICE}'''</span> : device name of SD card in Linux (e.g. /dev/sdf)
+
<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> : sdcard image built by bitbake (*.sdcard)
+
<span style="color:purple">'''${SDCARD_IMAGE}'''</span>&nbsp;: sdcard image built by bitbake (*.sdcard)
  
<span style="color:purple">'''${UBOOT}'''</span> :u-boot version(e.g. 2015.04)
+
<span style="color:purple">'''${UBOOT}'''</span>&nbsp;:u-boot version(e.g. 2015.04)
  
<span style="color:purple">'''${KERNEL}'''</span> : linux kernel version(e.g. 4.1.15)
+
<span style="color:purple">'''${KERNEL}'''</span>&nbsp;: linux kernel version(e.g. 4.1.15)
  
<span style="color:purple">'''${TOOLCHAIN}'''</span> : toolchain installed directory(e.g. /opt/fsl-imx-x11/4.1.15-1.1.0)
+
<span style="color:purple">'''${TOOLCHAIN}'''</span>&nbsp;: toolchain installed directory(e.g. /opt/fsl-imx-x11/4.1.15-1.1.0)
  
 
debug console / serial console
 
debug console / serial console
 +
 
:serial terminal program (e.g. minicom, putty, teraterm ...) that serial port is configured to 115200 8N1
 
:serial terminal program (e.g. minicom, putty, teraterm ...) that serial port is configured to 115200 8N1
  
 
terminal console
 
terminal console
 +
 
:terminal program (e.g. gnome-terminal, xfce4-terminal ...)
 
:terminal program (e.g. gnome-terminal, xfce4-terminal ...)
  
==<span style="color:#0070c0;">Prerequisites</span>==
+
== <span style="color:#0070c0;">Prerequisites</span> ==
===<span style="color:#0070c0;">To install Docker Engine on your platform</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
 
: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 12.04 image from Docker Hub] & run the image</span>===
+
=== <span style="color:#0070c0;">To pull [https://hub.docker.com/r/advrisc/u12.04-imx6lbv3/ ubuntu 12.04 image from Docker Hub] & run the image</span> ===
 +
 
 
:<code>$ docker pull advrisc/u12.04-imx6lbv3</code>
 
:<code>$ docker pull advrisc/u12.04-imx6lbv3</code>
:<code>$ docker run --privileged --name imx6LBV7000 -it -v <span style="color:purple">'''${SD_DEVICE}'''</span>:<span style="color:purple">'''${SD_DEVICE}'''</span> advrisc/u12.04-imx6lbv3 /bin/bash</code>
+
:<code>$ docker run --privileged --name imx6LBV7000 -it -v <span style="color:purple">'''${SD_DEVICE}'''</span>:<span style="color:purple">'''${SD_DEVICE}'''</span> advrisc/u12.04-imx6lbv3 /bin/bash</code>
  
===<span style="color:#0070c0;">To copy BSP from local filesystem to the container</span>===
+
=== <span style="color:#0070c0;">To copy BSP from local filesystem to the container</span> ===
:<code> $ docker cp <span style="color:purple">'''${BSP_PACK}'''</span> imx6LBV7000:/home/adv/</code>
+
 
 +
:<code>$ docker cp <span style="color:purple">'''${BSP_PACK}'''</span> imx6LBV7000:/home/adv/</code>
 +
 
 +
=== <span style="color:#0070c0;">To copy files from the container's filesystem to local machine</span> ===
  
===<span style="color:#0070c0;">To copy files from the container's filesystem to local machine</span>===
 
 
:<code>$ docker cp imx6LBV7000:/home/adv/<span style="color:#7030a0;">'''${BSP_HOME}'''</span>/yocto_build/tmp/deploy/images/<span style="color:#7030a0;">'''${MC}'''</span> ~</code>
 
:<code>$ docker cp imx6LBV7000:/home/adv/<span style="color:#7030a0;">'''${BSP_HOME}'''</span>/yocto_build/tmp/deploy/images/<span style="color:#7030a0;">'''${MC}'''</span> ~</code>
  
==<span style="color:#0070c0;">Introducing BSP</span>==
+
== <span style="color:#0070c0;">Get BSP</span> ==
 +
 
 +
=== <span style="color:#0070c0;">Official Release BSP</span> ===
 +
 
 +
:You can get i.MX6 Yocto BSP from PM. For example, the 4410A1LBV7000_2016-06-23.tgz file is i.MX6 Yocto BSP file.
 +
 
 +
=== <span style="color:#0070c0;">Download BSP</span> ===
 +
 
 +
==== <span style="color:#0070c0;">Setting up the repo utility</span> ====
 +
 
 +
:Repo is a tool built on top of Git that makes it easier to manage projects that contain multiple repositories, which do not need to be on the same server. Repo complements very well the layered nature of the Yocto Project, making it easier for users to add their own layers to the BSP.
 +
:To install the “repo” utility, perform these steps:
 +
 
 +
*Create a bin folder in the home directory.
 +
 
 +
$ mkdir ~/bin (this step may not be needed if the bin folder already exists)
 +
$ curl [http://commondatastorage.googleapis.com/git-repo-downloads/repo http://commondatastorage.googleapis.com/git-repo-downloads/repo] > ~/bin/repo
 +
$ chmod a+x ~/bin/repo
 +
 
 +
*Add the following line to the .bashrc file to ensure that the ~/bin folder is in your PATH variable.
 +
 
 +
$ export PATH=~/bin:$PATH
 +
 
 +
==== <span style="color:#0070c0;">Yocto Project Setup</span> ====
 +
 
 +
: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.
 +
 
 +
:The following example shows how to download the Advantech Yocto Project Community BSP recipe layers. For this
 +
 
 +
example, a directory called adv-release-bsp is created for the project. Any name can be used instead of this.
 +
 
 +
$ mkdir adv-release-bsp
 +
$ cd adv-release-bsp
 +
$ repo init -u [https://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git https://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git] -b jethro_4.1.15-1.0.0_ga
 +
$ repo sync
 +
 
 +
== <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..
 
:The BSP is based on Yocto Project with Freescale enhanced features for i.MX6, plus specific target board features from Advantech Inc..
  
===<span style="color:#0070c0;">Naming Rule</span>===
+
=== <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.
 
:The tarball/prebuilt image name is consist of the model name followed by "LB" or "LI" plus version number and released date.
  
 
:For example, 4410A1LBV7000_2016-06-23.tgz which "4410A1" stands for RSB-<span style="color:#ff0000;">'''4410 A1'''</span>, "LB" is acronym of <span style="color:#ff0000;">'''L'''</span>inux <span style="color:#ff0000;">'''B'''</span>SP, "V7000" stands for <span style="color:#ff0000;">'''V'''</span>ersion <span style="color:#ff0000;">'''7'''</span>.<span style="color:#ff0000;">'''000'''</span><nowiki>.</nowiki>
 
:For example, 4410A1LBV7000_2016-06-23.tgz which "4410A1" stands for RSB-<span style="color:#ff0000;">'''4410 A1'''</span>, "LB" is acronym of <span style="color:#ff0000;">'''L'''</span>inux <span style="color:#ff0000;">'''B'''</span>SP, "V7000" stands for <span style="color:#ff0000;">'''V'''</span>ersion <span style="color:#ff0000;">'''7'''</span>.<span style="color:#ff0000;">'''000'''</span><nowiki>.</nowiki>
 +
 
:For example, 4410A1LIV7000_DualQuad_2016-06-23.img.gz which "LI" is acronym for prebuilt <span style="color:#ff0000;">'''L'''</span>inux <span style="color:#ff0000;">'''I'''</span>mage, DualQuad means this image is fit for Dual Core/Quad Core.
 
:For example, 4410A1LIV7000_DualQuad_2016-06-23.img.gz which "LI" is acronym for prebuilt <span style="color:#ff0000;">'''L'''</span>inux <span style="color:#ff0000;">'''I'''</span>mage, DualQuad means this image is fit for Dual Core/Quad Core.
  
===<span style="color:#0070c0;">BSP tarball</span>===
+
=== <span style="color:#0070c0;">BSP tarball</span> ===
 +
 
 
:Unpack BSP tarball to home directory by performing the following command:
 
:Unpack BSP tarball to home directory by performing the following command:
::<code>$ tar xvf <span style="color:#7030a0;">'''${BSP</span><span style="color:#7030a0;">_TARBALL</span><span style="color:#7030a0;">}'''</span> -C ~/</code>
+
::<code>$ tar xvf <span style="color:#7030a0;">'''${BSP'''</span>'''<span style="color:#7030a0;">_TARBALL</span><span style="color:#7030a0;">}</span>''' -C ~/</code>
<div style="margin-left:1.498cm;margin-right:0cm;">(Every BSP with different version contains an unique folder, e.g. after unpacking 4410A1LBV7000_2016-06-23.tgz to home directory, the directory , ~/imx6LBV7000_2016-06-23 is the BSP's home folder.)</div>
+
<div style="margin-left:1.498cm;margin-right:0cm;">(Every BSP with different version contains an unique folder, e.g. after unpacking 4410A1LBV7000_2016-06-23.tgz to home directory, the directory , ~/imx6LBV7000_2016-06-23 is the BSP's home folder.)</div><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>
<div style="margin-left:0.499cm;margin-right:0cm;">The description of some important folders list below:</div>
+
=== <span style="color:#0070c0;">Prebuilt image</span> ===
<div style="margin-left:1.499cm;margin-right:0cm;">'''sources/'''</div>
 
<div style="margin-left:1.998cm;margin-right:0cm;">'''meta-advantech/''' : meta layer by Advantech</div>
 
<div style="margin-left:1.998cm;margin-right:0cm;">'''meta-fsl-*/''' : meta layer by Freescale</div>
 
<div style="margin-left:1.499cm;margin-right:0cm;">'''fsl-setup-release.sh''' : to create one new build environment</div>
 
<div style="margin-left:1.499cm;margin-right:0cm;">'''setup-environment''' : to continue an exist build environment</div>
 
  
===<span style="color:#0070c0;">Prebuilt image</span>===
 
 
:Perform the following command to build one boot-up SD card
 
:Perform the following command to build one boot-up SD card
::<code>$ gunzip -c <span style="color:#7030a0;">'''${</span><span style="color:#7030a0;">PREBUILT_IMAGE</span><span style="color:#7030a0;">}'''</span> | dd of=<span style="color:#7030a0;">'''${SD_DEVICE}'''</span> bs=1M</code>
+
::<code>$ gunzip -c <span style="color:#7030a0;">'''${'''</span>'''<span style="color:#7030a0;">PREBUILT_IMAGE</span><span style="color:#7030a0;">}</span>''' | dd of=<span style="color:#7030a0;">'''${SD_DEVICE}'''</span> bs=1M</code>
 +
 
 +
== <span style="color:#0070c0;">Build Instructions</span> ==
 +
 
 +
=== <span style="color:#0070c0;">To create one new build environment</span> ===
  
==<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
 
:Perform the following commands in terminal console
 
::<code>$ cd <span style="color:#7030a0;">'''${BSP_HOME}'''</span></code>
 
::<code>$ cd <span style="color:#7030a0;">'''${BSP_HOME}'''</span></code>
 
::<code>$ MACHINE=<span style="color:#7030a0;">'''${MC}'''</span> source fsl-setup-release.sh -b <span style="color:#7030a0;">'''${BDIR}'''</span> -e x11</code>
 
::<code>$ MACHINE=<span style="color:#7030a0;">'''${MC}'''</span> source fsl-setup-release.sh -b <span style="color:#7030a0;">'''${BDIR}'''</span> -e x11</code>
 
:You need to read and accept the EULA.
 
:You need to read and accept the EULA.
:[[Image:accept_EULA.png]]
+
:[[File:Accept EULA.png|RTENOTITLE]]
 +
 
 +
=== <span style="color:#0070c0;">To continue an exist build environment</span> ===
  
===<span style="color:#0070c0;">To continue an exist build environment</span>===
 
 
:Perform the following commands in terminal console
 
:Perform the following commands in terminal console
 
::<code>$ cd <span style="color:#7030a0;">'''${BSP_HOME}'''</span></code>
 
::<code>$ cd <span style="color:#7030a0;">'''${BSP_HOME}'''</span></code>
 
::<code>$ source setup-environment <span style="color:#7030a0;">'''${BDIR}'''</span></code>
 
::<code>$ source setup-environment <span style="color:#7030a0;">'''${BDIR}'''</span></code>
  
===<span style="color:#0070c0;">To build sdcard image</span>===
+
=== <span style="color:#0070c0;">To build sdcard image</span> ===
 +
 
 
:To create/continue a build environment
 
:To create/continue a build environment
 
:Perform the following command in terminal console
 
:Perform the following command in terminal console
Line 122: Line 184:
 
::<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/>
 
::<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>===
+
=== <span style="color:#0070c0;">To build u-boot</span> ===
 +
 
 
:To create/continue a build environment
 
:To create/continue a build environment
 
:Perform the following command in terminal console
 
:Perform the following command in terminal console
Line 128: Line 191:
 
: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>.
 
: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>===
+
=== <span style="color:#0070c0;">To build linux kernel</span> ===
 +
 
 
:To create/continue a build environment
 
:To create/continue a build environment
 
:Perform the following command in terminal console
 
:Perform the following command in terminal console
Line 135: Line 199:
 
::to do build
 
::to do build
 
:::<code>$ bitbake linux-imx</code>
 
:::<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>.
+
: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;">Creating boot-up on-board flash from prebuilt image</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> ===
  
===<span style="color:#0070c0;">To create one boot-up SD card</span>===
 
 
:Perform the following command in terminal console
 
: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>$ gunzip -c '''<span style="color:#7030a0;">${PREBUILT_IMAGE</span>''' | dd of=<span style="color:#7030a0;">'''${SD_DEVICE}'''</span> bs=1M</code>
  
===<span style="color:#0070c0;">To transfer whole system to on-board flash</span>===
+
=== <span style="color:#0070c0;">To transfer whole system to on-board flash</span> ===
 +
 
 
:Boot up from SD card
 
:Boot up from SD card
 
:Perform the following commands in debug console
 
:Perform the following commands in debug console
Line 149: Line 215:
 
::<code># ./mksd-linux.sh /dev/mmcblk0</code>
 
::<code># ./mksd-linux.sh /dev/mmcblk0</code>
 
:press y followed by Enter, if following message shows up:
 
:press y followed by Enter, if following message shows up:
::[[File:all_data_will_be_destroyed.png]]
+
::[[File:All data will be destroyed.png|RTENOTITLE]]
 
:While "[Done]" shows up means the transferring is finished.
 
: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;">Creating boot-up on-board flash from built sdcard image</span> ==
===<span style="color:#0070c0;">To create one boot-up SD card</span>===
+
 
 +
=== <span style="color:#0070c0;">To create one boot-up SD card</span> ===
 +
 
 
:Perform the following commands in terminal console
 
: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>$ pushd <span style="color:#7030a0;">'''${BSP_HOME}'''</span>/<span style="color:#7030a0;">'''${BDIR}'''</span>/tmp/deploy/images/<span style="color:#7030a0;">'''${MC}'''</span></code>
Line 159: Line 227:
 
::<code>$ popd</code>
 
::<code>$ popd</code>
  
===<span style="color:#0070c0;">To transfer whole system to on-board flash</span>===
+
=== <span style="color:#0070c0;">To transfer whole system to on-board flash</span> ===
 +
 
 
:Boot up from SD card
 
: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.
 
:Insert USB stick that contains <span style="color:#7030a0;">'''${SDCARD_IMAGE}'''</span>, USB stick will be auto mounted to /run/media/sda1.

Revision as of 07:40, 15 November 2016


Getting Started

Conventions

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

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

${BSP_HOME} : home directory of the BSP

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

${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

ubc220 / rom3420 / rom5420 / rom7420 / rsb4410 / ubcds31

${BOARD_REV} : board revision

a1 / a2 / b1

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

for example,


imx6dlubc220a1 for UBC-220 A1
imx6qrom3420a1 for ROM-3420 A1
imx6qrom5420b1 for ROM-5420 B1
imx6qrsb4410a2 for RSB-4410 A2


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

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

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

${TOOLCHAIN} : toolchain installed directory(e.g. /opt/fsl-imx-x11/4.1.15-1.1.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 ...)

Prerequisites

To install Docker Engine on your platform

Please refer to Docker Installation Guide for details

To pull ubuntu 12.04 image from Docker Hub & run the image

$ docker pull advrisc/u12.04-imx6lbv3
$ docker run --privileged --name imx6LBV7000 -it -v ${SD_DEVICE}:${SD_DEVICE} advrisc/u12.04-imx6lbv3 /bin/bash

To copy BSP from local filesystem to the container

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

To copy files from the container's filesystem to local machine

$ docker cp imx6LBV7000:/home/adv/${BSP_HOME}/yocto_build/tmp/deploy/images/${MC} ~

Get BSP

Official Release BSP

You can get i.MX6 Yocto BSP from PM. For example, the 4410A1LBV7000_2016-06-23.tgz file is i.MX6 Yocto BSP file.

Download BSP

Setting up the repo utility

Repo is a tool built on top of Git that makes it easier to manage projects that contain multiple repositories, which do not need to be on the same server. Repo complements very well the layered nature of the Yocto Project, making it easier for users to add their own layers to the BSP.
To install the “repo” utility, perform these steps:
  • Create a bin folder in the home directory.
$ mkdir ~/bin (this step may not be needed if the bin folder already exists)
$ curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
$ chmod a+x ~/bin/repo
  • Add the following line to the .bashrc file to ensure that the ~/bin folder is in your PATH variable.
$ export PATH=~/bin:$PATH

Yocto Project Setup

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.

The following example shows how to download the Advantech Yocto Project Community BSP recipe layers. For this

example, a directory called adv-release-bsp is created for the project. Any name can be used instead of this.

$ mkdir adv-release-bsp
$ cd adv-release-bsp
$ repo init -u https://github.com/ADVANTECH-Corp/adv-arm-yocto-bsp.git -b jethro_4.1.15-1.0.0_ga
$ repo sync

Introducing BSP

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

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, 4410A1LBV7000_2016-06-23.tgz which "4410A1" stands for RSB-4410 A1, "LB" is acronym of Linux BSP, "V7000" stands for Version 7.000.
For example, 4410A1LIV7000_DualQuad_2016-06-23.img.gz which "LI" is acronym for prebuilt Linux Image, DualQuad means this image is fit for Dual Core/Quad Core.

BSP tarball

Unpack BSP tarball to home directory by performing the following command:
$ tar xvf ${BSP_TARBALL} -C ~/
(Every BSP with different version contains an unique folder, e.g. after unpacking 4410A1LBV7000_2016-06-23.tgz to home directory, the directory , ~/imx6LBV7000_2016-06-23 is the BSP's home folder.)
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

Prebuilt image

Perform the following command to build one boot-up SD card
$ gunzip -c ${PREBUILT_IMAGE} | dd of=${SD_DEVICE} bs=1M

Build Instructions

To create one new build environment

Perform the following commands in terminal console
$ cd ${BSP_HOME}
$ MACHINE=${MC} source fsl-setup-release.sh -b ${BDIR} -e x11
You need to read and accept the EULA.
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
The file, fsl-image-qt5-${MC}.sdcard, will be located in directory, ./tmp/deploy/images/${MC}, while building process finished successfully.

To build toolchain installer

To create/continue a build environment
Perform the following command in terminal console
$ bitbake meta-toolchain-qt5
The below installer will be located in the directory "./tmp/deploy/sdk".
fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-${KERNEL}-1.1.0.sh

To build u-boot

To create/continue a build environment
Perform the following command in terminal console
$ bitbake u-boot-imx
The two files, u-boot_crc.bin & u-boot_crc.bin.crc, will be located in the directory, ./tmp/deploy/images/${MC}.

To build linux kernel

To create/continue a build environment
Perform the following command in terminal console
to show up menuconfig
$ bitbake linux-imx -c menuconfig
to do build
$ bitbake linux-imx
The two files, zImage & zImage-${IMX6PROC}-${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

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
$ 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

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
CORE_IMAGE_EXTRA_INSTALL += "chromium"
LICENSE_FLAGS_WHITELIST="commercial"
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-cortexa9hf-vfp-neon-poky-linux-gnueabi

Building & updating u-boot manually

To build u-boot

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)
Make one copy from Yocto working directory
$ mkdir -p ~/code
$ pushd ${BSP_HOME}/${BDIR}/tmp/work/${MC}-poky-linux-gnueabi/
$ rm -rf ~/code/u-boot-imx
$ cp -a ./u-boot-imx/${UBOOT}-r0/git ~/code/u-boot-imx
$ popd
Configure u-boot
$ cd ~/code/u-boot-imx
$ make distclean
$ make ${MX6PROC}${BOARD}${BOARD_REV}_${MEM_SIZE}_config
Start building u-boot
$ make -j4 LDFLAGS=
The two files, u-boot-crc.bin & u-boot-crc.bin.crc, are located in directory "~/code/u-boot-imx".

To update u-boot to target device

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
Make sure new u-boot does work then perform the following commands 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

To build kernel/modules/dtb

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)
Make one copy from Yocto working directory
$ mkdir -p ~/code
$ pushd ${BSP_HOME}/${BDIR}/tmp/work-shared/${MC}/
$ rm -rf ~/code/linux-imx
$ cp -a ./kernel-source ~/code/inux-imx
$ popd
Configure linux kernel
$ cd ~/code/linux-imx
$ make distclean
$ make imx_v7_adv_defconfig
$ make menuconfig PKG_CONFIG_SYSROOT_DIR= PKG_CONFIG_PATH=
Start building linux kernel
$ make -j4 zImage LOADADDR=0x10008000 LDFLAGS=
The kernel image file, zImage, is located in the directory "./arch/arm/boot/".
Start building kernel modules
$ make -j4 modules LDFLAGS=
Copy all modules to a temporary rootfs directory, "~/temp/rootfs"
$ make modules_install INSTALL_MOD_PATH=~/temp/rootfs
Start 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/".

To update kernel/modules/dtb to target device

Copy zImage & ${IMX6PROC}-${BOARD}-${BOARD_REV}.dtb to the 1st partition of SD card
Copy modues to the 2nd partition of SD card.
Make sure all new linux kernel, device tree and kernel modules work well, then copy all of them to the on-board flash

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.