[PATCH 00/22] Add ErgoDox firmware packages

+++ b/gnu/packages/avr.scm

+;;; Copyright © 2023 Maxim Cournoyer <maxim.cournoyer@gmail.com>

+(define* (make-avr-gcc/implementation #:key (xgcc gcc))

+ "Return a XGCC-base cross-compiler for the AVR target."

+ (let ((xgcc (cross-gcc "avr" #:xgcc xgcc #:xbinutils (make-avr-binutils))))

+ (package

+ (inherit xgcc)

+ (name "avr-gcc")

+ (arguments

+ (substitute-keyword-arguments (package-arguments xgcc)

+ ((#:phases phases)

+ #~(modify-phases #$phases

+ (add-after 'set-paths 'augment-CPLUS_INCLUDE_PATH

+ (lambda* (#:key inputs #:allow-other-keys)

+ (let ((gcc (assoc-ref inputs "gcc")))

+ ;; Remove the default compiler from CPLUS_INCLUDE_PATH

+ ;; to prevent header conflict with the GCC from

+ ;; native-inputs.

+ (setenv "CPLUS_INCLUDE_PATH"

+ (string-join

+ (delete (string-append gcc "/include/c++")

+ (string-split (getenv "CPLUS_INCLUDE_PATH")

+ #\:))

+ ":"))

+ (format #t

+ "environment variable `CPLUS_INCLUDE_PATH' \

+ (getenv "CPLUS_INCLUDE_PATH")))))

+ ;; Without a working multilib build, the resulting GCC lacks

+ ;; support for nearly every AVR chip.

+ (add-after 'unpack 'fix-genmultilib

+ (lambda _

+ ;; patch-shebang doesn't work here because there are

+ ;; actually several scripts inside this script, each with

+ ;; a #!/bin/sh that needs patching.

+ (substitute* "gcc/genmultilib"

+ (("#!/bin/sh") (string-append "#!" (which "sh"))))))))

+ ((#:configure-flags flags)

+ #~(delete "--disable-multilib" #$flags))))

+ (native-search-paths

+ (list (search-path-specification

+ (variable "CROSS_C_INCLUDE_PATH")

+ (files '("avr/include")))

+ (search-path-specification

+ (variable "CROSS_CPLUS_INCLUDE_PATH")

+ (files '("avr/include")))

+ (search-path-specification

+ (variable "CROSS_OBJC_INCLUDE_PATH")

+ (files '("avr/include")))

+ (search-path-specification

+ (variable "CROSS_OBJCPLUS_INCLUDE_PATH")

+ (files '("avr/include")))

+ (search-path-specification

+ (variable "CROSS_LIBRARY_PATH")

+ (files '("avr/lib")))))

+ (native-inputs

+ `(("gcc" ,gcc)

+ ,@(package-native-inputs xgcc))))))

+

+(define make-avr-gcc

+ (memoize make-avr-gcc/implementation))

+

+(define* (make-avr-libc/implementation #:key (xgcc gcc))

+ (package

+ (name "avr-libc")

+ (version "2.0.0")

+ (source (origin

+ (method url-fetch)

+ (uri (string-append "mirror://savannah//avr-libc/avr-libc-"

+ version ".tar.bz2"))

+ (sha256

+ (base32

+ "15svr2fx8j6prql2il2fc0ppwlv50rpmyckaxx38d3gxxv97zpdj"))))

+ (build-system gnu-build-system)

+ (arguments

+ '(#:out-of-source? #t

+ #:configure-flags '("--host=avr")))

+ (native-inputs `(("avr-binutils" ,(make-avr-binutils))

+ ("avr-gcc" ,(make-avr-gcc #:xgcc xgcc))))

+ (home-page "https://www.nongnu.org/avr-libc/")

+ (synopsis "The AVR C Library")

+ (description

+ "AVR Libc is a project whose goal is to provide a high quality C library

+for use with GCC on Atmel AVR microcontrollers.")

+ (license

+ (license:non-copyleft "http://www.nongnu.org/avr-libc/LICENSE.txt"))))

+ (memoize make-avr-libc/implementation))

+(define* (make-avr-toolchain/implementation #:key (xgcc gcc))

+ (let ((avr-binutils (make-avr-binutils))

+ (avr-libc (make-avr-libc #:xgcc xgcc))

+ (avr-gcc (make-avr-gcc #:xgcc xgcc)))

+ ;; avr-libc checks the compiler version and passes "--enable-device-lib"

+ ;; for avr-gcc > 5.1.0. It wouldn't install the library for atmega32u4

+ ;; etc if we didn't use the corret avr-gcc.

+ (package

+ (name "avr-toolchain")

+ (version (package-version avr-gcc))

+ (source #f)

+ (build-system trivial-build-system)

+ (arguments '(#:builder (begin (mkdir %output) #t)))

+ (propagated-inputs

+ `(("avrdude" ,avrdude)

+ ("binutils" ,avr-binutils)

+ ("gcc" ,avr-gcc)

+ ("libc" ,avr-libc)))

+ (synopsis "Complete GCC tool chain for AVR microcontroller development")

+ (description "This package provides a complete GCC tool chain for AVR

+ (home-page (package-home-page avr-libc))

+ (license (package-license avr-gcc)))))

+

+(define make-avr-toolchain

+ (memoize make-avr-toolchain/implementation))

+++ b/gnu/packages/firmware.scm

+ (arguments

+ (list #:tests? #f)) ;No tests.

+ (propagated-inputs (list python-dotty-dict

+ python-hid

+ python-hjson

+ python-jsonschema

+ python-milc

+ python-pillow

+ python-pygments

+ python-pyserial

+ python-pyusb))

+++ b/gnu/packages/firmware.scm

+ #:use-module (guix build-system copy)

+ #:use-module (gnu packages autotools)

+ #:use-module (gnu packages avr)

+ #:use-module (gnu packages flashing-tools)

+

+;;;

+;;; QMK Firmware.

+;;;

+

+ (list

+ #:tests? #f ;no tests

+ #:modules '((guix build pyproject-build-system)

+ (guix build utils)

+ (srfi srfi-26))

+ #:phases

+ #~(modify-phases %standard-phases

+ (add-after 'wrap 'wrap-path

+ (lambda* (#:key inputs outputs #:allow-other-keys)

+ (wrap-program (search-input-file outputs "bin/qmk")

+ `("PATH" prefix

+ ,(map (compose dirname

+ (cut search-input-file inputs <>))

+ '("bin/avr-gcc"

+ "bin/avrdude"

+ "bin/dfu-programmer"

+ "bin/git"

+ ;; TODO: Remove after git is wrapped with these.

+ "bin/basename"

+ "bin/sed"

+ "bin/uname")))))))))

+ ;; The inputs are not propagated since qmk is to be used strictly as a

+ ;; command.

+ (inputs

+ (list (make-avr-toolchain)

+ avrdude

+ dfu-programmer

+ git-minimal ;for the clone action

+ python-dotty-dict

+ python-hid

+ python-hjson

+ python-jsonschema

+ python-milc

+ python-pillow

+ python-pygments

+ python-pyserial

+ python-pyusb

+ ;; These are added to workaround faults in our git package (see

+ ;; bug#65924).

+ coreutils-minimal

+ sed

+ util-linux))

+ (description "The QMK CLI provides a @acronym{CLI, command line interface}

+based program to help users work with the QMK firmware, which can be used for

+multiple custom keyboards such as Planck, ErgoDox, Corne and others.

+

+This @acronym{CLI} program is mainly used for building the QMK firmware, but

+also has some other convenience utilities. It is highly recommended to

+install the udev rules provided by the @code{qmk-udev-rules} package to avoid

+having to run @command{qmk} as root when flashing the firmware.")

+++ b/gnu/packages/firmware.scm

+ ;; The 'qmk setup' command advises to use GCC at version 8, and there are

+ ;; compilation errors in some firmware otherwise.

+ (list (make-avr-toolchain #:xgcc gcc-8)

+++ b/gnu/packages/firmware.scm

+ #:use-module (gnu packages gawk)

+ ;; Wrap all the tools needed for the 'setup' and 'compile' actions

+ ;; (tested with the 'ergodox_ez' keyboard).

+ '("bin/avr-ar"

+ "bin/avr-gcc"

+ "bin/awk"

+ "bin/cmp"

+ "bin/dfu-util"

+ "bin/grep"

+ "bin/make"

+ "bin/python3"

+ "bin/sh"

+ "bin/uname")))

+ `("CROSS_C_INCLUDE_PATH" = (,(getenv "CROSS_C_INCLUDE_PATH")))

+ `("CROSS_LIBRARY_PATH" = (,(getenv "CROSS_LIBRARY_PATH")))))))))

+ bash-minimal

+ dfu-util

+ diffutils

+ gawk

+ gnu-make

+ grep

+ python

+++ b/gnu/packages/avr-xyz.scm

+;;; Copyright © 2023 Maxim Cournoyer <maxim.cournoyer@gmail.com>

+ #:use-module (gnu packages documentation)

+

+(define-public lufa

+ (package

+ (name "lufa")

+ (version "210130")

+ (source (origin

+ (method git-fetch)

+ (uri (git-reference

+ (url "https://github.com/abcminiuser/lufa")

+ (commit (string-append "LUFA-" version))))

+ (file-name (git-file-name name version))

+ (sha256

+ (base32

+ "0ylr7qsiikcy827k18zj1vdzf0kb8hb0gjmifd75y8krkhhar49g"))))

+ (outputs '("bootloaders" "demos" "projects" "doc"))

+ (build-system gnu-build-system)

+ (arguments

+ ;; There are tests, but even LUFA's own CI doesn't run them (they are

+ ;; only built).

+ (list

+ #:tests? #f

+ #:modules '((guix build gnu-build-system)

+ (guix build utils)

+ (ice-9 match)

+ (srfi srfi-26))

+ #:make-flags

+ #~(list (string-append "SHELL="(search-input-file %build-inputs

+ "bin/sh")))

+ #:phases #~(modify-phases %standard-phases

+ (delete 'configure)

+ (add-before 'build 'build-documentation

+ (lambda* (#:key make-flags #:allow-other-keys)

+ (apply invoke "make" "-j" (number->string

+ (or (parallel-job-count)

+ 1))

+ "doxygen"

+ ;; Ignore errors (see:

+ ;; https://github.com/abcminiuser/lufa/issues/90).

+ "-i"

+ make-flags)))

+ (replace 'install

+ ;; There is no default install target as the library is

+ ;; intended to be integrated in source form in a

+ ;; project. Install the example projects and demos

+ ;; binaries as well as the documentation.

+ (lambda _

+ (let ((doc (string-append #$output:doc

+ "/share/doc/lufa/"))

+ (html-dirs (find-files "." "^html$"

+ #:directories? #t)))

+ (for-each (cut install-file <> #$output:bootloaders)

+ (find-files "Bootloaders" "\\.hex$"))

+ (for-each (cut install-file <> #$output:demos)

+ (find-files "Demos" "\\.hex$"))

+ (for-each (cut install-file <> #$output:projects)

+ (find-files "Projects" "\\.hex$"))

+ ;; Install Doxygen generated HTML documentation.

+ (for-each

+ (lambda (html)

+ (let* ((suffix "Documentation/html")

+ (l (string-length suffix))

+ (dest (string-append

+ doc

+ (string-drop

+ (if (string-suffix? suffix html)

+ (string-drop-right html l)

+ (error "unexpected path" html))

+ 1)))) ;drop leading "."

+ (mkdir-p dest)

+ (copy-recursively html dest)))

+ html-dirs)))))))

+ (native-inputs (list doxygen (make-avr-toolchain)))

+ (home-page "https://www.lufa-lib.org/")

+ (synopsis "Lightweight USB Framework for AVRs")

+ (description "UFA is a simple to use, lightweight framework which sits

+atop the hardware USB controller in specific AVR microcontroller models, and

+allows for the quick and easy creation of complex USB devices and hosts. This

+package contains the user-submitted projects and bootloaders for use with

+compatible microcontroller models, as well as the demos and the

+documentation.")

+ (license license:expat))) ;see LUFA/License.txt

+++ b/gnu/packages/embedded.scm

+ #:use-module (gnu packages base)

+ which

+ ("which" ,which)))

+ (list pkg-config swig which))

+++ b/gnu/packages/firmware.scm

+ #:use-module (guix memoization)

+ #:use-module (gnu packages avr-xyz)

+ #:use-module (ice-9 format)

+ #:use-module (ice-9 match)

+

+ #:export (make-qmk-firmware))

+

+(define* (make-qmk-firmware/implementation keyboard keymap

+ #:key (description "")

+ keymap-json

+ keymap-source-directory)

+ "Return a package to build the QMK firmware for KEYBOARD with KEYMAP.

+Keyboard should be the name of a sub-directory under the @file{keyboards}

+directory. For custom keymaps, KEYMAP-JSON, a file-like object of a JSON

+representation of KEYMAP as generated by the @url{https://config.qmk.fm/, QMK

+Configurator} tool or KEYMAP-SOURCE-DIRECTORY, a file-like object directory

+containing the keymap source files files such as @file{keymap.c}, can be

+provided."

+ (package

+ (name (string-append "qmk-firmware-"

+ (string-replace-substring keyboard "_" "-") "-"

+ (string-replace-substring keymap "_" "-")))

+ ;; Note: When updating this package, make sure to also update the commit

+ ;; used for the LUFA submodule in the 'copy-lufa-source' phase below.

+ (version "0.22.3")

+ (source (origin

+ (method git-fetch)

+ (uri (git-reference

+ (url "https://github.com/qmk/qmk_firmware")

+ (commit version)))

+ (file-name (git-file-name "qmk-firmware" version))

+ (sha256

+ (base32

+ "0s1lcnv7cddpn768p7mrc5bkxhx0ba5p77ya007dnkbk36c33d0w"))))

+ (build-system gnu-build-system)

+ (arguments

+ (list

+ #:modules '((guix build gnu-build-system)

+ (guix build utils)

+ (ice-9 match)

+ (srfi srfi-26))

+ ;; XXX: Running a test target like "test:$keyboard" doesn't seem to run

+ ;; anything and causes the .hex file to be regenerated; leave the tests

+ ;; out for now.

+ #:tests? #f

+ #:make-flags

+ #~(list #$(format #f "~a:~a" keyboard keymap)

+ (string-append "SHELL=" (search-input-file

+ %build-inputs "bin/sh")))

+ #:phases

+ #~(modify-phases %standard-phases

+ (replace 'configure

+ (lambda _

+ ;; Do not attempt to retrieve information from git during the

+ ;; build.

+ (setenv "SKIP_GIT" "1")))

+ (add-after 'unpack 'copy-lufa-source

+ ;; QMK carries a custom fork of LUFA as a git submodule; make sure

+ ;; the same commit is used (see:

+ ;; https://github.com/qmk/qmk_firmware/tree/master/lib).

+ (lambda _

+ (copy-recursively

+ #$(let ((commit "549b97320d515bfca2f95c145a67bd13be968faa"))

+ (origin

+ (inherit (package-source lufa))

+ (uri (git-reference

+ (url "https://github.com/qmk/lufa")

+ (commit commit)))

+ (file-name (git-file-name "lufa" commit))

+ (sha256

+ (base32

+ "1rmhm4rxvq8skxqn6vc4n4ly1ak6whj7c386zbsci4pxx548n9h4"))))

+ "lib/lufa")))

+ #$@(if keymap-source-directory

+ #~((add-after 'unpack 'copy-keymap-source-directory

+ (lambda _

+ (let ((keymap-dir #$(string-append "keyboards/" keyboard

+ "/keymaps/" keymap)))

+ (false-if-exception (delete-file-recursively

+ keymap-dir))

+ (copy-recursively #$keymap-source-directory

+ keymap-dir)))))

+ #~())

+ #$@(if keymap-json

+ #~((replace 'build

+ (lambda _

+ (invoke "qmk" "compile" #$keymap-json))))

+ #~())

+ (replace 'install

+ (lambda _

+ (match (find-files ".build" "\\.hex$")

+ (()

+ (error "no built binary file found"))

+ ((hex ..1)

+ (for-each (cut install-file <> #$output) hex))))))))

+ ;; Some of the build tools are required to be on the PATH, as the make

+ ;; files do not always operate through 'qmk'; all of qmk's inputs must

+ ;; thus be made available.

+ (native-inputs (modify-inputs (package-inputs qmk)

+ (append qmk)))

+ (home-page "https://qmk.fm/")

+ (synopsis "Keyboard firmware for Atmel AVR and Arm USB families")

+ (description

+ (format #f "QMK (Quantum Mechanical Keyboard Firmware) is a keyboard

+firmware based on the @url{https://github.com/tmk/tmk_keyboard, tmk_keyboard

+firmware} with some useful features for Atmel AVR and ARM controllers, and

+more specifically, the @url{https://olkb.com/, OLKB product line}, the

+@url{https://ergodox-ez.com/, ErgoDox EZ keyboard}, and the

+@url{https://clueboard.co/, Clueboard product line}.~@[~%~%~a~]" description))

+ (license license:gpl2+)))

+

+(define make-qmk-firmware (memoize make-qmk-firmware/implementation))

+

+(define-public qmk-firmware-ergodox-ez-default

+ (make-qmk-firmware

+ "ergodox_ez" "default" #:description

+ "This is the default keymap used on the ErgoDox EZ keyboard. It includes

+the novel MEH and Hyper keys pioneered by the ErgoDox EZ, easy to reach

+Control/Shift modifiers keys, and two-functions hold keys to access layer 1.

+Layer 1 contains function keys, symbols, a numpad as well as brightness keys.

+Layer 2 contains multimedia and mouse keys. See the

+@file{keyboards/ergodox_ez/keymaps/default/keymap.c} source file for the

+keymap definition, or the

+@url{https://configure.ergodox-ez.com/ergodox-ez/layouts/JwwW/latest/0,

+ErgoDox EZ Configurator} page."))

+++ b/gnu/packages/firmware.scm

+

+(define-public qmk-firmware-ergodox-ez-dvorak-42-key

+ (make-qmk-firmware "ergodox_ez" "dvorak_42_key" #:description "\

+This is a Dvorak-based layout for the ErgoDox EZ. Its basic key layout is

+similar to the Atreus @samp{dvorak_42_key} layout; in fact this layout was

+created for seamless switching between the ErgoDox EZ and Atreus keyboards.

+On the base layer, the keys that don't exist on the Atreus are mapped to MEH

+shortcuts and can be interpreted by your window managher. This layout only

+makes use of the 42 keys that the Atreus also has for the main functionality.

+See the @file{keyboards/atreus/keymaps/dvorak_42_key/keymap.c} source file for

+the keymap definition."))

+++ b/gnu/packages/firmware.scm

+

+(define-public qmk-udev-rules

+ (package

+ (inherit qmk-firmware-ergodox-ez-default)

+ (name "qmk-udev-rules")

+ (build-system copy-build-system)

+ (arguments

+ '(#:install-plan '(("./util/udev" "lib/udev/rules.d"

+ #:include-regexp ("rules$")))))

+ (native-inputs '())

+ (inputs '())

+ (propagated-inputs '())

+ (synopsis "Udev rules for QMK Firmware")

+ (description

+ "This package provides a set of udev rules to specify the proper

+privileges for flashing QMK compatible devices without needing root. The

+rules require the group @code{plugdev} to be added to each user that needs

+this.")))

+++ b/gnu/local.mk

+ %D%/packages/patches/qmk-firmware-fix-hacker-dvorak.patch \

+++ b/gnu/packages/firmware.scm

+ "0s1lcnv7cddpn768p7mrc5bkxhx0ba5p77ya007dnkbk36c33d0w"))

+ (patches

+ (search-patches "qmk-firmware-fix-hacker-dvorak.patch"))))

+(define-public qmk-firmware-ergodox-ez-hacker-dvorak

+ (make-qmk-firmware "ergodox_ez" "hacker_dvorak" #:description "\

+This is a Dvorak layout for the ErgoDox EZ. It is inspired by the

+@url{https://www.kaufmann.no/roland/dvorak, Programmer Dvorak}. The operating

+system keyboard layout should be set to US for this keymap to function

+normally. It defines 10 layers:

+@enumerate

+@item Dvorak

+@item Querty

+@item Gaming

+@item Arrows

+@item Mouse

+@item Numpad

+@item Hyper Fn

+@item Media Fn

+@item Meh Fn

+@item Meh Fn +

+@end enumerate

+The complete keymap can be inspected at the ErgoDox EZ Configurator web site:

+@url{https://configure.ergodox-ez.com/ergodox-ez/layouts/Wadz/latest/0}."))

+

+++ b/gnu/packages/patches/qmk-firmware-fix-hacker-dvorak.patch

+Submitted upstream: https://github.com/qmk/qmk_firmware/pull/22102

+

+diff --git a/keyboards/ergodox_ez/keymaps/hacker_dvorak/user/layer_set_state_user.c b/keyboards/ergodox_ez/keymaps/hacker_dvorak/user/layer_set_state_user.c

+index bd4fd10ad1..5ce5f5298f 100644

+--- a/keyboards/ergodox_ez/keymaps/hacker_dvorak/user/layer_set_state_user.c

++++ b/keyboards/ergodox_ez/keymaps/hacker_dvorak/user/layer_set_state_user.c

+@@ -4,7 +4,7 @@ layer_state_t layer_state_set_user(layer_state_t state) {

+

+ switch (layer) {

+ case DVORAK:

+- rgblight_sethsv_noeeprom(GREEN);

++ rgblight_sethsv_noeeprom(HSV_GREEN);

+ rgblight_mode_noeeprom(RGBLIGHT_MODE_STATIC_LIGHT);

+

+ if (PLOVER_MODE) {

+++ b/gnu/packages/firmware.scm

+(define-public qmk-firmware-ergodox-ez-dvorak

+ (make-qmk-firmware

+ "ergodox_ez" "dvorak" #:description

+ "This is a rather plain Dvorak layout for the ErgoDox EZ, containing

+function and symbols on layer 1 and media and and mouse keys on layer 2. See

+the @file{layouts/community/ergodox/dvorak/keymap.c} source file for the

+keymap definition."))

+

+++ b/gnu/packages/firmware.scm

+(define-public qmk-firmware-ergodox-ez-dvorak-emacs

+ (make-qmk-firmware

+ "ergodox_ez" "dvorak_emacs" #:description

+ "This is a Dvorak-based keymap optimized for Emacs usage, with the

+frequently used Control and Meta (Alt) keys mapped to the thumb buttons. It

+contains a single extra layer that includes function and multimedia keys. A

+graphical representation of the keymap is available in the

+@file{layouts/community/ergodox/dvorak_emacs/readme.md} source file."))

+

+++ b/gnu/packages/firmware.scm

+(define-public qmk-firmware-ergodox-ez-dvorak-emacs-software

+ (make-qmk-firmware

+ "ergodox_ez" "dvorak_emacs_software" #:description

+ "This is the same layout as that of the

+@code{qmk-firmware-ergodox-ez-dvorak-emacs}, but designed to be used with a

+Dvorak-configured operating system (instead of a US QWERTY one, which is the

+default assumption for QMK firmware keymaps)."))

+

+++ b/gnu/packages/firmware.scm

+(define-public ergodox-firmware-colemak-symbol-mod

+ (make-ergodox-firmware "colemak-symbol-mod"))

+

+++ b/gnu/packages/firmware.scm

+(define-public ergodox-firmware-dvorak-kinesis-mod

+ (make-ergodox-firmware "dvorak-kinesis-mod"))

+

+++ b/gnu/local.mk

+ %D%/packages/patches/ergodox-firmware-fix-json-target.patch \

+ %D%/packages/patches/ergodox-firmware-fix-numpad.patch \

+++ b/gnu/packages/firmware.scm

+ #:export (make-ergodox-firmware

+ make-qmk-firmware))

+

+;;;

+;;; ErgoDox firmware.

+;;;

+

+(define* (make-ergodox-firmware/implementation layout #:key override.c

+ override.h)

+ "Return an ergodox-firmware package for LAYOUT, optionally using OVERRIDE.C,

+a C source file-like object to override LAYOUT which may be accompanied by

+OVERRIDE.H, to also override the corresponding layout include file."

+ (let ((revision "0")

+ (commit "89b7e2bfdafb2a87e0248846d5c95cc5e9a27858"))

+ (package

+ (name (string-append "ergodox-firmware-" layout))

+ (version (git-version "1" revision commit))

+ (source (origin

+ (method git-fetch)

+ (uri (git-reference

+ (url "https://github.com/benblazak/ergodox-firmware")

+ (commit commit)))

+ (file-name (git-file-name name version))

+ (sha256

+ (base32

+ "1z28frxyb21nz90frycrpsbxjp09374wawayvjphnwc8njlvkkpy"))

+ (patches

+ (search-patches "ergodox-firmware-fix-json-target.patch"

+ "ergodox-firmware-fix-numpad.patch"))))

+ (build-system gnu-build-system)

+ (arguments

+ (list

+ #:tests? #f ;no test suite

+ #:make-flags

+ #~(list (string-append "LAYOUT=" #$layout)

+ ;; Simplify the output directory name.

+ "ROOT=output")

+ #:phases

+ #~(modify-phases %standard-phases

+ (add-after 'unpack 'copy-override-files

+ (lambda _

+ (when #$override.c

+ (copy-file #$override.c

+ (format #f "src/keyboard/ergodox/layout/~a.c"

+ #$layout)))

+ (when #$override.h

+ (copy-file #$override.h

+ (format #f "src/keyboard/ergodox/layout/~a.h"

+ #$layout)))))

+ ;; The Makefile-based build system lacks configure

+ ;; and install targets.

+ (delete 'configure)

+ (replace 'install

+ (lambda _

+ (with-directory-excursion "output"

+ (install-file "firmware.hex" #$output)

+ (install-file "firmware.eep" #$output)

+ (install-file "firmware--layout.html" #$output)))))))

+ (native-inputs (list (make-avr-toolchain) python))

+ (home-page "https://www.ergodox.io")

+ (synopsis "Firmware for the ErgoDox keyboard")

+ (description (format #f "This package contains the original firmware for

+the ErgoDox keyboard, built using the ~a layout (as defined in the

+@file{src/keyboard/ergodox/layout/~@*~a.c} source file). It contains the

+@file{firmware.hex} and the @file{firmware.eep} files, which can be loaded to

+a target using the @code{teensy-loader-cli} package as well as a

+@file{firmware--layout.html} file, useful to easily visualize the

+corresponding layout." layout))

+ (license license:expat))))

+

+(define make-ergodox-firmware

+ (memoize make-ergodox-firmware/implementation))

+

+(define-public ergodox-firmware-colemak-jc-mod

+ (make-ergodox-firmware "colemak-jc-mod"))

+

+++ b/gnu/packages/patches/ergodox-firmware-fix-json-target.patch

+Submitted upstream:

+<https://github.com/benblazak/ergodox-firmware/pull/99>

+<https://github.com/benblazak/ergodox-firmware/pull/98>

+

+diff --git a/build-scripts/gen-layout.py b/build-scripts/gen-layout.py

+index fd5e54c..251a463 100755

+--- a/build-scripts/gen-layout.py

++++ b/build-scripts/gen-layout.py

+@@ -22,8 +22,10 @@ import sys

+

+ # -----------------------------------------------------------------------------

+

+-class Namespace():

+- pass

++

++class Namespace:

++ pass

++

+

+ template = Namespace()

+ doc = Namespace()

+@@ -31,45 +33,45 @@ info = Namespace()

+

+ # -----------------------------------------------------------------------------

+

++

+ def main():

+- arg_parser = argparse.ArgumentParser(

+- description = "Generate a picture of the firmware's "

+- + "keyboard layout" )

++ arg_parser = argparse.ArgumentParser(

++ description="Generate a picture of the firmware's " + "keyboard layout"

++ )

+

+- arg_parser.add_argument(

+- '--ui-info-file',

+- required = True )

++ arg_parser.add_argument("--ui-info-file", required=True)

+

+- args = arg_parser.parse_args(sys.argv[1:])

++ args = arg_parser.parse_args(sys.argv[1:])

+

+- # constant file paths

+- args.template_svg_file = './build-scripts/gen_layout/template.svg'

+- args.template_js_file = './build-scripts/gen_layout/template.js'

++ # constant file paths

++ args.template_svg_file = "./build-scripts/gen_layout/template.svg"

++ args.template_js_file = "./build-scripts/gen_layout/template.js"

+

+- # normalize paths

+- args.ui_info_file = os.path.abspath(args.ui_info_file)

+- args.template_svg_file = os.path.abspath(args.template_svg_file)

+- args.template_js_file = os.path.abspath(args.template_js_file)

++ # normalize paths

++ args.ui_info_file = os.path.abspath(args.ui_info_file)

++ args.template_svg_file = os.path.abspath(args.template_svg_file)

++ args.template_js_file = os.path.abspath(args.template_js_file)

+

+- # set vars

+- doc.main = '' # to store the html document we're generating

+- template.svg = open(args.template_svg_file).read()

+- template.js = open(args.template_js_file).read()

+- info.all = json.loads(open(args.ui_info_file).read())

++ # set vars

++ doc.main = "" # to store the html document we're generating

++ template.svg = open(args.template_svg_file).read()

++ template.js = open(args.template_js_file).read()

++ info.all = json.loads(open(args.ui_info_file).read())

+

+- info.matrix_positions = info.all['mappings']['matrix-positions']

+- info.matrix_layout = info.all['mappings']['matrix-layout']

++ info.matrix_positions = info.all["mappings"]["matrix-positions"]

++ info.matrix_layout = info.all["mappings"]["matrix-layout"]

+

+- # prefix

+- doc.prefix = ("""

++ # prefix

++ doc.prefix = (

++ """

+ <?xml version="1.0" encoding="UTF-8" standalone="no"?>

+ <html>

+

+ <head>

+ <script>

+ """

+-+ template.js +

+-""" </script>

++ + template.js

++ + """ </script>

+ </head>

+

+ <body>

+@@ -78,9 +80,13 @@ def main():

+

+ <ul>

+ <li>git commit date:

+- <code>""" + info.all['miscellaneous']['git-commit-date'] + """</code></li>

++ <code>"""

++ + info.all["miscellaneous"]["git-commit-date"]

++ + """</code></li>

+ <li>git commit id:

+- <code>""" + info.all['miscellaneous']['git-commit-id'] + """</code></li>

++ <code>"""

++ + info.all["miscellaneous"]["git-commit-id"]

++ + """</code></li>

+ </ul>

+

+ <h2>Notes</h2>

+@@ -123,301 +129,293 @@ def main():

+

+ <br>

+

+-""")[1:-1]

++"""

++ )[1:-1]

+

+- # suffix

+- doc.suffix = ("""

++ # suffix

++ doc.suffix = (

++ """

+ </body>

+ </html>

+

+-""")[1:-1]

+-

+- # substitute into template

+- # -------

+- # note: this is not general enough to handle any possible layout well, at

+- # the moment. but it should handle more standard ones well. (hopefully

+- # minor) modifications may be necessary on a case by case basis

+- # -------

+- layer_number = -1

+- for (layout, layer) in zip( info.matrix_layout,

+- range(len(info.matrix_layout))):

+- layer_number += 1

+- svg = template.svg

+- for (name, (code, press, release)) \

+- in zip(info.matrix_positions, layout):

+- replace = ''

+- if press == 'kbfun_transparent':

+- replace = ''

+- elif press == 'kbfun_shift_press_release':

+- replace = 'sh ' + keycode_to_string.get(code, '[n/a]')

+- elif press == 'kbfun_jump_to_bootloader':

+- replace = '[btldr]'

+- elif press == 'NULL' and release == 'NULL':

+- replace = '(null)'

+- elif re.search(r'numpad', press+release):

+- replace = '[num]'

+- elif re.search(r'layer', press+release):

+- replace = 'la ' + re.findall(r'\d+', press+release)[0] + ' '

+- if re.search(r'push', press+release):

+- replace += '+'

+- if re.search(r'pop', press+release):

+- replace += '-'

+- replace += ' ' + str(code)

+- else:

+- replace = keycode_to_string.get(code, '[n/a]')

+-

+- svg = re.sub(

+- '>'+name+'<', '>'+replace+'<', svg )

+- svg = re.sub(

+- r"\('(" + name + r".*)'\)",

+- r"('\1', " + str(layer) + r")",

+- svg )

+-

+- doc.main += '<h2>Layer ' + str(layer_number) + '</h2>\n' + svg

+-

+- # change the font size

+- doc.main = re.sub(r'22.5px', '15px', doc.main)

+-

+- print(doc.prefix + doc.main + doc.suffix)

++"""

++ )[1:-1]

++

++ # substitute into template

++ # -------

++ # note: this is not general enough to handle any possible layout well, at

++ # the moment. but it should handle more standard ones well. (hopefully

++ # minor) modifications may be necessary on a case by case basis

++ # -------

++ layer_number = -1

++ for (layout, layer) in zip(

++ info.matrix_layout, range(len(info.matrix_layout))

++ ):

++ layer_number += 1

++ svg = template.svg

++ for (name, (code, press, release)) in zip(

++ info.matrix_positions, layout

++ ):

++ replace = ""

++ if press == "kbfun_transparent":

++ replace = ""

++ elif press == "kbfun_shift_press_release":

++ replace = "sh " + keycode_to_string.get(code, "[n/a]")

++ elif press == "kbfun_jump_to_bootloader":

++ replace = "[btldr]"

++ elif press == "NULL" and release == "NULL":

++ replace = "(null)"

++ elif re.search(r"numpad", press + release):

++ replace = "[num]"

++ elif re.search(r"layer", press + release):

++ replace = "la " + re.findall(r"\d+", press + release)[0] + " "

++ if re.search(r"push", press + release):

++ replace += "+"

++ if re.search(r"pop", press + release):

++ replace += "-"

++ replace += " " + str(code)

++ else:

++ replace = keycode_to_string.get(code, "[n/a]")

++

++ svg = re.sub(">" + name + "<", ">" + replace + "<", svg)

++ svg = re.sub(

++ r"\('(" + name + r".*)'\)", r"('\1', " + str(layer) + r")", svg

++ )

++

++ doc.main += "<h2>Layer " + str(layer_number) + "</h2>\n" + svg

++

++ # change the font size

++ doc.main = re.sub(r"22.5px", "15px", doc.main)

++

++ print(doc.prefix + doc.main + doc.suffix)

++

+

+ # -----------------------------------------------------------------------------

+ # -----------------------------------------------------------------------------

+

+ keycode_to_string = {

+- 0x01: "Error", # ErrorRollOver

+- 0x02: "POSTFail",

+- 0x03: "Error", # ErrorUndefined

+- 0x04: "a A",

+- 0x05: "b B",

+- 0x06: "c C",

+- 0x07: "d D",

+- 0x08: "e E",

+- 0x09: "f F",

+- 0x0A: "g G",

+- 0x0B: "h H",

+- 0x0C: "i I",

+- 0x0D: "j J",

+- 0x0E: "k K",

+- 0x0F: "l L",

+- 0x10: "m M",

+- 0x11: "n N",

+- 0x12: "o O",

+- 0x13: "p P",

+- 0x14: "q Q",

+- 0x15: "r R",

+- 0x16: "s S",

+- 0x17: "t T",

+- 0x18: "u U",

+- 0x19: "v V",

+- 0x1A: "w W",

+- 0x1B: "x X",

+- 0x1C: "y Y",

+- 0x1D: "z Z",

+- 0x1E: "1 !",

+- 0x1F: "2 @",

+- 0x20: "3 #",

+- 0x21: "4 $",

+- 0x22: "5 %",

+- 0x23: "6 ^",

+- 0x24: "7 &",

+- 0x25: "8 *",

+- 0x26: "9 (",

+- 0x27: "0 )",

+- 0x28: "Return",

+- 0x29: "Esc",

+- 0x2A: "Backspace",

+- 0x2B: "Tab",

+- 0x2C: "Space",

+- 0x2D: "- _",

+- 0x2E: "= +",

+- 0x2F: "[ {",

+- 0x30: "] }",

+- 0x31: "\ |",

+- 0x32: "# ~",

+- 0x33: "; :",

+- 0x34: "\' \"",

+- 0x35: "` ~",

+- 0x36: ", <",

+- 0x37: ". >",

+- 0x38: "/ ?",

+- 0x39: "Caps",

+- 0x3A: "F1",

+- 0x3B: "F2",

+- 0x3C: "F3",

+- 0x3D: "F4",

+- 0x3E: "F5",

+- 0x3F: "F6",

+- 0x40: "F7",

+- 0x41: "F8",

+- 0x42: "F9",

+- 0x43: "F10",

+- 0x44: "F11",

+- 0x45: "F12",

+- 0x46: "PrintScreen",

+- 0x47: "ScrollLock",

+- 0x48: "Pause",

+- 0x49: "Ins", # Insert

+- 0x4A: "Hm", # Home

+- 0x4B: "Pg\u2191", # up arrow

+- 0x4C: "Delete",

+- 0x4D: "End",

+- 0x4E: "Pg\u2193", # down arrow

+- 0x4F: "\u2192", # right arrow

+- 0x50: "\u2190", # left arrow

+- 0x51: "\u2193", # down arrow

+- 0x52: "\u2191", # up arrow

+-

+- 0x53: "Num",

+- 0x54: "/",

+- 0x55: "*",

+- 0x56: "-",

+- 0x57: "+",

+- 0x58: "Enter",

+- 0x59: "1 End",

+- 0x5A: "2 \u2193", # down arrow

+- 0x5B: "3 Pg\u2193", # down arrow

+- 0x5C: "4 \u2190", # left arrow

+- 0x5D: "5",

+- 0x5E: "6 \u2192", # right arrow

+- 0x5F: "7 Hm", # Home

+- 0x60: "8 \u2191", # up arrow

+- 0x61: "9 Pg\u2191", # up arrow

+- 0x62: "0 Ins", # Insert

+- 0x63: ". Del",

+-

+- 0x64: "\ |",

+- 0x65: "App",

+- 0x66: "Power",

+-

+- 0x67: "=",

+-

+- 0x68: "F13",

+- 0x69: "F14",

+- 0x6A: "F15",

+- 0x6B: "F16",

+- 0x6C: "F17",

+- 0x6D: "F18",

+- 0x6E: "F19",

+- 0x6F: "F20",

+- 0x70: "F21",

+- 0x71: "F22",

+- 0x72: "F23",

+- 0x73: "F24",

+- 0x74: "Exec",

+- 0x75: "Help",

+- 0x76: "Menu",

+- 0x77: "Select",

+- 0x78: "Stop",

+- 0x79: "Again",

+- 0x7A: "Undo",

+- 0x7B: "Cut",

+- 0x7C: "Copy",

+- 0x7D: "Paste",

+- 0x7E: "Find",

+- 0x7F: "Mute",

+- 0x80: "VolUp",

+- 0x81: "VolDown",

+- 0x82: "LockingCapsLock",

+- 0x83: "LockingNumLock",

+- 0x84: "LockingScrollLock",

+-

+- 0x85: ",",

+- 0x86: "=",

+-

+- 0x87: "Int1",

+- 0x88: "Int2",

+- 0x89: "Int3",

+- 0x8A: "Int4",

+- 0x8B: "Int5",

+- 0x8C: "Int6",

+- 0x8D: "Int7",

+- 0x8E: "Int8",

+- 0x8F: "Int9",

+- 0x90: "LANG1",

+- 0x91: "LANG2",

+- 0x92: "LANG3",

+- 0x93: "LANG4",

+- 0x94: "LANG5",

+- 0x95: "LANG6",

+- 0x96: "LANG7",

+- 0x97: "LANG8",

+- 0x98: "LANG9",

+- 0x99: "AlternateErase",

+- 0x9A: "SysReq_Attention",

+- 0x9B: "Cancel",

+- 0x9C: "Clear",

+- 0x9D: "Prior",

+- 0x9E: "Return",

+- 0x9F: "Separator",

+- 0xA0: "Out",

+- 0xA1: "Oper",

+- 0xA2: "Clear_Again",

+- 0xA3: "CrSel_Props",

+- 0xA4: "ExSel",

+-

+- 0xB0: "00",

+- 0xB1: "000",

+-

+- 0xB2: "Thousands_Sep",

+- 0xB3: "Decimal_Sep",

+- 0xB4: "$",

+- 0xB5: "Currency_Subunit",

+-

+- 0xB6: "(",

+- 0xB7: ")",

+- 0xB8: "{",

+- 0xB9: "}",

+-

+- 0xBA: "Tab",

+- 0xBB: "Backspace",

+- 0xBC: "A",

+- 0xBD: "B",

+- 0xBE: "C",

+- 0xBF: "D",

+- 0xC0: "E",

+- 0xC1: "F",

+- 0xC2: "XOR",

+- 0xC3: "^",

+- 0xC4: "%",

+- 0xC5: "<",

+- 0xC6: ">",

+- 0xC7: "&",

+- 0xC8: "&&",

+- 0xC9: "|",

+- 0xCA: "||",

+- 0xCB: ":",

+- 0xCC: "#",

+- 0xCD: "Space",

+- 0xCE: "@",

+- 0xCF: "!",

+- 0xD0: "Mem_Store",

+- 0xD1: "Mem_Recall",

+- 0xD2: "Mem_Clear",

+- 0xD3: "Mem_+",

+- 0xD4: "Mem_-",

+- 0xD5: "Mem_*",

+- 0xD6: "Mem_/",

+- 0xD7: "+-",

+- 0xD8: "Clear",

+- 0xD9: "ClearEntry",

+- 0xDA: "Binary",

+- 0xDB: "Octal",

+- 0xDC: ".",

+- 0xDD: "Hexadecimal",

+-

+- 0xE0: "L-Ctrl",

+- 0xE1: "L-Shift",

+- 0xE2: "L-Alt",

+- 0xE3: "L-GUI",

+- 0xE4: "R-Ctrl",

+- 0xE5: "R-Shift",

+- 0xE6: "R-Alt",

+- 0xE7: "R-GUI",

+- }

++ 0x01: "Error", # ErrorRollOver

++ 0x02: "POSTFail",

++ 0x03: "Error", # ErrorUndefined

++ 0x04: "a A",

++ 0x05: "b B",

++ 0x06: "c C",

++ 0x07: "d D",

++ 0x08: "e E",

++ 0x09: "f F",

++ 0x0A: "g G",

++ 0x0B: "h H",

++ 0x0C: "i I",

++ 0x0D: "j J",

++ 0x0E: "k K",

++ 0x0F: "l L",

++ 0x10: "m M",

++ 0x11: "n N",

++ 0x12: "o O",

++ 0x13: "p P",

++ 0x14: "q Q",

++ 0x15: "r R",

++ 0x16: "s S",

++ 0x17: "t T",

++ 0x18: "u U",

++ 0x19: "v V",

++ 0x1A: "w W",

++ 0x1B: "x X",

++ 0x1C: "y Y",

++ 0x1D: "z Z",

++ 0x1E: "1 !",

++ 0x1F: "2 @",

++ 0x20: "3 #",

++ 0x21: "4 $",

++ 0x22: "5 %",

++ 0x23: "6 ^",

++ 0x24: "7 &",

++ 0x25: "8 *",

++ 0x26: "9 (",

++ 0x27: "0 )",

++ 0x28: "Return",

++ 0x29: "Esc",

++ 0x2A: "Backspace",

++ 0x2B: "Tab",

++ 0x2C: "Space",

++ 0x2D: "- _",

++ 0x2E: "= +",

++ 0x2F: "[ {",

++ 0x30: "] }",

++ 0x31: "\ |",

++ 0x32: "# ~",

++ 0x33: "; :",

++ 0x34: "' \"",

++ 0x35: "` ~",

++ 0x36: ", <",

++ 0x37: ". >",

++ 0x38: "/ ?",

++ 0x39: "Caps",

++ 0x3A: "F1",

++ 0x3B: "F2",

++ 0x3C: "F3",

++ 0x3D: "F4",

++ 0x3E: "F5",

++ 0x3F: "F6",

++ 0x40: "F7",

++ 0x41: "F8",

++ 0x42: "F9",

++ 0x43: "F10",

++ 0x44: "F11",

++ 0x45: "F12",

++ 0x46: "PrintScreen",

++ 0x47: "ScrollLock",

++ 0x48: "Pause",

++ 0x49: "Ins", # Insert

++ 0x4A: "Hm", # Home

++ 0x4B: "Pg\u2191", # up arrow

++ 0x4C: "Delete",

++ 0x4D: "End",

++ 0x4E: "Pg\u2193", # down arrow

++ 0x4F: "\u2192", # right arrow

++ 0x50: "\u2190", # left arrow

++ 0x51: "\u2193", # down arrow

++ 0x52: "\u2191", # up arrow

++ 0x53: "Num",

++ 0x54: "/",

++ 0x55: "*",

++ 0x56: "-",

++ 0x57: "+",

++ 0x58: "Enter",

++ 0x59: "1 End",

++ 0x5A: "2 \u2193", # down arrow

++ 0x5B: "3 Pg\u2193", # down arrow

++ 0x5C: "4 \u2190", # left arrow

++ 0x5D: "5",

++ 0x5E: "6 \u2192", # right arrow

++ 0x5F: "7 Hm", # Home

++ 0x60: "8 \u2191", # up arrow

++ 0x61: "9 Pg\u2191", # up arrow

++ 0x62: "0 Ins", # Insert

++ 0x63: ". Del",

++ 0x64: "\ |",

++ 0x65: "App",

++ 0x66: "Power",

++ 0x67: "=",

++ 0x68: "F13",

++ 0x69: "F14",

++ 0x6A: "F15",

++ 0x6B: "F16",

++ 0x6C: "F17",

++ 0x6D: "F18",

++ 0x6E: "F19",

++ 0x6F: "F20",

++ 0x70: "F21",

++ 0x71: "F22",

++ 0x72: "F23",

++ 0x73: "F24",

++ 0x74: "Exec",

++ 0x75: "Help",

++ 0x76: "Menu",

++ 0x77: "Select",

++ 0x78: "Stop",

++ 0x79: "Again",

++ 0x7A: "

+++ b/gnu/packages/firmware.scm

+(define-public ergodox-firmware-qwerty-kinesis-mod

+ (make-ergodox-firmware "qwerty-kinesis-mod"))

+

+++ b/gnu/packages/firmware.scm

+(define-public ergodox-firmware-workman-p-kinesis-mod

+ (make-ergodox-firmware "workman-p-kinesis-mod"))

+

+++ b/gnu/packages/flashing-tools.scm

+ (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")))))))

+++ b/gnu/packages/flashing-tools.scm

+ (license license:gpl3+)))

+++ b/gnu/packages/flashing-tools.scm

+;;; Copyright © 2023 Maxim Cournoyer <maxim.cournoyer@gmail.com>

+ #:use-module (guix build-system copy)

+ #:use-module (gnu packages tls)

+ #:use-module (srfi srfi-26))

+(define-public teensy-udev-rules

+ (package

+ (name "teensy-udev-rules")

+ (version "2023-09-13") ;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))))

+