diff mbox

[v7,1/6] clk: shmobile: sh73a0 common clock framework implementation

Message ID 1418222727-19888-2-git-send-email-ulrich.hecht+renesas@gmail.com (mailing list archive)
State Accepted
Commit ae073881aa7d2f744fa703ae47371611780e4e44
Delegated to: Simon Horman
Headers show

Commit Message

Ulrich Hecht Dec. 10, 2014, 2:45 p.m. UTC
Driver for the SH73A0's clocks that are too specific to be supported by a
generic driver.

Signed-off-by: Ulrich Hecht <ulrich.hecht+renesas@gmail.com>
Acked-by: Mike Turquette <mturquette@linaro.org>
Tested-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 .../bindings/clock/renesas,sh73a0-cpg-clocks.txt   |  35 ++++
 drivers/clk/shmobile/Makefile                      |   1 +
 drivers/clk/shmobile/clk-sh73a0.c                  | 218 +++++++++++++++++++++
 3 files changed, 254 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/renesas,sh73a0-cpg-clocks.txt
 create mode 100644 drivers/clk/shmobile/clk-sh73a0.c

Comments

Laurent Pinchart Dec. 10, 2014, 3:38 p.m. UTC | #1
Hi Ulrich,

Thank you for the patch.

On Wednesday 10 December 2014 15:45:22 Ulrich Hecht wrote:
> Driver for the SH73A0's clocks that are too specific to be supported by a
> generic driver.
> 
> Signed-off-by: Ulrich Hecht <ulrich.hecht+renesas@gmail.com>
> Acked-by: Mike Turquette <mturquette@linaro.org>
> Tested-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  .../bindings/clock/renesas,sh73a0-cpg-clocks.txt   |  35 ++++
>  drivers/clk/shmobile/Makefile                      |   1 +
>  drivers/clk/shmobile/clk-sh73a0.c                  | 218 ++++++++++++++++++
>  3 files changed, 254 insertions(+)
>  create mode 100644
> Documentation/devicetree/bindings/clock/renesas,sh73a0-cpg-clocks.txt
> create mode 100644 drivers/clk/shmobile/clk-sh73a0.c

[snip]

> diff --git a/drivers/clk/shmobile/clk-sh73a0.c
> b/drivers/clk/shmobile/clk-sh73a0.c new file mode 100644
> index 0000000..8574a6d
> --- /dev/null
> +++ b/drivers/clk/shmobile/clk-sh73a0.c
> @@ -0,0 +1,218 @@
> +/*
> + * sh73a0 Core CPG Clocks
> + *
> + * Copyright (C) 2014  Ulrich Hecht
> + *
> + * 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; version 2 of the License.
> + */
> +
> +#include <linux/clk-provider.h>
> +#include <linux/clkdev.h>
> +#include <linux/clk/shmobile.h>
> +#include <linux/init.h>
> +#include <linux/kernel.h>
> +#include <linux/of.h>
> +#include <linux/of_address.h>
> +#include <linux/spinlock.h>
> +
> +struct sh73a0_cpg {
> +	struct clk_onecell_data data;
> +	spinlock_t lock;
> +	void __iomem *reg;
> +};
> +
> +#define CPG_FRQCRA	0x00
> +#define CPG_FRQCRB	0x04
> +#define CPG_SD0CKCR	0x74
> +#define CPG_SD1CKCR	0x78
> +#define CPG_SD2CKCR	0x7c
> +#define CPG_PLLECR	0xd0
> +#define CPG_PLL0CR	0xd8
> +#define CPG_PLL1CR	0x28
> +#define CPG_PLL2CR	0x2c
> +#define CPG_PLL3CR	0xdc
> +#define CPG_CKSCR	0xc0
> +#define CPG_DSI0PHYCR	0x6c
> +#define CPG_DSI1PHYCR	0x70
> +
> +#define CLK_ENABLE_ON_INIT BIT(0)
> +
> +struct div4_clk {
> +	const char *name;
> +	const char *parent;
> +	unsigned int reg;
> +	unsigned int shift;
> +};
> +
> +static struct div4_clk div4_clks[] = {
> +	{ "zg", "pll0", CPG_FRQCRA, 16 },

I've already commented on this in v6, the comment has probably been 
overlooked. According to the datasheet the ZGFC value 1010 results in a x1/5 
factor, which  doesn't match the value in the div4_div_table below. I wonder 
if it could be an error in the datasheet though.

> +	{ "m3", "pll1", CPG_FRQCRA, 12 },
> +	{ "b",  "pll1", CPG_FRQCRA,  8 },
> +	{ "m1", "pll1", CPG_FRQCRA,  4 },
> +	{ "m2", "pll1", CPG_FRQCRA,  0 },
> +	{ "zx", "pll1", CPG_FRQCRB, 12 },
> +	{ "hp", "pll1", CPG_FRQCRB,  4 },

It's nice to see the unused mask and flags gone, but how to you plan to 
implement the fact that different div4 clocks have different allowed divider 
values ? :-)

