1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2020-2021, The Linux Foundation. All rights reserved.
4  */
5 
6 #include <linux/args.h>
7 #include <linux/bitfield.h>
8 #include <linux/clk.h>
9 #include <linux/interconnect-provider.h>
10 #include <linux/io.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/of.h>
14 #include <linux/platform_device.h>
15 
16 #include <dt-bindings/interconnect/qcom,osm-l3.h>
17 
18 #define LUT_MAX_ENTRIES			40U
19 #define LUT_SRC				GENMASK(31, 30)
20 #define LUT_L_VAL			GENMASK(7, 0)
21 #define CLK_HW_DIV			2
22 
23 /* OSM Register offsets */
24 #define REG_ENABLE			0x0
25 #define OSM_LUT_ROW_SIZE		32
26 #define OSM_REG_FREQ_LUT		0x110
27 #define OSM_REG_PERF_STATE		0x920
28 
29 /* EPSS Register offsets */
30 #define EPSS_LUT_ROW_SIZE		4
31 #define EPSS_REG_L3_VOTE		0x90
32 #define EPSS_REG_FREQ_LUT		0x100
33 #define EPSS_REG_PERF_STATE		0x320
34 
35 #define OSM_L3_MAX_LINKS		1
36 
37 #define to_osm_l3_provider(_provider) \
38 	container_of(_provider, struct qcom_osm_l3_icc_provider, provider)
39 
40 struct qcom_osm_l3_icc_provider {
41 	void __iomem *base;
42 	unsigned int max_state;
43 	unsigned int reg_perf_state;
44 	unsigned long lut_tables[LUT_MAX_ENTRIES];
45 	struct icc_provider provider;
46 };
47 
48 /**
49  * struct qcom_osm_l3_node - Qualcomm specific interconnect nodes
50  * @name: the node name used in debugfs
51  * @links: an array of nodes where we can go next while traversing
52  * @id: a unique node identifier
53  * @num_links: the total number of @links
54  * @buswidth: width of the interconnect between a node and the bus
55  */
56 struct qcom_osm_l3_node {
57 	const char *name;
58 	u16 links[OSM_L3_MAX_LINKS];
59 	u16 id;
60 	u16 num_links;
61 	u16 buswidth;
62 };
63 
64 struct qcom_osm_l3_desc {
65 	const struct qcom_osm_l3_node * const *nodes;
66 	size_t num_nodes;
67 	unsigned int lut_row_size;
68 	unsigned int reg_freq_lut;
69 	unsigned int reg_perf_state;
70 };
71 
72 enum {
73 	OSM_L3_MASTER_NODE = 10000,
74 	OSM_L3_SLAVE_NODE,
75 };
76 
77 #define DEFINE_QNODE(_name, _id, _buswidth, ...)			\
78 	static const struct qcom_osm_l3_node _name = {			\
79 		.name = #_name,						\
80 		.id = _id,						\
81 		.buswidth = _buswidth,					\
82 		.num_links = COUNT_ARGS(__VA_ARGS__),			\
83 		.links = { __VA_ARGS__ },				\
84 	}
85 
86 DEFINE_QNODE(osm_l3_master, OSM_L3_MASTER_NODE, 16, OSM_L3_SLAVE_NODE);
87 DEFINE_QNODE(osm_l3_slave, OSM_L3_SLAVE_NODE, 16);
88 
89 static const struct qcom_osm_l3_node * const osm_l3_nodes[] = {
90 	[MASTER_OSM_L3_APPS] = &osm_l3_master,
91 	[SLAVE_OSM_L3] = &osm_l3_slave,
92 };
93 
94 DEFINE_QNODE(epss_l3_master, OSM_L3_MASTER_NODE, 32, OSM_L3_SLAVE_NODE);
95 DEFINE_QNODE(epss_l3_slave, OSM_L3_SLAVE_NODE, 32);
96 
97 static const struct qcom_osm_l3_node * const epss_l3_nodes[] = {
98 	[MASTER_EPSS_L3_APPS] = &epss_l3_master,
99 	[SLAVE_EPSS_L3_SHARED] = &epss_l3_slave,
100 };
101 
102 static const struct qcom_osm_l3_desc osm_l3 = {
103 	.nodes = osm_l3_nodes,
104 	.num_nodes = ARRAY_SIZE(osm_l3_nodes),
105 	.lut_row_size = OSM_LUT_ROW_SIZE,
106 	.reg_freq_lut = OSM_REG_FREQ_LUT,
107 	.reg_perf_state = OSM_REG_PERF_STATE,
108 };
109 
110 static const struct qcom_osm_l3_desc epss_l3_perf_state = {
111 	.nodes = epss_l3_nodes,
112 	.num_nodes = ARRAY_SIZE(epss_l3_nodes),
113 	.lut_row_size = EPSS_LUT_ROW_SIZE,
114 	.reg_freq_lut = EPSS_REG_FREQ_LUT,
115 	.reg_perf_state = EPSS_REG_PERF_STATE,
116 };
117 
118 static const struct qcom_osm_l3_desc epss_l3_l3_vote = {
119 	.nodes = epss_l3_nodes,
120 	.num_nodes = ARRAY_SIZE(epss_l3_nodes),
121 	.lut_row_size = EPSS_LUT_ROW_SIZE,
122 	.reg_freq_lut = EPSS_REG_FREQ_LUT,
123 	.reg_perf_state = EPSS_REG_L3_VOTE,
124 };
125 
126 static int qcom_osm_l3_set(struct icc_node *src, struct icc_node *dst)
127 {
128 	struct qcom_osm_l3_icc_provider *qp;
129 	struct icc_provider *provider;
130 	const struct qcom_osm_l3_node *qn;
131 	unsigned int index;
132 	u64 rate;
133 
134 	qn = src->data;
135 	provider = src->provider;
136 	qp = to_osm_l3_provider(provider);
137 
138 	rate = icc_units_to_bps(dst->peak_bw);
139 	do_div(rate, qn->buswidth);
140 
141 	for (index = 0; index < qp->max_state - 1; index++) {
142 		if (qp->lut_tables[index] >= rate)
143 			break;
144 	}
145 
146 	writel_relaxed(index, qp->base + qp->reg_perf_state);
147 
148 	return 0;
149 }
150 
151 static int qcom_osm_l3_remove(struct platform_device *pdev)
152 {
153 	struct qcom_osm_l3_icc_provider *qp = platform_get_drvdata(pdev);
154 
155 	icc_provider_deregister(&qp->provider);
156 	icc_nodes_remove(&qp->provider);
157 
158 	return 0;
159 }
160 
161 static int qcom_osm_l3_probe(struct platform_device *pdev)
162 {
163 	u32 info, src, lval, i, prev_freq = 0, freq;
164 	static unsigned long hw_rate, xo_rate;
165 	struct qcom_osm_l3_icc_provider *qp;
166 	const struct qcom_osm_l3_desc *desc;
167 	struct icc_onecell_data *data;
168 	struct icc_provider *provider;
169 	const struct qcom_osm_l3_node * const *qnodes;
170 	struct icc_node *node;
171 	size_t num_nodes;
172 	struct clk *clk;
173 	int ret;
174 
175 	clk = clk_get(&pdev->dev, "xo");
176 	if (IS_ERR(clk))
177 		return PTR_ERR(clk);
178 
179 	xo_rate = clk_get_rate(clk);
180 	clk_put(clk);
181 
182 	clk = clk_get(&pdev->dev, "alternate");
183 	if (IS_ERR(clk))
184 		return PTR_ERR(clk);
185 
186 	hw_rate = clk_get_rate(clk) / CLK_HW_DIV;
187 	clk_put(clk);
188 
189 	qp = devm_kzalloc(&pdev->dev, sizeof(*qp), GFP_KERNEL);
190 	if (!qp)
191 		return -ENOMEM;
192 
193 	qp->base = devm_platform_ioremap_resource(pdev, 0);
194 	if (IS_ERR(qp->base))
195 		return PTR_ERR(qp->base);
196 
197 	/* HW should be in enabled state to proceed */
198 	if (!(readl_relaxed(qp->base + REG_ENABLE) & 0x1)) {
199 		dev_err(&pdev->dev, "error hardware not enabled\n");
200 		return -ENODEV;
201 	}
202 
203 	desc = device_get_match_data(&pdev->dev);
204 	if (!desc)
205 		return -EINVAL;
206 
207 	qp->reg_perf_state = desc->reg_perf_state;
208 
209 	for (i = 0; i < LUT_MAX_ENTRIES; i++) {
210 		info = readl_relaxed(qp->base + desc->reg_freq_lut +
211 				     i * desc->lut_row_size);
212 		src = FIELD_GET(LUT_SRC, info);
213 		lval = FIELD_GET(LUT_L_VAL, info);
214 		if (src)
215 			freq = xo_rate * lval;
216 		else
217 			freq = hw_rate;
218 
219 		/* Two of the same frequencies signify end of table */
220 		if (i > 0 && prev_freq == freq)
221 			break;
222 
223 		dev_dbg(&pdev->dev, "index=%d freq=%d\n", i, freq);
224 
225 		qp->lut_tables[i] = freq;
226 		prev_freq = freq;
227 	}
228 	qp->max_state = i;
229 
230 	qnodes = desc->nodes;
231 	num_nodes = desc->num_nodes;
232 
233 	data = devm_kzalloc(&pdev->dev, struct_size(data, nodes, num_nodes), GFP_KERNEL);
234 	if (!data)
235 		return -ENOMEM;
236 	data->num_nodes = num_nodes;
237 
238 	provider = &qp->provider;
239 	provider->dev = &pdev->dev;
240 	provider->set = qcom_osm_l3_set;
241 	provider->aggregate = icc_std_aggregate;
242 	provider->xlate = of_icc_xlate_onecell;
243 	provider->data = data;
244 
245 	icc_provider_init(provider);
246 
247 	for (i = 0; i < num_nodes; i++) {
248 		size_t j;
249 
250 		node = icc_node_create(qnodes[i]->id);
251 		if (IS_ERR(node)) {
252 			ret = PTR_ERR(node);
253 			goto err;
254 		}
255 
256 		node->name = qnodes[i]->name;
257 		/* Cast away const and add it back in qcom_osm_l3_set() */
258 		node->data = (void *)qnodes[i];
259 		icc_node_add(node, provider);
260 
261 		for (j = 0; j < qnodes[i]->num_links; j++)
262 			icc_link_create(node, qnodes[i]->links[j]);
263 
264 		data->nodes[i] = node;
265 	}
266 
267 	ret = icc_provider_register(provider);
268 	if (ret)
269 		goto err;
270 
271 	platform_set_drvdata(pdev, qp);
272 
273 	return 0;
274 err:
275 	icc_nodes_remove(provider);
276 
277 	return ret;
278 }
279 
280 static const struct of_device_id osm_l3_of_match[] = {
281 	{ .compatible = "qcom,epss-l3", .data = &epss_l3_l3_vote },
282 	{ .compatible = "qcom,osm-l3", .data = &osm_l3 },
283 	{ .compatible = "qcom,sc7180-osm-l3", .data = &osm_l3 },
284 	{ .compatible = "qcom,sc7280-epss-l3", .data = &epss_l3_perf_state },
285 	{ .compatible = "qcom,sdm845-osm-l3", .data = &osm_l3 },
286 	{ .compatible = "qcom,sm8150-osm-l3", .data = &osm_l3 },
287 	{ .compatible = "qcom,sc8180x-osm-l3", .data = &osm_l3 },
288 	{ .compatible = "qcom,sm8250-epss-l3", .data = &epss_l3_perf_state },
289 	{ }
290 };
291 MODULE_DEVICE_TABLE(of, osm_l3_of_match);
292 
293 static struct platform_driver osm_l3_driver = {
294 	.probe = qcom_osm_l3_probe,
295 	.remove = qcom_osm_l3_remove,
296 	.driver = {
297 		.name = "osm-l3",
298 		.of_match_table = osm_l3_of_match,
299 		.sync_state = icc_sync_state,
300 	},
301 };
302 module_platform_driver(osm_l3_driver);
303 
304 MODULE_DESCRIPTION("Qualcomm OSM L3 interconnect driver");
305 MODULE_LICENSE("GPL v2");
306