Skip to contentSkip to conversation

AST2600 clock and FSI: Add APLL to control FSI clock

PATCH In review Eddie James 2 participants 9 messages Aug 24, 2020 – Sep 2, 2020

Subsystems (4)
lore
Share & tools
lore

Eddie James

author maintainer
#0 lore raw

cover AST2600 clock and FSI: Add APLL to control FSI clock

Add functionality to control the APLL clock on the AST2600. The APLL provides the clock for the FSI master on the AST2600. Then add a devicetree property to set the AST2600 FSI master clock frequency.

Eddie James (4):
clk: ast2600: Add functionality to the APLL clock
dt-bindings: fsi: Aspeed master: Add clock-frequency property
fsi: Aspeed master: Set clock frequency from devicetree
ARM: dts: Aspeed: Rainier: Set FSI clock frequency

 .../bindings/fsi/fsi-master-aspeed.txt        |   1 +
 arch/arm/boot/dts/aspeed-bmc-ibm-rainier.dts  |   1 +
 drivers/clk/clk-ast2600.c                     | 177 ++++++++++++++++--
 drivers/fsi/fsi-master-aspeed.c               |   6 +
 include/dt-bindings/clock/ast2600-clock.h     |   1 +
 5 files changed, 174 insertions(+), 12 deletions(-)
Signature · 1 line
2.26.2
author maintainer
#1 lore raw

PATCH 1/4 clk: ast2600: Add functionality to the APLL clock

Register a clock with it's own operations to describe the APLL on the AST2600. The clock is controlled by an SCU register containing a multiplier and divider of the 25MHz input clock.
The functionality to change the APLL is necessary to finely control the FSI clock.

---
 drivers/clk/clk-ast2600.c                 | 177 ++++++++++++++++++++--
 include/dt-bindings/clock/ast2600-clock.h |   1 +
 2 files changed, 166 insertions(+), 12 deletions(-)
drivers/clk/clk-ast2600.c +165 -12
index bbacaccad554..975677491f09 100644
@@ -4,6 +4,7 @@
 
 #define pr_fmt(fmt) "clk-ast2600: " fmt
 
+#include <linux/kernel.h>
 #include <linux/mfd/syscon.h>
 #include <linux/of_address.h>
 #include <linux/of_device.h>
@@ -15,7 +16,7 @@
 
 #include "clk-aspeed.h"
 
-#define ASPEED_G6_NUM_CLKS		71
+#define ASPEED_G6_NUM_CLKS		72
 
 #define ASPEED_G6_SILICON_REV		0x004
 
@@ -31,6 +32,7 @@
 #define ASPEED_G6_CLK_SELECTION1	0x300
 #define ASPEED_G6_CLK_SELECTION2	0x304
 #define ASPEED_G6_CLK_SELECTION4	0x310
+#define ASPEED_G6_CLK_SELECTION5	0x314
 
 #define ASPEED_HPLL_PARAM		0x200
 #define ASPEED_APLL_PARAM		0x210
@@ -116,7 +118,7 @@ static const struct aspeed_gate_data aspeed_g6_gates[] = {
 	[ASPEED_CLK_GATE_UART11CLK]	= { 59,  -1, "uart11clk-gate",	"uartx", 0 },	/* UART11 */
 	[ASPEED_CLK_GATE_UART12CLK]	= { 60,  -1, "uart12clk-gate",	"uartx", 0 },	/* UART12 */
 	[ASPEED_CLK_GATE_UART13CLK]	= { 61,  -1, "uart13clk-gate",	"uartx", 0 },	/* UART13 */
-	[ASPEED_CLK_GATE_FSICLK]	= { 62,  59, "fsiclk-gate",	NULL,	 0 },	/* FSI */
+	[ASPEED_CLK_GATE_FSICLK]	= { 62,  59, "fsiclk-gate",	"aplln", CLK_SET_RATE_PARENT },	/* FSI */
 };
 
 static const struct clk_div_table ast2600_eclk_div_table[] = {
@@ -187,24 +189,166 @@ static struct clk_hw *ast2600_calc_pll(const char *name, u32 val)
 			mult, div);
 };
 