> +	{ NULL, 0, 0, 0 },
> +};
> +
> +static const struct clk_div_table div4_div_table[] = {
> +	{ 0, 2 }, { 1, 3 }, { 2, 4 }, { 3, 6 }, { 4, 8 }, { 5, 12 },
> +	{ 6, 16 }, { 7, 18 }, { 8, 24 }, { 10, 36 }, { 11, 48 },
> +	{ 12, 7 }, { 0, 0 }
> +};
> +
> +static const struct clk_div_table z_div_table[] = {
> +	/* ZSEL == 0 */
> +	{ 0, 1 }, { 1, 1 }, { 2, 1 }, { 3, 1 }, { 4, 1 }, { 5, 1 },
> +	{ 6, 1 }, { 7, 1 }, { 8, 1 }, { 9, 1 }, { 10, 1 }, { 11, 1 },
> +	{ 12, 1 }, { 13, 1 }, { 14, 1 }, { 15, 1 },

Do we have to list all entries, or could a single one be enough ?

> +	/* ZSEL == 1 */
> +	{ 16, 2 }, { 17, 3 }, { 18, 4 }, { 19, 6 }, { 20, 8 }, { 21, 12 },
> +	{ 22, 16 }, { 24, 24 }, { 27, 48 }, { 0, 0 }
> +};
> +
> +static struct clk * __init
> +sh73a0_cpg_register_clock(struct device_node *np, struct sh73a0_cpg *cpg,
> +			     const char *name)
> +{
> +	const struct clk_div_table *table = NULL;
> +	unsigned int shift, reg, width;
> +	const char *parent_name;
> +	unsigned int mult = 1;
> +	unsigned int div = 1;
> +
> +	if (!strcmp(name, "main")) {
> +		/* extal1, extal1_div2, extal2, extal2_div2 */
> +		u32 parent_idx = (clk_readl(cpg->reg + CPG_CKSCR) >> 28) & 3;
> +
> +		parent_name = of_clk_get_parent_name(np, parent_idx >> 1);
> +		div = (parent_idx & 1) + 1;
> +	} else if (!strncmp(name, "pll", 3)) {
> +		void __iomem *enable_reg = cpg->reg;
> +		u32 enable_bit = name[3] - '0';
> +
> +		parent_name = "main";
> +		switch (enable_bit) {
> +		case 0:
> +			enable_reg += CPG_PLL0CR;
> +			break;
> +		case 1:
> +			enable_reg += CPG_PLL1CR;
> +			break;
> +		case 2:
> +			enable_reg += CPG_PLL2CR;
> +			break;
> +		case 3:
> +			enable_reg += CPG_PLL3CR;
> +			break;
> +		default:
> +			return ERR_PTR(-EINVAL);
> +		}
> +		if (clk_readl(cpg->reg + CPG_PLLECR) & BIT(enable_bit)) {
> +			mult = ((clk_readl(enable_reg) >> 24) & 0x3f) + 1;
> +			/* handle CFG bit for PLL1 and PLL2 */
> +			if (enable_bit == 1 || enable_bit == 2)
> +				if (clk_readl(enable_reg) & BIT(20))
> +					mult *= 2;
> +		}
> +	} else if (!strcmp(name, "dsi0phy") || !strcmp(name, "dsi1phy")) {
> +		u32 phy_no = name[3] - '0';
> +		void __iomem *dsi_reg = cpg->reg +
> +			(phy_no ? CPG_DSI1PHYCR : CPG_DSI0PHYCR);
> +
> +		parent_name = phy_no ? "dsi1pck" : "dsi0pck";
> +		mult = __raw_readl(dsi_reg);
> +		if (!(mult & 0x8000))
> +			mult = 1;
> +		else
> +			mult = (mult & 0x3f) + 1;

It took me a bit of time to figure out that the PLLE bit always reflects the 
PLL state, regardless of whether it's in manual or automatic mode. Could you 
please add a comment to capture that ? Something like

"The PLLE bit controls the PLL in automatic mode only, but always reflects the 
PLL state even in manual mode."

Oh, and while you're at it, replacing 0x8000 with

#define DSIPHYCR_PLLE		BIT(15)

would be nice.

> +	} else if (!strcmp(name, "z")) {
> +		parent_name = "pll0";
> +		table = z_div_table;
> +		reg = CPG_FRQCRB;
> +		shift = 24;
> +		width = 5;
> +	} else {
> +		struct div4_clk *c;
> +
> +		for (c = div4_clks; c->name; c++) {
> +			if (!strcmp(name, c->name)) {
> +				parent_name = c->parent;
> +				table = div4_div_table;
> +				reg = c->reg;
> +				shift = c->shift;
> +				width = 4;
> +				break;
> +			}
> +		}
> +		if (!c->name)
> +			return ERR_PTR(-EINVAL);
> +	}
> +
> +	if (!table) {
> +		return clk_register_fixed_factor(NULL, name, parent_name, 0,
> +						 mult, div);
> +	} else {
> +		return clk_register_divider_table(NULL, name, parent_name, 0,
> +						  cpg->reg + reg, shift, width, 0,
> +						  table, &cpg->lock);
> +	}
> +}
> +
> +static void __init sh73a0_cpg_clocks_init(struct device_node *np)
> +{
> +	struct sh73a0_cpg *cpg;
> +	struct clk **clks;
> +	unsigned int i;
> +	int num_clks;
> +
> +	num_clks = of_property_count_strings(np, "clock-output-names");
> +	if (num_clks < 0) {
> +		pr_err("%s: failed to count clocks\n", __func__);
> +		return;
> +	}
> +
> +	cpg = kzalloc(sizeof(*cpg), GFP_KERNEL);
> +	clks = kcalloc(num_clks, sizeof(*clks), GFP_KERNEL);
> +	if (cpg == NULL || clks == NULL) {
> +		/* We're leaking memory on purpose, there's no point in cleaning
> +		 * up as the system won't boot anyway.
> +		 */
> +		return;
> +	}
> +
> +	spin_lock_init(&cpg->lock);
> +
> +	cpg->data.clks = clks;
> +	cpg->data.clk_num = num_clks;
> +
> +	cpg->reg = of_iomap(np, 0);
> +	if (WARN_ON(cpg->reg == NULL))
> +		return;
> +
> +	/* Set SDHI clocks to a known state */
> +	clk_writel(0x108, cpg->reg + CPG_SD0CKCR);
> +	clk_writel(0x108, cpg->reg + CPG_SD1CKCR);
> +	clk_writel(0x108, cpg->reg + CPG_SD2CKCR);

Why is this needed ?

> +	for (i = 0; i < num_clks; ++i) {
> +		const char *name;
> +		struct clk *clk;
> +
> +		of_property_read_string_index(np, "clock-output-names", i,
> +					      &name);
> +
> +		clk = sh73a0_cpg_register_clock(np, cpg, name);
> +		if (IS_ERR(clk))
> +			pr_err("%s: failed to register %s %s clock (%ld)\n",
> +			       __func__, np->name, name, PTR_ERR(clk));
> +		else
> +			cpg->data.clks[i] = clk;
> +	}
> +
> +	of_clk_add_provider(np, of_clk_src_onecell_get, &cpg->data);
> +}
> +CLK_OF_DECLARE(sh73a0_cpg_clks, "renesas,sh73a0-cpg-clocks",
> +	       sh73a0_cpg_clocks_init);
Ulrich Hecht Dec. 10, 2014, 4:53 p.m. UTC | #2
On Wed, Dec 10, 2014 at 4:38 PM, Laurent Pinchart
<laurent.pinchart@ideasonboard.com> wrote:
> On Wednesday 10 December 2014 15:45:22 Ulrich Hecht wrote:
>> Driver for the SH73A0's clocks that are too specific to be supported by a
>> generic driver.
[...]
>> +static struct div4_clk div4_clks[] = {
>> +     { "zg", "pll0", CPG_FRQCRA, 16 },
>
> I've already commented on this in v6, the comment has probably been
> overlooked. According to the datasheet the ZGFC value 1010 results in a x1/5
> factor, which  doesn't match the value in the div4_div_table below. I wonder
> if it could be an error in the datasheet though.

The legacy driver doesn't make an exception for zg.  Looks like an
error in the datasheet to me.

> It's nice to see the unused mask and flags gone, but how to you plan to
> implement the fact that different div4 clocks have different allowed divider
> values ? :-)

