ASoC: SOF: Add userspace ABI support

/* 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 4

#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

/* 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.

 */

#ifndef __INCLUDE_UAPI_SOUND_SOF_USER_EQ_H__

#define __INCLUDE_UAPI_SOUND_SOF_USER_EQ_H__

/* FIR EQ type */

#define SOF_EQ_FIR_IDX_SWITCH	0

#define SOF_EQ_FIR_MAX_SIZE 4096 /* Max size allowed for coef data in bytes */

#define SOF_EQ_FIR_MAX_LENGTH 192 /* Max length for individual filter */

#define SOF_EQ_FIR_MAX_RESPONSES 8 /* A blob can define max 8 FIR EQs */

/*

 * eq_fir_configuration data structure contains this information

 *     uint32_t size

 *	   This is the number of bytes need to store the received EQ

 *	   configuration.

 *     uint16_t channels_in_config

 *         This describes the number of channels in this EQ config data. It

 *         can be different from PLATFORM_MAX_CHANNELS.

 *     uint16_t number_of_responses

 *         0=no responses, 1=one response defined, 2=two responses defined, etc.

 *     int16_t data[]

 *         assign_response[channels_in_config]

 *             0 = use first response, 1 = use 2nd response, etc.

 *             E.g. {0, 0, 0, 0, 1, 1, 1, 1} would apply to channels 0-3 the

 *	       same first defined response and for to channels 4-7 the second.

 *         coef_data[]

 *             Repeated data

 *             { filter_length, output_shift, h[] }

 *	       for every EQ response defined where vector h has filter_length

 *             number of coefficients. Coefficients in h[] are in Q1.15 format.

 *             E.g. 16384 (Q1.15) = 0.5. The shifts are number of right shifts.

 *

 * NOTE: The channels_in_config must be even to have coef_data aligned to

 * 32 bit word in RAM. Therefore a mono EQ assign must be duplicated to 2ch

 * even if it would never used. Similarly a 5ch EQ assign must be increased

 * to 6ch. EQ init will return an error if this is not met.

 *

 * NOTE: The filter_length must be multiple of four. Therefore the filter must

 * be padded from the end with zeros have this condition met.

 */

struct sof_eq_fir_config {

	uint32_t size;

	uint16_t channels_in_config;

	uint16_t number_of_responses;

	/* reserved */

	uint32_t reserved[4];

	int16_t data[];

} __packed;

struct sof_eq_fir_coef_data {

	int16_t length; /* Number of FIR taps */

	int16_t out_shift; /* Amount of right shifts at output */

	/* reserved */

	uint32_t reserved[4];

	int16_t coef[]; /* FIR coefficients */

} __packed;

/* In the struct above there's two 16 bit words (length, shift) and four

 * reserved 32 bit words before the actual FIR coefficients. This information

 * is used in parsing of the configuration blob.

 */

#define SOF_EQ_FIR_COEF_NHEADER \

	(sizeof(struct sof_eq_fir_coef_data) / sizeof(int16_t))

/* IIR EQ type */

#define SOF_EQ_IIR_IDX_SWITCH   0

#define SOF_EQ_IIR_MAX_SIZE 1024 /* Max size allowed for coef data in bytes */

#define SOF_EQ_IIR_MAX_RESPONSES 8 /* A blob can define max 8 IIR EQs */

/* eq_iir_configuration

 *     uint32_t channels_in_config

 *         This describes the number of channels in this EQ config data. It

 *         can be different from PLATFORM_MAX_CHANNELS.

 *     uint32_t number_of_responses_defined

 *         0=no responses, 1=one response defined, 2=two responses defined, etc.

 *     int32_t data[]

 *         Data consist of two parts. First is the response assign vector that

 *	   has length of channels_in_config. The latter part is coefficient

 *         data.

 *         uint32_t assign_response[channels_in_config]

 *             -1 = not defined, 0 = use first response, 1 = use 2nd, etc.

 *             E.g. {0, 0, 0, 0, -1, -1, -1, -1} would apply to channels 0-3 the

 *             same first defined response and leave channels 4-7 unequalized.

 *         coefficient_data[]

 *             <1st EQ>

 *             uint32_t num_biquads

 *             uint32_t num_biquads_in_series

 *             <1st biquad>

 *             int32_t coef_a2       Q2.30 format

 *             int32_t coef_a1       Q2.30 format

 *             int32_t coef_b2       Q2.30 format

 *             int32_t coef_b1       Q2.30 format

 *             int32_t coef_b0       Q2.30 format

 *             int32_t output_shift  number of shifts right, shift left is negative

 *             int32_t output_gain   Q2.14 format

 *             <2nd biquad>

 *             ...

 *             <2nd EQ>

 *

 *         Note: A flat response biquad can be made with a section set to

 *         b0 = 1.0, gain = 1.0, and other parameters set to 0

 *         {0, 0, 0, 0, 1073741824, 0, 16484}

 */

