aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/version.h
blob: 89121777a654aafad0e3cdb1cb7a50e7597074a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* Copyright (c) 2013, Linaro Limited
 * All rights reserved.
 *
 * SPDX-License-Identifier:     BSD-3-Clause
 */


/**
 * @file
 *
 * ODP version
 */

#ifndef ODP_API_VERSION_H_
#define ODP_API_VERSION_H_

#ifdef __cplusplus
extern "C" {
#endif

/** @defgroup odp_version ODP VERSION
 *  @{
 */

/**
 * ODP API generation version
 *
 * Introduction of major new features or changes that make
 * very significant changes to the API. APIs with different
 * versions are likely not backward compatible.
 */
#define ODP_VERSION_API_GENERATION 1

/**
 * ODP API major version
 *
 * Introduction of major new features or changes. APIs with different major
 * versions are likely not backward compatible.
 */
#define ODP_VERSION_API_MAJOR 4

/**
 * ODP API minor version
 *
 * Minor version is incremented when introducing backward compatible changes
 * to the API. For an API with common generation and major version, but with
 * different minor numbers the two versions are backward compatible.
 */
#define ODP_VERSION_API_MINOR 1

/**
 * Returns ODP API version string
 */
const char *odp_version_api_str(void);


/**
 * Returns ODP implementation version string
 *
 * Every implementation of ODP may receive bug fixes independent of the version
 * of the API changing, this function returns that indication string.
 * @note This string is implementation specific.
 * @sa odp_version_api_str()
 *
 * @return null terminated implementation specific version identifier string
  */
const char *odp_version_impl_str(void);
/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif