Checklist for Sailfish OS
Contents
Introduction
Our official instructions for installing Sailfish X (Sailfish OS) 1 are on this web page. There are separate instructions for Windows, Linux and Mac computers. Furthermore, there is a different set of instructions for the Xperia X, Xperia XA2, Xperia 10, Xperia 10 II, Xperia 10 III, Xperia 10 IV, and Xperia 10 V.
Jolla Shop has a selection of Sailfish OS “images” for each supported device model. An image means a binary package or a compressed file that contains the executable code of the Sailfish operating system and some tools needed for the installation. The images can be downloaded as zip packages from the Jolla Shop after purchasing the Sailfish licence. You will need to sign in to the Shop for the download using the same Jolla account that you used for purchasing the licence.
In brief, installing Sailfish can be done on a device connected to a computer with a USB cable. At the moment of connection, the device is forced to a special state, the fastboot state. The computer shall have a directory holding the uncompressed Sailfish image.
The act of programming the code of the operating system to the device is called flashing (as the type of code storage is flash memory).
Checklist
This document, although called a checklist, explains in detail how to flash the Sailfish OS to a supported device. It is more verbose than the rather compact official installation instructions but relies on them throughout the document.
Go through all chapters and ensure that you have done everything correctly.
Fastboot driver, tool and command
In this chapter, we prepare the computer for the flashing.
The Android tool fastboot is required for unlocking the bootloader of the Xperia device and for flashing (installing) Sailfish OS to your device. An alternative operating system (like Sailfish) can only be installed and used when the bootloader is unlocked.
The fastboot tool requires the fastboot driver to be able to work. Typically, Linux and Mac computers have this driver by default, while it must be installed to Windows. The following three chapters help installing the fastboot driver on different computers.
The fastboot command can be used only when the phone is connected to the computer in the fastboot mode, indicated by the blue light on the phone. For details, see the 1st item in “Troubleshooting the USB connection and fastboot mode”.
On Linux computer
Usually, the Android tools are ok by default on Linux computers. The fastboot command should work fine. However, if you are facing some trouble in using fastboot, consider installing it according to these instructions:
There is some troubleshooting in chapter “Troubleshooting the USB connection and fastboot mode”.
On macOS computer
In the case of a macOS computer, you need to first install Homebrew, the open-source package management system that simplifies the installation of software on macOS. Install Homebrew using the instructions on this link.
Next, install the support for the fastboot by following these instructions:
There is some troubleshooting in chapter “Troubleshooting the USB connection and fastboot mode”.
On Windows computer
You should have a computer running Microsoft Windows (preferably Windows 10 or Windows 11).
Windows PCs do not have the fastboot tool nor the drivers installed by default. Therefore, you must install the fastboot driver on your PC. The tool itself, fastboot.exe, is included in the Sailfish OS image (zip package).
Moreover, it has turned out that these drivers must be re-installed if you connect a different Xperia device to your PC.
The phone must be connected to the computer in the fastboot mode before the fastboot driver can be installed to Windows. Press and hold the Volume Up button and connect the USB cable between your phone and your computer. Wait for the indicator light to light up blue on the phone. If the light turns green check the 1st item in “Troubleshooting the USB connection and fastboot mode”.
Open the Windows Device Manager by pressing both the Windows button and the X button. Next, click Device Manager on the pop-up menu.
If the Device Manager shows “Android” under “Other devices” (see Picture 1 below) then the correct fastboot driver (of Sony) is missing from your PC. This can be fixed by following these instructions:
You will end up in the view shown in Picture 2. The new device Sony sa0114 shall appear.
Note 1: In contrast to Sony’s instructions, Android SDK needs not (should not) be installed on the PC.
Note 2: There is no dedicated driver for Xperia XA2, Xperia 10, Xperia 10 II, Xperia 10 III, Xperia 10 IV or Xperia 10 V devices. Instead, the same driver that is used for Xperia X devices works for all of these devices, too.
Note 3: There is some troubleshooting in chapter “Troubleshooting the USB connection and fastboot mode”.
Troubleshooting the fastboot mode on Windows
This zip package contains stepwise screenshots about installing the fastboot driver to a Windows computer.
There is some troubleshooting in chapter “Troubleshooting the USB connection and fastboot mode”.
Unlocking the bootloader
This chapter discusses the enablers for unlocking the bootloader and changing the operating system of your device. The status checks require that your device is still running the Android OS.
If you have already unlocked the bootloader and installed the Sailfish OS (but it is failing to serve well) then you should probably jump to chapter “Correct contents in the flashing directory”. If you would anyhow like to run the checks explained below then you must revert the device back to Android first.
Xperia bootloader
The bootloader normally checks the integrity of the system it is about to boot up (turn on). Since it only knows about the official Sony Android, it has to be unlocked in order to install an alternative operating system like Sailfish and to boot up Sailfish.
Ensure that the bootloader of your Xperia device (that is still running Android) can be unlocked. To do this, open the Phone Dialer application and type the following code (as if it were a phone number):
*#*#7378423#*#*
A menu page should pop up. Tap “Service info > Configuration” and seek “Rooting Status”. One of the following three values should appear. If it is:
1) “Bootloader unlocked: Yes“
The bootloader has been unlocked previously and you can install Sailfish on your Xperia. Jump to chapter “Correct contents in the flashing directory”
2) “Bootloader unlock allowed: No“
It is unfortunately not possible to install Sailfish on this device. You should contact your Sony dealer in this case. There is no point to continue reading this document.
3) “Bootloader unlock allowed: Yes“
Your next task is to unlock the bootloader. The detailed instructions are given in the next chapter.
This is how your Android device should look like when it is ready for installing Sailfish OS
The following pictures represent the phone when it is still running the Android operating system. Either you are just preparing the device for Sailfish OS, or else Sailfish OS did not work properly and you have reverted the device to Android using Sony’s Emma tool (see this document on reverting Xperia back to Android for a detailed approach).
Check that you can see the following views on your device:
A) Settings > System > About phone
Check the device model (Picture 3). All supported models are listed in this table. Note that there are several different Sailfish OS images (read: installation packages) for the various models. Be sure to download the one matching your device.
Also, check the Build number (Picture 4). The valid build numbers (a.k.a. Android baseband version) are explained in this table. The Build number also indicates the Android OS version (although not explicitly). Read carefully the first lines of our Sailfish OS instructions to see which phones should be updated and which not.
B) Settings > System
You must enable the Developer options to be able to carry on. Enable them by tapping the “Build number” item of Picture 4 several times in a quick sequence. Then go to “Settings > System” and find the new item Developer options.
C) Settings > System > Developer options
Scroll down and find item OEM unlocking (which means bootloader unlocking). If the bootloader of your device has been unlocked previously, you will see it greyed out like in Picture 5 below. This is ok and no further actions are required for this setting.
However, if the item “OEM unlocking” appears black and locked (i.e. the slider is on the left), then you must first push the slider switch to the right to make the unlocking possible. The actual unlocking shall be done as instructed in document collection below - use the links of the table.
Scroll further down and find the item “USB debugging”. This is also a prerequisite for the fastboot mode. You must enable it to make installing Sailfish OS successful.
Correct contents in the flashing directory
By flashing directory (a.k.a. “Sailfish directory”), we mean the location on your PC to which you have unzipped the Sailfish OS image. Check that you have prepared the contents of the directory correctly.
Note that there are different instructions for Xperia X, Xperia XA2, Xperia 10, Xperia 10 II, Xperia 10 III, Xperia 10 IV, and Xperia 10 V. Also for different computers. Make sure you read the correct instructions. We have linked them for you below:
Check that you have the following two items in the flashing directory:
1) The correct Sailfish image for your device model
- There are 2 different installable images for Xperia X, 6 images for Xperia XA2, 4 images for Xperia 10, 2 images for Xperia 10 II, one image for Xperia 10 III, 1 or 2 images for Xperia 10 IV, and 1 or 2 images for Xperia 10 V. Pick up the correct one.
- You can check the phone model by pulling out a white label from the SIM card slot, from the sales package, or from the phone menus
- If in doubt about the device model, please see the chapter “Final check before flashing” below
2) The correct Sony vendor binary
- There are different vendor binaries for Xperia X, Xperia XA2, Xperia 10, Xperia 10 II, Xperia 10 III, Xperia 10 IV, and Xperia 10 V.
- Find more information in the chapters right below
Xperia X
Extracting the Sailfish zip package brings in everything necessary, except for the Sony binary image SW_binaries_for_Xperia_AOSP_M_MR1_3.10_v13_loire.img
which you need to download as instructed in chapter 5 of Sailfish instructions for Xperia X:
Check that the contents of the flashing directory are like in the picture below (we have OS release 4.2.0.21 as an example there).
Xperia XA2
Extracting the Sailfish zip package brings in everything necessary, except for the Sony binary image SW_binaries_for_Xperia_Android_8.1.6.4_r1_v16_nile.img
which you need to download as instructed in chapter 5 of Sailfish instructions for Xperia XA2:
Check that the contents of the flashing directory are like in the picture below (we have OS release 4.2.0.21 as an example there).
NOTE: Sony has also provided the binary file v17, however, some connection problems in the 5 GHz band of WiFi networks have been reported when using it. Therefore it may be best to use the v16 file.
Note that the zip file name of v17 has the version id “17B” whereas the “B” does not appear in the img file name.
You can change the vendor binary by flashing just it without affecting Sailfish OS. Please read this document.
Xperia 10
Extracting the Sailfish zip package brings in everything necessary, except for the Sony binary image SW_binaries_for_Xperia_Android_9.0_2.3.2_v9_ganges.img
which you need to download as instructed in chapter 5 of Sailfish instructions for Xperia 10:
Check that the contents of the flashing directory are like in the picture below (we have OS release 4.2.0.21 as an example there).
Xperia 10 II
Extracting the Sailfish zip package brings in everything necessary, except for the Sony binary image SW_binaries_for_Xperia_Android_10.0.7.1_r1_v12b_seine.img
which you need to download as instructed in chapter 5 of Sailfish instructions for Xperia 10 II:
Check that the contents of the flashing directory are like in the picture below.
Xperia 10 III
Extracting the Sailfish zip package brings in everything necessary, except for the Sony binary image SW_binaries_for_Xperia_Android_10.0.7.1_r1_v9a_lena.img
which you need to download as instructed in chapter 5 of Sailfish instructions for Xperia 10 III:
Check that the contents of the flashing directory are like in the picture below.
Xperia 10 IV
Check that the contents of the flashing directory are like in the picture below.
Xperia 10 V
Check that the contents of the flashing directory are like in the picture below.
Final check before flashing
Here we check that fastboot really works and that the bootloader is unlocked. The procedure below should not be needed. Run it if there are problems in installing Sailfish OS.
- Connect your device in the fastboot mode (blue indicator light is lit) to your computer with a USB cable.
- On the computer, open the terminal and change the directory to your flashing directory (see the chapter “Correct contents in the flashing directory”. This is crucial in the case of Windows especially, as we rely on fastboot.exe located in this directory.
- Give the command below. NOTE for Windows: We recommend using the default command shell of Windows (CMD) instead of PowerShell as the latter may have an incompatible configuration and the command syntax below would not work.
fastboot getvar all
It should print 20 to 200 lines of text, including:
(bootloader) unlocked: yes
(bootloader) secure: no
(bootloader) product: H4113
(or XQ-DC54 or another code)
this item dictates which Sailfish image you need to select at https://shop.jolla.com/downloads/(bootloader) version-baseband: 1311-2918_50.1.A.13.83
where “50.1.A.13.83” (an example here) is the build number (a.k.a. Android baseband version) from your phone (see chapter “A) Settings > System > About phone” above).
If you get a decent result containing the items above, proceed to the next chapter. However, if the command failed then check again everything in the chapters above and retry. If the command indicated that the bootloader is not unlocked (i.e., it is still locked), then you cannot install Sailfish OS to this device (unless you are able to unlock it).
Flashing Sailfish OS
The instructions for the actual flashing (installing the code to the phone) are in our Sailfish OS instructions. Note that there are different instructions for Xperia X, Xperia XA2, Xperia 10, Xperia 10 II, Xperia 10 III, Xperia 10 IV and, Xperia 10 V. Please select the correct link below depending on your phone and computer:
Printouts from the flashing script in a successful case
The attached PDF files show the output from the flashing script run successfully.
- Example 1: OS version 4.5.0.19 to an Xperia 10 II (XQ-AU52) with a Windows 11 PC: PDF1.
- Example 2: OS version 4.4.0.72 to an Xperia 10 II (XQ-AU52) with a Linux Ubuntu PC: PDF2.
Troubleshooting the USB connection and fastboot mode
- The phone must be connected to the computer in the fastboot mode before the fastboot command can be used. Ensure that the phone has power off. If in doubt, use the Forced Power Off method. Press and hold the Volume Up button and connect the USB cable between your phone and your computer. Wait for the indicator light to light up blue on the phone. If the Volume Up key is pressed too hard then green light may appear. Therefore, make sure you press the button gently when connecting the USB cable. If you keep getting the green light, restart the PC and the phone, and try again. If the phone has a cover (hiding the keys on the side) consider removing it. If the problem persists no matter what you try, check that the volume keys of your phone work in normal conditions, i.e. when playing music or video with the phone.
- Make sure that your USB cable is a data cable (having all lines connected) and not a charging cable. You can test this by copying a file over the cable from the PC to the phone or v.v.
- Sometimes a certain USB port on the PC may not work. In such a case try another USB port.
- Sometimes USB3 ports fail to work. In such a case try a USB2 port, if available. We recommend trying a USB2 hub if USB2 ports are not available.
- Linux: flashing Sailfish to Xperia XA2 might get interrupted in the message “ FAILED (remote: ‘unknown command’)”. In that case, read this document.
Sailfish OS is the technical name while Sailfish X is the commercial name. ↩