patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

nrf5_bsim cmake: Check that the simulator version is new enough

Browse source 
Add a cmake check to ensure the simulator is new enough and guide
users to update it and rebuild if it isn't,
so they get a better experience than by just getting a build or
runtime error.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2024-03-14 11:48:54 +01:00 committed by David Leach
parent f7165395b4
commit f0750df3da
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
cmake/modules/FindBabbleSim.cmake
View file

@ -60,3 +60,38 @@ endif()
#Many apps cmake files (in and out of tree) expect these environment variables. Lets provide them:
set(ENV{BSIM_COMPONENTS_PATH} ${BSIM_COMPONENTS_PATH})
set(ENV{BSIM_OUT_PATH} ${BSIM_OUT_PATH})
# Let's check that it is new enough and built,
# so we provide better information to users than a compile error:
# Internal function to print a descriptive error message
# Do NOT use it outside of this module. It uses variables internal to it
function(bsim_handle_not_built_error)
get_filename_component(BSIM_ROOT_PATH ${BSIM_COMPONENTS_PATH}/.. ABSOLUTE)
message(FATAL_ERROR "Please ensure you have the latest babblesim and rebuild it."
"If you got it from Zephyr's manifest, you can do:\n\
west update\n\
cd ${BSIM_ROOT_PATH}; make everything -j 8\n"
)
endfunction(bsim_handle_not_built_error)
# Internal function to check that a bsim component is at least the desired version
# Do NOT use it outside of this module. It uses variables internal to it
function(bsim_check_build_version bs_comp req_comp_ver)
set(version_file ${BSIM_OUT_PATH}/lib/${bs_comp}.version)
if (EXISTS ${version_file})
file(READ ${version_file} found_version)
string(STRIP ${found_version} found_version)
else()
message(WARNING "BabbleSim was never compiled (${version_file} not found)")
bsim_handle_not_built_error()
endif()
if (found_version VERSION_LESS req_comp_ver)
message(WARNING
"Built ${bs_comp} version = ${found_version} < ${req_comp_ver} (required version)")
bsim_handle_not_built_error()
endif()
endfunction(bsim_check_build_version)
bsim_check_build_version(bs_2G4_phy_v1 2.4)