aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/linux-headers/sound/sof/abi.h
blob: b0ee41451a06451fe84a1b826b149a0171203a11 (plain) (blame)
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
/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */ 
/* 
 * This file is provided under a dual BSD/GPLv2 license.  When using or 
 * redistributing this file, you may do so under either license. 
 * 
 * Copyright(c) 2018 Intel Corporation. All rights reserved. 
 */ 
 
/** 
 * SOF ABI versioning is based on Semantic Versioning where we have a given 
 * MAJOR.MINOR.PATCH version number. See https://semver.org/ 
 * 
 * Rules for incrementing or changing version :- 
 * 
 * 1) Increment MAJOR version if you make incompatible API changes. MINOR and 
 *    PATCH should be reset to 0. 
 * 
 * 2) Increment MINOR version if you add backwards compatible features or 
 *    changes. PATCH should be reset to 0. 
 * 
 * 3) Increment PATCH version if you add backwards compatible bug fixes. 
 */ 
 
#ifndef __INCLUDE_UAPI_SOUND_SOF_ABI_H__ 
#define __INCLUDE_UAPI_SOUND_SOF_ABI_H__ 
 
/* SOF ABI version major, minor and patch numbers */ 
#define SOF_ABI_MAJOR 3 
#define SOF_ABI_MINOR 13 
#define SOF_ABI_PATCH 0 
 
/* SOF ABI version number. Format within 32bit word is MMmmmppp */ 
#define SOF_ABI_MAJOR_SHIFT	24 
#define SOF_ABI_MAJOR_MASK	0xff 
#define SOF_ABI_MINOR_SHIFT	12 
#define SOF_ABI_MINOR_MASK	0xfff 
#define SOF_ABI_PATCH_SHIFT	0 
#define SOF_ABI_PATCH_MASK	0xfff 
 
#define SOF_ABI_VER(major, minor, patch) \ 
	(((major) << SOF_ABI_MAJOR_SHIFT) | \ 
	((minor) << SOF_ABI_MINOR_SHIFT) | \ 
	((patch) << SOF_ABI_PATCH_SHIFT)) 
 
#define SOF_ABI_VERSION_MAJOR(version) \ 
	(((version) >> SOF_ABI_MAJOR_SHIFT) & SOF_ABI_MAJOR_MASK) 
#define SOF_ABI_VERSION_MINOR(version)	\ 
	(((version) >> SOF_ABI_MINOR_SHIFT) & SOF_ABI_MINOR_MASK) 
#define SOF_ABI_VERSION_PATCH(version)	\ 
	(((version) >> SOF_ABI_PATCH_SHIFT) & SOF_ABI_PATCH_MASK) 
 
#define SOF_ABI_VERSION_INCOMPATIBLE(sof_ver, client_ver)		\ 
	(SOF_ABI_VERSION_MAJOR((sof_ver)) !=				\ 
		SOF_ABI_VERSION_MAJOR((client_ver))			\ 
	) 
 
#define SOF_ABI_VERSION SOF_ABI_VER(SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH) 
 
/* SOF ABI magic number "SOF\0". */ 
#define SOF_ABI_MAGIC		0x00464F53 
 
#endif