View source for IoTGateway/BSP/Linux/AM335x/AM335x LBV6 User Guide

{{DISPLAYTITLE:Linux BSP User Guide for AM335x series}}
__TOC__

= Start Guide =

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 12.04 LTS 64 bit/ Ubuntu 14.04 LTS 64 bit as developing environment. Because we have successfully tested our BSP on these OS version. Please install the Ubuntu 12.04 LTS 64 bit / Ubuntu 14.04 LTS 64 bit at your PC/NB in advance.

== <span style="color:#0070c0">Configure your Linux Host</span> ==

After installed this OS, you must install some essential libraries or tools on your host PC for building these source code. We will describe how to install them as follow:

*'''build-essential'''

If you have a new Ubuntu system where you have not installed anything for building. The build-essential library is necessary. The command as follow:
<pre> # sudo apt-get install build-essential
</pre>

*'''32-bit compatibility libraries'''

As we known, the host PC is 64-bit Ubuntu, but some tools are a 32-bit tool. To make them work, you must install this 32-bit compatibility libraries. The command is follow on 64 bit Ubuntu14.04:
<pre> # dpkg --add-architecture i386
 # cd /etc/apt/sources.list.d
 # echo "deb http://old-releases.ubuntu.com/ubuntu/ raring main restricted universe multiverse" >ia32-libs-old-release.list
 # sudo apt-get update
 # sudo apt-get install ia32-libs 
 # sudo rm ia32-libs-old-release.list
 # sudo apt-get update 
</pre>

On the 64-bit Ubuntu12.04, you need to type the following command:
<pre> #sudo apt-get install ia32-libs
</pre>

*'''Some essential tools for BSP building'''

After step1 and step2, you can build some application based linux. But if you want to build BSP source code, you need to install these following tools on ubuntu14.04.
<pre> # sudo apt-get update libncurses5-dev autoconf automake dos2unix u-boot-tools
</pre>

And On ubuntu12.04, you can type following command to install these software:
<pre> # sudo apt-get update libncurses5-dev autoconf automake dos2unix uboot-mkimage
</pre>

Because starting with Ubuntu 14.04 the package name for uboot-mkimage has changed to u-boot-tools.<br/>'''After these steps, you can buid what you want, best wishes!'''

== <span style="color:#0070c0">Install Advantech SDK</span> ==

When you obtain the advantech Linux source code package, please refer to following instructions to install it to you host PC.

*Copy "AM335X_LBBxxxx_yyyy-mm-dd.bin" package to /root/.
*Start your "Terminal" on Ubuntu host PC.
*$sudo su (Change to “root” authority)
*Input user password
*#cd /root/
*#chmod 777 AM335X_LBBxxxx_yyyy-mm-dd.bin
*#./AM335X_LBBxxxx_yyyy-mm-dd.bin
*Input “yes”
*Then you can see folder "AM335X_LBBxxxx_yyyy-mm-dd" on /root/.

AM335x board source code package (BSP) contains cross compiler, Linux source code, Uboot source code, root file system and some scripts used in development. Some of above components are developed by Advantech and the others are developed by open source community. AM335x source code package is composed of six main folders: “cross_compiler”, “document”，“image”, “package”, “scripts”, and “source”.<br/><font color="#FF0000">Note! AM335x source code package (BSP) is Advantech’s Intellectual Property. If you need to access this package, please contact your Advantech support window.</font><br/>[[File:Bsp.png|RTENOTITLE]]<br/>The description of AM335x BSP package contents:

{| class="wikitable"
|-
| '''cross_compiler'''
| Cross compiler tool
|-
| '''document'''
| Some important documents, such as usermanual.
|-
| '''image'''
| uImage, u-boot.img
|-
| '''image/rootfs'''
| Linux root file system
|-
| '''package'''
| source code provided by TI or open source community without any modification, for example: kernel source, uboot source, libmodbus source
|-
| '''scripts'''
| scripts for configure system and compile images automatically.
|-
| '''source'''
| source code owned by Advantech， the uboot, kernel and libmodbus source code and demo source for AM335x
|}

