Difference between revisions of "IoTGateway/BSP/Linux/iMX7/Yocto LBV8 User Guide"

From ESS-WIKI
Jump to: navigation, search
(Modify i.MX7 description)
 
 
(42 intermediate revisions by one other user not shown)
Line 6: Line 6:
  
 
= Getting Started =
 
= 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. imx7LBV8870)
 +
 +
<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">'''${MX7PROC}'''</span>&nbsp;: i.MX7 Processor
 +
 +
:mx7d for iMX7 Dual Core
 +
 +
<span style="color:purple">'''${IMX7PROC}'''</span>&nbsp;: i.MX7 Processor
 +
 +
:imx7d
 +
 +
<span style="color:purple">'''${BOARD}'''</span>&nbsp;: available target boards list below
 +
 +
:ebcrm01
 +
 +
<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">'''${IMX7PROC}${BOARD}${BOARD_REV}'''</span>
 +
 +
:for example,
 +
 +
::<tt>imx7debcrm01a1 for EBC-RM01 A1</tt>
 +
 +
<span style="color:purple">'''${MEM_SIZE}'''</span>&nbsp;: memory size
 +
 +
:2G
 +
 +
<span style="color:purple">'''${MEM_VENDOR}'''</span>&nbsp;: memory vendor
 +
 +
:IM / Micron
 +
 +
<span style="color:purple">'''${SD_DEVICE}'''</span>&nbsp;: device name of SD card in Linux (e.g. /dev/sdf)
 +
 +
<span style="color:purple">'''${SDCARD_IMAGE}'''</span>&nbsp;: sdcard image built by bitbake (*.sdcard)
 +
 +
<span style="color:purple">'''${WORKSPACE}'''</span>&nbsp;:&nbsp;host workspace folders
 +
 +
<span style="color:purple">'''${UBOOT}'''</span>&nbsp;:u-boot version(e.g. 2016.03)
 +
 +
<span style="color:purple">'''${KERNEL}'''</span>&nbsp;: linux kernel version(e.g. 4.1.15)
 +
 +
<span style="color:purple">'''${TOOLCHAIN}'''</span>&nbsp;: toolchain installed directory(e.g. /opt/fsl-imx-x11/4.1.15-2.0.0)
 +
 +
debug console / serial console
 +
 +
:serial terminal program (e.g. minicom, putty, teraterm ...) that serial port is configured to 115200 8N1
 +
 +
terminal console
 +
 +
:terminal program (e.g. gnome-terminal, xfce4-terminal ...)
 +
 +
== <font color="#0070c0">Docker install and setting</font> ==
 +
 +
<span style="font-size:larger;">'''<span style="color:#0070c0">If you don't have docker in your system, then you can follow the below &nbsp;steps to install docker and run it first.</span>'''</span>
 +
 +
=== <span style="color:#0070c0">To install Docker Engine on your platform</span> ===
 +
 +
:Please refer to [https://docs.docker.com/engine/installation/ Docker Installation Guide] for details
 +
 +
=== <span style="color:#0070c0">To pull [https://hub.docker.com/r/advrisc/u12.04-imx6lbv3/ ubuntu 12.04 image from Docker Hub]&nbsp;</span> ===
 +
 +
:<code>$ docker pull advrisc/u12.04-imx6lbv3</code><br/>
 +
:<code>$ docker run --name imx7LBV8870&nbsp;&nbsp;-it advrisc/u12.04-imx6lbv3 /bin/bash</code><br/>
 +
 +
=== To copy BSP from local filesystem to the container ===
 +
 +
:<code>$ docker cp '''${BSP_PACK}''' imx7LBV8870:/home/adv/&nbsp;</code>
 +
 +
=== <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/u12.04-imx6lbv3 /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/iMX7/OS_Support_List_new|IoTGateway/BSP/Linux/iMX7/OS Support List new]] , Official version "'''imx7LBV8870"&nbsp;'''is taken as&nbsp;an example&nbsp;:
 +
 +
$ 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/imx7LBV8870''' -m '''imx7LBV8870'''.xml
 +
