VAR-SOM-MX6 Android KK R03

From Variscite Wiki
VAR-SOM-MX6 Android-KK-4.4.2 100 r3 Developers Guide

1 Introduction

This WIKI describes how to build and deploy Android KitKat kit-kat-4-4 on the VAR-SOM-MX6. It is based on Freescale Android-KK-4.4.2 100. This version unifies the support for all platforms (Quad DualLite and Solo) under the same image.

2 Overview

The objective of this document is to guide VAR-SOM-MX6 Android developers to obtain Android KitKat sources, setting up host environment, compilation and deployment.

This document contains instructions for:

  • Hardware and software requirements.
  • Setup the hardware.
  • Setup the toolchain.
  • Download & build the sources.
  • Install the binaries on the VAR-SOM-MX6 SOM.

2.1 Document Reference

This release is based on Freescale Rev android_kk4.4.2_1.0.0-ga, 07/2014 release. Please download and read the below documents inside android_kk4.4.2_1.0.0-ga_docs.tar.

  • Android User's Guide
  • Android Quick Start Guide
  • Android Release Notes
  • Android Frequently Asked Questions

3 Supported hardware and features

Feature
Description
Board support
VAR-DVK-MX6,VAR-SOM-MX6
CPU

i.MX6 Quad
i.MX6 Dual
i.MX6 Dual lite
i.MX6 Solo

Software platform

Freescale Android-KK-4.4.2 100

Nand Recovery NAND-recovery SD V33 - can be downloaded from FTP
NAND Flash size support
128MB up to 1GB
eMMC
up to 64GB
DDR size support configuration
Solo:up to 1GB. DualLite, Dual, Quad: up to 4GB
SD-Card
+
Wired Network
10/100/1000 Mbps Ethernet
Wireless Network
Support for Wilink8, Dual band 5.0ghz + MIMO b/g/n
Bluetooth
+
SPI
+
I2C
+
Canbus
+
USB host
+
USB OTG
Host and Device
Uarts
x3, up to 3.6 Mbps.
RTC
+
Display HDMI: 720P,1080P
LVDS0 (On board LVDS-to-RGB bridge, 800x480 resolution), LVDS1 external display
Audio Line IN/ Line out and Audio over HDMI
Camera ov5640 camera sensor. CB402 board can be ordered separately at : sales@variscite.com
SATA +

4 Hardware Requirements

VAR-SOM-MX6 evaluation kit.

4.1 Host (PC) setup requirements

The host development environment for Android is based on Ubuntu, please install Ubuntu version 12.04 64bit LTS http://www.ubuntu.com/download/desktop


4.1.1 IMPORTANT

Do not use other Ubuntu releases, other than recommended above.

4.1.2 For 64-bit Ubuntu 12.04

The complete Android host requirments:  source.android.com/source/initializing.html Also the instruction are in Freescale "Android User's Guide" manual.

The following command installs the required packages for setting up the android build host:

First:
$ sudo apt-get install libgl1-mesa-dri
Then:
$ sudo apt-get install git gnupg flex bison gperf build-essential \
  zip curl libc6-dev libncurses5-dev:i386 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
$ sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so

In addition to the packages requested on the Android website, the following packages are also needed:

4.1.3 Installing the JDK

The Sun JDK is no longer in Ubuntu's main package repository. In order to download it, you need to add the appropriate repository and indicate which JDK should be used.

Please follow the link for the java install:  https://variwiki.com/index.php?title=VAR-SOM-MX6_Android_GS-java

4.1.4 Additional packages

In addition to the packages requested on the Android website, the following packages are also required:

$ sudo apt-get install uuid uuid-dev
$ sudo apt-get install zlib1g-dev liblz-dev
$ sudo apt-get install liblzo2-2 liblzo2-dev
$ sudo add-apt-repository ppa:git-core/ppa
$ sudo apt-get update
$ sudo apt-get install git-core curl
$ sudo apt-get install uboot-mkimage
NOTE:
The build machine should have at least 30GB of free space to complete the build process.
Please refer to the AOSP documentation for latest information and instructions for setting up other Ubuntu versions http://source.android.com/source/initializing.html

Comment for build error: If this is the first time you build on a 64bit machine you may encounter some error releated to lzo library and other. https://community.freescale.com/thread/303536 has detail information how to fix this.

5 Obtain source code

The Linux kernel and U-Boot are available through Github. Required patches can be found under: /VAR-SOM-MX6/Software/Android_KK/Android-KK4.4.2_Release_100/
Files:

  • android_kk4.4.2_1.0.0-ga_core_source.tar.gz - Freescale's i.MX6 KK4.4.2_100 original patch files.
  • android_kk4.4.2_1.0.0-ga_docs.tar.gz - Freescale i.MX6 KK4.4.2_100 documents
  • var_kk442_100_r3.tar.bz2 - Variscite's VAR-SOM-MX6 SOM patch files

5.1 Unpack Freescale's Android Release Package

