GNU Linux-libre 4.9.317-gnu1
[releases.git] / drivers / cpufreq / s3c24xx-cpufreq.c
1 /*
2  * Copyright (c) 2006-2008 Simtec Electronics
3  *      http://armlinux.simtec.co.uk/
4  *      Ben Dooks <ben@simtec.co.uk>
5  *
6  * S3C24XX CPU Frequency scaling
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11 */
12
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/interrupt.h>
18 #include <linux/ioport.h>
19 #include <linux/cpufreq.h>
20 #include <linux/cpu.h>
21 #include <linux/clk.h>
22 #include <linux/err.h>
23 #include <linux/io.h>
24 #include <linux/device.h>
25 #include <linux/sysfs.h>
26 #include <linux/slab.h>
27
28 #include <asm/mach/arch.h>
29 #include <asm/mach/map.h>
30
31 #include <plat/cpu.h>
32 #include <plat/cpu-freq-core.h>
33
34 #include <mach/regs-clock.h>
35
36 /* note, cpufreq support deals in kHz, no Hz */
37
38 static struct cpufreq_driver s3c24xx_driver;
39 static struct s3c_cpufreq_config cpu_cur;
40 static struct s3c_iotimings s3c24xx_iotiming;
41 static struct cpufreq_frequency_table *pll_reg;
42 static unsigned int last_target = ~0;
43 static unsigned int ftab_size;
44 static struct cpufreq_frequency_table *ftab;
45
46 static struct clk *_clk_mpll;
47 static struct clk *_clk_xtal;
48 static struct clk *clk_fclk;
49 static struct clk *clk_hclk;
50 static struct clk *clk_pclk;
51 static struct clk *clk_arm;
52
53 #ifdef CONFIG_ARM_S3C24XX_CPUFREQ_DEBUGFS
54 struct s3c_cpufreq_config *s3c_cpufreq_getconfig(void)
55 {
56         return &cpu_cur;
57 }
58
59 struct s3c_iotimings *s3c_cpufreq_getiotimings(void)
60 {
61         return &s3c24xx_iotiming;
62 }
63 #endif /* CONFIG_ARM_S3C24XX_CPUFREQ_DEBUGFS */
64
65 static void s3c_cpufreq_getcur(struct s3c_cpufreq_config *cfg)
66 {
67         unsigned long fclk, pclk, hclk, armclk;
68
69         cfg->freq.fclk = fclk = clk_get_rate(clk_fclk);
70         cfg->freq.hclk = hclk = clk_get_rate(clk_hclk);
71         cfg->freq.pclk = pclk = clk_get_rate(clk_pclk);
72         cfg->freq.armclk = armclk = clk_get_rate(clk_arm);
73
74         cfg->pll.driver_data = __raw_readl(S3C2410_MPLLCON);
75         cfg->pll.frequency = fclk;
76
77         cfg->freq.hclk_tns = 1000000000 / (cfg->freq.hclk / 10);
78
79         cfg->divs.h_divisor = fclk / hclk;
80         cfg->divs.p_divisor = fclk / pclk;
81 }
82
83 static inline void s3c_cpufreq_calc(struct s3c_cpufreq_config *cfg)
84 {
85         unsigned long pll = cfg->pll.frequency;
86
87         cfg->freq.fclk = pll;
88         cfg->freq.hclk = pll / cfg->divs.h_divisor;
89         cfg->freq.pclk = pll / cfg->divs.p_divisor;
90
91         /* convert hclk into 10ths of nanoseconds for io calcs */
92         cfg->freq.hclk_tns = 1000000000 / (cfg->freq.hclk / 10);
93 }
94
95 static inline int closer(unsigned int target, unsigned int n, unsigned int c)
96 {
97         int diff_cur = abs(target - c);
98         int diff_new = abs(target - n);
99
100         return (diff_new < diff_cur);
101 }
102
103 static void s3c_cpufreq_show(const char *pfx,
104                                  struct s3c_cpufreq_config *cfg)
105 {
106         s3c_freq_dbg("%s: Fvco=%u, F=%lu, A=%lu, H=%lu (%u), P=%lu (%u)\n",
107                      pfx, cfg->pll.frequency, cfg->freq.fclk, cfg->freq.armclk,
108                      cfg->freq.hclk, cfg->divs.h_divisor,
109                      cfg->freq.pclk, cfg->divs.p_divisor);
110 }
111
112 /* functions to wrapper the driver info calls to do the cpu specific work */
113
114 static void s3c_cpufreq_setio(struct s3c_cpufreq_config *cfg)
115 {
116         if (cfg->info->set_iotiming)
117                 (cfg->info->set_iotiming)(cfg, &s3c24xx_iotiming);
118 }
119
120 static int s3c_cpufreq_calcio(struct s3c_cpufreq_config *cfg)
121 {
122         if (cfg->info->calc_iotiming)
123                 return (cfg->info->calc_iotiming)(cfg, &s3c24xx_iotiming);
124
125         return 0;
126 }
127
128 static void s3c_cpufreq_setrefresh(struct s3c_cpufreq_config *cfg)
129 {
130         (cfg->info->set_refresh)(cfg);
131 }
132
133 static void s3c_cpufreq_setdivs(struct s3c_cpufreq_config *cfg)
134 {
135         (cfg->info->set_divs)(cfg);
136 }
137
138 static int s3c_cpufreq_calcdivs(struct s3c_cpufreq_config *cfg)
139 {
140         return (cfg->info->calc_divs)(cfg);
141 }
142
143 static void s3c_cpufreq_setfvco(struct s3c_cpufreq_config *cfg)
144 {
145         cfg->mpll = _clk_mpll;
146         (cfg->info->set_fvco)(cfg);
147 }
148
149 static inline void s3c_cpufreq_updateclk(struct clk *clk,
150                                          unsigned int freq)
151 {
152         clk_set_rate(clk, freq);
153 }
154
155 static int s3c_cpufreq_settarget(struct cpufreq_policy *policy,
156                                  unsigned int target_freq,
157                                  struct cpufreq_frequency_table *pll)
158 {
159         struct s3c_cpufreq_freqs freqs;
160         struct s3c_cpufreq_config cpu_new;
161         unsigned long flags;
162
163         cpu_new = cpu_cur;  /* copy new from current */
164
165         s3c_cpufreq_show("cur", &cpu_cur);
166
167         /* TODO - check for DMA currently outstanding */
168
169         cpu_new.pll = pll ? *pll : cpu_cur.pll;
170
171         if (pll)
172                 freqs.pll_changing = 1;
173
174         /* update our frequencies */
175
176         cpu_new.freq.armclk = target_freq;
177         cpu_new.freq.fclk = cpu_new.pll.frequency;
178
179         if (s3c_cpufreq_calcdivs(&cpu_new) < 0) {
180                 pr_err("no divisors for %d\n", target_freq);
181                 goto err_notpossible;
182         }
183
184         s3c_freq_dbg("%s: got divs\n", __func__);
185
186         s3c_cpufreq_calc(&cpu_new);
187
188         s3c_freq_dbg("%s: calculated frequencies for new\n", __func__);
189
190         if (cpu_new.freq.hclk != cpu_cur.freq.hclk) {
191                 if (s3c_cpufreq_calcio(&cpu_new) < 0) {
192                         pr_err("%s: no IO timings\n", __func__);
193                         goto err_notpossible;
194                 }
195         }
196
197         s3c_cpufreq_show("new", &cpu_new);
198
199         /* setup our cpufreq parameters */
200
201         freqs.old = cpu_cur.freq;
202         freqs.new = cpu_new.freq;
203
204         freqs.freqs.old = cpu_cur.freq.armclk / 1000;
205         freqs.freqs.new = cpu_new.freq.armclk / 1000;
206
207         /* update f/h/p clock settings before we issue the change
208          * notification, so that drivers do not need to do anything
209          * special if they want to recalculate on CPUFREQ_PRECHANGE. */
210
211         s3c_cpufreq_updateclk(_clk_mpll, cpu_new.pll.frequency);
212         s3c_cpufreq_updateclk(clk_fclk, cpu_new.freq.fclk);
213         s3c_cpufreq_updateclk(clk_hclk, cpu_new.freq.hclk);
214         s3c_cpufreq_updateclk(clk_pclk, cpu_new.freq.pclk);
215
216         /* start the frequency change */
217         cpufreq_freq_transition_begin(policy, &freqs.freqs);
218
219         /* If hclk is staying the same, then we do not need to
220          * re-write the IO or the refresh timings whilst we are changing
221          * speed. */
222
223         local_irq_save(flags);
224
225         /* is our memory clock slowing down? */
226         if (cpu_new.freq.hclk < cpu_cur.freq.hclk) {
227                 s3c_cpufreq_setrefresh(&cpu_new);
228                 s3c_cpufreq_setio(&cpu_new);
229         }
230
231         if (cpu_new.freq.fclk == cpu_cur.freq.fclk) {
232                 /* not changing PLL, just set the divisors */
233
234                 s3c_cpufreq_setdivs(&cpu_new);
235         } else {
236                 if (cpu_new.freq.fclk < cpu_cur.freq.fclk) {
237                         /* slow the cpu down, then set divisors */
238
239                         s3c_cpufreq_setfvco(&cpu_new);
240                         s3c_cpufreq_setdivs(&cpu_new);
241                 } else {
242                         /* set the divisors, then speed up */
243
244                         s3c_cpufreq_setdivs(&cpu_new);
245                         s3c_cpufreq_setfvco(&cpu_new);
246                 }
247         }
248
249         /* did our memory clock speed up */
250         if (cpu_new.freq.hclk > cpu_cur.freq.hclk) {
251                 s3c_cpufreq_setrefresh(&cpu_new);
252                 s3c_cpufreq_setio(&cpu_new);
253         }
254
255         /* update our current settings */
256         cpu_cur = cpu_new;
257
258         local_irq_restore(flags);
259
260         /* notify everyone we've done this */
261         cpufreq_freq_transition_end(policy, &freqs.freqs, 0);
262
263         s3c_freq_dbg("%s: finished\n", __func__);
264         return 0;
265
266  err_notpossible:
267         pr_err("no compatible settings for %d\n", target_freq);
268         return -EINVAL;
269 }
270
271 /* s3c_cpufreq_target
272  *
273  * called by the cpufreq core to adjust the frequency that the CPU
274  * is currently running at.
275  */
276
277 static int s3c_cpufreq_target(struct cpufreq_policy *policy,
278                               unsigned int target_freq,
279                               unsigned int relation)
280 {
281         struct cpufreq_frequency_table *pll;
282         unsigned int index;
283
284         /* avoid repeated calls which cause a needless amout of duplicated
285          * logging output (and CPU time as the calculation process is
286          * done) */
287         if (target_freq == last_target)
288                 return 0;
289
290         last_target = target_freq;
291
292         s3c_freq_dbg("%s: policy %p, target %u, relation %u\n",
293                      __func__, policy, target_freq, relation);
294
295         if (ftab) {
296                 index = cpufreq_frequency_table_target(policy, target_freq,
297                                                        relation);
298
299                 s3c_freq_dbg("%s: adjust %d to entry %d (%u)\n", __func__,
300                              target_freq, index, ftab[index].frequency);
301                 target_freq = ftab[index].frequency;
302         }
303
304         target_freq *= 1000;  /* convert target to Hz */
305
306         /* find the settings for our new frequency */
307
308         if (!pll_reg || cpu_cur.lock_pll) {
309                 /* either we've not got any PLL values, or we've locked
310                  * to the current one. */
311                 pll = NULL;
312         } else {
313                 struct cpufreq_policy tmp_policy;
314
315                 /* we keep the cpu pll table in Hz, to ensure we get an
316                  * accurate value for the PLL output. */
317
318                 tmp_policy.min = policy->min * 1000;
319                 tmp_policy.max = policy->max * 1000;
320                 tmp_policy.cpu = policy->cpu;
321                 tmp_policy.freq_table = pll_reg;
322
323                 /* cpufreq_frequency_table_target returns the index
324                  * of the table entry, not the value of
325                  * the table entry's index field. */
326
327                 index = cpufreq_frequency_table_target(&tmp_policy, target_freq,
328                                                        relation);
329                 pll = pll_reg + index;
330
331                 s3c_freq_dbg("%s: target %u => %u\n",
332                              __func__, target_freq, pll->frequency);
333
334                 target_freq = pll->frequency;
335         }
336
337         return s3c_cpufreq_settarget(policy, target_freq, pll);
338 }
339
340 struct clk *s3c_cpufreq_clk_get(struct device *dev, const char *name)
341 {
342         struct clk *clk;
343
344         clk = clk_get(dev, name);
345         if (IS_ERR(clk))
346                 pr_err("failed to get clock '%s'\n", name);
347
348         return clk;
349 }
350
351 static int s3c_cpufreq_init(struct cpufreq_policy *policy)
352 {
353         policy->clk = clk_arm;
354
355         policy->cpuinfo.transition_latency = cpu_cur.info->latency;
356
357         if (ftab)
358                 return cpufreq_table_validate_and_show(policy, ftab);
359
360         return 0;
361 }
362
363 static int __init s3c_cpufreq_initclks(void)
364 {
365         _clk_mpll = s3c_cpufreq_clk_get(NULL, "mpll");
366         _clk_xtal = s3c_cpufreq_clk_get(NULL, "xtal");
367         clk_fclk = s3c_cpufreq_clk_get(NULL, "fclk");
368         clk_hclk = s3c_cpufreq_clk_get(NULL, "hclk");
369         clk_pclk = s3c_cpufreq_clk_get(NULL, "pclk");
370         clk_arm = s3c_cpufreq_clk_get(NULL, "armclk");
371
372         if (IS_ERR(clk_fclk) || IS_ERR(clk_hclk) || IS_ERR(clk_pclk) ||
373             IS_ERR(_clk_mpll) || IS_ERR(clk_arm) || IS_ERR(_clk_xtal)) {
374                 pr_err("%s: could not get clock(s)\n", __func__);
375                 return -ENOENT;
376         }
377
378         pr_info("%s: clocks f=%lu,h=%lu,p=%lu,a=%lu\n",
379                 __func__,
380                 clk_get_rate(clk_fclk) / 1000,
381                 clk_get_rate(clk_hclk) / 1000,
382                 clk_get_rate(clk_pclk) / 1000,
383                 clk_get_rate(clk_arm) / 1000);
384
385         return 0;
386 }
387
388 #ifdef CONFIG_PM
389 static struct cpufreq_frequency_table suspend_pll;
390 static unsigned int suspend_freq;
391
392 static int s3c_cpufreq_suspend(struct cpufreq_policy *policy)
393 {
394         suspend_pll.frequency = clk_get_rate(_clk_mpll);
395         suspend_pll.driver_data = __raw_readl(S3C2410_MPLLCON);
396         suspend_freq = clk_get_rate(clk_arm);
397
398         return 0;
399 }
400
401 static int s3c_cpufreq_resume(struct cpufreq_policy *policy)
402 {
403         int ret;
404
405         s3c_freq_dbg("%s: resuming with policy %p\n", __func__, policy);
406
407         last_target = ~0;       /* invalidate last_target setting */
408
409         /* whilst we will be called later on, we try and re-set the
410          * cpu frequencies as soon as possible so that we do not end
411          * up resuming devices and then immediately having to re-set
412          * a number of settings once these devices have restarted.
413          *
414          * as a note, it is expected devices are not used until they
415          * have been un-suspended and at that time they should have
416          * used the updated clock settings.
417          */
418
419         ret = s3c_cpufreq_settarget(NULL, suspend_freq, &suspend_pll);
420         if (ret) {
421                 pr_err("%s: failed to reset pll/freq\n", __func__);
422                 return ret;
423         }
424
425         return 0;
426 }
427 #else
428 #define s3c_cpufreq_resume NULL
429 #define s3c_cpufreq_suspend NULL
430 #endif
431
432 static struct cpufreq_driver s3c24xx_driver = {
433         .flags          = CPUFREQ_STICKY | CPUFREQ_NEED_INITIAL_FREQ_CHECK,
434         .target         = s3c_cpufreq_target,
435         .get            = cpufreq_generic_get,
436         .init           = s3c_cpufreq_init,
437         .suspend        = s3c_cpufreq_suspend,
438         .resume         = s3c_cpufreq_resume,
439         .name           = "s3c24xx",
440 };
441
442
443 int s3c_cpufreq_register(struct s3c_cpufreq_info *info)
444 {
445         if (!info || !info->name) {
446                 pr_err("%s: failed to pass valid information\n", __func__);
447                 return -EINVAL;
448         }
449
450         pr_info("S3C24XX CPU Frequency driver, %s cpu support\n",
451                 info->name);
452
453         /* check our driver info has valid data */
454
455         BUG_ON(info->set_refresh == NULL);
456         BUG_ON(info->set_divs == NULL);
457         BUG_ON(info->calc_divs == NULL);
458
459         /* info->set_fvco is optional, depending on whether there
460          * is a need to set the clock code. */
461
462         cpu_cur.info = info;
463
464         /* Note, driver registering should probably update locktime */
465
466         return 0;
467 }
468
469 int __init s3c_cpufreq_setboard(struct s3c_cpufreq_board *board)
470 {
471         struct s3c_cpufreq_board *ours;
472
473         if (!board) {
474                 pr_info("%s: no board data\n", __func__);
475                 return -EINVAL;
476         }
477
478         /* Copy the board information so that each board can make this
479          * initdata. */
480
481         ours = kzalloc(sizeof(*ours), GFP_KERNEL);
482         if (ours == NULL) {
483                 pr_err("%s: no memory\n", __func__);
484                 return -ENOMEM;
485         }
486
487         *ours = *board;
488         cpu_cur.board = ours;
489
490         return 0;
491 }
492
493 static int __init s3c_cpufreq_auto_io(void)
494 {
495         int ret;
496
497         if (!cpu_cur.info->get_iotiming) {
498                 pr_err("%s: get_iotiming undefined\n", __func__);
499                 return -ENOENT;
500         }
501
502         pr_info("%s: working out IO settings\n", __func__);
503
504         ret = (cpu_cur.info->get_iotiming)(&cpu_cur, &s3c24xx_iotiming);
505         if (ret)
506                 pr_err("%s: failed to get timings\n", __func__);
507
508         return ret;
509 }
510
511 /* if one or is zero, then return the other, otherwise return the min */
512 #define do_min(_a, _b) ((_a) == 0 ? (_b) : (_b) == 0 ? (_a) : min(_a, _b))
513
514 /**
515  * s3c_cpufreq_freq_min - find the minimum settings for the given freq.
516  * @dst: The destination structure
517  * @a: One argument.
518  * @b: The other argument.
519  *
520  * Create a minimum of each frequency entry in the 'struct s3c_freq',
521  * unless the entry is zero when it is ignored and the non-zero argument
522  * used.
523  */
524 static void s3c_cpufreq_freq_min(struct s3c_freq *dst,
525                                  struct s3c_freq *a, struct s3c_freq *b)
526 {
527         dst->fclk = do_min(a->fclk, b->fclk);
528         dst->hclk = do_min(a->hclk, b->hclk);
529         dst->pclk = do_min(a->pclk, b->pclk);
530         dst->armclk = do_min(a->armclk, b->armclk);
531 }
532
533 static inline u32 calc_locktime(u32 freq, u32 time_us)
534 {
535         u32 result;
536
537         result = freq * time_us;
538         result = DIV_ROUND_UP(result, 1000 * 1000);
539
540         return result;
541 }
542
543 static void s3c_cpufreq_update_loctkime(void)
544 {
545         unsigned int bits = cpu_cur.info->locktime_bits;
546         u32 rate = (u32)clk_get_rate(_clk_xtal);
547         u32 val;
548
549         if (bits == 0) {
550                 WARN_ON(1);
551                 return;
552         }
553
554         val = calc_locktime(rate, cpu_cur.info->locktime_u) << bits;
555         val |= calc_locktime(rate, cpu_cur.info->locktime_m);
556
557         pr_info("%s: new locktime is 0x%08x\n", __func__, val);
558         __raw_writel(val, S3C2410_LOCKTIME);
559 }
560
561 static int s3c_cpufreq_build_freq(void)
562 {
563         int size, ret;
564
565         kfree(ftab);
566
567         size = cpu_cur.info->calc_freqtable(&cpu_cur, NULL, 0);
568         size++;
569
570         ftab = kzalloc(sizeof(*ftab) * size, GFP_KERNEL);
571         if (!ftab) {
572                 pr_err("%s: no memory for tables\n", __func__);
573                 return -ENOMEM;
574         }
575
576         ftab_size = size;
577
578         ret = cpu_cur.info->calc_freqtable(&cpu_cur, ftab, size);
579         s3c_cpufreq_addfreq(ftab, ret, size, CPUFREQ_TABLE_END);
580
581         return 0;
582 }
583
584 static int __init s3c_cpufreq_initcall(void)
585 {
586         int ret = 0;
587
588         if (cpu_cur.info && cpu_cur.board) {
589                 ret = s3c_cpufreq_initclks();
590                 if (ret)
591                         goto out;
592
593                 /* get current settings */
594                 s3c_cpufreq_getcur(&cpu_cur);
595                 s3c_cpufreq_show("cur", &cpu_cur);
596
597                 if (cpu_cur.board->auto_io) {
598                         ret = s3c_cpufreq_auto_io();
599                         if (ret) {
600                                 pr_err("%s: failed to get io timing\n",
601                                        __func__);
602                                 goto out;
603                         }
604                 }
605
606                 if (cpu_cur.board->need_io && !cpu_cur.info->set_iotiming) {
607                         pr_err("%s: no IO support registered\n", __func__);
608                         ret = -EINVAL;
609                         goto out;
610                 }
611
612                 if (!cpu_cur.info->need_pll)
613                         cpu_cur.lock_pll = 1;
614
615                 s3c_cpufreq_update_loctkime();
616
617                 s3c_cpufreq_freq_min(&cpu_cur.max, &cpu_cur.board->max,
618                                      &cpu_cur.info->max);
619
620                 if (cpu_cur.info->calc_freqtable)
621                         s3c_cpufreq_build_freq();
622
623                 ret = cpufreq_register_driver(&s3c24xx_driver);
624         }
625
626  out:
627         return ret;
628 }
629
630 late_initcall(s3c_cpufreq_initcall);
631
632 /**
633  * s3c_plltab_register - register CPU PLL table.
634  * @plls: The list of PLL entries.
635  * @plls_no: The size of the PLL entries @plls.
636  *
637  * Register the given set of PLLs with the system.
638  */
639 int s3c_plltab_register(struct cpufreq_frequency_table *plls,
640                                unsigned int plls_no)
641 {
642         struct cpufreq_frequency_table *vals;
643         unsigned int size;
644
645         size = sizeof(*vals) * (plls_no + 1);
646
647         vals = kzalloc(size, GFP_KERNEL);
648         if (vals) {
649                 memcpy(vals, plls, size);
650                 pll_reg = vals;
651
652                 /* write a terminating entry, we don't store it in the
653                  * table that is stored in the kernel */
654                 vals += plls_no;
655                 vals->frequency = CPUFREQ_TABLE_END;
656
657                 pr_info("%d PLL entries\n", plls_no);
658         } else
659                 pr_err("no memory for PLL tables\n");
660
661         return vals ? 0 : -ENOMEM;
662 }