-static struct clk_hw *ast2600_calc_apll(const char *name, u32 val)
+/*
+ * APLL Frequency: F = 25MHz * (2 - od) * [(m + 2) / (n + 1)]
+ */
+static void ast2600_apll_get_params(unsigned int *div, unsigned int *mul)
 {
-	unsigned int mult, div;
+	u32 val = readl(scu_g6_base + ASPEED_APLL_PARAM);
 
 	if (val & BIT(20)) {
 		/* Pass through mode */
-		mult = div = 1;
+		*mul = *div = 1;
 	} else {
-		/* F = 25Mhz * (2-od) * [(m + 2) / (n + 1)] */
 		u32 m = (val >> 5) & 0x3f;
 		u32 od = (val >> 4) & 0x1;
 		u32 n = val & 0xf;
 
-		mult = (2 - od) * (m + 2);
-		div = n + 1;
+		*mul = (2 - od) * (m + 2);
+		*div = n + 1;
 	}
-	return clk_hw_register_fixed_factor(NULL, name, "clkin", 0,
-			mult, div);
+}
+
+static long ast2600_apll_best(unsigned long ul_rate, unsigned long ul_prate,
+			      unsigned int *out_div, unsigned int *out_mul,
+			      unsigned int *output_divider)
+{
+#define min_mult 2ULL
+#define max_mult 65ULL
+#define min_div 1ULL
+#define max_div 16ULL
+	int i;
+	unsigned int bod = 0;
+	unsigned long long rem = 1ULL;
+	unsigned long long brem = ~(0ULL);
+	unsigned long long bdiv = 1ULL;
+	unsigned long long tdiv;
+	unsigned long long bmul = 16ULL;
+	unsigned long long tmul;
+	long brate = -ERANGE;
+	unsigned long long trate;
+	unsigned long long rate = ul_rate;
+	unsigned long long prate = ul_prate;
+
+	for (i = 0; i < 2; ++i, prate *= 2ULL) {
+		for (tdiv = min_div; tdiv <= max_div; ++tdiv) {
+			tmul = DIV_ROUND_CLOSEST_ULL(rate * tdiv, prate);
+			if (tmul <  min_mult || tmul > max_mult)
+				continue;
+
+			trate = DIV_ROUND_CLOSEST_ULL(prate * tmul, tdiv);
+			if (trate > rate)
+				rem = trate - rate;
+			else
+				rem = rate - trate;
+
+			if (rem < brem) {
+				bod = !i;
+				brem = rem;
+				bdiv = tdiv;
+				bmul = tmul;
+				brate = (long)trate;
+			}
+
+			if (!rem)
+				break;
+		}
+
+		if (!rem)
+			break;
+	}
+
+	if (out_div)
+		*out_div = (unsigned int)bdiv;
+
+	if (out_mul)
+		*out_mul = (unsigned int)bmul;
+
+	if (output_divider)
+		*output_divider = bod;
+
+	return brate;
+#undef min_mult
+#undef max_mult
+#undef min_div
+#undef max_div
+}
+
+static unsigned long ast2600_apll_recalc_rate(struct clk_hw *hw,
+					      unsigned long parent_rate)
+{
+	unsigned int div;
+	unsigned int mul;
+	unsigned long long rate;
+	unsigned long long prate = (unsigned long long)parent_rate;
+
+	ast2600_apll_get_params(&div, &mul);
+
+	rate = DIV_ROUND_CLOSEST_ULL(prate * (unsigned long long)mul, div);
+	return (unsigned long)rate;
+}
+
+static long ast2600_apll_round_rate(struct clk_hw *hw, unsigned long rate,
+				    unsigned long *parent_rate)
+{
+	return ast2600_apll_best(rate, *parent_rate, NULL, NULL, NULL);
+}
+
+static int ast2600_apll_set_rate(struct clk_hw *hw, unsigned long rate,
+				 unsigned long parent_rate)
+{
+	u32 val;
+	unsigned int od;
+	unsigned int div;
+	unsigned int mul;
+	long brate = ast2600_apll_best(rate, parent_rate, &div, &mul, &od);
+
+	if (brate < 0)
+		return brate;
+
+	val = readl(scu_g6_base + ASPEED_APLL_PARAM);
+	val &= ~0x7ff;
+	val |= (div - 1) & 0xf;
+	val |= ((mul - 2) & 0x3f) << 5;
+	if (od)
+		val |= 0x10;
+	writel(val, scu_g6_base + ASPEED_APLL_PARAM);
+
+	return 0;
+}
+
+static const struct clk_ops ast2600_apll_ops = {
+	.recalc_rate = ast2600_apll_recalc_rate,
+	.round_rate = ast2600_apll_round_rate,
+	.set_rate = ast2600_apll_set_rate,
+};
+
+static struct clk_hw *ast2600_create_apll(void)
+{
+	int rc;
+	const char *parent = "clkin";
+	struct clk_init_data init = {
+		.name = "apll",
+		.ops = &ast2600_apll_ops,
+		.parent_names = &parent,
+		.parent_data = NULL,
+		.parent_hws = NULL,
+		.num_parents = 1,
+		.flags = 0,
+	};
+	struct clk_hw *clk = kzalloc(sizeof(*clk), GFP_KERNEL);
+
+	if (!clk)
+		return ERR_PTR(-ENOMEM);
+
+	clk->init = &init;
+	rc = of_clk_hw_register(NULL, clk);
+	if (rc) {
+		kfree(clk);
+		clk = ERR_PTR(rc);
+	}
+
+	return clk;
 };
 
 static u32 get_bit(u8 idx)
@@ -630,6 +774,16 @@ static int aspeed_g6_clk_probe(struct platform_device *pdev)
 		return PTR_ERR(hw);
 	aspeed_g6_clk_data->hws[ASPEED_CLK_ECLK] = hw;
 
