summaryrefslogtreecommitdiff
path: root/libavb/avb_version.h (plain)
blob: 7757d090d39cad05a680f089c671d06778cdbe1e
1/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25#if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION)
26#error "Never include this file directly, include libavb.h instead."
27#endif
28
29#ifndef AVB_VERSION_H_
30#define AVB_VERSION_H_
31
32#include "avb_sysdeps.h"
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/* The version number of AVB - keep in sync with avbtool. */
39#define AVB_VERSION_MAJOR 1
40#define AVB_VERSION_MINOR 0
41#define AVB_VERSION_SUB 0
42
43/* Returns a NUL-terminated string for the libavb version in use. The
44 * returned string usually looks like "%d.%d.%d". Applications must
45 * not make assumptions about the content of this string.
46 *
47 * Boot loaders should display this string in debug/diagnostics output
48 * to aid with debugging.
49 *
50 * This is similar to the string put in the |release_string| string
51 * field in the VBMeta struct by avbtool.
52 */
53const char* avb_version_string(void);
54
55/* TODO: remove when there are no more users of AVB_{MAJOR,MINOR}_VERSION. */
56#define AVB_MAJOR_VERSION AVB_VERSION_MAJOR
57#define AVB_MINOR_VERSION AVB_VERSION_MINOR
58
59#ifdef __cplusplus
60}
61#endif
62
63#endif /* AVB_VERSION_H_ */
64