Migrate make_dfu_header to CLI (#12061)

* Migrate make_dfu_header to CLI

* lint fixes

* Update lib/python/qmk/cli/generate/dfu_header.py

Co-authored-by: Ryan <fauxpark@gmail.com>

* Rename object

Co-authored-by: Ryan <fauxpark@gmail.com>

data/mappings/info_config.json

@@ -38,5 +38,9 @@
     "RGBLIGHT_SPLIT": {"info_key": "rgblight.split", "value_type": "bool"},
     "PRODUCT": {"info_key": "keyboard_folder", "to_json": false},
     "PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex"},
-    "VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex"}
+    "VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex"},
+    "QMK_ESC_OUTPUT": {"info_key": "qmk_lufa_bootloader.esc_output"},
+    "QMK_ESC_INPUT": {"info_key": "qmk_lufa_bootloader.esc_input"},
+    "QMK_LED": {"info_key": "qmk_lufa_bootloader.led"},
+    "QMK_SPEAKER": {"info_key": "qmk_lufa_bootloader.speaker"}
 }

data/schemas/keyboard.jsonschema

@@ -299,6 +299,28 @@
                     "pattern": "^[0-9A-F]x[0-9A-F][0-9A-F][0-9A-F][0-9A-F]"
                 }
             }
+        },
+        "qmk_lufa_bootloader": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "esc_output": {
+                    "type": "string",
+                    "pattern": "^[A-K]\\d{1,2}$"
+                },
+                "esc_input": {
+                    "type": "string",
+                    "pattern": "^[A-K]\\d{1,2}$"
+                },
+                "led": {
+                    "type": "string",
+                    "pattern": "^[A-K]\\d{1,2}$"
+                },
+                "speaker": {
+                    "type": "string",
+                    "pattern": "^[A-K]\\d{1,2}$"
+                }
+            }
         }
     }
 }

lib/python/qmk/cli/generate/__init__.py

@@ -1,5 +1,6 @@
 from . import api
 from . import config_h
+from . import dfu_header
 from . import docs
 from . import info_json
 from . import layouts

lib/python/qmk/cli/generate/dfu_header.py

@@ -0,0 +1,59 @@
+"""Used by the make system to generate LUFA Keyboard.h from info.json
+"""
+from dotty_dict import dotty
+from milc import cli
+
+from qmk.decorators import automagic_keyboard
+from qmk.info import info_json
+from qmk.path import is_keyboard, normpath
+
+
+@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
+@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
+@cli.argument('-kb', '--keyboard', help='Keyboard to generate LUFA Keyboard.h for.')
+@cli.subcommand('Used by the make system to generate LUFA Keyboard.h from info.json', hidden=True)
+@automagic_keyboard
+def generate_dfu_header(cli):
+    """Generates the Keyboard.h file.
+    """
+    # Determine our keyboard(s)
+    if not cli.config.generate_dfu_header.keyboard:
+        cli.log.error('Missing parameter: --keyboard')
+        cli.subcommands['info'].print_help()
+        return False
+
+    if not is_keyboard(cli.config.generate_dfu_header.keyboard):
+        cli.log.error('Invalid keyboard: "%s"', cli.config.generate_dfu_header.keyboard)
+        return False
+
+    # Build the Keyboard.h file.
+    kb_info_json = dotty(info_json(cli.config.generate_dfu_header.keyboard))
+
+    keyboard_h_lines = ['/* This file was generated by `qmk generate-dfu-header`. Do not edit or copy.' ' */', '', '#pragma once']
+    keyboard_h_lines.append(f'#define MANUFACTURER {kb_info_json["manufacturer"]}')
+    keyboard_h_lines.append(f'#define PRODUCT {cli.config.generate_dfu_header.keyboard} Bootloader')
+
+    # Optional
+    if 'qmk_lufa_bootloader.esc_output' in kb_info_json:
+        keyboard_h_lines.append(f'#define QMK_ESC_OUTPUT {kb_info_json["qmk_lufa_bootloader.esc_output"]}')
+    if 'qmk_lufa_bootloader.esc_input' in kb_info_json:
+        keyboard_h_lines.append(f'#define QMK_ESC_INPUT {kb_info_json["qmk_lufa_bootloader.esc_input"]}')
+    if 'qmk_lufa_bootloader.led' in kb_info_json:
+        keyboard_h_lines.append(f'#define QMK_LED {kb_info_json["qmk_lufa_bootloader.led"]}')
+    if 'qmk_lufa_bootloader.speaker' in kb_info_json:
+        keyboard_h_lines.append(f'#define QMK_SPEAKER {kb_info_json["qmk_lufa_bootloader.speaker"]}')
+
+    # Show the results
+    keyboard_h = '\n'.join(keyboard_h_lines)
+
+    if cli.args.output:
+        cli.args.output.parent.mkdir(parents=True, exist_ok=True)
+        if cli.args.output.exists():
+            cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
+        cli.args.output.write_text(keyboard_h)
+
+        if not cli.args.quiet:
+            cli.log.info('Wrote Keyboard.h to %s.', cli.args.output)
+
+    else:
+        print(keyboard_h)

tmk_core/avr.mk

@@ -284,7 +284,7 @@ extcoff: $(BUILD_DIR)/$(TARGET).elf
 
 bootloader:
 	make -C lib/lufa/Bootloaders/DFU/ clean
-	$(TMK_DIR)/make_dfu_header.sh $(ALL_CONFIGS)
+	bin/qmk generate-dfu-header --quiet --keyboard $(KEYBOARD) --output lib/lufa/Bootloaders/DFU/Keyboard.h
 	$(eval MAX_SIZE=$(shell n=`$(CC) -E -mmcu=$(MCU) $(CFLAGS) $(OPT_DEFS) tmk_core/common/avr/bootloader_size.c 2> /dev/null | sed -ne 's/\r//;/^#/n;/^AVR_SIZE:/,$${s/^AVR_SIZE: //;p;}'` && echo $$(($$n)) || echo 0))
 	$(eval PROGRAM_SIZE_KB=$(shell n=`expr $(MAX_SIZE) / 1024` && echo $$(($$n)) || echo 0))
 	$(eval BOOT_SECTION_SIZE_KB=$(shell n=`expr  $(BOOTLOADER_SIZE) / 1024` && echo $$(($$n)) || echo 0))

tmk_core/make_dfu_header.sh

@@ -1,14 +0,0 @@
-#!/bin/sh
-ALL_CONFIGS=$*
-GREP="grep"
-
-cat <<- EOF > lib/lufa/Bootloaders/DFU/Keyboard.h
-#pragma once
-
-$($GREP "MANUFACTURER[ \t]" $ALL_CONFIGS -h | tail -1)
-$($GREP "PRODUCT[ \t]" $ALL_CONFIGS -h | tail -1 | tr -d '\r') Bootloader
-$($GREP "QMK_ESC_OUTPUT[ \t]" $ALL_CONFIGS -h | tail -1)
-$($GREP "QMK_ESC_INPUT[ \t]" $ALL_CONFIGS -h | tail -1)
-$($GREP "QMK_LED[ \t]" $ALL_CONFIGS -h | tail -1)
-$($GREP "QMK_SPEAKER[ \t]" $ALL_CONFIGS -h | tail -1)
-EOF