$ mkdir ~/var_kk_442_100
$ cd ~/var_kk_442_100
$ tar xvf ~/Downloads/android_kk4.4.2_1.0.0-ga_core_source.tar.gz
$ cd android_kk4.4.2_1.0.0-ga_core_source/code/
$ tar xvf kk4.4.2_1.0.0-ga.tar.gz

5.2 Download Google Android KK4.4.2

The Android source code is maintained in more than 100 different gits in the Android repository (android.googlesource.com).
To get the Android source code from Google repo, follow the steps below:

$ cd ~/var_kk_442_100
$ mkdir kk_442_100_build
$ cd kk_442_100_build
$ mkdir ~/bin
$ curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
$ chmod a+x ~/bin/repo
$ repo init -u https://android.googlesource.com/platform/manifest -b android-4.4.2_r1
$ repo sync
NOTE:
The repo tool which was used by Variscite is available on FTP site.

5.3 Download Variscite's u-boot and Linux kernel

clone kk4.4.2_1.0.0-ga kernel source code from Variscite's open source git:

$ cd ~/var_kk_442_100/kk_442_100_build
$ git clone https://github.com/varigit/linux-2.6-imx.git kernel_imx
$ cd kernel_imx
$ git checkout -b kk4.4.2_1.0.0-ga-var02 remotes/origin/kk4.4.2_1.0.0-ga-var02

clone the U-Boot git repository from Varicite's open source git:

$ cd ~/var_kk_442_100/kk_442_100_build/bootable/bootloader
$ git clone https://github.com/varigit/uboot-imx.git uboot-imx
$ cd uboot-imx
$ git checkout -b kk4.4.2_1.0.0-ga-var02 remotes/origin/kk4.4.2_1.0.0-ga-var02

5.4 Patching the AFS sources with Freescale i.MX6 support

The patch script (and_patch.sh) requires some basic utilities like awk/sed.
Apply all Android patches by using the following steps:

$ cd ~/var_kk_442_100/kk_442_100_build
$ source ../android_kk4.4.2_1.0.0-ga_core_source/code/kk4.4.2_1.0.0-ga/and_patch.sh
$ c_patch ../android_kk4.4.2_1.0.0-ga_core_source/code/kk4.4.2_1.0.0-ga imx_kk4.4.2_1.0.0-ga

5.5 Apply VAR-SOM-MX6 patches

After you setup your build machine,unpack Variscite's release Package:

$ cd ~/var_kk_442_100
$ tar xvf ~/Downloads/var_kk442_100_r3.tar.bz2
$ variscite/install
NOTE: The SPL files have been updated. This is a very critical fix. Please download u-boot-spl.tar.bz2 and replace the files in ~/var_kk_442_100/kk_442_100_build/device/variscite/common/firmware/

6 Build Android Images

6.1 Build the Android Filesystem

Change to Android top level directory.

$ cd ~/var_kk_442_100/kk_442_100_build
NOTE: edit build.sh and set -j4 to a suitable number. A good practice is to set it to number of threads of you build machine minus 1.
  • SD card build
$ ./build.sh mx6 sdcard
  • UBIFS build
$ ./build.sh mx6 ubifs

6.2 Build for 4GB NAND

Edit your BoardConfig.mk located at device/variscite/var_som_mx6q. At the end comment out the UBIFS parameters and add: "
#Micron 4096MB MT29F32G08AFACAWP NAND
TARGET_MKUBIFS_ARGS := -m 4096 -e 516096 -c 7855 -x none
TARGET_UBIRAW_ARGS := -m 4096 -p 512KiB -s 4096 -O 4096 $(UBI_ROOT_INI)
"
Rebuild your ubi system and you will get new ubifs for 4GB nand flash. nand-recovery.sh on the recovery sd card need to be updated with if [ `dmesg |grep MT29F32G08AFACAWP | wc -l` = 1 ] ; then # this is 4GB NAND (MT29F32G08AFACAWP) echo "4GB nand selected ..." ROOTFS_IMAGE=rootfs_4G_NAND.ubi.img ANDROID_SYSTEM=android_root_4G_NAND.img UBI_SUB_PAGE_SIZE=4096 UBI_VID_HDR_OFFSET=4096 fi

7 Boot

The Android can be booted from MMC/SD device on sdcard, UBIFS on NAND and MMC/SD device on eMMC.  nand-recovery version 33 support the nand and eMMC flash.

7.1 Boot From MMC/SD Card

NOTE: VAR-SOM-MX6 can be configured with or without eMMC. eMMC device number is 0 while SD Card is 1.

u-boot will always number the SD Card as 1.
$ booti mmc0 will boot from eMMC.
$ booti mmc1 will boot from SD Card
In case of SOM with eMMC the default partition table is to boot from eMMC. One should change the partition table if boot from SD Card required.

This section will guide you through the process of installing and boot VAR-SOM-MX6 from SD/MMC device.

Create bootable SD card

