1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
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.
6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
12 * Hardware interface for audio DSP on Broadwell
15 #include <linux/module.h>
16 #include <sound/sof.h>
17 #include <sound/sof/xtensa.h>
29 /* DSP memories for BDW */
30 #define IRAM_OFFSET 0xA0000
31 #define BDW_IRAM_SIZE (10 * 32 * 1024)
32 #define DRAM_OFFSET 0x00000
33 #define BDW_DRAM_SIZE (20 * 32 * 1024)
34 #define SHIM_OFFSET 0xFB000
35 #define SHIM_SIZE 0x100
36 #define MBOX_OFFSET 0x9E000
37 #define MBOX_SIZE 0x1000
38 #define MBOX_DUMP_SIZE 0x30
39 #define EXCEPT_OFFSET 0x800
42 #define DMAC0_OFFSET 0xFE000
43 #define DMAC1_OFFSET 0xFF000
44 #define DMAC_SIZE 0x420
45 #define SSP0_OFFSET 0xFC000
46 #define SSP1_OFFSET 0xFD000
47 #define SSP_SIZE 0x100
49 #define BDW_STACK_DUMP_SIZE 32
51 #define BDW_PANIC_OFFSET(x) ((x) & 0xFFFF)
53 static const struct snd_sof_debugfs_map bdw_debugfs[] = {
54 {"dmac0", BDW_DSP_BAR, DMAC0_OFFSET, DMAC_SIZE,
55 SOF_DEBUGFS_ACCESS_ALWAYS},
56 {"dmac1", BDW_DSP_BAR, DMAC1_OFFSET, DMAC_SIZE,
57 SOF_DEBUGFS_ACCESS_ALWAYS},
58 {"ssp0", BDW_DSP_BAR, SSP0_OFFSET, SSP_SIZE,
59 SOF_DEBUGFS_ACCESS_ALWAYS},
60 {"ssp1", BDW_DSP_BAR, SSP1_OFFSET, SSP_SIZE,
61 SOF_DEBUGFS_ACCESS_ALWAYS},
62 {"iram", BDW_DSP_BAR, IRAM_OFFSET, BDW_IRAM_SIZE,
63 SOF_DEBUGFS_ACCESS_D0_ONLY},
64 {"dram", BDW_DSP_BAR, DRAM_OFFSET, BDW_DRAM_SIZE,
65 SOF_DEBUGFS_ACCESS_D0_ONLY},
66 {"shim", BDW_DSP_BAR, SHIM_OFFSET, SHIM_SIZE,
67 SOF_DEBUGFS_ACCESS_ALWAYS},
70 static void bdw_host_done(struct snd_sof_dev *sdev);
71 static void bdw_dsp_done(struct snd_sof_dev *sdev);
72 static void bdw_get_reply(struct snd_sof_dev *sdev);
78 static int bdw_run(struct snd_sof_dev *sdev)
80 /* set opportunistic mode on engine 0,1 for all channels */
81 snd_sof_dsp_update_bits(sdev, BDW_DSP_BAR, SHIM_HMDC,
82 SHIM_HMDC_HDDA_E0_ALLCH |
83 SHIM_HMDC_HDDA_E1_ALLCH, 0);
86 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_CSR,
89 /* return init core mask */
93 static int bdw_reset(struct snd_sof_dev *sdev)
95 /* put DSP into reset and stall */
96 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_CSR,
97 SHIM_CSR_RST | SHIM_CSR_STALL,
98 SHIM_CSR_RST | SHIM_CSR_STALL);
100 /* keep in reset for 10ms */
103 /* take DSP out of reset and keep stalled for FW loading */
104 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_CSR,
105 SHIM_CSR_RST | SHIM_CSR_STALL,
111 static int bdw_set_dsp_D0(struct snd_sof_dev *sdev)
116 /* Disable core clock gating (VDRTCTL2.DCLCGE = 0) */
117 snd_sof_dsp_update_bits_unlocked(sdev, BDW_PCI_BAR, PCI_VDRTCTL2,
119 PCI_VDRTCL2_DTCGE, 0);
121 /* Disable D3PG (VDRTCTL0.D3PGD = 1) */
122 snd_sof_dsp_update_bits_unlocked(sdev, BDW_PCI_BAR, PCI_VDRTCTL0,
123 PCI_VDRTCL0_D3PGD, PCI_VDRTCL0_D3PGD);
126 snd_sof_dsp_update_bits_unlocked(sdev, BDW_PCI_BAR, PCI_PMCS,
127 PCI_PMCS_PS_MASK, 0);
129 /* check that ADSP shim is enabled */
131 reg = readl(sdev->bar[BDW_PCI_BAR] + PCI_PMCS)
143 * select SSP1 19.2MHz base clock, SSP clock 0,
144 * turn off Low Power Clock
146 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_CSR,
147 SHIM_CSR_S1IOCS | SHIM_CSR_SBCS1 |
150 /* stall DSP core, set clk to 192/96Mhz */
151 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR,
152 SHIM_CSR, SHIM_CSR_STALL |
157 /* Set 24MHz MCLK, prevent local clock gating, enable SSP0 clock */
158 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_CLKCTL,
166 /* Stall and reset core, set CSR */
169 /* Enable core clock gating (VDRTCTL2.DCLCGE = 1), delay 50 us */
170 snd_sof_dsp_update_bits_unlocked(sdev, BDW_PCI_BAR, PCI_VDRTCTL2,
176 usleep_range(50, 55);
178 /* switch on audio PLL */
179 snd_sof_dsp_update_bits_unlocked(sdev, BDW_PCI_BAR, PCI_VDRTCTL2,
180 PCI_VDRTCL2_APLLSE_MASK, 0);
183 * set default power gating control, enable power gating control for
184 * all blocks. that is, can't be accessed, please enable each block
187 snd_sof_dsp_update_bits_unlocked(sdev, BDW_PCI_BAR, PCI_VDRTCTL0,
190 /* disable DMA finish function for SSP0 & SSP1 */
191 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_CSR2,
193 SHIM_CSR2_SDFD_SSP1);
195 /* set on-demond mode on engine 0,1 for all channels */
196 snd_sof_dsp_update_bits(sdev, BDW_DSP_BAR, SHIM_HMDC,
197 SHIM_HMDC_HDDA_E0_ALLCH |
198 SHIM_HMDC_HDDA_E1_ALLCH,
199 SHIM_HMDC_HDDA_E0_ALLCH |
200 SHIM_HMDC_HDDA_E1_ALLCH);
202 /* Enable Interrupt from both sides */
203 snd_sof_dsp_update_bits(sdev, BDW_DSP_BAR, SHIM_IMRX,
204 (SHIM_IMRX_BUSY | SHIM_IMRX_DONE), 0x0);
205 snd_sof_dsp_update_bits(sdev, BDW_DSP_BAR, SHIM_IMRD,
206 (SHIM_IMRD_DONE | SHIM_IMRD_BUSY |
207 SHIM_IMRD_SSP0 | SHIM_IMRD_DMAC), 0x0);
209 /* clear IPC registers */
210 snd_sof_dsp_write(sdev, BDW_DSP_BAR, SHIM_IPCX, 0x0);
211 snd_sof_dsp_write(sdev, BDW_DSP_BAR, SHIM_IPCD, 0x0);
212 snd_sof_dsp_write(sdev, BDW_DSP_BAR, 0x80, 0x6);
213 snd_sof_dsp_write(sdev, BDW_DSP_BAR, 0xe0, 0x300a);
218 static void bdw_get_registers(struct snd_sof_dev *sdev,
219 struct sof_ipc_dsp_oops_xtensa *xoops,
220 struct sof_ipc_panic_info *panic_info,
221 u32 *stack, size_t stack_words)
223 u32 offset = sdev->dsp_oops_offset;
225 /* first read registers */
226 sof_mailbox_read(sdev, offset, xoops, sizeof(*xoops));
228 /* note: variable AR register array is not read */
230 /* then get panic info */
231 offset += xoops->arch_hdr.totalsize;
232 sof_mailbox_read(sdev, offset, panic_info, sizeof(*panic_info));
234 /* then get the stack */
235 offset += sizeof(*panic_info);
236 sof_mailbox_read(sdev, offset, stack, stack_words * sizeof(u32));
239 static void bdw_dump(struct snd_sof_dev *sdev, u32 flags)
241 struct sof_ipc_dsp_oops_xtensa xoops;
242 struct sof_ipc_panic_info panic_info;
243 u32 stack[BDW_STACK_DUMP_SIZE];
246 /* now try generic SOF status messages */
247 status = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IPCD);
248 panic = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IPCX);
249 bdw_get_registers(sdev, &xoops, &panic_info, stack,
250 BDW_STACK_DUMP_SIZE);
251 snd_sof_get_status(sdev, status, panic, &xoops, &panic_info, stack,
252 BDW_STACK_DUMP_SIZE);
256 * IPC Doorbell IRQ handler and thread.
259 static irqreturn_t bdw_irq_handler(int irq, void *context)
261 struct snd_sof_dev *sdev = context;
265 /* Interrupt arrived, check src */
266 isr = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_ISRX);
267 if (isr & (SHIM_ISRX_DONE | SHIM_ISRX_BUSY))
268 ret = IRQ_WAKE_THREAD;
273 static irqreturn_t bdw_irq_thread(int irq, void *context)
275 struct snd_sof_dev *sdev = context;
276 u32 ipcx, ipcd, imrx;
278 imrx = snd_sof_dsp_read64(sdev, BDW_DSP_BAR, SHIM_IMRX);
279 ipcx = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IPCX);
281 /* reply message from DSP */
282 if (ipcx & SHIM_IPCX_DONE &&
283 !(imrx & SHIM_IMRX_DONE)) {
284 /* Mask Done interrupt before return */
285 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR,
286 SHIM_IMRX, SHIM_IMRX_DONE,
289 spin_lock_irq(&sdev->ipc_lock);
292 * handle immediate reply from DSP core. If the msg is
293 * found, set done bit in cmd_done which is called at the
294 * end of message processing function, else set it here
295 * because the done bit can't be set in cmd_done function
296 * which is triggered by msg
299 snd_sof_ipc_reply(sdev, ipcx);
303 spin_unlock_irq(&sdev->ipc_lock);
306 ipcd = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IPCD);
308 /* new message from DSP */
309 if (ipcd & SHIM_IPCD_BUSY &&
310 !(imrx & SHIM_IMRX_BUSY)) {
311 /* Mask Busy interrupt before return */
312 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR,
313 SHIM_IMRX, SHIM_IMRX_BUSY,
316 /* Handle messages from DSP Core */
317 if ((ipcd & SOF_IPC_PANIC_MAGIC_MASK) == SOF_IPC_PANIC_MAGIC) {
318 snd_sof_dsp_panic(sdev, BDW_PANIC_OFFSET(ipcx) +
321 snd_sof_ipc_msgs_rx(sdev);
334 static int bdw_send_msg(struct snd_sof_dev *sdev, struct snd_sof_ipc_msg *msg)
336 /* send the message */
337 sof_mailbox_write(sdev, sdev->host_box.offset, msg->msg_data,
339 snd_sof_dsp_write(sdev, BDW_DSP_BAR, SHIM_IPCX, SHIM_IPCX_BUSY);
344 static void bdw_get_reply(struct snd_sof_dev *sdev)
346 struct snd_sof_ipc_msg *msg = sdev->msg;
347 struct sof_ipc_reply reply;
351 * Sometimes, there is unexpected reply ipc arriving. The reply
352 * ipc belongs to none of the ipcs sent from driver.
353 * In this case, the driver must ignore the ipc.
356 dev_warn(sdev->dev, "unexpected ipc interrupt raised!\n");
361 sof_mailbox_read(sdev, sdev->host_box.offset, &reply, sizeof(reply));
363 if (reply.error < 0) {
364 memcpy(msg->reply_data, &reply, sizeof(reply));
367 /* reply correct size ? */
368 if (reply.hdr.size != msg->reply_size) {
369 dev_err(sdev->dev, "error: reply expected %zu got %u bytes\n",
370 msg->reply_size, reply.hdr.size);
374 /* read the message */
375 if (msg->reply_size > 0)
376 sof_mailbox_read(sdev, sdev->host_box.offset,
377 msg->reply_data, msg->reply_size);
380 msg->reply_error = ret;
383 static int bdw_get_mailbox_offset(struct snd_sof_dev *sdev)
388 static int bdw_get_window_offset(struct snd_sof_dev *sdev, u32 id)
393 static void bdw_host_done(struct snd_sof_dev *sdev)
395 /* clear BUSY bit and set DONE bit - accept new messages */
396 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_IPCD,
397 SHIM_IPCD_BUSY | SHIM_IPCD_DONE,
400 /* unmask busy interrupt */
401 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_IMRX,
405 static void bdw_dsp_done(struct snd_sof_dev *sdev)
407 /* clear DONE bit - tell DSP we have completed */
408 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_IPCX,
411 /* unmask Done interrupt */
412 snd_sof_dsp_update_bits_unlocked(sdev, BDW_DSP_BAR, SHIM_IMRX,
419 static int bdw_probe(struct snd_sof_dev *sdev)
421 struct snd_sof_pdata *pdata = sdev->pdata;
422 const struct sof_dev_desc *desc = pdata->desc;
423 struct platform_device *pdev =
424 container_of(sdev->dev, struct platform_device, dev);
425 struct resource *mmio;
430 mmio = platform_get_resource(pdev, IORESOURCE_MEM,
431 desc->resindex_lpe_base);
434 size = resource_size(mmio);
436 dev_err(sdev->dev, "error: failed to get LPE base at idx %d\n",
437 desc->resindex_lpe_base);
441 dev_dbg(sdev->dev, "LPE PHY base at 0x%x size 0x%x", base, size);
442 sdev->bar[BDW_DSP_BAR] = devm_ioremap(sdev->dev, base, size);
443 if (!sdev->bar[BDW_DSP_BAR]) {
445 "error: failed to ioremap LPE base 0x%x size 0x%x\n",
449 dev_dbg(sdev->dev, "LPE VADDR %p\n", sdev->bar[BDW_DSP_BAR]);
451 /* TODO: add offsets */
452 sdev->mmio_bar = BDW_DSP_BAR;
453 sdev->mailbox_bar = BDW_DSP_BAR;
456 mmio = platform_get_resource(pdev, IORESOURCE_MEM,
457 desc->resindex_pcicfg_base);
460 size = resource_size(mmio);
462 dev_err(sdev->dev, "error: failed to get PCI base at idx %d\n",
463 desc->resindex_pcicfg_base);
467 dev_dbg(sdev->dev, "PCI base at 0x%x size 0x%x", base, size);
468 sdev->bar[BDW_PCI_BAR] = devm_ioremap(sdev->dev, base, size);
469 if (!sdev->bar[BDW_PCI_BAR]) {
471 "error: failed to ioremap PCI base 0x%x size 0x%x\n",
475 dev_dbg(sdev->dev, "PCI VADDR %p\n", sdev->bar[BDW_PCI_BAR]);
477 /* register our IRQ */
478 sdev->ipc_irq = platform_get_irq(pdev, desc->irqindex_host_ipc);
479 if (sdev->ipc_irq < 0)
480 return sdev->ipc_irq;
482 dev_dbg(sdev->dev, "using IRQ %d\n", sdev->ipc_irq);
483 ret = devm_request_threaded_irq(sdev->dev, sdev->ipc_irq,
484 bdw_irq_handler, bdw_irq_thread,
485 IRQF_SHARED, "AudioDSP", sdev);
487 dev_err(sdev->dev, "error: failed to register IRQ %d\n",
492 /* enable the DSP SHIM */
493 ret = bdw_set_dsp_D0(sdev);
495 dev_err(sdev->dev, "error: failed to set DSP D0\n");
499 /* DSP DMA can only access low 31 bits of host memory */
500 ret = dma_coerce_mask_and_coherent(sdev->dev, DMA_BIT_MASK(31));
502 dev_err(sdev->dev, "error: failed to set DMA mask %d\n", ret);
506 /* set default mailbox */
507 snd_sof_dsp_mailbox_init(sdev, MBOX_OFFSET, MBOX_SIZE, 0, 0);
513 static struct snd_soc_dai_driver bdw_dai[] = {
523 const struct snd_sof_dsp_ops sof_bdw_ops = {
527 /* DSP Core Control */
532 .write = sof_io_write,
534 .write64 = sof_io_write64,
535 .read64 = sof_io_read64,
538 .block_read = sof_block_read,
539 .block_write = sof_block_write,
542 .send_msg = bdw_send_msg,
543 .fw_ready = sof_fw_ready,
544 .get_mailbox_offset = bdw_get_mailbox_offset,
545 .get_window_offset = bdw_get_window_offset,
547 .ipc_msg_data = intel_ipc_msg_data,
548 .ipc_pcm_params = intel_ipc_pcm_params,
551 .debug_map = bdw_debugfs,
552 .debug_map_count = ARRAY_SIZE(bdw_debugfs),
553 .dbg_dump = bdw_dump,
555 /* stream callbacks */
556 .pcm_open = intel_pcm_open,
557 .pcm_close = intel_pcm_close,
560 .load_module = snd_sof_parse_module_memcpy,
562 /*Firmware loading */
563 .load_firmware = snd_sof_load_firmware_memcpy,
567 .num_drv = ARRAY_SIZE(bdw_dai)
569 EXPORT_SYMBOL(sof_bdw_ops);
571 const struct sof_intel_dsp_desc bdw_chip_info = {
575 EXPORT_SYMBOL(bdw_chip_info);
577 MODULE_LICENSE("Dual BSD/GPL");