unleashed-firmware/lib/toolbox/version.h
hedger 4d6b170769
[FL-2520] FW build with -Wextra ()
* Fixing compiler warnings with -Wextra
* More warnings suppression, WIP
* Even more warning fixes
* Added new lines at end of text files.
* Padding fix
* Additional fixes to warnings on different build configurations; added -Wextra to default build pipeline
* Fixes for Secplus v1
* -additional warnings
* +-Wredundant-decls fixes
* FuriHal: print stack overflow task name in console
* FuriHal: add missing include

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2022-05-06 16:37:10 +03:00

88 lines
2.1 KiB
C

#pragma once
#include <stdint.h>
#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct Version Version;
/** 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 pointer to Version data.
*/
const Version* version_get(void);
/** Get git commit hash.
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return git hash
*/
const char* version_get_githash(const Version* v);
/** Get git branch.
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return git branch
*/
const char* version_get_gitbranch(const Version* v);
/** Get number of commit in git branch.
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return number of commit
*/
const char* version_get_gitbranchnum(const Version* v);
/** Get build date.
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return build date
*/
const char* version_get_builddate(const Version* v);
/** Get build version. Build version is last tag in git history.
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return build date
*/
const char* version_get_version(const Version* v);
/** Get hardware target this firmware was built for
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return build date
*/
uint8_t version_get_target(const Version* v);
/** Get flag indicating if this build is "dirty" (source code had uncommited changes)
*
* @param v pointer to Version data. NULL for currently running
* software.
*
* @return build date
*/
bool version_get_dirty_flag(const Version* v);
#ifdef __cplusplus
}
#endif