xref: /linux/sound/soc/sof/amd/acp-common.c (revision e91c37f1)
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 struct snd_soc_acpi_mach *amd_sof_machine_select(struct snd_sof_dev *sdev)
122 {
123 	struct snd_sof_pdata *sof_pdata = sdev->pdata;
124 	const struct sof_dev_desc *desc = sof_pdata->desc;
125 	struct snd_soc_acpi_mach *mach;
126 
127 	mach = snd_soc_acpi_find_machine(desc->machines);
128 	if (!mach) {
129 		dev_warn(sdev->dev, "No matching ASoC machine driver found\n");
130 		return NULL;
131 	}
132 
133 	sof_pdata->tplg_filename = mach->sof_tplg_filename;
134 	sof_pdata->fw_filename = mach->fw_filename;
135 
136 	return mach;
137 }
138 
139 /* AMD Common DSP ops */
140 struct snd_sof_dsp_ops sof_acp_common_ops = {
141 	/* probe and remove */
142 	.probe			= amd_sof_acp_probe,
143 	.remove			= amd_sof_acp_remove,
144 
145 	/* Register IO */
146 	.write			= sof_io_write,
147 	.read			= sof_io_read,
148 
149 	/* Block IO */
150 	.block_read		= acp_dsp_block_read,
151 	.block_write		= acp_dsp_block_write,
152 
153 	/*Firmware loading */
154 	.load_firmware		= snd_sof_load_firmware_memcpy,
155 	.pre_fw_run		= acp_dsp_pre_fw_run,
156 	.get_bar_index		= acp_get_bar_index,
157 
158 	/* DSP core boot */
159 	.run			= acp_sof_dsp_run,
160 
161 	/*IPC */
162 	.send_msg		= acp_sof_ipc_send_msg,
163 	.ipc_msg_data		= acp_sof_ipc_msg_data,
164 	.set_stream_data_offset = acp_set_stream_data_offset,
165 	.get_mailbox_offset	= acp_sof_ipc_get_mailbox_offset,
166 	.get_window_offset      = acp_sof_ipc_get_window_offset,
167 	.irq_thread		= acp_sof_ipc_irq_thread,
168 
169 	/* stream callbacks */
170 	.pcm_open		= acp_pcm_open,
171 	.pcm_close		= acp_pcm_close,
172 	.pcm_hw_params		= acp_pcm_hw_params,
173 	.pcm_pointer		= acp_pcm_pointer,
174 
175 	.hw_info		= SNDRV_PCM_INFO_MMAP |
176 				  SNDRV_PCM_INFO_MMAP_VALID |
177 				  SNDRV_PCM_INFO_INTERLEAVED |
178 				  SNDRV_PCM_INFO_PAUSE |
179 				  SNDRV_PCM_INFO_NO_PERIOD_WAKEUP,
180 
181 	/* Machine driver callbacks */
182 	.machine_select		= amd_sof_machine_select,
183 	.machine_register	= sof_machine_register,
184 	.machine_unregister	= sof_machine_unregister,
185 
186 	/* Trace Logger */
187 	.trace_init		= acp_sof_trace_init,
188 	.trace_release		= acp_sof_trace_release,
189 
190 	/* PM */
191 	.suspend                = amd_sof_acp_suspend,
192 	.resume                 = amd_sof_acp_resume,
193 
194 	.ipc_dump		= amd_sof_ipc_dump,
195 	.dbg_dump		= amd_sof_dump,
196 	.debugfs_add_region_item = snd_sof_debugfs_add_region_item_iomem,
197 	.dsp_arch_ops = &sof_xtensa_arch_ops,
198 
199 	/* probe client device registation */
200 	.register_ipc_clients = acp_probes_register,
201 	.unregister_ipc_clients = acp_probes_unregister,
202 };
203 EXPORT_SYMBOL_NS(sof_acp_common_ops, SND_SOC_SOF_AMD_COMMON);
204 
205 MODULE_IMPORT_NS(SND_SOC_SOF_AMD_COMMON);
206 MODULE_IMPORT_NS(SND_SOC_SOF_XTENSA);
207 MODULE_DESCRIPTION("ACP SOF COMMON Driver");
208 MODULE_LICENSE("Dual BSD/GPL");
209