Skip to content

build-tutorial.md

Latest commit

 

History

History
156 lines (104 loc) · 4.69 KB

build-tutorial.md

File metadata and controls

156 lines (104 loc) · 4.69 KB
Raw

Tutorial to build Servonk

This tutorial was made using Antergos, an Arch distro based, but can be expanded to other distros.

B2G steps

You need to do a B2G build for your device (eng or userdebug to get root access), as this is not properly setup with the Android build system yet. If you need more info, this is a good first place to start.

Clone the B2G repository and enter to b2g directory.

git clone https://github.com/mozilla-b2g/B2G && cd b2g

Configure USB access.

wget -S -O - https://raw.githubusercontent.com/cm-b2g/B2G/1230463/tools/51-android.rules | sudo tee >/dev/null /etc/udev/rules.d/51-android.rules; sudo udevadm control --reload-rules

Configure ccache

ccache -M 50G

Enable multilib on Arch and install dependencies.

sudo pacman -S --needed alsa-lib autoconf2.13 bison ccache curl firefox flex gcc-multilib git gperf libnotify libxt libx11 mesa multilib-devel wget wireless_tools yasm zip lib32-mesa lib32-mesa-libgl lib32-ncurses lib32-readline lib32-zlib lzop

Configure Python. Remember to use virtualenv every time you try to compile.

sudo pacman -S python-virtualenvwrapper
source /usr/bin/virtualenvwrapper.sh
mkvirtualenv -p `which python2` firefoxos
workon firefoxos

Verify that all works.

python --version

Gives as result Python 2.7.XX.

Install Android tools.

yaourt -S android-sdk

Optionally you can install all the Android development tools.

yaourt -S android-sdk android-sdk-build-tools android-sdk-platform-tools android-platform

Plug your phone and make a copy of propietary blobs. Ensure you device has Remote Debugging enabled in Developer settings. Confirm your device is visible with the adb devices command, you should see something similar to this:

$ adb devices
List of devices attached
ABCXXXXXXX       device

If no device is listed, check your UDEV rules.

If you have permission issues, check that your screen is unlocked and that you have authorized access to your phone. You see a message on your device for that. If the issue persists used adb root and adb remount.

Back up the phone's partitions with the adb pull command:

adb pull /system <backup target dir>/system

Depending on the phone, you may also need to pull the /data and /vendor directories:

adb pull /data <backup target dir>/data
adb pull /vendor <backup target dir>/vendor

If the pull commands fail with an insufficient permission message, try the following:

  • Check you have granted root permissions within your custom ROM (e.g. under CyanogenMod, change Settings > System > Developer Options > Root Access to Apps and ADB or ADB only).
  • Verify that you have set up the udev rule correctly (see For Linux: configure the udev rule for your phone).

Remember to plug your phone. Now config, build and flash B2G on your phone. This is only necessary to build gonk, not gecko or gaia. A simple way to remove these from the build after running ./config.sh is to edit b2g.mk in gonk-misc repository and comment out the gecko and gaia lines, as shown in this git diff: https://pastebin.com/sdQG3Tki

./config.sh <device_platform_name>
./build.sh
./flash.sh

Servonk steps

Install rustup.

sudo pacman -S rustup

Clone the repo and enter to the servonk directory

cd .. && git clone https://github.com/fabricedesre/servonk.git && cd servonk

Run to install the Rust toolchain

./bootstrap.sh

Set the next environment variables:

export GONK_DIR=/path/to/b2g/repository
export GONK_PRODUCT_NAME=product_name

The product name for Android devices can bee seen here in the Device column.

The product name for FirefoxOS devices can bee seen here and here in the nickname or Name/Codename cell. This may not work depending on the device.

To build, run:

# For a Gonk build
./servonk build gonk --release

# Or for a desktop version
./servonk build glutin --release

Running

On desktop run:

./servonk run glutin

On mobile/Gonk, you first need to flash your device with B2G before running:

./servonk flash gonk
./servonk run gonk

The lockscreen code is 4242.