xref: /openbmc/linux/drivers/clk/qcom/clk-rpmh.c (revision 0eb76ba2)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2018-2020, The Linux Foundation. All rights reserved.
4  */
5 
6 #include <linux/clk-provider.h>
7 #include <linux/err.h>
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/of.h>
11 #include <linux/of_device.h>
12 #include <linux/platform_device.h>
13 #include <soc/qcom/cmd-db.h>
14 #include <soc/qcom/rpmh.h>
15 #include <soc/qcom/tcs.h>
16 
17 #include <dt-bindings/clock/qcom,rpmh.h>
18 
19 #define CLK_RPMH_ARC_EN_OFFSET		0
20 #define CLK_RPMH_VRM_EN_OFFSET		4
21 
22 /**
23  * struct bcm_db - Auxiliary data pertaining to each Bus Clock Manager(BCM)
24  * @unit: divisor used to convert Hz value to an RPMh msg
25  * @width: multiplier used to convert Hz value to an RPMh msg
26  * @vcd: virtual clock domain that this bcm belongs to
27  * @reserved: reserved to pad the struct
28  */
29 struct bcm_db {
30 	__le32 unit;
31 	__le16 width;
32 	u8 vcd;
33 	u8 reserved;
34 };
35 
36 /**
37  * struct clk_rpmh - individual rpmh clock data structure
38  * @hw:			handle between common and hardware-specific interfaces
39  * @res_name:		resource name for the rpmh clock
40  * @div:		clock divider to compute the clock rate
41  * @res_addr:		base address of the rpmh resource within the RPMh
42  * @res_on_val:		rpmh clock enable value
43  * @state:		rpmh clock requested state
44  * @aggr_state:		rpmh clock aggregated state
45  * @last_sent_aggr_state: rpmh clock last aggr state sent to RPMh
46  * @valid_state_mask:	mask to determine the state of the rpmh clock
47  * @unit:		divisor to convert rate to rpmh msg in magnitudes of Khz
48  * @dev:		device to which it is attached
49  * @peer:		pointer to the clock rpmh sibling
50  */
51 struct clk_rpmh {
52 	struct clk_hw hw;
53 	const char *res_name;
54 	u8 div;
55 	u32 res_addr;
56 	u32 res_on_val;
57 	u32 state;
58 	u32 aggr_state;
59 	u32 last_sent_aggr_state;
60 	u32 valid_state_mask;
61 	u32 unit;
62 	struct device *dev;
63 	struct clk_rpmh *peer;
64 };
65 
66 struct clk_rpmh_desc {
67 	struct clk_hw **clks;
68 	size_t num_clks;
69 };
70 
71 static DEFINE_MUTEX(rpmh_clk_lock);
72 
73 #define __DEFINE_CLK_RPMH(_platform, _name, _name_active, _res_name,	\
74 			  _res_en_offset, _res_on, _div)		\
75 	static struct clk_rpmh _platform##_##_name_active;		\
76 	static struct clk_rpmh _platform##_##_name = {			\
77 		.res_name = _res_name,					\
78 		.res_addr = _res_en_offset,				\
79 		.res_on_val = _res_on,					\
80 		.div = _div,						\
81 		.peer = &_platform##_##_name_active,			\
82 		.valid_state_mask = (BIT(RPMH_WAKE_ONLY_STATE) |	\
83 				      BIT(RPMH_ACTIVE_ONLY_STATE) |	\
84 				      BIT(RPMH_SLEEP_STATE)),		\
85 		.hw.init = &(struct clk_init_data){			\
86 			.ops = &clk_rpmh_ops,				\
87 			.name = #_name,					\
88 			.parent_data =  &(const struct clk_parent_data){ \
89 					.fw_name = "xo",		\
90 					.name = "xo_board",		\
91 			},						\
92 			.num_parents = 1,				\
93 		},							\
94 	};								\
95 	static struct clk_rpmh _platform##_##_name_active = {		\
96 		.res_name = _res_name,					\
97 		.res_addr = _res_en_offset,				\
98 		.res_on_val = _res_on,					\
99 		.div = _div,						\
100 		.peer = &_platform##_##_name,				\
101 		.valid_state_mask = (BIT(RPMH_WAKE_ONLY_STATE) |	\
102 					BIT(RPMH_ACTIVE_ONLY_STATE)),	\
103 		.hw.init = &(struct clk_init_data){			\
104 			.ops = &clk_rpmh_ops,				\
105 			.name = #_name_active,				\
106 			.parent_data =  &(const struct clk_parent_data){ \
107 					.fw_name = "xo",		\
108 					.name = "xo_board",		\
109 			},						\
110 			.num_parents = 1,				\
111 		},							\
112 	}
113 
114 #define DEFINE_CLK_RPMH_ARC(_platform, _name, _name_active, _res_name,	\
115 			    _res_on, _div)				\
116 	__DEFINE_CLK_RPMH(_platform, _name, _name_active, _res_name,	\
117 			  CLK_RPMH_ARC_EN_OFFSET, _res_on, _div)
118 
119 #define DEFINE_CLK_RPMH_VRM(_platform, _name, _name_active, _res_name,	\
120 				_div)					\
121 	__DEFINE_CLK_RPMH(_platform, _name, _name_active, _res_name,	\
122 			  CLK_RPMH_VRM_EN_OFFSET, 1, _div)
123 
124 #define DEFINE_CLK_RPMH_BCM(_platform, _name, _res_name)		\
125 	static struct clk_rpmh _platform##_##_name = {			\
126 		.res_name = _res_name,					\
127 		.valid_state_mask = BIT(RPMH_ACTIVE_ONLY_STATE),	\
128 		.div = 1,						\
129 		.hw.init = &(struct clk_init_data){			\
130 			.ops = &clk_rpmh_bcm_ops,			\
131 			.name = #_name,					\
132 		},							\
133 	}
134 
135 static inline struct clk_rpmh *to_clk_rpmh(struct clk_hw *_hw)
136 {
137 	return container_of(_hw, struct clk_rpmh, hw);
138 }
139 
140 static inline bool has_state_changed(struct clk_rpmh *c, u32 state)
141 {
142 	return (c->last_sent_aggr_state & BIT(state))
143 		!= (c->aggr_state & BIT(state));
144 }
145 
146 static int clk_rpmh_send(struct clk_rpmh *c, enum rpmh_state state,
147 			 struct tcs_cmd *cmd, bool wait)
148 {
149 	if (wait)
150 		return rpmh_write(c->dev, state, cmd, 1);
151 
152 	return rpmh_write_async(c->dev, state, cmd, 1);
153 }
154 
155 static int clk_rpmh_send_aggregate_command(struct clk_rpmh *c)
156 {
157 	struct tcs_cmd cmd = { 0 };
158 	u32 cmd_state, on_val;
159 	enum rpmh_state state = RPMH_SLEEP_STATE;
160 	int ret;
161 	bool wait;
162 
163 	cmd.addr = c->res_addr;
164 	cmd_state = c->aggr_state;
165 	on_val = c->res_on_val;
166 
167 	for (; state <= RPMH_ACTIVE_ONLY_STATE; state++) {
168 		if (has_state_changed(c, state)) {
169 			if (cmd_state & BIT(state))
170 				cmd.data = on_val;
171 
172 			wait = cmd_state && state == RPMH_ACTIVE_ONLY_STATE;
173 			ret = clk_rpmh_send(c, state, &cmd, wait);
174 			if (ret) {
175 				dev_err(c->dev, "set %s state of %s failed: (%d)\n",
176 					!state ? "sleep" :
177 					state == RPMH_WAKE_ONLY_STATE	?
178 					"wake" : "active", c->res_name, ret);
179 				return ret;
180 			}
181 		}
182 	}
183 
184 	c->last_sent_aggr_state = c->aggr_state;
185 	c->peer->last_sent_aggr_state =  c->last_sent_aggr_state;
186 
187 	return 0;
188 }
189 
190 /*
191  * Update state and aggregate state values based on enable value.
192  */
193 static int clk_rpmh_aggregate_state_send_command(struct clk_rpmh *c,
194 						bool enable)
195 {
196 	int ret;
197 
198 	/* Nothing required to be done if already off or on */
199 	if (enable == c->state)
200 		return 0;
201 
202 	c->state = enable ? c->valid_state_mask : 0;
203 	c->aggr_state = c->state | c->peer->state;
204 	c->peer->aggr_state = c->aggr_state;
205 
206 	ret = clk_rpmh_send_aggregate_command(c);
207 	if (!ret)
208 		return 0;
209 
210 	if (ret && enable)
211 		c->state = 0;
212 	else if (ret)
213 		c->state = c->valid_state_mask;
214 
215 	WARN(1, "clk: %s failed to %s\n", c->res_name,
216 	     enable ? "enable" : "disable");
217 	return ret;
218 }
219 
220 static int clk_rpmh_prepare(struct clk_hw *hw)
221 {
222 	struct clk_rpmh *c = to_clk_rpmh(hw);
223 	int ret = 0;
224 
225 	mutex_lock(&rpmh_clk_lock);
226 	ret = clk_rpmh_aggregate_state_send_command(c, true);
227 	mutex_unlock(&rpmh_clk_lock);
228 
229 	return ret;
230 }
231 
232 static void clk_rpmh_unprepare(struct clk_hw *hw)
233 {
234 	struct clk_rpmh *c = to_clk_rpmh(hw);
235 
236 	mutex_lock(&rpmh_clk_lock);
237 	clk_rpmh_aggregate_state_send_command(c, false);
238 	mutex_unlock(&rpmh_clk_lock);
239 };
240 
241 static unsigned long clk_rpmh_recalc_rate(struct clk_hw *hw,
242 					unsigned long prate)
243 {
244 	struct clk_rpmh *r = to_clk_rpmh(hw);
245 
246 	/*
247 	 * RPMh clocks have a fixed rate. Return static rate.
248 	 */
249 	return prate / r->div;
250 }
251 
252 static const struct clk_ops clk_rpmh_ops = {
253 	.prepare	= clk_rpmh_prepare,
254 	.unprepare	= clk_rpmh_unprepare,
255 	.recalc_rate	= clk_rpmh_recalc_rate,
256 };
257 
258 static int clk_rpmh_bcm_send_cmd(struct clk_rpmh *c, bool enable)
259 {
260 	struct tcs_cmd cmd = { 0 };
261 	u32 cmd_state;
262 	int ret = 0;
263 
264 	mutex_lock(&rpmh_clk_lock);
265 	if (enable) {
266 		cmd_state = 1;
267 		if (c->aggr_state)
268 			cmd_state = c->aggr_state;
269 	} else {
270 		cmd_state = 0;
271 	}
272 
273 	if (c->last_sent_aggr_state != cmd_state) {
274 		cmd.addr = c->res_addr;
275 		cmd.data = BCM_TCS_CMD(1, enable, 0, cmd_state);
276 
277 		ret = clk_rpmh_send(c, RPMH_ACTIVE_ONLY_STATE, &cmd, enable);
278 		if (ret) {
279 			dev_err(c->dev, "set active state of %s failed: (%d)\n",
280 				c->res_name, ret);
281 		} else {
282 			c->last_sent_aggr_state = cmd_state;
283 		}
284 	}
285 
286 	mutex_unlock(&rpmh_clk_lock);
287 
288 	return ret;
289 }
290 
291 static int clk_rpmh_bcm_prepare(struct clk_hw *hw)
292 {
293 	struct clk_rpmh *c = to_clk_rpmh(hw);
294 
295 	return clk_rpmh_bcm_send_cmd(c, true);
296 }
297 
298 static void clk_rpmh_bcm_unprepare(struct clk_hw *hw)
299 {
300 	struct clk_rpmh *c = to_clk_rpmh(hw);
301 
302 	clk_rpmh_bcm_send_cmd(c, false);
303 }
304 
305 static int clk_rpmh_bcm_set_rate(struct clk_hw *hw, unsigned long rate,
306 				 unsigned long parent_rate)
307 {
308 	struct clk_rpmh *c = to_clk_rpmh(hw);
309 
310 	c->aggr_state = rate / c->unit;
311 	/*
312 	 * Since any non-zero value sent to hw would result in enabling the
313 	 * clock, only send the value if the clock has already been prepared.
314 	 */
315 	if (clk_hw_is_prepared(hw))
316 		clk_rpmh_bcm_send_cmd(c, true);
317 
318 	return 0;
319 }
320 
321 static long clk_rpmh_round_rate(struct clk_hw *hw, unsigned long rate,
322 				unsigned long *parent_rate)
323 {
324 	return rate;
325 }
326 
327 static unsigned long clk_rpmh_bcm_recalc_rate(struct clk_hw *hw,
328 					unsigned long prate)
329 {
330 	struct clk_rpmh *c = to_clk_rpmh(hw);
331 
332 	return c->aggr_state * c->unit;
333 }
334 
335 static const struct clk_ops clk_rpmh_bcm_ops = {
336 	.prepare	= clk_rpmh_bcm_prepare,
337 	.unprepare	= clk_rpmh_bcm_unprepare,
338 	.set_rate	= clk_rpmh_bcm_set_rate,
339 	.round_rate	= clk_rpmh_round_rate,
340 	.recalc_rate	= clk_rpmh_bcm_recalc_rate,
341 };
342 
343 /* Resource name must match resource id present in cmd-db */
344 DEFINE_CLK_RPMH_ARC(sdm845, bi_tcxo, bi_tcxo_ao, "xo.lvl", 0x3, 2);
345 DEFINE_CLK_RPMH_VRM(sdm845, ln_bb_clk2, ln_bb_clk2_ao, "lnbclka2", 2);
346 DEFINE_CLK_RPMH_VRM(sdm845, ln_bb_clk3, ln_bb_clk3_ao, "lnbclka3", 2);
347 DEFINE_CLK_RPMH_VRM(sdm845, rf_clk1, rf_clk1_ao, "rfclka1", 1);
348 DEFINE_CLK_RPMH_VRM(sdm845, rf_clk2, rf_clk2_ao, "rfclka2", 1);
349 DEFINE_CLK_RPMH_VRM(sdm845, rf_clk3, rf_clk3_ao, "rfclka3", 1);
350 DEFINE_CLK_RPMH_VRM(sm8150, rf_clk3, rf_clk3_ao, "rfclka3", 1);
351 DEFINE_CLK_RPMH_BCM(sdm845, ipa, "IP0");
352 DEFINE_CLK_RPMH_BCM(sdm845, ce, "CE0");
353 
354 static struct clk_hw *sdm845_rpmh_clocks[] = {
355 	[RPMH_CXO_CLK]		= &sdm845_bi_tcxo.hw,
356 	[RPMH_CXO_CLK_A]	= &sdm845_bi_tcxo_ao.hw,
357 	[RPMH_LN_BB_CLK2]	= &sdm845_ln_bb_clk2.hw,
358 	[RPMH_LN_BB_CLK2_A]	= &sdm845_ln_bb_clk2_ao.hw,
359 	[RPMH_LN_BB_CLK3]	= &sdm845_ln_bb_clk3.hw,
360 	[RPMH_LN_BB_CLK3_A]	= &sdm845_ln_bb_clk3_ao.hw,
361 	[RPMH_RF_CLK1]		= &sdm845_rf_clk1.hw,
362 	[RPMH_RF_CLK1_A]	= &sdm845_rf_clk1_ao.hw,
363 	[RPMH_RF_CLK2]		= &sdm845_rf_clk2.hw,
364 	[RPMH_RF_CLK2_A]	= &sdm845_rf_clk2_ao.hw,
365 	[RPMH_RF_CLK3]		= &sdm845_rf_clk3.hw,
366 	[RPMH_RF_CLK3_A]	= &sdm845_rf_clk3_ao.hw,
367 	[RPMH_IPA_CLK]		= &sdm845_ipa.hw,
368 	[RPMH_CE_CLK]		= &sdm845_ce.hw,
369 };
370 
371 static const struct clk_rpmh_desc clk_rpmh_sdm845 = {
372 	.clks = sdm845_rpmh_clocks,
373 	.num_clks = ARRAY_SIZE(sdm845_rpmh_clocks),
374 };
375 
376 DEFINE_CLK_RPMH_VRM(sdx55, rf_clk1, rf_clk1_ao, "rfclkd1", 1);
377 DEFINE_CLK_RPMH_VRM(sdx55, rf_clk2, rf_clk2_ao, "rfclkd2", 1);
378 DEFINE_CLK_RPMH_BCM(sdx55, qpic_clk, "QP0");
379 
380 static struct clk_hw *sdx55_rpmh_clocks[] = {
381 	[RPMH_CXO_CLK]		= &sdm845_bi_tcxo.hw,
382 	[RPMH_CXO_CLK_A]	= &sdm845_bi_tcxo_ao.hw,
383 	[RPMH_RF_CLK1]		= &sdx55_rf_clk1.hw,
384 	[RPMH_RF_CLK1_A]	= &sdx55_rf_clk1_ao.hw,
385 	[RPMH_RF_CLK2]		= &sdx55_rf_clk2.hw,
386 	[RPMH_RF_CLK2_A]	= &sdx55_rf_clk2_ao.hw,
387 	[RPMH_QPIC_CLK]		= &sdx55_qpic_clk.hw,
388 };
389 
390 static const struct clk_rpmh_desc clk_rpmh_sdx55 = {
391 	.clks = sdx55_rpmh_clocks,
392 	.num_clks = ARRAY_SIZE(sdx55_rpmh_clocks),
393 };
394 
395 static struct clk_hw *sm8150_rpmh_clocks[] = {
396 	[RPMH_CXO_CLK]		= &sdm845_bi_tcxo.hw,
397 	[RPMH_CXO_CLK_A]	= &sdm845_bi_tcxo_ao.hw,
398 	[RPMH_LN_BB_CLK2]	= &sdm845_ln_bb_clk2.hw,
399 	[RPMH_LN_BB_CLK2_A]	= &sdm845_ln_bb_clk2_ao.hw,
400 	[RPMH_LN_BB_CLK3]	= &sdm845_ln_bb_clk3.hw,
401 	[RPMH_LN_BB_CLK3_A]	= &sdm845_ln_bb_clk3_ao.hw,
402 	[RPMH_RF_CLK1]		= &sdm845_rf_clk1.hw,
403 	[RPMH_RF_CLK1_A]	= &sdm845_rf_clk1_ao.hw,
404 	[RPMH_RF_CLK2]		= &sdm845_rf_clk2.hw,
405 	[RPMH_RF_CLK2_A]	= &sdm845_rf_clk2_ao.hw,
406 	[RPMH_RF_CLK3]		= &sdm845_rf_clk3.hw,
407 	[RPMH_RF_CLK3_A]	= &sdm845_rf_clk3_ao.hw,
408 };
409 
410 static const struct clk_rpmh_desc clk_rpmh_sm8150 = {
411 	.clks = sm8150_rpmh_clocks,
412 	.num_clks = ARRAY_SIZE(sm8150_rpmh_clocks),
413 };
414 
415 static struct clk_hw *sc7180_rpmh_clocks[] = {
416 	[RPMH_CXO_CLK]		= &sdm845_bi_tcxo.hw,
417 	[RPMH_CXO_CLK_A]	= &sdm845_bi_tcxo_ao.hw,
418 	[RPMH_LN_BB_CLK2]	= &sdm845_ln_bb_clk2.hw,
419 	[RPMH_LN_BB_CLK2_A]	= &sdm845_ln_bb_clk2_ao.hw,
420 	[RPMH_LN_BB_CLK3]	= &sdm845_ln_bb_clk3.hw,
421 	[RPMH_LN_BB_CLK3_A]	= &sdm845_ln_bb_clk3_ao.hw,
422 	[RPMH_RF_CLK1]		= &sdm845_rf_clk1.hw,
423 	[RPMH_RF_CLK1_A]	= &sdm845_rf_clk1_ao.hw,
424 	[RPMH_RF_CLK2]		= &sdm845_rf_clk2.hw,
425 	[RPMH_RF_CLK2_A]	= &sdm845_rf_clk2_ao.hw,
426 	[RPMH_IPA_CLK]		= &sdm845_ipa.hw,
427 };
428 
429 static const struct clk_rpmh_desc clk_rpmh_sc7180 = {
430 	.clks = sc7180_rpmh_clocks,
431 	.num_clks = ARRAY_SIZE(sc7180_rpmh_clocks),
432 };
433 
434 DEFINE_CLK_RPMH_VRM(sm8250, ln_bb_clk1, ln_bb_clk1_ao, "lnbclka1", 2);
435 
436 static struct clk_hw *sm8250_rpmh_clocks[] = {
437 	[RPMH_CXO_CLK]		= &sdm845_bi_tcxo.hw,
438 	[RPMH_CXO_CLK_A]	= &sdm845_bi_tcxo_ao.hw,
439 	[RPMH_LN_BB_CLK1]	= &sm8250_ln_bb_clk1.hw,
440 	[RPMH_LN_BB_CLK1_A]	= &sm8250_ln_bb_clk1_ao.hw,
441 	[RPMH_LN_BB_CLK2]	= &sdm845_ln_bb_clk2.hw,
442 	[RPMH_LN_BB_CLK2_A]	= &sdm845_ln_bb_clk2_ao.hw,
443 	[RPMH_LN_BB_CLK3]	= &sdm845_ln_bb_clk3.hw,
444 	[RPMH_LN_BB_CLK3_A]	= &sdm845_ln_bb_clk3_ao.hw,
445 	[RPMH_RF_CLK1]		= &sdm845_rf_clk1.hw,
446 	[RPMH_RF_CLK1_A]	= &sdm845_rf_clk1_ao.hw,
447 	[RPMH_RF_CLK3]		= &sdm845_rf_clk3.hw,
448 	[RPMH_RF_CLK3_A]	= &sdm845_rf_clk3_ao.hw,
449 };
450 
451 static const struct clk_rpmh_desc clk_rpmh_sm8250 = {
452 	.clks = sm8250_rpmh_clocks,
453 	.num_clks = ARRAY_SIZE(sm8250_rpmh_clocks),
454 };
455 
456 DEFINE_CLK_RPMH_VRM(sm8350, div_clk1, div_clk1_ao, "divclka1", 2);
457 DEFINE_CLK_RPMH_VRM(sm8350, rf_clk4, rf_clk4_ao, "rfclka4", 1);
458 DEFINE_CLK_RPMH_VRM(sm8350, rf_clk5, rf_clk5_ao, "rfclka5", 1);
459 DEFINE_CLK_RPMH_BCM(sm8350, pka, "PKA0");
460 DEFINE_CLK_RPMH_BCM(sm8350, hwkm, "HK0");
461 
462 static struct clk_hw *sm8350_rpmh_clocks[] = {
463 	[RPMH_CXO_CLK]		= &sdm845_bi_tcxo.hw,
464 	[RPMH_CXO_CLK_A]	= &sdm845_bi_tcxo_ao.hw,
465 	[RPMH_DIV_CLK1]		= &sm8350_div_clk1.hw,
466 	[RPMH_DIV_CLK1_A]	= &sm8350_div_clk1_ao.hw,
467 	[RPMH_LN_BB_CLK1]	= &sm8250_ln_bb_clk1.hw,
468 	[RPMH_LN_BB_CLK1_A]	= &sm8250_ln_bb_clk1_ao.hw,
469 	[RPMH_LN_BB_CLK2]	= &sdm845_ln_bb_clk2.hw,
470 	[RPMH_LN_BB_CLK2_A]	= &sdm845_ln_bb_clk2_ao.hw,
471 	[RPMH_RF_CLK1]		= &sdm845_rf_clk1.hw,
472 	[RPMH_RF_CLK1_A]	= &sdm845_rf_clk1_ao.hw,
473 	[RPMH_RF_CLK3]		= &sdm845_rf_clk3.hw,
474 	[RPMH_RF_CLK3_A]	= &sdm845_rf_clk3_ao.hw,
475 	[RPMH_RF_CLK4]		= &sm8350_rf_clk4.hw,
476 	[RPMH_RF_CLK4_A]	= &sm8350_rf_clk4_ao.hw,
477 	[RPMH_RF_CLK5]		= &sm8350_rf_clk5.hw,
478 	[RPMH_RF_CLK5_A]	= &sm8350_rf_clk5_ao.hw,
479 	[RPMH_IPA_CLK]		= &sdm845_ipa.hw,
480 	[RPMH_PKA_CLK]		= &sm8350_pka.hw,
481 	[RPMH_HWKM_CLK]		= &sm8350_hwkm.hw,
482 };
483 
484 static const struct clk_rpmh_desc clk_rpmh_sm8350 = {
485 	.clks = sm8350_rpmh_clocks,
486 	.num_clks = ARRAY_SIZE(sm8350_rpmh_clocks),
487 };
488 
489 static struct clk_hw *of_clk_rpmh_hw_get(struct of_phandle_args *clkspec,
490 					 void *data)
491 {
492 	struct clk_rpmh_desc *rpmh = data;
493 	unsigned int idx = clkspec->args[0];
494 
495 	if (idx >= rpmh->num_clks) {
496 		pr_err("%s: invalid index %u\n", __func__, idx);
497 		return ERR_PTR(-EINVAL);
498 	}
499 
500 	return rpmh->clks[idx];
501 }
502 
503 static int clk_rpmh_probe(struct platform_device *pdev)
504 {
505 	struct clk_hw **hw_clks;
506 	struct clk_rpmh *rpmh_clk;
507 	const struct clk_rpmh_desc *desc;
508 	int ret, i;
509 
510 	desc = of_device_get_match_data(&pdev->dev);
511 	if (!desc)
512 		return -ENODEV;
513 
514 	hw_clks = desc->clks;
515 
516 	for (i = 0; i < desc->num_clks; i++) {
517 		const char *name;
518 		u32 res_addr;
519 		size_t aux_data_len;
520 		const struct bcm_db *data;
521 
522 		if (!hw_clks[i])
523 			continue;
524 
525 		name = hw_clks[i]->init->name;
526 
527 		rpmh_clk = to_clk_rpmh(hw_clks[i]);
528 		res_addr = cmd_db_read_addr(rpmh_clk->res_name);
529 		if (!res_addr) {
530 			dev_err(&pdev->dev, "missing RPMh resource address for %s\n",
531 				rpmh_clk->res_name);
532 			return -ENODEV;
533 		}
534 
535 		data = cmd_db_read_aux_data(rpmh_clk->res_name, &aux_data_len);
536 		if (IS_ERR(data)) {
537 			ret = PTR_ERR(data);
538 			dev_err(&pdev->dev,
539 				"error reading RPMh aux data for %s (%d)\n",
540 				rpmh_clk->res_name, ret);
541 			return ret;
542 		}
543 
544 		/* Convert unit from Khz to Hz */
545 		if (aux_data_len == sizeof(*data))
546 			rpmh_clk->unit = le32_to_cpu(data->unit) * 1000ULL;
547 
548 		rpmh_clk->res_addr += res_addr;
549 		rpmh_clk->dev = &pdev->dev;
550 
551 		ret = devm_clk_hw_register(&pdev->dev, hw_clks[i]);
552 		if (ret) {
553 			dev_err(&pdev->dev, "failed to register %s\n", name);
554 			return ret;
555 		}
556 	}
557 
558 	/* typecast to silence compiler warning */
559 	ret = devm_of_clk_add_hw_provider(&pdev->dev, of_clk_rpmh_hw_get,
560 					  (void *)desc);
561 	if (ret) {
562 		dev_err(&pdev->dev, "Failed to add clock provider\n");
563 		return ret;
564 	}
565 
566 	dev_dbg(&pdev->dev, "Registered RPMh clocks\n");
567 
568 	return 0;
569 }
570 
571 static const struct of_device_id clk_rpmh_match_table[] = {
572 	{ .compatible = "qcom,sc7180-rpmh-clk", .data = &clk_rpmh_sc7180},
573 	{ .compatible = "qcom,sdm845-rpmh-clk", .data = &clk_rpmh_sdm845},
574 	{ .compatible = "qcom,sdx55-rpmh-clk",  .data = &clk_rpmh_sdx55},
575 	{ .compatible = "qcom,sm8150-rpmh-clk", .data = &clk_rpmh_sm8150},
576 	{ .compatible = "qcom,sm8250-rpmh-clk", .data = &clk_rpmh_sm8250},
577 	{ .compatible = "qcom,sm8350-rpmh-clk", .data = &clk_rpmh_sm8350},
578 	{ }
579 };
580 MODULE_DEVICE_TABLE(of, clk_rpmh_match_table);
581 
582 static struct platform_driver clk_rpmh_driver = {
583 	.probe		= clk_rpmh_probe,
584 	.driver		= {
585 		.name	= "clk-rpmh",
586 		.of_match_table = clk_rpmh_match_table,
587 	},
588 };
589 
590 static int __init clk_rpmh_init(void)
591 {
592 	return platform_driver_register(&clk_rpmh_driver);
593 }
594 core_initcall(clk_rpmh_init);
595 
596 static void __exit clk_rpmh_exit(void)
597 {
598 	platform_driver_unregister(&clk_rpmh_driver);
599 }
600 module_exit(clk_rpmh_exit);
601 
602 MODULE_DESCRIPTION("QCOM RPMh Clock Driver");
603 MODULE_LICENSE("GPL v2");
604