From f83ec5ce2b04380158299c20c603c1fbb49b12d6 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Thu, 6 Aug 2020 10:32:06 -0400 Subject: [PATCH] Refactor to using .keymap files * Still just devicetree keymaps. * Filename can now use `.keymap` or `.keymap` convention, including overrides for revisions, etc. --- app/CMakeLists.txt | 4 -- .../keymap.overlay => planck_rev6.keymap} | 0 ...ap.overlay => clueboard_california.keymap} | 0 .../{keymap/keymap.overlay => kyria.keymap} | 0 .../{keymap/keymap.overlay => lily58.keymap} | 0 .../petejohanson_handwire/Kconfig.defconfig | 13 ----- .../petejohanson_handwire/Kconfig.shield | 5 -- .../keymap/keymap.overlay | 40 -------------- .../petejohanson_handwire.conf | 1 - .../petejohanson_handwire.overlay | 44 --------------- .../Kconfig.defconfig | 13 ----- .../Kconfig.shield | 5 -- .../keymap/keymap.overlay | 41 -------------- .../petejohanson_pro_micro_handwire.conf | 0 .../petejohanson_pro_micro_handwire.overlay | 17 ------ app/cmake/zmk_config.cmake | 54 +++++++++---------- 16 files changed, 25 insertions(+), 212 deletions(-) rename app/boards/arm/planck/{keymap/keymap.overlay => planck_rev6.keymap} (100%) rename app/boards/shields/clueboard_california/{keymap/keymap.overlay => clueboard_california.keymap} (100%) rename app/boards/shields/kyria/{keymap/keymap.overlay => kyria.keymap} (100%) rename app/boards/shields/lily58/{keymap/keymap.overlay => lily58.keymap} (100%) delete mode 100644 app/boards/shields/petejohanson_handwire/Kconfig.defconfig delete mode 100644 app/boards/shields/petejohanson_handwire/Kconfig.shield delete mode 100644 app/boards/shields/petejohanson_handwire/keymap/keymap.overlay delete mode 100644 app/boards/shields/petejohanson_handwire/petejohanson_handwire.conf delete mode 100644 app/boards/shields/petejohanson_handwire/petejohanson_handwire.overlay delete mode 100644 app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.defconfig delete mode 100644 app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.shield delete mode 100644 app/boards/shields/petejohanson_pro_micro_handwire/keymap/keymap.overlay delete mode 100644 app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.conf delete mode 100644 app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.overlay diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt index b05d16bf..d0d343b7 100644 --- a/app/CMakeLists.txt +++ b/app/CMakeLists.txt @@ -18,10 +18,6 @@ include(cmake/zmk_config.cmake) find_package(Zephyr REQUIRED HINTS ../zephyr) project(zmk) -if(EXISTS ${KEYMAP_DIR}/keymap.c) - target_sources(app PRIVATE ${KEYMAP_DIR}/keymap.c) -endif() - zephyr_linker_sources(RODATA include/linker/zmk-events.ld) # Add your source file to the "app" target. This must come after diff --git a/app/boards/arm/planck/keymap/keymap.overlay b/app/boards/arm/planck/planck_rev6.keymap similarity index 100% rename from app/boards/arm/planck/keymap/keymap.overlay rename to app/boards/arm/planck/planck_rev6.keymap diff --git a/app/boards/shields/clueboard_california/keymap/keymap.overlay b/app/boards/shields/clueboard_california/clueboard_california.keymap similarity index 100% rename from app/boards/shields/clueboard_california/keymap/keymap.overlay rename to app/boards/shields/clueboard_california/clueboard_california.keymap diff --git a/app/boards/shields/kyria/keymap/keymap.overlay b/app/boards/shields/kyria/kyria.keymap similarity index 100% rename from app/boards/shields/kyria/keymap/keymap.overlay rename to app/boards/shields/kyria/kyria.keymap diff --git a/app/boards/shields/lily58/keymap/keymap.overlay b/app/boards/shields/lily58/lily58.keymap similarity index 100% rename from app/boards/shields/lily58/keymap/keymap.overlay rename to app/boards/shields/lily58/lily58.keymap diff --git a/app/boards/shields/petejohanson_handwire/Kconfig.defconfig b/app/boards/shields/petejohanson_handwire/Kconfig.defconfig deleted file mode 100644 index 7da09aca..00000000 --- a/app/boards/shields/petejohanson_handwire/Kconfig.defconfig +++ /dev/null @@ -1,13 +0,0 @@ - -if SHIELD_PETEJOHANSON_HANDWIRE - -config ZMK_KEYBOARD_NAME - default "Pete's Handwire Breadboard" - -config ZMK_BLE - default y - -config ZMK_ACTION_MOD_TAP - default y - -endif diff --git a/app/boards/shields/petejohanson_handwire/Kconfig.shield b/app/boards/shields/petejohanson_handwire/Kconfig.shield deleted file mode 100644 index defb90a2..00000000 --- a/app/boards/shields/petejohanson_handwire/Kconfig.shield +++ /dev/null @@ -1,5 +0,0 @@ -# Copyright (c) 2019 Linaro Limited -# SPDX-License-Identifier: MIT - -config SHIELD_PETEJOHANSON_HANDWIRE - def_bool $(shields_list_contains,petejohanson_handwire) diff --git a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay deleted file mode 100644 index b2941713..00000000 --- a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay +++ /dev/null @@ -1,40 +0,0 @@ -#include -#include - -/ { - chosen { - zmk,keymap = &keymap0; - }; - - keymap0: keymap { - compatible = "zmk,keymap"; - label ="Default keymap"; - layers = <&default &lower &raise>; - }; - - layers { - compatible = "zmk,layers"; - - default: layer_0 { - label = "DEFAULT"; - bindings = < - &cp M_NEXT &mt MOD_LSFT B &trans &trans - &mo 1 &mo 2 &trans &trans>; - }; - - lower: layer_1 { - label = "LOWER"; - - bindings = < - &cp M_PLAY &cp M_NEXT &trans &trans - &trans &trans &trans &trans>; - }; - - raise: layer_2 { - label = "RAISE"; - bindings = < - &kp C &kp D &trans &trans - &trans &kp E &trans &trans>; - }; - }; -}; diff --git a/app/boards/shields/petejohanson_handwire/petejohanson_handwire.conf b/app/boards/shields/petejohanson_handwire/petejohanson_handwire.conf deleted file mode 100644 index 63829ba3..00000000 --- a/app/boards/shields/petejohanson_handwire/petejohanson_handwire.conf +++ /dev/null @@ -1 +0,0 @@ -CONFIG_ZMK_KSCAN_COMPOSITE_DRIVER=y diff --git a/app/boards/shields/petejohanson_handwire/petejohanson_handwire.overlay b/app/boards/shields/petejohanson_handwire/petejohanson_handwire.overlay deleted file mode 100644 index 95b08354..00000000 --- a/app/boards/shields/petejohanson_handwire/petejohanson_handwire.overlay +++ /dev/null @@ -1,44 +0,0 @@ - -/ { - chosen { - zmk,kscan = &kscan0; - }; - - kscan0: kscan_0 { - compatible = "zmk,kscan-composite"; - label = "KSCAN_COMP"; - rows = <2>; - columns = <4>; - - left { - kscan = <&left_hand>; - }; - - right { - kscan = <&right_hand>; - column-offset = <2>; - }; - }; - - left_hand: kscan_1 { - compatible = "zmk,kscan-gpio-matrix"; - label = "KSCAN_LEFT"; - - diode-direction = "row2col"; - row-gpios = <&arduino_header 8 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>, - <&arduino_header 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; - col-gpios = <&arduino_header 10 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>, - <&arduino_header 11 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; - }; - - right_hand: kscan_2 { - compatible = "zmk,kscan-gpio-matrix"; - label = "KSCAN_RIGHT"; - - diode-direction = "row2col"; - row-gpios = <&arduino_header 12 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>, - <&arduino_header 13 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; - col-gpios = <&arduino_header 14 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>, - <&arduino_header 15 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; - }; -}; diff --git a/app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.defconfig b/app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.defconfig deleted file mode 100644 index 5098fc81..00000000 --- a/app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.defconfig +++ /dev/null @@ -1,13 +0,0 @@ - -if SHIELD_PETEJOHANSON_PRO_MICRO_HANDWIRE - -config ZMK_KEYBOARD_NAME - default "Pete's ProMicro Compat Handwire" - -config ZMK_USB - default y - -config ZMK_ACTION_MOD_TAP - default y - -endif diff --git a/app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.shield b/app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.shield deleted file mode 100644 index b6264dbc..00000000 --- a/app/boards/shields/petejohanson_pro_micro_handwire/Kconfig.shield +++ /dev/null @@ -1,5 +0,0 @@ -# Copyright (c) 2020 Pete Johanson -# SPDX-License-Identifier: MIT - -config SHIELD_PETEJOHANSON_PRO_MICRO_HANDWIRE - def_bool $(shields_list_contains,petejohanson_pro_micro_handwire) diff --git a/app/boards/shields/petejohanson_pro_micro_handwire/keymap/keymap.overlay b/app/boards/shields/petejohanson_pro_micro_handwire/keymap/keymap.overlay deleted file mode 100644 index ca035579..00000000 --- a/app/boards/shields/petejohanson_pro_micro_handwire/keymap/keymap.overlay +++ /dev/null @@ -1,41 +0,0 @@ -#include -#include - -/ { - chosen { - zmk,keymap = &keymap0; - }; - keymap0: keymap { - compatible = "zmk,keymap"; - label ="Default keymap"; - layers = <&default &lower &raise>; - }; - - layers { - compatible = "zmk,layers"; - - default: layer_0 { - label = "DEFAULT"; - - bindings = < - &mo 1 &kp A - &mo 2 &kp C>; - }; - - lower: layer_1 { - label = "LOWER"; - - bindings = < - &trans &kp D - &trans &kp E>; - }; - - raise: layer_2 { - label = "RAISE"; - - bindings = < - &trans &kp I - &trans &kp H>; - }; - }; -}; diff --git a/app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.conf b/app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.conf deleted file mode 100644 index e69de29b..00000000 diff --git a/app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.overlay b/app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.overlay deleted file mode 100644 index 1b27b939..00000000 --- a/app/boards/shields/petejohanson_pro_micro_handwire/petejohanson_pro_micro_handwire.overlay +++ /dev/null @@ -1,17 +0,0 @@ - -/ { - chosen { - zmk,kscan = &kscan0; - }; - - kscan0: kscan { - compatible = "zmk,kscan-gpio-matrix"; - label = "KSCAN"; - - diode-direction = "row2col"; - row-gpios = <&pro_micro_d 6 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>, - <&pro_micro_d 7 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; - col-gpios = <&pro_micro_d 8 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>, - <&pro_micro_d 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; - }; -}; diff --git a/app/cmake/zmk_config.cmake b/app/cmake/zmk_config.cmake index e4d2632f..518c3c3d 100644 --- a/app/cmake/zmk_config.cmake +++ b/app/cmake/zmk_config.cmake @@ -62,11 +62,9 @@ foreach(root ${BOARD_ROOT}) NAMES ${BOARD}_defconfig PATHS ${root}/boards/*/* NO_DEFAULT_PATH - ) - if(BOARD_DIR) - if (EXISTS "${BOARD_DIR}/keymap") - list(APPEND KEYMAP_DIRS ${BOARD_DIR}/keymap) - endif() + ) + if(BOARD_DIR) + list(APPEND KEYMAP_DIRS ${BOARD_DIR}) endif() if(DEFINED SHIELD) @@ -77,37 +75,16 @@ foreach(root ${BOARD_ROOT}) ) foreach(shield_path ${shields_refs_list}) get_filename_component(SHIELD_DIR ${shield_path} NAME) - if (EXISTS "${shield_path}/keymap") - list(APPEND KEYMAP_DIRS ${shield_path}/keymap) - endif() + list(APPEND KEYMAP_DIRS ${shield_path}) endforeach() endif() endforeach() -find_path(BASE_KEYMAPS_DIR - NAMES ${KEYMAP}/keymap.overlay - PATHS ${KEYMAP_DIRS} - NO_DEFAULT_PATH -) - -if (BASE_KEYMAPS_DIR) - set(KEYMAP_DIR "${BASE_KEYMAPS_DIR}/${KEYMAP}" CACHE STRING "Selected keymap directory") - message(STATUS "Keyboard Base Keymap: ${KEYMAP_DIR}/") - # Used to let local imports of custom keycodes work as expected - list(APPEND DTS_ROOT ${KEYMAP_DIR}) - if (EXISTS "${KEYMAP_DIR}/include") - include_directories("${KEYMAP_DIR}/include") - endif() - list(APPEND ZMK_DTC_FILES "${KEYMAP_DIR}keymap.overlay") -endif() - if (ZMK_CONFIG) if (EXISTS ${ZMK_CONFIG}) message(STATUS "ZMK Config directory: ${ZMK_CONFIG}") list(APPEND DTS_ROOT ${ZMK_CONFIG}) - if (EXISTS "${ZMK_CONFIG}/include") - include_directories("${ZMK_CONFIG}/include") - endif() + list(PREPEND KEYMAP_DIRS "${ZMK_CONFIG}") if (SHIELD) message(STATUS "Board: ${BOARD}, ${BOARD_DIR}, ${SHIELD}, ${SHIELD_DIR}") @@ -137,7 +114,7 @@ if (ZMK_CONFIG) foreach(conf ${config_candidates}) if (EXISTS "${conf}") - message(STATUS "ZMK Config Kconfig: ${overlay}") + message(STATUS "ZMK Config Kconfig: ${conf}") set(CONF_FILE "${conf}") break() endif() @@ -147,6 +124,25 @@ if (ZMK_CONFIG) endif() endif() + +if(NOT KEYMAP_FILE) + foreach(keymap_dir ${KEYMAP_DIRS}) + foreach(keymap_prefix ${SHIELD} ${SHIELD_DIR} ${BOARD} ${BOARD_DIR}) + if (EXISTS ${keymap_dir}/${keymap_prefix}.keymap) + set(KEYMAP_FILE "${keymap_dir}/${keymap_prefix}.keymap" CACHE STRING "Selected keymap file") + message(STATUS "Using keymap file: ${KEYMAP_FILE}") + break() + endif() + endforeach() + endforeach() +endif() + +if (NOT KEYMAP_FILE) + message(FATAL_ERROR "Failed to locate keymap file!") +endif() + +list(APPEND ZMK_DTC_FILES ${KEYMAP_FILE}) + if (ZMK_DTC_FILES) string(REPLACE ";" " " DTC_OVERLAY_FILE "${ZMK_DTC_FILES}") endif()