'''1. cross_compiler tools'''<br/>You can use the cross compiler tool chain to compile the uboot, uImage, modbus library and related applications. (gcc version is 4.7.3 20130226).

'''2. Scripts '''<br/>The scripts provided by Advantech will help you configure system or build the images more quickly. Please check them as follows:

{| class="wikitable"
|-
| '''setenv.sh'''
| A script to setup the developing environment quickly.
|-
| '''cfg_uboot.sh'''
| A script to configure the u-boot building setup quickly.
|-
| '''mk_uboot.sh'''
| A script to build the u-boot and copy the “u-boot” to “image” folder after building.
|-
| '''cfg_kernel.sh'''
| A script to build the “uImage” and copy the “uImage” to “image” folder after building.
|-
| '''mk_kernel.sh'''
| A script to build the “uImage” and copy the “uImage” to“image” folder after building.
|-
| '''mksd-linux.sh'''
| A script to setup up a bootable SD card if users build their images.
|-
| '''mkinand-linux.sh'''
| A script to go to SD card Linux O.S. then burn O.S to eMMC flash
|}

'''3. source '''<br/>This folder contains sub-directories "linux-xxx" and "u-boot-xxx" and demo. They are the source codes of the Linux kernel, U-boot and demo.

== <span style="color:#0070c0">BSP Building Guide</span> ==

In the following building demo, we always assume building is for RSB4220 platform. others(such as ROM3310,RSB4221) are same。 $(BSP) is your BSP root directory. In order to simplify the description， we use "$(BSP)" to represent actual BSP root path. you need to replace the string to actual path。

'''1. Setup uboot and kernel build environment'''

*$ sudo su (Change to “root” authority)
*Input user password
*#cd $(BSP)/scripts/
*#source setenv.sh (To configure the developing environment automatically)

Then you can start to code the source code, build uboot and kernel images.

The '''setenv.sh''' script is used to configure the developing environment quickly. It will configure the folder paths for system.

<font color="#FF0000">Note! You have to run “#source setenv.sh” every time once you open a new "Terminal" utility. It is suggested to change to “root” authority to use the source code. And the “$(BSP)” is the root directory of BSP source code. </font><br/>'''2. Build u-boot Image'''<br/>Advantech has a script to build the u-boot quickly. You can build u-boot image by follow below steps:

*Open "Terminal" on Ubuntu host PC.
*$sudo su (Change to “root” authority)
*Input user password.
*#cd $(BSP)/scripts/
*#source setenv.sh (To configure the developing environment automatically)
*#./cfg_uboot.sh am335x_rsb4220_defconfig (To set the u-boot configuration automatically)
*#./mk_uboot.sh (Start to build the u-boot)

'''Then you can see u-boot.img is being built and located in ../image. '''<br/><br/>'''3. Build Linux Kernel Image'''<br/>Advantech offer you a script to build the “uImage” quickly. You can build uImage by follow below steps:

*Open "Terminal" on Ubuntu host PC.
*$sudo su (Change to “root” authority)
*Input user password.
*#cd $(BSP)/scripts/
*#source setenv.sh (To configure the developing environment automatically)
*#./cfg_kernel.sh tisdk_am335x-rsb4220_defconfig (To set the uImage configuration automatically)
*#./mk_kernel.sh (Start to build the uImage)

'''Then you can see uImage is being built and located in ../image.'''

== <span style="color:#0070c0">Update Linux OS</span> ==

All advantech products based on AM335x platform support '''boot from SD card''' or '''onboard flash'''. This section will guide you how to build an image for Linux system boot media.

=== Debug Message ===

All advantech risc products can connect to a host PC (Linux or Windows) by using console cable and debug port adapter. In order to communicate with host PC, serial communication program such as HyperTerminal, Tera Term or PuTTY is must required. Suggest use PuTTY on your host PC. Below is the detail instruction of how to setup PuTTY on ubuntu 14.04 hosts:<br/>Install putty as below<br/>[[File:Putty1.png|RTENOTITLE]]

