2015-06-17 13:23:19

by Nicolas Ferre

[permalink] [raw]
Subject: [PATCH] clk: at91: add generated clock driver

Add a new type of clocks that can be provided to a peripheral.
In addition to the peripheral clock, this new clock that can use several
input clocks as parents can generate divided rates.
This would allow a peripheral to have finer grained clocks for generating
a baud rate, clocking an asynchronous part or having more
options in frequency.

Signed-off-by: Nicolas Ferre <[email protected]>
---
.../devicetree/bindings/clock/at91-clock.txt | 35 +++
arch/arm/mach-at91/Kconfig | 3 +
drivers/clk/at91/Makefile | 1 +
drivers/clk/at91/clk-generated.c | 329 +++++++++++++++++++++
drivers/clk/at91/pmc.c | 6 +
drivers/clk/at91/pmc.h | 5 +
include/linux/clk/at91_pmc.h | 7 +
7 files changed, 386 insertions(+)
create mode 100644 drivers/clk/at91/clk-generated.c

diff --git a/Documentation/devicetree/bindings/clock/at91-clock.txt b/Documentation/devicetree/bindings/clock/at91-clock.txt
index 5ba6450693b9..5e737d2cd05d 100644
--- a/Documentation/devicetree/bindings/clock/at91-clock.txt
+++ b/Documentation/devicetree/bindings/clock/at91-clock.txt
@@ -77,6 +77,9 @@ Required properties:
"atmel,sama5d4-clk-h32mx":
at91 h32mx clock

+ "atmel,sama5d2-clk-generated":
+ at91 generated clock
+
Required properties for SCKC node:
- reg : defines the IO memory reserved for the SCKC.
- #size-cells : shall be 0 (reg is used to encode clk id).
@@ -461,3 +464,35 @@ For example:
compatible = "atmel,sama5d4-clk-h32mx";
clocks = <&mck>;
};
+
+Required properties for generated clocks:
+- #size-cells : shall be 0 (reg is used to encode clk id).
+- #address-cells : shall be 1 (reg is used to encode clk id).
+- clocks : shall be the generated clock source phandles.
+ e.g. clocks = <&clk32k>, <&main>, <&plladiv>, <&utmi>, <&mck>;
+- name: device tree node describing a specific generated clock.
+ * #clock-cells : from common clock binding; shall be set to 0.
+ * reg: peripheral id. See Atmel's datasheets to get a full
+ list of peripheral ids.
+ * atmel,clk-output-range : minimum and maximum clock frequency
+ (two u32 fields).
+
+For example:
+ gck {
+ compatible = "atmel,sama5d2-clk-generated";
+ #address-cells = <1>;
+ #size-cells = <0>;
+ clocks = <&clk32k>, <&main>, <&plladiv>, <&utmi>, <&mck>;
+
+ tcb0_gclk: tcb0_gclk {
+ #clock-cells = <0>;
+ reg = <35>;
+ atmel,clk-output-range = <0 83000000>;
+ };
+
+ pwm_gclk: pwm_gclk {
+ #clock-cells = <0>;
+ reg = <38>;
+ atmel,clk-output-range = <0 83000000>;
+ };
+ };
diff --git a/arch/arm/mach-at91/Kconfig b/arch/arm/mach-at91/Kconfig
index fd95f34945f4..43ec794d1057 100644
--- a/arch/arm/mach-at91/Kconfig
+++ b/arch/arm/mach-at91/Kconfig
@@ -90,6 +90,9 @@ config HAVE_AT91_SMD
config HAVE_AT91_H32MX
bool

+config HAVE_AT91_GENERATED
+ bool
+
config SOC_SAM_V4_V5
bool

