Add Kiibohd bootloader type to bootloader.mk (#9908)

2025-10-31 05:12:33 +01:00 · 2020-08-12 12:28:20 +10:00 · 2020-08-12 12:28:20 +10:00 · e2d4cd1a41
commit e2d4cd1a41
parent 98e1e18f6b
11 changed files with 25 additions and 71 deletions
--- a/bootloader.mk
+++ b/bootloader.mk
@ -27,6 +27,7 @@
 # qmk-dfu        QMK DFU (LUFA + blinkenlight)
 # bootloadHID    HIDBootFlash compatible (ATmega32A)
 # USBasp         USBaspLoader (ATmega328P)
+# kiibohd        Input:Club Kiibohd bootloader (only used on their boards)
 #
 # BOOTLOADER_SIZE can still be defined manually, but it's recommended
 # you add any possible configuration to this list
@ -89,6 +90,18 @@ ifeq ($(strip $(BOOTLOADER)), lufa-ms)
    BOOTLOADER_SIZE = 6144
    FIRMWARE_FORMAT = bin
 endif
+ifeq ($(strip $(BOOTLOADER)), kiibohd)
+    OPT_DEFS += -DBOOTLOADER_KIIBOHD
+    ifeq ($(strip $(MCU)), MK20DX128)
+        MCU_LDSCRIPT = MK20DX128BLDR4
+    endif
+    ifeq ($(strip $(MCU)), MK20DX256)
+        MCU_LDSCRIPT = MK20DX256BLDR8
+    endif
+
+    DFU_ARGS = -d 1C11:B007
+    DFU_SUFFIX_ARGS = -v 1C11 -p B007
+endif

 ifdef BOOTLOADER_SIZE
    OPT_DEFS += -DBOOTLOADER_SIZE=$(strip $(BOOTLOADER_SIZE))
--- a/keyboards/ergodox_infinity/bootloader_defs.h
+++ b/keyboards/ergodox_infinity/bootloader_defs.h
@ -1 +0,0 @@
-#define KIIBOHD_BOOTLOADER
--- a/keyboards/ergodox_infinity/rules.mk
+++ b/keyboards/ergodox_infinity/rules.mk
@ -1,32 +1,18 @@
 # MCU name
 MCU = MK20DX256

-# Linker script to use
-# - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
-#   or <this_dir>/ld/
-# - NOTE: a custom ld script is needed for EEPROM on Teensy LC
-# - LDSCRIPT =
-#   - MKL26Z64 for Teensy LC
-#   - MK20DX128 for Teensy 3.0
-#   - MK20DX256 for Teensy 3.1 and 3.2
-#   - MK20DX128BLDR4 for Infinity 60% with Kiibohd bootloader
-#   - MK20DX256BLDR8 for Infinity ErgoDox with Kiibohd bootloader
-MCU_LDSCRIPT = MK20DX256BLDR8
-
 # Vector table for application
 # 0x00000000-0x00001000 area is occupied by bootlaoder.*/
 # The CORTEX_VTOR... is needed only for MCHCK/Infinity KB
 OPT_DEFS += -DCORTEX_VTOR_INIT=0x00002000

-BOOTLOADER = dfu
+# Bootloader selection
+BOOTLOADER = kiibohd

 # Build Options
 #   comment out to disable the options.
 #

-DFU_ARGS = -d 1c11:b007
-DFU_SUFFIX_ARGS = -p b007 -v 1c11
-
 BOOTMAGIC_ENABLE = no  # Virtual DIP switch configuration
 MOUSEKEY_ENABLE  = yes # Mouse keys
 EXTRAKEY_ENABLE  = yes # Audio control and System control
--- a/keyboards/infinity60/bootloader_defs.h
+++ b/keyboards/infinity60/bootloader_defs.h
@ -1 +0,0 @@
-#define KIIBOHD_BOOTLOADER
--- a/keyboards/infinity60/rules.mk
+++ b/keyboards/infinity60/rules.mk
@ -1,17 +1,6 @@
 # MCU name
 MCU = MK20DX128

-# Linker script to use
-# - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
-#   or <this_dir>/ld/
-# - NOTE: a custom ld script is needed for EEPROM on Teensy LC
-# - LDSCRIPT =
-#   - MKL26Z64 for Teensy LC
-#   - MK20DX128 for Teensy 3.0
-#   - MK20DX256 for Teensy 3.1 and 3.2
-#   - MK20DX128BLDR4 for Infinity with Kiibohd bootloader
-MCU_LDSCRIPT = MK20DX128BLDR4
-
 # Board: it should exist either in <chibios>/os/hal/boards/
 #  or <this_dir>/boards
 # - BOARD =
@ -26,15 +15,13 @@ BOARD = MCHCK_K20
 # The CORTEX_VTOR... is needed only for MCHCK/Infinity KB
 OPT_DEFS = -DCORTEX_VTOR_INIT=0x00001000

-BOOTLOADER = dfu
+# Bootloader selection
+BOOTLOADER = kiibohd

 # Build Options
 #   comment out to disable the options.
 #

-DFU_ARGS = -d 1c11:b007
-DFU_SUFFIX_ARGS = -p b007 -v 1c11
-
 BOOTMAGIC_ENABLE = no	# Virtual DIP switch configuration
 ## (Note that for BOOTMAGIC on Teensy LC you have to use a custom .ld script.)
 MOUSEKEY_ENABLE = yes	# Mouse keys
--- a/keyboards/k_type/bootloader_defs.h
+++ b/keyboards/k_type/bootloader_defs.h
@ -1 +0,0 @@
-#define KIIBOHD_BOOTLOADER
--- a/keyboards/k_type/rules.mk
+++ b/keyboards/k_type/rules.mk
@ -1,28 +1,14 @@
 # MCU name
 MCU = MK20DX256

-# Linker script to use
-# - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
-#   or <this_dir>/ld/
-# - NOTE: a custom ld script is needed for EEPROM on Teensy LC
-# - LDSCRIPT =
-#   - MKL26Z64 for Teensy LC
-#   - MK20DX128 for Teensy 3.0
-#   - MK20DX256 for Teensy 3.1 and 3.2
-#   - MK20DX128BLDR4 for Infinity with Kiibohd bootloader
-#   - MK20DX256BLDR8 for Infinity ErgoDox with Kiibohd bootloader
-MCU_LDSCRIPT = MK20DX256BLDR8
-
 # Board: it should exist either in <chibios>/os/hal/boards/
 #  or <this_dir>/boards
 # This board was copied from PJRC_TEENSY_3_1. The only difference should be a
 # hack to ensure the watchdog has started before trying to disable it.
 BOARD = IC_TEENSY_3_1

-DFU_ARGS = -d 1c11:b007
-DFU_SUFFIX_ARGS = -p b007 -v 1c11
-
-BOOTLOADER = dfu
+# Bootloader selection
+BOOTLOADER = kiibohd

 # Build Options
 #   comment out to disable the options.
--- a/keyboards/whitefox/bootloader_defs.h
+++ b/keyboards/whitefox/bootloader_defs.h
@ -1 +0,0 @@
-#define KIIBOHD_BOOTLOADER
--- a/keyboards/whitefox/rules.mk
+++ b/keyboards/whitefox/rules.mk
@ -1,18 +1,6 @@
 # MCU name
 MCU = MK20DX256

-# Linker script to use
-# - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
-#   or <this_dir>/ld/
-# - NOTE: a custom ld script is needed for EEPROM on Teensy LC
-# - LDSCRIPT =
-#   - MKL26Z64 for Teensy LC
-#   - MK20DX128 for Teensy 3.0
-#   - MK20DX256 for Teensy 3.1 and 3.2
-#   - MK20DX128BLDR4 for Infinity with Kiibohd bootloader
-#   - MK20DX256BLDR8 for Infinity ErgoDox with Kiibohd bootloader
-MCU_LDSCRIPT = MK20DX256BLDR8
-
 # Board: it should exist either in <chibios>/os/hal/boards/
 #  or <this_dir>/boards
 # - BOARD =
@ -22,10 +10,8 @@ MCU_LDSCRIPT = MK20DX256BLDR8
 #   - MCHCK_K20 for Infinity KB
 BOARD = IC_TEENSY_3_1

-DFU_ARGS = -d 1c11:b007
-DFU_SUFFIX_ARGS = -p b007 -v 1c11
-
-BOOTLOADER = dfu
+# Bootloader selection
+BOOTLOADER = kiibohd

 # Build Options
 #   comment out to disable the options.
--- a/tmk_core/chibios.mk
+++ b/tmk_core/chibios.mk
@ -324,7 +324,7 @@ bin: $(BUILD_DIR)/$(TARGET).bin sizeafter
 flash: $(BUILD_DIR)/$(TARGET).bin cpfirmware sizeafter
 ifneq ($(strip $(PROGRAM_CMD)),)
 	$(PROGRAM_CMD)
-else ifeq ($(strip $(BOOTLOADER)),dfu)
+else ifeq ($(strip $(BOOTLOADER)),kiibohd)
 	$(call EXEC_DFU_UTIL)
 else ifeq ($(strip $(MCU_FAMILY)),KINETIS)
 	$(call EXEC_TEENSY)
--- a/tmk_core/common/chibios/bootloader.c
+++ b/tmk_core/common/chibios/bootloader.c
@ -44,7 +44,7 @@ void enter_bootloader_mode_if_requested(void) {
 #elif defined(KL2x) || defined(K20x) /* STM32_BOOTLOADER_ADDRESS */
 /* Kinetis */

-#    if defined(KIIBOHD_BOOTLOADER)
+#    if defined(BOOTLOADER_KIIBOHD)
 /* Kiibohd Bootloader (MCHCK and Infinity KB) */
 #        define SCB_AIRCR_VECTKEY_WRITEMAGIC 0x05FA0000
 const uint8_t sys_reset_to_loader_magic[] = "\xff\x00\x7fRESET TO LOADER\x7f\x00\xff";
@ -54,14 +54,14 @@ void          bootloader_jump(void) {
    SCB->AIRCR = SCB_AIRCR_VECTKEY_WRITEMAGIC | SCB_AIRCR_SYSRESETREQ_Msk;
 }

-#    else /* defined(KIIBOHD_BOOTLOADER) */
+#    else /* defined(BOOTLOADER_KIIBOHD) */
 /* Default for Kinetis - expecting an ARM Teensy */
 #        include "wait.h"
 void bootloader_jump(void) {
    wait_ms(100);
    __BKPT(0);
 }
-#    endif /* defined(KIIBOHD_BOOTLOADER) */
+#    endif /* defined(BOOTLOADER_KIIBOHD) */

 #else /* neither STM32 nor KINETIS */
 __attribute__((weak)) void bootloader_jump(void) {}