[linux-2.6-block.git] / include / sound / sof / ext_manifest.h

/* 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) 2020 Intel Corporation
 */

/*
 * Extended manifest is a place to store metadata about firmware, known during
 * compilation time - for example firmware version or used compiler.
 * Given information are read on host side before firmware startup.
 * This part of output binary is not signed.
 */

#ifndef __SOF_FIRMWARE_EXT_MANIFEST_H__
#define __SOF_FIRMWARE_EXT_MANIFEST_H__

#include <linux/bits.h>
#include <linux/compiler.h>
#include <linux/types.h>
#include <sound/sof/info.h>

/* In ASCII `XMan` */
#define SOF_EXT_MAN_MAGIC_NUMBER	0x6e614d58

/* Build u32 number in format MMmmmppp */
#define SOF_EXT_MAN_BUILD_VERSION(MAJOR, MINOR, PATH) ((uint32_t)( \
	((MAJOR) << 24) | \
	((MINOR) << 12) | \
	(PATH)))

/* check extended manifest version consistency */
#define SOF_EXT_MAN_VERSION_INCOMPATIBLE(host_ver, cli_ver) ( \
	((host_ver) & GENMASK(31, 24)) != \
	((cli_ver) & GENMASK(31, 24)))

/* used extended manifest header version */
#define SOF_EXT_MAN_VERSION		SOF_EXT_MAN_BUILD_VERSION(1, 0, 0)

/* extended manifest header, deleting any field breaks backward compatibility */
struct sof_ext_man_header {
	uint32_t magic;		/*< identification number, */
				/*< EXT_MAN_MAGIC_NUMBER */
	uint32_t full_size;	/*< [bytes] full size of ext_man, */
				/*< (header + content + padding) */
	uint32_t header_size;	/*< [bytes] makes header extensionable, */
				/*< after append new field to ext_man header */
				/*< then backward compatible won't be lost */
	uint32_t header_version; /*< value of EXT_MAN_VERSION */
				/*< not related with following content */

	/* just after this header should be list of ext_man_elem_* elements */
} __packed;

/* Now define extended manifest elements */

/* Extended manifest elements types */
enum sof_ext_man_elem_type {
	SOF_EXT_MAN_ELEM_FW_VERSION		= 0,
	SOF_EXT_MAN_ELEM_WINDOW			= 1,
	SOF_EXT_MAN_ELEM_CC_VERSION		= 2,
	SOF_EXT_MAN_ELEM_DBG_ABI		= 4,
	SOF_EXT_MAN_ELEM_CONFIG_DATA		= 5, /**< ABI3.17 */
	SOF_EXT_MAN_ELEM_PLATFORM_CONFIG_DATA   = 6,
};

/* extended manifest element header */
struct sof_ext_man_elem_header {
	uint32_t type;		/*< SOF_EXT_MAN_ELEM_ */
	uint32_t size;		/*< in bytes, including header size */

	/* just after this header should be type dependent content */
} __packed;

/* FW version */
struct sof_ext_man_fw_version {
	struct sof_ext_man_elem_header hdr;
	/* use sof_ipc struct because of code re-use */
	struct sof_ipc_fw_version version;
	uint32_t flags;
} __packed;

/* extended data memory windows for IPC, trace and debug */
struct sof_ext_man_window {
	struct sof_ext_man_elem_header hdr;
	/* use sof_ipc struct because of code re-use */
	struct sof_ipc_window ipc_window;
} __packed;

/* Used C compiler description */
struct sof_ext_man_cc_version {
	struct sof_ext_man_elem_header hdr;
	/* use sof_ipc struct because of code re-use */
	struct sof_ipc_cc_version cc_version;
} __packed;

struct ext_man_dbg_abi {
	struct sof_ext_man_elem_header hdr;
	/* use sof_ipc struct because of code re-use */
	struct sof_ipc_user_abi_version dbg_abi;
} __packed;