+	hw = clk_hw_register_divider_table(dev, "aplln", "apll",
+					   CLK_SET_RATE_PARENT,
+					   scu_g6_base + ASPEED_G6_CLK_SELECTION5,
+					   28, 3, CLK_DIVIDER_READ_ONLY,
+					   ast2600_eclk_div_table,
+					   &aspeed_g6_clk_lock);
+	if (IS_ERR(hw))
+		return PTR_ERR(hw);
+	aspeed_g6_clk_data->hws[ASPEED_CLK_APLLN] = hw;
+
 	for (i = 0; i < ARRAY_SIZE(aspeed_g6_gates); i++) {
 		const struct aspeed_gate_data *gd = &aspeed_g6_gates[i];
 		u32 gate_flags;
@@ -710,8 +864,7 @@ static void __init aspeed_g6_cc(struct regmap *map)
 	regmap_read(map, ASPEED_EPLL_PARAM, &val);
 	aspeed_g6_clk_data->hws[ASPEED_CLK_EPLL] = ast2600_calc_pll("epll", val);
 
-	regmap_read(map, ASPEED_APLL_PARAM, &val);
-	aspeed_g6_clk_data->hws[ASPEED_CLK_APLL] = ast2600_calc_apll("apll", val);
+	aspeed_g6_clk_data->hws[ASPEED_CLK_APLL] = ast2600_create_apll();
 
 	/* Strap bits 12:11 define the AXI/AHB clock frequency ratio (aka HCLK)*/
 	regmap_read(map, ASPEED_G6_STRAP1, &val);
include/dt-bindings/clock/ast2600-clock.h +1 -0
index 62b9520a00fd..a286d63de399 100644
@@ -87,6 +87,7 @@
 #define ASPEED_CLK_MAC2RCLK		68
 #define ASPEED_CLK_MAC3RCLK		69
 #define ASPEED_CLK_MAC4RCLK		70
+#define ASPEED_CLK_APLLN        71
 
 /* Only list resets here that are not part of a gate */
 #define ASPEED_RESET_ADC		55
Signature · 1 line
2.26.2
maintainer
#2 lore raw

Re: [PATCH linux dev-5.8 1/4] clk: ast2600: Add functionality to the APLL clock

Quoted 6 lines · Eddie James

Register a clock with it's own operations to describe the APLL on the AST2600. The clock is controlled by an SCU register containing a multiplier and divider of the 25MHz input clock.
The functionality to change the APLL is necessary to finely control the FSI clock.

I thought the FSI clock could be sourced from either the APLL or another PLL. Should we go to the effort of modelling that in the clock driver?

Quoted 87 lines
---
 drivers/clk/clk-ast2600.c                 | 177 ++++++++++++++++++++--
 include/dt-bindings/clock/ast2600-clock.h |   1 +
 2 files changed, 166 insertions(+), 12 deletions(-)
drivers/clk/clk-ast2600.c +24 -10
index bbacaccad554..975677491f09 100644
@@ -4,6 +4,7 @@
 
 #define pr_fmt(fmt) "clk-ast2600: " fmt
 
+#include <linux/kernel.h>
 #include <linux/mfd/syscon.h>
 #include <linux/of_address.h>
 #include <linux/of_device.h>
@@ -15,7 +16,7 @@
 
 #include "clk-aspeed.h"
 
-#define ASPEED_G6_NUM_CLKS             71
+#define ASPEED_G6_NUM_CLKS             72
 
 #define ASPEED_G6_SILICON_REV          0x004
 
@@ -31,6 +32,7 @@
 #define ASPEED_G6_CLK_SELECTION1       0x300
 #define ASPEED_G6_CLK_SELECTION2       0x304
 #define ASPEED_G6_CLK_SELECTION4       0x310
+#define ASPEED_G6_CLK_SELECTION5       0x314
 
 #define ASPEED_HPLL_PARAM              0x200
 #define ASPEED_APLL_PARAM              0x210
@@ -116,7 +118,7 @@ static const struct aspeed_gate_data aspeed_g6_gates[] = {
        [ASPEED_CLK_GATE_UART11CLK]     = { 59,  -1, "uart11clk-gate",  "uartx", 0 },   /* UART11 */
        [ASPEED_CLK_GATE_UART12CLK]     = { 60,  -1, "uart12clk-gate",  "uartx", 0 },   /* UART12 */
        [ASPEED_CLK_GATE_UART13CLK]     = { 61,  -1, "uart13clk-gate",  "uartx", 0 },   /* UART13 */
-       [ASPEED_CLK_GATE_FSICLK]        = { 62,  59, "fsiclk-gate",     NULL,    0 },   /* FSI */
+       [ASPEED_CLK_GATE_FSICLK]        = { 62,  59, "fsiclk-gate",     "aplln", CLK_SET_RATE_PARENT }, /* FSI */
 };
 
 static const struct clk_div_table ast2600_eclk_div_table[] = {
@@ -187,24 +189,166 @@ static struct clk_hw *ast2600_calc_pll(const char *name, u32 val)
                        mult, div);
 };
 
