ASoC: SOF: Firmware (file) layout profile support (including the generic IPC type naming)

include/sound/sof.h

@@ -50,13 +50,59 @@ enum sof_dsp_power_states {
 	SOF_DSP_PM_D3,
 };
 
+/**
+ * enum sof_fw_layout_type - pre-defined file-layout for loadable fw files
+ * @SOF_FW_LAYOUT_VENDOR_IPC3:
+ *	firmware path:		<vendor>/sof</fw_path_postfix>
+ *	firmware name:		sof-<platform>.ri
+ *	topology path:		<vendor>/sof-tplg/
+ * @SOF_FW_LAYOUT_VENDOR_IPC4_SOF:
+ *	firmware path:		<vendor>/sof-ipc4/<platform></fw_path_postfix>
+ *	firmware name:		sof-<platform>.ri
+ *	firmware lib path:	<vendor>/sof-ipc4-lib/<platform></fw_path_postfix>
+ *      topology path:		<vendor>/sof-ipc4-tplg/
+ * @SOF_FW_LAYOUT_VENDOR_IPC4_INTEL_AVS:
+ *	firmware path:		intel/avs/<platform></fw_path_postfix>
+ *	firmware name:		dsp_basefw.bin
+ *	firmware lib path:	intel/avs-lib/<platform></fw_path_postfix>
+ *	topology path:		intel/avs-tplg/
+ * @SOF_FW_LAYOUT_VENDOR_IPC4_INTEL_ACE:
+ *	firmware path:		intel/sof-ipc4/<platform></fw_path_postfix>
+ *	firmware name:		sof-<platform>.ri
+ *	firmware lib path:	intel/sof-ipc4-lib/<platform></fw_path_postfix>
+ *	topology path:		intel/sof-ace-tplg/
+ */
+enum sof_fw_layout_type {
+	SOF_FW_LAYOUT_VENDOR_IPC3,
+	SOF_FW_LAYOUT_VENDOR_IPC4_SOF,
+	SOF_FW_LAYOUT_VENDOR_IPC4_INTEL_AVS,
+	SOF_FW_LAYOUT_VENDOR_IPC4_INTEL_ACE,
+	SOF_FW_LAYOUT_COUNT,
+};
+
 /* Definitions for multiple IPCs */
 enum sof_ipc_type {
-	SOF_IPC,
-	SOF_INTEL_IPC4,
+	SOF_IPC_TYPE_3,
+	SOF_IPC_TYPE_4,
 	SOF_IPC_TYPE_COUNT
 };
 
+/**
+ * struct sof_fw_layout_profile - Description of a firmware layout and type
+ * @ipc_type:		IPC type of the profile
+ * @fw_path:		Path where the @fw_filename resides
+ * @fw_lib_path:	Path where the external libraries can be found (IPC4 only)
+ * @fw_name:		Name of the frmware file
+ * @tplg_path:		Path where to look for the topology files
+ */
+struct sof_fw_layout_profile {
+	enum sof_ipc_type ipc_type;
+	const char *fw_path;
+	const char *fw_lib_path;
+	const char *fw_name;
+	const char *tplg_path;
+};
+
 /*
  * SOF Platform data.
  */
