clk: en7523: full clk_hw + set_rate for en7581
v3 cover clk: en7523: full clk_hw + set_rate for en7581
This simple patch convert the en7523 clk for EN7581 to full clk and adds the .set_rate OPs.
Needed mostly to configure MDC clk rate.
This will be also implemented by AN7583 since they share the same exact implementation.
Changes v3:
- Rework to clock divisor API
- Return error instead of -EINVAL
- Use dev_err where possible
- Use devm_kzalloc_obj
- Revert to not fail on clk registration failure
Changes v2:
- Fix recalc_rate return value on error
Christian Marangi (2):
clk: en7523: convert to full clk_hw implementation for en7581
clk: en7523: add support for .set_rate for en7581
drivers/clk/clk-en7523.c | 280 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 260 insertions(+), 20 deletions(-)
Signature · 1 line
2.55.0
PATCH v3 1/2 clk: en7523: convert to full clk_hw implementation for en7581
In preparation for support of .set_rate, convert the clock register logic from fixed clock implementation to full clk_hw implementation with dedicated OPs for Airoha EN7581 SoC.
This is just a rework and no behaviour change is expected.
--- drivers/clk/clk-en7523.c | 75 +++++++++++++++++++++++++++++----------- 1 file changed, 55 insertions(+), 20 deletions(-)
drivers/clk/clk-en7523.c +55 -20
@@ -126,6 +126,12 @@ struct en_clk_gate {struct clk_hw hw; }; +struct en_clk { +struct regmap *map; +const struct en_clk_desc *desc; +struct clk_hw hw; +}; +struct en_rst_data {const u16 *bank_ofs;const u16 *idx_map;
@@ -742,42 +748,71 @@ static int en7523_clk_hw_init(struct platform_device *pdev, en7581_rst_ofs); } +static unsigned long en7581_recalc_rate (struct clk_hw *hw, +unsigned long parent_rate) +{ + struct en_clk *c = container_of(hw, struct en_clk, hw); +const struct en_clk_desc *desc = c->desc; +struct device *dev =clk_hw_get_dev (hw); +struct regmap *map = c->map; +u32 val, reg; +u32 rate; +int err; + + err =regmap_read (map, desc->base_reg, &val); +if (err) { +dev_err (dev,"Failed reading fixed clk rate %s: %d\n" , + desc->name, err); +return 0 ; + } + rate =en7523_get_base_rate (desc, val); + + reg = desc->div_reg ? desc->div_reg : desc->base_reg; + err =regmap_read (map, reg, &val); +if (err) { +dev_err (dev,"Failed reading fixed clk div %s: %d\n" , + desc->name, err); +return 0 ; + } + +return rate /en7523_get_div (desc, val); +} + +static const struct clk_ops en7581_clk_ops = { + .recalc_rate = en7581_recalc_rate, +}; +static void en7581_register_clocks (struct device *dev,struct clk_hw_onecell_data *clk_data,struct regmap *map,void __iomem *base) {struct clk_hw *hw; -u32 rate;int i;for (i =0 ; i <ARRAY_SIZE (en7581_base_clks); i++) {const struct en_clk_desc *desc = &en7581_base_clks[i]; -u32 val, reg = desc->div_reg ? desc->div_reg : desc->base_reg; +struct clk_init_data init = { + .ops = &en7581_clk_ops, + }; +struct en_clk *en_clk;int err; - err =regmap_read (map, desc->base_reg, &val); -if (err) { -pr_err ("Failed reading fixed clk rate %s: %d\n" , - desc->name, err); + en_clk =devm_kzalloc_obj (dev, *en_clk); +if (!en_clk)continue ; - } - rate =en7523_get_base_rate (desc, val); - err =regmap_read (map, reg, &val); -if (err) { -pr_err ("Failed reading fixed clk div %s: %d\n" , - desc->name, err); -continue ; - } - rate /=en7523_get_div (desc, val); + init.name = desc->name; + en_clk->map = map; + en_clk->desc = desc; + en_clk->hw.init = &init; - hw =clk_hw_register_fixed_rate (dev, desc->name,NULL ,0 , rate); -if (IS_ERR (hw)) { -pr_err ("Failed to register clk %s: %ld\n" , - desc->name,PTR_ERR (hw)); + err =devm_clk_hw_register (dev, &en_clk->hw); +if (err) { +dev_err_probe (dev, err,"Failed to register clk %s\n" , + desc->name);continue ; } - clk_data->hws[desc->id] = hw; + clk_data->hws[desc->id] = &en_clk->hw; } hw =en7523_register_pcie_clk (dev, base);
Signature · 1 line
2.55.0
PATCH v3 2/2 clk: en7523: add support for .set_rate for en7581
In reply to Christian MarangiAdd support for EN7523 driver to configure rate for Airoha EN7581 SoC. The SoC expose both base clock selector and clock divisor hence it's possible to change the rate.
This will be especially needed for new SoC AN7583 that require changes for the MDIO and the eMMC.
The clock were assumed correctly configured by the bootloader but this goes against the rule of "kernel should not depend on external configuration".
To support the use of standard clock divider API, clock_div_table are added where needed (BUS, SPI and SLIC) in additionl to the previous info to derive and simulate the clock from the divisor registers.
Recalc rate for Airoha EN7581 is updated to use the divider_recalc_rate API for consistency with .set_rate and .determine_rate.
--- drivers/clk/clk-en7523.c | 207 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 206 insertions(+), 1 deletion(-)
drivers/clk/clk-en7523.c +206 -1
@@ -119,6 +119,8 @@ struct en_clk_desc {u16 div_val0;u8 div_step;u8 div_offset; +unsigned long div_flags; +const struct clk_div_table *div_table; };struct en_clk_gate {
@@ -161,7 +163,88 @@ struct en_clk_soc_data {static const u32 gsw_base[] = {400000000 ,500000000 };static const u32 emi_base[] = {333000000 ,400000000 };static const u32 bus_base[] = {500000000 ,540000000 }; +/* From documentation divisor 1 is n/a */ +static const struct clk_div_table bus_div[] = { + { .val =1 , .div =2 }, + { .val =2 , .div =3 }, + { .val =3 , .div =4 }, + { .val =4 , .div =5 }, + { .val =5 , .div =6 }, + { .val =6 , .div =7 }, + { .val =7 , .div =8 }, + {/* sentinel */ } +};static const u32 slic_base[] = {100000000 ,3125000 }; +static const struct clk_div_table slic_div[] = { + { .val =0 , .div =20 }, + { .val =1 , .div =2 }, + { .val =2 , .div =4 }, + { .val =3 , .div =6 }, + { .val =4 , .div =8 }, + { .val =5 , .div =10 }, + { .val =6 , .div =12 }, + { .val =7 , .div =14 }, + { .val =8 , .div =16 }, + { .val =9 , .div =18 }, + { .val =10 , .div =20 }, + { .val =11 , .div =22 }, + { .val =12 , .div =24 }, + { .val =13 , .div =26 }, + { .val =14 , .div =28 }, + { .val =15 , .div =30 }, + { .val =16 , .div =32 }, + { .val =17 , .div =34 }, + { .val =18 , .div =36 }, + { .val =19 , .div =38 }, + { .val =20 , .div =40 }, + { .val =21 , .div =42 }, + { .val =22 , .div =44 }, + { .val =23 , .div =46 }, + { .val =24 , .div =48 }, + { .val =25 , .div =50 }, + { .val =26 , .div =52 }, + { .val =27 , .div =54 }, + { .val =28 , .div =56 }, + { .val =29 , .div =58 }, + { .val =30 , .div =60 }, + { .val =31 , .div =62 }, + {/* sentinel */ } +}; +static const struct clk_div_table spi_div[] = { + { .val =0 , .div =40 }, + { .val =1 , .div =2 }, + { .val =2 , .div =4 }, + { .val =3 , .div =6 }, + { .val =4 , .div =8 }, + { .val =5 , .div =10 }, + { .val =6 , .div =12 }, + { .val =7 , .div =14 }, + { .val =8 , .div =16 }, + { .val =9 , .div =18 }, + { .val =10 , .div =20 }, + { .val =11 , .div =22 }, + { .val =12 , .div =24 }, + { .val =13 , .div =26 }, + { .val =14 , .div =28 }, + { .val =15 , .div =30 }, + { .val =16 , .div =32 }, + { .val =17 , .div =34 }, + { .val =18 , .div =36 }, + { .val =19 , .div =38 }, + { .val =20 , .div =40 }, + { .val =21 , .div =42 }, + { .val =22 , .div =44 }, + { .val =23 , .div =46 }, + { .val =24 , .div =48 }, + { .val =25 , .div =50 }, + { .val =26 , .div =52 }, + { .val =27 , .div =54 }, + { .val =28 , .div =56 }, + { .val =29 , .div =58 }, + { .val =30 , .div =60 }, + { .val =31 , .div =62 }, + {/* sentinel */ } +};static const u32 npu_base[] = {333000000 ,400000000 ,500000000 };/* EN7581 */ static const u32 emi7581_base[] = {540000000 ,480000000 ,400000000 ,300000000 };
@@ -215,6 +298,7 @@ static const struct en_clk_desc en7523_base_clks[] = { .div_shift = 0, .div_step = 1, .div_offset = 1, + .div_table = bus_div, }, { .id = EN7523_CLK_SLIC, .name = "slic",
@@ -230,6 +314,7 @@ static const struct en_clk_desc en7523_base_clks[] = { .div_shift = 24, .div_val0 = 20, .div_step = 2, + .div_table = slic_div, }, { .id = EN7523_CLK_SPI, .name = "spi",
@@ -242,6 +327,7 @@ static const struct en_clk_desc en7523_base_clks[] = { .div_shift = 8, .div_val0 = 40, .div_step = 2, + .div_table = spi_div, }, { .id = EN7523_CLK_NPU, .name = "npu",
@@ -311,6 +397,7 @@ static const struct en_clk_desc en7581_base_clks[] = { .div_shift = 0, .div_step = 1, .div_offset = 1, + .div_table = bus_div, }, { .id = EN7523_CLK_SLIC, .name = "slic",
@@ -326,6 +413,7 @@ static const struct en_clk_desc en7581_base_clks[] = { .div_shift = 24, .div_val0 = 20, .div_step = 2, + .div_table = slic_div, }, { .id = EN7523_CLK_SPI, .name = "spi",
@@ -338,6 +426,7 @@ static const struct en_clk_desc en7581_base_clks[] = { .div_shift = 8, .div_val0 = 40, .div_step = 2, + .div_table = spi_div, }, { .id = EN7523_CLK_NPU, .name = "npu",
@@ -775,11 +864,127 @@ static unsigned long en7581_recalc_rate(struct clk_hw *hw,return 0 ; } -return rate /en7523_get_div (desc, val); +if (desc->div_bits) { + val >>= desc->div_shift; + val &= (1 << desc->div_bits) -1 ; + + rate =divider_recalc_rate (hw, rate, val, + desc->div_table, + desc->div_flags, + desc->div_bits); + } + +return rate; +} + +static int en7581_get_vals_for_rate (struct clk_hw *hw, +const struct en_clk_desc *desc, +unsigned long rate, +u32 *base_val,u32 *div_val) +{ +struct device *dev =clk_hw_get_dev (hw); +int tmp_base_val =0 ; +int tmp_div_val =0 ; + +if (!desc->base_bits && !desc->div_bits) +return -EINVAL ; + +/* Search requested rate with every matching base rate + divisor */ +for (; tmp_base_val < desc->n_base_values; tmp_base_val++) { +unsigned long parent_rate = desc->base_values[tmp_base_val]; +unsigned long tmp_rate = parent_rate; + +/* +* Simulate rate with every divisor supported +* 1. Search the divisor for the requested rate +* 2. Simulate the final rate with the new divisor +*/ +if (desc->div_bits) { + tmp_div_val =divider_get_val (rate, parent_rate, + desc->div_table, + desc->div_bits, + desc->div_flags); + tmp_rate =divider_recalc_rate (hw, parent_rate, + tmp_div_val, + desc->div_table, + desc->div_flags, + desc->div_bits); + } + +/* Matching clock found */ +if (tmp_rate == rate) +break ; + } + +/* Failed to found matching clock, return error */ +if (tmp_base_val >= desc->n_base_values) { +dev_err (dev,"Invalid rate for clock %s\n" , + desc->name); +return -EINVAL ; + } + + *base_val = tmp_base_val; + *div_val = tmp_div_val; + +return 0 ; +} + +static int en7581_determine_rate (struct clk_hw *hw, +struct clk_rate_request *req) +{ + struct en_clk *en_clk = container_of(hw, struct en_clk, hw); +u32 div_val, base_val; + +/* Just check if the rate is possible */ +return en7581_get_vals_for_rate (hw, en_clk->desc, req->rate, + &base_val, &div_val); +} + +static int en7581_set_rate (struct clk_hw *hw,unsigned long rate, +unsigned long parent_rate) +{ + struct en_clk *en_clk = container_of(hw, struct en_clk, hw); +const struct en_clk_desc *desc = en_clk->desc; +struct device *dev =clk_hw_get_dev (hw); +struct regmap *map = en_clk->map; +u32 base_val, div_val; +u32 reg, val, mask; +int err; + + err =en7581_get_vals_for_rate (hw, en_clk->desc, rate, + &base_val, &div_val); +if (err) +return err; + +if (desc->div_bits) { + reg = desc->div_reg ? desc->div_reg : desc->base_reg; + + mask = (BIT (desc->div_bits) -1 ) << desc->div_shift; + val = div_val << desc->div_shift; + + err =regmap_update_bits (map, reg, mask, val); +if (err) +return dev_err_probe (dev, err,"Failed to update div reg for clock %s\n" , + desc->name); + } + +if (desc->base_bits) { + mask = (BIT (desc->base_bits) -1 ) << desc->base_shift; + val = base_val << desc->base_shift; + + err =regmap_update_bits (map, desc->base_reg, mask, val); +if (err) +return dev_err_probe (dev, err,"Failed to update reg for clock %s\n" , + desc->name); + } + +return 0 ; }static const struct clk_ops en7581_clk_ops = { .recalc_rate = en7581_recalc_rate, + .determine_rate = en7581_determine_rate, + .set_rate = en7581_set_rate, }; static void en7581_register_clocks(struct device *dev, struct clk_hw_onecell_data *clk_data,
Signature · 1 line
2.55.0
[email protected]
AI reviewRe: [PATCH v3 2/2] clk: en7523: add support for .set_rate for en7581
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [High] clk: en7523: broken SPI rate lookup in en7581_get_vals_for_rate() - [High] clk: en7523: unchecked…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [High] clk: en7523: broken SPI rate lookup in en7581_get_vals_for_rate()
- [High] clk: en7523: unchecked divider_get_val() error in en7581_get_vals_for_rate() --
commit 9938b50fa7a98aecdd2b2c8ce0469da6eedd9312
Author: Christian Marangi <[email protected]>
clk: en7523: add support for .set_rate for en7581
This commit adds .determine_rate and .set_rate callbacks for the Airoha EN7581 clock controller using standard clock divider helpers and divider tables for the BUS, SPI, and SLIC clocks.
Quoted 4 lines
drivers/clk/clk-en7523.c +0
-0
[ ... ]
Quoted 32 lines
drivers/clk/clk-en7523.c +20
-1@@ -338,6 +426,7 @@ static const struct en_clk_desc en7581_base_clks[] = { .div_shift = 8, .div_val0 = 40, .div_step = 2, + .div_table = spi_div, }, { .id = EN7523_CLK_NPU, .name = "npu",@@ -775,11 +864,127 @@ static unsigned long en7581_recalc_rate(struct clk_hw *hw,return 0 ; } -return rate /en7523_get_div (desc, val); +if (desc->div_bits) { + val >>= desc->div_shift; + val &= (1 << desc->div_bits) -1 ; + + rate =divider_recalc_rate (hw, rate, val, + desc->div_table, + desc->div_flags, + desc->div_bits); + } + +return rate; +} + +static int en7581_get_vals_for_rate (struct clk_hw *hw, +const struct en_clk_desc *desc, +unsigned long rate, +u32 *base_val,u32 *div_val) +{ +struct device *dev =clk_hw_get_dev (hw);
drivers/clk/clk-en7523.c static unsigned long en7581_recalc_rate(struct clk_hw *hw, · line 895
Quoted 10 lines
drivers/clk/clk-en7523.c +10
-0+int tmp_base_val =0 ; +int tmp_div_val =0 ; + +if (!desc->base_bits && !desc->div_bits) +return -EINVAL ; + +/* Search requested rate with every matching base rate + divisor */ +for (; tmp_base_val < desc->n_base_values; tmp_base_val++) { +unsigned long parent_rate = desc->base_values[tmp_base_val]; +unsigned long tmp_rate = parent_rate;
[Severity: High]
Does en7581_get_vals_for_rate() in drivers/clk/clk-en7523.c always fail with -EINVAL when called for EN7523_CLK_SPI via en7581_determine_rate() or en7581_set_rate()?
In en7581_base_clks, EN7523_CLK_SPI defines a fixed .base_value = 400000000 and leaves .base_bits and .n_base_values as 0:
{
.id = EN7523_CLK_SPI,
.name = "spi",
.base_reg = REG_SPI_CLK_DIV_SEL,
.base_value = 400000000,
.div_bits = 5,
.div_shift = 8,
.div_val0 = 40,
.div_step = 2,
.div_table = spi_div,
},When en7581_get_vals_for_rate() is called for EN7523_CLK_SPI, desc->n_base_values is 0, so the for loop never executes and the check tmp_base_val >= desc->n_base_values is immediately true, returning -EINVAL for every SPI clock rate.
Should en7581_get_vals_for_rate() handle clocks where desc->base_bits is 0 by testing a single iteration with parent_rate = desc->base_value (similar to how en7523_get_base_rate() handles !desc->base_bits)?
Quoted 7 lines
drivers/clk/clk-en7523.c +7
-0+ +/* +* Simulate rate with every divisor supported +* 1. Search the divisor for the requested rate +* 2. Simulate the final rate with the new divisor +*/ +if (desc->div_bits) {
drivers/clk/clk-en7523.c static unsigned long en7581_recalc_rate(struct clk_hw *hw, · line 912
Quoted 10 lines
drivers/clk/clk-en7523.c +10
-0+ tmp_div_val =divider_get_val (rate, parent_rate, + desc->div_table, + desc->div_bits, + desc->div_flags); + tmp_rate =divider_recalc_rate (hw, parent_rate, + tmp_div_val, + desc->div_table, + desc->div_flags, + desc->div_bits); + }
[Severity: High]
What happens in en7581_get_vals_for_rate() in drivers/clk/clk-en7523.c when divider_get_val() returns -EINVAL because DIV_ROUND_UP_ULL(parent_rate, rate) is not in desc->div_table?
Because tmp_div_val is passed to divider_recalc_rate() without checking for a negative error code, _get_div() looks up (unsigned int)-EINVAL in desc->div_table, fails to find a match, and returns 0. Since CLK_DIVIDER_ALLOW_ZERO is not set in desc->div_flags, divider_recalc_rate() triggers a WARN() and returns parent_rate:
drivers/clk/clk-divider.c:divider_recalc_rate() {
div = _get_div(table, val, flags, width);
if (!div) {
WARN(!(flags & CLK_DIVIDER_ALLOW_ZERO),
"%s: Zero divisor and CLK_DIVIDER_ALLOW_ZERO not set\n",
clk_hw_get_name(hw));
return parent_rate;
}
}This causes two problems on clocks using a clk_div_table (EN7523_CLK_BUS, EN7523_CLK_SLIC, and EN7523_CLK_SPI):
First, evaluating a valid rate that is derived from a subsequent entry in desc->base_values[] (such as 67.5 MHz on EN7523_CLK_BUS from 540 MHz / 8, or a rate on EN7523_CLK_SLIC derived from slic_base[1] = 3.125 MHz) will fail divider_get_val() on the first base rate and trigger a kernel WARN() before moving on to the next base rate.
Second, if a caller requests a rate equal to parent_rate on a clock where divisor 1 is not supported (for example, 600 MHz or 540 MHz on EN7523_CLK_BUS where divisor 1 is n/a in bus_div, or 100 MHz or 3.125 MHz on EN7523_CLK_SLIC), divider_recalc_rate() returns parent_rate, which matches tmp_rate == rate. en7581_get_vals_for_rate() then succeeds with *div_val set to (u32)-EINVAL, and en7581_set_rate() writes the low bits of -EINVAL into the hardware divider register via regmap_update_bits().
Should en7581_get_vals_for_rate() check if (tmp_div_val < 0) and continue to the next base rate before calling divider_recalc_rate()?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2