Android NXP Guide

DART-MX8M - Android O8.1.0_1.3.0 Developer Guide

Introduction

This page describes how to build and deploy Android Oreo on the DART-MX8M.
It is based on NXP's imx_8.1.0_1.3.0_8m_ANDROID release

Overview

The objective of this document is to guide DART-MX8M Android developers to obtain Android Oreo 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 DART-MX8M SOM and variants.

Supported hardware and features

Feature	Description
SOM support	DART-MX8M
Carrier Board support	VAR-DT8MCustomBoard
CPU	i.MX8M
eMMC	up to 64GB
DDR size support configuration	up to 4GB
SD card	+
Wired Network	10/100/1000 Mbps Ethernet
Wireless Network	Support for LWB5, 802.11 ac/a/b/g/n STA, AP, & Wi-Fi Direct Mode SmartConfig
Bluetooth	4.2 / BLE
SPI	+
I2C	+
USB host	+
USB OTG	Host and Device
Uarts	x4, up to 4 Mbps.
RTC	+
Display	HDMI: V2.0a up to 4Kp60 LVDS Dual 1920×1080 24-bit MIPI-DSI 1920×1080 24-bit
Audio	Line IN / HP
Camera	2x MIPI-CSI2
PCIE	+

Hardware Requirements

You will need the Variscite DART-MX8M based evaluation kit.

Host (PC) setup requirements

The host development environment for Android is based on Ubuntu, please install one of the following Ubuntu versions:

• Ubuntu 16.04/18.04 64bit LTS http://www.ubuntu.com/download/desktop

If you are running Linux in a virtual machine you need at least 16GB of RAM and 32 GB of swap.
The build process requires ~250GB of free storage space. Before starting a build, make sure you have adequate free space available.

Note: Do not use other Ubuntu releases other than the ones recommended above. Variscite provides Docker containers that can be used for a development environment as an alternative to using a virtual machine or a dedicated computer.

To learn more, please see Variscite's Docker Build Environment guide.

Windows with WSL/WSL2 is not supported for Android BSP

Install required packages on host PC

$ sudo apt-get -y install gnupg flex bison gperf build-essential zip gcc-multilib g++-multilib 
$ sudo apt-get -y install libc6-dev-i386 lib32ncurses5-dev libncurses5-dev x11proto-core-dev libx11-dev lib32z-dev libz-dev libssl-dev
$ sudo apt-get -y install ccache libgl1-mesa-dev libxml2-utils xsltproc unzip bc
$ sudo apt-get -y install uuid uuid-dev zlib1g-dev liblz-dev liblzo2-2 liblzo2-dev lzop git curl lib32ncurses5-dev 
$ sudo apt-get -y install u-boot-tools mtd-utils android-tools-fsutils device-tree-compiler gdisk m4 dwarves libgnutls28-dev
$ sudo apt-get -y install libelf-dev cpio lz4
$ sudo apt-get -y install swig libdw-dev ninja-build clang liblz4-tool libncurses5 make tar rsync

For Ubuntu 20.04 and above:
The package android-tools-fsutils is obsolete and has been replaced by android-sdk-libsparse-utils.

$ sudo apt-get -y install android-sdk-libsparse-utils

Configure Git

$ git config --global user.name "Your Name"
$ git config --global user.email "Your Email"

Install the OpenJDK

To install it:

$ sudo apt-get update
$ sudo apt-get install openjdk-8-jdk