diff --git a/drivers/clk/at91/Makefile b/drivers/clk/at91/Makefile
index 89a48a7bd5df..867e5d1b295e 100644
--- a/drivers/clk/at91/Makefile
+++ b/drivers/clk/at91/Makefile
@@ -10,3 +10,4 @@ obj-$(CONFIG_HAVE_AT91_UTMI) += clk-utmi.o
obj-$(CONFIG_HAVE_AT91_USB_CLK) += clk-usb.o
obj-$(CONFIG_HAVE_AT91_SMD) += clk-smd.o
obj-$(CONFIG_HAVE_AT91_H32MX) += clk-h32mx.o
+obj-$(CONFIG_HAVE_AT91_GENERATED) += clk-generated.o
diff --git a/drivers/clk/at91/clk-generated.c b/drivers/clk/at91/clk-generated.c
new file mode 100644
index 000000000000..4db46b0f07b4
--- /dev/null
+++ b/drivers/clk/at91/clk-generated.c
@@ -0,0 +1,329 @@
+/*
+ * Copyright (C) 2015 Atmel Corporation,
+ * Nicolas Ferre <[email protected]>
+ *
+ * Based on clk-programmable & clk-peripheral drivers by Boris BREZILLON.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ */
+
+#include <linux/clk-provider.h>
+#include <linux/clkdev.h>
+#include <linux/clk/at91_pmc.h>
+#include <linux/of.h>
+#include <linux/of_address.h>
+#include <linux/io.h>
+
+#include "pmc.h"
+
+#define PERIPHERAL_MAX 64
+
+#define PERIPHERAL_ID_MIN 2
+
+#define GENERATED_SOURCE_MAX 6
+#define GENERATED_MAX_DIV 255
+
+struct clk_generated {
+ struct clk_hw hw;
+ struct at91_pmc *pmc;
+ struct clk_range range;
+ u32 id;
+ u32 gckdiv;
+ u8 parent_id;
+};
+
+#define to_clk_generated(hw) \
+ container_of(hw, struct clk_generated, hw)
+
+static int clk_generated_enable(struct clk_hw *hw)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+ struct at91_pmc *pmc = gck->pmc;
+ u32 tmp;
+
+ if (gck->id < PERIPHERAL_ID_MIN)
+ return 0;
+
+ pr_debug("GCLK: %s, gckdiv = %d, parent id = %d\n",
+ __FUNCTION__, gck->gckdiv, gck->parent_id);
+
+ pmc_lock(pmc);
+ pmc_write(pmc, AT91_PMC_PCR, (gck->id & AT91_PMC_PCR_PID_MASK));
+ tmp = pmc_read(pmc, AT91_PMC_PCR) &
+ ~(AT91_PMC_PCR_GCKDIV_MASK | AT91_PMC_PCR_GCKCSS_MASK);
+ pmc_write(pmc, AT91_PMC_PCR, tmp | AT91_PMC_PCR_GCKCSS(gck->parent_id)
+ | AT91_PMC_PCR_CMD
+ | AT91_PMC_PCR_GCKDIV(gck->gckdiv)
+ | AT91_PMC_PCR_GCKEN);
+ pmc_unlock(pmc);
+ return 0;
+}
+
+static void clk_generated_disable(struct clk_hw *hw)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+ struct at91_pmc *pmc = gck->pmc;
+ u32 tmp;
+
+ if (gck->id < PERIPHERAL_ID_MIN)
+ return;
+
+ pmc_lock(pmc);
+ pmc_write(pmc, AT91_PMC_PCR, (gck->id & AT91_PMC_PCR_PID_MASK));
+ tmp = pmc_read(pmc, AT91_PMC_PCR) & ~AT91_PMC_PCR_GCKEN;
+ pmc_write(pmc, AT91_PMC_PCR, tmp | AT91_PMC_PCR_CMD);
+ pmc_unlock(pmc);
+}
+
+static int clk_generated_is_enabled(struct clk_hw *hw)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+ struct at91_pmc *pmc = gck->pmc;
+ int ret;
+
+ if (gck->id < PERIPHERAL_ID_MIN)
+ return 1;
+
+ pmc_lock(pmc);
+ pmc_write(pmc, AT91_PMC_PCR, (gck->id & AT91_PMC_PCR_PID_MASK));
+ ret = !!(pmc_read(pmc, AT91_PMC_PCR) & AT91_PMC_PCR_GCKEN);
+ pmc_unlock(pmc);
+
+ return ret;
+}
+
+static unsigned long
+clk_generated_recalc_rate(struct clk_hw *hw,
+ unsigned long parent_rate)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+
+ if (gck->id < PERIPHERAL_ID_MIN)
+ return parent_rate;
+
+ return DIV_ROUND_CLOSEST(parent_rate, gck->gckdiv + 1);
+}
+
+static long clk_generated_determine_rate(struct clk_hw *hw,
+ unsigned long rate,
+ unsigned long *best_parent_rate,
+ struct clk_hw **best_parent_hw)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+ struct clk *parent = NULL;
+ long best_rate = -EINVAL;
+ unsigned long tmp_rate;
+ int best_diff = -1;
+ int tmp_diff;
+ int i;
+
+ for (i = 0; i < __clk_get_num_parents(hw->clk); i++) {
+ u32 div;
+ unsigned long parent_rate;
+
+ parent = clk_get_parent_by_index(hw->clk, i);
+ if (!parent)
+ continue;
+
+ parent_rate = __clk_get_rate(parent);
+ if (!parent_rate
+ || DIV_ROUND_CLOSEST(parent_rate, GENERATED_MAX_DIV + 1)
+ > gck->range.max)
+ continue;
+
+ for (div = 1; div < GENERATED_MAX_DIV + 2; div++) {
+
+ tmp_rate = DIV_ROUND_CLOSEST(parent_rate, div);
+ tmp_diff = abs(rate - tmp_rate);
+
+ if (best_diff < 0 || best_diff > tmp_diff) {
+ best_rate = tmp_rate;
+ best_diff = tmp_diff;
+ *best_parent_rate = parent_rate;
+ *best_parent_hw = __clk_get_hw(parent);
+ }
+
+ if (!best_diff || tmp_rate < rate)
+ break;
+ }
+
+ if (!best_diff)
+ break;
+ }
+
+ pr_debug("GCLK: %s, best_rate = %ld, parent clk: %s @ %ld\n" ,
+ __FUNCTION__ , best_rate,
+ __clk_get_name((*best_parent_hw)->clk), *best_parent_rate);
+
+ return best_rate;
+}
+
+/* No modification of hardware as we have the flag CLK_SET_PARENT_GATE set */
+static int clk_generated_set_parent(struct clk_hw *hw, u8 index)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+
+ if (index >= __clk_get_num_parents(hw->clk))
+ return -EINVAL;
+
+ gck->parent_id = index;
+ return 0;
+}
+
+static u8 clk_generated_get_parent(struct clk_hw *hw)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+
+ return gck->parent_id;
+}
+
+/* No modification of hardware as we have the flag CLK_SET_RATE_GATE set */
+static int clk_generated_set_rate(struct clk_hw *hw,
+ unsigned long rate,
+ unsigned long parent_rate)
+{
+ struct clk_generated *gck = to_clk_generated(hw);
+ u32 div;
+
+ if (!rate)
+ return -EINVAL;
+
+ if (gck->id < PERIPHERAL_ID_MIN || !gck->range.max) {
+ if (parent_rate == rate) {
+ gck->gckdiv = 0;
+ return 0;
+ } else {
+ return -EINVAL;
+ }
+ }
+
+ if (rate > gck->range.max)
+ return -EINVAL;
+
+ div = DIV_ROUND_CLOSEST(parent_rate, rate);
+ if (div > GENERATED_MAX_DIV + 1 || !div)
+ return -EINVAL;
+
+ gck->gckdiv = div - 1;
+ return 0;
+}
+
+static const struct clk_ops generated_ops = {
+ .enable = clk_generated_enable,
+ .disable = clk_generated_disable,
+ .is_enabled = clk_generated_is_enabled,
+ .recalc_rate = clk_generated_recalc_rate,
+ .determine_rate = clk_generated_determine_rate,
+ .get_parent = clk_generated_get_parent,
+ .set_parent = clk_generated_set_parent,
+ .set_rate = clk_generated_set_rate,
+};
+
+/**
+ * clk_generated_startup - Initialize a given clock to its default parent and
+ * divisor parameter.
+ *
+ * @gck: Generated clock to set the startup parameters for.
+ *
+ * Take parameters from the hardware and update local clock configuration
+ * accordingly.
+ */
+static void clk_generated_startup(struct clk_generated *gck)
+{
+ struct at91_pmc *pmc = gck->pmc;
+ u32 tmp;
+
+ pmc_lock(pmc);
+ pmc_write(pmc, AT91_PMC_PCR, (gck->id & AT91_PMC_PCR_PID_MASK));
+ tmp = pmc_read(pmc, AT91_PMC_PCR);
+ pmc_unlock(pmc);
+
+ gck->parent_id = (tmp & AT91_PMC_PCR_GCKCSS_MASK) >> AT91_PMC_PCR_GCKCSS_OFFSET;
+ gck->gckdiv = (tmp & AT91_PMC_PCR_GCKDIV_MASK) >> AT91_PMC_PCR_GCKDIV_OFFSET;
+}
+
+static struct clk * __init
+at91_clk_register_generated(struct at91_pmc *pmc, const char *name,
+ const char **parent_names, u8 num_parents,
+ u8 id, const struct clk_range *range)
+{
+ struct clk_generated *gck;
+ struct clk *clk = NULL;
+ struct clk_init_data init;
+
+ gck = kzalloc(sizeof(*gck), GFP_KERNEL);
+ if (!gck)
+ return ERR_PTR(-ENOMEM);
+
+ init.name = name;
+ init.ops = &generated_ops;
+ init.parent_names = parent_names;
+ init.num_parents = num_parents;
+ init.flags = CLK_SET_RATE_GATE | CLK_SET_PARENT_GATE;
+
+ gck->id = id;
+ gck->hw.init = &init;
+ gck->pmc = pmc;
+ gck->range = *range;
+
+ clk = clk_register(NULL, &gck->hw);
+ if (IS_ERR(clk))
+ kfree(gck);
+ else
+ clk_generated_startup(gck);
+
+ return clk;
+}
+
+void __init of_sama5d2_clk_generated_setup(struct device_node *np,
+ struct at91_pmc *pmc)
+{
+ int i;
+ int num;
+ u32 id;
+ const char *name;
+ struct clk *clk;
+ int num_parents;
+ const char *parent_names[GENERATED_SOURCE_MAX];
+ struct device_node *gcknp;
+ struct clk_range range = CLK_RANGE(0, 0);
+
+ num_parents = of_count_phandle_with_args(np, "clocks", "#clock-cells");
+ if (num_parents <= 0 || num_parents > GENERATED_SOURCE_MAX)
+ return;
+
+ for (i = 0; i < num_parents; ++i) {
+ parent_names[i] = of_clk_get_parent_name(np, i);
+ if (!parent_names[i])
+ return;
+ }
+
+ num = of_get_child_count(np);
+ if (!num || num > PERIPHERAL_MAX)
+ return;
+
+ for_each_child_of_node(np, gcknp) {
+ if (of_property_read_u32(gcknp, "reg", &id))
+ continue;
+
+ if (id >= PERIPHERAL_MAX)
+ continue;
+
+ if (of_property_read_string(np, "clock-output-names", &name))
+ name = gcknp->name;
+
+ of_at91_get_clk_range(gcknp, "atmel,clk-output-range",
+ &range);
+
+ clk = at91_clk_register_generated(pmc, name, parent_names,
+ num_parents, id, &range);
+ if (IS_ERR(clk))
+ continue;
+
+ of_clk_add_provider(gcknp, of_clk_src_simple_get, clk);
+ }
+}
diff --git a/drivers/clk/at91/pmc.c b/drivers/clk/at91/pmc.c
index 39be2be82b0a..bed2ce6b3cb9 100644
--- a/drivers/clk/at91/pmc.c
+++ b/drivers/clk/at91/pmc.c
@@ -370,6 +370,12 @@ static const struct of_device_id pmc_clk_ids[] __initconst = {
.data = of_sama5d4_clk_h32mx_setup,
},
#endif
+#if defined(CONFIG_HAVE_AT91_GENERATED)
+ {
+ .compatible = "atmel,sama5d2-clk-generated",
+ .data = of_sama5d2_clk_generated_setup,
+ },
+#endif
{ /*sentinel*/ }
};

