How do I access VERSION file parameters from prj.conf?

RE: How do I access VERSION file parameters from prj.conf?

nik2k — Thu, 06 Jun 2024 13:16:49 GMT

Thanks Simon. Here's a video I found on YouTube that addresses using git tags for what I need. I'm going to leave this for anyone reading this thread in the future as a reference, if they're interested.

That's all for now, you can close the case. Really appreciate your time.

Regards,

Shovnik

RE: How do I access VERSION file parameters from prj.conf?

Simonr — Thu, 06 Jun 2024 08:36:06 GMT

The APP_BUILD_VERSION is a string that can refer to the git description, but you choose yourself in reality. It's usually used for the git tag, but can be used as whatever to describe your build version.

Best regards,

Simon

RE: How do I access VERSION file parameters from prj.conf?

nik2k — Wed, 05 Jun 2024 21:25:20 GMT

one last follow up: does the VERSION file have anything to do with git tags ? What I mean for example is: is it common practice to somehow derive the VERSION file's contents from the latest tag like "v1.0.0" (using a script or a git hook perhaps leveraging git describe)? It would be nice to use git tags to mark stable releases in my repo but if it's too much of a hassle I won't bother.

Currently, it seems that there is a macro APP_BUILD_VERSION but it does not use anything from the VERSION file and only uses the output from a git describe command.

RE: How do I access VERSION file parameters from prj.conf?

Simonr — Wed, 05 Jun 2024 11:35:06 GMT

Correct! Let me know if any follow-ups come up or if we can close this case now.

Best of luck and regards,

Simon

RE: How do I access VERSION file parameters from prj.conf?

nik2k — Tue, 04 Jun 2024 17:28:47 GMT

Hi Simon, thanks a lot. I missed the Kconfig file in my project directory completely, or maybe I thought it would be best to not mess with it. In the meantime, I found a workaround by loading the version string at runtime using:

#include "app_version.h"

/* Runtime settings override. */
static int settings_runtime_load(void)
{
#if defined(CONFIG_BT_DIS_FW_REV)
	settings_runtime_set("bt/dis/fw", APP_VERSION_STRING , sizeof(APP_VERSION_STRING));
#endif
	return 0;
}

...
settings_runtime_load(); /* call later inside main() */

But I will definitely be considering the solution you have provided (best to keep configuration stuff like this outside of app code I believe).

I believe I don't need to do anything involving the macros: CONFIG_FW_INFO_FIRMWARE_VERSION and CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION for this right?

RE: How do I access VERSION file parameters from prj.conf?

Simonr — Tue, 04 Jun 2024 08:03:45 GMT

So, this won't be possible to set in the prj.conf file, as it's not able to do this kind of stuff, but you can do it either in the Kconfig file or the CMakeLists.txt file I assume. Here's a .zip file showing the bare bones of what to do to add something like what you are requesting. Check the main.c, Kconfig and VERSION file.

devzone.nordicsemi.com/.../versionname.zip

Best regards,

Simon

RE: How do I access VERSION file parameters from prj.conf?

nik2k — Fri, 31 May 2024 18:36:58 GMT

Hi Simon. Thanks for your time. Your example shows a hardcoded string "0.0.1" but I want to substitute the values of the $(VERSION_MAJOR) and $(VERSION_MINOR) variables into the CONFIG_BT_DIS_FW_REV_STR macro.
If I do something like CONFIG_BT_DIS_FW_REV_STR="$(VERSION_MAJOR).$(VERSION_MINOR)", it will be treated literally:

so I was wondering, if there's some special syntax for using $(variables) in prj.conf. I searched online but unfortunately couldn't find anything concrete on this, other than the Kconfig language reference which details the syntax for Kconfig, not prj.conf.

When I try using the unquoted variables like in my original post: CONFIG_BT_DIS_FW_REV_STR=$(VERSION_MAJOR).$(VERSION_MINOR), I get the below logs on build failure:

c:/Users/91833/Documents/NordicSemiconductor/myApps/RedSOS-Touch/prj.conf:70: warning: malformed string literal in assignment to BT_DIS_FW_REV_STR (defined at C:/ncs/v2.6.0__/nrf\subsys\bluetooth\services\fast_pair/Kconfig.fast_pair:36, C:/ncs/v2.6.0__/zephyr/subsys/bluetooth/services\Kconfig.dis:117, C:/ncs/v2.6.0__/zephyr/subsys/bluetooth/host\../services\Kconfig.dis:117, subsys/bluetooth\host\../services\Kconfig.dis:117). Assignment ignored.

error: Aborting due to Kconfig warnings

Parsing C:/Users/91833/Documents/NordicSemiconductor/myApps/RedSOS-Touch/Kconfig
Loaded configuration 'C:/ncs/v2.6.0__/zephyr/boards/arm/nrf52dk_nrf52832/nrf52dk_nrf52832_defconfig'
Merged configuration 'c:/Users/91833/Documents/NordicSemiconductor/myApps/RedSOS-Touch/prj.conf'
CMake Error at C:/ncs/v2.6.0__/zephyr/cmake/modules/kconfig.cmake:358 (message):
  command failed with return code: 1
Call Stack (most recent call first):
  C:/ncs/v2.6.0__/nrf/cmake/modules/kconfig.cmake:29 (include)
  C:/ncs/v2.6.0__/zephyr/cmake/modules/zephyr_default.cmake:129 (include)
  C:/ncs/v2.6.0__/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:66 (include)
  C:/ncs/v2.6.0__/zephyr/share/zephyr-package/cmake/ZephyrConfig.cmake:92 (include_boilerplate)
  CMakeLists.txt:8 (find_package)

Any thoughts?

EDIT: A small addendum - I read the Image Versions doc and it specifies two related macros: CONFIG_FW_INFO_FIRMWARE_VERSION and CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION. The latter, as the document states, is an alternative to using the VERSION file. So I'm a little confused as to whether I should set these or not if I already have a VERSION file? particularly the first one - CONFIG_FW_INFO_FIRMWARE_VERSION?

RE: How do I access VERSION file parameters from prj.conf?

Simonr — Fri, 31 May 2024 09:13:43 GMT

Yes, this should be possible, but you have to format it as a string, so CONFIG_BT_DIS_FW_REV_STR="0.0.1" for example.

What kind of build failures/error messages are you seeing exactly? They usually provide a hint towards what exactly is wrong or a suggestion on what to do, so please follow that, or upload the build log here if you're confused.

Best regards,

Simon