Skip to contentSkip to conversation

Use of_clk_get_parent_count() instead of open coding

PATCH Superseded Geert Uytterhoeven 6 participants 9 messages Jan 19, 2018 – Mar 12, 2018

Subsystems (6)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Use of_clk_get_parent_count() instead of open coding

Hi all,

This patch series replaces open-coded versions of of_clk_get_parent_count() by calls to the helper function.

These patches are independent, so they can be applied where appropriate. Thanks!

Geert Uytterhoeven (3):
pinctrl: sunxi: Use of_clk_get_parent_count() instead of open coding
soc: rockchip: power-domain: Use of_clk_get_parent_count() instead of
open coding
soc/tegra: pmc: Use of_clk_get_parent_count() instead of open coding

 drivers/pinctrl/sunxi/pinctrl-sunxi.c | 3 ++-
 drivers/soc/rockchip/pm_domains.c     | 3 ++-
 drivers/soc/tegra/pmc.c               | 3 ++-
 3 files changed, 6 insertions(+), 3 deletions(-)
Signature · 12 lines
2.7.4

Gr{oetje,eeting}s,

						Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
							    -- Linus Torvalds
#1 lore raw

PATCH 1/3 pinctrl: sunxi: Use of_clk_get_parent_count() instead of open coding

---
 drivers/pinctrl/sunxi/pinctrl-sunxi.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/pinctrl/sunxi/pinctrl-sunxi.c +2 -1
index 4b6cb25bc796f86d..ab425eb45bf5e0f4 100644
@@ -12,6 +12,7 @@
 
 #include <linux/io.h>
 #include <linux/clk.h>
+#include <linux/clk-provider.h>
 #include <linux/gpio/driver.h>
 #include <linux/irqdomain.h>
 #include <linux/irqchip/chained_irq.h>
@@ -1185,7 +1186,7 @@ static int sunxi_pinctrl_setup_debounce(struct sunxi_pinctrl *pctl,
 	int i, ret;
 
 	/* Deal with old DTs that didn't have the oscillators */
-	if (of_count_phandle_with_args(node, "clocks", "#clock-cells") != 3)
+	if (of_clk_get_parent_count(node) != 3)
 		return 0;
 
 	/* If we don't have any setup, bail out */
Signature · 1 line
2.7.4
#3 lore raw

PATCH 2/3 soc: rockchip: power-domain: Use of_clk_get_parent_count() instead of open coding

In reply to Geert Uytterhoeven

As of_clk_get_parent_count() returns zero on failure, while of_count_phandle_with_args() might return a negative error code, this also fixes the issue of possibly using a negative number in the allocation below.

---
 drivers/soc/rockchip/pm_domains.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/soc/rockchip/pm_domains.c +2 -1
index 5c342167b9db7a16..9936038d38771784 100644
@@ -16,6 +16,7 @@
 #include <linux/of_address.h>
 #include <linux/of_platform.h>
 #include <linux/clk.h>
+#include <linux/clk-provider.h>
 #include <linux/regmap.h>
 #include <linux/mfd/syscon.h>
 #include <dt-bindings/power/rk3288-power.h>
@@ -391,7 +392,7 @@ static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
 		return -EINVAL;
 	}
 
-	clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
+	clk_cnt = of_clk_get_parent_count(node);
 	pd = devm_kzalloc(pmu->dev,
 			  sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
 			  GFP_KERNEL);
Signature · 1 line
2.7.4
maintainer
#4 lore raw

PATCH 2/3 soc: rockchip: power-domain: Use of_clk_get_parent_count() instead of open coding

Hi Geert,

Am Freitag, 19. Januar 2018, 16:18:20 CET schrieb Geert Uytterhoeven:

Quoted 15 lines

As of_clk_get_parent_count() returns zero on failure, while of_count_phandle_with_args() might return a negative error code, this also fixes the issue of possibly using a negative number in the allocation below.

---
 drivers/soc/rockchip/pm_domains.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/soc/rockchip/pm_domains.c +0 -0
index 5c342167b9db7a16..9936038d38771784 100644

drivers/soc/rockchip/pm_domains.c line 19

Quoted 4 lines
drivers/soc/rockchip/pm_domains.c +1 -0
@@ -16,6 +16,7 @@
 #include <linux/of_address.h>
 #include <linux/of_platform.h>
 #include <linux/clk.h>
+#include <linux/clk-provider.h>

not wanting to be to nitpicky, but clk-provider.h seems that it should be used from drivers exposing clocks to the system, not from clock users.

I just remember that in the past clk maintainers tried to keep their layering intact, so I've included them for clarification.

Mike, Stephen: the power-domain driver of Rockchip socs needs to toggle all clocks of domain peripherals when turning a domain on or off, so has a variable list of clocks in the clocks property in dt. Hence the of_count_... call which could be replaced with of_clk_get_parent_count to not open-code this.

Heiko

Quoted 13 lines
drivers/soc/rockchip/pm_domains.c +1 -1
 #include <linux/regmap.h>
 #include <linux/mfd/syscon.h>
 #include <dt-bindings/power/rk3288-power.h>
