Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Raspberry Pi 4 #336

Merged
merged 1 commit into from
Nov 5, 2021
Merged

Add documentation for Raspberry Pi 4 #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added modules/ROOT/assets/images/raspberry-pi-imager.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
** xref:provisioning-libvirt.adoc[Booting on libvirt]
** xref:provisioning-openstack.adoc[Booting on OpenStack]
** xref:provisioning-qemu.adoc[Booting on QEMU]
** xref:provisioning-raspberry-pi4.adoc[Booting on the Raspberry Pi 4]
** xref:provisioning-virtualbox.adoc[Booting on VirtualBox]
** xref:provisioning-vmware.adoc[Booting on VMware]
** xref:provisioning-vultr.adoc[Booting on Vultr]
Expand Down
203 changes: 203 additions & 0 deletions modules/ROOT/pages/provisioning-raspberry-pi4.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
= Provisioning Fedora CoreOS on the Raspberry Pi 4

Fedora CoreOS produces 64-bit ARM (`aarch64`) artifacts. These images can be used as the Operating System for the Raspberry Pi 4 device. Before trying to get FCOS up and running on your Raspberry Pi 4 you'll want to xref:#_updating_eeprom_on_raspberry_pi_4[Update the EEPROM] to the latest version and choose how you want to boot the Raspberry Pi 4. There are two options:

- xref:#_installing_fcos_and_booting_via_u_boot[Installing FCOS and Booting via U-Boot]
- xref:#_installing_fcos_and_booting_via_uefi[Installing FCOS and Booting via UEFI]

U-Boot is the way the Raspberry Pi 4 has traditionally been booted. The https://rpi4-uefi.dev/about/[UEFI Firmware] is an effort to provide a layer that will make RPi4 ServerReady (SBBC compliant) similar to most larger 64-bit ARM servers.

## Updating EEPROM on Raspberry Pi 4

The Raspberry Pi 4 uses an EEPROM to boot the system. The EEPROM/Firmware in the past https://github.com/raspberrypi/rpi-eeprom/blob/master/firmware/release-notes.md#2021-10-04---add-support-for-gpt-fat16-and-increase-usb-timeouts---beta[had problems reading a FAT16 EFI partition], which https://github.com/coreos/fedora-coreos-tracker/issues/993[FCOS uses]. For the best experience getting FCOS to run on the RPi4 please update the EEPROM to the latest version. To check if you have the latest version you can go to the https://github.com/raspberrypi/rpi-eeprom/releases[raspberrypi/rpi-eeprom releases page] and make sure the version reported by your Raspberry Pi on boot is from around the same date as the last release.

NOTE: Ignore the October 8th 2021 release as it was just a repackaging of a previous release.

The https://www.raspberrypi.org/documentation/computers/raspberry-pi.html#updating-the-bootloader[Raspberry Pi Documentation] recommends using the Raspberry Pi Imager for creating a boot disk that can be used to update the EEPROM. If you're on a flavor of Fedora Linux the Raspberry Pi Imager is packaged up and available in the repositories. You can install it with:

[source, bash]
----
dnf install rpi-imager
----

NOTE: This also works inside a Toolbx container.

If not on Fedora Linux you'll need to follow the documentation for obtaining the imager.

Once you have the imager up and running (on Fedora you can run it with `rpi-imager` on the command line), you'll see the imager application load:

image::raspberry-pi-imager.png["Raspberry Pi Imager Application"]

At this point you can follow https://www.raspberrypi.org/documentation/computers/raspberry-pi.html#updating-the-bootloader[the documentation] for how to create the disk and then update your Raspberry Pi 4.

## Installing FCOS and Booting via U-Boot

To run FCOS on a Raspberry Pi 4 via U-Boot the SD card or USB disk needs to be prepared on another system and then the disk moved to the RPi4. After writing FCOS to the disk a few more files will need to be copied in place on the EFI partition of the FCOS disk. Check out the https://www.raspberrypi.com/documentation/computers/configuration.html#boot-folder-contents[Raspberry Pi Documentation] to read more about what these files are for.

In this case we can grab these files from the `uboot-images-armv8`, `bcm283x-firmware`, `bcm283x-overlays` RPMs from the Fedora Linux repositories. First download them and store them in a temporary directory on your system:

[source, bash]
----
RELEASE=34 # The target Fedora Release. Use the same one that current FCOS is based on.
mkdir -p /tmp/RPi4boot/boot/efi/
sudo dnf install -y --downloadonly --release=$RELEASE --forcearch=aarch64 --destdir=/tmp/RPi4boot/ uboot-images-armv8 bcm283x-firmware bcm283x-overlays
----

Now extract the contents of the RPMs and copy the proper `u-boot.bin` for the RPi4 into place:

[source, bash]
----
for rpm in /tmp/RPi4boot/*rpm; do rpm2cpio $rpm | sudo cpio -idv -D /tmp/RPi4boot/; done
sudo mv /tmp/RPi4boot/usr/share/uboot/rpi_4/u-boot.bin /tmp/RPi4boot/boot/efi/rpi4-u-boot.bin
----

Run `coreos-installer` to install to the target disk. There are https://coreos.github.io/coreos-installer/getting-started/[various ways] to run `coreos-installer` and install to a target disk. We won't cover them all here, but this workflow most closely mirrors the xref:bare-metal.adoc#_installing_from_the_container["Installing from the container"] documentation.

[source, bash]
----
FCOSDISK=/dev/sdX
sudo coreos-installer install --architecture=aarch64 -i config.ign $FCOSDISK
----

NOTE: Make sure you provide an xref:producing-ign.adoc[Ignition config] when you run `coreos-installer`.

Now mount the EFI partition and copy the files over:

[source, bash]
----
FCOSEFIPARTITION=$(lsblk $FCOSDISK -J -oLABEL,PATH | jq -r '.blockdevices[] | select(.label == "EFI-SYSTEM")'.path)
mkdir /tmp/FCOSEFIpart
sudo mount $FCOSEFIPARTITION /tmp/FCOSEFIpart
sudo rsync -avh --ignore-existing /tmp/RPi4boot/boot/efi/ /tmp/FCOSEFIpart/
sudo umount ${FCOSDISK}2
----

Now take the USB/SD card and attach it to the RPi4 and boot.

TIP: It can take some time to boot, especially if the disk is slow. Be patient. You may not see anything on the screen for 20-30 seconds.


## Installing FCOS and Booting via UEFI

There is a UEFI firmware implementation for the RPi4 (https://github.com/pftf/RPi4/[pftf/RPi4]) that attempts to make the RPi4 ServerReady (SBBC compliant) and allows you to pretend that the RPi4 is just like any other server hardware with UEFI.

You can write the firmware to a disk (USB or SD card) and then boot/install FCOS as you would on any bare metal server. However, the firmware files need to be on an SD card or USB disk and will take up either the SD card slot or a USB slot. Depending on your needs this may be acceptable or not. Depending on the answer you have a few options:

- Separate UEFI Firmware Disk (aka "separate disk mode")
- Combined Fedora CoreOS + UEFI Firmware Disk (aka "combined disk mode")

These options are covered in the following sections. Regardless of which option you choose you'll want to consider if you need to either xref:#_uefi_firmware_changing_the_3g_limit[Change the 3G RAM limit] or xref:#_uefi_firmware_gpio_via_devicetree[Enable DeviceTree Boot].


### UEFI: Separate UEFI Firmware Disk Mode

In separate disk mode the UEFI firmware will take up either the SD card slot or a USB slot on your RPi4. Once the firmware disk is attached to the system you'll be able to follow the xref:bare-metal.adoc[bare metal install documentation] and pretend like the RPi4 is any other server hardware.

To create a disk (SD or USB) with the firmware on it you can do something like:

[source, bash]
----
VERSION=v1.32 # use latest one from https://github.com/pftf/RPi4/releases
UEFIDISK=/dev/sdX
sudo mkfs.vfat $UEFIDISK
mkdir /tmp/UEFIdisk
sudo mount $UEFIDISK /tmp/UEFIdisk
pushd /tmp/UEFIdisk
sudo curl -LO https://github.com/pftf/RPi4/releases/download/${VERSION}/RPi4_UEFI_Firmware_${VERSION}.zip
sudo unzip RPi4_UEFI_Firmware_${VERSION}.zip
sudo rm RPi4_UEFI_Firmware_${VERSION}.zip
popd
sudo umount /tmp/UEFIdisk
----

Attaching this disk to your Pi4 you can now install FCOS as you would on any bare metal server.

NOTE: The separate UEFI firmware disk will need to stay attached permanently for future boots to work.

### UEFI: Combined Fedora CoreOS + UEFI Firmware Disk

In combined disk mode the UEFI firmware will live inside the EFI partition of Fedora CoreOS, allowing for a single disk to be used for the UEFI firmware and FCOS.

There are a few ways to achieve this goal:

- Install Directly on RPi4
- Prepare Pi4 Disk on Alternate Machine


#### UEFI: Combined Disk Mode Direct Install

When performing a direct install, meaning you boot (via the UEFI firmware) into the Fedora CoreOS live environment (ISO or PXE) and run `coreos-installer`, you can mount the EFI partition (2nd partition) of the installed FCOS disk after the install is complete and copy the UEFI firmware files over:

[source, bash]
----
UEFIDISK=/dev/mmcblkX or /dev/sdX
FCOSDISK=/dev/sdY
FCOSEFIPARTITION=$(lsblk $FCOSDISK -J -oLABEL,PATH | jq -r '.blockdevices[] | select(.label == "EFI-SYSTEM")'.path)
mkdir /tmp/mnt{1,2}
sudo mount $UEFIDISK /tmp/mnt1
sudo mount $FCOSEFIPARTITION /tmp/mnt2
sudo rsync -avh /tmp/mnt1/ /tmp/mnt2/
sudo umount /tmp/mnt1 /tmp/mnt2
----

Now you can remove the extra disk from the RPi4 and reboot the machine.

TIP: It can take some time to boot, especially if the disk is slow. Be patient. You may not see anything on the screen for 20-30 seconds.

#### UEFI: Combined Disk Mode Alternate Machine Disk Preparation

When preparing the RPi4 disk from an alternate machine (i.e. creating the disk from your laptop) then you can mount the 2nd partition **after** running `coreos-installer` and pull down the UEFI firmware files.

First, run `coreos-installer` to install to the target disk:

[source, bash]
----
FCOSDISK=/dev/sdX
sudo coreos-installer install --architecture=aarch64 -i config.ign $FCOSDISK
----

Now you can mount the 2nd partition and pull down the UEFI firmware files:

[source, bash]
----
FCOSEFIPARTITION=$(lsblk $FCOSDISK -J -oLABEL,PATH | jq -r '.blockdevices[] | select(.label == "EFI-SYSTEM")'.path)
mkdir /tmp/FCOSEFIpart
sudo mount $FCOSEFIPARTITION /tmp/FCOSEFIpart
pushd /tmp/FCOSEFIpart
VERSION=v1.32 # use latest one from https://github.com/pftf/RPi4/releases
sudo curl -LO https://github.com/pftf/RPi4/releases/download/${VERSION}/RPi4_UEFI_Firmware_${VERSION}.zip
sudo unzip RPi4_UEFI_Firmware_${VERSION}.zip
sudo rm RPi4_UEFI_Firmware_${VERSION}.zip
popd
sudo umount /tmp/FCOSEFIpart
----

Now take the USB/SD card and attach it to the RPi4 and boot.

TIP: It can take some time to boot, especially if the disk is slow. Be patient. You may not see anything on the screen for 20-30 seconds.

### UEFI Firmware: Changing the 3G limit

If you have a Pi4 with more than 3G of memory you'll most likely want to disable the 3G memory limitation. In the UEFI firmware menu go to

- `Device Manager` -> `Raspberry Pi Configuration` -> `Advanced Configuration` -> `Limit RAM to 3GB` -> `Disabled`
- `F10` to save -> `Y` to confirm
- `Esc` to top level menu and select `reset` to cycle the system.

### UEFI Firmware: GPIO via DeviceTree

With the UEFI Firmware in ACPI mode (the default) you won't get access to GPIO (i.e. no Pi HATs will work). To get access to GPIO pins you'll need to change the setting to DeviceTree mode in the UEFI menus.

- `Device Manager` -> `Raspberry Pi Configuration` -> `Advanced Configuration` -> `System Table Selection` -> `DeviceTree`
- `F10` to save -> `Y` to confirm
- `Esc` to top level menu and select `reset` to cycle the system.

After boot you should see entries under `/proc/device-tree/` and also see `/dev/gpiochip1` and `/dev/gpiochip2`:

[source, bash]
----
[core@localhost ~]$ ls /proc/device-tree/ | wc -l
35
[core@localhost ~]$ ls /dev/gpiochip*
/dev/gpiochip0 /dev/gpiochip1
----