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 353 static struct clk_hw *sdm845_rpmh_clocks[] = { 354 [RPMH_CXO_CLK] = &sdm845_bi_tcxo.hw, 355 [RPMH_CXO_CLK_A] = &sdm845_bi_tcxo_ao.hw, 356 [RPMH_LN_BB_CLK2] = &sdm845_ln_bb_clk2.hw, 357 [RPMH_LN_BB_CLK2_A] = &sdm845_ln_bb_clk2_ao.hw, 358 [RPMH_LN_BB_CLK3] = &sdm845_ln_bb_clk3.hw, 359 [RPMH_LN_BB_CLK3_A] = &sdm845_ln_bb_clk3_ao.hw, 360 [RPMH_RF_CLK1] = &sdm845_rf_clk1.hw, 361 [RPMH_RF_CLK1_A] = &sdm845_rf_clk1_ao.hw, 362 [RPMH_RF_CLK2] = &sdm845_rf_clk2.hw, 363 [RPMH_RF_CLK2_A] = &sdm845_rf_clk2_ao.hw, 364 [RPMH_RF_CLK3] = &sdm845_rf_clk3.hw, 365 [RPMH_RF_CLK3_A] = &sdm845_rf_clk3_ao.hw, 366 [RPMH_IPA_CLK] = &sdm845_ipa.hw, 367 }; 368 369 static const struct clk_rpmh_desc clk_rpmh_sdm845 = { 370 .clks = sdm845_rpmh_clocks, 371 .num_clks = ARRAY_SIZE(sdm845_rpmh_clocks), 372 }; 373 374 static struct clk_hw *sm8150_rpmh_clocks[] = { 375 [RPMH_CXO_CLK] = &sdm845_bi_tcxo.hw, 376 [RPMH_CXO_CLK_A] = &sdm845_bi_tcxo_ao.hw, 377 [RPMH_LN_BB_CLK2] = &sdm845_ln_bb_clk2.hw, 378 [RPMH_LN_BB_CLK2_A] = &sdm845_ln_bb_clk2_ao.hw, 379 [RPMH_LN_BB_CLK3] = &sdm845_ln_bb_clk3.hw, 380 [RPMH_LN_BB_CLK3_A] = &sdm845_ln_bb_clk3_ao.hw, 381 [RPMH_RF_CLK1] = &sdm845_rf_clk1.hw, 382 [RPMH_RF_CLK1_A] = &sdm845_rf_clk1_ao.hw, 383 [RPMH_RF_CLK2] = &sdm845_rf_clk2.hw, 384 [RPMH_RF_CLK2_A] = &sdm845_rf_clk2_ao.hw, 385 [RPMH_RF_CLK3] = &sdm845_rf_clk3.hw, 386 [RPMH_RF_CLK3_A] = &sdm845_rf_clk3_ao.hw, 387 }; 388 389 static const struct clk_rpmh_desc clk_rpmh_sm8150 = { 390 .clks = sm8150_rpmh_clocks, 391 .num_clks = ARRAY_SIZE(sm8150_rpmh_clocks), 392 }; 393 394 static struct clk_hw *sc7180_rpmh_clocks[] = { 395 [RPMH_CXO_CLK] = &sdm845_bi_tcxo.hw, 396 [RPMH_CXO_CLK_A] = &sdm845_bi_tcxo_ao.hw, 397 [RPMH_LN_BB_CLK2] = &sdm845_ln_bb_clk2.hw, 398 [RPMH_LN_BB_CLK2_A] = &sdm845_ln_bb_clk2_ao.hw, 399 [RPMH_LN_BB_CLK3] = &sdm845_ln_bb_clk3.hw, 400 [RPMH_LN_BB_CLK3_A] = &sdm845_ln_bb_clk3_ao.hw, 401 [RPMH_RF_CLK1] = &sdm845_rf_clk1.hw, 402 [RPMH_RF_CLK1_A] = &sdm845_rf_clk1_ao.hw, 403 [RPMH_RF_CLK2] = &sdm845_rf_clk2.hw, 404 [RPMH_RF_CLK2_A] = &sdm845_rf_clk2_ao.hw, 405 [RPMH_IPA_CLK] = &sdm845_ipa.hw, 406 }; 407 408 static const struct clk_rpmh_desc clk_rpmh_sc7180 = { 409 .clks = sc7180_rpmh_clocks, 410 .num_clks = ARRAY_SIZE(sc7180_rpmh_clocks), 411 }; 412 413 DEFINE_CLK_RPMH_VRM(sm8250, ln_bb_clk1, ln_bb_clk1_ao, "lnbclka1", 2); 414 415 static struct clk_hw *sm8250_rpmh_clocks[] = { 416 [RPMH_CXO_CLK] = &sdm845_bi_tcxo.hw, 417 [RPMH_CXO_CLK_A] = &sdm845_bi_tcxo_ao.hw, 418 [RPMH_LN_BB_CLK1] = &sm8250_ln_bb_clk1.hw, 419 [RPMH_LN_BB_CLK1_A] = &sm8250_ln_bb_clk1_ao.hw, 420 [RPMH_LN_BB_CLK2] = &sdm845_ln_bb_clk2.hw, 421 [RPMH_LN_BB_CLK2_A] = &sdm845_ln_bb_clk2_ao.hw, 422 [RPMH_LN_BB_CLK3] = &sdm845_ln_bb_clk3.hw, 423 [RPMH_LN_BB_CLK3_A] = &sdm845_ln_bb_clk3_ao.hw, 424 [RPMH_RF_CLK1] = &sdm845_rf_clk1.hw, 425 [RPMH_RF_CLK1_A] = &sdm845_rf_clk1_ao.hw, 426 [RPMH_RF_CLK3] = &sdm845_rf_clk3.hw, 427 [RPMH_RF_CLK3_A] = &sdm845_rf_clk3_ao.hw, 428 }; 429 430 static const struct clk_rpmh_desc clk_rpmh_sm8250 = { 431 .clks = sm8250_rpmh_clocks, 432 .num_clks = ARRAY_SIZE(sm8250_rpmh_clocks), 433 }; 434 435 static struct clk_hw *of_clk_rpmh_hw_get(struct of_phandle_args *clkspec, 436 void *data) 437 { 438 struct clk_rpmh_desc *rpmh = data; 439 unsigned int idx = clkspec->args[0]; 440 441 if (idx >= rpmh->num_clks) { 442 pr_err("%s: invalid index %u\n", __func__, idx); 443 return ERR_PTR(-EINVAL); 444 } 445 446 return rpmh->clks[idx]; 447 } 448 449 static int clk_rpmh_probe(struct platform_device *pdev) 450 { 451 struct clk_hw **hw_clks; 452 struct clk_rpmh *rpmh_clk; 453 const struct clk_rpmh_desc *desc; 454 int ret, i; 455 456 desc = of_device_get_match_data(&pdev->dev); 457 if (!desc) 458 return -ENODEV; 459 460 hw_clks = desc->clks; 461 462 for (i = 0; i < desc->num_clks; i++) { 463 const char *name; 464 u32 res_addr; 465 size_t aux_data_len; 466 const struct bcm_db *data; 467 468 if (!hw_clks[i]) 469 continue; 470 471 name = hw_clks[i]->init->name; 472 473 rpmh_clk = to_clk_rpmh(hw_clks[i]); 474 res_addr = cmd_db_read_addr(rpmh_clk->res_name); 475 if (!res_addr) { 476 dev_err(&pdev->dev, "missing RPMh resource address for %s\n", 477 rpmh_clk->res_name); 478 return -ENODEV; 479 } 480 481 data = cmd_db_read_aux_data(rpmh_clk->res_name, &aux_data_len); 482 if (IS_ERR(data)) { 483 ret = PTR_ERR(data); 484 dev_err(&pdev->dev, 485 "error reading RPMh aux data for %s (%d)\n", 486 rpmh_clk->res_name, ret); 487 return ret; 488 } 489 490 /* Convert unit from Khz to Hz */ 491 if (aux_data_len == sizeof(*data)) 492 rpmh_clk->unit = le32_to_cpu(data->unit) * 1000ULL; 493 494 rpmh_clk->res_addr += res_addr; 495 rpmh_clk->dev = &pdev->dev; 496 497 ret = devm_clk_hw_register(&pdev->dev, hw_clks[i]); 498 if (ret) { 499 dev_err(&pdev->dev, "failed to register %s\n", name); 500 return ret; 501 } 502 } 503 504 /* typecast to silence compiler warning */ 505 ret = devm_of_clk_add_hw_provider(&pdev->dev, of_clk_rpmh_hw_get, 506 (void *)desc); 507 if (ret) { 508 dev_err(&pdev->dev, "Failed to add clock provider\n"); 509 return ret; 510 } 511 512 dev_dbg(&pdev->dev, "Registered RPMh clocks\n"); 513 514 return 0; 515 } 516 517 static const struct of_device_id clk_rpmh_match_table[] = { 518 { .compatible = "qcom,sc7180-rpmh-clk", .data = &clk_rpmh_sc7180}, 519 { .compatible = "qcom,sdm845-rpmh-clk", .data = &clk_rpmh_sdm845}, 520 { .compatible = "qcom,sm8150-rpmh-clk", .data = &clk_rpmh_sm8150}, 521 { .compatible = "qcom,sm8250-rpmh-clk", .data = &clk_rpmh_sm8250}, 522 { } 523 }; 524 MODULE_DEVICE_TABLE(of, clk_rpmh_match_table); 525 526 static struct platform_driver clk_rpmh_driver = { 527 .probe = clk_rpmh_probe, 528 .driver = { 529 .name = "clk-rpmh", 530 .of_match_table = clk_rpmh_match_table, 531 }, 532 }; 533 534 static int __init clk_rpmh_init(void) 535 { 536 return platform_driver_register(&clk_rpmh_driver); 537 } 538 core_initcall(clk_rpmh_init); 539 540 static void __exit clk_rpmh_exit(void) 541 { 542 platform_driver_unregister(&clk_rpmh_driver); 543 } 544 module_exit(clk_rpmh_exit); 545 546 MODULE_DESCRIPTION("QCOM RPMh Clock Driver"); 547 MODULE_LICENSE("GPL v2"); 548