|
|
@@ -1,71 +1,76 @@
|
|
|
#pragma once
|
|
|
|
|
|
+#include <stdint.h>
|
|
|
+
|
|
|
#ifdef __cplusplus
|
|
|
extern "C" {
|
|
|
#endif
|
|
|
|
|
|
typedef struct Version Version;
|
|
|
|
|
|
-/**
|
|
|
- * Gets current running firmware version handle.
|
|
|
- * You can store it somewhere. But if you want to retrieve data,
|
|
|
- * you have to use 'version_*_get()' set of functions.
|
|
|
- * Also, 'version_*_get()' imply to use this
|
|
|
+/** Get current running firmware version handle.
|
|
|
+ *
|
|
|
+ * You can store it somewhere. But if you want to retrieve data, you have to use
|
|
|
+ * 'version_*_get()' set of functions. Also, 'version_*_get()' imply to use this
|
|
|
* handle if no handle (NULL_PTR) provided.
|
|
|
*
|
|
|
- * @return Handle to version data.
|
|
|
+ * @return pointer to Version data.
|
|
|
*/
|
|
|
const Version* version_get(void);
|
|
|
|
|
|
-/**
|
|
|
- * Gets git hash of build commit.
|
|
|
+/** Get git commit hash.
|
|
|
*
|
|
|
- * @param v - ptr to version handle. If zero - gets current running fw info.
|
|
|
- * @return git hash
|
|
|
+ * @param v pointer to Version data. NULL for currently running
|
|
|
+ * software.
|
|
|
+ *
|
|
|
+ * @return git hash
|
|
|
*/
|
|
|
const char* version_get_githash(const Version* v);
|
|
|
|
|
|
-/**
|
|
|
- * Gets git branch of build commit.
|
|
|
+/** Get git branch.
|
|
|
+ *
|
|
|
+ * @param v pointer to Version data. NULL for currently running
|
|
|
+ * software.
|
|
|
*
|
|
|
- * @param v - ptr to version handle. If zero - gets current running fw info.
|
|
|
- * @return git branch
|
|
|
+ * @return git branch
|
|
|
*/
|
|
|
const char* version_get_gitbranch(const Version* v);
|
|
|
|
|
|
-/**
|
|
|
- * Gets git number of build commit.
|
|
|
+/** Get number of commit in git branch.
|
|
|
*
|
|
|
- * @param v - ptr to version handle. If zero - gets current running fw info.
|
|
|
- * @return number of commit
|
|
|
+ * @param v pointer to Version data. NULL for currently running
|
|
|
+ * software.
|
|
|
+ *
|
|
|
+ * @return number of commit
|
|
|
*/
|
|
|
const char* version_get_gitbranchnum(const Version* v);
|
|
|
|
|
|
-/**
|
|
|
- * Gets build date.
|
|
|
+/** Get build date.
|
|
|
+ *
|
|
|
+ * @param v pointer to Version data. NULL for currently running
|
|
|
+ * software.
|
|
|
*
|
|
|
- * @param v - ptr to version handle. If zero - gets current running fw info.
|
|
|
- * @return build date
|
|
|
+ * @return build date
|
|
|
*/
|
|
|
const char* version_get_builddate(const Version* v);
|
|
|
|
|
|
-/**
|
|
|
- * Gets build version.
|
|
|
- * Build version is last tag in git history.
|
|
|
+/** Get build version. Build version is last tag in git history.
|
|
|
*
|
|
|
- * @param v - ptr to version handle. If zero - gets current running fw info.
|
|
|
- * @return build date
|
|
|
+ * @param v pointer to Version data. NULL for currently running
|
|
|
+ * software.
|
|
|
+ *
|
|
|
+ * @return build date
|
|
|
*/
|
|
|
const char* version_get_version(const Version* v);
|
|
|
|
|
|
-/**
|
|
|
- * Gets firmware target.
|
|
|
- * Build version is last tag for build commit.
|
|
|
+/** Get hardware target this firmware was built for
|
|
|
+ *
|
|
|
+ * @param v pointer to Version data. NULL for currently running
|
|
|
+ * software.
|
|
|
*
|
|
|
- * @param v - ptr to version handle. If zero - gets current running fw info.
|
|
|
- * @return build date
|
|
|
+ * @return build date
|
|
|
*/
|
|
|
-const char* version_get_target(const Version* v);
|
|
|
+const uint8_t version_get_target(const Version* v);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
}
|