diff --git a/drivers/clk/at91/pmc.h b/drivers/clk/at91/pmc.h
index 69abb08cf146..e40623a4d7aa 100644
--- a/drivers/clk/at91/pmc.h
+++ b/drivers/clk/at91/pmc.h
@@ -126,4 +126,9 @@ extern void __init of_sama5d4_clk_h32mx_setup(struct device_node *np,
struct at91_pmc *pmc);
#endif

+#if defined(CONFIG_HAVE_AT91_GENERATED)
+extern void __init of_sama5d2_clk_generated_setup(struct device_node *np,
+ struct at91_pmc *pmc);
+#endif
+
#endif /* __PMC_H_ */
diff --git a/include/linux/clk/at91_pmc.h b/include/linux/clk/at91_pmc.h
index dfc59e2b64fb..ae61860e6892 100644
--- a/include/linux/clk/at91_pmc.h
+++ b/include/linux/clk/at91_pmc.h
@@ -183,10 +183,17 @@ extern void __iomem *at91_pmc_base;

#define AT91_PMC_PCR 0x10c /* Peripheral Control Register [some SAM9 and SAMA5] */
#define AT91_PMC_PCR_PID_MASK 0x3f
+#define AT91_PMC_PCR_GCKCSS_OFFSET 8
+#define AT91_PMC_PCR_GCKCSS_MASK (0x7 << AT91_PMC_PCR_GCKCSS_OFFSET)
+#define AT91_PMC_PCR_GCKCSS(n) ((n) << AT91_PMC_PCR_GCKCSS_OFFSET) /* GCK Clock Source Selection */
#define AT91_PMC_PCR_CMD (0x1 << 12) /* Command (read=0, write=1) */
#define AT91_PMC_PCR_DIV_OFFSET 16
#define AT91_PMC_PCR_DIV_MASK (0x3 << AT91_PMC_PCR_DIV_OFFSET)
#define AT91_PMC_PCR_DIV(n) ((n) << AT91_PMC_PCR_DIV_OFFSET) /* Divisor Value */
+#define AT91_PMC_PCR_GCKDIV_OFFSET 20
+#define AT91_PMC_PCR_GCKDIV_MASK (0xff << AT91_PMC_PCR_GCKDIV_OFFSET)
+#define AT91_PMC_PCR_GCKDIV(n) ((n) << AT91_PMC_PCR_GCKDIV_OFFSET) /* Generated Clock Divisor Value */
#define AT91_PMC_PCR_EN (0x1 << 28) /* Enable */
+#define AT91_PMC_PCR_GCKEN (0x1 << 29) /* GCK Enable */

