View source for IoTGateway/BSP/Android/Android BSP User Guide for iMX6 series 4.4

<big><big><big>Android BSP User Guide for iMX6 series 4.4.2</big></big></big><!--
{| align="right"
 | <span class="fck_mw_magic" _fck_mw_customtag="true" _fck_mw_tagname="TOC" _fck_mw_tagtype="c">_</span>
 |}
-->

= Getting Started =

== <span style="color:#0066cc;">Prerequisites</span> ==

All operations in this guide are based on Ubuntu 12.04 LTS 64bit only.<br/>First please install Ubuntu 12.04 LTS 64bit<span style="color:#FF0000;"><sup>*</sup></span> with minimum 2GB memory.


<nowiki>* ubuntu-12.04.1-desktop-amd64.iso</nowiki>

=== <span style="color:#0066cc;">To install required packages</span> ===

Please login and perform the following commands:
<pre>$ sudo apt-get install ssh
$ sudo apt-get install ia32-libs libx11-dev:i386 libreadline6-dev:i386 \
libgl1-mesa-glx:i386 zlib1g-dev:i386 uuid-dev:i386 liblzo2-dev:i386 \ 
libncurses5-dev:i386
$ sudo apt-get install \
bison build-essential ccache dpkg flex gcc g++ gettext intltool \
libarchive-zip-perl libfreetype6-dev libdbus-glib-1-dev liborbit2-dev \
libxml2-dev libx11-dev libgtk2.0-dev liblzo2-2 libtool m4 \
patch rpm tcl uboot-mkimage uuid zlib1g zlib1g-dev \
git gnupg flex bison gperf build-essential  zip \
curl libc6-dev libncurses5-dev x11proto-core-dev libx11-dev:i386 \
libreadline6-dev:i386 libgl1-mesa-glx:i386 libgl1-mesa-dev g++-multilib \
mingw32 tofrodos python-markdown libxml2-utils xsltproc zlib1g-dev:i386 \
gcc-4.6 g++-4.6 cpp-4.6 gcc-4.6-multilib uuid-dev liblzo2-dev \
uboot-mkimage libarchive-zip-perl \
wget git-core unzip texinfo gawk diffstat build-essential chrpath \
sed cvs subversion coreutils texi2html \
docbook-utils python-pysqlite2 help2man make gcc g++ \
desktop-file-utils libgl1-mesa-dev libglu1-mesa-dev mercurial \
autoconf automake groff curl lzop asciidoc xterm
$ sudo apt-get install libncurses5-dev:i386 liblzo2-dev:i386 uuid-dev:i386
$ sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so
$ tar zcvf ~/usr_lib_i386-linux-gnu_for_Building_Android_KK.tar.gz \
/usr/lib/i386-linux-gnu/{libuuid.a,libuuid.so,liblzo2.so,liblzo2.a}
$ sudo apt-get install uuid-dev liblzo2-dev
$ sudo tar zxvf ~/usr_lib_i386-linux-gnu_for_Building_Android_KK.tar.gz -C /
</pre>

=== <span style="color:#0066cc;">To install JDK</span> ===

Please download "jdk-6u45-linux-x64.bin" manually, put it to directory ~/FILES/ and perform the following commands:
<pre>$ cd /usr/lib
$ sudo ~/FILES/jdk-6u45-linux-x64.bin
$ sudo mkdir jvm
$ cd jvm
$ sudo mv ../jdk1.6.0_45 .
$ cd jdk1.6.0_45/
$ sudo update-alternatives --install /usr/bin/java    java    /usr/lib/jvm/jdk1.6.0_45/jre/bin/java    2
$ sudo update-alternatives --install /usr/bin/javac   javac   /usr/lib/jvm/jdk1.6.0_45/bin/javac   2
$ sudo update-alternatives --install /usr/bin/jar     jar     /usr/lib/jvm/jdk1.6.0_45/bin/jar     2
$ sudo update-alternatives --install /usr/bin/javap   javap   /usr/lib/jvm/jdk1.6.0_45/bin/javap   2
$ sudo update-alternatives --install /usr/bin/javadoc javadoc /usr/lib/jvm/jdk1.6.0_45/bin/javadoc 2
$ sudo update-alternatives --config javap
$ sudo update-alternatives --config javadoc
$ sudo update-alternatives --config java
$ sudo update-alternatives --config javac
$ sudo update-alternatives --config jar
$ cd ~/
$ sudo sh -c "echo "JAVA_HOME=/usr/lib/jvm/jdk1.6.0_45" >> /etc/environment"
</pre>

