Loading...
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/intel-dsp-config.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
22/* platform specific devices */
23#include "intel/shim.h"
24#include "intel/hda.h"
25
26static char *fw_path;
27module_param(fw_path, charp, 0444);
28MODULE_PARM_DESC(fw_path, "alternate path for SOF firmware.");
29
30static char *tplg_path;
31module_param(tplg_path, charp, 0444);
32MODULE_PARM_DESC(tplg_path, "alternate path for SOF topology.");
33
34static int sof_pci_debug;
35module_param_named(sof_pci_debug, sof_pci_debug, int, 0444);
36MODULE_PARM_DESC(sof_pci_debug, "SOF PCI debug options (0x0 all off)");
37
38#define SOF_PCI_DISABLE_PM_RUNTIME BIT(0)
39
40static const struct dmi_system_id community_key_platforms[] = {
41 {
42 .ident = "Up Squared",
43 .matches = {
44 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
45 DMI_MATCH(DMI_BOARD_NAME, "UP-APL01"),
46 }
47 },
48 {
49 .ident = "Google Chromebooks",
50 .matches = {
51 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
52 }
53 },
54 {},
55};
56
57#if IS_ENABLED(CONFIG_SND_SOC_SOF_APOLLOLAKE)
58static const struct sof_dev_desc bxt_desc = {
59 .machines = snd_soc_acpi_intel_bxt_machines,
60 .resindex_lpe_base = 0,
61 .resindex_pcicfg_base = -1,
62 .resindex_imr_base = -1,
63 .irqindex_host_ipc = -1,
64 .resindex_dma_base = -1,
65 .chip_info = &apl_chip_info,
66 .default_fw_path = "intel/sof",
67 .default_tplg_path = "intel/sof-tplg",
68 .default_fw_filename = "sof-apl.ri",
69 .nocodec_tplg_filename = "sof-apl-nocodec.tplg",
70 .ops = &sof_apl_ops,
71};
72#endif
73
74#if IS_ENABLED(CONFIG_SND_SOC_SOF_GEMINILAKE)
75static const struct sof_dev_desc glk_desc = {
76 .machines = snd_soc_acpi_intel_glk_machines,
77 .resindex_lpe_base = 0,
78 .resindex_pcicfg_base = -1,
79 .resindex_imr_base = -1,
80 .irqindex_host_ipc = -1,
81 .resindex_dma_base = -1,
82 .chip_info = &apl_chip_info,
83 .default_fw_path = "intel/sof",
84 .default_tplg_path = "intel/sof-tplg",
85 .default_fw_filename = "sof-glk.ri",
86 .nocodec_tplg_filename = "sof-glk-nocodec.tplg",
87 .ops = &sof_apl_ops,
88};
89#endif
90
91#if IS_ENABLED(CONFIG_SND_SOC_SOF_MERRIFIELD)
92static struct snd_soc_acpi_mach sof_tng_machines[] = {
93 {
94 .id = "INT343A",
95 .drv_name = "edison",
96 .sof_fw_filename = "sof-byt.ri",
97 .sof_tplg_filename = "sof-byt.tplg",
98 },
99 {}
100};
101
102static const struct sof_dev_desc tng_desc = {
103 .machines = sof_tng_machines,
104 .resindex_lpe_base = 3, /* IRAM, but subtract IRAM offset */
105 .resindex_pcicfg_base = -1,
106 .resindex_imr_base = 0,
107 .irqindex_host_ipc = -1,
108 .resindex_dma_base = -1,
109 .chip_info = &tng_chip_info,
110 .default_fw_path = "intel/sof",
111 .default_tplg_path = "intel/sof-tplg",
112 .default_fw_filename = "sof-byt.ri",
113 .nocodec_tplg_filename = "sof-byt.tplg",
114 .ops = &sof_tng_ops,
115};
116#endif
117
118#if IS_ENABLED(CONFIG_SND_SOC_SOF_CANNONLAKE)
119static const struct sof_dev_desc cnl_desc = {
120 .machines = snd_soc_acpi_intel_cnl_machines,
121 .alt_machines = snd_soc_acpi_intel_cnl_sdw_machines,
122 .resindex_lpe_base = 0,
123 .resindex_pcicfg_base = -1,
124 .resindex_imr_base = -1,
125 .irqindex_host_ipc = -1,
126 .resindex_dma_base = -1,
127 .chip_info = &cnl_chip_info,
128 .default_fw_path = "intel/sof",
129 .default_tplg_path = "intel/sof-tplg",
130 .default_fw_filename = "sof-cnl.ri",
131 .nocodec_tplg_filename = "sof-cnl-nocodec.tplg",
132 .ops = &sof_cnl_ops,
133};
134#endif
135
136#if IS_ENABLED(CONFIG_SND_SOC_SOF_COFFEELAKE)
137static const struct sof_dev_desc cfl_desc = {
138 .machines = snd_soc_acpi_intel_cfl_machines,
139 .alt_machines = snd_soc_acpi_intel_cfl_sdw_machines,
140 .resindex_lpe_base = 0,
141 .resindex_pcicfg_base = -1,
142 .resindex_imr_base = -1,
143 .irqindex_host_ipc = -1,
144 .resindex_dma_base = -1,
145 .chip_info = &cnl_chip_info,
146 .default_fw_path = "intel/sof",
147 .default_tplg_path = "intel/sof-tplg",
148 .default_fw_filename = "sof-cfl.ri",
149 .nocodec_tplg_filename = "sof-cnl-nocodec.tplg",
150 .ops = &sof_cnl_ops,
151};
152#endif
153
154#if IS_ENABLED(CONFIG_SND_SOC_SOF_COMETLAKE)
155static const struct sof_dev_desc cml_desc = {
156 .machines = snd_soc_acpi_intel_cml_machines,
157 .alt_machines = snd_soc_acpi_intel_cml_sdw_machines,
158 .resindex_lpe_base = 0,
159 .resindex_pcicfg_base = -1,
160 .resindex_imr_base = -1,
161 .irqindex_host_ipc = -1,
162 .resindex_dma_base = -1,
163 .chip_info = &cnl_chip_info,
164 .default_fw_path = "intel/sof",
165 .default_tplg_path = "intel/sof-tplg",
166 .default_fw_filename = "sof-cml.ri",
167 .nocodec_tplg_filename = "sof-cnl-nocodec.tplg",
168 .ops = &sof_cnl_ops,
169};
170#endif
171
172#if IS_ENABLED(CONFIG_SND_SOC_SOF_ICELAKE)
173static const struct sof_dev_desc icl_desc = {
174 .machines = snd_soc_acpi_intel_icl_machines,
175 .alt_machines = snd_soc_acpi_intel_icl_sdw_machines,
176 .resindex_lpe_base = 0,
177 .resindex_pcicfg_base = -1,
178 .resindex_imr_base = -1,
179 .irqindex_host_ipc = -1,
180 .resindex_dma_base = -1,
181 .chip_info = &icl_chip_info,
182 .default_fw_path = "intel/sof",
183 .default_tplg_path = "intel/sof-tplg",
184 .default_fw_filename = "sof-icl.ri",
185 .nocodec_tplg_filename = "sof-icl-nocodec.tplg",
186 .ops = &sof_cnl_ops,
187};
188#endif
189
190#if IS_ENABLED(CONFIG_SND_SOC_SOF_TIGERLAKE)
191static const struct sof_dev_desc tgl_desc = {
192 .machines = snd_soc_acpi_intel_tgl_machines,
193 .alt_machines = snd_soc_acpi_intel_tgl_sdw_machines,
194 .resindex_lpe_base = 0,
195 .resindex_pcicfg_base = -1,
196 .resindex_imr_base = -1,
197 .irqindex_host_ipc = -1,
198 .resindex_dma_base = -1,
199 .chip_info = &tgl_chip_info,
200 .default_fw_path = "intel/sof",
201 .default_tplg_path = "intel/sof-tplg",
202 .default_fw_filename = "sof-tgl.ri",
203 .nocodec_tplg_filename = "sof-tgl-nocodec.tplg",
204 .ops = &sof_cnl_ops,
205};
206#endif
207
208#if IS_ENABLED(CONFIG_SND_SOC_SOF_ELKHARTLAKE)
209static const struct sof_dev_desc ehl_desc = {
210 .machines = snd_soc_acpi_intel_ehl_machines,
211 .resindex_lpe_base = 0,
212 .resindex_pcicfg_base = -1,
213 .resindex_imr_base = -1,
214 .irqindex_host_ipc = -1,
215 .resindex_dma_base = -1,
216 .chip_info = &ehl_chip_info,
217 .default_fw_path = "intel/sof",
218 .default_tplg_path = "intel/sof-tplg",
219 .default_fw_filename = "sof-ehl.ri",
220 .nocodec_tplg_filename = "sof-ehl-nocodec.tplg",
221 .ops = &sof_cnl_ops,
222};
223#endif
224
225#if IS_ENABLED(CONFIG_SND_SOC_SOF_JASPERLAKE)
226static const struct sof_dev_desc jsl_desc = {
227 .machines = snd_soc_acpi_intel_jsl_machines,
228 .resindex_lpe_base = 0,
229 .resindex_pcicfg_base = -1,
230 .resindex_imr_base = -1,
231 .irqindex_host_ipc = -1,
232 .resindex_dma_base = -1,
233 .chip_info = &jsl_chip_info,
234 .default_fw_path = "intel/sof",
235 .default_tplg_path = "intel/sof-tplg",
236 .default_fw_filename = "sof-jsl.ri",
237 .nocodec_tplg_filename = "sof-jsl-nocodec.tplg",
238 .ops = &sof_cnl_ops,
239};
240#endif
241
242static const struct dev_pm_ops sof_pci_pm = {
243 .prepare = snd_sof_prepare,
244 .complete = snd_sof_complete,
245 SET_SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume)
246 SET_RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume,
247 snd_sof_runtime_idle)
248};
249
250static void sof_pci_probe_complete(struct device *dev)
251{
252 dev_dbg(dev, "Completing SOF PCI probe");
253
254 if (sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME)
255 return;
256
257 /* allow runtime_pm */
258 pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS);
259 pm_runtime_use_autosuspend(dev);
260
261 /*
262 * runtime pm for pci device is "forbidden" by default.
263 * so call pm_runtime_allow() to enable it.
264 */
265 pm_runtime_allow(dev);
266
267 /* mark last_busy for pm_runtime to make sure not suspend immediately */
268 pm_runtime_mark_last_busy(dev);
269
270 /* follow recommendation in pci-driver.c to decrement usage counter */
271 pm_runtime_put_noidle(dev);
272}
273
274static int sof_pci_probe(struct pci_dev *pci,
275 const struct pci_device_id *pci_id)
276{
277 struct device *dev = &pci->dev;
278 const struct sof_dev_desc *desc =
279 (const struct sof_dev_desc *)pci_id->driver_data;
280 struct snd_sof_pdata *sof_pdata;
281 const struct snd_sof_dsp_ops *ops;
282 int ret;
283
284 ret = snd_intel_dsp_driver_probe(pci);
285 if (ret != SND_INTEL_DSP_DRIVER_ANY &&
286 ret != SND_INTEL_DSP_DRIVER_SOF)
287 return -ENODEV;
288
289 dev_dbg(&pci->dev, "PCI DSP detected");
290
291 /* get ops for platform */
292 ops = desc->ops;
293 if (!ops) {
294 dev_err(dev, "error: no matching PCI descriptor ops\n");
295 return -ENODEV;
296 }
297
298 sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL);
299 if (!sof_pdata)
300 return -ENOMEM;
301
302 ret = pcim_enable_device(pci);
303 if (ret < 0)
304 return ret;
305
306 ret = pci_request_regions(pci, "Audio DSP");
307 if (ret < 0)
308 return ret;
309
310 sof_pdata->name = pci_name(pci);
311 sof_pdata->desc = (struct sof_dev_desc *)pci_id->driver_data;
312 sof_pdata->dev = dev;
313 sof_pdata->fw_filename = desc->default_fw_filename;
314
315 /*
316 * for platforms using the SOF community key, change the
317 * default path automatically to pick the right files from the
318 * linux-firmware tree. This can be overridden with the
319 * fw_path kernel parameter, e.g. for developers.
320 */
321
322 /* alternate fw and tplg filenames ? */
323 if (fw_path) {
324 sof_pdata->fw_filename_prefix = fw_path;
325
326 dev_dbg(dev,
327 "Module parameter used, changed fw path to %s\n",
328 sof_pdata->fw_filename_prefix);
329
330 } else if (dmi_check_system(community_key_platforms)) {
331 sof_pdata->fw_filename_prefix =
332 devm_kasprintf(dev, GFP_KERNEL, "%s/%s",
333 sof_pdata->desc->default_fw_path,
334 "community");
335
336 dev_dbg(dev,
337 "Platform uses community key, changed fw path to %s\n",
338 sof_pdata->fw_filename_prefix);
339 } else {
340 sof_pdata->fw_filename_prefix =
341 sof_pdata->desc->default_fw_path;
342 }
343
344 if (tplg_path)
345 sof_pdata->tplg_filename_prefix = tplg_path;
346 else
347 sof_pdata->tplg_filename_prefix =
348 sof_pdata->desc->default_tplg_path;
349
350#if IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE)
351 /* set callback to enable runtime_pm */
352 sof_pdata->sof_probe_complete = sof_pci_probe_complete;
353#endif
354 /* call sof helper for DSP hardware probe */
355 ret = snd_sof_device_probe(dev, sof_pdata);
356 if (ret) {
357 dev_err(dev, "error: failed to probe DSP hardware!\n");
358 goto release_regions;
359 }
360
361#if !IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE)
362 sof_pci_probe_complete(dev);
363#endif
364
365 return ret;
366
367release_regions:
368 pci_release_regions(pci);
369
370 return ret;
371}
372
373static void sof_pci_remove(struct pci_dev *pci)
374{
375 /* call sof helper for DSP hardware remove */
376 snd_sof_device_remove(&pci->dev);
377
378 /* follow recommendation in pci-driver.c to increment usage counter */
379 if (!(sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME))
380 pm_runtime_get_noresume(&pci->dev);
381
382 /* release pci regions and disable device */
383 pci_release_regions(pci);
384}
385
386/* PCI IDs */
387static const struct pci_device_id sof_pci_ids[] = {
388#if IS_ENABLED(CONFIG_SND_SOC_SOF_MERRIFIELD)
389 { PCI_DEVICE(0x8086, 0x119a),
390 .driver_data = (unsigned long)&tng_desc},
391#endif
392#if IS_ENABLED(CONFIG_SND_SOC_SOF_APOLLOLAKE)
393 /* BXT-P & Apollolake */
394 { PCI_DEVICE(0x8086, 0x5a98),
395 .driver_data = (unsigned long)&bxt_desc},
396 { PCI_DEVICE(0x8086, 0x1a98),
397 .driver_data = (unsigned long)&bxt_desc},
398#endif
399#if IS_ENABLED(CONFIG_SND_SOC_SOF_GEMINILAKE)
400 { PCI_DEVICE(0x8086, 0x3198),
401 .driver_data = (unsigned long)&glk_desc},
402#endif
403#if IS_ENABLED(CONFIG_SND_SOC_SOF_CANNONLAKE)
404 { PCI_DEVICE(0x8086, 0x9dc8),
405 .driver_data = (unsigned long)&cnl_desc},
406#endif
407#if IS_ENABLED(CONFIG_SND_SOC_SOF_COFFEELAKE)
408 { PCI_DEVICE(0x8086, 0xa348),
409 .driver_data = (unsigned long)&cfl_desc},
410#endif
411#if IS_ENABLED(CONFIG_SND_SOC_SOF_ICELAKE)
412 { PCI_DEVICE(0x8086, 0x34C8), /* ICL-LP */
413 .driver_data = (unsigned long)&icl_desc},
414 { PCI_DEVICE(0x8086, 0x3dc8), /* ICL-H */
415 .driver_data = (unsigned long)&icl_desc},
416
417#endif
418#if IS_ENABLED(CONFIG_SND_SOC_SOF_JASPERLAKE)
419 { PCI_DEVICE(0x8086, 0x38c8),
420 .driver_data = (unsigned long)&jsl_desc},
421 { PCI_DEVICE(0x8086, 0x4dc8),
422 .driver_data = (unsigned long)&jsl_desc},
423#endif
424#if IS_ENABLED(CONFIG_SND_SOC_SOF_COMETLAKE)
425 { PCI_DEVICE(0x8086, 0x02c8), /* CML-LP */
426 .driver_data = (unsigned long)&cml_desc},
427 { PCI_DEVICE(0x8086, 0x06c8), /* CML-H */
428 .driver_data = (unsigned long)&cml_desc},
429 { PCI_DEVICE(0x8086, 0xa3f0), /* CML-S */
430 .driver_data = (unsigned long)&cml_desc},
431#endif
432#if IS_ENABLED(CONFIG_SND_SOC_SOF_TIGERLAKE)
433 { PCI_DEVICE(0x8086, 0xa0c8), /* TGL-LP */
434 .driver_data = (unsigned long)&tgl_desc},
435 { PCI_DEVICE(0x8086, 0x43c8), /* TGL-H */
436 .driver_data = (unsigned long)&tgl_desc},
437
438#endif
439#if IS_ENABLED(CONFIG_SND_SOC_SOF_ELKHARTLAKE)
440 { PCI_DEVICE(0x8086, 0x4b55),
441 .driver_data = (unsigned long)&ehl_desc},
442 { PCI_DEVICE(0x8086, 0x4b58),
443 .driver_data = (unsigned long)&ehl_desc},
444#endif
445 { 0, }
446};
447MODULE_DEVICE_TABLE(pci, sof_pci_ids);
448
449/* pci_driver definition */
450static struct pci_driver snd_sof_pci_driver = {
451 .name = "sof-audio-pci",
452 .id_table = sof_pci_ids,
453 .probe = sof_pci_probe,
454 .remove = sof_pci_remove,
455 .driver = {
456 .pm = &sof_pci_pm,
457 },
458};
459module_pci_driver(snd_sof_pci_driver);
460
461MODULE_LICENSE("Dual BSD/GPL");
462MODULE_IMPORT_NS(SND_SOC_SOF_MERRIFIELD);
463MODULE_IMPORT_NS(SND_SOC_SOF_INTEL_HDA_COMMON);
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
23static char *fw_path;
24module_param(fw_path, charp, 0444);
25MODULE_PARM_DESC(fw_path, "alternate path for SOF firmware.");
26
27static char *fw_filename;
28module_param(fw_filename, charp, 0444);
29MODULE_PARM_DESC(fw_filename, "alternate filename for SOF firmware.");
30
31static char *lib_path;
32module_param(lib_path, charp, 0444);
33MODULE_PARM_DESC(lib_path, "alternate path for SOF firmware libraries.");
34
35static char *tplg_path;
36module_param(tplg_path, charp, 0444);
37MODULE_PARM_DESC(tplg_path, "alternate path for SOF topology.");
38
39static char *tplg_filename;
40module_param(tplg_filename, charp, 0444);
41MODULE_PARM_DESC(tplg_filename, "alternate filename for SOF topology.");
42
43static int sof_pci_debug;
44module_param_named(sof_pci_debug, sof_pci_debug, int, 0444);
45MODULE_PARM_DESC(sof_pci_debug, "SOF PCI debug options (0x0 all off)");
46
47static int sof_pci_ipc_type = -1;
48module_param_named(ipc_type, sof_pci_ipc_type, int, 0444);
49MODULE_PARM_DESC(ipc_type, "SOF IPC type (0): SOF, (1) Intel CAVS");
50
51static const char *sof_dmi_override_tplg_name;
52static bool sof_dmi_use_community_key;
53
54#define SOF_PCI_DISABLE_PM_RUNTIME BIT(0)
55
56static int sof_tplg_cb(const struct dmi_system_id *id)
57{
58 sof_dmi_override_tplg_name = id->driver_data;
59 return 1;
60}
61
62static const struct dmi_system_id sof_tplg_table[] = {
63 {
64 .callback = sof_tplg_cb,
65 .matches = {
66 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Volteer"),
67 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98373_ALC5682I_I2S_UP4"),
68 },
69 .driver_data = "sof-tgl-rt5682-ssp0-max98373-ssp2.tplg",
70 },
71 {
72 .callback = sof_tplg_cb,
73 .matches = {
74 DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
75 DMI_MATCH(DMI_PRODUCT_NAME, "Alder Lake Client Platform"),
76 DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98373_ALC5682I_I2S"),
77 },
78 .driver_data = "sof-adl-rt5682-ssp0-max98373-ssp2.tplg",
79 },
80 {
81 .callback = sof_tplg_cb,
82 .matches = {
83 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
84 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98390_ALC5682I_I2S"),
85 },
86 .driver_data = "sof-adl-max98390-ssp2-rt5682-ssp0.tplg",
87 },
88 {
89 .callback = sof_tplg_cb,
90 .matches = {
91 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
92 DMI_MATCH(DMI_OEM_STRING, "AUDIO_AMP-MAX98360_ALC5682VS_I2S_2WAY"),
93 },
94 .driver_data = "sof-adl-max98360a-rt5682-2way.tplg",
95 },
96 {
97 .callback = sof_tplg_cb,
98 .matches = {
99 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
100 DMI_MATCH(DMI_OEM_STRING, "AUDIO-AUDIO_MAX98357_ALC5682I_I2S_2WAY"),
101 },
102 .driver_data = "sof-adl-max98357a-rt5682-2way.tplg",
103 },
104 {
105 .callback = sof_tplg_cb,
106 .matches = {
107 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
108 DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98360_ALC5682I_I2S_AMP_SSP2"),
109 },
110 .driver_data = "sof-adl-max98357a-rt5682.tplg",
111 },
112 {}
113};
114
115/* all Up boards use the community key */
116static int up_use_community_key(const struct dmi_system_id *id)
117{
118 sof_dmi_use_community_key = true;
119 return 1;
120}
121
122/*
123 * For ApolloLake Chromebooks we want to force the use of the Intel production key.
124 * All newer platforms use the community key
125 */
126static int chromebook_use_community_key(const struct dmi_system_id *id)
127{
128 if (!soc_intel_is_apl())
129 sof_dmi_use_community_key = true;
130 return 1;
131}
132
133static const struct dmi_system_id community_key_platforms[] = {
134 {
135 .ident = "Up boards",
136 .callback = up_use_community_key,
137 .matches = {
138 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
139 }
140 },
141 {
142 .ident = "Google Chromebooks",
143 .callback = chromebook_use_community_key,
144 .matches = {
145 DMI_MATCH(DMI_PRODUCT_FAMILY, "Google"),
146 }
147 },
148 {},
149};
150
151const struct dev_pm_ops sof_pci_pm = {
152 .prepare = snd_sof_prepare,
153 .complete = snd_sof_complete,
154 SET_SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume)
155 SET_RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume,
156 snd_sof_runtime_idle)
157};
158EXPORT_SYMBOL_NS(sof_pci_pm, SND_SOC_SOF_PCI_DEV);
159
160static void sof_pci_probe_complete(struct device *dev)
161{
162 dev_dbg(dev, "Completing SOF PCI probe");
163
164 if (sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME)
165 return;
166
167 /* allow runtime_pm */
168 pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS);
169 pm_runtime_use_autosuspend(dev);
170
171 /*
172 * runtime pm for pci device is "forbidden" by default.
173 * so call pm_runtime_allow() to enable it.
174 */
175 pm_runtime_allow(dev);
176
177 /* mark last_busy for pm_runtime to make sure not suspend immediately */
178 pm_runtime_mark_last_busy(dev);
179
180 /* follow recommendation in pci-driver.c to decrement usage counter */
181 pm_runtime_put_noidle(dev);
182}
183
184int sof_pci_probe(struct pci_dev *pci, const struct pci_device_id *pci_id)
185{
186 struct device *dev = &pci->dev;
187 const struct sof_dev_desc *desc =
188 (const struct sof_dev_desc *)pci_id->driver_data;
189 struct snd_sof_pdata *sof_pdata;
190 int ret;
191
192 dev_dbg(&pci->dev, "PCI DSP detected");
193
194 if (!desc) {
195 dev_err(dev, "error: no matching PCI descriptor\n");
196 return -ENODEV;
197 }
198
199 if (!desc->ops) {
200 dev_err(dev, "error: no matching PCI descriptor ops\n");
201 return -ENODEV;
202 }
203
204 sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL);
205 if (!sof_pdata)
206 return -ENOMEM;
207
208 ret = pcim_enable_device(pci);
209 if (ret < 0)
210 return ret;
211
212 ret = pci_request_regions(pci, "Audio DSP");
213 if (ret < 0)
214 return ret;
215
216 sof_pdata->name = pci_name(pci);
217 sof_pdata->desc = desc;
218 sof_pdata->dev = dev;
219
220 sof_pdata->ipc_type = desc->ipc_default;
221
222 if (sof_pci_ipc_type < 0) {
223 sof_pdata->ipc_type = desc->ipc_default;
224 } else {
225 dev_info(dev, "overriding default IPC %d to requested %d\n",
226 desc->ipc_default, sof_pci_ipc_type);
227 if (sof_pci_ipc_type >= SOF_IPC_TYPE_COUNT) {
228 dev_err(dev, "invalid request value %d\n", sof_pci_ipc_type);
229 ret = -EINVAL;
230 goto out;
231 }
232 if (!(BIT(sof_pci_ipc_type) & desc->ipc_supported_mask)) {
233 dev_err(dev, "invalid request value %d, supported mask is %#x\n",
234 sof_pci_ipc_type, desc->ipc_supported_mask);
235 ret = -EINVAL;
236 goto out;
237 }
238 sof_pdata->ipc_type = sof_pci_ipc_type;
239 }
240
241 if (fw_filename) {
242 sof_pdata->fw_filename = fw_filename;
243
244 dev_dbg(dev, "Module parameter used, changed fw filename to %s\n",
245 sof_pdata->fw_filename);
246 } else {
247 sof_pdata->fw_filename = desc->default_fw_filename[sof_pdata->ipc_type];
248 }
249
250 /*
251 * for platforms using the SOF community key, change the
252 * default path automatically to pick the right files from the
253 * linux-firmware tree. This can be overridden with the
254 * fw_path kernel parameter, e.g. for developers.
255 */
256
257 /* alternate fw and tplg filenames ? */
258 if (fw_path) {
259 sof_pdata->fw_filename_prefix = fw_path;
260
261 dev_dbg(dev,
262 "Module parameter used, changed fw path to %s\n",
263 sof_pdata->fw_filename_prefix);
264
265 } else if (dmi_check_system(community_key_platforms) && sof_dmi_use_community_key) {
266 sof_pdata->fw_filename_prefix =
267 devm_kasprintf(dev, GFP_KERNEL, "%s/%s",
268 sof_pdata->desc->default_fw_path[sof_pdata->ipc_type],
269 "community");
270
271 dev_dbg(dev,
272 "Platform uses community key, changed fw path to %s\n",
273 sof_pdata->fw_filename_prefix);
274 } else {
275 sof_pdata->fw_filename_prefix =
276 sof_pdata->desc->default_fw_path[sof_pdata->ipc_type];
277 }
278
279 if (lib_path) {
280 sof_pdata->fw_lib_prefix = lib_path;
281
282 dev_dbg(dev, "Module parameter used, changed fw_lib path to %s\n",
283 sof_pdata->fw_lib_prefix);
284
285 } else if (sof_pdata->desc->default_lib_path[sof_pdata->ipc_type]) {
286 if (dmi_check_system(community_key_platforms) && sof_dmi_use_community_key) {
287 sof_pdata->fw_lib_prefix =
288 devm_kasprintf(dev, GFP_KERNEL, "%s/%s",
289 sof_pdata->desc->default_lib_path[sof_pdata->ipc_type],
290 "community");
291
292 dev_dbg(dev,
293 "Platform uses community key, changed fw_lib path to %s\n",
294 sof_pdata->fw_lib_prefix);
295 } else {
296 sof_pdata->fw_lib_prefix =
297 sof_pdata->desc->default_lib_path[sof_pdata->ipc_type];
298 }
299 }
300
301 if (tplg_path)
302 sof_pdata->tplg_filename_prefix = tplg_path;
303 else
304 sof_pdata->tplg_filename_prefix =
305 sof_pdata->desc->default_tplg_path[sof_pdata->ipc_type];
306
307 /*
308 * the topology filename will be provided in the machine descriptor, unless
309 * it is overridden by a module parameter or DMI quirk.
310 */
311 if (tplg_filename) {
312 sof_pdata->tplg_filename = tplg_filename;
313
314 dev_dbg(dev, "Module parameter used, changed tplg filename to %s\n",
315 sof_pdata->tplg_filename);
316 } else {
317 dmi_check_system(sof_tplg_table);
318 if (sof_dmi_override_tplg_name)
319 sof_pdata->tplg_filename = sof_dmi_override_tplg_name;
320 }
321
322 /* set callback to be called on successful device probe to enable runtime_pm */
323 sof_pdata->sof_probe_complete = sof_pci_probe_complete;
324
325 /* call sof helper for DSP hardware probe */
326 ret = snd_sof_device_probe(dev, sof_pdata);
327
328out:
329 if (ret)
330 pci_release_regions(pci);
331
332 return ret;
333}
334EXPORT_SYMBOL_NS(sof_pci_probe, SND_SOC_SOF_PCI_DEV);
335
336void sof_pci_remove(struct pci_dev *pci)
337{
338 /* call sof helper for DSP hardware remove */
339 snd_sof_device_remove(&pci->dev);
340
341 /* follow recommendation in pci-driver.c to increment usage counter */
342 if (snd_sof_device_probe_completed(&pci->dev) &&
343 !(sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME))
344 pm_runtime_get_noresume(&pci->dev);
345
346 /* release pci regions and disable device */
347 pci_release_regions(pci);
348}
349EXPORT_SYMBOL_NS(sof_pci_remove, SND_SOC_SOF_PCI_DEV);
350
351void sof_pci_shutdown(struct pci_dev *pci)
352{
353 snd_sof_device_shutdown(&pci->dev);
354}
355EXPORT_SYMBOL_NS(sof_pci_shutdown, SND_SOC_SOF_PCI_DEV);
356
357MODULE_LICENSE("Dual BSD/GPL");