michaelh/zephyr
1
0
Fork 0
Code Releases Activity

cmake: add optional app_set_runner_args()

Browse source 
Due to a chicken-and-egg problem, it's not possible to call
board_runner_args() directly from an application CMakeLists.txt and
have it take effect:

  - if the board_runner_args() call appears before including the
    boilerplate file, then the function is undefined and an error
    occurs.

  - if the call appears after including the boilerplate file, then
    board_finalize_runner_args() has already been called by the
    relevant runner.board.cmake file, so it won't take effect.

Similarly to the way set_conf_file() works, allow applications to
declare additional runner args by checking if they have provided a
macro named app_set_runner_args(), which contains calls to
board_runner_args(). Using a macro means that we can invoke it with
the definition of board_runner_args() in scope.

Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
This commit is contained in:
Marti Bolivar 2017-12-19 14:50:01 -05:00 • committed by Anas Nashif
commit 70a40813df
1 changed files with 25 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

31
cmake/extensions.cmake
View file

@ -520,17 +520,28 @@ endmacro()
# provides glue between CMake and the runner invocation script,
# zephyr_flash_debug.py.
# This function is intended for board.cmake files.
# This function is intended for board.cmake files and application
# CMakeLists.txt files.
#
# Usage:
# Usage from board.cmake files:
# board_runner_args(runner "--some-arg=val1" "--another-arg=val2")
#
# Will ensure the command line to zephyr_flash_debug.py contains:
# The build system will then ensure the command line to
# zephyr_flash_debug.py contains:
# --some-arg=val1 --another-arg=val2
#
# in the flash, debug, and debugserver target recipes, as
# appropriate. These settings will override any defaults provided by
# the build system.
# Within application CMakeLists.txt files, ensure that all calls to
# board_runner_args() are part of a macro named app_set_runner_args(),
# like this, which is defined before including the boilerplate file:
# macro(app_set_runner_args)
# board_runner_args(runner "--some-app-setting=value")
# endmacro()
#
# The build system tests for the existence of the macro and will
# invoke it at the appropriate time if it is defined.
#
# Any explicitly provided settings given by this function override
# defaults provided by the build system.
function(board_runner_args runner)
string(MAKE_C_IDENTIFIER ${runner} runner_id)
# Note the "_EXPLICIT_" here, and see below.
@ -554,8 +565,16 @@ endfunction()
# precedence, except for arguments which can be given multiple times
# (use these with caution).
function(board_finalize_runner_args runner)
# If the application provided a macro to add additional runner
# arguments, handle them.
if(COMMAND app_set_runner_args)
app_set_runner_args()
endif()
# Retrieve the list of explicitly set arguments.
string(MAKE_C_IDENTIFIER ${runner} runner_id)
get_property(explicit GLOBAL PROPERTY "BOARD_RUNNER_ARGS_EXPLICIT_${runner_id}")
# Note no _EXPLICIT_ here. This property contains the final list.
set_property(GLOBAL APPEND PROPERTY BOARD_RUNNER_ARGS_${runner_id}
# Default arguments from the common runner file come first.