1 // SPDX-License-Identifier: GPL-2.0-only
3 // Copyright(c) 2021-2022 Intel Corporation. All rights reserved.
5 // Authors: Cezary Rojewski <cezary.rojewski@intel.com>
6 // Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
9 #include <linux/io-64-nonatomic-lo-hi.h>
10 #include <linux/slab.h>
11 #include <sound/hdaudio_ext.h>
14 #include "registers.h"
17 #define AVS_IPC_TIMEOUT_MS 300
18 #define AVS_D0IX_DELAY_MS 300
21 avs_dsp_set_d0ix(struct avs_dev *adev, bool enable)
23 struct avs_ipc *ipc = adev->ipc;
26 /* Is transition required? */
27 if (ipc->in_d0ix == enable)
30 ret = avs_dsp_op(adev, set_d0ix, enable);
32 /* Prevent further d0ix attempts on conscious IPC failure. */
34 atomic_inc(&ipc->d0ix_disable_depth);
40 ipc->in_d0ix = enable;
44 static void avs_dsp_schedule_d0ix(struct avs_dev *adev, struct avs_ipc_msg *tx)
46 if (atomic_read(&adev->ipc->d0ix_disable_depth))
49 mod_delayed_work(system_power_efficient_wq, &adev->ipc->d0ix_work,
50 msecs_to_jiffies(AVS_D0IX_DELAY_MS));
53 static void avs_dsp_d0ix_work(struct work_struct *work)
55 struct avs_ipc *ipc = container_of(work, struct avs_ipc, d0ix_work.work);
57 avs_dsp_set_d0ix(to_avs_dev(ipc->dev), true);
60 static int avs_dsp_wake_d0i0(struct avs_dev *adev, struct avs_ipc_msg *tx)
62 struct avs_ipc *ipc = adev->ipc;
64 if (!atomic_read(&ipc->d0ix_disable_depth)) {
65 cancel_delayed_work_sync(&ipc->d0ix_work);
66 return avs_dsp_set_d0ix(adev, false);
72 int avs_dsp_disable_d0ix(struct avs_dev *adev)
74 struct avs_ipc *ipc = adev->ipc;
76 /* Prevent PG only on the first disable. */
77 if (atomic_inc_return(&ipc->d0ix_disable_depth) == 1) {
78 cancel_delayed_work_sync(&ipc->d0ix_work);
79 return avs_dsp_set_d0ix(adev, false);
85 int avs_dsp_enable_d0ix(struct avs_dev *adev)
87 struct avs_ipc *ipc = adev->ipc;
89 if (atomic_dec_and_test(&ipc->d0ix_disable_depth))
90 queue_delayed_work(system_power_efficient_wq, &ipc->d0ix_work,
91 msecs_to_jiffies(AVS_D0IX_DELAY_MS));
95 static void avs_dsp_recovery(struct avs_dev *adev)
97 struct avs_soc_component *acomp;
98 unsigned int core_mask;
101 mutex_lock(&adev->comp_list_mutex);
102 /* disconnect all running streams */
103 list_for_each_entry(acomp, &adev->comp_list, node) {
104 struct snd_soc_pcm_runtime *rtd;
105 struct snd_soc_card *card;
107 card = acomp->base.card;
111 for_each_card_rtds(card, rtd) {
116 if (!pcm || rtd->dai_link->no_pcm)
119 for_each_pcm_streams(dir) {
120 struct snd_pcm_substream *substream;
122 substream = pcm->streams[dir].substream;
123 if (!substream || !substream->runtime)
126 /* No need for _irq() as we are in nonatomic context. */
127 snd_pcm_stream_lock(substream);
128 snd_pcm_stop(substream, SNDRV_PCM_STATE_DISCONNECTED);
129 snd_pcm_stream_unlock(substream);
133 mutex_unlock(&adev->comp_list_mutex);
135 /* forcibly shutdown all cores */
136 core_mask = GENMASK(adev->hw_cfg.dsp_cores - 1, 0);
137 avs_dsp_core_disable(adev, core_mask);
139 /* attempt dsp reboot */
140 ret = avs_dsp_boot_firmware(adev, true);
142 dev_err(adev->dev, "dsp reboot failed: %d\n", ret);
144 pm_runtime_mark_last_busy(adev->dev);
145 pm_runtime_enable(adev->dev);
146 pm_request_autosuspend(adev->dev);
148 atomic_set(&adev->ipc->recovering, 0);
151 static void avs_dsp_recovery_work(struct work_struct *work)
153 struct avs_ipc *ipc = container_of(work, struct avs_ipc, recovery_work);
155 avs_dsp_recovery(to_avs_dev(ipc->dev));
158 static void avs_dsp_exception_caught(struct avs_dev *adev, union avs_notify_msg *msg)
160 struct avs_ipc *ipc = adev->ipc;
162 /* Account for the double-exception case. */
165 if (!atomic_add_unless(&ipc->recovering, 1, 1)) {
166 dev_err(adev->dev, "dsp recovery is already in progress\n");
170 dev_crit(adev->dev, "communication severed, rebooting dsp..\n");
172 cancel_delayed_work_sync(&ipc->d0ix_work);
173 ipc->in_d0ix = false;
174 /* Re-enabled on recovery completion. */
175 pm_runtime_disable(adev->dev);
177 /* Process received notification. */
178 avs_dsp_op(adev, coredump, msg);
180 schedule_work(&ipc->recovery_work);
183 static void avs_dsp_receive_rx(struct avs_dev *adev, u64 header)
185 struct avs_ipc *ipc = adev->ipc;
186 union avs_reply_msg msg = AVS_MSG(header);
189 reg = readq(avs_sram_addr(adev, AVS_FW_REGS_WINDOW));
190 trace_avs_ipc_reply_msg(header, reg);
192 ipc->rx.header = header;
193 /* Abort copying payload if request processing was unsuccessful. */
195 /* update size in case of LARGE_CONFIG_GET */
196 if (msg.msg_target == AVS_MOD_MSG &&
197 msg.global_msg_type == AVS_MOD_LARGE_CONFIG_GET)
198 ipc->rx.size = min_t(u32, AVS_MAILBOX_SIZE,
199 msg.ext.large_config.data_off_size);
201 memcpy_fromio(ipc->rx.data, avs_uplink_addr(adev), ipc->rx.size);
202 trace_avs_msg_payload(ipc->rx.data, ipc->rx.size);
206 static void avs_dsp_process_notification(struct avs_dev *adev, u64 header)
208 struct avs_notify_mod_data mod_data;
209 union avs_notify_msg msg = AVS_MSG(header);
210 size_t data_size = 0;
214 reg = readq(avs_sram_addr(adev, AVS_FW_REGS_WINDOW));
215 trace_avs_ipc_notify_msg(header, reg);
217 /* Ignore spurious notifications until handshake is established. */
218 if (!adev->ipc->ready && msg.notify_msg_type != AVS_NOTIFY_FW_READY) {
219 dev_dbg(adev->dev, "FW not ready, skip notification: 0x%08x\n", msg.primary);
223 /* Calculate notification payload size. */
224 switch (msg.notify_msg_type) {
225 case AVS_NOTIFY_FW_READY:
228 case AVS_NOTIFY_PHRASE_DETECTED:
229 data_size = sizeof(struct avs_notify_voice_data);
232 case AVS_NOTIFY_RESOURCE_EVENT:
233 data_size = sizeof(struct avs_notify_res_data);
236 case AVS_NOTIFY_LOG_BUFFER_STATUS:
237 case AVS_NOTIFY_EXCEPTION_CAUGHT:
240 case AVS_NOTIFY_MODULE_EVENT:
241 /* To know the total payload size, header needs to be read first. */
242 memcpy_fromio(&mod_data, avs_uplink_addr(adev), sizeof(mod_data));
243 data_size = sizeof(mod_data) + mod_data.data_size;
247 dev_info(adev->dev, "unknown notification: 0x%08x\n", msg.primary);
252 data = kmalloc(data_size, GFP_KERNEL);
256 memcpy_fromio(data, avs_uplink_addr(adev), data_size);
257 trace_avs_msg_payload(data, data_size);
260 /* Perform notification-specific operations. */
261 switch (msg.notify_msg_type) {
262 case AVS_NOTIFY_FW_READY:
263 dev_dbg(adev->dev, "FW READY 0x%08x\n", msg.primary);
264 adev->ipc->ready = true;
265 complete(&adev->fw_ready);
268 case AVS_NOTIFY_LOG_BUFFER_STATUS:
269 avs_log_buffer_status_locked(adev, &msg);
272 case AVS_NOTIFY_EXCEPTION_CAUGHT:
273 avs_dsp_exception_caught(adev, &msg);
283 void avs_dsp_process_response(struct avs_dev *adev, u64 header)
285 struct avs_ipc *ipc = adev->ipc;
288 * Response may either be solicited - a reply for a request that has
289 * been sent beforehand - or unsolicited (notification).
291 if (avs_msg_is_reply(header)) {
292 /* Response processing is invoked from IRQ thread. */
293 spin_lock_irq(&ipc->rx_lock);
294 avs_dsp_receive_rx(adev, header);
295 ipc->rx_completed = true;
296 spin_unlock_irq(&ipc->rx_lock);
298 avs_dsp_process_notification(adev, header);
301 complete(&ipc->busy_completion);
304 irqreturn_t avs_dsp_irq_handler(int irq, void *dev_id)
306 struct avs_dev *adev = dev_id;
307 struct avs_ipc *ipc = adev->ipc;
308 u32 adspis, hipc_rsp, hipc_ack;
309 irqreturn_t ret = IRQ_NONE;
311 adspis = snd_hdac_adsp_readl(adev, AVS_ADSP_REG_ADSPIS);
312 if (adspis == UINT_MAX || !(adspis & AVS_ADSP_ADSPIS_IPC))
315 hipc_ack = snd_hdac_adsp_readl(adev, SKL_ADSP_REG_HIPCIE);
316 hipc_rsp = snd_hdac_adsp_readl(adev, SKL_ADSP_REG_HIPCT);
318 /* DSP acked host's request */
319 if (hipc_ack & SKL_ADSP_HIPCIE_DONE) {
321 * As an extra precaution, mask done interrupt. Code executed
322 * due to complete() found below does not assume any masking.
324 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCCTL,
325 AVS_ADSP_HIPCCTL_DONE, 0);
327 complete(&ipc->done_completion);
329 /* tell DSP it has our attention */
330 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCIE,
331 SKL_ADSP_HIPCIE_DONE,
332 SKL_ADSP_HIPCIE_DONE);
333 /* unmask done interrupt */
334 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCCTL,
335 AVS_ADSP_HIPCCTL_DONE,
336 AVS_ADSP_HIPCCTL_DONE);
340 /* DSP sent new response to process */
341 if (hipc_rsp & SKL_ADSP_HIPCT_BUSY) {
342 /* mask busy interrupt */
343 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCCTL,
344 AVS_ADSP_HIPCCTL_BUSY, 0);
346 ret = IRQ_WAKE_THREAD;
352 irqreturn_t avs_dsp_irq_thread(int irq, void *dev_id)
354 struct avs_dev *adev = dev_id;
355 union avs_reply_msg msg;
358 hipct = snd_hdac_adsp_readl(adev, SKL_ADSP_REG_HIPCT);
359 hipcte = snd_hdac_adsp_readl(adev, SKL_ADSP_REG_HIPCTE);
361 /* ensure DSP sent new response to process */
362 if (!(hipct & SKL_ADSP_HIPCT_BUSY))
366 msg.ext.val = hipcte;
367 avs_dsp_process_response(adev, msg.val);
369 /* tell DSP we accepted its message */
370 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCT,
371 SKL_ADSP_HIPCT_BUSY, SKL_ADSP_HIPCT_BUSY);
372 /* unmask busy interrupt */
373 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCCTL,
374 AVS_ADSP_HIPCCTL_BUSY, AVS_ADSP_HIPCCTL_BUSY);
379 static bool avs_ipc_is_busy(struct avs_ipc *ipc)
381 struct avs_dev *adev = to_avs_dev(ipc->dev);
384 hipc_rsp = snd_hdac_adsp_readl(adev, SKL_ADSP_REG_HIPCT);
385 return hipc_rsp & SKL_ADSP_HIPCT_BUSY;
388 static int avs_ipc_wait_busy_completion(struct avs_ipc *ipc, int timeout)
390 u32 repeats_left = 128; /* to avoid infinite looping */
394 ret = wait_for_completion_timeout(&ipc->busy_completion, msecs_to_jiffies(timeout));
396 /* DSP could be unresponsive at this point. */
401 if (!avs_ipc_is_busy(ipc))
404 * Firmware did its job, either notification or reply
405 * has been received - now wait until it's processed.
407 wait_for_completion_killable(&ipc->busy_completion);
410 /* Ongoing notification's bottom-half may cause early wakeup */
411 spin_lock(&ipc->rx_lock);
412 if (!ipc->rx_completed) {
414 /* Reply delayed due to notification. */
416 reinit_completion(&ipc->busy_completion);
417 spin_unlock(&ipc->rx_lock);
421 spin_unlock(&ipc->rx_lock);
425 spin_unlock(&ipc->rx_lock);
429 static void avs_ipc_msg_init(struct avs_ipc *ipc, struct avs_ipc_msg *reply)
431 lockdep_assert_held(&ipc->rx_lock);
434 ipc->rx.size = reply ? reply->size : 0;
435 ipc->rx_completed = false;
437 reinit_completion(&ipc->done_completion);
438 reinit_completion(&ipc->busy_completion);
441 static void avs_dsp_send_tx(struct avs_dev *adev, struct avs_ipc_msg *tx, bool read_fwregs)
445 tx->header |= SKL_ADSP_HIPCI_BUSY;
447 reg = readq(avs_sram_addr(adev, AVS_FW_REGS_WINDOW));
449 trace_avs_request(tx, reg);
452 memcpy_toio(avs_downlink_addr(adev), tx->data, tx->size);
453 snd_hdac_adsp_writel(adev, SKL_ADSP_REG_HIPCIE, tx->header >> 32);
454 snd_hdac_adsp_writel(adev, SKL_ADSP_REG_HIPCI, tx->header & UINT_MAX);
457 static int avs_dsp_do_send_msg(struct avs_dev *adev, struct avs_ipc_msg *request,
458 struct avs_ipc_msg *reply, int timeout)
460 struct avs_ipc *ipc = adev->ipc;
466 mutex_lock(&ipc->msg_mutex);
468 spin_lock(&ipc->rx_lock);
469 avs_ipc_msg_init(ipc, reply);
470 avs_dsp_send_tx(adev, request, true);
471 spin_unlock(&ipc->rx_lock);
473 ret = avs_ipc_wait_busy_completion(ipc, timeout);
475 if (ret == -ETIMEDOUT) {
476 union avs_notify_msg msg = AVS_NOTIFICATION(EXCEPTION_CAUGHT);
478 /* Same treatment as on exception, just stack_dump=0. */
479 avs_dsp_exception_caught(adev, &msg);
484 ret = ipc->rx.rsp.status;
486 reply->header = ipc->rx.header;
487 reply->size = ipc->rx.size;
488 if (reply->data && ipc->rx.size)
489 memcpy(reply->data, ipc->rx.data, reply->size);
493 mutex_unlock(&ipc->msg_mutex);
497 static int avs_dsp_send_msg_sequence(struct avs_dev *adev, struct avs_ipc_msg *request,
498 struct avs_ipc_msg *reply, int timeout, bool wake_d0i0,
503 trace_avs_d0ix("wake", wake_d0i0, request->header);
505 ret = avs_dsp_wake_d0i0(adev, request);
510 ret = avs_dsp_do_send_msg(adev, request, reply, timeout);
514 trace_avs_d0ix("schedule", schedule_d0ix, request->header);
516 avs_dsp_schedule_d0ix(adev, request);
521 int avs_dsp_send_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request,
522 struct avs_ipc_msg *reply, int timeout)
524 bool wake_d0i0 = avs_dsp_op(adev, d0ix_toggle, request, true);
525 bool schedule_d0ix = avs_dsp_op(adev, d0ix_toggle, request, false);
527 return avs_dsp_send_msg_sequence(adev, request, reply, timeout, wake_d0i0, schedule_d0ix);
530 int avs_dsp_send_msg(struct avs_dev *adev, struct avs_ipc_msg *request,
531 struct avs_ipc_msg *reply)
533 return avs_dsp_send_msg_timeout(adev, request, reply, adev->ipc->default_timeout_ms);
536 int avs_dsp_send_pm_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request,
537 struct avs_ipc_msg *reply, int timeout, bool wake_d0i0)
539 return avs_dsp_send_msg_sequence(adev, request, reply, timeout, wake_d0i0, false);
542 int avs_dsp_send_pm_msg(struct avs_dev *adev, struct avs_ipc_msg *request,
543 struct avs_ipc_msg *reply, bool wake_d0i0)
545 return avs_dsp_send_pm_msg_timeout(adev, request, reply, adev->ipc->default_timeout_ms,
549 static int avs_dsp_do_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request, int timeout)
551 struct avs_ipc *ipc = adev->ipc;
554 mutex_lock(&ipc->msg_mutex);
556 spin_lock(&ipc->rx_lock);
557 avs_ipc_msg_init(ipc, NULL);
559 * with hw still stalled, memory windows may not be
560 * configured properly so avoid accessing SRAM
562 avs_dsp_send_tx(adev, request, false);
563 spin_unlock(&ipc->rx_lock);
565 /* ROM messages must be sent before main core is unstalled */
566 ret = avs_dsp_op(adev, stall, AVS_MAIN_CORE_MASK, false);
568 ret = wait_for_completion_timeout(&ipc->done_completion, msecs_to_jiffies(timeout));
569 ret = ret ? 0 : -ETIMEDOUT;
572 mutex_unlock(&ipc->msg_mutex);
577 int avs_dsp_send_rom_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, int timeout)
579 return avs_dsp_do_send_rom_msg(adev, request, timeout);
582 int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request)
584 return avs_dsp_send_rom_msg_timeout(adev, request, adev->ipc->default_timeout_ms);
587 void avs_dsp_interrupt_control(struct avs_dev *adev, bool enable)
592 * No particular bit setting order. All of these are required
593 * to have a functional SW <-> FW communication.
595 value = enable ? AVS_ADSP_ADSPIC_IPC : 0;
596 snd_hdac_adsp_updatel(adev, AVS_ADSP_REG_ADSPIC, AVS_ADSP_ADSPIC_IPC, value);
598 mask = AVS_ADSP_HIPCCTL_DONE | AVS_ADSP_HIPCCTL_BUSY;
599 value = enable ? mask : 0;
600 snd_hdac_adsp_updatel(adev, SKL_ADSP_REG_HIPCCTL, mask, value);
603 int avs_ipc_init(struct avs_ipc *ipc, struct device *dev)
605 ipc->rx.data = devm_kzalloc(dev, AVS_MAILBOX_SIZE, GFP_KERNEL);
611 ipc->default_timeout_ms = AVS_IPC_TIMEOUT_MS;
612 INIT_WORK(&ipc->recovery_work, avs_dsp_recovery_work);
613 INIT_DELAYED_WORK(&ipc->d0ix_work, avs_dsp_d0ix_work);
614 init_completion(&ipc->done_completion);
615 init_completion(&ipc->busy_completion);
616 spin_lock_init(&ipc->rx_lock);
617 mutex_init(&ipc->msg_mutex);
622 void avs_ipc_block(struct avs_ipc *ipc)
625 cancel_work_sync(&ipc->recovery_work);
626 cancel_delayed_work_sync(&ipc->d0ix_work);
627 ipc->in_d0ix = false;