/* EXT_MAN_ELEM_CONFIG_DATA elements identificators, ABI3.17 */
enum config_elem_type {
	SOF_EXT_MAN_CONFIG_EMPTY		= 0,
	SOF_EXT_MAN_CONFIG_IPC_MSG_SIZE		= 1,
	SOF_EXT_MAN_CONFIG_MEMORY_USAGE_SCAN	= 2, /**< ABI 3.18 */
};

struct sof_config_elem {
	uint32_t token;
	uint32_t value;
} __packed;

/* firmware configuration information */
struct sof_ext_man_config_data {
	struct sof_ext_man_elem_header hdr;

	struct sof_config_elem elems[];
} __packed;

#endif /* __SOF_FIRMWARE_EXT_MANIFEST_H__ */
Commit	Line	Data
a80cf198 KT	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	*
ea89a742	6	* Copyright(c) 2020 Intel Corporation
a80cf198 KT	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>
3e2a89d3	22	#include <sound/sof/info.h>
a80cf198 KT	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 */
	42	struct 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
3e2a89d3 KT	58	/* Extended manifest elements types */
	59	enum sof_ext_man_elem_type {
	60	SOF_EXT_MAN_ELEM_FW_VERSION = 0,
cc11626d FO	61	SOF_EXT_MAN_ELEM_WINDOW = 1,
	62	SOF_EXT_MAN_ELEM_CC_VERSION = 2,
	63	SOF_EXT_MAN_ELEM_DBG_ABI = 4,
7f09f79d	64	SOF_EXT_MAN_ELEM_CONFIG_DATA = 5, /*< ABI3.17 /
e984f3ef	65	SOF_EXT_MAN_ELEM_PLATFORM_CONFIG_DATA = 6,
3e2a89d3 KT	66	};
3e2a89d3 KT	67
a80cf198 KT	68	/* extended manifest element header */
	69	struct sof_ext_man_elem_header {
	70	uint32_t type; /< SOF_EXT_MAN_ELEM_ /
	71	uint32_t size; /< in bytes, including header size /
	72
	73	/* just after this header should be type dependent content */
	74	} __packed;
	75
3e2a89d3 KT	76	/* FW version */
	77	struct sof_ext_man_fw_version {
	78	struct sof_ext_man_elem_header hdr;
	79	/* use sof_ipc struct because of code re-use */
	80	struct sof_ipc_fw_version version;
	81	uint32_t flags;
	82	} __packed;
	83
8d809c15 KT	84	/* extended data memory windows for IPC, trace and debug */
	85	struct sof_ext_man_window {
	86	struct sof_ext_man_elem_header hdr;
	87	/* use sof_ipc struct because of code re-use */
	88	struct sof_ipc_window ipc_window;
	89	} __packed;
	90
4c4a9751 KT	91	/* Used C compiler description */
	92	struct sof_ext_man_cc_version {
	93	struct sof_ext_man_elem_header hdr;
	94	/* use sof_ipc struct because of code re-use */
	95	struct sof_ipc_cc_version cc_version;
	96	} __packed;
	97
60b7c1ba KT	98	struct ext_man_dbg_abi {
	99	struct sof_ext_man_elem_header hdr;
	100	/* use sof_ipc struct because of code re-use */
	101	struct sof_ipc_user_abi_version dbg_abi;
	102	} __packed;
	103
7f09f79d KT	104	/* EXT_MAN_ELEM_CONFIG_DATA elements identificators, ABI3.17 */
	105	enum config_elem_type {
	106	SOF_EXT_MAN_CONFIG_EMPTY = 0,
	107	SOF_EXT_MAN_CONFIG_IPC_MSG_SIZE = 1,
5b10b629	108	SOF_EXT_MAN_CONFIG_MEMORY_USAGE_SCAN = 2, /*< ABI 3.18 /
7f09f79d KT	109	};
	110
	111	struct sof_config_elem {
	112	uint32_t token;
	113	uint32_t value;
	114	} __packed;
	115
	116	/* firmware configuration information */
	117	struct sof_ext_man_config_data {
	118	struct sof_ext_man_elem_header hdr;
	119
	120	struct sof_config_elem elems[];
	121	} __packed;
	122
a80cf198	123	#endif /* __SOF_FIRMWARE_EXT_MANIFEST_H__ */