NixOS Wiki

NixOS on ARM/Raspberry Pi: Difference between revisions

← Older editNewer edit →
VisualWikitext
imported>Rogarb
No edit summary
imported>Mweinelt
Bluetooth: Clarify, that the documented device applies to the Raspberry Pi 4
Line 31: Line 31:
== Status ==
== Status ==


Only the ''Raspberry Pi 3 Family'' 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.
 
The Raspberry Pi 4B may require using the vendor kernel for better hardware support.
 
Other Raspberry Pis (0, 1, and 2) are part of diverse community 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 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>.
Line 46: Line 42:
! Architecture
! Architecture
! Support
! Support
|-
!colspan="3" style="text-align: left;"|Raspberry Pi Zero
|-
| Raspberry Pi Zero
|rowspan="2" stype="vertical-align: middle;"|armv6
| C*
|-
| Raspberry Pi Zero W
| C
|-
| Raspberry Pi Zero 2 W
|armv7
| ?
|-
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 1
!colspan="3" style="text-align: left;"|Raspberry Pi 1
|-
|-
| Raspberry Pi 1 Model B
| Raspberry Pi 1 Model B
|rowspan="3" style="vertical-align: middle;"| armv6
|rowspan="5" style="vertical-align: middle;"| armv6
| C
| C
|-
|-
Line 70: Line 53:
|-
|-
| Raspberry Pi 1 Model B+
| Raspberry Pi 1 Model B+
| C
|-
| Raspberry Pi Zero
| C*
|-
| Raspberry Pi Zero W
| C
| C
|-
|-
Line 80: Line 69:
!colspan="3" style="text-align: left;"|Raspberry Pi 3
!colspan="3" style="text-align: left;"|Raspberry Pi 3
|-
|-
| [[NixOS on ARM/Raspberry Pi 3|Raspberry Pi 3 Model B]]
| Raspberry Pi 3 Model B
|rowspan="3" style="vertical-align: middle;"| AArch64<br /> ''+ armv7''
|rowspan="3" style="vertical-align: middle;"| AArch64<br /> ''+ armv7''
| YES
| YES
|-
|-
| [[NixOS on ARM/Raspberry Pi 3|Raspberry Pi 3 Model B+]]
| Raspberry Pi 3 Model B+
| YES
| YES
|-
|-
| [[NixOS on ARM/Raspberry Pi 3|Raspberry Pi 3 Model A+]]
| Raspberry Pi 3 Model A+
| ?
| ?
|-
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 4
!colspan="3" style="text-align: left;"|Raspberry Pi 4
|-
|-
| [[NixOS on ARM/Raspberry Pi 4|Raspberry Pi 4 Model B]]
| Raspberry Pi 4 Model B
| AArch64<br /> ''+ armv7''
| YES
|-
!colspan="3" style="text-align: left;"|Raspberry Pi 400
|-
| Raspberry Pi 400
| AArch64<br /> ''+ armv7''
| AArch64<br /> ''+ armv7''
| Yes (only with kernel >= 6.1)
| YES* ([https://github.com/NixOS/nixpkgs/issues/63720 GitHub issue])
|}
|}


Line 117: Line 100:


