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>
15 static int dsp_driver;
17 module_param(dsp_driver, int, 0444);
18 MODULE_PARM_DESC(dsp_driver, "Force the DSP driver for Intel DSP (0=auto, 1=legacy, 2=SST, 3=SOF)");
20 #define FLAG_SST BIT(0)
21 #define FLAG_SOF BIT(1)
22 #define FLAG_SST_ONLY_IF_DMIC BIT(15)
23 #define FLAG_SOF_ONLY_IF_DMIC BIT(16)
24 #define FLAG_SOF_ONLY_IF_SOUNDWIRE BIT(17)
26 #define FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE (FLAG_SOF_ONLY_IF_DMIC | \
27 FLAG_SOF_ONLY_IF_SOUNDWIRE)
32 u8 acpi_hid[ACPI_ID_LEN];
33 const struct dmi_system_id *dmi_table;
38 * - the order of similar PCI ID entries is important!
39 * - the first successful match will win
41 static const struct config_entry config_table[] = {
43 #if IS_ENABLED(CONFIG_SND_SOC_SOF_MERRIFIELD)
50 #if IS_ENABLED(CONFIG_SND_SOC_SOF_APOLLOLAKE)
57 * Apollolake (Broxton-P)
58 * the legacy HDAudio driver is used except on Up Squared (SOF) and
61 #if IS_ENABLED(CONFIG_SND_SOC_SOF_APOLLOLAKE)
65 .dmi_table = (const struct dmi_system_id []) {
67 .ident = "Up Squared",
69 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
70 DMI_MATCH(DMI_BOARD_NAME, "UP-APL01"),
77 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_APL)
81 .dmi_table = (const struct dmi_system_id []) {
83 .ident = "Google Chromebooks",
85 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
93 * Skylake and Kabylake use legacy HDAudio driver except for Google
97 /* Sunrise Point-LP */
98 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_SKL)
102 .dmi_table = (const struct dmi_system_id []) {
104 .ident = "Google Chromebooks",
106 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
113 .flags = FLAG_SST | FLAG_SST_ONLY_IF_DMIC,
118 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_KBL)
122 .dmi_table = (const struct dmi_system_id []) {
124 .ident = "Google Chromebooks",
126 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
133 .flags = FLAG_SST | FLAG_SST_ONLY_IF_DMIC,
139 * Geminilake uses legacy HDAudio driver except for Google
143 #if IS_ENABLED(CONFIG_SND_SOC_SOF_GEMINILAKE)
147 .dmi_table = (const struct dmi_system_id []) {
149 .ident = "Google Chromebooks",
151 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
160 * CoffeeLake, CannonLake, CometLake, IceLake, TigerLake use legacy
161 * HDAudio driver except for Google Chromebooks and when DMICs are
162 * present. Two cases are required since Coreboot does not expose NHLT
165 * When the Chromebook quirk is not present, it's based on information
166 * that no such device exists. When the quirk is present, it could be
167 * either based on product information or a placeholder.
171 #if IS_ENABLED(CONFIG_SND_SOC_SOF_CANNONLAKE)
175 .dmi_table = (const struct dmi_system_id []) {
177 .ident = "Google Chromebooks",
179 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
186 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
192 #if IS_ENABLED(CONFIG_SND_SOC_SOF_COFFEELAKE)
196 .dmi_table = (const struct dmi_system_id []) {
198 .ident = "Google Chromebooks",
200 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
207 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
212 #if IS_ENABLED(CONFIG_SND_SOC_SOF_COMETLAKE)
217 .dmi_table = (const struct dmi_system_id []) {
219 .ident = "Google Chromebooks",
221 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
226 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
227 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "09C6")
231 /* early version of SKU 09C6 */
233 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
234 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "0983")
241 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
248 .dmi_table = (const struct dmi_system_id []) {
251 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
252 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "098F"),
257 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc"),
258 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "0990"),
265 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
271 #if IS_ENABLED(CONFIG_SND_SOC_SOF_ICELAKE)
275 .dmi_table = (const struct dmi_system_id []) {
277 .ident = "Google Chromebooks",
279 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
286 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
292 #if IS_ENABLED(CONFIG_SND_SOC_SOF_TIGERLAKE)
296 .dmi_table = (const struct dmi_system_id []) {
298 .ident = "Google Chromebooks",
300 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
307 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
311 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
317 #if IS_ENABLED(CONFIG_SND_SOC_SOF_ELKHARTLAKE)
319 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC,
325 #if IS_ENABLED(CONFIG_SND_SOC_SOF_ALDERLAKE)
327 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
331 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
335 .flags = FLAG_SOF | FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE,
342 static const struct config_entry *snd_intel_dsp_find_config
343 (struct pci_dev *pci, const struct config_entry *table, u32 len)
347 device = pci->device;
348 for (; len > 0; len--, table++) {
349 if (table->device != device)
351 if (table->dmi_table && !dmi_check_system(table->dmi_table))
358 static int snd_intel_dsp_check_dmic(struct pci_dev *pci)
360 struct nhlt_acpi_table *nhlt;
363 nhlt = intel_nhlt_init(&pci->dev);
365 if (intel_nhlt_get_dmic_geo(&pci->dev, nhlt))
367 intel_nhlt_free(nhlt);
372 #if IS_ENABLED(CONFIG_SND_SOC_SOF_INTEL_SOUNDWIRE)
373 static int snd_intel_dsp_check_soundwire(struct pci_dev *pci)
375 struct sdw_intel_acpi_info info;
379 handle = ACPI_HANDLE(&pci->dev);
381 ret = sdw_intel_acpi_scan(handle, &info);
385 return info.link_mask;
388 static int snd_intel_dsp_check_soundwire(struct pci_dev *pci)
394 int snd_intel_dsp_driver_probe(struct pci_dev *pci)
396 const struct config_entry *cfg;
398 /* Intel vendor only */
399 if (pci->vendor != 0x8086)
400 return SND_INTEL_DSP_DRIVER_ANY;
403 * Legacy devices don't have a PCI-based DSP and use HDaudio
404 * for HDMI/DP support, ignore kernel parameter
406 switch (pci->device) {
407 case 0x160c: /* Broadwell */
408 case 0x0a0c: /* Haswell */
411 case 0x0f04: /* Baytrail */
412 case 0x2284: /* Braswell */
413 return SND_INTEL_DSP_DRIVER_ANY;
416 if (dsp_driver > 0 && dsp_driver <= SND_INTEL_DSP_DRIVER_LAST)
420 * detect DSP by checking class/subclass/prog-id information
421 * class=04 subclass 03 prog-if 00: no DSP, use legacy driver
422 * class=04 subclass 01 prog-if 00: DSP is present
423 * (and may be required e.g. for DMIC or SSP support)
424 * class=04 subclass 03 prog-if 80: use DSP or legacy mode
426 if (pci->class == 0x040300)
427 return SND_INTEL_DSP_DRIVER_LEGACY;
428 if (pci->class != 0x040100 && pci->class != 0x040380) {
429 dev_err(&pci->dev, "Unknown PCI class/subclass/prog-if information (0x%06x) found, selecting HDAudio legacy driver\n", pci->class);
430 return SND_INTEL_DSP_DRIVER_LEGACY;
433 dev_info(&pci->dev, "DSP detected with PCI class/subclass/prog-if info 0x%06x\n", pci->class);
435 /* find the configuration for the specific device */
436 cfg = snd_intel_dsp_find_config(pci, config_table, ARRAY_SIZE(config_table));
438 return SND_INTEL_DSP_DRIVER_ANY;
440 if (cfg->flags & FLAG_SOF) {
441 if (cfg->flags & FLAG_SOF_ONLY_IF_SOUNDWIRE &&
442 snd_intel_dsp_check_soundwire(pci) > 0) {
443 dev_info(&pci->dev, "SoundWire enabled on CannonLake+ platform, using SOF driver\n");
444 return SND_INTEL_DSP_DRIVER_SOF;
446 if (cfg->flags & FLAG_SOF_ONLY_IF_DMIC &&
447 snd_intel_dsp_check_dmic(pci)) {
448 dev_info(&pci->dev, "Digital mics found on Skylake+ platform, using SOF driver\n");
449 return SND_INTEL_DSP_DRIVER_SOF;
451 if (!(cfg->flags & FLAG_SOF_ONLY_IF_DMIC_OR_SOUNDWIRE))
452 return SND_INTEL_DSP_DRIVER_SOF;
456 if (cfg->flags & FLAG_SST) {
457 if (cfg->flags & FLAG_SST_ONLY_IF_DMIC) {
458 if (snd_intel_dsp_check_dmic(pci)) {
459 dev_info(&pci->dev, "Digital mics found on Skylake+ platform, using SST driver\n");
460 return SND_INTEL_DSP_DRIVER_SST;
463 return SND_INTEL_DSP_DRIVER_SST;
467 return SND_INTEL_DSP_DRIVER_LEGACY;
469 EXPORT_SYMBOL_GPL(snd_intel_dsp_driver_probe);
471 /* Should we default to SOF or SST for BYT/CHT ? */
472 #if IS_ENABLED(CONFIG_SND_INTEL_BYT_PREFER_SOF) || \
473 !IS_ENABLED(CONFIG_SND_SST_ATOM_HIFI2_PLATFORM_ACPI)
474 #define FLAG_SST_OR_SOF_BYT FLAG_SOF
476 #define FLAG_SST_OR_SOF_BYT FLAG_SST
480 * configuration table
481 * - the order of similar ACPI ID entries is important!
482 * - the first successful match will win
484 static const struct config_entry acpi_config_table[] = {
485 #if IS_ENABLED(CONFIG_SND_SST_ATOM_HIFI2_PLATFORM_ACPI) || \
486 IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
489 .flags = FLAG_SST_OR_SOF_BYT,
490 .acpi_hid = "80860F28",
494 .flags = FLAG_SST_OR_SOF_BYT,
495 .acpi_hid = "808622A8",
499 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_CATPT)
502 .acpi_hid = "INT3438"
505 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
508 .acpi_hid = "INT3438"
511 /* Haswell - not supported by SOF but added for consistency */
512 #if IS_ENABLED(CONFIG_SND_SOC_INTEL_CATPT)
515 .acpi_hid = "INT33C8"
520 static const struct config_entry *snd_intel_acpi_dsp_find_config(const u8 acpi_hid[ACPI_ID_LEN],
521 const struct config_entry *table,
524 for (; len > 0; len--, table++) {
525 if (memcmp(table->acpi_hid, acpi_hid, ACPI_ID_LEN))
527 if (table->dmi_table && !dmi_check_system(table->dmi_table))
534 int snd_intel_acpi_dsp_driver_probe(struct device *dev, const u8 acpi_hid[ACPI_ID_LEN])
536 const struct config_entry *cfg;
538 if (dsp_driver > SND_INTEL_DSP_DRIVER_LEGACY && dsp_driver <= SND_INTEL_DSP_DRIVER_LAST)
541 if (dsp_driver == SND_INTEL_DSP_DRIVER_LEGACY) {
542 dev_warn(dev, "dsp_driver parameter %d not supported, using automatic detection\n",
543 SND_INTEL_DSP_DRIVER_LEGACY);
546 /* find the configuration for the specific device */
547 cfg = snd_intel_acpi_dsp_find_config(acpi_hid, acpi_config_table,
548 ARRAY_SIZE(acpi_config_table));
550 return SND_INTEL_DSP_DRIVER_ANY;
552 if (cfg->flags & FLAG_SST)
553 return SND_INTEL_DSP_DRIVER_SST;
555 if (cfg->flags & FLAG_SOF)
556 return SND_INTEL_DSP_DRIVER_SOF;
558 return SND_INTEL_DSP_DRIVER_SST;
560 EXPORT_SYMBOL_GPL(snd_intel_acpi_dsp_driver_probe);
562 MODULE_LICENSE("GPL v2");
563 MODULE_DESCRIPTION("Intel DSP config driver");
564 MODULE_IMPORT_NS(SND_INTEL_SOUNDWIRE_ACPI);