1*4882a593Smuzhiyun /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * This file is provided under a dual BSD/GPLv2 license. When using or 4*4882a593Smuzhiyun * redistributing this file, you may do so under either license. 5*4882a593Smuzhiyun * 6*4882a593Smuzhiyun * Copyright(c) 2018 Intel Corporation. All rights reserved. 7*4882a593Smuzhiyun */ 8*4882a593Smuzhiyun 9*4882a593Smuzhiyun /** 10*4882a593Smuzhiyun * SOF ABI versioning is based on Semantic Versioning where we have a given 11*4882a593Smuzhiyun * MAJOR.MINOR.PATCH version number. See https://semver.org/ 12*4882a593Smuzhiyun * 13*4882a593Smuzhiyun * Rules for incrementing or changing version :- 14*4882a593Smuzhiyun * 15*4882a593Smuzhiyun * 1) Increment MAJOR version if you make incompatible API changes. MINOR and 16*4882a593Smuzhiyun * PATCH should be reset to 0. 17*4882a593Smuzhiyun * 18*4882a593Smuzhiyun * 2) Increment MINOR version if you add backwards compatible features or 19*4882a593Smuzhiyun * changes. PATCH should be reset to 0. 20*4882a593Smuzhiyun * 21*4882a593Smuzhiyun * 3) Increment PATCH version if you add backwards compatible bug fixes. 22*4882a593Smuzhiyun */ 23*4882a593Smuzhiyun 24*4882a593Smuzhiyun #ifndef __INCLUDE_UAPI_SOUND_SOF_ABI_H__ 25*4882a593Smuzhiyun #define __INCLUDE_UAPI_SOUND_SOF_ABI_H__ 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun /* SOF ABI version major, minor and patch numbers */ 28*4882a593Smuzhiyun #define SOF_ABI_MAJOR 3 29*4882a593Smuzhiyun #define SOF_ABI_MINOR 17 30*4882a593Smuzhiyun #define SOF_ABI_PATCH 0 31*4882a593Smuzhiyun 32*4882a593Smuzhiyun /* SOF ABI version number. Format within 32bit word is MMmmmppp */ 33*4882a593Smuzhiyun #define SOF_ABI_MAJOR_SHIFT 24 34*4882a593Smuzhiyun #define SOF_ABI_MAJOR_MASK 0xff 35*4882a593Smuzhiyun #define SOF_ABI_MINOR_SHIFT 12 36*4882a593Smuzhiyun #define SOF_ABI_MINOR_MASK 0xfff 37*4882a593Smuzhiyun #define SOF_ABI_PATCH_SHIFT 0 38*4882a593Smuzhiyun #define SOF_ABI_PATCH_MASK 0xfff 39*4882a593Smuzhiyun 40*4882a593Smuzhiyun #define SOF_ABI_VER(major, minor, patch) \ 41*4882a593Smuzhiyun (((major) << SOF_ABI_MAJOR_SHIFT) | \ 42*4882a593Smuzhiyun ((minor) << SOF_ABI_MINOR_SHIFT) | \ 43*4882a593Smuzhiyun ((patch) << SOF_ABI_PATCH_SHIFT)) 44*4882a593Smuzhiyun 45*4882a593Smuzhiyun #define SOF_ABI_VERSION_MAJOR(version) \ 46*4882a593Smuzhiyun (((version) >> SOF_ABI_MAJOR_SHIFT) & SOF_ABI_MAJOR_MASK) 47*4882a593Smuzhiyun #define SOF_ABI_VERSION_MINOR(version) \ 48*4882a593Smuzhiyun (((version) >> SOF_ABI_MINOR_SHIFT) & SOF_ABI_MINOR_MASK) 49*4882a593Smuzhiyun #define SOF_ABI_VERSION_PATCH(version) \ 50*4882a593Smuzhiyun (((version) >> SOF_ABI_PATCH_SHIFT) & SOF_ABI_PATCH_MASK) 51*4882a593Smuzhiyun 52*4882a593Smuzhiyun #define SOF_ABI_VERSION_INCOMPATIBLE(sof_ver, client_ver) \ 53*4882a593Smuzhiyun (SOF_ABI_VERSION_MAJOR((sof_ver)) != \ 54*4882a593Smuzhiyun SOF_ABI_VERSION_MAJOR((client_ver)) \ 55*4882a593Smuzhiyun ) 56*4882a593Smuzhiyun 57*4882a593Smuzhiyun #define SOF_ABI_VERSION SOF_ABI_VER(SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH) 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun /* SOF ABI magic number "SOF\0". */ 60*4882a593Smuzhiyun #define SOF_ABI_MAGIC 0x00464F53 61*4882a593Smuzhiyun 62*4882a593Smuzhiyun #endif 63