1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
4 ;;; Copyright © 2017 David Craven <david@craven.ch>
5 ;;; Copyright © 2017, 2018 Efraim Flashner <efraim@flashner.co.il>
6 ;;; Copyright © 2018 Tobias Geerinckx-Rice <me@tobias.gr>
7 ;;; Copyright © 2018 Vagrant Cascadian <vagrant@debian.org>
8 ;;; Copyright © 2019 Mathieu Othacehe <m.othacehe@gmail.com>
9 ;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
11 ;;; This file is part of GNU Guix.
13 ;;; GNU Guix is free software; you can redistribute it and/or modify it
14 ;;; under the terms of the GNU General Public License as published by
15 ;;; the Free Software Foundation; either version 3 of the License, or (at
16 ;;; your option) any later version.
18 ;;; GNU Guix is distributed in the hope that it will be useful, but
19 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;;; GNU General Public License for more details.
23 ;;; You should have received a copy of the GNU General Public License
24 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
26 (define-module (gnu packages firmware)
27 #:use-module ((guix licenses) #:prefix license:)
28 #:use-module (guix packages)
29 #:use-module (guix download)
30 #:use-module (guix utils)
31 #:use-module (guix git-download)
32 #:use-module (guix build-system gnu)
33 #:use-module (gnu packages)
34 #:use-module (gnu packages admin)
35 #:use-module (gnu packages assembly)
36 #:use-module (gnu packages base)
37 #:use-module (gnu packages bison)
38 #:use-module (gnu packages cmake)
39 #:use-module (gnu packages cross-base)
40 #:use-module (gnu packages flex)
41 #:use-module (gnu packages gcc)
42 #:use-module (gnu packages linux)
43 #:use-module (gnu packages perl)
44 #:use-module (gnu packages python))
46 (define-public ath9k-htc-firmware
48 (name "ath9k-htc-firmware")
53 (url "https://github.com/qca/open-ath9k-htc-firmware")
57 "16jbj8avg5jkgvq5lxm0hdxxn4c3zn7fx8b4nxllvr024apk9w23"))
58 (file-name (git-file-name name version))
59 (patches (search-patches "ath9k-htc-firmware-objcopy.patch"))))
60 (build-system gnu-build-system)
63 (modify-phases %standard-phases
64 (add-before 'configure 'pre-configure
65 (lambda* (#:key inputs native-inputs #:allow-other-keys)
66 (chdir "target_firmware")
68 ;; 'configure' is a simple script that runs 'cmake' with
70 (substitute* "configure"
72 (string-append "TOOLCHAIN="
73 (assoc-ref (or native-inputs inputs) "cross-gcc")
77 (lambda* (#:key outputs #:allow-other-keys)
78 (let* ((out (assoc-ref outputs "out"))
79 (fw-dir (string-append out "/lib/firmware")))
80 (for-each (lambda (file)
81 (install-file file fw-dir))
82 (find-files "." "\\.fw$"))
86 ;; The firmware is cross-compiled using a "bare bones" compiler (no libc.)
87 ;; Use our own tool chain for that.
88 (native-inputs `(("cross-gcc" ,(cross-gcc
90 #:xbinutils (cross-binutils "xtensa-elf"
92 ("cross-binutils" ,(cross-binutils "xtensa-elf" binutils-2.33))
93 ("cmake" ,cmake-minimal)
95 (home-page "https://wireless.wiki.kernel.org/en/users/Drivers/ath9k_htc")
96 (synopsis "Firmware for the Atheros AR7010 and AR9271 USB 802.11n NICs")
98 "This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
99 802.11n NICs (aka Wi-Fi USB dongles). It is used by the ath9k driver of
101 (license (license:non-copyleft "http://directory.fsf.org/wiki/License:ClearBSD"))))
103 (define-public b43-tools
104 (let ((commit "27892ef741e7f1d08cb939744f8b8f5dac7b04ae")
108 (version (git-version "0.0.0" revision commit))
113 (url "http://git.bues.ch/git/b43-tools.git")
115 (file-name (git-file-name name version))
118 "1wgmj4d65izbhprwb5bcwimc2ryv19b9066lqzy4sa5m6wncm9cn"))))
119 (build-system gnu-build-system)
124 `(#:modules ((srfi srfi-1)
125 (guix build gnu-build-system)
127 #:tests? #f ; no tests
129 (let ((subdirs '("assembler" "disassembler")))
130 (modify-phases %standard-phases
131 (delete 'configure) ; no configure script
132 (add-before 'build 'patch-/bin/true
134 (substitute* (find-files "." "Makefile")
139 (for-each (lambda (dir)
140 (invoke "make" "-C" dir "CC=gcc"))
144 (lambda* (#:key outputs #:allow-other-keys)
145 (let ((out (assoc-ref outputs "out")))
146 (mkdir-p (string-append out "/bin"))
147 (for-each (lambda (dir)
148 (invoke "make" "-C" dir
149 (string-append "PREFIX=" out)
154 "https://bues.ch/cms/hacking/misc.html#linux_b43_driver_firmware_tools")
155 (synopsis "Collection of tools for the b43 wireless driver")
157 "The b43 firmware tools is a collection of firmware extractor,
158 assembler, disassembler, and debugging tools for the Linux kernel b43 wireless
160 (license license:gpl2))))
162 (define-public openfwwf-firmware
164 (name "openfwwf-firmware")
169 (uri (string-append "http://netweb.ing.unibs.it/~openfwwf/firmware/"
170 "openfwwf-" version ".tar.gz"))
173 "1p60gdi7w88s7qw82d3g9v7mk887mhvidf4l5q5hh09j10h37q4x"))))
174 (build-system gnu-build-system)
176 `(("b43-tools" ,b43-tools)))
178 `(#:make-flags (list (string-append "PREFIX="
179 (assoc-ref %outputs "out")
180 "/lib/firmware/b43-open"))
181 #:tests? #f ;no tests
182 #:phases (modify-phases %standard-phases
183 (delete 'configure))))
184 (home-page "http://netweb.ing.unibs.it/~openfwwf/")
185 (synopsis "Firmware for BCM43xx devices")
187 "This is firmware from Open FirmWare for WiFi networks (OpenFWWF) for the
188 Broadcom/AirForce chipset BCM43xx with Wireless-Core Revision 5. It is used
189 by the b43-open driver of Linux-libre.")
190 (license license:gpl2)))
192 (define* (make-opensbi-package platform name #:optional (arch "riscv64"))
200 (url "https://github.com/riscv/opensbi")
201 (commit (string-append "v" version))))
202 (file-name (git-file-name name version))
204 (base32 "1y9z0b6q6wpw7mgy31wml4djc6m8ydm71a9f1asnks4ragc7m98b"))))
205 (build-system gnu-build-system)
207 `(,@(if (and (not (string-prefix? "riscv64" (%current-system)))
208 (string-prefix? "riscv64" arch))
209 `(("cross-gcc" ,(cross-gcc "riscv64-linux-gnu" #:xgcc gcc-7))
210 ("cross-binutils" ,(cross-binutils "riscv64-linux-gnu")))
213 `(#:tests? #f ; no check target
214 #:make-flags (list (string-append "PLATFORM=" ,platform)
215 ,@(if (and (not (string-prefix? "riscv64"
217 (string-prefix? "riscv64" arch))
218 `("CROSS_COMPILE=riscv64-linux-gnu-")
223 (modify-phases %standard-phases
226 (lambda* (#:key outputs #:allow-other-keys)
227 (let ((out (assoc-ref outputs "out"))
228 (bin (find-files "." ".*fw_.*.elf$")))
231 (install-file file out))
234 (home-page "https://github.com/riscv/opensbi")
235 (synopsis "RISC-V Open Source Supervisor Binary Interface")
236 (description "A reference implementation of the RISC-V SBI specifications
237 for platform-specific firmwares executing in M-mode.")
238 (license (list license:bsd-2
239 ;; lib/utils/libfdt/* is dual licensed under bsd-2 and gpl2+.
241 ;; platform/ariane-fpga/* is gpl2.
244 (define-public opensbi-qemu-generic
245 (make-opensbi-package "generic" "opensbi-qemu-generic"))
247 (define-public opensbi-qemu-virt
248 (deprecated-package "opensbi-qemu-virt" opensbi-qemu-generic))
250 (define-public opensbi-sifive-fu540
251 (make-opensbi-package "sifive/fu540" "opensbi-sifive-fu540"))
253 (define-public opensbi-qemu-sifive-u
254 ;; Dropped upstream, as all functionality is present in the sifive-fu540
255 ;; target for recent versions of qemu, u-boot and linux.
256 (deprecated-package "opensbi-qemu-sifive-u" opensbi-sifive-fu540))
258 (define-public seabios
266 (url "https://review.coreboot.org/seabios.git")
267 (commit (string-append "rel-" version))))
268 (file-name (git-file-name name version))
270 (base32 "1n1bd6msfs7xn8844sz2qnm7hb5x2qfl3zb06kp4bx9vdc3i6619"))))
271 (build-system gnu-build-system)
273 `(("python" ,python-wrapper)))
275 `(#:tests? #f ; no check target
277 (modify-phases %standard-phases
283 (lambda* (#:key outputs #:allow-other-keys)
284 (let* ((out (assoc-ref outputs "out"))
285 (fmw (string-append out "/share/firmware")))
287 (copy-file "out/bios.bin" (string-append fmw "/bios.bin"))
289 (home-page "https://www.seabios.org/SeaBIOS")
290 (synopsis "x86 BIOS implementation")
291 (description "SeaBIOS is an implementation of a 16bit x86 BIOS. SeaBIOS
292 can run in an emulator or it can run natively on X86 hardware with the use of
295 (license (list license:gpl3+ license:lgpl3+
296 ;; src/fw/acpi-dsdt.dsl is lgpl2
298 ;; src/fw/lzmadecode.c and src/fw/lzmadecode.h are lgpl3+ and
299 ;; cpl with a linking exception.
302 ;; OVMF is part of the edk2 source tree.
303 (define edk2-commit "13a50a6fe1dcfa6600c38456ee24e0f9ecf51b5f")
304 (define edk2-version (git-version "20170116" "1" edk2-commit))
309 (url "https://github.com/tianocore/edk2")
310 (commit edk2-commit)))
311 (file-name (git-file-name "edk2" edk2-version))
314 "1gy2332kdqk8bjzpcsripx10896rbvgl0ic7r344kmpiwdgm948b"))))
319 (version edk2-version)
321 (build-system gnu-build-system)
326 ("python-2" ,python-2)
327 ("util-linux" ,util-linux "lib")))
329 `(#:tests? #f ; No check target.
331 (modify-phases %standard-phases
332 ;; Hide the default GCC from CPLUS_INCLUDE_PATH to prevent it from
333 ;; shadowing the version of GCC provided in native-inputs.
334 (add-after 'set-paths 'hide-gcc7
335 (lambda* (#:key inputs #:allow-other-keys)
336 (let ((gcc (assoc-ref inputs "gcc")))
337 (setenv "CPLUS_INCLUDE_PATH"
339 (delete (string-append gcc "/include/c++")
340 (string-split (getenv "CPLUS_INCLUDE_PATH")
346 (let* ((cwd (getcwd))
347 (tools (string-append cwd "/BaseTools"))
348 (bin (string-append tools "/BinWrappers/PosixLike")))
349 (setenv "WORKSPACE" cwd)
350 (setenv "EDK_TOOLS_PATH" tools)
351 (setenv "PATH" (string-append (getenv "PATH") ":" bin))
352 ; FIXME: The below script errors out. When using 'invoke' instead
353 ; of 'system*' this causes the build to fail.
354 (system* "bash" "edksetup.sh")
355 (substitute* "Conf/target.txt"
356 (("^TARGET[ ]*=.*$") "TARGET = RELEASE\n")
357 (("^MAX_CONCURRENT_THREAD_NUMBER[ ]*=.*$")
358 (format #f "MAX_CONCURRENT_THREAD_NUMBER = ~a~%"
359 (number->string (parallel-job-count)))))
360 ;; Build build support.
361 (setenv "BUILD_CC" "gcc")
362 (invoke "make" "-C" tools)
366 (invoke "build" "-a" "IA32" "-t" "GCC49"
367 "-p" "OvmfPkg/OvmfPkgIa32.dsc")))
368 ,@(if (string=? "x86_64-linux" (%current-system))
369 '((add-after 'build 'build-x64
371 (invoke "build" "-a" "X64" "-t" "GCC49"
372 "-p" "OvmfPkg/OvmfPkgX64.dsc"))))
375 (lambda* (#:key outputs #:allow-other-keys)
376 (let* ((out (assoc-ref outputs "out"))
377 (fmw (string-append out "/share/firmware")))
379 (copy-file "Build/OvmfIa32/RELEASE_GCC49/FV/OVMF.fd"
380 (string-append fmw "/ovmf_ia32.bin"))
381 ,@(if (string=? "x86_64-linux" (%current-system))
382 '((copy-file "Build/OvmfX64/RELEASE_GCC49/FV/OVMF.fd"
383 (string-append fmw "/ovmf_x64.bin")))
386 (supported-systems '("x86_64-linux" "i686-linux"))
387 (home-page "https://www.tianocore.org")
388 (synopsis "UEFI firmware for QEMU")
389 (description "OVMF is an EDK II based project to enable UEFI support for
390 Virtual Machines. OVMF contains a sample UEFI firmware for QEMU and KVM.")
391 (license (list license:expat
392 license:bsd-2 license:bsd-3 license:bsd-4))))
394 (define-public ovmf-aarch64
397 (name "ovmf-aarch64")
399 `(,@(package-native-inputs ovmf)
400 ,@(if (not (string-prefix? "aarch64" (%current-system)))
401 `(("cross-gcc" ,(cross-gcc "aarch64-linux-gnu"))
402 ("cross-binutils" ,(cross-binutils "aarch64-linux-gnu")))
405 (substitute-keyword-arguments (package-arguments ovmf)
407 `(modify-phases ,phases
408 (add-before 'configure 'set-env
410 ,@(if (not (string-prefix? "aarch64" (%current-system)))
411 `((setenv "GCC49_AARCH64_PREFIX" "aarch64-linux-gnu-"))
416 (invoke "build" "-a" "AARCH64" "-t" "GCC49"
417 "-p" "ArmVirtPkg/ArmVirtQemu.dsc")))
420 (lambda* (#:key outputs #:allow-other-keys)
421 (let* ((out (assoc-ref outputs "out"))
422 (fmw (string-append out "/share/firmware")))
424 (copy-file "Build/ArmVirtQemu-AARCH64/RELEASE_GCC49/FV/QEMU_EFI.fd"
425 (string-append fmw "/ovmf_aarch64.bin"))
427 (supported-systems %supported-systems)))
429 (define-public ovmf-arm
434 `(,@(package-native-inputs ovmf)
435 ,@(if (not (string-prefix? "armhf" (%current-system)))
436 `(("cross-gcc" ,(cross-gcc "arm-linux-gnueabihf"))
437 ("cross-binutils" ,(cross-binutils "arm-linux-gnueabihf")))
440 (substitute-keyword-arguments (package-arguments ovmf)
442 `(modify-phases ,phases
443 (add-before 'configure 'set-env
445 ,@(if (not (string-prefix? "armhf" (%current-system)))
446 `((setenv "GCC49_ARM_PREFIX" "arm-linux-gnueabihf-"))
451 (invoke "build" "-a" "ARM" "-t" "GCC49"
452 "-p" "ArmVirtPkg/ArmVirtQemu.dsc")))
455 (lambda* (#:key outputs #:allow-other-keys)
456 (let* ((out (assoc-ref outputs "out"))
457 (fmw (string-append out "/share/firmware")))
459 (copy-file "Build/ArmVirtQemu-ARM/RELEASE_GCC49/FV/QEMU_EFI.fd"
460 (string-append fmw "/ovmf_arm.bin"))
462 (supported-systems %supported-systems)))
464 (define* (make-arm-trusted-firmware platform #:optional (arch "aarch64"))
466 (name (string-append "arm-trusted-firmware-" platform))
472 ;; There are only GitHub generated release snapshots.
473 (url "https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/")
474 (commit (string-append "v" version))))
475 (file-name (git-file-name "arm-trusted-firmware" version))
478 "113mcf1hwwl0i90cqh08lywxs1bfbg0nwqibay9wlkmx1a5v0bnj"))))
479 (build-system gnu-build-system)
482 (modify-phases %standard-phases
483 (delete 'configure) ; no configure script
484 ;; Remove binary blobs which do not contain source or proper license.
485 (add-after 'unpack 'remove-binary-blobs
487 (for-each (lambda (file)
489 (find-files "." ".*\\.bin$"))))
491 (lambda* (#:key outputs #:allow-other-keys)
492 (let ((out (assoc-ref outputs "out"))
493 (bin (find-files "." ".*\\.(bin|elf)$")))
496 (install-file file out))
499 #:make-flags (list (string-append "PLAT=" ,platform)
500 ,@(if (and (not (string-prefix? "aarch64"
502 (string-prefix? "aarch64" arch))
503 `("CROSS_COMPILE=aarch64-linux-gnu-")
505 ,@(if (and (not (string-prefix? "armhf"
507 (string-prefix? "armhf" arch))
508 `("CROSS_COMPILE=arm-linux-gnueabihf-")
511 #:tests? #f)) ; no tests
513 `(,@(if (and (not (string-prefix? "aarch64" (%current-system)))
514 (string-prefix? "aarch64" arch))
515 ;; gcc-7 since it is used for u-boot, which needs gcc-7.
516 `(("cross-gcc" ,(cross-gcc "aarch64-linux-gnu" #:xgcc gcc-7))
517 ("cross-binutils" ,(cross-binutils "aarch64-linux-gnu")))
519 ,@(if (and (not (string-prefix? "armhf" (%current-system)))
520 (string-prefix? "armhf" arch))
521 ;; gcc-7 since it is used for u-boot, which needs gcc-7.
522 `(("cross-gcc" ,(cross-gcc "arm-linux-gnueabihf" #:xgcc gcc-7))
523 ("cross-binutils" ,(cross-binutils "arm-linux-gnueabihf")))
526 (home-page "https://www.trustedfirmware.org/")
527 (synopsis "Implementation of \"secure world software\"")
529 "ARM Trusted Firmware provides a reference implementation of secure world
530 software for ARMv7A and ARMv8-A, including a Secure Monitor executing at
531 @dfn{Exception Level 3} (EL3). It implements various ARM interface standards,
534 @item The Power State Coordination Interface (PSCI)
535 @item Trusted Board Boot Requirements (TBBR, ARM DEN0006C-1)
536 @item SMC Calling Convention
537 @item System Control and Management Interface
538 @item Software Delegated Exception Interface (SDEI)
540 (license (list license:bsd-3
541 license:bsd-2)))) ; libfdt
543 (define-public arm-trusted-firmware-sun50i-a64
544 (let ((base (make-arm-trusted-firmware "sun50i_a64")))
547 (name "arm-trusted-firmware-sun50i-a64"))))
549 (define-public arm-trusted-firmware-rk3328
550 (make-arm-trusted-firmware "rk3328"))
552 (define-public arm-trusted-firmware-puma-rk3399
553 (let ((base (make-arm-trusted-firmware "rk3399"))
554 ;; Vendor's arm trusted firmware branch hasn't been upstreamed yet.
555 (commit "d71e6d83612df896774ec4c03d49500312d2c324")
559 (name "arm-trusted-firmware-puma-rk3399")
560 (version (git-version "1.3" revision commit))
565 (url "https://git.theobroma-systems.com/arm-trusted-firmware.git")
567 (file-name (git-file-name name version))
570 "0vqhwqqh8h9qlkpybg2v94911091c1418bc4pnzq5fd7zf0fjkf8")))))))
572 (define-public arm-trusted-firmware-rk3399
573 (let ((base (make-arm-trusted-firmware "rk3399")))
576 (name "arm-trusted-firmware-rk3399")
578 `(("cross32-gcc" ,(cross-gcc "arm-none-eabi"))
579 ("cross32-binutils", (cross-binutils "arm-none-eabi"))
580 ,@(package-native-inputs base))))))
582 (define-public rk3399-cortex-m0
584 (name "rk3399-cortex-m0")
590 (url "https://git.theobroma-systems.com/rk3399-cortex-m0.git")
591 (commit (string-append "v" version))))
592 (file-name (git-file-name "rk3399-cortex-m0" version))
595 "02wz1vkf4j3zc8rx289z76xhrf71jhb2p05lvmygky393a9gjh9w"))))
596 (home-page "https://git.theobroma-systems.com/rk3399-cortex-m0.git/about/")
597 (synopsis "PMU Cortex M0 firmware for RK3399 Q7 (Puma)")
599 "Cortex-M0 firmware used with the RK3399 to implement
600 power-management functionality and helpers (e.g. DRAM frequency
601 switching support).\n")
602 (license license:bsd-3)
603 (build-system gnu-build-system)
606 (modify-phases %standard-phases
610 (lambda* (#:key outputs #:allow-other-keys)
611 (let ((out (assoc-ref outputs "out"))
612 (mzerofiles (find-files "." "rk3399m0.(elf|bin)$")))
615 (install-file file out))
618 (add-before 'build 'setenv
619 (lambda* (#:key inputs #:allow-other-keys)
620 (setenv "CROSS_COMPILE" "arm-none-eabi-")
622 (native-inputs `(("cross-gcc" ,(cross-gcc "arm-none-eabi" #:xgcc gcc-7))
623 ("cross-binutils" ,(cross-binutils "arm-none-eabi"))))))