19c7e4702STaniya Das // SPDX-License-Identifier: GPL-2.0 29c7e4702STaniya Das /* 39c7e4702STaniya Das * Copyright (c) 2018, The Linux Foundation. All rights reserved. 49c7e4702STaniya Das */ 59c7e4702STaniya Das 69c7e4702STaniya Das #include <linux/clk-provider.h> 79c7e4702STaniya Das #include <linux/err.h> 89c7e4702STaniya Das #include <linux/kernel.h> 99c7e4702STaniya Das #include <linux/module.h> 109c7e4702STaniya Das #include <linux/of.h> 119c7e4702STaniya Das #include <linux/of_device.h> 129c7e4702STaniya Das #include <linux/platform_device.h> 139c7e4702STaniya Das #include <soc/qcom/cmd-db.h> 149c7e4702STaniya Das #include <soc/qcom/rpmh.h> 159c7e4702STaniya Das 169c7e4702STaniya Das #include <dt-bindings/clock/qcom,rpmh.h> 179c7e4702STaniya Das 189c7e4702STaniya Das #define CLK_RPMH_ARC_EN_OFFSET 0 199c7e4702STaniya Das #define CLK_RPMH_VRM_EN_OFFSET 4 209c7e4702STaniya Das 219c7e4702STaniya Das /** 229c7e4702STaniya Das * struct clk_rpmh - individual rpmh clock data structure 239c7e4702STaniya Das * @hw: handle between common and hardware-specific interfaces 249c7e4702STaniya Das * @res_name: resource name for the rpmh clock 259c7e4702STaniya Das * @div: clock divider to compute the clock rate 269c7e4702STaniya Das * @res_addr: base address of the rpmh resource within the RPMh 279c7e4702STaniya Das * @res_on_val: rpmh clock enable value 289c7e4702STaniya Das * @state: rpmh clock requested state 299c7e4702STaniya Das * @aggr_state: rpmh clock aggregated state 309c7e4702STaniya Das * @last_sent_aggr_state: rpmh clock last aggr state sent to RPMh 319c7e4702STaniya Das * @valid_state_mask: mask to determine the state of the rpmh clock 329c7e4702STaniya Das * @dev: device to which it is attached 339c7e4702STaniya Das * @peer: pointer to the clock rpmh sibling 349c7e4702STaniya Das */ 359c7e4702STaniya Das struct clk_rpmh { 369c7e4702STaniya Das struct clk_hw hw; 379c7e4702STaniya Das const char *res_name; 389c7e4702STaniya Das u8 div; 399c7e4702STaniya Das u32 res_addr; 409c7e4702STaniya Das u32 res_on_val; 419c7e4702STaniya Das u32 state; 429c7e4702STaniya Das u32 aggr_state; 439c7e4702STaniya Das u32 last_sent_aggr_state; 449c7e4702STaniya Das u32 valid_state_mask; 459c7e4702STaniya Das struct device *dev; 469c7e4702STaniya Das struct clk_rpmh *peer; 479c7e4702STaniya Das }; 489c7e4702STaniya Das 499c7e4702STaniya Das struct clk_rpmh_desc { 509c7e4702STaniya Das struct clk_hw **clks; 519c7e4702STaniya Das size_t num_clks; 529c7e4702STaniya Das }; 539c7e4702STaniya Das 549c7e4702STaniya Das static DEFINE_MUTEX(rpmh_clk_lock); 559c7e4702STaniya Das 569c7e4702STaniya Das #define __DEFINE_CLK_RPMH(_platform, _name, _name_active, _res_name, \ 579c7e4702STaniya Das _res_en_offset, _res_on, _div) \ 589c7e4702STaniya Das static struct clk_rpmh _platform##_##_name_active; \ 599c7e4702STaniya Das static struct clk_rpmh _platform##_##_name = { \ 609c7e4702STaniya Das .res_name = _res_name, \ 619c7e4702STaniya Das .res_addr = _res_en_offset, \ 629c7e4702STaniya Das .res_on_val = _res_on, \ 639c7e4702STaniya Das .div = _div, \ 649c7e4702STaniya Das .peer = &_platform##_##_name_active, \ 659c7e4702STaniya Das .valid_state_mask = (BIT(RPMH_WAKE_ONLY_STATE) | \ 669c7e4702STaniya Das BIT(RPMH_ACTIVE_ONLY_STATE) | \ 679c7e4702STaniya Das BIT(RPMH_SLEEP_STATE)), \ 689c7e4702STaniya Das .hw.init = &(struct clk_init_data){ \ 699c7e4702STaniya Das .ops = &clk_rpmh_ops, \ 709c7e4702STaniya Das .name = #_name, \ 719c7e4702STaniya Das .parent_names = (const char *[]){ "xo_board" }, \ 729c7e4702STaniya Das .num_parents = 1, \ 739c7e4702STaniya Das }, \ 749c7e4702STaniya Das }; \ 759c7e4702STaniya Das static struct clk_rpmh _platform##_##_name_active = { \ 769c7e4702STaniya Das .res_name = _res_name, \ 779c7e4702STaniya Das .res_addr = _res_en_offset, \ 789c7e4702STaniya Das .res_on_val = _res_on, \ 799c7e4702STaniya Das .div = _div, \ 809c7e4702STaniya Das .peer = &_platform##_##_name, \ 819c7e4702STaniya Das .valid_state_mask = (BIT(RPMH_WAKE_ONLY_STATE) | \ 829c7e4702STaniya Das BIT(RPMH_ACTIVE_ONLY_STATE)), \ 839c7e4702STaniya Das .hw.init = &(struct clk_init_data){ \ 849c7e4702STaniya Das .ops = &clk_rpmh_ops, \ 859c7e4702STaniya Das .name = #_name_active, \ 869c7e4702STaniya Das .parent_names = (const char *[]){ "xo_board" }, \ 879c7e4702STaniya Das .num_parents = 1, \ 889c7e4702STaniya Das }, \ 899c7e4702STaniya Das } 909c7e4702STaniya Das 919c7e4702STaniya Das #define DEFINE_CLK_RPMH_ARC(_platform, _name, _name_active, _res_name, \ 929c7e4702STaniya Das _res_on, _div) \ 939c7e4702STaniya Das __DEFINE_CLK_RPMH(_platform, _name, _name_active, _res_name, \ 949c7e4702STaniya Das CLK_RPMH_ARC_EN_OFFSET, _res_on, _div) 959c7e4702STaniya Das 969c7e4702STaniya Das #define DEFINE_CLK_RPMH_VRM(_platform, _name, _name_active, _res_name, \ 979c7e4702STaniya Das _div) \ 989c7e4702STaniya Das __DEFINE_CLK_RPMH(_platform, _name, _name_active, _res_name, \ 999c7e4702STaniya Das CLK_RPMH_VRM_EN_OFFSET, 1, _div) 1009c7e4702STaniya Das 1019c7e4702STaniya Das static inline struct clk_rpmh *to_clk_rpmh(struct clk_hw *_hw) 1029c7e4702STaniya Das { 1039c7e4702STaniya Das return container_of(_hw, struct clk_rpmh, hw); 1049c7e4702STaniya Das } 1059c7e4702STaniya Das 1069c7e4702STaniya Das static inline bool has_state_changed(struct clk_rpmh *c, u32 state) 1079c7e4702STaniya Das { 1089c7e4702STaniya Das return (c->last_sent_aggr_state & BIT(state)) 1099c7e4702STaniya Das != (c->aggr_state & BIT(state)); 1109c7e4702STaniya Das } 1119c7e4702STaniya Das 1129c7e4702STaniya Das static int clk_rpmh_send_aggregate_command(struct clk_rpmh *c) 1139c7e4702STaniya Das { 1149c7e4702STaniya Das struct tcs_cmd cmd = { 0 }; 1159c7e4702STaniya Das u32 cmd_state, on_val; 1169c7e4702STaniya Das enum rpmh_state state = RPMH_SLEEP_STATE; 1179c7e4702STaniya Das int ret; 1189c7e4702STaniya Das 1199c7e4702STaniya Das cmd.addr = c->res_addr; 1209c7e4702STaniya Das cmd_state = c->aggr_state; 1219c7e4702STaniya Das on_val = c->res_on_val; 1229c7e4702STaniya Das 1239c7e4702STaniya Das for (; state <= RPMH_ACTIVE_ONLY_STATE; state++) { 1249c7e4702STaniya Das if (has_state_changed(c, state)) { 1259c7e4702STaniya Das if (cmd_state & BIT(state)) 1269c7e4702STaniya Das cmd.data = on_val; 1279c7e4702STaniya Das 1289c7e4702STaniya Das ret = rpmh_write_async(c->dev, state, &cmd, 1); 1299c7e4702STaniya Das if (ret) { 1309c7e4702STaniya Das dev_err(c->dev, "set %s state of %s failed: (%d)\n", 1319c7e4702STaniya Das !state ? "sleep" : 1329c7e4702STaniya Das state == RPMH_WAKE_ONLY_STATE ? 1339c7e4702STaniya Das "wake" : "active", c->res_name, ret); 1349c7e4702STaniya Das return ret; 1359c7e4702STaniya Das } 1369c7e4702STaniya Das } 1379c7e4702STaniya Das } 1389c7e4702STaniya Das 1399c7e4702STaniya Das c->last_sent_aggr_state = c->aggr_state; 1409c7e4702STaniya Das c->peer->last_sent_aggr_state = c->last_sent_aggr_state; 1419c7e4702STaniya Das 1429c7e4702STaniya Das return 0; 1439c7e4702STaniya Das } 1449c7e4702STaniya Das 1459c7e4702STaniya Das /* 1469c7e4702STaniya Das * Update state and aggregate state values based on enable value. 1479c7e4702STaniya Das */ 1489c7e4702STaniya Das static int clk_rpmh_aggregate_state_send_command(struct clk_rpmh *c, 1499c7e4702STaniya Das bool enable) 1509c7e4702STaniya Das { 1519c7e4702STaniya Das int ret; 1529c7e4702STaniya Das 1539c7e4702STaniya Das /* Nothing required to be done if already off or on */ 1549c7e4702STaniya Das if (enable == c->state) 1559c7e4702STaniya Das return 0; 1569c7e4702STaniya Das 1579c7e4702STaniya Das c->state = enable ? c->valid_state_mask : 0; 1589c7e4702STaniya Das c->aggr_state = c->state | c->peer->state; 1599c7e4702STaniya Das c->peer->aggr_state = c->aggr_state; 1609c7e4702STaniya Das 1619c7e4702STaniya Das ret = clk_rpmh_send_aggregate_command(c); 1629c7e4702STaniya Das if (!ret) 1639c7e4702STaniya Das return 0; 1649c7e4702STaniya Das 1659c7e4702STaniya Das if (ret && enable) 1669c7e4702STaniya Das c->state = 0; 1679c7e4702STaniya Das else if (ret) 1689c7e4702STaniya Das c->state = c->valid_state_mask; 1699c7e4702STaniya Das 1709c7e4702STaniya Das WARN(1, "clk: %s failed to %s\n", c->res_name, 1719c7e4702STaniya Das enable ? "enable" : "disable"); 1729c7e4702STaniya Das return ret; 1739c7e4702STaniya Das } 1749c7e4702STaniya Das 1759c7e4702STaniya Das static int clk_rpmh_prepare(struct clk_hw *hw) 1769c7e4702STaniya Das { 1779c7e4702STaniya Das struct clk_rpmh *c = to_clk_rpmh(hw); 1789c7e4702STaniya Das int ret = 0; 1799c7e4702STaniya Das 1809c7e4702STaniya Das mutex_lock(&rpmh_clk_lock); 1819c7e4702STaniya Das ret = clk_rpmh_aggregate_state_send_command(c, true); 1829c7e4702STaniya Das mutex_unlock(&rpmh_clk_lock); 1839c7e4702STaniya Das 1849c7e4702STaniya Das return ret; 1859c7e4702STaniya Das }; 1869c7e4702STaniya Das 1879c7e4702STaniya Das static void clk_rpmh_unprepare(struct clk_hw *hw) 1889c7e4702STaniya Das { 1899c7e4702STaniya Das struct clk_rpmh *c = to_clk_rpmh(hw); 1909c7e4702STaniya Das 1919c7e4702STaniya Das mutex_lock(&rpmh_clk_lock); 1929c7e4702STaniya Das clk_rpmh_aggregate_state_send_command(c, false); 1939c7e4702STaniya Das mutex_unlock(&rpmh_clk_lock); 1949c7e4702STaniya Das }; 1959c7e4702STaniya Das 1969c7e4702STaniya Das static unsigned long clk_rpmh_recalc_rate(struct clk_hw *hw, 1979c7e4702STaniya Das unsigned long prate) 1989c7e4702STaniya Das { 1999c7e4702STaniya Das struct clk_rpmh *r = to_clk_rpmh(hw); 2009c7e4702STaniya Das 2019c7e4702STaniya Das /* 2029c7e4702STaniya Das * RPMh clocks have a fixed rate. Return static rate. 2039c7e4702STaniya Das */ 2049c7e4702STaniya Das return prate / r->div; 2059c7e4702STaniya Das } 2069c7e4702STaniya Das 2079c7e4702STaniya Das static const struct clk_ops clk_rpmh_ops = { 2089c7e4702STaniya Das .prepare = clk_rpmh_prepare, 2099c7e4702STaniya Das .unprepare = clk_rpmh_unprepare, 2109c7e4702STaniya Das .recalc_rate = clk_rpmh_recalc_rate, 2119c7e4702STaniya Das }; 2129c7e4702STaniya Das 2139c7e4702STaniya Das /* Resource name must match resource id present in cmd-db. */ 2149c7e4702STaniya Das DEFINE_CLK_RPMH_ARC(sdm845, bi_tcxo, bi_tcxo_ao, "xo.lvl", 0x3, 2); 2159c7e4702STaniya Das DEFINE_CLK_RPMH_VRM(sdm845, ln_bb_clk2, ln_bb_clk2_ao, "lnbclka2", 2); 2169c7e4702STaniya Das DEFINE_CLK_RPMH_VRM(sdm845, ln_bb_clk3, ln_bb_clk3_ao, "lnbclka3", 2); 2179c7e4702STaniya Das DEFINE_CLK_RPMH_VRM(sdm845, rf_clk1, rf_clk1_ao, "rfclka1", 1); 2189c7e4702STaniya Das DEFINE_CLK_RPMH_VRM(sdm845, rf_clk2, rf_clk2_ao, "rfclka2", 1); 2199c7e4702STaniya Das DEFINE_CLK_RPMH_VRM(sdm845, rf_clk3, rf_clk3_ao, "rfclka3", 1); 2209c7e4702STaniya Das 2219c7e4702STaniya Das static struct clk_hw *sdm845_rpmh_clocks[] = { 2229c7e4702STaniya Das [RPMH_CXO_CLK] = &sdm845_bi_tcxo.hw, 2239c7e4702STaniya Das [RPMH_CXO_CLK_A] = &sdm845_bi_tcxo_ao.hw, 2249c7e4702STaniya Das [RPMH_LN_BB_CLK2] = &sdm845_ln_bb_clk2.hw, 2259c7e4702STaniya Das [RPMH_LN_BB_CLK2_A] = &sdm845_ln_bb_clk2_ao.hw, 2269c7e4702STaniya Das [RPMH_LN_BB_CLK3] = &sdm845_ln_bb_clk3.hw, 2279c7e4702STaniya Das [RPMH_LN_BB_CLK3_A] = &sdm845_ln_bb_clk3_ao.hw, 2289c7e4702STaniya Das [RPMH_RF_CLK1] = &sdm845_rf_clk1.hw, 2299c7e4702STaniya Das [RPMH_RF_CLK1_A] = &sdm845_rf_clk1_ao.hw, 2309c7e4702STaniya Das [RPMH_RF_CLK2] = &sdm845_rf_clk2.hw, 2319c7e4702STaniya Das [RPMH_RF_CLK2_A] = &sdm845_rf_clk2_ao.hw, 2329c7e4702STaniya Das [RPMH_RF_CLK3] = &sdm845_rf_clk3.hw, 2339c7e4702STaniya Das [RPMH_RF_CLK3_A] = &sdm845_rf_clk3_ao.hw, 2349c7e4702STaniya Das }; 2359c7e4702STaniya Das 2369c7e4702STaniya Das static const struct clk_rpmh_desc clk_rpmh_sdm845 = { 2379c7e4702STaniya Das .clks = sdm845_rpmh_clocks, 2389c7e4702STaniya Das .num_clks = ARRAY_SIZE(sdm845_rpmh_clocks), 2399c7e4702STaniya Das }; 2409c7e4702STaniya Das 2419c7e4702STaniya Das static struct clk_hw *of_clk_rpmh_hw_get(struct of_phandle_args *clkspec, 2429c7e4702STaniya Das void *data) 2439c7e4702STaniya Das { 2449c7e4702STaniya Das struct clk_rpmh_desc *rpmh = data; 2459c7e4702STaniya Das unsigned int idx = clkspec->args[0]; 2469c7e4702STaniya Das 2479c7e4702STaniya Das if (idx >= rpmh->num_clks) { 2489c7e4702STaniya Das pr_err("%s: invalid index %u\n", __func__, idx); 2499c7e4702STaniya Das return ERR_PTR(-EINVAL); 2509c7e4702STaniya Das } 2519c7e4702STaniya Das 2529c7e4702STaniya Das return rpmh->clks[idx]; 2539c7e4702STaniya Das } 2549c7e4702STaniya Das 2559c7e4702STaniya Das static int clk_rpmh_probe(struct platform_device *pdev) 2569c7e4702STaniya Das { 2579c7e4702STaniya Das struct clk_hw **hw_clks; 2589c7e4702STaniya Das struct clk_rpmh *rpmh_clk; 2599c7e4702STaniya Das const struct clk_rpmh_desc *desc; 2609c7e4702STaniya Das int ret, i; 2619c7e4702STaniya Das 2629c7e4702STaniya Das desc = of_device_get_match_data(&pdev->dev); 2639c7e4702STaniya Das if (!desc) 2649c7e4702STaniya Das return -ENODEV; 2659c7e4702STaniya Das 2669c7e4702STaniya Das hw_clks = desc->clks; 2679c7e4702STaniya Das 2689c7e4702STaniya Das for (i = 0; i < desc->num_clks; i++) { 2699c7e4702STaniya Das u32 res_addr; 2709c7e4702STaniya Das 2719c7e4702STaniya Das rpmh_clk = to_clk_rpmh(hw_clks[i]); 2729c7e4702STaniya Das res_addr = cmd_db_read_addr(rpmh_clk->res_name); 2739c7e4702STaniya Das if (!res_addr) { 2749c7e4702STaniya Das dev_err(&pdev->dev, "missing RPMh resource address for %s\n", 2759c7e4702STaniya Das rpmh_clk->res_name); 2769c7e4702STaniya Das return -ENODEV; 2779c7e4702STaniya Das } 2789c7e4702STaniya Das rpmh_clk->res_addr += res_addr; 2799c7e4702STaniya Das rpmh_clk->dev = &pdev->dev; 2809c7e4702STaniya Das 2819c7e4702STaniya Das ret = devm_clk_hw_register(&pdev->dev, hw_clks[i]); 2829c7e4702STaniya Das if (ret) { 2839c7e4702STaniya Das dev_err(&pdev->dev, "failed to register %s\n", 2849c7e4702STaniya Das hw_clks[i]->init->name); 2859c7e4702STaniya Das return ret; 2869c7e4702STaniya Das } 2879c7e4702STaniya Das } 2889c7e4702STaniya Das 2899c7e4702STaniya Das /* typecast to silence compiler warning */ 2909c7e4702STaniya Das ret = devm_of_clk_add_hw_provider(&pdev->dev, of_clk_rpmh_hw_get, 2919c7e4702STaniya Das (void *)desc); 2929c7e4702STaniya Das if (ret) { 2939c7e4702STaniya Das dev_err(&pdev->dev, "Failed to add clock provider\n"); 2949c7e4702STaniya Das return ret; 2959c7e4702STaniya Das } 2969c7e4702STaniya Das 2979c7e4702STaniya Das dev_dbg(&pdev->dev, "Registered RPMh clocks\n"); 2989c7e4702STaniya Das 2999c7e4702STaniya Das return 0; 3009c7e4702STaniya Das } 3019c7e4702STaniya Das 3029c7e4702STaniya Das static const struct of_device_id clk_rpmh_match_table[] = { 3039c7e4702STaniya Das { .compatible = "qcom,sdm845-rpmh-clk", .data = &clk_rpmh_sdm845}, 3049c7e4702STaniya Das { } 3059c7e4702STaniya Das }; 3069c7e4702STaniya Das MODULE_DEVICE_TABLE(of, clk_rpmh_match_table); 3079c7e4702STaniya Das 3089c7e4702STaniya Das static struct platform_driver clk_rpmh_driver = { 3099c7e4702STaniya Das .probe = clk_rpmh_probe, 3109c7e4702STaniya Das .driver = { 3119c7e4702STaniya Das .name = "clk-rpmh", 3129c7e4702STaniya Das .of_match_table = clk_rpmh_match_table, 3139c7e4702STaniya Das }, 3149c7e4702STaniya Das }; 3159c7e4702STaniya Das 3169c7e4702STaniya Das static int __init clk_rpmh_init(void) 3179c7e4702STaniya Das { 3189c7e4702STaniya Das return platform_driver_register(&clk_rpmh_driver); 3199c7e4702STaniya Das } 3209c7e4702STaniya Das subsys_initcall(clk_rpmh_init); 3219c7e4702STaniya Das 3229c7e4702STaniya Das static void __exit clk_rpmh_exit(void) 3239c7e4702STaniya Das { 3249c7e4702STaniya Das platform_driver_unregister(&clk_rpmh_driver); 3259c7e4702STaniya Das } 3269c7e4702STaniya Das module_exit(clk_rpmh_exit); 3279c7e4702STaniya Das 3289c7e4702STaniya Das MODULE_DESCRIPTION("QCOM RPMh Clock Driver"); 3299c7e4702STaniya Das MODULE_LICENSE("GPL v2"); 330