#endif
--
2.1.3


2015-06-18 07:12:47

by Paul Bolle

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

On Wed, 2015-06-17 at 15:23 +0200, Nicolas Ferre wrote:

> --- a/arch/arm/mach-at91/Kconfig
> +++ b/arch/arm/mach-at91/Kconfig

> +config HAVE_AT91_GENERATED
> + bool

This will always be 'n'.

> --- a/drivers/clk/at91/Makefile
> +++ b/drivers/clk/at91/Makefile

> +obj-$(CONFIG_HAVE_AT91_GENERATED) += clk-generated.o

And clk-generated.o will never be built.

I think your options are to use
config HAVE_AT91_GENERATED
def_bool y

or
config HAVE_AT91_GENERATED
bool "Yadda yadda yadda"

or add
select HAVE_AT91_GENERATED

somewhere (possibly even in a second patch). But as it stands the patch
looks like an elaborate NOP.

Thanks,


Paul Bolle

2015-06-18 07:34:07

by Boris Brezillon

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Hi Paul,

On Thu, 18 Jun 2015 09:12:36 +0200
Paul Bolle <[email protected]> wrote:

> On Wed, 2015-06-17 at 15:23 +0200, Nicolas Ferre wrote:
>
> > --- a/arch/arm/mach-at91/Kconfig
> > +++ b/arch/arm/mach-at91/Kconfig
>
> > +config HAVE_AT91_GENERATED
> > + bool
>
> This will always be 'n'.
>
> > --- a/drivers/clk/at91/Makefile
> > +++ b/drivers/clk/at91/Makefile
>
> > +obj-$(CONFIG_HAVE_AT91_GENERATED) += clk-generated.o
>
> And clk-generated.o will never be built.
>
> I think your options are to use
> config HAVE_AT91_GENERATED
> def_bool y
>
> or
> config HAVE_AT91_GENERATED
> bool "Yadda yadda yadda"
>
> or add
> select HAVE_AT91_GENERATED
>
> somewhere (possibly even in a second patch). But as it stands the patch
> looks like an elaborate NOP.

