mbox series

[v4,0/9] add support for Sama5d2 audio PLLs and enable ClassD

Message ID cover.c8ce78c15296190b2aa5c452c0c4512528e28518.1500968090.git-series.quentin.schulz@free-electrons.com
Headers show
Series add support for Sama5d2 audio PLLs and enable ClassD | expand

Message

Quentin Schulz July 25, 2017, 7:37 a.m. UTC
This patch series adds support for the audio PLLs and enables ClassD that
can be found in ATMEL Sama5d2 SoC.

There are two audio PLLs (PMC and PAD) that shares the same parent (FRAC).
FRAC can output between 620 and 700MHz and only multiply the rate of its
parent. The two audio PLLs then divide the FRAC rate to best match the
asked rate.

I basically took an old patch series posted by Nicolas on December, 6th
2016[1][2][3] and the comments Boris did on the first version[4] Nicolas
sent on July, 15th 2015.

I also fixed the function used to compute the divisors, removed useless
spinlocks and added a range to the audio frac PLL to stay within vendor's
supported range. Clocks that are children of gclk (generated-clk) are now
able to propagate rate to the audio PLL clocks when needed.

However, there are multiple children clocks that could technically
change the rate of audio_pll (via gck). With the rate locking introduced
in Jerome Brunet's patch series[5], the first consumer to enable the clock
will be the one definitely setting the rate of the clock. Without the rate
locking, the last consumer to set the rate will be able to mess with the
rate.
Since audio IPs are most likely to request the same rate, we enforce
that the only clks able to modify gck rate are those of audio IPs.

To remain consistent, we deny other clocks to be children of audio_pll.

v4:
 - initialized the clk_init_data structure,
 - switched to of_clk_parent_fill instead of manually setting
 parent_names,
 - removed include of clkdev.h in favor of slab.h,
 - removed unnecessary second cast in operation,
 - used clamp instead of two conditions,
 - removed dependency on clock-output-names, the name is gotten from DT
 node,
 - merged all three drivers for audio PLLs (FRAC, PMC, PAD) into one,

v3:
 - added a flag per generated clock to know which one is allowed to
 modify audio_pll rate,
 - set the flag in setup function depending on the compatible and the
 clock ID,

v2:
 - split big patch containing dt-binding, pll drivers and classd
 modifications,
 - removed unused AUDIO_PLL_*FOUT* defines from clk-audio-pll-pmc,
 - added conditions for audio pll rate setting restriction for SSC and
 I2S,
 - renamed all mentions of ACLK to GCLK in classD driver,

Thanks,
Quentin

[1] https://patchwork.kernel.org/patch/9462351/
[2] https://patchwork.kernel.org/patch/9462347/
[3] https://patchwork.kernel.org/patch/9462349/
[4] https://www.spinics.net/lists/arm-kernel/msg436120.html
[5] http://www.spinics.net/lists/linux-clk/msg17927.html

Cyrille Pitchen (2):
  ARM: dts: at91: sama5d2: add classd nodes
  ARM: dts: at91: sama5d2_xplained: add pin muxing and enable classd

Quentin Schulz (7):
  clk: at91: clk-generated: remove useless divisor loop
  dt-bindings: clk: at91: add audio plls to the compatible list
  clk: at91: add audio pll clock drivers
  clk: at91: clk-generated: create function to find best_diff
  clk: at91: clk-generated: make gclk determine audio_pll rate
  ASoC: atmel-classd: remove aclk clock from DT binding
  ASoC: atmel-classd: remove aclk clock

 Documentation/devicetree/bindings/clock/at91-clock.txt   |  10 +-
 Documentation/devicetree/bindings/sound/atmel-classd.txt |   9 +-
 arch/arm/boot/dts/at91-sama5d2_xplained.dts              |  16 +-
 arch/arm/boot/dts/sama5d2.dtsi                           |  39 +-
 arch/arm/mach-at91/Kconfig                               |   4 +-
 drivers/clk/at91/Makefile                                |   1 +-
 drivers/clk/at91/clk-audio-pll.c                         | 531 ++++++++-
 drivers/clk/at91/clk-generated.c                         | 101 +-
 include/linux/clk/at91_pmc.h                             |  25 +-
 sound/soc/atmel/atmel-classd.c                           |  47 +-
 10 files changed, 724 insertions(+), 59 deletions(-)
 create mode 100644 drivers/clk/at91/clk-audio-pll.c

base-commit: 047a0f692a9354d730dad30f25e1ebd8437b32b1
-- 
git-series 0.9.1
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Nicolas Ferre July 25, 2017, 3:37 p.m. UTC | #1
On 25/07/2017 at 09:37, Quentin Schulz wrote:
> This allows gclk to determine audio_pll rate and set the parent rate

