mirror of
https://github.com/nix-community/raspberry-pi-nix.git
synced 2025-11-08 19:46:03 +01:00
393 lines
15 KiB
Nix
393 lines
15 KiB
Nix
{ pinned, core-overlay, libcamera-overlay }:
|
|
{ lib, pkgs, config, ... }:
|
|
|
|
let
|
|
cfg = config.raspberry-pi-nix;
|
|
version = cfg.kernel-version;
|
|
board = cfg.board;
|
|
kernel = pkgs.rpi-kernels."${version}"."${board}";
|
|
in
|
|
{
|
|
imports = [ ../sd-image ./config.nix ./i2c.nix ];
|
|
|
|
options = with lib; {
|
|
raspberry-pi-nix = {
|
|
kernel-version = mkOption {
|
|
default = "v6_6_31";
|
|
type = types.str;
|
|
description = "Kernel version to build.";
|
|
};
|
|
board = mkOption {
|
|
type = types.enum [ "bcm2711" "bcm2712" ];
|
|
description = ''
|
|
The kernel board version to build.
|
|
Examples at: https://www.raspberrypi.com/documentation/computers/linux_kernel.html#native-build-configuration
|
|
without the _defconfig part.
|
|
'';
|
|
};
|
|
pin-inputs = {
|
|
enable = mkOption {
|
|
default = true;
|
|
type = types.bool;
|
|
description = ''
|
|
Whether to pin the kernel to the latest cachix build.
|
|
'';
|
|
};
|
|
};
|
|
firmware-migration-service = {
|
|
enable = mkOption {
|
|
default = true;
|
|
type = types.bool;
|
|
description = ''
|
|
Whether to run the migration service automatically or not.
|
|
'';
|
|
};
|
|
};
|
|
libcamera-overlay = {
|
|
enable = mkOption {
|
|
default = true;
|
|
type = types.bool;
|
|
description = ''
|
|
If enabled then the libcamera overlay is applied which
|
|
overrides libcamera with the rpi fork.
|
|
'';
|
|
};
|
|
};
|
|
uboot = {
|
|
enable = mkOption {
|
|
default = false;
|
|
type = types.bool;
|
|
description = ''
|
|
If enabled then uboot is used as the bootloader. If disabled
|
|
then the linux kernel is installed directly into the
|
|
firmware directory as expected by the raspberry pi boot
|
|
process.
|
|
|
|
This can be useful for newer hardware that doesn't yet have
|
|
uboot compatibility or less common setups, like booting a
|
|
cm4 with an nvme drive.
|
|
'';
|
|
};
|
|
|
|
package = mkPackageOption pkgs "uboot-rpi-arm64" {};
|
|
};
|
|
};
|
|
};
|
|
|
|
config = {
|
|
systemd.services = {
|
|
"raspberry-pi-firmware-migrate" =
|
|
{
|
|
description = "update the firmware partition";
|
|
wantedBy = if cfg.firmware-migration-service.enable then [ "multi-user.target" ] else [ ];
|
|
serviceConfig =
|
|
let
|
|
firmware-path = "/boot/firmware";
|
|
kernel-params = pkgs.writeTextFile {
|
|
name = "cmdline.txt";
|
|
text = ''
|
|
${lib.strings.concatStringsSep " " config.boot.kernelParams}
|
|
'';
|
|
};
|
|
in
|
|
{
|
|
Type = "oneshot";
|
|
MountImages =
|
|
"/dev/disk/by-label/${config.sdImage.firmwarePartitionName}:${firmware-path}";
|
|
StateDirectory = "raspberrypi-firmware";
|
|
ExecStart = pkgs.writeShellScript "migrate-rpi-firmware" ''
|
|
shopt -s nullglob
|
|
|
|
TARGET_FIRMWARE_DIR="${firmware-path}"
|
|
TARGET_OVERLAYS_DIR="$TARGET_FIRMWARE_DIR/overlays"
|
|
TMPFILE="$TARGET_FIRMWARE_DIR/tmp"
|
|
UBOOT="${cfg.uboot.package}/u-boot.bin"
|
|
KERNEL="${kernel}/Image"
|
|
SHOULD_UBOOT=${if cfg.uboot.enable then "1" else "0"}
|
|
SRC_FIRMWARE_DIR="${pkgs.raspberrypifw}/share/raspberrypi/boot"
|
|
STARTFILES=("$SRC_FIRMWARE_DIR"/start*.elf)
|
|
DTBS=("$SRC_FIRMWARE_DIR"/*.dtb)
|
|
BOOTCODE="$SRC_FIRMWARE_DIR/bootcode.bin"
|
|
FIXUPS=("$SRC_FIRMWARE_DIR"/fixup*.dat)
|
|
SRC_OVERLAYS_DIR="$SRC_FIRMWARE_DIR/overlays"
|
|
SRC_OVERLAYS=("$SRC_OVERLAYS_DIR"/*)
|
|
CONFIG="${config.hardware.raspberry-pi.config-output}"
|
|
|
|
${lib.strings.optionalString cfg.uboot.enable ''
|
|
UBOOT="${pkgs.uboot-rpi-arm64}/u-boot.bin"
|
|
|
|
migrate_uboot() {
|
|
echo "migrating uboot"
|
|
touch "$STATE_DIRECTORY/uboot-migration-in-progress"
|
|
cp "$UBOOT" "$TMPFILE"
|
|
mv -T "$TMPFILE" "$TARGET_FIRMWARE_DIR/u-boot-rpi-arm64.bin"
|
|
echo "${builtins.toString cfg.uboot.package}" " > "$STATE_DIRECTORY/uboot-version"
|
|
rm "$STATE_DIRECTORY/uboot-migration-in-progress"
|
|
}
|
|
''}
|
|
|
|
migrate_kernel() {
|
|
echo "migrating kernel"
|
|
touch "$STATE_DIRECTORY/kernel-migration-in-progress"
|
|
cp "$KERNEL" "$TMPFILE"
|
|
mv -T "$TMPFILE" "$TARGET_FIRMWARE_DIR/kernel.img"
|
|
echo "${
|
|
builtins.toString kernel
|
|
}" > "$STATE_DIRECTORY/kernel-version"
|
|
rm "$STATE_DIRECTORY/kernel-migration-in-progress"
|
|
}
|
|
|
|
migrate_cmdline() {
|
|
echo "migrating cmdline"
|
|
touch "$STATE_DIRECTORY/cmdline-migration-in-progress"
|
|
cp "${kernel-params}" "$TMPFILE"
|
|
mv -T "$TMPFILE" "$TARGET_FIRMWARE_DIR/cmdline.txt"
|
|
echo "${
|
|
builtins.toString kernel-params
|
|
}" > "$STATE_DIRECTORY/cmdline-version"
|
|
rm "$STATE_DIRECTORY/cmdline-migration-in-progress"
|
|
}
|
|
|
|
migrate_config() {
|
|
echo "migrating config.txt"
|
|
touch "$STATE_DIRECTORY/config-migration-in-progress"
|
|
cp "$CONFIG" "$TMPFILE"
|
|
mv -T "$TMPFILE" "$TARGET_FIRMWARE_DIR/config.txt"
|
|
echo "${config.hardware.raspberry-pi.config-output}" > "$STATE_DIRECTORY/config-version"
|
|
rm "$STATE_DIRECTORY/config-migration-in-progress"
|
|
}
|
|
|
|
migrate_firmware() {
|
|
echo "migrating raspberrypi firmware"
|
|
touch "$STATE_DIRECTORY/firmware-migration-in-progress"
|
|
for SRC in "''${STARTFILES[@]}" "''${DTBS[@]}" "$BOOTCODE" "''${FIXUPS[@]}"
|
|
do
|
|
cp "$SRC" "$TMPFILE"
|
|
mv -T "$TMPFILE" "$TARGET_FIRMWARE_DIR/$(basename "$SRC")"
|
|
done
|
|
|
|
if [[ ! -d "$TARGET_OVERLAYS_DIR" ]]; then
|
|
mkdir "$TARGET_OVERLAYS_DIR"
|
|
fi
|
|
|
|
for SRC in "''${SRC_OVERLAYS[@]}"
|
|
do
|
|
cp "$SRC" "$TMPFILE"
|
|
mv -T "$TMPFILE" "$TARGET_OVERLAYS_DIR/$(basename "$SRC")"
|
|
done
|
|
echo "${
|
|
builtins.toString pkgs.raspberrypifw
|
|
}" > "$STATE_DIRECTORY/firmware-version"
|
|
rm "$STATE_DIRECTORY/firmware-migration-in-progress"
|
|
}
|
|
|
|
${lib.strings.optionalString cfg.uboot.enable ''
|
|
if [[ "$SHOULD_UBOOT" -eq 1 ]] && [[ -f "$STATE_DIRECTORY/uboot-migration-in-progress" || ! -f "$STATE_DIRECTORY/uboot-version" || $(< "$STATE_DIRECTORY/uboot-version") != ${
|
|
builtins.toString cfg.uboot.package
|
|
} ]]; then
|
|
migrate_uboot
|
|
fi
|
|
''}
|
|
|
|
if [[ "$SHOULD_UBOOT" -ne 1 ]] && [[ ! -f "$STATE_DIRECTORY/kernel-version" || $(< "$STATE_DIRECTORY/kernel-version") != ${
|
|
builtins.toString kernel
|
|
} ]]; then
|
|
migrate_kernel
|
|
fi
|
|
|
|
if [[ "$SHOULD_UBOOT" -ne 1 ]] && [[ ! -f "$STATE_DIRECTORY/cmdline-version" || $(< "$STATE_DIRECTORY/cmdline-version") != ${
|
|
builtins.toString kernel-params
|
|
} ]]; then
|
|
migrate_cmdline
|
|
fi
|
|
|
|
if [[ -f "$STATE_DIRECTORY/config-migration-in-progress" || ! -f "$STATE_DIRECTORY/config-version" || $(< "$STATE_DIRECTORY/config-version") != ${
|
|
builtins.toString config.hardware.raspberry-pi.config-output
|
|
} ]]; then
|
|
migrate_config
|
|
fi
|
|
|
|
if [[ -f "$STATE_DIRECTORY/firmware-migration-in-progress" || ! -f "$STATE_DIRECTORY/firmware-version" || $(< "$STATE_DIRECTORY/firmware-version") != ${
|
|
builtins.toString pkgs.raspberrypifw
|
|
} ]]; then
|
|
migrate_firmware
|
|
fi
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
# Default config.txt on Raspberry Pi OS:
|
|
# https://github.com/RPi-Distro/pi-gen/blob/master/stage1/00-boot-files/files/config.txt
|
|
hardware.raspberry-pi.config = {
|
|
cm4 = {
|
|
options = {
|
|
otg_mode = {
|
|
enable = lib.mkDefault true;
|
|
value = lib.mkDefault true;
|
|
};
|
|
};
|
|
};
|
|
pi4 = {
|
|
options = {
|
|
arm_boost = {
|
|
enable = lib.mkDefault true;
|
|
value = lib.mkDefault true;
|
|
};
|
|
};
|
|
};
|
|
all = {
|
|
options = {
|
|
# The firmware will start our u-boot binary rather than a
|
|
# linux kernel.
|
|
kernel = {
|
|
enable = true;
|
|
value = if cfg.uboot.enable then "u-boot-rpi-arm64.bin" else "kernel.img";
|
|
};
|
|
arm_64bit = {
|
|
enable = true;
|
|
value = true;
|
|
};
|
|
enable_uart = {
|
|
enable = true;
|
|
value = true;
|
|
};
|
|
avoid_warnings = {
|
|
enable = lib.mkDefault true;
|
|
value = lib.mkDefault true;
|
|
};
|
|
camera_auto_detect = {
|
|
enable = lib.mkDefault true;
|
|
value = lib.mkDefault true;
|
|
};
|
|
display_auto_detect = {
|
|
enable = lib.mkDefault true;
|
|
value = lib.mkDefault true;
|
|
};
|
|
disable_overscan = {
|
|
enable = lib.mkDefault true;
|
|
value = lib.mkDefault true;
|
|
};
|
|
};
|
|
dt-overlays = {
|
|
vc4-kms-v3d = {
|
|
enable = lib.mkDefault true;
|
|
params = { };
|
|
};
|
|
};
|
|
};
|
|
};
|
|
|
|
nixpkgs = {
|
|
overlays =
|
|
let
|
|
rpi-overlays = [ core-overlay ]
|
|
++ (if config.raspberry-pi-nix.libcamera-overlay.enable
|
|
then [ libcamera-overlay ] else [ ]);
|
|
rpi-overlay = lib.composeManyExtensions rpi-overlays;
|
|
pin-prev-overlay = overlay: pinned-prev: final: prev:
|
|
let
|
|
# apply the overlay to pinned-prev and fix that so no references to the actual final
|
|
# and prev appear in applied-overlay
|
|
applied-overlay =
|
|
lib.fix (final: pinned-prev // overlay final pinned-prev);
|
|
# We only want to set keys that appear in the overlay, so restrict applied-overlay to
|
|
# these keys
|
|
restricted-overlay = lib.getAttrs (builtins.attrNames (overlay { } { })) applied-overlay;
|
|
in
|
|
prev // restricted-overlay;
|
|
in
|
|
if cfg.pin-inputs.enable
|
|
then [ (pin-prev-overlay rpi-overlay pinned) ]
|
|
else [ rpi-overlay ];
|
|
};
|
|
boot = {
|
|
kernelParams =
|
|
if cfg.uboot.enable then [ ]
|
|
else [
|
|
# This is ugly and fragile, but the sdImage image has an msdos
|
|
# table, so the partition table id is a 1-indexed hex
|
|
# number. So, we drop the hex prefix and stick on a "02" to
|
|
# refer to the root partition.
|
|
"root=PARTUUID=${lib.strings.removePrefix "0x" config.sdImage.firmwarePartitionID}-02"
|
|
"rootfstype=ext4"
|
|
"fsck.repair=yes"
|
|
"rootwait"
|
|
"init=/sbin/init"
|
|
];
|
|
initrd = {
|
|
availableKernelModules = [
|
|
"usbhid"
|
|
"usb_storage"
|
|
"vc4"
|
|
"pcie_brcmstb" # required for the pcie bus to work
|
|
"reset-raspberrypi" # required for vl805 firmware to load
|
|
];
|
|
};
|
|
kernelPackages = pkgs.linuxPackagesFor kernel;
|
|
loader = {
|
|
grub.enable = lib.mkDefault false;
|
|
initScript.enable = !cfg.uboot.enable;
|
|
generic-extlinux-compatible = {
|
|
enable = lib.mkDefault cfg.uboot.enable;
|
|
# We want to use the device tree provided by firmware, so don't
|
|
# add FDTDIR to the extlinux conf file.
|
|
useGenerationDeviceTree = false;
|
|
};
|
|
};
|
|
};
|
|
hardware.enableRedistributableFirmware = true;
|
|
|
|
users.groups = builtins.listToAttrs (map (k: { name = k; value = { }; })
|
|
[ "input" "sudo" "plugdev" "games" "netdev" "gpio" "i2c" "spi" ]);
|
|
services = {
|
|
udev.extraRules =
|
|
let shell = "${pkgs.bash}/bin/bash";
|
|
in ''
|
|
# https://raw.githubusercontent.com/RPi-Distro/raspberrypi-sys-mods/master/etc.armhf/udev/rules.d/99-com.rules
|
|
SUBSYSTEM=="input", GROUP="input", MODE="0660"
|
|
SUBSYSTEM=="i2c-dev", GROUP="i2c", MODE="0660"
|
|
SUBSYSTEM=="spidev", GROUP="spi", MODE="0660"
|
|
SUBSYSTEM=="*gpiomem*", GROUP="gpio", MODE="0660"
|
|
SUBSYSTEM=="rpivid-*", GROUP="video", MODE="0660"
|
|
|
|
KERNEL=="vcsm-cma", GROUP="video", MODE="0660"
|
|
SUBSYSTEM=="dma_heap", GROUP="video", MODE="0660"
|
|
|
|
SUBSYSTEM=="gpio", GROUP="gpio", MODE="0660"
|
|
SUBSYSTEM=="gpio", KERNEL=="gpiochip*", ACTION=="add", PROGRAM="${shell} -c 'chgrp -R gpio /sys/class/gpio && chmod -R g=u /sys/class/gpio'"
|
|
SUBSYSTEM=="gpio", ACTION=="add", PROGRAM="${shell} -c 'chgrp -R gpio /sys%p && chmod -R g=u /sys%p'"
|
|
|
|
# PWM export results in a "change" action on the pwmchip device (not "add" of a new device), so match actions other than "remove".
|
|
SUBSYSTEM=="pwm", ACTION!="remove", PROGRAM="${shell} -c 'chgrp -R gpio /sys%p && chmod -R g=u /sys%p'"
|
|
|
|
KERNEL=="ttyAMA[0-9]*|ttyS[0-9]*", PROGRAM="${shell} -c '\
|
|
ALIASES=/proc/device-tree/aliases; \
|
|
TTYNODE=$$(readlink /sys/class/tty/%k/device/of_node | sed 's/base/:/' | cut -d: -f2); \
|
|
if [ -e $$ALIASES/bluetooth ] && [ $$TTYNODE/bluetooth = $$(strings $$ALIASES/bluetooth) ]; then \
|
|
echo 1; \
|
|
elif [ -e $$ALIASES/console ]; then \
|
|
if [ $$TTYNODE = $$(strings $$ALIASES/console) ]; then \
|
|
echo 0;\
|
|
else \
|
|
exit 1; \
|
|
fi \
|
|
elif [ $$TTYNODE = $$(strings $$ALIASES/serial0) ]; then \
|
|
echo 0; \
|
|
elif [ $$TTYNODE = $$(strings $$ALIASES/serial1) ]; then \
|
|
echo 1; \
|
|
else \
|
|
exit 1; \
|
|
fi \
|
|
'", SYMLINK+="serial%c"
|
|
|
|
ACTION=="add", SUBSYSTEM=="vtconsole", KERNEL=="vtcon1", RUN+="${shell} -c '\
|
|
if echo RPi-Sense FB | cmp -s /sys/class/graphics/fb0/name; then \
|
|
echo 0 > /sys$devpath/bind; \
|
|
fi; \
|
|
'"
|
|
'';
|
|
};
|
|
};
|
|
|
|
}
|