If your Ubuntu version is missing the package (which shouldn't happen), add the PPA repository and run the previous commands again:

$ sudo add-apt-repository ppa:openjdk-r/ppa

Update the default Java version by running:

$ sudo update-alternatives --config java
$ sudo update-alternatives --config javac

Note: The build process requires about 500GB of free space.

Check python version

In the next steps, we will download (from Google repositories) the command repo, used to download all the Android source repositories.

Recent versions of command repo, rely on python 3.6, not available in Ubuntu 16.04.

Ubuntu 16.04 LTS users can install it running

$ sudo add-apt-repository ppa:deadsnakes/ppa
$ sudo apt-get update
$ sudo apt-get install python3.6 python2

Obtain source code

Variscite's Linux kernel and U-Boot are available through Github.
Required patches for the Android file system are under: https://variscite-public.nyc3.cdn.digitaloceanspaces.com/DART-MX8M/Software/Android/Android_iMX8M_O810_130/ in Variscite's FTP

Files:

• imx-o8.1.0_1.3.0_8m.tar.gz - NXP's Android O8.1.0_1.3.0 original BSP patch files.
  

Get NXP's Android Release Package

$ mkdir ~/var_imx-o8.1.0_1.3.0_8m
$ cd ~/var_imx-o8.1.0_1.3.0_8m
$ curl -o ~/Downloads/imx-o8.1.0_1.3.0_8m.tar.gz https://variscite-public.nyc3.cdn.digitaloceanspaces.com/DART-MX8M/Software/Android/Android_iMX8M_O810_130/imx-o8.1.0_1.3.0_8m.tar.gz
$ tar xvf ~/Downloads/imx-o8.1.0_1.3.0_8m.tar.gz

Download Google Android O8.1.0_r14

Important update:

As of March 31, 2023, all codeaurora.org repositories have been migrated to other platforms and the project has been shut down.
For more information, please visit: https://bye.codeaurora.org/

In this context, errors may occur when downloading the source code running the script, such as:
fatal: unable to look up source.codeaurora.org (port 9418) (No address associated with hostname)

Variscite has updated all relevant software repositories. Please re-download https://variscite-public.nyc3.cdn.digitaloceanspaces.com/DART-MX8M/Software/Android/Android_iMX8M_O810_130/imx-o8.1.0_1.3.0_8m.tar.gz and the full Android source code from Variscite FTP

$ mkdir -p ~/bin
$ curl -o ~/bin/repo https://commondatastorage.googleapis.com/git-repo-downloads/repo
$ chmod a+x ~/bin/repo
$ export PATH=~/bin:$PATH
$ cd ~/var_imx-o8.1.0_1.3.0_8m
$ source imx-o8.1.0_1.3.0_8m/imx_android_setup.sh

• Note : Since Oreo the distribution of Android NXP Source code is partially hosted on Linux Foundation https://source.codeaurora.org/*
• Since Android 12 onwards the Android NXP source code is hosted on GitHub https://github.com/nxp-imx-android

Note: Wait for the script to finish running, and it should create a "~/var_imx-o8.1.0_1.3.0_8m/android_build" folder

$ cd ~/var_imx-o8.1.0_1.3.0_8m/android_build; mkdir -p vendor/variscite/

Clone Variscite's U-Boot and Linux kernel sources

$ cd ~/var_imx-o8.1.0_1.3.0_8m/android_build/vendor/variscite/
$ git clone https://github.com/varigit/uboot-imx.git -b imx_v2017.03_4.9.51_imx8m_ga_var01
$ git clone https://github.com/varigit/linux-imx kernel_imx -b o8.1.0_1.3.0_8m-ga_var01

Apply Variscite's i.MX platforms patches

$ cd ~/var_imx-o8.1.0_1.3.0_8m/android_build/device
$ git clone https://github.com/varigit/MX6x-android.git -b o8.1.0_1.3.0_8m-ga-var01 variscite
$ variscite/scripts/install.sh

Build Android Images

Change to Android top level directory.

$ cd ~/var_imx-o8.1.0_1.3.0_8m/android_build
$ source build/envsetup.sh
$ lunch dart_mx8m-eng
 or
$ lunch dart_mx8m-userdebug

Note: userdebug build creates a debuggable version of Android. eng build creates an engineering version of Android. Development mode enable and development tools are available on target.

$ export PATH=/usr/lib/jvm/java-8-openjdk-amd64/bin:$PATH

Switching from eMMC build to SD card build and vice versa

Unlike previous Android BSPs, the boot media is autodetected at boot time.

Build Android

./imx-make.sh -j4 2>&1 | tee build1-1.log

Images created by the Android build

The resulted images are located in out/target/product/dart_mx8m.

Image	Description
u-boot-imx8m-var-dart.imx	U-Boot for eMMC/SD card boot. SOM agnostics.
system.img	Android system image file. SOM agnostics.
vendor.img	Android vendor image file. SOM agnostics.
boot-<name>.img vbmeta-<name>.img	configuration dependent
<name> is one of:	imx8m-var-dart-emmc-wifi-dcss-lvds - Supports LVDS (via DCSS) / WiFi imx8m-var-dart-emmc-wifi-dual-display - Supports HDMI (via DCSS) / LVDS (via LCDIF) / WiFi imx8m-var-dart-emmc-wifi-hdmi-4k - Supports HDMI-4k / WiFi imx8m-var-dart-emmc-wifi-hdmi - Supports HDMI / WiFi imx8m-var-dart-emmc-wifi-lcdif-lvds - Supports LVDS (via LCDIF) / WiFi imx8m-var-dart-sd-emmc-dcss-lvds - Supports LVDS (via DCSS) / SD imx8m-var-dart-sd-emmc-dual-display - Supports HDMI (via DCSS) / LVDS (via LCDIF) / SD imx8m-var-dart-sd-emmc-hdmi-4k - Supports HDMI-4k (via DCSS) / SD imx8m-var-dart-sd-emmc-hdmi - Supports HDMI (via DCSS) / SD imx8m-var-dart-sd-emmc-lcdif-lvds - Supports LVDS (via LCDIF) / SD

Boot options

Boot options of the Android:
1. Directly from SD card
2. U-Boot boots from on-SOM eMMC

Flash and boot Android from SD card

Create a bootable SD card

Partition and format SD card, and copy all images

$ sudo ./var-mksdcard.sh -f <name> /dev/sdX;sync

• Replace <name> with the actual desired setup name according to the second table in the "Images created by the Android build" section.
• Replace /dev/sdX with your true device, You can identify it with dmesg.

Boot From SD card

• Power-off the board.
• Insert the SD card into the SD card slot of the carrier board (DVK)
• Make sure the Boot Mode is set to SD card: see Setting the Boot Mode section
• Power up the board - it will boot into Linux from the SD card

Flash and boot Android from eMMC

Preparing images

The default system.img and vendor.img format is suitable for flashing using fastboot, and must be modified for flashing using 'dd'.

$ cd out/target/product/dart_mx8m
$ simg2img system.img system_raw.img
$ simg2img vendor.img vendor_raw.img

Flashing Android from Linux shell (when the primary installation android)

An example of flashing eMMC, can be found here.

Follow the following steps instructions above:

1. Preparing a rescue SD card;

2. Flash from command line (use the install_android.sh script)

Further, follow the steps described in paragraph "Flashing Android with USB Fastboot"

Flashing Android with USB Fastboot

Install tools on host

$ sudo apt-get install android-tools-adb android-tools-fastboot

Note: Make sure you built Android for eMMC
Connect the target with host PC at fastboot mode:

1. Connect a USB OTG cable from the target board OTG port to a your host machine USB HOST port.
2. Power up the board and hit return/space to stop the boot at U-Boot.
3. type fastboot 0 in the U-Boot command line.

On the Host PC:

$ sudo `which fastboot` flash boot_a out/target/product/dart_mx8m/boot-<name>.img
$ sudo `which fastboot` flash boot_b out/target/product/dart_mx8m/boot-<name>.img
$ sudo `which fastboot` flash system_a out/target/product/dart_mx8m/system.img
$ sudo `which fastboot` flash system_b out/target/product/dart_mx8m/system.img
$ sudo `which fastboot` flash vendor_a out/target/product/dart_mx8m/vendor.img
$ sudo `which fastboot` flash vendor_b out/target/product/dart_mx8m/vendor.img
$ sudo `which fastboot` flash vbmeta_a out/target/product/dart_mx8m/vbmeta-<name>.img
$ sudo `which fastboot` flash vbmeta_b out/target/product/dart_mx8m/vbmeta-<name>.img
$ sudo `which fastboot` reboot

Replace <name> with the actual desired setup name according to the table in the "Images created by the Android build" section.

Update Android firmware

Generate OTA packages

For generating "OTA" packages, use the following commands:

$ cd ~/var_imx-o8.1.0_1.3.0_8m/android_build
tee build1-1.log

Install OTA package to device

• Extract payload.bin and payload_properties.txt from OTA zip file

• Push file payload.bin to somewhere on the device (typically /cache folder)
• Open payload_properties.txt on an editor to copy its content, lets suppose it's like in the NXP manual:

 FILE_HASH=0fSBbXonyTjaAzMpwTBgM9AVtlBeyOigpCCgkoOfHKY=
 FILE_SIZE=379074366
 METADATA_HASH=Icrs3NqoglzyppyCZouWKbo5f08IPokhlUfHDmz77WQ/de8Dgp9zFXt8Fo+Hxccp465uTOvKNsteWU=
 METADATA_SIZE=46866
 

• Input the following command on the board's console to update:

 su
 update_engine_client --payload=file:///data/ota_package/payload.bin --update --headers="FILE_HASH=0fSBbXonyTjaAzMpwTBgM9AVtlBeyOigpCCgkoOfHKY=
 FILE_SIZE=379074366
 METADATA_HASH=Icrs3NqoglzyppyCZouWKbo5f08IPokhlUfHDmz77WQ/de8Dgp9zFXt8Fo+Hxccp465uTOvKNsteWU=
 METADATA_SIZE=46866"

Make sure that the -- header equals to the exact content of payload_properties.txt without "space" or "return" character.

After issuing the command, nothing seems to happen on the device, but you can monit logcat for operation progress. After a successful update you can reboot into the updated version.

You can check chapter 7 of official NXP "Android User Guide" for further "Over-The-Air (OTA) Update" examples.

Manual operations

Build boot.img

When you perform changes to the kernel, you may build boot.img solely instead of building the whole Android.

$ cd ~/var_imx-o8.1.0_1.3.0_8m/android_build
$ source build/envsetup.sh
$ lunch dart_mx8m-userdebug

$ make bootimage

Toolchain setup for manual build

$ export ARCH=arm64
$ export CROSS_COMPILE=~/var_imx-o8.1.0_1.3.0_8m/android_build/prebuilts/gcc/linux-x86/aarch64/aarch64-linux-android-4.9/bin/aarch64-linux-android-

Unlock device for fastboot

Our build behaves like any other standard Android device.

To use fastboot, you should go through the following steps

• Settings => System => About Tablet => Build number
• keep on tapping until you see a prompt that says "You are now a developer!"
• Settings => System => Advanced => Developer options => OEM unlocking
• reboot to bootloader
• type "fastboot 0" in the U-Boot command line
• run "sudo `which fastboot` oem unlock" from the Host PC
• wait until the unlock process is complete
• proceed for flashing