1 /*
2  * Copyright (c) 2021, STMicroelectronics.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 /*
8  * @file	version.h
9  * @brief	Library version information for OpenAMP.
10  */
11 
12 #ifndef __OPENAMP_VERSION__H__
13 #define __OPENAMP_VERSION__H__
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 /** \defgroup versions Library Version Interfaces
20  *  @{
21  */
22 
23 /**
24  * @brief Library major version number.
25  *
26  * Return the major version number of the library linked into the application.
27  * This is required to match the value of LIB_VERSION_MAJOR, which is the major
28  * version of the library that the application was compiled against.
29  *
30  * @return Library major version number.
31  *
32  * @see PROJECT_VERSION_MAJOR
33  */
34 extern int openamp_version_major(void);
35 
36 /**
37  * @brief Library minor version number.
38  *
39  * Return the minor version number of the library linked into the application.
40  * This could differ from the value of LIB_VERSION_MINOR, which is the minor
41  * version of the library that the application was compiled against.
42  *
43  * @return Library minor version number.
44  *
45  * @see PROJECT_VERSION_MINOR
46  */
47 extern int openamp_version_minor(void);
48 
49 /**
50  * @brief Library patch level.
51  *
52  * Return the patch level of the library linked into the application.  This
53  * could differ from the value of LIB_VERSION_PATCH, which is the patch level of
54  * the library that the application was compiled against.
55  *
56  * @return Library patch level.
57  *
58  * @see PROJECT_VERSION_PATCH
59  */
60 extern int openamp_version_patch(void);
61 
62 /**
63  * @brief Library version string.
64  *
65  * Return the version string of the library linked into the application.  This
66  * could differ from the value of LIB_VERSION, which is the version string of
67  * the library that the application was compiled against.
68  *
69  * @return Library version string.
70  *
71  * @see PROJECT_VERSION
72  */
73 extern const char *openamp_version(void);
74 
75 /** @} */
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif /* __OPENAMP_VERSION__H__ */
82