*Connect target board to your ubuntu PC by using console cable.
*Open putty on your ubuntu PC.
*power up the target board.
*Setting putty as follows.

[[File:Putty5.png|RTENOTITLE]]<br/>Select correct serial line， then click open. Then you will see the console information： [[File:Putty7.png|RTENOTITLE]]<br/>Type root to login in system.

=== Storage Information (eMMC/SD card) ===

The storages devices name as following:

{| class="wikitable"
|-
! Device
! Node Name
|-
| SD card<br/>
| /dev/mmcblk0
|-
| eMMC
| /dev/mmcblk1
|}

If Linux os exists in both SD card and eMMC flash, the linux in SD is default boot option. If no SD card inserted, the eMMC node is "/dev/mmcblk0".

=== Create a Linux SD Card System ===

'''1. Create system from Pre-built System Image'''<br/>You are able to find the pre-built image from Advantech website. Please follow below steps to create a SD card for boot up. we still use the RSB-4220 as demo:

*Copy “4420LIVxxxx_yyyy-mm-dd.tar.gz” package to your /root/.
*Open "Terminal" on Ubuntu host PC.
*$sudo su (Change to “root” authority)
*Input your password.
*#cd /root/
*#tar xzvf 4220LIVxxxx_yyyy-mm-dd.tar.gz (Unzip files)
*Insert one SD card to your developing computer
*Check the SD card location, like /dev/sdb
*#cd ./4220LIVxxxx_yyyy-mm-dd/scripts
*#./mksd-linux.sh /dev/sdb
*Type “y” (Start to copy files, wait until it shows [Done] )

Then insert the Linux system SD card to target board (like RSB-4220), it will boot up with Linux environment.

'''2.Create system from Source Code Package'''<br/>When you receive the advantech Linux source code package, you can refer following steps to create a Linux system SD card for booting up from it.we still use the RSB-4220 as demo:

*Open "Terminal" on Ubuntu host PC.
*$sudo su (Change to “root” authority)
*Input your password.
*Insert one SD card to your developing computer
*Check the SD card location, like: /dev/sdb
*Ensure that you have built the uboot and kernel
*#cd $(BSP)/scripts
*#./mksd-linux.sh /dev/sdb
*Type “y” (Start to copy files, wait until it shows [Done] )

Then insert the Linux system SD card to target board's (such as RSB-4220) SD card slot, it will boot up with Linux environment.

=== Boot from Onboard Flash ===

If you’ve already had a Linux system SD card, you can refer following steps to copy the content to onboard flash and then boot from onboard flash. Advantech also provide you a script “mkinand-linux.sh” to speed up the process of installing system image to onboard flash.

*Ensure you have created a linux system on SD card
*Insert this Linux system SD card to target board and connect serial console.
*On your target system, type #root (Login)
*On your target system, type #cd /mk_inand
*On your target system, type #./mkinand-linux.sh /dev/mmcblk1
*Type “y” (Start to copy files, wait until it shows [Done] )
*After done, Power off and remove this SD card.

Then you can boot from onboard flash without SD card.

=Developement Guide=
== <span style="color:#0070c0">HW module Configuration & driver</span> ==

*[[IoTGateway/BSP/Linux/AM335x/Add_a_Driver_to_Kernel_by_menuconfig|Add a Driver to Kernel by menuconfig]]
*[[IoTGateway/BSP/Linux/AM335x/Hardware_module|Hardware module]]

== <span style="color:#0070c0;"> C/C++ & Qt Application Development </span>==
* [[IoTGateway/BSP/Linux/AM335x/C/C++_Development| C/C++ Application Development]]
* [[IoTGateway/BSP/Linux/AM335x/Qt_Application_Development| Qt Application Development]]

== <span style="color:#0070c0;"> System Service & Usage </span>==
* [[IoTGateway/BSP/Linux/AM335x/System_Service_and_Usage| System Service & Usage]]