-static struct clk_hw *ast2600_calc_apll(const char *name, u32 val)
+/*
+ * APLL Frequency: F = 25MHz * (2 - od) * [(m + 2) / (n + 1)]
+ */
+static void ast2600_apll_get_params(unsigned int *div, unsigned int *mul)
 {
-       unsigned int mult, div;
+       u32 val = readl(scu_g6_base + ASPEED_APLL_PARAM);
 
        if (val & BIT(20)) {
                /* Pass through mode */
-               mult = div = 1;
+               *mul = *div = 1;
        } else {
-               /* F = 25Mhz * (2-od) * [(m + 2) / (n + 1)] */
                u32 m = (val >> 5) & 0x3f;
                u32 od = (val >> 4) & 0x1;
                u32 n = val & 0xf;
 
-               mult = (2 - od) * (m + 2);
-               div = n + 1;
+               *mul = (2 - od) * (m + 2);
+               *div = n + 1;
        }
-       return clk_hw_register_fixed_factor(NULL, name, "clkin", 0,
-                       mult, div);
+}
+
+static long ast2600_apll_best(unsigned long ul_rate, unsigned long ul_prate,
+                             unsigned int *out_div, unsigned int *out_mul,
+                             unsigned int *output_divider)
+{
+#define min_mult 2ULL
+#define max_mult 65ULL
+#define min_div 1ULL
+#define max_div 16ULL
+       int i;
+       unsigned int bod = 0;

drivers/clk/clk-ast2600.c static struct clk_hw *ast2600_calc_pll(const char *name, u32 val) · line 231

Quoted 10 lines
drivers/clk/clk-ast2600.c +10 -0
+       unsigned long long rem = 1ULL;
+       unsigned long long brem = ~(0ULL);
+       unsigned long long bdiv = 1ULL;
+       unsigned long long tdiv;
+       unsigned long long bmul = 16ULL;
+       unsigned long long tmul;
+       long brate = -ERANGE;
+       unsigned long long trate;
+       unsigned long long rate = ul_rate;
+       unsigned long long prate = ul_prate;

This is pretty full on. Can you take a look at some other clock drivers and see how they solve it?

Can we hardcode a few known configurations, and select the closest?

If we have to do a search, take a look at something like rational_best_approximation in include/linux/rational.h

Importantly, send the changes to the clk driver upstream for review instead of doing a v2 on the openbmc list.

Quoted 89 lines
drivers/clk/clk-ast2600.c +89 -0
+
+       for (i = 0; i < 2; ++i, prate *= 2ULL) {
+               for (tdiv = min_div; tdiv <= max_div; ++tdiv) {
+                       tmul = DIV_ROUND_CLOSEST_ULL(rate * tdiv, prate);
+                       if (tmul <  min_mult || tmul > max_mult)
+                               continue;
+
+                       trate = DIV_ROUND_CLOSEST_ULL(prate * tmul, tdiv);
+                       if (trate > rate)
+                               rem = trate - rate;
+                       else
+                               rem = rate - trate;
+
+                       if (rem < brem) {
+                               bod = !i;
+                               brem = rem;
+                               bdiv = tdiv;
+                               bmul = tmul;
+                               brate = (long)trate;
+                       }
+
+                       if (!rem)
+                               break;
+               }
+
+               if (!rem)
+                       break;
+       }
+
+       if (out_div)
+               *out_div = (unsigned int)bdiv;
+
+       if (out_mul)
+               *out_mul = (unsigned int)bmul;
+
+       if (output_divider)
+               *output_divider = bod;
+
+       return brate;
+#undef min_mult
+#undef max_mult
+#undef min_div
+#undef max_div
+}
+
+static unsigned long ast2600_apll_recalc_rate(struct clk_hw *hw,
+                                             unsigned long parent_rate)
+{
+       unsigned int div;
+       unsigned int mul;
+       unsigned long long rate;
+       unsigned long long prate = (unsigned long long)parent_rate;
+
+       ast2600_apll_get_params(&div, &mul);
+
+       rate = DIV_ROUND_CLOSEST_ULL(prate * (unsigned long long)mul, div);
+       return (unsigned long)rate;
+}
+
+static long ast2600_apll_round_rate(struct clk_hw *hw, unsigned long rate,
+                                   unsigned long *parent_rate)
+{
+       return ast2600_apll_best(rate, *parent_rate, NULL, NULL, NULL);
+}
+
+static int ast2600_apll_set_rate(struct clk_hw *hw, unsigned long rate,
+                                unsigned long parent_rate)
+{
+       u32 val;
+       unsigned int od;
+       unsigned int div;
+       unsigned int mul;
+       long brate = ast2600_apll_best(rate, parent_rate, &div, &mul, &od);
+
+       if (brate < 0)
+               return brate;
+
+       val = readl(scu_g6_base + ASPEED_APLL_PARAM);
+       val &= ~0x7ff;
+       val |= (div - 1) & 0xf;
+       val |= ((mul - 2) & 0x3f) << 5;
+       if (od)
+               val |= 0x10;
+       writel(val, scu_g6_base + ASPEED_APLL_PARAM);
+
+       return 0;
+}
+
+static const struct clk_ops ast2600_apll_ops = {

drivers/clk/clk-ast2600.c static struct clk_hw *ast2600_calc_pll(const char *name, u32 val) · line 330

Quoted 10 lines
drivers/clk/clk-ast2600.c +10 -0
+       .recalc_rate = ast2600_apll_recalc_rate,
+       .round_rate = ast2600_apll_round_rate,
+       .set_rate = ast2600_apll_set_rate,
+};
+
+static struct clk_hw *ast2600_create_apll(void)
+{
+       int rc;
+       const char *parent = "clkin";
+       struct clk_init_data init = {

const?

Quoted 66 lines
drivers/clk/clk-ast2600.c +32 -2
+               .name = "apll",
+               .ops = &ast2600_apll_ops,
+               .parent_names = &parent,
+               .parent_data = NULL,
+               .parent_hws = NULL,
+               .num_parents = 1,
+               .flags = 0,
+       };
+       struct clk_hw *clk = kzalloc(sizeof(*clk), GFP_KERNEL);
+
+       if (!clk)
+               return ERR_PTR(-ENOMEM);
+
+       clk->init = &init;
+       rc = of_clk_hw_register(NULL, clk);
+       if (rc) {
+               kfree(clk);
+               clk = ERR_PTR(rc);
+       }
+
+       return clk;
 };
 
 static u32 get_bit(u8 idx)