$ repo sync
 +
 +
*If you want to get latest bsp
 +
 +
$ 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 imx-4.1-krogoth
 +
$ repo sync
 +
 +
=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===
 +
 +
:If you have BSP tarball (eg. imx7LBV8870_2018-10-18.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 imx7LBV8870_2018-10-18.tgz '''${WORKSPACE}'''
 +
$ sudo chown adv:adv ${WORKSPACE}/imx7LBV8870_2018-10-18.tgz&nbsp;
 +
 +
3.Back to container
 +
 +
$ docker start '''${CONTAINER_NAME}'''
 +
$ docker attach '''${CONTAINER_NAME}'''
 +
 +
4.Unpack BSP tarball
 +
 +
$ tar zxvf imx7LBV8870_2018-10-18.tgz
 +
 +
== <span style="color:#0070c0">Introducing BSP</span> ==
 +
 +
:The BSP is based on Yocto Project with Freescale enhanced features for i.MX7, 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: imx7LBV8870_2018-10-18.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;"V8870" stands for <span style="color:#ff0000">'''V'''</span>ersion <font color="#ff0000">'''8'''</font>.<span style="color:#ff0000">'''870'''</span><nowiki>.</nowiki>
 +
:For example, '''Yocto image name: RM01LIV8870_Dual_2018-10-18.img.gz'''<br/>
 +
:which "rm01A1" stands for <span style="color:#ff0000">'''EBC-RM01 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; "Dual" means this image is fit for Dual 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> source fsl-setup-release.sh -b <span style="color:#7030a0">'''${BDIR}'''</span> -e x11</code>
 +
: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 fsl-image-qt5</code>
 +
:The file, fsl-image-qt5-<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.
 +
 +
=== <span style="color:#0070c0">To build toolchain installer</span> ===
 +
 +
:To create/continue a build environment
 +
:Perform the following command in terminal console
 +
::<code>$ bitbake meta-toolchain-qt5</code><br/>
 +
:The below installer will be located in the directory "./tmp/deploy/sdk".
 +
::<tt>fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-<span style="color:#7030a0">'''${KERNEL}'''</span>-1.1.0.sh</tt><br/>
 +
 +
=== <span style="color:#0070c0">To build u-boot</span> ===
 +
 +
: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 modify source code and rebuild u-boot</span> ===
 +
 +
:To create/continue a build environment
 +
:Perform the following command in terminal console
 +
::to modify source code and created a patch file
 +
:::<code>$ git diff > test.patch</code>
 +
::to create "u-boot-imx" directory and copy the "test.patch" file in following path
 +
:::<code>sources/meta-advantech/meta-fsl-imx6/recipes-bsp/u-boot$</code>
 +
::to open "u-boot-imx_2016.03.bbappend" file in following path
 +
:::<code>sources/meta-advantech/meta-fsl-imx6/recipes-kernel$vi u-boot-imx_2016.03.bbappend</code>
 +
:::<code>FILESEXTRAPATHS_prepend&nbsp;:= "${THISDIR}/${PN}:"</code>
 +
:::<code>SRCBRANCH = "imx_v2016.03_4.1.15_2.0.0_ga"</code>
 +
:::<code>UBOOT_SRC = "..."</code>
 +
:::<code>SRCREV = "${AUTOREV}"</code>
 +
::to add path information of patch file to u-boot-imx_2016.03.bbappend file
 +
:::<code>SRC_URI += "file://test.patch</code>
 +
::to clean u-boot image and code if you modify content of "mx7*.defconfig" file or "Makefile" file in the patch file
 +
:::<code>$ bitbake u-boot-imx -c cleansstate</code>
 +
::to build u-boot image
 +
:::<code>$ bitbake u-boot-imx</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, zImage & zImage-<span style="color:#7030a0">'''${IMX7PROC}'''</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> ===
 +
 +
:To create/continue a build environment
 +
:Perform the following command in terminal console
 +
::to modify source code and created a patch file
 +
:::<code>$ git diff > test.patch</code>
 +
::to create "linux-imx" directory and copy the "test.patch" file in following path&nbsp;
 +
:::<code>sources/meta-advantech/meta-fsl-imx6/recipes-kernel/linux/linux-imx$</code>
 +
::to open "linux-imx_4.1.15.bbappend" file in following path&nbsp; (<code><span style="color:#FF0000;">linux-imx</span>_4.1.15.bbappend will check&nbsp;<span style="color:#FF0000;">linux-imx</span> folder&nbsp;&nbsp;</code>)
 +
:::<code>sources/meta-advantech/meta-fsl-imx6/recipes-kernel/linux/$vi linux-imx_4.1.15.bbappend</code>
 +
:::<code>FILESEXTRAPATHS_prepend&nbsp;:= "${THISDIR}/${PN}:"</code>
 +
:::<code>SRCBRANCH = "imx_4.1.15_2.0.0_ga"</code>
 +
:::<code>KERNEL_SRC = "..."</code>
 +
:::<code>SRCREV = "${AUTOREV}"</code>
 +
::to add path information of patch file to linux-imx_4.1.15.bbappend file
 +
:::<span style="color:#FF0000;"><code>SRC_URI += "file://test.patch</code></span>
 +
::to clean kernel image and code if you modify content of "imx_v7_adv_imx7_defconfig" file or "Makefile" file in the patch file
 +
:::<code>$ bitbake linux-imx -c cleansstate</code>
 +
::to build kernel image
 +
:::<code>$ bitbake linux-imx</code>
 +
 +
== <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 (eMMC)</span> ===
 +
 +
:Boot up from SD card
 +
:Perform the following commands in debug console
 +
::<code># cd /mk_inand</code>
 +
::<code># ./mksd-linux.sh /dev/mmcblk0</code>
 +
:press y followed by Enter, if following message shows up:
 +
::[[File:All data will be destroyed.png|RTENOTITLE]]
 +
:While "[Done]" shows up means the transferring is finished.
 +
 +
== <span style="color:#0070c0">Creating boot-up on-board flash from built sdcard image</span> ==
 +
 +
=== <span style="color:#0070c0">To create one boot-up SD card</span> ===
 +
 +
:Perform the following commands in terminal console
 +
::<code>$ pushd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/<span style="color:#7030a0">'''${BDIR}'''</span>/tmp/deploy/images/<span style="color:#7030a0">'''${MC}'''</span></code>
 +
::<code>$ dd if=<span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span> of=<span style="color:#7030a0">'''${SD_DEVICE}'''</span> bs=1M</code>
 +
::<code>$ sync</code>
 +
::<code>$ popd</code>
 +
 +
=== <span style="color:#0070c0">To transfer whole system to on-board flash</span> ===
 +
 +
:Boot up from SD card
 +
:Insert USB stick that contains <span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span>, USB stick will be auto mounted to /run/media/sda1.
 +
:Perform the following commands in debug console
 +
::<code># umount /dev/mmcblk2p?</code>
 +
::<code># cd /run/media/sda1</code>
 +
::<code># dd if=<span style="color:#7030a0">'''${SDCARD_IMAGE}'''</span> of=/dev/mmcblk2 bs=4M conv=fsync</code>
 +
::<code># P2START=$(fdisk -lu | grep mmcblk2p2 | 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/mmcblk2</code>
 +
::<code># umount /dev/mmcblk2p2</code>
 +
::<code># e2fsck -f -y /dev/mmcblk2p2</code>
 +
::<code># resize2fs /dev/mmcblk2p2</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.MX7|Debug Port Information]]
 +
 +
=== <span style="color:#0070c0">Preparing for software tool</span> ===
 +
 +
*You need to prepare the debug console tool. For example: "minicom" tool or "putty" tool.
 +
*Baud rate: 115200
 +
 +
= Customization =
 +
 +
== <span style="color:#0070c0">Package addition</span> ==
 +
 +
=== <span style="color:#0070c0">To add tcf-agent & openssh-sftp-server</span> ===
 +
 +
:Navigate to the directory where fsl-image-adv.inc located
 +
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/sources/meta-advantech/recipes-fsl/images</code>
 +
:Add following line to fsl-image-adv.inc
 +
::<code>IMAGE_INSTALL += " tcf-agent openssh-sftp-server "</code>
 +
:[[IoTGateway/BSP/Linux/iMX6/Yocto_LBV5_User_Guide#To_continue_an_exist_build_environment|Continue an exist build environment]] and [[IoTGateway/BSP/Linux/iMX6/Yocto_LBV5_User_Guide#To_build_sdcard_image|build sdcard image]]
 +
 +
== <span style="color:#0070c0">Setting up SDK</span> ==
 +
 +
:Please follow the section,[[IoTGateway/BSP/Linux/iMX7/Yocto_LBV8_User_Guide#To_build_toolchain_installer|<span style="color:#FF0000;">To build toolchain installer</span>]], to build one toolchain installer
 +
:Perform the following command in terminal console
 +
::<code>$ cd <span style="color:#7030a0">'''${BSP_HOME}'''</span>/<span style="color:#7030a0">'''${BDIR}'''</span>/tmp/deploy/sdk</code>
 +
::<code>$ sudo ./fsl-imx-x11-glibc-x86_64-meta-toolchain-qt5-cortexa9hf-vfp-neon-toolchain-<span style="color:#7030a0">'''${KERNEL}'''</span>-1.1.0.sh</code><br/>
 +
:Enter new installed directory or just press <code>Enter</code> to use default directory.
 +
:While <code>Proceed[y/n]?</code> shows up, please enter the correct one.
 +
:Waiting for the SDK installed (while the following messages show up completely)
 +
::[[File:Setting up sdk 3.png|RTENOTITLE]]
 +
 +
== <span style="color:#0070c0">Setting up cross compiling environment</span> ==
 +
 +
:SDK has been set up (ref.[[#Setting_up_SDK|<span style="color:#FF0000;">Setting up SDK</span>]])
 +
:Perform the following command in terminal console
 +
::<code>$ source <span style="color:#7030a0">'''${TOOLCHAIN}'''</span>/environment-setup-cortexa9hf-vfp-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]])
 +
 +
=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===
 +
 +
*If you have an official version of u-boot source code, you can refer to [http://ess-wiki.advantech.com.tw/view/IoTGateway/BSP/Linux/iMX7/Yocto_LBV8_User_Guide#Copy_BSP_tarball_to_Container <span style="color:#FF0000;">Copy_BSP_tarball_to_Container</span>] , copy u-boot tarball to ${WORKSPACE} and back to container change owner & unpack tarball
 +
 +
$ sudo chown adv:adv imx7LBV8870_2018-10-18_uboot-imx7.tgz
 +
$ tar zxvf imx7LBV8870_2018-10-18_uboot-imx7.tgz
 +
 +
*If you want to get latest u-boot source code by following information
 +
 +
$ git clone [https://github.com/ADVANTECH-Corp/uboot-imx6.git https://github.com/ADVANTECH-Corp/uboot-imx6.git] -b imx_v2016.03_4.1.15_2.0.0_ga
 +
 +
=== <span style="color:#0070c0">Config u-boot</span> ===
 +
 +
$make '''${MX7PROC}${BOARD}${BOARD_REV}'''_'''${MEM_SIZE}'''_'''${MEM_VENDOR}'''_defconfig
 +
 +
eg.
 +
 +
$make mx7debcrm01a1_2G_IM_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 u-boot image to exist boot-up SD card
 +
 +
$ dd if=u-boot.imx of='''${SD_DEVICE}''' bs=512 seek=2 conv=fsync
 +
 +
:Perform the following command to transfer u-boot image to on-board flash(eMMC)
 +
 +
$ dd if=u-boot.imx of=/dev/mmcblk0 bs=512 seek=2 conv=fsync
 +
 +
:Download the [[Media:qspi-header.tar.gz|qspi-header.tar.gz]] file. Copy the qspi-header.tar.gz file to the device. Perform the following command to transfer u-boot image to first qspi
 +
$ tar zxvf qspi-header.tar.gz
 +
$ flash_erase /dev/mtd0 0 16
 +
$ dd if=qspi-header of=/dev/mtd0 bs=1k seek=0
 +
$ dd if=u-boot.imx of=/dev/mtd0 bs=512 seek=2 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]])
 +
 +
=== <span style="color:#0070c0">Copy BSP tarball to Container</span> ===
 +
 +
*If you have an official version of kernel source code, you can refer to [http://ess-wiki.advantech.com.tw/view/IoTGateway/BSP/Linux/iMX7/Yocto_LBV8_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 imx7LBV8870_2018-10-18_linux-imx7.tgz
 +
$ tar zxvf imx7LBV8870_2018-10-18_linux-imx7.tgz
 +
 +
*If you want to get latest kernel source code by the following information
 +
 +
$ git clone [https://github.com/ADVANTECH-Corp/linux-imx6.git https://github.com/ADVANTECH-Corp/linux-imx6.git] -b imx_4.1.15_2.0.0_ga
 +
 +
=== <span style="color:#0070c0">Config kernel</span> ===
 +
 +
:Configure linux kernel
 +
 +
$cd linux-imx6
 +
$make distclean
 +
$make imx_v7_adv_imx7_defconfig
 +
$make menuconfig
 +
 +
If you get error ,when you "make imx_v7_adv_imx7_defconfig" , you need to insatall "libncurses*"
 +
 +
$apt-get install libncurses*
 +
 +
[[File:Error.jpg|imx_v7_adv_imx7_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">'''${IMX7PROC}'''</span>-<span style="color:#7030a0">'''${BOARD}'''</span>-<span style="color:#7030a0">'''${BOARD_REV}'''</span>.dtb
 +
 +
:The device tree blob, <span style="color:#7030a0">'''${IMX7PROC}'''</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

Latest revision as of 04:21, 20 March 2020


Contents

Getting Started

Conventions

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

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

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

${BSP_HOME} : home directory of the BSP

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

${MX7PROC} : i.MX7 Processor

mx7d for iMX7 Dual Core

${IMX7PROC} : i.MX7 Processor

imx7d

${BOARD} : available target boards list below

ebcrm01

${BOARD_REV} : board revision

a1

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

for example,
imx7debcrm01a1 for EBC-RM01 A1

${MEM_SIZE} : memory size

2G

${MEM_VENDOR} : memory vendor

IM / Micron

${SD_DEVICE} : device name of SD card in Linux (e.g. /dev/sdf)

${SDCARD_IMAGE} : sdcard image built by bitbake (*.sdcard)

${WORKSPACE} : host workspace folders

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

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

${TOOLCHAIN} : toolchain installed directory(e.g. /opt/fsl-imx-x11/4.1.15-2.0.0)

debug console / serial console

serial terminal program (e.g. minicom, putty, teraterm ...) that serial port is configured to 115200 8N1

terminal console

terminal program (e.g. gnome-terminal, xfce4-terminal ...)

Docker install and setting

If you don't have docker in your system, then you can follow the below  steps to install docker and run it first.

To install Docker Engine on your platform

Please refer to Docker Installation Guide for details

To pull ubuntu 12.04 image from Docker Hub 

$ docker pull advrisc/u12.04-imx6lbv3
$ docker run --name imx7LBV8870  -it advrisc/u12.04-imx6lbv3 /bin/bash

To copy BSP from local filesystem to the container

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

To create container

$ docker run --privileged -it --name ${CONTAINER_NAME} -v ${WORKSPACE}:/home/adv/adv-release-bsp -v /dev:/dev advrisc/u12.04-imx6lbv3 /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/iMX7/OS Support List new , Official version "imx7LBV8870" 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/imx7LBV8870 -m imx7LBV8870.xml
$ repo sync
  • If you want to get latest bsp
$ 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 imx-4.1-krogoth
$ repo sync

Copy BSP tarball to Container

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

3.Back to container 

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

4.Unpack BSP tarball 

$ tar zxvf imx7LBV8870_2018-10-18.tgz

Introducing BSP

The BSP is based on Yocto Project with Freescale enhanced features for i.MX7, 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: imx7LBV8870_2018-10-18.tgz
which , "LB" is acronym of Linux BSP,
           "V8870" stands for Version 8.870.
For example, Yocto image name: RM01LIV8870_Dual_2018-10-18.img.gz
which "rm01A1" stands for EBC-RM01 A1
          "LI" is acronym for prebuilt Linux Image,
          "Dual" means this image is fit for Dual 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} 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 modify source code and rebuild u-boot

To create/continue a build environment
Perform the following command in terminal console
to modify source code and created a patch file
$ git diff > test.patch
to create "u-boot-imx" directory and copy the "test.patch" file in following path
sources/meta-advantech/meta-fsl-imx6/recipes-bsp/u-boot$
to open "u-boot-imx_2016.03.bbappend" file in following path
sources/meta-advantech/meta-fsl-imx6/recipes-kernel$vi u-boot-imx_2016.03.bbappend
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
SRCBRANCH = "imx_v2016.03_4.1.15_2.0.0_ga"
UBOOT_SRC = "..."
SRCREV = "${AUTOREV}"
to add path information of patch file to u-boot-imx_2016.03.bbappend file
SRC_URI += "file://test.patch
to clean u-boot image and code if you modify content of "mx7*.defconfig" file or "Makefile" file in the patch file
$ bitbake u-boot-imx -c cleansstate
to build u-boot image
$ bitbake u-boot-imx

To build linux kernel

To create/continue a build environment
If you operate on docker images, please install tmux application before running this command
$ sudo apt-get install tmux
Type following command to enter tmux
$ tmux
Perform the following command in terminal console to show up menuconfig
$ bitbake linux-imx -c menuconfig
After edit menuconfig, type following command to exit tmux windows
$ exit
to build kernel image
$ bitbake linux-imx
The two files, zImage & zImage-${IMX7PROC}-${BOARD}-${BOARD_REV}.dtb, will be located in the directory, ./tmp/deploy/images/${MC}.

To modify source code and rebuild linux kernel

To create/continue a build environment
Perform the following command in terminal console
to modify source code and created a patch file
$ git diff > test.patch
to create "linux-imx" directory and copy the "test.patch" file in following path 
sources/meta-advantech/meta-fsl-imx6/recipes-kernel/linux/linux-imx$
to open "linux-imx_4.1.15.bbappend" file in following path  (linux-imx_4.1.15.bbappend will check linux-imx folder  )
sources/meta-advantech/meta-fsl-imx6/recipes-kernel/linux/$vi linux-imx_4.1.15.bbappend
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
SRCBRANCH = "imx_4.1.15_2.0.0_ga"
KERNEL_SRC = "..."
SRCREV = "${AUTOREV}"
to add path information of patch file to linux-imx_4.1.15.bbappend file
SRC_URI += "file://test.patch
to clean kernel image and code if you modify content of "imx_v7_adv_imx7_defconfig" file or "Makefile" file in the patch file
$ bitbake linux-imx -c cleansstate
to build kernel image
$ bitbake linux-imx

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 (eMMC)

Boot up from SD card
Perform the following commands in debug console
# cd /mk_inand
# ./mksd-linux.sh /dev/mmcblk0
press y followed by Enter, if following message shows up:
RTENOTITLE
While "[Done]" shows up means the transferring is finished.

Creating boot-up on-board flash from built sdcard image

To create one boot-up SD card

Perform the following commands in terminal console
$ pushd ${BSP_HOME}/${BDIR}/tmp/deploy/images/${MC}
$ dd if=${SDCARD_IMAGE} of=${SD_DEVICE} bs=1M
$ sync
$ popd

To transfer whole system to on-board flash

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

Debug console information

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

Preparing for hardware device

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

Debug Port Information

Preparing for software tool

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

Customization

Package addition

To add tcf-agent & openssh-sftp-server

Navigate to the directory where fsl-image-adv.inc located
$ cd ${BSP_HOME}/sources/meta-advantech/recipes-fsl/images
Add following line to fsl-image-adv.inc
IMAGE_INSTALL += " tcf-agent openssh-sftp-server "
Continue an exist build environment and build sdcard image

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

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)

Copy BSP tarball to Container

  • If you have an official version of u-boot source code, you can refer to Copy_BSP_tarball_to_Container , copy u-boot tarball to ${WORKSPACE} and back to container change owner & unpack tarball
$ sudo chown adv:adv imx7LBV8870_2018-10-18_uboot-imx7.tgz
$ tar zxvf imx7LBV8870_2018-10-18_uboot-imx7.tgz
  • If you want to get latest u-boot source code by following information
$ git clone https://github.com/ADVANTECH-Corp/uboot-imx6.git -b imx_v2016.03_4.1.15_2.0.0_ga

Config u-boot

$make ${MX7PROC}${BOARD}${BOARD_REV}_${MEM_SIZE}_${MEM_VENDOR}_defconfig

eg. 

$make mx7debcrm01a1_2G_IM_defconfig

Build u-boot

$make -j4

Replace u-boot

Perform the following command to transfer u-boot image to exist boot-up SD card
$ dd if=u-boot.imx of=${SD_DEVICE} bs=512 seek=2 conv=fsync
Perform the following command to transfer u-boot image to on-board flash(eMMC)
$ dd if=u-boot.imx of=/dev/mmcblk0 bs=512 seek=2 conv=fsync
Download the qspi-header.tar.gz file. Copy the qspi-header.tar.gz file to the device. Perform the following command to transfer u-boot image to first qspi
$ tar zxvf qspi-header.tar.gz
$ flash_erase /dev/mtd0 0 16
$ dd if=qspi-header of=/dev/mtd0 bs=1k seek=0
$ dd if=u-boot.imx of=/dev/mtd0 bs=512 seek=2 conv=fsync

Building & updating kernel/modules/dtb manually

The cross compiling environment has been set up. (ref. Setting up cross compiling environment)

Copy BSP tarball to Container

  • If you have an official version of kernel source code, you can refer to Copy_BSP_tarball_to_Container , copy kernel tarball to ${WORKSPACE} and back to container change owner & unpack tarball
$ sudo chown adv:adv imx7LBV8870_2018-10-18_linux-imx7.tgz
$ tar zxvf imx7LBV8870_2018-10-18_linux-imx7.tgz
  • If you want to get latest kernel source code by the following information
$ git clone https://github.com/ADVANTECH-Corp/linux-imx6.git -b imx_4.1.15_2.0.0_ga

Config kernel

Configure linux kernel
$cd linux-imx6
$make distclean
$make imx_v7_adv_imx7_defconfig
$make menuconfig

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

$apt-get install libncurses*

imx_v7_adv_imx7_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 ${IMX7PROC}-${BOARD}-${BOARD_REV}.dtb
The device tree blob, ${IMX7PROC}-${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
Retrieved from "https://ess-wiki.advantech.com.tw/wiki/index.php?title=IoTGateway/BSP/Linux/iMX7/Yocto_LBV8_User_Guide&oldid=18652"