1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2016, Linaro Limited
4 * Copyright (c) 2014, The Linux Foundation. All rights reserved.
7 #include <linux/clk-provider.h>
9 #include <linux/export.h>
10 #include <linux/init.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/mfd/qcom_rpm.h>
16 #include <linux/of_device.h>
17 #include <linux/platform_device.h>
19 #include <dt-bindings/mfd/qcom-rpm.h>
20 #include <dt-bindings/clock/qcom,rpmcc.h>
22 #define QCOM_RPM_MISC_CLK_TYPE 0x306b6c63
23 #define QCOM_RPM_SCALING_ENABLE_ID 0x2
24 #define QCOM_RPM_XO_MODE_ON 0x2
26 static const struct clk_parent_data gcc_pxo[] = {
27 { .fw_name = "pxo", .name = "pxo_board" },
30 static const struct clk_parent_data gcc_cxo[] = {
31 { .fw_name = "cxo", .name = "cxo_board" },
34 #define DEFINE_CLK_RPM(_name, r_id) \
35 static struct clk_rpm clk_rpm_##_name##_a_clk; \
36 static struct clk_rpm clk_rpm_##_name##_clk = { \
37 .rpm_clk_id = (r_id), \
38 .peer = &clk_rpm_##_name##_a_clk, \
40 .hw.init = &(struct clk_init_data){ \
41 .ops = &clk_rpm_ops, \
42 .name = #_name "_clk", \
43 .parent_data = gcc_pxo, \
44 .num_parents = ARRAY_SIZE(gcc_pxo), \
47 static struct clk_rpm clk_rpm_##_name##_a_clk = { \
48 .rpm_clk_id = (r_id), \
49 .peer = &clk_rpm_##_name##_clk, \
50 .active_only = true, \
52 .hw.init = &(struct clk_init_data){ \
53 .ops = &clk_rpm_ops, \
54 .name = #_name "_a_clk", \
55 .parent_data = gcc_pxo, \
56 .num_parents = ARRAY_SIZE(gcc_pxo), \
60 #define DEFINE_CLK_RPM_XO_BUFFER(_name, offset) \
61 static struct clk_rpm clk_rpm_##_name##_clk = { \
62 .rpm_clk_id = QCOM_RPM_CXO_BUFFERS, \
63 .xo_offset = (offset), \
64 .hw.init = &(struct clk_init_data){ \
65 .ops = &clk_rpm_xo_ops, \
66 .name = #_name "_clk", \
67 .parent_data = gcc_cxo, \
68 .num_parents = ARRAY_SIZE(gcc_cxo), \
72 #define DEFINE_CLK_RPM_FIXED(_name, r_id, r) \
73 static struct clk_rpm clk_rpm_##_name##_clk = { \
74 .rpm_clk_id = (r_id), \
76 .hw.init = &(struct clk_init_data){ \
77 .ops = &clk_rpm_fixed_ops, \
78 .name = #_name "_clk", \
79 .parent_data = gcc_pxo, \
80 .num_parents = ARRAY_SIZE(gcc_pxo), \
84 #define to_clk_rpm(_hw) container_of(_hw, struct clk_rpm, hw)
91 const bool active_only;
98 struct rpm_cc *rpm_cc;
102 struct qcom_rpm *rpm;
103 struct clk_rpm **clks;
106 struct mutex xo_lock;
109 struct rpm_clk_desc {
110 struct clk_rpm **clks;
114 static DEFINE_MUTEX(rpm_clk_lock);
116 static int clk_rpm_handoff(struct clk_rpm *r)
122 * The vendor tree simply reads the status for this
125 if (r->rpm_clk_id == QCOM_RPM_PLL_4 ||
126 r->rpm_clk_id == QCOM_RPM_CXO_BUFFERS)
129 ret = qcom_rpm_write(r->rpm, QCOM_RPM_ACTIVE_STATE,
130 r->rpm_clk_id, &value, 1);
133 ret = qcom_rpm_write(r->rpm, QCOM_RPM_SLEEP_STATE,
134 r->rpm_clk_id, &value, 1);
141 static int clk_rpm_set_rate_active(struct clk_rpm *r, unsigned long rate)
143 u32 value = DIV_ROUND_UP(rate, 1000); /* to kHz */
145 return qcom_rpm_write(r->rpm, QCOM_RPM_ACTIVE_STATE,
146 r->rpm_clk_id, &value, 1);
149 static int clk_rpm_set_rate_sleep(struct clk_rpm *r, unsigned long rate)
151 u32 value = DIV_ROUND_UP(rate, 1000); /* to kHz */
153 return qcom_rpm_write(r->rpm, QCOM_RPM_SLEEP_STATE,
154 r->rpm_clk_id, &value, 1);
157 static void to_active_sleep(struct clk_rpm *r, unsigned long rate,
158 unsigned long *active, unsigned long *sleep)
163 * Active-only clocks don't care what the rate is during sleep. So,
164 * they vote for zero.
172 static int clk_rpm_prepare(struct clk_hw *hw)
174 struct clk_rpm *r = to_clk_rpm(hw);
175 struct clk_rpm *peer = r->peer;
176 unsigned long this_rate = 0, this_sleep_rate = 0;
177 unsigned long peer_rate = 0, peer_sleep_rate = 0;
178 unsigned long active_rate, sleep_rate;
181 mutex_lock(&rpm_clk_lock);
183 /* Don't send requests to the RPM if the rate has not been set. */
187 to_active_sleep(r, r->rate, &this_rate, &this_sleep_rate);
189 /* Take peer clock's rate into account only if it's enabled. */
191 to_active_sleep(peer, peer->rate,
192 &peer_rate, &peer_sleep_rate);
194 active_rate = max(this_rate, peer_rate);
197 active_rate = !!active_rate;
199 ret = clk_rpm_set_rate_active(r, active_rate);
203 sleep_rate = max(this_sleep_rate, peer_sleep_rate);
205 sleep_rate = !!sleep_rate;
207 ret = clk_rpm_set_rate_sleep(r, sleep_rate);
209 /* Undo the active set vote and restore it */
210 ret = clk_rpm_set_rate_active(r, peer_rate);
216 mutex_unlock(&rpm_clk_lock);
221 static void clk_rpm_unprepare(struct clk_hw *hw)
223 struct clk_rpm *r = to_clk_rpm(hw);
224 struct clk_rpm *peer = r->peer;
225 unsigned long peer_rate = 0, peer_sleep_rate = 0;
226 unsigned long active_rate, sleep_rate;
229 mutex_lock(&rpm_clk_lock);
234 /* Take peer clock's rate into account only if it's enabled. */
236 to_active_sleep(peer, peer->rate, &peer_rate,
239 active_rate = r->branch ? !!peer_rate : peer_rate;
240 ret = clk_rpm_set_rate_active(r, active_rate);
244 sleep_rate = r->branch ? !!peer_sleep_rate : peer_sleep_rate;
245 ret = clk_rpm_set_rate_sleep(r, sleep_rate);
252 mutex_unlock(&rpm_clk_lock);
255 static int clk_rpm_xo_prepare(struct clk_hw *hw)
257 struct clk_rpm *r = to_clk_rpm(hw);
258 struct rpm_cc *rcc = r->rpm_cc;
259 int ret, clk_id = r->rpm_clk_id;
262 mutex_lock(&rcc->xo_lock);
264 value = rcc->xo_buffer_value | (QCOM_RPM_XO_MODE_ON << r->xo_offset);
265 ret = qcom_rpm_write(r->rpm, QCOM_RPM_ACTIVE_STATE, clk_id, &value, 1);
268 rcc->xo_buffer_value = value;
271 mutex_unlock(&rcc->xo_lock);
276 static void clk_rpm_xo_unprepare(struct clk_hw *hw)
278 struct clk_rpm *r = to_clk_rpm(hw);
279 struct rpm_cc *rcc = r->rpm_cc;
280 int ret, clk_id = r->rpm_clk_id;
283 mutex_lock(&rcc->xo_lock);
285 value = rcc->xo_buffer_value & ~(QCOM_RPM_XO_MODE_ON << r->xo_offset);
286 ret = qcom_rpm_write(r->rpm, QCOM_RPM_ACTIVE_STATE, clk_id, &value, 1);
289 rcc->xo_buffer_value = value;
292 mutex_unlock(&rcc->xo_lock);
295 static int clk_rpm_fixed_prepare(struct clk_hw *hw)
297 struct clk_rpm *r = to_clk_rpm(hw);
301 ret = qcom_rpm_write(r->rpm, QCOM_RPM_ACTIVE_STATE,
302 r->rpm_clk_id, &value, 1);
309 static void clk_rpm_fixed_unprepare(struct clk_hw *hw)
311 struct clk_rpm *r = to_clk_rpm(hw);
315 ret = qcom_rpm_write(r->rpm, QCOM_RPM_ACTIVE_STATE,
316 r->rpm_clk_id, &value, 1);
321 static int clk_rpm_set_rate(struct clk_hw *hw,
322 unsigned long rate, unsigned long parent_rate)
324 struct clk_rpm *r = to_clk_rpm(hw);
325 struct clk_rpm *peer = r->peer;
326 unsigned long active_rate, sleep_rate;
327 unsigned long this_rate = 0, this_sleep_rate = 0;
328 unsigned long peer_rate = 0, peer_sleep_rate = 0;
331 mutex_lock(&rpm_clk_lock);
336 to_active_sleep(r, rate, &this_rate, &this_sleep_rate);
338 /* Take peer clock's rate into account only if it's enabled. */
340 to_active_sleep(peer, peer->rate,
341 &peer_rate, &peer_sleep_rate);
343 active_rate = max(this_rate, peer_rate);
344 ret = clk_rpm_set_rate_active(r, active_rate);
348 sleep_rate = max(this_sleep_rate, peer_sleep_rate);
349 ret = clk_rpm_set_rate_sleep(r, sleep_rate);
356 mutex_unlock(&rpm_clk_lock);
361 static long clk_rpm_round_rate(struct clk_hw *hw, unsigned long rate,
362 unsigned long *parent_rate)
365 * RPM handles rate rounding and we don't have a way to
366 * know what the rate will be, so just return whatever
372 static unsigned long clk_rpm_recalc_rate(struct clk_hw *hw,
373 unsigned long parent_rate)
375 struct clk_rpm *r = to_clk_rpm(hw);
378 * RPM handles rate rounding and we don't have a way to
379 * know what the rate will be, so just return whatever
385 static const struct clk_ops clk_rpm_xo_ops = {
386 .prepare = clk_rpm_xo_prepare,
387 .unprepare = clk_rpm_xo_unprepare,
390 static const struct clk_ops clk_rpm_fixed_ops = {
391 .prepare = clk_rpm_fixed_prepare,
392 .unprepare = clk_rpm_fixed_unprepare,
393 .round_rate = clk_rpm_round_rate,
394 .recalc_rate = clk_rpm_recalc_rate,
397 static const struct clk_ops clk_rpm_ops = {
398 .prepare = clk_rpm_prepare,
399 .unprepare = clk_rpm_unprepare,
400 .set_rate = clk_rpm_set_rate,
401 .round_rate = clk_rpm_round_rate,
402 .recalc_rate = clk_rpm_recalc_rate,
405 DEFINE_CLK_RPM(afab, QCOM_RPM_APPS_FABRIC_CLK);
406 DEFINE_CLK_RPM(sfab, QCOM_RPM_SYS_FABRIC_CLK);
407 DEFINE_CLK_RPM(mmfab, QCOM_RPM_MM_FABRIC_CLK);
408 DEFINE_CLK_RPM(daytona, QCOM_RPM_DAYTONA_FABRIC_CLK);
409 DEFINE_CLK_RPM(sfpb, QCOM_RPM_SFPB_CLK);
410 DEFINE_CLK_RPM(cfpb, QCOM_RPM_CFPB_CLK);
411 DEFINE_CLK_RPM(mmfpb, QCOM_RPM_MMFPB_CLK);
412 DEFINE_CLK_RPM(smi, QCOM_RPM_SMI_CLK);
413 DEFINE_CLK_RPM(ebi1, QCOM_RPM_EBI1_CLK);
415 DEFINE_CLK_RPM(qdss, QCOM_RPM_QDSS_CLK);
416 DEFINE_CLK_RPM(nss_fabric_0, QCOM_RPM_NSS_FABRIC_0_CLK);
417 DEFINE_CLK_RPM(nss_fabric_1, QCOM_RPM_NSS_FABRIC_1_CLK);
419 DEFINE_CLK_RPM_FIXED(pll4, QCOM_RPM_PLL_4, 540672000);
421 DEFINE_CLK_RPM_XO_BUFFER(xo_d0, 0);
422 DEFINE_CLK_RPM_XO_BUFFER(xo_d1, 8);
423 DEFINE_CLK_RPM_XO_BUFFER(xo_a0, 16);
424 DEFINE_CLK_RPM_XO_BUFFER(xo_a1, 24);
425 DEFINE_CLK_RPM_XO_BUFFER(xo_a2, 28);
427 static struct clk_rpm *msm8660_clks[] = {
428 [RPM_APPS_FABRIC_CLK] = &clk_rpm_afab_clk,
429 [RPM_APPS_FABRIC_A_CLK] = &clk_rpm_afab_a_clk,
430 [RPM_SYS_FABRIC_CLK] = &clk_rpm_sfab_clk,
431 [RPM_SYS_FABRIC_A_CLK] = &clk_rpm_sfab_a_clk,
432 [RPM_MM_FABRIC_CLK] = &clk_rpm_mmfab_clk,
433 [RPM_MM_FABRIC_A_CLK] = &clk_rpm_mmfab_a_clk,
434 [RPM_DAYTONA_FABRIC_CLK] = &clk_rpm_daytona_clk,
435 [RPM_DAYTONA_FABRIC_A_CLK] = &clk_rpm_daytona_a_clk,
436 [RPM_SFPB_CLK] = &clk_rpm_sfpb_clk,
437 [RPM_SFPB_A_CLK] = &clk_rpm_sfpb_a_clk,
438 [RPM_CFPB_CLK] = &clk_rpm_cfpb_clk,
439 [RPM_CFPB_A_CLK] = &clk_rpm_cfpb_a_clk,
440 [RPM_MMFPB_CLK] = &clk_rpm_mmfpb_clk,
441 [RPM_MMFPB_A_CLK] = &clk_rpm_mmfpb_a_clk,
442 [RPM_SMI_CLK] = &clk_rpm_smi_clk,
443 [RPM_SMI_A_CLK] = &clk_rpm_smi_a_clk,
444 [RPM_EBI1_CLK] = &clk_rpm_ebi1_clk,
445 [RPM_EBI1_A_CLK] = &clk_rpm_ebi1_a_clk,
446 [RPM_PLL4_CLK] = &clk_rpm_pll4_clk,
449 static const struct rpm_clk_desc rpm_clk_msm8660 = {
450 .clks = msm8660_clks,
451 .num_clks = ARRAY_SIZE(msm8660_clks),
454 static struct clk_rpm *apq8064_clks[] = {
455 [RPM_APPS_FABRIC_CLK] = &clk_rpm_afab_clk,
456 [RPM_APPS_FABRIC_A_CLK] = &clk_rpm_afab_a_clk,
457 [RPM_CFPB_CLK] = &clk_rpm_cfpb_clk,
458 [RPM_CFPB_A_CLK] = &clk_rpm_cfpb_a_clk,
459 [RPM_DAYTONA_FABRIC_CLK] = &clk_rpm_daytona_clk,
460 [RPM_DAYTONA_FABRIC_A_CLK] = &clk_rpm_daytona_a_clk,
461 [RPM_EBI1_CLK] = &clk_rpm_ebi1_clk,
462 [RPM_EBI1_A_CLK] = &clk_rpm_ebi1_a_clk,
463 [RPM_MM_FABRIC_CLK] = &clk_rpm_mmfab_clk,
464 [RPM_MM_FABRIC_A_CLK] = &clk_rpm_mmfab_a_clk,
465 [RPM_MMFPB_CLK] = &clk_rpm_mmfpb_clk,
466 [RPM_MMFPB_A_CLK] = &clk_rpm_mmfpb_a_clk,
467 [RPM_SYS_FABRIC_CLK] = &clk_rpm_sfab_clk,
468 [RPM_SYS_FABRIC_A_CLK] = &clk_rpm_sfab_a_clk,
469 [RPM_SFPB_CLK] = &clk_rpm_sfpb_clk,
470 [RPM_SFPB_A_CLK] = &clk_rpm_sfpb_a_clk,
471 [RPM_QDSS_CLK] = &clk_rpm_qdss_clk,
472 [RPM_QDSS_A_CLK] = &clk_rpm_qdss_a_clk,
473 [RPM_XO_D0] = &clk_rpm_xo_d0_clk,
474 [RPM_XO_D1] = &clk_rpm_xo_d1_clk,
475 [RPM_XO_A0] = &clk_rpm_xo_a0_clk,
476 [RPM_XO_A1] = &clk_rpm_xo_a1_clk,
477 [RPM_XO_A2] = &clk_rpm_xo_a2_clk,
480 static const struct rpm_clk_desc rpm_clk_apq8064 = {
481 .clks = apq8064_clks,
482 .num_clks = ARRAY_SIZE(apq8064_clks),
485 static struct clk_rpm *ipq806x_clks[] = {
486 [RPM_APPS_FABRIC_CLK] = &clk_rpm_afab_clk,
487 [RPM_APPS_FABRIC_A_CLK] = &clk_rpm_afab_a_clk,
488 [RPM_CFPB_CLK] = &clk_rpm_cfpb_clk,
489 [RPM_CFPB_A_CLK] = &clk_rpm_cfpb_a_clk,
490 [RPM_DAYTONA_FABRIC_CLK] = &clk_rpm_daytona_clk,
491 [RPM_DAYTONA_FABRIC_A_CLK] = &clk_rpm_daytona_a_clk,
492 [RPM_EBI1_CLK] = &clk_rpm_ebi1_clk,
493 [RPM_EBI1_A_CLK] = &clk_rpm_ebi1_a_clk,
494 [RPM_SYS_FABRIC_CLK] = &clk_rpm_sfab_clk,
495 [RPM_SYS_FABRIC_A_CLK] = &clk_rpm_sfab_a_clk,
496 [RPM_SFPB_CLK] = &clk_rpm_sfpb_clk,
497 [RPM_SFPB_A_CLK] = &clk_rpm_sfpb_a_clk,
498 [RPM_NSS_FABRIC_0_CLK] = &clk_rpm_nss_fabric_0_clk,
499 [RPM_NSS_FABRIC_0_A_CLK] = &clk_rpm_nss_fabric_0_a_clk,
500 [RPM_NSS_FABRIC_1_CLK] = &clk_rpm_nss_fabric_1_clk,
501 [RPM_NSS_FABRIC_1_A_CLK] = &clk_rpm_nss_fabric_1_a_clk,
504 static const struct rpm_clk_desc rpm_clk_ipq806x = {
505 .clks = ipq806x_clks,
506 .num_clks = ARRAY_SIZE(ipq806x_clks),
509 static const struct of_device_id rpm_clk_match_table[] = {
510 { .compatible = "qcom,rpmcc-msm8660", .data = &rpm_clk_msm8660 },
511 { .compatible = "qcom,rpmcc-apq8060", .data = &rpm_clk_msm8660 },
512 { .compatible = "qcom,rpmcc-apq8064", .data = &rpm_clk_apq8064 },
513 { .compatible = "qcom,rpmcc-ipq806x", .data = &rpm_clk_ipq806x },
516 MODULE_DEVICE_TABLE(of, rpm_clk_match_table);
518 static struct clk_hw *qcom_rpm_clk_hw_get(struct of_phandle_args *clkspec,
521 struct rpm_cc *rcc = data;
522 unsigned int idx = clkspec->args[0];
524 if (idx >= rcc->num_clks) {
525 pr_err("%s: invalid index %u\n", __func__, idx);
526 return ERR_PTR(-EINVAL);
529 return rcc->clks[idx] ? &rcc->clks[idx]->hw : ERR_PTR(-ENOENT);
532 static int rpm_clk_probe(struct platform_device *pdev)
537 struct qcom_rpm *rpm;
538 struct clk_rpm **rpm_clks;
539 const struct rpm_clk_desc *desc;
541 rpm = dev_get_drvdata(pdev->dev.parent);
543 dev_err(&pdev->dev, "Unable to retrieve handle to RPM\n");
547 desc = of_device_get_match_data(&pdev->dev);
551 rpm_clks = desc->clks;
552 num_clks = desc->num_clks;
554 rcc = devm_kzalloc(&pdev->dev, sizeof(*rcc), GFP_KERNEL);
558 rcc->clks = rpm_clks;
559 rcc->num_clks = num_clks;
560 mutex_init(&rcc->xo_lock);
562 for (i = 0; i < num_clks; i++) {
566 rpm_clks[i]->rpm = rpm;
567 rpm_clks[i]->rpm_cc = rcc;
569 ret = clk_rpm_handoff(rpm_clks[i]);
574 for (i = 0; i < num_clks; i++) {
578 ret = devm_clk_hw_register(&pdev->dev, &rpm_clks[i]->hw);
583 ret = of_clk_add_hw_provider(pdev->dev.of_node, qcom_rpm_clk_hw_get,
590 dev_err(&pdev->dev, "Error registering RPM Clock driver (%d)\n", ret);
594 static void rpm_clk_remove(struct platform_device *pdev)
596 of_clk_del_provider(pdev->dev.of_node);
599 static struct platform_driver rpm_clk_driver = {
601 .name = "qcom-clk-rpm",
602 .of_match_table = rpm_clk_match_table,
604 .probe = rpm_clk_probe,
605 .remove_new = rpm_clk_remove,
608 static int __init rpm_clk_init(void)
610 return platform_driver_register(&rpm_clk_driver);
612 core_initcall(rpm_clk_init);
614 static void __exit rpm_clk_exit(void)
616 platform_driver_unregister(&rpm_clk_driver);
618 module_exit(rpm_clk_exit);
620 MODULE_DESCRIPTION("Qualcomm RPM Clock Controller Driver");
621 MODULE_LICENSE("GPL v2");
622 MODULE_ALIAS("platform:qcom-clk-rpm");