[PATCH v3 2/7] clk: starfive: Add StarFive JH7110 PLL clock driver

From: Xingyu Wu
Date: Thu Apr 13 2023 - 22:43:19 EST


Add driver for the StarFive JH7110 PLL clock controller
and they work by reading and setting syscon registers.

Signed-off-by: Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx>
---
MAINTAINERS | 6 +
drivers/clk/starfive/Kconfig | 8 +
drivers/clk/starfive/Makefile | 1 +
.../clk/starfive/clk-starfive-jh7110-pll.c | 427 ++++++++++++++++++
.../clk/starfive/clk-starfive-jh7110-pll.h | 293 ++++++++++++
5 files changed, 735 insertions(+)
create mode 100644 drivers/clk/starfive/clk-starfive-jh7110-pll.c
create mode 100644 drivers/clk/starfive/clk-starfive-jh7110-pll.h

diff --git a/MAINTAINERS b/MAINTAINERS
index 4c0b39c44957..03051ae2e9e5 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -19911,6 +19911,12 @@ S: Supported
F: Documentation/devicetree/bindings/mmc/starfive*
F: drivers/mmc/host/dw_mmc-starfive.c

+STARFIVE JH7110 PLL CLOCK DRIVER
+M: Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx>
+S: Supported
+F: Documentation/devicetree/bindings/clock/starfive,jh7110-pll.yaml
+F: drivers/clk/starfive/clk-starfive-jh7110-pll.*
+
STARFIVE JH71X0 CLOCK DRIVERS
M: Emil Renner Berthing <kernel@xxxxxxxx>
M: Hal Feng <hal.feng@xxxxxxxxxxxxxxxx>
diff --git a/drivers/clk/starfive/Kconfig b/drivers/clk/starfive/Kconfig
index 71c1148ee5f6..e306edf4defa 100644
--- a/drivers/clk/starfive/Kconfig
+++ b/drivers/clk/starfive/Kconfig
@@ -21,6 +21,14 @@ config CLK_STARFIVE_JH7100_AUDIO
Say Y or M here to support the audio clocks on the StarFive JH7100
SoC.

+config CLK_STARFIVE_JH7110_PLL
+ bool "StarFive JH7110 PLL clock support"
+ depends on ARCH_STARFIVE || COMPILE_TEST
+ default ARCH_STARFIVE
+ help
+ Say yes here to support the PLL clock controller on the
+ StarFive JH7110 SoC.
+
config CLK_STARFIVE_JH7110_SYS
bool "StarFive JH7110 system clock support"
depends on ARCH_STARFIVE || COMPILE_TEST
diff --git a/drivers/clk/starfive/Makefile b/drivers/clk/starfive/Makefile
index f3df7d957b1e..b48e539e52b0 100644
--- a/drivers/clk/starfive/Makefile
+++ b/drivers/clk/starfive/Makefile
@@ -4,5 +4,6 @@ obj-$(CONFIG_CLK_STARFIVE_JH71X0) += clk-starfive-jh71x0.o
obj-$(CONFIG_CLK_STARFIVE_JH7100) += clk-starfive-jh7100.o
obj-$(CONFIG_CLK_STARFIVE_JH7100_AUDIO) += clk-starfive-jh7100-audio.o

