NixOS Wiki

NixOS on ARM/Raspberry Pi: Difference between revisions

← Older edit
VisualWikitext
imported>Petersjt014
updated note about 3B+ image
Tennox (talk | contribs)
3 edits
Add Raspberry Pi 5 to tables (it's already described below)
 
(56 intermediate revisions by 26 users not shown)
Line 17: Line 17:
|-
|-
!colspan="2" class="title"|Raspberry Pi 3
!colspan="2" class="title"|Raspberry Pi 3
|-
!Architecture
|AArch64 + ARMv7
|-
!colspan="2" class="title"|Raspberry Pi 4
|-
!Architecture
|AArch64 + ARMv7
|-
! colspan="2" |Raspberry Pi 5
|-
|-
!Architecture
!Architecture
Line 22: Line 32:
|}
|}
</div>
</div>
<!-- TODO : write intro paragraph -->
The Raspberry Pi family of devices is a series of single-board computers made by the Raspberry Pi Foundation. They are all based on Broadcom System-on-a-chip (SOCs).
 
== Status ==
== Status ==


Only the ''Raspberry Pi 3'' is supported upstream, with the aarch64 effort.
Only the ''Raspberry Pi 3 Family'' is supported upstream, with the AArch64 effort. Other Raspberry Pis are part of '''@dezgeg''''s porting efforts to ARMv6 and ARMv7.


Other Raspberry Pis are part of '''@dezgeg''''s porting efforts to ARMv6 and ARMv7.
The Linux kernel in use, except for the Raspberry Pi 1 family, is the mainline Linux kernel, and not the Raspberry Pi Foundation's fork. This could reduce compatibility with some add-on boards or third-party libraries<sup>[expanded explanation needed]</sup>.
 
