2 * skl.c - Implementation of ASoC Intel SKL HD Audio driver
4 * Copyright (C) 2014-2015 Intel Corp
5 * Author: Jeeja KP <jeeja.kp@intel.com>
7 * Derived mostly from Intel HDA driver with following copyrights:
8 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
9 * PeiSen Hou <pshou@realtek.com.tw>
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; version 2 of the License.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 #include <linux/module.h>
25 #include <linux/pci.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/platform_device.h>
28 #include <linux/firmware.h>
29 #include <sound/pcm.h>
30 #include "../common/sst-acpi.h"
31 #include <sound/hda_register.h>
32 #include <sound/hdaudio.h>
33 #include <sound/hda_i915.h>
35 #include "skl-sst-dsp.h"
36 #include "skl-sst-ipc.h"
39 * initialize the PCI registers
41 static void skl_update_pci_byte(struct pci_dev
*pci
, unsigned int reg
,
42 unsigned char mask
, unsigned char val
)
46 pci_read_config_byte(pci
, reg
, &data
);
49 pci_write_config_byte(pci
, reg
, data
);
52 static void skl_init_pci(struct skl
*skl
)
54 struct hdac_ext_bus
*ebus
= &skl
->ebus
;
57 * Clear bits 0-2 of PCI register TCSEL (at offset 0x44)
58 * TCSEL == Traffic Class Select Register, which sets PCI express QOS
59 * Ensuring these bits are 0 clears playback static on some HD Audio
61 * The PCI register TCSEL is defined in the Intel manuals.
63 dev_dbg(ebus_to_hbus(ebus
)->dev
, "Clearing TCSEL\n");
64 skl_update_pci_byte(skl
->pci
, AZX_PCIREG_TCSEL
, 0x07, 0);
67 static void update_pci_dword(struct pci_dev
*pci
,
68 unsigned int reg
, u32 mask
, u32 val
)
72 pci_read_config_dword(pci
, reg
, &data
);
75 pci_write_config_dword(pci
, reg
, data
);
79 * skl_enable_miscbdcge - enable/dsiable CGCTL.MISCBDCGE bits
81 * @dev: device pointer
82 * @enable: enable/disable flag
84 static void skl_enable_miscbdcge(struct device
*dev
, bool enable
)
86 struct pci_dev
*pci
= to_pci_dev(dev
);
89 val
= enable
? AZX_CGCTL_MISCBDCGE_MASK
: 0;
91 update_pci_dword(pci
, AZX_PCIREG_CGCTL
, AZX_CGCTL_MISCBDCGE_MASK
, val
);
95 * While performing reset, controller may not come back properly causing
96 * issues, so recommendation is to set CGCTL.MISCBDCGE to 0 then do reset
97 * (init chip) and then again set CGCTL.MISCBDCGE to 1
99 static int skl_init_chip(struct hdac_bus
*bus
, bool full_reset
)
103 skl_enable_miscbdcge(bus
->dev
, false);
104 ret
= snd_hdac_bus_init_chip(bus
, full_reset
);
105 skl_enable_miscbdcge(bus
->dev
, true);
110 /* called from IRQ */
111 static void skl_stream_update(struct hdac_bus
*bus
, struct hdac_stream
*hstr
)
113 snd_pcm_period_elapsed(hstr
->substream
);
116 static irqreturn_t
skl_interrupt(int irq
, void *dev_id
)
118 struct hdac_ext_bus
*ebus
= dev_id
;
119 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
122 if (!pm_runtime_active(bus
->dev
))
125 spin_lock(&bus
->reg_lock
);
127 status
= snd_hdac_chip_readl(bus
, INTSTS
);
128 if (status
== 0 || status
== 0xffffffff) {
129 spin_unlock(&bus
->reg_lock
);
134 status
= snd_hdac_chip_readb(bus
, RIRBSTS
);
135 if (status
& RIRB_INT_MASK
) {
136 if (status
& RIRB_INT_RESPONSE
)
137 snd_hdac_bus_update_rirb(bus
);
138 snd_hdac_chip_writeb(bus
, RIRBSTS
, RIRB_INT_MASK
);
141 spin_unlock(&bus
->reg_lock
);
143 return snd_hdac_chip_readl(bus
, INTSTS
) ? IRQ_WAKE_THREAD
: IRQ_HANDLED
;
146 static irqreturn_t
skl_threaded_handler(int irq
, void *dev_id
)
148 struct hdac_ext_bus
*ebus
= dev_id
;
149 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
152 status
= snd_hdac_chip_readl(bus
, INTSTS
);
154 snd_hdac_bus_handle_stream_irq(bus
, status
, skl_stream_update
);
159 static int skl_acquire_irq(struct hdac_ext_bus
*ebus
, int do_disconnect
)
161 struct skl
*skl
= ebus_to_skl(ebus
);
162 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
165 ret
= request_threaded_irq(skl
->pci
->irq
, skl_interrupt
,
166 skl_threaded_handler
,
168 KBUILD_MODNAME
, ebus
);
171 "unable to grab IRQ %d, disabling device\n",
176 bus
->irq
= skl
->pci
->irq
;
177 pci_intx(skl
->pci
, 1);
183 static int _skl_suspend(struct hdac_ext_bus
*ebus
)
185 struct skl
*skl
= ebus_to_skl(ebus
);
186 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
189 snd_hdac_ext_bus_link_power_down_all(ebus
);
191 ret
= skl_suspend_dsp(skl
);
195 snd_hdac_bus_stop_chip(bus
);
196 skl_enable_miscbdcge(bus
->dev
, false);
197 snd_hdac_bus_enter_link_reset(bus
);
198 skl_enable_miscbdcge(bus
->dev
, true);
203 static int _skl_resume(struct hdac_ext_bus
*ebus
)
205 struct skl
*skl
= ebus_to_skl(ebus
);
206 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
209 skl_init_chip(bus
, true);
211 return skl_resume_dsp(skl
);
215 #ifdef CONFIG_PM_SLEEP
219 static int skl_suspend(struct device
*dev
)
221 struct pci_dev
*pci
= to_pci_dev(dev
);
222 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
223 struct skl
*skl
= ebus_to_skl(ebus
);
224 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
228 * Do not suspend if streams which are marked ignore suspend are
229 * running, we need to save the state for these and continue
231 if (skl
->supend_active
) {
232 /* turn off the links and stop the CORB/RIRB DMA if it is On */
233 snd_hdac_ext_bus_link_power_down_all(ebus
);
235 if (ebus
->cmd_dma_state
)
236 snd_hdac_bus_stop_cmd_io(&ebus
->bus
);
238 enable_irq_wake(bus
->irq
);
240 pci_disable_device(pci
);
242 ret
= _skl_suspend(ebus
);
247 if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI
)) {
248 ret
= snd_hdac_display_power(bus
, false);
251 "Cannot turn OFF display power on i915\n");
257 static int skl_resume(struct device
*dev
)
259 struct pci_dev
*pci
= to_pci_dev(dev
);
260 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
261 struct skl
*skl
= ebus_to_skl(ebus
);
262 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
263 struct hdac_ext_link
*hlink
= NULL
;
266 /* Turned OFF in HDMI codec driver after codec reconfiguration */
267 if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI
)) {
268 ret
= snd_hdac_display_power(bus
, true);
271 "Cannot turn on display power on i915\n");
277 * resume only when we are not in suspend active, otherwise need to
280 if (skl
->supend_active
) {
281 pci_restore_state(pci
);
282 ret
= pci_enable_device(pci
);
283 snd_hdac_ext_bus_link_power_up_all(ebus
);
284 disable_irq_wake(bus
->irq
);
286 * turn On the links which are On before active suspend
287 * and start the CORB/RIRB DMA if On before
290 list_for_each_entry(hlink
, &ebus
->hlink_list
, list
) {
291 if (hlink
->ref_count
)
292 snd_hdac_ext_bus_link_power_up(hlink
);
295 if (ebus
->cmd_dma_state
)
296 snd_hdac_bus_init_cmd_io(&ebus
->bus
);
298 ret
= _skl_resume(ebus
);
300 /* turn off the links which are off before suspend */
301 list_for_each_entry(hlink
, &ebus
->hlink_list
, list
) {
302 if (!hlink
->ref_count
)
303 snd_hdac_ext_bus_link_power_down(hlink
);
306 if (!ebus
->cmd_dma_state
)
307 snd_hdac_bus_stop_cmd_io(&ebus
->bus
);
312 #endif /* CONFIG_PM_SLEEP */
315 static int skl_runtime_suspend(struct device
*dev
)
317 struct pci_dev
*pci
= to_pci_dev(dev
);
318 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
319 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
321 dev_dbg(bus
->dev
, "in %s\n", __func__
);
323 return _skl_suspend(ebus
);
326 static int skl_runtime_resume(struct device
*dev
)
328 struct pci_dev
*pci
= to_pci_dev(dev
);
329 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
330 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
332 dev_dbg(bus
->dev
, "in %s\n", __func__
);
334 return _skl_resume(ebus
);
336 #endif /* CONFIG_PM */
338 static const struct dev_pm_ops skl_pm
= {
339 SET_SYSTEM_SLEEP_PM_OPS(skl_suspend
, skl_resume
)
340 SET_RUNTIME_PM_OPS(skl_runtime_suspend
, skl_runtime_resume
, NULL
)
346 static int skl_free(struct hdac_ext_bus
*ebus
)
348 struct skl
*skl
= ebus_to_skl(ebus
);
349 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
351 skl
->init_failed
= 1; /* to be sure */
353 snd_hdac_ext_stop_streams(ebus
);
356 free_irq(bus
->irq
, (void *)bus
);
357 snd_hdac_bus_free_stream_pages(bus
);
358 snd_hdac_stream_free_all(ebus
);
359 snd_hdac_link_free_all(ebus
);
362 iounmap(bus
->remap_addr
);
364 pci_release_regions(skl
->pci
);
365 pci_disable_device(skl
->pci
);
367 snd_hdac_ext_bus_exit(ebus
);
369 if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI
))
370 snd_hdac_i915_exit(&ebus
->bus
);
374 static int skl_machine_device_register(struct skl
*skl
, void *driver_data
)
376 struct hdac_bus
*bus
= ebus_to_hbus(&skl
->ebus
);
377 struct platform_device
*pdev
;
378 struct sst_acpi_mach
*mach
= driver_data
;
381 mach
= sst_acpi_find_machine(mach
);
383 dev_err(bus
->dev
, "No matching machine driver found\n");
386 skl
->fw_name
= mach
->fw_filename
;
388 pdev
= platform_device_alloc(mach
->drv_name
, -1);
390 dev_err(bus
->dev
, "platform device alloc failed\n");
394 ret
= platform_device_add(pdev
);
396 dev_err(bus
->dev
, "failed to add machine device\n");
397 platform_device_put(pdev
);
405 static void skl_machine_device_unregister(struct skl
*skl
)
408 platform_device_unregister(skl
->i2s_dev
);
411 static int skl_dmic_device_register(struct skl
*skl
)
413 struct hdac_bus
*bus
= ebus_to_hbus(&skl
->ebus
);
414 struct platform_device
*pdev
;
417 /* SKL has one dmic port, so allocate dmic device for this */
418 pdev
= platform_device_alloc("dmic-codec", -1);
420 dev_err(bus
->dev
, "failed to allocate dmic device\n");
424 ret
= platform_device_add(pdev
);
426 dev_err(bus
->dev
, "failed to add dmic device: %d\n", ret
);
427 platform_device_put(pdev
);
430 skl
->dmic_dev
= pdev
;
435 static void skl_dmic_device_unregister(struct skl
*skl
)
438 platform_device_unregister(skl
->dmic_dev
);
442 * Probe the given codec address
444 static int probe_codec(struct hdac_ext_bus
*ebus
, int addr
)
446 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
447 unsigned int cmd
= (addr
<< 28) | (AC_NODE_ROOT
<< 20) |
448 (AC_VERB_PARAMETERS
<< 8) | AC_PAR_VENDOR_ID
;
451 mutex_lock(&bus
->cmd_mutex
);
452 snd_hdac_bus_send_cmd(bus
, cmd
);
453 snd_hdac_bus_get_response(bus
, addr
, &res
);
454 mutex_unlock(&bus
->cmd_mutex
);
457 dev_dbg(bus
->dev
, "codec #%d probed OK\n", addr
);
459 return snd_hdac_ext_bus_device_init(ebus
, addr
);
462 /* Codec initialization */
463 static int skl_codec_create(struct hdac_ext_bus
*ebus
)
465 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
468 max_slots
= HDA_MAX_CODECS
;
470 /* First try to probe all given codec slots */
471 for (c
= 0; c
< max_slots
; c
++) {
472 if ((bus
->codec_mask
& (1 << c
))) {
473 if (probe_codec(ebus
, c
) < 0) {
475 * Some BIOSen give you wrong codec addresses
479 "Codec #%d probe error; disabling it...\n", c
);
480 bus
->codec_mask
&= ~(1 << c
);
482 * More badly, accessing to a non-existing
483 * codec often screws up the controller bus,
484 * and disturbs the further communications.
485 * Thus if an error occurs during probing,
486 * better to reset the controller bus to get
487 * back to the sanity state.
489 snd_hdac_bus_stop_chip(bus
);
490 skl_init_chip(bus
, true);
498 static const struct hdac_bus_ops bus_core_ops
= {
499 .command
= snd_hdac_bus_send_cmd
,
500 .get_response
= snd_hdac_bus_get_response
,
506 static int skl_create(struct pci_dev
*pci
,
507 const struct hdac_io_ops
*io_ops
,
511 struct hdac_ext_bus
*ebus
;
517 err
= pci_enable_device(pci
);
521 skl
= devm_kzalloc(&pci
->dev
, sizeof(*skl
), GFP_KERNEL
);
523 pci_disable_device(pci
);
527 snd_hdac_ext_bus_init(ebus
, &pci
->dev
, &bus_core_ops
, io_ops
);
528 ebus
->bus
.use_posbuf
= 1;
531 ebus
->bus
.bdl_pos_adj
= 0;
538 static int skl_i915_init(struct hdac_bus
*bus
)
543 * The HDMI codec is in GPU so we need to ensure that it is powered
544 * up and ready for probe
546 err
= snd_hdac_i915_init(bus
);
550 err
= snd_hdac_display_power(bus
, true);
552 dev_err(bus
->dev
, "Cannot turn on display power on i915\n");
559 static int skl_first_init(struct hdac_ext_bus
*ebus
)
561 struct skl
*skl
= ebus_to_skl(ebus
);
562 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
563 struct pci_dev
*pci
= skl
->pci
;
566 int cp_streams
, pb_streams
, start_idx
;
568 err
= pci_request_regions(pci
, "Skylake HD audio");
572 bus
->addr
= pci_resource_start(pci
, 0);
573 bus
->remap_addr
= pci_ioremap_bar(pci
, 0);
574 if (bus
->remap_addr
== NULL
) {
575 dev_err(bus
->dev
, "ioremap error\n");
579 snd_hdac_ext_bus_parse_capabilities(ebus
);
581 if (skl_acquire_irq(ebus
, 0) < 0)
585 synchronize_irq(bus
->irq
);
587 gcap
= snd_hdac_chip_readw(bus
, GCAP
);
588 dev_dbg(bus
->dev
, "chipset global capabilities = 0x%x\n", gcap
);
590 /* allow 64bit DMA address if supported by H/W */
591 if (!dma_set_mask(bus
->dev
, DMA_BIT_MASK(64))) {
592 dma_set_coherent_mask(bus
->dev
, DMA_BIT_MASK(64));
594 dma_set_mask(bus
->dev
, DMA_BIT_MASK(32));
595 dma_set_coherent_mask(bus
->dev
, DMA_BIT_MASK(32));
598 /* read number of streams from GCAP register */
599 cp_streams
= (gcap
>> 8) & 0x0f;
600 pb_streams
= (gcap
>> 12) & 0x0f;
602 if (!pb_streams
&& !cp_streams
)
605 ebus
->num_streams
= cp_streams
+ pb_streams
;
607 /* initialize streams */
608 snd_hdac_ext_stream_init_all
609 (ebus
, 0, cp_streams
, SNDRV_PCM_STREAM_CAPTURE
);
610 start_idx
= cp_streams
;
611 snd_hdac_ext_stream_init_all
612 (ebus
, start_idx
, pb_streams
, SNDRV_PCM_STREAM_PLAYBACK
);
614 err
= snd_hdac_bus_alloc_stream_pages(bus
);
618 /* initialize chip */
621 if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI
)) {
622 err
= skl_i915_init(bus
);
627 skl_init_chip(bus
, true);
629 /* codec detection */
630 if (!bus
->codec_mask
) {
631 dev_info(bus
->dev
, "no hda codecs found!\n");
637 static int skl_probe(struct pci_dev
*pci
,
638 const struct pci_device_id
*pci_id
)
641 struct hdac_ext_bus
*ebus
= NULL
;
642 struct hdac_bus
*bus
= NULL
;
643 struct hdac_ext_link
*hlink
= NULL
;
646 /* we use ext core ops, so provide NULL for ops here */
647 err
= skl_create(pci
, NULL
, &skl
);
652 bus
= ebus_to_hbus(ebus
);
654 err
= skl_first_init(ebus
);
658 skl
->pci_id
= pci
->device
;
660 skl
->nhlt
= skl_nhlt_init(bus
->dev
);
662 if (skl
->nhlt
== NULL
)
665 skl_nhlt_update_topology_bin(skl
);
667 pci_set_drvdata(skl
->pci
, ebus
);
669 /* check if dsp is there */
671 err
= skl_machine_device_register(skl
,
672 (void *)pci_id
->driver_data
);
676 err
= skl_init_dsp(skl
);
678 dev_dbg(bus
->dev
, "error failed to register dsp\n");
681 skl
->skl_sst
->enable_miscbdcge
= skl_enable_miscbdcge
;
685 snd_hdac_ext_bus_get_ml_capabilities(ebus
);
687 /* create device for soc dmic */
688 err
= skl_dmic_device_register(skl
);
692 /* register platform dai and controls */
693 err
= skl_platform_register(bus
->dev
);
697 /* create codec instances */
698 err
= skl_codec_create(ebus
);
702 if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI
)) {
703 err
= snd_hdac_display_power(bus
, false);
705 dev_err(bus
->dev
, "Cannot turn off display power on i915\n");
711 * we are done probling so decrement link counts
713 list_for_each_entry(hlink
, &ebus
->hlink_list
, list
)
714 snd_hdac_ext_bus_link_put(ebus
, hlink
);
717 pm_runtime_put_noidle(bus
->dev
);
718 pm_runtime_allow(bus
->dev
);
723 skl_platform_unregister(bus
->dev
);
725 skl_dmic_device_unregister(skl
);
729 skl_machine_device_unregister(skl
);
731 skl_nhlt_free(skl
->nhlt
);
733 skl
->init_failed
= 1;
739 static void skl_shutdown(struct pci_dev
*pci
)
741 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
742 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
743 struct hdac_stream
*s
;
744 struct hdac_ext_stream
*stream
;
750 skl
= ebus_to_skl(ebus
);
752 if (skl
->init_failed
)
755 snd_hdac_ext_stop_streams(ebus
);
756 list_for_each_entry(s
, &bus
->stream_list
, list
) {
757 stream
= stream_to_hdac_ext_stream(s
);
758 snd_hdac_ext_stream_decouple(ebus
, stream
, false);
761 snd_hdac_bus_stop_chip(bus
);
764 static void skl_remove(struct pci_dev
*pci
)
766 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
767 struct skl
*skl
= ebus_to_skl(ebus
);
770 release_firmware(skl
->tplg
);
772 if (pci_dev_run_wake(pci
))
773 pm_runtime_get_noresume(&pci
->dev
);
775 /* codec removal, invoke bus_device_remove */
776 snd_hdac_ext_bus_device_remove(ebus
);
778 skl_platform_unregister(&pci
->dev
);
780 skl_machine_device_unregister(skl
);
781 skl_dmic_device_unregister(skl
);
782 skl_nhlt_free(skl
->nhlt
);
784 dev_set_drvdata(&pci
->dev
, NULL
);
787 static struct sst_acpi_mach sst_skl_devdata
[] = {
788 { "INT343A", "skl_alc286s_i2s", "intel/dsp_fw_release.bin", NULL
, NULL
, NULL
},
789 { "INT343B", "skl_nau88l25_ssm4567_i2s", "intel/dsp_fw_release.bin",
791 { "MX98357A", "skl_nau88l25_max98357a_i2s", "intel/dsp_fw_release.bin",
796 static struct sst_acpi_mach sst_bxtp_devdata
[] = {
797 { "INT343A", "bxt_alc298s_i2s", "intel/dsp_fw_bxtn.bin", NULL
, NULL
, NULL
},
801 static const struct pci_device_id skl_ids
[] = {
802 /* Sunrise Point-LP */
803 { PCI_DEVICE(0x8086, 0x9d70),
804 .driver_data
= (unsigned long)&sst_skl_devdata
},
806 { PCI_DEVICE(0x8086, 0x5a98),
807 .driver_data
= (unsigned long)&sst_bxtp_devdata
},
810 MODULE_DEVICE_TABLE(pci
, skl_ids
);
812 /* pci_driver definition */
813 static struct pci_driver skl_driver
= {
814 .name
= KBUILD_MODNAME
,
817 .remove
= skl_remove
,
818 .shutdown
= skl_shutdown
,
823 module_pci_driver(skl_driver
);
825 MODULE_LICENSE("GPL v2");
826 MODULE_DESCRIPTION("Intel Skylake ASoC HDA driver");