User:Fxc/Software Draft

From PINE64
< User:Fxc
Revision as of 10:14, 12 April 2022 by Fxc (talk | contribs) (new text)
Jump to navigation Jump to search

Software

The software section explains how to install available software releases for the PinePhone Pro to the external or the internal memory and how to boot them and addresses common problems with booting the phone.

Note: Images of the regular PinePhone are not compatible with the PinePhone Pro.

Software releases

The PinePhone Pro Software Releases page has a complete list of currently supported phone-optimized operating system images that work with the PinePhone Pro.

Boot order

The RK3399S in the PinePhone Pro searches for the bootloader (for example the U-Boot SPL) in the following order:

  1. SPI flash
  2. eMMC (the internal memory)
  3. MicroSD card

The bootloader on the corresponding storage devices (for example the U-Boot SPL) can deviate from that fixed hardware boot order in software.

The SPI flash and the eMMC can be temporarily bypassed at boot by disconnecting them temporarily using the following method, for example in case of the installation on the SPI flash or the eMMC being corrupted:

  • On the Explorer Edition hold the RE button underneath the cover for a few seconds, while powering on the device.
  • On the Developer Edition, which was an earlier revision intended for developers only, the SPI and the eMMC can be bypassed by shorting the bypass contact points while booting. The process is explained in the article PinePhone Pro Developer Edition. Please join the community chat for any questions regarding the process.

The bypass disconnects the SPI and the eMMC while being held and the PinePhone Pro will try to boot from the next available boot medium, which is the microSD card. Note: When holding the RE button (or when shorting the contact points in case of the Developer Edition) for a longer time at boot the operating system will not initialize the SPI and eMMC and it will not be possible to write to these storage mediums until the next reboot.

Note: The bootloader (such as U-Boot) resides in the free space in front of the first partition. Wiping the bootloader from the eMMC to make the PinePhone Pro boot from microSD card can be done using sudo dd if=/dev/zero of=/dev/mmcblk2 seek=64 count=400 conv=fsync. Formatting the drive or deleting the partition table is not sufficient to wipe the bootloader.

See RK3399 boot sequence for details regarding the boot sequence.

Installation instructions

The software releases can be installed (the process is being referred to as flashing) to the eMMC or to an microSD card.

Flashing to microSD card

To install an image to the microSD card:

  1. Download a compatible image from PinePhone Pro Software Releases
  2. Extract the compressed image
  3. Write the image to your microSD card using your favorite method, examples:
    • Using dd: On the device you're flashing the microSD card from, find the correct device under lsblk and then flash the image to the microSD card using sudo dd if=IMAGE.img of=/dev/[DEVICE] bs=1M status=progress conv=fsync. Make sure the target is the whole microSD card and not its first partition (sdc1 or mmcblk0p1 are wrong!).
    • Using bmaptool: Make sure to select the correct device using lsblk. Then run bmaptool with the correct device: Download the IMAGE.xz and the 'IMAGE.bmap files, then run bmaptool copy --bmap IMAGE.bmap IMAGE.xz /dev/[DEVICE]. This takes around 2.5 minutes to flash a 4 GB file.
    • Using a graphical tool: A graphical tool such as Gnome Disks under Linux or Etcher under Windows may also be used.
  4. Insert the microSD card into the top slot of the PinePhone Pro. Make sure the microSD card is inserted all the way and that the notch of the right side of the microSD card is not visible anymore.
  5. Power on the PinePhone Pro. If there is an existing bootloader on the eMMC already you need to bypass or wipe the bootloader on the eMMC as explained in the section PinePhone Pro#Boot order

Flashing to the eMMC

Flashing to the eMMC can be done by booting an operating system from the microSD and by writing to the eMMC directly from there:

  1. Boot an operating system from the microSD card. If there is already a bootloader on the eMMC installed see the section PinePhone Pro#Boot order to bypass it
  2. Download or copy the desired image to the microSD card as file
  3. Check if the eMMC appears under lsblk. If it doesn't appear in the output of the command, the eMMC wasn't initialized due to applying the above explained bypass method for a too long time during the boot
  4. Extract the image
  5. Flash the extracted image using sudo dd if=IMAGE.img of=/dev/mmcblk2 bs=1M status=progress conv=fsync
  6. Reboot the PinePhone Pro

Troubleshooting

If the PinePhone Pro is not booting (either booting incompletely into a boot splash or tty or if the PinePhone Pro is showing no signs of life) this will typically have the following two reasons:

If the battery is fully drained U-Boot might fail to boot any installed operating system on the eMMC and microSD card due to a bug.

If that's the case please start your phone in Maskrom mode and let it charge in that for a few hours. To do that:

  • Remove any microSD card from the phone and keep it removed for the below procedure
  • Remove the battery, any USB cable and any serial cable
  • Reinsert the battery
  • Hold the "RE" button underneath the back cover of your Explorer Edition (or shorting the bypass contact points on the Developer Edition)
  • Connect the phone to an USB port of a computer, while still holding the button for some time
  • Check if the phone in Maskrom mode appears in the output of the Linux command lsusb on the computer
  • Let the phone charge for multiple hours

Note: If the device doesn't appear under lsusb please try again with a different known good USB-C cable make sure that there is no microSD card in the phone inserted.

It can be checked if the battery is charged or not by putting the phone into Maskrom mode and by removing the USB cable for 30 seconds and reinserting it into the computer. If the device reappears under lsusb the battery is not drained and the installed operating system on the eMMC is instead corrupted, in that case please see the following flashing instructions.