suzu.yml

name: "Sony Xperia X (F5121 & F5122)"
codename: "suzu"
formfactor: "phone"
aliases:
  - "F5121"
  - "F5122"
doppelgangers: []
user_actions:
  recovery:
    title: "Reboot to Recovery"
    description: "With the device powered off, hold Volume Down + Power."
    image: "phone_power_down"
    button: true
  bootloader:
    title: "Reboot to Bootloader"
    description: "With the device powered off, hold Volume Up and insert a USB cable. The LED indicator has to light up blue."
    image: "phone_power_up"
    button: true
  boot:
    title: "Boot the device"
    description: "Power on the device."
    image: "phone_power_up"
    button: true
  confirm_model:
    title: "Confirm your model"
    description: "Please double-check that your device is a Sony Xperia X (F5121 or F5122)."
  ta_backup:
    title: "Backup the TA partition"
    description: "In case you later wish to return to factory state, you will have to back up your TA partition before unlocking the bootloader. You can't do this step at a later stage!"
    link: "https://together.jolla.com/question/168711/xperia-x-backup-ta-partition-before-unlocking-bootloader/"
  unlock:
    title: "Unlock the bootloader"
    description: "You have to unlock the bootloader to install third-party operating systems on your device."
    link: "https://developer.sony.com/develop/open-devices/get-started/unlock-bootloader/"
  upgrade_android:
    title: "Upgrade Android"
    description: "If the device is running Android, you might have to upgrade to Android 8.0."
    link: "https://forums.ubports.com/topic/3229/sony-xperia-x-suzu-f5121"
unlock:
  - "confirm_model"
  - "ta_backup"
  - "unlock"
handlers:
  bootloader_locked:
    actions:
      - fastboot:oem_unlock:
          code_url: "https://developer.sony.com/develop/open-devices/get-started/unlock-bootloader/"
operating_systems:
  - name: "Ubuntu Touch"
    compatible_installer: ">=0.9.2-beta"
    options:
      - var: "channel"
        name: "Channel"
        tooltip: "The release channel"
        link: "https://docs.ubports.com/en/latest/about/process/release-schedule.html"
        type: "select"
        remote_values:
          systemimage:channels:
      - var: "wipe"
        name: "Wipe Userdata"
        tooltip: "Wipe personal data (required for new installs)"
        type: "checkbox"
      - var: "bootstrap"
        name: "Bootstrap"
        tooltip: "Flash system partitions using fastboot"
        type: "checkbox"
        value: true
    prerequisites:
      - "upgrade_android"
    steps:
      - actions:
          - core:manual_download:
              group: "firmware"
              file:
                name: "SW_binaries_for_Xperia_AOSP_N_MR1_5.7_r1_v08_loire.zip"
                url: "https://developer.sony.com/file/download/software-binaries-for-aosp-nougat-android-7-1-kernel-4-4-loire/"
                checksum:
                  sum: "9d9d6df01f0816e74b386daf82658768a54e515161ee9fb907a7aae292167e51"
                  algorithm: "sha256"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - core:unpack:
              group: "firmware"
              files:
                - archive: "SW_binaries_for_Xperia_AOSP_N_MR1_5.7_r1_v08_loire.zip"
                  dir: "unpacked"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - core:download:
              group: "firmware"
              files:
                - url: "https://cdimage.ubports.com/devices/halium-unlocked-recovery_suzu.img"
                  checksum:
                    sum: "d230df1a9d4d5d8e92232ec272e365996ef5a77edb60aaddbfcd5aa97e058dc1"
                    algorithm: "sha256"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - adb:reboot:
              to_state: "bootloader"
        fallback:
          - core:user_action:
              action: "bootloader"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - fastboot:erase:
              partition: "system"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - fastboot:erase:
              partition: "cache"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - fastboot:erase:
              partition: "userdata"
        condition:
          var: "wipe"
          value: true
      - actions:
          - fastboot:flash:
              partitions:
                - partition: "boot"
                  file: "halium-unlocked-recovery_suzu.img"
                  group: "firmware"
                  raw: true
                - partition: "recovery"
                  file: "halium-unlocked-recovery_suzu.img"
                  group: "firmware"
                - partition: "oem"
                  file: "unpacked/SW_binaries_for_Xperia_AOSP_N_MR1_5.7_r1_v08_loire.img"
                  group: "firmware"
        condition:
          var: "bootstrap"
          value: true
      - actions:
          - fastboot:reboot:
        fallback:
          - core:user_action:
              action: "boot"
      - actions:
          - systemimage:install:
      - actions:
          - adb:reboot:
              to_state: "recovery"
        fallback:
          - core:user_action:
              action: "recovery"
    slideshow: []