b85954787e
The YAML contents mirror the values in the ZEPHYR_RUNNER_CONFIG variables, but they are phrased in terms of command line arguments. This makes it possible for Python to intermix them with runner-specific arguments, which is a step towards being able to set arguments like --bin-file via board_set_runner_args(). The next step is to handle them in Python too. Move the RUNNERS_VERBOSE setting closer to its use while at it, to preserve readability. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
222 lines
6.9 KiB
CMake
222 lines
6.9 KiB
CMake
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
# Save runner state in a YAML file, and put that YAML file's location
|
|
# in the cache.
|
|
function(create_runners_yaml)
|
|
set(runners ${ARGV})
|
|
|
|
set(runners_yaml "${PROJECT_BINARY_DIR}/runners.yaml")
|
|
|
|
set(yaml_contents "# Available runners configured by board.cmake.
|
|
runners:
|
|
")
|
|
foreach(runner ${runners})
|
|
string(APPEND yaml_contents "\
|
|
- ${runner}
|
|
")
|
|
endforeach()
|
|
|
|
if(DEFINED BOARD_FLASH_RUNNER)
|
|
string(APPEND yaml_contents "\
|
|
|
|
# Default flash runner if --runner is not given.
|
|
flash-runner: ${BOARD_FLASH_RUNNER}
|
|
")
|
|
endif()
|
|
if(DEFINED BOARD_DEBUG_RUNNER)
|
|
string(APPEND yaml_contents "\
|
|
|
|
# Default debug runner if --runner is not given.
|
|
debug-runner: ${BOARD_FLASH_RUNNER}
|
|
")
|
|
endif()
|
|
|
|
string(APPEND yaml_contents "\
|
|
|
|
# Default command line arguments. The ones in \"common\" are always given.
|
|
# The other sub-keys give runner-specific arguments.
|
|
args:
|
|
common:
|
|
")
|
|
|
|
# Get default settings for common arguments.
|
|
#
|
|
# TODO: clean up the host tools arguments. These are really runner
|
|
# specific; they only continue to exist here out of inertia.
|
|
string(APPEND yaml_contents "\
|
|
- --board-dir=${BOARD_DIR}
|
|
- --elf-file=${PROJECT_BINARY_DIR}/${KERNEL_ELF_NAME}
|
|
- --hex-file=${PROJECT_BINARY_DIR}/${KERNEL_HEX_NAME}
|
|
- --bin-file=${PROJECT_BINARY_DIR}/${KERNEL_BIN_NAME}
|
|
")
|
|
if (DEFINED CMAKE_GDB)
|
|
string(APPEND yaml_contents "\
|
|
- --gdb=${CMAKE_GDB}
|
|
")
|
|
endif()
|
|
if (DEFINED OPENOCD)
|
|
string(APPEND yaml_contents "\
|
|
- --openocd=${OPENOCD}
|
|
")
|
|
endif()
|
|
if(DEFINED OPENOCD_DEFAULT_PATH)
|
|
string(APPEND yaml_contents "\
|
|
- --openocd-search=${OPENOCD_DEFAULT_PATH}
|
|
")
|
|
endif()
|
|
|
|
# Get runner-specific arguments set in the board files.
|
|
foreach(runner ${runners})
|
|
string(MAKE_C_IDENTIFIER ${runner} runner_id)
|
|
string(APPEND yaml_contents "\
|
|
${runner_id}:
|
|
")
|
|
get_property(args GLOBAL PROPERTY "BOARD_RUNNER_ARGS_${runner_id}")
|
|
foreach(arg ${args})
|
|
string(APPEND yaml_contents "\
|
|
- ${arg}
|
|
")
|
|
endforeach()
|
|
endforeach()
|
|
|
|
# Write the final contents and set its location in the cache.
|
|
file(WRITE "${runners_yaml}" "${yaml_contents}")
|
|
set(ZEPHYR_RUNNERS_YAML "${runners_yaml}" CACHE INTERNAL
|
|
"a configuration file for the runners Python package")
|
|
endfunction()
|
|
|
|
get_property(RUNNERS GLOBAL PROPERTY ZEPHYR_RUNNERS)
|
|
|
|
# Persist the runner-related state.
|
|
#
|
|
# Available runners and their arguments are configured in board.cmake
|
|
# files.
|
|
#
|
|
# Everything is marked with FORCE so that re-running CMake updates the
|
|
# configuration if the board files change.
|
|
#
|
|
# TODO: drop the hack in sign.py that uses cached_runner_config to
|
|
# guess the .bin and .hex files, then delete the cache variables.
|
|
if(RUNNERS)
|
|
create_runners_yaml(${RUNNERS})
|
|
|
|
set(ZEPHYR_RUNNERS ${RUNNERS} CACHE INTERNAL "Available runners")
|
|
|
|
# Runner configuration. This is provided to all runners, and is
|
|
# distinct from the free-form arguments provided by e.g.
|
|
# board_runner_args().
|
|
#
|
|
# Always applicable:
|
|
set(ZEPHYR_RUNNER_CONFIG_BOARD_DIR "${BOARD_DIR}"
|
|
CACHE STRING "Board definition directory" FORCE)
|
|
set(ZEPHYR_RUNNER_CONFIG_KERNEL_ELF "${PROJECT_BINARY_DIR}/${KERNEL_ELF_NAME}"
|
|
CACHE STRING "Path to kernel image in ELF format" FORCE)
|
|
get_property(HEX_FILES_TO_MERGE GLOBAL PROPERTY HEX_FILES_TO_MERGE)
|
|
if(HEX_FILES_TO_MERGE)
|
|
set(ZEPHYR_RUNNER_CONFIG_KERNEL_HEX "${PROJECT_BINARY_DIR}/${MERGED_HEX_NAME}"
|
|
CACHE STRING "Path to merged image in Intel Hex format" FORCE)
|
|
else()
|
|
set(ZEPHYR_RUNNER_CONFIG_KERNEL_HEX "${PROJECT_BINARY_DIR}/${KERNEL_HEX_NAME}"
|
|
CACHE STRING "Path to kernel image in Intel Hex format" FORCE)
|
|
endif()
|
|
set(ZEPHYR_RUNNER_CONFIG_KERNEL_BIN "${PROJECT_BINARY_DIR}/${KERNEL_BIN_NAME}"
|
|
CACHE STRING "Path to kernel image as raw binary" FORCE)
|
|
# Not always applicable, but so often needed that they're provided
|
|
# by default: (TODO: clean this up)
|
|
if(DEFINED CMAKE_GDB)
|
|
set(ZEPHYR_RUNNER_CONFIG_GDB "${CMAKE_GDB}"
|
|
CACHE STRING "Path to GDB binary, if applicable" FORCE)
|
|
endif()
|
|
if(DEFINED OPENOCD)
|
|
set(ZEPHYR_RUNNER_CONFIG_OPENOCD "${OPENOCD}"
|
|
CACHE STRING "Path to openocd binary, if applicable" FORCE)
|
|
endif()
|
|
if(DEFINED OPENOCD_DEFAULT_PATH)
|
|
set(ZEPHYR_RUNNER_CONFIG_OPENOCD_SEARCH "${OPENOCD_DEFAULT_PATH}"
|
|
CACHE STRING "Path to add to openocd search path, if applicable" FORCE)
|
|
endif()
|
|
|
|
# Runner-specific command line arguments obtained from the board's
|
|
# build scripts, the application's scripts, etc.
|
|
foreach(runner ${RUNNERS})
|
|
string(MAKE_C_IDENTIFIER ${runner} runner_id)
|
|
# E.g. args = BOARD_RUNNER_ARGS_openocd, BOARD_RUNNER_ARGS_dfu_util, etc.
|
|
get_property(runner_args GLOBAL PROPERTY "BOARD_RUNNER_ARGS_${runner_id}")
|
|
set(ZEPHYR_RUNNER_ARGS_${runner_id} ${runner_args} CACHE STRING
|
|
"Runner-specific arguments for ${runner}" FORCE)
|
|
endforeach()
|
|
endif()
|
|
if(BOARD_FLASH_RUNNER)
|
|
set(ZEPHYR_BOARD_FLASH_RUNNER ${BOARD_FLASH_RUNNER} CACHE STRING
|
|
"Default runner for flashing binaries" FORCE)
|
|
endif()
|
|
if(BOARD_DEBUG_RUNNER)
|
|
set(ZEPHYR_BOARD_DEBUG_RUNNER ${BOARD_DEBUG_RUNNER} CACHE STRING
|
|
"Default runner for debugging" FORCE)
|
|
endif()
|
|
|
|
if(DEFINED ENV{WEST_DIR} AND NOT WEST_DIR)
|
|
set(WEST_DIR $ENV{WEST_DIR})
|
|
endif(DEFINED ENV{WEST_DIR} AND NOT WEST_DIR)
|
|
|
|
if(WEST_DIR)
|
|
set(WEST "PYTHONPATH=${WEST_DIR}/src" "${PYTHON_EXECUTABLE};${WEST_DIR}/src/west/main.py;--zephyr-base=$ENV{ZEPHYR_BASE} ")
|
|
endif()
|
|
|
|
# Generate the flash, debug, debugserver, attach targets within the build
|
|
# system itself.
|
|
foreach(target flash debug debugserver attach)
|
|
if(target STREQUAL flash)
|
|
set(comment "Flashing ${BOARD}")
|
|
elseif(target STREQUAL debug)
|
|
set(comment "Debugging ${BOARD}")
|
|
elseif(target STREQUAL debugserver)
|
|
set(comment "Debugging ${BOARD}")
|
|
if(EMU_PLATFORM)
|
|
# cmake/qemu/CMakeLists.txt will add a debugserver target for
|
|
# emulation platforms, so we don't add one here
|
|
continue()
|
|
endif()
|
|
elseif(target STREQUAL attach)
|
|
set(comment "Debugging ${BOARD}")
|
|
endif()
|
|
|
|
list(APPEND FLASH_DEPS ${logical_target_for_zephyr_elf})
|
|
|
|
# Enable verbose output, if requested.
|
|
if(CMAKE_VERBOSE_MAKEFILE)
|
|
set(RUNNER_VERBOSE "--verbose")
|
|
else()
|
|
set(RUNNER_VERBOSE)
|
|
endif()
|
|
|
|
# We pass --skip-rebuild here because the DEPENDS value ensures the
|
|
# build is already up to date before west is run.
|
|
if(WEST)
|
|
set(cmd
|
|
${CMAKE_COMMAND} -E env
|
|
${WEST}
|
|
${RUNNER_VERBOSE}
|
|
${target}
|
|
--skip-rebuild
|
|
DEPENDS ${FLASH_DEPS}
|
|
WORKING_DIRECTORY ${APPLICATION_BINARY_DIR}
|
|
)
|
|
|
|
add_custom_target(${target}
|
|
COMMAND
|
|
${cmd}
|
|
COMMENT
|
|
${comment}
|
|
USES_TERMINAL
|
|
)
|
|
else()
|
|
add_custom_target(${target}
|
|
COMMAND ${CMAKE_COMMAND} -E echo \"West was not found in path. To support
|
|
'${CMAKE_MAKE_PROGRAM} ${target}', please install west bootstrapper with:
|
|
'pip install west --user', and thereafter 'west init'.\"
|
|
USES_TERMINAL
|
|
)
|
|
endif(WEST)
|
|
endforeach()
|