1 /*
2  * Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 /*
8  * @file	version.h
9  * @brief	Library version information for libmetal.
10  */
11 
12 #ifndef __METAL_VERSION__H__
13 #define __METAL_VERSION__H__
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 /** \defgroup versions Library Version Interfaces
20  *  @{ */
21 
22 /**
23  *  @brief	Library major version number.
24  *
25  *  Return the major version number of the library linked into the application.
26  *  This is required to match the value of METAL_VER_MAJOR, which is the major
27  *  version of the library that the application was compiled against.
28  *
29  *  @return	Library major version number.
30  *  @see	METAL_VER_MAJOR
31  */
32 extern int metal_ver_major(void);
33 
34 /**
35  *  @brief	Library minor version number.
36  *
37  *  Return the minor version number of the library linked into the application.
38  *  This could differ from the value of METAL_VER_MINOR, which is the minor
39  *  version of the library that the application was compiled against.
40  *
41  *  @return	Library minor version number.
42  *  @see	METAL_VER_MINOR
43  */
44 extern int metal_ver_minor(void);
45 
46 /**
47  *  @brief	Library patch level.
48  *
49  *  Return the patch level of the library linked into the application.  This
50  *  could differ from the value of METAL_VER_PATCH, which is the patch level of
51  *  the library that the application was compiled against.
52  *
53  *  @return	Library patch level.
54  *  @see	METAL_VER_PATCH
55  */
56 extern int metal_ver_patch(void);
57 
58 /**
59  *  @brief	Library version string.
60  *
61  *  Return the version string of the library linked into the application.  This
62  *  could differ from the value of METAL_VER, which is the version string of
63  *  the library that the application was compiled against.
64  *
65  *  @return	Library version string.
66  *  @see	METAL_VER
67  */
68 extern const char *metal_ver(void);
69 
70 /** @} */
71 
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif /* __METAL_VERSION__H__ */
77