> accordingly.

> 

> However, there are multiple children clocks that could technically

> change the rate of audio_pll (via gck). With the rate locking, the first

> consumer to enable the clock will be the one definitely setting the rate

> of the clock.

> 

> Since audio IPs are most likely to request the same rate, we enforce

> that the only clks able to modify gck rate are those of audio IPs.

> 

> To remain consistent, we deny other clocks to be children of audio_pll.

> 

> Signed-off-by: Quentin Schulz <quentin.schulz@free-electrons.com>

> Acked-by: Boris Brezillon <boris.brezillon@free-electrons.com>


Acked-by: Nicolas Ferre <nicolas.ferre@microchip.com>


> ---

>  drivers/clk/at91/clk-generated.c | 63 +++++++++++++++++++++++++++++----

>  1 file changed, 57 insertions(+), 6 deletions(-)

> 

> diff --git a/drivers/clk/at91/clk-generated.c b/drivers/clk/at91/clk-generated.c

> index 7260e49..3348136 100644

> --- a/drivers/clk/at91/clk-generated.c

> +++ b/drivers/clk/at91/clk-generated.c

> @@ -26,6 +26,13 @@

>  #define GENERATED_SOURCE_MAX	6

>  #define GENERATED_MAX_DIV	255

>  

> +#define GCK_ID_SSC0		43

> +#define GCK_ID_SSC1		44

> +#define GCK_ID_I2S0		54

> +#define GCK_ID_I2S1		55

> +#define GCK_ID_CLASSD		59

> +#define GCK_INDEX_DT_AUDIO_PLL	5

> +

