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 // Authors: Liam Girdwood <liam.r.girdwood@linux.intel.com>
9 // Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
10 // Rander Wang <rander.wang@intel.com>
11 // Keyon Jie <yang.jie@linux.intel.com>
15 * Hardware interface for generic Intel audio DSP HDA IP
18 #include <sound/hdaudio_ext.h>
19 #include <sound/hda_register.h>
21 #include <linux/module.h>
22 #include <sound/sof.h>
23 #include <sound/sof/xtensa.h>
27 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
28 #include <sound/soc-acpi-intel-match.h>
31 /* platform specific devices */
34 #define IS_CFL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0xa348)
35 #define IS_CNL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0x9dc8)
41 struct hda_dsp_msg_code {
46 static const struct hda_dsp_msg_code hda_dsp_rom_msg[] = {
47 {HDA_DSP_ROM_FW_MANIFEST_LOADED, "status: manifest loaded"},
48 {HDA_DSP_ROM_FW_FW_LOADED, "status: fw loaded"},
49 {HDA_DSP_ROM_FW_ENTERED, "status: fw entered"},
50 {HDA_DSP_ROM_CSE_ERROR, "error: cse error"},
51 {HDA_DSP_ROM_CSE_WRONG_RESPONSE, "error: cse wrong response"},
52 {HDA_DSP_ROM_IMR_TO_SMALL, "error: IMR too small"},
53 {HDA_DSP_ROM_BASE_FW_NOT_FOUND, "error: base fw not found"},
54 {HDA_DSP_ROM_CSE_VALIDATION_FAILED, "error: signature verification failed"},
55 {HDA_DSP_ROM_IPC_FATAL_ERROR, "error: ipc fatal error"},
56 {HDA_DSP_ROM_L2_CACHE_ERROR, "error: L2 cache error"},
57 {HDA_DSP_ROM_LOAD_OFFSET_TO_SMALL, "error: load offset too small"},
58 {HDA_DSP_ROM_API_PTR_INVALID, "error: API ptr invalid"},
59 {HDA_DSP_ROM_BASEFW_INCOMPAT, "error: base fw incompatible"},
60 {HDA_DSP_ROM_UNHANDLED_INTERRUPT, "error: unhandled interrupt"},
61 {HDA_DSP_ROM_MEMORY_HOLE_ECC, "error: ECC memory hole"},
62 {HDA_DSP_ROM_KERNEL_EXCEPTION, "error: kernel exception"},
63 {HDA_DSP_ROM_USER_EXCEPTION, "error: user exception"},
64 {HDA_DSP_ROM_UNEXPECTED_RESET, "error: unexpected reset"},
65 {HDA_DSP_ROM_NULL_FW_ENTRY, "error: null FW entry point"},
68 static void hda_dsp_get_status_skl(struct snd_sof_dev *sdev)
73 status = snd_sof_dsp_read(sdev, HDA_DSP_BAR,
74 HDA_ADSP_FW_STATUS_SKL);
76 for (i = 0; i < ARRAY_SIZE(hda_dsp_rom_msg); i++) {
77 if (status == hda_dsp_rom_msg[i].code) {
78 dev_err(sdev->dev, "%s - code %8.8x\n",
79 hda_dsp_rom_msg[i].msg, status);
84 /* not for us, must be generic sof message */
85 dev_dbg(sdev->dev, "unknown ROM status value %8.8x\n", status);
88 static void hda_dsp_get_status(struct snd_sof_dev *sdev)
93 status = snd_sof_dsp_read(sdev, HDA_DSP_BAR,
94 HDA_DSP_SRAM_REG_ROM_STATUS);
96 for (i = 0; i < ARRAY_SIZE(hda_dsp_rom_msg); i++) {
97 if (status == hda_dsp_rom_msg[i].code) {
98 dev_err(sdev->dev, "%s - code %8.8x\n",
99 hda_dsp_rom_msg[i].msg, status);
104 /* not for us, must be generic sof message */
105 dev_dbg(sdev->dev, "unknown ROM status value %8.8x\n", status);
108 static void hda_dsp_get_registers(struct snd_sof_dev *sdev,
109 struct sof_ipc_dsp_oops_xtensa *xoops,
110 struct sof_ipc_panic_info *panic_info,
111 u32 *stack, size_t stack_words)
113 u32 offset = sdev->dsp_oops_offset;
115 /* first read registers */
116 sof_mailbox_read(sdev, offset, xoops, sizeof(*xoops));
118 /* note: variable AR register array is not read */
120 /* then get panic info */
121 offset += xoops->arch_hdr.totalsize;
122 sof_block_read(sdev, sdev->mmio_bar, offset,
123 panic_info, sizeof(*panic_info));
125 /* then get the stack */
126 offset += sizeof(*panic_info);
127 sof_block_read(sdev, sdev->mmio_bar, offset, stack,
128 stack_words * sizeof(u32));
131 void hda_dsp_dump_skl(struct snd_sof_dev *sdev, u32 flags)
133 struct sof_ipc_dsp_oops_xtensa xoops;
134 struct sof_ipc_panic_info panic_info;
135 u32 stack[HDA_DSP_STACK_DUMP_SIZE];
138 /* try APL specific status message types first */
139 hda_dsp_get_status_skl(sdev);
141 /* now try generic SOF status messages */
142 status = snd_sof_dsp_read(sdev, HDA_DSP_BAR,
143 HDA_ADSP_ERROR_CODE_SKL);
145 /*TODO: Check: there is no define in spec, but it is used in the code*/
146 panic = snd_sof_dsp_read(sdev, HDA_DSP_BAR,
147 HDA_ADSP_ERROR_CODE_SKL + 0x4);
149 if (sdev->boot_complete) {
150 hda_dsp_get_registers(sdev, &xoops, &panic_info, stack,
151 HDA_DSP_STACK_DUMP_SIZE);
152 snd_sof_get_status(sdev, status, panic, &xoops, &panic_info,
153 stack, HDA_DSP_STACK_DUMP_SIZE);
155 dev_err(sdev->dev, "error: status = 0x%8.8x panic = 0x%8.8x\n",
157 hda_dsp_get_status_skl(sdev);
161 void hda_dsp_dump(struct snd_sof_dev *sdev, u32 flags)
163 struct sof_ipc_dsp_oops_xtensa xoops;
164 struct sof_ipc_panic_info panic_info;
165 u32 stack[HDA_DSP_STACK_DUMP_SIZE];
168 /* try APL specific status message types first */
169 hda_dsp_get_status(sdev);
171 /* now try generic SOF status messages */
172 status = snd_sof_dsp_read(sdev, HDA_DSP_BAR,
173 HDA_DSP_SRAM_REG_FW_STATUS);
174 panic = snd_sof_dsp_read(sdev, HDA_DSP_BAR, HDA_DSP_SRAM_REG_FW_TRACEP);
176 if (sdev->boot_complete) {
177 hda_dsp_get_registers(sdev, &xoops, &panic_info, stack,
178 HDA_DSP_STACK_DUMP_SIZE);
179 snd_sof_get_status(sdev, status, panic, &xoops, &panic_info,
180 stack, HDA_DSP_STACK_DUMP_SIZE);
182 dev_err(sdev->dev, "error: status = 0x%8.8x panic = 0x%8.8x\n",
184 hda_dsp_get_status(sdev);
188 void hda_ipc_irq_dump(struct snd_sof_dev *sdev)
190 struct hdac_bus *bus = sof_to_bus(sdev);
197 /* read key IRQ stats and config registers */
198 adspis = snd_sof_dsp_read(sdev, HDA_DSP_BAR, HDA_DSP_REG_ADSPIS);
199 intsts = snd_sof_dsp_read(sdev, HDA_DSP_HDA_BAR, SOF_HDA_INTSTS);
200 intctl = snd_sof_dsp_read(sdev, HDA_DSP_HDA_BAR, SOF_HDA_INTCTL);
201 ppsts = snd_sof_dsp_read(sdev, HDA_DSP_PP_BAR, SOF_HDA_REG_PP_PPSTS);
202 rirbsts = snd_hdac_chip_readb(bus, RIRBSTS);
205 "error: hda irq intsts 0x%8.8x intlctl 0x%8.8x rirb %2.2x\n",
206 intsts, intctl, rirbsts);
208 "error: dsp irq ppsts 0x%8.8x adspis 0x%8.8x\n",
212 void hda_ipc_dump(struct snd_sof_dev *sdev)
218 hda_ipc_irq_dump(sdev);
220 /* read IPC status */
221 hipcie = snd_sof_dsp_read(sdev, HDA_DSP_BAR, HDA_DSP_REG_HIPCIE);
222 hipct = snd_sof_dsp_read(sdev, HDA_DSP_BAR, HDA_DSP_REG_HIPCT);
223 hipcctl = snd_sof_dsp_read(sdev, HDA_DSP_BAR, HDA_DSP_REG_HIPCCTL);
225 /* dump the IPC regs */
226 /* TODO: parse the raw msg */
228 "error: host status 0x%8.8x dsp status 0x%8.8x mask 0x%8.8x\n",
229 hipcie, hipct, hipcctl);
232 static int hda_init(struct snd_sof_dev *sdev)
234 struct hda_bus *hbus;
235 struct hdac_bus *bus;
236 struct pci_dev *pci = to_pci_dev(sdev->dev);
239 hbus = sof_to_hbus(sdev);
240 bus = sof_to_bus(sdev);
243 sof_hda_bus_init(bus, &pci->dev);
245 /* Workaround for a communication error on CFL (bko#199007) and CNL */
246 if (IS_CFL(pci) || IS_CNL(pci))
247 bus->polling_mode = 1;
250 bus->bdl_pos_adj = 0;
252 mutex_init(&hbus->prepare_mutex);
254 hbus->mixer_assigned = -1;
255 hbus->modelname = "sofbus";
257 /* initialise hdac bus */
258 bus->addr = pci_resource_start(pci, 0);
259 #if IS_ENABLED(CONFIG_PCI)
260 bus->remap_addr = pci_ioremap_bar(pci, 0);
262 if (!bus->remap_addr) {
263 dev_err(bus->dev, "error: ioremap error\n");
268 sdev->bar[HDA_DSP_HDA_BAR] = bus->remap_addr;
270 /* get controller capabilities */
271 ret = hda_dsp_ctrl_get_caps(sdev);
273 dev_err(sdev->dev, "error: get caps error\n");
278 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
280 static const char *fixup_tplg_name(struct snd_sof_dev *sdev,
281 const char *sof_tplg_filename)
283 const char *tplg_filename = NULL;
287 filename = devm_kstrdup(sdev->dev, sof_tplg_filename, GFP_KERNEL);
291 /* this assumes a .tplg extension */
292 split_ext = strsep(&filename, ".");
294 tplg_filename = devm_kasprintf(sdev->dev, GFP_KERNEL,
295 "%s-idisp.tplg", split_ext);
299 return tplg_filename;
304 static int hda_init_caps(struct snd_sof_dev *sdev)
306 struct hdac_bus *bus = sof_to_bus(sdev);
307 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
308 struct hdac_ext_link *hlink;
309 struct snd_soc_acpi_mach_params *mach_params;
310 struct snd_soc_acpi_mach *hda_mach;
311 struct snd_sof_pdata *pdata = sdev->pdata;
312 struct snd_soc_acpi_mach *mach;
313 const char *tplg_filename;
319 device_disable_async_suspend(bus->dev);
321 /* check if dsp is there */
323 dev_dbg(sdev->dev, "PP capability, will probe DSP later.\n");
325 ret = hda_dsp_ctrl_init_chip(sdev, true);
327 dev_err(bus->dev, "error: init chip failed with ret: %d\n",
332 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
334 snd_hdac_ext_bus_get_ml_capabilities(bus);
336 /* init i915 and HDMI codecs */
337 ret = hda_codec_i915_init(sdev);
339 dev_err(sdev->dev, "error: no HDMI audio devices found\n");
343 /* codec detection */
344 if (!bus->codec_mask) {
345 dev_info(bus->dev, "no hda codecs found!\n");
347 dev_info(bus->dev, "hda codecs found, mask %lx\n",
350 for (i = 0; i < HDA_MAX_CODECS; i++) {
351 if (bus->codec_mask & (1 << i))
356 * If no machine driver is found, then:
358 * hda machine driver is used if :
359 * 1. there is one HDMI codec and one external HDAudio codec
362 if (!pdata->machine && codec_num <= 2 &&
363 HDA_IDISP_CODEC(bus->codec_mask)) {
364 hda_mach = snd_soc_acpi_intel_hda_machines;
365 pdata->machine = hda_mach;
367 /* topology: use the info from hda_machines */
368 pdata->tplg_filename =
369 hda_mach->sof_tplg_filename;
371 /* firmware: pick the first in machine list */
372 mach = pdata->desc->machines;
373 pdata->fw_filename = mach->sof_fw_filename;
375 dev_info(bus->dev, "using HDA machine driver %s now\n",
378 /* fixup topology file for HDMI only platforms */
379 if (codec_num == 1) {
380 /* use local variable for readability */
381 tplg_filename = pdata->tplg_filename;
382 tplg_filename = fixup_tplg_name(sdev, tplg_filename);
383 if (!tplg_filename) {
384 hda_codec_i915_exit(sdev);
387 pdata->tplg_filename = tplg_filename;
392 /* used by hda machine driver to create dai links */
393 if (pdata->machine) {
394 mach_params = (struct snd_soc_acpi_mach_params *)
395 &pdata->machine->mach_params;
396 mach_params->codec_mask = bus->codec_mask;
397 mach_params->platform = dev_name(sdev->dev);
400 /* create codec instances */
401 hda_codec_probe_bus(sdev);
403 hda_codec_i915_put(sdev);
406 * we are done probing so decrement link counts
408 list_for_each_entry(hlink, &bus->hlink_list, list)
409 snd_hdac_ext_bus_link_put(bus, hlink);
414 static const struct sof_intel_dsp_desc
415 *get_chip_info(struct snd_sof_pdata *pdata)
417 const struct sof_dev_desc *desc = pdata->desc;
418 const struct sof_intel_dsp_desc *chip_info;
420 chip_info = desc->chip_info;
425 int hda_dsp_probe(struct snd_sof_dev *sdev)
427 struct pci_dev *pci = to_pci_dev(sdev->dev);
428 struct sof_intel_hda_dev *hdev;
429 struct hdac_bus *bus;
430 const struct sof_intel_dsp_desc *chip;
434 * detect DSP by checking class/subclass/prog-id information
435 * class=04 subclass 03 prog-if 00: no DSP, legacy driver is required
436 * class=04 subclass 01 prog-if 00: DSP is present
437 * (and may be required e.g. for DMIC or SSP support)
438 * class=04 subclass 03 prog-if 80: either of DSP or legacy mode works
440 if (pci->class == 0x040300) {
441 dev_err(sdev->dev, "error: the DSP is not enabled on this platform, aborting probe\n");
443 } else if (pci->class != 0x040100 && pci->class != 0x040380) {
444 dev_err(sdev->dev, "error: unknown PCI class/subclass/prog-if 0x%06x found, aborting probe\n", pci->class);
447 dev_info(sdev->dev, "DSP detected with PCI class/subclass/prog-if 0x%06x\n", pci->class);
449 chip = get_chip_info(sdev->pdata);
451 dev_err(sdev->dev, "error: no such device supported, chip id:%x\n",
457 hdev = devm_kzalloc(sdev->dev, sizeof(*hdev), GFP_KERNEL);
460 sdev->pdata->hw_pdata = hdev;
463 hdev->dmic_dev = platform_device_register_data(sdev->dev, "dmic-codec",
466 if (IS_ERR(hdev->dmic_dev)) {
467 dev_err(sdev->dev, "error: failed to create DMIC device\n");
468 return PTR_ERR(hdev->dmic_dev);
472 * use position update IPC if either it is forced
473 * or we don't have other choice
475 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_FORCE_IPC_POSITION)
476 hdev->no_ipc_position = 0;
478 hdev->no_ipc_position = sof_ops(sdev)->pcm_pointer ? 1 : 0;
481 /* set up HDA base */
482 bus = sof_to_bus(sdev);
483 ret = hda_init(sdev);
488 #if IS_ENABLED(CONFIG_PCI)
489 sdev->bar[HDA_DSP_BAR] = pci_ioremap_bar(pci, HDA_DSP_BAR);
491 if (!sdev->bar[HDA_DSP_BAR]) {
492 dev_err(sdev->dev, "error: ioremap error\n");
497 sdev->mmio_bar = HDA_DSP_BAR;
498 sdev->mailbox_bar = HDA_DSP_BAR;
500 /* allow 64bit DMA address if supported by H/W */
501 if (!dma_set_mask(&pci->dev, DMA_BIT_MASK(64))) {
502 dev_dbg(sdev->dev, "DMA mask is 64 bit\n");
503 dma_set_coherent_mask(&pci->dev, DMA_BIT_MASK(64));
505 dev_dbg(sdev->dev, "DMA mask is 32 bit\n");
506 dma_set_mask(&pci->dev, DMA_BIT_MASK(32));
507 dma_set_coherent_mask(&pci->dev, DMA_BIT_MASK(32));
511 ret = hda_dsp_stream_init(sdev);
513 dev_err(sdev->dev, "error: failed to init streams\n");
515 * not all errors are due to memory issues, but trying
516 * to free everything does not harm
523 * let's try to enable msi firstly
524 * if it fails, use legacy interrupt mode
525 * TODO: support interrupt mode selection with kernel parameter
526 * support msi multiple vectors
528 ret = pci_alloc_irq_vectors(pci, 1, 1, PCI_IRQ_MSI);
530 dev_info(sdev->dev, "use legacy interrupt mode\n");
532 * in IO-APIC mode, hda->irq and ipc_irq are using the same
533 * irq number of pci->irq
535 hdev->irq = pci->irq;
536 sdev->ipc_irq = pci->irq;
537 sdev->msi_enabled = 0;
539 dev_info(sdev->dev, "use msi interrupt mode\n");
540 hdev->irq = pci_irq_vector(pci, 0);
541 /* ipc irq number is the same of hda irq */
542 sdev->ipc_irq = hdev->irq;
543 sdev->msi_enabled = 1;
546 dev_dbg(sdev->dev, "using HDA IRQ %d\n", hdev->irq);
547 ret = request_threaded_irq(hdev->irq, hda_dsp_stream_interrupt,
548 hda_dsp_stream_threaded_handler,
549 IRQF_SHARED, "AudioHDA", bus);
551 dev_err(sdev->dev, "error: failed to register HDA IRQ %d\n",
553 goto free_irq_vector;
556 dev_dbg(sdev->dev, "using IPC IRQ %d\n", sdev->ipc_irq);
557 ret = request_threaded_irq(sdev->ipc_irq, hda_dsp_ipc_irq_handler,
558 sof_ops(sdev)->irq_thread, IRQF_SHARED,
561 dev_err(sdev->dev, "error: failed to register IPC IRQ %d\n",
567 synchronize_irq(pci->irq);
570 * clear TCSEL to clear playback on some HD Audio
571 * codecs. PCI TCSEL is defined in the Intel manuals.
573 snd_sof_pci_update_bits(sdev, PCI_TCSEL, 0x07, 0);
575 /* init HDA capabilities */
576 ret = hda_init_caps(sdev);
580 /* enable ppcap interrupt */
581 hda_dsp_ctrl_ppcap_enable(sdev, true);
582 hda_dsp_ctrl_ppcap_int_enable(sdev, true);
584 /* initialize waitq for code loading */
585 init_waitqueue_head(&sdev->waitq);
587 /* set default mailbox offset for FW ready message */
588 sdev->dsp_box.offset = HDA_DSP_MBOX_UPLINK_OFFSET;
593 free_irq(sdev->ipc_irq, sdev);
595 free_irq(hdev->irq, bus);
597 if (sdev->msi_enabled)
598 pci_free_irq_vectors(pci);
600 hda_dsp_stream_free(sdev);
601 /* dsp_unmap: not currently used */
602 iounmap(sdev->bar[HDA_DSP_BAR]);
604 iounmap(bus->remap_addr);
609 int hda_dsp_remove(struct snd_sof_dev *sdev)
611 struct sof_intel_hda_dev *hda = sdev->pdata->hw_pdata;
612 struct hdac_bus *bus = sof_to_bus(sdev);
613 struct pci_dev *pci = to_pci_dev(sdev->dev);
614 const struct sof_intel_dsp_desc *chip = hda->desc;
616 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
617 /* codec removal, invoke bus_device_remove */
618 snd_hdac_ext_bus_device_remove(bus);
621 if (!IS_ERR_OR_NULL(hda->dmic_dev))
622 platform_device_unregister(hda->dmic_dev);
624 /* disable DSP IRQ */
625 snd_sof_dsp_update_bits(sdev, HDA_DSP_PP_BAR, SOF_HDA_REG_PP_PPCTL,
626 SOF_HDA_PPCTL_PIE, 0);
628 /* disable CIE and GIE interrupts */
629 snd_sof_dsp_update_bits(sdev, HDA_DSP_HDA_BAR, SOF_HDA_INTCTL,
630 SOF_HDA_INT_CTRL_EN | SOF_HDA_INT_GLOBAL_EN, 0);
634 hda_dsp_core_reset_power_down(sdev, chip->cores_mask);
637 snd_sof_dsp_update_bits(sdev, HDA_DSP_PP_BAR, SOF_HDA_REG_PP_PPCTL,
638 SOF_HDA_PPCTL_GPROCEN, 0);
640 free_irq(sdev->ipc_irq, sdev);
641 free_irq(hda->irq, bus);
642 if (sdev->msi_enabled)
643 pci_free_irq_vectors(pci);
645 hda_dsp_stream_free(sdev);
646 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
647 snd_hdac_link_free_all(bus);
650 iounmap(sdev->bar[HDA_DSP_BAR]);
651 iounmap(bus->remap_addr);
653 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
654 snd_hdac_ext_bus_exit(bus);
656 hda_codec_i915_exit(sdev);
661 MODULE_LICENSE("Dual BSD/GPL");