@@ -630,6 +774,16 @@ static int aspeed_g6_clk_probe(struct platform_device *pdev)
                return PTR_ERR(hw);
        aspeed_g6_clk_data->hws[ASPEED_CLK_ECLK] = hw;
 
+       hw = clk_hw_register_divider_table(dev, "aplln", "apll",
+                                          CLK_SET_RATE_PARENT,
+                                          scu_g6_base + ASPEED_G6_CLK_SELECTION5,
+                                          28, 3, CLK_DIVIDER_READ_ONLY,
+                                          ast2600_eclk_div_table,
+                                          &aspeed_g6_clk_lock);
+       if (IS_ERR(hw))
+               return PTR_ERR(hw);
+       aspeed_g6_clk_data->hws[ASPEED_CLK_APLLN] = hw;
+
        for (i = 0; i < ARRAY_SIZE(aspeed_g6_gates); i++) {
                const struct aspeed_gate_data *gd = &aspeed_g6_gates[i];
                u32 gate_flags;
@@ -710,8 +864,7 @@ static void __init aspeed_g6_cc(struct regmap *map)
        regmap_read(map, ASPEED_EPLL_PARAM, &val);
        aspeed_g6_clk_data->hws[ASPEED_CLK_EPLL] = ast2600_calc_pll("epll", val);
 
-       regmap_read(map, ASPEED_APLL_PARAM, &val);
-       aspeed_g6_clk_data->hws[ASPEED_CLK_APLL] = ast2600_calc_apll("apll", val);
+       aspeed_g6_clk_data->hws[ASPEED_CLK_APLL] = ast2600_create_apll();
 
        /* Strap bits 12:11 define the AXI/AHB clock frequency ratio (aka HCLK)*/
        regmap_read(map, ASPEED_G6_STRAP1, &val);
include/dt-bindings/clock/ast2600-clock.h +1 -1
index 62b9520a00fd..a286d63de399 100644
@@ -87,6 +87,7 @@
 #define ASPEED_CLK_MAC2RCLK            68
 #define ASPEED_CLK_MAC3RCLK            69
 #define ASPEED_CLK_MAC4RCLK            70
+#define ASPEED_CLK_APLLN        71
 
 /* Only list resets here that are not part of a gate */
 #define ASPEED_RESET_ADC               55
--

2.26.2

author maintainer
#3 lore raw

Re: [PATCH linux dev-5.8 1/4] clk: ast2600: Add functionality to the APLL clock

Quoted 9 lines · Joel Stanley
Quoted 5 lines · Eddie James

Register a clock with it's own operations to describe the APLL on the AST2600. The clock is controlled by an SCU register containing a multiplier and divider of the 25MHz input clock.
The functionality to change the APLL is necessary to finely control the FSI clock.

I thought the FSI clock could be sourced from either the APLL or another PLL. Should we go to the effort of modelling that in the clock driver?

Hm, I don't see that in the specification?

Thanks,

Eddie

Quoted 275 lines
Quoted 87 lines
---
  drivers/clk/clk-ast2600.c                 | 177 ++++++++++++++++++++--
  include/dt-bindings/clock/ast2600-clock.h |   1 +
  2 files changed, 166 insertions(+), 12 deletions(-)
drivers/clk/clk-ast2600.c +24 -10
index bbacaccad554..975677491f09 100644
@@ -4,6 +4,7 @@
 
  #define pr_fmt(fmt) "clk-ast2600: " fmt
 
+#include <linux/kernel.h>
  #include <linux/mfd/syscon.h>
  #include <linux/of_address.h>
  #include <linux/of_device.h>
@@ -15,7 +16,7 @@
 
  #include "clk-aspeed.h"
 
-#define ASPEED_G6_NUM_CLKS             71
+#define ASPEED_G6_NUM_CLKS             72
 
  #define ASPEED_G6_SILICON_REV          0x004
 
@@ -31,6 +32,7 @@
  #define ASPEED_G6_CLK_SELECTION1       0x300
  #define ASPEED_G6_CLK_SELECTION2       0x304
  #define ASPEED_G6_CLK_SELECTION4       0x310
+#define ASPEED_G6_CLK_SELECTION5       0x314
 
  #define ASPEED_HPLL_PARAM              0x200
  #define ASPEED_APLL_PARAM              0x210
@@ -116,7 +118,7 @@ static const struct aspeed_gate_data aspeed_g6_gates[] = {
         [ASPEED_CLK_GATE_UART11CLK]     = { 59,  -1, "uart11clk-gate",  "uartx", 0 },   /* UART11 */
         [ASPEED_CLK_GATE_UART12CLK]     = { 60,  -1, "uart12clk-gate",  "uartx", 0 },   /* UART12 */
         [ASPEED_CLK_GATE_UART13CLK]     = { 61,  -1, "uart13clk-gate",  "uartx", 0 },   /* UART13 */
-       [ASPEED_CLK_GATE_FSICLK]        = { 62,  59, "fsiclk-gate",     NULL,    0 },   /* FSI */
+       [ASPEED_CLK_GATE_FSICLK]        = { 62,  59, "fsiclk-gate",     "aplln", CLK_SET_RATE_PARENT }, /* FSI */
  };
 
  static const struct clk_div_table ast2600_eclk_div_table[] = {
@@ -187,24 +189,166 @@ static struct clk_hw *ast2600_calc_pll(const char *name, u32 val)
                         mult, div);
  };
 