== <span style="color:#0066cc;">Introducing BSP</span> ==

:The BSP contains cross toolchain, linux kernel source code, u-boot source code, Android root file system and some scripts. It is consist of three top folders: "android", "image", "scripts".

=== <span style="color:#0066cc;">Overview</span> ===

:The description of some important folders as below:
::'''android/'''
:::'''prebuilt/gcc/linux-x86/host/'''&nbsp;: cross toolchain
:::'''bootable/bootloader/uboot-imx/'''&nbsp;: u-boot source code
:::'''kernel_imx/'''&nbsp;: linux kernel source code
:::'''device/'''
::::'''fsl/'''&nbsp;: Android device related settings
::::'''fsl-proprietary/'''&nbsp;: modules & firmware(e.g. WiFi, GPU)
:::'''hardware/imx/'''&nbsp;: HAL (Hardware Abstraction Layer)
::'''image/'''&nbsp;: all built images located in
::'''scripts/'''&nbsp;: to simplify building process (Please refer to [[#Build_Instructions|1.4]] & [[#Boot_up_from_SD_card_or_eMMC|1.5]] for details)

=== <span style="color:#0066cc;">Naming Rule</span> ===

:It is consist of the model name followed by "AB" plus version number, for example, 4410ABV2080 which "4410" stands for RSB-4410, "AB" is acronym of Android BSP, "V2080" stands for Version 2.080; other model names list below:
::"3420" stands for ROM-3420
::"5420" stands for ROM-5420
::"7420" stands for ROM-7420
::"DS31" stands for UBC-DS31
::"U220" stands for UBC-220
::"6410" stands for RSB-6410

== <span style="color:#0066cc;">Conventions</span> ==

<span style="color:#800080;">'''${BOARD}'''</span>&nbsp;: target board name (list below)

:rsb_4410 / rom_3420 / rom_5420 / rom_7420 / ubc_ds31 / ubc_200 / rsb_6410

<span style="color:#800080;">'''${BSPHOME}'''</span>&nbsp;: the directory that BSP tarball extacted to

<span style="color:#800080;">'''${SD_DEVICE}'''</span>&nbsp;: device name of SD card in Ubuntu (e.g. /dev/sdf)

<span style="color:#800080;">'''${MMC_DEVICE}'''</span>&nbsp;: device name of on-board eMMC in Android (e.g. /dev/block/mmcblk0)

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 ...)

== <span style="color:#0066cc;">Build Instructions</span> ==

=== <span style="color:#0066cc;">To build everything</span> ===

:Perform one of the following commands in terminal console
:*engineer version (default option)
::<code>$ cd '''<span style="color:#800080;">${BSPHOME</span>}'''/scripts</code>
::<code>$ ./mk_android.sh <span style="color:#800080;">'''${BOARD}'''</span></code>
:*user version
::<code>$ cd <span style="color:#800080;">'''${BSPHOME}'''</span>/scripts</code>
::<code>$ ./mk_android.sh <span style="color:#800080;">'''${BOARD}'''</span> user</code>

=== <span style="color:#0066cc;">To build boot loader</span> ===

:Perform the following command in terminal console
::<code>$ cd <span style="color:#800080;">'''${BSPHOME}'''</span>/scripts</code>
::<code>$ ./mk_bootloader.sh <span style="color:#800080;">'''${BOARD}'''</span></code>

=== <span style="color:#0066cc;">To build boot image</span> ===

:Perform the following command in terminal console
::<code>$ cd <span style="color:#800080;">'''${BSPHOME}'''</span>/scripts</code>
::<code>$ ./mk_bootimg.sh <span style="color:#800080;">'''${BOARD}'''</span></code>

=== <span style="color:#0066cc;">To build recovery image</span> ===

:Perform the following command in terminal console
::<code>$ cd <span style="color:#800080;">'''${BSPHOME}'''</span>/scripts</code>
::<code>$ ./mk_recoveryimg.sh <span style="color:#800080;">'''${BOARD}'''</span></code>

=== <span style="color:#0066cc;">To build system image</span> ===

:Perform the following command in terminal console
::<code>$ cd '''$<span style="color:#800080;">{BSPHOME}</span>'''/scripts</code>
::<code>$ ./mk_systemimg.sh <span style="color:#800080;">'''${BOARD}'''</span></code>

=== <span style="color:#0066cc;">To build OTA image</span> ===

:Perform the following command in terminal console
::<code>$ cd <span style="color:#800080;">'''${BSPHOME}'''</span>/scripts</code>
::<code>$ ./mk_otapackage.sh <span style="color:#800080;">'''${BOARD}'''</span></code>
:and the OTA package, update.zip, is located in the following directory
::../android/out/target/product/<span style="color:#800080;">'''${BOARD}'''</span>.

== <span style="color:#0066cc;">Boot up from SD card or eMMC</span> ==

=== <span style="color:#0066cc;">To create a bootable SD card</span> ===

:Perform the following command in terminal console
::<code>$ cd <span style="color:#800080;">'''${BSPHOME}'''</span>/scripts</code>
::<code>$ ./mksd-android.sh <span style="color:#800080;">'''${SD_DEVICE}'''</span></code>

=== <span style="color:#0066cc;">To transfer whole system to onboard eMMC</span> ===

:Boot up from SD card
:Perform the following commands in debug console
::<code># cd /data/mkimage/scripts</code>
::<code># sh ./mksd-android.sh <span style="color:#800080;">'''${MMC_DEVICE}'''</span></code>
:Remove SD card, then target board can boot up from onboard eMMC.

= Software Functionality =

== <span style="color:#0066cc;">Serial Port Test</span> ==

=== <span style="color:#0066cc;">Serial Port Setup</span> ===

#Click "Serial Port"
#:[[File:Imx6ABV1 APP serialport.png|800px|Imx6ABV1 APP serialport.png]]
#Click "Setup"
#:[[File:Imx6ABV1 serialport setup.png|800px|Imx6ABV1 serialport setup.png]]
#Click "Device" , and choose the used device(e.g. ttymxc1)
#:[[File:Imx6ABV1 serialport setup device 1.png|RTENOTITLE]]
#Click "Baud rate" , and choose the used baudrate(e.g. 115200)
#:[[File:Imx6ABV1 serialport setup device 2.png|RTENOTITLE]]

=== <span style="color:#0066cc;">Console Test</span> ===

#Open one serial console.
#Click "Console"
#:[[File:Imx6ABV1 console.png|800px|Imx6ABV1 console.png]]
#:Typing some characters (e.g. "This is a test. 123456789ABCDEF") then pressing Enter in serial console, the identical message will shows up in reception block as below:
#:[[File:Imx6ABV1 console serialport.png|RTENOTITLE]]
#:On the other hand, typing some message (ex. "MESSAGE from Android") in emission block, the identical message will shows up in serial console as below:
#:[[File:Imx6ABV1 console message from.png|RTENOTITLE]]

=== <span style="color:#0066cc;">Loopback Test</span> ===

#Plug loopback device into COM2
#Click "Loopback"
#:The loopback test result will show up as below
#:[[File:Imx6ABV1 loopback.png|800px|Imx6ABV1 loopback.png]]

=== <span style="color:#0066cc;">Send01010101 Test</span> ===

#Open one serial console.
#Click Send01010101 .
#:The character "U" (b'01010101) will show up continuously as below:
#:[[File:Imx6ABV1 send01010101.png|RTENOTITLE]]

== <span style="color:#0066cc;">Display Output Option</span> ==

=== <span style="color:#0066cc;">Single HDMI Display</span> ===

:Perform the following command in u-boot:
::<code>> setenv bootargs 'console=ttymxc0,115200 androidboot.console=ttymxc0 vmalloc=400M init=/init video=mxcfb0:dev=hdmi,1920x1080M@60,bpp=32 video=mxcfb1:off video=mxcfb2:off video=mxcfb3:off fbmem=28M androidboot.hardware=freescale'</code>
::<code>> saveenv</code>
::<code>> reset</code>

=== <span style="color:#0066cc;">Single VGA Display</span> ===

:Perform the following command in u-boot:
::<code>> setenv bootargs 'console=ttymxc0,115200 androidboot.console=ttymxc0 vmalloc=400M init=/init video=mxcfb0:dev=lcd,1920x1080M@60,bpp=32 video=mxcfb1:off video=mxcfb2:off video=mxcfb3:off fbmem=28M androidboot.hardware=freescale'</code>
::<code>> saveenv</code>
::<code>> reset</code>

=== <span style="color:#0066cc;">Single LVDS Display</span> ===

:Perform the following command in u-boot:
::<code>> setenv bootargs 'console=ttymxc0,115200 androidboot.console=ttymxc0 vmalloc=400M init=/init video=mxcfb0:dev=ldb,1024x768M@60,bpp=24 video=mxcfb1:off video=mxcfb2:off video=mxcfb3:off fbmem=28M androidboot.hardware=freescale'</code>
::<code>> saveenv</code>
::<code>> reset</code>

=== <span style="color:#0066cc;">Dual Display</span> ===

:For example of HDMI & VGA, Perform the following command in u-boot:
::<code>> setenv bootargs 'console=ttymxc0,115200 androidboot.console=ttymxc0 vmalloc=400M init=/init video=mxcfb0:dev=hdmi,1920x1080M@60,bpp=32 video=mxcfb1:dev=lcd,1920x1080M@60,bpp=32 video=mxcfb2:off video=mxcfb3:off fbmem=28M,28M androidboot.hardware=freescale'</code>
::<code>> saveenv</code>
::<code>> reset</code>

== <span style="color:#0066cc;">Network Setup</span> ==

=== <span style="color:#0066cc;">Wi-Fi</span> ===

#Click "Settings"
#:[[File:Imx6ABV1 APP settings.png|800px|Imx6ABV1 APP settings.png]]
#Turn Wi-Fi on
#:[[File:Imx6ABV1 settings wifi on.png|800px|Imx6ABV1 settings wifi on.png]]
#Choose ESSID (e.g. ESSD Testing )
#:[[File:Imx6ABV1 settings wifi choose ESSID.png|800px|Imx6ABV1 settings wifi choose ESSID.png]]
#Input correct password
#:[[File:Imx6ABV1 settings wifi password.png|RTENOTITLE]]
#Wi-Fi Authenticating/Connecting/Obtaining IP address
#:[[File:Imx6ABV1 settings wifi authenticating.png|800px|Imx6ABV1 settings wifi authenticating.png]]
#:[[File:Imx6ABV1 settings wifi connecting.png|800px|Imx6ABV1 settings wifi connecting.png]]
#:[[File:Imx6ABV1 settings wifi obtaining ip.png|800px|Imx6ABV1 settings wifi obtaining ip.png]]
#Wi-Fi connected
#:[[File:Imx6ABV1 settings wifi connected.png|800px|Imx6ABV1 settings wifi connected.png]]

=== <span style="color:#0066cc;">Ethernet</span> ===

#Click "Settings" / "Ethernet configuration" , then Turn on Ethernet
#:[[File:Imx6ABV1 settings ethernet config.png|800px|Imx6ABV1 settings ethernet config.png]]
#Click "Ethernet configuration"
#:[[File:Imx6ABV1 settings ethernet config next level.png|800px|Imx6ABV1 settings ethernet config next level.png]]
#Choose Connection Type (DHCP or Static IP)
#:[[File:Imx6ABV1 settings ethernet config dhcp.png|400px|Imx6ABV1 settings ethernet config dhcp.png]][[File:Imx6ABV1 settings ethernet config static.png|400px|Imx6ABV1 settings ethernet config static.png]]

== <span style="color:#0066cc;">To update system</span> ==

#Refer to 1.4.6 to build OTA package.
#Plug SD card that contains OTA package(update.zip) into SD slot.
#Click "Settings" / "About tablet" / "Addition system updates"&nbsp;:
#:[[File:Imx6ABV1 settings addition system updates.png|800px|Imx6ABV1 settings addition system updates.png]]
#Wait for one moment, system will reboot for updating
#:[[File:Imx6ABV1 poweroff.png|800px|Imx6ABV1 poweroff.png]]
#It will take some time to update.

= System Recovery =

Please refer to [[#To_create_a_bootable_SD_card|1.5.1]] & [[#To_transfer_whole_system_to_onboard_eMMC|1.5.2]] to create a bootable SD card and transfer whole system to on-board eMMC.