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 // Krzysztof Hejmowski <krzysztof.hejmowski@intel.com>
10 // Michal Sienkiewicz <michal.sienkiewicz@intel.com>
13 // for sharing Intel AudioDSP expertise and helping shape the very
14 // foundation of this driver
17 #include <linux/module.h>
18 #include <linux/pci.h>
19 #include <sound/hda_codec.h>
20 #include <sound/hda_i915.h>
21 #include <sound/hda_register.h>
22 #include <sound/hdaudio.h>
23 #include <sound/hdaudio_ext.h>
24 #include <sound/intel-dsp-config.h>
25 #include <sound/intel-nhlt.h>
30 avs_hda_update_config_dword(struct hdac_bus *bus, u32 reg, u32 mask, u32 value)
32 struct pci_dev *pci = to_pci_dev(bus->dev);
35 pci_read_config_dword(pci, reg, &data);
37 data |= (value & mask);
38 pci_write_config_dword(pci, reg, data);
41 void avs_hda_power_gating_enable(struct avs_dev *adev, bool enable)
45 value = enable ? 0 : AZX_PGCTL_LSRMD_MASK;
46 avs_hda_update_config_dword(&adev->base.core, AZX_PCIREG_PGCTL,
47 AZX_PGCTL_LSRMD_MASK, value);
50 static void avs_hdac_clock_gating_enable(struct hdac_bus *bus, bool enable)
54 value = enable ? AZX_CGCTL_MISCBDCGE_MASK : 0;
55 avs_hda_update_config_dword(bus, AZX_PCIREG_CGCTL, AZX_CGCTL_MISCBDCGE_MASK, value);
58 void avs_hda_clock_gating_enable(struct avs_dev *adev, bool enable)
60 avs_hdac_clock_gating_enable(&adev->base.core, enable);
63 void avs_hda_l1sen_enable(struct avs_dev *adev, bool enable)
67 value = enable ? AZX_VS_EM2_L1SEN : 0;
68 snd_hdac_chip_updatel(&adev->base.core, VS_EM2, AZX_VS_EM2_L1SEN, value);
71 static int avs_hdac_bus_init_streams(struct hdac_bus *bus)
73 unsigned int cp_streams, pb_streams;
76 gcap = snd_hdac_chip_readw(bus, GCAP);
77 cp_streams = (gcap >> 8) & 0x0F;
78 pb_streams = (gcap >> 12) & 0x0F;
79 bus->num_streams = cp_streams + pb_streams;
81 snd_hdac_ext_stream_init_all(bus, 0, cp_streams, SNDRV_PCM_STREAM_CAPTURE);
82 snd_hdac_ext_stream_init_all(bus, cp_streams, pb_streams, SNDRV_PCM_STREAM_PLAYBACK);
84 return snd_hdac_bus_alloc_stream_pages(bus);
87 static bool avs_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset)
89 struct hdac_ext_link *hlink;
92 avs_hdac_clock_gating_enable(bus, false);
93 ret = snd_hdac_bus_init_chip(bus, full_reset);
95 /* Reset stream-to-link mapping */
96 list_for_each_entry(hlink, &bus->hlink_list, list)
97 writel(0, hlink->ml_addr + AZX_REG_ML_LOSIDV);
99 avs_hdac_clock_gating_enable(bus, true);
101 /* Set DUM bit to address incorrect position reporting for capture
102 * streams. In order to do so, CTRL needs to be out of reset state
104 snd_hdac_chip_updatel(bus, VS_EM2, AZX_VS_EM2_DUM, AZX_VS_EM2_DUM);
109 static int probe_codec(struct hdac_bus *bus, int addr)
111 struct hda_codec *codec;
112 unsigned int cmd = (addr << 28) | (AC_NODE_ROOT << 20) |
113 (AC_VERB_PARAMETERS << 8) | AC_PAR_VENDOR_ID;
114 unsigned int res = -1;
117 mutex_lock(&bus->cmd_mutex);
118 snd_hdac_bus_send_cmd(bus, cmd);
119 snd_hdac_bus_get_response(bus, addr, &res);
120 mutex_unlock(&bus->cmd_mutex);
124 dev_dbg(bus->dev, "codec #%d probed OK: 0x%x\n", addr, res);
126 codec = snd_hda_codec_device_init(to_hda_bus(bus), addr, "hdaudioB%dD%d", bus->idx, addr);
128 dev_err(bus->dev, "init codec failed: %ld\n", PTR_ERR(codec));
129 return PTR_ERR(codec);
132 * Allow avs_core suspend by forcing suspended state on all
133 * of its codec child devices. Component interested in
134 * dealing with hda codecs directly takes pm responsibilities
136 pm_runtime_set_suspended(hda_codec_dev(codec));
138 /* configure effectively creates new ASoC component */
139 ret = snd_hda_codec_configure(codec);
141 dev_err(bus->dev, "failed to config codec %d\n", ret);
148 static void avs_hdac_bus_probe_codecs(struct hdac_bus *bus)
152 /* First try to probe all given codec slots */
153 for (c = 0; c < HDA_MAX_CODECS; c++) {
154 if (!(bus->codec_mask & BIT(c)))
157 if (!probe_codec(bus, c))
158 /* success, continue probing */
162 * Some BIOSen give you wrong codec addresses
165 dev_warn(bus->dev, "Codec #%d probe error; disabling it...\n", c);
166 bus->codec_mask &= ~BIT(c);
168 * More badly, accessing to a non-existing
169 * codec often screws up the controller bus,
170 * and disturbs the further communications.
171 * Thus if an error occurs during probing,
172 * better to reset the controller bus to get
173 * back to the sanity state.
175 snd_hdac_bus_stop_chip(bus);
176 avs_hdac_bus_init_chip(bus, true);
180 static void avs_hda_probe_work(struct work_struct *work)
182 struct avs_dev *adev = container_of(work, struct avs_dev, probe_work);
183 struct hdac_bus *bus = &adev->base.core;
184 struct hdac_ext_link *hlink;
187 pm_runtime_set_active(bus->dev); /* clear runtime_error flag */
189 ret = snd_hdac_i915_init(bus);
191 dev_info(bus->dev, "i915 init unsuccessful: %d\n", ret);
193 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, true);
194 avs_hdac_bus_init_chip(bus, true);
195 avs_hdac_bus_probe_codecs(bus);
196 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
198 /* with all codecs probed, links can be powered down */
199 list_for_each_entry(hlink, &bus->hlink_list, list)
200 snd_hdac_ext_bus_link_put(bus, hlink);
202 snd_hdac_ext_bus_ppcap_enable(bus, true);
203 snd_hdac_ext_bus_ppcap_int_enable(bus, true);
205 ret = avs_dsp_first_boot_firmware(adev);
209 adev->nhlt = intel_nhlt_init(adev->dev);
211 dev_info(bus->dev, "platform has no NHLT\n");
213 avs_register_all_boards(adev);
216 pm_runtime_set_autosuspend_delay(bus->dev, 2000);
217 pm_runtime_use_autosuspend(bus->dev);
218 pm_runtime_mark_last_busy(bus->dev);
219 pm_runtime_put_autosuspend(bus->dev);
220 pm_runtime_allow(bus->dev);
223 static void hdac_stream_update_pos(struct hdac_stream *stream, u64 buffer_size)
225 u64 prev_pos, pos, num_bytes;
227 div64_u64_rem(stream->curr_pos, buffer_size, &prev_pos);
228 pos = snd_hdac_stream_get_pos_posbuf(stream);
231 num_bytes = (buffer_size - prev_pos) + pos;
233 num_bytes = pos - prev_pos;
235 stream->curr_pos += num_bytes;
238 /* called from IRQ */
239 static void hdac_update_stream(struct hdac_bus *bus, struct hdac_stream *stream)
241 if (stream->substream) {
242 snd_pcm_period_elapsed(stream->substream);
243 } else if (stream->cstream) {
244 u64 buffer_size = stream->cstream->runtime->buffer_size;
246 hdac_stream_update_pos(stream, buffer_size);
247 snd_compr_fragment_elapsed(stream->cstream);
251 static irqreturn_t hdac_bus_irq_handler(int irq, void *context)
253 struct hdac_bus *bus = context;
254 u32 mask, int_enable;
258 if (!pm_runtime_active(bus->dev))
261 spin_lock(&bus->reg_lock);
263 status = snd_hdac_chip_readl(bus, INTSTS);
264 if (status == 0 || status == UINT_MAX) {
265 spin_unlock(&bus->reg_lock);
270 status = snd_hdac_chip_readb(bus, RIRBSTS);
271 if (status & RIRB_INT_MASK) {
272 if (status & RIRB_INT_RESPONSE)
273 snd_hdac_bus_update_rirb(bus);
274 snd_hdac_chip_writeb(bus, RIRBSTS, RIRB_INT_MASK);
277 mask = (0x1 << bus->num_streams) - 1;
279 status = snd_hdac_chip_readl(bus, INTSTS);
282 /* Disable stream interrupts; Re-enable in bottom half */
283 int_enable = snd_hdac_chip_readl(bus, INTCTL);
284 snd_hdac_chip_writel(bus, INTCTL, (int_enable & (~mask)));
285 ret = IRQ_WAKE_THREAD;
290 spin_unlock(&bus->reg_lock);
294 static irqreturn_t hdac_bus_irq_thread(int irq, void *context)
296 struct hdac_bus *bus = context;
302 status = snd_hdac_chip_readl(bus, INTSTS);
304 snd_hdac_bus_handle_stream_irq(bus, status, hdac_update_stream);
306 /* Re-enable stream interrupts */
307 mask = (0x1 << bus->num_streams) - 1;
308 spin_lock_irqsave(&bus->reg_lock, flags);
309 int_enable = snd_hdac_chip_readl(bus, INTCTL);
310 snd_hdac_chip_writel(bus, INTCTL, (int_enable | mask));
311 spin_unlock_irqrestore(&bus->reg_lock, flags);
316 static int avs_hdac_acquire_irq(struct avs_dev *adev)
318 struct hdac_bus *bus = &adev->base.core;
319 struct pci_dev *pci = to_pci_dev(bus->dev);
322 /* request one and check that we only got one interrupt */
323 ret = pci_alloc_irq_vectors(pci, 1, 1, PCI_IRQ_MSI | PCI_IRQ_LEGACY);
325 dev_err(adev->dev, "Failed to allocate IRQ vector: %d\n", ret);
329 ret = pci_request_irq(pci, 0, hdac_bus_irq_handler, hdac_bus_irq_thread, bus,
332 dev_err(adev->dev, "Failed to request stream IRQ handler: %d\n", ret);
336 ret = pci_request_irq(pci, 0, avs_dsp_irq_handler, avs_dsp_irq_thread, adev,
339 dev_err(adev->dev, "Failed to request IPC IRQ handler: %d\n", ret);
340 goto free_stream_irq;
346 pci_free_irq(pci, 0, bus);
348 pci_free_irq_vectors(pci);
352 static int avs_bus_init(struct avs_dev *adev, struct pci_dev *pci, const struct pci_device_id *id)
354 struct hda_bus *bus = &adev->base;
356 struct device *dev = &pci->dev;
359 ret = snd_hdac_ext_bus_init(&bus->core, dev, NULL, NULL);
363 bus->core.use_posbuf = 1;
364 bus->core.bdl_pos_adj = 0;
365 bus->core.sync_write = 1;
367 bus->mixer_assigned = -1;
368 mutex_init(&bus->prepare_mutex);
370 ipc = devm_kzalloc(dev, sizeof(*ipc), GFP_KERNEL);
373 ret = avs_ipc_init(ipc, dev);
378 adev->spec = (const struct avs_spec *)id->driver_data;
380 adev->hw_cfg.dsp_cores = hweight_long(AVS_MAIN_CORE_MASK);
381 INIT_WORK(&adev->probe_work, avs_hda_probe_work);
382 INIT_LIST_HEAD(&adev->comp_list);
383 INIT_LIST_HEAD(&adev->path_list);
384 INIT_LIST_HEAD(&adev->fw_list);
385 init_completion(&adev->fw_ready);
386 spin_lock_init(&adev->path_list_lock);
387 mutex_init(&adev->modres_mutex);
388 mutex_init(&adev->comp_list_mutex);
389 mutex_init(&adev->path_mutex);
394 static int avs_pci_probe(struct pci_dev *pci, const struct pci_device_id *id)
396 struct hdac_bus *bus;
397 struct avs_dev *adev;
398 struct device *dev = &pci->dev;
401 ret = snd_intel_dsp_driver_probe(pci);
402 if (ret != SND_INTEL_DSP_DRIVER_ANY && ret != SND_INTEL_DSP_DRIVER_AVS)
405 ret = pcim_enable_device(pci);
409 adev = devm_kzalloc(dev, sizeof(*adev), GFP_KERNEL);
412 ret = avs_bus_init(adev, pci, id);
414 dev_err(dev, "failed to init avs bus: %d\n", ret);
418 ret = pci_request_regions(pci, "AVS HDAudio");
422 bus = &adev->base.core;
423 bus->addr = pci_resource_start(pci, 0);
424 bus->remap_addr = pci_ioremap_bar(pci, 0);
425 if (!bus->remap_addr) {
426 dev_err(bus->dev, "ioremap error\n");
431 adev->dsp_ba = pci_ioremap_bar(pci, 4);
433 dev_err(bus->dev, "ioremap error\n");
438 snd_hdac_bus_parse_capabilities(bus);
440 snd_hdac_ext_bus_get_ml_capabilities(bus);
442 if (!dma_set_mask(dev, DMA_BIT_MASK(64))) {
443 dma_set_coherent_mask(dev, DMA_BIT_MASK(64));
445 dma_set_mask(dev, DMA_BIT_MASK(32));
446 dma_set_coherent_mask(dev, DMA_BIT_MASK(32));
449 ret = avs_hdac_bus_init_streams(bus);
451 dev_err(dev, "failed to init streams: %d\n", ret);
452 goto err_init_streams;
455 ret = avs_hdac_acquire_irq(adev);
457 dev_err(bus->dev, "failed to acquire irq: %d\n", ret);
458 goto err_acquire_irq;
462 pci_set_drvdata(pci, bus);
463 device_disable_async_suspend(dev);
465 schedule_work(&adev->probe_work);
470 snd_hdac_bus_free_stream_pages(bus);
471 snd_hdac_stream_free_all(bus);
473 iounmap(adev->dsp_ba);
475 iounmap(bus->remap_addr);
477 pci_release_regions(pci);
481 static void avs_pci_remove(struct pci_dev *pci)
483 struct hdac_device *hdev, *save;
484 struct hdac_bus *bus = pci_get_drvdata(pci);
485 struct avs_dev *adev = hdac_to_avs(bus);
487 cancel_work_sync(&adev->probe_work);
488 avs_ipc_block(adev->ipc);
490 avs_unregister_all_boards(adev);
493 intel_nhlt_free(adev->nhlt);
495 if (avs_platattr_test(adev, CLDMA))
496 hda_cldma_free(&code_loader);
498 snd_hdac_stop_streams_and_chip(bus);
499 avs_dsp_op(adev, int_control, false);
500 snd_hdac_ext_bus_ppcap_int_enable(bus, false);
502 /* it is safe to remove all codecs from the system now */
503 list_for_each_entry_safe(hdev, save, &bus->codec_list, list)
504 snd_hda_codec_unregister(hdac_to_hda_codec(hdev));
506 snd_hdac_bus_free_stream_pages(bus);
507 snd_hdac_stream_free_all(bus);
508 /* reverse ml_capabilities */
509 snd_hdac_link_free_all(bus);
510 snd_hdac_ext_bus_exit(bus);
512 avs_dsp_core_disable(adev, GENMASK(adev->hw_cfg.dsp_cores - 1, 0));
513 snd_hdac_ext_bus_ppcap_enable(bus, false);
515 /* snd_hdac_stop_streams_and_chip does that already? */
516 snd_hdac_bus_stop_chip(bus);
517 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
518 if (bus->audio_component)
519 snd_hdac_i915_exit(bus);
521 avs_module_info_free(adev);
522 pci_free_irq(pci, 0, adev);
523 pci_free_irq(pci, 0, bus);
524 pci_free_irq_vectors(pci);
525 iounmap(bus->remap_addr);
526 iounmap(adev->dsp_ba);
527 pci_release_regions(pci);
529 /* Firmware is not needed anymore */
530 avs_release_firmwares(adev);
532 /* pm_runtime_forbid() can rpm_resume() which we do not want */
533 pm_runtime_disable(&pci->dev);
534 pm_runtime_forbid(&pci->dev);
535 pm_runtime_enable(&pci->dev);
536 pm_runtime_get_noresume(&pci->dev);
539 static int __maybe_unused avs_suspend_common(struct avs_dev *adev)
541 struct hdac_bus *bus = &adev->base.core;
544 flush_work(&adev->probe_work);
546 snd_hdac_ext_bus_link_power_down_all(bus);
548 ret = avs_ipc_set_dx(adev, AVS_MAIN_CORE_MASK, false);
550 * pm_runtime is blocked on DSP failure but system-wide suspend is not.
551 * Do not block entire system from suspending if that's the case.
553 if (ret && ret != -EPERM) {
554 dev_err(adev->dev, "set dx failed: %d\n", ret);
555 return AVS_IPC_RET(ret);
558 avs_dsp_op(adev, int_control, false);
559 snd_hdac_ext_bus_ppcap_int_enable(bus, false);
561 ret = avs_dsp_core_disable(adev, AVS_MAIN_CORE_MASK);
563 dev_err(adev->dev, "core_mask %ld disable failed: %d\n", AVS_MAIN_CORE_MASK, ret);
567 snd_hdac_ext_bus_ppcap_enable(bus, false);
568 /* disable LP SRAM retention */
569 avs_hda_power_gating_enable(adev, false);
570 snd_hdac_bus_stop_chip(bus);
571 /* disable CG when putting controller to reset */
572 avs_hdac_clock_gating_enable(bus, false);
573 snd_hdac_bus_enter_link_reset(bus);
574 avs_hdac_clock_gating_enable(bus, true);
576 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
581 static int __maybe_unused avs_resume_common(struct avs_dev *adev, bool purge)
583 struct hdac_bus *bus = &adev->base.core;
584 struct hdac_ext_link *hlink;
587 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, true);
588 avs_hdac_bus_init_chip(bus, true);
590 snd_hdac_ext_bus_ppcap_enable(bus, true);
591 snd_hdac_ext_bus_ppcap_int_enable(bus, true);
593 ret = avs_dsp_boot_firmware(adev, purge);
595 dev_err(adev->dev, "firmware boot failed: %d\n", ret);
599 /* turn off the links that were off before suspend */
600 list_for_each_entry(hlink, &bus->hlink_list, list) {
601 if (!hlink->ref_count)
602 snd_hdac_ext_bus_link_power_down(hlink);
605 /* check dma status and clean up CORB/RIRB buffers */
606 if (!bus->cmd_dma_state)
607 snd_hdac_bus_stop_cmd_io(bus);
612 static int __maybe_unused avs_suspend(struct device *dev)
614 return avs_suspend_common(to_avs_dev(dev));
617 static int __maybe_unused avs_resume(struct device *dev)
619 return avs_resume_common(to_avs_dev(dev), true);
622 static int __maybe_unused avs_runtime_suspend(struct device *dev)
624 return avs_suspend_common(to_avs_dev(dev));
627 static int __maybe_unused avs_runtime_resume(struct device *dev)
629 return avs_resume_common(to_avs_dev(dev), true);
632 static const struct dev_pm_ops avs_dev_pm = {
633 SET_SYSTEM_SLEEP_PM_OPS(avs_suspend, avs_resume)
634 SET_RUNTIME_PM_OPS(avs_runtime_suspend, avs_runtime_resume, NULL)
637 static const struct avs_spec skl_desc = {
645 .dsp_ops = &skl_dsp_ops,
647 .attributes = AVS_PLATATTR_CLDMA,
648 .sram_base_offset = SKL_ADSP_SRAM_BASE_OFFSET,
649 .sram_window_size = SKL_ADSP_SRAM_WINDOW_SIZE,
650 .rom_status = SKL_ADSP_SRAM_BASE_OFFSET,
653 static const struct avs_spec apl_desc = {
661 .dsp_ops = &apl_dsp_ops,
663 .attributes = AVS_PLATATTR_IMR,
664 .sram_base_offset = APL_ADSP_SRAM_BASE_OFFSET,
665 .sram_window_size = APL_ADSP_SRAM_WINDOW_SIZE,
666 .rom_status = APL_ADSP_SRAM_BASE_OFFSET,
669 static const struct pci_device_id avs_ids[] = {
670 { PCI_VDEVICE(INTEL, 0x9d70), (unsigned long)&skl_desc }, /* SKL */
671 { PCI_VDEVICE(INTEL, 0x9d71), (unsigned long)&skl_desc }, /* KBL */
672 { PCI_VDEVICE(INTEL, 0x5a98), (unsigned long)&apl_desc }, /* APL */
673 { PCI_VDEVICE(INTEL, 0x3198), (unsigned long)&apl_desc }, /* GML */
676 MODULE_DEVICE_TABLE(pci, avs_ids);
678 static struct pci_driver avs_pci_driver = {
679 .name = KBUILD_MODNAME,
681 .probe = avs_pci_probe,
682 .remove = avs_pci_remove,
687 module_pci_driver(avs_pci_driver);
689 MODULE_AUTHOR("Cezary Rojewski <cezary.rojewski@intel.com>");
690 MODULE_AUTHOR("Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>");
691 MODULE_DESCRIPTION("Intel cAVS sound driver");
692 MODULE_LICENSE("GPL");