-static struct clk_hw *ast2600_calc_apll(const char *name, u32 val)
+/*
+ * APLL Frequency: F = 25MHz * (2 - od) * [(m + 2) / (n + 1)]
+ */
+static void ast2600_apll_get_params(unsigned int *div, unsigned int *mul)
  {
-       unsigned int mult, div;
+       u32 val = readl(scu_g6_base + ASPEED_APLL_PARAM);
 
         if (val & BIT(20)) {
                 /* Pass through mode */
-               mult = div = 1;
+               *mul = *div = 1;
         } else {
-               /* F = 25Mhz * (2-od) * [(m + 2) / (n + 1)] */
                 u32 m = (val >> 5) & 0x3f;
                 u32 od = (val >> 4) & 0x1;
                 u32 n = val & 0xf;
 
-               mult = (2 - od) * (m + 2);
-               div = n + 1;
+               *mul = (2 - od) * (m + 2);
+               *div = n + 1;
         }
-       return clk_hw_register_fixed_factor(NULL, name, "clkin", 0,
-                       mult, div);
+}
+
+static long ast2600_apll_best(unsigned long ul_rate, unsigned long ul_prate,
+                             unsigned int *out_div, unsigned int *out_mul,
+                             unsigned int *output_divider)
+{
+#define min_mult 2ULL
+#define max_mult 65ULL
+#define min_div 1ULL
+#define max_div 16ULL
+       int i;
+       unsigned int bod = 0;

drivers/clk/clk-ast2600.c static struct clk_hw *ast2600_calc_pll(const char *name, u32 val) · line 231

Quoted 10 lines
drivers/clk/clk-ast2600.c +10 -0
+       unsigned long long rem = 1ULL;
+       unsigned long long brem = ~(0ULL);
+       unsigned long long bdiv = 1ULL;
+       unsigned long long tdiv;
+       unsigned long long bmul = 16ULL;
+       unsigned long long tmul;
+       long brate = -ERANGE;
+       unsigned long long trate;
+       unsigned long long rate = ul_rate;
+       unsigned long long prate = ul_prate;

This is pretty full on. Can you take a look at some other clock drivers and see how they solve it?

Can we hardcode a few known configurations, and select the closest?

If we have to do a search, take a look at something like rational_best_approximation in include/linux/rational.h

Importantly, send the changes to the clk driver upstream for review instead of doing a v2 on the openbmc list.

Quoted 89 lines
drivers/clk/clk-ast2600.c +89 -0
+
+       for (i = 0; i < 2; ++i, prate *= 2ULL) {
+               for (tdiv = min_div; tdiv <= max_div; ++tdiv) {
+                       tmul = DIV_ROUND_CLOSEST_ULL(rate * tdiv, prate);
+                       if (tmul <  min_mult || tmul > max_mult)
+                               continue;
+
+                       trate = DIV_ROUND_CLOSEST_ULL(prate * tmul, tdiv);
+                       if (trate > rate)
+                               rem = trate - rate;
+                       else
+                               rem = rate - trate;
+
+                       if (rem < brem) {
+                               bod = !i;
+                               brem = rem;
+                               bdiv = tdiv;
+                               bmul = tmul;
+                               brate = (long)trate;
+                       }
+
+                       if (!rem)
+                               break;
+               }
+
+               if (!rem)
+                       break;
+       }
+
+       if (out_div)
+               *out_div = (unsigned int)bdiv;
+
+       if (out_mul)
+               *out_mul = (unsigned int)bmul;
+
+       if (output_divider)
+               *output_divider = bod;
+
+       return brate;
+#undef min_mult
+#undef max_mult
+#undef min_div
+#undef max_div
+}
+
+static unsigned long ast2600_apll_recalc_rate(struct clk_hw *hw,
+                                             unsigned long parent_rate)
+{
+       unsigned int div;
+       unsigned int mul;
+       unsigned long long rate;
+       unsigned long long prate = (unsigned long long)parent_rate;
+
+       ast2600_apll_get_params(&div, &mul);
+
+       rate = DIV_ROUND_CLOSEST_ULL(prate * (unsigned long long)mul, div);
+       return (unsigned long)rate;
+}
+
+static long ast2600_apll_round_rate(struct clk_hw *hw, unsigned long rate,
+                                   unsigned long *parent_rate)
+{
+       return ast2600_apll_best(rate, *parent_rate, NULL, NULL, NULL);
+}
+
+static int ast2600_apll_set_rate(struct clk_hw *hw, unsigned long rate,
+                                unsigned long parent_rate)
+{
+       u32 val;
+       unsigned int od;
+       unsigned int div;
+       unsigned int mul;
+       long brate = ast2600_apll_best(rate, parent_rate, &div, &mul, &od);
+
+       if (brate < 0)
+               return brate;
+
+       val = readl(scu_g6_base + ASPEED_APLL_PARAM);
+       val &= ~0x7ff;
+       val |= (div - 1) & 0xf;
+       val |= ((mul - 2) & 0x3f) << 5;
+       if (od)
+               val |= 0x10;
+       writel(val, scu_g6_base + ASPEED_APLL_PARAM);
+
+       return 0;
+}
+
+static const struct clk_ops ast2600_apll_ops = {

drivers/clk/clk-ast2600.c static struct clk_hw *ast2600_calc_pll(const char *name, u32 val) · line 330

Quoted 10 lines
drivers/clk/clk-ast2600.c +10 -0
+       .recalc_rate = ast2600_apll_recalc_rate,
+       .round_rate = ast2600_apll_round_rate,
+       .set_rate = ast2600_apll_set_rate,
+};
+
+static struct clk_hw *ast2600_create_apll(void)
+{
+       int rc;
+       const char *parent = "clkin";
+       struct clk_init_data init = {

const?

Quoted 66 lines
drivers/clk/clk-ast2600.c +32 -2
+               .name = "apll",
+               .ops = &ast2600_apll_ops,
+               .parent_names = &parent,
+               .parent_data = NULL,
+               .parent_hws = NULL,
+               .num_parents = 1,
+               .flags = 0,
+       };
+       struct clk_hw *clk = kzalloc(sizeof(*clk), GFP_KERNEL);
+
+       if (!clk)
+               return ERR_PTR(-ENOMEM);
+
+       clk->init = &init;
+       rc = of_clk_hw_register(NULL, clk);
+       if (rc) {
+               kfree(clk);
+               clk = ERR_PTR(rc);
+       }
+
+       return clk;
  };
 
  static u32 get_bit(u8 idx)
