xref: /linux/sound/soc/sof/sof-acpi-dev.c (revision 2634682fdffd9ba6e74b76be8aa91cf8b2e05c41)
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/acpi.h>
12 #include <linux/firmware.h>
13 #include <linux/module.h>
14 #include <linux/pm_runtime.h>
15 #include <sound/soc-acpi.h>
16 #include <sound/soc-acpi-intel-match.h>
17 #include <sound/sof.h>
18 #include "../intel/common/soc-intel-quirks.h"
19 #include "ops.h"
20 
21 /* platform specific devices */
22 #include "intel/shim.h"
23 
24 static char *fw_path;
25 module_param(fw_path, charp, 0444);
26 MODULE_PARM_DESC(fw_path, "alternate path for SOF firmware.");
27 
28 static char *tplg_path;
29 module_param(tplg_path, charp, 0444);
30 MODULE_PARM_DESC(tplg_path, "alternate path for SOF topology.");
31 
32 static int sof_acpi_debug;
33 module_param_named(sof_acpi_debug, sof_acpi_debug, int, 0444);
34 MODULE_PARM_DESC(sof_acpi_debug, "SOF ACPI debug options (0x0 all off)");
35 
36 #define SOF_ACPI_DISABLE_PM_RUNTIME BIT(0)
37 
38 #if IS_ENABLED(CONFIG_ACPI) && IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
39 static const struct sof_dev_desc sof_acpi_broadwell_desc = {
40 	.machines = snd_soc_acpi_intel_broadwell_machines,
41 	.resindex_lpe_base = 0,
42 	.resindex_pcicfg_base = 1,
43 	.resindex_imr_base = -1,
44 	.irqindex_host_ipc = 0,
45 	.chip_info = &bdw_chip_info,
46 	.default_fw_path = "intel/sof",
47 	.default_tplg_path = "intel/sof-tplg",
48 	.default_fw_filename = "sof-bdw.ri",
49 	.nocodec_tplg_filename = "sof-bdw-nocodec.tplg",
50 	.ops = &sof_bdw_ops,
51 };
52 #endif
53 
54 #if IS_ENABLED(CONFIG_ACPI) && IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
55 
56 /* BYTCR uses different IRQ index */
57 static const struct sof_dev_desc sof_acpi_baytrailcr_desc = {
58 	.machines = snd_soc_acpi_intel_baytrail_machines,
59 	.resindex_lpe_base = 0,
60 	.resindex_pcicfg_base = 1,
61 	.resindex_imr_base = 2,
62 	.irqindex_host_ipc = 0,
63 	.chip_info = &byt_chip_info,
64 	.default_fw_path = "intel/sof",
65 	.default_tplg_path = "intel/sof-tplg",
66 	.default_fw_filename = "sof-byt.ri",
67 	.nocodec_tplg_filename = "sof-byt-nocodec.tplg",
68 	.ops = &sof_byt_ops,
69 };
70 
71 static const struct sof_dev_desc sof_acpi_baytrail_desc = {
72 	.machines = snd_soc_acpi_intel_baytrail_machines,
73 	.resindex_lpe_base = 0,
74 	.resindex_pcicfg_base = 1,
75 	.resindex_imr_base = 2,
76 	.irqindex_host_ipc = 5,
77 	.chip_info = &byt_chip_info,
78 	.default_fw_path = "intel/sof",
79 	.default_tplg_path = "intel/sof-tplg",
80 	.default_fw_filename = "sof-byt.ri",
81 	.nocodec_tplg_filename = "sof-byt-nocodec.tplg",
82 	.ops = &sof_byt_ops,
83 };
84 
85 static const struct sof_dev_desc sof_acpi_cherrytrail_desc = {
86 	.machines = snd_soc_acpi_intel_cherrytrail_machines,
87 	.resindex_lpe_base = 0,
88 	.resindex_pcicfg_base = 1,
89 	.resindex_imr_base = 2,
90 	.irqindex_host_ipc = 5,
91 	.chip_info = &cht_chip_info,
92 	.default_fw_path = "intel/sof",
93 	.default_tplg_path = "intel/sof-tplg",
94 	.default_fw_filename = "sof-cht.ri",
95 	.nocodec_tplg_filename = "sof-cht-nocodec.tplg",
96 	.ops = &sof_cht_ops,
97 };
98 
99 #endif
100 
101 static const struct dev_pm_ops sof_acpi_pm = {
102 	SET_SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume)
103 	SET_RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume,
104 			   snd_sof_runtime_idle)
105 };
106 
107 static void sof_acpi_probe_complete(struct device *dev)
108 {
109 	if (sof_acpi_debug & SOF_ACPI_DISABLE_PM_RUNTIME)
110 		return;
111 
112 	/* allow runtime_pm */
113 	pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS);
114 	pm_runtime_use_autosuspend(dev);
115 	pm_runtime_enable(dev);
116 }
117 
118 static int sof_acpi_probe(struct platform_device *pdev)
119 {
120 	struct device *dev = &pdev->dev;
121 	const struct sof_dev_desc *desc;
122 	struct snd_sof_pdata *sof_pdata;
123 	const struct snd_sof_dsp_ops *ops;
124 	int ret;
125 
126 	dev_dbg(&pdev->dev, "ACPI DSP detected");
127 
128 	sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL);
129 	if (!sof_pdata)
130 		return -ENOMEM;
131 
132 	desc = device_get_match_data(dev);
133 	if (!desc)
134 		return -ENODEV;
135 
136 #if IS_ENABLED(CONFIG_ACPI) && IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
137 	if (desc == &sof_acpi_baytrail_desc && soc_intel_is_byt_cr(pdev))
138 		desc = &sof_acpi_baytrailcr_desc;
139 #endif
140 
141 	/* get ops for platform */
142 	ops = desc->ops;
143 	if (!ops) {
144 		dev_err(dev, "error: no matching ACPI descriptor ops\n");
145 		return -ENODEV;
146 	}
147 
148 	sof_pdata->desc = desc;
149 	sof_pdata->dev = &pdev->dev;
150 	sof_pdata->fw_filename = desc->default_fw_filename;
151 
152 	/* alternate fw and tplg filenames ? */
153 	if (fw_path)
154 		sof_pdata->fw_filename_prefix = fw_path;
155 	else
156 		sof_pdata->fw_filename_prefix =
157 			sof_pdata->desc->default_fw_path;
158 
159 	if (tplg_path)
160 		sof_pdata->tplg_filename_prefix = tplg_path;
161 	else
162 		sof_pdata->tplg_filename_prefix =
163 			sof_pdata->desc->default_tplg_path;
164 
165 #if IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE)
166 	/* set callback to enable runtime_pm */
167 	sof_pdata->sof_probe_complete = sof_acpi_probe_complete;
168 #endif
169 	/* call sof helper for DSP hardware probe */
170 	ret = snd_sof_device_probe(dev, sof_pdata);
171 	if (ret) {
172 		dev_err(dev, "error: failed to probe DSP hardware!\n");
173 		return ret;
174 	}
175 
176 #if !IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE)
177 	sof_acpi_probe_complete(dev);
178 #endif
179 
180 	return ret;
181 }
182 
183 static int sof_acpi_remove(struct platform_device *pdev)
184 {
185 	if (!(sof_acpi_debug & SOF_ACPI_DISABLE_PM_RUNTIME))
186 		pm_runtime_disable(&pdev->dev);
187 
188 	/* call sof helper for DSP hardware remove */
189 	snd_sof_device_remove(&pdev->dev);
190 
191 	return 0;
192 }
193 
194 #ifdef CONFIG_ACPI
195 static const struct acpi_device_id sof_acpi_match[] = {
196 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
197 	{ "INT3438", (unsigned long)&sof_acpi_broadwell_desc },
198 #endif
199 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
200 	{ "80860F28", (unsigned long)&sof_acpi_baytrail_desc },
201 	{ "808622A8", (unsigned long)&sof_acpi_cherrytrail_desc },
202 #endif
203 	{ }
204 };
205 MODULE_DEVICE_TABLE(acpi, sof_acpi_match);
206 #endif
207 
208 /* acpi_driver definition */
209 static struct platform_driver snd_sof_acpi_driver = {
210 	.probe = sof_acpi_probe,
211 	.remove = sof_acpi_remove,
212 	.driver = {
213 		.name = "sof-audio-acpi",
214 		.pm = &sof_acpi_pm,
215 		.acpi_match_table = ACPI_PTR(sof_acpi_match),
216 	},
217 };
218 module_platform_driver(snd_sof_acpi_driver);
219 
220 MODULE_LICENSE("Dual BSD/GPL");
221 MODULE_IMPORT_NS(SND_SOC_SOF_BAYTRAIL);
222 MODULE_IMPORT_NS(SND_SOC_SOF_BROADWELL);
223