mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-24 02:23:33 +08:00
version cleanup: move all version information into version.c and use a common API
The provided versioning information is the same, except for some additions, like OS version (which still need to be implemented on NuttX).
This commit is contained in:
Beat Küng
@@ -0,0 +1,41 @@
|
||||
############################################################################
|
||||
#
|
||||
# Copyright (c) 2016 PX4 Development Team. All rights reserved.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without
|
||||
# modification, are permitted provided that the following conditions
|
||||
# are met:
|
||||
#
|
||||
# 1. Redistributions of source code must retain the above copyright
|
||||
# notice, this list of conditions and the following disclaimer.
|
||||
# 2. Redistributions in binary form must reproduce the above copyright
|
||||
# notice, this list of conditions and the following disclaimer in
|
||||
# the documentation and/or other materials provided with the
|
||||
# distribution.
|
||||
# 3. Neither the name PX4 nor the names of its contributors may be
|
||||
# used to endorse or promote products derived from this software
|
||||
# without specific prior written permission.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||||
# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
||||
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
# POSSIBILITY OF SUCH DAMAGE.
|
||||
#
|
||||
############################################################################
|
||||
px4_add_module(
|
||||
MODULE lib__version
|
||||
COMPILE_FLAGS
|
||||
SRCS
|
||||
version.c
|
||||
DEPENDS
|
||||
platforms__common
|
||||
)
|
||||
# vim: set noet ft=cmake fenc=utf-8 ff=unix :
|
||||
@@ -0,0 +1,258 @@
|
||||
/****************************************************************************
|
||||
*
|
||||
* Copyright (c) 2016 PX4 Development Team. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* 3. Neither the name PX4 nor the names of its contributors may be
|
||||
* used to endorse or promote products derived from this software
|
||||
* without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||||
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
||||
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
* POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
#include "version.h"
|
||||
|
||||
#include "build_git_version.h" //generated from build_git_version.h.in
|
||||
|
||||
#include <string.h>
|
||||
|
||||
#if !defined(CONFIG_CDCACM_PRODUCTID)
|
||||
# define CONFIG_CDCACM_PRODUCTID 0
|
||||
#endif
|
||||
|
||||
#if defined(__PX4_LINUX)
|
||||
#include <sys/utsname.h>
|
||||
#endif
|
||||
|
||||
// dev >= 0
|
||||
// alpha >= 64
|
||||
// beta >= 128
|
||||
// release candidate >= 192
|
||||
// release == 255
|
||||
enum FIRMWARE_TYPE {
|
||||
FIRMWARE_TYPE_DEV = 0,
|
||||
FIRMWARE_TYPE_ALPHA = 64,
|
||||
FIRMWARE_TYPE_BETA = 128,
|
||||
FIRMWARE_TYPE_RC = 192,
|
||||
FIRMWARE_TYPE_RELEASE = 255
|
||||
};
|
||||
|
||||
/**
|
||||
* Convert a version tag string to a number
|
||||
* @param tag version tag in one of the following forms:
|
||||
* - dev: v1.4.0rc3-7-g7e282f57
|
||||
* - rc: v1.4.0rc4
|
||||
* - release: v1.4.0
|
||||
* - linux: 7.9.3
|
||||
* @return version in the form 0xAABBCCTT (AA: Major, BB: Minor, CC: Patch, TT Type @see FIRMWARE_TYPE)
|
||||
*/
|
||||
static uint32_t version_tag_to_number(const char *tag)
|
||||
{
|
||||
uint32_t ver = 0;
|
||||
unsigned len = strlen(tag);
|
||||
unsigned mag = 0;
|
||||
int32_t type = -1;
|
||||
unsigned dashcount = 0;
|
||||
|
||||
for (int i = len - 1; i >= 0; i--) {
|
||||
|
||||
if (tag[i] == '-') {
|
||||
dashcount++;
|
||||
}
|
||||
|
||||
if (tag[i] >= '0' && tag[i] <= '9') {
|
||||
if (mag < 32) {
|
||||
unsigned number = tag[i] - '0';
|
||||
|
||||
ver += (number << mag);
|
||||
mag += 8;
|
||||
}
|
||||
|
||||
} else if (tag[i] == '.') {
|
||||
continue;
|
||||
|
||||
} else if (i > 3 && type == -1) {
|
||||
/* scan and look for signature characters for each type */
|
||||
const char *curr = &tag[i - 1];
|
||||
|
||||
while (curr > &tag[0]) {
|
||||
if (*curr == 'v') {
|
||||
type = FIRMWARE_TYPE_DEV;
|
||||
break;
|
||||
|
||||
} else if (*curr == 'p') {
|
||||
type = FIRMWARE_TYPE_ALPHA;
|
||||
break;
|
||||
|
||||
} else if (*curr == 't') {
|
||||
type = FIRMWARE_TYPE_BETA;
|
||||
break;
|
||||
|
||||
} else if (*curr == 'r') {
|
||||
type = FIRMWARE_TYPE_RC;
|
||||
break;
|
||||
}
|
||||
|
||||
curr--;
|
||||
}
|
||||
|
||||
/* looks like a release */
|
||||
if (type == -1) {
|
||||
type = FIRMWARE_TYPE_RELEASE;
|
||||
}
|
||||
|
||||
} else if (tag[i] != 'v') {
|
||||
/* reset, because we don't have a full tag but
|
||||
* are seeing non-numeric characters (eg. '-')
|
||||
*/
|
||||
ver = 0;
|
||||
mag = 0;
|
||||
}
|
||||
}
|
||||
|
||||
/* if git describe contains dashes this is not a real tag */
|
||||
if (dashcount > 0) {
|
||||
type = FIRMWARE_TYPE_DEV;
|
||||
}
|
||||
|
||||
/* looks like a release */
|
||||
if (type == -1) {
|
||||
type = FIRMWARE_TYPE_RELEASE;
|
||||
}
|
||||
|
||||
ver = (ver << 8);
|
||||
|
||||
return ver | type;
|
||||
}
|
||||
|
||||
|
||||
uint32_t px4_firmware_version(void)
|
||||
{
|
||||
return version_tag_to_number(PX4_GIT_TAG_STR);
|
||||
}
|
||||
|
||||
uint32_t px4_board_version(void)
|
||||
{
|
||||
#if defined(__PX4_NUTTX)
|
||||
return CONFIG_CDCACM_PRODUCTID;
|
||||
#else
|
||||
return 1;
|
||||
#endif
|
||||
}
|
||||
|
||||
uint32_t px4_os_version(void)
|
||||
{
|
||||
#if defined(__PX4_DARWIN)
|
||||
return 0; //TODO: implement version for Darwin
|
||||
#elif defined(__PX4_LINUX)
|
||||
struct utsname name;
|
||||
|
||||
if (uname(&name) == 0) {
|
||||
char *c = name.release;
|
||||
|
||||
// cut the part after the first '-'
|
||||
while (*c && *c != '-') {
|
||||
++c;
|
||||
}
|
||||
|
||||
*c = 0;
|
||||
return version_tag_to_number(name.release);
|
||||
|
||||
} else {
|
||||
return 0;
|
||||
}
|
||||
|
||||
#elif defined(__PX4_QURT)
|
||||
return 0; //TODO: implement version for QuRT
|
||||
#elif defined(__PX4_NUTTX)
|
||||
return version_tag_to_number("v7.18.0"); //TODO: get correct version
|
||||
#else
|
||||
# error "px4_os_version not implemented for current OS"
|
||||
#endif
|
||||
}
|
||||
|
||||
const char *px4_os_version_string(void)
|
||||
{
|
||||
#if defined(__PX4_NUTTX)
|
||||
return NULL; //TODO: get NuttX git tag as string
|
||||
#else
|
||||
return NULL;
|
||||
#endif
|
||||
}
|
||||
|
||||
const char *px4_os_name(void)
|
||||
{
|
||||
#if defined(__PX4_DARWIN)
|
||||
return "Darwin";
|
||||
#elif defined(__PX4_LINUX)
|
||||
return "Linux";
|
||||
#elif defined(__PX4_QURT)
|
||||
return "QuRT";
|
||||
#elif defined(__PX4_NUTTX)
|
||||
return "NuttX";
|
||||
#else
|
||||
# error "px4_os_name not implemented for current OS"
|
||||
#endif
|
||||
}
|
||||
|
||||
const char *px4_toolchain_name(void)
|
||||
{
|
||||
#if defined(__clang__)
|
||||
return "Clang/LLVM";
|
||||
#elif defined(__ICC) || defined(__INTEL_COMPILER)
|
||||
return "Intel ICC";
|
||||
#elif defined(__GNUC__) || defined(__GNUG__)
|
||||
return "GNU GCC";
|
||||
#elif defined(_MSC_VER)
|
||||
return "MS Visual Studio";
|
||||
#else
|
||||
return "Unknown";
|
||||
#endif
|
||||
}
|
||||
|
||||
const char *px4_toolchain_version(void)
|
||||
{
|
||||
#ifdef __VERSION__
|
||||
return __VERSION__;
|
||||
#else
|
||||
return "";
|
||||
#endif
|
||||
}
|
||||
|
||||
const char *px4_firmware_version_string(void)
|
||||
{
|
||||
return PX4_GIT_VERSION_STR;
|
||||
}
|
||||
|
||||
uint64_t px4_firmware_version_binary(void)
|
||||
{
|
||||
return PX4_GIT_VERSION_BINARY;
|
||||
}
|
||||
|
||||
uint64_t px4_os_version_binary(void)
|
||||
{
|
||||
//TODO: get NuttX version via git tag
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -38,10 +38,12 @@
|
||||
* Tools for system version detection.
|
||||
*
|
||||
* @author Anton Babushkin <anton.babushkin@me.com>
|
||||
* @author Beat Küng <beat-kueng@gmx.net>
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#define FREEZE_STR(s) #s
|
||||
#define STRINGIFY(s) FREEZE_STR(s)
|
||||
@@ -79,7 +81,60 @@ static inline const char *px4_board_name(void)
|
||||
return BOARD_NAME;
|
||||
}
|
||||
|
||||
/**
|
||||
* get the PX4 Firmware version
|
||||
* @return version in the form 0xAABBCCTT (AA: Major, BB: Minor, CC: Patch, TT Type @see FIRMWARE_TYPE)
|
||||
*/
|
||||
__EXPORT uint32_t px4_firmware_version(void);
|
||||
|
||||
/**
|
||||
* get the board version (last 8 bytes should be silicon ID, if any)
|
||||
*/
|
||||
__EXPORT uint32_t px4_board_version(void);
|
||||
|
||||
/**
|
||||
* operating system version
|
||||
* @return version in the form 0xAABBCCTT (AA: Major, BB: Minor, CC: Patch, TT Type @see FIRMWARE_TYPE)
|
||||
*/
|
||||
__EXPORT uint32_t px4_os_version(void);
|
||||
|
||||
/**
|
||||
* Operating system version as human readable string (git tag)
|
||||
* @return string or NULL if not defined
|
||||
*/
|
||||
__EXPORT const char *px4_os_version_string(void);
|
||||
|
||||
/**
|
||||
* name of the operating system
|
||||
* @return human readable string
|
||||
*/
|
||||
__EXPORT const char *px4_os_name(void);
|
||||
|
||||
/**
|
||||
* Toolchain name used to compile PX4
|
||||
*/
|
||||
__EXPORT const char *px4_toolchain_name(void);
|
||||
|
||||
/**
|
||||
* Toolchain version used to compile PX4 (no particular format)
|
||||
*/
|
||||
__EXPORT const char *px4_toolchain_version(void);
|
||||
|
||||
/**
|
||||
* Firmware version as human readable string (git tag)
|
||||
*/
|
||||
__EXPORT const char *px4_firmware_version_string(void);
|
||||
|
||||
/**
|
||||
* Firmware version in binary form (first part of the git tag)
|
||||
*/
|
||||
__EXPORT uint64_t px4_firmware_version_binary(void);
|
||||
|
||||
/**
|
||||
* Operating system version in binary form (first part of the git tag)
|
||||
* @return this is not available on all OSes and can return 0
|
||||
*/
|
||||
__EXPORT uint64_t px4_os_version_binary(void);
|
||||
|
||||
__END_DECLS
|
||||
|
||||
|
||||
Reference in New Issue
Block a user