@@ -79,6 +125,8 @@ struct snd_sof_pdata {
 	const struct sof_dev_desc *desc;
 
 	/* firmware and topology filenames */
+	struct sof_fw_layout_profile default_fw_profile;
+
 	const char *fw_filename_prefix;
 	const char *fw_filename;
 	const char *tplg_filename_prefix;
@@ -135,13 +183,9 @@ struct sof_dev_desc {
 	/* The platform supports DSPless mode */
 	bool dspless_mode_supported;
 
-	/* defaults paths for firmware, library and topology files */
-	const char *default_fw_path[SOF_IPC_TYPE_COUNT];
-	const char *default_lib_path[SOF_IPC_TYPE_COUNT];
-	const char *default_tplg_path[SOF_IPC_TYPE_COUNT];
-
-	/* default firmware name */
-	const char *default_fw_filename[SOF_IPC_TYPE_COUNT];
+	/* strings used for the firmware layout path/filename creation */
+	const char *vendor;
+	const char *platform;
 
 	struct snd_sof_dsp_ops *ops;
 	int (*ops_init)(struct snd_sof_dev *sdev);

sound/soc/sof/Kconfig

@@ -272,7 +272,7 @@ config SND_SOC_SOF_PROBE_WORK_QUEUE
 config SND_SOC_SOF_IPC3
 	bool
 
-config SND_SOC_SOF_INTEL_IPC4
+config SND_SOC_SOF_IPC4
 	bool
 
 source "sound/soc/sof/amd/Kconfig"

sound/soc/sof/Makefile

@@ -1,14 +1,15 @@
 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
 
 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
+		control.o trace.o iomem-utils.o sof-audio.o stream-ipc.o\
+		fw-file-layout.o
 
 # IPC implementations
 ifneq ($(CONFIG_SND_SOC_SOF_IPC3),)
 snd-sof-objs +=	ipc3.o ipc3-loader.o ipc3-topology.o ipc3-control.o ipc3-pcm.o\
 		ipc3-dtrace.o
 endif
-ifneq ($(CONFIG_SND_SOC_SOF_INTEL_IPC4),)
+ifneq ($(CONFIG_SND_SOC_SOF_IPC4),)
 snd-sof-objs += ipc4.o ipc4-loader.o ipc4-topology.o ipc4-control.o ipc4-pcm.o\
 		ipc4-mtrace.o
 endif
@@ -30,7 +31,7 @@ snd-sof-probes-objs := sof-client-probes.o
 ifneq ($(CONFIG_SND_SOC_SOF_IPC3),)
 snd-sof-probes-objs += sof-client-probes-ipc3.o
 endif
-ifneq ($(CONFIG_SND_SOC_SOF_INTEL_IPC4),)
+ifneq ($(CONFIG_SND_SOC_SOF_IPC4),)
 snd-sof-probes-objs += sof-client-probes-ipc4.o
 endif
 

sound/soc/sof/amd/pci-rmb.c

@@ -45,17 +45,10 @@ static const struct sof_dev_desc rembrandt_desc = {
 	.resindex_imr_base	= -1,
 	.irqindex_host_ipc	= -1,
 	.chip_info		= &rembrandt_chip_info,
-	.ipc_supported_mask     = BIT(SOF_IPC),
-	.ipc_default            = SOF_IPC,
-	.default_fw_path	= {
-		[SOF_IPC] = "amd/sof",
-	},
-	.default_tplg_path	= {
-		[SOF_IPC] = "amd/sof-tplg",
-	},
-	.default_fw_filename	= {
-		[SOF_IPC] = "sof-rmb.ri",
-	},
+	.ipc_supported_mask     = BIT(SOF_IPC_TYPE_3),
+	.ipc_default            = SOF_IPC_TYPE_3,
+	.vendor			= "amd",
+	.platform		= "rmb",
 	.nocodec_tplg_filename	= "sof-acp.tplg",
 	.ops			= &sof_rembrandt_ops,
 	.ops_init		= sof_rembrandt_ops_init,

sound/soc/sof/amd/pci-rn.c

@@ -45,17 +45,10 @@ static const struct sof_dev_desc renoir_desc = {
 	.resindex_imr_base	= -1,
 	.irqindex_host_ipc	= -1,
 	.chip_info		= &renoir_chip_info,
-	.ipc_supported_mask	= BIT(SOF_IPC),
-	.ipc_default		= SOF_IPC,
-	.default_fw_path = {
-		[SOF_IPC] = "amd/sof",
-	},
-	.default_tplg_path = {
-		[SOF_IPC] = "amd/sof-tplg",
-	},
-	.default_fw_filename	= {
-		[SOF_IPC] = "sof-rn.ri",
-	},
+	.ipc_supported_mask	= BIT(SOF_IPC_TYPE_3),
+	.ipc_default		= SOF_IPC_TYPE_3,
+	.vendor			= "amd",
+	.platform		= "rn",
 	.nocodec_tplg_filename	= "sof-acp.tplg",
 	.ops			= &sof_renoir_ops,
 	.ops_init		= sof_renoir_ops_init,