;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2014 Mark H Weaver ;;; Copyright © 2014 Manolis Fragkiskos Ragkousis ;;; Copyright © 2016 Hartmut Goebel ;;; Copyright © 2016, 2018, 2021 Ludovic Courtès ;;; Copyright © 2016, 2019 Efraim Flashner ;;; Copyright © 2017 Jonathan Brielmaier ;;; Copyright © 2017 Julien Lepiller ;;; Copyright © 2018–2021 Tobias Geerinckx-Rice ;;; Copyright © 2021 Ricardo Wurmus ;;; Copyright © 2021 Mathieu Othacehe ;;; Copyright © 2022 Peter Polidoro ;;; Copyright © 2023 B. Wilson ;;; Copyright © 2023 Maxim Cournoyer ;;; ;;; 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 packages flashing-tools) #:use-module ((guix licenses) #:prefix license:) #:use-module (guix download) #:use-module (guix gexp) #:use-module (guix git-download) #:use-module (guix packages) #:use-module (guix utils) #:use-module (gnu packages) #:use-module (guix build-system cmake) #:use-module (guix build-system copy) #:use-module (guix build-system gnu) #:use-module (guix build-system meson) #:use-module (guix build-system python) #:use-module (gnu packages autotools) #:use-module (gnu packages admin) #:use-module (gnu packages base) #:use-module (gnu packages bash) #:use-module (gnu packages bison) #:use-module (gnu packages boost) #:use-module (gnu packages check) #:use-module (gnu packages compression) #:use-module (gnu packages documentation) #:use-module (gnu packages elf) #:use-module (gnu packages embedded) #:use-module (gnu packages flex) #:use-module (gnu packages ghostscript) #:use-module (gnu packages gnupg) #:use-module (gnu packages graphviz) #:use-module (gnu packages groff) #:use-module (gnu packages pciutils) #:use-module (gnu packages perl) #:use-module (gnu packages pkg-config) #:use-module (gnu packages libusb) #:use-module (gnu packages libftdi) #:use-module (gnu packages linux) #:use-module (gnu packages pciutils) #:use-module (gnu packages qt) #:use-module (gnu packages tls) #:use-module (gnu packages xml) #:use-module (srfi srfi-26)) (define-public flashrom (package (name "flashrom") (version "1.3.0") (source (origin (method url-fetch) (uri (string-append "https://download.flashrom.org/releases/flashrom-v" version ".tar.bz2")) (sha256 (base32 "08wn2j5vxzzvigflrjypgxxzjp32c76bshrlkzki5l6cad226lx0")))) (build-system meson-build-system) (inputs (list bash-minimal dmidecode pciutils libusb libftdi libjaylink)) (native-inputs (list cmocka pkg-config)) (arguments (list #:configure-flags #~'("-Dprogrammer=all") #:phases #~(modify-phases %standard-phases (add-after 'install 'wrap-program (lambda* (#:key inputs #:allow-other-keys) (let ((flashrom (string-append #$output "/sbin/flashrom"))) (wrap-program flashrom `("PATH" ":" prefix (,(dirname (search-input-file inputs "/sbin/dmidecode"))))))))))) (home-page "https://flashrom.org/") (synopsis "Identify, read, write, erase, and verify ROM/flash chips") (description "flashrom is a utility for identifying, reading, writing, verifying and erasing flash chips. It is designed to flash BIOS/EFI/coreboot/firmware/optionROM images on mainboards, network/graphics/storage controller cards, and various other programmer devices.") (license license:gpl2))) (define-public 0xffff (package (name "0xffff") (version "0.9") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/pali/0xffff") (commit version))) (file-name (git-file-name name version)) (sha256 (base32 "0rl1xzbxl991pm2is98zbryac1lgjrc3zphmbd8agv07av0r6r6n")))) (build-system gnu-build-system) (inputs ;; Building with libusb-compat will succeed but the result will be broken. ;; See . (list libusb-0.1)) (arguments `(#:phases (modify-phases %standard-phases (delete 'configure)) ; no configure #:make-flags (list (string-append "CC=" ,(cc-for-target)) "HOST_CC=gcc" "BUILD_DATE=GNU Guix" (string-append "PREFIX=" %output)) #:tests? #f)) ; no 'check' target (home-page "https://github.com/pali/0xFFFF") (synopsis "Flash FIASCO images on Maemo devices") (description "The Open Free Fiasco Firmware Flasher (0xFFFF) is a flashing tool for FIASCO images. It supports generating, unpacking, editing and flashing of FIASCO images for Maemo devices. Use it with care. It can brick your device.") (license license:gpl3+))) (define-public avrdude (package (name "avrdude") (version "6.3") (source (origin (method url-fetch) (uri (string-append "mirror://savannah/avrdude/avrdude-" version ".tar.gz")) (sha256 (base32 "15m1w1qad3dj7r8n5ng1qqcaiyx1gyd6hnc3p2apgjllccdp77qg")))) (build-system gnu-build-system) (inputs (list libelf libusb-compat libftdi)) (native-inputs (list bison flex)) (home-page "https://www.nongnu.org/avrdude/") (synopsis "AVR downloader and uploader") (description "AVRDUDE is a utility to download/upload/manipulate the ROM and EEPROM contents of AVR microcontrollers using the @acronym{ISP, in-system programming} technique.") (license license:gpl2+))) (define-public dfu-programmer (package (name "dfu-programmer") (version "0.7.2") (source (origin (method url-fetch) (uri (string-append "mirror://sourceforge/dfu-programmer/dfu-programmer/" version "/dfu-programmer-" version ".tar.gz")) (sha256 (base32 "15gr99y1z9vbvhrkd25zqhnzhg6zjmaam3vfjzf2mazd39mx7d0x")) (patches (search-patches "dfu-programmer-fix-libusb.patch")))) (build-system gnu-build-system) (native-inputs (list pkg-config)) (inputs (list libusb)) (home-page "https://dfu-programmer.github.io/") (synopsis "Device firmware update programmer for Atmel chips") (description "Dfu-programmer is a multi-platform command-line programmer for Atmel (8051, AVR, XMEGA & AVR32) chips with a USB bootloader supporting ISP.") (license license:gpl2+))) (define-public dfu-util (package (name "dfu-util") (version "0.11") (source (origin (method url-fetch) (uri (string-append "http://dfu-util.sourceforge.net/releases/dfu-util-" version ".tar.gz")) (sha256 (base32 "17piiyp08pccqmbhnswv957lkypmmm92kps79hypxvw23ai3pddl")))) (build-system gnu-build-system) (inputs (list libusb)) (native-inputs (list pkg-config)) (synopsis "Host side of the USB Device Firmware Upgrade (DFU) protocol") (description "The DFU (Universal Serial Bus Device Firmware Upgrade) protocol is intended to download and upload firmware to devices connected over USB. It ranges from small devices like micro-controller boards up to mobile phones. With dfu-util you are able to download firmware to your device or upload firmware from it.") (home-page "https://dfu-util.sourceforge.net/") (license license:gpl2+))) (define-public teensy-loader-cli (package (name "teensy-loader-cli") (version "2.2") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/PaulStoffregen/teensy_loader_cli") (commit version))) (sha256 (base32 "12n8ifz4gph1anhwd8if3j1kw0wc3yxf48abbyxl8071l9vj3m0b")) (file-name (git-file-name name version)) (modules '((guix build utils))) (snippet `(begin ;; Remove example flash files and teensy rebooter flash binaries. (for-each delete-file (find-files "." "\\.(elf|hex)$")))) (patches (search-patches "teensy-loader-cli-help.patch")))) (build-system gnu-build-system) (arguments (list #:tests? #f ;; Makefile has no test target #:make-flags #~(list "CC=gcc" (string-append "PREFIX=" #$output)) #:phases #~(modify-phases %standard-phases (delete 'configure) (replace 'install (lambda _ (install-file "teensy_loader_cli" (string-append #$output "/bin"))))))) (inputs (list libusb-compat)) ;only compatible with libusb 0.1 (synopsis "Command line firmware uploader for Teensy development boards") (description "The Teensy loader program communicates with your Teensy board when the HalfKay bootloader is running, so you can upload new programs and run them. You need to add the udev rules to make the Teensy update available for non-root users.") (home-page "https://www.pjrc.com/teensy/loader_cli.html") (license license:gpl3+))) (define-public teensy-udev-rules (package (name "teensy-udev-rules") (version "20230913") ;no version whatsoever -- use the current date (source (origin (method url-fetch) (uri "https://www.pjrc.com/teensy/00-teensy.rules") (sha256 (base32 "1yxczxvwi0s31g7lfa4v13yvvpv6gcsfs7r9mv6y4w9jc1inpx8p")))) (build-system copy-build-system) (arguments (let ((rules-file "lib/udev/rules.d/70-teensy.rules")) (list #:install-plan #~(list `(,#$source #$rules-file)) #:phases #~(modify-phases %standard-phases (add-after 'install 'patch-paths (lambda* (#:key inputs #:allow-other-keys) (substitute* (string-append #$output "/" #$rules-file) (("/bin/stty") (search-input-file inputs "bin/stty"))))))))) (inputs (list coreutils-minimal)) (home-page "https://www.pjrc.com/teensy/loader_cli.html") (synopsis "udev rules for the Teensy family of micro-controllers") (description "This package provides a udev rules file that allows unprivileged users communication with the Teensy family of micro-controllers. ModemManager (part of NetworkManager) can interfere with USB Serial devices, which includes the Teensy. In case of problems, see the @file{.rules} file for possible workarounds.") ;; FIXME: The file lacks an explicit license, so the license of ;; teensy-cli-loader is *assumed* to hold (see: ;; https://github.com/PaulStoffregen/teensy_loader_cli/issues/84). (license license:gpl3+) (supported-systems (filter (cut string-suffix? "-linux" <>) %supported-systems)))) (define-public rkflashtool (let ((commit "8966c4e277de8148290554aaaa4146a3a84a3c53") (revision "1")) (package (name "rkflashtool") (version (git-version "5.2" revision commit)) (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/linux-rockchip/rkflashtool") (commit commit))) (file-name (git-file-name name version)) (sha256 (base32 "1ndyzg1zlgg20dd8js9kfqm5kq19k005vddkvf65qj20w0pcyahn")))) (build-system gnu-build-system) (arguments '(#:phases (modify-phases %standard-phases (delete 'configure)) ; no configure #:make-flags (list (string-append "PREFIX=" %output)) #:tests? #f)) ; no tests (native-inputs (list pkg-config)) (inputs (list libusb)) (home-page "https://github.com/linux-rockchip/rkflashtool") (synopsis "Tools for flashing Rockchip devices") (description "Allows flashing of Rockchip based embedded linux devices. The list of currently supported devices is: RK2818, RK2918, RK2928, RK3026, RK3036, RK3066, RK312X, RK3168, RK3188, RK3288, RK3368.") (license license:bsd-2)))) (define-public heimdall (package (name "heimdall") (version "1.4.2") (source (origin (method git-fetch) (uri (git-reference (url "https://gitlab.com/BenjaminDobell/Heimdall.git") (commit (string-append "v" version)))) (file-name (git-file-name name version)) (sha256 (base32 "1ygn4snvcmi98rgldgxf5hwm7zzi1zcsihfvm6awf9s6mpcjzbqz")))) (build-system cmake-build-system) (arguments `(#:build-type "Release" #:tests? #f ; no tests #:phases (modify-phases %standard-phases (add-after 'unpack 'patch-invocations (lambda* (#:key outputs #:allow-other-keys) (substitute* '("heimdall-frontend/source/aboutform.cpp" "heimdall-frontend/source/mainwindow.cpp") (("start[(]\"heimdall\"") (string-append "start(\"" (assoc-ref outputs "out") "/bin/heimdall\""))) #t)) (replace 'install (lambda* (#:key outputs #:allow-other-keys) (let ((bin (string-append (assoc-ref outputs "out") "/bin")) (lib (string-append (assoc-ref outputs "out") "/lib"))) (install-file "bin/heimdall" bin) (install-file "bin/heimdall-frontend" bin) (install-file "libpit/libpit.a" lib) #t)))))) (inputs (list libusb qtbase-5 zlib)) (home-page "https://glassechidna.com.au/heimdall/") (synopsis "Flash firmware onto Samsung mobile devices") (description "@command{heimdall} is a tool suite used to flash firmware (aka ROMs) onto Samsung mobile devices. Heimdall connects to a mobile device over USB and interacts with low-level software running on the device, known as Loke. Loke and Heimdall communicate via the custom Samsung-developed protocol typically referred to as the \"Odin 3 protocol\".") (license license:expat))) (define-public coreboot-version "4.22") (define-public coreboot-source (origin (method git-fetch) (uri (git-reference (url "https://github.com/coreboot/coreboot") (commit coreboot-version))) (file-name (git-file-name "coreboot" coreboot-version)) (sha256 (base32 "125qw98f8zfhq0d5rpawxsjghqxwmg6yha1r1dqmwbxd7i12bj8f")))) (define-public bucts (package (name "bucts") (version coreboot-version) (source coreboot-source) (inputs (list pciutils)) (build-system gnu-build-system) (arguments (list #:tests? #f ;no tests #:make-flags #~(list (string-append "CC=" #$(cc-for-target)) (string-append "DESTDIR=" #$output) "INSTALL=install" "PREFIX=/") #:phases #~(modify-phases %standard-phases (delete 'configure) ;no configure script (add-after 'unpack 'enter-source (lambda _ (chdir "util/bucts"))) (add-after 'enter-source 'fixup-version (lambda _ (substitute* "Makefile" (("^VERSION:=*") #$(string-append "VERSION:=" version))))) ;; no install target (replace 'install (lambda _ (let ((bin (string-append #$output "/bin")) (doc (string-append #$output "/share/doc/bucts/")) (licenses (string-append #$output "/share/licenses/bucts/"))) (install-file "bucts" bin) (install-file "readme.md" doc) (install-file "../../COPYING" licenses))))))) (home-page "https://coreboot.org") (synopsis "Tool to manipulate swap boot firmware bootblocks on the Intel I945 chipsets") (description "This package provides @command{bucts}. That command can flip a bit in the BUC.TS register of the Intel I945 chipsets and show the register status. When the bit is set, it swaps the bootblock location. Because the bootblock region is often set read-only by the default BIOS, this enables to bypass that restriction and is used as part of a procedure to replace the nonfree BIOS with free software on various computers (Lenovo X60, X60s, X60T, T60, probably more).") (license license:gpl2))) (define-public ifdtool (package (name "ifdtool") (version coreboot-version) (source coreboot-source) (build-system gnu-build-system) (arguments (list #:make-flags #~(list "CC=gcc" "INSTALL=install" (string-append "PREFIX=" #$output)) #:phases #~(modify-phases %standard-phases (add-after 'unpack 'chdir (lambda _ (chdir "util/ifdtool"))) (delete 'configure)) ; no configure script #:tests? #f)) ; no test suite (home-page "https://github.com/corna/me_cleaner/") (synopsis "Intel Firmware Descriptor dumper") (description "This package provides @command{ifdtool}, a program to dump Intel Firmware Descriptor data of an image file.") (license license:gpl2))) (define-public intelmetool (package (name "intelmetool") (version coreboot-version) (source coreboot-source) (build-system gnu-build-system) (inputs (list pciutils zlib)) (arguments `(#:make-flags (list "CC=gcc" "INSTALL=install" (string-append "PREFIX=" (assoc-ref %outputs "out"))) #:phases (modify-phases %standard-phases (add-after 'unpack 'chdir (lambda _ (chdir "util/intelmetool") #t)) (delete 'configure) (delete 'check)))) (home-page "https://github.com/zamaudio/intelmetool") (synopsis "Intel Management Engine tools") (description "This package provides tools for working with Intel Management Engine (ME). You need to @code{sudo rmmod mei_me} and @code{sudo rmmod mei} before using this tool. Also pass @code{iomem=relaxed} to the Linux kernel command line.") (license license:gpl2) ;; This is obviously an Intel thing, plus it requires . (supported-systems '("x86_64-linux" "i686-linux")))) (define-public me-cleaner (package (name "me-cleaner") (version "1.2") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/corna/me_cleaner") (commit (string-append "v" version)))) (sha256 (base32 "1bdj2clm13ir441vn7sv860xsc5gh71ja5lc2wn0gggnff0adxj4")) (file-name (git-file-name name version)))) (build-system python-build-system) (arguments `(#:phases (modify-phases %standard-phases (add-after 'install 'install-documentation (lambda* (#:key outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (man (string-append out "/share/man/man1"))) (install-file "man/me_cleaner.1" man) #t)))))) (home-page "https://github.com/corna/me_cleaner") (synopsis "Intel ME cleaner") (description "This package provides tools for disabling Intel ME as far as possible (it only edits ME firmware image files).") (license license:gpl3+) ;; This is an Intel thing. (supported-systems '("x86_64-linux" "i686-linux")))) (define-public uefitool (package (name "uefitool") (version "0.28.0") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/LongSoft/UEFITool") (commit version))) (sha256 (base32 "1n2hd2dysi5bv2iyq40phh1jxc48gdwzs414vfbxvcharcwapnja")) (file-name (git-file-name name version)))) (build-system gnu-build-system) (arguments `(#:phases (modify-phases %standard-phases (replace 'configure (lambda _ (invoke "qmake" "-makefile"))) (replace 'install (lambda* (#:key outputs #:allow-other-keys) (install-file "UEFITool" (string-append (assoc-ref outputs "out") "/bin"))))))) (inputs (list qtbase-5)) (home-page "https://github.com/LongSoft/UEFITool/") (synopsis "UEFI image editor") (description "@code{uefitool} is a graphical image file editor for Unifinished Extensible Firmware Interface (UEFI) images.") (license license:bsd-2))) (define-public srecord (package (name "srecord") (version "1.65.0") (source (origin (method url-fetch) (uri (string-append "mirror://sourceforge/srecord/srecord/" (version-major+minor version) "/" "srecord-" version "-Source.tar.gz")) (sha256 (base32 "0i3n6g8i28xx8761nadm6p2nf9y31bywx0isyi0h9rawy5yd1hw1")) (modules '((guix build utils))) (snippet '(begin ;; Fix building without Git. Upstream tries to allow it but is buggy. (substitute* "etc/configure.cmake" (("\\(GIT_SHA1\\)") "(FALSE)")) ;; It also tries to install the entire RUNTIME_DEPENDENCY_SET of ;; each executable: libm, libc, libstc++ & more! Get the cluehammer. (substitute* "etc/packaging.cmake" ((".*# Find standard library DLL.*" match) "ENDFUNCTION()\n\nFUNCTION(WTF no)\n")) ;; Now stop it from deliberately clobbering -DCMAKE_INSTALL_PREFIX. (substitute* "CMakeLists.txt" (("set\\(CMAKE_INSTALL_PREFIX") "#")))))) (build-system cmake-build-system) (arguments (list #:modules '((guix build cmake-build-system) (guix build utils) (srfi srfi-26)) #:phases #~(modify-phases %standard-phases (add-before 'check 'make-tests-executable (lambda _ (for-each (cut chmod <> #o755) ;; We're in a parallel build directory to the sources and tests. (find-files ".." "\\.sh$"))))))) (inputs (list boost libgcrypt)) (native-inputs (list doxygen ghostscript ; for ps2pdf graphviz ; the build scripts call this ‘doxygen’… groff psutils ;; For the tests. diffutils which ;; XXX Work around Guix's currently-broken psutils package. Remove ;; both and maybe (gnu packages perl) when core-updates is merged. perl perl-ipc-run3)) (home-page "https://srecord.sourceforge.net/") (synopsis "Tools for EPROM files") (description "The SRecord package is a collection of powerful tools for manipulating EPROM load files. It reads and writes numerous EPROM file formats, and can perform many different manipulations.") (license license:gpl3+))) (define-public uuu (package (name "uuu") (version "1.4.165") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/NXPmicro/mfgtools") (commit (string-append "uuu_" version)))) (file-name (git-file-name name version)) (sha256 (base32 "0k309lp27d4k6x4qq0badbk8i47xsc6f3fffz73650iyfs4hcniw")))) (arguments `(#:tests? #f ; no tests #:modules ((guix build utils) (ice-9 popen) (srfi srfi-26) (guix build cmake-build-system)) #:phases (modify-phases %standard-phases (add-before 'configure 'fix-version-gen (lambda _ (call-with-output-file ".tarball-version" (lambda (port) (display ,version port))))) (add-after 'install 'install-udev-rules (lambda* (#:key outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (uuu (string-append out "/bin/uuu")) (pipe (open-pipe* OPEN_READ uuu "-udev")) (rules (string-append out "/lib/udev/rules.d/70-uuu.rules"))) (mkdir-p (string-append out "/lib/udev/rules.d")) (call-with-output-file rules (cut dump-port pipe <>)))))))) (build-system cmake-build-system) (native-inputs (list pkg-config)) (inputs (list libusb bzip2 zlib libzip openssl)) (home-page "https://github.com/NXPmicro/mfgtools") (synopsis "Freescale/NXP I.MX chip image deploy tools") (description "@code{uuu} is a command line tool, evolved out of MFGTools. It can be used to upload images to I.MX SoC's using at least their boot ROM.") (license license:bsd-3))) (define-public qdl (let ((commit "13681fcb359c9f9c32a17a91d3dd20df2e413b6d") (revision "1")) (package (name "qdl") (version (git-version "1.0" revision commit)) (source (origin (method git-fetch) (uri (git-reference (url "https://git.linaro.org/landing-teams/working/qualcomm/qdl.git") (commit commit))) (file-name (git-file-name name version)) (sha256 (base32 "0m6wdhfwbf7gzlckxx21bvbv33qjahpzqbg1pdqdd1lifx5f51mj")))) (build-system gnu-build-system) (native-inputs (list libxml2)) (inputs (list eudev)) (arguments `(#:tests? #f ; No tests implemented #:make-flags (list (string-append "CC=" ,(cc-for-target)) (string-append "prefix=" %output)) #:phases (modify-phases %standard-phases (delete 'configure)))) (home-page "https://git.linaro.org/landing-teams/working/qualcomm/qdl") (synopsis "Qualcomm EDL mode flashing tool") (description "This tool communicates with USB devices of id 05c6:9008 to upload a flash loader and use this to flash images.") (license license:bsd-3))))