xref: /kernel/linux/linux-5.10/drivers/soc/ti/pruss.c (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * PRU-ICSS platform driver for various TI SoCs
4 *
5 * Copyright (C) 2014-2020 Texas Instruments Incorporated - http://www.ti.com/
6 * Author(s):
7 *	Suman Anna <s-anna@ti.com>
8 *	Andrew F. Davis <afd@ti.com>
9 */
10
11#include <linux/clk-provider.h>
12#include <linux/dma-mapping.h>
13#include <linux/io.h>
14#include <linux/mfd/syscon.h>
15#include <linux/module.h>
16#include <linux/of_address.h>
17#include <linux/of_device.h>
18#include <linux/pm_runtime.h>
19#include <linux/pruss_driver.h>
20#include <linux/regmap.h>
21#include <linux/slab.h>
22
23/**
24 * struct pruss_private_data - PRUSS driver private data
25 * @has_no_sharedram: flag to indicate the absence of PRUSS Shared Data RAM
26 * @has_core_mux_clock: flag to indicate the presence of PRUSS core clock
27 */
28struct pruss_private_data {
29	bool has_no_sharedram;
30	bool has_core_mux_clock;
31};
32
33static void pruss_of_free_clk_provider(void *data)
34{
35	struct device_node *clk_mux_np = data;
36
37	of_clk_del_provider(clk_mux_np);
38	of_node_put(clk_mux_np);
39}
40
41static int pruss_clk_mux_setup(struct pruss *pruss, struct clk *clk_mux,
42			       char *mux_name, struct device_node *clks_np)
43{
44	struct device_node *clk_mux_np;
45	struct device *dev = pruss->dev;
46	char *clk_mux_name;
47	unsigned int num_parents;
48	const char **parent_names;
49	void __iomem *reg;
50	u32 reg_offset;
51	int ret;
52
53	clk_mux_np = of_get_child_by_name(clks_np, mux_name);
54	if (!clk_mux_np) {
55		dev_err(dev, "%pOF is missing its '%s' node\n", clks_np,
56			mux_name);
57		return -ENODEV;
58	}
59
60	num_parents = of_clk_get_parent_count(clk_mux_np);
61	if (num_parents < 1) {
62		dev_err(dev, "mux-clock %pOF must have parents\n", clk_mux_np);
63		ret = -EINVAL;
64		goto put_clk_mux_np;
65	}
66
67	parent_names = devm_kcalloc(dev, sizeof(*parent_names), num_parents,
68				    GFP_KERNEL);
69	if (!parent_names) {
70		ret = -ENOMEM;
71		goto put_clk_mux_np;
72	}
73
74	of_clk_parent_fill(clk_mux_np, parent_names, num_parents);
75
76	clk_mux_name = devm_kasprintf(dev, GFP_KERNEL, "%s.%pOFn",
77				      dev_name(dev), clk_mux_np);
78	if (!clk_mux_name) {
79		ret = -ENOMEM;
80		goto put_clk_mux_np;
81	}
82
83	ret = of_property_read_u32(clk_mux_np, "reg", &reg_offset);
84	if (ret)
85		goto put_clk_mux_np;
86
87	reg = pruss->cfg_base + reg_offset;
88
89	clk_mux = clk_register_mux(NULL, clk_mux_name, parent_names,
90				   num_parents, 0, reg, 0, 1, 0, NULL);
91	if (IS_ERR(clk_mux)) {
92		ret = PTR_ERR(clk_mux);
93		goto put_clk_mux_np;
94	}
95
96	ret = devm_add_action_or_reset(dev, (void(*)(void *))clk_unregister_mux,
97				       clk_mux);
98	if (ret) {
99		dev_err(dev, "failed to add clkmux unregister action %d", ret);
100		goto put_clk_mux_np;
101	}
102
103	ret = of_clk_add_provider(clk_mux_np, of_clk_src_simple_get, clk_mux);
104	if (ret)
105		goto put_clk_mux_np;
106
107	ret = devm_add_action_or_reset(dev, pruss_of_free_clk_provider,
108				       clk_mux_np);
109	if (ret) {
110		dev_err(dev, "failed to add clkmux free action %d", ret);
111		goto put_clk_mux_np;
112	}
113
114	return 0;
115
116put_clk_mux_np:
117	of_node_put(clk_mux_np);
118	return ret;
119}
120
121static int pruss_clk_init(struct pruss *pruss, struct device_node *cfg_node)
122{
123	const struct pruss_private_data *data;
124	struct device_node *clks_np;
125	struct device *dev = pruss->dev;
126	int ret = 0;
127
128	data = of_device_get_match_data(dev);
129	if (IS_ERR(data))
130		return -ENODEV;
131
132	clks_np = of_get_child_by_name(cfg_node, "clocks");
133	if (!clks_np) {
134		dev_err(dev, "%pOF is missing its 'clocks' node\n", cfg_node);
135		return -ENODEV;
136	}
137
138	if (data && data->has_core_mux_clock) {
139		ret = pruss_clk_mux_setup(pruss, pruss->core_clk_mux,
140					  "coreclk-mux", clks_np);
141		if (ret) {
142			dev_err(dev, "failed to setup coreclk-mux\n");
143			goto put_clks_node;
144		}
145	}
146
147	ret = pruss_clk_mux_setup(pruss, pruss->iep_clk_mux, "iepclk-mux",
148				  clks_np);
149	if (ret) {
150		dev_err(dev, "failed to setup iepclk-mux\n");
151		goto put_clks_node;
152	}
153
154put_clks_node:
155	of_node_put(clks_np);
156
157	return ret;
158}
159
160static struct regmap_config regmap_conf = {
161	.reg_bits = 32,
162	.val_bits = 32,
163	.reg_stride = 4,
164};
165
166static int pruss_probe(struct platform_device *pdev)
167{
168	struct device *dev = &pdev->dev;
169	struct device_node *np = dev_of_node(dev);
170	struct device_node *child;
171	struct pruss *pruss;
172	struct resource res;
173	int ret, i, index;
174	const struct pruss_private_data *data;
175	const char *mem_names[PRUSS_MEM_MAX] = { "dram0", "dram1", "shrdram2" };
176
177	data = of_device_get_match_data(&pdev->dev);
178	if (IS_ERR(data)) {
179		dev_err(dev, "missing private data\n");
180		return -ENODEV;
181	}
182
183	ret = dma_set_coherent_mask(dev, DMA_BIT_MASK(32));
184	if (ret) {
185		dev_err(dev, "failed to set the DMA coherent mask");
186		return ret;
187	}
188
189	pruss = devm_kzalloc(dev, sizeof(*pruss), GFP_KERNEL);
190	if (!pruss)
191		return -ENOMEM;
192
193	pruss->dev = dev;
194
195	child = of_get_child_by_name(np, "memories");
196	if (!child) {
197		dev_err(dev, "%pOF is missing its 'memories' node\n", child);
198		return -ENODEV;
199	}
200
201	for (i = 0; i < PRUSS_MEM_MAX; i++) {
202		/*
203		 * On AM437x one of two PRUSS units don't contain Shared RAM,
204		 * skip it
205		 */
206		if (data && data->has_no_sharedram && i == PRUSS_MEM_SHRD_RAM2)
207			continue;
208
209		index = of_property_match_string(child, "reg-names",
210						 mem_names[i]);
211		if (index < 0) {
212			of_node_put(child);
213			return index;
214		}
215
216		if (of_address_to_resource(child, index, &res)) {
217			of_node_put(child);
218			return -EINVAL;
219		}
220
221		pruss->mem_regions[i].va = devm_ioremap(dev, res.start,
222							resource_size(&res));
223		if (!pruss->mem_regions[i].va) {
224			dev_err(dev, "failed to parse and map memory resource %d %s\n",
225				i, mem_names[i]);
226			of_node_put(child);
227			return -ENOMEM;
228		}
229		pruss->mem_regions[i].pa = res.start;
230		pruss->mem_regions[i].size = resource_size(&res);
231
232		dev_dbg(dev, "memory %8s: pa %pa size 0x%zx va %pK\n",
233			mem_names[i], &pruss->mem_regions[i].pa,
234			pruss->mem_regions[i].size, pruss->mem_regions[i].va);
235	}
236	of_node_put(child);
237
238	platform_set_drvdata(pdev, pruss);
239
240	pm_runtime_enable(dev);
241	ret = pm_runtime_get_sync(dev);
242	if (ret < 0) {
243		dev_err(dev, "couldn't enable module\n");
244		pm_runtime_put_noidle(dev);
245		goto rpm_disable;
246	}
247
248	child = of_get_child_by_name(np, "cfg");
249	if (!child) {
250		dev_err(dev, "%pOF is missing its 'cfg' node\n", child);
251		ret = -ENODEV;
252		goto rpm_put;
253	}
254
255	if (of_address_to_resource(child, 0, &res)) {
256		ret = -ENOMEM;
257		goto node_put;
258	}
259
260	pruss->cfg_base = devm_ioremap(dev, res.start, resource_size(&res));
261	if (!pruss->cfg_base) {
262		ret = -ENOMEM;
263		goto node_put;
264	}
265
266	regmap_conf.name = kasprintf(GFP_KERNEL, "%pOFn@%llx", child,
267				     (u64)res.start);
268	regmap_conf.max_register = resource_size(&res) - 4;
269
270	pruss->cfg_regmap = devm_regmap_init_mmio(dev, pruss->cfg_base,
271						  &regmap_conf);
272	kfree(regmap_conf.name);
273	if (IS_ERR(pruss->cfg_regmap)) {
274		dev_err(dev, "regmap_init_mmio failed for cfg, ret = %ld\n",
275			PTR_ERR(pruss->cfg_regmap));
276		ret = PTR_ERR(pruss->cfg_regmap);
277		goto node_put;
278	}
279
280	ret = pruss_clk_init(pruss, child);
281	if (ret) {
282		dev_err(dev, "failed to setup coreclk-mux\n");
283		goto node_put;
284	}
285
286	ret = devm_of_platform_populate(dev);
287	if (ret) {
288		dev_err(dev, "failed to register child devices\n");
289		goto node_put;
290	}
291
292	of_node_put(child);
293
294	return 0;
295
296node_put:
297	of_node_put(child);
298rpm_put:
299	pm_runtime_put_sync(dev);
300rpm_disable:
301	pm_runtime_disable(dev);
302	return ret;
303}
304
305static int pruss_remove(struct platform_device *pdev)
306{
307	struct device *dev = &pdev->dev;
308
309	devm_of_platform_depopulate(dev);
310
311	pm_runtime_put_sync(dev);
312	pm_runtime_disable(dev);
313
314	return 0;
315}
316
317/* instance-specific driver private data */
318static const struct pruss_private_data am437x_pruss1_data = {
319	.has_no_sharedram = false,
320};
321
322static const struct pruss_private_data am437x_pruss0_data = {
323	.has_no_sharedram = true,
324};
325
326static const struct pruss_private_data am65x_j721e_pruss_data = {
327	.has_core_mux_clock = true,
328};
329
330static const struct of_device_id pruss_of_match[] = {
331	{ .compatible = "ti,am3356-pruss" },
332	{ .compatible = "ti,am4376-pruss0", .data = &am437x_pruss0_data, },
333	{ .compatible = "ti,am4376-pruss1", .data = &am437x_pruss1_data, },
334	{ .compatible = "ti,am5728-pruss" },
335	{ .compatible = "ti,k2g-pruss" },
336	{ .compatible = "ti,am654-icssg", .data = &am65x_j721e_pruss_data, },
337	{ .compatible = "ti,j721e-icssg", .data = &am65x_j721e_pruss_data, },
338	{},
339};
340MODULE_DEVICE_TABLE(of, pruss_of_match);
341
342static struct platform_driver pruss_driver = {
343	.driver = {
344		.name = "pruss",
345		.of_match_table = pruss_of_match,
346	},
347	.probe  = pruss_probe,
348	.remove = pruss_remove,
349};
350module_platform_driver(pruss_driver);
351
352MODULE_AUTHOR("Suman Anna <s-anna@ti.com>");
353MODULE_DESCRIPTION("PRU-ICSS Subsystem Driver");
354MODULE_LICENSE("GPL v2");
355