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