+obj-$(CONFIG_CLK_STARFIVE_JH7110_PLL) += clk-starfive-jh7110-pll.o
obj-$(CONFIG_CLK_STARFIVE_JH7110_SYS) += clk-starfive-jh7110-sys.o
obj-$(CONFIG_CLK_STARFIVE_JH7110_AON) += clk-starfive-jh7110-aon.o
diff --git a/drivers/clk/starfive/clk-starfive-jh7110-pll.c b/drivers/clk/starfive/clk-starfive-jh7110-pll.c
new file mode 100644
index 000000000000..43d707ea45c7
--- /dev/null
+++ b/drivers/clk/starfive/clk-starfive-jh7110-pll.c
@@ -0,0 +1,427 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * StarFive JH7110 PLL Clock Generator Driver
+ *
+ * Copyright (C) 2023 StarFive Technology Co., Ltd.
+ *
+ * This driver is about to register JH7110 PLL clock generator and support ops.
+ * The JH7110 have three PLL clock, PLL0, PLL1 and PLL2.
+ * Each PLL clocks work in integer mode or fraction mode by some dividers,
+ * and the configuration registers and dividers are set in several syscon registers.
+ * The formula for calculating frequency is:
+ * Fvco = Fref * (NI + NF) / M / Q1
+ * Fref: OSC source clock rate
+ * NI: integer frequency dividing ratio of feedback divider, set by fbdiv[11:0].
+ * NF: fractional frequency dividing ratio, set by frac[23:0]. NF = frac[23:0] / 2^24 = 0 ~ 0.999.
+ * M: frequency dividing ratio of pre-divider, set by prediv[5:0].
+ * Q1: frequency dividing ratio of post divider, set by postdiv1[1:0], Q1= 1,2,4,8.
+ */
+
+#include <linux/clk-provider.h>
+#include <linux/debugfs.h>
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/mfd/syscon.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+
+#include <dt-bindings/clock/starfive,jh7110-crg.h>
+
+#include "clk-starfive-jh7110-pll.h"
+
+static struct jh7110_clk_pll_data *jh7110_pll_data_from(struct clk_hw *hw)
+{
+ return container_of(hw, struct jh7110_clk_pll_data, hw);
+}
+
+static struct jh7110_clk_pll_priv *jh7110_pll_priv_from(struct jh7110_clk_pll_data *data)
+{
+ return container_of(data, struct jh7110_clk_pll_priv, data[data->idx]);
+}
+
+/* Read register value from syscon and calculate PLL(x) frequency */
+static unsigned long jh7110_pll_get_freq(struct jh7110_clk_pll_data *data,
+ unsigned long parent_rate)
+{
+ struct jh7110_clk_pll_priv *priv = jh7110_pll_priv_from(data);
+ struct jh7110_pll_syscon_offset *offset = &data->offset;
+ struct jh7110_pll_syscon_mask *mask = &data->mask;
+ struct jh7110_pll_syscon_shift *shift = &data->shift;
+ unsigned long freq = 0;
+ unsigned long frac_cal;
+ u32 dacpd;
+ u32 dsmpd;
+ u32 fbdiv;
+ u32 prediv;
+ u32 postdiv1;
+ u32 frac;
+ u32 reg_val;
+
+ if (regmap_read(priv->syscon_regmap, offset->dacpd, &reg_val))
+ goto read_error;
+ dacpd = (reg_val & mask->dacpd) >> shift->dacpd;
+
+ if (regmap_read(priv->syscon_regmap, offset->dsmpd, &reg_val))
+ goto read_error;
+ dsmpd = (reg_val & mask->dsmpd) >> shift->dsmpd;
+
+ if (regmap_read(priv->syscon_regmap, offset->fbdiv, &reg_val))
+ goto read_error;
+ fbdiv = (reg_val & mask->fbdiv) >> shift->fbdiv;
+ /* fbdiv value should be 8 to 4095 */
+ if (fbdiv < 8)
+ goto read_error;
+
+ if (regmap_read(priv->syscon_regmap, offset->prediv, &reg_val))
+ goto read_error;
+ prediv = (reg_val & mask->prediv) >> shift->prediv;
+
+ if (regmap_read(priv->syscon_regmap, offset->postdiv1, &reg_val))
+ goto read_error;
+ /* postdiv1 = 2 ^ reg_val */
+ postdiv1 = 1 << ((reg_val & mask->postdiv1) >> shift->postdiv1);
+
+ if (regmap_read(priv->syscon_regmap, offset->frac, &reg_val))
+ goto read_error;
+ frac = (reg_val & mask->frac) >> shift->frac;
+
+ /*
+ * Integer Mode (Both 1) or Fraction Mode (Both 0).
+ * And the decimal places are counted by expanding them by
+ * a factor of STARFIVE_PLL_FRAC_PATR_SIZE.
+ */
+ if (dacpd == 1 && dsmpd == 1)
+ frac_cal = 0;
+ else if (dacpd == 0 && dsmpd == 0)
+ frac_cal = (unsigned long)frac * STARFIVE_PLL_FRAC_PATR_SIZE / (1 << 24);
+ else
+ goto read_error;
+
+ /* Fvco = Fref * (NI + NF) / M / Q1 */
+ freq = parent_rate / STARFIVE_PLL_FRAC_PATR_SIZE *
+ (fbdiv * STARFIVE_PLL_FRAC_PATR_SIZE + frac_cal) / prediv / postdiv1;
+
+read_error:
+ return freq;
+}
+
+static unsigned long jh7110_pll_rate_sub_fabs(unsigned long rate1, unsigned long rate2)
+{
+ return rate1 > rate2 ? (rate1 - rate2) : (rate2 - rate1);
+}
+
+/* Select the appropriate frequency from the already configured registers value */
+static void jh7110_pll_select_near_freq_id(struct jh7110_clk_pll_data *data,
+ unsigned long rate)
+{
+ const struct starfive_pll_syscon_value *syscon_val;
+ unsigned int id;
+ unsigned int pll_arry_size;
+ unsigned long rate_diff;
+
+ if (data->idx == JH7110_CLK_PLL0_OUT)
+ pll_arry_size = ARRAY_SIZE(jh7110_pll0_syscon_freq);
+ else if (data->idx == JH7110_CLK_PLL1_OUT)
+ pll_arry_size = ARRAY_SIZE(jh7110_pll1_syscon_freq);
+ else
+ pll_arry_size = ARRAY_SIZE(jh7110_pll2_syscon_freq);
+
+ /* compare the frequency one by one from small to large in order */
+ for (id = 0; id < pll_arry_size; id++) {
+ if (data->idx == JH7110_CLK_PLL0_OUT)
+ syscon_val = &jh7110_pll0_syscon_freq[id];
+ else if (data->idx == JH7110_CLK_PLL1_OUT)
+ syscon_val = &jh7110_pll1_syscon_freq[id];
+ else
+ syscon_val = &jh7110_pll2_syscon_freq[id];
+
+ if (rate == syscon_val->freq)
+ goto match_end;
+
+ /* select near frequency */
+ if (rate < syscon_val->freq) {
+ /* The last frequency is closer to the target rate than this time. */
+ if (id > 0)
+ if (rate_diff < jh7110_pll_rate_sub_fabs(rate, syscon_val->freq))
+ id--;
+
+ goto match_end;
+ } else {
+ rate_diff = jh7110_pll_rate_sub_fabs(rate, syscon_val->freq);
+ }
+ }
+
+match_end:
+ data->freq_select_idx = id;
+}
+
+static int jh7110_pll_set_freq_syscon(struct jh7110_clk_pll_data *data)
+{
+ struct jh7110_clk_pll_priv *priv = jh7110_pll_priv_from(data);
+ struct jh7110_pll_syscon_offset *offset = &data->offset;
+ struct jh7110_pll_syscon_mask *mask = &data->mask;
+ struct jh7110_pll_syscon_shift *shift = &data->shift;
+ unsigned int freq_idx = data->freq_select_idx;
+ const struct starfive_pll_syscon_value *syscon_val;
+ int ret;
+
+ if (data->idx == JH7110_CLK_PLL0_OUT)
+ syscon_val = &jh7110_pll0_syscon_freq[freq_idx];
+ else if (data->idx == JH7110_CLK_PLL1_OUT)
+ syscon_val = &jh7110_pll1_syscon_freq[freq_idx];
+ else
+ syscon_val = &jh7110_pll2_syscon_freq[freq_idx];
+
+ ret = regmap_update_bits(priv->syscon_regmap, offset->dacpd, mask->dacpd,
+ (syscon_val->dacpd << shift->dacpd));
+ if (ret)
+ goto set_failed;
+
+ ret = regmap_update_bits(priv->syscon_regmap, offset->dsmpd, mask->dsmpd,
+ (syscon_val->dsmpd << shift->dsmpd));
+ if (ret)
+ goto set_failed;
+
+ ret = regmap_update_bits(priv->syscon_regmap, offset->prediv, mask->prediv,
+ (syscon_val->prediv << shift->prediv));
+ if (ret)
+ goto set_failed;
+
+ ret = regmap_update_bits(priv->syscon_regmap, offset->fbdiv, mask->fbdiv,
+ (syscon_val->fbdiv << shift->fbdiv));
+ if (ret)
+ goto set_failed;
+
+ ret = regmap_update_bits(priv->syscon_regmap, offset->postdiv1, mask->postdiv1,
+ ((syscon_val->postdiv1 >> 1) << shift->postdiv1));
+ if (ret)
+ goto set_failed;
+
+ /* frac: Integer Mode (Both 1) or Fraction Mode (Both 0) */
+ if (syscon_val->dacpd == 0 && syscon_val->dsmpd == 0)
+ ret = regmap_update_bits(priv->syscon_regmap, offset->frac, mask->frac,
+ (syscon_val->frac << shift->frac));
+ else if (syscon_val->dacpd != syscon_val->dsmpd)
+ ret = -EINVAL;
+
+set_failed:
+ return ret;
+}
+
+static unsigned long jh7110_pll_recalc_rate(struct clk_hw *hw, unsigned long parent_rate)
+{
+ struct jh7110_clk_pll_data *data = jh7110_pll_data_from(hw);
+
+ return jh7110_pll_get_freq(data, parent_rate);
+}
+
+static int jh7110_pll_determine_rate(struct clk_hw *hw, struct clk_rate_request *req)
+{
+ struct jh7110_clk_pll_data *data = jh7110_pll_data_from(hw);
+
+ jh7110_pll_select_near_freq_id(data, req->rate);
+
+ if (data->idx == JH7110_CLK_PLL0_OUT)
+ req->rate = jh7110_pll0_syscon_freq[data->freq_select_idx].freq;
+ else if (data->idx == JH7110_CLK_PLL1_OUT)
+ req->rate = jh7110_pll1_syscon_freq[data->freq_select_idx].freq;
+ else
+ req->rate = jh7110_pll2_syscon_freq[data->freq_select_idx].freq;
+
+ return 0;
+}
+
+static int jh7110_pll_set_rate(struct clk_hw *hw, unsigned long rate,
+ unsigned long parent_rate)
+{
+ struct jh7110_clk_pll_data *data = jh7110_pll_data_from(hw);
+
+ return jh7110_pll_set_freq_syscon(data);
+}
+
+#ifdef CONFIG_DEBUG_FS
+static void jh7110_pll_debug_init(struct clk_hw *hw, struct dentry *dentry)
+{
+ static const struct debugfs_reg32 jh7110_clk_pll_reg = {
+ .name = "CTRL",
+ .offset = 0,
+ };
+ struct jh7110_clk_pll_data *data = jh7110_pll_data_from(hw);
+ struct jh7110_clk_pll_priv *priv = jh7110_pll_priv_from(data);
+ struct debugfs_regset32 *regset;
+
+ regset = devm_kzalloc(priv->dev, sizeof(*regset), GFP_KERNEL);
+ if (!regset)
+ return;
+
+ regset->regs = &jh7110_clk_pll_reg;
+ regset->nregs = 1;
+
+ debugfs_create_regset32("registers", 0400, dentry, regset);
+}
+#else
+#define jh7110_pll_debug_init NULL
+#endif
+
+static const struct clk_ops jh7110_pll_ops = {
+ .recalc_rate = jh7110_pll_recalc_rate,
+ .determine_rate = jh7110_pll_determine_rate,
+ .set_rate = jh7110_pll_set_rate,
+ .debug_init = jh7110_pll_debug_init,
+};
+
+/* get offset, mask and shift of PLL(x) syscon */
+static int jh7110_pll_data_get(struct jh7110_clk_pll_data *data, int index)
+{
+ struct jh7110_pll_syscon_offset *offset = &data->offset;
+ struct jh7110_pll_syscon_mask *mask = &data->mask;
+ struct jh7110_pll_syscon_shift *shift = &data->shift;
+
+ if (index == JH7110_CLK_PLL0_OUT) {
+ offset->dacpd = STARFIVE_JH7110_PLL0_DACPD_OFFSET;
+ offset->dsmpd = STARFIVE_JH7110_PLL0_DSMPD_OFFSET;
+ offset->fbdiv = STARFIVE_JH7110_PLL0_FBDIV_OFFSET;
+ offset->frac = STARFIVE_JH7110_PLL0_FRAC_OFFSET;
+ offset->prediv = STARFIVE_JH7110_PLL0_PREDIV_OFFSET;
+ offset->postdiv1 = STARFIVE_JH7110_PLL0_POSTDIV1_OFFSET;
+
+ mask->dacpd = STARFIVE_JH7110_PLL0_DACPD_MASK;
+ mask->dsmpd = STARFIVE_JH7110_PLL0_DSMPD_MASK;
+ mask->fbdiv = STARFIVE_JH7110_PLL0_FBDIV_MASK;
+ mask->frac = STARFIVE_JH7110_PLL0_FRAC_MASK;
+ mask->prediv = STARFIVE_JH7110_PLL0_PREDIV_MASK;
+ mask->postdiv1 = STARFIVE_JH7110_PLL0_POSTDIV1_MASK;
+
+ shift->dacpd = STARFIVE_JH7110_PLL0_DACPD_SHIFT;
+ shift->dsmpd = STARFIVE_JH7110_PLL0_DSMPD_SHIFT;
+ shift->fbdiv = STARFIVE_JH7110_PLL0_FBDIV_SHIFT;
+ shift->frac = STARFIVE_JH7110_PLL0_FRAC_SHIFT;
+ shift->prediv = STARFIVE_JH7110_PLL0_PREDIV_SHIFT;
+ shift->postdiv1 = STARFIVE_JH7110_PLL0_POSTDIV1_SHIFT;
+
+ } else if (index == JH7110_CLK_PLL1_OUT) {
+ offset->dacpd = STARFIVE_JH7110_PLL1_DACPD_OFFSET;
+ offset->dsmpd = STARFIVE_JH7110_PLL1_DSMPD_OFFSET;
+ offset->fbdiv = STARFIVE_JH7110_PLL1_FBDIV_OFFSET;
+ offset->frac = STARFIVE_JH7110_PLL1_FRAC_OFFSET;
+ offset->prediv = STARFIVE_JH7110_PLL1_PREDIV_OFFSET;
+ offset->postdiv1 = STARFIVE_JH7110_PLL1_POSTDIV1_OFFSET;
+
+ mask->dacpd = STARFIVE_JH7110_PLL1_DACPD_MASK;
+ mask->dsmpd = STARFIVE_JH7110_PLL1_DSMPD_MASK;
+ mask->fbdiv = STARFIVE_JH7110_PLL1_FBDIV_MASK;
+ mask->frac = STARFIVE_JH7110_PLL1_FRAC_MASK;
+ mask->prediv = STARFIVE_JH7110_PLL1_PREDIV_MASK;
+ mask->postdiv1 = STARFIVE_JH7110_PLL1_POSTDIV1_MASK;
+
+ shift->dacpd = STARFIVE_JH7110_PLL1_DACPD_SHIFT;
+ shift->dsmpd = STARFIVE_JH7110_PLL1_DSMPD_SHIFT;
+ shift->fbdiv = STARFIVE_JH7110_PLL1_FBDIV_SHIFT;
+ shift->frac = STARFIVE_JH7110_PLL1_FRAC_SHIFT;
+ shift->prediv = STARFIVE_JH7110_PLL1_PREDIV_SHIFT;
+ shift->postdiv1 = STARFIVE_JH7110_PLL1_POSTDIV1_SHIFT;
+
+ } else if (index == JH7110_CLK_PLL2_OUT) {
+ offset->dacpd = STARFIVE_JH7110_PLL2_DACPD_OFFSET;
+ offset->dsmpd = STARFIVE_JH7110_PLL2_DSMPD_OFFSET;
+ offset->fbdiv = STARFIVE_JH7110_PLL2_FBDIV_OFFSET;
+ offset->frac = STARFIVE_JH7110_PLL2_FRAC_OFFSET;
+ offset->prediv = STARFIVE_JH7110_PLL2_PREDIV_OFFSET;
+ offset->postdiv1 = STARFIVE_JH7110_PLL2_POSTDIV1_OFFSET;
+
+ mask->dacpd = STARFIVE_JH7110_PLL2_DACPD_MASK;
+ mask->dsmpd = STARFIVE_JH7110_PLL2_DSMPD_MASK;
+ mask->fbdiv = STARFIVE_JH7110_PLL2_FBDIV_MASK;
+ mask->frac = STARFIVE_JH7110_PLL2_FRAC_MASK;
+ mask->prediv = STARFIVE_JH7110_PLL2_PREDIV_MASK;
+ mask->postdiv1 = STARFIVE_JH7110_PLL2_POSTDIV1_MASK;
+
+ shift->dacpd = STARFIVE_JH7110_PLL2_DACPD_SHIFT;
+ shift->dsmpd = STARFIVE_JH7110_PLL2_DSMPD_SHIFT;
+ shift->fbdiv = STARFIVE_JH7110_PLL2_FBDIV_SHIFT;
+ shift->frac = STARFIVE_JH7110_PLL2_FRAC_SHIFT;
+ shift->prediv = STARFIVE_JH7110_PLL2_PREDIV_SHIFT;
+ shift->postdiv1 = STARFIVE_JH7110_PLL2_POSTDIV1_SHIFT;
+
+ } else {
+ return -ENOENT;
+ }
+
+ return 0;
+}
+
+static struct clk_hw *jh7110_pll_get(struct of_phandle_args *clkspec, void *data)
+{
+ struct jh7110_clk_pll_priv *priv = data;
+ unsigned int idx = clkspec->args[0];
+
+ if (idx < JH7110_PLLCLK_END)
+ return &priv->data[idx].hw;
+
+ return ERR_PTR(-EINVAL);
+}
+
+static int jh7110_pll_probe(struct platform_device *pdev)
+{
+ const char *pll_name[JH7110_PLLCLK_END] = {
+ "pll0_out",
+ "pll1_out",
+ "pll2_out"
+ };
+ struct jh7110_clk_pll_priv *priv;
+ struct jh7110_clk_pll_data *data;
+ int ret;
+ unsigned int idx;
+
+ priv = devm_kzalloc(&pdev->dev, struct_size(priv, data, JH7110_PLLCLK_END),
+ GFP_KERNEL);
+ if (!priv)
+ return -ENOMEM;
+
+ priv->dev = &pdev->dev;
+ priv->syscon_regmap = syscon_node_to_regmap(priv->dev->of_node->parent);
+ if (IS_ERR(priv->syscon_regmap))
+ return PTR_ERR(priv->syscon_regmap);
+
+ for (idx = 0; idx < JH7110_PLLCLK_END; idx++) {
+ struct clk_parent_data parents = {
+ .index = 0,
+ };
+ struct clk_init_data init = {
+ .name = pll_name[idx],
+ .ops = &jh7110_pll_ops,
+ .parent_data = &parents,
+ .num_parents = 1,
+ .flags = 0,
+ };
+
+ data = &priv->data[idx];
+
+ ret = jh7110_pll_data_get(data, idx);
+ if (ret)
+ return ret;
+
+ data->hw.init = &init;
+ data->idx = idx;
+
+ ret = devm_clk_hw_register(&pdev->dev, &data->hw);
+ if (ret)
+ return ret;
+ }
+
+ return devm_of_clk_add_hw_provider(&pdev->dev, jh7110_pll_get, priv);
+}
+
+static const struct of_device_id jh7110_pll_match[] = {
+ { .compatible = "starfive,jh7110-pll" },
+ { /* sentinel */ }
+};
+MODULE_DEVICE_TABLE(of, jh7110_pll_match);
+
+static struct platform_driver jh7110_pll_driver = {
+ .driver = {
+ .name = "clk-starfive-jh7110-pll",
+ .of_match_table = jh7110_pll_match,
+ },
+};
+builtin_platform_driver_probe(jh7110_pll_driver, jh7110_pll_probe);
diff --git a/drivers/clk/starfive/clk-starfive-jh7110-pll.h b/drivers/clk/starfive/clk-starfive-jh7110-pll.h
new file mode 100644
index 000000000000..2cbfa9630c98
--- /dev/null
+++ b/drivers/clk/starfive/clk-starfive-jh7110-pll.h
@@ -0,0 +1,293 @@
+/* SPDX-License-Identifier: GPL-2.0 OR MIT */
+/*
+ * StarFive JH7110 PLL Clock Generator Driver
+ *
+ * Copyright (C) 2023 StarFive Technology Co., Ltd.
+ */
+
+#ifndef _CLK_STARFIVE_JH7110_PLL_H_
+#define _CLK_STARFIVE_JH7110_PLL_H_
+
+#include <linux/bits.h>
+
+/* The decimal places are counted by expanding them by a factor of STARFIVE_PLL_FRAC_PATR_SIZE */
+#define STARFIVE_PLL_FRAC_PATR_SIZE 1000
+
+#define STARFIVE_JH7110_PLL0_DACPD_OFFSET 0x18
+#define STARFIVE_JH7110_PLL0_DACPD_SHIFT 24
+#define STARFIVE_JH7110_PLL0_DACPD_MASK BIT(24)
+#define STARFIVE_JH7110_PLL0_DSMPD_OFFSET 0x18
+#define STARFIVE_JH7110_PLL0_DSMPD_SHIFT 25
+#define STARFIVE_JH7110_PLL0_DSMPD_MASK BIT(25)
+#define STARFIVE_JH7110_PLL0_FBDIV_OFFSET 0x1c
+#define STARFIVE_JH7110_PLL0_FBDIV_SHIFT 0
+#define STARFIVE_JH7110_PLL0_FBDIV_MASK GENMASK(11, 0)
+#define STARFIVE_JH7110_PLL0_FRAC_OFFSET 0x20
+#define STARFIVE_JH7110_PLL0_FRAC_SHIFT 0
+#define STARFIVE_JH7110_PLL0_FRAC_MASK GENMASK(23, 0)
+#define STARFIVE_JH7110_PLL0_POSTDIV1_OFFSET 0x20
+#define STARFIVE_JH7110_PLL0_POSTDIV1_SHIFT 28
+#define STARFIVE_JH7110_PLL0_POSTDIV1_MASK GENMASK(29, 28)
+#define STARFIVE_JH7110_PLL0_PREDIV_OFFSET 0x24
+#define STARFIVE_JH7110_PLL0_PREDIV_SHIFT 0
+#define STARFIVE_JH7110_PLL0_PREDIV_MASK GENMASK(5, 0)
+
+#define STARFIVE_JH7110_PLL1_DACPD_OFFSET 0x24
+#define STARFIVE_JH7110_PLL1_DACPD_SHIFT 15
+#define STARFIVE_JH7110_PLL1_DACPD_MASK BIT(15)
+#define STARFIVE_JH7110_PLL1_DSMPD_OFFSET 0x24
+#define STARFIVE_JH7110_PLL1_DSMPD_SHIFT 16
+#define STARFIVE_JH7110_PLL1_DSMPD_MASK BIT(16)
+#define STARFIVE_JH7110_PLL1_FBDIV_OFFSET 0x24
+#define STARFIVE_JH7110_PLL1_FBDIV_SHIFT 17
+#define STARFIVE_JH7110_PLL1_FBDIV_MASK GENMASK(28, 17)
+#define STARFIVE_JH7110_PLL1_FRAC_OFFSET 0x28
+#define STARFIVE_JH7110_PLL1_FRAC_SHIFT 0
+#define STARFIVE_JH7110_PLL1_FRAC_MASK GENMASK(23, 0)
+#define STARFIVE_JH7110_PLL1_POSTDIV1_OFFSET 0x28
+#define STARFIVE_JH7110_PLL1_POSTDIV1_SHIFT 28
+#define STARFIVE_JH7110_PLL1_POSTDIV1_MASK GENMASK(29, 28)
+#define STARFIVE_JH7110_PLL1_PREDIV_OFFSET 0x2c
+#define STARFIVE_JH7110_PLL1_PREDIV_SHIFT 0
+#define STARFIVE_JH7110_PLL1_PREDIV_MASK GENMASK(5, 0)
+
+#define STARFIVE_JH7110_PLL2_DACPD_OFFSET 0x2c
+#define STARFIVE_JH7110_PLL2_DACPD_SHIFT 15
+#define STARFIVE_JH7110_PLL2_DACPD_MASK BIT(15)
+#define STARFIVE_JH7110_PLL2_DSMPD_OFFSET 0x2c
+#define STARFIVE_JH7110_PLL2_DSMPD_SHIFT 16
+#define STARFIVE_JH7110_PLL2_DSMPD_MASK BIT(16)
+#define STARFIVE_JH7110_PLL2_FBDIV_OFFSET 0x2c
+#define STARFIVE_JH7110_PLL2_FBDIV_SHIFT 17
+#define STARFIVE_JH7110_PLL2_FBDIV_MASK GENMASK(28, 17)
+#define STARFIVE_JH7110_PLL2_FRAC_OFFSET 0x30
+#define STARFIVE_JH7110_PLL2_FRAC_SHIFT 0
+#define STARFIVE_JH7110_PLL2_FRAC_MASK GENMASK(23, 0)
+#define STARFIVE_JH7110_PLL2_POSTDIV1_OFFSET 0x30
+#define STARFIVE_JH7110_PLL2_POSTDIV1_SHIFT 28
+#define STARFIVE_JH7110_PLL2_POSTDIV1_MASK GENMASK(29, 28)
+#define STARFIVE_JH7110_PLL2_PREDIV_OFFSET 0x34
+#define STARFIVE_JH7110_PLL2_PREDIV_SHIFT 0
+#define STARFIVE_JH7110_PLL2_PREDIV_MASK GENMASK(5, 0)
+
+struct jh7110_pll_syscon_offset {
+ unsigned int dacpd;
+ unsigned int dsmpd;
+ unsigned int fbdiv;
+ unsigned int frac;
+ unsigned int prediv;
+ unsigned int postdiv1;
+};
+
+struct jh7110_pll_syscon_mask {
+ u32 dacpd;
+ u32 dsmpd;
+ u32 fbdiv;
+ u32 frac;
+ u32 prediv;
+ u32 postdiv1;
+};
+
+struct jh7110_pll_syscon_shift {
+ char dacpd;
+ char dsmpd;
+ char fbdiv;
+ char frac;
+ char prediv;
+ char postdiv1;
+};
+
+struct jh7110_clk_pll_data {
+ struct clk_hw hw;
+ unsigned int idx;
+ unsigned int freq_select_idx;
+
+ struct jh7110_pll_syscon_offset offset;
+ struct jh7110_pll_syscon_mask mask;
+ struct jh7110_pll_syscon_shift shift;
+};
+
+struct jh7110_clk_pll_priv {
+ struct device *dev;
+ struct regmap *syscon_regmap;
+ struct jh7110_clk_pll_data data[];
+};
+
+struct starfive_pll_syscon_value {
+ unsigned long freq;
+ u32 prediv;
+ u32 fbdiv;
+ u32 postdiv1;
+/* Both daxpd and dsmpd set 1 while integer mode */
+/* Both daxpd and dsmpd set 0 while fraction mode */
+ u32 dacpd;
+ u32 dsmpd;
+/* frac value should be decimals multiplied by 2^24 */
+ u32 frac;
+};
+
+enum starfive_pll0_freq_index {
+ PLL0_FREQ_375 = 0,
+ PLL0_FREQ_500,
+ PLL0_FREQ_625,
+ PLL0_FREQ_750,
+ PLL0_FREQ_875,
+ PLL0_FREQ_1000,
+ PLL0_FREQ_1250,
+ PLL0_FREQ_1375,
+ PLL0_FREQ_1500,
+ PLL0_FREQ_MAX
+};
+
+enum starfive_pll1_freq_index {
+ PLL1_FREQ_1066 = 0,
+ PLL1_FREQ_1200,
+ PLL1_FREQ_1400,
+ PLL1_FREQ_1600,
+ PLL1_FREQ_MAX
+};
+
+enum starfive_pll2_freq_index {
+ PLL2_FREQ_1188 = 0,
+ PLL2_FREQ_12288,
+ PLL2_FREQ_MAX
+};
+
+/*
+ * Because the pll frequency is relatively fixed,
+ * it cannot be set arbitrarily, so it needs a specific configuration.
+ * PLL0 frequency should be multiple of 125MHz (USB frequency).
+ */
+static const struct starfive_pll_syscon_value
+ jh7110_pll0_syscon_freq[PLL0_FREQ_MAX] = {
+ [PLL0_FREQ_375] = {
+ .freq = 375000000,
+ .prediv = 8,
+ .fbdiv = 125,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_500] = {
+ .freq = 500000000,
+ .prediv = 6,
+ .fbdiv = 125,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_625] = {
+ .freq = 625000000,
+ .prediv = 24,
+ .fbdiv = 625,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_750] = {
+ .freq = 750000000,
+ .prediv = 4,
+ .fbdiv = 125,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_875] = {
+ .freq = 875000000,
+ .prediv = 24,
+ .fbdiv = 875,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_1000] = {
+ .freq = 1000000000,
+ .prediv = 3,
+ .fbdiv = 125,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_1250] = {
+ .freq = 1250000000,
+ .prediv = 12,
+ .fbdiv = 625,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_1375] = {
+ .freq = 1375000000,
+ .prediv = 24,
+ .fbdiv = 1375,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL0_FREQ_1500] = {
+ .freq = 1500000000,
+ .prediv = 2,
+ .fbdiv = 125,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+};
+
+static const struct starfive_pll_syscon_value
+ jh7110_pll1_syscon_freq[PLL1_FREQ_MAX] = {
+ [PLL1_FREQ_1066] = {
+ .freq = 1066000000,
+ .prediv = 12,
+ .fbdiv = 533,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL1_FREQ_1200] = {
+ .freq = 1200000000,
+ .prediv = 1,
+ .fbdiv = 50,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL1_FREQ_1400] = {
+ .freq = 1400000000,
+ .prediv = 6,
+ .fbdiv = 350,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL1_FREQ_1600] = {
+ .freq = 1600000000,
+ .prediv = 3,
+ .fbdiv = 200,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+};
+
+static const struct starfive_pll_syscon_value
+ jh7110_pll2_syscon_freq[PLL2_FREQ_MAX] = {
+ [PLL2_FREQ_1188] = {
+ .freq = 1188000000,
+ .prediv = 2,
+ .fbdiv = 99,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+ [PLL2_FREQ_12288] = {
+ .freq = 1228800000,
+ .prediv = 5,
+ .fbdiv = 256,
+ .postdiv1 = 1,
+ .dacpd = 1,
+ .dsmpd = 1,
+ },
+};
+
+#endif
--
2.25.1