Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0
0002 /*
0003  * Copyright 2017-2018 NXP.
0004  */
0005 
0006 #define pr_fmt(fmt) "pll14xx: " fmt
0007 
0008 #include <linux/bitfield.h>
0009 #include <linux/bits.h>
0010 #include <linux/clk-provider.h>
0011 #include <linux/err.h>
0012 #include <linux/export.h>
0013 #include <linux/io.h>
0014 #include <linux/iopoll.h>
0015 #include <linux/slab.h>
0016 #include <linux/jiffies.h>
0017 
0018 #include "clk.h"
0019 
0020 #define GNRL_CTL    0x0
0021 #define DIV_CTL0    0x4
0022 #define DIV_CTL1    0x8
0023 #define LOCK_STATUS BIT(31)
0024 #define LOCK_SEL_MASK   BIT(29)
0025 #define CLKE_MASK   BIT(11)
0026 #define RST_MASK    BIT(9)
0027 #define BYPASS_MASK BIT(4)
0028 #define MDIV_MASK   GENMASK(21, 12)
0029 #define PDIV_MASK   GENMASK(9, 4)
0030 #define SDIV_MASK   GENMASK(2, 0)
0031 #define KDIV_MASK   GENMASK(15, 0)
0032 #define KDIV_MIN    SHRT_MIN
0033 #define KDIV_MAX    SHRT_MAX
0034 
0035 #define LOCK_TIMEOUT_US     10000
0036 
0037 struct clk_pll14xx {
0038     struct clk_hw           hw;
0039     void __iomem            *base;
0040     enum imx_pll14xx_type       type;
0041     const struct imx_pll14xx_rate_table *rate_table;
0042     int rate_count;
0043 };
0044 
0045 #define to_clk_pll14xx(_hw) container_of(_hw, struct clk_pll14xx, hw)
0046 
0047 static const struct imx_pll14xx_rate_table imx_pll1416x_tbl[] = {
0048     PLL_1416X_RATE(1800000000U, 225, 3, 0),
0049     PLL_1416X_RATE(1600000000U, 200, 3, 0),
0050     PLL_1416X_RATE(1500000000U, 375, 3, 1),
0051     PLL_1416X_RATE(1400000000U, 350, 3, 1),
0052     PLL_1416X_RATE(1200000000U, 300, 3, 1),
0053     PLL_1416X_RATE(1000000000U, 250, 3, 1),
0054     PLL_1416X_RATE(800000000U,  200, 3, 1),
0055     PLL_1416X_RATE(750000000U,  250, 2, 2),
0056     PLL_1416X_RATE(700000000U,  350, 3, 2),
0057     PLL_1416X_RATE(600000000U,  300, 3, 2),
0058 };
0059 
0060 static const struct imx_pll14xx_rate_table imx_pll1443x_tbl[] = {
0061     PLL_1443X_RATE(1039500000U, 173, 2, 1, 16384),
0062     PLL_1443X_RATE(650000000U, 325, 3, 2, 0),
0063     PLL_1443X_RATE(594000000U, 198, 2, 2, 0),
0064     PLL_1443X_RATE(519750000U, 173, 2, 2, 16384),
0065     PLL_1443X_RATE(393216000U, 262, 2, 3, 9437),
0066     PLL_1443X_RATE(361267200U, 361, 3, 3, 17511),
0067 };
0068 
0069 struct imx_pll14xx_clk imx_1443x_pll = {
0070     .type = PLL_1443X,
0071     .rate_table = imx_pll1443x_tbl,
0072     .rate_count = ARRAY_SIZE(imx_pll1443x_tbl),
0073 };
0074 EXPORT_SYMBOL_GPL(imx_1443x_pll);
0075 
0076 struct imx_pll14xx_clk imx_1443x_dram_pll = {
0077     .type = PLL_1443X,
0078     .rate_table = imx_pll1443x_tbl,
0079     .rate_count = ARRAY_SIZE(imx_pll1443x_tbl),
0080     .flags = CLK_GET_RATE_NOCACHE,
0081 };
0082 EXPORT_SYMBOL_GPL(imx_1443x_dram_pll);
0083 
0084 struct imx_pll14xx_clk imx_1416x_pll = {
0085     .type = PLL_1416X,
0086     .rate_table = imx_pll1416x_tbl,
0087     .rate_count = ARRAY_SIZE(imx_pll1416x_tbl),
0088 };
0089 EXPORT_SYMBOL_GPL(imx_1416x_pll);
0090 
0091 static const struct imx_pll14xx_rate_table *imx_get_pll_settings(
0092         struct clk_pll14xx *pll, unsigned long rate)
0093 {
0094     const struct imx_pll14xx_rate_table *rate_table = pll->rate_table;
0095     int i;
0096 
0097     for (i = 0; i < pll->rate_count; i++)
0098         if (rate == rate_table[i].rate)
0099             return &rate_table[i];
0100 
0101     return NULL;
0102 }
0103 
0104 static long pll14xx_calc_rate(struct clk_pll14xx *pll, int mdiv, int pdiv,
0105                   int sdiv, int kdiv, unsigned long prate)
0106 {
0107     u64 fvco = prate;
0108 
0109     /* fvco = (m * 65536 + k) * Fin / (p * 65536) */
0110     fvco *= (mdiv * 65536 + kdiv);
0111     pdiv *= 65536;
0112 
0113     do_div(fvco, pdiv << sdiv);
0114 
0115     return fvco;
0116 }
0117 
0118 static long pll1443x_calc_kdiv(int mdiv, int pdiv, int sdiv,
0119         unsigned long rate, unsigned long prate)
0120 {
0121     long kdiv;
0122 
0123     /* calc kdiv = round(rate * pdiv * 65536 * 2^sdiv / prate) - (mdiv * 65536) */
0124     kdiv = ((rate * ((pdiv * 65536) << sdiv) + prate / 2) / prate) - (mdiv * 65536);
0125 
0126     return clamp_t(short, kdiv, KDIV_MIN, KDIV_MAX);
0127 }
0128 
0129 static void imx_pll14xx_calc_settings(struct clk_pll14xx *pll, unsigned long rate,
0130                       unsigned long prate, struct imx_pll14xx_rate_table *t)
0131 {
0132     u32 pll_div_ctl0, pll_div_ctl1;
0133     int mdiv, pdiv, sdiv, kdiv;
0134     long fvco, rate_min, rate_max, dist, best = LONG_MAX;
0135     const struct imx_pll14xx_rate_table *tt;
0136 
0137     /*
0138      * Fractional PLL constrains:
0139      *
0140      * a) 6MHz <= prate <= 25MHz
0141      * b) 1 <= p <= 63 (1 <= p <= 4 prate = 24MHz)
0142      * c) 64 <= m <= 1023
0143      * d) 0 <= s <= 6
0144      * e) -32768 <= k <= 32767
0145      *
0146      * fvco = (m * 65536 + k) * prate / (p * 65536)
0147      */
0148 
0149     /* First try if we can get the desired rate from one of the static entries */
0150     tt = imx_get_pll_settings(pll, rate);
0151     if (tt) {
0152         pr_debug("%s: in=%ld, want=%ld, Using PLL setting from table\n",
0153              clk_hw_get_name(&pll->hw), prate, rate);
0154         t->rate = tt->rate;
0155         t->mdiv = tt->mdiv;
0156         t->pdiv = tt->pdiv;
0157         t->sdiv = tt->sdiv;
0158         t->kdiv = tt->kdiv;
0159         return;
0160     }
0161 
0162     pll_div_ctl0 = readl_relaxed(pll->base + DIV_CTL0);
0163     mdiv = FIELD_GET(MDIV_MASK, pll_div_ctl0);
0164     pdiv = FIELD_GET(PDIV_MASK, pll_div_ctl0);
0165     sdiv = FIELD_GET(SDIV_MASK, pll_div_ctl0);
0166     pll_div_ctl1 = readl_relaxed(pll->base + DIV_CTL1);
0167 
0168     /* Then see if we can get the desired rate by only adjusting kdiv (glitch free) */
0169     rate_min = pll14xx_calc_rate(pll, mdiv, pdiv, sdiv, KDIV_MIN, prate);
0170     rate_max = pll14xx_calc_rate(pll, mdiv, pdiv, sdiv, KDIV_MAX, prate);
0171 
0172     if (rate >= rate_min && rate <= rate_max) {
0173         kdiv = pll1443x_calc_kdiv(mdiv, pdiv, sdiv, rate, prate);
0174         pr_debug("%s: in=%ld, want=%ld Only adjust kdiv %ld -> %d\n",
0175              clk_hw_get_name(&pll->hw), prate, rate,
0176              FIELD_GET(KDIV_MASK, pll_div_ctl1), kdiv);
0177         fvco = pll14xx_calc_rate(pll, mdiv, pdiv, sdiv, kdiv, prate);
0178         t->rate = (unsigned int)fvco;
0179         t->mdiv = mdiv;
0180         t->pdiv = pdiv;
0181         t->sdiv = sdiv;
0182         t->kdiv = kdiv;
0183         return;
0184     }
0185 
0186     /* Finally calculate best values */
0187     for (pdiv = 1; pdiv <= 7; pdiv++) {
0188         for (sdiv = 0; sdiv <= 6; sdiv++) {
0189             /* calc mdiv = round(rate * pdiv * 2^sdiv) / prate) */
0190             mdiv = DIV_ROUND_CLOSEST(rate * (pdiv << sdiv), prate);
0191             mdiv = clamp(mdiv, 64, 1023);
0192 
0193             kdiv = pll1443x_calc_kdiv(mdiv, pdiv, sdiv, rate, prate);
0194             fvco = pll14xx_calc_rate(pll, mdiv, pdiv, sdiv, kdiv, prate);
0195 
0196             /* best match */
0197             dist = abs((long)rate - (long)fvco);
0198             if (dist < best) {
0199                 best = dist;
0200                 t->rate = (unsigned int)fvco;
0201                 t->mdiv = mdiv;
0202                 t->pdiv = pdiv;
0203                 t->sdiv = sdiv;
0204                 t->kdiv = kdiv;
0205 
0206                 if (!dist)
0207                     goto found;
0208             }
0209         }
0210     }
0211 found:
0212     pr_debug("%s: in=%ld, want=%ld got=%d (pdiv=%d sdiv=%d mdiv=%d kdiv=%d)\n",
0213          clk_hw_get_name(&pll->hw), prate, rate, t->rate, t->pdiv, t->sdiv,
0214          t->mdiv, t->kdiv);
0215 }
0216 
0217 static long clk_pll1416x_round_rate(struct clk_hw *hw, unsigned long rate,
0218             unsigned long *prate)
0219 {
0220     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0221     const struct imx_pll14xx_rate_table *rate_table = pll->rate_table;
0222     int i;
0223 
0224     /* Assuming rate_table is in descending order */
0225     for (i = 0; i < pll->rate_count; i++)
0226         if (rate >= rate_table[i].rate)
0227             return rate_table[i].rate;
0228 
0229     /* return minimum supported value */
0230     return rate_table[pll->rate_count - 1].rate;
0231 }
0232 
0233 static long clk_pll1443x_round_rate(struct clk_hw *hw, unsigned long rate,
0234             unsigned long *prate)
0235 {
0236     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0237     struct imx_pll14xx_rate_table t;
0238 
0239     imx_pll14xx_calc_settings(pll, rate, *prate, &t);
0240 
0241     return t.rate;
0242 }
0243 
0244 static unsigned long clk_pll14xx_recalc_rate(struct clk_hw *hw,
0245                           unsigned long parent_rate)
0246 {
0247     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0248     u32 mdiv, pdiv, sdiv, kdiv, pll_div_ctl0, pll_div_ctl1;
0249 
0250     pll_div_ctl0 = readl_relaxed(pll->base + DIV_CTL0);
0251     mdiv = FIELD_GET(MDIV_MASK, pll_div_ctl0);
0252     pdiv = FIELD_GET(PDIV_MASK, pll_div_ctl0);
0253     sdiv = FIELD_GET(SDIV_MASK, pll_div_ctl0);
0254 
0255     if (pll->type == PLL_1443X) {
0256         pll_div_ctl1 = readl_relaxed(pll->base + DIV_CTL1);
0257         kdiv = FIELD_GET(KDIV_MASK, pll_div_ctl1);
0258     } else {
0259         kdiv = 0;
0260     }
0261 
0262     return pll14xx_calc_rate(pll, mdiv, pdiv, sdiv, kdiv, parent_rate);
0263 }
0264 
0265 static inline bool clk_pll14xx_mp_change(const struct imx_pll14xx_rate_table *rate,
0266                       u32 pll_div)
0267 {
0268     u32 old_mdiv, old_pdiv;
0269 
0270     old_mdiv = FIELD_GET(MDIV_MASK, pll_div);
0271     old_pdiv = FIELD_GET(PDIV_MASK, pll_div);
0272 
0273     return rate->mdiv != old_mdiv || rate->pdiv != old_pdiv;
0274 }
0275 
0276 static int clk_pll14xx_wait_lock(struct clk_pll14xx *pll)
0277 {
0278     u32 val;
0279 
0280     return readl_poll_timeout(pll->base + GNRL_CTL, val, val & LOCK_STATUS, 0,
0281             LOCK_TIMEOUT_US);
0282 }
0283 
0284 static int clk_pll1416x_set_rate(struct clk_hw *hw, unsigned long drate,
0285                  unsigned long prate)
0286 {
0287     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0288     const struct imx_pll14xx_rate_table *rate;
0289     u32 tmp, div_val;
0290     int ret;
0291 
0292     rate = imx_get_pll_settings(pll, drate);
0293     if (!rate) {
0294         pr_err("Invalid rate %lu for pll clk %s\n", drate,
0295                clk_hw_get_name(hw));
0296         return -EINVAL;
0297     }
0298 
0299     tmp = readl_relaxed(pll->base + DIV_CTL0);
0300 
0301     if (!clk_pll14xx_mp_change(rate, tmp)) {
0302         tmp &= ~SDIV_MASK;
0303         tmp |= FIELD_PREP(SDIV_MASK, rate->sdiv);
0304         writel_relaxed(tmp, pll->base + DIV_CTL0);
0305 
0306         return 0;
0307     }
0308 
0309     /* Bypass clock and set lock to pll output lock */
0310     tmp = readl_relaxed(pll->base + GNRL_CTL);
0311     tmp |= LOCK_SEL_MASK;
0312     writel_relaxed(tmp, pll->base + GNRL_CTL);
0313 
0314     /* Enable RST */
0315     tmp &= ~RST_MASK;
0316     writel_relaxed(tmp, pll->base + GNRL_CTL);
0317 
0318     /* Enable BYPASS */
0319     tmp |= BYPASS_MASK;
0320     writel(tmp, pll->base + GNRL_CTL);
0321 
0322     div_val = FIELD_PREP(MDIV_MASK, rate->mdiv) | FIELD_PREP(PDIV_MASK, rate->pdiv) |
0323         FIELD_PREP(SDIV_MASK, rate->sdiv);
0324     writel_relaxed(div_val, pll->base + DIV_CTL0);
0325 
0326     /*
0327      * According to SPEC, t3 - t2 need to be greater than
0328      * 1us and 1/FREF, respectively.
0329      * FREF is FIN / Prediv, the prediv is [1, 63], so choose
0330      * 3us.
0331      */
0332     udelay(3);
0333 
0334     /* Disable RST */
0335     tmp |= RST_MASK;
0336     writel_relaxed(tmp, pll->base + GNRL_CTL);
0337 
0338     /* Wait Lock */
0339     ret = clk_pll14xx_wait_lock(pll);
0340     if (ret)
0341         return ret;
0342 
0343     /* Bypass */
0344     tmp &= ~BYPASS_MASK;
0345     writel_relaxed(tmp, pll->base + GNRL_CTL);
0346 
0347     return 0;
0348 }
0349 
0350 static int clk_pll1443x_set_rate(struct clk_hw *hw, unsigned long drate,
0351                  unsigned long prate)
0352 {
0353     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0354     struct imx_pll14xx_rate_table rate;
0355     u32 gnrl_ctl, div_ctl0;
0356     int ret;
0357 
0358     imx_pll14xx_calc_settings(pll, drate, prate, &rate);
0359 
0360     div_ctl0 = readl_relaxed(pll->base + DIV_CTL0);
0361 
0362     if (!clk_pll14xx_mp_change(&rate, div_ctl0)) {
0363         /* only sdiv and/or kdiv changed - no need to RESET PLL */
0364         div_ctl0 &= ~SDIV_MASK;
0365         div_ctl0 |= FIELD_PREP(SDIV_MASK, rate.sdiv);
0366         writel_relaxed(div_ctl0, pll->base + DIV_CTL0);
0367 
0368         writel_relaxed(FIELD_PREP(KDIV_MASK, rate.kdiv),
0369                    pll->base + DIV_CTL1);
0370 
0371         return 0;
0372     }
0373 
0374     /* Enable RST */
0375     gnrl_ctl = readl_relaxed(pll->base + GNRL_CTL);
0376     gnrl_ctl &= ~RST_MASK;
0377     writel_relaxed(gnrl_ctl, pll->base + GNRL_CTL);
0378 
0379     /* Enable BYPASS */
0380     gnrl_ctl |= BYPASS_MASK;
0381     writel_relaxed(gnrl_ctl, pll->base + GNRL_CTL);
0382 
0383     div_ctl0 = FIELD_PREP(MDIV_MASK, rate.mdiv) |
0384            FIELD_PREP(PDIV_MASK, rate.pdiv) |
0385            FIELD_PREP(SDIV_MASK, rate.sdiv);
0386     writel_relaxed(div_ctl0, pll->base + DIV_CTL0);
0387 
0388     writel_relaxed(FIELD_PREP(KDIV_MASK, rate.kdiv), pll->base + DIV_CTL1);
0389 
0390     /*
0391      * According to SPEC, t3 - t2 need to be greater than
0392      * 1us and 1/FREF, respectively.
0393      * FREF is FIN / Prediv, the prediv is [1, 63], so choose
0394      * 3us.
0395      */
0396     udelay(3);
0397 
0398     /* Disable RST */
0399     gnrl_ctl |= RST_MASK;
0400     writel_relaxed(gnrl_ctl, pll->base + GNRL_CTL);
0401 
0402     /* Wait Lock*/
0403     ret = clk_pll14xx_wait_lock(pll);
0404     if (ret)
0405         return ret;
0406 
0407     /* Bypass */
0408     gnrl_ctl &= ~BYPASS_MASK;
0409     writel_relaxed(gnrl_ctl, pll->base + GNRL_CTL);
0410 
0411     return 0;
0412 }
0413 
0414 static int clk_pll14xx_prepare(struct clk_hw *hw)
0415 {
0416     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0417     u32 val;
0418     int ret;
0419 
0420     /*
0421      * RESETB = 1 from 0, PLL starts its normal
0422      * operation after lock time
0423      */
0424     val = readl_relaxed(pll->base + GNRL_CTL);
0425     if (val & RST_MASK)
0426         return 0;
0427     val |= BYPASS_MASK;
0428     writel_relaxed(val, pll->base + GNRL_CTL);
0429     val |= RST_MASK;
0430     writel_relaxed(val, pll->base + GNRL_CTL);
0431 
0432     ret = clk_pll14xx_wait_lock(pll);
0433     if (ret)
0434         return ret;
0435 
0436     val &= ~BYPASS_MASK;
0437     writel_relaxed(val, pll->base + GNRL_CTL);
0438 
0439     return 0;
0440 }
0441 
0442 static int clk_pll14xx_is_prepared(struct clk_hw *hw)
0443 {
0444     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0445     u32 val;
0446 
0447     val = readl_relaxed(pll->base + GNRL_CTL);
0448 
0449     return (val & RST_MASK) ? 1 : 0;
0450 }
0451 
0452 static void clk_pll14xx_unprepare(struct clk_hw *hw)
0453 {
0454     struct clk_pll14xx *pll = to_clk_pll14xx(hw);
0455     u32 val;
0456 
0457     /*
0458      * Set RST to 0, power down mode is enabled and
0459      * every digital block is reset
0460      */
0461     val = readl_relaxed(pll->base + GNRL_CTL);
0462     val &= ~RST_MASK;
0463     writel_relaxed(val, pll->base + GNRL_CTL);
0464 }
0465 
0466 static const struct clk_ops clk_pll1416x_ops = {
0467     .prepare    = clk_pll14xx_prepare,
0468     .unprepare  = clk_pll14xx_unprepare,
0469     .is_prepared    = clk_pll14xx_is_prepared,
0470     .recalc_rate    = clk_pll14xx_recalc_rate,
0471     .round_rate = clk_pll1416x_round_rate,
0472     .set_rate   = clk_pll1416x_set_rate,
0473 };
0474 
0475 static const struct clk_ops clk_pll1416x_min_ops = {
0476     .recalc_rate    = clk_pll14xx_recalc_rate,
0477 };
0478 
0479 static const struct clk_ops clk_pll1443x_ops = {
0480     .prepare    = clk_pll14xx_prepare,
0481     .unprepare  = clk_pll14xx_unprepare,
0482     .is_prepared    = clk_pll14xx_is_prepared,
0483     .recalc_rate    = clk_pll14xx_recalc_rate,
0484     .round_rate = clk_pll1443x_round_rate,
0485     .set_rate   = clk_pll1443x_set_rate,
0486 };
0487 
0488 struct clk_hw *imx_dev_clk_hw_pll14xx(struct device *dev, const char *name,
0489                 const char *parent_name, void __iomem *base,
0490                 const struct imx_pll14xx_clk *pll_clk)
0491 {
0492     struct clk_pll14xx *pll;
0493     struct clk_hw *hw;
0494     struct clk_init_data init;
0495     int ret;
0496     u32 val;
0497 
0498     pll = kzalloc(sizeof(*pll), GFP_KERNEL);
0499     if (!pll)
0500         return ERR_PTR(-ENOMEM);
0501 
0502     init.name = name;
0503     init.flags = pll_clk->flags;
0504     init.parent_names = &parent_name;
0505     init.num_parents = 1;
0506 
0507     switch (pll_clk->type) {
0508     case PLL_1416X:
0509         if (!pll_clk->rate_table)
0510             init.ops = &clk_pll1416x_min_ops;
0511         else
0512             init.ops = &clk_pll1416x_ops;
0513         break;
0514     case PLL_1443X:
0515         init.ops = &clk_pll1443x_ops;
0516         break;
0517     default:
0518         pr_err("Unknown pll type for pll clk %s\n", name);
0519         kfree(pll);
0520         return ERR_PTR(-EINVAL);
0521     }
0522 
0523     pll->base = base;
0524     pll->hw.init = &init;
0525     pll->type = pll_clk->type;
0526     pll->rate_table = pll_clk->rate_table;
0527     pll->rate_count = pll_clk->rate_count;
0528 
0529     val = readl_relaxed(pll->base + GNRL_CTL);
0530     val &= ~BYPASS_MASK;
0531     writel_relaxed(val, pll->base + GNRL_CTL);
0532 
0533     hw = &pll->hw;
0534 
0535     ret = clk_hw_register(dev, hw);
0536     if (ret) {
0537         pr_err("failed to register pll %s %d\n", name, ret);
0538         kfree(pll);
0539         return ERR_PTR(ret);
0540     }
0541 
0542     return hw;
0543 }
0544 EXPORT_SYMBOL_GPL(imx_dev_clk_hw_pll14xx);