@@ -391,7 +392,7 @@ static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
 		return -EINVAL;
 	}
 
-	clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
+	clk_cnt = of_clk_get_parent_count(node);
 	pd = devm_kzalloc(pmu->dev,
 			  sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
 			  GFP_KERNEL);
#5 lore raw

PATCH 2/3 soc: rockchip: power-domain: Use of_clk_get_parent_count() instead of open coding

Heiko, Geert,

Quoted 26 lines · Heiko Stuebner

Hi Geert,

Am Freitag, 19. Januar 2018, 16:18:20 CET schrieb Geert Uytterhoeven:

Quoted 15 lines

As of_clk_get_parent_count() returns zero on failure, while of_count_phandle_with_args() might return a negative error code, this also fixes the issue of possibly using a negative number in the allocation below.

---
 drivers/soc/rockchip/pm_domains.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/soc/rockchip/pm_domains.c +0 -0
index 5c342167b9db7a16..9936038d38771784 100644

drivers/soc/rockchip/pm_domains.c line 19

Quoted 4 lines
drivers/soc/rockchip/pm_domains.c +1 -0
@@ -16,6 +16,7 @@
 #include <linux/of_address.h>
 #include <linux/of_platform.h>
 #include <linux/clk.h>
+#include <linux/clk-provider.h>

not wanting to be to nitpicky, but clk-provider.h seems that it should be used from drivers exposing clocks to the system, not from clock users.

Quoted 8 lines

I just remember that in the past clk maintainers tried to keep their layering intact, so I've included them for clarification.

Mike, Stephen: the power-domain driver of Rockchip socs needs to toggle all clocks of domain peripherals when turning a domain on or off, so has a variable list of clocks in the clocks property in dt. Hence the of_count_... call which could be replaced with of_clk_get_parent_count to not open-code this.

Moving of_clk_get_parent_count to clk.h seems reasonable to me. It's more of an of-specific helper than a provider-specific helper.

Anyone up to submit a patch so that this one doesn't need to include clk-provider.h?

Regards,
Mike

Quoted 19 lines

Heiko

Quoted 13 lines
drivers/soc/rockchip/pm_domains.c +1 -1
 #include <linux/regmap.h>
 #include <linux/mfd/syscon.h>
 #include <dt-bindings/power/rk3288-power.h>
@@ -391,7 +392,7 @@ static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
              return -EINVAL;
      }
 
-     clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
+     clk_cnt = of_clk_get_parent_count(node);
      pd = devm_kzalloc(pmu->dev,
                        sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
                        GFP_KERNEL);
Signature · 4 lines
Michael Turquette
CEO
BayLibre - At the Heart of Embedded Linux
http://baylibre.com/
#6 lore raw

PATCH 2/3 soc: rockchip: power-domain: Use of_clk_get_parent_count() instead of open coding

Hi Mike,

Quoted 34 lines · Michael Turquette
Quoted 24 lines · Heiko Stuebner

Am Freitag, 19. Januar 2018, 16:18:20 CET schrieb Geert Uytterhoeven:

Quoted 15 lines

As of_clk_get_parent_count() returns zero on failure, while of_count_phandle_with_args() might return a negative error code, this also fixes the issue of possibly using a negative number in the allocation below.

---
 drivers/soc/rockchip/pm_domains.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/soc/rockchip/pm_domains.c +0 -0
index 5c342167b9db7a16..9936038d38771784 100644

drivers/soc/rockchip/pm_domains.c line 19

Quoted 4 lines
drivers/soc/rockchip/pm_domains.c +1 -0
@@ -16,6 +16,7 @@
 #include <linux/of_address.h>
 #include <linux/of_platform.h>
 #include <linux/clk.h>
+#include <linux/clk-provider.h>

not wanting to be to nitpicky, but clk-provider.h seems that it should be used from drivers exposing clocks to the system, not from clock users.

Quoted 8 lines

I just remember that in the past clk maintainers tried to keep their layering intact, so I've included them for clarification.

Mike, Stephen: the power-domain driver of Rockchip socs needs to toggle all clocks of domain peripherals when turning a domain on or off, so has a variable list of clocks in the clocks property in dt. Hence the of_count_... call which could be replaced with of_clk_get_parent_count to not open-code this.

Quoted 5 lines

Moving of_clk_get_parent_count to clk.h seems reasonable to me. It's more of an of-specific helper than a provider-specific helper.

Anyone up to submit a patch so that this one doesn't need to include clk-provider.h?

