658 lines
14 KiB
Plaintext
658 lines
14 KiB
Plaintext
# Copyright (c) 2020 The ZMK Contributors
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
mainmenu "ZMK Firmware"
|
|
|
|
menu "ZMK"
|
|
|
|
menu "Basic Keyboard Setup"
|
|
|
|
config ZMK_KEYBOARD_NAME
|
|
string "Keyboard Name"
|
|
|
|
config USB_DEVICE_PRODUCT
|
|
default ZMK_KEYBOARD_NAME
|
|
|
|
config BT_DEVICE_NAME
|
|
default ZMK_KEYBOARD_NAME
|
|
|
|
config USB_DEVICE_VID
|
|
default 0x1D50
|
|
|
|
config USB_DEVICE_PID
|
|
default 0x615E
|
|
|
|
config USB_DEVICE_MANUFACTURER
|
|
default "ZMK Project"
|
|
|
|
config BT_DIS_PNP_VID
|
|
default 0x1D50
|
|
|
|
config BT_DIS_PNP_PID
|
|
default 0x615E
|
|
|
|
config BT_DIS_MODEL
|
|
default ZMK_KEYBOARD_NAME
|
|
|
|
config BT_DIS_MANUF
|
|
default "ZMK Project"
|
|
|
|
# Hardware specific overrides
|
|
|
|
if SOC_SERIES_NRF52X
|
|
|
|
# Default on for our usage until boards implement retained bootmode.
|
|
config NRF_STORE_REBOOT_TYPE_GPREGRET
|
|
bool
|
|
default y
|
|
|
|
endif
|
|
|
|
menu "HID"
|
|
|
|
choice ZMK_HID_REPORT_TYPE
|
|
prompt "HID Report Type"
|
|
|
|
config ZMK_HID_REPORT_TYPE_HKRO
|
|
bool "#-Key Roll Over (HKRO) HID Report"
|
|
help
|
|
Enable # key roll over for HID report. This selection is "boot keyboard" compatible
|
|
but limits the total number of possible keys to report as held to #.
|
|
|
|
config ZMK_HID_REPORT_TYPE_NKRO
|
|
bool "Full N-Key Roll Over (NKRO) HID Report"
|
|
help
|
|
Enable full N-Key Roll Over for HID output. This selection will prevent the keyboard
|
|
from working with some BIOS/UEFI versions that only support "boot keyboard" support.
|
|
This option also prevents using some infrequently used higher range HID usages (notably F13-F24 and INTL1-9)
|
|
These usages can be re enabled with ZMK_HID_KEYBOARD_NKRO_EXTENDED_REPORT.
|
|
|
|
endchoice
|
|
|
|
config ZMK_HID_KEYBOARD_NKRO_EXTENDED_REPORT
|
|
bool "Enable extended NKRO reporting"
|
|
depends on ZMK_HID_REPORT_TYPE_NKRO
|
|
help
|
|
Enables higher usage range for NKRO (F13-F24 and INTL1-9).
|
|
Please note this is not compatible with Android currently and you will get no input
|
|
|
|
|
|
if ZMK_HID_REPORT_TYPE_HKRO
|
|
|
|
config ZMK_HID_KEYBOARD_REPORT_SIZE
|
|
int "# Keyboard Keys Reportable"
|
|
default 6
|
|
|
|
endif
|
|
|
|
config ZMK_HID_CONSUMER_REPORT_SIZE
|
|
int "# Consumer Keys Reportable"
|
|
default 6
|
|
|
|
|
|
choice ZMK_HID_CONSUMER_REPORT_USAGES
|
|
prompt "HID Report Type"
|
|
|
|
config ZMK_HID_CONSUMER_REPORT_USAGES_FULL
|
|
bool "Full Consumer HID Usage Support"
|
|
help
|
|
Enable full Consumer usage ID values to be sent to hosts. Allows for less
|
|
frequently used usages, but has compatibability issues with some host OSes.
|
|
|
|
config ZMK_HID_CONSUMER_REPORT_USAGES_BASIC
|
|
bool "Basic Consumer HID Usage Support"
|
|
help
|
|
Enable Consumer usage ID values up to "Playback Speed - Slow" to be sent to
|
|
hosts. Allows for broader compatibability with more host OSes.
|
|
|
|
endchoice
|
|
|
|
config ZMK_HID_INDICATORS
|
|
bool "HID Indicators"
|
|
help
|
|
Enable HID indicators, used for detecting state of Caps/Scroll/Num Lock,
|
|
Kata, and Compose.
|
|
|
|
menu "Output Types"
|
|
|
|
config ZMK_USB
|
|
bool "USB"
|
|
depends on (!ZMK_SPLIT || (ZMK_SPLIT && ZMK_SPLIT_ROLE_CENTRAL))
|
|
select USB
|
|
select USB_DEVICE_STACK
|
|
select USB_DEVICE_HID
|
|
|
|
config ZMK_USB_BOOT
|
|
bool "USB Boot Protocol Support"
|
|
depends on ZMK_USB
|
|
select USB_HID_BOOT_PROTOCOL
|
|
select USB_DEVICE_SOF
|
|
|
|
if ZMK_USB
|
|
|
|
config USB_NUMOF_EP_WRITE_RETRIES
|
|
default 10
|
|
|
|
config USB_HID_POLL_INTERVAL_MS
|
|
default 1
|
|
|
|
#ZMK_USB
|
|
endif
|
|
|
|
menuconfig ZMK_BLE
|
|
bool "BLE (HID over GATT)"
|
|
select BT
|
|
select BT_SMP
|
|
select BT_SMP_SC_PAIR_ONLY
|
|
select BT_SMP_APP_PAIRING_ACCEPT
|
|
select BT_PERIPHERAL
|
|
select BT_DIS
|
|
imply BT_SETTINGS if !ARCH_POSIX
|
|
imply SETTINGS if !ARCH_POSIX
|
|
imply ZMK_BATTERY_REPORTING if !ARCH_POSIX
|
|
|
|
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
|
|
to improve connection stability. This includes changes to timing on BLE pairing initation,
|
|
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.
|
|
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"
|
|
select ZMK_BLE_EXPERIMENTAL_CONN
|
|
select ZMK_BLE_EXPERIMENTAL_SEC
|
|
help
|
|
Enables experimental connection changes and security features.
|
|
|
|
config ZMK_BLE_PASSKEY_ENTRY
|
|
bool "Require passkey entry on the keyboard to complete pairing"
|
|
default n
|
|
select RING_BUFFER
|
|
|
|
config BT_SMP_ALLOW_UNAUTH_OVERWRITE
|
|
imply ZMK_BLE_PASSKEY_ENTRY
|
|
|
|
config BT_CTLR_PHY_2M
|
|
default n if ZMK_BLE_EXPERIMENTAL_CONN
|
|
|
|
# BT_TINYCRYPT_ECC is required for BT_SMP_SC_PAIR_ONLY when using HCI
|
|
config BT_TINYCRYPT_ECC
|
|
default y if BT_HCI && !BT_CTLR
|
|
|
|
config SYSTEM_WORKQUEUE_STACK_SIZE
|
|
default 4096 if SOC_RP2040
|
|
default 2048
|
|
|
|
config ZMK_BLE_THREAD_STACK_SIZE
|
|
int "BLE notify thread stack size"
|
|
default 768
|
|
|
|
config ZMK_BLE_THREAD_PRIORITY
|
|
int "BLE notify thread priority"
|
|
default 5
|
|
|
|
config ZMK_BLE_KEYBOARD_REPORT_QUEUE_SIZE
|
|
int "Max number of keyboard HID reports to queue for sending over BLE"
|
|
default 20
|
|
|
|
config ZMK_BLE_CONSUMER_REPORT_QUEUE_SIZE
|
|
int "Max number of consumer HID reports to queue for sending over BLE"
|
|
default 5
|
|
|
|
config ZMK_BLE_MOUSE_REPORT_QUEUE_SIZE
|
|
int "Max number of mouse HID reports to queue for sending over BLE"
|
|
default 20
|
|
|
|
config ZMK_BLE_CLEAR_BONDS_ON_START
|
|
bool "Configuration that clears all bond information from the keyboard on startup."
|
|
default n
|
|
|
|
# HID GATT notifications sent this way are *not* picked up by Linux, and possibly others.
|
|
config BT_GATT_NOTIFY_MULTIPLE
|
|
default n
|
|
|
|
config BT_GATT_AUTO_SEC_REQ
|
|
default (ZMK_SPLIT_BLE && !ZMK_SPLIT_ROLE_CENTRAL)
|
|
|
|
config BT_DEVICE_APPEARANCE
|
|
default 961
|
|
|
|
config BT_PERIPHERAL_PREF_MIN_INT
|
|
default 6
|
|
|
|
config BT_PERIPHERAL_PREF_MAX_INT
|
|
default 12
|
|
|
|
config BT_PERIPHERAL_PREF_LATENCY
|
|
default 30
|
|
|
|
config BT_PERIPHERAL_PREF_TIMEOUT
|
|
default 400
|
|
|
|
#ZMK_BLE
|
|
endif
|
|
|
|
#Output Types
|
|
endmenu
|
|
|
|
# HID
|
|
endmenu
|
|
|
|
rsource "src/split/Kconfig"
|
|
|
|
#Basic Keyboard Setup
|
|
endmenu
|
|
|
|
menu "Display/LED Options"
|
|
|
|
rsource "src/display/Kconfig"
|
|
|
|
menuconfig ZMK_RGB_UNDERGLOW
|
|
bool "RGB Adressable LED Underglow"
|
|
select LED_STRIP
|
|
select ZMK_LOW_PRIORITY_WORK_QUEUE
|
|
|
|
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"
|
|
|
|
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
|
|
|
|
menuconfig ZMK_BACKLIGHT
|
|
bool "LED backlight"
|
|
select LED
|
|
|
|
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"
|
|
|
|
config ZMK_BACKLIGHT_AUTO_OFF_USB
|
|
bool "Turn off backlight when USB is disconnected"
|
|
|
|
#ZMK_BACKLIGHT
|
|
endif
|
|
|
|
#Display/LED Options
|
|
endmenu
|
|
|
|
menu "Mouse Options"
|
|
|
|
config ZMK_MOUSE
|
|
bool "Enable ZMK mouse emulation"
|
|
default n
|
|
|
|
#Mouse Options
|
|
endmenu
|
|
|
|
menu "Power Management"
|
|
|
|
config ZMK_BATTERY_REPORTING
|
|
bool "Battery level detection/reporting"
|
|
default n
|
|
select SENSOR
|
|
select ZMK_LOW_PRIORITY_WORK_QUEUE
|
|
imply BT_BAS if ZMK_BLE
|
|
|
|
config ZMK_IDLE_TIMEOUT
|
|
int "Milliseconds of inactivity before entering idle state (OLED shutoff, etc)"
|
|
default 30000
|
|
|
|
config ZMK_SLEEP
|
|
bool "Enable deep sleep support"
|
|
depends on HAS_POWEROFF
|
|
select POWEROFF
|
|
imply USB
|
|
|
|
if ZMK_SLEEP
|
|
|
|
config ZMK_IDLE_SLEEP_TIMEOUT
|
|
int "Milliseconds of inactivity before entering deep sleep"
|
|
default 900000
|
|
|
|
#ZMK_SLEEP
|
|
endif
|
|
|
|
config ZMK_EXT_POWER
|
|
bool "Enable support to control external power output"
|
|
default y
|
|
|
|
#Power Management
|
|
endmenu
|
|
|
|
menu "Combo options"
|
|
|
|
config ZMK_COMBO_MAX_PRESSED_COMBOS
|
|
int "Maximum number of currently pressed combos"
|
|
default 4
|
|
|
|
config ZMK_COMBO_MAX_COMBOS_PER_KEY
|
|
int "Maximum number of combos per key"
|
|
default 5
|
|
|
|
config ZMK_COMBO_MAX_KEYS_PER_COMBO
|
|
int "Maximum number of keys per combo"
|
|
default 4
|
|
|
|
#Combo options
|
|
endmenu
|
|
|
|
menu "Behavior Options"
|
|
|
|
config ZMK_BEHAVIORS_QUEUE_SIZE
|
|
int "Maximum number of behaviors to allow queueing from a macro or other complex behavior"
|
|
default 64
|
|
|
|
rsource "Kconfig.behaviors"
|
|
|
|
config ZMK_MACRO_DEFAULT_WAIT_MS
|
|
int "Default time to wait (in milliseconds) before triggering the next behavior in macros"
|
|
default 15
|
|
|
|
config ZMK_MACRO_DEFAULT_TAP_MS
|
|
int "Default time to wait (in milliseconds) between the press and release events of a tapped behavior in macros"
|
|
default 30
|
|
|
|
endmenu
|
|
|
|
menu "Advanced"
|
|
|
|
menu "Initialization Priorities"
|
|
|
|
if USB_DEVICE_STACK
|
|
|
|
config ZMK_USB_INIT_PRIORITY
|
|
int "USB Init Priority"
|
|
default 50
|
|
|
|
#USB
|
|
endif
|
|
|
|
if ZMK_BLE || ZMK_SPLIT_BLE
|
|
|
|
config ZMK_BLE_INIT_PRIORITY
|
|
int "BLE Init Priority"
|
|
default 50
|
|
|
|
#ZMK_BLE || ZMK_SPLIT_BLE
|
|
endif
|
|
|
|
#Initialization Priorities
|
|
endmenu
|
|
|
|
menuconfig ZMK_KSCAN
|
|
bool "ZMK KScan Integration"
|
|
default y
|
|
select KSCAN
|
|
|
|
if ZMK_KSCAN
|
|
|
|
config ZMK_KSCAN_EVENT_QUEUE_SIZE
|
|
int "Size of the event queue for KSCAN events to buffer events"
|
|
default 4
|
|
|
|
endif # ZMK_KSCAN
|
|
|
|
menu "Logging"
|
|
|
|
config ZMK_LOGGING_MINIMAL
|
|
bool "Suppress all ZMK debug log messages"
|
|
default false
|
|
|
|
if !ZMK_LOGGING_MINIMAL
|
|
|
|
config ZMK_LOG_LEVEL
|
|
default 4
|
|
|
|
endif
|
|
|
|
config ZMK_USB_LOGGING
|
|
bool "Enable USB CDC ACM logging to help debug"
|
|
select LOG
|
|
select USB
|
|
select USB_DEVICE_STACK
|
|
select USB_CDC_ACM
|
|
select SERIAL
|
|
select CONSOLE
|
|
select UART_INTERRUPT_DRIVEN
|
|
select UART_LINE_CTRL
|
|
select UART_CONSOLE
|
|
select USB_UART_CONSOLE
|
|
|
|
if ZMK_USB_LOGGING
|
|
|
|
choice USB_CDC_ACM_LOG_LEVEL_CHOICE
|
|
default USB_CDC_ACM_LOG_LEVEL_OFF
|
|
endchoice
|
|
|
|
choice USB_DRIVER_LOG_LEVEL_CHOICE
|
|
default USB_DRIVER_LOG_LEVEL_OFF
|
|
endchoice
|
|
|
|
# We do this to avoid log loop where logging to USB generates more log messages.
|
|
|
|
config USB_CDC_ACM_RINGBUF_SIZE
|
|
default 1024
|
|
|
|
config LOG_PROCESS_THREAD_STARTUP_DELAY_MS
|
|
default 1000
|
|
|
|
#ZMK_USB_LOGGING
|
|
endif
|
|
|
|
config ZMK_RTT_LOGGING
|
|
bool "Enable RTT logging to help debug"
|
|
select LOG
|
|
select DEBUG
|
|
select ASSERT
|
|
select USE_SEGGER_RTT
|
|
select CONSOLE
|
|
select RTT_CONSOLE
|
|
|
|
if ZMK_RTT_LOGGING
|
|
|
|
config SEGGER_RTT_BUFFER_SIZE_UP
|
|
default 8192
|
|
|
|
#ZMK_RTT_LOGGING
|
|
endif
|
|
|
|
if ZMK_USB_LOGGING || ZMK_RTT_LOGGING
|
|
|
|
config LOG_BUFFER_SIZE
|
|
default 8192
|
|
|
|
config LOG_PROCESS_THREAD_SLEEP_MS
|
|
default 100
|
|
|
|
#ZMK_USB_LOGGING || ZMK_RTT_LOGGING
|
|
endif
|
|
|
|
#Logging
|
|
endmenu
|
|
|
|
if SETTINGS
|
|
|
|
config ZMK_SETTINGS_SAVE_DEBOUNCE
|
|
int "Milliseconds to debounce settings saves"
|
|
default 60000
|
|
|
|
#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"
|
|
|
|
if ZMK_LOW_PRIORITY_WORK_QUEUE
|
|
|
|
config ZMK_LOW_PRIORITY_THREAD_STACK_SIZE
|
|
int "Low priority thread stack size"
|
|
default 768
|
|
|
|
config ZMK_LOW_PRIORITY_THREAD_PRIORITY
|
|
int "Low priority thread priority"
|
|
default 10
|
|
|
|
endif
|
|
|
|
#Advanced
|
|
endmenu
|
|
|
|
#ZMK
|
|
endmenu
|
|
|
|
config HEAP_MEM_POOL_SIZE
|
|
default 8192 if ZMK_DISPLAY
|
|
|
|
config KERNEL_BIN_NAME
|
|
default "zmk"
|
|
|
|
config REBOOT
|
|
default y
|
|
|
|
config USB_DEVICE_STACK
|
|
default y if HAS_HW_NRF_USBD
|
|
|
|
config FPU
|
|
default CPU_HAS_FPU
|
|
|
|
config ZMK_WPM
|
|
bool "Calculate WPM"
|
|
default n
|
|
|
|
config ZMK_KEYMAP_SENSORS
|
|
bool "Enable Keymap Sensors support"
|
|
default y
|
|
depends on DT_HAS_ZMK_KEYMAP_SENSORS_ENABLED
|
|
select SENSOR
|
|
|
|
if ZMK_KEYMAP_SENSORS
|
|
|
|
config ZMK_KEYMAP_SENSORS_DEFAULT_TRIGGERS_PER_ROTATION
|
|
int "Default triggers per rotation"
|
|
help
|
|
Unless overridden for a sensor in the board/shield/devicetree, this value
|
|
determines how many times to trigger the bound behavior per full rotation.
|
|
For tactile encoders with detents, this usually should match the number of
|
|
detents per rotation of the encoder.
|
|
default 20
|
|
|
|
endif # ZMK_KEYMAP_SENSORS
|
|
|
|
choice CBPRINTF_IMPLEMENTATION
|
|
default CBPRINTF_NANO
|
|
|
|
endchoice
|
|
|
|
module = ZMK
|
|
module-str = zmk
|
|
source "subsys/logging/Kconfig.template.log_config"
|
|
|
|
rsource "boards/Kconfig"
|
|
rsource "boards/shields/*/Kconfig.defconfig"
|
|
rsource "boards/shields/*/Kconfig.shield"
|
|
|
|
osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.defconfig"
|
|
osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.shield"
|
|
|
|
|
|
source "Kconfig.zephyr"
|