mirror of https://github.com/zmkfirmware/zmk.git
refactor: Adjust how we're searching/loading keymap files
Use new post_boards_shields extension point for loading keymap files from board/shield directories.
This commit is contained in:
Peter Johanson
parent
1783414f70
commit
07e4f0544b
|
|
@ -0,0 +1,100 @@
|
|||
# TODO: Check for env or command line "ZMK_CONFIG" setting.
|
||||
# * That directory should load
|
||||
# * defconfigs,
|
||||
# * .conf file,
|
||||
# * single overlay,
|
||||
# * or per board/shield.
|
||||
|
||||
list(APPEND KEYMAP_DIRS ${BOARD_DIR})
|
||||
get_filename_component(BOARD_DIR_NAME ${BOARD_DIR} NAME)
|
||||
# Give a shield like `kyria_rev2_left` we want to use `kyria_rev2` and `kyria` as candidate names for
|
||||
# overlay/conf/keymap files.
|
||||
if(DEFINED SHIELD)
|
||||
list(APPEND KEYMAP_DIRS ${SHIELD_DIRS})
|
||||
foreach(s ${SHIELD_AS_LIST})
|
||||
if (DEFINED SHIELD_DIR_${s})
|
||||
get_filename_component(shield_dir_name ${SHIELD_DIR_${s}} NAME)
|
||||
list(APPEND shield_candidate_names ${shield_dir_name})
|
||||
endif()
|
||||
string(REPLACE "_" ";" S_PIECES ${s})
|
||||
list(LENGTH S_PIECES S_PIECES_LEN)
|
||||
while(NOT S_PIECES STREQUAL "")
|
||||
list(POP_BACK S_PIECES)
|
||||
list(JOIN S_PIECES "_" s_substr)
|
||||
if ("${s_substr}" STREQUAL "" OR "${s_substr}" STREQUAL "${shield_dir_name}")
|
||||
break()
|
||||
endif()
|
||||
list(APPEND shield_candidate_names ${s_substr})
|
||||
endwhile()
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
if (ZMK_CONFIG)
|
||||
if (EXISTS ${ZMK_CONFIG})
|
||||
message(STATUS "ZMK Config directory: ${ZMK_CONFIG}")
|
||||
list(PREPEND KEYMAP_DIRS "${ZMK_CONFIG}")
|
||||
|
||||
if (DEFINED SHIELD)
|
||||
foreach (s ${shield_candidate_names} ${SHIELD_AS_LIST})
|
||||
if (DEFINED ${SHIELD_DIR_${s}})
|
||||
get_filename_component(shield_dir_name ${SHIELD_DIR_${s}} NAME)
|
||||
endif()
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${s}_${BOARD}.overlay")
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${s}.overlay")
|
||||
if (NOT "${shield_dir_name}" STREQUAL "${s}")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${shield_dir_name}_${BOARD}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${shield_dir_name}.conf")
|
||||
endif()
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${s}_${BOARD}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${s}.conf")
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
# TODO: Board revisions?
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${BOARD_DIR_NAME}.overlay")
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${BOARD}.overlay")
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/default.overlay")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${BOARD_DIR_NAME}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${BOARD}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/default.conf")
|
||||
|
||||
foreach(overlay ${overlay_candidates})
|
||||
if (EXISTS "${overlay}")
|
||||
message(STATUS "ZMK Config devicetree overlay: ${overlay}")
|
||||
list(APPEND shield_dts_files "${overlay}")
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
foreach(conf ${config_candidates})
|
||||
if (EXISTS "${conf}")
|
||||
message(STATUS "ZMK Config Kconfig: ${conf}")
|
||||
list(APPEND shield_conf_files "${conf}")
|
||||
endif()
|
||||
endforeach()
|
||||
else()
|
||||
message(WARNING "Unable to locate ZMK config at: ${ZMK_CONFIG}")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
|
||||
if(NOT KEYMAP_FILE)
|
||||
message("${NORMALIZED_BOARD_TARGET} for ${NORMALIZED_BOARD_QUALIFIERS} for ${BOARD} with version ${BOARD_REVISION}")
|
||||
foreach(keymap_dir ${KEYMAP_DIRS})
|
||||
foreach(keymap_prefix ${shield_candidate_names} ${SHIELD_AS_LIST} ${SHIELD_DIR} "${BOARD}_${BOARD_REVISION_STRING}" ${BOARD} ${BOARD_DIR_NAME})
|
||||
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}")
|
||||
set(EXTRA_DTC_OVERLAY_FILE ${KEYMAP_FILE})
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
endforeach()
|
||||
else()
|
||||
message(STATUS "Using keymap file: ${KEYMAP_FILE}")
|
||||
set(EXTRA_DTC_OVERLAY_FILE ${KEYMAP_FILE})
|
||||
endif()
|
||||
|
||||
if (NOT KEYMAP_FILE)
|
||||
message(WARNING "Failed to locate keymap file!")
|
||||
endif()
|
||||
|
|
@ -59,184 +59,3 @@ if (ZMK_CONFIG)
|
|||
list(APPEND DTS_ROOT ${ZMK_CONFIG})
|
||||
endif()
|
||||
endif()
|
||||
|
||||
|
||||
if(DEFINED SHIELD)
|
||||
string(REPLACE " " ";" SHIELD_AS_LIST "${SHIELD}")
|
||||
endif()
|
||||
|
||||
# Helper function for parsing a board's name, revision, and qualifiers,
|
||||
# from one input variable to three separate output variables.
|
||||
function(parse_board_components board_in name_out revision_out qualifiers_out)
|
||||
if(NOT "${${board_in}}" MATCHES "^([^@/]+)(@[^@/]+)?(/[^@]+)?$")
|
||||
message(FATAL_ERROR
|
||||
"Invalid revision / qualifiers format for ${board_in} (${${board_in}}). "
|
||||
"Valid format is: <board>@<revision>/<qualifiers>"
|
||||
)
|
||||
endif()
|
||||
string(REPLACE "@" "" board_revision "${CMAKE_MATCH_2}")
|
||||
|
||||
set(${name_out} ${CMAKE_MATCH_1} PARENT_SCOPE)
|
||||
set(${revision_out} ${board_revision} PARENT_SCOPE)
|
||||
set(${qualifiers_out} ${CMAKE_MATCH_3} PARENT_SCOPE)
|
||||
endfunction()
|
||||
|
||||
parse_board_components(
|
||||
BOARD
|
||||
BOARD BOARD_REVISION BOARD_QUALIFIERS
|
||||
)
|
||||
|
||||
# string(FIND "${BOARD}" "@" REVISION_SEPARATOR_INDEX)
|
||||
# if(NOT (REVISION_SEPARATOR_INDEX EQUAL -1))
|
||||
# math(EXPR BOARD_REVISION_INDEX "${REVISION_SEPARATOR_INDEX} + 1")
|
||||
# string(SUBSTRING ${BOARD} ${BOARD_REVISION_INDEX} -1 BOARD_REVISION)
|
||||
# string(SUBSTRING ${BOARD} 0 ${REVISION_SEPARATOR_INDEX} BOARD)
|
||||
# endif()
|
||||
|
||||
foreach(root ${BOARD_ROOT})
|
||||
set(shield_dir ${root}/boards/shields)
|
||||
# Match the Kconfig.shield files in the shield directories to make sure we are
|
||||
# finding shields, e.g. x_nucleo_iks01a1/Kconfig.shield
|
||||
file(GLOB_RECURSE shields_refs_list ${shield_dir}/*/Kconfig.shield)
|
||||
unset(SHIELD_LIST)
|
||||
foreach(shields_refs ${shields_refs_list})
|
||||
get_filename_component(shield_path ${shields_refs} DIRECTORY)
|
||||
file(GLOB shield_overlays RELATIVE ${shield_path} ${shield_path}/*.overlay)
|
||||
foreach(overlay ${shield_overlays})
|
||||
get_filename_component(shield ${overlay} NAME_WE)
|
||||
list(APPEND SHIELD_LIST ${shield})
|
||||
set(SHIELD_DIR_${shield} ${shield_path})
|
||||
endforeach()
|
||||
endforeach()
|
||||
|
||||
if (EXISTS "${root}/boards/${BOARD}.overlay")
|
||||
list(APPEND shield_dts_files "${root}/boards/${BOARD}.overlay")
|
||||
endif()
|
||||
if (NOT DEFINED BOARD_DIR_NAME)
|
||||
find_path(BOARD_DIR
|
||||
NAMES ${BOARD}_defconfig
|
||||
PATHS ${root}/boards/*/*
|
||||
NO_DEFAULT_PATH
|
||||
)
|
||||
if(BOARD_DIR)
|
||||
get_filename_component(BOARD_DIR_NAME ${BOARD_DIR} NAME)
|
||||
list(APPEND KEYMAP_DIRS ${BOARD_DIR})
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(DEFINED SHIELD)
|
||||
foreach(s ${SHIELD_AS_LIST})
|
||||
if(NOT ${s} IN_LIST SHIELD_LIST)
|
||||
continue()
|
||||
endif()
|
||||
message(STATUS "Adding ${SHIELD_DIR_${s}}")
|
||||
list(APPEND KEYMAP_DIRS ${SHIELD_DIR_${s}})
|
||||
get_filename_component(shield_dir_name ${SHIELD_DIR_${s}} NAME)
|
||||
list(APPEND SHIELD_DIR ${shield_dir_name})
|
||||
endforeach()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
if(EXISTS ${BOARD_DIR}/revision.cmake)
|
||||
# Board provides revision handling.
|
||||
include(${BOARD_DIR}/revision.cmake)
|
||||
elseif(BOARD_REVISION)
|
||||
message(WARNING "Board revision ${BOARD_REVISION} specified for ${BOARD}, \
|
||||
but board has no revision so revision will be ignored.")
|
||||
endif()
|
||||
|
||||
if(DEFINED BOARD_REVISION)
|
||||
string(REPLACE "." "_" BOARD_REVISION_STRING ${BOARD_REVISION})
|
||||
set(KEYMAP_BOARD_REVISION_PREFIX "${BOARD}_${BOARD_REVISION_STRING}")
|
||||
else()
|
||||
set(KEYMAP_BOARD_REVISION_PREFIX "")
|
||||
endif()
|
||||
|
||||
# Give a shield like `kyria_rev2_left` we want to use `kyria_rev2` and `kyria` as candidate names for
|
||||
# overlay/conf/keymap files.
|
||||
if(DEFINED SHIELD)
|
||||
foreach(s ${SHIELD_AS_LIST})
|
||||
if (DEFINED $SHIELD_DIR_${s})
|
||||
get_filename_component(shield_dir_name ${SHIELD_DIR_${s}} NAME)
|
||||
endif()
|
||||
string(REPLACE "_" ";" S_PIECES ${s})
|
||||
list(LENGTH S_PIECES S_PIECES_LEN)
|
||||
while(NOT S_PIECES STREQUAL "")
|
||||
list(POP_BACK S_PIECES)
|
||||
list(JOIN S_PIECES "_" s_substr)
|
||||
if ("${s_substr}" STREQUAL "" OR "${s_substr}" STREQUAL "${shield_dir_name}")
|
||||
break()
|
||||
endif()
|
||||
list(APPEND shield_candidate_names ${s_substr})
|
||||
endwhile()
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
if (ZMK_CONFIG)
|
||||
if (EXISTS ${ZMK_CONFIG})
|
||||
message(STATUS "ZMK Config directory: ${ZMK_CONFIG}")
|
||||
list(PREPEND KEYMAP_DIRS "${ZMK_CONFIG}")
|
||||
|
||||
if (DEFINED SHIELD)
|
||||
foreach (s ${shield_candidate_names} ${SHIELD_AS_LIST})
|
||||
if (DEFINED ${SHIELD_DIR_${s}})
|
||||
get_filename_component(shield_dir_name ${SHIELD_DIR_${s}} NAME)
|
||||
endif()
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${s}_${BOARD}.overlay")
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${s}.overlay")
|
||||
if (NOT "${shield_dir_name}" STREQUAL "${s}")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${shield_dir_name}_${BOARD}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${shield_dir_name}.conf")
|
||||
endif()
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${s}_${BOARD}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${s}.conf")
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
# TODO: Board revisions?
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${BOARD_DIR_NAME}.overlay")
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/${BOARD}.overlay")
|
||||
list(APPEND overlay_candidates "${ZMK_CONFIG}/default.overlay")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${BOARD_DIR_NAME}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/${BOARD}.conf")
|
||||
list(APPEND config_candidates "${ZMK_CONFIG}/default.conf")
|
||||
|
||||
foreach(overlay ${overlay_candidates})
|
||||
if (EXISTS "${overlay}")
|
||||
message(STATUS "ZMK Config devicetree overlay: ${overlay}")
|
||||
list(APPEND shield_dts_files "${overlay}")
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
foreach(conf ${config_candidates})
|
||||
if (EXISTS "${conf}")
|
||||
message(STATUS "ZMK Config Kconfig: ${conf}")
|
||||
list(APPEND shield_conf_files "${conf}")
|
||||
endif()
|
||||
endforeach()
|
||||
else()
|
||||
message(WARNING "Unable to locate ZMK config at: ${ZMK_CONFIG}")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
|
||||
if(NOT KEYMAP_FILE)
|
||||
foreach(keymap_dir ${KEYMAP_DIRS})
|
||||
foreach(keymap_prefix ${shield_candidate_names} ${SHIELD_AS_LIST} ${SHIELD_DIR} ${KEYMAP_BOARD_REVISION_PREFIX} ${BOARD} ${BOARD_DIR_NAME})
|
||||
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}")
|
||||
set(DTC_OVERLAY_FILE ${KEYMAP_FILE})
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
endforeach()
|
||||
else()
|
||||
message(STATUS "Using keymap file: ${KEYMAP_FILE}")
|
||||
set(DTC_OVERLAY_FILE ${KEYMAP_FILE})
|
||||
endif()
|
||||
|
||||
if (NOT KEYMAP_FILE)
|
||||
message(WARNING "Failed to locate keymap file!")
|
||||
endif()
|
||||
|
|
|
|||
Loading…
Reference in New Issue