1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) 2 // 3 // This file is provided under a dual BSD/GPLv2 license. When using or 4 // redistributing this file, you may do so under either license. 5 // 6 // Copyright(c) 2018 Intel Corporation. All rights reserved. 7 // 8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com> 9 // 10 11 #include <linux/firmware.h> 12 #include <linux/dmi.h> 13 #include <linux/module.h> 14 #include <linux/pci.h> 15 #include <linux/pm_runtime.h> 16 #include <sound/soc-acpi.h> 17 #include <sound/soc-acpi-intel-match.h> 18 #include <sound/sof.h> 19 #include "ops.h" 20 #include "sof-pci-dev.h" 21 22 static char *fw_path; 23 module_param(fw_path, charp, 0444); 24 MODULE_PARM_DESC(fw_path, "alternate path for SOF firmware."); 25 26 static char *tplg_path; 27 module_param(tplg_path, charp, 0444); 28 MODULE_PARM_DESC(tplg_path, "alternate path for SOF topology."); 29 30 static int sof_pci_debug; 31 module_param_named(sof_pci_debug, sof_pci_debug, int, 0444); 32 MODULE_PARM_DESC(sof_pci_debug, "SOF PCI debug options (0x0 all off)"); 33 34 static const char *sof_override_tplg_name; 35 36 #define SOF_PCI_DISABLE_PM_RUNTIME BIT(0) 37 38 static int sof_tplg_cb(const struct dmi_system_id *id) 39 { 40 sof_override_tplg_name = id->driver_data; 41 return 1; 42 } 43 44 static const struct dmi_system_id sof_tplg_table[] = { 45 { 46 .callback = sof_tplg_cb, 47 .matches = { 48 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Volteer"), 49 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98373_ALC5682I_I2S_UP4"), 50 }, 51 .driver_data = "sof-tgl-rt5682-ssp0-max98373-ssp2.tplg", 52 }, 53 { 54 .callback = sof_tplg_cb, 55 .matches = { 56 DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"), 57 DMI_MATCH(DMI_PRODUCT_NAME, "Alder Lake Client Platform"), 58 DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98373_ALC5682I_I2S"), 59 }, 60 .driver_data = "sof-adl-rt5682-ssp0-max98373-ssp2.tplg", 61 }, 62 { 63 .callback = sof_tplg_cb, 64 .matches = { 65 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"), 66 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98390_ALC5682I_I2S"), 67 }, 68 .driver_data = "sof-adl-max98390-ssp2-rt5682-ssp0.tplg", 69 }, 70 { 71 .callback = sof_tplg_cb, 72 .matches = { 73 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"), 74 DMI_MATCH(DMI_OEM_STRING, "AUDIO_AMP-MAX98360_ALC5682VS_I2S_2WAY"), 75 }, 76 .driver_data = "sof-adl-max98360a-rt5682-2way.tplg", 77 }, 78 { 79 .callback = sof_tplg_cb, 80 .matches = { 81 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"), 82 DMI_MATCH(DMI_OEM_STRING, "AUDIO-AUDIO_MAX98357_ALC5682I_I2S_2WAY"), 83 }, 84 .driver_data = "sof-adl-max98357a-rt5682-2way.tplg", 85 }, 86 87 {} 88 }; 89 90 static const struct dmi_system_id community_key_platforms[] = { 91 { 92 .ident = "Up boards", 93 .matches = { 94 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"), 95 } 96 }, 97 { 98 .ident = "Google Chromebooks", 99 .matches = { 100 DMI_MATCH(DMI_SYS_VENDOR, "Google"), 101 } 102 }, 103 {}, 104 }; 105 106 const struct dev_pm_ops sof_pci_pm = { 107 .prepare = snd_sof_prepare, 108 .complete = snd_sof_complete, 109 SET_SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume) 110 SET_RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume, 111 snd_sof_runtime_idle) 112 }; 113 EXPORT_SYMBOL_NS(sof_pci_pm, SND_SOC_SOF_PCI_DEV); 114 115 static void sof_pci_probe_complete(struct device *dev) 116 { 117 dev_dbg(dev, "Completing SOF PCI probe"); 118 119 if (sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME) 120 return; 121 122 /* allow runtime_pm */ 123 pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS); 124 pm_runtime_use_autosuspend(dev); 125 126 /* 127 * runtime pm for pci device is "forbidden" by default. 128 * so call pm_runtime_allow() to enable it. 129 */ 130 pm_runtime_allow(dev); 131 132 /* mark last_busy for pm_runtime to make sure not suspend immediately */ 133 pm_runtime_mark_last_busy(dev); 134 135 /* follow recommendation in pci-driver.c to decrement usage counter */ 136 pm_runtime_put_noidle(dev); 137 } 138 139 int sof_pci_probe(struct pci_dev *pci, const struct pci_device_id *pci_id) 140 { 141 struct device *dev = &pci->dev; 142 const struct sof_dev_desc *desc = 143 (const struct sof_dev_desc *)pci_id->driver_data; 144 struct snd_sof_pdata *sof_pdata; 145 int ret; 146 147 dev_dbg(&pci->dev, "PCI DSP detected"); 148 149 if (!desc->ops) { 150 dev_err(dev, "error: no matching PCI descriptor ops\n"); 151 return -ENODEV; 152 } 153 154 sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL); 155 if (!sof_pdata) 156 return -ENOMEM; 157 158 ret = pcim_enable_device(pci); 159 if (ret < 0) 160 return ret; 161 162 ret = pci_request_regions(pci, "Audio DSP"); 163 if (ret < 0) 164 return ret; 165 166 sof_pdata->name = pci_name(pci); 167 sof_pdata->desc = desc; 168 sof_pdata->dev = dev; 169 sof_pdata->fw_filename = desc->default_fw_filename; 170 171 /* 172 * for platforms using the SOF community key, change the 173 * default path automatically to pick the right files from the 174 * linux-firmware tree. This can be overridden with the 175 * fw_path kernel parameter, e.g. for developers. 176 */ 177 178 /* alternate fw and tplg filenames ? */ 179 if (fw_path) { 180 sof_pdata->fw_filename_prefix = fw_path; 181 182 dev_dbg(dev, 183 "Module parameter used, changed fw path to %s\n", 184 sof_pdata->fw_filename_prefix); 185 186 } else if (dmi_check_system(community_key_platforms)) { 187 sof_pdata->fw_filename_prefix = 188 devm_kasprintf(dev, GFP_KERNEL, "%s/%s", 189 sof_pdata->desc->default_fw_path, 190 "community"); 191 192 dev_dbg(dev, 193 "Platform uses community key, changed fw path to %s\n", 194 sof_pdata->fw_filename_prefix); 195 } else { 196 sof_pdata->fw_filename_prefix = 197 sof_pdata->desc->default_fw_path; 198 } 199 200 if (tplg_path) 201 sof_pdata->tplg_filename_prefix = tplg_path; 202 else 203 sof_pdata->tplg_filename_prefix = 204 sof_pdata->desc->default_tplg_path; 205 206 dmi_check_system(sof_tplg_table); 207 if (sof_override_tplg_name) 208 sof_pdata->tplg_filename = sof_override_tplg_name; 209 210 /* set callback to be called on successful device probe to enable runtime_pm */ 211 sof_pdata->sof_probe_complete = sof_pci_probe_complete; 212 213 /* call sof helper for DSP hardware probe */ 214 ret = snd_sof_device_probe(dev, sof_pdata); 215 if (ret) 216 pci_release_regions(pci); 217 218 return ret; 219 } 220 EXPORT_SYMBOL_NS(sof_pci_probe, SND_SOC_SOF_PCI_DEV); 221 222 void sof_pci_remove(struct pci_dev *pci) 223 { 224 /* call sof helper for DSP hardware remove */ 225 snd_sof_device_remove(&pci->dev); 226 227 /* follow recommendation in pci-driver.c to increment usage counter */ 228 if (snd_sof_device_probe_completed(&pci->dev) && 229 !(sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME)) 230 pm_runtime_get_noresume(&pci->dev); 231 232 /* release pci regions and disable device */ 233 pci_release_regions(pci); 234 } 235 EXPORT_SYMBOL_NS(sof_pci_remove, SND_SOC_SOF_PCI_DEV); 236 237 void sof_pci_shutdown(struct pci_dev *pci) 238 { 239 snd_sof_device_shutdown(&pci->dev); 240 } 241 EXPORT_SYMBOL_NS(sof_pci_shutdown, SND_SOC_SOF_PCI_DEV); 242 243 MODULE_LICENSE("Dual BSD/GPL"); 244