struct sof_eq_iir_config {

	uint32_t size;

	uint32_t channels_in_config;

	uint32_t number_of_responses;

	/* reserved */

	uint32_t reserved[4];

	int32_t data[]; /* eq_assign[channels], eq 0, eq 1, ... */

} __packed;

struct sof_eq_iir_header_df2t {

	uint32_t num_sections;

	uint32_t num_sections_in_series;

	/* reserved */

	uint32_t reserved[4];

	int32_t biquads[]; /* Repeated biquad coefficients */

} __packed;

struct sof_eq_iir_biquad_df2t {

	int32_t a2; /* Q2.30 */

	int32_t a1; /* Q2.30 */

	int32_t b2; /* Q2.30 */

	int32_t b1; /* Q2.30 */

	int32_t b0; /* Q2.30 */

	int32_t output_shift; /* Number of right shifts */

	int32_t output_gain;  /* Q2.14 */

} __packed;

/* A full 22th order equalizer with 11 biquads cover octave bands 1-11 in

 * in the 0 - 20 kHz bandwidth.

 */

#define SOF_EQ_IIR_DF2T_BIQUADS_MAX 11

/* The number of int32_t words in sof_eq_iir_header_df2t:

 *	num_sections, num_sections_in_series, reserved[4]

 */

#define SOF_EQ_IIR_NHEADER_DF2T \

	(sizeof(struct sof_eq_iir_header_df2t) / sizeof(int32_t))

/* The number of int32_t words in sof_eq_iir_biquad_df2t:

 *	a2, a1, b2, b1, b0, output_shift, output_gain

 */

#define SOF_EQ_IIR_NBIQUAD_DF2T \

	(sizeof(struct sof_eq_iir_biquad_df2t) / sizeof(int32_t))

#endif

/* 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.

 */

/*

 * Firmware file format .

 */

#ifndef __INCLUDE_UAPI_SOF_FW_H__

#define __INCLUDE_UAPI_SOF_FW_H__

#define SND_SOF_FW_SIG_SIZE	4

#define SND_SOF_FW_ABI		1

#define SND_SOF_FW_SIG		"Reef"

/*

 * Firmware module is made up of 1 . N blocks of different types. The

 * Block header is used to determine where and how block is to be copied in the

 * DSP/host memory space.

 */

enum snd_sof_fw_blk_type {

	SOF_FW_BLK_TYPE_INVALID	= -1,

	SOF_FW_BLK_TYPE_START	= 0,

	SOF_FW_BLK_TYPE_RSRVD0	= SOF_FW_BLK_TYPE_START,

	SOF_FW_BLK_TYPE_IRAM	= 1,	/* local instruction RAM */

	SOF_FW_BLK_TYPE_DRAM	= 2,	/* local data RAM */

	SOF_FW_BLK_TYPE_SRAM	= 3,	/* system RAM */

	SOF_FW_BLK_TYPE_ROM	= 4,

	SOF_FW_BLK_TYPE_IMR	= 5,

	SOF_FW_BLK_TYPE_RSRVD6	= 6,

	SOF_FW_BLK_TYPE_RSRVD7	= 7,

	SOF_FW_BLK_TYPE_RSRVD8	= 8,

	SOF_FW_BLK_TYPE_RSRVD9	= 9,

	SOF_FW_BLK_TYPE_RSRVD10	= 10,

	SOF_FW_BLK_TYPE_RSRVD11	= 11,

	SOF_FW_BLK_TYPE_RSRVD12	= 12,

	SOF_FW_BLK_TYPE_RSRVD13	= 13,

	SOF_FW_BLK_TYPE_RSRVD14	= 14,