Variscite provides a script that can be used to partition an SD card and install the required images on it.

  • Insert a micro SD into your Linux PC
  • Determine the block device name of your micro SD (for instance /dev/sdc). Use "dmesg" after you inserted theSD card.
  • Make sure all partitions of your micro SD are unmounted. Use "sudo umount /media/<uname>" to unmount it.
  • cd ~/var_kk_442_100/kk_442_100_build
  • sudo ./mksdcard.sh /dev/sdX mx6 (replace /dev/sdX with your SD card block device)

Use the created SD card and:

  • Insert the SD card you just created into the MMC/SD slot on the custom board.
  • Press and hold the boot-select button and power-on the SOM.

7.2 Boot From NAND Flash or eMMC

Flashing the U-Boot, boot image and Android UBI root file system into NAND can be done from target Linux shell.

The images  can be found at Android build machine under: "out/target/product/var_som_mx6".

Boot the target device using Variscite's pre-build NAND recovery SD image version 33 or greater, then follow the instructions below:

7.2.1 Boot From NAND Flash

$ nand-recovery.sh -o Android

You can also push the Flash Android on the GUI.

7.2.2 Boot From eMMC Flash

$ nand-recovery.sh -o Android -m Emmc

8 Manual operations

8.1 Build boot.img

We use boot.img and booti as default commands to boot rather than the uramdisk and uImage.
You can use this command to generate boot.img under android environment:

$ cd ~/var_kk_442_100/kk_442_100_build
$ source build/envsetup.sh
$ lunch var_som_mx6-user
$ make bootimage

8.2 Toolchain setup for manual build kernel and u-boot

Setup the toolchain path to point to arm-eabi- tools in prebuilts/gcc/linux-x86/arm/arm-eabi-4.6/bin

$ export ARCH=arm
$ export PATH=~/var_kk_442_100/kk_442_100_build/prebuilts/gcc/linux-x86/arm/arm-eabi-4.6/bin:$PATH
$ export CROSS_COMPILE=arm-eabi-

8.3 Manual build Bootloader 

Change directory to u-boot

$ cd ~/var_kk_442_100/kk_442_100_build/bootable/bootloader/uboot-imx 

Execute following commands:

$ make ARCH=arm distclean
$ make mx6_var_som_android_config      # VAR-SOM-MXQ/D/DL/S, boot from MMC
$ make mx6_var_som_nand_android_config # VAR-SOM-MXQ/D/DL/S, boot from NAND
$ make -j4 


This command will generate the u-boot Image 'u-boot.img'

8.4 Manual build Android Linux Kernel and modules

Change directory to kernel

$ cd ~/var_kk_442_100/kk_442_100_build/kernel_imx 

Execute following commands

$ make distclean
$ make var_som_mx6_android_defconfig
$ make -j4 uImage
$ make -j4 modules

This will generate uImage(kernel image) in kernel/arch/arm/boot folder

9 Flashing Android with Fastboot

  1. Connect a USB OTG cable from the target board OTG port to a you host machine USB HOST port.
  2. Power up the board and hit return to stop the boot
  3. type fastboot in the u-boot prompt.

On the target:

$ sudo `which fastboot` flash boot out/target/product/var_som_mx6/boot.img
$ sudo `which fastboot` flash recovery out/target/product/var_som_mx6/recovery.img
$ sudo `which fastboot` flash android_root out/target/product/var_som_mx6/android_root.img
$ sudo `which fastboot` reboot

10 Display Options

Selecting the display type is done by setting the bootcmd with the required display type.

The bootcmd is embedded into boot.img. To set the bootargs edit the file '~/var_kk_442_100/kk_442_100_build/device/variscite/var_som_mx6/BoardConfig.mk' as follows:

  • HDMI
BOARD_KERNEL_CMDLINE := console=ttymxc0,115200 init=/init video=mxcfb0:dev=hdmi,1920x1080M@60,if=RGB24,bpp=32 video=mxcfb1:off video=mxcfb2:off arm_freq=1000 fbmem=48M vmalloc=400M androidboot.console=ttymxc0 androidboot.hardware=freescale
  • Variscite's LCD (Capacitive and resistive)
BOARD_KERNEL_CMDLINE := console=ttymxc0,115200 init=/init video=mxcfb0:dev=ldb,bpp=32 video=mxcfb1:off video=mxcfb2:off arm_freq=1000 fbmem=24M vmalloc=400M androidboot.console=ttymxc0 androidboot.hardware=freescale

11 Android ADB Setup

Android Debug Bridge (adb) is a versatile tool that let you manage the state of the Android-powered device.

For more information about how to setup ADB adb, see TI ADB Setup page at http://processors.wiki.ti.com/index.php/Android_ADB_Setup.

NOTE: When using adb over USB on Windows Machine, edit android_winusb.inf to match VAR-SOM-MX6 vendor and product ids, under [Google.NTx86] section add:

;VAR-SOM-MX6
%SingleAdbInterface%        = USB_Install, USB\VID_18D1&PID_0D02
%CompositeAdbInterface%     = USB_Install, USB\VID_18D1&PID_0D02&MI_00