Difference between revisions of "Purism Librem5 (purism-librem5)"

From postmarketOS
Jump to navigation Jump to search
(remove device milestone link)
m (add instructions for smartcard installation/setup)
Line 159: Line 159:
  
 
These directions were gathered from '''[https://developer.puri.sm/Librem5/Development_Environment/Phone/Troubleshooting/Reflashing_the_Phone.html#flash-the-image Purism's documentation]''', refer to it for additional details/troubleshooting.
 
These directions were gathered from '''[https://developer.puri.sm/Librem5/Development_Environment/Phone/Troubleshooting/Reflashing_the_Phone.html#flash-the-image Purism's documentation]''', refer to it for additional details/troubleshooting.
 +
 +
== OpenPGP Smartcard ==
 +
 +
In order to use the OpenPGP smartcard reader, most Librem 5 phones will need to have the reader firmware upgraded. The firmware can be built from source, but Purism has created a helper script to download/flash the firmware. In order to run this script on Alpine Linux / postmarketOS, these patches should be applied: https://source.puri.sm/angus.ainslie/ttxs-firmware/-/merge_requests/3/diffs
 +
 +
Running the script should result in the following if it is successful:
 +
 +
<syntaxhighlight lang="shell-session">
 +
$ ./scripts/stm_reflash.sh
 +
Connecting to source.puri.sm (178.63.173.204:443)
 +
saving to '/tmp/tmp.FLFPGo/ttxs.bin'
 +
ttxs.bin            100% |********************************************************************************************************************************************************************|  9096  0:00:00 ETA
 +
'/tmp/tmp.FLFPGo/ttxs.bin' saved
 +
2a5f7172591d76ae3177b0ccd94f70d67597e4a7  /tmp/tmp.FLFPGo/ttxs.bin
 +
0
 +
1
 +
1
 +
stm32flash 0.6
 +
http://stm32flash.sourceforge.net/
 +
Using Parser : Raw BINARY
 +
Interface serial_posix: 57600 8E1
 +
Version      : 0x31
 +
Option 1    : 0x00
 +
Option 2    : 0x00
 +
Device ID    : 0x0435 (STM32L43xxx/44xxx)
 +
- RAM        : Up to 48KiB  (12544b reserved by bootloader)
 +
- Flash      : Up to 256KiB (size first sector: 1x2048)
 +
- Option RAM : 16b
 +
- System RAM : 28KiB
 +
Write to memory
 +
Erasing memory
 +
Wrote address 0x08002388 (100.00%) Done.
 +
0
 +
0
 +
1
 +
</syntaxhighlight>
 +
 +
