Add ZMK_BOARD_COMPAT symbol, that we can enable for our ZMK variants (#3265)

feat: Add ZMK_BOARD_COMPAT Kconfig symbol, and check for it To properly detect users selecting a base board ID, when a ZMK variant is available, add a ZMK_BOARD_COMPAT Kconfig symbol that the ZMK variants will enable, allowing us to detect using the bare varand and warn/error in CI so users don't end up with passing CI that results in an unusable firmware due to missing ZMK enablement for keyboard name, settings storage, etc. refactor(boards): Add ZMK_BOARD_COMPAT to ZMK board variants To clearly indicate the ZMK board variants are set up for ZMK usage, select the ZMK_BOARD_COMPAT symbols for them. fix(boards): Fix pillbug board.yml to report extension Properly not the ZMK variant is part of an extension of the existing pillbug board.
2026-03-19 20:45:18 -05:00 · 2026-03-03 08:39:11 -07:00
parent 2a9ac3ba7f
commit a23aa009d7
39 changed files with 155 additions and 12 deletions
--- a/app/boards/adafruit/kb2040/Kconfig.adafruit_kb2040
+++ b/app/boards/adafruit/kb2040/Kconfig.adafruit_kb2040
@@ -0,0 +1,9 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_ADAFRUIT_KB2040
+    select ZMK_BOARD_COMPAT if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
+    imply RETAINED_MEM if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
+    imply RETENTION if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
+
--- a/app/boards/adafruit/qt_py_rp2040/Kconfig.adafruit_qt_py_rp2040
+++ b/app/boards/adafruit/qt_py_rp2040/Kconfig.adafruit_qt_py_rp2040
@@ -0,0 +1,9 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_ADAFRUIT_QT_PY_RP2040
+    select ZMK_BOARD_COMPAT if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
+    imply RETAINED_MEM if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
+    imply RETENTION if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
+
--- a/app/boards/boardsource/blok/Kconfig.boardsource_blok
+++ b/app/boards/boardsource/blok/Kconfig.boardsource_blok
@@ -0,0 +1,9 @@
+# Copyright (c) 2026 Pete Johanson
+# SPDX-License-Identifier: MIT
+
+config BOARD_BOARDSOURCE_BLOK
+    select ZMK_BOARD_COMPAT if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
+    imply RETAINED_MEM if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
+    imply RETENTION if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
+
--- a/app/boards/joric/nrfmicro/Kconfig.nrfmicro
+++ b/app/boards/joric/nrfmicro/Kconfig.nrfmicro
@@ -7,6 +7,7 @@ config BOARD_NRFMICRO
    select SOC_NRF52840_QIAA if BOARD_NRFMICRO_NRF52840_ZMK
    select SOC_NRF52840_QIAA if BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK
    select SOC_NRF52833_QIAA if BOARD_NRFMICRO_NRF52833_ZMK
+    select ZMK_BOARD_COMPAT if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
    imply RETAINED_MEM if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
    imply RETENTION if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
    imply RETENTION_BOOT_MODE if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
--- a/app/boards/jpconstantineau/bluemicro840/Kconfig.bluemicro840
+++ b/app/boards/jpconstantineau/bluemicro840/Kconfig.bluemicro840
@@ -3,6 +3,7 @@

 config BOARD_BLUEMICRO840
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_BLUEMICRO840_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_BLUEMICRO840_NRF52840_ZMK
    imply RETENTION if BOARD_BLUEMICRO840_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_BLUEMICRO840_NRF52840_ZMK
--- a/app/boards/kbdfans/tofu65/Kconfig.tofu65
+++ b/app/boards/kbdfans/tofu65/Kconfig.tofu65
@@ -3,6 +3,7 @@

 config BOARD_TOFU65
    select SOC_RP2040
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/keebio/bdn9/Kconfig.bdn9
+++ b/app/boards/keebio/bdn9/Kconfig.bdn9
@@ -3,3 +3,4 @@

 config BOARD_BDN9
    select SOC_STM32F072XB
+    select ZMK_BOARD_COMPAT
--- a/app/boards/keycapsss/puchi_ble/Kconfig.puchi_ble
+++ b/app/boards/keycapsss/puchi_ble/Kconfig.puchi_ble
@@ -5,6 +5,7 @@

 config BOARD_PUCHI_BLE
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_PUCHI_BLE_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_PUCHI_BLE_NRF52840_ZMK
    imply RETENTION if BOARD_PUCHI_BLE_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_PUCHI_BLE_NRF52840_ZMK
--- a/app/boards/kinesis/adv360pro/Kconfig.adv360pro_left
+++ b/app/boards/kinesis/adv360pro/Kconfig.adv360pro_left
@@ -5,6 +5,7 @@

 config BOARD_ADV360PRO_LEFT
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
-    imply RETENTION_BOOT_MODE
+    imply RETENTION_BOOT_MODE
--- a/app/boards/kinesis/adv360pro/Kconfig.adv360pro_right
+++ b/app/boards/kinesis/adv360pro/Kconfig.adv360pro_right
@@ -5,6 +5,7 @@

 config BOARD_ADV360PRO_RIGHT
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
-    imply RETENTION_BOOT_MODE
+    imply RETENTION_BOOT_MODE
--- a/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_left
+++ b/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_left
@@ -5,6 +5,7 @@

 config BOARD_CORNEISH_ZEN_LEFT
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_right
+++ b/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_right
@@ -5,6 +5,7 @@

 config BOARD_CORNEISH_ZEN_RIGHT
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/makerdiary/nrf52840_m2/Kconfig.nrf52840_m2
+++ b/app/boards/makerdiary/nrf52840_m2/Kconfig.nrf52840_m2
@@ -3,6 +3,7 @@

 config BOARD_NRF52840_M2
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_NRF52840_M2_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_NRF52840_M2_NRF52840_ZMK
    imply RETENTION if BOARD_NRF52840_M2_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_NRF52840_M2_NRF52840_ZMK
--- a/app/boards/mechwild/pillbug/Kconfig.pillbug
+++ b/app/boards/mechwild/pillbug/Kconfig.pillbug
@@ -3,6 +3,7 @@

 config BOARD_PILLBUG
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_PILLBUG_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_PILLBUG_NRF52840_ZMK
    imply RETENTION if BOARD_PILLBUG_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_PILLBUG_NRF52840_ZMK
--- a/app/boards/mechwild/pillbug/board.yml
+++ b/app/boards/mechwild/pillbug/board.yml
@@ -1,5 +1,5 @@
 board:
-  name: pillbug
+  extend: pillbug
  variants:
    - name: zmk
      qualifier: nrf52840
--- a/app/boards/moergo/glove80/Kconfig.glove80_lh
+++ b/app/boards/moergo/glove80/Kconfig.glove80_lh
@@ -3,6 +3,7 @@

 config BOARD_GLOVE80_LH
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/moergo/glove80/Kconfig.glove80_rh
+++ b/app/boards/moergo/glove80/Kconfig.glove80_rh
@@ -3,6 +3,7 @@

 config BOARD_GLOVE80_RH
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/nicekeyboards/nice60/Kconfig.nice60
+++ b/app/boards/nicekeyboards/nice60/Kconfig.nice60
@@ -3,6 +3,7 @@

 config BOARD_NICE60
    select SOC_NRF52840_QIAA
-    imply RETAINED_MEM
-    imply RETENTION
-    imply RETENTION_BOOT_MODE
+    select ZMK_BOARD_COMPAT if BOARD_NICE60_NRF52840_ZMK
+    imply RETAINED_MEM if BOARD_NICE60_NRF52840_ZMK
+    imply RETENTION if BOARD_NICE60_NRF52840_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_NICE60_NRF52840_ZMK
--- a/app/boards/nicekeyboards/nice_nano/Kconfig.nice_nano
+++ b/app/boards/nicekeyboards/nice_nano/Kconfig.nice_nano
@@ -3,6 +3,7 @@

 config BOARD_NICE_NANO
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_NICE_NANO_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_NICE_NANO_NRF52840_ZMK
    imply RETENTION if BOARD_NICE_NANO_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_NICE_NANO_NRF52840_ZMK
--- a/app/boards/nordic/nrf52840dk/Kconfig.nrf52840dk
+++ b/app/boards/nordic/nrf52840dk/Kconfig.nrf52840dk
@@ -1,3 +1,4 @@

 config BOARD_NRF52840DK
    select SOC_NRF52840_QIAA if BOARD_NRF52840DK_NRF52840_ZMK
+    select ZMK_BOARD_COMPAT if BOARD_NRF52840DK_NRF52840_ZMK
--- a/app/boards/olkb/planck/Kconfig.planck
+++ b/app/boards/olkb/planck/Kconfig.planck
@@ -4,5 +4,5 @@
 # SPDX-License-Identifier: MIT

 config BOARD_PLANCK
-    bool "Planck Keyboard"
    select SOC_STM32F303XC
+    select ZMK_BOARD_COMPAT
--- a/app/boards/olkb/preonic/Kconfig.preonic
+++ b/app/boards/olkb/preonic/Kconfig.preonic
@@ -5,3 +5,4 @@

 config BOARD_PREONIC
    select SOC_STM32F303XC
+    select ZMK_BOARD_COMPAT
--- a/app/boards/pierrechevalier83/ferris/Kconfig.ferris
+++ b/app/boards/pierrechevalier83/ferris/Kconfig.ferris
@@ -5,6 +5,7 @@

 config BOARD_FERRIS
    select SOC_STM32F072XB
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt60/Kconfig.bt60
+++ b/app/boards/polarityworks/bt60/Kconfig.bt60
@@ -5,6 +5,7 @@

 config BOARD_BT60
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt60/Kconfig.bt60_hs
+++ b/app/boards/polarityworks/bt60/Kconfig.bt60_hs
@@ -5,6 +5,7 @@

 config BOARD_BT60_HS
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt65/Kconfig.bt65
+++ b/app/boards/polarityworks/bt65/Kconfig.bt65
@@ -5,6 +5,7 @@

 config BOARD_BT65
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt75/Kconfig.bt75
+++ b/app/boards/polarityworks/bt75/Kconfig.bt75
@@ -5,6 +5,7 @@

 config BOARD_BT75
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/qmk/proton_c/Kconfig.proton_c
+++ b/app/boards/qmk/proton_c/Kconfig.proton_c
@@ -0,0 +1,6 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: Apache-2.0
+
+config BOARD_PROTON_C
+    select ZMK_BOARD_COMPAT
+
--- a/app/boards/raspberrypi/rpi_pico/Kconfig.rpi_pico
+++ b/app/boards/raspberrypi/rpi_pico/Kconfig.rpi_pico
@@ -0,0 +1,10 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_RPI_PICO
+    select SOC_RP2040
+    select ZMK_BOARD_COMPAT if BOARD_RPI_PICO_RP2040_ZMK
+    imply RETAINED_MEM if BOARD_RPI_PICO_RP2040_ZMK
+    imply RETENTION if BOARD_RPI_PICO_RP2040_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_RPI_PICO_RP2040_ZMK
+
--- a/app/boards/seeed/seeeduino_xiao/Kconfig.seeeduino_xiao
+++ b/app/boards/seeed/seeeduino_xiao/Kconfig.seeeduino_xiao
@@ -0,0 +1,9 @@
+# Copyright (c) 2026 Pete Johanson
+# SPDX-License-Identifier: MIT
+
+config BOARD_SEEEDUINO_XIAO
+    select ZMK_BOARD_COMPAT if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
+    imply RETAINED_MEM if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
+    imply RETENTION if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
+
--- a/app/boards/seeed/xiao_ble/Kconfig.xiao_ble
+++ b/app/boards/seeed/xiao_ble/Kconfig.xiao_ble
@@ -0,0 +1,10 @@
+# Copyright (c) 2026 Pete Johanson
+# SPDX-License-Identifier: MIT
+
+config BOARD_XIAO_BLE
+    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_XIAO_BLE_NRF52840_ZMK
+    imply RETAINED_MEM if BOARD_XIAO_BLE_NRF52840_ZMK
+    imply RETENTION if BOARD_XIAO_BLE_NRF52840_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_XIAO_BLE_NRF52840_ZMK
+
--- a/app/boards/sparkfun/pro_micro_rp2040/Kconfig.sparkfun_pro_micro_rp2040
+++ b/app/boards/sparkfun/pro_micro_rp2040/Kconfig.sparkfun_pro_micro_rp2040
@@ -0,0 +1,10 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_SPARKFUN_PRO_MICRO_RP2040
+    select ZMK_BOARD_COMPAT if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
+    imply RETAINED_MEM if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
+    imply RETENTION if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
+    imply RETENTION_BOOT_MODE if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
+
+
--- a/app/boards/weact/blackpill_f401cc/Kconfig.blackpill_f401cc
+++ b/app/boards/weact/blackpill_f401cc/Kconfig.blackpill_f401cc
@@ -0,0 +1,6 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_BLACKPILL_F401CC
+    select ZMK_BOARD_COMPAT
+
--- a/app/boards/weact/blackpill_f401ce/Kconfig.blackpill_f401ce
+++ b/app/boards/weact/blackpill_f401ce/Kconfig.blackpill_f401ce
@@ -0,0 +1,6 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_BLACKPILL_F401CE
+    select ZMK_BOARD_COMPAT
+
--- a/app/boards/weact/blackpill_f411ce/Kconfig.blackpill_f411ce
+++ b/app/boards/weact/blackpill_f411ce/Kconfig.blackpill_f411ce
@@ -0,0 +1,6 @@
+# Copyright (c) 2026 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config BOARD_BLACKPILL_F411CE
+    select ZMK_BOARD_COMPAT
+
--- a/app/boards/zhiayang/mikoto/Kconfig.mikoto
+++ b/app/boards/zhiayang/mikoto/Kconfig.mikoto
@@ -3,6 +3,7 @@

 config BOARD_MIKOTO
    select SOC_NRF52840_QIAA
+    select ZMK_BOARD_COMPAT if BOARD_MIKOTO_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_MIKOTO_NRF52840_ZMK
    imply RETENTION if BOARD_MIKOTO_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_MIKOTO_NRF52840_ZMK