>  struct clk_generated {

>  	struct clk_hw hw;

>  	struct regmap *regmap;

> @@ -34,6 +41,7 @@ struct clk_generated {

>  	u32 id;

>  	u32 gckdiv;

>  	u8 parent_id;

> +	bool audio_pll_allowed;

>  };

>  

>  #define to_clk_generated(hw) \

> @@ -126,15 +134,14 @@ static int clk_generated_determine_rate(struct clk_hw *hw,

>  {

>  	struct clk_generated *gck = to_clk_generated(hw);

>  	struct clk_hw *parent = NULL;

> +	struct clk_rate_request req_parent = *req;

>  	long best_rate = -EINVAL;

> -	unsigned long min_rate;

> +	unsigned long min_rate, parent_rate;

>  	int best_diff = -1;

>  	int i;

> +	u32 div;

>  

> -	for (i = 0; i < clk_hw_get_num_parents(hw); i++) {

> -		u32 div;

> -		unsigned long parent_rate;

> -

> +	for (i = 0; i < clk_hw_get_num_parents(hw) - 1; i++) {

>  		parent = clk_hw_get_parent_by_index(hw, i);

>  		if (!parent)

>  			continue;

> @@ -150,11 +157,38 @@ static int clk_generated_determine_rate(struct clk_hw *hw,

>  		clk_generated_best_diff(req, parent, parent_rate, div,

>  					&best_diff, &best_rate);

>  

> +		if (!best_diff)

> +			break;

> +	}

> +

> +	/*

> +	 * The audio_pll rate can be modified, unlike the five others clocks

> +	 * that should never be altered.

> +	 * The audio_pll can technically be used by multiple consumers. However,

> +	 * with the rate locking, the first consumer to enable to clock will be

> +	 * the one definitely setting the rate of the clock.

> +	 * Since audio IPs are most likely to request the same rate, we enforce

> +	 * that the only clks able to modify gck rate are those of audio IPs.

> +	 */

> +

> +	if (!gck->audio_pll_allowed)

> +		goto end;

> +

> +	parent = clk_hw_get_parent_by_index(hw, GCK_INDEX_DT_AUDIO_PLL);

> +	if (!parent)

> +		goto end;

> +

> +	for (div = 1; div < GENERATED_MAX_DIV + 2; div++) {

> +		req_parent.rate = req->rate * div;

> +		__clk_determine_rate(parent, &req_parent);

> +		clk_generated_best_diff(req, parent, req_parent.rate, div,

> +					&best_diff, &best_rate);

>  

>  		if (!best_diff)

>  			break;

>  	}

>  

> +end:

>  	pr_debug("GCLK: %s, best_rate = %ld, parent clk: %s @ %ld\n",

>  		 __func__, best_rate,

>  		 __clk_get_name((req->best_parent_hw)->clk),

> @@ -264,7 +298,8 @@ at91_clk_register_generated(struct regmap *regmap, spinlock_t *lock,

>  	init.ops = &generated_ops;

>  	init.parent_names = parent_names;

>  	init.num_parents = num_parents;

> -	init.flags = CLK_SET_RATE_GATE | CLK_SET_PARENT_GATE;

> +	init.flags = CLK_SET_RATE_GATE | CLK_SET_PARENT_GATE |

> +		CLK_SET_RATE_PARENT;

>  

>  	gck->id = id;

>  	gck->hw.init = &init;

> @@ -296,6 +331,7 @@ static void __init of_sama5d2_clk_generated_setup(struct device_node *np)

>  	struct device_node *gcknp;

>  	struct clk_range range = CLK_RANGE(0, 0);

>  	struct regmap *regmap;

> +	struct clk_generated *gck;

>  

>  	num_parents = of_clk_get_parent_count(np);

>  	if (num_parents == 0 || num_parents > GENERATED_SOURCE_MAX)

> @@ -327,6 +363,21 @@ static void __init of_sama5d2_clk_generated_setup(struct device_node *np)

>  		hw = at91_clk_register_generated(regmap, &pmc_pcr_lock, name,

>  						  parent_names, num_parents,

>  						  id, &range);

> +

> +		gck = to_clk_generated(hw);

> +

> +		if (of_device_is_compatible(np,

> +					    "atmel,sama5d2-clk-generated")) {

> +			if (gck->id == GCK_ID_SSC0 || gck->id == GCK_ID_SSC1 ||

> +			    gck->id == GCK_ID_I2S0 || gck->id == GCK_ID_I2S1 ||

> +			    gck->id == GCK_ID_CLASSD)

> +				gck->audio_pll_allowed = true;

> +			else

> +				gck->audio_pll_allowed = false;

> +		} else {

> +			gck->audio_pll_allowed = false;

> +		}

> +

>  		if (IS_ERR(hw))

>  			continue;

>  

> 



-- 
Nicolas Ferre
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Alexandre Belloni July 26, 2017, 6:57 a.m. UTC | #2
On 25/07/2017 at 17:44:19 +0200, Nicolas Ferre wrote:
> On 25/07/2017 at 09:37, Quentin Schulz wrote:

> > This patch series adds support for the audio PLLs and enables ClassD that

> > can be found in ATMEL Sama5d2 SoC.

> > 

> > There are two audio PLLs (PMC and PAD) that shares the same parent (FRAC).

> > FRAC can output between 620 and 700MHz and only multiply the rate of its

> > parent. The two audio PLLs then divide the FRAC rate to best match the

> > asked rate.

> > 

> > I basically took an old patch series posted by Nicolas on December, 6th

> > 2016[1][2][3] and the comments Boris did on the first version[4] Nicolas

> > sent on July, 15th 2015.

> > 

> > I also fixed the function used to compute the divisors, removed useless

> > spinlocks and added a range to the audio frac PLL to stay within vendor's

> > supported range. Clocks that are children of gclk (generated-clk) are now

> > able to propagate rate to the audio PLL clocks when needed.

> > 

> > However, there are multiple children clocks that could technically

> > change the rate of audio_pll (via gck). With the rate locking introduced

> > in Jerome Brunet's patch series[5], the first consumer to enable the clock

> > will be the one definitely setting the rate of the clock. Without the rate

> > locking, the last consumer to set the rate will be able to mess with the

> > rate.

> > Since audio IPs are most likely to request the same rate, we enforce

> > that the only clks able to modify gck rate are those of audio IPs.

> > 

> > To remain consistent, we deny other clocks to be children of audio_pll.

> 

> Quentin,

> 

> Thanks for having revived this series. Everything's okay on my side for

> this v4. I think that my tag isn't missing from any patch of this

> series. Now we surely need to define which path it must take...

> 


I'll take the two dts patches now as the bindings have been acked.
Everything else should probably go through the clk tree.


-- 
Alexandre Belloni, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Alexandre Belloni July 26, 2017, 6:59 a.m. UTC | #3
On 25/07/2017 at 09:37:05 +0200, Quentin Schulz wrote:
> From: Cyrille Pitchen <cyrille.pitchen@atmel.com>

> 

> This patch adds nodes for the classd device and its generated clock.

> 

> Signed-off-by: Cyrille Pitchen <cyrille.pitchen@atmel.com>

> Signed-off-by: Nicolas Ferre <nicolas.ferre@atmel.com>

> Signed-off-by: Quentin Schulz <quentin.schulz@free-electrons.com>

> ---

>  arch/arm/boot/dts/sama5d2.dtsi | 39 ++++++++++++++++++++++++++++++++++-

>  1 file changed, 38 insertions(+), 1 deletion(-)

> 

Applied, thanks.

-- 
Alexandre Belloni, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html