The following table is intended to be updated by the NixOS contributors with the current status of the boards. For a list of products, [https://www.raspberrypi.org/products/ see the ''Products Archive]''.
 
{|class="wikitable"
|-
! Board name
! Architecture
! Support
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 1
|-
| Raspberry Pi 1 Model B
|rowspan="5" style="vertical-align: middle;"| armv6
| C
|-
| Raspberry Pi 1 Model A+
| C*
|-
| Raspberry Pi 1 Model B+
| C
|-
| Raspberry Pi Zero
| C*
|-
| Raspberry Pi Zero W
| C
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 2
|-
| Raspberry Pi 2 Model B
| armv7
| C
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 3
|-
| Raspberry Pi 3 Model B
|rowspan="3" style="vertical-align: middle;"| AArch64<br /> ''+ armv7''
| YES
|-
| Raspberry Pi 3 Model B+
| YES
|-
| Raspberry Pi 3 Model A+
| ?
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 4
|-
| Raspberry Pi 4 Model B
| AArch64<br /> ''+ armv7''
| YES
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 400
|-
| Raspberry Pi 400
| AArch64<br /> ''+ armv7''
| Yes (only with kernel >= 6.1)
|-
! colspan="3" |Raspberry Pi 5
|-
|Raspberry Pi 5
|AArch64<br /> ''+ armv7''
|C*
|}
 
''Support''
* YES: Supported architecture by Nixpkgs downstream and tested to be working.
* C: Community supported, and tested to be working.
* C*: Community supported, unverified but should be working.
* ? : Unverified, unknown if it will work.
 
The Raspberry Pi 3 Family is only supported as '''AArch64'''. Use as armv7 is community supported.


== Board-specific installation notes ==
== Board-specific installation notes ==
Line 41: Line 123:
The ARMv7 image should boot out-of-the-box, though the author hasn't personally tested this.
The ARMv7 image should boot out-of-the-box, though the author hasn't personally tested this.


=== Raspberry Pi 3 ===
=== Raspberry Pi 3 / 3B+ ===


Both the AArch64 and ARMv7 images boot out-of-the-box. Using the 64-bit AArch64 image is highly recommended, as the availability of binaries is much better and allows the use of the 64-bit instruction set.
Both the AArch64 and ARMv7 images boot out-of-the-box. Using the 64-bit AArch64 image is highly recommended, as the availability of binaries is much better and allows the use of the 64-bit instruction set.


Use the following GPIO Pins with an USB-TTL connector:  
For the UART console, edit <code>/extlinux/extlinux.conf</code> on the boot partition of the SD card to set <code>console=ttyS1,115200n8</code> in the kernel boot parameters, and use the following GPIO Pins with an USB-TTL connector:  
<syntaxhighlight>
<syntaxhighlight>
GND        - 3rd in top row, black cable
GND        - 3rd in top row, black cable
Line 52: Line 134:
</syntaxhighlight>
</syntaxhighlight>
Use <code>nix-shell -p screen --run "screen /dev/ttyUSB0 115200"</code> to connect to the console.  
Use <code>nix-shell -p screen --run "screen /dev/ttyUSB0 115200"</code> to connect to the console.  
{{note|Right now (2017-10-08) wifi is not working out of the box on the Raspberrypi 3, you will need to use ethernet. Add the following to your configuration.nix. This requires linux kernel > 4.13.0 }}
{{note|The mainline kernel (tested with nixos kernel 4.18.7) [https://github.com/raspberrypi/linux/wiki/Upstreaming#downstream-drivers does not include support for cpu frequency scaling] on the Raspberry Pi. To get higher clock speed, set [https://www.raspberrypi.org/documentation/configuration/config-txt/overclocking.md <code><nowiki>force_turbo=1</nowiki></code>] in <code>/boot/config.txt</code> }}
 
<syntaxhighlight lang=nix>
<syntaxhighlight lang=nix>
{
{
  ...
   hardware.enableRedistributableFirmware = true;
   hardware.enableRedistributableFirmware = true;
  hardware.firmware = [
    (pkgs.stdenv.mkDerivation {
    name = "broadcom-rpi3-extra";
    src = pkgs.fetchurl {
    url = "https://raw.githubusercontent.com/RPi-Distro/firmware-nonfree/54bab3d/brcm80211/brcm/brcmfmac43430-sdio.txt";
    sha256 = "19bmdd7w0xzybfassn7x4rb30l70vynnw3c80nlapna2k57xwbw7";
    };
    phases = [ "installPhase" ];
    installPhase = ''
    mkdir -p $out/lib/firmware/brcm
    cp $src $out/lib/firmware/brcm/brcmfmac43430-sdio.txt
    '';
    })
  ];
   networking.wireless.enable = true;
   networking.wireless.enable = true;
}
}
</syntaxhighlight>
</syntaxhighlight>


=== Raspberry Pi 3B+ ===
==== HDMI output issue with kernel 5.4 (NixOS 20.03 or NixOS unstable) ====
 
(Unverified for 5.5 or 5.6)
 
Some users have reported that the 5.4 kernel "hung at Starting kernel..." {{issue|82455}}. In all cases where it was possible to investigate, it was found that the device did boot, but that the HDMI out didn't function as expected.
 
It looks like it may be a setup-dependent issue, as a 20.03 image with 5.4 was verified as working.
 
If your setup is having the issue, first report on {{issue|82455}} with the Raspberry Pi model (important to note whether it is a plus or non-plus) and the kind of display used with the HDMI out, including whether it is using adapters or not.
 
Then, you can work around the issue by configuring your system to use the 4.19 kernel (previous LTS) using one of the following tricks.
 
# Use the serial console to configure the system, and <code>nixos-rebuild boot</code> it.
# Use a 19.09 image, specify the kernel in its configuration and upgrade to 20.03
# Boot the image, poweroff blindly using a keyboard, edit on another computer <code>/home/nixos/.ssh/authorized_keys</code> from the SD to add your key file, chmod as 600, unmount, boot the Raspberry Pi and find it on your network by some means.
 
<syntaxHighlight>
{
  boot.kernelPackages = pkgs.linuxPackages_4_19;
}
</syntaxHighlight>
 
=== Raspberry Pi 4 ===
''See'' [[NixOS on ARM/Raspberry Pi 4]]


<s>Until the kernel 3.18 is finalized, this will require a temporary work-around image. See also the note in the [[#Serial console]] section.</s> The workaround is no longer needed:
=== Raspberry Pi 5===
''See'' [[NixOS on ARM/Raspberry Pi 5]]


* https://github.com/NixOS/nixpkgs/issues/22014#issuecomment-399715748
== Audio ==
 
In addition to the usual config, it might be required to enable audio support explicitly in the firmwareConfig.
 
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
  sound.enable = true;
  hardware.pulseaudio.enable = true;
 
  boot.loader.raspberryPi.firmwareConfig = ''
    dtparam=audio=on
  '';
</nowiki>}}


== Serial console==
== Serial console==


Your configuration.nix will need to add <code>console=ttyS0,115200n8</code> to the <code>boot.kernelParams</code> configuration to use the serial console.
Your <code>configuration.nix</code> will need to add <code>console=ttyS1,115200n8</code> to the <code>boot.kernelParams</code> configuration to use the serial console.
 
{{note|For the Raspberry Pi 3B+ it has been reported that the console may be <tt>ttyS1</tt> instead of <tt>ttyS0</tt>.}}


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
Line 91: Line 192:
{
{
   boot.kernelParams = [
   boot.kernelParams = [
     "console=ttyS0,115200n8"
     "console=ttyS1,115200n8"
   ];
   ];
}
</nowiki>}}
If the Raspberry Pi downstream kernel is used the serial interface is named <code>serial0</code> instead.
== Bluetooth ==
The bluetooth controller is by default connected via a UART device (<code>/dev/ttyAMA0</code> on the RPi4) and needs to be enabled through <code>btattach</code>:
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{ pkgs, ... }:
{
  systemd.services.btattach = {
    before = [ "bluetooth.service" ];
    after = [ "dev-ttyAMA0.device" ];
    wantedBy = [ "multi-user.target" ];
    serviceConfig = {
      ExecStart = "${pkgs.bluez}/bin/btattach -B /dev/ttyAMA0 -P bcm -S 3000000";
    };
  };
}
}
</nowiki>}}
</nowiki>}}
Line 100: Line 221:
For the camera to work, you will need to add the following code to your configuration.nix:  
For the camera to work, you will need to add the following code to your configuration.nix:  