@@ -630,6 +774,16 @@ static int aspeed_g6_clk_probe(struct platform_device *pdev)
                 return PTR_ERR(hw);
         aspeed_g6_clk_data->hws[ASPEED_CLK_ECLK] = hw;
 
+       hw = clk_hw_register_divider_table(dev, "aplln", "apll",
+                                          CLK_SET_RATE_PARENT,
+                                          scu_g6_base + ASPEED_G6_CLK_SELECTION5,
+                                          28, 3, CLK_DIVIDER_READ_ONLY,
+                                          ast2600_eclk_div_table,
+                                          &aspeed_g6_clk_lock);
+       if (IS_ERR(hw))
+               return PTR_ERR(hw);
+       aspeed_g6_clk_data->hws[ASPEED_CLK_APLLN] = hw;
+
         for (i = 0; i < ARRAY_SIZE(aspeed_g6_gates); i++) {
                 const struct aspeed_gate_data *gd = &aspeed_g6_gates[i];
                 u32 gate_flags;
@@ -710,8 +864,7 @@ static void __init aspeed_g6_cc(struct regmap *map)
         regmap_read(map, ASPEED_EPLL_PARAM, &val);
         aspeed_g6_clk_data->hws[ASPEED_CLK_EPLL] = ast2600_calc_pll("epll", val);
 
-       regmap_read(map, ASPEED_APLL_PARAM, &val);
-       aspeed_g6_clk_data->hws[ASPEED_CLK_APLL] = ast2600_calc_apll("apll", val);
+       aspeed_g6_clk_data->hws[ASPEED_CLK_APLL] = ast2600_create_apll();
 
         /* Strap bits 12:11 define the AXI/AHB clock frequency ratio (aka HCLK)*/
         regmap_read(map, ASPEED_G6_STRAP1, &val);
include/dt-bindings/clock/ast2600-clock.h +1 -1
index 62b9520a00fd..a286d63de399 100644
@@ -87,6 +87,7 @@
  #define ASPEED_CLK_MAC2RCLK            68
  #define ASPEED_CLK_MAC3RCLK            69
  #define ASPEED_CLK_MAC4RCLK            70
+#define ASPEED_CLK_APLLN        71
 
  /* Only list resets here that are not part of a gate */
  #define ASPEED_RESET_ADC               55
--

2.26.2

author maintainer
#4 lore raw

PATCH 2/4 dt-bindings: fsi: Aspeed master: Add clock-frequency property

In reply to Eddie James

Document the clock-frequency property.

---
 Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt | 1 +
 1 file changed, 1 insertion(+)
Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt +1 -0
index a513e65ec0c9..f10abef837e6 100644
@@ -17,6 +17,7 @@ Optional properties:
 
  - fsi-routing-gpios: GPIO for setting the FSI mux (internal or cabled)
  - fsi-mux-gpios: GPIO for detecting the desired FSI mux state
+ - clock-frequency: the frequency of the FSI clock
 
 
 Examples:
Signature · 1 line
2.26.2
maintainer
#5 lore raw

Re: [PATCH linux dev-5.8 2/4] dt-bindings: fsi: Aspeed master: Add clock-frequency property

Quoted 13 lines · Eddie James

Document the clock-frequency property.

---
 Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt | 1 +
 1 file changed, 1 insertion(+)
Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt +0 -0
index a513e65ec0c9..f10abef837e6 100644

Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt Optional properties: · line 20

Quoted 4 lines
Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt +1 -0
@@ -17,6 +17,7 @@ Optional properties:
 
  - fsi-routing-gpios: GPIO for setting the FSI mux (internal or cabled)
  - fsi-mux-gpios: GPIO for detecting the desired FSI mux state
+ - clock-frequency: the frequency of the FSI clock

If we follow the example of i2c, they call the frequency of the i2c bus the bus-frequency. This stops us from confusing it with the input clock of the AHB or OPB or whatever peripheral bus is inside the SoC.

Quoted 6 lines
Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt +0 -1
 Examples:
--

2.26.2

author maintainer
#6 lore raw

PATCH 3/4 fsi: Aspeed master: Set clock frequency from devicetree

In reply to Eddie James

Set the FSI clock frequency based on the value encoded in the devicetree, if present.

---
 drivers/fsi/fsi-master-aspeed.c | 6 ++++++
 1 file changed, 6 insertions(+)
drivers/fsi/fsi-master-aspeed.c +6 -0
index c006ec008a1a..aedcc9be48ca 100644
@@ -515,6 +515,7 @@ static int fsi_master_aspeed_probe(struct platform_device *pdev)
 	struct fsi_master_aspeed *aspeed;
 	struct resource *res;
 	int rc, links, reg;
+	u32 clk_freq;
 	__be32 raw;
 
 	rc = tacoma_cabled_fsi_fixup(&pdev->dev);
@@ -539,6 +540,11 @@ static int fsi_master_aspeed_probe(struct platform_device *pdev)
 		dev_err(aspeed->dev, "couldn't get clock\n");
 		return PTR_ERR(aspeed->clk);
 	}
