OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/bindesc/bindesc_version.c

75 lines
2.7 KiB
C
Raw Normal View History

bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
/*
* Copyright (c) 2023 Yonatan Schachter
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <zephyr/kernel.h>
#include <zephyr/bindesc.h>
build: namespace the generated headers with `zephyr/` Namespaced the generated headers with `zephyr` to prevent potential conflict with other headers. Introduce a temporary Kconfig `LEGACY_GENERATED_INCLUDE_PATH` that is enabled by default. This allows the developers to continue the use of the old include paths for the time being until it is deprecated and eventually removed. The Kconfig will generate a build-time warning message, similar to the `CONFIG_TIMER_RANDOM_GENERATOR`. Updated the includes path of in-tree sources accordingly. Most of the changes here are scripted, check the PR for more info. Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2024-01-24 17:35:04 +08:00
#include <zephyr/version.h>
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_KERNEL_VERSION_STRING)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_STR_DEFINE(kernel_version_string, BINDESC_ID_KERNEL_VERSION_STRING,
KERNEL_VERSION_STRING);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_KERNEL_VERSION_STRING) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_KERNEL_VERSION_MAJOR)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(kernel_version_major, BINDESC_ID_KERNEL_VERSION_MAJOR,
KERNEL_VERSION_MAJOR);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_KERNEL_VERSION_MAJOR) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_KERNEL_VERSION_MINOR)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(kernel_version_minor, BINDESC_ID_KERNEL_VERSION_MINOR,
KERNEL_VERSION_MINOR);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_KERNEL_VERSION_MINOR) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_KERNEL_VERSION_PATCHLEVEL)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(kernel_version_patchlevel, BINDESC_ID_KERNEL_VERSION_PATCHLEVEL,
KERNEL_PATCHLEVEL);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_KERNEL_VERSION_PATCHLEVEL) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_KERNEL_VERSION_NUMBER)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(kernel_version_number, BINDESC_ID_KERNEL_VERSION_NUMBER,
KERNEL_VERSION_NUMBER);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_KERNEL_VERSION_NUMBER) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
bindesc: Add support for the build version values This patch adds bindesc support for the build version values for the kernel and application - BUILD_VERSION and APP_BUILD_VERSION. The kernel's BUILD_VERSION can be overridden at build time. Signed-off-by: Attie Grande <attie.grande@argentum-systems.co.uk>
2024-01-23 07:19:53 +08:00
#if defined(CONFIG_BINDESC_KERNEL_BUILD_VERSION)
BINDESC_STR_DEFINE(kernel_build_version, BINDESC_ID_KERNEL_BUILD_VERSION,
STRINGIFY(BUILD_VERSION));
#endif /* CONFIG_BINDESC_KERNEL_BUILD_VERSION */
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(HAS_APP_VERSION)
build: namespace the generated headers with `zephyr/` Namespaced the generated headers with `zephyr` to prevent potential conflict with other headers. Introduce a temporary Kconfig `LEGACY_GENERATED_INCLUDE_PATH` that is enabled by default. This allows the developers to continue the use of the old include paths for the time being until it is deprecated and eventually removed. The Kconfig will generate a build-time warning message, similar to the `CONFIG_TIMER_RANDOM_GENERATOR`. Updated the includes path of in-tree sources accordingly. Most of the changes here are scripted, check the PR for more info. Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2024-01-24 17:35:04 +08:00
#include <zephyr/app_version.h>
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_APP_VERSION_STRING)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_STR_DEFINE(app_version_string, BINDESC_ID_APP_VERSION_STRING,
APP_VERSION_STRING);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_APP_VERSION_STRING) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_APP_VERSION_MAJOR)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(app_version_major, BINDESC_ID_APP_VERSION_MAJOR,
APP_VERSION_MAJOR);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_APP_VERSION_MAJOR) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_APP_VERSION_MINOR)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(app_version_minor, BINDESC_ID_APP_VERSION_MINOR,
APP_VERSION_MINOR);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_APP_VERSION_MINOR) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_APP_VERSION_PATCHLEVEL)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(app_version_patchlevel, BINDESC_ID_APP_VERSION_PATCHLEVEL,
APP_PATCHLEVEL);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_APP_VERSION_PATCHLEVEL) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#if defined(CONFIG_BINDESC_APP_VERSION_NUMBER)
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
BINDESC_UINT_DEFINE(app_version_number, BINDESC_ID_APP_VERSION_NUMBER,
APP_VERSION_NUMBER);
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(CONFIG_BINDESC_APP_VERSION_NUMBER) */
bindesc: Add initial support for binary descriptor definition Binary descriptors are data objects stored at a known location of a binary image. They can be read by an external tool or image, and are used mostly for build information: version, build time, host information, etc. This commit adds initial support for defining such descriptors. Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2023-03-23 23:54:31 +08:00
bindesc: Add support for the build version values This patch adds bindesc support for the build version values for the kernel and application - BUILD_VERSION and APP_BUILD_VERSION. The kernel's BUILD_VERSION can be overridden at build time. Signed-off-by: Attie Grande <attie.grande@argentum-systems.co.uk>
2024-01-23 07:19:53 +08:00
#if defined(CONFIG_BINDESC_APP_BUILD_VERSION)
BINDESC_STR_DEFINE(app_build_version, BINDESC_ID_APP_BUILD_VERSION,
STRINGIFY(APP_BUILD_VERSION));
#endif /* CONFIG_BINDESC_APP_BUILD_VERSION */
everywhere: replace `#if IS_ENABLED()` as per docs Replace `#if IS_ENABLED()` with `#if defined()` as recommended by the documentation of `IS_ENABLED`. Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 18:59:51 +08:00
#endif /* defined(HAS_APP_VERSION) */