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 /**
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 METAL_VER_MAJOR, which is the major
28  *  version of the library that the application was compiled against.
29  *
30  *  @return	Library major version number.
31  *  @see	METAL_VER_MAJOR
32  */
33 int metal_ver_major(void);
34 
35 /**
36  *  @brief	Library minor version number.
37  *
38  *  Return the minor version number of the library linked into the application.
39  *  This could differ from the value of METAL_VER_MINOR, which is the minor
40  *  version of the library that the application was compiled against.
41  *
42  *  @return	Library minor version number.
43  *  @see	METAL_VER_MINOR
44  */
45 int metal_ver_minor(void);
46 
47 /**
48  *  @brief	Library patch level.
49  *
50  *  Return the patch level of the library linked into the application.  This
51  *  could differ from the value of METAL_VER_PATCH, which is the patch level of
52  *  the library that the application was compiled against.
53  *
54  *  @return	Library patch level.
55  *  @see	METAL_VER_PATCH
56  */
57 int metal_ver_patch(void);
58 
59 /**
60  *  @brief	Library version string.
61  *
62  *  Return the version string of the library linked into the application.  This
63  *  could differ from the value of METAL_VER, which is the version string of
64  *  the library that the application was compiled against.
65  *
66  *  @return	Library version string.
67  *  @see	METAL_VER
68  */
69 const char *metal_ver(void);
70 
71 /** @} */
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif /* __METAL_VERSION__H__ */
78