2 * Copyright (c) 2014, NVIDIA CORPORATION. All rights reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
22 * Shamelessly ripped off from ChromeOS's gk20a/clk_pllg.c
25 #include <subdev/clk.h>
26 #include <subdev/timer.h>
28 #include <core/device.h>
31 #include <nouveau_platform.h>
34 #define MHZ (1000 * 1000)
36 #define MASK(w) ((1 << w) - 1)
38 #define SYS_GPCPLL_CFG_BASE 0x00137000
39 #define GPC_BCASE_GPCPLL_CFG_BASE 0x00132800
41 #define GPCPLL_CFG (SYS_GPCPLL_CFG_BASE + 0)
42 #define GPCPLL_CFG_ENABLE BIT(0)
43 #define GPCPLL_CFG_IDDQ BIT(1)
44 #define GPCPLL_CFG_LOCK_DET_OFF BIT(4)
45 #define GPCPLL_CFG_LOCK BIT(17)
47 #define GPCPLL_COEFF (SYS_GPCPLL_CFG_BASE + 4)
48 #define GPCPLL_COEFF_M_SHIFT 0
49 #define GPCPLL_COEFF_M_WIDTH 8
50 #define GPCPLL_COEFF_N_SHIFT 8
51 #define GPCPLL_COEFF_N_WIDTH 8
52 #define GPCPLL_COEFF_P_SHIFT 16
53 #define GPCPLL_COEFF_P_WIDTH 6
55 #define GPCPLL_CFG2 (SYS_GPCPLL_CFG_BASE + 0xc)
56 #define GPCPLL_CFG2_SETUP2_SHIFT 16
57 #define GPCPLL_CFG2_PLL_STEPA_SHIFT 24
59 #define GPCPLL_CFG3 (SYS_GPCPLL_CFG_BASE + 0x18)
60 #define GPCPLL_CFG3_PLL_STEPB_SHIFT 16
62 #define GPCPLL_NDIV_SLOWDOWN (SYS_GPCPLL_CFG_BASE + 0x1c)
63 #define GPCPLL_NDIV_SLOWDOWN_NDIV_LO_SHIFT 0
64 #define GPCPLL_NDIV_SLOWDOWN_NDIV_MID_SHIFT 8
65 #define GPCPLL_NDIV_SLOWDOWN_STEP_SIZE_LO2MID_SHIFT 16
66 #define GPCPLL_NDIV_SLOWDOWN_SLOWDOWN_USING_PLL_SHIFT 22
67 #define GPCPLL_NDIV_SLOWDOWN_EN_DYNRAMP_SHIFT 31
69 #define SEL_VCO (SYS_GPCPLL_CFG_BASE + 0x100)
70 #define SEL_VCO_GPC2CLK_OUT_SHIFT 0
72 #define GPC2CLK_OUT (SYS_GPCPLL_CFG_BASE + 0x250)
73 #define GPC2CLK_OUT_SDIV14_INDIV4_WIDTH 1
74 #define GPC2CLK_OUT_SDIV14_INDIV4_SHIFT 31
75 #define GPC2CLK_OUT_SDIV14_INDIV4_MODE 1
76 #define GPC2CLK_OUT_VCODIV_WIDTH 6
77 #define GPC2CLK_OUT_VCODIV_SHIFT 8
78 #define GPC2CLK_OUT_VCODIV1 0
79 #define GPC2CLK_OUT_VCODIV_MASK (MASK(GPC2CLK_OUT_VCODIV_WIDTH) << \
80 GPC2CLK_OUT_VCODIV_SHIFT)
81 #define GPC2CLK_OUT_BYPDIV_WIDTH 6
82 #define GPC2CLK_OUT_BYPDIV_SHIFT 0
83 #define GPC2CLK_OUT_BYPDIV31 0x3c
84 #define GPC2CLK_OUT_INIT_MASK ((MASK(GPC2CLK_OUT_SDIV14_INDIV4_WIDTH) << \
85 GPC2CLK_OUT_SDIV14_INDIV4_SHIFT)\
86 | (MASK(GPC2CLK_OUT_VCODIV_WIDTH) << GPC2CLK_OUT_VCODIV_SHIFT)\
87 | (MASK(GPC2CLK_OUT_BYPDIV_WIDTH) << GPC2CLK_OUT_BYPDIV_SHIFT))
88 #define GPC2CLK_OUT_INIT_VAL ((GPC2CLK_OUT_SDIV14_INDIV4_MODE << \
89 GPC2CLK_OUT_SDIV14_INDIV4_SHIFT) \
90 | (GPC2CLK_OUT_VCODIV1 << GPC2CLK_OUT_VCODIV_SHIFT) \
91 | (GPC2CLK_OUT_BYPDIV31 << GPC2CLK_OUT_BYPDIV_SHIFT))
93 #define GPC_BCAST_NDIV_SLOWDOWN_DEBUG (GPC_BCASE_GPCPLL_CFG_BASE + 0xa0)
94 #define GPC_BCAST_NDIV_SLOWDOWN_DEBUG_PLL_DYNRAMP_DONE_SYNCED_SHIFT 24
95 #define GPC_BCAST_NDIV_SLOWDOWN_DEBUG_PLL_DYNRAMP_DONE_SYNCED_MASK \
96 (0x1 << GPC_BCAST_NDIV_SLOWDOWN_DEBUG_PLL_DYNRAMP_DONE_SYNCED_SHIFT)
98 static const u8 pl_to_div[] = {
99 /* PL: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 */
100 /* p: */ 1, 2, 3, 4, 5, 6, 8, 10, 12, 16, 12, 16, 20, 24, 32,
103 /* All frequencies in Mhz */
104 struct gk20a_clk_pllg_params {
105 u32 min_vco, max_vco;
112 static const struct gk20a_clk_pllg_params gk20a_pllg_params = {
113 .min_vco = 1000, .max_vco = 2064,
114 .min_u = 12, .max_u = 38,
115 .min_m = 1, .max_m = 255,
116 .min_n = 8, .max_n = 255,
117 .min_pl = 1, .max_pl = 32,
120 struct gk20a_clk_priv {
121 struct nvkm_clk base;
122 const struct gk20a_clk_pllg_params *params;
126 #define to_gk20a_clk(base) container_of(base, struct gk20a_clk_priv, base)
129 gk20a_pllg_read_mnp(struct gk20a_clk_priv *priv)
133 val = nv_rd32(priv, GPCPLL_COEFF);
134 priv->m = (val >> GPCPLL_COEFF_M_SHIFT) & MASK(GPCPLL_COEFF_M_WIDTH);
135 priv->n = (val >> GPCPLL_COEFF_N_SHIFT) & MASK(GPCPLL_COEFF_N_WIDTH);
136 priv->pl = (val >> GPCPLL_COEFF_P_SHIFT) & MASK(GPCPLL_COEFF_P_WIDTH);
140 gk20a_pllg_calc_rate(struct gk20a_clk_priv *priv)
145 rate = priv->parent_rate * priv->n;
146 divider = priv->m * pl_to_div[priv->pl];
147 do_div(rate, divider);
153 gk20a_pllg_calc_mnp(struct gk20a_clk_priv *priv, unsigned long rate)
155 u32 target_clk_f, ref_clk_f, target_freq;
156 u32 min_vco_f, max_vco_f;
157 u32 low_pl, high_pl, best_pl;
158 u32 target_vco_f, vco_f;
162 u32 delta, lwv, best_delta = ~0;
165 target_clk_f = rate * 2 / MHZ;
166 ref_clk_f = priv->parent_rate / MHZ;
168 max_vco_f = priv->params->max_vco;
169 min_vco_f = priv->params->min_vco;
170 best_m = priv->params->max_m;
171 best_n = priv->params->min_n;
172 best_pl = priv->params->min_pl;
174 target_vco_f = target_clk_f + target_clk_f / 50;
175 if (max_vco_f < target_vco_f)
176 max_vco_f = target_vco_f;
178 /* min_pl <= high_pl <= max_pl */
179 high_pl = (max_vco_f + target_vco_f - 1) / target_vco_f;
180 high_pl = min(high_pl, priv->params->max_pl);
181 high_pl = max(high_pl, priv->params->min_pl);
183 /* min_pl <= low_pl <= max_pl */
184 low_pl = min_vco_f / target_vco_f;
185 low_pl = min(low_pl, priv->params->max_pl);
186 low_pl = max(low_pl, priv->params->min_pl);
188 /* Find Indices of high_pl and low_pl */
189 for (pl = 0; pl < ARRAY_SIZE(pl_to_div) - 1; pl++) {
190 if (pl_to_div[pl] >= low_pl) {
195 for (pl = 0; pl < ARRAY_SIZE(pl_to_div) - 1; pl++) {
196 if (pl_to_div[pl] >= high_pl) {
202 nv_debug(priv, "low_PL %d(div%d), high_PL %d(div%d)", low_pl,
203 pl_to_div[low_pl], high_pl, pl_to_div[high_pl]);
205 /* Select lowest possible VCO */
206 for (pl = low_pl; pl <= high_pl; pl++) {
207 target_vco_f = target_clk_f * pl_to_div[pl];
208 for (m = priv->params->min_m; m <= priv->params->max_m; m++) {
211 if (u_f < priv->params->min_u)
213 if (u_f > priv->params->max_u)
216 n = (target_vco_f * m) / ref_clk_f;
217 n2 = ((target_vco_f * m) + (ref_clk_f - 1)) / ref_clk_f;
219 if (n > priv->params->max_n)
222 for (; n <= n2; n++) {
223 if (n < priv->params->min_n)
225 if (n > priv->params->max_n)
228 vco_f = ref_clk_f * n / m;
230 if (vco_f >= min_vco_f && vco_f <= max_vco_f) {
231 lwv = (vco_f + (pl_to_div[pl] / 2))
233 delta = abs(lwv - target_clk_f);
235 if (delta < best_delta) {
250 WARN_ON(best_delta == ~0);
253 nv_debug(priv, "no best match for target @ %dMHz on gpc_pll",
260 target_freq = gk20a_pllg_calc_rate(priv) / MHZ;
262 nv_debug(priv, "actual target freq %d MHz, M %d, N %d, PL %d(div%d)\n",
263 target_freq, priv->m, priv->n, priv->pl, pl_to_div[priv->pl]);
268 gk20a_pllg_slide(struct gk20a_clk_priv *priv, u32 n)
273 /* get old coefficients */
274 val = nv_rd32(priv, GPCPLL_COEFF);
275 /* do nothing if NDIV is the same */
276 if (n == ((val >> GPCPLL_COEFF_N_SHIFT) & MASK(GPCPLL_COEFF_N_WIDTH)))
280 nv_mask(priv, GPCPLL_CFG2, 0xff << GPCPLL_CFG2_PLL_STEPA_SHIFT,
281 0x2b << GPCPLL_CFG2_PLL_STEPA_SHIFT);
282 nv_mask(priv, GPCPLL_CFG3, 0xff << GPCPLL_CFG3_PLL_STEPB_SHIFT,
283 0xb << GPCPLL_CFG3_PLL_STEPB_SHIFT);
285 /* pll slowdown mode */
286 nv_mask(priv, GPCPLL_NDIV_SLOWDOWN,
287 BIT(GPCPLL_NDIV_SLOWDOWN_SLOWDOWN_USING_PLL_SHIFT),
288 BIT(GPCPLL_NDIV_SLOWDOWN_SLOWDOWN_USING_PLL_SHIFT));
290 /* new ndiv ready for ramp */
291 val = nv_rd32(priv, GPCPLL_COEFF);
292 val &= ~(MASK(GPCPLL_COEFF_N_WIDTH) << GPCPLL_COEFF_N_SHIFT);
293 val |= (n & MASK(GPCPLL_COEFF_N_WIDTH)) << GPCPLL_COEFF_N_SHIFT;
295 nv_wr32(priv, GPCPLL_COEFF, val);
297 /* dynamic ramp to new ndiv */
298 val = nv_rd32(priv, GPCPLL_NDIV_SLOWDOWN);
299 val |= 0x1 << GPCPLL_NDIV_SLOWDOWN_EN_DYNRAMP_SHIFT;
301 nv_wr32(priv, GPCPLL_NDIV_SLOWDOWN, val);
303 for (ramp_timeout = 500; ramp_timeout > 0; ramp_timeout--) {
305 val = nv_rd32(priv, GPC_BCAST_NDIV_SLOWDOWN_DEBUG);
306 if (val & GPC_BCAST_NDIV_SLOWDOWN_DEBUG_PLL_DYNRAMP_DONE_SYNCED_MASK)
310 /* exit slowdown mode */
311 nv_mask(priv, GPCPLL_NDIV_SLOWDOWN,
312 BIT(GPCPLL_NDIV_SLOWDOWN_SLOWDOWN_USING_PLL_SHIFT) |
313 BIT(GPCPLL_NDIV_SLOWDOWN_EN_DYNRAMP_SHIFT), 0);
314 nv_rd32(priv, GPCPLL_NDIV_SLOWDOWN);
316 if (ramp_timeout <= 0) {
317 nv_error(priv, "gpcpll dynamic ramp timeout\n");
325 _gk20a_pllg_enable(struct gk20a_clk_priv *priv)
327 nv_mask(priv, GPCPLL_CFG, GPCPLL_CFG_ENABLE, GPCPLL_CFG_ENABLE);
328 nv_rd32(priv, GPCPLL_CFG);
332 _gk20a_pllg_disable(struct gk20a_clk_priv *priv)
334 nv_mask(priv, GPCPLL_CFG, GPCPLL_CFG_ENABLE, 0);
335 nv_rd32(priv, GPCPLL_CFG);
339 _gk20a_pllg_program_mnp(struct gk20a_clk_priv *priv, bool allow_slide)
342 u32 m_old, pl_old, n_lo;
344 /* get old coefficients */
345 val = nv_rd32(priv, GPCPLL_COEFF);
346 m_old = (val >> GPCPLL_COEFF_M_SHIFT) & MASK(GPCPLL_COEFF_M_WIDTH);
347 pl_old = (val >> GPCPLL_COEFF_P_SHIFT) & MASK(GPCPLL_COEFF_P_WIDTH);
349 /* do NDIV slide if there is no change in M and PL */
350 cfg = nv_rd32(priv, GPCPLL_CFG);
351 if (allow_slide && priv->m == m_old && priv->pl == pl_old &&
352 (cfg & GPCPLL_CFG_ENABLE)) {
353 return gk20a_pllg_slide(priv, priv->n);
356 /* slide down to NDIV_LO */
357 n_lo = DIV_ROUND_UP(m_old * priv->params->min_vco,
358 priv->parent_rate / MHZ);
359 if (allow_slide && (cfg & GPCPLL_CFG_ENABLE)) {
360 int ret = gk20a_pllg_slide(priv, n_lo);
366 /* split FO-to-bypass jump in halfs by setting out divider 1:2 */
367 nv_mask(priv, GPC2CLK_OUT, GPC2CLK_OUT_VCODIV_MASK,
368 0x2 << GPC2CLK_OUT_VCODIV_SHIFT);
370 /* put PLL in bypass before programming it */
371 val = nv_rd32(priv, SEL_VCO);
372 val &= ~(BIT(SEL_VCO_GPC2CLK_OUT_SHIFT));
374 nv_wr32(priv, SEL_VCO, val);
376 /* get out from IDDQ */
377 val = nv_rd32(priv, GPCPLL_CFG);
378 if (val & GPCPLL_CFG_IDDQ) {
379 val &= ~GPCPLL_CFG_IDDQ;
380 nv_wr32(priv, GPCPLL_CFG, val);
381 nv_rd32(priv, GPCPLL_CFG);
385 _gk20a_pllg_disable(priv);
387 nv_debug(priv, "%s: m=%d n=%d pl=%d\n", __func__, priv->m, priv->n,
390 n_lo = DIV_ROUND_UP(priv->m * priv->params->min_vco,
391 priv->parent_rate / MHZ);
392 val = priv->m << GPCPLL_COEFF_M_SHIFT;
393 val |= (allow_slide ? n_lo : priv->n) << GPCPLL_COEFF_N_SHIFT;
394 val |= priv->pl << GPCPLL_COEFF_P_SHIFT;
395 nv_wr32(priv, GPCPLL_COEFF, val);
397 _gk20a_pllg_enable(priv);
399 val = nv_rd32(priv, GPCPLL_CFG);
400 if (val & GPCPLL_CFG_LOCK_DET_OFF) {
401 val &= ~GPCPLL_CFG_LOCK_DET_OFF;
402 nv_wr32(priv, GPCPLL_CFG, val);
405 if (!nvkm_timer_wait_eq(priv, 300000, GPCPLL_CFG, GPCPLL_CFG_LOCK,
407 nv_error(priv, "%s: timeout waiting for pllg lock\n", __func__);
411 /* switch to VCO mode */
412 nv_mask(priv, SEL_VCO, 0, BIT(SEL_VCO_GPC2CLK_OUT_SHIFT));
414 /* restore out divider 1:1 */
415 val = nv_rd32(priv, GPC2CLK_OUT);
416 val &= ~GPC2CLK_OUT_VCODIV_MASK;
418 nv_wr32(priv, GPC2CLK_OUT, val);
420 /* slide up to new NDIV */
421 return allow_slide ? gk20a_pllg_slide(priv, priv->n) : 0;
425 gk20a_pllg_program_mnp(struct gk20a_clk_priv *priv)
429 err = _gk20a_pllg_program_mnp(priv, true);
431 err = _gk20a_pllg_program_mnp(priv, false);
437 gk20a_pllg_disable(struct gk20a_clk_priv *priv)
441 /* slide to VCO min */
442 val = nv_rd32(priv, GPCPLL_CFG);
443 if (val & GPCPLL_CFG_ENABLE) {
446 coeff = nv_rd32(priv, GPCPLL_COEFF);
447 m = (coeff >> GPCPLL_COEFF_M_SHIFT) & MASK(GPCPLL_COEFF_M_WIDTH);
448 n_lo = DIV_ROUND_UP(m * priv->params->min_vco,
449 priv->parent_rate / MHZ);
450 gk20a_pllg_slide(priv, n_lo);
453 /* put PLL in bypass before disabling it */
454 nv_mask(priv, SEL_VCO, BIT(SEL_VCO_GPC2CLK_OUT_SHIFT), 0);
456 _gk20a_pllg_disable(priv);
459 #define GK20A_CLK_GPC_MDIV 1000
461 static struct nvkm_domain
463 { nv_clk_src_crystal, 0xff },
464 { nv_clk_src_gpc, 0xff, 0, "core", GK20A_CLK_GPC_MDIV },
468 static struct nvkm_pstate
472 .domain[nv_clk_src_gpc] = 72000,
478 .domain[nv_clk_src_gpc] = 108000,
484 .domain[nv_clk_src_gpc] = 180000,
490 .domain[nv_clk_src_gpc] = 252000,
496 .domain[nv_clk_src_gpc] = 324000,
502 .domain[nv_clk_src_gpc] = 396000,
508 .domain[nv_clk_src_gpc] = 468000,
514 .domain[nv_clk_src_gpc] = 540000,
520 .domain[nv_clk_src_gpc] = 612000,
526 .domain[nv_clk_src_gpc] = 648000,
532 .domain[nv_clk_src_gpc] = 684000,
538 .domain[nv_clk_src_gpc] = 708000,
544 .domain[nv_clk_src_gpc] = 756000,
550 .domain[nv_clk_src_gpc] = 804000,
556 .domain[nv_clk_src_gpc] = 852000,
563 gk20a_clk_read(struct nvkm_clk *clk, enum nv_clk_src src)
565 struct gk20a_clk_priv *priv = (void *)clk;
568 case nv_clk_src_crystal:
569 return nv_device(clk)->crystal;
571 gk20a_pllg_read_mnp(priv);
572 return gk20a_pllg_calc_rate(priv) / GK20A_CLK_GPC_MDIV;
574 nv_error(clk, "invalid clock source %d\n", src);
580 gk20a_clk_calc(struct nvkm_clk *clk, struct nvkm_cstate *cstate)
582 struct gk20a_clk_priv *priv = (void *)clk;
584 return gk20a_pllg_calc_mnp(priv, cstate->domain[nv_clk_src_gpc] *
589 gk20a_clk_prog(struct nvkm_clk *clk)
591 struct gk20a_clk_priv *priv = (void *)clk;
593 return gk20a_pllg_program_mnp(priv);
597 gk20a_clk_tidy(struct nvkm_clk *clk)
602 gk20a_clk_fini(struct nvkm_object *object, bool suspend)
604 struct gk20a_clk_priv *priv = (void *)object;
607 ret = nvkm_clk_fini(&priv->base, false);
609 gk20a_pllg_disable(priv);
615 gk20a_clk_init(struct nvkm_object *object)
617 struct gk20a_clk_priv *priv = (void *)object;
620 nv_mask(priv, GPC2CLK_OUT, GPC2CLK_OUT_INIT_MASK, GPC2CLK_OUT_INIT_VAL);
622 ret = nvkm_clk_init(&priv->base);
626 ret = gk20a_clk_prog(&priv->base);
628 nv_error(priv, "cannot initialize clock\n");
636 gk20a_clk_ctor(struct nvkm_object *parent, struct nvkm_object *engine,
637 struct nvkm_oclass *oclass, void *data, u32 size,
638 struct nvkm_object **pobject)
640 struct gk20a_clk_priv *priv;
641 struct nouveau_platform_device *plat;
645 /* Finish initializing the pstates */
646 for (i = 0; i < ARRAY_SIZE(gk20a_pstates); i++) {
647 INIT_LIST_HEAD(&gk20a_pstates[i].list);
648 gk20a_pstates[i].pstate = i + 1;
651 ret = nvkm_clk_create(parent, engine, oclass, gk20a_domains,
652 gk20a_pstates, ARRAY_SIZE(gk20a_pstates),
654 *pobject = nv_object(priv);
658 priv->params = &gk20a_pllg_params;
660 plat = nv_device_to_platform(nv_device(parent));
661 priv->parent_rate = clk_get_rate(plat->gpu->clk);
662 nv_info(priv, "parent clock rate: %d Mhz\n", priv->parent_rate / MHZ);
664 priv->base.read = gk20a_clk_read;
665 priv->base.calc = gk20a_clk_calc;
666 priv->base.prog = gk20a_clk_prog;
667 priv->base.tidy = gk20a_clk_tidy;
673 .handle = NV_SUBDEV(CLK, 0xea),
674 .ofuncs = &(struct nvkm_ofuncs) {
675 .ctor = gk20a_clk_ctor,
676 .dtor = _nvkm_subdev_dtor,
677 .init = gk20a_clk_init,
678 .fini = gk20a_clk_fini,