;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2017 David Craven ;;; Copyright © 2017, 2019 Mathieu Othacehe ;;; Copyright © 2020 Julien Lepiller ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen ;;; Copyright © 2022 Maxim Cournoyer ;;; Copyright © 2023 Efraim Flashner ;;; Copyright © 2023-2024 Herman Rimm ;;; Copyright © 2024 Zheng Junjie <873216071@qq.com> ;;; Copyright © 2024 Lilah Tascheter ;;; ;;; This file is part of GNU Guix. ;;; ;;; GNU Guix is free software; you can redistribute it and/or modify it ;;; under the terms of the GNU General Public License as published by ;;; the Free Software Foundation; either version 3 of the License, or (at ;;; your option) any later version. ;;; ;;; GNU Guix is distributed in the hope that it will be useful, but ;;; WITHOUT ANY WARRANTY; without even the implied warranty of ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;;; GNU General Public License for more details. ;;; ;;; You should have received a copy of the GNU General Public License ;;; along with GNU Guix. If not, see . (define-module (gnu bootloader u-boot) #:use-module (gnu bootloader) #:use-module (gnu bootloader extlinux) #:use-module (gnu packages bootloaders) #:use-module (guix gexp) #:export (u-boot-a20-olinuxino-lime-bootloader u-boot-a20-olinuxino-lime2-bootloader u-boot-a20-olinuxino-micro-bootloader u-boot-bananapi-m2-ultra-bootloader u-boot-beaglebone-black-bootloader u-boot-cubietruck-bootloader u-boot-firefly-rk3399-bootloader u-boot-mx6cuboxi-bootloader u-boot-nanopi-r4s-rk3399-bootloader u-boot-nintendo-nes-classic-edition-bootloader u-boot-novena-bootloader u-boot-orangepi-r1-plus-lts-rk3328-bootloader u-boot-orangepi-zero2w-bootloader u-boot-pine64-plus-bootloader u-boot-pine64-lts-bootloader u-boot-pinebook-bootloader u-boot-pinebook-pro-rk3399-bootloader u-boot-puma-rk3399-bootloader u-boot-rock64-rk3328-bootloader u-boot-rockpro64-rk3399-bootloader u-boot-sifive-unmatched-bootloader u-boot-qemu-riscv64-bootloader u-boot-starfive-visionfive2-bootloader u-boot-ts7970-q-2g-1000mhz-c-bootloader u-boot-wandboard-bootloader)) (define (make-install-u-boot firmware installers) (lambda* (#:key bootloader-config #:allow-other-keys . args) (with-targets (bootloader-configuration-targets bootloader-config) ('extlinux (apply install-extlinux-config args)) (('install => (path :path)) #~(let ((path #$path)) #$firmware)) (('disk => (disk :device)) #~(let ((disk #$disk)) #f #$@installers))))) (define-syntax-rule (define-u-bootloader def-name package firmware (file size doffset) ...) "Defines a U-Boot installer DEF-NAME, using u-boot PACKAGE. Installs each given FILE of SIZE (or #f to autodetect) to the targeted disk at OFFSET. FIRMWARE is ran on the U-Boot firmware directory to install supporting files, with the directory path as the local variable 'path'." (define def-name (bootloader (name 'u-boot) (default-targets (list (bootloader-target (type 'install) (offset 'root) (path "boot")) (bootloader-target (type 'extlinux) (offset 'install) (path "extlinux")))) (installer (make-install-u-boot firmware (list #~(let ((fw #$(file-append package "/libexec/" file))) (write-file-on-device fw #$(or size #~(stat:size (stat fw))) disk #$doffset)) ...)))))) ;;; ;;; Bootloader definitions. ;;; (define-u-bootloader u-boot-beaglebone-black-bootloader u-boot-am335x-boneblack #f ;; http://wiki.beyondlogic.org/index.php?title=BeagleBoneBlack_Upgrading_uBoot ;; This first stage bootloader called MLO (U-Boot SPL) is expected at ;; 0x20000 by BBB ROM code. The second stage bootloader will be loaded by ;; the MLO and is expected at 0x60000. Write both first stage ("MLO") and ;; second stage ("u-boot.img") images to the target. ("MLO" (* 256 512) (* 256 512)) ("u-boot.img" (* 1024 512) (* 768 512))) (define-u-bootloader u-boot-sifive-unmatched-bootloader u-boot-sifive-unmatched #f ("spl/u-boot-spl.bin" #f (* 34 512)) ("u-boot.itb" #f (* 2082 512))) (define-u-bootloader u-boot-starfive-visionfive2-bootloader u-boot-starfive-visionfive2 #~(begin (mkdir-p path) (call-with-output-file (string-append path "/uEnv.txt") (lambda (port) (format port ;; if board SPI use vender's u-boot, will find ;; ""starfive/starfive_visionfive2.dtb"", We cannot guarantee ;; that users will update this u-boot, so set it. "fdtfile=starfive/jh7110-starfive-visionfive-2-v1.3b.dtb~%")))) ("spl/u-boot-spl.bin.normal.out" #f (* 34 512)) ("u-boot.itb" #f (* 2082 512))) ;;; ;;; Allwinner bootloader definitions. ;;; (define-syntax-rule (define-u-bootloader-allwinner def-name package) (define-u-bootloader def-name package #f ("u-boot-sunxi-with-spl.bin" #f (* 8 1024)))) (define-u-bootloader-allwinner u-boot-nintendo-nes-classic-edition-bootloader u-boot-nintendo-nes-classic-edition) (define-u-bootloader-allwinner u-boot-a20-olinuxino-lime-bootloader u-boot-a20-olinuxino-lime) (define-u-bootloader-allwinner u-boot-a20-olinuxino-lime2-bootloader u-boot-a20-olinuxino-lime2) (define-u-bootloader-allwinner u-boot-a20-olinuxino-micro-bootloader u-boot-a20-olinuxino-micro) (define-u-bootloader-allwinner u-boot-bananapi-m2-ultra-bootloader u-boot-bananapi-m2-ultra) (define-u-bootloader-allwinner u-boot-cubietruck-bootloader u-boot-cubietruck) (define-u-bootloader-allwinner u-boot-pine64-lts-bootloader u-boot-pine64-lts) (define-u-bootloader-allwinner u-boot-orangepi-zero2w-bootloader u-boot-orangepi-zero2w) ;;; ;;; Allwinner64 bootloader definitions. ;;; (define-syntax-rule (define-u-bootloader-allwinner64 def-name package) (define-u-bootloader def-name package #f ("u-boot-sunxi-with-spl.bin" #f (* 8 1024)) ("u-boot-sunxi-with-spl.fit.itb" #f (* 40 1024)))) (define-u-bootloader-allwinner64 u-boot-pine64-plus-bootloader u-boot-pine64-plus) (define-u-bootloader-allwinner64 u-boot-pinebook-bootloader u-boot-pinebook) ;;; ;;; IMX bootloader definitions. ;;; (define-syntax-rule (define-u-bootloader-imx def-name package) (define-u-bootloader def-name package #f ("SPL" #f (* 8 1024)) ("u-boot.img" #f (* 40 1024)))) (define-u-bootloader-imx u-boot-mx6cuboxi-bootloader u-boot-mx6cuboxi) (define-u-bootloader-imx u-boot-wandboard-bootloader u-boot-wandboard) (define-u-bootloader-imx u-boot-novena-bootloader u-boot-novena) ;;; ;;; Rockchip bootloader definitions. ;;; (define-syntax-rule (define-u-bootloader-rockchip def-name package) ;; SD and eMMC use the same format (define-u-bootloader def-name package #f ("idbloader.img" #f (* 64 512)) ("u-boot.itb" #f (* 16384 512)))) (define-u-bootloader-rockchip u-boot-firefly-rk3399-bootloader u-boot-firefly-rk3399) (define-u-bootloader-rockchip u-boot-nanopi-r4s-rk3399-bootloader u-boot-nanopi-r4s-rk3399) (define-u-bootloader-rockchip u-boot-orangepi-r1-plus-lts-rk3328-bootloader u-boot-orangepi-r1-plus-lts-rk3328) (define-u-bootloader-rockchip u-boot-rock64-rk3328-bootloader u-boot-rock64-rk3328) (define-u-bootloader-rockchip u-boot-rockpro64-rk3399-bootloader u-boot-rockpro64-rk3399) (define-u-bootloader-rockchip u-boot-pinebook-pro-rk3399-bootloader u-boot-pinebook-pro-rk3399) (define-u-bootloader u-boot-puma-rk3399-bootloader u-boot-puma-rk3399 #f ("idbloader.img" #f (* 64 512)) ("u-boot.itb" #f (* 512 512))) ;;; ;;; Copy-only bootloader definitions. ;;; ;; These bootloaders don't really need to be installed, as they are read from ;; an SPI memory chip or directly from the FS, not the disk. (define-syntax-rule (define-u-bootloader-copy def-name package file) (define-u-bootloader def-name package #~(install-file #$(file-append package "/libexec/" file) path))) ;; user should manually install this to SPI flash ;; TODO: write directly to SPI flash? unless wear issues are a problem. (define-u-bootloader-copy u-boot-ts7970-q-2g-1000mhz-c-bootloader u-boot-ts7970-q-2g-1000mhz-c "u-boot.imx") (define-u-bootloader-copy u-boot-qemu-riscv64-bootloader u-boot-qemu-riscv64 "u-boot.bin")