	/* use SOF_FW_BLK_TYPE_RSVRDX for new block types */

	SOF_FW_BLK_TYPE_NUM

};

struct snd_sof_blk_hdr {

	enum snd_sof_fw_blk_type type;

	uint32_t size;		/* bytes minus this header */

	uint32_t offset;	/* offset from base */

} __packed;

/*

 * Firmware file is made up of 1 .. N different modules types. The module

 * type is used to determine how to load and parse the module.

 */

enum snd_sof_fw_mod_type {

	SOF_FW_BASE	= 0,	/* base firmware image */

	SOF_FW_MODULE	= 1,	/* firmware module */

};

struct snd_sof_mod_hdr {

	enum snd_sof_fw_mod_type type;

	uint32_t size;		/* bytes minus this header */

	uint32_t num_blocks;	/* number of blocks */

} __packed;

/*

 * Firmware file header.

 */

struct snd_sof_fw_header {

	unsigned char sig[SND_SOF_FW_SIG_SIZE]; /* "Reef" */

	uint32_t file_size;	/* size of file minus this header */

	uint32_t num_modules;	/* number of modules */

	uint32_t abi;		/* version of header format */

} __packed;

#endif

/* 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.

 */

#ifndef __INCLUDE_UAPI_SOUND_SOF_USER_HEADER_H__

#define __INCLUDE_UAPI_SOUND_SOF_USER_HEADER_H__

/*

 * Header for all non IPC ABI data.

 *

 * Identifies data type, size and ABI.

 * Used by any bespoke component data structures or binary blobs.

 */

struct sof_abi_hdr {

	uint32_t magic;		/**< 'S', 'O', 'F', '\0' */

	uint32_t type;		/**< component specific type */

	uint32_t size;		/**< size in bytes of data excl. this struct */

	uint32_t abi;		/**< SOF ABI version */

	uint32_t reserved[4];	/**< reserved for future use */

	uint32_t data[0];	/**< Component data - opaque to core */

}  __packed;

#endif

/* 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.

 */

#ifndef __INCLUDE_UAPI_SOUND_SOF_USER_MANIFEST_H__

#define __INCLUDE_UAPI_SOUND_SOF_USER_MANIFEST_H__

/* start offset for base FW module */

#define SOF_MAN_ELF_TEXT_OFFSET		0x2000

/* FW Extended Manifest Header id = $AE1 */

#define SOF_MAN_EXT_HEADER_MAGIC	0x31454124

/* module type load type */

#define SOF_MAN_MOD_TYPE_BUILTIN	0

#define SOF_MAN_MOD_TYPE_MODULE		1

struct sof_man_module_type {

	uint32_t load_type:4;	/* SOF_MAN_MOD_TYPE_ */

	uint32_t auto_start:1;

	uint32_t domain_ll:1;

	uint32_t domain_dp:1;

	uint32_t rsvd_:25;

};

/* segment flags.type */

#define SOF_MAN_SEGMENT_TEXT		0

#define SOF_MAN_SEGMENT_RODATA		1

#define SOF_MAN_SEGMENT_DATA		1

#define SOF_MAN_SEGMENT_BSS		2

#define SOF_MAN_SEGMENT_EMPTY		15

union sof_man_segment_flags {

	uint32_t ul;

	struct {

		uint32_t contents:1;

		uint32_t alloc:1;

		uint32_t load:1;

		uint32_t readonly:1;

		uint32_t code:1;

		uint32_t data:1;

		uint32_t _rsvd0:2;

		uint32_t type:4;	/* MAN_SEGMENT_ */

		uint32_t _rsvd1:4;

		uint32_t length:16;	/* of segment in pages */

	} r;

} __packed;

/*

 * Module segment descriptor. Used by ROM - Immutable.

 */

struct sof_man_segment_desc {

	union sof_man_segment_flags flags;

	uint32_t v_base_addr;

	uint32_t file_offset;

} __packed;

/*

 * The firmware binary can be split into several modules.

 */

#define SOF_MAN_MOD_ID_LEN		4

#define SOF_MAN_MOD_NAME_LEN		8

#define SOF_MAN_MOD_SHA256_LEN		32

#define SOF_MAN_MOD_ID			{'$', 'A', 'M', 'E'}

