Device configuration for Fairphone 3

Device specifications

Basic	Spec Sheet
CPU	Octa-core 1.8 GHz Cortex-A53
CHIPSET	Qualcomm SDM632 Snapdragon 632
GPU	Adreno 506
Memory	4GB
Shipped Android Version	9.0 (Pie)
Internal Storage	64GB
microSD	Up to 400GB (dedicated slot)
Battery	3000 mAh
Dimensions	158 x 71.8 x 9.89 mm
Display	2160 x 1080 pixels, 5.65-inch IPS LCD
Rear Camera	12 MP (f/1.8, 1/2.55", PDAF)
Front Camera	8 MP (f/2.0, 1/4", HDR)

Introduction

This is the device tree to build LineageOS 16 for the Fairphone 3.

Originally it was started with the base configuration of Motorola's SDM632 platform and the river configuration was used as an example. Some settings and the kernel originate from k4y0z's amazing work for porting TWRP to Fairphone 3.

Since the /e/ foundation published the sources for FP3 support this was used as base. Advantages are:

We can easily sync between the repos.
Nearly everything is working with it incl. AVB, SELinux etc.

Current Status

It builds successfully. ✔️
Device boots and adb can be accessed. ✔️
Bootanimation is shown. ✔️
LineageOS is booting completely. ✔️
Working things after quick test:
- Display / Touchscreen ✔️
- Sound ✔️
- Bluetooth ✔️
- Camera ✔️
- Wi-Fi ✔️
- NFC ✔️
- Device encryption ✔️
- Fingerprint sensor ✔️
- LTE ✔️
- GPS ✔️

Known Issues

These things are untested or known not to work:

Updater
Playing videos in fullscreen causing some overlay issue in Chrome

Kernel Source

Kernel is taken from /e/ project now.

It has added the qcom specific audio-kernel stuff in techpack/audio and the prima WLAN drivers.

Kernel sources are here in the lineage-16.0 branch: https://github.com/WeAreFairphone/android_kernel_fairphone_sdm632/tree/lineage-16.0

How to build

Follow the first steps for setting up the LineageOS build system as described e.g. here. Be aware that a complete build can occupy up to 200G of disk space!
Before downloading the source code using repo sync, create a local manifest file in .repo/local_manifests. From the top of the source tree this command can be used:

mkdir -p .repo/local_manifests
cat <<EOF > .repo/local_manifests/roomservice.xml
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
  <project name="WeAreFairphone/android_device_fairphone_FP3" path="device/fairphone/FP3" revision="lineage-16.0" remote="github" />
  <project name="WeAreFairphone/android_kernel_fairphone_sdm632" path="kernel/fairphone/sdm632" revision="lineage-16.0" remote="github" sync-s="true" />
  <remove-project name="LineageOS/android_hardware_qcom_audio" />
  <project name="WeAreFairphone/android_hardware_qcom_audio" path="hardware/qcom/audio-caf/msm8996" revision="v1-pie-caf-8996" remote="github" />
  <project name="FairBlobs/proprietary_vendor_fairphone" path="vendor/fairphone/FP3" revision="lineage-16.0" remote="github" />
  <project name="LineageOS/android_packages_resources_devicesettings" path="packages/resources/devicesettings" remote="github" />
  <project name="LineageOS/android_external_bson" path="external/bson" remote="github" />
  <project name="LineageOS/android_system_qcom" path="system/qcom" remote="github" />
  <remove-project name="LineageOS/android_external_chromium-webview"/>
  <project path="external/chromium-webview" name="LineageOS/android_external_chromium-webview" groups="pdk" revision="lineage-16.0" />
</manifest>
EOF

This is a temporary hack while we are working outside of the LineageOS repositories. Note that we are pulling in proprietary blobs from a repository, see the section below for how these can be extracted from a firmware image or running device.

Do repo sync -c to download all needed project repositories.
Then do

. build/envsetup.sh
brunch FP3 eng

Use docker to build

Alternatively the docker image from the microG project can be used for building more easily. It supports building with and without the microG patches.

Go to a preferred work directory and create the required folders if not already done:

mkdir cache keys lineage logs manifests zips

Create the local manifest file in manifest directory:

cat <<EOF > manifests/roomservice.xml
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
  <project name="WeAreFairphone/android_device_fairphone_FP3" path="device/fairphone/FP3" revision="lineage-16.0" remote="github" />
  <project name="WeAreFairphone/android_kernel_fairphone_sdm632" path="kernel/fairphone/sdm632" revision="lineage-16.0" remote="github" sync-s="true" />
  <remove-project name="LineageOS/android_hardware_qcom_audio" />
  <project name="WeAreFairphone/android_hardware_qcom_audio" path="hardware/qcom/audio-caf/msm8996" revision="v1-pie-caf-8996" remote="github" />
  <project name="FairBlobs/proprietary_vendor_fairphone" path="vendor/fairphone/FP3" revision="lineage-16.0" remote="github" />
  <project name="LineageOS/android_packages_resources_devicesettings" path="packages/resources/devicesettings" remote="github" />
  <project name="LineageOS/android_external_bson" path="external/bson" remote="github" />
  <project name="LineageOS/android_system_qcom" path="system/qcom" remote="github" />
  <project name="lineageos4microg/android_prebuilts_prebuiltapks" path="prebuilts/prebuiltapks" remote="github" revision="master" />
  <remove-project name="LineageOS/android_external_chromium-webview"/>
  <project path="external/chromium-webview" name="LineageOS/android_external_chromium-webview" groups="pdk" revision="lineage-16.0" />
</manifest>
EOF

Then only the docker command with correspondig parameters needs to be executed:

docker run \
    -e "BRANCH_NAME=lineage-16.0" \
    -e "DEVICE_LIST=FP3" \
    -e "SIGN_BUILDS=false" \
    -e "INCLUDE_PROPRIETARY=false" \
    -e "CLEAN_AFTER_BUILD=false" \
    -v "lineage:/srv/src" \
    -v "$(pwd)/zips:/srv/zips" \
    -v "$(pwd)/logs:/srv/logs" \
    -v "$(pwd)/cache:/srv/ccache" \
    -v "$(pwd)/keys:/srv/keys" \
    -v "$(pwd)/manifests:/srv/local_manifests" \
    lineageos4microg/docker-lineage-cicd

This automatically downloads the docker image the first time. Afterwards the docker image is started and the build process begins. This may take some time, especially on first build. Detailed logs are written to the logs folder. This can be followed, e.g. with tail -f logs/...

If used more regularly it makes sense to put the command into a shell script. This also allows easier modification of the parameters.

To build with microG patches and pre-installed F-Droid etc., add these parameter lines to the command:

    -e "SIGNATURE_SPOOFING=restricted" \
    -e "CUSTOM_PACKAGES=GmsCore GsfProxy FakeStore MozillaNlpBackend NominatimNlpBackend com.google.android.maps.jar FDroid FDroidPrivilegedExtension " \

More settings and descriptions can be found in the README of the docker image.

How to install

With generated vbmeta.img it shouldn't be required to have both slots in successful state anymore (details here). However it makes sense to have a working fallback to ensure nothing gets bricked. As always backup is highly recommended anyway.

With TWRP

The generated update package can be flashed with TWRP. TWRP flashes it to the currently inactive slots and activates it afterwards. The built package can be found in out/target/product/FP3 with a name similar to lineage-16.0-20200505-UNOFFICIAL-FP3.zip. Alternatively the package can also be taken from an UNOFFICIAL release.

Boot TWRP from bootloader:

fastboot boot twrp_image.img

In TWRP you can sideload the package then. Go to Advanced -> ADB Sideload -> Swipe Run

adb sideload lineage-16.0-20200509-UNOFFICIAL-FP3.zip

Adapt the file name of course. This should flash it to the inactive slot and activate it on success.

Alternatively you can push the package to sd-card and install it from TWRP:

adb push lineage-16.0-20200509-UNOFFICIAL-FP3.zip /sdcard

Optional when coming from stock firmware: Format data from TWRP.

If this is not done LineageOS will reboot and ask you for it.

Reboot and LineageOS should boot up.

With fastboot

The image files can also be flashed directly with fastboot.

fastboot flash system out/target/product/FP3/system.img
fastboot flash vendor out/target/product/FP3/vendor.img
fastboot flash product out/target/product/FP3/product.img
fastboot flash boot out/target/product/FP3/boot.img
fastboot flash dtbo out/target/product/FP3/dtbo.img
fastboot flash vbmeta out/target/product/FP3/vbmeta.img

If coming from stock firmware formating data is recommended to prevent LineageOS from asking for it:

fastboot -w

Disabling verity should not be required anymore as long as the images are not modified afterwards, e.g. something is intalled to system or boot partition. In that case boot into TWRP and disable verity with adb:

adb disable-verity

How to update

So far OTA update are not available and are untested as well. That means updates need to be done manually. For that boot to recovery mode and simply sideload the new package.

Alternatively TWRP can be booted and the new package can be installed from there. Of course flashing images directly with fastboot is also possible.

How to extract proprietary blobs

At the moment we manage blobs in a dedicated repository. If you wish to use a different set of blobs, then we can offer you the following hints.

As an example stock 110 release firmware dump from k4y0z can be used.

The files may be compressed with brotli.
- Install a brotli tool if necessary, e.g. with sudo apt-get install brotli under Ubuntu.
- Extract *.br files with: brotli -d *.br
- The *.dat files then need to be converted to *.img files with sdat2img tool which comes with LOS.

vendor/lineage/build/tools/sdat2img.py system.transfer.list system.new.dat system.img
vendor/lineage/build/tools/sdat2img.py vendor.transfer.list vendor.new.dat vendor.img
vendor/lineage/build/tools/sdat2img.py product.transfer.list product.new.dat product.img

Mount system and vendor image and run the script on the folder:

mkdir tmp
sudo mount -o ro,loop system.img tmp
sudo mount -o ro,loop vendor.img tmp/vendor
cd device/fairphone/FP3
./extract-files.sh ../../../tmp

If file access permissions are missing correct these with chown before calling extract_files.sh and don't flash image files anymore after that:

sudo chown -R $(id -un):$(id -gn) tmp