aboutsummaryrefslogtreecommitdiff
path: root/sound
diff options
context:
space:
mode:
authorMark Brown <broonie@kernel.org>2022-04-29 17:01:18 +0100
committerMark Brown <broonie@kernel.org>2022-04-29 17:01:18 +0100
commit756a615083315c9dc3b60c3b84c01427a082f1f8 (patch)
tree09ec5bdb6dbaae50f6cb634e9840e075965ea467 /sound
parent66727cdb250ec5d3f42558e33ace5c7d0fbd9477 (diff)
parent1dd4b999dad2d8b8fce257e4c3c3d334a709c933 (diff)
ASoC: SOF: IPC Abstraction for FW loading
Merge series from Ranjani Sridharan <ranjani.sridharan@linux.intel.com>: This series introduces IPC abstraction for FW loading in the SOF driver in preparation for supporting the new IPC version in the SOF firmware.
Diffstat (limited to 'sound')
-rw-r--r--sound/soc/sof/Makefile2
-rw-r--r--sound/soc/sof/amd/renoir.c3
-rw-r--r--sound/soc/sof/imx/imx8.c6
-rw-r--r--sound/soc/sof/imx/imx8m.c3
-rw-r--r--sound/soc/sof/intel/bdw.c3
-rw-r--r--sound/soc/sof/intel/byt.c6
-rw-r--r--sound/soc/sof/intel/pci-tng.c3
-rw-r--r--sound/soc/sof/ipc.c57
-rw-r--r--sound/soc/sof/ipc3-loader.c416
-rw-r--r--sound/soc/sof/ipc3-priv.h24
-rw-r--r--sound/soc/sof/ipc3.c62
-rw-r--r--sound/soc/sof/loader.c471
-rw-r--r--sound/soc/sof/mediatek/mt8195/mt8195.c2
-rw-r--r--sound/soc/sof/sof-priv.h24
14 files changed, 539 insertions, 543 deletions
diff --git a/sound/soc/sof/Makefile b/sound/soc/sof/Makefile
index 18acbc001b9a..e7dc47b01437 100644
--- a/sound/soc/sof/Makefile
+++ b/sound/soc/sof/Makefile
@@ -2,7 +2,7 @@
snd-sof-objs := core.o ops.o loader.o ipc.o pcm.o pm.o debug.o topology.o\
control.o trace.o iomem-utils.o sof-audio.o stream-ipc.o\
- ipc3-topology.o ipc3.o ipc3-control.o ipc3-pcm.o
+ ipc3-topology.o ipc3-control.o ipc3.o ipc3-pcm.o ipc3-loader.o
ifneq ($(CONFIG_SND_SOC_SOF_CLIENT),)
snd-sof-objs += sof-client.o
endif
diff --git a/sound/soc/sof/amd/renoir.c b/sound/soc/sof/amd/renoir.c
index 275f266c5e4d..70190365328c 100644
--- a/sound/soc/sof/amd/renoir.c
+++ b/sound/soc/sof/amd/renoir.c
@@ -136,9 +136,6 @@ struct snd_sof_dsp_ops sof_renoir_ops = {
.block_read = acp_dsp_block_read,
.block_write = acp_dsp_block_write,
- /* Module loading */
- .load_module = snd_sof_parse_module_memcpy,
-
/*Firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
.pre_fw_run = acp_dsp_pre_fw_run,
diff --git a/sound/soc/sof/imx/imx8.c b/sound/soc/sof/imx/imx8.c
index ba2fbed93f1d..2844d9a8040a 100644
--- a/sound/soc/sof/imx/imx8.c
+++ b/sound/soc/sof/imx/imx8.c
@@ -510,9 +510,8 @@ static struct snd_sof_dsp_ops sof_imx8_ops = {
.ipc_msg_data = sof_ipc_msg_data,
.set_stream_data_offset = sof_set_stream_data_offset,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
.get_bar_index = imx8_get_bar_index,
+
/* firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
@@ -572,9 +571,8 @@ static struct snd_sof_dsp_ops sof_imx8x_ops = {
.ipc_msg_data = sof_ipc_msg_data,
.set_stream_data_offset = sof_set_stream_data_offset,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
.get_bar_index = imx8_get_bar_index,
+
/* firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
diff --git a/sound/soc/sof/imx/imx8m.c b/sound/soc/sof/imx/imx8m.c
index 1e95f91a7b22..1243f8a6141e 100644
--- a/sound/soc/sof/imx/imx8m.c
+++ b/sound/soc/sof/imx/imx8m.c
@@ -436,9 +436,8 @@ static struct snd_sof_dsp_ops sof_imx8m_ops = {
.ipc_msg_data = sof_ipc_msg_data,
.set_stream_data_offset = sof_set_stream_data_offset,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
.get_bar_index = imx8m_get_bar_index,
+
/* firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
diff --git a/sound/soc/sof/intel/bdw.c b/sound/soc/sof/intel/bdw.c
index c0a1d4ae8c68..26df780c702e 100644
--- a/sound/soc/sof/intel/bdw.c
+++ b/sound/soc/sof/intel/bdw.c
@@ -613,9 +613,6 @@ static struct snd_sof_dsp_ops sof_bdw_ops = {
.pcm_open = sof_stream_pcm_open,
.pcm_close = sof_stream_pcm_close,
- /* Module loading */
- .load_module = snd_sof_parse_module_memcpy,
-
/*Firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
diff --git a/sound/soc/sof/intel/byt.c b/sound/soc/sof/intel/byt.c
index 0fd5edb1bdbc..4ed8381eceda 100644
--- a/sound/soc/sof/intel/byt.c
+++ b/sound/soc/sof/intel/byt.c
@@ -267,9 +267,6 @@ static struct snd_sof_dsp_ops sof_byt_ops = {
.pcm_open = sof_stream_pcm_open,
.pcm_close = sof_stream_pcm_close,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
-
/*Firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
@@ -349,9 +346,6 @@ static struct snd_sof_dsp_ops sof_cht_ops = {
.pcm_open = sof_stream_pcm_open,
.pcm_close = sof_stream_pcm_close,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
-
/*Firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
diff --git a/sound/soc/sof/intel/pci-tng.c b/sound/soc/sof/intel/pci-tng.c
index f1aae9667834..f0f6d9ba8803 100644
--- a/sound/soc/sof/intel/pci-tng.c
+++ b/sound/soc/sof/intel/pci-tng.c
@@ -186,9 +186,6 @@ struct snd_sof_dsp_ops sof_tng_ops = {
.pcm_open = sof_stream_pcm_open,
.pcm_close = sof_stream_pcm_close,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
-
/*Firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
diff --git a/sound/soc/sof/ipc.c b/sound/soc/sof/ipc.c
index 48ea58dbc998..a6ec4b5a4923 100644
--- a/sound/soc/sof/ipc.c
+++ b/sound/soc/sof/ipc.c
@@ -137,57 +137,6 @@ void snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id)
}
EXPORT_SYMBOL(snd_sof_ipc_reply);
-int snd_sof_ipc_valid(struct snd_sof_dev *sdev)
-{
- struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
- struct sof_ipc_fw_version *v = &ready->version;
-
- dev_info(sdev->dev,
- "Firmware info: version %d:%d:%d-%s\n", v->major, v->minor,
- v->micro, v->tag);
- dev_info(sdev->dev,
- "Firmware: ABI %d:%d:%d Kernel ABI %d:%d:%d\n",
- SOF_ABI_VERSION_MAJOR(v->abi_version),
- SOF_ABI_VERSION_MINOR(v->abi_version),
- SOF_ABI_VERSION_PATCH(v->abi_version),
- SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH);
-
- if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, v->abi_version)) {
- dev_err(sdev->dev, "error: incompatible FW ABI version\n");
- return -EINVAL;
- }
-
- if (SOF_ABI_VERSION_MINOR(v->abi_version) > SOF_ABI_MINOR) {
- if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
- dev_warn(sdev->dev, "warn: FW ABI is more recent than kernel\n");
- } else {
- dev_err(sdev->dev, "error: FW ABI is more recent than kernel\n");
- return -EINVAL;
- }
- }
-
- if (ready->flags & SOF_IPC_INFO_BUILD) {
- dev_info(sdev->dev,
- "Firmware debug build %d on %s-%s - options:\n"
- " GDB: %s\n"
- " lock debug: %s\n"
- " lock vdebug: %s\n",
- v->build, v->date, v->time,
- (ready->flags & SOF_IPC_INFO_GDB) ?
- "enabled" : "disabled",
- (ready->flags & SOF_IPC_INFO_LOCKS) ?
- "enabled" : "disabled",
- (ready->flags & SOF_IPC_INFO_LOCKSV) ?
- "enabled" : "disabled");
- }
-
- /* copy the fw_version into debugfs at first boot */
- memcpy(&sdev->fw_version, v, sizeof(*v));
-
- return 0;
-}
-EXPORT_SYMBOL(snd_sof_ipc_valid);
-
struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev)
{
struct snd_sof_ipc *ipc;
@@ -220,6 +169,12 @@ struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev)
return NULL;
}
+ if (!ops->fw_loader || !ops->fw_loader->validate ||
+ !ops->fw_loader->parse_ext_manifest) {
+ dev_err(sdev->dev, "Missing IPC firmware loading ops\n");
+ return NULL;
+ }
+
if (!ops->pcm) {
dev_err(sdev->dev, "Missing IPC PCM ops\n");
return NULL;
diff --git a/sound/soc/sof/ipc3-loader.c b/sound/soc/sof/ipc3-loader.c
new file mode 100644
index 000000000000..14158c52a2b7
--- /dev/null
+++ b/sound/soc/sof/ipc3-loader.c
@@ -0,0 +1,416 @@
+// SPDX-License-Identifier: (GPL-2.0-only 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) 2022 Intel Corporation. All rights reserved.
+
+#include <linux/firmware.h>
+#include "sof-priv.h"
+#include "sof-audio.h"
+#include "ipc3-priv.h"
+#include "ipc3-ops.h"
+#include "ops.h"
+
+static int ipc3_fw_ext_man_get_version(struct snd_sof_dev *sdev,
+ const struct sof_ext_man_elem_header *hdr)
+{
+ const struct sof_ext_man_fw_version *v =
+ container_of(hdr, struct sof_ext_man_fw_version, hdr);
+
+ memcpy(&sdev->fw_ready.version, &v->version, sizeof(v->version));
+ sdev->fw_ready.flags = v->flags;
+
+ /* log ABI versions and check FW compatibility */
+ return sof_ipc3_validate_fw_version(sdev);
+}
+
+static int ipc3_fw_ext_man_get_windows(struct snd_sof_dev *sdev,
+ const struct sof_ext_man_elem_header *hdr)
+{
+ const struct sof_ext_man_window *w;
+
+ w = container_of(hdr, struct sof_ext_man_window, hdr);
+
+ return sof_ipc3_get_ext_windows(sdev, &w->ipc_window.ext_hdr);
+}
+
+static int ipc3_fw_ext_man_get_cc_info(struct snd_sof_dev *sdev,
+ const struct sof_ext_man_elem_header *hdr)
+{
+ const struct sof_ext_man_cc_version *cc;
+
+ cc = container_of(hdr, struct sof_ext_man_cc_version, hdr);
+
+ return sof_ipc3_get_cc_info(sdev, &cc->cc_version.ext_hdr);
+}
+
+static int ipc3_fw_ext_man_get_dbg_abi_info(struct snd_sof_dev *sdev,
+ const struct sof_ext_man_elem_header *hdr)
+{
+ const struct ext_man_dbg_abi *dbg_abi =
+ container_of(hdr, struct ext_man_dbg_abi, hdr);
+
+ if (sdev->first_boot)
+ dev_dbg(sdev->dev,
+ "Firmware: DBG_ABI %d:%d:%d\n",
+ SOF_ABI_VERSION_MAJOR(dbg_abi->dbg_abi.abi_dbg_version),
+ SOF_ABI_VERSION_MINOR(dbg_abi->dbg_abi.abi_dbg_version),
+ SOF_ABI_VERSION_PATCH(dbg_abi->dbg_abi.abi_dbg_version));
+
+ return 0;
+}
+
+static int ipc3_fw_ext_man_get_config_data(struct snd_sof_dev *sdev,
+ const struct sof_ext_man_elem_header *hdr)
+{
+ const struct sof_ext_man_config_data *config =
+ container_of(hdr, struct sof_ext_man_config_data, hdr);
+ const struct sof_config_elem *elem;
+ int elems_counter;
+ int elems_size;
+ int ret = 0;
+ int i;
+
+ /* calculate elements counter */
+ elems_size = config->hdr.size - sizeof(struct sof_ext_man_elem_header);
+ elems_counter = elems_size / sizeof(struct sof_config_elem);
+
+ dev_dbg(sdev->dev, "%s can hold up to %d config elements\n",
+ __func__, elems_counter);
+
+ for (i = 0; i < elems_counter; ++i) {
+ elem = &config->elems[i];
+ dev_dbg(sdev->dev, "%s get index %d token %d val %d\n",
+ __func__, i, elem->token, elem->value);
+ switch (elem->token) {
+ case SOF_EXT_MAN_CONFIG_EMPTY:
+ /* unused memory space is zero filled - mapped to EMPTY elements */
+ break;
+ case SOF_EXT_MAN_CONFIG_IPC_MSG_SIZE:
+ /* TODO: use ipc msg size from config data */
+ break;
+ case SOF_EXT_MAN_CONFIG_MEMORY_USAGE_SCAN:
+ if (sdev->first_boot && elem->value)
+ ret = snd_sof_dbg_memory_info_init(sdev);
+ break;
+ default:
+ dev_info(sdev->dev,
+ "Unknown firmware configuration token %d value %d",
+ elem->token, elem->value);
+ break;
+ }
+ if (ret < 0) {
+ dev_err(sdev->dev,
+ "%s: processing failed for token %d value %#x, %d\n",
+ __func__, elem->token, elem->value, ret);
+ return ret;
+ }
+ }
+
+ return 0;
+}
+
+static ssize_t ipc3_fw_ext_man_size(const struct firmware *fw)
+{
+ const struct sof_ext_man_header *head;
+
+ head = (struct sof_ext_man_header *)fw->data;
+
+ /*
+ * assert fw size is big enough to contain extended manifest header,
+ * it prevents from reading unallocated memory from `head` in following
+ * step.
+ */
+ if (fw->size < sizeof(*head))
+ return -EINVAL;
+
+ /*
+ * When fw points to extended manifest,
+ * then first u32 must be equal SOF_EXT_MAN_MAGIC_NUMBER.
+ */
+ if (head->magic == SOF_EXT_MAN_MAGIC_NUMBER)
+ return head->full_size;
+
+ /* otherwise given fw don't have an extended manifest */
+ return 0;
+}
+
+static size_t sof_ipc3_fw_parse_ext_man(struct snd_sof_dev *sdev)
+{
+ struct snd_sof_pdata *plat_data = sdev->pdata;
+ const struct firmware *fw = plat_data->fw;
+ const struct sof_ext_man_elem_header *elem_hdr;
+ const struct sof_ext_man_header *head;
+ ssize_t ext_man_size;
+ ssize_t remaining;
+ uintptr_t iptr;
+ int ret = 0;
+
+ head = (struct sof_ext_man_header *)fw->data;
+ remaining = head->full_size - head->header_size;
+ ext_man_size = ipc3_fw_ext_man_size(fw);
+
+ /* Assert firmware starts with extended manifest */
+ if (ext_man_size <= 0)
+ return ext_man_size;
+
+ /* incompatible version */
+ if (SOF_EXT_MAN_VERSION_INCOMPATIBLE(SOF_EXT_MAN_VERSION,
+ head->header_version)) {
+ dev_err(sdev->dev,
+ "extended manifest version %#x differ from used %#x\n",
+ head->header_version, SOF_EXT_MAN_VERSION);
+ return -EINVAL;
+ }
+
+ /* get first extended manifest element header */
+ iptr = (uintptr_t)fw->data + head->header_size;
+
+ while (remaining > sizeof(*elem_hdr)) {
+ elem_hdr = (struct sof_ext_man_elem_header *)iptr;
+
+ dev_dbg(sdev->dev, "found sof_ext_man header type %d size %#x\n",
+ elem_hdr->type, elem_hdr->size);
+
+ if (elem_hdr->size < sizeof(*elem_hdr) ||
+ elem_hdr->size > remaining) {
+ dev_err(sdev->dev,
+ "invalid sof_ext_man header size, type %d size %#x\n",
+ elem_hdr->type, elem_hdr->size);
+ return -EINVAL;
+ }
+
+ /* process structure data */
+ switch (elem_hdr->type) {
+ case SOF_EXT_MAN_ELEM_FW_VERSION:
+ ret = ipc3_fw_ext_man_get_version(sdev, elem_hdr);
+ break;
+ case SOF_EXT_MAN_ELEM_WINDOW:
+ ret = ipc3_fw_ext_man_get_windows(sdev, elem_hdr);
+ break;
+ case SOF_EXT_MAN_ELEM_CC_VERSION:
+ ret = ipc3_fw_ext_man_get_cc_info(sdev, elem_hdr);
+ break;
+ case SOF_EXT_MAN_ELEM_DBG_ABI:
+ ret = ipc3_fw_ext_man_get_dbg_abi_info(sdev, elem_hdr);
+ break;
+ case SOF_EXT_MAN_ELEM_CONFIG_DATA:
+ ret = ipc3_fw_ext_man_get_config_data(sdev, elem_hdr);
+ break;
+ case SOF_EXT_MAN_ELEM_PLATFORM_CONFIG_DATA:
+ ret = snd_sof_dsp_parse_platform_ext_manifest(sdev, elem_hdr);
+ break;
+ default:
+ dev_info(sdev->dev,
+ "unknown sof_ext_man header type %d size %#x\n",
+ elem_hdr->type, elem_hdr->size);
+ break;
+ }
+
+ if (ret < 0) {
+ dev_err(sdev->dev,
+ "failed to parse sof_ext_man header type %d size %#x\n",
+ elem_hdr->type, elem_hdr->size);
+ return ret;
+ }
+
+ remaining -= elem_hdr->size;
+ iptr += elem_hdr->size;
+ }
+
+ if (remaining) {
+ dev_err(sdev->dev, "error: sof_ext_man header is inconsistent\n");
+ return -EINVAL;
+ }
+
+ return ext_man_size;
+}
+
+/* generic module parser for mmaped DSPs */
+static int sof_ipc3_parse_module_memcpy(struct snd_sof_dev *sdev,
+ struct snd_sof_mod_hdr *module)
+{
+ struct snd_sof_blk_hdr *block;
+ int count, ret;
+ u32 offset;
+ size_t remaining;
+
+ dev_dbg(sdev->dev, "new module size %#x blocks %#x type %#x\n",
+ module->size, module->num_blocks, module->type);
+
+ block = (struct snd_sof_blk_hdr *)((u8 *)module + sizeof(*module));
+
+ /* module->size doesn't include header size */
+ remaining = module->size;
+ for (count = 0; count < module->num_blocks; count++) {
+ /* check for wrap */
+ if (remaining < sizeof(*block)) {
+ dev_err(sdev->dev, "not enough data remaining\n");
+ return -EINVAL;
+ }
+
+ /* minus header size of block */
+ remaining -= sizeof(*block);
+
+ if (block->size == 0) {
+ dev_warn(sdev->dev,
+ "warning: block %d size zero\n", count);
+ dev_warn(sdev->dev, " type %#x offset %#x\n",
+ block->type, block->offset);
+ continue;
+ }
+
+ switch (block->type) {
+ case SOF_FW_BLK_TYPE_RSRVD0:
+ case SOF_FW_BLK_TYPE_ROM...SOF_FW_BLK_TYPE_RSRVD14:
+ continue; /* not handled atm */
+ case SOF_FW_BLK_TYPE_IRAM:
+ case SOF_FW_BLK_TYPE_DRAM:
+ case SOF_FW_BLK_TYPE_SRAM:
+ offset = block->offset;
+ break;
+ default:
+ dev_err(sdev->dev, "%s: bad type %#x for block %#x\n",
+ __func__, block->type, count);
+ return -EINVAL;
+ }
+
+ dev_dbg(sdev->dev, "block %d type %#x size %#x ==> offset %#x\n",
+ count, block->type, block->size, offset);
+
+ /* checking block->size to avoid unaligned access */
+ if (block->size % sizeof(u32)) {
+ dev_err(sdev->dev, "%s: invalid block size %#x\n",
+ __func__, block->size);
+ return -EINVAL;
+ }
+ ret = snd_sof_dsp_block_write(sdev, block->type, offset,
+ block + 1, block->size);
+ if (ret < 0) {
+ dev_err(sdev->dev, "%s: write to block type %#x failed\n",
+ __func__, block->type);
+ return ret;
+ }
+
+ if (remaining < block->size) {
+ dev_err(sdev->dev, "%s: not enough data remaining\n", __func__);
+ return -EINVAL;
+ }
+
+ /* minus body size of block */
+ remaining -= block->size;
+ /* next block */
+ block = (struct snd_sof_blk_hdr *)((u8 *)block + sizeof(*block)
+ + block->size);
+ }
+
+ return 0;
+}
+
+static int sof_ipc3_load_fw_to_dsp(struct snd_sof_dev *sdev)
+{
+ struct snd_sof_pdata *plat_data = sdev->pdata;
+ const struct firmware *fw = plat_data->fw;
+ struct snd_sof_fw_header *header;
+ struct snd_sof_mod_hdr *module;
+ int (*load_module)(struct snd_sof_dev *sof_dev, struct snd_sof_mod_hdr *hdr);
+ size_t remaining;
+ int ret, count;
+
+ if (!plat_data->fw)
+ return -EINVAL;
+
+ header = (struct snd_sof_fw_header *)(fw->data + plat_data->fw_offset);
+ load_module = sof_ops(sdev)->load_module;
+ if (!load_module) {
+ dev_dbg(sdev->dev, "%s: Using generic module loading\n", __func__);
+ load_module = sof_ipc3_parse_module_memcpy;
+ } else {
+ dev_dbg(sdev->dev, "%s: Using custom module loading\n", __func__);
+ }
+
+ /* parse each module */
+ module = (struct snd_sof_mod_hdr *)(fw->data + plat_data->fw_offset +
+ sizeof(*header));
+ remaining = fw->size - sizeof(*header) - plat_data->fw_offset;
+ /* check for wrap */
+ if (remaining > fw->size) {
+ dev_err(sdev->dev, "%s: fw size smaller than header size\n", __func__);
+ return -EINVAL;
+ }
+
+ for (count = 0; count < header->num_modules; count++) {
+ /* check for wrap */
+ if (remaining < sizeof(*module)) {
+ dev_err(sdev->dev, "%s: not enough data for a module\n",
+ __func__);
+ return -EINVAL;
+ }
+
+ /* minus header size of module */
+ remaining -= sizeof(*module);
+
+ /* module */
+ ret = load_module(sdev, module);
+ if (ret < 0) {
+ dev_err(sdev->dev, "%s: invalid module %d\n", __func__, count);
+ return ret;
+ }
+
+ if (remaining < module->size) {
+ dev_err(sdev->dev, "%s: not enough data remaining\n", __func__);
+ return -EINVAL;
+ }
+
+ /* minus body size of module */
+ remaining -= module->size;
+ module = (struct snd_sof_mod_hdr *)((u8 *)module +
+ sizeof(*module) + module->size);
+ }
+
+ return 0;
+}
+
+static int sof_ipc3_validate_firmware(struct snd_sof_dev *sdev)
+{
+ struct snd_sof_pdata *plat_data = sdev->pdata;
+ const struct firmware *fw = plat_data->fw;
+ struct snd_sof_fw_header *header;
+ size_t fw_size = fw->size - plat_data->fw_offset;
+
+ if (fw->size <= plat_data->fw_offset) {
+ dev_err(sdev->dev,
+ "firmware size must be greater than firmware offset\n");
+ return -EINVAL;
+ }
+
+ /* Read the header information from the data pointer */
+ header = (struct snd_sof_fw_header *)(fw->data + plat_data->fw_offset);
+
+ /* verify FW sig */
+ if (strncmp(header->sig, SND_SOF_FW_SIG, SND_SOF_FW_SIG_SIZE) != 0) {
+ dev_err(sdev->dev, "invalid firmware signature\n");
+ return -EINVAL;
+ }
+
+ /* check size is valid */
+ if (fw_size != header->file_size + sizeof(*header)) {
+ dev_err(sdev->dev,
+ "invalid filesize mismatch got 0x%zx expected 0x%zx\n",
+ fw_size, header->file_size + sizeof(*header));
+ return -EINVAL;
+ }
+
+ dev_dbg(sdev->dev, "header size=0x%x modules=0x%x abi=0x%x size=%zu\n",
+ header->file_size, header->num_modules,
+ header->abi, sizeof(*header));
+
+ return 0;
+}
+
+const struct sof_ipc_fw_loader_ops ipc3_loader_ops = {
+ .validate = sof_ipc3_validate_firmware,
+ .parse_ext_manifest = sof_ipc3_fw_parse_ext_man,
+ .load_fw_to_dsp = sof_ipc3_load_fw_to_dsp,
+};
diff --git a/sound/soc/sof/ipc3-priv.h b/sound/soc/sof/ipc3-priv.h
new file mode 100644
index 000000000000..a9b9201508a5
--- /dev/null
+++ b/sound/soc/sof/ipc3-priv.h
@@ -0,0 +1,24 @@
+/* SPDX-License-Identifier: (GPL-2.0-only 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) 2021 Intel Corporation. All rights reserved.
+ */
+
+#ifndef __SOUND_SOC_SOF_IPC3_PRIV_H
+#define __SOUND_SOC_SOF_IPC3_PRIV_H
+
+#include "sof-priv.h"
+
+/* IPC3 specific ops */
+extern const struct sof_ipc_fw_loader_ops ipc3_loader_ops;
+
+/* helpers for fw_ready and ext_manifest parsing */
+int sof_ipc3_get_ext_windows(struct snd_sof_dev *sdev,
+ const struct sof_ipc_ext_data_hdr *ext_hdr);
+int sof_ipc3_get_cc_info(struct snd_sof_dev *sdev,
+ const struct sof_ipc_ext_data_hdr *ext_hdr);
+int sof_ipc3_validate_fw_version(struct snd_sof_dev *sdev);
+
+#endif
diff --git a/sound/soc/sof/ipc3.c b/sound/soc/sof/ipc3.c
index 7d28bfa3d231..efcd201597fa 100644
--- a/sound/soc/sof/ipc3.c
+++ b/sound/soc/sof/ipc3.c
@@ -11,6 +11,7 @@
#include <sound/sof/control.h>
#include "sof-priv.h"
#include "sof-audio.h"
+#include "ipc3-priv.h"
#include "ipc3-ops.h"
#include "ops.h"
@@ -475,8 +476,8 @@ static int sof_ipc3_set_get_data(struct snd_sof_dev *sdev, void *data, size_t da
return ret;
}
-static int sof_ipc3_get_ext_windows(struct snd_sof_dev *sdev,
- const struct sof_ipc_ext_data_hdr *ext_hdr)
+int sof_ipc3_get_ext_windows(struct snd_sof_dev *sdev,
+ const struct sof_ipc_ext_data_hdr *ext_hdr)
{
const struct sof_ipc_window *w =
container_of(ext_hdr, struct sof_ipc_window, ext_hdr);
@@ -500,8 +501,8 @@ static int sof_ipc3_get_ext_windows(struct snd_sof_dev *sdev,
return 0;
}
-static int sof_ipc3_get_cc_info(struct snd_sof_dev *sdev,
- const struct sof_ipc_ext_data_hdr *ext_hdr)
+int sof_ipc3_get_cc_info(struct snd_sof_dev *sdev,
+ const struct sof_ipc_ext_data_hdr *ext_hdr)
{
int ret;
@@ -735,6 +736,56 @@ static int ipc3_init_reply_data_buffer(struct snd_sof_dev *sdev)
return 0;
}
+int sof_ipc3_validate_fw_version(struct snd_sof_dev *sdev)
+{
+ struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
+ struct sof_ipc_fw_version *v = &ready->version;
+
+ dev_info(sdev->dev,
+ "Firmware info: version %d:%d:%d-%s\n", v->major, v->minor,
+ v->micro, v->tag);
+ dev_info(sdev->dev,
+ "Firmware: ABI %d:%d:%d Kernel ABI %d:%d:%d\n",
+ SOF_ABI_VERSION_MAJOR(v->abi_version),
+ SOF_ABI_VERSION_MINOR(v->abi_version),
+ SOF_ABI_VERSION_PATCH(v->abi_version),
+ SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH);
+
+ if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, v->abi_version)) {
+ dev_err(sdev->dev, "incompatible FW ABI version\n");
+ return -EINVAL;
+ }
+
+ if (SOF_ABI_VERSION_MINOR(v->abi_version) > SOF_ABI_MINOR) {
+ if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
+ dev_warn(sdev->dev, "FW ABI is more recent than kernel\n");
+ } else {
+ dev_err(sdev->dev, "FW ABI is more recent than kernel\n");
+ return -EINVAL;
+ }
+ }
+
+ if (ready->flags & SOF_IPC_INFO_BUILD) {
+ dev_info(sdev->dev,
+ "Firmware debug build %d on %s-%s - options:\n"
+ " GDB: %s\n"
+ " lock debug: %s\n"
+ " lock vdebug: %s\n",
+ v->build, v->date, v->time,
+ (ready->flags & SOF_IPC_INFO_GDB) ?
+ "enabled" : "disabled",
+ (ready->flags & SOF_IPC_INFO_LOCKS) ?
+ "enabled" : "disabled",
+ (ready->flags & SOF_IPC_INFO_LOCKSV) ?
+ "enabled" : "disabled");
+ }
+
+ /* copy the fw_version into debugfs at first boot */
+ memcpy(&sdev->fw_version, v, sizeof(*v));
+
+ return 0;
+}
+
static int ipc3_fw_ready(struct snd_sof_dev *sdev, u32 cmd)
{
struct sof_ipc_fw_ready *fw_ready = &sdev->fw_ready;
@@ -767,7 +818,7 @@ static int ipc3_fw_ready(struct snd_sof_dev *sdev, u32 cmd)
}
/* make sure ABI version is compatible */
- ret = snd_sof_ipc_valid(sdev);
+ ret = sof_ipc3_validate_fw_version(sdev);
if (ret < 0)
return ret;
@@ -1019,6 +1070,7 @@ const struct sof_ipc_ops ipc3_ops = {
.tplg = &ipc3_tplg_ops,
.pm = &ipc3_pm_ops,
.pcm = &ipc3_pcm_ops,
+ .fw_loader = &ipc3_loader_ops,
.tx_msg = sof_ipc3_tx_msg,
.rx_msg = sof_ipc3_rx_msg,
diff --git a/sound/soc/sof/loader.c b/sound/soc/sof/loader.c
index b0d192749734..5f51d936b306 100644
--- a/sound/soc/sof/loader.c
+++ b/sound/soc/sof/loader.c
@@ -11,463 +11,9 @@
//
#include <linux/firmware.h>
-#include <sound/sof.h>
-#include <sound/sof/ext_manifest.h>
#include "sof-priv.h"
#include "ops.h"
-static int get_ext_windows(struct snd_sof_dev *sdev,
- const struct sof_ipc_ext_data_hdr *ext_hdr)
-{
- const struct sof_ipc_window *w =
- container_of(ext_hdr, struct sof_ipc_window, ext_hdr);
-
- if (w->num_windows == 0 || w->num_windows > SOF_IPC_MAX_ELEMS)
- return -EINVAL;
-
- if (sdev->info_window) {
- if (memcmp(sdev->info_window, w, ext_hdr->hdr.size)) {
- dev_err(sdev->dev, "error: mismatch between window descriptor from extended manifest and mailbox");
- return -EINVAL;
- }
- return 0;
- }
-
- /* keep a local copy of the data */
- sdev->info_window = devm_kmemdup(sdev->dev, w, ext_hdr->hdr.size,
- GFP_KERNEL);
- if (!sdev->info_window)
- return -ENOMEM;
-
- return 0;
-}
-
-static int get_cc_info(struct snd_sof_dev *sdev,
- const struct sof_ipc_ext_data_hdr *ext_hdr)
-{
- int ret;
-
- const struct sof_ipc_cc_version *cc =
- container_of(ext_hdr, struct sof_ipc_cc_version, ext_hdr);
-
- if (sdev->cc_version) {
- if (memcmp(sdev->cc_version, cc, cc->ext_hdr.hdr.size)) {
- dev_err(sdev->dev, "error: receive diverged cc_version descriptions");
- return -EINVAL;
- }
- return 0;
- }
-
- dev_dbg(sdev->dev, "Firmware info: used compiler %s %d:%d:%d%s used optimization flags %s\n",
- cc->name, cc->major, cc->minor, cc->micro, cc->desc,
- cc->optim);
-
- /* create read-only cc_version debugfs to store compiler version info */
- /* use local copy of the cc_version to prevent data corruption */
- if (sdev->first_boot) {
- sdev->cc_version = devm_kmalloc(sdev->dev, cc->ext_hdr.hdr.size,
- GFP_KERNEL);
-
- if (!sdev->cc_version)
- return -ENOMEM;
-
- memcpy(sdev->cc_version, cc, cc->ext_hdr.hdr.size);
- ret = snd_sof_debugfs_buf_item(sdev, sdev->cc_version,
- cc->ext_hdr.hdr.size,
- "cc_version", 0444);
-
- /* errors are only due to memory allocation, not debugfs */
- if (ret < 0) {
- dev_err(sdev->dev, "error: snd_sof_debugfs_buf_item failed\n");
- return ret;
- }
- }
-
- return 0;
-}
-
-static int ext_man_get_fw_version(struct snd_sof_dev *sdev,
- const struct sof_ext_man_elem_header *hdr)
-{
- const struct sof_ext_man_fw_version *v =
- container_of(hdr, struct sof_ext_man_fw_version, hdr);
-
- memcpy(&sdev->fw_ready.version, &v->version, sizeof(v->version));
- sdev->fw_ready.flags = v->flags;
-
- /* log ABI versions and check FW compatibility */
- return snd_sof_ipc_valid(sdev);
-}
-
-static int ext_man_get_windows(struct snd_sof_dev *sdev,
- const struct sof_ext_man_elem_header *hdr)
-{
- const struct sof_ext_man_window *w;
-
- w = container_of(hdr, struct sof_ext_man_window, hdr);
-
- return get_ext_windows(sdev, &w->ipc_window.ext_hdr);
-}
-
-static int ext_man_get_cc_info(struct snd_sof_dev *sdev,
- const struct sof_ext_man_elem_header *hdr)
-{
- const struct sof_ext_man_cc_version *cc;
-
- cc = container_of(hdr, struct sof_ext_man_cc_version, hdr);
-
- return get_cc_info(sdev, &cc->cc_version.ext_hdr);
-}
-
-static int ext_man_get_dbg_abi_info(struct snd_sof_dev *sdev,
- const struct sof_ext_man_elem_header *hdr)
-{
- const struct ext_man_dbg_abi *dbg_abi =
- container_of(hdr, struct ext_man_dbg_abi, hdr);
-
- if (sdev->first_boot)
- dev_dbg(sdev->dev,
- "Firmware: DBG_ABI %d:%d:%d\n",
- SOF_ABI_VERSION_MAJOR(dbg_abi->dbg_abi.abi_dbg_version),
- SOF_ABI_VERSION_MINOR(dbg_abi->dbg_abi.abi_dbg_version),
- SOF_ABI_VERSION_PATCH(dbg_abi->dbg_abi.abi_dbg_version));
-
- return 0;
-}
-
-static int ext_man_get_config_data(struct snd_sof_dev *sdev,
- const struct sof_ext_man_elem_header *hdr)
-{
- const struct sof_ext_man_config_data *config =
- container_of(hdr, struct sof_ext_man_config_data, hdr);
- const struct sof_config_elem *elem;
- int elems_counter;
- int elems_size;
- int ret = 0;
- int i;
-
- /* calculate elements counter */
- elems_size = config->hdr.size - sizeof(struct sof_ext_man_elem_header);
- elems_counter = elems_size / sizeof(struct sof_config_elem);
-
- dev_dbg(sdev->dev, "%s can hold up to %d config elements\n",
- __func__, elems_counter);
-
- for (i = 0; i < elems_counter; ++i) {
- elem = &config->elems[i];
- dev_dbg(sdev->dev, "%s get index %d token %d val %d\n",
- __func__, i, elem->token, elem->value);
- switch (elem->token) {
- case SOF_EXT_MAN_CONFIG_EMPTY:
- /* unused memory space is zero filled - mapped to EMPTY elements */
- break;
- case SOF_EXT_MAN_CONFIG_IPC_MSG_SIZE:
- /* TODO: use ipc msg size from config data */
- break;
- case SOF_EXT_MAN_CONFIG_MEMORY_USAGE_SCAN:
- if (sdev->first_boot && elem->value)
- ret = snd_sof_dbg_memory_info_init(sdev);
- break;
- default:
- dev_info(sdev->dev, "Unknown firmware configuration token %d value %d",
- elem->token, elem->value);
- break;
- }
- if (ret < 0) {
- dev_err(sdev->dev, "error: processing sof_ext_man_config_data failed for token %d value 0x%x, %d\n",
- elem->token, elem->value, ret);
- return ret;
- }
- }
-
- return 0;
-}
-
-static ssize_t snd_sof_ext_man_size(const struct firmware *fw)
-{
- const struct sof_ext_man_header *head;
-
- head = (struct sof_ext_man_header *)fw->data;
-
- /*
- * assert fw size is big enough to contain extended manifest header,
- * it prevents from reading unallocated memory from `head` in following
- * step.
- */
- if (fw->size < sizeof(*head))
- return -EINVAL;
-
- /*
- * When fw points to extended manifest,
- * then first u32 must be equal SOF_EXT_MAN_MAGIC_NUMBER.
- */
- if (head->magic == SOF_EXT_MAN_MAGIC_NUMBER)
- return head->full_size;
-
- /* otherwise given fw don't have an extended manifest */
- return 0;
-}
-
-/* parse extended FW manifest data structures */
-static int snd_sof_fw_ext_man_parse(struct snd_sof_dev *sdev,
- const struct firmware *fw)
-{
- const struct sof_ext_man_elem_header *elem_hdr;
- const struct sof_ext_man_header *head;
- ssize_t ext_man_size;
- ssize_t remaining;
- uintptr_t iptr;
- int ret = 0;
-
- head = (struct sof_ext_man_header *)fw->data;
- remaining = head->full_size - head->header_size;
- ext_man_size = snd_sof_ext_man_size(fw);
-
- /* Assert firmware starts with extended manifest */
- if (ext_man_size <= 0)
- return ext_man_size;
-
- /* incompatible version */
- if (SOF_EXT_MAN_VERSION_INCOMPATIBLE(SOF_EXT_MAN_VERSION,
- head->header_version)) {
- dev_err(sdev->dev, "error: extended manifest version 0x%X differ from used 0x%X\n",
- head->header_version, SOF_EXT_MAN_VERSION);
- return -EINVAL;
- }
-
- /* get first extended manifest element header */
- iptr = (uintptr_t)fw->data + head->header_size;
-
- while (remaining > sizeof(*elem_hdr)) {
- elem_hdr = (struct sof_ext_man_elem_header *)iptr;
-
- dev_dbg(sdev->dev, "found sof_ext_man header type %d size 0x%X\n",
- elem_hdr->type, elem_hdr->size);
-
- if (elem_hdr->size < sizeof(*elem_hdr) ||
- elem_hdr->size > remaining) {
- dev_err(sdev->dev, "error: invalid sof_ext_man header size, type %d size 0x%X\n",
- elem_hdr->type, elem_hdr->size);
- return -EINVAL;
- }
-
- /* process structure data */
- switch (elem_hdr->type) {
- case SOF_EXT_MAN_ELEM_FW_VERSION:
- ret = ext_man_get_fw_version(sdev, elem_hdr);
- break;
- case SOF_EXT_MAN_ELEM_WINDOW:
- ret = ext_man_get_windows(sdev, elem_hdr);
- break;
- case SOF_EXT_MAN_ELEM_CC_VERSION:
- ret = ext_man_get_cc_info(sdev, elem_hdr);
- break;
- case SOF_EXT_MAN_ELEM_DBG_ABI:
- ret = ext_man_get_dbg_abi_info(sdev, elem_hdr);
- break;
- case SOF_EXT_MAN_ELEM_CONFIG_DATA:
- ret = ext_man_get_config_data(sdev, elem_hdr);
- break;
- case SOF_EXT_MAN_ELEM_PLATFORM_CONFIG_DATA:
- ret = snd_sof_dsp_parse_platform_ext_manifest(sdev, elem_hdr);
- break;
- default:
- dev_info(sdev->dev, "unknown sof_ext_man header type %d size 0x%X\n",
- elem_hdr->type, elem_hdr->size);
- break;
- }
-
- if (ret < 0) {
- dev_err(sdev->dev, "error: failed to parse sof_ext_man header type %d size 0x%X\n",
- elem_hdr->type, elem_hdr->size);
- return ret;
- }
-
- remaining -= elem_hdr->size;
- iptr += elem_hdr->size;
- }
-
- if (remaining) {
- dev_err(sdev->dev, "error: sof_ext_man header is inconsistent\n");
- return -EINVAL;
- }
-
- return ext_man_size;
-}
-
-/* generic module parser for mmaped DSPs */
-int snd_sof_parse_module_memcpy(struct snd_sof_dev *sdev,
- struct snd_sof_mod_hdr *module)
-{
- struct snd_sof_blk_hdr *block;
- int count, ret;
- u32 offset;
- size_t remaining;
-
- dev_dbg(sdev->dev, "new module size 0x%x blocks 0x%x type 0x%x\n",
- module->size, module->num_blocks, module->type);
-
- block = (struct snd_sof_blk_hdr *)((u8 *)module + sizeof(*module));
-
- /* module->size doesn't include header size */
- remaining = module->size;
- for (count = 0; count < module->num_blocks; count++) {
- /* check for wrap */
- if (remaining < sizeof(*block)) {
- dev_err(sdev->dev, "error: not enough data remaining\n");
- return -EINVAL;
- }
-
- /* minus header size of block */
- remaining -= sizeof(*block);
-
- if (block->size == 0) {
- dev_warn(sdev->dev,
- "warning: block %d size zero\n", count);
- dev_warn(sdev->dev, " type 0x%x offset 0x%x\n",
- block->type, block->offset);
- continue;
- }
-
- switch (block->type) {
- case SOF_FW_BLK_TYPE_RSRVD0:
- case SOF_FW_BLK_TYPE_ROM...SOF_FW_BLK_TYPE_RSRVD14:
- continue; /* not handled atm */
- case SOF_FW_BLK_TYPE_IRAM:
- case SOF_FW_BLK_TYPE_DRAM:
- case SOF_FW_BLK_TYPE_SRAM:
- offset = block->offset;
- break;
- default:
- dev_err(sdev->dev, "error: bad type 0x%x for block 0x%x\n",
- block->type, count);
- return -EINVAL;
- }
-
- dev_dbg(sdev->dev,
- "block %d type 0x%x size 0x%x ==> offset 0x%x\n",
- count, block->type, block->size, offset);
-
- /* checking block->size to avoid unaligned access */
- if (block->size % sizeof(u32)) {
- dev_err(sdev->dev, "error: invalid block size 0x%x\n",
- block->size);
- return -EINVAL;
- }
- ret = snd_sof_dsp_block_write(sdev, block->type, offset,
- block + 1, block->size);
- if (ret < 0) {
- dev_err(sdev->dev, "error: write to block type 0x%x failed\n",
- block->type);
- return ret;
- }
-
- if (remaining < block->size) {
- dev_err(sdev->dev, "error: not enough data remaining\n");
- return -EINVAL;
- }
-
- /* minus body size of block */
- remaining -= block->size;
- /* next block */
- block = (struct snd_sof_blk_hdr *)((u8 *)block + sizeof(*block)
- + block->size);
- }
-
- return 0;
-}
-EXPORT_SYMBOL(snd_sof_parse_module_memcpy);
-
-static int check_header(struct snd_sof_dev *sdev, const struct firmware *fw,
- size_t fw_offset)
-{
- struct snd_sof_fw_header *header;
- size_t fw_size = fw->size - fw_offset;
-
- if (fw->size <= fw_offset) {
- dev_err(sdev->dev, "error: firmware size must be greater than firmware offset\n");
- return -EINVAL;
- }
-
- /* Read the header information from the data pointer */
- header = (struct snd_sof_fw_header *)(fw->data + fw_offset);
-
- /* verify FW sig */
- if (strncmp(header->sig, SND_SOF_FW_SIG, SND_SOF_FW_SIG_SIZE) != 0) {
- dev_err(sdev->dev, "error: invalid firmware signature\n");
- return -EINVAL;
- }
-
- /* check size is valid */
- if (fw_size != header->file_size + sizeof(*header)) {
- dev_err(sdev->dev, "error: invalid filesize mismatch got 0x%zx expected 0x%zx\n",
- fw_size, header->file_size + sizeof(*header));
- return -EINVAL;
- }
-
- dev_dbg(sdev->dev, "header size=0x%x modules=0x%x abi=0x%x size=%zu\n",
- header->file_size, header->num_modules,
- header->abi, sizeof(*header));
-
- return 0;
-}
-
-static int load_modules(struct snd_sof_dev *sdev, const struct firmware *fw,
- size_t fw_offset)
-{
- struct snd_sof_fw_header *header;
- struct snd_sof_mod_hdr *module;
- int (*load_module)(struct snd_sof_dev *sof_dev,
- struct snd_sof_mod_hdr *hdr);
- int ret, count;
- size_t remaining;
-
- header = (struct snd_sof_fw_header *)(fw->data + fw_offset);
- load_module = sof_ops(sdev)->load_module;
- if (!load_module)
- return -EINVAL;
-
- /* parse each module */
- module = (struct snd_sof_mod_hdr *)(fw->data + fw_offset +
- sizeof(*header));
- remaining = fw->size - sizeof(*header) - fw_offset;
- /* check for wrap */
- if (remaining > fw->size) {
- dev_err(sdev->dev, "error: fw size smaller than header size\n");
- return -EINVAL;
- }
-
- for (count = 0; count < header->num_modules; count++) {
- /* check for wrap */
- if (remaining < sizeof(*module)) {
- dev_err(sdev->dev, "error: not enough data remaining\n");
- return -EINVAL;
- }
-
- /* minus header size of module */
- remaining -= sizeof(*module);
-
- /* module */
- ret = load_module(sdev, module);
- if (ret < 0) {
- dev_err(sdev->dev, "error: invalid module %d\n", count);
- return ret;
- }
-
- if (remaining < module->size) {
- dev_err(sdev->dev, "error: not enough data remaining\n");
- return -EINVAL;
- }
-
- /* minus body size of module */
- remaining -= module->size;
- module = (struct snd_sof_mod_hdr *)((u8 *)module
- + sizeof(*module) + module->size);
- }
-
- return 0;
-}
-
int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev)
{
struct snd_sof_pdata *plat_data = sdev->pdata;
@@ -499,7 +45,7 @@ int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev)
}
/* check for extended manifest */
- ext_man_size = snd_sof_fw_ext_man_parse(sdev, plat_data->fw);
+ ext_man_size = sdev->ipc->ops->fw_loader->parse_ext_manifest(sdev);
if (ext_man_size > 0) {
/* when no error occurred, drop extended manifest */
plat_data->fw_offset = ext_man_size;
@@ -529,7 +75,7 @@ int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev)
return ret;
/* make sure the FW header and file is valid */
- ret = check_header(sdev, plat_data->fw, plat_data->fw_offset);
+ ret = sdev->ipc->ops->fw_loader->validate(sdev);
if (ret < 0) {
dev_err(sdev->dev, "error: invalid FW header\n");
goto error;
@@ -543,10 +89,12 @@ int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev)
}
/* parse and load firmware modules to DSP */
- ret = load_modules(sdev, plat_data->fw, plat_data->fw_offset);
- if (ret < 0) {
- dev_err(sdev->dev, "error: invalid FW modules\n");
- goto error;
+ if (sdev->ipc->ops->fw_loader->load_fw_to_dsp) {
+ ret = sdev->ipc->ops->fw_loader->load_fw_to_dsp(sdev);
+ if (ret < 0) {
+ dev_err(sdev->dev, "Firmware loading failed\n");
+ goto error;
+ }
}
return 0;
@@ -627,6 +175,9 @@ int snd_sof_run_firmware(struct snd_sof_dev *sdev)
dev_dbg(sdev->dev, "firmware boot complete\n");
sof_set_fw_state(sdev, SOF_FW_BOOT_COMPLETE);
+ if (sdev->first_boot && sdev->ipc->ops->fw_loader->query_fw_configuration)
+ return sdev->ipc->ops->fw_loader->query_fw_configuration(sdev);
+
return 0;
}
EXPORT_SYMBOL(snd_sof_run_firmware);
diff --git a/sound/soc/sof/mediatek/mt8195/mt8195.c b/sound/soc/sof/mediatek/mt8195/mt8195.c
index 6216af2d2263..ba13e4540f7a 100644
--- a/sound/soc/sof/mediatek/mt8195/mt8195.c
+++ b/sound/soc/sof/mediatek/mt8195/mt8195.c
@@ -415,8 +415,6 @@ static struct snd_sof_dsp_ops sof_mt8195_ops = {
/* misc */
.get_bar_index = mt8195_get_bar_index,
- /* module loading */
- .load_module = snd_sof_parse_module_memcpy,
/* firmware loading */
.load_firmware = snd_sof_load_firmware_memcpy,
diff --git a/sound/soc/sof/sof-priv.h b/sound/soc/sof/sof-priv.h
index 382187e89e54..a1141ea8d907 100644
--- a/sound/soc/sof/sof-priv.h
+++ b/sound/soc/sof/sof-priv.h
@@ -364,6 +364,25 @@ struct sof_ipc_pm_ops {
int (*ctx_restore)(struct snd_sof_dev *sdev);
};
+/**
+ * struct sof_ipc_fw_loader_ops - IPC/FW-specific loader ops
+ * @validate: Function pointer for validating the firmware image
+ * @parse_ext_manifest: Function pointer for parsing the manifest of the firmware
+ * @load_fw_to_dsp: Optional function pointer for loading the firmware to the
+ * DSP.
+ * The function implements generic, hardware independent way
+ * of loading the initial firmware and its modules (if any).
+ * @query_fw_configuration: Optional function pointer to query information and
+ * configuration from the booted firmware.
+ * Executed after the first successful firmware boot.
+ */
+struct sof_ipc_fw_loader_ops {
+ int (*validate)(struct snd_sof_dev *sdev);
+ size_t (*parse_ext_manifest)(struct snd_sof_dev *sdev);
+ int (*load_fw_to_dsp)(struct snd_sof_dev *sdev);
+ int (*query_fw_configuration)(struct snd_sof_dev *sdev);
+};
+
struct sof_ipc_tplg_ops;
struct sof_ipc_pcm_ops;
@@ -372,6 +391,7 @@ struct sof_ipc_pcm_ops;
* @tplg: Pointer to IPC-specific topology ops
* @pm: Pointer to PM ops
* @pcm: Pointer to PCM ops
+ * @fw_loader: Pointer to Firmware Loader ops
*
* @tx_msg: Function pointer for sending a 'short' IPC message
* @set_get_data: Function pointer for set/get data ('large' IPC message). This
@@ -391,6 +411,7 @@ struct sof_ipc_ops {
const struct sof_ipc_tplg_ops *tplg;
const struct sof_ipc_pm_ops *pm;
const struct sof_ipc_pcm_ops *pcm;
+ const struct sof_ipc_fw_loader_ops *fw_loader;
int (*tx_msg)(struct snd_sof_dev *sdev, void *msg_data, size_t msg_bytes,
void *reply_data, size_t reply_bytes, bool no_pm);
@@ -587,8 +608,6 @@ extern struct snd_compress_ops sof_compressed_ops;
int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev);
int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev);
int snd_sof_run_firmware(struct snd_sof_dev *sdev);
-int snd_sof_parse_module_memcpy(struct snd_sof_dev *sdev,
- struct snd_sof_mod_hdr *module);
void snd_sof_fw_unload(struct snd_sof_dev *sdev);
/*
@@ -602,7 +621,6 @@ static inline void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev)
{
sdev->ipc->ops->rx_msg(sdev);
}
-int snd_sof_ipc_valid(struct snd_sof_dev *sdev);
int sof_ipc_tx_message(struct snd_sof_ipc *ipc, void *msg_data, size_t msg_bytes,
void *reply_data, size_t reply_bytes);
int sof_ipc_tx_message_no_pm(struct snd_sof_ipc *ipc, void *msg_data, size_t msg_bytes,