**Warning**: While backing up to internal device storage is possible for some devices, if during porting you end up overwriting that partition, your backups will be gone. In that case (and in case of devices without SD card slots), it’s better to also copy the backup data to your development machine (e.g. via adb pull in recovery). Recent versions of adb support full-device backups to a host computer using the adb backup feature. See the ClockworkMod Instructions for additional help.
### 3.2 Flash and Test your Android base image Flash an image that you built or obtained of your Android base, whether it’s LineageOS, CAF, AOSP, or another. The official LineageOS flashing instructions can be found on this LineageOS wiki page. You may also want to verify that the Android base build for your device is fully functional, to avoid wasting time with hardware adaptations that have known issues. Also, your device might have some hardware defects - testing in Android verifies that all components are working correctly, so you have a functionality baseline to compare your Sailfish OS build results with. You should at least check the following features: • OpenGL ES 2.0: Use e.g. Gears for Android to test (the hz you will get there will be max refresh rate). • WLAN connectivity: Connect to an AP, ad-hoc or set up a mobile access point with your device. • Audio: Headset detection, earpiece speaker, loudspeakers, etc. • Bluetooth: Connect to bluetooth headsets, verify discoverability, send files. • NFC: Check if NFC tags can be detected, read and/or written by the device. • SD/MicroSD: Use a file manager app to see if inserted SD cards can be detected. • USB: MTP, mass storage (if available) and adb access. • Telephony: 2G/3G/LTE calls + data connectivity. • GPS: Using GPS Test, check GLONASS too; typical time to fix; AGPS. • Sensors: Using AndroSensor: Accelerometer, Proximity Sensor, Ambient Light Sensor, Gyroscope, Mag- netometer (Compass), Hall (flip case), . . . • LEDs: If your device has notification LEDs or keypad backlights. • Camera (front and back): Also test functionality of zoom, flash, etc.. • Buttons: Volume up, volume down, power, camera shutter, etc.. • Video out: HDMI / MHL connectivity if you have the necessary adapters. TV out. • Screen backlight: Suspend and backlight control, minimum and maximum brightness. • Battery meter: Charge level, battery health, charging via USB (wall charger and host PC). • Vibration motor: Intensity, patterns. • HW composer version: check dumpsys SurfaceFlinger through ADB (see SF Layer Debugging). • Fingerprint sensor • FM Radio We recommend that you write down the results of these tests, so you can always remember them. ## 4 SETTING UP THE SDKS ### 4.1 Setting up required environment variables Throughout this guide we will be referencing the location of your SDK, device build environment and source code. As is customary with Android hardware adaptations, the device vendor ($VENDOR) and device codename ($DEVICE) are also used, both in scripts and configuration files. Throughout this guide as example, we’ll use Nexus 5 (lge/hammerhead for its vendor/device pair), and port it using CyanogenMod 11.0 version as the “Android baseâ€. Thus ensure you read the code snippets carefully and rename where appropriate for your ported device/vendor/base. Now run the following commands on your host operating system fitting for your device and setup: ```bash HOST $ cat <<'EOF' > $HOME/.hadk.env export ANDROID_ROOT="$HOME/hadk" export VENDOR="lge" export DEVICE="hammerhead" # "armv7hl" is still supported, but we encourage to have full 64bit ports export PORT_ARCH="aarch64" # Uncomment the next line to conveniently build all RPMs in local repo: #alias mb2='mb2 --output-dir "${ANDROID_ROOT?}/droid-local-repo/${DEVICE?}"' EOF cat <<'EOF' >> $HOME/.mersdkubu.profile function hadk() { source $HOME/.hadk.env; echo "Env setup for $DEVICE"; } export PS1="HABUILD_SDK [\${DEVICE}] $PS1" hadk EOF ``` This ensures that the environment is setup correctly when you use the ubu-chroot command to enter the Android SDK. It also creates a function hadk that you can use to set or reset the environment variables. ### 4.2 Setup the Platform SDK Instructions are found on Sailfish OS docs (“Quick start†section is enough, do not install SDK Targets yet): [https://docs.sailfishos.org/Tools/Platform\_SDK/Installation/](https://docs.sailfishos.org/Tools/Platform_SDK/Installation/) Afterwards, temporarily leave the PLATFORM\_SDK to top up your ~/.bashrc with necessary commands: ```bash PLATFORM_SDK $ exit HOST $ cat <<'EOF' >> $HOME/.bashrc if [[ $SAILFISH_SDK ]]; then function hadk() { source $HOME/.hadk.env; echo "Env setup for $DEVICE"; } hadk fi EOF sfossdk ```**Warning**: With Platform SDK version 4.4.0.58 and olders you need to check the MERSDK variable instead of SAILFISH\_SDK in the above code snippet.
You’ll need some tools which are not installed into the Platform SDK by default: • android-tools-hadk contains tools and utilities needed for working with the Android SDK • kmod is needed by mic’s qemu to build the image • createrepo\_c is needed when passing local repo to mic ```bash PLATFORM_SDK $ sudo zypper ref sudo zypper in android-tools-hadk kmod createrepo_c ``` The minimum Platform SDK SFOS version is 4.3.0.15. Use sdk-assistant command to upgrade your build tools, or create from new (especially when updating from 2.x to 3.x). To check what release you are on: ```bash PLATFORM_SDK $ # if no such file, you're on an old SDK version cat /etc/os-release ``` More information about keeping your SDK up-to-date: https://github.com/sailfishos/sdk-setup/blob/master/ sdk-setup/README.tips.wiki#SDK\_Maintenance ### 4.3 Setting up an Android Build Environment #### 4.3.1 Downloading and Unpacking Ubuntu Chroot In order to maintain build stability, we use a Ubuntu GNU/Linux chroot environment from within the Platform SDK to build our Android source tree. For Android device ports that require OpenJDK 1.8 or newer, the following commands download and unpack the rootfs to the appropriate location: ```bash PLATFORM_SDK $ TARBALL=ubuntu-focal-20210531-android-rootfs.tar.bz2 curl -O https://releases.sailfishos.org/ubu/$TARBALL UBUNTU_CHROOT=$PLATFORM_SDK_ROOT/sdks/ubuntu sudo mkdir -p $UBUNTU_CHROOT sudo tar --numeric-owner -xjf $TARBALL -C $UBUNTU_CHROOT ``` In case you find you’re not able to gain sudo privileges inside the Ubuntu Chroot, execute the following inside the Platform SDK: ``` PLATFORM_SDK $ sudo chroot $UBUNTU_CHROOT /bin/bash -c "chage -M 999999 $(id -nu 1000)" ``` #### 4.3.2 Entering Ubuntu Chroot ```bash PLATFORM_SDK $ ubu-chroot -r $PLATFORM_SDK_ROOT/sdks/ubuntu # FIXME: Hostname resolution might fail. This error can be ignored. # Can be fixed manually by adding the hostname to /etc/hosts HABUILD_SDK $ # Now you are in the HABUILD_SDK environment # To leave, just type `exit` or Ctrl+D, and you'll be back to the PLATFORM_SDK ``` #### 4.3.3 If your port requires OpenJDK 1.7 or older Our ubu-chroot environment is based on 20.04 LTS which provides OpenJDK 1.8 or newer. If your Android base build requires an older Java Development Kit, please install the legacy ubu-chroot instead: ```bash PLATFORM_SDK $ TARBALL=ubuntu-trusty-20180613-android-rootfs.tar.bz2 curl -O https://releases.sailfishos.org/ubu/$TARBALL UBUNTU_CHROOT=$PLATFORM_SDK_ROOT/sdks/ubuntu sudo mkdir -p $UBUNTU_CHROOT sudo tar --numeric-owner -xjf $TARBALL -C $UBUNTU_CHROOT ``` ## 5 BUILDING THE ANDROID HAL ### 5.1 Checking out Source of the Android base Our build process is based around the Android source tree, but where needed we’ve modified some projects, in order to apply patches required to make libhybris function correctly, and to minimise the built-in actions and services in the init.\*.rc files. Ensure you have setup your name and e-mail address in your Git configuration: ```bash HABUILD_SDK $ git config --global user.name "Your Name" git config --global user.email "you@example.com" Ensure Ubuntu chroot has cpio installed: HABUILD_SDK $ sudo apt-get install cpio ``` You also need to install the repo command from the AOSP source code repositories, see Installing repo. **Note: If your port requires OpenJDK 1.7 or older, use the older repo tool for legacy Python 2 systems.** After you’ve installed the repo command, a set of commands below will download the required projects for building the modified parts of the Android base used in Sailfish OS hardware adaptations. All available Android base variants and versions that you can port on can be seen here: https://github.com/ mer-hybris/android/branches Choose a version which has the best hardware support for your device. Alternatively, you can patch an Android base of your choosing (e.g. be it CAF or AOSP or another). The result of your Sailfish OS port will be an installable ZIP file. Before deploying it onto your device, you’ll have to flash a corresponding version of the Android base, so Sailfish OS can re-use its Android HAL shared objects. If your primary ROM does not match your Android base or its version, and you would like to keep it on your device, then look for MultiROM support for it. Starting with its version v28, it supports booting Sailfish OS. This porting guide is using Nexus 5 and CyanogenMod 11.0 version as example: ```bash HABUILD_SDK $ sudo mkdir -p $ANDROID_ROOT sudo chown -R $USER $ANDROID_ROOT cd $ANDROID_ROOT repo init -u https://github.com/mer-hybris/android.git -b hybris-11.0 ``` ### 5.2 Device repos The local manifest contains device-specific repositories, for Android as well as for the mer-hybris builds. If your device has already been ported, its codes properly placed on GitHub, you should check this repository: https://github.com/mer-hybris/local\_manifests (choose the branch of hybris-\* that your are porting to), and use $DEVICE.xml file instead of creating a new one in this chapter. Create directory at first: ```bash HABUILD_SDK $ mkdir $ANDROID_ROOT/.repo/local_manifests ``` If your are working on a new port, you’ll have to create the local manifest yourself, which contains at least two repos: one for the kernel, another for the device configuration. Find those in the LineageOS device wiki, for Nexus 5 it would be https://wiki.lineageos.org/devices/hammerhead/build#initialize-the-lineageos-source-repository Lo- cal manifest below will also need pointing to correct branches - identify which one matches the default manifest branch (stable/cm-11.0 in Nexus 5 case). Add the following content to $ANDROID\_ROOT/.repo/local\_manifests/$DEVICE.xml: ```**Important: Minimum version for SFOS target is 4.3.0.15 (same requirement as for the Platform SDK Chroot** **earlier)**
**Warning**: To ensure consistency with HADK build scripts, name your tooling SailfishOS-4.5.0 (or whichever release you are building for) instead of suggested SailfishOS-latest, and your target as $VENDOR-$DEVICE-$PORT\_ARCH (instead of SailfishOS-latest-aarch64). Ignore the i486 tar- get.
For ARM devices, choose aarch64 build target, unless you are building for the armv7hl Sailfish OS userspace. https://docs.sailfishos.org/Tools/Platform\_SDK/Target\_Installation/ To verify the correct installation of the build tools, cross-compile a simple “Hello, World!†C application with mb2 build-shell: ```bash PLATFORM_SDK $ cd $HOME mkdir hadk-test-tmp cd hadk-test-tmp cat > main.c << EOF #includeImportant: Avoid building older releases unless you know what you’re doing - we do not guarantee backwards compatibility for old Sailfish OS versions! E.g., expect patterns to break as new HA packages get introduced etc.
Ensure you pick the same release as your target was in Installing Build Tools for Your Device. E.g., if target’s ssu lr versions begin with 4.5.0., build Sailfish OS update 4.5.0.19 (check for the latest, non “Early Access†Sailfish OS version)
Build a rootfs using RPM repositories and a kickstart file (NB: all errors are non-critical as long as you end up with a generated .zip image): ```bash PLATFORM_SDK $ # Set the version of your choosing, latest is strongly preferred # (check with "Sailfish OS version" link above) export RELEASE=4.5.0.19 # EXTRA_NAME adds your custom tag. It doesn't support '.' dots in it! export EXTRA_NAME=-my1 rpm/dhd/helpers/build_packages.sh --mic ``` Once obtained the .zip file, sideload via your device’s recovery mode, or examine other particular ways of deploying to your device. Jolla Store functionality can be enabled only if your device identifies itself uniquely - either via IMEI or (for non-cellular devices) WLAN/BT MAC address. Consult us on #sailfishos-porters IRC channel on oftc.net about details. If creation fails due to absence of a package required by pattern, note down the package name. If that package is critical (e.g. libhybris, qt5-qpa-hwcomposer-plugin etc.), build and add it to the local repo as explained in Additional Packages for Hardware Adaptation. Afterwards perform: • Modifying a pattern • Building the Image with MIC Otherwise if a package is not critical, and you accept to have less functionality (or even unbootable) image, you can temporarily comment it out from patterns in hybris/droid-configs/patterns and orderly perform: • Modifying a pattern • Building the Image with MIC Alternatively (or if you can’t find it among patterns) provide a line beginning with dash (e.g. -jolla-camera) indicating explicit removal of package, to your .ks %packages section (remember that regenerating .ks will overwrite this modification). ### 8.5 Troubleshooting #### 8.5.1 /dev/null - Permission denied (while using mic) Most likely the partition your Platform SDK resides in, is mounted with nodev option. Remove that option from mount rules. #### 8.5.2 Executing commands in the build environment You can execute commands to build and install packages under the build environment, inspect and debug any issues. The syntax is shown in Installing Build Tools for Your Device. Note that mb2 uses a working copy of your original build target, which means you can experiment with mb2 build-shell at will, but once you have found a desired fix, make it permanent by recording the changes in your source code (e.g. do not leave installed packages with zypper in lying around, but add them to your .spec’s BuildRequires). If you break your build environment via mb2 build-shell, you can reset it back to its clean state via mb2 -t $VENDOR-$DEVICE-$PORT\_ARCH build-requires reset. This happens implicitly after re-running build\_packages.sh1 . Use ```bash mb2 ... build-requires diff ``` if you want to know what you have done to your build environment with mb2 in terms of installed/removed packages2 . ```bash mb2 ... build-shell ``` is limited to launch only from directories where you previously ran commands like mb2 ... build or mb2 ... build-init3 . Such commands are run under $ANDROID\_ROOT during the build of dhd, so you can run mb2 build-shell from $ANDROID\_ROOT if you find no better place. 1 As long as your original build target does not change, mb2 keeps using the same working copy (“snapshot†in mb2’s speech) of your build target in subsequent executions, preserving any changes you make to it. When your original build target changes, mb2 will reset the working copy to match the updated state of your original target next time it is invoked. This happens e.g. when you use build\_packages.sh, which intentionally works directly on your original build target. Factors that are regarded as a change in the original build target are: RPM DB change, SSU configuration, and few other things. 2 If you need to make permanent changes to the original build environment (not recommended), add --no-snapshot=force option at the beginning of mb2 command line (it is a global option). 3 mb2 looks for a directory named .mb2, where it stores some of its state. It is created implicitly by mb2 ... build and you can also create it explicitly with mb2 -t $VENDOR-$DEVICE-$PORT\_ARCH build-init. ## 9 GETTING IN ### 9.1 Boot and Flashing Process This varies from device to device. There are a few different boot loaders and flashing mechanisms used for Android devices: • fastboot: Used by most Nexus devices • odin: Used by most Samsung devices For flashing fastboot-based devices, use fastboot (available in the Platform SDK), for odin-based devices, use Heimdall. ### 9.2 Operating Blind on an Existing Device Long story short, you will have to assume that you cannot: • See any framebuffer console • See any error messages of any kind during bootup • Get any information relayed from your startup process • Set any kind of modified kernel command lines Hence, we have to learn how to operate blind on a device. The good news is that when you have a working kernel, you can combine it with a init ramdisk and that Android’s USB gadget is built in to most kernel configurations. It is possible then for the ramdisk to set up working USB networking on most devices and then open up a telnet daemon. The hybris-boot repository contains such an initrd with convenient USB networking, DHCP and telnet server, plus the ability to boot into a Sailfish OS system. The init system in the hybris-boot initrd will attempt to write information via the USB device serial number and model. So dmesg on the host could produce: ```bash HOST $ dmesg # sample output: ... [1094634.238136] usb 2-2: Manufacturer: Mer Boat Loader [1094634.238143] usb 2-2: SerialNumber: Mer Debug setting up (DONE_SWITCH=no) ``` ... However dmesg doesn’t report all changes in the USB subsystem and the init script will attempt to update the iSerial field with information so also do: ```bash HOST $ lsusb -v | grep iSerial # sample output: iSerial 3 Mer Debug telnet on port 23 on rndis0 192.168.2.15 - also running ˓→udhcpd ``` However, if it says something like: ```bash [1094634.238143] usb 2-2: SerialNumber: Mer Debug setting up (DONE_SWITCH=yes) ``` connectivity will be available via telnet 192.168.2.15 2323 port. ### 9.3 Logs across reboots ```bash DEVICE $ devel-su # change Storage=volatile --> Storage=automatic in: vi /etc/systemd/journald.conf mkdir /var/log/journal reboot ``` Systemd suppresses journal, and some valuable info might get hidden. To prevent this, set RateLimitInterval=0 #### 9.3.1 Bootloops If device bootloops, there might be several reasons: • If it immediately reboots (and especially if it later boots to recovery mode), SELinux is en- abled, and all ports based on Android 4.4 (hybris-11.0) up to Android 9.0 (hybris-16.0) need to disable it. Add CONFIG\_SECURITY\_SELINUX\_BOOTPARAM=y to your kernel defconfig, and selinux=0 to your kernel command line (usually in BOARD\_KERNEL\_CMDLINE under $ANDROID\_ROOT/device/$VENDOR/\*/BoardConfig\*.mk) • If it reboots after a minute or so, be quick and telnet into device, then do: ```bash ln -s /dev/null /etc/systemd/system/ofono.service ``` • Check if your /system is mounted by systemd (system.mount unit) 9.3.2 Tips To ease debugging in unstable/halting/logs spamming early ports: ```bash DEVICE $ systemctl mask droid-hal-init systemctl mask user@100000 ``` #### 9.3.3 Get connected Use USB networking to connect to the Internet from your Sailfish OS Execute on your host as root. Use the interface which your host uses to connect to the Internet. It’s wlan0 in this example: ```bash HOST $ iptables -t nat -A POSTROUTING -o wlan0 -j MASQUERADE echo 1 > /proc/sys/net/ipv4/ip_forward ``` Execute on the device: ```bash TARGET $ route add default gw 192.168.2.X # <- host's usb0 IP echo 'nameserver 208.67.222.222' > /etc/resolv.conf ``` ### 9.4 Splitting and Re-Assembling Boot Images A boot.img file is basically a combination of a Linux kernel and an initramfs as cpio archive. The Platform SDK offer the mkbootimg to build a boot image from a kernel and cpio archive. To split a boot image, use split\_bootimg in Platform SDK. In the Sailfish OS port, a boot image with Sailfish OS-specific scripts will be built automatically. These boot im- ages are then available as hybris-boot.img (for booting into Sailfish OS) and hybris-recovery.img (for debugging via telnet and test-booting). ## 10 FLASHING THE ROOTFS IMAGE In order to be able to use Sailfish OS on the device, the parts that we built and assembled in the previous chapters now need to be flashed to the device. After flashing, Sailfish OS should boot on your device on the next reboot. ### 10.1 Prerequisites • Android Recovery flashed to your device • The stock firmware image (for your version and device) • The Android base release (for your version and device) • A Sailfish OS rootfs update .zip, created by mic ### 10.2 Flashing back to Stock Android It is important that you start with a fresh stock image that matches the Android base release version you are going to flash (which in turn is dictated by the Sailfish OS image you are going to flash). While the Android base (e.g. CyanogenMod) .zip contains all files in /system/ (e.g. libraries and libhardware modules), the stock image also contains firmware parts and flashables for partitions that are not included in the Android base .zip. For example, if you are running stock 4.4.2 on a Nexus 4 (mako), and you are going to flash CM 10.1.3 and Sailfish OS to it, you have to first flash the stock 4.2.2 (note that this is 4.2, not 4.4) first, so that the firmware bits are matching the CM version. If you do not flash the right stock version (and therefore firmware), there might be some issues when booting into Sailfish OS: \- Problems accessing /sdcard/ in recovery (e.g. adb push does not work) \- WLAN, sensors, audio and other hardware not working If you experience such issues, please make sure you first flash the stock system, ROM, followed by the Android base image, and finally the Sailfish OS update. Please also note that you can’t just take the latest stock ROM and/or Android base ROM - both versions have to match the Android version against which the Sailfish OS adaptation was built. ### 10.3 Flashing using Android Recovery 1\. Boot into Android Recovery 2\. Upload the CM release: ```bash adb push cm-10.1.3-$DEVICE.zip /sdcard/ ``` 3\. Upload Sailfish OS: ```bash adb push sailfishos-$DEVICE-devel-1.2.3.4.zip /sdcard/ ``` 4\. In the Recovery on the device: 1. Clear data and cache (factory reset) 2. Install the CM release by picking the CM image 3. Install Sailfish OS by picking the SFOS image 4. Reboot the device ## 11 MANUAL INSTALLATION AND MAINTENANCE This assumes you are booted into the Android base on your device, can adb shell to it to get a root shell and have your boot image and rootfs tarball ready. Some of these approaches also work in Android Recovery (there’s an adbd running). ### 11.1 Extracting the rootfs via adb Replace sailfishos-devel-hammerhead.tar.bz2 with the name of your rootfs tarball: ```bash PLATFORM_SDK $ adb push sailfishos-devel-hammerhead.tar.bz2 /sdcard/ adb shell su mkdir -p /data/.stowaways/sailfishos tar --numeric-owner -xvf /sdcard/sailfishos-devel-hammerhead.tar.bz2 \ -C /data/.stowaways/sailfishos ``` ### 11.2 Flashing the boot image via adb The following example is for hammerhead, for other devices the output partition and filename is obviously different: ```bash PLATFORM_SDK $ cd $ANDROID_ROOT adb push out/target/product/hammerhead/hybris-boot.img /sdcard/ adb shell su dd if=/sdcard/hybris-boot.img of=/dev/block/mmcblk0p19 ``` ### 11.3 Flashing or booting the boot image via fastboot ```bash PLATFORM_SDK $ cd $ANDROID_ROOT # to smoke test a boot image without flashing it: fastboot boot out/target/product/$DEVICE/hybris-boot.img # to permanently flash an image to boot partition: fastboot flash boot out/target/product/$DEVICE/hybris-boot.img adb shell su dd if=/sdcard/hybris-boot.img of=/dev/block/mmcblk0p19 ``` ### 11.4 Interacting with the rootfs via adb from Android You can interact with the Sailfish OS rootfs and carry out maintenance (editing files, installing packages, etc..) when booted into an Android system. You have to have your rootfs already installed/extracted. You can use Android’s WLAN connectivity to connect to the Internet and download updates: ```bash PLATFORM_SDK $ adb shell su mount -o bind /dev /data/.stowaways/sailfishos/dev mount -o bind /proc /data/.stowaways/sailfishos/proc mount -o bind /sys /data/.stowaways/sailfishos/sys chroot /data/.stowaways/sailfishos/ /bin/su - echo "nameserver 8.8.8.8" >/etc/resolv.conf ``` ## 12 OTA (OVER-THE-AIR) UPDATES You can setup to upgrade a Sailfish OS device over the air, a.k.a. OTA update. ### 12.1 Prepare the infrastructure • Ensure your Sailfish OS version is at least 3.2.1 (3.4.0 for aarch64) • Create file 20-mydomain.ini (rename “mydomain†as you see fit) under $ANDROID\_ROOT/ hybris/droid-configs/sparse/usr/share/ssu/repos.d/ with the following content: ```bash [release] adaptation=https://mydomain.net/%(release)/%(vendor)-%(adaptation)/%(arch)/ ``` • Substitute https://mydomain.net/ with your Web server address (including subpath if exists) • The %(release)/%(vendor)-%(adaptation)/%(arch)/ format is advised, because it’s the most future-proof. E.g. for the Nexus 5 this string would resolve to 4.5.0.19/lge-hammerhead/ aarch64/ • Commit the above change to droid-configs (including updating the submodule, which introduces times- tamped versioning, so updates get picked up) • Make new image and ensure devices are flashed which will be receiving future updates • Make some changes to your adaptation (e.g. fix some HW issue) and rebuild the affected part via build\_packages.sh, so that version numbers increase ### 12.2 Test for any breakages Before deploying any updates to production, they must be tested first. Prerequisites: • Web server (e.g. Apache) running on HOST and accessible within network • Directory listing doesn’t need to be enabled • Assuming Web server’s rootdir is /srv/http Perform the following: ```bash HOST $ . ~/.hadk.env rm -rf /srv/http/sailfish-tmp-test-repo cp -ar $ANDROID_ROOT/droid-local-repo/$DEVICE /srv/http/sailfish-tmp-test-repo rm -rf /srv/http/sailfish-tmp-test-repo/repo createrepo_c /srv/http/sailfish-tmp-test-repo ``` SSH into your device and execute (substituting https://mydomain.net with the address to your Web server): ```bash DEVICE $ ssu ar sfos-test https://mydomain.net/sailfish-tmp-test-repo devel-su -p pkcon install zypper devel-su zypper refresh sfos-test devel-su zypper dup --from sfos-test ``` Check that all the packages you touched are to be updated or removed as expected. Afterwards you can press “Yes†to execute the update and check if the device functions as desired, also after reboot. Once happy, clean up the testing environment: ```bash DEVICE $ ssu rr sfos-test HOST $ rm -rf /srv/http/sailfish-tmp-test-repo ``` ### 12.3 Release into production for all users Once successfully tested, deploy the stable packages to the release repo: ```bash HOST $ . ~/.hadk.env rm -rf /srv/http/$RELEASE/$VENDOR-$DEVICE/$PORT_ARCH mkdir -p /srv/http/$RELEASE/$VENDOR-$DEVICE cp -ar $ANDROID_ROOT/droid-local-repo/$DEVICE \ /srv/http/$RELEASE/$VENDOR-$DEVICE/$PORT_ARCH rm -rf /srv/http/$RELEASE/$VENDOR-$DEVICE/$PORT_ARCH/repo createrepo_c /srv/http/$RELEASE/$VENDOR-$DEVICE/$PORT_ARCH ``` To receive the update, each device will have to execute devel-su -p version --dup, and reboot when instructed. ### 12.4 Adding custom RPM packages You can add any other RPM binary packages to the local build repository (i.e. packages that were not created by running build\_packages.sh). For example: ```bash PLATFORM_SDK $ cd $ANDROID_ROOT # Alternatively you can use `mb2 --output-dir ... build` instead of copying cp -a path/to/custom-built.rpm droid-local-repo/$DEVICE ``` To make the devices of your users pull this RPM package in, ensure some other package or pattern requires it, then test and deploy your repo as per instructions above. ### 12.5 Updating to the next Sailfish OS release If another official Sailfish OS update has been released since you last published your HW adaptation update, perform the following: Update your SDK target device build environment (see how in the last paragraph of Setup the Platform SDK). Alternatively, you can remove it and create a new one as per Installing Build Tools for Your Device. Remove or backup your local build repository: ```bash PLATFORM_SDK $ cd $ANDROID_ROOT PREV_RELEASE=4.4.0.68 # adjust to the previous release version you were on mv droid-local-repo/$DEVICE droid-local-repo/$DEVICE-$PREV_RELEASE mkdir droid-local-repo/$DEVICE ``` Then rebuild all packages and a new image by executing build\_packages.sh. Afterwards test the rebuilt repo. The actual testing sequence on the device will be different: ```bash DEVICE $ ssu ar sfos-test https://mydomain.net/sailfish-tmp-test-repo ssu dr adaptation0 ssu re 4.5.0.19 # adjust to the actual version devel-su -p version --dup ssu rr sfos-test ssu er adaptation0 ``` Then reboot as and test device functionality. Once satisfactory, publish your repo for all users. Finally, to receive the update, each device will have to execute: ```bash DEVICE $ ssu re 4.5.0.19 # adjust to the actual version devel-su -p version --dup ``` NOTE: The %(release) in your self-hosted repo (visible via ssu lr) will get updated automatically after ssu re. After devel-su -p version --dup has finished, reboot as instructed. ## 13 MODIFICATIONS AND PATCHES Running Sailfish OS on top of a Mer Hybris adaptation requires a few modifications to the underlying Android base. We maintain forks of some repos with those patches applied. ### 13.1 Hybris Modifications to an Android base Our modifications are tracked by our own Hybris-specific repo manifest file. The below sections outline our modifications to these sources. #### 13.1.1 Droid System In order to work with libhybris, some parts of the lower levels of Android need to be modified: • bionic/ • Pass errno from bionic to libhybris (libdsyscalls.so) • Rename /dev/log/ to /dev/alog/ • TLS slots need to be re-assigned to not conflict with glibc • Support for HYBRIS\_LD\_LIBRARY\_PATH in the linker • Add /usr/libexec/droid-hybris/system/lib to the linker search path • external/busybox/: Busybox is used in the normal and recovery boot images. We need some tional features like mdev and udhcpd addi- • system/core/ • Make cutils and logcat aware of the new log location (/dev/alog/) • Add /usr/libexec/droid-hybris/lib-dev-alog/ to the LD\_LIBRARY\_PATH • Force SELinux OFF since hybris does not utilise the relevant Android parts, and leaving SELinux support ON would then cause device to reboot to recovery • Remove various init and init.rc settings and operations that are handled by systemd and/or Hybris on a Sailfish OS system • frameworks/base/: Only build servicemanager, bootanimation and androidfw to make the minimal Droid HAL build smaller (no Java content) • libcore/: Don’t include JavaLibrary.mk, as Java won’t be available All these modifications have already been done in the mer-hybris GitHub organisation of forks from various Android sources. If its android manifest is used, these patches will be included automatically. In addition to these generic modifications, for some devices and SoCs we also maintain a set of patches to fix issues with drivers that only happen in Sailfish OS, for example: • hardware/samsung/: SEC hwcomposer: Avoid segfault if registerProcs was never called #### 13.1.2 Kernel For the Kernel, some configuration options must be enabled to support systemd features, and some configuration options must be disabled, because they conflict or block certain features of Sailfish OS. • Required Configuration Options: See $ANDROID\_ROOT/hybris/hybris-boot/init-script function check\_kernel\_config() for a list of required kernel options • Conflicting Configuration Options: CONFIG\_ANDROID\_PARANOID\_NETWORK: This would make all network connections fail if the user is not in the group with ID 3003. As an alternative to checking the kernel options in the initramfs, the script $ANDROID\_ROOT/hybris/ mer-kernel-check can also be used to verify if all required configuration options have been enabled. ### 13.2 Configuring and Compiling the Kernel For supported devices, the kernel is built as part of mka hybris-hal with the right configuration. For new devices, you have to make sure to get the right kernel configuration included in the repository. For this, clone the kernel repository for the device into mer-hybris and configure the kernel using hybris/ mer-kernel-check. ## 14 DETAILED SUBSYSTEM ADAPTATION GUIDES Sailfish OS uses some kernel interfaces directly, bypassing the android HAL. Mainly this is used in places where the kernel API is stable enough and also used by Android. The other reasons for using kernel APIs directly include better features offered by standard kernel frameworks, differing middleware between Sailfish OS linux and Android, and lastly special features of Sailfish OS. ### 14.1 Vibration / force feedback The default vibra framework that is used in full featured productized Sailfish OS devices is the force feedback API in kernel input framework. The kernel drivers should either use the ffmemless framework OR provide FF\_PERIODIC and FF\_RUMBLE support via as a normal input driver. In this chapter we go through the ff- memless aproach of adapting your kernel for Sailfish OS This is a different method than what is used in community Sailfish OS ports, which utilize the android vibrator / timed-output API. The android vibrator plugins in Sailfish OS middleware have very reduced feature set, and are not recommended for commercial products. In order to utilize the standard input framework force feedback features of Sailfish OS, the android timed output vibrator kernel driver needs to be converted to a ffmemless driver. The main tasks for this are: • Enable CONFIG\_INPUT\_FF\_MEMLESS kernel config option • Disable CONFIG\_ANDROID\_TIMED\_OUTPUT kernel config option • Change maximum amount of ffmemless effects to 64 by patching ff-memless.c: • http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/drivers/input/ff-memless.c#n41 ```bash diff --git a/drivers/input/ff-memless.c b/drivers/input/ff-memless.c index 117a59a..fa53611 100644 --- a/drivers/input/ff-memless.c +++ b/drivers/input/ff-memless.c @@ -39,7 +39,7 @@ MODULE_AUTHOR("Anssi HannulaPLEASE see the pdf for 17.1 and co!
## 18 HARDWARE ADAPTATION CHECKLIST Before publishing the adaptation, at least the following features should be checked. • Thermal sensor configuration for dsme – Even if we do not enforce any limits, CSD1 gets temperature info from dsme – Quick test: dbus-send --system --print-reply --dest=com.nokia.thermalmanager \\ /com/nokia/thermalmanager com.nokia.thermalmanager.battery\_temperature • memnotify patch to kernel + config for mce – Memory pressure normal|warning|critical affects for example browser – Quick test: ls /etc/mce/\*memnot\* • Watchdog driver in kernel + verify it works with dsme – We want the device to reboot if userspace gets hopelessly stuck – Some android kernels use hardware watchdog for kernel stuck detection – Quick test: journalctl -b | grep 'dsme.\*watchdog' • usb-moded works – Detects charger and PC correctly • USB diag mode works (optional) – Only needed for factory releases, and not even always for those • USB gadget driver in kernel + verify it works with buteo-mtp – Android has some MTP logic imlemented at kernel and thus some FFS stuff we need is typically missing • ssu config files – Verify ssu & ssu-sysinfo agree on results • Vibra driver in kernel – Patterns choose android vibra, LED vibra or ff-memless (memoryless force-feedback devices) – ff-memless needs adding kernel driver • Suspend works – If the device does not suspend, standby time will drop considerably – There is a CSD test for this (Hardware tests->All tests->System state) • Resume via iphb works – Only “official†way we have for scheduled wakeups from suspend • Volume key probing & policy works – Display off -> no ringing volume change should happen – Display off -> audio playback volume should change – Both vol keys down -> UI snapshot should happen • Power key works – Long press power key menu – Double presses – Loooong press shutdown in dsme – False double press reporting from a single press • Proximity sensor works in suspend – We have built in assumption of having up-to-date p-sensor state – NB: If device does not have PS -> that must be configured • Ambient light sensor works – Long sensor power up time -> can break display power on brightness – Kernel side filtering / odd delta reporting -> breaks auto adjustments – Total darkness should report “zero lux†• LED works – Check the accuracy of colours and brightness – Blocking at sysfs write can make mce unresponsive – All but RGB LEDs probably require custom pattern config • Proximity blanking during active call works – Some ports have weird problems here • CSD config – HW features – Factory test set – Run-in test set – Masked/blacklisted tests • abootsettings etc. when applicable • Double tap works – There has been many devices where gestures are supported but touch driver uses odd concepts • zram in kernel • Look out for suspicious logging during bootup / shutdown – Faster/slower/just different -> odd things can/will happen • usb-moded vs Android USB stuff in /\*.rc – Device serial number is assumed to come from Android side logic • Touch reporting – Seems many Android kernels have issues around display power cycling & finger on screen • Act dead mode – What Android services are needed varies from one device to another – Act dead alarms need to be verified too • Extra filesystems enabled in kernel where possible – BTRFS, F2FS, UDF, NFS, CIFS etc. 1 You can start the CSD tool either via command line (csd) or via Settings app: Go to “About Product†and tap five times on the Build entry ## 19 LICENSE Creative Commons Legal Code Attribution-NonCommercial-ShareAlike 3.0 Unported CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY- CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN “AS-IS†BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE IN- FORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE. License THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE (“CCPL†OR “LICENSEâ€). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDER- ATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. 1\. Definitions a. “Adaptation†means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image (“synchingâ€) will be considered an Adaptation for the purpose of this License. b. “Collection†means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Sec- tion 1(g) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assem- bled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined above) for the purposes of this License. c. “Distribute†means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership. d. “License Elements†means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, Noncommercial, ShareAlike. e. “Licensor†means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License. f. “Original Author†means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast. g. “Work†means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work. h. “You†means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation. i. “Publicly Perform†means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images. j. “Reproduce†means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium. 2\. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws. 3\. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below: a. to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections; b. to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked “The original work was translated from English to Spanish,†or a modification could indicate “The original work has been modified.â€; c. to Distribute and Publicly Perform the Work including as incorporated in Collections; and, d. to Distribute and Publicly Perform Adaptations. The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved, including but not limited to the rights described in Section 4(e). 4\. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions: a. You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(d), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(d), as requested. b. You may Distribute or Publicly Perform an Adaptation only under: (i) the terms of this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Cre- ative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-NonCommercial-ShareAlike 3.0 US) (“Ap- plicable Licenseâ€). You must include a copy of, or the URI, for Applicable License with every copy of each Adaptation You Distribute or Publicly Perform. You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License. You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License. c. You may not exercise any of the rights granted to You in Section 3 above in any manner that is primarily intended for or directed toward commercial advantage or private monetary compensa- tion. The exchange of the Work for other copyrighted works by means of digital file-sharing or otherwise shall not be considered to be intended for or directed toward commercial advantage or private monetary compensation, provided there is no payment of any monetary compensation in con-nection with the exchange of copyrighted works. d. If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution (“Attribution Partiesâ€) in Licensor’s copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and, (iv) consistent with Section 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., “French translation of the Work by Original Author,†or “Screenplay based on original Work by Original Authorâ€). The credit required by this Section 4(d) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties. e. For the avoidance of doubt: i. Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; ii. Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License if Your exercise of such rights is for a purpose or use which is otherwise than noncommercial as permitted under Section 4(c) and otherwise waives the right to collect royalties through any statutory or compulsory licensing scheme; and, iii. Voluntary License Schemes. The Licensor reserves the right to collect royalties, whether indi- vidually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted un- der this License that is for a purpose or use which is otherwise than noncommercial as permitted under Section 4(c). f. Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author’s honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author’s honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise. 5\. Representations, Warranties and Disclaimer UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING AND TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IM- PLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE AB- SENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THIS EXCLUSION MAY NOT APPLY TO YOU. 6\. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAM- AGES. 7\. Termination a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License. b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above. 8\. Miscellaneous a. Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License. b. Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License. c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent. e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You. f. The rights granted under, and the subject matter referenced, in this License were drafted utilizing the termi- nology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law. Creative Commons Notice Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor. Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, Creative Commons does not authorize the use by either party of the trademark “Creative Commons†or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons’ then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time. For the avoidance of doubt, this trademark restriction does not form part of this License. Creative Commons may be contacted at http://creativecommons.org/. # HADK - Hot