refactor(Kconfig): Extracted designer defaults out into new files (#2537)

docs: Fix incorrect kconfig default values

fix(Kconfig): Added a name to EC11's trigger mode choice, allowing it to be set in device Kconfig.defconfig

refactor(Kconfig): Moved designer defaults out into new files

app/Kconfig

@@ -46,7 +46,7 @@ config NRF_STORE_REBOOT_TYPE_GPREGRET
     bool
     default y
 
-endif
+endif # SOC_SERIES_NRF52X
 
 menu "HID"
 
@@ -81,14 +81,11 @@ if ZMK_HID_REPORT_TYPE_HKRO
 
 config ZMK_HID_KEYBOARD_REPORT_SIZE
     int "# Keyboard Keys Reportable"
-    default 6
 
-endif
+endif # ZMK_HID_REPORT_TYPE_HKRO
 
 config ZMK_HID_CONSUMER_REPORT_SIZE
     int "# Consumer Keys Reportable"
-    default 6
-
 
 choice ZMK_HID_CONSUMER_REPORT_USAGES
     prompt "HID Report Type"
@@ -142,8 +139,7 @@ config USB_NUMOF_EP_WRITE_RETRIES
 config USB_HID_POLL_INTERVAL_MS
     default 1
 
-#ZMK_USB
+endif # ZMK_USB
-endif
 
 menuconfig ZMK_BLE
     bool "BLE (HID over GATT)"
@@ -163,17 +159,14 @@ if ZMK_BLE
 config ZMK_BLE_EXPERIMENTAL_CONN
     bool "Experimental BLE connection changes"
     help
-      Enables a combination of settings that are planned to be default in future versions of ZMK
+      Enables settings that are planned to be default in future versions of ZMK
-      to improve connection stability. This includes changes to timing on BLE pairing initiation,
+      to improve connection stability.
-      restores use of the updated/new LLCP implementation, and disables 2M PHY support.
 
 config ZMK_BLE_EXPERIMENTAL_SEC
     bool "Experimental BLE security changes"
     imply BT_SMP_ALLOW_UNAUTH_OVERWRITE
     help
-      Enables a combination of settings that are planned to be officially supported in the future.
+      Enables security settings that are planned to be officially supported in the future.
-      This includes enabling BT Secure Connection passkey entry, and allows overwrite of keys from
-      previously paired hosts.
 
 config ZMK_BLE_EXPERIMENTAL_FEATURES
     bool "Experimental BLE connection and security settings/features"
@@ -245,19 +238,15 @@ config BT_PERIPHERAL_PREF_LATENCY
 config BT_PERIPHERAL_PREF_TIMEOUT
     default 400
 
-#ZMK_BLE
+endif # ZMK_BLE
-endif
 
-#Output Types
+endmenu # Output Types
-endmenu
 
-# HID
+endmenu # HID
-endmenu
 
 rsource "src/split/Kconfig"
 
-#Basic Keyboard Setup
+endmenu # Basic Keyboard Setup
-endmenu
 
 menu "Keymaps"
 
@@ -275,7 +264,7 @@ config ZMK_KEYMAP_LAYER_NAME_MAX_LEN
     int "Max Layer Name Length"
     default 20
 
-endif
+endif # ZMK_KEYMAP_SETTINGS_STORAGE
 
 endmenu # Keymaps
 
@@ -292,67 +281,51 @@ menuconfig ZMK_RGB_UNDERGLOW
 
 if ZMK_RGB_UNDERGLOW
 
-# This default value cuts down on tons of excess .conf files, if you're using GPIO, manually disable this
-config SPI
-    default y
-
 config ZMK_RGB_UNDERGLOW_EXT_POWER
     bool "RGB underglow toggling also controls external power"
-    default y
 
 config ZMK_RGB_UNDERGLOW_BRT_MIN
     int "RGB underglow minimum brightness in percent"
     range 0 100
-    default 0
 
 config ZMK_RGB_UNDERGLOW_BRT_MAX
     int "RGB underglow maximum brightness in percent"
     range ZMK_RGB_UNDERGLOW_BRT_MIN 100
-    default 100
 
 config ZMK_RGB_UNDERGLOW_HUE_STEP
     int "RGB underglow hue step in degrees"
     range 0 359
-    default 10
 
 config ZMK_RGB_UNDERGLOW_SAT_STEP
     int "RGB underglow saturation step in percent"
     range 0 100
-    default 10
 
 config ZMK_RGB_UNDERGLOW_BRT_STEP
     int "RGB underglow brightness step in percent"
     range 0 100
-    default 10
 
 config ZMK_RGB_UNDERGLOW_HUE_START
     int "RGB underglow start hue value in degrees"
     range 0 359
-    default 0
 
 config ZMK_RGB_UNDERGLOW_SAT_START
     int "RGB underglow start saturations value in percent"
     range 0 100
-    default 100
 
 config ZMK_RGB_UNDERGLOW_BRT_START
     int "RGB underglow start brightness value in percent"
     range ZMK_RGB_UNDERGLOW_BRT_MIN ZMK_RGB_UNDERGLOW_BRT_MAX
-    default ZMK_RGB_UNDERGLOW_BRT_MAX
 
 config ZMK_RGB_UNDERGLOW_SPD_START
     int "RGB underglow start animation speed value"
     range 1 5
-    default 3
 
 config ZMK_RGB_UNDERGLOW_EFF_START
     int "RGB underglow start effect int value related to the effect enum list"
     range 0 3
-    default 0
 
 config ZMK_RGB_UNDERGLOW_ON_START
     bool "RGB underglow starts on by default"
-    default y
 
 config ZMK_RGB_UNDERGLOW_AUTO_OFF_IDLE
     bool "Turn off RGB underglow when keyboard goes into idle state"
@@ -361,8 +334,7 @@ config ZMK_RGB_UNDERGLOW_AUTO_OFF_USB
     bool "Turn off RGB underglow when USB is disconnected"
     depends on USB_DEVICE_STACK
 
-#ZMK_RGB_UNDERGLOW
+endif # ZMK_RGB_UNDERGLOW
-endif
 
 menuconfig ZMK_BACKLIGHT
     bool "LED backlight"
@@ -373,16 +345,13 @@ if ZMK_BACKLIGHT
 config ZMK_BACKLIGHT_BRT_STEP
     int "Brightness step in percent"
     range 1 100
-    default 20
 
 config ZMK_BACKLIGHT_BRT_START
     int "Default brightness in percent"
     range 1 100
-    default 40
 
 config ZMK_BACKLIGHT_ON_START
     bool "Default backlight state"
-    default y
 
 config ZMK_BACKLIGHT_AUTO_OFF_IDLE
     bool "Turn off backlight when keyboard goes into idle state"
@@ -390,19 +359,16 @@ config ZMK_BACKLIGHT_AUTO_OFF_IDLE
 config ZMK_BACKLIGHT_AUTO_OFF_USB
     bool "Turn off backlight when USB is disconnected"
 
-#ZMK_BACKLIGHT
+endif # ZMK_BACKLIGHT
-endif
 
-#Display/LED Options
+endmenu # Display/LED Options
-endmenu
 
 menu "Mouse Options"
 
 config ZMK_MOUSE
     bool "Enable ZMK mouse emulation"
 
-#Mouse Options
+endmenu # Mouse Options
-endmenu
 
 menu "Power Management"
 
@@ -424,7 +390,8 @@ config ZMK_BATTERY_REPORTING_FETCH_MODE_LITHIUM_VOLTAGE
     bool "Lithium Voltage"
 
 endchoice
-endif
+
+endif # ZMK_BATTERY_REPORTING
 
 config ZMK_IDLE_TIMEOUT
     int "Milliseconds of inactivity before entering idle state (OLED shutoff, etc)"
@@ -446,12 +413,10 @@ config ZMK_IDLE_SLEEP_TIMEOUT
     int "Milliseconds of inactivity before entering deep sleep"
     default 900000
 
-#ZMK_SLEEP
+endif # ZMK_SLEEP
-endif
 
 config ZMK_EXT_POWER
     bool "Enable support to control external power output"
-    default y
 
 config ZMK_PM
     bool
@@ -473,7 +438,7 @@ config ZMK_GPIO_KEY_WAKEUP_TRIGGER
     default y
     depends on DT_HAS_ZMK_GPIO_KEY_WAKEUP_TRIGGER_ENABLED && ZMK_PM_SOFT_OFF
 
-#Power Management
+# Power Management
 endmenu
 
 menu "Combo options"
@@ -490,7 +455,7 @@ config ZMK_COMBO_MAX_KEYS_PER_COMBO
     int "Maximum number of keys per combo"
     default 4
 
-#Combo options
+# Combo options
 endmenu
 
 menu "Behavior Options"
@@ -525,8 +490,7 @@ config ZMK_USB_HID_INIT_PRIORITY
     int "USB HID Init Priority"
     default 95
 
-#USB
+endif # USB
-endif
 
 if ZMK_BLE || ZMK_SPLIT_BLE
 
@@ -534,11 +498,9 @@ config ZMK_BLE_INIT_PRIORITY
     int "BLE Init Priority"
     default 50
 
-#ZMK_BLE || ZMK_SPLIT_BLE
+endif # ZMK_BLE || ZMK_SPLIT_BLE
-endif
 
-#Initialization Priorities
+endmenu # Initialization Priorities
-endmenu
 
 menuconfig ZMK_KSCAN
     bool "ZMK KScan Integration"
@@ -612,8 +574,7 @@ config USB_CDC_ACM_RINGBUF_SIZE
 config LOG_PROCESS_THREAD_STARTUP_DELAY_MS
     default 1000
 
-#ZMK_USB_LOGGING
+endif # ZMK_USB_LOGGING
-endif
 
 config ZMK_RTT_LOGGING
     bool "Enable RTT logging to help debug"
@@ -629,8 +590,7 @@ if ZMK_RTT_LOGGING
 config SEGGER_RTT_BUFFER_SIZE_UP
     default 8192
 
-#ZMK_RTT_LOGGING
+endif # ZMK_RTT_LOGGING
-endif
 
 if ZMK_USB_LOGGING || ZMK_RTT_LOGGING
 
@@ -640,11 +600,9 @@ config LOG_BUFFER_SIZE
 config LOG_PROCESS_THREAD_SLEEP_MS
     default 100
 
-#ZMK_USB_LOGGING || ZMK_RTT_LOGGING
+endif # ZMK_USB_LOGGING || ZMK_RTT_LOGGING
-endif
 
-#Logging
+endmenu # Logging
-endmenu
 
 if SETTINGS
 
@@ -660,21 +618,17 @@ config ZMK_SETTINGS_RESET_ON_START_INIT_PRIORITY
       Initialization priority for the settings reset on start. Must be lower priority/
       higher value than FLASH_INIT_PRIORITY if using the NVS/Flash settings backend.
 
-
+endif # ZMK_SETTINGS_RESET_ON_START
-endif
-
 
 config ZMK_SETTINGS_SAVE_DEBOUNCE
     int "Milliseconds to debounce settings saves"
     default 60000
 
-#SETTINGS
+endif # SETTINGS
-endif
 
 config ZMK_BATTERY_REPORT_INTERVAL
     depends on ZMK_BATTERY_REPORTING
     int "Battery level report interval in seconds"
-    default 60
 
 config ZMK_LOW_PRIORITY_WORK_QUEUE
     bool "Work queue for low priority items"
@@ -689,13 +643,11 @@ config ZMK_LOW_PRIORITY_THREAD_PRIORITY
     int "Low priority thread priority"
     default 10
 
-endif
+endif # ZMK_LOW_PRIORITY_WORK_QUEUE
 
-#Advanced
+endmenu # Advanced
-endmenu
 
-#ZMK
+endmenu # ZMK
-endmenu
 
 config KERNEL_BIN_NAME
     default "zmk"
@@ -747,5 +699,6 @@ rsource "boards/shields/*/Kconfig.shield"
 osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.defconfig"
 osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.shield"
 
+rsource "Kconfig.defaults"
 
 source "Kconfig.zephyr"

app/Kconfig.defaults

@@ -0,0 +1,83 @@
+# Copyright (c) 2024 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+# HID
+if ZMK_HID_REPORT_TYPE_HKRO
+
+config ZMK_HID_KEYBOARD_REPORT_SIZE
+    default 6
+
+endif
+
+config ZMK_HID_CONSUMER_REPORT_SIZE
+    default 6
+
+# Underglow
+if ZMK_RGB_UNDERGLOW
+
+# This default value cuts down on tons of excess .conf files, if you're using GPIO, manually disable this
+config SPI
+    default y
+
+config ZMK_RGB_UNDERGLOW_EXT_POWER
+    default y
+
+config ZMK_RGB_UNDERGLOW_BRT_MIN
+    default 0
+
+config ZMK_RGB_UNDERGLOW_BRT_MAX
+    default 100
+
+config ZMK_RGB_UNDERGLOW_HUE_STEP
+    default 10
+
+config ZMK_RGB_UNDERGLOW_SAT_STEP
+    default 10
+
+config ZMK_RGB_UNDERGLOW_BRT_STEP
+    default 10
+
+config ZMK_RGB_UNDERGLOW_HUE_START
+    default 0
+
+config ZMK_RGB_UNDERGLOW_SAT_START
+    default 100
+
+config ZMK_RGB_UNDERGLOW_BRT_START
+    default ZMK_RGB_UNDERGLOW_BRT_MAX
+
+config ZMK_RGB_UNDERGLOW_SPD_START
+    default 3
+
+config ZMK_RGB_UNDERGLOW_EFF_START
+    default 0
+
+config ZMK_RGB_UNDERGLOW_ON_START
+    default y
+
+endif # ZMK_RGB_UNDERGLOW
+
+# Backlight
+if ZMK_BACKLIGHT
+
+config ZMK_BACKLIGHT_BRT_STEP
+    default 20
+
+config ZMK_BACKLIGHT_BRT_START
+    default 40
+
+config ZMK_BACKLIGHT_ON_START
+    default y
+
+endif # ZMK_BACKLIGHT
+
+# Ext_power
+config ZMK_EXT_POWER
+    default y
+
+# Battery
+config ZMK_BATTERY_REPORT_INTERVAL
+    default 60
+
+# Imports
+rsource "src/split/Kconfig.defaults"

app/module/drivers/sensor/ec11/Kconfig

@@ -11,7 +11,7 @@ menuconfig EC11
 
 if EC11
 
-choice
+choice EC11_TRIGGER_MODE
     prompt "Trigger mode"
     default EC11_TRIGGER_NONE
     help

app/src/split/Kconfig

@@ -26,7 +26,6 @@ config ZMK_SPLIT_PERIPHERAL_HID_INDICATORS
     help
       Enable propagating the HID (LED) Indicator state to the split peripheral(s).
 
-#ZMK_SPLIT
+endif # ZMK_SPLIT
-endif
 
 rsource "bluetooth/Kconfig"

app/src/split/Kconfig.defaults

@@ -0,0 +1,4 @@
+# Copyright (c) 2024 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+rsource "bluetooth/Kconfig.defaults"

app/src/split/bluetooth/Kconfig

@@ -5,7 +5,7 @@ if ZMK_SPLIT && ZMK_SPLIT_BLE
 
 menu "BLE Transport"
 
-# Added for backwards compatibility. New shields/board should set `ZMK_SPLIT_ROLE_CENTRAL` only.
+# Added for backwards compatibility. New shields / board should set `ZMK_SPLIT_ROLE_CENTRAL` only.
 config ZMK_SPLIT_BLE_ROLE_CENTRAL
     bool
     select ZMK_SPLIT_ROLE_CENTRAL
@@ -24,7 +24,6 @@ if ZMK_SPLIT_ROLE_CENTRAL
 
 config ZMK_SPLIT_BLE_CENTRAL_PERIPHERALS
     int "Number of peripherals that will connect to the central."
-    default 1
 
 menuconfig ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING
     bool "Fetch Peripheral Battery Level Info"
@@ -96,39 +95,8 @@ config BT_MAX_CONN
 config BT_GAP_AUTO_UPDATE_CONN_PARAMS
     default n
 
-#!ZMK_SPLIT_ROLE_CENTRAL
+endif # !ZMK_SPLIT_ROLE_CENTRAL
-endif
 
 endmenu
 
-#ZMK_SPLIT_BLE
+endif # ZMK_SPLIT_BLE
-endif
-
-
-if ZMK_BLE
-
-if ZMK_SPLIT_BLE && ZMK_SPLIT_ROLE_CENTRAL
-
-config BT_MAX_CONN
-    default 6
-
-config BT_MAX_PAIRED
-    default 6
-
-#ZMK_SPLIT_BLE && ZMK_SPLIT_ROLE_CENTRAL
-endif
-
-if !ZMK_SPLIT_BLE
-
-config BT_MAX_CONN
-    default 5
-
-config BT_MAX_PAIRED
-    default 5
-
-#!ZMK_SPLIT_BLE
-endif
-
-#ZMK_BLE
-endif
-

app/src/split/bluetooth/Kconfig.defaults

@@ -0,0 +1,33 @@
+# Copyright (c) 2024 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+if ZMK_BLE
+
+if ZMK_SPLIT_BLE && ZMK_SPLIT_ROLE_CENTRAL
+
+config ZMK_SPLIT_BLE_CENTRAL_PERIPHERALS
+    default 1
+
+config BT_MAX_CONN
+    default 6
+
+config BT_MAX_PAIRED
+    default 6
+
+#ZMK_SPLIT_BLE && ZMK_SPLIT_ROLE_CENTRAL
+endif
+
+if !ZMK_SPLIT_BLE
+
+config BT_MAX_CONN
+    default 5
+
+config BT_MAX_PAIRED
+    default 5
+
+#!ZMK_SPLIT_BLE
+endif
+
+#ZMK_BLE
+endif
+

docs/docs/config/system.md

@@ -103,7 +103,7 @@ for more information on configuring Bluetooth.
 | `CONFIG_ZMK_BLE_KEYBOARD_REPORT_QUEUE_SIZE` | int  | Max number of keyboard HID reports to queue for sending over BLE      | 20      |
 | `CONFIG_ZMK_BLE_INIT_PRIORITY`              | int  | BLE init priority                                                     | 50      |
 | `CONFIG_ZMK_BLE_THREAD_PRIORITY`            | int  | Priority of the BLE notify thread                                     | 5       |
-| `CONFIG_ZMK_BLE_THREAD_STACK_SIZE`          | int  | Stack size of the BLE notify thread                                   | 512     |
+| `CONFIG_ZMK_BLE_THREAD_STACK_SIZE`          | int  | Stack size of the BLE notify thread                                   | 768     |
 | `CONFIG_ZMK_BLE_PASSKEY_ENTRY`              | bool | Experimental: require typing passkey from host to pair BLE connection | n       |
 
 Note that `CONFIG_BT_MAX_CONN` and `CONFIG_BT_MAX_PAIRED` should be set to the same value. On a split keyboard they should only be set for the central and must be set to one greater than the desired number of bluetooth profiles.
@@ -132,7 +132,7 @@ Following [split keyboard](../features/split-keyboards.md) settings are defined
 | `CONFIG_ZMK_SPLIT_BLE_CENTRAL_POSITION_QUEUE_SIZE`      | int  | Max number of key state events to queue when received from peripherals     | 5                                          |
 | `CONFIG_ZMK_SPLIT_BLE_CENTRAL_SPLIT_RUN_STACK_SIZE`     | int  | Stack size of the BLE split central write thread                           | 512                                        |
 | `CONFIG_ZMK_SPLIT_BLE_CENTRAL_SPLIT_RUN_QUEUE_SIZE`     | int  | Max number of behavior run events to queue to send to the peripheral(s)    | 5                                          |
-| `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_STACK_SIZE`            | int  | Stack size of the BLE split peripheral notify thread                       | 650                                        |
+| `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_STACK_SIZE`            | int  | Stack size of the BLE split peripheral notify thread                       | 756                                        |
 | `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_PRIORITY`              | int  | Priority of the BLE split peripheral notify thread                         | 5                                          |
 | `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_POSITION_QUEUE_SIZE`   | int  | Max number of key state events to queue to send to the central             | 10                                         |