I gave it a try.
Just moving of_clk_get_parent_count() from clk-provider.h to clk.h causes breakage, as half of the clock providers using of_clk_get_parent_count() do not include <linux/clk.h>:

    drivers/clk/at91/clk-generated.c
    drivers/clk/at91/clk-main.c
    drivers/clk/at91/clk-master.c
    drivers/clk/at91/clk-programmable.c
    drivers/clk/at91/clk-slow.c
    drivers/clk/at91/clk-smd.c
    drivers/clk/at91/clk-usb.c
    drivers/clk/at91/sckc.c
    drivers/clk/clk-axi-clkgen.c
    drivers/clk/clk-gpio.c
    drivers/clk/clk-hsdk-pll.c
    drivers/clk/h8300/clk-div.c
    drivers/clk/h8300/clk-h8s2678.c
    drivers/clk/renesas/clk-div6.c
    drivers/clk/ti/composite.c
    drivers/clk/ti/gate.c
    drivers/clk/ti/mux.c

So our options are:
1. Add #include <linux/clk.h> to each of the above,
2. Add #include <linux/clk.h> to <linux/clk-provider.h>,
3. Do nothing, i.e. users of of_clk_get_parent_count () need to

      #include <linux/clk-provider.h>, cfr. this patch series.

Any preference? Any option I'm missing?

Thanks!

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
drivers/soc/rockchip/pm_domains.c +0 -0
 #include <linux/regmap.h>
 #include <linux/mfd/syscon.h>
 #include <dt-bindings/power/rk3288-power.h>
@@ -391,7 +392,7 @@ static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
              return -EINVAL;
      }
 
Quoted 6 lines
Quoted 6 lines

drivers/soc/rockchip/pm_domains.c static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu, · line 398

Quoted 6 lines
drivers/soc/rockchip/pm_domains.c +1 -1
-     clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
+     clk_cnt = of_clk_get_parent_count(node);
      pd = devm_kzalloc(pmu->dev,
                        sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
                        GFP_KERNEL);

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert at linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

maintainer
#7 lore raw

PATCH 2/3 soc: rockchip: power-domain: Use of_clk_get_parent_count() instead of open coding

Quoting Geert Uytterhoeven (2018-03-02 05:15:35)

Quoted 33 lines

Hi Mike,

Quoted 5 lines · Michael Turquette

Moving of_clk_get_parent_count to clk.h seems reasonable to me. It's more of an of-specific helper than a provider-specific helper.

Anyone up to submit a patch so that this one doesn't need to include clk-provider.h?

I gave it a try.
Just moving of_clk_get_parent_count() from clk-provider.h to clk.h causes breakage, as half of the clock providers using of_clk_get_parent_count() do not include <linux/clk.h>:

    drivers/clk/at91/clk-generated.c
    drivers/clk/at91/clk-main.c
    drivers/clk/at91/clk-master.c
    drivers/clk/at91/clk-programmable.c
    drivers/clk/at91/clk-slow.c
    drivers/clk/at91/clk-smd.c
    drivers/clk/at91/clk-usb.c
    drivers/clk/at91/sckc.c
    drivers/clk/clk-axi-clkgen.c
    drivers/clk/clk-gpio.c
    drivers/clk/clk-hsdk-pll.c
    drivers/clk/h8300/clk-div.c
    drivers/clk/h8300/clk-h8s2678.c
    drivers/clk/renesas/clk-div6.c
    drivers/clk/ti/composite.c
    drivers/clk/ti/gate.c
    drivers/clk/ti/mux.c
Quoted 8 lines

So our options are:
1. Add #include <linux/clk.h> to each of the above,
2. Add #include <linux/clk.h> to <linux/clk-provider.h>,
3. Do nothing, i.e. users of of_clk_get_parent_count () need to

      #include <linux/clk-provider.h>, cfr. this patch series.

Any preference? Any option I'm missing?

#2 is a definite no.

How about option #4? Move of_clk_get_parent_count() and of_clk_get_parent_name() to a new include/linux/of_clk.h, include that in clk-provider.h, and then have non-clk provider drivers include that file? After that, we can also move of_clk_init() into this new file, and then non-provider arch code can call of_clk_init() without including the provider APIs. I'd also like to get rid of the include of linux/of.h in clk-provider.h, but that's a ways away.

#8 lore raw

PATCH 3/3 soc/tegra: pmc: Use of_clk_get_parent_count() instead of open coding

In reply to Geert Uytterhoeven

As of_clk_get_parent_count() returns zero on failure, while of_count_phandle_with_args() might return a negative error code, this also fixes the issue of possibly using a very big number in the allocation below.

---
 drivers/soc/tegra/pmc.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/soc/tegra/pmc.c +2 -1
index ce62a47a6647a817..4379e4d602bc5428 100644
@@ -21,6 +21,7 @@
 
 #include <linux/kernel.h>
 #include <linux/clk.h>
+#include <linux/clk-provider.h>
 #include <linux/clk/tegra.h>
 #include <linux/debugfs.h>
 #include <linux/delay.h>
@@ -743,7 +744,7 @@ static int tegra_powergate_of_get_clks(struct tegra_powergate *pg,
 	unsigned int i, count;
 	int err;
 
-	count = of_count_phandle_with_args(np, "clocks", "#clock-cells");
+	count = of_clk_get_parent_count(np);
 	if (count == 0)
 		return -ENODEV;
 
Signature · 1 line
2.7.4