xref: /linux/sound/soc/sof/amd/acp-ipc.c (revision 320fefa9e2edc67011e235ea1d50f0d00ddfe004)
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) 2021 Advanced Micro Devices, Inc.
7 //
8 // Authors: Balakishore Pati <Balakishore.pati@amd.com>
9 //	    Ajit Kumar Pandey <AjitKumar.Pandey@amd.com>
10 
11 /* ACP-specific SOF IPC code */
12 
13 #include <linux/module.h>
14 #include "../ops.h"
15 #include "acp.h"
16 #include "acp-dsp-offset.h"
17 
18 void acp_mailbox_write(struct snd_sof_dev *sdev, u32 offset, void *message, size_t bytes)
19 {
20 	memcpy_to_scratch(sdev, offset, message, bytes);
21 }
22 EXPORT_SYMBOL_NS(acp_mailbox_write, SND_SOC_SOF_AMD_COMMON);
23 
24 void acp_mailbox_read(struct snd_sof_dev *sdev, u32 offset, void *message, size_t bytes)
25 {
26 	memcpy_from_scratch(sdev, offset, message, bytes);
27 }
28 EXPORT_SYMBOL_NS(acp_mailbox_read, SND_SOC_SOF_AMD_COMMON);
29 
30 static void acpbus_trigger_host_to_dsp_swintr(struct acp_dev_data *adata)
31 {
32 	struct snd_sof_dev *sdev = adata->dev;
33 	const struct sof_amd_acp_desc *desc = get_chip_info(sdev->pdata);
34 	u32 swintr_trigger;
35 
36 	swintr_trigger = snd_sof_dsp_read(sdev, ACP_DSP_BAR, desc->dsp_intr_base +
37 						DSP_SW_INTR_TRIG_OFFSET);
38 	swintr_trigger |= 0x01;
39 	snd_sof_dsp_write(sdev, ACP_DSP_BAR, desc->dsp_intr_base + DSP_SW_INTR_TRIG_OFFSET,
40 			  swintr_trigger);
41 }
42 
43 static void acp_ipc_host_msg_set(struct snd_sof_dev *sdev)
44 {
45 	unsigned int host_msg = sdev->debug_box.offset +
46 				offsetof(struct scratch_ipc_conf, sof_host_msg_write);
47 
48 	snd_sof_dsp_write(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + host_msg, 1);
49 }
50 
51 static void acp_dsp_ipc_host_done(struct snd_sof_dev *sdev)
52 {
53 	unsigned int dsp_msg = sdev->debug_box.offset +
54 			       offsetof(struct scratch_ipc_conf, sof_dsp_msg_write);
55 
56 	snd_sof_dsp_write(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + dsp_msg, 0);
57 }
58 
59 static void acp_dsp_ipc_dsp_done(struct snd_sof_dev *sdev)
60 {
61 	unsigned int dsp_ack = sdev->debug_box.offset +
62 			       offsetof(struct scratch_ipc_conf, sof_dsp_ack_write);
63 
64 	snd_sof_dsp_write(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + dsp_ack, 0);
65 }
66 
67 int acp_sof_ipc_send_msg(struct snd_sof_dev *sdev, struct snd_sof_ipc_msg *msg)
68 {
69 	struct acp_dev_data *adata = sdev->pdata->hw_pdata;
70 	const struct sof_amd_acp_desc *desc = get_chip_info(sdev->pdata);
71 	unsigned int offset = sdev->host_box.offset;
72 	unsigned int count = ACP_HW_SEM_RETRY_COUNT;
73 
74 	while (snd_sof_dsp_read(sdev, ACP_DSP_BAR, desc->hw_semaphore_offset)) {
75 		/* Wait until acquired HW Semaphore Lock or timeout*/
76 		count--;
77 		if (!count) {
78 			dev_err(sdev->dev, "%s: Failed to acquire HW lock\n", __func__);
79 			return -EINVAL;
80 		}
81 	}
82 
83 	acp_mailbox_write(sdev, offset, msg->msg_data, msg->msg_size);
84 	acp_ipc_host_msg_set(sdev);
85 
86 	/* Trigger host to dsp interrupt for the msg */
87 	acpbus_trigger_host_to_dsp_swintr(adata);
88 
89 	/* Unlock or Release HW Semaphore */
90 	snd_sof_dsp_write(sdev, ACP_DSP_BAR, desc->hw_semaphore_offset, 0x0);
91 
92 	return 0;
93 }
94 EXPORT_SYMBOL_NS(acp_sof_ipc_send_msg, SND_SOC_SOF_AMD_COMMON);
95 
96 static void acp_dsp_ipc_get_reply(struct snd_sof_dev *sdev)
97 {
98 	struct snd_sof_ipc_msg *msg = sdev->msg;
99 	struct sof_ipc_reply reply;
100 	struct sof_ipc_cmd_hdr *hdr;
101 	unsigned int offset = sdev->host_box.offset;
102 	int ret = 0;
103 
104        /*
105 	* Sometimes, there is unexpected reply ipc arriving. The reply
106 	* ipc belongs to none of the ipcs sent from driver.
107 	* In this case, the driver must ignore the ipc.
108 	*/
109 	if (!msg) {
110 		dev_warn(sdev->dev, "unexpected ipc interrupt raised!\n");
111 		return;
112 	}
113 	hdr = msg->msg_data;
114 	if (hdr->cmd == (SOF_IPC_GLB_PM_MSG | SOF_IPC_PM_CTX_SAVE) ||
115 	    hdr->cmd == (SOF_IPC_GLB_PM_MSG | SOF_IPC_PM_GATE)) {
116 		/*
117 		 * memory windows are powered off before sending IPC reply,
118 		 * so we can't read the mailbox for CTX_SAVE and PM_GATE
119 		 * replies.
120 		 */
121 		reply.error = 0;
122 		reply.hdr.cmd = SOF_IPC_GLB_REPLY;
123 		reply.hdr.size = sizeof(reply);
124 		memcpy(msg->reply_data, &reply, sizeof(reply));
125 		goto out;
126 	}
127 	/* get IPC reply from DSP in the mailbox */
128 	acp_mailbox_read(sdev, offset, &reply, sizeof(reply));
129 	if (reply.error < 0) {
130 		memcpy(msg->reply_data, &reply, sizeof(reply));
131 		ret = reply.error;
132 	} else {
133 		/* reply correct size ? */
134 		if (reply.hdr.size != msg->reply_size &&
135 		    !(reply.hdr.cmd & SOF_IPC_GLB_PROBE)) {
136 			dev_err(sdev->dev, "reply expected %zu got %u bytes\n",
137 				msg->reply_size, reply.hdr.size);
138 			ret = -EINVAL;
139 		}
140 		/* read the message */
141 		if (msg->reply_size > 0)
142 			acp_mailbox_read(sdev, offset, msg->reply_data, msg->reply_size);
143 	}
144 out:
145 	msg->reply_error = ret;
146 }
147 
148 irqreturn_t acp_sof_ipc_irq_thread(int irq, void *context)
149 {
150 	struct snd_sof_dev *sdev = context;
151 	unsigned int dsp_msg_write = sdev->debug_box.offset +
152 				     offsetof(struct scratch_ipc_conf, sof_dsp_msg_write);
153 	unsigned int dsp_ack_write = sdev->debug_box.offset +
154 				     offsetof(struct scratch_ipc_conf, sof_dsp_ack_write);
155 	bool ipc_irq = false;
156 	int dsp_msg, dsp_ack;
157 
158 	if (sdev->first_boot && sdev->fw_state != SOF_FW_BOOT_COMPLETE) {
159 		snd_sof_ipc_msgs_rx(sdev);
160 		acp_dsp_ipc_host_done(sdev);
161 		return IRQ_HANDLED;
162 	}
163 
164 	dsp_msg = snd_sof_dsp_read(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + dsp_msg_write);
165 	if (dsp_msg) {
166 		snd_sof_ipc_msgs_rx(sdev);
167 		acp_dsp_ipc_host_done(sdev);
168 		ipc_irq = true;
169 	}
170 
171 	dsp_ack = snd_sof_dsp_read(sdev, ACP_DSP_BAR, ACP_SCRATCH_REG_0 + dsp_ack_write);
172 	if (dsp_ack) {
173 		spin_lock_irq(&sdev->ipc_lock);
174 		/* handle immediate reply from DSP core */
175 		acp_dsp_ipc_get_reply(sdev);
176 		snd_sof_ipc_reply(sdev, 0);
177 		/* set the done bit */
178 		acp_dsp_ipc_dsp_done(sdev);
179 		spin_unlock_irq(&sdev->ipc_lock);
180 		ipc_irq = true;
181 	}
182 
183 	if (!ipc_irq)
184 		dev_dbg_ratelimited(sdev->dev, "nothing to do in IPC IRQ thread\n");
185 
186 	return IRQ_HANDLED;
187 }
188 EXPORT_SYMBOL_NS(acp_sof_ipc_irq_thread, SND_SOC_SOF_AMD_COMMON);
189 
190 int acp_sof_ipc_msg_data(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream,
191 			 void *p, size_t sz)
192 {
193 	unsigned int offset = sdev->dsp_box.offset;
194 
195 	if (!substream || !sdev->stream_box.size)
196 		acp_mailbox_read(sdev, offset, p, sz);
197 
198 	return 0;
199 }
200 EXPORT_SYMBOL_NS(acp_sof_ipc_msg_data, SND_SOC_SOF_AMD_COMMON);
201 
202 int acp_sof_ipc_get_mailbox_offset(struct snd_sof_dev *sdev)
203 {
204 	const struct sof_amd_acp_desc *desc = get_chip_info(sdev->pdata);
205 
206 	return desc->sram_pte_offset;
207 }
208 EXPORT_SYMBOL_NS(acp_sof_ipc_get_mailbox_offset, SND_SOC_SOF_AMD_COMMON);
209 
210 int acp_sof_ipc_get_window_offset(struct snd_sof_dev *sdev, u32 id)
211 {
212 	return 0;
213 }
214 EXPORT_SYMBOL_NS(acp_sof_ipc_get_window_offset, SND_SOC_SOF_AMD_COMMON);
215 
216 MODULE_DESCRIPTION("AMD ACP sof-ipc driver");
217