+
+	if (!of_property_read_u32(pdev->dev.of_node, "clock-frequency",
+				  &clk_freq))
+		clk_set_rate(aspeed->clk, clk_freq);
+
 	rc = clk_prepare_enable(aspeed->clk);
 	if (rc) {
 		dev_err(aspeed->dev, "couldn't enable clock\n");
Signature · 1 line
2.26.2
maintainer Reviewed-by on v1 3/4
#7 lore raw

Re: [PATCH linux dev-5.8 3/4] fsi: Aspeed master: Set clock frequency from devicetree

Quoted 3 lines · Eddie James

Set the FSI clock frequency based on the value encoded in the devicetree, if present.

Should we default it to 166 if it's not present?

Quoted 33 lines
---
 drivers/fsi/fsi-master-aspeed.c | 6 ++++++
 1 file changed, 6 insertions(+)
drivers/fsi/fsi-master-aspeed.c +6 -1
index c006ec008a1a..aedcc9be48ca 100644
@@ -515,6 +515,7 @@ static int fsi_master_aspeed_probe(struct platform_device *pdev)
        struct fsi_master_aspeed *aspeed;
        struct resource *res;
        int rc, links, reg;
+       u32 clk_freq;
        __be32 raw;
 
        rc = tacoma_cabled_fsi_fixup(&pdev->dev);
@@ -539,6 +540,11 @@ static int fsi_master_aspeed_probe(struct platform_device *pdev)
                dev_err(aspeed->dev, "couldn't get clock\n");
                return PTR_ERR(aspeed->clk);
        }
+
+       if (!of_property_read_u32(pdev->dev.of_node, "clock-frequency",
+                                 &clk_freq))
+               clk_set_rate(aspeed->clk, clk_freq);
+
        rc = clk_prepare_enable(aspeed->clk);
        if (rc) {
                dev_err(aspeed->dev, "couldn't enable clock\n");
--

2.26.2

author maintainer
#8 lore raw

PATCH 4/4 ARM: dts: Aspeed: Rainier: Set FSI clock frequency

In reply to Eddie James

Set the FSI clock frequency to 166MHz.

---
 arch/arm/boot/dts/aspeed-bmc-ibm-rainier.dts | 1 +
 1 file changed, 1 insertion(+)
arch/arm/boot/dts/aspeed-bmc-ibm-rainier.dts +1 -0
index cbc64a1d14d1..8a1d04feecb0 100644
@@ -237,6 +237,7 @@ &emmc {
 
 &fsim0 {
 	status = "okay";
+	clock-frequency = <166666666>;
 
 	#address-cells = <2>;
 	#size-cells = <0>;
Signature · 1 line
2.26.2