I guess it will be selected by platforms embedding such clks. We just
have to wait for those platform to reach mainline ;-).

Best Regards,

Boris
--
Boris Brezillon, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com

2015-06-18 07:42:03

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Le 18/06/2015 09:33, Boris Brezillon a ?crit :
> Hi Paul,
>
> On Thu, 18 Jun 2015 09:12:36 +0200
> Paul Bolle <[email protected]> wrote:
>
>> On Wed, 2015-06-17 at 15:23 +0200, Nicolas Ferre wrote:
>>
>>> --- a/arch/arm/mach-at91/Kconfig
>>> +++ b/arch/arm/mach-at91/Kconfig
>>
>>> +config HAVE_AT91_GENERATED
>>> + bool
>>
>> This will always be 'n'.
>>
>>> --- a/drivers/clk/at91/Makefile
>>> +++ b/drivers/clk/at91/Makefile
>>
>>> +obj-$(CONFIG_HAVE_AT91_GENERATED) += clk-generated.o
>>
>> And clk-generated.o will never be built.
>>
>> I think your options are to use
>> config HAVE_AT91_GENERATED
>> def_bool y
>>
>> or
>> config HAVE_AT91_GENERATED
>> bool "Yadda yadda yadda"
>>
>> or add
>> select HAVE_AT91_GENERATED
>>
>> somewhere (possibly even in a second patch). But as it stands the patch
>> looks like an elaborate NOP.
>
> I guess it will be selected by platforms embedding such clks. We just
> have to wait for those platform to reach mainline ;-).

Yes, absolutely.

I am in the process, with my colleagues, of building bricks for our
upcoming SoC the sama5d2. So, the basic support for this chip will come
in the next weeks and will select this Kconfig option.

I'd like though that this matter of fact doesn't block this piece of
code from being reviewed or even better merged in order to ease this new
SoC landing...

Bye,
--
Nicolas Ferre

2015-06-18 07:45:06

by Paul Bolle

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

On Thu, 2015-06-18 at 09:33 +0200, Boris Brezillon wrote:
> I guess it will be selected by platforms embedding such clks. We just
> have to wait for those platform to reach mainline ;-).

So what's the point of this patch at this moment?


Paul Bolle

2015-06-18 07:55:00

by Paul Bolle

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Hi Nicolas,

On Thu, 2015-06-18 at 09:40 +0200, Nicolas Ferre wrote:
> I am in the process, with my colleagues, of building bricks for our
> upcoming SoC the sama5d2. So, the basic support for this chip will come
> in the next weeks and will select this Kconfig option.

Perhaps that could be added, say below the --- marker in the patch.
Maybe I missed something to that effect. Anyhow, I didn't spot in the
patch that this was done deliberately. It had all the looks of a silly
mistake.

> I'd like though that this matter of fact doesn't block this piece of
> code from being reviewed or even better merged in order to ease this new
> SoC landing...

The other side of that is that the sama5d2 might never make it, or take
very long to make it, into mainline. And this would then end up being
yet another chunk of code adding no value to mainline.

Thanks,


Paul Bolle

2015-06-18 12:41:59

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Le 18/06/2015 09:54, Paul Bolle a écrit :
> Hi Nicolas,
>
> On Thu, 2015-06-18 at 09:40 +0200, Nicolas Ferre wrote:
>> I am in the process, with my colleagues, of building bricks for our
>> upcoming SoC the sama5d2. So, the basic support for this chip will come
>> in the next weeks and will select this Kconfig option.
>
> Perhaps that could be added, say below the --- marker in the patch.

Yep, I should have added that, for sure!

> Maybe I missed something to that effect. Anyhow, I didn't spot in the
> patch that this was done deliberately. It had all the looks of a silly
> mistake.
>
>> I'd like though that this matter of fact doesn't block this piece of
>> code from being reviewed or even better merged in order to ease this new
>> SoC landing...
>
> The other side of that is that the sama5d2 might never make it, or take
> very long to make it, into mainline. And this would then end up being
> yet another chunk of code adding no value to mainline.

C'mon Paul, it's a simple chicken and egg problem... I have several
options here:

1/ I send the clock patch early and benefit from early review and a
comfortable landing strip

2/ I send the SoC early and have the very same remark concerning the
"+ select HAVE_AT91_GENERATED" line in my patch

3/ I do it in several separated series... but at the price of additional
synchronization between subsystems, additional dumb patches with so
little benefit in my opinion.

