clk: qcom: clk-rpmh: Add QCOM RPMh clock driver

Add RPMh clock device bindings for Qualcomm Technology Inc's SoCs. These devices would be used for communicating resource state requests to control the clocks managed by RPMh.

Signed-off-by Amit Nischal <[email protected]>

Signed-off-by Taniya Das <[email protected]>

Reviewed-by Rob Herring <[email protected]>

---

drivers/clk/qcom/clk-rpmh.c new file +17 -0

new file mode 100644
index 0000000..907a73f
@@ -0,0 +1,364 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (c) 2018, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/clk-provider.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_device.h>
+#include <linux/platform_device.h>
+#include <soc/qcom/cmd-db.h>
+#include <soc/qcom/rpmh.h>
+
+#include <dt-bindings/clock/qcom,rpmh.h>
+

drivers/clk/qcom/clk-rpmh.c new file +27 -0

+ * @res_on_val:                rpmh clock enable value
+ * @res_off_val:       rpmh clock disable value
+ * @state:             rpmh clock requested state
+ * @aggr_state:                rpmh clock aggregated state
+ * @last_sent_aggr_state: rpmh clock last aggr state sent to RPMh
+ * @valid_state_mask:  mask to determine the state of the rpmh clock
+ * @rpmh_client:       handle used for rpmh communications
+ * @dev:               device to which it is attached
+ * @peer:              pointer to the clock rpmh sibling
+ * @rate:              rate of the rpmh clock
+ */
+struct clk_rpmh {
+       struct clk_hw hw;
+       const char *res_name;
+       u32 res_addr;
+       u32 res_en_offset;
+       u32 res_on_val;
+       u32 res_off_val;
+       u32 state;
+       u32 aggr_state;
+       u32 last_sent_aggr_state;
+       u32 valid_state_mask;
+       struct rpmh_client *rpmh_client;
+       struct device *dev;
+       struct clk_rpmh *peer;
+       unsigned long rate;
+};

drivers/clk/qcom/clk-rpmh.c new file +11 -0

+}
+
+static int clk_rpmh_send_aggregate_command(struct clk_rpmh *c)
+{
+       struct tcs_cmd cmd = { 0 };
+       u32 cmd_state, on_val;
+       enum rpmh_state state = RPMH_SLEEP_STATE;
+       int ret;
+
+       cmd.addr = c->res_addr + c->res_en_offset;
+       cmd_state = c->aggr_state;

+ (state == RPMH_WAKE_ONLY_STATE) ?

drivers/clk/qcom/clk-rpmh.c new file +11 -0

+                                       "wake" : "active", c->res_name, ret);
+                               return ret;
+                       }
+               }
+       }
+
+       c->last_sent_aggr_state = c->aggr_state;
+       c->peer->last_sent_aggr_state =  c->last_sent_aggr_state;
+
+       return 0;
+}

drivers/clk/qcom/clk-rpmh.c new file +4 -0

