View source for Yocto Linux BSP Ver.4 User Guide for AM57xx/AM335x series

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

= Introduction =

This page provides the steps to build the Processor SDK and individual components from source. The Processor SDK build is based on the Arago Project which provides a set of layers for OpenEmbedded and the Yocto Project targeting TI platforms.

This page will provide the basic steps require to recreate the Processor SDK along with a reference of Processor SDK specific configurations, build targets, and target devices. Also, tips and suggestions are provided along with links for more in-depth information.

&nbsp;

= Getting Start =

== <span style="color: rgb(0, 112, 192);">Prerequisites</span> ==

=== <span style="color: rgb(0, 112, 192);">Host Setup</span> ===

Generally，to do Linux development, you’ll need a host PC running Linux. In the development with the advantech SDK, it would be strongly recommend to use Ubuntu 16.04 LTS 64 bit as developing environment. Because we have successfully tested our BSP on these OS version. Please install the Ubuntu 16.04 LTS 64 bit at your PC/NB in advance.

=== <span style="color: rgb(0, 112, 192);">Docker install and setting</span> ===

If you don't have docker in your system, then you can follow the below&nbsp; 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
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ docker pull advrisc/u16.04-amxxlbv1</div>
To create container
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ docker run -it --name ${CONTAINER_NAME} -v ${WORKSPACE}:/home/adv/yocto_bsp:rw advrisc/u16.04-amxxlbv1 /bin/bash</div>
&nbsp;

== <span style="color: rgb(0, 112, 192);">Build Steps</span> ==

The following example shows how to download the Advantech Yocto BSP from GitHub.

