Open Devices

For some of the Xperia™ devices, we provide Android™ Open Source Project (AOSP) device configurations on GitHub. This means that the software will be open for you as a developer to use and contribute to. This is a way for us to support the open Android community, and it is also a tool for us to facilitate and verify contributions to AOSP.

Build AOSP KitKat 4.4

1. Prepare your Java environment

To prevent errors generated by having the wrong version of Java installed on your computer, we will start by removing any conflicting Java version and adding the correct version. Java 6 is needed to build Android 4.4.x.

  1. On your computer: In a terminal window, enter the following command:

sudo apt-get purge openjdk-\* icedtea-\* icedtea6-\*

  1. A guide will appear on the screen. Follow the instructions to remove Java.
  2. Once Java is removed, install the correct version of Java by entering the following commands in a terminal window:

sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update && sudo apt-get install oracle-java6-installer
java -version

You should now see something similar to the following in your terminal window:

java version "1.6.0_45"
Java(TM) SE Runtime Environment (build 1.6.0_45-b06)
Java HotSpot(TM) 64-Bit Server VM (build 20.45-b01, mixed mode)

2. Install the necessary tools to make an Android build

To be able to build the images that you will later flash on your device, you need to install a set of software packages and libraries which give you the tools to compile source code into binary files that can run on your device.

  1. In a terminal window, enter the following commands, all at once:

sudo apt-get install git gnupg ccache lzop flex bison gperf build-essential zip curl zlib1g-dev zlib1g-dev:i386 libc6-dev lib32bz2-1.0 lib32ncurses5-dev x11proto-core-dev libx11-dev:i386 libreadline6-dev:i386 lib32z1-dev libgl1-mesa-glx:i386 libgl1-mesa-dev g++-multilib mingw32 tofrodos python-markdown libxml2-utils xsltproc libreadline6-dev lib32readline-gplv2-dev libncurses5-dev bzip2 libbz2-dev libbz2-1.0 libghc-bzlib-dev lib32bz2-dev squashfs-tools pngcrush schedtool dpkg-dev
sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so

Now you have the tools you need to compile and build a flashable AOSP image. Follow the steps below to learn how to do this.

3. Download Repo tool and set PATH

In order to access and use the source code available on the Sonyxperiadev GitHub, you need to install the Repo tool that is provided by Google.

  1. In a terminal window, enter the following commands to download and install Repo, and set the right access rules for it:

mkdir ~/bin
curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo

  1. Open the bashrc file included in the repo tool:

nano ~/.bashrc

  1. To set the right path for your local bin folder, paste the following code to a new line at the very bottom of the bashrc file, and then save the file using Ctrl+X:

export PATH=~/bin:$PATH

  1. Reload bash variables to include the new path:

source ~/.bashrc

Now you have all the tools you need and can move on to initializing the AOSP code and Xperia device configurations. Learn how to do this below!

4. Initialise the AOSP tree

The next step is to create a folder on your computer, and then download the Android source code to it. Follow the steps below to do this.

  1. In a terminal window, enter the following commands:

mkdir ~/android
cd ~/android
repo init -u https://android.googlesource.com/platform/manifest -b android-4.4.4_r2
repo sync

Note: The downloaded data is around 10 GB. Depending on your Internet connection, it can take quite a long time to download the source code. When the download has finished you have the basic AOSP source code on your computer.

  1. Create and open a file where you will later add Sony’s repos containing the device configurations for Xperia devices, by entering the following commands:

