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 {} 72 }; 73 74 static const struct dmi_system_id community_key_platforms[] = { 75 { 76 .ident = "Up boards", 77 .matches = { 78 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"), 79 } 80 }, 81 { 82 .ident = "Google Chromebooks", 83 .matches = { 84 DMI_MATCH(DMI_SYS_VENDOR, "Google"), 85 } 86 }, 87 {}, 88 }; 89 90 const struct dev_pm_ops sof_pci_pm = { 91 .prepare = snd_sof_prepare, 92 .complete = snd_sof_complete, 93 SET_SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume) 94 SET_RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume, 95 snd_sof_runtime_idle) 96 }; 97 EXPORT_SYMBOL_NS(sof_pci_pm, SND_SOC_SOF_PCI_DEV); 98 99 static void sof_pci_probe_complete(struct device *dev) 100 { 101 dev_dbg(dev, "Completing SOF PCI probe"); 102 103 if (sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME) 104 return; 105 106 /* allow runtime_pm */ 107 pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS); 108 pm_runtime_use_autosuspend(dev); 109 110 /* 111 * runtime pm for pci device is "forbidden" by default. 112 * so call pm_runtime_allow() to enable it. 113 */ 114 pm_runtime_allow(dev); 115 116 /* mark last_busy for pm_runtime to make sure not suspend immediately */ 117 pm_runtime_mark_last_busy(dev); 118 119 /* follow recommendation in pci-driver.c to decrement usage counter */ 120 pm_runtime_put_noidle(dev); 121 } 122 123 int sof_pci_probe(struct pci_dev *pci, const struct pci_device_id *pci_id) 124 { 125 struct device *dev = &pci->dev; 126 const struct sof_dev_desc *desc = 127 (const struct sof_dev_desc *)pci_id->driver_data; 128 struct snd_sof_pdata *sof_pdata; 129 int ret; 130 131 dev_dbg(&pci->dev, "PCI DSP detected"); 132 133 if (!desc->ops) { 134 dev_err(dev, "error: no matching PCI descriptor ops\n"); 135 return -ENODEV; 136 } 137 138 sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL); 139 if (!sof_pdata) 140 return -ENOMEM; 141 142 ret = pcim_enable_device(pci); 143 if (ret < 0) 144 return ret; 145 146 ret = pci_request_regions(pci, "Audio DSP"); 147 if (ret < 0) 148 return ret; 149 150 sof_pdata->name = pci_name(pci); 151 sof_pdata->desc = desc; 152 sof_pdata->dev = dev; 153 sof_pdata->fw_filename = desc->default_fw_filename; 154 155 /* 156 * for platforms using the SOF community key, change the 157 * default path automatically to pick the right files from the 158 * linux-firmware tree. This can be overridden with the 159 * fw_path kernel parameter, e.g. for developers. 160 */ 161 162 /* alternate fw and tplg filenames ? */ 163 if (fw_path) { 164 sof_pdata->fw_filename_prefix = fw_path; 165 166 dev_dbg(dev, 167 "Module parameter used, changed fw path to %s\n", 168 sof_pdata->fw_filename_prefix); 169 170 } else if (dmi_check_system(community_key_platforms)) { 171 sof_pdata->fw_filename_prefix = 172 devm_kasprintf(dev, GFP_KERNEL, "%s/%s", 173 sof_pdata->desc->default_fw_path, 174 "community"); 175 176 dev_dbg(dev, 177 "Platform uses community key, changed fw path to %s\n", 178 sof_pdata->fw_filename_prefix); 179 } else { 180 sof_pdata->fw_filename_prefix = 181 sof_pdata->desc->default_fw_path; 182 } 183 184 if (tplg_path) 185 sof_pdata->tplg_filename_prefix = tplg_path; 186 else 187 sof_pdata->tplg_filename_prefix = 188 sof_pdata->desc->default_tplg_path; 189 190 dmi_check_system(sof_tplg_table); 191 if (sof_override_tplg_name) 192 sof_pdata->tplg_filename = sof_override_tplg_name; 193 194 /* set callback to be called on successful device probe to enable runtime_pm */ 195 sof_pdata->sof_probe_complete = sof_pci_probe_complete; 196 197 /* call sof helper for DSP hardware probe */ 198 ret = snd_sof_device_probe(dev, sof_pdata); 199 if (ret) 200 pci_release_regions(pci); 201 202 return ret; 203 } 204 EXPORT_SYMBOL_NS(sof_pci_probe, SND_SOC_SOF_PCI_DEV); 205 206 void sof_pci_remove(struct pci_dev *pci) 207 { 208 /* call sof helper for DSP hardware remove */ 209 snd_sof_device_remove(&pci->dev); 210 211 /* follow recommendation in pci-driver.c to increment usage counter */ 212 if (snd_sof_device_probe_completed(&pci->dev) && 213 !(sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME)) 214 pm_runtime_get_noresume(&pci->dev); 215 216 /* release pci regions and disable device */ 217 pci_release_regions(pci); 218 } 219 EXPORT_SYMBOL_NS(sof_pci_remove, SND_SOC_SOF_PCI_DEV); 220 221 void sof_pci_shutdown(struct pci_dev *pci) 222 { 223 snd_sof_device_shutdown(&pci->dev); 224 } 225 EXPORT_SYMBOL_NS(sof_pci_shutdown, SND_SOC_SOF_PCI_DEV); 226 227 MODULE_LICENSE("Dual BSD/GPL"); 228