gnu/packages/firmware.scm

   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 ;;;
   9 ;;; This file is part of GNU Guix.
  10 ;;;
  11 ;;; GNU Guix is free software; you can redistribute it and/or modify it
  12 ;;; under the terms of the GNU General Public License as published by
  13 ;;; the Free Software Foundation; either version 3 of the License, or (at
  14 ;;; your option) any later version.
  15 ;;;
  16 ;;; GNU Guix is distributed in the hope that it will be useful, but
  17 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;;; GNU General Public License for more details.
  20 ;;;
  21 ;;; You should have received a copy of the GNU General Public License
  22 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 (define-module (gnu packages firmware)
  25   #:use-module ((guix licenses) #:prefix license:)
  26   #:use-module (guix packages)
  27   #:use-module (guix download)
  28   #:use-module (guix utils)
  29   #:use-module (guix git-download)
  30   #:use-module (guix build-system gnu)
  31   #:use-module (gnu packages)
  32   #:use-module (gnu packages admin)
  33   #:use-module (gnu packages assembly)
  34   #:use-module (gnu packages bison)
  35   #:use-module (gnu packages cmake)
  36   #:use-module (gnu packages cross-base)
  37   #:use-module (gnu packages flex)
  38   #:use-module (gnu packages gcc)
  39   #:use-module (gnu packages linux)
  40   #:use-module (gnu packages perl)
  41   #:use-module (gnu packages python))
  42
  43 (define-public ath9k-htc-firmware
  44   (package
  45     (name "ath9k-htc-firmware")
  46     (version "1.4.0")
  47     (source (origin
  48               (method git-fetch)
  49               (uri (git-reference
  50                     (url "https://github.com/qca/open-ath9k-htc-firmware.git")
  51                     (commit version)))
  52               (sha256
  53                (base32
  54                 "16jbj8avg5jkgvq5lxm0hdxxn4c3zn7fx8b4nxllvr024apk9w23"))
  55               (file-name (string-append name "-" version "-checkout"))
  56               (patches (search-patches "ath9k-htc-firmware-objcopy.patch"))))
  57     (build-system gnu-build-system)
  58     (arguments
  59      '(#:phases
  60        (modify-phases %standard-phases
  61          (add-before 'configure 'pre-configure
  62            (lambda* (#:key inputs #:allow-other-keys)
  63              (chdir "target_firmware")
  64
  65              ;; 'configure' is a simple script that runs 'cmake' with
  66              ;; the right flags.
  67              (substitute* "configure"
  68                (("^TOOLCHAIN=.*$")
  69                 (string-append "TOOLCHAIN="
  70                                (assoc-ref inputs "cross-gcc")
  71                                "\n")))
  72              #t))
  73          (replace 'install
  74            (lambda* (#:key outputs #:allow-other-keys)
  75              (let* ((out    (assoc-ref outputs "out"))
  76                     (fw-dir (string-append out "/lib/firmware")))
  77                (for-each (lambda (file)
  78                            (install-file file fw-dir))
  79                          (find-files "." "\\.fw$"))
  80               #t))))
  81        #:tests? #f))
  82
  83     ;; The firmware is cross-compiled using a "bare bones" compiler (no libc.)
  84     ;; Use our own tool chain for that.
  85     (native-inputs `(("cross-gcc" ,(cross-gcc "xtensa-elf"))
  86                      ("cross-binutils" ,(cross-binutils "xtensa-elf"))
  87                      ("cmake" ,cmake-minimal)
  88                      ("perl" ,perl)))
  89     (home-page "http://wireless.kernel.org/en/users/Drivers/ath9k_htc")
  90     (synopsis "Firmware for the Atheros AR7010 and AR9271 USB 802.11n NICs")
  91     (description
  92      "This is the firmware for the Qualcomm Atheros AR7010 and AR9271 USB
  93 802.11n NICs (aka Wi-Fi USB dongles).  It is used by the ath9k driver of
  94 Linux-libre.")
  95     (license (license:non-copyleft "http://directory.fsf.org/wiki/License:ClearBSD"))))
  96
  97 (define-public b43-tools
  98   (let ((commit "27892ef741e7f1d08cb939744f8b8f5dac7b04ae")
  99         (revision "1"))
 100     (package
 101       (name "b43-tools")
 102       (version (git-version "0.0.0" revision commit))
 103       (source
 104        (origin
 105          (method git-fetch)
 106          (uri (git-reference
 107                (url "http://git.bues.ch/git/b43-tools.git")
 108                (commit commit)))
 109          (file-name (string-append name "-" version "-checkout"))
 110          (sha256
 111           (base32
 112            "1wgmj4d65izbhprwb5bcwimc2ryv19b9066lqzy4sa5m6wncm9cn"))))
 113       (build-system gnu-build-system)
 114       (native-inputs
 115        `(("flex" ,flex)
 116          ("bison" ,bison)))
 117       (arguments
 118        `(#:modules ((srfi srfi-1)
 119                     (guix build gnu-build-system)
 120                     (guix build utils))
 121          #:tests? #f                    ; no tests
 122          #:phases
 123          (let ((subdirs '("assembler" "disassembler")))
 124            (modify-phases %standard-phases
 125              (delete 'configure)        ; no configure script
 126              (add-before 'build 'patch-/bin/true
 127                (lambda _
 128                  (substitute* (find-files "." "Makefile")
 129                    (("/bin/true") ":"))
 130                  #t))
 131              (replace 'build
 132                (lambda _
 133                  (for-each (lambda (dir)
 134                              (invoke "make" "-C" dir "CC=gcc"))
 135                            subdirs)
 136                  #t))
 137              (replace 'install
 138                (lambda* (#:key outputs #:allow-other-keys)
 139                  (let ((out (assoc-ref outputs "out")))
 140                    (mkdir-p (string-append out "/bin"))
 141                    (for-each (lambda (dir)
 142                                (invoke "make" "-C" dir
 143                                        (string-append "PREFIX=" out)
 144                                        "install"))
 145                              subdirs)
 146                    #t)))))))
 147       (home-page
 148        "https://bues.ch/cms/hacking/misc.html#linux_b43_driver_firmware_tools")
 149       (synopsis "Collection of tools for the b43 wireless driver")
 150       (description
 151        "The b43 firmware tools is a collection of firmware extractor,
 152 assembler, disassembler, and debugging tools for the Linux kernel b43 wireless
 153 driver.")
 154       (license license:gpl2))))
 155
 156 (define-public openfwwf-firmware
 157   (package
 158     (name "openfwwf-firmware")
 159     (version "5.2")
 160     (source
 161      (origin
 162        (method url-fetch)
 163        (uri (string-append "http://netweb.ing.unibs.it/~openfwwf/firmware/"
 164                            "openfwwf-" version ".tar.gz"))
 165        (sha256
 166         (base32
 167          "1p60gdi7w88s7qw82d3g9v7mk887mhvidf4l5q5hh09j10h37q4x"))))
 168     (build-system gnu-build-system)
 169     (native-inputs
 170      `(("b43-tools" ,b43-tools)))
 171     (arguments
 172      `(#:make-flags (list (string-append "PREFIX="
 173                                          (assoc-ref %outputs "out")
 174                                          "/lib/firmware/b43-open"))
 175        #:tests? #f                      ;no tests
 176        #:phases (modify-phases %standard-phases
 177                   (delete 'configure))))
 178     (home-page "http://netweb.ing.unibs.it/~openfwwf/")
 179     (synopsis "Firmware for BCM43xx devices")
 180     (description
 181      "This is firmware from Open FirmWare for WiFi networks (OpenFWWF) for the
 182 Broadcom/AirForce chipset BCM43xx with Wireless-Core Revision 5.  It is used
 183 by the b43-open driver of Linux-libre.")
 184     (license license:gpl2)))
 185
 186 (define-public seabios
 187   (package
 188     (name "seabios")
 189     (version "1.12.1")
 190     (source
 191      (origin
 192        (method git-fetch)
 193        (uri (git-reference
 194              (url "https://review.coreboot.org/seabios.git")
 195              (commit (string-append "rel-" version))))
 196        (file-name (git-file-name name version))
 197        (sha256
 198         (base32 "1g9y03r5ky58q2g9rhbwfhs42z0zb9f59wfxpwh6zjqa6fyv1r80"))))
 199     (build-system gnu-build-system)
 200     (native-inputs
 201      `(("python-2" ,python-2)))
 202     (arguments
 203      `(#:tests? #f                      ; no check target
 204        #:phases
 205        (modify-phases %standard-phases
 206          (replace 'configure
 207            (lambda _
 208              (setenv "CC" "gcc")
 209              #t))
 210          (replace 'install
 211            (lambda* (#:key outputs #:allow-other-keys)
 212              (let* ((out (assoc-ref outputs "out"))
 213                     (fmw (string-append out "/share/firmware")))
 214                (mkdir-p fmw)
 215                (copy-file "out/bios.bin" (string-append fmw "/bios.bin"))
 216                #t))))))
 217     (home-page "https://www.seabios.org/SeaBIOS")
 218     (synopsis "x86 BIOS implementation")
 219     (description "SeaBIOS is an implementation of a 16bit x86 BIOS.  SeaBIOS
 220 can run in an emulator or it can run natively on X86 hardware with the use of
 221 coreboot.")
 222     ;; Dual licensed.
 223     (license (list license:gpl3+ license:lgpl3+
 224                    ;; src/fw/acpi-dsdt.dsl is lgpl2
 225                    license:lgpl2.1
 226                    ;; src/fw/lzmadecode.c and src/fw/lzmadecode.h are lgpl3+ and
 227                    ;; cpl with a linking exception.
 228                    license:cpl1.0))))
 229
 230 ;; OVMF is part of the edk2 source tree.
 231 (define edk2-commit "13a50a6fe1dcfa6600c38456ee24e0f9ecf51b5f")
 232 (define edk2-version (git-version "20170116" "1" edk2-commit))
 233 (define edk2-origin
 234   (origin
 235     (method git-fetch)
 236     (uri (git-reference
 237           (url "https://github.com/tianocore/edk2")
 238           (commit edk2-commit)))
 239     (file-name (git-file-name "edk2" edk2-version))
 240     (sha256
 241      (base32
 242       "1gy2332kdqk8bjzpcsripx10896rbvgl0ic7r344kmpiwdgm948b"))))
 243
 244 (define-public ovmf
 245   (package
 246     (name "ovmf")
 247     (version edk2-version)
 248     (source edk2-origin)
 249     (build-system gnu-build-system)
 250     (native-inputs
 251      `(("acpica" ,acpica)
 252        ("nasm" ,nasm)
 253        ("python-2" ,python-2)
 254        ("util-linux" ,util-linux)))
 255     (arguments
 256      `(#:tests? #f ; No check target.
 257        #:phases
 258        (modify-phases %standard-phases
 259          (replace 'configure
 260            (lambda _
 261              (let* ((cwd (getcwd))
 262                     (tools (string-append cwd "/BaseTools"))
 263                     (bin (string-append tools "/BinWrappers/PosixLike")))
 264                (setenv "WORKSPACE" cwd)
 265                (setenv "EDK_TOOLS_PATH" tools)
 266                (setenv "PATH" (string-append (getenv "PATH") ":" bin))
 267                ; FIXME: The below script errors out. When using 'invoke' instead
 268                ; of 'system*' this causes the build to fail.
 269                (system* "bash" "edksetup.sh")
 270                (substitute* "Conf/target.txt"
 271                  (("^TARGET[ ]*=.*$") "TARGET = RELEASE\n")
 272                  (("^MAX_CONCURRENT_THREAD_NUMBER[ ]*=.*$")
 273                   (format #f "MAX_CONCURRENT_THREAD_NUMBER = ~a~%"
 274                           (number->string (parallel-job-count)))))
 275                ;; Build build support.
 276                (setenv "BUILD_CC" "gcc")
 277                (invoke "make" "-C" tools)
 278                #t)))
 279          (replace 'build
 280            (lambda _
 281              (invoke "build" "-a" "IA32" "-t" "GCC49"
 282                      "-p" "OvmfPkg/OvmfPkgIa32.dsc")))
 283          ,@(if (string=? "x86_64-linux" (%current-system))
 284              '((add-after 'build 'build-x64
 285                 (lambda _
 286                   (invoke "build" "-a" "X64" "-t" "GCC49"
 287                           "-p" "OvmfPkg/OvmfPkgX64.dsc"))))
 288              '())
 289          (replace 'install
 290            (lambda* (#:key outputs #:allow-other-keys)
 291              (let* ((out (assoc-ref outputs "out"))
 292                     (fmw (string-append out "/share/firmware")))
 293                (mkdir-p fmw)
 294                (copy-file "Build/OvmfIa32/RELEASE_GCC49/FV/OVMF.fd"
 295                           (string-append fmw "/ovmf_ia32.bin"))
 296                ,@(if (string=? "x86_64-linux" (%current-system))
 297                    '((copy-file "Build/OvmfX64/RELEASE_GCC49/FV/OVMF.fd"
 298                                 (string-append fmw "/ovmf_x64.bin")))
 299                    '()))
 300              #t)))))
 301     (supported-systems '("x86_64-linux" "i686-linux"))
 302     (home-page "https://www.tianocore.org")
 303     (synopsis "UEFI firmware for QEMU")
 304     (description "OVMF is an EDK II based project to enable UEFI support for
 305 Virtual Machines.  OVMF contains a sample UEFI firmware for QEMU and KVM.")
 306     (license (list license:expat
 307                    license:bsd-2 license:bsd-3 license:bsd-4))))
 308
 309 (define-public ovmf-aarch64
 310   (package
 311     (inherit ovmf)
 312     (name "ovmf-aarch64")
 313     (native-inputs
 314      `(,@(package-native-inputs ovmf)
 315        ,@(if (not (string-prefix? "aarch64" (%current-system)))
 316            `(("cross-gcc" ,(cross-gcc "aarch64-linux-gnu"))
 317              ("cross-binutils" ,(cross-binutils "aarch64-linux-gnu")))
 318            '())))
 319     (arguments
 320      (substitute-keyword-arguments (package-arguments ovmf)
 321        ((#:phases phases)
 322         `(modify-phases ,phases
 323            (add-before 'configure 'set-env
 324              (lambda _
 325                ,@(if (not (string-prefix? "aarch64" (%current-system)))
 326                      `((setenv "GCC49_AARCH64_PREFIX" "aarch64-linux-gnu-"))
 327                      '())
 328                #t))
 329            (replace 'build
 330              (lambda _
 331                (invoke "build" "-a" "AARCH64" "-t" "GCC49"
 332                        "-p" "ArmVirtPkg/ArmVirtQemu.dsc")))
 333            (delete 'build-x64)
 334            (replace 'install
 335              (lambda* (#:key outputs #:allow-other-keys)
 336                (let* ((out (assoc-ref outputs "out"))
 337                       (fmw (string-append out "/share/firmware")))
 338                  (mkdir-p fmw)
 339                  (copy-file "Build/ArmVirtQemu-AARCH64/RELEASE_GCC49/FV/QEMU_EFI.fd"
 340                             (string-append fmw "/ovmf_aarch64.bin"))
 341                  #t)))))))
 342     (supported-systems %supported-systems)))
 343
 344 (define-public ovmf-arm
 345   (package
 346     (inherit ovmf)
 347     (name "ovmf-arm")
 348     (native-inputs
 349      `(,@(package-native-inputs ovmf)
 350        ,@(if (not (string-prefix? "armhf" (%current-system)))
 351            `(("cross-gcc" ,(cross-gcc "arm-linux-gnueabihf"))
 352              ("cross-binutils" ,(cross-binutils "arm-linux-gnueabihf")))
 353            '())))
 354     (arguments
 355      (substitute-keyword-arguments (package-arguments ovmf)
 356        ((#:phases phases)
 357         `(modify-phases ,phases
 358            (add-before 'configure 'set-env
 359              (lambda _
 360                ,@(if (not (string-prefix? "armhf" (%current-system)))
 361                      `((setenv "GCC49_ARM_PREFIX" "arm-linux-gnueabihf-"))
 362                      '())
 363                #t))
 364            (replace 'build
 365              (lambda _
 366                (invoke "build" "-a" "ARM" "-t" "GCC49"
 367                        "-p" "ArmVirtPkg/ArmVirtQemu.dsc")))
 368            (delete 'build-x64)
 369            (replace 'install
 370              (lambda* (#:key outputs #:allow-other-keys)
 371                (let* ((out (assoc-ref outputs "out"))
 372                       (fmw (string-append out "/share/firmware")))
 373                  (mkdir-p fmw)
 374                  (copy-file "Build/ArmVirtQemu-ARM/RELEASE_GCC49/FV/QEMU_EFI.fd"
 375                             (string-append fmw "/ovmf_arm.bin"))
 376                  #t)))))))
 377     (supported-systems %supported-systems)))
 378
 379 (define* (make-arm-trusted-firmware platform #:optional (arch "aarch64"))
 380   (package
 381     (name (string-append "arm-trusted-firmware-" platform))
 382     (version "2.1")
 383     (source
 384       (origin
 385         (method git-fetch)
 386         (uri (git-reference
 387                ;; There are only GitHub generated release snapshots.
 388                (url "https://github.com/ARM-software/arm-trusted-firmware.git")
 389                (commit (string-append "v" version))))
 390         (file-name (git-file-name "arm-trusted-firmware" version))
 391        (sha256
 392         (base32
 393          "1gy5qskrjy8n3kxdcm1dx8b45l5b75n0pm8pq80wl6xic1ycy24r"))))
 394     (build-system gnu-build-system)
 395     (arguments
 396      `(#:phases
 397        (modify-phases %standard-phases
 398          (delete 'configure) ; no configure script
 399          (replace 'install
 400            (lambda* (#:key outputs #:allow-other-keys)
 401              (let ((out (assoc-ref outputs "out"))
 402                    (bin (find-files "." ".*\\.bin$")))
 403                (for-each
 404                  (lambda (file)
 405                    (install-file file out))
 406                  bin))
 407              #t)))
 408        #:make-flags (list (string-append "PLAT=" ,platform)
 409                           ,@(if (and (not (string-prefix? "aarch64"
 410                                                           (%current-system)))
 411                                      (string-prefix? "aarch64" arch))
 412                               `("CROSS_COMPILE=aarch64-linux-gnu-")
 413                               '())
 414                           ,@(if (and (not (string-prefix? "armhf"
 415                                                           (%current-system)))
 416                                      (string-prefix? "armhf" arch))
 417                               `("CROSS_COMPILE=arm-linux-gnueabihf-")
 418                               '())
 419                           "DEBUG=1")
 420        #:tests? #f)) ; no tests
 421     (native-inputs
 422      `(,@(if (and (not (string-prefix? "aarch64" (%current-system)))
 423                   (string-prefix? "aarch64" arch))
 424            ;; gcc-7 since it is used for u-boot, which needs gcc-7.
 425            `(("cross-gcc" ,(cross-gcc "aarch64-linux-gnu" #:xgcc gcc-7))
 426              ("cross-binutils" ,(cross-binutils "aarch64-linux-gnu")))
 427            '())
 428        ,@(if (and (not (string-prefix? "armhf" (%current-system)))
 429                   (string-prefix? "armhf" arch))
 430            ;; gcc-7 since it is used for u-boot, which needs gcc-7.
 431            `(("cross-gcc" ,(cross-gcc "arm-linux-gnueabihf" #:xgcc gcc-7))
 432              ("cross-binutils" ,(cross-binutils "arm-linux-gnueabihf")))
 433            '())
 434         ))
 435     (home-page "https://github.com/ARM-software/arm-trusted-firmware")
 436     (synopsis "Implementation of \"secure world software\"")
 437     (description
 438      "ARM Trusted Firmware provides a reference implementation of secure world
 439 software for ARMv7A and ARMv8-A, including a Secure Monitor executing at
 440 @dfn{Exception Level 3} (EL3).  It implements various ARM interface standards,
 441 such as:
 442 @enumerate
 443 @item The Power State Coordination Interface (PSCI)
 444 @item Trusted Board Boot Requirements (TBBR, ARM DEN0006C-1)
 445 @item SMC Calling Convention
 446 @item System Control and Management Interface
 447 @item Software Delegated Exception Interface (SDEI)
 448 @end enumerate\n")
 449     (license (list license:bsd-3
 450                    license:bsd-2)))) ; libfdt
 451
 452 (define-public arm-trusted-firmware-sun50i-a64
 453   (let ((base (make-arm-trusted-firmware "sun50i_a64")))
 454     (package
 455       (inherit base)
 456       (name "arm-trusted-firmware-sun50i-a64"))))
 457
 458 (define-public arm-trusted-firmware-puma-rk3399
 459   (let ((base (make-arm-trusted-firmware "rk3399"))
 460         ;; Vendor's arm trusted firmware branch hasn't been upstreamed yet.
 461         (commit "d71e6d83612df896774ec4c03d49500312d2c324")
 462         (revision "1"))
 463     (package
 464       (inherit base)
 465       (name "arm-trusted-firmware-puma-rk3399")
 466       (version (git-version "1.3" revision commit))
 467       (source
 468         (origin
 469           (method git-fetch)
 470           (uri (git-reference
 471                  (url "https://git.theobroma-systems.com/arm-trusted-firmware.git")
 472                  (commit commit)))
 473           (file-name (git-file-name name version))
 474           (sha256
 475            (base32
 476             "0vqhwqqh8h9qlkpybg2v94911091c1418bc4pnzq5fd7zf0fjkf8")))))))
 477
 478 (define-public rk3399-cortex-m0
 479   (package
 480     (name "rk3399-cortex-m0")
 481     (version "1")
 482     (source
 483      (origin
 484        (method git-fetch)
 485        (uri (git-reference
 486              (url "https://git.theobroma-systems.com/rk3399-cortex-m0.git")
 487              (commit (string-append "v" version))))
 488        (file-name (git-file-name "rk3399-cortex-m0" version))
 489        (sha256
 490         (base32
 491          "02wz1vkf4j3zc8rx289z76xhrf71jhb2p05lvmygky393a9gjh9w"))))
 492     (home-page "https://git.theobroma-systems.com/rk3399-cortex-m0.git/about/")
 493     (synopsis "PMU Cortex M0 firmware for RK3399 Q7 (Puma)")
 494     (description
 495      "Cortex-M0 firmware used with the RK3399 to implement
 496 power-management functionality and helpers (e.g. DRAM frequency
 497 switching support).\n")
 498     (license license:bsd-3)
 499     (build-system gnu-build-system)
 500     (arguments
 501      `(#:phases
 502        (modify-phases %standard-phases
 503          (delete 'configure)
 504          (delete 'check)
 505          (replace 'install
 506            (lambda* (#:key outputs #:allow-other-keys)
 507              (let ((out (assoc-ref outputs "out"))
 508                    (mzerofiles (find-files "." "rk3399m0.(elf|bin)$")))
 509                (for-each
 510                  (lambda (file)
 511                    (install-file file out))
 512                  mzerofiles))
 513              #t))
 514          (add-before 'build 'setenv
 515            (lambda* (#:key inputs #:allow-other-keys)
 516              (setenv "CROSS_COMPILE" "arm-none-eabi-")
 517              #t)))))
 518     (native-inputs `(("cross-gcc" ,(cross-gcc "arm-none-eabi" #:xgcc gcc-7))
 519                      ("cross-binutils" ,(cross-binutils "arm-none-eabi"))))))