Reboot the phone after upgrading the firmware.
 +
 +
{{note|The next step depends on a package that is not yet available, see: https://gitlab.com/postmarketOS/pmaports/-/merge_requests/1993}}
 +
There's a package in the postmarketOS aports repo that enables/installs everything required to use a smartcard on this device: <code>sudo apk add device-purism-librem5-smartcard</code>. Reboot after installing this package for the first time.
 +
 +
For more information, including some examples of how to generate keys and push existing keys to the smart card using <code>gpg</code>, see Purism's Librem Key manual: https://docs.puri.sm/Librem_Key/Getting_Started/User_Manual.html
  
 
== Known Issues ==
 
== Known Issues ==
For an ever-up-to-date list of issues, see [https://gitlab.com/postmarketOS/pmaports/-/issues gitlab]
+
For an ever-up-to-date list of issues, see [https://gitlab.com/postmarketOS/pmaports/-/issues?label_name=device-purism-librem5 issues in gitlab with the device-purism-librem5 label]
 
 
* Suspend, as implemented in gnome settings under phosh, is not supported by the device [https://gitlab.com/postmarketOS/pmaports/-/issues/914].
 
  
== Related ==
+
* Suspend/resume is not supported on the Librem 5, this is an upstream issue and not specific to postmarketOS.
* {{MR|1673|pmaports}} upgrade to 5.9.1, information about selecting dtb on boot with u-boot (not enabled in this MR yet)
 

Revision as of 01:40, 26 February 2021

Purism Librem 5
Manufacturer Purism
Name Librem 5
Codename purism-librem5
Released 2019
Category community
Original software PureOS
Hardware
Chipset Emcraft NXP i.MX8M
CPU 4x 1.5 GHz Cortex-A53
GPU Vivante GC7000Lite
Display 1440x720
Storage 32 GB eMMC
Memory 3 GB
Architecture aarch64
Non-Android based device
Features
USB Networking
Works
Flashing
Works
Touchscreen
Works
Display
Works
WiFi
Works
Xwayland
Works
FDE
Works
Mainline
Works
Battery
Works
3D Acceleration
Works
Accelerometer
Works
Audio
Works
Bluetooth
Works
Camera
GPS
Works
Mobile data
Works
SMS
Works
Calls
Works
USB OTG
Partial



Contributors

Installation

From pre-built image (easy method)

Official images of postmarketOS for the Librem 5 are built at least every week. Currently the device is only supported on the edge branch of postmarketOS.

This method requires the uuu application is installed on the host computer. <uuu> is NXP's image deploy tool, and may be found in some distros in a package named mfgtools.

Download the right image

  • Branch (more):
    • edge: bleeding edge version (has latest features, but may break more often).
  • User interface
    • Phosh: Purism's GTK based phone interface (more)
    • Plasma Mobile: KDE's Plasma based phone interface (more)
    • (Note that more interfaces are available, build your own image with pmbootstrap if interested)
  • Pick the latest image by its date
  • Choose the regular image, or the installer image
    • Graphical Installer:
      • Ends in -installer.img.xz
      • Recommended for a proper installation.
      • Encrypting your installation is possible
      • Passwords for user and SSH are set during installation (and SSH can be disabled)
    • Regular image:
      • Ends in .img.xz
      • An installation of postmarketOS with defaults for passwords and no full disk encryption
      • The login is user with password 147147
      • sshd is currently enabled by default! (build.postmarketos.org#85)
      • Not recommended, unless looking for a quick way to try out postmarketOS

Download JumpDrive

Grab the latest purism-librem5.tar.xz image from the JumpDrive release page

JumpDrive 0.7 is the first version to support the Librem 5

Extract it, and you should see something similar:

$ tar xf purism-librem5.tar.xz
$ ls
boot-purism-librem5.sh  dtbs  initramfs-purism-librem5.gz  kernel-librem5.gz  purism-librem5.lst  purism-librem5.tar.xz  u-boot-librem5.bin

Run JumpDrive

Place the Librem 5 into #Flash Mode.

Use the helper script from the JumpDrive release to flash the Librem 5:

$ ./boot-purism-librem5.sh
uuu (Universal Update Utility) for nxp imx chips -- libuuu_1.4.72-0-g8e9e189

Success 1    Failure 0

3:2     10/10 [Done                                  ] FB: Done

Flash to EMMC

In order to flash the postmarketOS image to the Librem 5, locate the bock device exposed to the host computer via JumpDrive:

$ lsblk -o name,size,model,vendor
NAME        SIZE MODEL                     VENDOR
sda       476.9G Samsung_SSD_860_PRO_512GB ATA
├─sda1   1007.5K
├─sda2    476.8G
│ └─root  476.8G
└─sda3     99.3M
sdc        29.1G e_eMMC                    JumpDriv
├─sdc1      189M
└─sdc2     28.9G
zram0       247M

In the example above, the /dev/sdc is the EMMC device on the Librem 5.

Warning! Triple check you have selected the right block device when performing the next step!!
$ xzcat 20210217-0609-postmarketOS-edge-phosh-6-purism-librem5-installer.img.xz | sudo dd of=/dev/DRIVE status=progress bs=1M oflag=direct iflag=fullblock
4277141504 bytes (4.3 GB, 4.0 GiB) copied, 194 s, 22.0 MB/s
4093+0 records in
4093+0 records out
4291821568 bytes (4.3 GB, 4.0 GiB) copied, 200.427 s, 21.4 MB/s

Remove the usb cable and power cycle the phone to boot into the postmarketOS installer.

With pmbootstrap (Advanced)

Use pmbootstrap to build a customized image. Consult the installation guide for details.

$ pmbootstrap init # vendor: purism, device: librem5
$ pmbootstrap install...  # add --fde for full disk encryption

Place the device into #Flash Mode, then flash it with:

$ pmbootstrap flasher flash_rootfs

Flash Mode

To place the Librem 5 info flashing mode, perform the following:

  1. Ensure that the phone is switched off.
  2. Turn all Hardware-Kill-Switches off
  3. Remove battery
  4. Hold volume-up
  5. Insert the USB-c cable: (red light blinks, no green light)
  6. Reinsert the battery: (red light is constantly on, the script will continue)
  7. Release volume-up
Some USB-C cables may need to be plugged into the phone with a particular orientation. If the instructions above do not appear to work, try flipping the USB-C end of the cable over and replugging it into the phone.

These directions were gathered from Purism's documentation, refer to it for additional details/troubleshooting.

OpenPGP Smartcard

In order to use the OpenPGP smartcard reader, most Librem 5 phones will need to have the reader firmware upgraded. The firmware can be built from source, but Purism has created a helper script to download/flash the firmware. In order to run this script on Alpine Linux / postmarketOS, these patches should be applied: https://source.puri.sm/angus.ainslie/ttxs-firmware/-/merge_requests/3/diffs

Running the script should result in the following if it is successful:

$ ./scripts/stm_reflash.sh
Connecting to source.puri.sm (178.63.173.204:443)
saving to '/tmp/tmp.FLFPGo/ttxs.bin'
ttxs.bin             100% |********************************************************************************************************************************************************************|  9096  0:00:00 ETA
'/tmp/tmp.FLFPGo/ttxs.bin' saved
2a5f7172591d76ae3177b0ccd94f70d67597e4a7  /tmp/tmp.FLFPGo/ttxs.bin
0
1
1
stm32flash 0.6
http://stm32flash.sourceforge.net/
Using Parser : Raw BINARY
Interface serial_posix: 57600 8E1
Version      : 0x31
Option 1     : 0x00
Option 2     : 0x00
Device ID    : 0x0435 (STM32L43xxx/44xxx)
- RAM        : Up to 48KiB  (12544b reserved by bootloader)
- Flash      : Up to 256KiB (size first sector: 1x2048)
- Option RAM : 16b
- System RAM : 28KiB
Write to memory
Erasing memory
Wrote address 0x08002388 (100.00%) Done.
0
0
1

Reboot the phone after upgrading the firmware.

The next step depends on a package that is not yet available, see: https://gitlab.com/postmarketOS/pmaports/-/merge_requests/1993

There's a package in the postmarketOS aports repo that enables/installs everything required to use a smartcard on this device: sudo apk add device-purism-librem5-smartcard. Reboot after installing this package for the first time.

For more information, including some examples of how to generate keys and push existing keys to the smart card using gpg, see Purism's Librem Key manual: https://docs.puri.sm/Librem_Key/Getting_Started/User_Manual.html

Known Issues

For an ever-up-to-date list of issues, see issues in gitlab with the device-purism-librem5 label

  • Suspend/resume is not supported on the Librem 5, this is an upstream issue and not specific to postmarketOS.