For this example, a directory called yocto_bsp is created for the project.
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ mkdir&nbsp;yocto_bsp<br/></div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ sudo chown adv:adv -R yocto_bsp</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ cd yocto_bsp/</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ mkdir tisdk</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ cd tisdk/</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$&nbsp;repo init -u [https://github.com/ADVANTECH-Corp/adv-ti-yocto-bsp.git https://github.com/ADVANTECH-Corp/adv-ti-yocto-bsp.git] -b processor-sdk-05.03.00.07 -m amxxLBV1090.xml&nbsp;</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);"><div>
$ repo init -u&nbsp;[git://github.com/ADVANTECH-Corp/adv-ti-yocto-bsp.git -b git://github.com/ADVANTECH-Corp/adv-ti-yocto-bsp.git&nbsp;-b] &nbsp;refs/tags/am57xxLBV1000&nbsp;
</div></div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ repo sync</div>
If you want to get latest bsp:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ repo init -u [git://github.com/ADVANTECH-Corp/adv-ti-yocto-bsp.git git://github.com/ADVANTECH-Corp/adv-ti-yocto-bsp.git] -b processor-sdk-05.03.00.07</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ repo sync</div>
Due to lots of company firewalls/proxies only permitting HTTP traffic this is what our default repo manifest is using. At times the loading of repository server might be too heavy or for other reasons. You may be experience the following issues:

&nbsp;[[File:23456789.png|23456789.png]]

First just try repo syncing again it might just have been a connection glitch.

Then, if the error(s) persist try using git's garbage collection on the failing repository before attempting to sync again, e.g. if the error indicates an issue in the meta-openembedded repository:

cd .repo/projects/sources/meta-arago.git
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ git gc</div>
If the error(s) persist try removing your local git/repo cache before attempting to sync again, e.g. if the error indicates an issue in the meta-openembedded repository:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ rm -rf .repo/projects/sources/meta-arago.git</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ rm -rf .repo/project-objects/meta-arago.git.git</div>
Additionally you can limit the number of git repositories which are downloaded in parallel by using the additional parameter "-jX". e.g. to download one repository at a time:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ repo sync -j1</div>
Additionally the following tweak to your IP settings maybe helpful:

sudo sysctl -w net.ipv4.tcp_window_scaling=0

If your Internet connection permits you might also try switching those failing repositories to using the git protocol instead by modifying your .repo/manifest.xml as follows:

<remote fetch="[git://git.arago-project.org git://git.arago-project.org]" name="meta-arago"/>
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ ./oe-layertool-setup.sh</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ cd build</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ . conf/setenv</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=&lt;machine&gt; bitbake arago-core-tisdk-image</div>
&nbsp;

= Processor SDK Build Reference =

The following sections provide information for configuration, build options, and supported platforms of the Processor SDK.

== <span style="color: rgb(0, 112, 192);">Layer Configuration</span> ==

Processor SDK uses the following oe-layertool-setup configs to configure the meta layers.
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ ./oe-layertool-setup.sh</div>
&nbsp;

== <span style="color: rgb(0, 112, 192);">Build Options</span> ==

=== <span style="color: rgb(0, 112, 192);">Images</span> ===

In addition to individual components packages, the following table provides a list of build targets supported. These are the &lt;target&gt; used in the command:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE==&lt;machine&gt; bitbake &lt;target&gt;</div>
The "Build Output" is given relative to the arago-tmp-[toolchain]/deploy directory.

{| cellpadding="0" cellspacing="0" border="1"
|-
| 
'''Target'''

| 
'''Build Output'''

| 
'''Description'''

|-
| 
arago-core-tisdk-image

| 
images/&lt;machine&gt;/processor-sdk-linux-image-&lt;machine&gt;.tar.xz

| 
Full SDK

|-
| 
tisdk-rootfs-image

| 
images/&lt;machine&gt;/tisdk-rootfs-image-&lt;machine&gt;.tar.xz

| 
Target Filesystem

|-
| 
u-boot-ti-staging

| 
images/&lt;machine&gt;/u-boot-&lt;machine&gt;.img

images/&lt;machine&gt;/MLO-&lt;machine&gt;

| 
u-boot

|-
| 
linux-ti-staging

| 
images/&lt;machine&gt;/zImage-&lt;machine&gt;.bin

images/&lt;machine&gt;/zImage-&lt;machine&gt;.dtb

| 
kernel

|}

&nbsp;

=== <span style="color: rgb(0, 112, 192);">Platforms</span> ===

The following platforms are supported in Processor SDK. These are the &lt;machine&gt; in the command:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE==&lt;machine&gt; bitbake &lt;target&gt;</div>


{| cellpadding="0" cellspacing="0" border="1"
|-
| 
'''MACHINE'''

| style="width: 443px;" | 
'''Supported Product'''

|-
| am335xrsb4220a1
| style="width: 443px;" | 
RSB-4220A1

|-
| am335xrsb4221a1
| style="width: 443px;" | 
RSB-4221A1

|-
| am335xrom3310a1
| style="width: 443px;" | 
ROM-3310A1

|-
| am335xepcr3220a1
| style="width: 443px;" | 
EPC-R3220A1

|}

&nbsp;

== <span style="color: rgb(0, 112, 192);">Command</span> ==

=== <span style="color: rgb(0, 112, 192);">Build command</span> ===
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=&lt;machine&gt; bitbake &lt;target&gt;</div>
Take uboot as an example：
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=am335xepcr3220a1 bitbake u-boot-ti-staging</div>
The MLO and u-boot.img will be located in the directory, ./arago-tmp-external-linaro-toolchain/deploy/images/am57xxrom7510a2.

When the target is arago-core-tisdk-image, MLO,u-boot.img,zImage, devicetree file, filesystem and full SDK will compiled.

&nbsp;

=== <span style="color: rgb(0, 112, 192);">To modify source code and rebuild u-boot</span> ===

When needed, source code under the work directory (e.g.,arago-tmp-external-linaro-toolchain/work/am57xxrom7510a2-linux-gnueabi/u-boot-ti-staging/2016.05+gitAUTOINC+87ffcd71d0-r14/git) can be modified. After the modification is done, run the following commands to force recompilation with the new code and rebuilding of the recipe, e.g.,
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=&lt;machine&gt; bitbake &lt;target&gt; --force -c compile</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=&lt;machine&gt; bitbake &lt;target&gt;</div>
Take uboot as an example：
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=am335xepcr3220a1 bitbake u-boot-ti-staging --force -c compile</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=am335xepcr3220a1 bitbake u-boot-ti-staging</div>
&nbsp;

=== <span style="color: rgb(0, 112, 192);">Cleaning Built Recipe</span> ===

A built recipe can be cleaned using:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=&lt;machine&gt; bitbake &lt;target&gt;　-c cleansstate</div>
Take uboot as an example：
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=am335xepcr3220a1 bitbake u-boot-ti-staging -c cleansstate</div>
The cleansstate task will clean recipe's work directory and remove the recipe's output from the dependency tree used by other recipe's during compilation.

== <span style="color: rgb(0, 112, 192);">Recipes</span> ==

=== <span style="color: rgb(0, 112, 192);">Recipe Basics</span> ===

One or more recipes can be specified for the &lt;target&gt; for greater granularity of recipe development and debug. Specifying a recipe name, minus the version (if the version is appended to the name), will build the recipe and all its dependencies.

For example, the command below builds only the opencl recipe and all the dependencies it defines.
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE=am335xepcr3220a1 bitbake opencl</div>
After the bitbake command above is successfully done, arago-tmp-[toolchain]/work/am335xepcr3220a1-linux-gnueabi/opencl directory will be available including the original source code under the git folder, independent shared objects (.so files) under packages-split folder, and IPKs under deploy-ipks folder.

''NOTE:Please note that the output of a recipe can be in another folder under "arago-tmp-[toolchain]/work" directory, depending on the defines of the recipe.''

=== <span style="color: rgb(0, 112, 192);">Installing Package</span> ===

To install a modified and rebuilt package, copy the new IPKs from the deploy-ipks folder (e.g., arago-tmp-[toolchain]/work/am57xx_am57xxrom7510a2-linux-gnueabi/opencl/[version]/deploy-ipks) to the target system and then run the following command to install the IPKs:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ opkg install [package_ipk].ipk</div>
== <span style="color: rgb(0, 112, 192);">Common Variations</span> ==

=== <span style="color: rgb(0, 112, 192);">Rebuilding without SGX</span> ===

In Processor SDK delivered today the graphics hardware acceleration is enabled by default for device families with SGX (e.g. AM335x, AM437x, AM57xx). As a result, some of the applications with graphics dependencies will not run properly on device variants in those families that do not contain the SGX accelerator (e.g. AM3352, AM4372, etc.). The Processor SDK has been enhanced to provide the same OOB experience with software rendering provided by QT5/Weston. The non-SGX software rendering build will be enabled by adding the following to the bottom of conf/local.conf immediately before invoking bitbake.
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ MACHINE_FEATURES_remove=”sgx”</div>
=== <span style="color: rgb(0, 112, 192);">Rebuilding without Wayland</span> ===

If a full Window system is not needed, i.e. if you simply want apps to run full screen using EGLFS then you can remove Wayland by adding the following to the bottom of conf/local.conf immediately before invoking bitbake:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ DISTRO_FEATURES_remove = "wayland"</div>
&nbsp;

= Create a Linux System Boot Media =

Our motherboard&nbsp;generally supports from SD card and onboard flash. This section will take&nbsp;ROM-7510 as an example to introduce how to make a system boot media.

== <span style="color: rgb(0, 112, 192);">Create a Linux System SD Card</span> ==

Copy full SDK(processor-sdk-linux-image-&lt;machine&gt;.tar.xz) package to your desktop
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ mkdir ti-sdk-XXX(XXX represents numbers, e.g. ti-sdk-001)</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ tar –xJf Desktop/processor-sdk-linux-image-&lt;machine&gt;.tar.xz –C ti-sdk-XXX</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ cd ti-sdk-XXX/bin</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ ./create-sdcard.sh</div>
Select SD card:

[[File:AM57XX select sd 1.png|336x119px|AM57XX select sd 1.png]]

Select number of partitions:

[[File:AM57XX partition 1.png|735x201px|AM57XX partition 1.png]]

Whether to continue:

[[File:AM57XX continue 1.png|734x205px|AM57XX continue 1.png]]

Select Pre-built System image:

[[File:AM57XX pre 1.png|736x187px|AM57XX pre 1.png]]

Select tisdk-rootfs-image-XXX.tar.xz(XXX represents machine name, e.g. am335xepcr3220a1):

[[File:TI Yocto2.4 Multi rootfs select.JPG|682x172px]]

If you need to transfer whole system to on-board flash, please press y followed by Enter.

[[File:AM57XX upgrade 1.png|442x27px|AM57XX upgrade 1.png]]

While "[Operation Finished]" shows up means the transferring is finished.

Then insert the Linux system SD card to ROM-7510, it will boot up with Linux environment.

== <span style="color: rgb(0, 112, 192);">Boot from Onboard Flash</span> ==

If you have&nbsp;already get&nbsp;a Linux system SD card and the last step of make process&nbsp;selected "y", you can refer to the following steps to burn the system to the onboard flash.

Please insert the Linux system SD card to ROM-7510, and then power up.&nbsp;It&nbsp;boot&nbsp;from the SD card.
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ cd /mk_inand</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ ./mk-eMMC-boot.sh</div>
Select eMMC:

[[File:AM57XX select emmc 1.png|305x107px|AM57XX select emmc 1.png]]

Select number of partitions:

[[File:AM57XX partition emmc 3.png|656x200px|AM57XX partition emmc 3.png]]

Partition completion. Continue the burning system or not?

[[File:AM57XX continue emmc 1.png|654x182px|AM57XX continue emmc 1.png]]

If “y” was pressed, the system will be burned to eMMC.

While "[Operation Finished]" shows up means the burning is finished.

Then you can boot from onboard flash without SD card.&nbsp;

== <span style="color: rgb(0, 112, 192);">Debug console information</span> ==

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

=== <span id="preparing_for_hardware_device" class="mw-headline"><span style="color: rgb(0, 112, 192);">Preparing for hardware device</span></span> ===

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

[http://ess-wiki.advantech.com.tw/view/Debug_Port_Information#i.MX6 <font color="#0066cc">Debug Port Information</font>]

=== <span id="preparing_for_software_tool" class="mw-headline"><span style="color: rgb(0, 112, 192);">Preparing for software tool</span></span> ===

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

&nbsp; &nbsp;

= Local development =

All instructions in this guide are based on Ubuntu 14.04 LTS developing environment. Please install the Ubuntu 14.04 LTS at your PC/NB in advance.

== <span style="color: rgb(0, 112, 192);">Set up Build Environment</span> ==

Perform the following command in terminal console
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ cd ti-sdk-XXX/</div><div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ ./sdk-install.sh</div>
== <span style="color: rgb(0, 112, 192);">Rebuild sources</span> ==

Using the&nbsp;[http://processors.wiki.ti.com/index.php/Processor_Linux_SDK_Top-Level_Makefile top-level makefile]&nbsp;in the SDK root directory. For example:

Rebuilds all components in the SDK:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ make all</div>
Configures and builds the kernel:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ make linux</div>
If you want to copy the compiled module to the specified directory:

Please specifying the installation directory in the&nbsp;Rules.make file firstly
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">DESTDIR=<''install_directory''></div>
Then executing the following instructions:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ make linux_install</div>
Builds u-boot, u-boot-spl and MLO:
<div style="background: rgb(238, 238, 238); padding: 5px 10px; border: 1px solid rgb(204, 204, 204);">$ make u-boot</div>
&nbsp; &nbsp;

= Customization =

== <span style="color: rgb(0, 112, 192);">Package addition</span> ==

=== <span style="color: rgb(0, 112, 192);">To add vsftpd & crontab</span> ===

:Navigate to the directory where '''tisdk-rootfs-image.bbappend''' located
::<code>$ cd <span style="color: rgb(112, 48, 160);">'''${BSP_HOME}'''</span>/sources/meta-advantech2/meta-ti-adv/recipes-core/images/</code>
:Add following line to '''tisdk-rootfs-image.bbappend'''
::<code>IMAGE_INSTALL += " cronie vsftpd "</code>
:Then, follow the [[IoTGateway/BSP/Linux/AM57xx/AM57xx_User_Guide#Build_Steps|Build Steps]] above to generate the image.