Well, not now, at any rate...

>> +static const struct clk_div_table z_div_table[] = {
>> +     /* ZSEL == 0 */
>> +     { 0, 1 }, { 1, 1 }, { 2, 1 }, { 3, 1 }, { 4, 1 }, { 5, 1 },
>> +     { 6, 1 }, { 7, 1 }, { 8, 1 }, { 9, 1 }, { 10, 1 }, { 11, 1 },
>> +     { 12, 1 }, { 13, 1 }, { 14, 1 }, { 15, 1 },
>
> Do we have to list all entries, or could a single one be enough ?

Hmm... u-boot initializes to all zeros, so just the first one might do.

>> +             if (!(mult & 0x8000))
>> +                     mult = 1;
>> +             else
>> +                     mult = (mult & 0x3f) + 1;
>
> It took me a bit of time to figure out that the PLLE bit always reflects the
> PLL state, regardless of whether it's in manual or automatic mode. Could you
> please add a comment to capture that ? Something like
>
> "The PLLE bit controls the PLL in automatic mode only, but always reflects the
> PLL state even in manual mode."

Yes, that is probably a good idea.

>> +     /* Set SDHI clocks to a known state */
>> +     clk_writel(0x108, cpg->reg + CPG_SD0CKCR);
>> +     clk_writel(0x108, cpg->reg + CPG_SD1CKCR);
>> +     clk_writel(0x108, cpg->reg + CPG_SD2CKCR);
>
> Why is this needed ?

Cargo cult programming, it's what the legacy driver does.  It
essentially just stops the clock (which u-boot leaves on), so it's
possible that it is not really necessary.

Geert, could I ask you to to occasionally check if this works without
the three SD clock initialization lines and without the "{ 1, 1 }" to
"{ 15, 1 }" entries in z_div_table?

CU
Uli
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Laurent Pinchart Dec. 10, 2014, 6:39 p.m. UTC | #3
Hi Ulrich,

(CC'ing Morimoto-san)

On Wednesday 10 December 2014 17:53:22 Ulrich Hecht wrote:
> On Wed, Dec 10, 2014 at 4:38 PM, Laurent Pinchart wrote:
> > On Wednesday 10 December 2014 15:45:22 Ulrich Hecht wrote:
> >> Driver for the SH73A0's clocks that are too specific to be supported by a
> >> generic driver.
> 
> [...]
> 
> >> +static struct div4_clk div4_clks[] = {
> >> +     { "zg", "pll0", CPG_FRQCRA, 16 },
> > 
> > I've already commented on this in v6, the comment has probably been
> > overlooked. According to the datasheet the ZGFC value 1010 results in a
> > x1/5 factor, which  doesn't match the value in the div4_div_table below.
> > I wonder if it could be an error in the datasheet though.
> 
> The legacy driver doesn't make an exception for zg.  Looks like an
> error in the datasheet to me.

Morimoto-san, do you think it would be possible to get that information from 
the hardware team(s) ?

In the meantime I don't think this is a show stopper.
Magnus Damm Dec. 11, 2014, 10:07 a.m. UTC | #4
Hi Laurent,

On Thu, Dec 11, 2014 at 3:39 AM, Laurent Pinchart
<laurent.pinchart@ideasonboard.com> wrote:
> Hi Ulrich,
>
> (CC'ing Morimoto-san)
>
> On Wednesday 10 December 2014 17:53:22 Ulrich Hecht wrote:
>> On Wed, Dec 10, 2014 at 4:38 PM, Laurent Pinchart wrote:
>> > On Wednesday 10 December 2014 15:45:22 Ulrich Hecht wrote:
>> >> Driver for the SH73A0's clocks that are too specific to be supported by a
>> >> generic driver.
>>
>> [...]
>>
>> >> +static struct div4_clk div4_clks[] = {
>> >> +     { "zg", "pll0", CPG_FRQCRA, 16 },
>> >
>> > I've already commented on this in v6, the comment has probably been
>> > overlooked. According to the datasheet the ZGFC value 1010 results in a
>> > x1/5 factor, which  doesn't match the value in the div4_div_table below.
>> > I wonder if it could be an error in the datasheet though.
>>
>> The legacy driver doesn't make an exception for zg.  Looks like an
>> error in the datasheet to me.
>
> Morimoto-san, do you think it would be possible to get that information from
> the hardware team(s) ?
>
> In the meantime I don't think this is a show stopper.

Let me step in here for a sec. I think getting reliable new
information about sh73a0 is highly unlikely. That particular SoC is
both old and part of the mobile line up that was chopped off quite
some time ago. So I don't think anyone with knowledge is left in the
company.

Thanks,

/ magnus
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Geert Uytterhoeven Dec. 11, 2014, 2:15 p.m. UTC | #5
Hi Ulrich,

On Wed, Dec 10, 2014 at 5:53 PM, Ulrich Hecht
<ulrich.hecht+renesas@gmail.com> wrote:
>>> +static const struct clk_div_table z_div_table[] = {
>>> +     /* ZSEL == 0 */
>>> +     { 0, 1 }, { 1, 1 }, { 2, 1 }, { 3, 1 }, { 4, 1 }, { 5, 1 },
>>> +     { 6, 1 }, { 7, 1 }, { 8, 1 }, { 9, 1 }, { 10, 1 }, { 11, 1 },
>>> +     { 12, 1 }, { 13, 1 }, { 14, 1 }, { 15, 1 },
>>
>> Do we have to list all entries, or could a single one be enough ?
>
> Hmm... u-boot initializes to all zeros, so just the first one might do.

>>> +     /* Set SDHI clocks to a known state */
>>> +     clk_writel(0x108, cpg->reg + CPG_SD0CKCR);
>>> +     clk_writel(0x108, cpg->reg + CPG_SD1CKCR);
>>> +     clk_writel(0x108, cpg->reg + CPG_SD2CKCR);
>>
>> Why is this needed ?
>
> Cargo cult programming, it's what the legacy driver does.  It
> essentially just stops the clock (which u-boot leaves on), so it's
> possible that it is not really necessary.
>
> Geert, could I ask you to to occasionally check if this works without
> the three SD clock initialization lines and without the "{ 1, 1 }" to
> "{ 15, 1 }" entries in z_div_table?

Kzm9g still boots after
  1) Setting z_div_table[1..15] to { 0, 0 }
  2) Removing the lines that initialize CPG_SD[012]CKCR.

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@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
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Laurent Pinchart Dec. 11, 2014, 2:19 p.m. UTC | #6
Hi Magnus,

On Thursday 11 December 2014 19:07:27 Magnus Damm wrote:
> On Thu, Dec 11, 2014 at 3:39 AM, Laurent Pinchart wrote:
> > Hi Ulrich,
> > 
> > (CC'ing Morimoto-san)
> > 
> > On Wednesday 10 December 2014 17:53:22 Ulrich Hecht wrote:
> >> On Wed, Dec 10, 2014 at 4:38 PM, Laurent Pinchart wrote:
> >> > On Wednesday 10 December 2014 15:45:22 Ulrich Hecht wrote:
> >> >> Driver for the SH73A0's clocks that are too specific to be supported
> >> >> by a
> >> >> generic driver.
> >> 
> >> [...]
> >> 
> >> >> +static struct div4_clk div4_clks[] = {
> >> >> +     { "zg", "pll0", CPG_FRQCRA, 16 },
> >> > 
> >> > I've already commented on this in v6, the comment has probably been
> >> > overlooked. According to the datasheet the ZGFC value 1010 results in a
> >> > x1/5 factor, which  doesn't match the value in the div4_div_table
> >> > below.
> >> > I wonder if it could be an error in the datasheet though.
> >> 
> >> The legacy driver doesn't make an exception for zg.  Looks like an
> >> error in the datasheet to me.
> > 
> > Morimoto-san, do you think it would be possible to get that information
> > from the hardware team(s) ?
> > 
> > In the meantime I don't think this is a show stopper.
> 
> Let me step in here for a sec. I think getting reliable new information
> about sh73a0 is highly unlikely. That particular SoC is both old and part of
> the mobile line up that was chopped off quite some time ago. So I don't
> think anyone with knowledge is left in the company.

Fair enough, I was quite expecting that, but I possibly naively thought it 
would be worth trying :-)

It should in theory be possible to test this by measuring the SGX perfomances, 
but I don't think that would be feasible in practice in our team. I'm thus 
fine considering this as an error in the documentation until proven wrong. It 
should probably be captured in a comment in the source code though.
Ulrich Hecht Dec. 11, 2014, 2:38 p.m. UTC | #7
On Thu, Dec 11, 2014 at 3:15 PM, Geert Uytterhoeven
<geert@linux-m68k.org> wrote:
> Kzm9g still boots after
>   1) Setting z_div_table[1..15] to { 0, 0 }
>   2) Removing the lines that initialize CPG_SD[012]CKCR.

OK, that's all I need to know.  Thanks a lot for checking!

CU
Uli
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Simon Horman Dec. 12, 2014, 12:16 a.m. UTC | #8
On Thu, Dec 11, 2014 at 04:19:20PM +0200, Laurent Pinchart wrote:
> Hi Magnus,
> 
> On Thursday 11 December 2014 19:07:27 Magnus Damm wrote:
> > On Thu, Dec 11, 2014 at 3:39 AM, Laurent Pinchart wrote:
> > > Hi Ulrich,
> > > 
> > > (CC'ing Morimoto-san)
> > > 
> > > On Wednesday 10 December 2014 17:53:22 Ulrich Hecht wrote:
> > >> On Wed, Dec 10, 2014 at 4:38 PM, Laurent Pinchart wrote:
> > >> > On Wednesday 10 December 2014 15:45:22 Ulrich Hecht wrote:
> > >> >> Driver for the SH73A0's clocks that are too specific to be supported
> > >> >> by a
> > >> >> generic driver.
> > >> 
> > >> [...]
> > >> 
> > >> >> +static struct div4_clk div4_clks[] = {
> > >> >> +     { "zg", "pll0", CPG_FRQCRA, 16 },
> > >> > 
> > >> > I've already commented on this in v6, the comment has probably been
> > >> > overlooked. According to the datasheet the ZGFC value 1010 results in a
> > >> > x1/5 factor, which  doesn't match the value in the div4_div_table
> > >> > below.
> > >> > I wonder if it could be an error in the datasheet though.
> > >> 
> > >> The legacy driver doesn't make an exception for zg.  Looks like an
> > >> error in the datasheet to me.
> > > 
> > > Morimoto-san, do you think it would be possible to get that information
> > > from the hardware team(s) ?
> > > 
> > > In the meantime I don't think this is a show stopper.
> > 
> > Let me step in here for a sec. I think getting reliable new information
> > about sh73a0 is highly unlikely. That particular SoC is both old and part of
> > the mobile line up that was chopped off quite some time ago. So I don't
> > think anyone with knowledge is left in the company.
> 
> Fair enough, I was quite expecting that, but I possibly naively thought it 
> would be worth trying :-)
> 
> It should in theory be possible to test this by measuring the SGX perfomances, 
> but I don't think that would be feasible in practice in our team. I'm thus 
> fine considering this as an error in the documentation until proven wrong. It 
> should probably be captured in a comment in the source code though.

FWIW, that is fine by me.

In more words: I think its perfectly reasonable to make informed and
appropriately documented judgements about the accuracy of the documentation
in lieu of a mechanism to confirm details from a hardware team.
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/clock/renesas,sh73a0-cpg-clocks.txt b/Documentation/devicetree/bindings/clock/renesas,sh73a0-cpg-clocks.txt
new file mode 100644
index 0000000..a8978ec
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/renesas,sh73a0-cpg-clocks.txt
@@ -0,0 +1,35 @@ 
+These bindings should be considered EXPERIMENTAL for now.
+
+* Renesas SH73A0 Clock Pulse Generator (CPG)
+
+The CPG generates core clocks for the SH73A0 SoC. It includes four PLLs
+and several fixed ratio dividers.
+
+Required Properties:
+
+  - compatible: Must be "renesas,sh73a0-cpg-clocks"
+
+  - reg: Base address and length of the memory resource used by the CPG
+
+  - clocks: Reference to the parent clocks ("extal1" and "extal2")
+
+  - #clock-cells: Must be 1
+
+  - clock-output-names: The names of the clocks. Supported clocks are "main",
+    "pll0", "pll1", "pll2", "pll3", "dsi0phy", "dsi1phy", "zg", "m3", "b",
+    "m1", "m2", "z", "zx", and "hp".
+
+
+Example
+-------
+
+        cpg_clocks: cpg_clocks@e6150000 {
+                compatible = "renesas,sh73a0-cpg-clocks";
+                reg = <0 0xe6150000 0 0x10000>;
+                clocks = <&extal1_clk>, <&extal2_clk>;
+                #clock-cells = <1>;
+                clock-output-names = "main", "pll0", "pll1", "pll2",
+                                     "pll3", "dsi0phy", "dsi1phy",
+                                     "zg", "m3", "b", "m1", "m2",
+                                     "z", "zx", "hp";
+        };
diff --git a/drivers/clk/shmobile/Makefile b/drivers/clk/shmobile/Makefile
index 960bf22..f83980f 100644
--- a/drivers/clk/shmobile/Makefile
+++ b/drivers/clk/shmobile/Makefile
@@ -5,5 +5,6 @@  obj-$(CONFIG_ARCH_R8A7779)		+= clk-r8a7779.o
 obj-$(CONFIG_ARCH_R8A7790)		+= clk-rcar-gen2.o
 obj-$(CONFIG_ARCH_R8A7791)		+= clk-rcar-gen2.o
 obj-$(CONFIG_ARCH_R8A7794)		+= clk-rcar-gen2.o
+obj-$(CONFIG_ARCH_SH73A0)		+= clk-sh73a0.o
 obj-$(CONFIG_ARCH_SHMOBILE_MULTI)	+= clk-div6.o
 obj-$(CONFIG_ARCH_SHMOBILE_MULTI)	+= clk-mstp.o
diff --git a/drivers/clk/shmobile/clk-sh73a0.c b/drivers/clk/shmobile/clk-sh73a0.c
new file mode 100644
index 0000000..8574a6d
--- /dev/null
+++ b/drivers/clk/shmobile/clk-sh73a0.c
@@ -0,0 +1,218 @@ 
+/*
+ * sh73a0 Core CPG Clocks
+ *
+ * Copyright (C) 2014  Ulrich Hecht
+ *
+ * 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; version 2 of the License.
+ */
+
+#include <linux/clk-provider.h>
+#include <linux/clkdev.h>
+#include <linux/clk/shmobile.h>
+#include <linux/init.h>
+#include <linux/kernel.h>
+#include <linux/of.h>
+#include <linux/of_address.h>
+#include <linux/spinlock.h>
+
+struct sh73a0_cpg {
+	struct clk_onecell_data data;
+	spinlock_t lock;
+	void __iomem *reg;
+};
+
+#define CPG_FRQCRA	0x00
+#define CPG_FRQCRB	0x04
+#define CPG_SD0CKCR	0x74
+#define CPG_SD1CKCR	0x78
+#define CPG_SD2CKCR	0x7c
+#define CPG_PLLECR	0xd0
+#define CPG_PLL0CR	0xd8
+#define CPG_PLL1CR	0x28
+#define CPG_PLL2CR	0x2c
+#define CPG_PLL3CR	0xdc
+#define CPG_CKSCR	0xc0
+#define CPG_DSI0PHYCR	0x6c
+#define CPG_DSI1PHYCR	0x70
+
+#define CLK_ENABLE_ON_INIT BIT(0)
+
+struct div4_clk {
+	const char *name;
+	const char *parent;
+	unsigned int reg;
+	unsigned int shift;
+};
+
+static struct div4_clk div4_clks[] = {
+	{ "zg", "pll0", CPG_FRQCRA, 16 },
+	{ "m3", "pll1", CPG_FRQCRA, 12 },
+	{ "b",  "pll1", CPG_FRQCRA,  8 },
+	{ "m1", "pll1", CPG_FRQCRA,  4 },
+	{ "m2", "pll1", CPG_FRQCRA,  0 },
+	{ "zx", "pll1", CPG_FRQCRB, 12 },
+	{ "hp", "pll1", CPG_FRQCRB,  4 },
+	{ NULL, 0, 0, 0 },
+};
+
+static const struct clk_div_table div4_div_table[] = {
+	{ 0, 2 }, { 1, 3 }, { 2, 4 }, { 3, 6 }, { 4, 8 }, { 5, 12 },
+	{ 6, 16 }, { 7, 18 }, { 8, 24 }, { 10, 36 }, { 11, 48 },
+	{ 12, 7 }, { 0, 0 }
+};
+
+static const struct clk_div_table z_div_table[] = {
+	/* ZSEL == 0 */
+	{ 0, 1 }, { 1, 1 }, { 2, 1 }, { 3, 1 }, { 4, 1 }, { 5, 1 },
+	{ 6, 1 }, { 7, 1 }, { 8, 1 }, { 9, 1 }, { 10, 1 }, { 11, 1 },
+	{ 12, 1 }, { 13, 1 }, { 14, 1 }, { 15, 1 },
+	/* ZSEL == 1 */
+	{ 16, 2 }, { 17, 3 }, { 18, 4 }, { 19, 6 }, { 20, 8 }, { 21, 12 },
+	{ 22, 16 }, { 24, 24 }, { 27, 48 }, { 0, 0 }
+};
+
+static struct clk * __init
+sh73a0_cpg_register_clock(struct device_node *np, struct sh73a0_cpg *cpg,
+			     const char *name)
+{
+	const struct clk_div_table *table = NULL;
+	unsigned int shift, reg, width;
+	const char *parent_name;
+	unsigned int mult = 1;
+	unsigned int div = 1;
+
+	if (!strcmp(name, "main")) {
+		/* extal1, extal1_div2, extal2, extal2_div2 */
+		u32 parent_idx = (clk_readl(cpg->reg + CPG_CKSCR) >> 28) & 3;
+
+		parent_name = of_clk_get_parent_name(np, parent_idx >> 1);
+		div = (parent_idx & 1) + 1;
+	} else if (!strncmp(name, "pll", 3)) {
+		void __iomem *enable_reg = cpg->reg;
+		u32 enable_bit = name[3] - '0';
+
+		parent_name = "main";
+		switch (enable_bit) {
+		case 0:
+			enable_reg += CPG_PLL0CR;
+			break;
+		case 1:
+			enable_reg += CPG_PLL1CR;
+			break;
+		case 2:
+			enable_reg += CPG_PLL2CR;
+			break;
+		case 3:
+			enable_reg += CPG_PLL3CR;
+			break;
+		default:
+			return ERR_PTR(-EINVAL);
+		}
+		if (clk_readl(cpg->reg + CPG_PLLECR) & BIT(enable_bit)) {
+			mult = ((clk_readl(enable_reg) >> 24) & 0x3f) + 1;
+			/* handle CFG bit for PLL1 and PLL2 */
+			if (enable_bit == 1 || enable_bit == 2)
+				if (clk_readl(enable_reg) & BIT(20))
+					mult *= 2;
+		}
+	} else if (!strcmp(name, "dsi0phy") || !strcmp(name, "dsi1phy")) {
+		u32 phy_no = name[3] - '0';
+		void __iomem *dsi_reg = cpg->reg +
+			(phy_no ? CPG_DSI1PHYCR : CPG_DSI0PHYCR);
+
+		parent_name = phy_no ? "dsi1pck" : "dsi0pck";
+		mult = __raw_readl(dsi_reg);
+		if (!(mult & 0x8000))
+			mult = 1;
+		else
+			mult = (mult & 0x3f) + 1;
+	} else if (!strcmp(name, "z")) {
+		parent_name = "pll0";
+		table = z_div_table;
+		reg = CPG_FRQCRB;
+		shift = 24;
+		width = 5;
+	} else {
+		struct div4_clk *c;
+
+		for (c = div4_clks; c->name; c++) {
+			if (!strcmp(name, c->name)) {
+				parent_name = c->parent;
+				table = div4_div_table;
+				reg = c->reg;
+				shift = c->shift;
+				width = 4;
+				break;
+			}
+		}
+		if (!c->name)
+			return ERR_PTR(-EINVAL);
+	}
+
+	if (!table) {
+		return clk_register_fixed_factor(NULL, name, parent_name, 0,
+						 mult, div);
+	} else {
+		return clk_register_divider_table(NULL, name, parent_name, 0,
+						  cpg->reg + reg, shift, width, 0,
+						  table, &cpg->lock);
+	}
+}
+
+static void __init sh73a0_cpg_clocks_init(struct device_node *np)
+{
+	struct sh73a0_cpg *cpg;
+	struct clk **clks;
+	unsigned int i;
+	int num_clks;
+
+	num_clks = of_property_count_strings(np, "clock-output-names");
+	if (num_clks < 0) {
+		pr_err("%s: failed to count clocks\n", __func__);
+		return;
+	}
+
+	cpg = kzalloc(sizeof(*cpg), GFP_KERNEL);
+	clks = kcalloc(num_clks, sizeof(*clks), GFP_KERNEL);
+	if (cpg == NULL || clks == NULL) {
+		/* We're leaking memory on purpose, there's no point in cleaning
+		 * up as the system won't boot anyway.
+		 */
+		return;
+	}
+
+	spin_lock_init(&cpg->lock);
+
+	cpg->data.clks = clks;
+	cpg->data.clk_num = num_clks;
+
+	cpg->reg = of_iomap(np, 0);
+	if (WARN_ON(cpg->reg == NULL))
+		return;
+
+	/* Set SDHI clocks to a known state */
+	clk_writel(0x108, cpg->reg + CPG_SD0CKCR);
+	clk_writel(0x108, cpg->reg + CPG_SD1CKCR);
+	clk_writel(0x108, cpg->reg + CPG_SD2CKCR);
+
+	for (i = 0; i < num_clks; ++i) {
+		const char *name;
+		struct clk *clk;
+
+		of_property_read_string_index(np, "clock-output-names", i,
+					      &name);
+
+		clk = sh73a0_cpg_register_clock(np, cpg, name);
+		if (IS_ERR(clk))
+			pr_err("%s: failed to register %s %s clock (%ld)\n",
+			       __func__, np->name, name, PTR_ERR(clk));
+		else
+			cpg->data.clks[i] = clk;
+	}
+
+	of_clk_add_provider(np, of_clk_src_onecell_get, &cpg->data);
+}
+CLK_OF_DECLARE(sh73a0_cpg_clks, "renesas,sh73a0-cpg-clocks",
+	       sh73a0_cpg_clocks_init);