drivers/clk/clk-hsdk-cgu.c

   1 /*
   2  * Synopsys HSDK SDP CGU clock driver
   3  *
   4  * Copyright (C) 2017 Synopsys
   5  * Author: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com>
   6  *
   7  * This file is licensed under the terms of the GNU General Public
   8  * License version 2. This program is licensed "as is" without any
   9  * warranty of any kind, whether express or implied.
  10  */
  11
  12 #include <common.h>
  13 #include <clk-uclass.h>
  14 #include <div64.h>
  15 #include <dm.h>
  16 #include <linux/io.h>
  17
  18 /*
  19  * Synopsys ARC HSDK clock tree.
  20  *
  21  *   ------------------
  22  *   | 33.33 MHz xtal |
  23  *   ------------------
  24  *            |
  25  *            |   -----------
  26  *            |-->| ARC PLL |
  27  *            |   -----------
  28  *            |        |
  29  *            |        |-->|CGU_ARC_IDIV|----------->
  30  *            |        |-->|CREG_CORE_IF_DIV|------->
  31  *            |
  32  *            |   --------------
  33  *            |-->| SYSTEM PLL |
  34  *            |   --------------
  35  *            |        |
  36  *            |        |-->|CGU_SYS_IDIV_APB|------->
  37  *            |        |-->|CGU_SYS_IDIV_AXI|------->
  38  *            |        |-->|CGU_SYS_IDIV_*|--------->
  39  *            |        |-->|CGU_SYS_IDIV_EBI_REF|--->
  40  *            |
  41  *            |   --------------
  42  *            |-->| TUNNEL PLL |
  43  *            |   --------------
  44  *            |        |
  45  *            |        |-->|CGU_TUN_IDIV_TUN|----------->
  46  *            |        |-->|CGU_TUN_IDIV_ROM|----------->
  47  *            |        |-->|CGU_TUN_IDIV_PWM|----------->
  48  *            |
  49  *            |   -----------
  50  *            |-->| DDR PLL |
  51  *                -----------
  52  *                     |
  53  *                     |---------------------------->
  54  *
  55  *   ------------------
  56  *   | 27.00 MHz xtal |
  57  *   ------------------
  58  *            |
  59  *            |   ------------
  60  *            |-->| HDMI PLL |
  61  *                ------------
  62  *                     |
  63  *                     |-->|CGU_HDMI_IDIV_APB|------>
  64  */
  65
  66 #define CGU_ARC_IDIV            0x080
  67 #define CGU_TUN_IDIV_TUN        0x380
  68 #define CGU_TUN_IDIV_ROM        0x390
  69 #define CGU_TUN_IDIV_PWM        0x3A0
  70 #define CGU_TUN_IDIV_TIMER      0x3B0
  71 #define CGU_HDMI_IDIV_APB       0x480
  72 #define CGU_SYS_IDIV_APB        0x180
  73 #define CGU_SYS_IDIV_AXI        0x190
  74 #define CGU_SYS_IDIV_ETH        0x1A0
  75 #define CGU_SYS_IDIV_USB        0x1B0
  76 #define CGU_SYS_IDIV_SDIO       0x1C0
  77 #define CGU_SYS_IDIV_HDMI       0x1D0
  78 #define CGU_SYS_IDIV_GFX_CORE   0x1E0
  79 #define CGU_SYS_IDIV_GFX_DMA    0x1F0
  80 #define CGU_SYS_IDIV_GFX_CFG    0x200
  81 #define CGU_SYS_IDIV_DMAC_CORE  0x210
  82 #define CGU_SYS_IDIV_DMAC_CFG   0x220
  83 #define CGU_SYS_IDIV_SDIO_REF   0x230
  84 #define CGU_SYS_IDIV_SPI_REF    0x240
  85 #define CGU_SYS_IDIV_I2C_REF    0x250
  86 #define CGU_SYS_IDIV_UART_REF   0x260
  87 #define CGU_SYS_IDIV_EBI_REF    0x270
  88
  89 #define CGU_IDIV_MASK           0xFF /* All idiv have 8 significant bits */
  90
  91 #define CGU_ARC_PLL             0x0
  92 #define CGU_SYS_PLL             0x10
  93 #define CGU_DDR_PLL             0x20
  94 #define CGU_TUN_PLL             0x30
  95 #define CGU_HDMI_PLL            0x40
  96
  97 #define CGU_PLL_CTRL            0x000 /* ARC PLL control register */
  98 #define CGU_PLL_STATUS          0x004 /* ARC PLL status register */
  99 #define CGU_PLL_FMEAS           0x008 /* ARC PLL frequency measurement register */
 100 #define CGU_PLL_MON             0x00C /* ARC PLL monitor register */
 101
 102 #define CGU_PLL_CTRL_ODIV_SHIFT         2
 103 #define CGU_PLL_CTRL_IDIV_SHIFT         4
 104 #define CGU_PLL_CTRL_FBDIV_SHIFT        9
 105 #define CGU_PLL_CTRL_BAND_SHIFT         20
 106
 107 #define CGU_PLL_CTRL_ODIV_MASK          GENMASK(3, CGU_PLL_CTRL_ODIV_SHIFT)
 108 #define CGU_PLL_CTRL_IDIV_MASK          GENMASK(8, CGU_PLL_CTRL_IDIV_SHIFT)
 109 #define CGU_PLL_CTRL_FBDIV_MASK         GENMASK(15, CGU_PLL_CTRL_FBDIV_SHIFT)
 110
 111 #define CGU_PLL_CTRL_PD                 BIT(0)
 112 #define CGU_PLL_CTRL_BYPASS             BIT(1)
 113
 114 #define CGU_PLL_STATUS_LOCK             BIT(0)
 115 #define CGU_PLL_STATUS_ERR              BIT(1)
 116
 117 #define HSDK_PLL_MAX_LOCK_TIME          100 /* 100 us */
 118
 119 #define CREG_CORE_IF_DIV                0x000 /* ARC CORE interface divider */
 120 #define CORE_IF_CLK_THRESHOLD_HZ        500000000
 121 #define CREG_CORE_IF_CLK_DIV_1          0x0
 122 #define CREG_CORE_IF_CLK_DIV_2          0x1
 123
 124 #define MIN_PLL_RATE                    100000000 /* 100 MHz */
 125 #define PARENT_RATE_33                  33333333 /* fixed clock - xtal */
 126 #define PARENT_RATE_27                  27000000 /* fixed clock - xtal */
 127 #define CGU_MAX_CLOCKS                  27
 128
 129 #define MAX_FREQ_VARIATIONS             6
 130
 131 struct hsdk_idiv_cfg {
 132         const u32 oft;
 133         const u8  val[MAX_FREQ_VARIATIONS];
 134 };
 135
 136 struct hsdk_div_full_cfg {
 137         const u32 clk_rate[MAX_FREQ_VARIATIONS];
 138         const u32 pll_rate[MAX_FREQ_VARIATIONS];
 139         const struct hsdk_idiv_cfg idiv[];
 140 };
 141
 142 static const struct hsdk_div_full_cfg tun_clk_cfg = {
 143         { 25000000,  50000000,  75000000,  100000000, 125000000, 150000000 },
 144         { 600000000, 600000000, 600000000, 600000000, 750000000, 600000000 }, {
 145         { CGU_TUN_IDIV_TUN,     { 24,   12,     8,      6,      6,      4 } },
 146         { CGU_TUN_IDIV_ROM,     { 4,    4,      4,      4,      5,      4 } },
 147         { CGU_TUN_IDIV_PWM,     { 8,    8,      8,      8,      10,     8 } },
 148         { CGU_TUN_IDIV_TIMER,   { 12,   12,     12,     12,     15,     12 } },
 149         { /* last one */ }
 150         }
 151 };
 152
 153 static const struct hsdk_div_full_cfg axi_clk_cfg = {
 154         { 200000000,    400000000,      600000000,      800000000 },
 155         { 800000000,    800000000,      600000000,      800000000 }, {
 156         { CGU_SYS_IDIV_APB,      { 4,   4,      3,      4 } },  /* APB */
 157         { CGU_SYS_IDIV_AXI,      { 4,   2,      1,      1 } },  /* AXI */
 158         { CGU_SYS_IDIV_ETH,      { 2,   2,      2,      2 } },  /* ETH */
 159         { CGU_SYS_IDIV_USB,      { 2,   2,      2,      2 } },  /* USB */
 160         { CGU_SYS_IDIV_SDIO,     { 2,   2,      2,      2 } },  /* SDIO */
 161         { CGU_SYS_IDIV_HDMI,     { 2,   2,      2,      2 } },  /* HDMI */
 162         { CGU_SYS_IDIV_GFX_CORE, { 1,   1,      1,      1 } },  /* GPU-CORE */
 163         { CGU_SYS_IDIV_GFX_DMA,  { 2,   2,      2,      2 } },  /* GPU-DMA */
 164         { CGU_SYS_IDIV_GFX_CFG,  { 4,   4,      3,      4 } },  /* GPU-CFG */
 165         { CGU_SYS_IDIV_DMAC_CORE,{ 2,   2,      2,      2 } },  /* DMAC-CORE */
 166         { CGU_SYS_IDIV_DMAC_CFG, { 4,   4,      3,      4 } },  /* DMAC-CFG */
 167         { CGU_SYS_IDIV_SDIO_REF, { 8,   8,      6,      8 } },  /* SDIO-REF */
 168         { CGU_SYS_IDIV_SPI_REF,  { 24,  24,     18,     24 } }, /* SPI-REF */
 169         { CGU_SYS_IDIV_I2C_REF,  { 4,   4,      3,      4 } },  /* I2C-REF */
 170         { CGU_SYS_IDIV_UART_REF, { 24,  24,     18,     24 } }, /* UART-REF */
 171         { CGU_SYS_IDIV_EBI_REF,  { 16,  16,     12,     16 } }, /* EBI-REF */
 172         { /* last one */ }
 173         }
 174 };
 175
 176 struct hsdk_pll_cfg {
 177         const u32 rate;
 178         const u8  idiv;
 179         const u8  fbdiv;
 180         const u8  odiv;
 181         const u8  band;
 182 };
 183
 184 static const struct hsdk_pll_cfg asdt_pll_cfg[] = {
 185         { 100000000,  0, 11, 3, 0 },
 186         { 125000000,  0, 14, 3, 0 },
 187         { 133000000,  0, 15, 3, 0 },
 188         { 150000000,  0, 17, 3, 0 },
 189         { 200000000,  1, 47, 3, 0 },
 190         { 233000000,  1, 27, 2, 0 },
 191         { 300000000,  1, 35, 2, 0 },
 192         { 333000000,  1, 39, 2, 0 },
 193         { 400000000,  1, 47, 2, 0 },
 194         { 500000000,  0, 14, 1, 0 },
 195         { 600000000,  0, 17, 1, 0 },
 196         { 700000000,  0, 20, 1, 0 },
 197         { 750000000,  1, 44, 1, 0 },
 198         { 800000000,  0, 23, 1, 0 },
 199         { 900000000,  1, 26, 0, 0 },
 200         { 1000000000, 1, 29, 0, 0 },
 201         { 1100000000, 1, 32, 0, 0 },
 202         { 1200000000, 1, 35, 0, 0 },
 203         { 1300000000, 1, 38, 0, 0 },
 204         { 1400000000, 1, 41, 0, 0 },
 205         { 1500000000, 1, 44, 0, 0 },
 206         { 1600000000, 1, 47, 0, 0 },
 207         {}
 208 };
 209
 210 static const struct hsdk_pll_cfg hdmi_pll_cfg[] = {
 211         { 297000000,  0, 21, 2, 0 },
 212         { 540000000,  0, 19, 1, 0 },
 213         { 594000000,  0, 21, 1, 0 },
 214         {}
 215 };
 216
 217 struct hsdk_cgu_clk {
 218         /* CGU block register */
 219         void __iomem *cgu_regs;
 220         /* CREG block register */
 221         void __iomem *creg_regs;
 222
 223         /* PLLs registers */
 224         void __iomem *regs;
 225         /* PLLs special registers */
 226         void __iomem *spec_regs;
 227         /* PLLs devdata */
 228         const struct hsdk_pll_devdata *pll_devdata;
 229
 230         /* Dividers registers */
 231         void __iomem *idiv_regs;
 232 };
 233
 234 struct hsdk_pll_devdata {
 235         const u32 parent_rate;
 236         const struct hsdk_pll_cfg *const pll_cfg;
 237         const int (*const update_rate)(struct hsdk_cgu_clk *clk,
 238                                        unsigned long rate,
 239                                        const struct hsdk_pll_cfg *cfg);
 240 };
 241
 242 static int hsdk_pll_core_update_rate(struct hsdk_cgu_clk *, unsigned long,
 243                                      const struct hsdk_pll_cfg *);
 244 static int hsdk_pll_comm_update_rate(struct hsdk_cgu_clk *, unsigned long,
 245                                      const struct hsdk_pll_cfg *);
 246
 247 static const struct hsdk_pll_devdata core_pll_dat = {
 248         .parent_rate = PARENT_RATE_33,
 249         .pll_cfg = asdt_pll_cfg,
 250         .update_rate = hsdk_pll_core_update_rate,
 251 };
 252
 253 static const struct hsdk_pll_devdata sdt_pll_dat = {
 254         .parent_rate = PARENT_RATE_33,
 255         .pll_cfg = asdt_pll_cfg,
 256         .update_rate = hsdk_pll_comm_update_rate,
 257 };
 258
 259 static const struct hsdk_pll_devdata hdmi_pll_dat = {
 260         .parent_rate = PARENT_RATE_27,
 261         .pll_cfg = hdmi_pll_cfg,
 262         .update_rate = hsdk_pll_comm_update_rate,
 263 };
 264
 265 static ulong idiv_set(struct clk *, ulong);
 266 static ulong cpu_clk_set(struct clk *, ulong);
 267 static ulong axi_clk_set(struct clk *, ulong);
 268 static ulong tun_clk_set(struct clk *, ulong);
 269 static ulong idiv_get(struct clk *);
 270 static int idiv_off(struct clk *);
 271 static ulong pll_set(struct clk *, ulong);
 272 static ulong pll_get(struct clk *);
 273
 274 struct hsdk_cgu_clock_map {
 275         const u32 cgu_pll_oft;
 276         const u32 cgu_div_oft;
 277         const struct hsdk_pll_devdata *const pll_devdata;
 278         const ulong (*const get_rate)(struct clk *clk);
 279         const ulong (*const set_rate)(struct clk *clk, ulong rate);
 280         const int (*const disable)(struct clk *clk);
 281 };
 282
 283 static const struct hsdk_cgu_clock_map clock_map[] = {
 284         { CGU_ARC_PLL, 0, &core_pll_dat, pll_get, pll_set, NULL },
 285         { CGU_ARC_PLL, CGU_ARC_IDIV, &core_pll_dat, idiv_get, cpu_clk_set, idiv_off },
 286         { CGU_DDR_PLL, 0, &sdt_pll_dat, pll_get, pll_set, NULL },
 287         { CGU_SYS_PLL, 0, &sdt_pll_dat, pll_get, pll_set, NULL },
 288         { CGU_SYS_PLL, CGU_SYS_IDIV_APB, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 289         { CGU_SYS_PLL, CGU_SYS_IDIV_AXI, &sdt_pll_dat, idiv_get, axi_clk_set, idiv_off },
 290         { CGU_SYS_PLL, CGU_SYS_IDIV_ETH, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 291         { CGU_SYS_PLL, CGU_SYS_IDIV_USB, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 292         { CGU_SYS_PLL, CGU_SYS_IDIV_SDIO, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 293         { CGU_SYS_PLL, CGU_SYS_IDIV_HDMI, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 294         { CGU_SYS_PLL, CGU_SYS_IDIV_GFX_CORE, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 295         { CGU_SYS_PLL, CGU_SYS_IDIV_GFX_DMA, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 296         { CGU_SYS_PLL, CGU_SYS_IDIV_GFX_CFG, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 297         { CGU_SYS_PLL, CGU_SYS_IDIV_DMAC_CORE, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 298         { CGU_SYS_PLL, CGU_SYS_IDIV_DMAC_CFG, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 299         { CGU_SYS_PLL, CGU_SYS_IDIV_SDIO_REF, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 300         { CGU_SYS_PLL, CGU_SYS_IDIV_SPI_REF, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 301         { CGU_SYS_PLL, CGU_SYS_IDIV_I2C_REF, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 302         { CGU_SYS_PLL, CGU_SYS_IDIV_UART_REF, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 303         { CGU_SYS_PLL, CGU_SYS_IDIV_EBI_REF, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 304         { CGU_TUN_PLL, 0, &sdt_pll_dat, pll_get, pll_set, NULL },
 305         { CGU_TUN_PLL, CGU_TUN_IDIV_TUN, &sdt_pll_dat, idiv_get, tun_clk_set, idiv_off },
 306         { CGU_TUN_PLL, CGU_TUN_IDIV_ROM, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 307         { CGU_TUN_PLL, CGU_TUN_IDIV_PWM, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 308         { CGU_TUN_PLL, CGU_TUN_IDIV_TIMER, &sdt_pll_dat, idiv_get, idiv_set, idiv_off },
 309         { CGU_HDMI_PLL, 0, &hdmi_pll_dat, pll_get, pll_set, NULL },
 310         { CGU_HDMI_PLL, CGU_HDMI_IDIV_APB, &hdmi_pll_dat, idiv_get, idiv_set, idiv_off }
 311 };
 312
 313 static inline void hsdk_idiv_write(struct hsdk_cgu_clk *clk, u32 val)
 314 {
 315         iowrite32(val, clk->idiv_regs);
 316 }
 317
 318 static inline u32 hsdk_idiv_read(struct hsdk_cgu_clk *clk)
 319 {
 320         return ioread32(clk->idiv_regs);
 321 }
 322
 323 static inline void hsdk_pll_write(struct hsdk_cgu_clk *clk, u32 reg, u32 val)
 324 {
 325         iowrite32(val, clk->regs + reg);
 326 }
 327
 328 static inline u32 hsdk_pll_read(struct hsdk_cgu_clk *clk, u32 reg)
 329 {
 330         return ioread32(clk->regs + reg);
 331 }
 332
 333 static inline void hsdk_pll_spcwrite(struct hsdk_cgu_clk *clk, u32 reg, u32 val)
 334 {
 335         iowrite32(val, clk->spec_regs + reg);
 336 }
 337
 338 static inline u32 hsdk_pll_spcread(struct hsdk_cgu_clk *clk, u32 reg)
 339 {
 340         return ioread32(clk->spec_regs + reg);
 341 }
 342
 343 static inline void hsdk_pll_set_cfg(struct hsdk_cgu_clk *clk,
 344                                     const struct hsdk_pll_cfg *cfg)
 345 {
 346         u32 val = 0;
 347
 348         /* Powerdown and Bypass bits should be cleared */
 349         val |= (u32)cfg->idiv << CGU_PLL_CTRL_IDIV_SHIFT;
 350         val |= (u32)cfg->fbdiv << CGU_PLL_CTRL_FBDIV_SHIFT;
 351         val |= (u32)cfg->odiv << CGU_PLL_CTRL_ODIV_SHIFT;
 352         val |= (u32)cfg->band << CGU_PLL_CTRL_BAND_SHIFT;
 353
 354         pr_debug("write configurarion: %#x\n", val);
 355
 356         hsdk_pll_write(clk, CGU_PLL_CTRL, val);
 357 }
 358
 359 static inline bool hsdk_pll_is_locked(struct hsdk_cgu_clk *clk)
 360 {
 361         return !!(hsdk_pll_read(clk, CGU_PLL_STATUS) & CGU_PLL_STATUS_LOCK);
 362 }
 363
 364 static inline bool hsdk_pll_is_err(struct hsdk_cgu_clk *clk)
 365 {
 366         return !!(hsdk_pll_read(clk, CGU_PLL_STATUS) & CGU_PLL_STATUS_ERR);
 367 }
 368
 369 static ulong pll_get(struct clk *sclk)
 370 {
 371         u32 val;
 372         u64 rate;
 373         u32 idiv, fbdiv, odiv;
 374         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 375         u32 parent_rate = clk->pll_devdata->parent_rate;
 376
 377         val = hsdk_pll_read(clk, CGU_PLL_CTRL);
 378
 379         pr_debug("current configurarion: %#x\n", val);
 380
 381         /* Check if PLL is bypassed */
 382         if (val & CGU_PLL_CTRL_BYPASS)
 383                 return parent_rate;
 384
 385         /* Check if PLL is disabled */
 386         if (val & CGU_PLL_CTRL_PD)
 387                 return 0;
 388
 389         /* input divider = reg.idiv + 1 */
 390         idiv = 1 + ((val & CGU_PLL_CTRL_IDIV_MASK) >> CGU_PLL_CTRL_IDIV_SHIFT);
 391         /* fb divider = 2*(reg.fbdiv + 1) */
 392         fbdiv = 2 * (1 + ((val & CGU_PLL_CTRL_FBDIV_MASK) >> CGU_PLL_CTRL_FBDIV_SHIFT));
 393         /* output divider = 2^(reg.odiv) */
 394         odiv = 1 << ((val & CGU_PLL_CTRL_ODIV_MASK) >> CGU_PLL_CTRL_ODIV_SHIFT);
 395
 396         rate = (u64)parent_rate * fbdiv;
 397         do_div(rate, idiv * odiv);
 398
 399         return rate;
 400 }
 401
 402 static unsigned long hsdk_pll_round_rate(struct clk *sclk, unsigned long rate)
 403 {
 404         int i;
 405         unsigned long best_rate;
 406         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 407         const struct hsdk_pll_cfg *pll_cfg = clk->pll_devdata->pll_cfg;
 408
 409         if (pll_cfg[0].rate == 0)
 410                 return -EINVAL;
 411
 412         best_rate = pll_cfg[0].rate;
 413
 414         for (i = 1; pll_cfg[i].rate != 0; i++) {
 415                 if (abs(rate - pll_cfg[i].rate) < abs(rate - best_rate))
 416                         best_rate = pll_cfg[i].rate;
 417         }
 418
 419         pr_debug("chosen best rate: %lu\n", best_rate);
 420
 421         return best_rate;
 422 }
 423
 424 static int hsdk_pll_comm_update_rate(struct hsdk_cgu_clk *clk,
 425                                      unsigned long rate,
 426                                      const struct hsdk_pll_cfg *cfg)
 427 {
 428         hsdk_pll_set_cfg(clk, cfg);
 429
 430         /*
 431          * Wait until CGU relocks and check error status.
 432          * If after timeout CGU is unlocked yet return error.
 433          */
 434         udelay(HSDK_PLL_MAX_LOCK_TIME);
 435         if (!hsdk_pll_is_locked(clk))
 436                 return -ETIMEDOUT;
 437
 438         if (hsdk_pll_is_err(clk))
 439                 return -EINVAL;
 440
 441         return 0;
 442 }
 443
 444 static int hsdk_pll_core_update_rate(struct hsdk_cgu_clk *clk,
 445                                      unsigned long rate,
 446                                      const struct hsdk_pll_cfg *cfg)
 447 {
 448         /*
 449          * When core clock exceeds 500MHz, the divider for the interface
 450          * clock must be programmed to div-by-2.
 451          */
 452         if (rate > CORE_IF_CLK_THRESHOLD_HZ)
 453                 hsdk_pll_spcwrite(clk, CREG_CORE_IF_DIV, CREG_CORE_IF_CLK_DIV_2);
 454
 455         hsdk_pll_set_cfg(clk, cfg);
 456
 457         /*
 458          * Wait until CGU relocks and check error status.
 459          * If after timeout CGU is unlocked yet return error.
 460          */
 461         udelay(HSDK_PLL_MAX_LOCK_TIME);
 462         if (!hsdk_pll_is_locked(clk))
 463                 return -ETIMEDOUT;
 464
 465         if (hsdk_pll_is_err(clk))
 466                 return -EINVAL;
 467
 468         /*
 469          * Program divider to div-by-1 if we succesfuly set core clock below
 470          * 500MHz threshold.
 471          */
 472         if (rate <= CORE_IF_CLK_THRESHOLD_HZ)
 473                 hsdk_pll_spcwrite(clk, CREG_CORE_IF_DIV, CREG_CORE_IF_CLK_DIV_1);
 474
 475         return 0;
 476 }
 477
 478 static ulong pll_set(struct clk *sclk, ulong rate)
 479 {
 480         int i;
 481         unsigned long best_rate;
 482         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 483         const struct hsdk_pll_cfg *pll_cfg = clk->pll_devdata->pll_cfg;
 484
 485         best_rate = hsdk_pll_round_rate(sclk, rate);
 486
 487         for (i = 0; pll_cfg[i].rate != 0; i++) {
 488                 if (pll_cfg[i].rate == best_rate) {
 489                         return clk->pll_devdata->update_rate(clk, best_rate,
 490                                                              &pll_cfg[i]);
 491                 }
 492         }
 493
 494         pr_err("invalid rate=%ld Hz, parent_rate=%d Hz\n", best_rate,
 495                clk->pll_devdata->parent_rate);
 496
 497         return -EINVAL;
 498 }
 499
 500 static int idiv_off(struct clk *sclk)
 501 {
 502         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 503
 504         hsdk_idiv_write(clk, 0);
 505
 506         return 0;
 507 }
 508
 509 static ulong idiv_get(struct clk *sclk)
 510 {
 511         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 512         ulong parent_rate = pll_get(sclk);
 513         u32 div_factor = hsdk_idiv_read(clk);
 514
 515         div_factor &= CGU_IDIV_MASK;
 516
 517         pr_debug("current configurarion: %#x (%d)\n", div_factor, div_factor);
 518
 519         if (div_factor == 0)
 520                 return 0;
 521
 522         return parent_rate / div_factor;
 523 }
 524
 525 /* Special behavior: wen we set this clock we set both idiv and pll */
 526 static ulong cpu_clk_set(struct clk *sclk, ulong rate)
 527 {
 528         ulong ret;
 529
 530         ret = pll_set(sclk, rate);
 531         idiv_set(sclk, rate);
 532
 533         return ret;
 534 }
 535
 536 /*
 537  * Special behavior:
 538  * when we set these clocks we set both PLL and all idiv dividers related to
 539  * this PLL domain.
 540  */
 541 static ulong common_div_clk_set(struct clk *sclk, ulong rate,
 542                                 const struct hsdk_div_full_cfg *cfg)
 543 {
 544         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 545         ulong pll_rate;
 546         int i, freq_idx = -1;
 547         ulong ret = 0;
 548
 549         pll_rate = pll_get(sclk);
 550
 551         for (i = 0; i < MAX_FREQ_VARIATIONS; i++) {
 552                 /* unused freq variations are filled with 0 */
 553                 if (!cfg->clk_rate[i])
 554                         break;
 555
 556                 if (cfg->clk_rate[i] == rate) {
 557                         freq_idx = i;
 558                         break;
 559                 }
 560         }
 561
 562         if (freq_idx < 0) {
 563                 pr_err("clk: invalid rate=%ld Hz\n", rate);
 564                 return -EINVAL;
 565         }
 566
 567         /* configure PLL before dividers */
 568         if (cfg->pll_rate[freq_idx] < pll_rate)
 569                 ret = pll_set(sclk, cfg->pll_rate[freq_idx]);
 570
 571         /* configure SYS dividers */
 572         for (i = 0; cfg->idiv[i].oft != 0; i++) {
 573                 clk->idiv_regs = clk->cgu_regs + cfg->idiv[i].oft;
 574                 hsdk_idiv_write(clk, cfg->idiv[i].val[freq_idx]);
 575         }
 576
 577         /* configure PLL after dividers */
 578         if (cfg->pll_rate[freq_idx] >= pll_rate)
 579                 ret = pll_set(sclk, cfg->pll_rate[freq_idx]);
 580
 581         return ret;
 582 }
 583
 584 static ulong axi_clk_set(struct clk *sclk, ulong rate)
 585 {
 586         return common_div_clk_set(sclk, rate, &axi_clk_cfg);
 587 }
 588
 589 static ulong tun_clk_set(struct clk *sclk, ulong rate)
 590 {
 591         return common_div_clk_set(sclk, rate, &tun_clk_cfg);
 592 }
 593
 594 static ulong idiv_set(struct clk *sclk, ulong rate)
 595 {
 596         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 597         ulong parent_rate = pll_get(sclk);
 598         u32 div_factor;
 599
 600         div_factor = parent_rate / rate;
 601         if (abs(rate - parent_rate / (div_factor + 1)) <=
 602             abs(rate - parent_rate / div_factor)) {
 603                 div_factor += 1;
 604         }
 605
 606         if (div_factor & ~CGU_IDIV_MASK) {
 607                 pr_err("invalid rate=%ld Hz, parent_rate=%ld Hz, div=%d: max divider valie is%d\n",
 608                        rate, parent_rate, div_factor, CGU_IDIV_MASK);
 609
 610                 div_factor = CGU_IDIV_MASK;
 611         }
 612
 613         if (div_factor == 0) {
 614                 pr_err("invalid rate=%ld Hz, parent_rate=%ld Hz, div=%d: min divider valie is 1\n",
 615                        rate, parent_rate, div_factor);
 616
 617                 div_factor = 1;
 618         }
 619
 620         hsdk_idiv_write(clk, div_factor);
 621
 622         return 0;
 623 }
 624
 625 static int hsdk_prepare_clock_tree_branch(struct clk *sclk)
 626 {
 627         struct hsdk_cgu_clk *clk = dev_get_priv(sclk->dev);
 628
 629         if (sclk->id >= CGU_MAX_CLOCKS)
 630                 return -EINVAL;
 631
 632         clk->pll_devdata = clock_map[sclk->id].pll_devdata;
 633         clk->regs = clk->cgu_regs + clock_map[sclk->id].cgu_pll_oft;
 634         clk->spec_regs = clk->creg_regs;
 635         clk->idiv_regs = clk->cgu_regs + clock_map[sclk->id].cgu_div_oft;
 636
 637         return 0;
 638 }
 639
 640 static ulong hsdk_cgu_get_rate(struct clk *sclk)
 641 {
 642         if (hsdk_prepare_clock_tree_branch(sclk))
 643                 return -EINVAL;
 644
 645         return clock_map[sclk->id].get_rate(sclk);
 646 }
 647
 648 static ulong hsdk_cgu_set_rate(struct clk *sclk, ulong rate)
 649 {
 650         if (hsdk_prepare_clock_tree_branch(sclk))
 651                 return -EINVAL;
 652
 653         return clock_map[sclk->id].set_rate(sclk, rate);
 654 }
 655
 656 static int hsdk_cgu_disable(struct clk *sclk)
 657 {
 658         if (hsdk_prepare_clock_tree_branch(sclk))
 659                 return -EINVAL;
 660
 661         if (clock_map[sclk->id].disable)
 662                 return clock_map[sclk->id].disable(sclk);
 663
 664         return -ENOTSUPP;
 665 }
 666
 667 static const struct clk_ops hsdk_cgu_ops = {
 668         .set_rate = hsdk_cgu_set_rate,
 669         .get_rate = hsdk_cgu_get_rate,
 670         .disable = hsdk_cgu_disable,
 671 };
 672
 673 static int hsdk_cgu_clk_probe(struct udevice *dev)
 674 {
 675         struct hsdk_cgu_clk *pll_clk = dev_get_priv(dev);
 676
 677         BUILD_BUG_ON(ARRAY_SIZE(clock_map) != CGU_MAX_CLOCKS);
 678
 679         pll_clk->cgu_regs = (void __iomem *)devfdt_get_addr_index(dev, 0);
 680         if (!pll_clk->cgu_regs)
 681                 return -EINVAL;
 682
 683         pll_clk->creg_regs = (void __iomem *)devfdt_get_addr_index(dev, 1);
 684         if (!pll_clk->creg_regs)
 685                 return -EINVAL;
 686
 687         return 0;
 688 }
 689
 690 static const struct udevice_id hsdk_cgu_clk_id[] = {
 691         { .compatible = "snps,hsdk-cgu-clock" },
 692         { }
 693 };
 694
 695 U_BOOT_DRIVER(hsdk_cgu_clk) = {
 696         .name = "hsdk-cgu-clk",
 697         .id = UCLASS_CLK,
 698         .of_match = hsdk_cgu_clk_id,
 699         .probe = hsdk_cgu_clk_probe,
 700         .priv_auto_alloc_size = sizeof(struct hsdk_cgu_clk),
 701         .ops = &hsdk_cgu_ops,
 702 };