跳转至

version

version 提供固件版本号与 SDK 版本标识的获取功能,返回编译时生成的版本字符串。

头文件清单

#include "include/cfbb_version.h"
#include "include/middleware/utils/sdk_version.h"

接口清单

接口名称 功能简述
uapi_get_cfbb_version 获取CFBB版本号字符串
uapi_sdk_read_id 获取SDK版本标识字符串

Functions

uapi_get_cfbb_version

const char *uapi_get_cfbb_version(void)

头文件清单

#include "include/cfbb_version.h"

功能说明

  • 返回当前CFBB(Common Firmware Base Build)版本号,字符串格式,如"CFBB 0.9.0.5"
  • 版本号由编译时宏CFBB_VER_MAJOR、CFBB_VER_MINOR、CFBB_VER_RELEASE、CFBB_VER_PATCH组合生成
  • 该接口为静态内联函数,在头文件中直接实现,无需链接外部符号

返回值

  • 返回类型:const char *
返回值 文字含义 触发场景
非NULL指针 CFBB版本号字符串 正常调用

uapi_sdk_read_id

const char *uapi_sdk_read_id(void)

头文件清单

#include "include/middleware/utils/sdk_version.h"

功能说明

  • 获取SDK固件版本标识字符串,包含编译时间与固件版本信息
  • 返回的字符串由构建系统在编译时注入,内容为编译时间与固件版本号的组合
  • 该接口通过内部调用get_version_string()获取版本信息,无入参要求

返回值

  • 返回类型:const char *
返回值 文字含义 触发场景
非NULL指针 SDK版本标识字符串 正常调用

Macros

CFBB_VER_MAJOR

/* Major version number (X.y.z[.p]) */
#define CFBB_VER_MAJOR      0

CFBB_VER_MINOR

/* Minor version number (x.Y.z[.p]) */
#define CFBB_VER_MINOR      9

CFBB_VER_RELEASE

/* Release version nubmer (x.y.Z[.p]) */
#define CFBB_VER_RELEASE    0

CFBB_VER_PATCH

/* Patch version number (x.y.z[.P]) */
#define CFBB_VER_PATCH      5

CFBB_VERSION_VALUE

#define CFBB_VERSION_VALUE(x, y, z, p)      (((x) << 24) | ((y) << 16) | ((z) << 8) | (p))

CFBB_VERSION

#define CFBB_VERSION    CFBB_VERSION_VALUE(CFBB_VER_MAJOR, CFBB_VER_MINOR, CFBB_VER_RELEASE, CFBB_VER_PATCH)

MAKE_VERSION_STR_IMPL

#if CFBB_VER_PATCH == 0
#define MAKE_VERSION_STR_IMPL(x, y, z, p)   "CFBB "#x"."#y"."#z
#else
#define MAKE_VERSION_STR_IMPL(x, y, z, p)   "CFBB "#x"."#y"."#z"."#p
#endif

MAKE_VERSION_STR

#define MAKE_VERSION_STR(x, y, z, p)        MAKE_VERSION_STR_IMPL(x, y, z, p)

CFBB_VERSION_STR

#define CFBB_VERSION_STR    MAKE_VERSION_STR(CFBB_VER_MAJOR, CFBB_VER_MINOR, CFBB_VER_RELEASE, CFBB_VER_PATCH)