sound/soc/intel/skylake/skl.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  skl.c - Implementation of ASoC Intel SKL HD Audio driver
   4  *
   5  *  Copyright (C) 2014-2015 Intel Corp
   6  *  Author: Jeeja KP <jeeja.kp@intel.com>
   7  *
   8  *  Derived mostly from Intel HDA driver with following copyrights:
   9  *  Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
  10  *                     PeiSen Hou <pshou@realtek.com.tw>
  11  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12  *
  13  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/pci.h>
  18 #include <linux/pm_runtime.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/firmware.h>
  21 #include <linux/delay.h>
  22 #include <sound/pcm.h>
  23 #include <sound/soc-acpi.h>
  24 #include <sound/soc-acpi-intel-match.h>
  25 #include <sound/hda_register.h>
  26 #include <sound/hdaudio.h>
  27 #include <sound/hda_i915.h>
  28 #include <sound/hda_codec.h>
  29 #include "skl.h"
  30 #include "skl-sst-dsp.h"
  31 #include "skl-sst-ipc.h"
  32 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC)
  33 #include "../../../soc/codecs/hdac_hda.h"
  34 #endif
  35 static int skl_pci_binding;
  36 module_param_named(pci_binding, skl_pci_binding, int, 0444);
  37 MODULE_PARM_DESC(pci_binding, "PCI binding (0=auto, 1=only legacy, 2=only asoc");
  38
  39 /*
  40  * initialize the PCI registers
  41  */
  42 static void skl_update_pci_byte(struct pci_dev *pci, unsigned int reg,
  43                             unsigned char mask, unsigned char val)
  44 {
  45         unsigned char data;
  46
  47         pci_read_config_byte(pci, reg, &data);
  48         data &= ~mask;
  49         data |= (val & mask);
  50         pci_write_config_byte(pci, reg, data);
  51 }
  52
  53 static void skl_init_pci(struct skl *skl)
  54 {
  55         struct hdac_bus *bus = skl_to_bus(skl);
  56
  57         /*
  58          * Clear bits 0-2 of PCI register TCSEL (at offset 0x44)
  59          * TCSEL == Traffic Class Select Register, which sets PCI express QOS
  60          * Ensuring these bits are 0 clears playback static on some HD Audio
  61          * codecs.
  62          * The PCI register TCSEL is defined in the Intel manuals.
  63          */
  64         dev_dbg(bus->dev, "Clearing TCSEL\n");
  65         skl_update_pci_byte(skl->pci, AZX_PCIREG_TCSEL, 0x07, 0);
  66 }
  67
  68 static void update_pci_dword(struct pci_dev *pci,
  69                         unsigned int reg, u32 mask, u32 val)
  70 {
  71         u32 data = 0;
  72
  73         pci_read_config_dword(pci, reg, &data);
  74         data &= ~mask;
  75         data |= (val & mask);
  76         pci_write_config_dword(pci, reg, data);
  77 }
  78
  79 /*
  80  * skl_enable_miscbdcge - enable/dsiable CGCTL.MISCBDCGE bits
  81  *
  82  * @dev: device pointer
  83  * @enable: enable/disable flag
  84  */
  85 static void skl_enable_miscbdcge(struct device *dev, bool enable)
  86 {
  87         struct pci_dev *pci = to_pci_dev(dev);
  88         u32 val;
  89
  90         val = enable ? AZX_CGCTL_MISCBDCGE_MASK : 0;
  91
  92         update_pci_dword(pci, AZX_PCIREG_CGCTL, AZX_CGCTL_MISCBDCGE_MASK, val);
  93 }
  94
  95 /**
  96  * skl_clock_power_gating: Enable/Disable clock and power gating
  97  *
  98  * @dev: Device pointer
  99  * @enable: Enable/Disable flag
 100  */
 101 static void skl_clock_power_gating(struct device *dev, bool enable)
 102 {
 103         struct pci_dev *pci = to_pci_dev(dev);
 104         struct hdac_bus *bus = pci_get_drvdata(pci);
 105         u32 val;
 106
 107         /* Update PDCGE bit of CGCTL register */
 108         val = enable ? AZX_CGCTL_ADSPDCGE : 0;
 109         update_pci_dword(pci, AZX_PCIREG_CGCTL, AZX_CGCTL_ADSPDCGE, val);
 110
 111         /* Update L1SEN bit of EM2 register */
 112         val = enable ? AZX_REG_VS_EM2_L1SEN : 0;
 113         snd_hdac_chip_updatel(bus, VS_EM2, AZX_REG_VS_EM2_L1SEN, val);
 114
 115         /* Update ADSPPGD bit of PGCTL register */
 116         val = enable ? 0 : AZX_PGCTL_ADSPPGD;
 117         update_pci_dword(pci, AZX_PCIREG_PGCTL, AZX_PGCTL_ADSPPGD, val);
 118 }
 119
 120 /*
 121  * While performing reset, controller may not come back properly causing
 122  * issues, so recommendation is to set CGCTL.MISCBDCGE to 0 then do reset
 123  * (init chip) and then again set CGCTL.MISCBDCGE to 1
 124  */
 125 static int skl_init_chip(struct hdac_bus *bus, bool full_reset)
 126 {
 127         struct hdac_ext_link *hlink;
 128         int ret;
 129
 130         skl_enable_miscbdcge(bus->dev, false);
 131         ret = snd_hdac_bus_init_chip(bus, full_reset);
 132
 133         /* Reset stream-to-link mapping */
 134         list_for_each_entry(hlink, &bus->hlink_list, list)
 135                 bus->io_ops->reg_writel(0, hlink->ml_addr + AZX_REG_ML_LOSIDV);
 136
 137         skl_enable_miscbdcge(bus->dev, true);
 138
 139         return ret;
 140 }
 141
 142 void skl_update_d0i3c(struct device *dev, bool enable)
 143 {
 144         struct pci_dev *pci = to_pci_dev(dev);
 145         struct hdac_bus *bus = pci_get_drvdata(pci);
 146         u8 reg;
 147         int timeout = 50;
 148
 149         reg = snd_hdac_chip_readb(bus, VS_D0I3C);
 150         /* Do not write to D0I3C until command in progress bit is cleared */
 151         while ((reg & AZX_REG_VS_D0I3C_CIP) && --timeout) {
 152                 udelay(10);
 153                 reg = snd_hdac_chip_readb(bus, VS_D0I3C);
 154         }
 155
 156         /* Highly unlikely. But if it happens, flag error explicitly */
 157         if (!timeout) {
 158                 dev_err(bus->dev, "Before D0I3C update: D0I3C CIP timeout\n");
 159                 return;
 160         }
 161
 162         if (enable)
 163                 reg = reg | AZX_REG_VS_D0I3C_I3;
 164         else
 165                 reg = reg & (~AZX_REG_VS_D0I3C_I3);
 166
 167         snd_hdac_chip_writeb(bus, VS_D0I3C, reg);
 168
 169         timeout = 50;
 170         /* Wait for cmd in progress to be cleared before exiting the function */
 171         reg = snd_hdac_chip_readb(bus, VS_D0I3C);
 172         while ((reg & AZX_REG_VS_D0I3C_CIP) && --timeout) {
 173                 udelay(10);
 174                 reg = snd_hdac_chip_readb(bus, VS_D0I3C);
 175         }
 176
 177         /* Highly unlikely. But if it happens, flag error explicitly */
 178         if (!timeout) {
 179                 dev_err(bus->dev, "After D0I3C update: D0I3C CIP timeout\n");
 180                 return;
 181         }
 182
 183         dev_dbg(bus->dev, "D0I3C register = 0x%x\n",
 184                         snd_hdac_chip_readb(bus, VS_D0I3C));
 185 }
 186
 187 /**
 188  * skl_dum_set - set DUM bit in EM2 register
 189  * @bus: HD-audio core bus
 190  *
 191  * Addresses incorrect position reporting for capture streams.
 192  * Used on device power up.
 193  */
 194 static void skl_dum_set(struct hdac_bus *bus)
 195 {
 196         /* For the DUM bit to be set, CRST needs to be out of reset state */
 197         if (!(snd_hdac_chip_readb(bus, GCTL) & AZX_GCTL_RESET)) {
 198                 skl_enable_miscbdcge(bus->dev, false);
 199                 snd_hdac_bus_exit_link_reset(bus);
 200                 skl_enable_miscbdcge(bus->dev, true);
 201         }
 202
 203         snd_hdac_chip_updatel(bus, VS_EM2, AZX_VS_EM2_DUM, AZX_VS_EM2_DUM);
 204 }
 205
 206 /* called from IRQ */
 207 static void skl_stream_update(struct hdac_bus *bus, struct hdac_stream *hstr)
 208 {
 209         snd_pcm_period_elapsed(hstr->substream);
 210 }
 211
 212 static irqreturn_t skl_interrupt(int irq, void *dev_id)
 213 {
 214         struct hdac_bus *bus = dev_id;
 215         u32 status;
 216
 217         if (!pm_runtime_active(bus->dev))
 218                 return IRQ_NONE;
 219
 220         spin_lock(&bus->reg_lock);
 221
 222         status = snd_hdac_chip_readl(bus, INTSTS);
 223         if (status == 0 || status == 0xffffffff) {
 224                 spin_unlock(&bus->reg_lock);
 225                 return IRQ_NONE;
 226         }
 227
 228         /* clear rirb int */
 229         status = snd_hdac_chip_readb(bus, RIRBSTS);
 230         if (status & RIRB_INT_MASK) {
 231                 if (status & RIRB_INT_RESPONSE)
 232                         snd_hdac_bus_update_rirb(bus);
 233                 snd_hdac_chip_writeb(bus, RIRBSTS, RIRB_INT_MASK);
 234         }
 235
 236         spin_unlock(&bus->reg_lock);
 237
 238         return snd_hdac_chip_readl(bus, INTSTS) ? IRQ_WAKE_THREAD : IRQ_HANDLED;
 239 }
 240
 241 static irqreturn_t skl_threaded_handler(int irq, void *dev_id)
 242 {
 243         struct hdac_bus *bus = dev_id;
 244         u32 status;
 245
 246         status = snd_hdac_chip_readl(bus, INTSTS);
 247
 248         snd_hdac_bus_handle_stream_irq(bus, status, skl_stream_update);
 249
 250         return IRQ_HANDLED;
 251 }
 252
 253 static int skl_acquire_irq(struct hdac_bus *bus, int do_disconnect)
 254 {
 255         struct skl *skl = bus_to_skl(bus);
 256         int ret;
 257
 258         ret = request_threaded_irq(skl->pci->irq, skl_interrupt,
 259                         skl_threaded_handler,
 260                         IRQF_SHARED,
 261                         KBUILD_MODNAME, bus);
 262         if (ret) {
 263                 dev_err(bus->dev,
 264                         "unable to grab IRQ %d, disabling device\n",
 265                         skl->pci->irq);
 266                 return ret;
 267         }
 268
 269         bus->irq = skl->pci->irq;
 270         pci_intx(skl->pci, 1);
 271
 272         return 0;
 273 }
 274
 275 static int skl_suspend_late(struct device *dev)
 276 {
 277         struct pci_dev *pci = to_pci_dev(dev);
 278         struct hdac_bus *bus = pci_get_drvdata(pci);
 279         struct skl *skl = bus_to_skl(bus);
 280
 281         return skl_suspend_late_dsp(skl);
 282 }
 283
 284 #ifdef CONFIG_PM
 285 static int _skl_suspend(struct hdac_bus *bus)
 286 {
 287         struct skl *skl = bus_to_skl(bus);
 288         struct pci_dev *pci = to_pci_dev(bus->dev);
 289         int ret;
 290
 291         snd_hdac_ext_bus_link_power_down_all(bus);
 292
 293         ret = skl_suspend_dsp(skl);
 294         if (ret < 0)
 295                 return ret;
 296
 297         snd_hdac_bus_stop_chip(bus);
 298         update_pci_dword(pci, AZX_PCIREG_PGCTL,
 299                 AZX_PGCTL_LSRMD_MASK, AZX_PGCTL_LSRMD_MASK);
 300         skl_enable_miscbdcge(bus->dev, false);
 301         snd_hdac_bus_enter_link_reset(bus);
 302         skl_enable_miscbdcge(bus->dev, true);
 303         skl_cleanup_resources(skl);
 304
 305         return 0;
 306 }
 307
 308 static int _skl_resume(struct hdac_bus *bus)
 309 {
 310         struct skl *skl = bus_to_skl(bus);
 311
 312         skl_init_pci(skl);
 313         skl_dum_set(bus);
 314         skl_init_chip(bus, true);
 315
 316         return skl_resume_dsp(skl);
 317 }
 318 #endif
 319
 320 #ifdef CONFIG_PM_SLEEP
 321 /*
 322  * power management
 323  */
 324 static int skl_suspend(struct device *dev)
 325 {
 326         struct pci_dev *pci = to_pci_dev(dev);
 327         struct hdac_bus *bus = pci_get_drvdata(pci);
 328         struct skl *skl  = bus_to_skl(bus);
 329         int ret;
 330
 331         /*
 332          * Do not suspend if streams which are marked ignore suspend are
 333          * running, we need to save the state for these and continue
 334          */
 335         if (skl->supend_active) {
 336                 /* turn off the links and stop the CORB/RIRB DMA if it is On */
 337                 snd_hdac_ext_bus_link_power_down_all(bus);
 338
 339                 if (bus->cmd_dma_state)
 340                         snd_hdac_bus_stop_cmd_io(bus);
 341
 342                 enable_irq_wake(bus->irq);
 343                 pci_save_state(pci);
 344         } else {
 345                 ret = _skl_suspend(bus);
 346                 if (ret < 0)
 347                         return ret;
 348                 skl->skl_sst->fw_loaded = false;
 349         }
 350
 351         return 0;
 352 }
 353
 354 static int skl_resume(struct device *dev)
 355 {
 356         struct pci_dev *pci = to_pci_dev(dev);
 357         struct hdac_bus *bus = pci_get_drvdata(pci);
 358         struct skl *skl  = bus_to_skl(bus);
 359         struct hdac_ext_link *hlink = NULL;
 360         int ret;
 361
 362         /*
 363          * resume only when we are not in suspend active, otherwise need to
 364          * restore the device
 365          */
 366         if (skl->supend_active) {
 367                 pci_restore_state(pci);
 368                 snd_hdac_ext_bus_link_power_up_all(bus);
 369                 disable_irq_wake(bus->irq);
 370                 /*
 371                  * turn On the links which are On before active suspend
 372                  * and start the CORB/RIRB DMA if On before
 373                  * active suspend.
 374                  */
 375                 list_for_each_entry(hlink, &bus->hlink_list, list) {
 376                         if (hlink->ref_count)
 377                                 snd_hdac_ext_bus_link_power_up(hlink);
 378                 }
 379
 380                 ret = 0;
 381                 if (bus->cmd_dma_state)
 382                         snd_hdac_bus_init_cmd_io(bus);
 383         } else {
 384                 ret = _skl_resume(bus);
 385
 386                 /* turn off the links which are off before suspend */
 387                 list_for_each_entry(hlink, &bus->hlink_list, list) {
 388                         if (!hlink->ref_count)
 389                                 snd_hdac_ext_bus_link_power_down(hlink);
 390                 }
 391
 392                 if (!bus->cmd_dma_state)
 393                         snd_hdac_bus_stop_cmd_io(bus);
 394         }
 395
 396         return ret;
 397 }
 398 #endif /* CONFIG_PM_SLEEP */
 399
 400 #ifdef CONFIG_PM
 401 static int skl_runtime_suspend(struct device *dev)
 402 {
 403         struct pci_dev *pci = to_pci_dev(dev);
 404         struct hdac_bus *bus = pci_get_drvdata(pci);
 405
 406         dev_dbg(bus->dev, "in %s\n", __func__);
 407
 408         return _skl_suspend(bus);
 409 }
 410
 411 static int skl_runtime_resume(struct device *dev)
 412 {
 413         struct pci_dev *pci = to_pci_dev(dev);
 414         struct hdac_bus *bus = pci_get_drvdata(pci);
 415
 416         dev_dbg(bus->dev, "in %s\n", __func__);
 417
 418         return _skl_resume(bus);
 419 }
 420 #endif /* CONFIG_PM */
 421
 422 static const struct dev_pm_ops skl_pm = {
 423         SET_SYSTEM_SLEEP_PM_OPS(skl_suspend, skl_resume)
 424         SET_RUNTIME_PM_OPS(skl_runtime_suspend, skl_runtime_resume, NULL)
 425         .suspend_late = skl_suspend_late,
 426 };
 427
 428 /*
 429  * destructor
 430  */
 431 static int skl_free(struct hdac_bus *bus)
 432 {
 433         struct skl *skl  = bus_to_skl(bus);
 434
 435         skl->init_done = 0; /* to be sure */
 436
 437         snd_hdac_ext_stop_streams(bus);
 438
 439         if (bus->irq >= 0)
 440                 free_irq(bus->irq, (void *)bus);
 441         snd_hdac_bus_free_stream_pages(bus);
 442         snd_hdac_stream_free_all(bus);
 443         snd_hdac_link_free_all(bus);
 444
 445         if (bus->remap_addr)
 446                 iounmap(bus->remap_addr);
 447
 448         pci_release_regions(skl->pci);
 449         pci_disable_device(skl->pci);
 450
 451         snd_hdac_ext_bus_exit(bus);
 452
 453         cancel_work_sync(&skl->probe_work);
 454         if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI)) {
 455                 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
 456                 snd_hdac_i915_exit(bus);
 457         }
 458
 459         return 0;
 460 }
 461
 462 /*
 463  * For each ssp there are 3 clocks (mclk/sclk/sclkfs).
 464  * e.g. for ssp0, clocks will be named as
 465  *      "ssp0_mclk", "ssp0_sclk", "ssp0_sclkfs"
 466  * So for skl+, there are 6 ssps, so 18 clocks will be created.
 467  */
 468 static struct skl_ssp_clk skl_ssp_clks[] = {
 469         {.name = "ssp0_mclk"}, {.name = "ssp1_mclk"}, {.name = "ssp2_mclk"},
 470         {.name = "ssp3_mclk"}, {.name = "ssp4_mclk"}, {.name = "ssp5_mclk"},
 471         {.name = "ssp0_sclk"}, {.name = "ssp1_sclk"}, {.name = "ssp2_sclk"},
 472         {.name = "ssp3_sclk"}, {.name = "ssp4_sclk"}, {.name = "ssp5_sclk"},
 473         {.name = "ssp0_sclkfs"}, {.name = "ssp1_sclkfs"},
 474                                                 {.name = "ssp2_sclkfs"},
 475         {.name = "ssp3_sclkfs"}, {.name = "ssp4_sclkfs"},
 476                                                 {.name = "ssp5_sclkfs"},
 477 };
 478
 479 static struct snd_soc_acpi_mach *skl_find_hda_machine(struct skl *skl,
 480                                         struct snd_soc_acpi_mach *machines)
 481 {
 482         struct hdac_bus *bus = skl_to_bus(skl);
 483         struct snd_soc_acpi_mach *mach;
 484
 485         /* check if we have any codecs detected on bus */
 486         if (bus->codec_mask == 0)
 487                 return NULL;
 488
 489         /* point to common table */
 490         mach = snd_soc_acpi_intel_hda_machines;
 491
 492         /* all entries in the machine table use the same firmware */
 493         mach->fw_filename = machines->fw_filename;
 494
 495         return mach;
 496 }
 497
 498 static int skl_find_machine(struct skl *skl, void *driver_data)
 499 {
 500         struct hdac_bus *bus = skl_to_bus(skl);
 501         struct snd_soc_acpi_mach *mach = driver_data;
 502         struct skl_machine_pdata *pdata;
 503
 504         mach = snd_soc_acpi_find_machine(mach);
 505         if (!mach) {
 506                 dev_dbg(bus->dev, "No matching I2S machine driver found\n");
 507                 mach = skl_find_hda_machine(skl, driver_data);
 508                 if (!mach) {
 509                         dev_err(bus->dev, "No matching machine driver found\n");
 510                         return -ENODEV;
 511                 }
 512         }
 513
 514         skl->mach = mach;
 515         skl->fw_name = mach->fw_filename;
 516         pdata = mach->pdata;
 517
 518         if (pdata) {
 519                 skl->use_tplg_pcm = pdata->use_tplg_pcm;
 520                 mach->mach_params.dmic_num = skl_get_dmic_geo(skl);
 521         }
 522
 523         return 0;
 524 }
 525
 526 static int skl_machine_device_register(struct skl *skl)
 527 {
 528         struct snd_soc_acpi_mach *mach = skl->mach;
 529         struct hdac_bus *bus = skl_to_bus(skl);
 530         struct platform_device *pdev;
 531         int ret;
 532
 533         pdev = platform_device_alloc(mach->drv_name, -1);
 534         if (pdev == NULL) {
 535                 dev_err(bus->dev, "platform device alloc failed\n");
 536                 return -EIO;
 537         }
 538
 539         mach->mach_params.platform = dev_name(bus->dev);
 540         mach->mach_params.codec_mask = bus->codec_mask;
 541
 542         ret = platform_device_add_data(pdev, (const void *)mach, sizeof(*mach));
 543         if (ret) {
 544                 dev_err(bus->dev, "failed to add machine device platform data\n");
 545                 platform_device_put(pdev);
 546                 return ret;
 547         }
 548
 549         ret = platform_device_add(pdev);
 550         if (ret) {
 551                 dev_err(bus->dev, "failed to add machine device\n");
 552                 platform_device_put(pdev);
 553                 return -EIO;
 554         }
 555
 556
 557         skl->i2s_dev = pdev;
 558
 559         return 0;
 560 }
 561
 562 static void skl_machine_device_unregister(struct skl *skl)
 563 {
 564         if (skl->i2s_dev)
 565                 platform_device_unregister(skl->i2s_dev);
 566 }
 567
 568 static int skl_dmic_device_register(struct skl *skl)
 569 {
 570         struct hdac_bus *bus = skl_to_bus(skl);
 571         struct platform_device *pdev;
 572         int ret;
 573
 574         /* SKL has one dmic port, so allocate dmic device for this */
 575         pdev = platform_device_alloc("dmic-codec", -1);
 576         if (!pdev) {
 577                 dev_err(bus->dev, "failed to allocate dmic device\n");
 578                 return -ENOMEM;
 579         }
 580
 581         ret = platform_device_add(pdev);
 582         if (ret) {
 583                 dev_err(bus->dev, "failed to add dmic device: %d\n", ret);
 584                 platform_device_put(pdev);
 585                 return ret;
 586         }
 587         skl->dmic_dev = pdev;
 588
 589         return 0;
 590 }
 591
 592 static void skl_dmic_device_unregister(struct skl *skl)
 593 {
 594         if (skl->dmic_dev)
 595                 platform_device_unregister(skl->dmic_dev);
 596 }
 597
 598 static struct skl_clk_parent_src skl_clk_src[] = {
 599         { .clk_id = SKL_XTAL, .name = "xtal" },
 600         { .clk_id = SKL_CARDINAL, .name = "cardinal", .rate = 24576000 },
 601         { .clk_id = SKL_PLL, .name = "pll", .rate = 96000000 },
 602 };
 603
 604 struct skl_clk_parent_src *skl_get_parent_clk(u8 clk_id)
 605 {
 606         unsigned int i;
 607
 608         for (i = 0; i < ARRAY_SIZE(skl_clk_src); i++) {
 609                 if (skl_clk_src[i].clk_id == clk_id)
 610                         return &skl_clk_src[i];
 611         }
 612
 613         return NULL;
 614 }
 615
 616 static void init_skl_xtal_rate(int pci_id)
 617 {
 618         switch (pci_id) {
 619         case 0x9d70:
 620         case 0x9d71:
 621                 skl_clk_src[0].rate = 24000000;
 622                 return;
 623
 624         default:
 625                 skl_clk_src[0].rate = 19200000;
 626                 return;
 627         }
 628 }
 629
 630 static int skl_clock_device_register(struct skl *skl)
 631 {
 632         struct platform_device_info pdevinfo = {NULL};
 633         struct skl_clk_pdata *clk_pdata;
 634
 635         clk_pdata = devm_kzalloc(&skl->pci->dev, sizeof(*clk_pdata),
 636                                                         GFP_KERNEL);
 637         if (!clk_pdata)
 638                 return -ENOMEM;
 639
 640         init_skl_xtal_rate(skl->pci->device);
 641
 642         clk_pdata->parent_clks = skl_clk_src;
 643         clk_pdata->ssp_clks = skl_ssp_clks;
 644         clk_pdata->num_clks = ARRAY_SIZE(skl_ssp_clks);
 645
 646         /* Query NHLT to fill the rates and parent */
 647         skl_get_clks(skl, clk_pdata->ssp_clks);
 648         clk_pdata->pvt_data = skl;
 649
 650         /* Register Platform device */
 651         pdevinfo.parent = &skl->pci->dev;
 652         pdevinfo.id = -1;
 653         pdevinfo.name = "skl-ssp-clk";
 654         pdevinfo.data = clk_pdata;
 655         pdevinfo.size_data = sizeof(*clk_pdata);
 656         skl->clk_dev = platform_device_register_full(&pdevinfo);
 657         return PTR_ERR_OR_ZERO(skl->clk_dev);
 658 }
 659
 660 static void skl_clock_device_unregister(struct skl *skl)
 661 {
 662         if (skl->clk_dev)
 663                 platform_device_unregister(skl->clk_dev);
 664 }
 665
 666 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC)
 667
 668 #define IDISP_INTEL_VENDOR_ID   0x80860000
 669
 670 /*
 671  * load the legacy codec driver
 672  */
 673 static void load_codec_module(struct hda_codec *codec)
 674 {
 675 #ifdef MODULE
 676         char modalias[MODULE_NAME_LEN];
 677         const char *mod = NULL;
 678
 679         snd_hdac_codec_modalias(&codec->core, modalias, sizeof(modalias));
 680         mod = modalias;
 681         dev_dbg(&codec->core.dev, "loading %s codec module\n", mod);
 682         request_module(mod);
 683 #endif
 684 }
 685
 686 #endif /* CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC */
 687
 688 /*
 689  * Probe the given codec address
 690  */
 691 static int probe_codec(struct hdac_bus *bus, int addr)
 692 {
 693         unsigned int cmd = (addr << 28) | (AC_NODE_ROOT << 20) |
 694                 (AC_VERB_PARAMETERS << 8) | AC_PAR_VENDOR_ID;
 695         unsigned int res = -1;
 696         struct skl *skl = bus_to_skl(bus);
 697 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC)
 698         struct hdac_hda_priv *hda_codec;
 699         int err;
 700 #endif
 701         struct hdac_device *hdev;
 702
 703         mutex_lock(&bus->cmd_mutex);
 704         snd_hdac_bus_send_cmd(bus, cmd);
 705         snd_hdac_bus_get_response(bus, addr, &res);
 706         mutex_unlock(&bus->cmd_mutex);
 707         if (res == -1)
 708                 return -EIO;
 709         dev_dbg(bus->dev, "codec #%d probed OK: %x\n", addr, res);
 710
 711 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC)
 712         hda_codec = devm_kzalloc(&skl->pci->dev, sizeof(*hda_codec),
 713                                  GFP_KERNEL);
 714         if (!hda_codec)
 715                 return -ENOMEM;
 716
 717         hda_codec->codec.bus = skl_to_hbus(skl);
 718         hdev = &hda_codec->codec.core;
 719
 720         err = snd_hdac_ext_bus_device_init(bus, addr, hdev);
 721         if (err < 0)
 722                 return err;
 723
 724         /* use legacy bus only for HDA codecs, idisp uses ext bus */
 725         if ((res & 0xFFFF0000) != IDISP_INTEL_VENDOR_ID) {
 726                 hdev->type = HDA_DEV_LEGACY;
 727                 load_codec_module(&hda_codec->codec);
 728         }
 729         return 0;
 730 #else
 731         hdev = devm_kzalloc(&skl->pci->dev, sizeof(*hdev), GFP_KERNEL);
 732         if (!hdev)
 733                 return -ENOMEM;
 734
 735         return snd_hdac_ext_bus_device_init(bus, addr, hdev);
 736 #endif /* CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC */
 737 }
 738
 739 /* Codec initialization */
 740 static void skl_codec_create(struct hdac_bus *bus)
 741 {
 742         int c, max_slots;
 743
 744         max_slots = HDA_MAX_CODECS;
 745
 746         /* First try to probe all given codec slots */
 747         for (c = 0; c < max_slots; c++) {
 748                 if ((bus->codec_mask & (1 << c))) {
 749                         if (probe_codec(bus, c) < 0) {
 750                                 /*
 751                                  * Some BIOSen give you wrong codec addresses
 752                                  * that don't exist
 753                                  */
 754                                 dev_warn(bus->dev,
 755                                          "Codec #%d probe error; disabling it...\n", c);
 756                                 bus->codec_mask &= ~(1 << c);
 757                                 /*
 758                                  * More badly, accessing to a non-existing
 759                                  * codec often screws up the controller bus,
 760                                  * and disturbs the further communications.
 761                                  * Thus if an error occurs during probing,
 762                                  * better to reset the controller bus to get
 763                                  * back to the sanity state.
 764                                  */
 765                                 snd_hdac_bus_stop_chip(bus);
 766                                 skl_init_chip(bus, true);
 767                         }
 768                 }
 769         }
 770 }
 771
 772 static const struct hdac_bus_ops bus_core_ops = {
 773         .command = snd_hdac_bus_send_cmd,
 774         .get_response = snd_hdac_bus_get_response,
 775 };
 776
 777 static int skl_i915_init(struct hdac_bus *bus)
 778 {
 779         int err;
 780
 781         /*
 782          * The HDMI codec is in GPU so we need to ensure that it is powered
 783          * up and ready for probe
 784          */
 785         err = snd_hdac_i915_init(bus);
 786         if (err < 0)
 787                 return err;
 788
 789         snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, true);
 790
 791         return 0;
 792 }
 793
 794 static void skl_probe_work(struct work_struct *work)
 795 {
 796         struct skl *skl = container_of(work, struct skl, probe_work);
 797         struct hdac_bus *bus = skl_to_bus(skl);
 798         struct hdac_ext_link *hlink = NULL;
 799         int err;
 800
 801         if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI)) {
 802                 err = skl_i915_init(bus);
 803                 if (err < 0)
 804                         return;
 805         }
 806
 807         err = skl_init_chip(bus, true);
 808         if (err < 0) {
 809                 dev_err(bus->dev, "Init chip failed with err: %d\n", err);
 810                 goto out_err;
 811         }
 812
 813         /* codec detection */
 814         if (!bus->codec_mask)
 815                 dev_info(bus->dev, "no hda codecs found!\n");
 816
 817         /* create codec instances */
 818         skl_codec_create(bus);
 819
 820         /* register platform dai and controls */
 821         err = skl_platform_register(bus->dev);
 822         if (err < 0) {
 823                 dev_err(bus->dev, "platform register failed: %d\n", err);
 824                 goto out_err;
 825         }
 826
 827         err = skl_machine_device_register(skl);
 828         if (err < 0) {
 829                 dev_err(bus->dev, "machine register failed: %d\n", err);
 830                 goto out_err;
 831         }
 832
 833         /*
 834          * we are done probing so decrement link counts
 835          */
 836         list_for_each_entry(hlink, &bus->hlink_list, list)
 837                 snd_hdac_ext_bus_link_put(bus, hlink);
 838
 839         if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI))
 840                 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
 841
 842         /* configure PM */
 843         pm_runtime_put_noidle(bus->dev);
 844         pm_runtime_allow(bus->dev);
 845         skl->init_done = 1;
 846
 847         return;
 848
 849 out_err:
 850         if (IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI))
 851                 snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
 852 }
 853
 854 /*
 855  * constructor
 856  */
 857 static int skl_create(struct pci_dev *pci,
 858                       const struct hdac_io_ops *io_ops,
 859                       struct skl **rskl)
 860 {
 861         struct hdac_ext_bus_ops *ext_ops = NULL;
 862         struct skl *skl;
 863         struct hdac_bus *bus;
 864         struct hda_bus *hbus;
 865         int err;
 866
 867         *rskl = NULL;
 868
 869         err = pci_enable_device(pci);
 870         if (err < 0)
 871                 return err;
 872
 873         skl = devm_kzalloc(&pci->dev, sizeof(*skl), GFP_KERNEL);
 874         if (!skl) {
 875                 pci_disable_device(pci);
 876                 return -ENOMEM;
 877         }
 878
 879         hbus = skl_to_hbus(skl);
 880         bus = skl_to_bus(skl);
 881
 882 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC)
 883         ext_ops = snd_soc_hdac_hda_get_ops();
 884 #endif
 885         snd_hdac_ext_bus_init(bus, &pci->dev, &bus_core_ops, io_ops, ext_ops);
 886         bus->use_posbuf = 1;
 887         skl->pci = pci;
 888         INIT_WORK(&skl->probe_work, skl_probe_work);
 889         bus->bdl_pos_adj = 0;
 890
 891         mutex_init(&hbus->prepare_mutex);
 892         hbus->pci = pci;
 893         hbus->mixer_assigned = -1;
 894         hbus->modelname = "sklbus";
 895
 896         *rskl = skl;
 897
 898         return 0;
 899 }
 900
 901 static int skl_first_init(struct hdac_bus *bus)
 902 {
 903         struct skl *skl = bus_to_skl(bus);
 904         struct pci_dev *pci = skl->pci;
 905         int err;
 906         unsigned short gcap;
 907         int cp_streams, pb_streams, start_idx;
 908
 909         err = pci_request_regions(pci, "Skylake HD audio");
 910         if (err < 0)
 911                 return err;
 912
 913         bus->addr = pci_resource_start(pci, 0);
 914         bus->remap_addr = pci_ioremap_bar(pci, 0);
 915         if (bus->remap_addr == NULL) {
 916                 dev_err(bus->dev, "ioremap error\n");
 917                 return -ENXIO;
 918         }
 919
 920         snd_hdac_bus_reset_link(bus, true);
 921
 922         snd_hdac_bus_parse_capabilities(bus);
 923
 924         /* check if PPCAP exists */
 925         if (!bus->ppcap) {
 926                 dev_err(bus->dev, "bus ppcap not set, HDaudio or DSP not present?\n");
 927                 return -ENODEV;
 928         }
 929
 930         if (skl_acquire_irq(bus, 0) < 0)
 931                 return -EBUSY;
 932
 933         pci_set_master(pci);
 934         synchronize_irq(bus->irq);
 935
 936         gcap = snd_hdac_chip_readw(bus, GCAP);
 937         dev_dbg(bus->dev, "chipset global capabilities = 0x%x\n", gcap);
 938
 939         /* read number of streams from GCAP register */
 940         cp_streams = (gcap >> 8) & 0x0f;
 941         pb_streams = (gcap >> 12) & 0x0f;
 942
 943         if (!pb_streams && !cp_streams) {
 944                 dev_err(bus->dev, "no streams found in GCAP definitions?\n");
 945                 return -EIO;
 946         }
 947
 948         bus->num_streams = cp_streams + pb_streams;
 949
 950         /* allow 64bit DMA address if supported by H/W */
 951         if (!dma_set_mask(bus->dev, DMA_BIT_MASK(64))) {
 952                 dma_set_coherent_mask(bus->dev, DMA_BIT_MASK(64));
 953         } else {
 954                 dma_set_mask(bus->dev, DMA_BIT_MASK(32));
 955                 dma_set_coherent_mask(bus->dev, DMA_BIT_MASK(32));
 956         }
 957
 958         /* initialize streams */
 959         snd_hdac_ext_stream_init_all
 960                 (bus, 0, cp_streams, SNDRV_PCM_STREAM_CAPTURE);
 961         start_idx = cp_streams;
 962         snd_hdac_ext_stream_init_all
 963                 (bus, start_idx, pb_streams, SNDRV_PCM_STREAM_PLAYBACK);
 964
 965         err = snd_hdac_bus_alloc_stream_pages(bus);
 966         if (err < 0)
 967                 return err;
 968
 969         /* initialize chip */
 970         skl_init_pci(skl);
 971         skl_dum_set(bus);
 972
 973         return skl_init_chip(bus, true);
 974 }
 975
 976 static int skl_probe(struct pci_dev *pci,
 977                      const struct pci_device_id *pci_id)
 978 {
 979         struct skl *skl;
 980         struct hdac_bus *bus = NULL;
 981         int err;
 982
 983         switch (skl_pci_binding) {
 984         case SND_SKL_PCI_BIND_AUTO:
 985                 /*
 986                  * detect DSP by checking class/subclass/prog-id information
 987                  * class=04 subclass 03 prog-if 00: no DSP, use legacy driver
 988                  * class=04 subclass 01 prog-if 00: DSP is present
 989                  *   (and may be required e.g. for DMIC or SSP support)
 990                  * class=04 subclass 03 prog-if 80: use DSP or legacy mode
 991                  */
 992                 if (pci->class == 0x040300) {
 993                         dev_info(&pci->dev, "The DSP is not enabled on this platform, aborting probe\n");
 994                         return -ENODEV;
 995                 }
 996                 if (pci->class != 0x040100 && pci->class != 0x040380) {
 997                         dev_err(&pci->dev, "Unknown PCI class/subclass/prog-if information (0x%06x) found, aborting probe\n", pci->class);
 998                         return -ENODEV;
 999                 }
1000                 dev_info(&pci->dev, "DSP detected with PCI class/subclass/prog-if info 0x%06x\n", pci->class);
1001                 break;
1002         case SND_SKL_PCI_BIND_LEGACY:
1003                 dev_info(&pci->dev, "Module parameter forced binding with HDaudio legacy, aborting probe\n");
1004                 return -ENODEV;
1005         case SND_SKL_PCI_BIND_ASOC:
1006                 dev_info(&pci->dev, "Module parameter forced binding with SKL driver, bypassed detection logic\n");
1007                 break;
1008         default:
1009                 dev_err(&pci->dev, "invalid value for skl_pci_binding module parameter, ignored\n");
1010                 break;
1011         }
1012
1013         /* we use ext core ops, so provide NULL for ops here */
1014         err = skl_create(pci, NULL, &skl);
1015         if (err < 0)
1016                 return err;
1017
1018         bus = skl_to_bus(skl);
1019
1020         err = skl_first_init(bus);
1021         if (err < 0) {
1022                 dev_err(bus->dev, "skl_first_init failed with err: %d\n", err);
1023                 goto out_free;
1024         }
1025
1026         skl->pci_id = pci->device;
1027
1028         device_disable_async_suspend(bus->dev);
1029
1030         skl->nhlt = skl_nhlt_init(bus->dev);
1031
1032         if (skl->nhlt == NULL) {
1033 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_SKYLAKE_HDAUDIO_CODEC)
1034                 dev_err(bus->dev, "no nhlt info found\n");
1035                 err = -ENODEV;
1036                 goto out_free;
1037 #else
1038                 dev_warn(bus->dev, "no nhlt info found, continuing to try to enable HDaudio codec\n");
1039 #endif
1040         } else {
1041
1042                 err = skl_nhlt_create_sysfs(skl);
1043                 if (err < 0) {
1044                         dev_err(bus->dev, "skl_nhlt_create_sysfs failed with err: %d\n", err);
1045                         goto out_nhlt_free;
1046                 }
1047
1048                 skl_nhlt_update_topology_bin(skl);
1049
1050                 /* create device for dsp clk */
1051                 err = skl_clock_device_register(skl);
1052                 if (err < 0) {
1053                         dev_err(bus->dev, "skl_clock_device_register failed with err: %d\n", err);
1054                         goto out_clk_free;
1055                 }
1056         }
1057
1058         pci_set_drvdata(skl->pci, bus);
1059
1060
1061         err = skl_find_machine(skl, (void *)pci_id->driver_data);
1062         if (err < 0) {
1063                 dev_err(bus->dev, "skl_find_machine failed with err: %d\n", err);
1064                 goto out_nhlt_free;
1065         }
1066
1067         err = skl_init_dsp(skl);
1068         if (err < 0) {
1069                 dev_dbg(bus->dev, "error failed to register dsp\n");
1070                 goto out_nhlt_free;
1071         }
1072         skl->skl_sst->enable_miscbdcge = skl_enable_miscbdcge;
1073         skl->skl_sst->clock_power_gating = skl_clock_power_gating;
1074
1075         if (bus->mlcap)
1076                 snd_hdac_ext_bus_get_ml_capabilities(bus);
1077
1078         snd_hdac_bus_stop_chip(bus);
1079
1080         /* create device for soc dmic */
1081         err = skl_dmic_device_register(skl);
1082         if (err < 0) {
1083                 dev_err(bus->dev, "skl_dmic_device_register failed with err: %d\n", err);
1084                 goto out_dsp_free;
1085         }
1086
1087         schedule_work(&skl->probe_work);
1088
1089         return 0;
1090
1091 out_dsp_free:
1092         skl_free_dsp(skl);
1093 out_clk_free:
1094         skl_clock_device_unregister(skl);
1095 out_nhlt_free:
1096         skl_nhlt_free(skl->nhlt);
1097 out_free:
1098         skl_free(bus);
1099
1100         return err;
1101 }
1102
1103 static void skl_shutdown(struct pci_dev *pci)
1104 {
1105         struct hdac_bus *bus = pci_get_drvdata(pci);
1106         struct hdac_stream *s;
1107         struct hdac_ext_stream *stream;
1108         struct skl *skl;
1109
1110         if (!bus)
1111                 return;
1112
1113         skl = bus_to_skl(bus);
1114
1115         if (!skl->init_done)
1116                 return;
1117
1118         snd_hdac_ext_stop_streams(bus);
1119         list_for_each_entry(s, &bus->stream_list, list) {
1120                 stream = stream_to_hdac_ext_stream(s);
1121                 snd_hdac_ext_stream_decouple(bus, stream, false);
1122         }
1123
1124         snd_hdac_bus_stop_chip(bus);
1125 }
1126
1127 static void skl_remove(struct pci_dev *pci)
1128 {
1129         struct hdac_bus *bus = pci_get_drvdata(pci);
1130         struct skl *skl = bus_to_skl(bus);
1131
1132         release_firmware(skl->tplg);
1133
1134         pm_runtime_get_noresume(&pci->dev);
1135
1136         /* codec removal, invoke bus_device_remove */
1137         snd_hdac_ext_bus_device_remove(bus);
1138
1139         skl->debugfs = NULL;
1140         skl_platform_unregister(&pci->dev);
1141         skl_free_dsp(skl);
1142         skl_machine_device_unregister(skl);
1143         skl_dmic_device_unregister(skl);
1144         skl_clock_device_unregister(skl);
1145         skl_nhlt_remove_sysfs(skl);
1146         skl_nhlt_free(skl->nhlt);
1147         skl_free(bus);
1148         dev_set_drvdata(&pci->dev, NULL);
1149 }
1150
1151 /* PCI IDs */
1152 static const struct pci_device_id skl_ids[] = {
1153 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKL)
1154         /* Sunrise Point-LP */
1155         { PCI_DEVICE(0x8086, 0x9d70),
1156                 .driver_data = (unsigned long)&snd_soc_acpi_intel_skl_machines},
1157 #endif
1158 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_APL)
1159         /* BXT-P */
1160         { PCI_DEVICE(0x8086, 0x5a98),
1161                 .driver_data = (unsigned long)&snd_soc_acpi_intel_bxt_machines},
1162 #endif
1163 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_KBL)
1164         /* KBL */
1165         { PCI_DEVICE(0x8086, 0x9D71),
1166                 .driver_data = (unsigned long)&snd_soc_acpi_intel_kbl_machines},
1167 #endif
1168 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_GLK)
1169         /* GLK */
1170         { PCI_DEVICE(0x8086, 0x3198),
1171                 .driver_data = (unsigned long)&snd_soc_acpi_intel_glk_machines},
1172 #endif
1173 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_CNL)
1174         /* CNL */
1175         { PCI_DEVICE(0x8086, 0x9dc8),
1176                 .driver_data = (unsigned long)&snd_soc_acpi_intel_cnl_machines},
1177 #endif
1178 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_CFL)
1179         /* CFL */
1180         { PCI_DEVICE(0x8086, 0xa348),
1181                 .driver_data = (unsigned long)&snd_soc_acpi_intel_cnl_machines},
1182 #endif
1183         { 0, }
1184 };
1185 MODULE_DEVICE_TABLE(pci, skl_ids);
1186
1187 /* pci_driver definition */
1188 static struct pci_driver skl_driver = {
1189         .name = KBUILD_MODNAME,
1190         .id_table = skl_ids,
1191         .probe = skl_probe,
1192         .remove = skl_remove,
1193         .shutdown = skl_shutdown,
1194         .driver = {
1195                 .pm = &skl_pm,
1196         },
1197 };
1198 module_pci_driver(skl_driver);
1199
1200 MODULE_LICENSE("GPL v2");
1201 MODULE_DESCRIPTION("Intel Skylake ASoC HDA driver");