View source for Android NXP Guide

<!-- Set release according to "release" parameter in URL and use RELEASE_O8.1.0_1.3.0_8M_DART-MX8M as default
--> {{#vardefine:RELEASE_PARAM|{{#urlget:release}}}} <!--
--> {{#lst:Android_Platform_Customization|{{#var:RELEASE_PARAM|RELEASE_O8.1.0_1.3.0_8M_DART-MX8M}}}} <!--
--> {{PageHeader|{{#var:HARDWARE_NAME}} - {{#ifeq:{{#var:ANDROID_NAME}}|Android 10 | Android {{#var:ANDROID_VERSION}} | Android {{#var:ANDROID_NAME}} {{#var:ANDROID_VERSION}} }} Developer Guide}} {{DocImage|category1=Android|category2={{#var:HARDWARE_NAME}}}} __toc__

= Introduction<br/> =

This Wiki describes how to build and deploy {{#ifeq:{{#var:ANDROID_NAME}}|Android 10|{{#var:ANDROID_NAME}}|Android {{#var:ANDROID_NAME}} }} on the {{#var:HARDWARE_NAME}}. It is based on NXP's {{#var:NXP_BSP_VERSION}} release

= Overview =

The objective of this document is to guide {{#var:HARDWARE_NAME}} Android developers to obtain {{#ifeq:{{#var:ANDROID_NAME}}|Android 10|{{#var:ANDROID_NAME}}|Android {{#var:ANDROID_NAME}} }} 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:HARDWARE_NAME}} SOM and variants.

= Supported hardware and features =
{{#lst:Android_Platform_Customization|{{#var:ANDROID_SUPPORTED_HARDWARE_SECTION}}}}

= Hardware Requirements =
You will need the Variscite {{#var:HARDWARE_NAME}} based evaluation kit.

== Host (PC) setup requirements ==

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

If you are running Linux in a virtual machine you need at least 16GB of RAM/swap.

<span style="color:red">Note:</span> Do not use other Ubuntu releases other than the ones recommended above.

=== Install required packages on host PC ===
<pre>
$ 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 x11proto-core-dev libx11-dev lib32z-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
$ sudo apt-get -y install u-boot-tools mtd-utils android-tools-fsutils device-tree-compiler gdisk m4 libz-dev
</pre>

=== 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

<span style="color:red">Note:</span> The build process requires about 135GB of free space.

= Obtain source code =

Variscite's Linux kernel and U-Boot are available through Github.<br>
Required patches for the Android file system are under: {{#var:ANDROID_VARFTP_PATCH_DIR}} in Variscite's FTP<br>
<br>
Files:<br>
* {{#var:ANDROID_VARFTP_BASE_PATCH_FILE}} - NXP's i.MX8M {{#var:ANDROID_NXP_VERSION}} original BSP patch files.<br>

== Get NXP's Android Release Package ==
 $ mkdir {{#var:BUILD_FOLDER}}
 $ cd {{#var:BUILD_FOLDER}}
 $ curl -o ~/Downloads/{{#var:ANDROID_VARFTP_BASE_PATCH_FILE}} {{#var:ANDROID_VARFTP_PATCH_DIR}}{{#var:ANDROID_VARFTP_BASE_PATCH_FILE}}
 $ tar xvf ~/Downloads/{{#var:ANDROID_VARFTP_BASE_PATCH_FILE}}

== Download Google Android {{#var:ANDROID_VERSION}} ==
 $ mkdir -p ~/bin
 $ curl -o ~/bin/repo http://commondatastorage.googleapis.com/git-repo-downloads/repo
 $ chmod a+x ~/bin/repo
 $ export PATH=~/bin:$PATH
 $ cd {{#var:BUILD_FOLDER}}
 $ source {{#var:ANDROID_FOLDER_ID}}/imx_android_setup.sh
* Note : Since Oreo the distribution of Android Source code is partially hosted on Linux Foundation https://source.codeaurora.org/*
Wait for the script to finish running, and it should create a "{{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}" folder
 $ cd {{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}; mkdir -p vendor/variscite/

== Clone Variscite's U-Boot and Linux kernel sources ==
 $ cd {{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}/vendor/variscite/
 $ git clone {{#var:U-BOOT_GIT}} -b {{#var:U-BOOT_BRANCH}}
 $ git clone {{#var:KERNEL_GIT}} kernel_imx -b {{#var:KERNEL_BRANCH}}

== Apply Variscite's i.MX platforms patches ==
 $ cd {{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}/device
 $ git clone {{#var:ANDROID_VARISCITE_GIT}} -b {{#var:ANDROID_VARISCITE_BRANCH}} variscite
 $ variscite/scripts/install.sh

= Build Android Images =

Change to Android top level directory.
 $ cd {{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}
 $ source build/envsetup.sh
 {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
 $ lunch {{#var:ANDROID_MACHINE_NAME}}-userdebug
 |
 $ lunch {{#var:ANDROID_MACHINE_NAME}}-eng
 or
 $ lunch {{#var:ANDROID_MACHINE_NAME}}-userdebug
 }}

<span style="color:red">Note:</span> 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 ==
 $ {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |./imx-make.sh|make}} -j4 2>&1 | tee build1-1.log

== Images created by the Android build ==
The resulted images are located in out/target/product/{{#if: {{#var:ANDROID_PRODUCT_NAME}} | {{#var:ANDROID_PRODUCT_NAME}} | {{#var:ANDROID_MACHINE_NAME}} }}.

{{#lst:Android_Platform_Customization|{{#var:ANDROID_IMAGES_SECTION}}}}
{{#ifeq:{{#var:ANDROID_DYNAMIC_PARTITION}}|true |
<span style="color:red">Note:</span> To create images with no dynamic support please follow [[Android_10_no_dynamic_partition]]
}}

= Boot options=

Boot options of the Android:<br>
1. Directly from SD card<br>
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
<pre>
$ sudo ./var-mksdcard.sh -f <name> /dev/sdX;sync
</pre>
* Replace <name> with the actual desired setup name according to the second table in the [[#Images_created_by_the_Android_build|"Images created by the Android build" section]].
* Replace /dev/sdX with your true device, You can identify it with dmesg.

=== Boot From SD card ===
{{#lst:Android_Recovery_SD_card|BOOT_FROM_SD_CARD}}

== Flash and boot Android from eMMC ==

=== Preparing images ===

{{#ifeq:{{#var:ANDROID_DYNAMIC_PARTITION}}|true |
The default super.img, format is suitable for flashing using fastboot, and must be modified for flashing using 'dd'.

 $ cd out/target/product/{{#if: {{#var:ANDROID_PRODUCT_NAME}} | {{#var:ANDROID_PRODUCT_NAME}} | {{#var:ANDROID_MACHINE_NAME}} }}
 $ simg2img super.img super_raw.img
|
{{#ifeq:{{#var:ANDROID_NAME}}|Android 10 |
The default system.img, vendor.img and product.img format is suitable for flashing using fastboot, and must be modified for flashing using 'dd'.
|
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/{{#if: {{#var:ANDROID_PRODUCT_NAME}} | {{#var:ANDROID_PRODUCT_NAME}} | {{#var:ANDROID_MACHINE_NAME}} }}
 $ simg2img system.img system_raw.img
 $ simg2img vendor.img vendor_raw.img
 {{#ifeq:{{#var:ANDROID_NAME}}|Android 10| $ simg2img product.img product_raw.img}}
 }}

=== Flashing Android from Linux shell (when the primary installation android) ===
An example of flashing eMMC, can be found {{Varlink|Android Recovery SD card|{{#var:RELEASE_PARAM|RELEASE_O8.1.0_1.3.0_8M_DART-MX8M}}|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 ====
<pre>
$ sudo apt-get install android-tools-adb android-tools-fastboot
</pre>

<span style="color:red">Note:</span> Make sure you built Android for eMMC
<br>
'''Connect the target with host PC at fastboot mode:'''
#Connect a USB OTG cable from the target board OTG port to a your host machine USB HOST port.
#Power up the board and hit return/space to stop the boot at U-Boot.
#type '''fastboot q''' in the U-Boot command line.

'''On the Host PC:'''
{{#lst:Android_Platform_Customization|{{#var:ANDROID_FASTBOOT_SECTION}}}}
Replace ''<name>'' with the actual desired setup name according to the table in the [[#Images_created_by_the_Android_build|"Images created by the Android build" section]].

=== Android recovery mode ===
==== Enter board in Android Recovery mode ====
If you are using DT8MCustomBoard or you implemented any recovery key detection in uboot, the device can powered on in recovery mode by holding down the "back" (or any other recovery key) button until the end of the boot, showing the "Android Recovery" menu.

Alternatively you can issue the command reboot recovery from the Android console (or using adb shell).

==== Control menu in Android Recovery Mode ====

If the board has UP, DOWN keys (like DT8MCustomBoard)

# To cycle between menu items, use a short press of UP or DOWN buttons
# To highlight an item, use a long press of BACK or HOME buttons or long touch the touchscreen
# To activate an item, use a short press of ON/OFF button

If the board has no UP and DOWN keys (like SymphonyBoard)

# To cycle between menu items, use a short press of any buttons or select the item with the touchscreen
# To activate an item, use a long press of any buttons or of the touchscreen

==== Update Android firmware ====

===== Generate OTA packages =====
For generating "OTA" packages, use the following commands:
 $ cd {{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}
 {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
 $ source build/envsetup.sh 
 $ lunch PRODUCT={{#var:ANDROID_MACHINE_NAME}}-userdebug
 $ ./imx-make.sh bootloader kernel -j4
 $ make otapackage -j4 
 |
 $ make PRODUCT={{#var:ANDROID_MACHINE_NAME}}-eng otapackage -j4 2>&1 | tee build1-1.log
 }}

===== Install OTA package to device =====
* extract payload.bin and payload_properties.txt from OTA zip file
  {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
* Push payload.bin to board's /sdcard dir: adb push payload.bin /sdcard/ .
  |
* 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
  {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
  METADATA_HASH=Icrs3NqoglzyppyCZouWKbo5f08IPokhlUfHDmz77WQ=
  |
  METADATA_HASH=Icrs3NqoglzyppyCZouWKbo5f08IPokhlUfHDmz77WQ/de8Dgp9zFXt8Fo+Hxccp465uTOvKNsteWU=
  }}
  METADATA_SIZE=46866
  {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
* Input the following command on the board's console to update:
  su
  update_engine_client --payload=file:///sdcard/payload.bin --update --headers="FILE_HASH=0fSBbXonyTjaAzMpwTBgM9AVtlBeyOigpCCgkoOfHKY=
  |
* Issue the following command on adb shell:
  update_engine_client --payload=file:///cache/payload.bin --update --headers="FILE_HASH=0fSBbXonyTjaAzMpwTBgM9AVtlBeyOigpCCgkoOfHKY=
  }}
  FILE_SIZE=379074366
  {{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
  METADATA_HASH=Icrs3NqoglzyppyCZouWKbo5f08IPokhlUfHDmz77WQ=
  |
  METADATA_HASH=Icrs3NqoglzyppyCZouWKbo5f08IPokhlUfHDmz77WQ/de8Dgp9zFXt8Fo+Hxccp465uTOvKNsteWU=
  }}
  METADATA_SIZE=46866"

{{#ifeq: {{#var:ANDROID_NAME}} | Android 10 |
Make sure that the -- header equals to the exact content of payload_properties.txt without "space" or "return"
character.
|
Note that the command argument --headers="..." contains the exact (4-line) content of the payload_properties.txt file between quotes (you can copy and paste it), including 3 newline characters.
}}
 
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:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}
 $ source build/envsetup.sh
 $ lunch {{#var:ANDROID_MACHINE_NAME}}-userdebug
 $ make bootimage

== Toolchain setup for manual build ==
Setup the toolchain path to point to arm-linux-androideabi- tools in prebuilts/gcc/linux-x86/aarch64/aarch64-linux-android-4.9/bin
 $ export ARCH=arm64
 $ export CROSS_COMPILE={{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_ANDROID}}/prebuilts/gcc/linux-x86/aarch64/aarch64-linux-android-4.9/bin/aarch64-linux-android-

{{#if: {{#var:ANDROID_FASTBOOT_NEED_UNLOCK}} |
== 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

}}