{{note| Two pull requests ({{pull|38490}} and {{pull|38342}}) are required to make this configuration.nix and the camera working.}}
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{ config, pkgs, lib, ... }:
{ config, pkgs, lib, ... }:
Line 110: Line 230:
   boot.loader.raspberryPi.uboot.enable = true;
   boot.loader.raspberryPi.uboot.enable = true;
   # These two parameters are the important ones to get the
   # These two parameters are the important ones to get the
   # camera working. These will be appended to /boot/configuration.txt.
   # camera working. These will be appended to /boot/config.txt.
   boot.loader.raspberryPi.firmwareConfig = ''
   boot.loader.raspberryPi.firmwareConfig = ''
     start_x=1
     start_x=1
Line 127: Line 247:
}
}
</nowiki>}}
</nowiki>}}
== Binary Cache ==
== Binary Cache ==


Depending on the architecture used, binary caches availability varies. Binary caches instructions are on the main [[NixOS on ARM#Binary cache|NixOS on ARM]] page. The following table desribes the architectures supported by each board.  
Depending on the architecture used, binary caches availability varies. Binary caches instructions are on the main [[NixOS on ARM#Binary cache|NixOS on ARM]] page. The following table describes the architectures supported by each board.  


{|class="wikitable"
{|class="wikitable"
Line 143: Line 262:
| armv7
| armv7
|-
|-
| aarch64
| AArch64
|-
!rowspan="2" style="vertical-align: middle;"|Raspberry Pi 4
| armv7
|-
| AArch64
|}
|}
== Kernel selection ==
By default NixOS uses the official Linux kernel released by kernel.org (a "mainline" kernel, e.g. <code>pkgs.linuxPackages</code>). This works fine on a Raspberry Pi, and is the better-tested option.
It is also possible to use a kernel released by the Raspberry Pi Foundation (a "vendor" kernel, e.g. <code>pkgs.linuxPackages_rpi3</code>). This may be preferable if you're using an add-on board that the mainline kernel does not have drivers for.
You can select your kernel by setting <code>boot.kernelPackages</code>.


== Notes about the boot process ==
== Notes about the boot process ==
The Raspberry Pi's stage 1 bootloader (in ROM) loads the stage 2 bootloader (bootcode.bin) from the first VFAT partition on the SD card. The NixOS aarch64 SD card image includes a VFAT partition (labelled <code>FIRMWARE</code>) with the stage 2 bootloader and configuration that loads U-Boot. U-Boot then continues from the second partition (labelled <code>NIXOS_SD</code>).
It takes approximately 1 minute to boot a Pi 3B.
There are 2 primary options for booting a Raspberry Pi:
=== Boot option 1: <code>boot.loader.generic-extlinux-compatible</code> ===
This configuration is the most similar to the way that NixOS works on other devices. The downside is that NixOS won't attempt to manage anything associated with the first and second stage bootloaders (e.g. config.txt).
You can feel better about this by thinking about this configuration as similar to BIOS settings.
<syntaxhighlight lang="nix">
boot.loader.grub.enable = false;
boot.loader.generic-extlinux-compatible.enable = true;
</syntaxhighlight>
=== Boot option 2: <code>boot.loader.raspberryPi</code> ===
{{warning| This option has been deprecated in https://github.com/NixOS/nixpkgs/pull/241534}}
This configuration assumes that the VFAT firmware partition is mounted to /boot. If it isn't, options like <code>boot.loader.raspberryPi.firmwareConfig</code> will write their configuration to the wrong partition and have no effect.
<syntaxhighlight lang="nix">
boot.loader.grub.enable = false;
boot.loader.raspberryPi.enable = true;
boot.loader.raspberryPi.uboot.enable = true;
</syntaxhighlight>


=== Raspberry Pi (all versions) ===
=== Raspberry Pi (all versions) ===


USB keyboards and HDMI displays work perfectly.
USB keyboards and HDMI displays should work, though some issues have been reported (see Troubleshooting below).


Using the 3.3v serial port via the pin headers (exact location depends on hardware version) will get u-boot output and, when configured, a Linux kernel console.
Using the 3.3v serial port via the pin headers (exact location depends on hardware version) will get u-boot output and, when configured, a Linux kernel console.
== Device trees ==
Raspberry Pi add-on hardware often requires a device tree overlay. On other OSes this is usually set up using a <code>dtoverlay=</code> option in config.txt on the firmware partition. This approach can be made to work on NixOS with some combination of bootloader and kernel, but it may be easier and more explicit to use NixOS' <code>hardware.deviceTree</code> option to compile the overlay directly into the device tree.
A device tree config looks something like this:
<syntaxhighlight lang="nix">
hardware.deviceTree = {
    enable = true;
    overlays = [
      {
        name = "hifiberry-dacplus";
        dtsText = ''
/dts-v1/;
/plugin/;
/ {
      compatible = "brcm,bcm2835";
// ... etc.
'';
      };
    ];
  };
</syntaxhighlight>
This will apply the overlay to all <code>.dtb</code> files with a matching <code>compatible</code> line.
After rebooting you can check if the overlay has been applied by looking for it in the output of <code>dtc --sort /proc/device-tree</code>.
dtoverlay may fail with <code>FDT_ERR_NOTFOUND</code> on some Raspberry Pi device tree overlays. In this case dtmerge should be used instead. There is a Nix overlay to use dtmerge for applying device tree overlays: https://github.com/NixOS/nixos-hardware/blob/429f232fe1dc398c5afea19a51aad6931ee0fb89/raspberry-pi/4/apply-overlays-dtmerge.nix


== Troubleshooting ==
== Troubleshooting ==
Line 158: Line 350:
=== Power issues ===
=== Power issues ===


Especially with the power-hungry Raspberry Pi 3, it is important to have a [https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md sufficient enough power supply] or ''weirdness'' may happen. Weirdness may include:
Especially with the power-hungry Raspberry Pi 3, it is important to have a [https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md sufficient enough power supply] or unexpected behaviour may occur; this may include:


* Lightning bolt on HDMI output "breaking" the display.
* Lightning bolt on HDMI output "breaking" the display.
* Screen switching back to u-boot text
* Screen switching back to u-boot text
** Fixable temporarily when power is sufficient by swtiching VT (alt+F2 / alt+F1)
** Fixable temporarily when power is sufficient by switching VT (alt+F2 / alt+F1)
* Random hangs
* Random hangs


This problem is a hard problem. It is caused by the Raspberry Pi warning about power issues, but the current drivers (as of  
This is a hard problem. It is caused by the Raspberry Pi warning about power issues, but the current drivers (as of  
Linux 4.14) have a hard time dealing with it properly. If the power supply is rated properly AND the cable is not incurring too much power losses, it may be required to disable the lightning bolt indicator so the display driver isn't messed up.<ref>https://logs.nix.samueldr.com/nixos/2017-12-20#1513784657-1513784714;</ref> The lightning bolt indicator can be disabled by adding the line <code>avoid_warnings=1</code> in config.txt<ref>https://www.raspberrypi.org/documentation/configuration/config-txt/README.md</ref>
Linux 4.14) have a hard time dealing with it properly. If the power supply is rated properly AND the cable is not incurring too much power losses, it may be required to disable the lightning bolt indicator so the display driver isn't messed up.<ref>https://logs.nix.samueldr.com/nixos/2017-12-20#1513784657-1513784714;</ref> The lightning bolt indicator can be disabled by adding the line <code>avoid_warnings=1</code> in config.txt<ref>https://www.raspberrypi.org/documentation/configuration/config-txt/README.md</ref>


{{note|A ''properly rated'' USB power supply, AND a good cable are necessary. The cable has to be short enough to not incur power losses through the length. Do note that thin and cheap cables usually have thinner copper wires, which in turn accentuates power losses.}}
{{note|A ''properly rated'' USB power supply, AND a good cable are necessary. The cable has to be short enough to not incur power losses through the length. Do note that thin and cheap cables usually have thinner copper wires, which in turn accentuates power losses.}}
===WiFi / WLAN===
For a possible solution to 802.11 wireless connectivity issues, see: https://github.com/NixOS/nixpkgs/issues/82462#issuecomment-604634627
===HDMI===
HDMI issues have been observed on the 18.09 AArch64 image. The display would hang on "Starting Kernel...", then act as if the HDMI cable was unplugged. Re-plugging the HDMI cable after boot fixed the issue, as did a different monitor and HDMI cable.
==== Early boot messages ====
To show boot messages from initrd with the mainline kernel, add this to <code>configuration.nix</code>.
<syntaxhighlight lang=nix>
{
  boot.initrd.kernelModules = [ "vc4" "bcm2835_dma" "i2c_bcm2835" ];
}
</syntaxhighlight>
=== Raspberry Pi 3B+ HDMI output issues ===
As of 2019/08/19, the u-boot build and kernel build can disagree about the name of the dtb file for the Raspberry Pi 3B+. This happens because the upstream filename has changed, and the built u-boot has hardcoded expectations for the filename to load.
For now, do not use <tt>linuxPackages_latest</tt>, use the default <tt>linuxPackages</tt> which is the latest LTS, 4.19, which is known to be compatible.
See {{issue|66960}}.
===Additional Troubleshooting===
Additional troubleshooting information may be found [https://elinux.org/R-Pi_Troubleshooting at elinux.org].


<hr />
<hr />
Retrieved from "https://wiki.nixos.org/wiki/NixOS_on_ARM/Raspberry_Pi"