Ok, so I post sama5d2 early support today so that we can agree it's not
necessary to add superfluous steps.

Bye,
--
Nicolas Ferre

2015-06-18 12:59:29

by Alexandre Belloni

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

On 18/06/2015 at 09:54:50 +0200, Paul Bolle wrote :
> > I'd like though that this matter of fact doesn't block this piece of
> > code from being reviewed or even better merged in order to ease this new
> > SoC landing...
>
> The other side of that is that the sama5d2 might never make it, or take
> very long to make it, into mainline. And this would then end up being
> yet another chunk of code adding no value to mainline.
>

Come on Paul, you prefer the current situation were each vendor have
there tree and when support for an SoC lands in mainline it is already
deprecated?

You have one vendor here, trying to get support for its SoC even before
the silicon is available. Intel is always cited as being a good player
in the linux community for doing exactly that. They even have to remove
support for a CPU that was never manufactured...
The main difference here is that we are no longer doinc everything in
mach-xxx so we have to get the driver part mainlined and this requires
synchronization. I really belive that you can't blame Nicolas to get the
drivers first then the SoC in.

Also, Atmel has a good track record and their SocS are almost fully
supported in mainline, you can trust that sama5d2 support is going to
land there soon.

--
Alexandre Belloni, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

2015-06-18 13:30:05

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Le 18/06/2015 14:59, Alexandre Belloni a ?crit :
> On 18/06/2015 at 09:54:50 +0200, Paul Bolle wrote :
>>> I'd like though that this matter of fact doesn't block this piece of
>>> code from being reviewed or even better merged in order to ease this new
>>> SoC landing...
>>
>> The other side of that is that the sama5d2 might never make it, or take
>> very long to make it, into mainline. And this would then end up being
>> yet another chunk of code adding no value to mainline.
>>
>
> Come on Paul, you prefer the current situation were each vendor have
> there tree and when support for an SoC lands in mainline it is already
> deprecated?
>
> You have one vendor here, trying to get support for its SoC even before
> the silicon is available. Intel is always cited as being a good player
> in the linux community for doing exactly that. They even have to remove
> support for a CPU that was never manufactured...
> The main difference here is that we are no longer doinc everything in
> mach-xxx so we have to get the driver part mainlined and this requires
> synchronization. I really belive that you can't blame Nicolas to get the
> drivers first then the SoC in.
>
> Also, Atmel has a good track record and their SocS are almost fully
> supported in mainline, you can trust that sama5d2 support is going to
> land there soon.

I've just posted it BTW.

And it contains the "HAVE_AT91_GENERATED" symbol.

Bye,
--
Nicolas Ferre

2015-06-18 14:46:58

by Paul Bolle

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Hi Nicolas,

On Thu, 2015-06-18 at 14:40 +0200, Nicolas Ferre wrote:
> I have several options here:
>
> 1/ I send the clock patch early and benefit from early review and a
> comfortable landing strip
>
> 2/ I send the SoC early and have the very same remark concerning the
> "+ select HAVE_AT91_GENERATED" line in my patch

(In that case that line could be part of the patch adding the clock
driver. That might work too. Depends on how things fit together,
obviously.)

> 3/ I do it in several separated series... but at the price of additional
> synchronization between subsystems, additional dumb patches with so
> little benefit in my opinion.

Would one series for everything you plan to submit have worked here or
would that grow unwieldy?

Anyhow, would I have known that the code that actually enables this
driver to build was pending this discussion would not have started. (I
do try to check for related patches, on lkml that is, even if they're
not part of the same series etc.) Say, with a small remark below the ---
line as we discussed. And would I then have started a thread like this
you could point a finger at me and shout: "Paul can't read! Na na na na
na! Paul can't read!"

> Ok, so I post sama5d2 early support today so that we can agree it's not
> necessary to add superfluous steps.

I see.

Thanks,


Paul Bolle

2015-06-18 15:12:04

by Paul Bolle

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Hi Alexandre,

You know, I can't read Nicolas' mind, so I couldn't say from the patch
itself that it was not a silly mistake.

I also can't look into the future. I can however check lkml (at least
the few weeks of lkml I keep at hand) and see whether there's another
patch pending that would allow this driver to build.

Discussing those two disabilities doesn't require a (much broader)
discussion on how Atmel goes about their Linux business. At least, I
hope it doesn't, because I don't actually have an opinion in that
matter.

Thanks,


Paul Bolle

2015-06-18 15:25:45

by Boris Brezillon

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Hi Nicolas,

I haven't run checkpatch on your patch, but there seems to be a few
things to fix ;-).

On Wed, 17 Jun 2015 15:23:29 +0200
Nicolas Ferre <[email protected]> wrote:




> +
> +static long clk_generated_determine_rate(struct clk_hw *hw,
> + unsigned long rate,
> + unsigned long *best_parent_rate,
> + struct clk_hw **best_parent_hw)

The ->determine_rate() prototype has changed (see [1]).


