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 <sound/pcm.h>
32 * initialize the PCI registers
34 static void skl_update_pci_byte(struct pci_dev
*pci
, unsigned int reg
,
35 unsigned char mask
, unsigned char val
)
39 pci_read_config_byte(pci
, reg
, &data
);
42 pci_write_config_byte(pci
, reg
, data
);
45 static void skl_init_pci(struct skl
*skl
)
47 struct hdac_ext_bus
*ebus
= &skl
->ebus
;
50 * Clear bits 0-2 of PCI register TCSEL (at offset 0x44)
51 * TCSEL == Traffic Class Select Register, which sets PCI express QOS
52 * Ensuring these bits are 0 clears playback static on some HD Audio
54 * The PCI register TCSEL is defined in the Intel manuals.
56 dev_dbg(ebus_to_hbus(ebus
)->dev
, "Clearing TCSEL\n");
57 skl_update_pci_byte(skl
->pci
, AZX_PCIREG_TCSEL
, 0x07, 0);
61 static void skl_stream_update(struct hdac_bus
*bus
, struct hdac_stream
*hstr
)
63 snd_pcm_period_elapsed(hstr
->substream
);
66 static irqreturn_t
skl_interrupt(int irq
, void *dev_id
)
68 struct hdac_ext_bus
*ebus
= dev_id
;
69 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
72 if (!pm_runtime_active(bus
->dev
))
75 spin_lock(&bus
->reg_lock
);
77 status
= snd_hdac_chip_readl(bus
, INTSTS
);
78 if (status
== 0 || status
== 0xffffffff) {
79 spin_unlock(&bus
->reg_lock
);
84 status
= snd_hdac_chip_readb(bus
, RIRBSTS
);
85 if (status
& RIRB_INT_MASK
) {
86 if (status
& RIRB_INT_RESPONSE
)
87 snd_hdac_bus_update_rirb(bus
);
88 snd_hdac_chip_writeb(bus
, RIRBSTS
, RIRB_INT_MASK
);
91 spin_unlock(&bus
->reg_lock
);
93 return snd_hdac_chip_readl(bus
, INTSTS
) ? IRQ_WAKE_THREAD
: IRQ_HANDLED
;
96 static irqreturn_t
skl_threaded_handler(int irq
, void *dev_id
)
98 struct hdac_ext_bus
*ebus
= dev_id
;
99 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
102 status
= snd_hdac_chip_readl(bus
, INTSTS
);
104 snd_hdac_bus_handle_stream_irq(bus
, status
, skl_stream_update
);
109 static int skl_acquire_irq(struct hdac_ext_bus
*ebus
, int do_disconnect
)
111 struct skl
*skl
= ebus_to_skl(ebus
);
112 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
115 ret
= request_threaded_irq(skl
->pci
->irq
, skl_interrupt
,
116 skl_threaded_handler
,
118 KBUILD_MODNAME
, ebus
);
121 "unable to grab IRQ %d, disabling device\n",
126 bus
->irq
= skl
->pci
->irq
;
127 pci_intx(skl
->pci
, 1);
132 #ifdef CONFIG_PM_SLEEP
136 static int skl_suspend(struct device
*dev
)
138 struct pci_dev
*pci
= to_pci_dev(dev
);
139 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
140 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
142 snd_hdac_bus_stop_chip(bus
);
143 snd_hdac_bus_enter_link_reset(bus
);
148 static int skl_resume(struct device
*dev
)
150 struct pci_dev
*pci
= to_pci_dev(dev
);
151 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
152 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
153 struct skl
*hda
= ebus_to_skl(ebus
);
157 snd_hdac_bus_init_chip(bus
, 1);
161 #endif /* CONFIG_PM_SLEEP */
164 static int skl_runtime_suspend(struct device
*dev
)
166 struct pci_dev
*pci
= to_pci_dev(dev
);
167 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
168 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
169 struct skl
*skl
= ebus_to_skl(ebus
);
172 dev_dbg(bus
->dev
, "in %s\n", __func__
);
174 /* enable controller wake up event */
175 snd_hdac_chip_updatew(bus
, WAKEEN
, 0, STATESTS_INT_MASK
);
177 snd_hdac_ext_bus_link_power_down_all(ebus
);
179 ret
= skl_suspend_dsp(skl
);
183 snd_hdac_bus_stop_chip(bus
);
184 snd_hdac_bus_enter_link_reset(bus
);
189 static int skl_runtime_resume(struct device
*dev
)
191 struct pci_dev
*pci
= to_pci_dev(dev
);
192 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
193 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
194 struct skl
*skl
= ebus_to_skl(ebus
);
197 dev_dbg(bus
->dev
, "in %s\n", __func__
);
199 /* Read STATESTS before controller reset */
200 status
= snd_hdac_chip_readw(bus
, STATESTS
);
203 snd_hdac_bus_init_chip(bus
, true);
204 /* disable controller Wake Up event */
205 snd_hdac_chip_updatew(bus
, WAKEEN
, STATESTS_INT_MASK
, 0);
207 return skl_resume_dsp(skl
);
209 #endif /* CONFIG_PM */
211 static const struct dev_pm_ops skl_pm
= {
212 SET_SYSTEM_SLEEP_PM_OPS(skl_suspend
, skl_resume
)
213 SET_RUNTIME_PM_OPS(skl_runtime_suspend
, skl_runtime_resume
, NULL
)
219 static int skl_free(struct hdac_ext_bus
*ebus
)
221 struct skl
*skl
= ebus_to_skl(ebus
);
222 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
224 skl
->init_failed
= 1; /* to be sure */
226 snd_hdac_ext_stop_streams(ebus
);
229 free_irq(bus
->irq
, (void *)bus
);
231 iounmap(bus
->remap_addr
);
233 snd_hdac_bus_free_stream_pages(bus
);
234 snd_hdac_stream_free_all(ebus
);
235 snd_hdac_link_free_all(ebus
);
236 pci_release_regions(skl
->pci
);
237 pci_disable_device(skl
->pci
);
239 snd_hdac_ext_bus_exit(ebus
);
244 static int skl_dmic_device_register(struct skl
*skl
)
246 struct hdac_bus
*bus
= ebus_to_hbus(&skl
->ebus
);
247 struct platform_device
*pdev
;
250 /* SKL has one dmic port, so allocate dmic device for this */
251 pdev
= platform_device_alloc("dmic-codec", -1);
253 dev_err(bus
->dev
, "failed to allocate dmic device\n");
257 ret
= platform_device_add(pdev
);
259 dev_err(bus
->dev
, "failed to add dmic device: %d\n", ret
);
260 platform_device_put(pdev
);
263 skl
->dmic_dev
= pdev
;
268 static void skl_dmic_device_unregister(struct skl
*skl
)
271 platform_device_unregister(skl
->dmic_dev
);
275 * Probe the given codec address
277 static int probe_codec(struct hdac_ext_bus
*ebus
, int addr
)
279 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
280 unsigned int cmd
= (addr
<< 28) | (AC_NODE_ROOT
<< 20) |
281 (AC_VERB_PARAMETERS
<< 8) | AC_PAR_VENDOR_ID
;
284 mutex_lock(&bus
->cmd_mutex
);
285 snd_hdac_bus_send_cmd(bus
, cmd
);
286 snd_hdac_bus_get_response(bus
, addr
, &res
);
287 mutex_unlock(&bus
->cmd_mutex
);
290 dev_dbg(bus
->dev
, "codec #%d probed OK\n", addr
);
292 return snd_hdac_ext_bus_device_init(ebus
, addr
);
295 /* Codec initialization */
296 static int skl_codec_create(struct hdac_ext_bus
*ebus
)
298 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
301 max_slots
= HDA_MAX_CODECS
;
303 /* First try to probe all given codec slots */
304 for (c
= 0; c
< max_slots
; c
++) {
305 if ((bus
->codec_mask
& (1 << c
))) {
306 if (probe_codec(ebus
, c
) < 0) {
308 * Some BIOSen give you wrong codec addresses
312 "Codec #%d probe error; disabling it...\n", c
);
313 bus
->codec_mask
&= ~(1 << c
);
315 * More badly, accessing to a non-existing
316 * codec often screws up the controller bus,
317 * and disturbs the further communications.
318 * Thus if an error occurs during probing,
319 * better to reset the controller bus to get
320 * back to the sanity state.
322 snd_hdac_bus_stop_chip(bus
);
323 snd_hdac_bus_init_chip(bus
, true);
331 static const struct hdac_bus_ops bus_core_ops
= {
332 .command
= snd_hdac_bus_send_cmd
,
333 .get_response
= snd_hdac_bus_get_response
,
339 static int skl_create(struct pci_dev
*pci
,
340 const struct hdac_io_ops
*io_ops
,
344 struct hdac_ext_bus
*ebus
;
350 err
= pci_enable_device(pci
);
354 skl
= devm_kzalloc(&pci
->dev
, sizeof(*skl
), GFP_KERNEL
);
356 pci_disable_device(pci
);
360 snd_hdac_ext_bus_init(ebus
, &pci
->dev
, &bus_core_ops
, io_ops
);
361 ebus
->bus
.use_posbuf
= 1;
364 ebus
->bus
.bdl_pos_adj
= 0;
371 static int skl_first_init(struct hdac_ext_bus
*ebus
)
373 struct skl
*skl
= ebus_to_skl(ebus
);
374 struct hdac_bus
*bus
= ebus_to_hbus(ebus
);
375 struct pci_dev
*pci
= skl
->pci
;
378 int cp_streams
, pb_streams
, start_idx
;
380 err
= pci_request_regions(pci
, "Skylake HD audio");
384 bus
->addr
= pci_resource_start(pci
, 0);
385 bus
->remap_addr
= pci_ioremap_bar(pci
, 0);
386 if (bus
->remap_addr
== NULL
) {
387 dev_err(bus
->dev
, "ioremap error\n");
391 snd_hdac_ext_bus_parse_capabilities(ebus
);
393 if (skl_acquire_irq(ebus
, 0) < 0)
397 synchronize_irq(bus
->irq
);
399 gcap
= snd_hdac_chip_readw(bus
, GCAP
);
400 dev_dbg(bus
->dev
, "chipset global capabilities = 0x%x\n", gcap
);
402 /* allow 64bit DMA address if supported by H/W */
403 if (!dma_set_mask(bus
->dev
, DMA_BIT_MASK(64))) {
404 dma_set_coherent_mask(bus
->dev
, DMA_BIT_MASK(64));
406 dma_set_mask(bus
->dev
, DMA_BIT_MASK(32));
407 dma_set_coherent_mask(bus
->dev
, DMA_BIT_MASK(32));
410 /* read number of streams from GCAP register */
411 cp_streams
= (gcap
>> 8) & 0x0f;
412 pb_streams
= (gcap
>> 12) & 0x0f;
414 if (!pb_streams
&& !cp_streams
)
417 ebus
->num_streams
= cp_streams
+ pb_streams
;
419 /* initialize streams */
420 snd_hdac_ext_stream_init_all
421 (ebus
, 0, cp_streams
, SNDRV_PCM_STREAM_CAPTURE
);
422 start_idx
= cp_streams
;
423 snd_hdac_ext_stream_init_all
424 (ebus
, start_idx
, pb_streams
, SNDRV_PCM_STREAM_PLAYBACK
);
426 err
= snd_hdac_bus_alloc_stream_pages(bus
);
430 /* initialize chip */
433 snd_hdac_bus_init_chip(bus
, true);
435 /* codec detection */
436 if (!bus
->codec_mask
) {
437 dev_err(bus
->dev
, "no codecs found!\n");
444 static int skl_probe(struct pci_dev
*pci
,
445 const struct pci_device_id
*pci_id
)
448 struct hdac_ext_bus
*ebus
= NULL
;
449 struct hdac_bus
*bus
= NULL
;
452 /* we use ext core ops, so provide NULL for ops here */
453 err
= skl_create(pci
, NULL
, &skl
);
458 bus
= ebus_to_hbus(ebus
);
460 err
= skl_first_init(ebus
);
464 skl
->nhlt
= skl_nhlt_init(bus
->dev
);
466 if (skl
->nhlt
== NULL
)
469 pci_set_drvdata(skl
->pci
, ebus
);
471 /* check if dsp is there */
473 err
= skl_init_dsp(skl
);
475 dev_dbg(bus
->dev
, "error failed to register dsp\n");
480 snd_hdac_ext_bus_get_ml_capabilities(ebus
);
482 /* create device for soc dmic */
483 err
= skl_dmic_device_register(skl
);
487 /* register platform dai and controls */
488 err
= skl_platform_register(bus
->dev
);
492 /* create codec instances */
493 err
= skl_codec_create(ebus
);
498 pm_runtime_set_autosuspend_delay(bus
->dev
, SKL_SUSPEND_DELAY
);
499 pm_runtime_use_autosuspend(bus
->dev
);
500 pm_runtime_put_noidle(bus
->dev
);
501 pm_runtime_allow(bus
->dev
);
506 skl_platform_unregister(bus
->dev
);
508 skl_dmic_device_unregister(skl
);
512 skl
->init_failed
= 1;
518 static void skl_remove(struct pci_dev
*pci
)
520 struct hdac_ext_bus
*ebus
= pci_get_drvdata(pci
);
521 struct skl
*skl
= ebus_to_skl(ebus
);
523 if (pci_dev_run_wake(pci
))
524 pm_runtime_get_noresume(&pci
->dev
);
526 skl_platform_unregister(&pci
->dev
);
528 skl_dmic_device_unregister(skl
);
530 dev_set_drvdata(&pci
->dev
, NULL
);
534 static const struct pci_device_id skl_ids
[] = {
535 /* Sunrise Point-LP */
536 { PCI_DEVICE(0x8086, 0x9d70), 0},
539 MODULE_DEVICE_TABLE(pci
, skl_ids
);
541 /* pci_driver definition */
542 static struct pci_driver skl_driver
= {
543 .name
= KBUILD_MODNAME
,
546 .remove
= skl_remove
,
551 module_pci_driver(skl_driver
);
553 MODULE_LICENSE("GPL v2");
554 MODULE_DESCRIPTION("Intel Skylake ASoC HDA driver");