1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2019 Jaroslav Kysela <perex@perex.cz>
4 #include <linux/acpi.h>
5 #include <linux/bits.h>
7 #include <linux/module.h>
9 #include <linux/soundwire/sdw.h>
10 #include <linux/soundwire/sdw_intel.h>
11 #include <sound/core.h>
12 #include <sound/intel-dsp-config.h>
13 #include <sound/intel-nhlt.h>
14 #include <sound/soc-acpi.h>
16 static int dsp_driver;
18 module_param(dsp_driver, int, 0444);
19 MODULE_PARM_DESC(dsp_driver, "Force the DSP driver for Intel DSP (0=auto, 1=legacy, 2=SST, 3=SOF)");
21 #define FLAG_SST BIT(0)
22 #define FLAG_SOF BIT(1)
23 #define FLAG_SST_ONLY_IF_DMIC BIT(15)
24 #define FLAG_SOF_ONLY_IF_DMIC BIT(16)
25 #define FLAG_SOF_ONLY_IF_SOUNDWIRE BIT(17)
27 #define FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE (FLAG_SOF_ONLY_IF_DMIC | \
28 FLAG_SOF_ONLY_IF_SOUNDWIRE)
33 u8 acpi_hid[ACPI_ID_LEN];
34 const struct dmi_system_id *dmi_table;
35 const struct snd_soc_acpi_codecs *codec_hid;
38 static const struct snd_soc_acpi_codecs __maybe_unused essx_83x6 = {
40 .codecs = { "ESSX8316", "ESSX8326", "ESSX8336"},
45 * - the order of similar PCI ID entries is important!
46 * - the first successful match will win
48 static const struct config_entry config_table[] = {
50 #if IS_ENABLED(CONFIG_SND_SOC_SOF_MERRIFIELD)
57 #if IS_ENABLED(CONFIG_SND_SOC_SOF_APOLLOLAKE)
64 * Apollolake (Broxton-P)
65 * the legacy HDAudio driver is used except on Up Squared (SOF) and
66 * Chromebooks (SST), as well as devices based on the ES8336 codec
68 #if IS_ENABLED(CONFIG_SND_SOC_SOF_APOLLOLAKE)
72 .dmi_table = (const struct dmi_system_id []) {
74 .ident = "Up Squared",
76 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
77 DMI_MATCH(DMI_BOARD_NAME, "UP-APL01"),
86 .codec_hid = &essx_83x6,
89 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_APL)
93 .dmi_table = (const struct dmi_system_id []) {
95 .ident = "Google Chromebooks",
97 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
105 * Skylake and Kabylake use legacy HDAudio driver except for Google
109 /* Sunrise Point-LP */
110 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKL)
114 .dmi_table = (const struct dmi_system_id []) {
116 .ident = "Google Chromebooks",
118 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
125 .flags = FLAG_SST | FLAG_SST_ONLY_IF_DMIC,
130 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_KBL)
134 .dmi_table = (const struct dmi_system_id []) {
136 .ident = "Google Chromebooks",
138 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
145 .flags = FLAG_SST | FLAG_SST_ONLY_IF_DMIC,
151 * Geminilake uses legacy HDAudio driver except for Google
152 * Chromebooks and devices based on the ES8336 codec
155 #if IS_ENABLED(CONFIG_SND_SOC_SOF_GEMINILAKE)
159 .dmi_table = (const struct dmi_system_id []) {
161 .ident = "Google Chromebooks",
163 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
172 .codec_hid = &essx_83x6,
177 * CoffeeLake, CannonLake, CometLake, IceLake, TigerLake use legacy
178 * HDAudio driver except for Google Chromebooks and when DMICs are
179 * present. Two cases are required since Coreboot does not expose NHLT
182 * When the Chromebook quirk is not present, it's based on information
183 * that no such device exists. When the quirk is present, it could be
184 * either based on product information or a placeholder.
188 #if IS_ENABLED(CONFIG_SND_SOC_SOF_CANNONLAKE)
192 .dmi_table = (const struct dmi_system_id []) {
194 .ident = "Google Chromebooks",
196 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
202 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
211 .codec_hid = &essx_83x6,
214 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
220 #if IS_ENABLED(CONFIG_SND_SOC_SOF_COFFEELAKE)
224 .dmi_table = (const struct dmi_system_id []) {
226 .ident = "Google Chromebooks",
228 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
235 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
240 #if IS_ENABLED(CONFIG_SND_SOC_SOF_COMETLAKE)
245 .dmi_table = (const struct dmi_system_id []) {
247 .ident = "Google Chromebooks",
249 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
254 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
255 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "09C6")
259 /* early version of SKU 09C6 */
261 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
262 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "0983")
271 .codec_hid = &essx_83x6,
274 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
281 .dmi_table = (const struct dmi_system_id []) {
284 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
285 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "098F"),
290 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
291 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "0990"),
300 .codec_hid = &essx_83x6,
303 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
309 #if IS_ENABLED(CONFIG_SND_SOC_SOF_ICELAKE)
313 .dmi_table = (const struct dmi_system_id []) {
315 .ident = "Google Chromebooks",
317 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
324 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
330 #if IS_ENABLED(CONFIG_SND_SOC_SOF_JASPERLAKE)
334 .dmi_table = (const struct dmi_system_id []) {
336 .ident = "Google Chromebooks",
338 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
347 .codec_hid = &essx_83x6,
350 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC,
356 #if IS_ENABLED(CONFIG_SND_SOC_SOF_TIGERLAKE)
360 .dmi_table = (const struct dmi_system_id []) {
362 .ident = "Google Chromebooks",
364 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
370 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
379 .codec_hid = &essx_83x6,
382 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
386 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
392 #if IS_ENABLED(CONFIG_SND_SOC_SOF_ELKHARTLAKE)
394 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC,
398 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC,
404 #if IS_ENABLED(CONFIG_SND_SOC_SOF_ALDERLAKE)
407 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
412 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
419 .codec_hid = &essx_83x6,
422 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
426 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
433 .codec_hid = &essx_83x6,
436 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
441 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
446 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
451 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
455 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
460 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
465 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
472 static const struct config_entry *snd_intel_dsp_find_config
473 (struct pci_dev *pci, const struct config_entry *table, u32 len)
477 device = pci->device;
478 for (; len > 0; len--, table++) {
479 if (table->device != device)
481 if (table->dmi_table && !dmi_check_system(table->dmi_table))
483 if (table->codec_hid) {
486 for (i = 0; i < table->codec_hid->num_codecs; i++)
487 if (acpi_dev_present(table->codec_hid->codecs[i], NULL, -1))
489 if (i == table->codec_hid->num_codecs)
497 static int snd_intel_dsp_check_dmic(struct pci_dev *pci)
499 struct nhlt_acpi_table *nhlt;
502 nhlt = intel_nhlt_init(&pci->dev);
504 if (intel_nhlt_has_endpoint_type(nhlt, NHLT_LINK_DMIC))
506 intel_nhlt_free(nhlt);
511 #if IS_ENABLED(CONFIG_SND_SOC_SOF_INTEL_SOUNDWIRE)
512 static int snd_intel_dsp_check_soundwire(struct pci_dev *pci)
514 struct sdw_intel_acpi_info info;
518 handle = ACPI_HANDLE(&pci->dev);
520 ret = sdw_intel_acpi_scan(handle, &info);
524 return info.link_mask;
527 static int snd_intel_dsp_check_soundwire(struct pci_dev *pci)
533 int snd_intel_dsp_driver_probe(struct pci_dev *pci)
535 const struct config_entry *cfg;
537 /* Intel vendor only */
538 if (pci->vendor != 0x8086)
539 return SND_INTEL_DSP_DRIVER_ANY;
542 * Legacy devices don't have a PCI-based DSP and use HDaudio
543 * for HDMI/DP support, ignore kernel parameter
545 switch (pci->device) {
546 case 0x160c: /* Broadwell */
547 case 0x0a0c: /* Haswell */
550 case 0x0f04: /* Baytrail */
551 case 0x2284: /* Braswell */
552 return SND_INTEL_DSP_DRIVER_ANY;
555 if (dsp_driver > 0 && dsp_driver <= SND_INTEL_DSP_DRIVER_LAST)
559 * detect DSP by checking class/subclass/prog-id information
560 * class=04 subclass 03 prog-if 00: no DSP, use legacy driver
561 * class=04 subclass 01 prog-if 00: DSP is present
562 * (and may be required e.g. for DMIC or SSP support)
563 * class=04 subclass 03 prog-if 80: use DSP or legacy mode
565 if (pci->class == 0x040300)
566 return SND_INTEL_DSP_DRIVER_LEGACY;
567 if (pci->class != 0x040100 && pci->class != 0x040380) {
568 dev_err(&pci->dev, "Unknown PCI class/subclass/prog-if information (0x%06x) found, selecting HDAudio legacy driver\n", pci->class);
569 return SND_INTEL_DSP_DRIVER_LEGACY;
572 dev_info(&pci->dev, "DSP detected with PCI class/subclass/prog-if info 0x%06x\n", pci->class);
574 /* find the configuration for the specific device */
575 cfg = snd_intel_dsp_find_config(pci, config_table, ARRAY_SIZE(config_table));
577 return SND_INTEL_DSP_DRIVER_ANY;
579 if (cfg->flags & FLAG_SOF) {
580 if (cfg->flags & FLAG_SOF_ONLY_IF_SOUNDWIRE &&
581 snd_intel_dsp_check_soundwire(pci) > 0) {
582 dev_info(&pci->dev, "SoundWire enabled on CannonLake+ platform, using SOF driver\n");
583 return SND_INTEL_DSP_DRIVER_SOF;
585 if (cfg->flags & FLAG_SOF_ONLY_IF_DMIC &&
586 snd_intel_dsp_check_dmic(pci)) {
587 dev_info(&pci->dev, "Digital mics found on Skylake+ platform, using SOF driver\n");
588 return SND_INTEL_DSP_DRIVER_SOF;
590 if (!(cfg->flags & FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE))
591 return SND_INTEL_DSP_DRIVER_SOF;
595 if (cfg->flags & FLAG_SST) {
596 if (cfg->flags & FLAG_SST_ONLY_IF_DMIC) {
597 if (snd_intel_dsp_check_dmic(pci)) {
598 dev_info(&pci->dev, "Digital mics found on Skylake+ platform, using SST driver\n");
599 return SND_INTEL_DSP_DRIVER_SST;
602 return SND_INTEL_DSP_DRIVER_SST;
606 return SND_INTEL_DSP_DRIVER_LEGACY;
608 EXPORT_SYMBOL_GPL(snd_intel_dsp_driver_probe);
610 /* Should we default to SOF or SST for BYT/CHT ? */
611 #if IS_ENABLED(CONFIG_SND_INTEL_BYT_PREFER_SOF) || \
612 !IS_ENABLED(CONFIG_SND_SST_ATOM_HIFI2_PLATFORM_ACPI)
613 #define FLAG_SST_OR_SOF_BYT FLAG_SOF
615 #define FLAG_SST_OR_SOF_BYT FLAG_SST
619 * configuration table
620 * - the order of similar ACPI ID entries is important!
621 * - the first successful match will win
623 static const struct config_entry acpi_config_table[] = {
624 #if IS_ENABLED(CONFIG_SND_SST_ATOM_HIFI2_PLATFORM_ACPI) || \
625 IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
628 .flags = FLAG_SST_OR_SOF_BYT,
629 .acpi_hid = "80860F28",
633 .flags = FLAG_SST_OR_SOF_BYT,
634 .acpi_hid = "808622A8",
638 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_CATPT)
641 .acpi_hid = "INT3438"
644 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
647 .acpi_hid = "INT3438"
650 /* Haswell - not supported by SOF but added for consistency */
651 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_CATPT)
654 .acpi_hid = "INT33C8"
659 static const struct config_entry *snd_intel_acpi_dsp_find_config(const u8 acpi_hid[ACPI_ID_LEN],
660 const struct config_entry *table,
663 for (; len > 0; len--, table++) {
664 if (memcmp(table->acpi_hid, acpi_hid, ACPI_ID_LEN))
666 if (table->dmi_table && !dmi_check_system(table->dmi_table))
673 int snd_intel_acpi_dsp_driver_probe(struct device *dev, const u8 acpi_hid[ACPI_ID_LEN])
675 const struct config_entry *cfg;
677 if (dsp_driver > SND_INTEL_DSP_DRIVER_LEGACY && dsp_driver <= SND_INTEL_DSP_DRIVER_LAST)
680 if (dsp_driver == SND_INTEL_DSP_DRIVER_LEGACY) {
681 dev_warn(dev, "dsp_driver parameter %d not supported, using automatic detection\n",
682 SND_INTEL_DSP_DRIVER_LEGACY);
685 /* find the configuration for the specific device */
686 cfg = snd_intel_acpi_dsp_find_config(acpi_hid, acpi_config_table,
687 ARRAY_SIZE(acpi_config_table));
689 return SND_INTEL_DSP_DRIVER_ANY;
691 if (cfg->flags & FLAG_SST)
692 return SND_INTEL_DSP_DRIVER_SST;
694 if (cfg->flags & FLAG_SOF)
695 return SND_INTEL_DSP_DRIVER_SOF;
697 return SND_INTEL_DSP_DRIVER_SST;
699 EXPORT_SYMBOL_GPL(snd_intel_acpi_dsp_driver_probe);
701 MODULE_LICENSE("GPL v2");
702 MODULE_DESCRIPTION("Intel DSP config driver");
703 MODULE_IMPORT_NS(SND_INTEL_SOUNDWIRE_ACPI);