> +/* No modification of hardware as we have the flag CLK_SET_RATE_GATE set */
> +static int clk_generated_set_rate(struct clk_hw *hw,
> + unsigned long rate,
> + unsigned long parent_rate)
> +{
> + struct clk_generated *gck = to_clk_generated(hw);
> + u32 div;
> +
> + if (!rate)
> + return -EINVAL;
> +
> + if (gck->id < PERIPHERAL_ID_MIN || !gck->range.max) {
> + if (parent_rate == rate) {
> + gck->gckdiv = 0;
> + return 0;
> + } else {
> + return -EINVAL;
> + }
> + }

Do you really need the above check ?
AFAICT, periph ids inferior to 2 are invalid ids, so they should be
detected at probe time.
The !gck->range.max will be caught by the rate > gck->range.max test.
And finally, the case parent_rate == rate will just give you a div of 1,
which in turns give a gckdiv of 0.

> +
> + if (rate > gck->range.max)
> + return -EINVAL;
> +
> + div = DIV_ROUND_CLOSEST(parent_rate, rate);
> + if (div > GENERATED_MAX_DIV + 1 || !div)
> + return -EINVAL;
> +
> + gck->gckdiv = div - 1;
> + return 0;
> +}
> +
> +static const struct clk_ops generated_ops = {
> + .enable = clk_generated_enable,
> + .disable = clk_generated_disable,
> + .is_enabled = clk_generated_is_enabled,
> + .recalc_rate = clk_generated_recalc_rate,
> + .determine_rate = clk_generated_determine_rate,
> + .get_parent = clk_generated_get_parent,
> + .set_parent = clk_generated_set_parent,
> + .set_rate = clk_generated_set_rate,
> +};
> +
> +/**
> + * clk_generated_startup - Initialize a given clock to its default parent and
> + * divisor parameter.
> + *
> + * @gck: Generated clock to set the startup parameters for.
> + *
> + * Take parameters from the hardware and update local clock configuration
> + * accordingly.
> + */
> +static void clk_generated_startup(struct clk_generated *gck)
> +{
> + struct at91_pmc *pmc = gck->pmc;
> + u32 tmp;
> +
> + pmc_lock(pmc);
> + pmc_write(pmc, AT91_PMC_PCR, (gck->id & AT91_PMC_PCR_PID_MASK));
> + tmp = pmc_read(pmc, AT91_PMC_PCR);
> + pmc_unlock(pmc);
> +
> + gck->parent_id = (tmp & AT91_PMC_PCR_GCKCSS_MASK) >> AT91_PMC_PCR_GCKCSS_OFFSET;
> + gck->gckdiv = (tmp & AT91_PMC_PCR_GCKDIV_MASK) >> AT91_PMC_PCR_GCKDIV_OFFSET;
> +}
> +
> +static struct clk * __init
> +at91_clk_register_generated(struct at91_pmc *pmc, const char *name,
> + const char **parent_names, u8 num_parents,
> + u8 id, const struct clk_range *range)
> +{
> + struct clk_generated *gck;
> + struct clk *clk = NULL;
> + struct clk_init_data init;
> +
> + gck = kzalloc(sizeof(*gck), GFP_KERNEL);
> + if (!gck)
> + return ERR_PTR(-ENOMEM);
> +
> + init.name = name;
> + init.ops = &generated_ops;
> + init.parent_names = parent_names;
> + init.num_parents = num_parents;
> + init.flags = CLK_SET_RATE_GATE | CLK_SET_PARENT_GATE;
> +
> + gck->id = id;
> + gck->hw.init = &init;
> + gck->pmc = pmc;
> + gck->range = *range;
> +
> + clk = clk_register(NULL, &gck->hw);
> + if (IS_ERR(clk))
> + kfree(gck);
> + else
> + clk_generated_startup(gck);
> +
> + return clk;
> +}
> +
> +void __init of_sama5d2_clk_generated_setup(struct device_node *np,
> + struct at91_pmc *pmc)
> +{
> + int i;
> + int num;
> + u32 id;
> + const char *name;
> + struct clk *clk;
> + int num_parents;
> + const char *parent_names[GENERATED_SOURCE_MAX];
> + struct device_node *gcknp;
> + struct clk_range range = CLK_RANGE(0, 0);
> +
> + num_parents = of_count_phandle_with_args(np, "clocks", "#clock-cells");

Use the of_clk_get_parent_count() [2].

That's all I got for now.

Thanks,

Boris


[1]http://lxr.free-electrons.com/source/include/linux/clk-provider.h#L178
[2]http://lxr.free-electrons.com/source/include/linux/clk-provider.h#L626

--
Boris Brezillon, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com

2015-06-22 16:52:09

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] clk: at91: add generated clock driver

Le 18/06/2015 17:25, Boris Brezillon a ?crit :
> Hi Nicolas,

Thanks for your review Boris. I'll address your remarks by sending
another revision of this series in several days...

Bye,

