1/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
 2/*
 3 * This file is provided under a dual BSD/GPLv2 license.  When using or
 4 * redistributing this file, you may do so under either license.
 5 *
 6 * Copyright(c) 2020 Intel Corporation. All rights reserved.
 7 */
 8
 9/*
10 * Extended manifest is a place to store metadata about firmware, known during
11 * compilation time - for example firmware version or used compiler.
12 * Given information are read on host side before firmware startup.
13 * This part of output binary is not signed.
14 */
15
16#ifndef __SOF_FIRMWARE_EXT_MANIFEST_H__
17#define __SOF_FIRMWARE_EXT_MANIFEST_H__
18
19#include <linux/bits.h>
20#include <linux/compiler.h>
21#include <linux/types.h>
22#include <sound/sof/info.h>
23
24/* In ASCII `XMan` */
25#define SOF_EXT_MAN_MAGIC_NUMBER	0x6e614d58
26
27/* Build u32 number in format MMmmmppp */
28#define SOF_EXT_MAN_BUILD_VERSION(MAJOR, MINOR, PATH) ((uint32_t)( \
29	((MAJOR) << 24) | \
30	((MINOR) << 12) | \
31	(PATH)))
32
33/* check extended manifest version consistency */
34#define SOF_EXT_MAN_VERSION_INCOMPATIBLE(host_ver, cli_ver) ( \
35	((host_ver) & GENMASK(31, 24)) != \
36	((cli_ver) & GENMASK(31, 24)))
37
38/* used extended manifest header version */
39#define SOF_EXT_MAN_VERSION		SOF_EXT_MAN_BUILD_VERSION(1, 0, 0)
40
41/* extended manifest header, deleting any field breaks backward compatibility */
42struct sof_ext_man_header {
43	uint32_t magic;		/*< identification number, */
44				/*< EXT_MAN_MAGIC_NUMBER */
45	uint32_t full_size;	/*< [bytes] full size of ext_man, */
46				/*< (header + content + padding) */
47	uint32_t header_size;	/*< [bytes] makes header extensionable, */
48				/*< after append new field to ext_man header */
49				/*< then backward compatible won't be lost */
50	uint32_t header_version; /*< value of EXT_MAN_VERSION */
51				/*< not related with following content */
52
53	/* just after this header should be list of ext_man_elem_* elements */
54} __packed;
55
56/* Now define extended manifest elements */
57
58/* Extended manifest elements types */
59enum sof_ext_man_elem_type {
60	SOF_EXT_MAN_ELEM_FW_VERSION		= 0,
61	SOF_EXT_MAN_ELEM_WINDOW			= SOF_IPC_EXT_WINDOW,
62	SOF_EXT_MAN_ELEM_CC_VERSION		= SOF_IPC_EXT_CC_INFO,
63};
64
65/* extended manifest element header */
66struct sof_ext_man_elem_header {
67	uint32_t type;		/*< SOF_EXT_MAN_ELEM_ */
68	uint32_t size;		/*< in bytes, including header size */
69
70	/* just after this header should be type dependent content */
71} __packed;
72
73/* FW version */
74struct sof_ext_man_fw_version {
75	struct sof_ext_man_elem_header hdr;
76	/* use sof_ipc struct because of code re-use */
77	struct sof_ipc_fw_version version;
78	uint32_t flags;
79} __packed;
80
81/* extended data memory windows for IPC, trace and debug */
82struct sof_ext_man_window {
83	struct sof_ext_man_elem_header hdr;
84	/* use sof_ipc struct because of code re-use */
85	struct sof_ipc_window ipc_window;
86} __packed;
87
88/* Used C compiler description */
89struct sof_ext_man_cc_version {
90	struct sof_ext_man_elem_header hdr;
91	/* use sof_ipc struct because of code re-use */
92	struct sof_ipc_cc_version cc_version;
93} __packed;
94
95#endif /* __SOF_FIRMWARE_EXT_MANIFEST_H__ */