xref: /linux/sound/soc/sof/amd/acp-common.c (revision 4b132aacb0768ac1e652cf517097ea6f237214b9)
1 // SPDX-License-Identifier: (GPL-2.0-only 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) 2022 Advanced Micro Devices, Inc.
7 //
8 // Authors: Ajit Kumar Pandey <AjitKumar.Pandey@amd.com>
9 //	    V sujith kumar Reddy <Vsujithkumar.Reddy@amd.com>
10 
11 /* ACP-specific Common code */
12 
13 #include "../sof-priv.h"
14 #include "../sof-audio.h"
15 #include "../ops.h"
16 #include "acp.h"
17 #include "acp-dsp-offset.h"
18 #include <sound/sof/xtensa.h>
19 
20 /**
21  * amd_sof_ipc_dump() - This function is called when IPC tx times out.
22  * @sdev: SOF device.
23  */
24 void amd_sof_ipc_dump(struct snd_sof_dev *sdev)
25 {
26 	const struct sof_amd_acp_desc *desc = get_chip_info(sdev->pdata);
27 	u32 base = desc->dsp_intr_base;
28 	u32 dsp_msg_write = sdev->debug_box.offset +
29 			    offsetof(struct scratch_ipc_conf, sof_dsp_msg_write);
30 	u32 dsp_ack_write = sdev->debug_box.offset +
31 			    offsetof(struct scratch_ipc_conf, sof_dsp_ack_write);
32 	u32 host_msg_write = sdev->debug_box.offset +
33 			     offsetof(struct scratch_ipc_conf, sof_host_msg_write);
34 	u32 host_ack_write = sdev->debug_box.offset +
35 			     offsetof(struct scratch_ipc_conf, sof_host_ack_write);
36 	u32 dsp_msg, dsp_ack, host_msg, host_ack, irq_stat;
37 
38 	dsp_msg = snd_sof_dsp_read(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + dsp_msg_write);
39 	dsp_ack = snd_sof_dsp_read(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + dsp_ack_write);
40 	host_msg = snd_sof_dsp_read(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + host_msg_write);
41 	host_ack = snd_sof_dsp_read(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + host_ack_write);
42 	irq_stat = snd_sof_dsp_read(sdev, ACP_DSP_BAR, base + DSP_SW_INTR_STAT_OFFSET);
43 
44 	dev_err(sdev->dev,
45 		"dsp_msg = %#x dsp_ack = %#x host_msg = %#x host_ack = %#x irq_stat = %#x\n",
46 		dsp_msg, dsp_ack, host_msg, host_ack, irq_stat);
47 }
48 
49 /**
50  * amd_get_registers() - This function is called in case of DSP oops
51  * in order to gather information about the registers, filename and
52  * linenumber and stack.
53  * @sdev: SOF device.
54  * @xoops: Stores information about registers.
55  * @panic_info: Stores information about filename and line number.
56  * @stack: Stores the stack dump.
57  * @stack_words: Size of the stack dump.
58  */
59 static void amd_get_registers(struct snd_sof_dev *sdev,
60 			      struct sof_ipc_dsp_oops_xtensa *xoops,
61 			      struct sof_ipc_panic_info *panic_info,
62 			      u32 *stack, size_t stack_words)
63 {
64 	u32 offset = sdev->dsp_oops_offset;
65 
66 	/* first read registers */
67 	acp_mailbox_read(sdev, offset, xoops, sizeof(*xoops));
68 
69 	/* then get panic info */
70 	if (xoops->arch_hdr.totalsize > EXCEPT_MAX_HDR_SIZE) {
71 		dev_err(sdev->dev, "invalid header size 0x%x. FW oops is bogus\n",
72 			xoops->arch_hdr.totalsize);
73 		return;
74 	}
75 
76 	offset += xoops->arch_hdr.totalsize;
77 	acp_mailbox_read(sdev, offset, panic_info, sizeof(*panic_info));
78 
79 	/* then get the stack */
80 	offset += sizeof(*panic_info);
81 	acp_mailbox_read(sdev, offset, stack, stack_words * sizeof(u32));
82 }
83 
84 /**
85  * amd_sof_dump() - This function is called when a panic message is
86  * received from the firmware.
87  * @sdev: SOF device.
88  * @flags: parameter not used but required by ops prototype
89  */
90 void amd_sof_dump(struct snd_sof_dev *sdev, u32 flags)
91 {
92 	struct sof_ipc_dsp_oops_xtensa xoops;
93 	struct sof_ipc_panic_info panic_info;
94 	u32 stack[AMD_STACK_DUMP_SIZE];
95 	u32 status;
96 
97 	/* Get information about the panic status from the debug box area.
98 	 * Compute the trace point based on the status.
99 	 */
100 	if (sdev->dsp_oops_offset > sdev->debug_box.offset) {
101 		acp_mailbox_read(sdev, sdev->debug_box.offset, &status, sizeof(u32));
102 	} else {
103 		/* Read DSP Panic status from dsp_box.
104 		 * As window information for exception box offset and size is not available
105 		 * before FW_READY
106 		 */
107 		acp_mailbox_read(sdev, sdev->dsp_box.offset, &status, sizeof(u32));
108 		sdev->dsp_oops_offset = sdev->dsp_box.offset + sizeof(status);
109 	}
110 
111 	/* Get information about the registers, the filename and line
112 	 * number and the stack.
113 	 */
114 	amd_get_registers(sdev, &xoops, &panic_info, stack, AMD_STACK_DUMP_SIZE);
115 
116 	/* Print the information to the console */
117 	sof_print_oops_and_stack(sdev, KERN_ERR, status, status, &xoops,
118 				 &panic_info, stack, AMD_STACK_DUMP_SIZE);
119 }
120 
121 #if IS_ENABLED(CONFIG_SND_SOC_SOF_AMD_SOUNDWIRE)
122 static int amd_sof_sdw_get_slave_info(struct snd_sof_dev *sdev)
123 {
124 	struct acp_dev_data *acp_data = sdev->pdata->hw_pdata;
125 
126 	return sdw_amd_get_slave_info(acp_data->sdw);
127 }
128 
129 static struct snd_soc_acpi_mach *amd_sof_sdw_machine_select(struct snd_sof_dev *sdev)
130 {
131 	struct snd_soc_acpi_mach *mach;
132 	const struct snd_soc_acpi_link_adr *link;
133 	struct acp_dev_data *acp_data = sdev->pdata->hw_pdata;
134 	int ret, i;
135 
136 	if (acp_data->info.count) {
137 		ret = amd_sof_sdw_get_slave_info(sdev);
138 		if (ret) {
139 			dev_info(sdev->dev, "failed to read slave information\n");
140 			return NULL;
141 		}
142 		for (mach = sdev->pdata->desc->alt_machines; mach; mach++) {
143 			if (!mach->links)
144 				break;
145 			link = mach->links;
146 			for (i = 0; i < acp_data->info.count && link->num_adr; link++, i++) {
147 				if (!snd_soc_acpi_sdw_link_slaves_found(sdev->dev, link,
148 									acp_data->sdw->ids,
149 									acp_data->sdw->num_slaves))
150 					break;
151 			}
152 			if (i == acp_data->info.count || !link->num_adr)
153 				break;
154 		}
155 		if (mach && mach->link_mask) {
156 			mach->mach_params.links = mach->links;
157 			mach->mach_params.link_mask = mach->link_mask;
158 			mach->mach_params.platform = dev_name(sdev->dev);
159 			return mach;
160 		}
161 	}
162 	dev_info(sdev->dev, "No SoundWire machine driver found\n");
163 	return NULL;
164 }
165 
166 #else
167 static struct snd_soc_acpi_mach *amd_sof_sdw_machine_select(struct snd_sof_dev *sdev)
168 {
169 	return NULL;
170 }
171 #endif
172 
173 struct snd_soc_acpi_mach *amd_sof_machine_select(struct snd_sof_dev *sdev)
174 {
175 	struct snd_sof_pdata *sof_pdata = sdev->pdata;
176 	const struct sof_dev_desc *desc = sof_pdata->desc;
177 	struct snd_soc_acpi_mach *mach = NULL;
178 
179 	if (desc->machines)
180 		mach = snd_soc_acpi_find_machine(desc->machines);
181 	if (!mach) {
182 		mach = amd_sof_sdw_machine_select(sdev);
183 		if (!mach) {
184 			dev_warn(sdev->dev, "No matching ASoC machine driver found\n");
185 			return NULL;
186 		}
187 	}
188 
189 	sof_pdata->tplg_filename = mach->sof_tplg_filename;
190 	sof_pdata->fw_filename = mach->fw_filename;
191 
192 	return mach;
193 }
194 
195 /* AMD Common DSP ops */
196 const struct snd_sof_dsp_ops sof_acp_common_ops = {
197 	/* probe and remove */
198 	.probe			= amd_sof_acp_probe,
199 	.remove			= amd_sof_acp_remove,
200 
201 	/* Register IO */
202 	.write			= sof_io_write,
203 	.read			= sof_io_read,
204 
205 	/* Block IO */
206 	.block_read		= acp_dsp_block_read,
207 	.block_write		= acp_dsp_block_write,
208 
209 	/*Firmware loading */
210 	.load_firmware		= snd_sof_load_firmware_memcpy,
211 	.pre_fw_run		= acp_dsp_pre_fw_run,
212 	.get_bar_index		= acp_get_bar_index,
213 
214 	/* DSP core boot */
215 	.run			= acp_sof_dsp_run,
216 
217 	/*IPC */
218 	.send_msg		= acp_sof_ipc_send_msg,
219 	.ipc_msg_data		= acp_sof_ipc_msg_data,
220 	.set_stream_data_offset = acp_set_stream_data_offset,
221 	.get_mailbox_offset	= acp_sof_ipc_get_mailbox_offset,
222 	.get_window_offset      = acp_sof_ipc_get_window_offset,
223 	.irq_thread		= acp_sof_ipc_irq_thread,
224 
225 	/* stream callbacks */
226 	.pcm_open		= acp_pcm_open,
227 	.pcm_close		= acp_pcm_close,
228 	.pcm_hw_params		= acp_pcm_hw_params,
229 	.pcm_pointer		= acp_pcm_pointer,
230 
231 	.hw_info		= SNDRV_PCM_INFO_MMAP |
232 				  SNDRV_PCM_INFO_MMAP_VALID |
233 				  SNDRV_PCM_INFO_INTERLEAVED |
234 				  SNDRV_PCM_INFO_PAUSE |
235 				  SNDRV_PCM_INFO_NO_PERIOD_WAKEUP,
236 
237 	/* Machine driver callbacks */
238 	.machine_select		= amd_sof_machine_select,
239 	.machine_register	= sof_machine_register,
240 	.machine_unregister	= sof_machine_unregister,
241 
242 	/* Trace Logger */
243 	.trace_init		= acp_sof_trace_init,
244 	.trace_release		= acp_sof_trace_release,
245 
246 	/* PM */
247 	.suspend                = amd_sof_acp_suspend,
248 	.resume                 = amd_sof_acp_resume,
249 
250 	.ipc_dump		= amd_sof_ipc_dump,
251 	.dbg_dump		= amd_sof_dump,
252 	.debugfs_add_region_item = snd_sof_debugfs_add_region_item_iomem,
253 	.dsp_arch_ops = &sof_xtensa_arch_ops,
254 
255 	/* probe client device registation */
256 	.register_ipc_clients = acp_probes_register,
257 	.unregister_ipc_clients = acp_probes_unregister,
258 };
259 EXPORT_SYMBOL_NS(sof_acp_common_ops, SND_SOC_SOF_AMD_COMMON);
260 
261 MODULE_LICENSE("Dual BSD/GPL");
262 MODULE_DESCRIPTION("ACP SOF COMMON Driver");
263 MODULE_IMPORT_NS(SND_SOC_SOF_AMD_COMMON);
264 MODULE_IMPORT_NS(SND_SOC_SOF_XTENSA);
265 MODULE_IMPORT_NS(SOUNDWIRE_AMD_INIT);
266