+
+static const struct clk_ops clk_rpmh_ops = {
+       .prepare        = clk_rpmh_prepare,
+       .unprepare      = clk_rpmh_unprepare,

Quoting Taniya Das (2018-04-24 05:23:19)

Quoted 28 lines

drivers/clk/qcom/clk-rpmh.c new file +22 -0

new file mode 100644
index 0000000..907a73f
@@ -0,0 +1,364 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (c) 2018, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/clk-provider.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_device.h>
+#include <linux/platform_device.h>
+#include <soc/qcom/cmd-db.h>
+#include <soc/qcom/rpmh.h>
+
+#include <dt-bindings/clock/qcom,rpmh.h>
+
+#define CLK_RPMH_ARC_EN_OFFSET         0
+#define CLK_RPMH_VRM_EN_OFFSET         4
+
+/**
+ * struct clk_rpmh - individual rpmh clock data structure

drivers/clk/qcom/clk-rpmh.c line 27

Quoted 5 lines

drivers/clk/qcom/clk-rpmh.c new file +5 -0

+ * @hw:                        handle between common and hardware-specific interfaces
+ * @res_name:          resource name for the rpmh clock
+ * @res_addr:          base address of the rpmh resource within the RPMh
+ * @res_en_offset:     clock resource enable offset corresponding to ARC or
+ *                     VRM type clock

Can these be combined still? Just do a += on res_addr after we get the base of it?

Quoted 27 lines

drivers/clk/qcom/clk-rpmh.c new file +27 -0

+ * @res_on_val:                rpmh clock enable value
+ * @res_off_val:       rpmh clock disable value
+ * @state:             rpmh clock requested state
+ * @aggr_state:                rpmh clock aggregated state
+ * @last_sent_aggr_state: rpmh clock last aggr state sent to RPMh
+ * @valid_state_mask:  mask to determine the state of the rpmh clock
+ * @rpmh_client:       handle used for rpmh communications
+ * @dev:               device to which it is attached
+ * @peer:              pointer to the clock rpmh sibling
+ * @rate:              rate of the rpmh clock
+ */
+struct clk_rpmh {
+       struct clk_hw hw;
+       const char *res_name;
+       u32 res_addr;
+       u32 res_en_offset;
+       u32 res_on_val;
+       u32 res_off_val;
+       u32 state;
+       u32 aggr_state;
+       u32 last_sent_aggr_state;
+       u32 valid_state_mask;
+       struct rpmh_client *rpmh_client;
+       struct device *dev;
+       struct clk_rpmh *peer;
+       unsigned long rate;
+};

[...]

drivers/clk/qcom/clk-rpmh.c line 114

Quoted 5 lines

drivers/clk/qcom/clk-rpmh.c new file +5 -0

+
+static inline bool has_state_changed(struct clk_rpmh *c, u32 state)
+{
+       return (c->last_sent_aggr_state & BIT(state))
+               != (c->aggr_state & BIT(state));

Please drop useless parenthesis.

Quoted 15 lines

drivers/clk/qcom/clk-rpmh.c new file +15 -0

+}
+
+static int clk_rpmh_send_aggregate_command(struct clk_rpmh *c)
+{
+       struct tcs_cmd cmd = { 0 };
+       u32 cmd_state, on_val;
+       enum rpmh_state state = RPMH_SLEEP_STATE;
+       int ret;
+
+       cmd.addr = c->res_addr + c->res_en_offset;
+       cmd_state = c->aggr_state;
+       on_val = c->res_on_val;
+
+       for (; state <= RPMH_ACTIVE_ONLY_STATE; state++) {
+               if (has_state_changed(c, state)) {

drivers/clk/qcom/clk-rpmh.c line 135

Quoted 6 lines

drivers/clk/qcom/clk-rpmh.c new file +6 -0

+                       cmd.data = (cmd_state & BIT(state)) ? on_val : 0;
+                       ret = rpmh_write_async(c->rpmh_client, state,
+                                               &cmd, 1);
+                       if (ret) {
+                               dev_err(c->dev, "set %s state of %s failed: (%d)\n",
+                                       (!state) ? "sleep" :

Drop parenthesis please.

Quoted 1 line

+ (state == RPMH_WAKE_ONLY_STATE) ?

Drop parenthesis please.

Quoted 11 lines

drivers/clk/qcom/clk-rpmh.c new file +11 -0

+                                       "wake" : "active", c->res_name, ret);
+                               return ret;
+                       }
+               }
+       }
+
+       c->last_sent_aggr_state = c->aggr_state;
+       c->peer->last_sent_aggr_state =  c->last_sent_aggr_state;
+
+       return 0;
+}

[...]

Quoted 4 lines

drivers/clk/qcom/clk-rpmh.c new file +4 -0

+
+static const struct clk_ops clk_rpmh_ops = {
+       .prepare        = clk_rpmh_prepare,
+       .unprepare      = clk_rpmh_unprepare,

drivers/clk/qcom/clk-rpmh.c line 222

Quoted 10 lines

drivers/clk/qcom/clk-rpmh.c new file +10 -0

+       .recalc_rate    = clk_rpmh_recalc_rate,
+};
+
+/* Resource name must match resource id present in cmd-db. */
+DEFINE_CLK_RPMH_ARC(sdm845, bi_tcxo, bi_tcxo_ao, "xo.lvl", 0x3, 0x0, 19200000);
+DEFINE_CLK_RPMH_VRM(sdm845, ln_bb_clk2, ln_bb_clk2_ao, "lnbclka2", 19200000);
+DEFINE_CLK_RPMH_VRM(sdm845, ln_bb_clk3, ln_bb_clk3_ao, "lnbclka3", 19200000);
+DEFINE_CLK_RPMH_VRM(sdm845, rf_clk1, rf_clk1_ao, "rfclka1", 38400000);
+DEFINE_CLK_RPMH_VRM(sdm845, rf_clk2, rf_clk2_ao, "rfclka2", 38400000);
+DEFINE_CLK_RPMH_VRM(sdm845, rf_clk3, rf_clk3_ao, "rfclka3", 38400000);

These rates should come from DT and parents of these clks.