> I haven't run checkpatch on your patch, but there seems to be a few
> things to fix ;-).
>
> On Wed, 17 Jun 2015 15:23:29 +0200
> Nicolas Ferre <[email protected]> wrote:
>
>
>
>
>> +
>> +static long clk_generated_determine_rate(struct clk_hw *hw,
>> + unsigned long rate,
>> + unsigned long *best_parent_rate,
>> + struct clk_hw **best_parent_hw)
>
> The ->determine_rate() prototype has changed (see [1]).
>
>
>> +/* No modification of hardware as we have the flag CLK_SET_RATE_GATE set */
>> +static int clk_generated_set_rate(struct clk_hw *hw,
>> + unsigned long rate,
>> + unsigned long parent_rate)
>> +{
>> + struct clk_generated *gck = to_clk_generated(hw);
>> + u32 div;
>> +
>> + if (!rate)
>> + return -EINVAL;
>> +
>> + if (gck->id < PERIPHERAL_ID_MIN || !gck->range.max) {
>> + if (parent_rate == rate) {
>> + gck->gckdiv = 0;
>> + return 0;
>> + } else {
>> + return -EINVAL;
>> + }
>> + }
>
> Do you really need the above check ?
> AFAICT, periph ids inferior to 2 are invalid ids, so they should be
> detected at probe time.
> The !gck->range.max will be caught by the rate > gck->range.max test.
> And finally, the case parent_rate == rate will just give you a div of 1,
> which in turns give a gckdiv of 0.
>
>> +
>> + if (rate > gck->range.max)
>> + return -EINVAL;
>> +
>> + div = DIV_ROUND_CLOSEST(parent_rate, rate);
>> + if (div > GENERATED_MAX_DIV + 1 || !div)
>> + return -EINVAL;
>> +
>> + gck->gckdiv = div - 1;
>> + return 0;
>> +}
>> +
>> +static const struct clk_ops generated_ops = {
>> + .enable = clk_generated_enable,
>> + .disable = clk_generated_disable,
>> + .is_enabled = clk_generated_is_enabled,
>> + .recalc_rate = clk_generated_recalc_rate,
>> + .determine_rate = clk_generated_determine_rate,
>> + .get_parent = clk_generated_get_parent,
>> + .set_parent = clk_generated_set_parent,
>> + .set_rate = clk_generated_set_rate,
>> +};
>> +
>> +/**
>> + * clk_generated_startup - Initialize a given clock to its default parent and
>> + * divisor parameter.
>> + *
>> + * @gck: Generated clock to set the startup parameters for.
>> + *
>> + * Take parameters from the hardware and update local clock configuration
>> + * accordingly.
>> + */
>> +static void clk_generated_startup(struct clk_generated *gck)
>> +{
>> + struct at91_pmc *pmc = gck->pmc;
>> + u32 tmp;
>> +
>> + pmc_lock(pmc);
>> + pmc_write(pmc, AT91_PMC_PCR, (gck->id & AT91_PMC_PCR_PID_MASK));
>> + tmp = pmc_read(pmc, AT91_PMC_PCR);
>> + pmc_unlock(pmc);
>> +
>> + gck->parent_id = (tmp & AT91_PMC_PCR_GCKCSS_MASK) >> AT91_PMC_PCR_GCKCSS_OFFSET;
>> + gck->gckdiv = (tmp & AT91_PMC_PCR_GCKDIV_MASK) >> AT91_PMC_PCR_GCKDIV_OFFSET;
>> +}
>> +
>> +static struct clk * __init
>> +at91_clk_register_generated(struct at91_pmc *pmc, const char *name,
>> + const char **parent_names, u8 num_parents,
>> + u8 id, const struct clk_range *range)
>> +{
>> + struct clk_generated *gck;
>> + struct clk *clk = NULL;
>> + struct clk_init_data init;
>> +
>> + gck = kzalloc(sizeof(*gck), GFP_KERNEL);
>> + if (!gck)
>> + return ERR_PTR(-ENOMEM);
>> +
>> + init.name = name;
>> + init.ops = &generated_ops;
>> + init.parent_names = parent_names;
>> + init.num_parents = num_parents;
>> + init.flags = CLK_SET_RATE_GATE | CLK_SET_PARENT_GATE;
>> +
>> + gck->id = id;
>> + gck->hw.init = &init;
>> + gck->pmc = pmc;
>> + gck->range = *range;
>> +
>> + clk = clk_register(NULL, &gck->hw);
>> + if (IS_ERR(clk))
>> + kfree(gck);
>> + else
>> + clk_generated_startup(gck);
>> +
>> + return clk;
>> +}
>> +
>> +void __init of_sama5d2_clk_generated_setup(struct device_node *np,
>> + struct at91_pmc *pmc)
>> +{
>> + int i;
>> + int num;
>> + u32 id;
>> + const char *name;
>> + struct clk *clk;
>> + int num_parents;
>> + const char *parent_names[GENERATED_SOURCE_MAX];
>> + struct device_node *gcknp;
>> + struct clk_range range = CLK_RANGE(0, 0);
>> +
>> + num_parents = of_count_phandle_with_args(np, "clocks", "#clock-cells");
>
> Use the of_clk_get_parent_count() [2].
>
> That's all I got for now.
>
> Thanks,
>
> Boris
>
>
> [1]http://lxr.free-electrons.com/source/include/linux/clk-provider.h#L178
> [2]http://lxr.free-electrons.com/source/include/linux/clk-provider.h#L626
>


--
Nicolas Ferre