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/platform_data/x86/soc.h>
16 #include <linux/pm_runtime.h>
17 #include <sound/soc-acpi.h>
18 #include <sound/soc-acpi-intel-match.h>
19 #include <sound/sof.h>
20 #include "ops.h"
21 #include "sof-pci-dev.h"
22
23 static char *fw_path;
24 module_param(fw_path, charp, 0444);
25 MODULE_PARM_DESC(fw_path, "alternate path for SOF firmware.");
26
27 static char *fw_filename;
28 module_param(fw_filename, charp, 0444);
29 MODULE_PARM_DESC(fw_filename, "alternate filename for SOF firmware.");
30
31 static char *tplg_path;
32 module_param(tplg_path, charp, 0444);
33 MODULE_PARM_DESC(tplg_path, "alternate path for SOF topology.");
34
35 static char *tplg_filename;
36 module_param(tplg_filename, charp, 0444);
37 MODULE_PARM_DESC(tplg_filename, "alternate filename for SOF topology.");
38
39 static int sof_pci_debug;
40 module_param_named(sof_pci_debug, sof_pci_debug, int, 0444);
41 MODULE_PARM_DESC(sof_pci_debug, "SOF PCI debug options (0x0 all off)");
42
43 static int sof_pci_ipc_type = -1;
44 module_param_named(ipc_type, sof_pci_ipc_type, int, 0444);
45 MODULE_PARM_DESC(ipc_type, "SOF IPC type (0): SOF, (1) Intel CAVS");
46
47 static const char *sof_dmi_override_tplg_name;
48 static bool sof_dmi_use_community_key;
49
50 #define SOF_PCI_DISABLE_PM_RUNTIME BIT(0)
51
sof_tplg_cb(const struct dmi_system_id * id)52 static int sof_tplg_cb(const struct dmi_system_id *id)
53 {
54 sof_dmi_override_tplg_name = id->driver_data;
55 return 1;
56 }
57
58 static const struct dmi_system_id sof_tplg_table[] = {
59 {
60 .callback = sof_tplg_cb,
61 .matches = {
62 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Volteer"),
63 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98373_ALC5682I_I2S_UP4"),
64 },
65 .driver_data = "sof-tgl-rt5682-ssp0-max98373-ssp2.tplg",
66 },
67 {
68 .callback = sof_tplg_cb,
69 .matches = {
70 DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
71 DMI_MATCH(DMI_PRODUCT_NAME, "Alder Lake Client Platform"),
72 DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98373_ALC5682I_I2S"),
73 },
74 .driver_data = "sof-adl-rt5682-ssp0-max98373-ssp2.tplg",
75 },
76 {
77 .callback = sof_tplg_cb,
78 .matches = {
79 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
80 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98390_ALC5682I_I2S"),
81 },
82 .driver_data = "sof-adl-max98390-ssp2-rt5682-ssp0.tplg",
83 },
84 {
85 .callback = sof_tplg_cb,
86 .matches = {
87 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
88 DMI_MATCH(DMI_OEM_STRING, "AUDIO_AMP-MAX98360_ALC5682VS_I2S_2WAY"),
89 },
90 .driver_data = "sof-adl-max98360a-rt5682-2way.tplg",
91 },
92 {
93 .callback = sof_tplg_cb,
94 .matches = {
95 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
96 DMI_MATCH(DMI_OEM_STRING, "AUDIO-AUDIO_MAX98357_ALC5682I_I2S_2WAY"),
97 },
98 .driver_data = "sof-adl-max98357a-rt5682-2way.tplg",
99 },
100 {
101 .callback = sof_tplg_cb,
102 .matches = {
103 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
104 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98360_ALC5682I_I2S_AMP_SSP2"),
105 },
106 .driver_data = "sof-adl-max98357a-rt5682.tplg",
107 },
108 {}
109 };
110
111 /* all Up boards use the community key */
up_use_community_key(const struct dmi_system_id * id)112 static int up_use_community_key(const struct dmi_system_id *id)
113 {
114 sof_dmi_use_community_key = true;
115 return 1;
116 }
117
118 /*
119 * For ApolloLake Chromebooks we want to force the use of the Intel production key.
120 * All newer platforms use the community key
121 */
chromebook_use_community_key(const struct dmi_system_id * id)122 static int chromebook_use_community_key(const struct dmi_system_id *id)
123 {
124 if (!soc_intel_is_apl())
125 sof_dmi_use_community_key = true;
126 return 1;
127 }
128
129 static const struct dmi_system_id community_key_platforms[] = {
130 {
131 .ident = "Up boards",
132 .callback = up_use_community_key,
133 .matches = {
134 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
135 }
136 },
137 {
138 .ident = "Google Chromebooks",
139 .callback = chromebook_use_community_key,
140 .matches = {
141 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google"),
142 }
143 },
144 {
145 .ident = "Google firmware",
146 .callback = chromebook_use_community_key,
147 .matches = {
148 DMI_MATCH(DMI_BIOS_VERSION, "Google"),
149 }
150 },
151 {},
152 };
153
154 const struct dev_pm_ops sof_pci_pm = {
155 .prepare = snd_sof_prepare,
156 .complete = snd_sof_complete,
157 SET_SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume)
158 SET_RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume,
159 snd_sof_runtime_idle)
160 };
161 EXPORT_SYMBOL_NS(sof_pci_pm, SND_SOC_SOF_PCI_DEV);
162
sof_pci_probe_complete(struct device * dev)163 static void sof_pci_probe_complete(struct device *dev)
164 {
165 dev_dbg(dev, "Completing SOF PCI probe");
166
167 if (sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME)
168 return;
169
170 /* allow runtime_pm */
171 pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS);
172 pm_runtime_use_autosuspend(dev);
173
174 /*
175 * runtime pm for pci device is "forbidden" by default.
176 * so call pm_runtime_allow() to enable it.
177 */
178 pm_runtime_allow(dev);
179
180 /* mark last_busy for pm_runtime to make sure not suspend immediately */
181 pm_runtime_mark_last_busy(dev);
182
183 /* follow recommendation in pci-driver.c to decrement usage counter */
184 pm_runtime_put_noidle(dev);
185 }
186
sof_pci_probe(struct pci_dev * pci,const struct pci_device_id * pci_id)187 int sof_pci_probe(struct pci_dev *pci, const struct pci_device_id *pci_id)
188 {
189 struct device *dev = &pci->dev;
190 const struct sof_dev_desc *desc =
191 (const struct sof_dev_desc *)pci_id->driver_data;
192 struct snd_sof_pdata *sof_pdata;
193 int ret;
194
195 dev_dbg(&pci->dev, "PCI DSP detected");
196
197 if (!desc) {
198 dev_err(dev, "error: no matching PCI descriptor\n");
199 return -ENODEV;
200 }
201
202 if (!desc->ops) {
203 dev_err(dev, "error: no matching PCI descriptor ops\n");
204 return -ENODEV;
205 }
206
207 sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL);
208 if (!sof_pdata)
209 return -ENOMEM;
210
211 ret = pcim_enable_device(pci);
212 if (ret < 0)
213 return ret;
214
215 ret = pci_request_regions(pci, "Audio DSP");
216 if (ret < 0)
217 return ret;
218
219 sof_pdata->name = pci_name(pci);
220
221 /* PCI defines a vendor ID of 0xFFFF as invalid. */
222 if (pci->subsystem_vendor != 0xFFFF) {
223 sof_pdata->subsystem_vendor = pci->subsystem_vendor;
224 sof_pdata->subsystem_device = pci->subsystem_device;
225 sof_pdata->subsystem_id_set = true;
226 }
227
228 sof_pdata->desc = desc;
229 sof_pdata->dev = dev;
230
231 sof_pdata->ipc_type = desc->ipc_default;
232
233 if (sof_pci_ipc_type < 0) {
234 sof_pdata->ipc_type = desc->ipc_default;
235 } else {
236 dev_info(dev, "overriding default IPC %d to requested %d\n",
237 desc->ipc_default, sof_pci_ipc_type);
238 if (sof_pci_ipc_type >= SOF_IPC_TYPE_COUNT) {
239 dev_err(dev, "invalid request value %d\n", sof_pci_ipc_type);
240 ret = -EINVAL;
241 goto out;
242 }
243 if (!(BIT(sof_pci_ipc_type) & desc->ipc_supported_mask)) {
244 dev_err(dev, "invalid request value %d, supported mask is %#x\n",
245 sof_pci_ipc_type, desc->ipc_supported_mask);
246 ret = -EINVAL;
247 goto out;
248 }
249 sof_pdata->ipc_type = sof_pci_ipc_type;
250 }
251
252 if (fw_filename) {
253 sof_pdata->fw_filename = fw_filename;
254
255 dev_dbg(dev, "Module parameter used, changed fw filename to %s\n",
256 sof_pdata->fw_filename);
257 } else {
258 sof_pdata->fw_filename = desc->default_fw_filename[sof_pdata->ipc_type];
259 }
260
261 /*
262 * for platforms using the SOF community key, change the
263 * default path automatically to pick the right files from the
264 * linux-firmware tree. This can be overridden with the
265 * fw_path kernel parameter, e.g. for developers.
266 */
267
268 /* alternate fw and tplg filenames ? */
269 if (fw_path) {
270 sof_pdata->fw_filename_prefix = fw_path;
271
272 dev_dbg(dev,
273 "Module parameter used, changed fw path to %s\n",
274 sof_pdata->fw_filename_prefix);
275
276 } else if (dmi_check_system(community_key_platforms) && sof_dmi_use_community_key) {
277 sof_pdata->fw_filename_prefix =
278 devm_kasprintf(dev, GFP_KERNEL, "%s/%s",
279 sof_pdata->desc->default_fw_path[sof_pdata->ipc_type],
280 "community");
281
282 dev_dbg(dev,
283 "Platform uses community key, changed fw path to %s\n",
284 sof_pdata->fw_filename_prefix);
285 } else {
286 sof_pdata->fw_filename_prefix =
287 sof_pdata->desc->default_fw_path[sof_pdata->ipc_type];
288 }
289
290 if (tplg_path)
291 sof_pdata->tplg_filename_prefix = tplg_path;
292 else
293 sof_pdata->tplg_filename_prefix =
294 sof_pdata->desc->default_tplg_path[sof_pdata->ipc_type];
295
296 /*
297 * the topology filename will be provided in the machine descriptor, unless
298 * it is overridden by a module parameter or DMI quirk.
299 */
300 if (tplg_filename) {
301 sof_pdata->tplg_filename = tplg_filename;
302
303 dev_dbg(dev, "Module parameter used, changed tplg filename to %s\n",
304 sof_pdata->tplg_filename);
305 } else {
306 dmi_check_system(sof_tplg_table);
307 if (sof_dmi_override_tplg_name)
308 sof_pdata->tplg_filename = sof_dmi_override_tplg_name;
309 }
310
311 /* set callback to be called on successful device probe to enable runtime_pm */
312 sof_pdata->sof_probe_complete = sof_pci_probe_complete;
313
314 /* call sof helper for DSP hardware probe */
315 ret = snd_sof_device_probe(dev, sof_pdata);
316
317 out:
318 if (ret)
319 pci_release_regions(pci);
320
321 return ret;
322 }
323 EXPORT_SYMBOL_NS(sof_pci_probe, SND_SOC_SOF_PCI_DEV);
324
sof_pci_remove(struct pci_dev * pci)325 void sof_pci_remove(struct pci_dev *pci)
326 {
327 /* call sof helper for DSP hardware remove */
328 snd_sof_device_remove(&pci->dev);
329
330 /* follow recommendation in pci-driver.c to increment usage counter */
331 if (snd_sof_device_probe_completed(&pci->dev) &&
332 !(sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME))
333 pm_runtime_get_noresume(&pci->dev);
334
335 /* release pci regions and disable device */
336 pci_release_regions(pci);
337 }
338 EXPORT_SYMBOL_NS(sof_pci_remove, SND_SOC_SOF_PCI_DEV);
339
sof_pci_shutdown(struct pci_dev * pci)340 void sof_pci_shutdown(struct pci_dev *pci)
341 {
342 snd_sof_device_shutdown(&pci->dev);
343 }
344 EXPORT_SYMBOL_NS(sof_pci_shutdown, SND_SOC_SOF_PCI_DEV);
345
346 MODULE_LICENSE("Dual BSD/GPL");
347