xref: /openbmc/linux/sound/soc/amd/ps/pci-ps.c (revision d84881e06836dc1655777a592b4279be76ad7324)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * AMD Pink Sardine ACP PCI Driver
4  *
5  * Copyright 2022 Advanced Micro Devices, Inc.
6  */
7 
8 #include <linux/pci.h>
9 #include <linux/module.h>
10 #include <linux/io.h>
11 #include <linux/delay.h>
12 #include <linux/platform_device.h>
13 #include <linux/acpi.h>
14 #include <linux/interrupt.h>
15 #include <sound/pcm_params.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/iopoll.h>
18 
19 #include "acp63.h"
20 
21 static int acp63_power_on(void __iomem *acp_base)
22 {
23 	u32 val;
24 
25 	val = readl(acp_base + ACP_PGFSM_STATUS);
26 
27 	if (!val)
28 		return val;
29 
30 	if ((val & ACP_PGFSM_STATUS_MASK) != ACP_POWER_ON_IN_PROGRESS)
31 		writel(ACP_PGFSM_CNTL_POWER_ON_MASK, acp_base + ACP_PGFSM_CONTROL);
32 
33 	return readl_poll_timeout(acp_base + ACP_PGFSM_STATUS, val, !val, DELAY_US, ACP_TIMEOUT);
34 }
35 
36 static int acp63_reset(void __iomem *acp_base)
37 {
38 	u32 val;
39 	int ret;
40 
41 	writel(1, acp_base + ACP_SOFT_RESET);
42 
43 	ret = readl_poll_timeout(acp_base + ACP_SOFT_RESET, val,
44 				 val & ACP_SOFT_RESET_SOFTRESET_AUDDONE_MASK,
45 				 DELAY_US, ACP_TIMEOUT);
46 	if (ret)
47 		return ret;
48 
49 	writel(0, acp_base + ACP_SOFT_RESET);
50 
51 	return readl_poll_timeout(acp_base + ACP_SOFT_RESET, val, !val, DELAY_US, ACP_TIMEOUT);
52 }
53 
54 static void acp63_enable_interrupts(void __iomem *acp_base)
55 {
56 	writel(1, acp_base + ACP_EXTERNAL_INTR_ENB);
57 }
58 
59 static void acp63_disable_interrupts(void __iomem *acp_base)
60 {
61 	writel(ACP_EXT_INTR_STAT_CLEAR_MASK, acp_base + ACP_EXTERNAL_INTR_STAT);
62 	writel(0, acp_base + ACP_EXTERNAL_INTR_CNTL);
63 	writel(0, acp_base + ACP_EXTERNAL_INTR_ENB);
64 }
65 
66 static int acp63_init(void __iomem *acp_base, struct device *dev)
67 {
68 	int ret;
69 
70 	ret = acp63_power_on(acp_base);
71 	if (ret) {
72 		dev_err(dev, "ACP power on failed\n");
73 		return ret;
74 	}
75 	writel(0x01, acp_base + ACP_CONTROL);
76 	ret = acp63_reset(acp_base);
77 	if (ret) {
78 		dev_err(dev, "ACP reset failed\n");
79 		return ret;
80 	}
81 	acp63_enable_interrupts(acp_base);
82 	return 0;
83 }
84 
85 static int acp63_deinit(void __iomem *acp_base, struct device *dev)
86 {
87 	int ret;
88 
89 	acp63_disable_interrupts(acp_base);
90 	ret = acp63_reset(acp_base);
91 	if (ret) {
92 		dev_err(dev, "ACP reset failed\n");
93 		return ret;
94 	}
95 	writel(0, acp_base + ACP_CONTROL);
96 	return 0;
97 }
98 
99 static irqreturn_t acp63_irq_handler(int irq, void *dev_id)
100 {
101 	struct acp63_dev_data *adata;
102 	struct pdm_dev_data *ps_pdm_data;
103 	u32 val;
104 	u16 pdev_index;
105 
106 	adata = dev_id;
107 	if (!adata)
108 		return IRQ_NONE;
109 
110 	val = readl(adata->acp63_base + ACP_EXTERNAL_INTR_STAT);
111 	if (val & BIT(PDM_DMA_STAT)) {
112 		pdev_index = adata->pdm_dev_index;
113 		ps_pdm_data = dev_get_drvdata(&adata->pdev[pdev_index]->dev);
114 		writel(BIT(PDM_DMA_STAT), adata->acp63_base + ACP_EXTERNAL_INTR_STAT);
115 		if (ps_pdm_data->capture_stream)
116 			snd_pcm_period_elapsed(ps_pdm_data->capture_stream);
117 		return IRQ_HANDLED;
118 	}
119 	return IRQ_NONE;
120 }
121 
122 static void get_acp63_device_config(u32 config, struct pci_dev *pci,
123 				    struct acp63_dev_data *acp_data)
124 {
125 	struct acpi_device *dmic_dev;
126 	const union acpi_object *obj;
127 	bool is_dmic_dev = false;
128 
129 	dmic_dev = acpi_find_child_device(ACPI_COMPANION(&pci->dev), ACP63_DMIC_ADDR, 0);
130 	if (dmic_dev) {
131 		if (!acpi_dev_get_property(dmic_dev, "acp-audio-device-type",
132 					   ACPI_TYPE_INTEGER, &obj) &&
133 					   obj->integer.value == ACP_DMIC_DEV)
134 			is_dmic_dev = true;
135 	}
136 
137 	switch (config) {
138 	case ACP_CONFIG_0:
139 	case ACP_CONFIG_1:
140 	case ACP_CONFIG_2:
141 	case ACP_CONFIG_3:
142 	case ACP_CONFIG_9:
143 	case ACP_CONFIG_15:
144 		dev_dbg(&pci->dev, "Audio Mode %d\n", config);
145 		break;
146 	default:
147 		if (is_dmic_dev) {
148 			acp_data->pdev_mask = ACP63_PDM_DEV_MASK;
149 			acp_data->pdev_count = ACP63_PDM_MODE_DEVS;
150 		}
151 		break;
152 	}
153 }
154 
155 static void acp63_fill_platform_dev_info(struct platform_device_info *pdevinfo,
156 					 struct device *parent,
157 					 struct fwnode_handle *fw_node,
158 					 char *name, unsigned int id,
159 					 const struct resource *res,
160 					 unsigned int num_res,
161 					 const void *data,
162 					 size_t size_data)
163 {
164 	pdevinfo->name = name;
165 	pdevinfo->id = id;
166 	pdevinfo->parent = parent;
167 	pdevinfo->num_res = num_res;
168 	pdevinfo->res = res;
169 	pdevinfo->data = data;
170 	pdevinfo->size_data = size_data;
171 	pdevinfo->fwnode = fw_node;
172 }
173 
174 static int create_acp63_platform_devs(struct pci_dev *pci, struct acp63_dev_data *adata, u32 addr)
175 {
176 	struct platform_device_info pdevinfo[ACP63_DEVS];
177 	struct device *parent;
178 	int index;
179 	int ret;
180 
181 	parent = &pci->dev;
182 	dev_dbg(&pci->dev,
183 		"%s pdev_mask:0x%x pdev_count:0x%x\n", __func__, adata->pdev_mask,
184 		adata->pdev_count);
185 	if (adata->pdev_mask) {
186 		adata->res = devm_kzalloc(&pci->dev, sizeof(struct resource), GFP_KERNEL);
187 		if (!adata->res) {
188 			ret = -ENOMEM;
189 			goto de_init;
190 		}
191 		adata->res->flags = IORESOURCE_MEM;
192 		adata->res->start = addr;
193 		adata->res->end = addr + (ACP63_REG_END - ACP63_REG_START);
194 		memset(&pdevinfo, 0, sizeof(pdevinfo));
195 	}
196 
197 	switch (adata->pdev_mask) {
198 	case ACP63_PDM_DEV_MASK:
199 		adata->pdm_dev_index  = 0;
200 		acp63_fill_platform_dev_info(&pdevinfo[0], parent, NULL, "acp_ps_pdm_dma",
201 					     0, adata->res, 1, &adata->acp_lock,
202 					     sizeof(adata->acp_lock));
203 		acp63_fill_platform_dev_info(&pdevinfo[1], parent, NULL, "dmic-codec",
204 					     0, NULL, 0, NULL, 0);
205 		acp63_fill_platform_dev_info(&pdevinfo[2], parent, NULL, "acp_ps_mach",
206 					     0, NULL, 0, NULL, 0);
207 		break;
208 	default:
209 		dev_dbg(&pci->dev, "No PDM devices found\n");
210 		return 0;
211 	}
212 
213 	for (index = 0; index < adata->pdev_count; index++) {
214 		adata->pdev[index] = platform_device_register_full(&pdevinfo[index]);
215 		if (IS_ERR(adata->pdev[index])) {
216 			dev_err(&pci->dev,
217 				"cannot register %s device\n", pdevinfo[index].name);
218 			ret = PTR_ERR(adata->pdev[index]);
219 			goto unregister_devs;
220 		}
221 	}
222 	return 0;
223 unregister_devs:
224 	for (--index; index >= 0; index--)
225 		platform_device_unregister(adata->pdev[index]);
226 de_init:
227 	if (acp63_deinit(adata->acp63_base, &pci->dev))
228 		dev_err(&pci->dev, "ACP de-init failed\n");
229 	return ret;
230 }
231 
232 static int snd_acp63_probe(struct pci_dev *pci,
233 			   const struct pci_device_id *pci_id)
234 {
235 	struct acp63_dev_data *adata;
236 	u32 addr;
237 	u32 irqflags, flag;
238 	int val;
239 	int ret;
240 
241 	irqflags = IRQF_SHARED;
242 
243 	/* Return if acp config flag is defined */
244 	flag = snd_amd_acp_find_config(pci);
245 	if (flag)
246 		return -ENODEV;
247 
248 	/* Pink Sardine device check */
249 	switch (pci->revision) {
250 	case 0x63:
251 		break;
252 	default:
253 		dev_dbg(&pci->dev, "acp63 pci device not found\n");
254 		return -ENODEV;
255 	}
256 	if (pci_enable_device(pci)) {
257 		dev_err(&pci->dev, "pci_enable_device failed\n");
258 		return -ENODEV;
259 	}
260 
261 	ret = pci_request_regions(pci, "AMD ACP6.2 audio");
262 	if (ret < 0) {
263 		dev_err(&pci->dev, "pci_request_regions failed\n");
264 		goto disable_pci;
265 	}
266 	adata = devm_kzalloc(&pci->dev, sizeof(struct acp63_dev_data),
267 			     GFP_KERNEL);
268 	if (!adata) {
269 		ret = -ENOMEM;
270 		goto release_regions;
271 	}
272 
273 	addr = pci_resource_start(pci, 0);
274 	adata->acp63_base = devm_ioremap(&pci->dev, addr,
275 					 pci_resource_len(pci, 0));
276 	if (!adata->acp63_base) {
277 		ret = -ENOMEM;
278 		goto release_regions;
279 	}
280 	pci_set_master(pci);
281 	pci_set_drvdata(pci, adata);
282 	mutex_init(&adata->acp_lock);
283 	ret = acp63_init(adata->acp63_base, &pci->dev);
284 	if (ret)
285 		goto release_regions;
286 	ret = devm_request_irq(&pci->dev, pci->irq, acp63_irq_handler,
287 			       irqflags, "ACP_PCI_IRQ", adata);
288 	if (ret) {
289 		dev_err(&pci->dev, "ACP PCI IRQ request failed\n");
290 		goto de_init;
291 	}
292 	val = readl(adata->acp63_base + ACP_PIN_CONFIG);
293 	get_acp63_device_config(val, pci, adata);
294 	ret = create_acp63_platform_devs(pci, adata, addr);
295 	if (ret < 0) {
296 		dev_err(&pci->dev, "ACP platform devices creation failed\n");
297 		goto de_init;
298 	}
299 	pm_runtime_set_autosuspend_delay(&pci->dev, ACP_SUSPEND_DELAY_MS);
300 	pm_runtime_use_autosuspend(&pci->dev);
301 	pm_runtime_put_noidle(&pci->dev);
302 	pm_runtime_allow(&pci->dev);
303 	return 0;
304 de_init:
305 	if (acp63_deinit(adata->acp63_base, &pci->dev))
306 		dev_err(&pci->dev, "ACP de-init failed\n");
307 release_regions:
308 	pci_release_regions(pci);
309 disable_pci:
310 	pci_disable_device(pci);
311 
312 	return ret;
313 }
314 
315 static int __maybe_unused snd_acp63_suspend(struct device *dev)
316 {
317 	struct acp63_dev_data *adata;
318 	int ret;
319 
320 	adata = dev_get_drvdata(dev);
321 	ret = acp63_deinit(adata->acp63_base, dev);
322 	if (ret)
323 		dev_err(dev, "ACP de-init failed\n");
324 	return ret;
325 }
326 
327 static int __maybe_unused snd_acp63_resume(struct device *dev)
328 {
329 	struct acp63_dev_data *adata;
330 	int ret;
331 
332 	adata = dev_get_drvdata(dev);
333 	ret = acp63_init(adata->acp63_base, dev);
334 	if (ret)
335 		dev_err(dev, "ACP init failed\n");
336 	return ret;
337 }
338 
339 static const struct dev_pm_ops acp63_pm_ops = {
340 	SET_RUNTIME_PM_OPS(snd_acp63_suspend, snd_acp63_resume, NULL)
341 	SET_SYSTEM_SLEEP_PM_OPS(snd_acp63_suspend, snd_acp63_resume)
342 };
343 
344 static void snd_acp63_remove(struct pci_dev *pci)
345 {
346 	struct acp63_dev_data *adata;
347 	int ret, index;
348 
349 	adata = pci_get_drvdata(pci);
350 	for (index = 0; index < adata->pdev_count; index++)
351 		platform_device_unregister(adata->pdev[index]);
352 	ret = acp63_deinit(adata->acp63_base, &pci->dev);
353 	if (ret)
354 		dev_err(&pci->dev, "ACP de-init failed\n");
355 	pm_runtime_forbid(&pci->dev);
356 	pm_runtime_get_noresume(&pci->dev);
357 	pci_release_regions(pci);
358 	pci_disable_device(pci);
359 }
360 
361 static const struct pci_device_id snd_acp63_ids[] = {
362 	{ PCI_DEVICE(PCI_VENDOR_ID_AMD, ACP_DEVICE_ID),
363 	.class = PCI_CLASS_MULTIMEDIA_OTHER << 8,
364 	.class_mask = 0xffffff },
365 	{ 0, },
366 };
367 MODULE_DEVICE_TABLE(pci, snd_acp63_ids);
368 
369 static struct pci_driver ps_acp63_driver  = {
370 	.name = KBUILD_MODNAME,
371 	.id_table = snd_acp63_ids,
372 	.probe = snd_acp63_probe,
373 	.remove = snd_acp63_remove,
374 	.driver = {
375 		.pm = &acp63_pm_ops,
376 	}
377 };
378 
379 module_pci_driver(ps_acp63_driver);
380 
381 MODULE_AUTHOR("Vijendar.Mukunda@amd.com");
382 MODULE_AUTHOR("Syed.SabaKareem@amd.com");
383 MODULE_DESCRIPTION("AMD ACP Pink Sardine PCI driver");
384 MODULE_LICENSE("GPL v2");
385