sof-pci-dev.c

  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
  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, "deprecated - moved to snd-sof module.");
 26
 27static char *fw_filename;
 28module_param(fw_filename, charp, 0444);
 29MODULE_PARM_DESC(fw_filename, "deprecated - moved to snd-sof module.");
 30
 31static char *lib_path;
 32module_param(lib_path, charp, 0444);
 33MODULE_PARM_DESC(lib_path, "deprecated - moved to snd-sof module.");
 34
 35static char *tplg_path;
 36module_param(tplg_path, charp, 0444);
 37MODULE_PARM_DESC(tplg_path, "deprecated - moved to snd-sof module.");
 38
 39static char *tplg_filename;
 40module_param(tplg_filename, charp, 0444);
 41MODULE_PARM_DESC(tplg_filename, "deprecated - moved to snd-sof module.");
 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, "deprecated - moved to snd-sof module.");
 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		.ident = "Google firmware",
150		.callback = chromebook_use_community_key,
151		.matches = {
152			DMI_MATCH(DMI_BIOS_VERSION, "Google"),
153		}
154	},
155	{},
156};
157
158EXPORT_NS_DEV_PM_OPS(sof_pci_pm, SND_SOC_SOF_PCI_DEV) = {
159	.prepare = snd_sof_prepare,
160	.complete = snd_sof_complete,
161	SYSTEM_SLEEP_PM_OPS(snd_sof_suspend, snd_sof_resume)
162	RUNTIME_PM_OPS(snd_sof_runtime_suspend, snd_sof_runtime_resume,
163		       snd_sof_runtime_idle)
164};
165
166static void sof_pci_probe_complete(struct device *dev)
167{
168	dev_dbg(dev, "Completing SOF PCI probe");
169
170	if (sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME)
171		return;
172
173	/* allow runtime_pm */
174	pm_runtime_set_autosuspend_delay(dev, SND_SOF_SUSPEND_DELAY_MS);
175	pm_runtime_use_autosuspend(dev);
176
177	/*
178	 * runtime pm for pci device is "forbidden" by default.
179	 * so call pm_runtime_allow() to enable it.
180	 */
181	pm_runtime_allow(dev);
182
183	/* mark last_busy for pm_runtime to make sure not suspend immediately */
184	pm_runtime_mark_last_busy(dev);
185
186	/* follow recommendation in pci-driver.c to decrement usage counter */
187	pm_runtime_put_noidle(dev);
188}
189
190int sof_pci_probe(struct pci_dev *pci, const struct pci_device_id *pci_id)
191{
192	struct sof_loadable_file_profile *path_override;
193	struct device *dev = &pci->dev;
194	const struct sof_dev_desc *desc =
195		(const struct sof_dev_desc *)pci_id->driver_data;
196	struct snd_sof_pdata *sof_pdata;
197	int ret;
198
199	dev_dbg(&pci->dev, "PCI DSP detected");
200
201	if (!desc) {
202		dev_err(dev, "error: no matching PCI descriptor\n");
203		return -ENODEV;
204	}
205
206	if (!desc->ops) {
207		dev_err(dev, "error: no matching PCI descriptor ops\n");
208		return -ENODEV;
209	}
210
211	sof_pdata = devm_kzalloc(dev, sizeof(*sof_pdata), GFP_KERNEL);
212	if (!sof_pdata)
213		return -ENOMEM;
214
215	ret = pcim_enable_device(pci);
216	if (ret < 0)
217		return ret;
218
219	ret = pcim_request_all_regions(pci, "Audio DSP");
220	if (ret < 0)
221		return ret;
222
223	sof_pdata->name = pci_name(pci);
224
225	/* PCI defines a vendor ID of 0xFFFF as invalid. */
226	if (pci->subsystem_vendor != 0xFFFF) {
227		sof_pdata->subsystem_vendor = pci->subsystem_vendor;
228		sof_pdata->subsystem_device = pci->subsystem_device;
229		sof_pdata->subsystem_id_set = true;
230	}
231
232	sof_pdata->desc = desc;
233	sof_pdata->dev = dev;
234
235	path_override = &sof_pdata->ipc_file_profile_base;
236
237	if (sof_pci_ipc_type < 0) {
238		path_override->ipc_type = desc->ipc_default;
239	} else if (sof_pci_ipc_type < SOF_IPC_TYPE_COUNT) {
240		path_override->ipc_type = sof_pci_ipc_type;
241	} else {
242		dev_err(dev, "Invalid IPC type requested: %d\n", sof_pci_ipc_type);
243		return -EINVAL;
244	}
245
246	path_override->fw_path = fw_path;
247	path_override->fw_name = fw_filename;
248	path_override->fw_lib_path = lib_path;
249	path_override->tplg_path = tplg_path;
250
251	if (dmi_check_system(community_key_platforms) &&
252	    sof_dmi_use_community_key) {
253		path_override->fw_path_postfix = "community";
254		path_override->fw_lib_path_postfix = "community";
255	}
256
257	/*
258	 * the topology filename will be provided in the machine descriptor, unless
259	 * it is overridden by a module parameter or DMI quirk.
260	 */
261	if (tplg_filename) {
262		path_override->tplg_name = tplg_filename;
263	} else {
264		dmi_check_system(sof_tplg_table);
265		if (sof_dmi_override_tplg_name)
266			path_override->tplg_name = sof_dmi_override_tplg_name;
267	}
268
269	/* set callback to be called on successful device probe to enable runtime_pm */
270	sof_pdata->sof_probe_complete = sof_pci_probe_complete;
271
272	/* call sof helper for DSP hardware probe */
273	return snd_sof_device_probe(dev, sof_pdata);
274}
275EXPORT_SYMBOL_NS(sof_pci_probe, "SND_SOC_SOF_PCI_DEV");
276
277void sof_pci_remove(struct pci_dev *pci)
278{
279	/* call sof helper for DSP hardware remove */
280	snd_sof_device_remove(&pci->dev);
281
282	/* follow recommendation in pci-driver.c to increment usage counter */
283	if (snd_sof_device_probe_completed(&pci->dev) &&
284	    !(sof_pci_debug & SOF_PCI_DISABLE_PM_RUNTIME))
285		pm_runtime_get_noresume(&pci->dev);
286}
287EXPORT_SYMBOL_NS(sof_pci_remove, "SND_SOC_SOF_PCI_DEV");
288
289void sof_pci_shutdown(struct pci_dev *pci)
290{
291	snd_sof_device_shutdown(&pci->dev);
292}
293EXPORT_SYMBOL_NS(sof_pci_shutdown, "SND_SOC_SOF_PCI_DEV");
294
295MODULE_LICENSE("Dual BSD/GPL");
296MODULE_DESCRIPTION("SOF support for PCI platforms");