/*

 * Each module has an entry in the FW header. Used by ROM - Immutable.

 */

struct sof_man_module {

	uint8_t struct_id[SOF_MAN_MOD_ID_LEN];	/* SOF_MAN_MOD_ID */

	uint8_t name[SOF_MAN_MOD_NAME_LEN];

	uint8_t uuid[16];

	struct sof_man_module_type type;

	uint8_t hash[SOF_MAN_MOD_SHA256_LEN];

	uint32_t entry_point;

	uint16_t cfg_offset;

	uint16_t cfg_count;

	uint32_t affinity_mask;

	uint16_t instance_max_count;	/* max number of instances */

	uint16_t instance_bss_size;	/* instance (pages) */

	struct sof_man_segment_desc segment[3];

} __packed;

/*

 * Each module has a configuration in the FW header. Used by ROM - Immutable.

 */

struct sof_man_mod_config {

	uint32_t par[4];	/* module parameters */

	uint32_t is_pages;	/* actual size of instance .bss (pages) */

	uint32_t cps;		/* cycles per second */

	uint32_t ibs;		/* input buffer size (bytes) */

	uint32_t obs;		/* output buffer size (bytes) */

	uint32_t module_flags;	/* flags, reserved for future use */

	uint32_t cpc;		/* cycles per single run */

	uint32_t obls;		/* output block size, reserved for future use */

} __packed;

/*

 * FW Manifest Header

 */

#define SOF_MAN_FW_HDR_FW_NAME_LEN	8

#define SOF_MAN_FW_HDR_ID		{'$', 'A', 'M', '1'}

#define SOF_MAN_FW_HDR_NAME		"ADSPFW"

#define SOF_MAN_FW_HDR_FLAGS		0x0

#define SOF_MAN_FW_HDR_FEATURES		0xff

/*

 * The firmware has a standard header that is checked by the ROM on firmware

 * loading. preload_page_count is used by DMA code loader and is entire

 * image size on CNL. i.e. CNL: total size of the binary’s .text and .rodata

 * Used by ROM - Immutable.

 */

struct sof_man_fw_header {

	uint8_t header_id[4];

	uint32_t header_len;

	uint8_t name[SOF_MAN_FW_HDR_FW_NAME_LEN];

	/* number of pages of preloaded image loaded by driver */

	uint32_t preload_page_count;

	uint32_t fw_image_flags;

	uint32_t feature_mask;

	uint16_t major_version;

	uint16_t minor_version;

	uint16_t hotfix_version;

	uint16_t build_version;

	uint32_t num_module_entries;

	uint32_t hw_buf_base_addr;

	uint32_t hw_buf_length;

	/* target address for binary loading as offset in IMR - must be == base offset */

	uint32_t load_offset;

} __packed;

/*

 * Firmware manifest descriptor. This can contain N modules and N module

 * configs. Used by ROM - Immutable.

 */

struct sof_man_fw_desc {

	struct sof_man_fw_header header;

	/* Warning - hack for module arrays. For some unknown reason the we

	 * have a variable size array of struct man_module followed by a

	 * variable size array of struct mod_config. These should have been

	 * merged into a variable array of a parent structure. We have to hack

	 * around this in many places....

	 *

	 * struct sof_man_module man_module[];

	 * struct sof_man_mod_config mod_config[];

	 */

} __packed;

/*

 * Component Descriptor. Used by ROM - Immutable.

 */

struct sof_man_component_desc {

	uint32_t reserved[2];	/* all 0 */

	uint32_t version;

	uint8_t hash[SOF_MAN_MOD_SHA256_LEN];

	uint32_t base_offset;

	uint32_t limit_offset;

	uint32_t attributes[4];

} __packed;

/*

 * Audio DSP extended metadata. Used by ROM - Immutable.

 */

struct sof_man_adsp_meta_file_ext {

	uint32_t ext_type;	/* always 17 for ADSP extension */

	uint32_t ext_len;

	uint32_t imr_type;

	uint8_t reserved[16];	/* all 0 */

	struct sof_man_component_desc comp_desc[1];

} __packed;

/*

 * Module Manifest for rimage module metadata. Not used by ROM.

 */

struct sof_man_module_manifest {

	struct sof_man_module module;

	uint32_t text_size;

} __packed;

#endif