mkdir .repo/local_manifests/
nano .repo/local_manifests/sony.xml

  1. Add repos for Xperia devices by copying and pasting the following text into the file, and then save the file using Ctrl+X:
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<remote  name="sony" fetch="git://github.com/sonyxperiadev/" />
<remove-project name="platform/hardware/qcom/keymaster" />
<remove-project name="platform/hardware/qcom/media" />
<remove-project name="platform/hardware/qcom/msm8960" />
<remove-project name="platform/hardware/qcom/sensors" />
<remove-project name="platform/hardware/invensense" />
<remove-project name="platform/hardware/akm" />
<project path="device/sony/lagan" name="device-sony-lagan" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/yuga" name="device-sony-yuga" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/rhine" name="device-sony-rhine" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/honami" name="device-sony-honami" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/shinano" name="device-sony-shinano" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/sirius" name="device-sony-sirius" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/yukon" name="device-sony-yukon" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/eagle" name="device-sony-eagle" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/flamingo" name="device-sony-flamingo" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/seagull" name="device-sony-seagull" groups="device" remote="sony" revision="kk_mr2" />
<project path="device/sony/tianchi" name="device-sony-tianchi" groups="device" remote="sony" revision="kk_mr2" />
<project path="vendor/sony/system/dash" name="DASH" groups="device" remote="sony" revision="master" />
<project path="vendor/sony/system/thermanager" name="thermanager" groups="device" remote="sony" revision="master" />
<project path="vendor/sony/system/mkqcdtbootimg" name="mkqcdtbootimg" groups="device" remote="sony" revision="master" />
</manifest>

Note: These repos include a precompiled kernel. If you want to change or improve the kernel, you can recompile a new kernel. The new kernel binary should be placed in the corresponding device repository along with new kernel modules for wireless hardware. For more information, see the page how to rebuild kernels for Xperia devices.

  1. Find and download the software binaries for the device you want to use on Sony’s AOSP for Xperia devices
  2. In the root of your Android code tree, unzip the software binaries file you downloaded.
  3. You should now have a number of new directories in your vendor To make sure, enter the following command in a terminal window:

ls vendor/sony

This should give you the output:

eagle flamingo honami lagan rhine seagull shinano sirius system tianchi yuga yukon
  1. To download the code into the device repos created above, run the command
repo sync

5. Add necessary patches from the AOSP upstream branch

In order for certain functions to work on the hardware in Xperia devices, you need to add a set of patches from the AOSP master branch. This is done by executing the following commands:

  1. In a terminal window, enter:

cd build
git cherry-pick 612e2cd0e8c79bc6ab46d13cd96c01d1be382139
cd ..
cd hardware/qcom/bt
git cherry-pick 5a6037f1c8b5ff0cf263c9e63777444ba239a056
cd ../../../
cd hardware/qcom/audio
git cherry-pick 00f6869a0981b570f90dbf39981734f36eafdfa9
git cherry-pick 20bcfa8b451941843e8eabb5308f1f04f07d347a
cd ../../../
cd hardware/qcom/display
git cherry-pick d5ae1812a9509d8849f4494fcf17f68bf33f533c
git cherry-pick 5898f2e789800fb196ce94532eef033e7d7e60b3
cd ../../../

Note: This information will be updated continuously for new Android versions and new devices, so you should always check the AOSP section on Developer World for the latest patches.

6. Build AOSP images that can be flashed

Now you are ready to build AOSP images that can be flashed to a device. To do this, you have to point out your specific device and then start building the images.

  1. Enter the following commands:

source build/envsetup.sh && lunch

  1. When prompted, pick the number corresponding to your device in the list displayed and press enter.
  2. To start the build, type:
make –j <em><insert the cpu thread number of your computer></em>

This step will take a long time. It may take up to several hours, so go grab a coffee or play a game while you wait. When it’s done, AOSP images that can be flashed to a device will be ready.

7. Flash AOSP image to your device

Before you flash the images that you built in the previous step, you must make sure your device is unlocked through Sony’s unlock bootloader service. Then you can flash the AOSP images on your device by following these steps:

  1. On your device: Connect the device to your computer in Fastboot mode, by pressing volume up while inserting the USB cable. When the device is in Fastboot mode, the LED on the device will be illuminated in blue.
  2. On your computer: Flash the boot, system and userdata images by entering the following commands in a terminal window:

fastboot flash boot out/target/product/<device>/boot.img
fastboot flash system out/target/product/<device>/system.img
fastboot flash userdata out/target/product/<device>/userdata.img

Note: It’s not necessary to re-flash the userdata every time you flash your device, but sometimes the new software is incompatible with previous content, which might result in a device that doesn’t boot. If you experience this, try to re-flash only the userdata again.

  1. Now when you disconnect your device from the computer and start it, it will be running AOSP.

We hope this tutorial will help you get started building your own version of Android for Xperia devices.

Feel free to contribute your work back to our repositories on our Sonyxperiadev GitHub account.

We will review and merge your code as soon as possible.