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