Re: [PATCH v4 4/5] clk: Ingenic: Add missing clocks for Ingenic SoCs.

Paul Cercueil
2020-12-23T12:30:45Z

Hi Zhou,

Le lun. 21 déc. 2020 à 23:52, 周琰杰 (Zhou Yanjie)
<zhouyanjie@wanyeetech.com> a écrit :
> Add CIM, AIC, DMIC, I2S clocks for the X1000 SoC and the
> X1830 SoC from Ingenic.
>
> Signed-off-by: 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
> ---
>
> Notes:
> v1->v2:
> Add I2S clock for X1000.
>
> v2->v3:
> Correct the comment in x1000-cgu.c, change it from
> "Custom (SoC-specific) OTG PHY" to "Custom (SoC-specific)",
> since there is more than just the "OTG PHY" clock.
>
> v3->v4:
> No change.
>
> drivers/clk/ingenic/x1000-cgu.c | 207
> +++++++++++++++++++++++++++++++++++++++-
> drivers/clk/ingenic/x1830-cgu.c | 207
> +++++++++++++++++++++++++++++++++++++++-
> 2 files changed, 412 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/clk/ingenic/x1000-cgu.c
> b/drivers/clk/ingenic/x1000-cgu.c
> index 53e5fe0..f03dd47 100644
> --- a/drivers/clk/ingenic/x1000-cgu.c
> +++ b/drivers/clk/ingenic/x1000-cgu.c
> @@ -58,6 +58,17 @@
> #define USBPCR1_REFCLKDIV_24 (0x1 << USBPCR1_REFCLKDIV_SHIFT)
> #define USBPCR1_REFCLKDIV_12 (0x0 << USBPCR1_REFCLKDIV_SHIFT)
>
> +/* bits within the I2SCDR register */
> +#define I2SCDR_I2PCS_SHIFT 31
> +#define I2SCDR_I2PCS_MASK (0x1 << I2SCDR_I2PCS_SHIFT)
> +#define I2SCDR_I2CS_SHIFT 30
> +#define I2SCDR_I2CS_MASK (0x1 << I2SCDR_I2CS_SHIFT)
> +#define I2SCDR_I2SDIV_M_SHIFT 13
> +#define I2SCDR_I2SDIV_M_MASK (0x1ff << I2SCDR_I2SDIV_M_SHIFT)
> +#define I2SCDR_I2SDIV_N_SHIFT 0
> +#define I2SCDR_I2SDIV_N_MASK (0x1fff << I2SCDR_I2SDIV_N_SHIFT)
> +#define I2SCDR_CE_I2S BIT(29)
> +
> static struct ingenic_cgu *cgu;
>
> static unsigned long x1000_otg_phy_recalc_rate(struct clk_hw *hw,
> @@ -168,6 +179,175 @@ static const struct clk_ops x1000_otg_phy_ops =
> {
> .is_enabled = x1000_usb_phy_is_enabled,
> };
>
> +static u8 x1000_i2s_get_parent(struct clk_hw *hw)
> +{
> + u32 i2scdr;
> +
> + i2scdr = readl(cgu->base + CGU_REG_I2SCDR);
> +
> + return (i2scdr & (I2SCDR_I2PCS_MASK | I2SCDR_I2CS_MASK)) >>
> I2SCDR_I2CS_SHIFT;
> +}
> +
> +static int x1000_i2s_set_parent(struct clk_hw *hw, u8 idx)
> +{
> + unsigned long flags;
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> + writel(idx << I2SCDR_I2CS_SHIFT, cgu->base + CGU_REG_I2SCDR);
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +
> + return 0;
> +}
> +
> +static unsigned long x1000_i2s_recalc_rate(struct clk_hw *hw,
> + unsigned long parent_rate)
> +{
> + unsigned m, n;
> + u32 i2scdr;
> +
> + i2scdr = readl(cgu->base + CGU_REG_I2SCDR);
> +
> + m = (i2scdr & I2SCDR_I2SDIV_M_MASK) >> I2SCDR_I2SDIV_M_SHIFT;
> + n = (i2scdr & I2SCDR_I2SDIV_N_MASK) >> I2SCDR_I2SDIV_N_SHIFT;
> +
> + return div_u64((u64)parent_rate * m, n);
> +}
> +
> +static unsigned long x1000_i2s_calc(unsigned long rate, unsigned
> long parent_rate,
> + unsigned *pm, unsigned *pn)
> +{
> + u64 curr_delta, curr_m, curr_n, delta, m, n;
> +
> + if ((parent_rate % rate == 0) && ((parent_rate / rate) > 1)) {
> + m = 1;
> + n = parent_rate / rate;
> + goto out;
> + }
> +
> + delta = rate;
> +
> + /*
> + * The length of M is 9 bits, its value must be between 1 and 511.
> + * The length of N is 13 bits, its value must be between 2 and 8191,
> + * and must not be less than 2 times of the value of M.
> + */
> + for (curr_m = 511; curr_m >= 1; curr_m--) {
> + curr_n = parent_rate * curr_m;
> + curr_delta = do_div(curr_n, rate);
> +
> + if (curr_n < 2 * curr_m || curr_n > 8191)
> + continue;
> +
> + if (curr_delta == 0)
> + break;
> +
> + if (curr_delta < delta) {
> + m = curr_m;
> + n = curr_n;
> + delta = curr_delta;
> + }
> + }
> +
> +out:
> + if (pm)
> + *pm = m;
> + if (pn)
> + *pn = n;
> +
> + return div_u64((u64)parent_rate * m, n);
> +}
> +
> +static long x1000_i2s_round_rate(struct clk_hw *hw, unsigned long
> req_rate,
> + unsigned long *prate)
> +{
> + return x1000_i2s_calc(req_rate, *prate, NULL, NULL);
> +}
> +
> +static int x1000_i2s_set_rate(struct clk_hw *hw, unsigned long
> req_rate,
> + unsigned long parent_rate)
> +{
> + unsigned long rate, flags;
> + unsigned m, n;
> + u32 ctl;
> +
> + /*
> + * The parent clock rate of I2S must not be lower than 2 times
> + * of the target clock rate.
> + */
> + if (parent_rate < 2 * req_rate)
> + return -EINVAL;
> +
> + rate = x1000_i2s_calc(req_rate, parent_rate, &m, &n);
> + if (rate != req_rate)
> + pr_info("%s: request I2S rate %luHz, actual %luHz\n", __func__,
> + req_rate, rate);
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> + ctl &= ~I2SCDR_I2SDIV_M_MASK;
> + ctl |= m << I2SCDR_I2SDIV_M_SHIFT;
> + ctl &= ~I2SCDR_I2SDIV_N_MASK;
> + ctl |= n << I2SCDR_I2SDIV_N_SHIFT;
> + writel(ctl, cgu->base + CGU_REG_I2SCDR);
> +
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +
> + return 0;
> +}
> +
> +static int x1000_i2s_enable(struct clk_hw *hw)
> +{
> + unsigned long flags;
> + u32 ctl;
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> + ctl |= I2SCDR_CE_I2S;
> + writel(ctl, cgu->base + CGU_REG_I2SCDR);
> +
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +
> + return 0;
> +}
> +
> +static void x1000_i2s_disable(struct clk_hw *hw)
> +{
> + unsigned long flags;
> + u32 ctl;
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> + ctl &= ~I2SCDR_CE_I2S;
> + writel(ctl, cgu->base + CGU_REG_I2SCDR);
> +
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +}
> +
> +static int x1000_i2s_is_enabled(struct clk_hw *hw)
> +{
> + u32 ctl;
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> +
> + return !!(ctl & I2SCDR_CE_I2S);
> +}
> +
> +static const struct clk_ops x1000_i2s_ops = {
> + .get_parent = x1000_i2s_get_parent,
> + .set_parent = x1000_i2s_set_parent,
> +
> + .recalc_rate = x1000_i2s_recalc_rate,
> + .round_rate = x1000_i2s_round_rate,
> + .set_rate = x1000_i2s_set_rate,
> +
> + .enable = x1000_i2s_enable,
> + .disable = x1000_i2s_disable,
> + .is_enabled = x1000_i2s_is_enabled,
> +};
> +
> static const s8 pll_od_encoding[8] = {
> 0x0, 0x1, -1, 0x2, -1, -1, -1, 0x3,
> };
> @@ -227,7 +407,7 @@ static const struct ingenic_cgu_clk_info
> x1000_cgu_clocks[] = {
> },
> },
>
> - /* Custom (SoC-specific) OTG PHY */
> + /* Custom (SoC-specific) */
>
> [X1000_CLK_OTGPHY] = {
> "otg_phy", CGU_CLK_CUSTOM,
> @@ -235,6 +415,12 @@ static const struct ingenic_cgu_clk_info
> x1000_cgu_clocks[] = {
> .custom = { &x1000_otg_phy_ops },
> },
>
> + [X1000_CLK_I2S] = {
> + "i2s", CGU_CLK_CUSTOM,
> + .parents = { X1000_CLK_EXCLK, X1000_CLK_SCLKA, -1, X1000_CLK_MPLL
> },
> + .custom = { &x1000_i2s_ops },
> + },

I still think this should be a PLL - even though we have to update the
PLL code in cgu.c. I am working on JZ4760 support now, and the PLLs
require M>=4 and N>=2. We could have for instance a (*calc_m_n_od)()
callback that would be called in ingenic_pll_calc().

Cheers,
-Paul

> +
> /* Muxes & dividers */
>
> [X1000_CLK_SCLKA] = {
> @@ -359,6 +545,13 @@ static const struct ingenic_cgu_clk_info
> x1000_cgu_clocks[] = {
> .mux = { CGU_REG_SSICDR, 30, 1 },
> },
>
> + [X1000_CLK_CIM] = {
> + "cim", CGU_CLK_MUX | CGU_CLK_DIV,
> + .parents = { X1000_CLK_SCLKA, X1000_CLK_MPLL, -1, -1 },
> + .mux = { CGU_REG_CIMCDR, 31, 1 },
> + .div = { CGU_REG_CIMCDR, 0, 1, 8, 29, 28, 27 },
> + },
> +
> [X1000_CLK_EXCLK_DIV512] = {
> "exclk_div512", CGU_CLK_FIXDIV,
> .parents = { X1000_CLK_EXCLK },
> @@ -410,6 +603,12 @@ static const struct ingenic_cgu_clk_info
> x1000_cgu_clocks[] = {
> .gate = { CGU_REG_CLKGR, 9 },
> },
>
> + [X1000_CLK_AIC] = {
> + "aic", CGU_CLK_GATE,
> + .parents = { X1000_CLK_EXCLK, -1, -1, -1 },
> + .gate = { CGU_REG_CLKGR, 11 },
> + },
> +
> [X1000_CLK_UART0] = {
> "uart0", CGU_CLK_GATE,
> .parents = { X1000_CLK_EXCLK, -1, -1, -1 },
> @@ -428,6 +627,12 @@ static const struct ingenic_cgu_clk_info
> x1000_cgu_clocks[] = {
> .gate = { CGU_REG_CLKGR, 16 },
> },
>
> + [X1000_CLK_DMIC] = {
> + "dmic", CGU_CLK_GATE,
> + .parents = { X1000_CLK_PCLK, -1, -1, -1 },
> + .gate = { CGU_REG_CLKGR, 17 },
> + },
> +
> [X1000_CLK_TCU] = {
> "tcu", CGU_CLK_GATE,
> .parents = { X1000_CLK_EXCLK, -1, -1, -1 },
> diff --git a/drivers/clk/ingenic/x1830-cgu.c
> b/drivers/clk/ingenic/x1830-cgu.c
> index 59342bc..d93cefa 100644
> --- a/drivers/clk/ingenic/x1830-cgu.c
> +++ b/drivers/clk/ingenic/x1830-cgu.c
> @@ -52,6 +52,15 @@
> #define USBPCR_SIDDQ BIT(21)
> #define USBPCR_OTG_DISABLE BIT(20)
>
> +/* bits within the I2SCDR register */
> +#define I2SCDR_I2PCS_SHIFT 30
> +#define I2SCDR_I2PCS_MASK (0x3 << I2SCDR_I2PCS_SHIFT)
> +#define I2SCDR_I2SDIV_M_SHIFT 20
> +#define I2SCDR_I2SDIV_M_MASK (0x1ff << I2SCDR_I2SDIV_M_SHIFT)
> +#define I2SCDR_I2SDIV_N_SHIFT 0
> +#define I2SCDR_I2SDIV_N_MASK (0xfffff << I2SCDR_I2SDIV_N_SHIFT)
> +#define I2SCDR_CE_I2S BIT(29)
> +
> static struct ingenic_cgu *cgu;
>
> static int x1830_usb_phy_enable(struct clk_hw *hw)
> @@ -89,6 +98,175 @@ static const struct clk_ops x1830_otg_phy_ops = {
> .is_enabled = x1830_usb_phy_is_enabled,
> };
>
> +static u8 x1830_i2s_get_parent(struct clk_hw *hw)
> +{
> + u32 i2scdr;
> +
> + i2scdr = readl(cgu->base + CGU_REG_I2SCDR);
> +
> + return (i2scdr & I2SCDR_I2PCS_MASK) >> I2SCDR_I2PCS_SHIFT;
> +}
> +
> +static int x1830_i2s_set_parent(struct clk_hw *hw, u8 idx)
> +{
> + unsigned long flags;
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> + writel(idx << I2SCDR_I2PCS_SHIFT, cgu->base + CGU_REG_I2SCDR);
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +
> + return 0;
> +}
> +
> +static unsigned long x1830_i2s_recalc_rate(struct clk_hw *hw,
> + unsigned long parent_rate)
> +{
> + unsigned m, n;
> + u32 i2scdr;
> +
> + i2scdr = readl(cgu->base + CGU_REG_I2SCDR);
> +
> + m = (i2scdr & I2SCDR_I2SDIV_M_MASK) >> I2SCDR_I2SDIV_M_SHIFT;
> + n = (i2scdr & I2SCDR_I2SDIV_N_MASK) >> I2SCDR_I2SDIV_N_SHIFT;
> +
> + return div_u64((u64)parent_rate * m, n);
> +}
> +
> +static unsigned long x1830_i2s_calc(unsigned long rate, unsigned
> long parent_rate,
> + unsigned *pm, unsigned *pn)
> +{
> + u64 curr_delta, curr_m, curr_n, delta, m, n;
> +
> + if ((parent_rate % rate == 0) && ((parent_rate / rate) > 1)) {
> + m = 1;
> + n = parent_rate / rate;
> + goto out;
> + }
> +
> + delta = rate;
> +
> + /*
> + * The length of M is 9 bits, its value must be between 1 and 511.
> + * The length of N is 20 bits, its value must be between 2 and
> 1048575,
> + * and must not be less than 2 times of the value of M.
> + */
> + for (curr_m = 511; curr_m >= 1; curr_m--) {
> + curr_n = parent_rate * curr_m;
> + curr_delta = do_div(curr_n, rate);
> +
> + if (curr_n < 2 * curr_m || curr_n > 1048575)
> + continue;
> +
> + if (curr_delta == 0)
> + break;
> +
> + if (curr_delta < delta) {
> + m = curr_m;
> + n = curr_n;
> + delta = curr_delta;
> + }
> + }
> +
> +out:
> + if (pm)
> + *pm = m;
> + if (pn)
> + *pn = n;
> +
> + return div_u64((u64)parent_rate * m, n);
> +}
> +
> +static long x1830_i2s_round_rate(struct clk_hw *hw, unsigned long
> req_rate,
> + unsigned long *prate)
> +{
> + return x1830_i2s_calc(req_rate, *prate, NULL, NULL);
> +}
> +
> +static int x1830_i2s_set_rate(struct clk_hw *hw, unsigned long
> req_rate,
> + unsigned long parent_rate)
> +{
> + unsigned long rate, flags;
> + unsigned m, n;
> + u32 ctl;
> +
> + /*
> + * The parent clock rate of I2S must not be lower than 2 times
> + * of the target clock rate.
> + */
> + if (parent_rate < 2 * req_rate)
> + return -EINVAL;
> +
> + rate = x1830_i2s_calc(req_rate, parent_rate, &m, &n);
> + if (rate != req_rate)
> + pr_info("%s: request I2S rate %luHz, actual %luHz\n", __func__,
> + req_rate, rate);
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> + ctl &= ~I2SCDR_I2SDIV_M_MASK;
> + ctl |= m << I2SCDR_I2SDIV_M_SHIFT;
> + ctl &= ~I2SCDR_I2SDIV_N_MASK;
> + ctl |= n << I2SCDR_I2SDIV_N_SHIFT;
> + writel(ctl, cgu->base + CGU_REG_I2SCDR);
> +
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +
> + return 0;
> +}
> +
> +static int x1830_i2s_enable(struct clk_hw *hw)
> +{
> + unsigned long flags;
> + u32 ctl;
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> + ctl |= I2SCDR_CE_I2S;
> + writel(ctl, cgu->base + CGU_REG_I2SCDR);
> +
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +
> + return 0;
> +}
> +
> +static void x1830_i2s_disable(struct clk_hw *hw)
> +{
> + unsigned long flags;
> + u32 ctl;
> +
> + spin_lock_irqsave(&cgu->lock, flags);
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> + ctl &= ~I2SCDR_CE_I2S;
> + writel(ctl, cgu->base + CGU_REG_I2SCDR);
> +
> + spin_unlock_irqrestore(&cgu->lock, flags);
> +}
> +
> +static int x1830_i2s_is_enabled(struct clk_hw *hw)
> +{
> + u32 ctl;
> +
> + ctl = readl(cgu->base + CGU_REG_I2SCDR);
> +
> + return !!(ctl & I2SCDR_CE_I2S);
> +}
> +
> +static const struct clk_ops x1830_i2s_ops = {
> + .get_parent = x1830_i2s_get_parent,
> + .set_parent = x1830_i2s_set_parent,
> +
> + .recalc_rate = x1830_i2s_recalc_rate,
> + .round_rate = x1830_i2s_round_rate,
> + .set_rate = x1830_i2s_set_rate,
> +
> + .enable = x1830_i2s_enable,
> + .disable = x1830_i2s_disable,
> + .is_enabled = x1830_i2s_is_enabled,
> +};
> +
> static const s8 pll_od_encoding[64] = {
> 0x0, 0x1, -1, 0x2, -1, -1, -1, 0x3,
> -1, -1, -1, -1, -1, -1, -1, 0x4,
> @@ -201,7 +379,7 @@ static const struct ingenic_cgu_clk_info
> x1830_cgu_clocks[] = {
> },
> },
>
> - /* Custom (SoC-specific) OTG PHY */
> + /* Custom (SoC-specific) */
>
> [X1830_CLK_OTGPHY] = {
> "otg_phy", CGU_CLK_CUSTOM,
> @@ -209,6 +387,13 @@ static const struct ingenic_cgu_clk_info
> x1830_cgu_clocks[] = {
> .custom = { &x1830_otg_phy_ops },
> },
>
> + [X1830_CLK_I2S] = {
> + "i2s", CGU_CLK_CUSTOM,
> + .parents = { X1830_CLK_SCLKA, X1830_CLK_MPLL,
> + X1830_CLK_VPLL, X1830_CLK_EPLL },
> + .custom = { &x1830_i2s_ops },
> + },
> +
> /* Muxes & dividers */
>
> [X1830_CLK_SCLKA] = {
> @@ -328,6 +513,14 @@ static const struct ingenic_cgu_clk_info
> x1830_cgu_clocks[] = {
> .mux = { CGU_REG_SSICDR, 29, 1 },
> },
>
> + [X1830_CLK_CIM] = {
> + "cim", CGU_CLK_MUX | CGU_CLK_DIV,
> + .parents = { X1830_CLK_SCLKA, X1830_CLK_MPLL,
> + X1830_CLK_VPLL, X1830_CLK_EPLL },
> + .mux = { CGU_REG_CIMCDR, 30, 2 },
> + .div = { CGU_REG_CIMCDR, 0, 1, 8, 29, 28, 27 },
> + },
> +
> [X1830_CLK_EXCLK_DIV512] = {
> "exclk_div512", CGU_CLK_FIXDIV,
> .parents = { X1830_CLK_EXCLK },
> @@ -385,6 +578,18 @@ static const struct ingenic_cgu_clk_info
> x1830_cgu_clocks[] = {
> .gate = { CGU_REG_CLKGR0, 9 },
> },
>
> + [X1830_CLK_AIC] = {
> + "aic", CGU_CLK_GATE,
> + .parents = { X1830_CLK_EXCLK, -1, -1, -1 },
> + .gate = { CGU_REG_CLKGR0, 11 },
> + },
> +
> + [X1830_CLK_DMIC] = {
> + "dmic", CGU_CLK_GATE,
> + .parents = { X1830_CLK_PCLK, -1, -1, -1 },
> + .gate = { CGU_REG_CLKGR0, 12 },
> + },
> +
> [X1830_CLK_UART0] = {
> "uart0", CGU_CLK_GATE,
> .parents = { X1830_CLK_EXCLK, -1, -1, -1 },
> --
> 2.7.4
>