Re: [PATCH v4 08/13] clk: imx: Update pllv3 to support i.MXRT1170

[Jesse Taube <mr.bossman075@gmail.com>]

On 6/27/22 09:32, Abel Vesa wrote:
> On 22-06-26 02:45:18, Jesse Taube wrote:
>> The i.MXRT1170 has a pll that has the multiplier bits inverted and
>> cannot be changed add IMX_PLLV3_GENERICV2.
>>
>> The i.MXRT1170 also has the lock bit moved as well as the
>> power bit inverted the power bit also is in different locations on each
>> pll control register.
>>
>> Signed-off-by: Jesse Taube <Mr.Bossman075@gmail.com>
>> ---
>> V1 -> V2:
>>   - Nothing done
>> V2 -> V3:
>>   - Nothing done
>> V3 -> V4:
>>   - Nothing done
>> ---
>>   drivers/clk/imx/clk-pllv3.c | 57 +++++++++++++++++++++++++++++++++++--
>>   drivers/clk/imx/clk.h       |  4 +++
>>   2 files changed, 59 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/clk/imx/clk-pllv3.c b/drivers/clk/imx/clk-pllv3.c
>> index eea32f87c60a..740412ea2f7e 100644
>> --- a/drivers/clk/imx/clk-pllv3.c
>> +++ b/drivers/clk/imx/clk-pllv3.c
>> @@ -23,6 +23,7 @@
>>
>>   #define BM_PLL_POWER		(0x1 << 12)
>>   #define BM_PLL_LOCK		(0x1 << 31)
>> +#define BM_PLL_LOCK_V2		(0x1 << 29)
>>   #define IMX7_ENET_PLL_POWER	(0x1 << 5)
>>   #define IMX7_DDR_PLL_POWER	(0x1 << 20)
>>
>> @@ -34,6 +35,7 @@
>>    * @base:	 base address of PLL registers
>>    * @power_bit:	 pll power bit mask
>>    * @powerup_set: set power_bit to power up the PLL
>> + * @lock_bit:	 pll lock bit mask
>>    * @div_mask:	 mask of divider bits
>>    * @div_shift:	 shift of divider bits
>>    * @ref_clock:	reference clock rate
>> @@ -48,6 +50,7 @@ struct clk_pllv3 {
>>   	void __iomem	*base;
>>   	u32		power_bit;
>>   	bool		powerup_set;
>> +	u32		lock_bit;
>>   	u32		div_mask;
>>   	u32		div_shift;
>>   	unsigned long	ref_clock;
>> @@ -65,7 +68,7 @@ static int clk_pllv3_wait_lock(struct clk_pllv3 *pll)
>>   	if ((pll->powerup_set && !val) || (!pll->powerup_set && val))
>>   		return 0;
>>
>> -	return readl_relaxed_poll_timeout(pll->base, val, val & BM_PLL_LOCK,
>> +	return readl_relaxed_poll_timeout(pll->base, val, val & pll->lock_bit,
>>   					  500, PLL_LOCK_TIMEOUT);
>>   }
>>
>> @@ -101,7 +104,7 @@ static int clk_pllv3_is_prepared(struct clk_hw *hw)
>>   {
>>   	struct clk_pllv3 *pll = to_clk_pllv3(hw);
>>
>> -	if (readl_relaxed(pll->base) & BM_PLL_LOCK)
>> +	if (readl_relaxed(pll->base) & pll->lock_bit)
>>   		return 1;
>>
>>   	return 0;
>> @@ -155,6 +158,39 @@ static const struct clk_ops clk_pllv3_ops = {
>>   	.set_rate	= clk_pllv3_set_rate,
>>   };
>>
>> +static int clk_pllv3_genericv2_set_rate(struct clk_hw *hw, unsigned long rate,
>> +		unsigned long parent_rate)
>> +{
>> +	struct clk_pllv3 *pll = to_clk_pllv3(hw);
>> +	u32 val, div;
>> +
>> +	div = (readl_relaxed(pll->base) >> pll->div_shift) & pll->div_mask;
>> +	val = (div == 0) ? parent_rate * 22 : parent_rate * 20;
>> +
>> +	if (rate == val)
>> +		return 0;
>> +
>> +	return -EINVAL;
>> +}
>> +
>> +static unsigned long clk_pllv3_genericv2_recalc_rate(struct clk_hw *hw,
>> +					   unsigned long parent_rate)
>> +{
>> +	struct clk_pllv3 *pll = to_clk_pllv3(hw);
>> +	u32 div = (readl_relaxed(pll->base) >> pll->div_shift)  & pll->div_mask;
>> +
>> +	return (div == 0) ? parent_rate * 22 : parent_rate * 20;
>> +}
>> +
>> +static const struct clk_ops clk_pllv3_genericv2_ops = {
>> +	.prepare	= clk_pllv3_prepare,
>> +	.unprepare	= clk_pllv3_unprepare,
>> +	.is_prepared	= clk_pllv3_is_prepared,
>> +	.recalc_rate	= clk_pllv3_genericv2_recalc_rate,
>> +	.round_rate	= clk_pllv3_round_rate,
>> +	.set_rate	= clk_pllv3_genericv2_set_rate,
>> +};
>> +
>>   static unsigned long clk_pllv3_sys_recalc_rate(struct clk_hw *hw,
>>   					       unsigned long parent_rate)
>>   {
>> @@ -407,6 +443,13 @@ static const struct clk_ops clk_pllv3_enet_ops = {
>>   	.recalc_rate	= clk_pllv3_enet_recalc_rate,
>>   };
>>
>> +void imx_clk_hw_pll3_powerbit(struct clk_hw *hw, u8 shift)
>> +{
>> +	struct clk_pllv3 *pll = to_clk_pllv3(hw);
>> +
>> +	pll->power_bit = shift;
>> +}
>> +
> 
> I can see why you need this, but I think the approach is not quite
> right.

I wasn't sure if modifying the function like that was appropriate for 
this, but sense it is I will do like you said.

> I suggest we rename the imx_clk_hw_pllv3 to __imx_clk_hw_pllv3 and add
> the power_bit parameter to it (and set it accordingly inside).
> 
> Then we should do the following in imx/clk.h:
> 
> #define imx_clk_hw_pllv3(name, parent_names, num_parents, parent,	\
> 				bypass1, bypass2, base, flags)		\
> 	__imx_clk_hw_pllv3(name, parent_names, num_parents, parent,	\
> 				bypass1, bypass2, base, flags, BM_PLL_POWER)

One problem BM_PLL_POWER will have to be in imx/clk.h, but then it will 
be the only macro like it in the file, is line 9 ok for it.
I could also make a function instead of a macro.

thanks,
Jesse Taube
> And then, the i.MXRT1170 can use the __imx_clk_hw_pllv3 and pass the
> right power_bit shift.
> 
>>   struct clk_hw *imx_clk_hw_pllv3(enum imx_pllv3_type type, const char *name,
>>   			  const char *parent_name, void __iomem *base,
>>   			  u32 div_mask)
>> @@ -422,10 +465,20 @@ struct clk_hw *imx_clk_hw_pllv3(enum imx_pllv3_type type, const char *name,
>>   		return ERR_PTR(-ENOMEM);
>>
>>   	pll->power_bit = BM_PLL_POWER;
>> +	pll->lock_bit = BM_PLL_LOCK;
>>   	pll->num_offset = PLL_NUM_OFFSET;
>>   	pll->denom_offset = PLL_DENOM_OFFSET;
>>
>>   	switch (type) {
>> +	case IMX_PLLV3_GENERICV2:
>> +		pll->lock_bit = BM_PLL_LOCK_V2;
>> +		pll->powerup_set = true;
>> +		ops = &clk_pllv3_genericv2_ops;
>> +		break;
>> +	case IMX_PLLV3_SYSV2:
>> +		pll->lock_bit = BM_PLL_LOCK_V2;
>> +		pll->powerup_set = true;
>> +		fallthrough;
>>   	case IMX_PLLV3_SYS:
>>   		ops = &clk_pllv3_sys_ops;
>>   		break;
>> diff --git a/drivers/clk/imx/clk.h b/drivers/clk/imx/clk.h
>> index 5061a06468df..31e017248602 100644
>> --- a/drivers/clk/imx/clk.h
>> +++ b/drivers/clk/imx/clk.h
>> @@ -242,6 +242,8 @@ struct clk_hw *imx_clk_hw_sscg_pll(const char *name,
>>
>>   enum imx_pllv3_type {
>>   	IMX_PLLV3_GENERIC,
>> +	IMX_PLLV3_GENERICV2,
>> +	IMX_PLLV3_SYSV2,
>>   	IMX_PLLV3_SYS,
>>   	IMX_PLLV3_USB,
>>   	IMX_PLLV3_USB_VF610,
>> @@ -253,6 +255,8 @@ enum imx_pllv3_type {
>>   	IMX_PLLV3_AV_IMX7,
>>   };
>>
>> +void imx_clk_hw_pll3_powerbit(struct clk_hw *hw, u8 shift);
>> +
>>   struct clk_hw *imx_clk_hw_pllv3(enum imx_pllv3_type type, const char *name,
>>   		const char *parent_name, void __iomem *base, u32 div_mask);
>>
>> --
>> 2.36.1
>>