=== Raspberry Pi (1) ===
=== Raspberry Pi (1) ===
The ARMv6 image boots out-of-the-box. The instructions to build an image for ARMv6 are adapted from [[NixOS_on_ARM#Build_your_own_image_natively|here]].


First, create your own configuration in sd-image.nix (adding cross-compiling information if needed):
The ARMv6 image boots out-of-the-box.
<syntaxHighlight lang=nix>
 
# save as sd-image.nix somewhere
=== Raspberry Pi 2 ===
{ ... }: {
 
  # uncomment for enabling cross compilation
The ARMv7 image should boot out-of-the-box, though the author hasn't personally tested this.
  #nixpkgs.crossSystem.system = "armv6l-linux";
 
  imports = [
=== Raspberry Pi 3 / 3B+ ===
    # This contains the default definition for the sdcard image build
 
    <nixpkgs/nixos/modules/installer/sd-card/sd-image-raspberrypi.nix>
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.
   ];
 
   # put your own configuration here, for example ssh keys:
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:  
  #users.users.root.openssh.authorizedKeys.keys = [
<syntaxhighlight>
  #   "ssh-ed25519 AAAAC3NzaC1lZDI1.... username@tld"
GND        - 3rd in top row, black cable
   #];
GPIO 14 TXD - 4th in top row, white cable
GPIO 15 RXD - 5th in top row, green cable
</syntaxhighlight>
Use <code>nix-shell -p screen --run "screen /dev/ttyUSB0 115200"</code> to connect to the console.  
{{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>
{
   hardware.enableRedistributableFirmware = true;
   networking.wireless.enable = true;
}
</syntaxhighlight>
 
==== 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>
</syntaxHighlight>


Then build the image:
=== Raspberry Pi 4B ===
Support for the Pi 4 in nixpkgs is still experimental. These configurations will boot (from [https://github.com/NixOS/nixpkgs/pull/68265#issuecomment-532040372 this PR comment]):
 
==== Without GPU ====
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{ pkgs, ... }:
 
{
  imports = [ </nowiki><nixpkgs/nixos/modules/installer/cd-dvd/sd-image-raspberrypi4.nix><nowiki> ];


<syntaxHighlight lang=nix>
  networking.wireless.enable = false;
$ nix-build '<nixpkgs/nixos>' -A config.system.build.sdImage -I nixos-config=./sd-image.nix
  services.xserver = {
</syntaxHighlight>
    enable = true;
    displayManager.slim.enable = true;
    desktopManager.gnome3.enable = true;
    videoDrivers = [ "fbdev" ];
  };
}
</nowiki>}}
 
==== With GPU ====
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{ pkgs, ... }:
 
{
  imports = [ </nowiki><nixpkgs/nixos/modules/installer/cd-dvd/sd-image-raspberrypi4.nix><nowiki> ];


=== Raspberry Pi 2 ===
  networking.wireless.enable = false;
  hardware.opengl = {
    enable = true;
    setLdLibraryPath = true;
    package = pkgs.mesa_drivers;
  };
  hardware.deviceTree = {
    base = pkgs.device-tree_rpi;
    overlays = [ "${pkgs.device-tree_rpi.overlays}/vc4-fkms-v3d.dtbo" ];
  };
  services.xserver = {
    enable = true;
    displayManager.slim.enable = true;
    desktopManager.gnome3.enable = true;
    videoDrivers = [ "modesetting" ];
  };


The ARMv7 image should boot out-of-the-box, though the author hasn't personally tested this.
  boot.loader.raspberryPi.firmwareConfig = ''
    gpu_mem=192
  '';
}
</nowiki>}}


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


[[NixOS_on_ARM/Raspberry_Pi_3#Board-specific_installation_notes|Raspberry Pi 3#Board-specific installation notes]]
In addition to the usual config, it might be required to enable audio support explicitly in the firmwareConfig.


=== Raspberry Pi 4B ===
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
  sound.enable = true;
  hardware.pulseaudio.enable = true;


[[NixOS_on_ARM/Raspberry_Pi_4#Board-specific_installation_notes|Raspberry Pi 4#Board-specific installation notes]]
  boot.loader.raspberryPi.firmwareConfig = ''
    dtparam=audio=on
  '';
</nowiki>}}


== Serial console==
== Serial console==
Line 166: Line 224:
}
}
</nowiki>}}
</nowiki>}}
If the Raspberry Pi downstream kernel is used the serial interface is named <code>serial0</code> instead.
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>}}
== Camera ==
For the camera to work, you will need to add the following code to your configuration.nix:
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{ config, pkgs, lib, ... }:
{
  boot.loader.raspberryPi.enable = true;
  # Set the version depending on your raspberry pi.
  boot.loader.raspberryPi.version = 3;
  # We need uboot
  boot.loader.raspberryPi.uboot.enable = true;
  # These two parameters are the important ones to get the
  # camera working. These will be appended to /boot/config.txt.
  boot.loader.raspberryPi.firmwareConfig = ''
    start_x=1
    gpu_mem=256
  '';
}
</nowiki>}}
{{note| A reboot is required to load the new firmware configuration.}}
To make the camera available as v4l device under <code>/dev/video0</code> the <code>bcm2835-v4l2</code> kernel module need to be loaded. This can be done by adding the following code to your configuration.nix:
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{ config, pkgs, lib, ... }:
{
  boot.kernelModules = [ "bcm2835-v4l2" ];
}
</nowiki>}}
== Binary Cache ==
== Binary Cache ==


Line 193: Line 300:
== Notes about the boot process ==
== Notes about the boot process ==


The custom bootloader, part of the Raspberry Pi firmware, is abstracted away for NixOS by making it boot U-Boot instead.
It takes approximately 1 minute to boot a Pi 3B.
 
U-Boot gives us the ability to provide a generation selection menu during the boot process, in addition to storing the boot files on the main partition, rather than on the firmware partition.


=== Raspberry Pi (all versions) ===
=== Raspberry Pi (all versions) ===
Line 207: Line 312:
=== Power issues ===
=== Power issues ===


Especially with the newer power-hungry Raspberry Pi families (3, 4), 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 ''weirdness'' may happen. Weirdness may include:


* Lightning bolt on HDMI output "breaking" the display.
* Lightning bolt on HDMI output "breaking" the display.
Line 218: Line 323:


{{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===
Retrieved from "https://wiki.nixos.org/wiki/NixOS_on_ARM/Raspberry_Pi"