2 * Copyright (C) 2002 - 2005 Benjamin Herrenschmidt <benh@kernel.crashing.org>
3 * and Markus Demleitner <msdemlei@cl.uni-heidelberg.de>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This driver adds basic cpufreq support for SMU & 970FX based G5 Macs,
10 * that is iMac G5 and latest single CPU desktop.
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <linux/errno.h>
18 #include <linux/kernel.h>
19 #include <linux/delay.h>
20 #include <linux/sched.h>
21 #include <linux/slab.h>
22 #include <linux/cpufreq.h>
23 #include <linux/init.h>
24 #include <linux/completion.h>
25 #include <linux/mutex.h>
27 #include <asm/machdep.h>
29 #include <asm/sections.h>
30 #include <asm/cputable.h>
33 #include <asm/pmac_pfunc.h>
35 #define DBG(fmt...) pr_debug(fmt)
37 /* see 970FX user manual */
39 #define SCOM_PCR 0x0aa001 /* PCR scom addr */
41 #define PCR_HILO_SELECT 0x80000000U /* 1 = PCR, 0 = PCRH */
42 #define PCR_SPEED_FULL 0x00000000U /* 1:1 speed value */
43 #define PCR_SPEED_HALF 0x00020000U /* 1:2 speed value */
44 #define PCR_SPEED_QUARTER 0x00040000U /* 1:4 speed value */
45 #define PCR_SPEED_MASK 0x000e0000U /* speed mask */
46 #define PCR_SPEED_SHIFT 17
47 #define PCR_FREQ_REQ_VALID 0x00010000U /* freq request valid */
48 #define PCR_VOLT_REQ_VALID 0x00008000U /* volt request valid */
49 #define PCR_TARGET_TIME_MASK 0x00006000U /* target time */
50 #define PCR_STATLAT_MASK 0x00001f00U /* STATLAT value */
51 #define PCR_SNOOPLAT_MASK 0x000000f0U /* SNOOPLAT value */
52 #define PCR_SNOOPACC_MASK 0x0000000fU /* SNOOPACC value */
54 #define SCOM_PSR 0x408001 /* PSR scom addr */
55 /* warning: PSR is a 64 bits register */
56 #define PSR_CMD_RECEIVED 0x2000000000000000U /* command received */
57 #define PSR_CMD_COMPLETED 0x1000000000000000U /* command completed */
58 #define PSR_CUR_SPEED_MASK 0x0300000000000000U /* current speed */
59 #define PSR_CUR_SPEED_SHIFT (56)
62 * The G5 only supports two frequencies (Quarter speed is not supported)
64 #define CPUFREQ_HIGH 0
67 static struct cpufreq_frequency_table g5_cpu_freqs[] = {
70 {0, CPUFREQ_TABLE_END},
73 static struct freq_attr* g5_cpu_freqs_attr[] = {
74 &cpufreq_freq_attr_scaling_available_freqs,
78 /* Power mode data is an array of the 32 bits PCR values to use for
79 * the various frequencies, retrieved from the device-tree
81 static int g5_pmode_cur;
83 static void (*g5_switch_volt)(int speed_mode);
84 static int (*g5_switch_freq)(int speed_mode);
85 static int (*g5_query_freq)(void);
87 static DEFINE_MUTEX(g5_switch_mutex);
90 #ifdef CONFIG_PMAC_SMU
92 static const u32 *g5_pmode_data;
93 static int g5_pmode_max;
95 static struct smu_sdbp_fvt *g5_fvt_table; /* table of op. points */
96 static int g5_fvt_count; /* number of op. points */
97 static int g5_fvt_cur; /* current op. point */
100 * SMU based voltage switching for Neo2 platforms
103 static void g5_smu_switch_volt(int speed_mode)
105 struct smu_simple_cmd cmd;
107 DECLARE_COMPLETION_ONSTACK(comp);
108 smu_queue_simple(&cmd, SMU_CMD_POWER_COMMAND, 8, smu_done_complete,
109 &comp, 'V', 'S', 'L', 'E', 'W',
110 0xff, g5_fvt_cur+1, speed_mode);
111 wait_for_completion(&comp);
115 * Platform function based voltage/vdnap switching for Neo2
118 static struct pmf_function *pfunc_set_vdnap0;
119 static struct pmf_function *pfunc_vdnap0_complete;
121 static void g5_vdnap_switch_volt(int speed_mode)
123 struct pmf_args args;
125 unsigned long timeout;
127 slew = (speed_mode == CPUFREQ_LOW) ? 1 : 0;
131 pmf_call_one(pfunc_set_vdnap0, &args);
133 /* It's an irq GPIO so we should be able to just block here,
134 * I'll do that later after I've properly tested the IRQ code for
137 timeout = jiffies + HZ/10;
138 while(!time_after(jiffies, timeout)) {
141 pmf_call_one(pfunc_vdnap0_complete, &args);
147 printk(KERN_WARNING "cpufreq: Timeout in clock slewing !\n");
152 * SCOM based frequency switching for 970FX rev3
154 static int g5_scom_switch_freq(int speed_mode)
159 /* If frequency is going up, first ramp up the voltage */
160 if (speed_mode < g5_pmode_cur)
161 g5_switch_volt(speed_mode);
163 local_irq_save(flags);
166 scom970_write(SCOM_PCR, 0);
168 scom970_write(SCOM_PCR, PCR_HILO_SELECT | 0);
170 scom970_write(SCOM_PCR, PCR_HILO_SELECT |
171 g5_pmode_data[speed_mode]);
173 /* Wait for completion */
174 for (to = 0; to < 10; to++) {
175 unsigned long psr = scom970_read(SCOM_PSR);
177 if ((psr & PSR_CMD_RECEIVED) == 0 &&
178 (((psr >> PSR_CUR_SPEED_SHIFT) ^
179 (g5_pmode_data[speed_mode] >> PCR_SPEED_SHIFT)) & 0x3)
182 if (psr & PSR_CMD_COMPLETED)
187 local_irq_restore(flags);
189 /* If frequency is going down, last ramp the voltage */
190 if (speed_mode > g5_pmode_cur)
191 g5_switch_volt(speed_mode);
193 g5_pmode_cur = speed_mode;
194 ppc_proc_freq = g5_cpu_freqs[speed_mode].frequency * 1000ul;
199 static int g5_scom_query_freq(void)
201 unsigned long psr = scom970_read(SCOM_PSR);
204 for (i = 0; i <= g5_pmode_max; i++)
205 if ((((psr >> PSR_CUR_SPEED_SHIFT) ^
206 (g5_pmode_data[i] >> PCR_SPEED_SHIFT)) & 0x3) == 0)
212 * Fake voltage switching for platforms with missing support
215 static void g5_dummy_switch_volt(int speed_mode)
219 #endif /* CONFIG_PMAC_SMU */
222 * Platform function based voltage switching for PowerMac7,2 & 7,3
225 static struct pmf_function *pfunc_cpu0_volt_high;
226 static struct pmf_function *pfunc_cpu0_volt_low;
227 static struct pmf_function *pfunc_cpu1_volt_high;
228 static struct pmf_function *pfunc_cpu1_volt_low;
230 static void g5_pfunc_switch_volt(int speed_mode)
232 if (speed_mode == CPUFREQ_HIGH) {
233 if (pfunc_cpu0_volt_high)
234 pmf_call_one(pfunc_cpu0_volt_high, NULL);
235 if (pfunc_cpu1_volt_high)
236 pmf_call_one(pfunc_cpu1_volt_high, NULL);
238 if (pfunc_cpu0_volt_low)
239 pmf_call_one(pfunc_cpu0_volt_low, NULL);
240 if (pfunc_cpu1_volt_low)
241 pmf_call_one(pfunc_cpu1_volt_low, NULL);
243 msleep(10); /* should be faster , to fix */
247 * Platform function based frequency switching for PowerMac7,2 & 7,3
250 static struct pmf_function *pfunc_cpu_setfreq_high;
251 static struct pmf_function *pfunc_cpu_setfreq_low;
252 static struct pmf_function *pfunc_cpu_getfreq;
253 static struct pmf_function *pfunc_slewing_done;;
255 static int g5_pfunc_switch_freq(int speed_mode)
257 struct pmf_args args;
259 unsigned long timeout;
262 DBG("g5_pfunc_switch_freq(%d)\n", speed_mode);
264 /* If frequency is going up, first ramp up the voltage */
265 if (speed_mode < g5_pmode_cur)
266 g5_switch_volt(speed_mode);
269 if (speed_mode == CPUFREQ_HIGH)
270 rc = pmf_call_one(pfunc_cpu_setfreq_high, NULL);
272 rc = pmf_call_one(pfunc_cpu_setfreq_low, NULL);
275 printk(KERN_WARNING "cpufreq: pfunc switch error %d\n", rc);
277 /* It's an irq GPIO so we should be able to just block here,
278 * I'll do that later after I've properly tested the IRQ code for
281 timeout = jiffies + HZ/10;
282 while(!time_after(jiffies, timeout)) {
285 pmf_call_one(pfunc_slewing_done, &args);
291 printk(KERN_WARNING "cpufreq: Timeout in clock slewing !\n");
293 /* If frequency is going down, last ramp the voltage */
294 if (speed_mode > g5_pmode_cur)
295 g5_switch_volt(speed_mode);
297 g5_pmode_cur = speed_mode;
298 ppc_proc_freq = g5_cpu_freqs[speed_mode].frequency * 1000ul;
303 static int g5_pfunc_query_freq(void)
305 struct pmf_args args;
310 pmf_call_one(pfunc_cpu_getfreq, &args);
311 return val ? CPUFREQ_HIGH : CPUFREQ_LOW;
316 * Common interface to the cpufreq core
319 static int g5_cpufreq_verify(struct cpufreq_policy *policy)
321 return cpufreq_frequency_table_verify(policy, g5_cpu_freqs);
324 static int g5_cpufreq_target(struct cpufreq_policy *policy,
325 unsigned int target_freq, unsigned int relation)
327 unsigned int newstate = 0;
328 struct cpufreq_freqs freqs;
331 if (cpufreq_frequency_table_target(policy, g5_cpu_freqs,
332 target_freq, relation, &newstate))
335 if (g5_pmode_cur == newstate)
338 mutex_lock(&g5_switch_mutex);
340 freqs.old = g5_cpu_freqs[g5_pmode_cur].frequency;
341 freqs.new = g5_cpu_freqs[newstate].frequency;
344 cpufreq_notify_transition(&freqs, CPUFREQ_PRECHANGE);
345 rc = g5_switch_freq(newstate);
346 cpufreq_notify_transition(&freqs, CPUFREQ_POSTCHANGE);
348 mutex_unlock(&g5_switch_mutex);
353 static unsigned int g5_cpufreq_get_speed(unsigned int cpu)
355 return g5_cpu_freqs[g5_pmode_cur].frequency;
358 static int g5_cpufreq_cpu_init(struct cpufreq_policy *policy)
360 policy->cpuinfo.transition_latency = CPUFREQ_ETERNAL;
361 policy->cur = g5_cpu_freqs[g5_query_freq()].frequency;
362 /* secondary CPUs are tied to the primary one by the
363 * cpufreq core if in the secondary policy we tell it that
364 * it actually must be one policy together with all others. */
365 cpumask_copy(policy->cpus, &cpu_online_map);
366 cpufreq_frequency_table_get_attr(g5_cpu_freqs, policy->cpu);
368 return cpufreq_frequency_table_cpuinfo(policy,
373 static struct cpufreq_driver g5_cpufreq_driver = {
375 .owner = THIS_MODULE,
376 .flags = CPUFREQ_CONST_LOOPS,
377 .init = g5_cpufreq_cpu_init,
378 .verify = g5_cpufreq_verify,
379 .target = g5_cpufreq_target,
380 .get = g5_cpufreq_get_speed,
381 .attr = g5_cpu_freqs_attr,
385 #ifdef CONFIG_PMAC_SMU
387 static int __init g5_neo2_cpufreq_init(struct device_node *cpus)
389 struct device_node *cpunode;
390 unsigned int psize, ssize;
391 unsigned long max_freq;
392 char *freq_method, *volt_method;
395 int use_volts_vdnap = 0;
396 int use_volts_smu = 0;
399 /* Check supported platforms */
400 if (machine_is_compatible("PowerMac8,1") ||
401 machine_is_compatible("PowerMac8,2") ||
402 machine_is_compatible("PowerMac9,1"))
404 else if (machine_is_compatible("PowerMac11,2"))
409 /* Get first CPU node */
411 (cpunode = of_get_next_child(cpus, cpunode)) != NULL;) {
412 const u32 *reg = of_get_property(cpunode, "reg", NULL);
413 if (reg == NULL || (*reg) != 0)
415 if (!strcmp(cpunode->type, "cpu"))
418 if (cpunode == NULL) {
419 printk(KERN_ERR "cpufreq: Can't find any CPU 0 node\n");
423 /* Check 970FX for now */
424 valp = of_get_property(cpunode, "cpu-version", NULL);
426 DBG("No cpu-version property !\n");
429 pvr_hi = (*valp) >> 16;
430 if (pvr_hi != 0x3c && pvr_hi != 0x44) {
431 printk(KERN_ERR "cpufreq: Unsupported CPU version\n");
435 /* Look for the powertune data in the device-tree */
436 g5_pmode_data = of_get_property(cpunode, "power-mode-data",&psize);
437 if (!g5_pmode_data) {
438 DBG("No power-mode-data !\n");
441 g5_pmode_max = psize / sizeof(u32) - 1;
444 const struct smu_sdbp_header *shdr;
446 /* Look for the FVT table */
447 shdr = smu_get_sdb_partition(SMU_SDB_FVT_ID, NULL);
450 g5_fvt_table = (struct smu_sdbp_fvt *)&shdr[1];
451 ssize = (shdr->len * sizeof(u32)) -
452 sizeof(struct smu_sdbp_header);
453 g5_fvt_count = ssize / sizeof(struct smu_sdbp_fvt);
456 /* Sanity checking */
457 if (g5_fvt_count < 1 || g5_pmode_max < 1)
460 g5_switch_volt = g5_smu_switch_volt;
462 } else if (use_volts_vdnap) {
463 struct device_node *root;
465 root = of_find_node_by_path("/");
467 printk(KERN_ERR "cpufreq: Can't find root of "
471 pfunc_set_vdnap0 = pmf_find_function(root, "set-vdnap0");
472 pfunc_vdnap0_complete =
473 pmf_find_function(root, "slewing-done");
474 if (pfunc_set_vdnap0 == NULL ||
475 pfunc_vdnap0_complete == NULL) {
476 printk(KERN_ERR "cpufreq: Can't find required "
477 "platform function\n");
481 g5_switch_volt = g5_vdnap_switch_volt;
482 volt_method = "GPIO";
484 g5_switch_volt = g5_dummy_switch_volt;
485 volt_method = "none";
489 * From what I see, clock-frequency is always the maximal frequency.
490 * The current driver can not slew sysclk yet, so we really only deal
491 * with powertune steps for now. We also only implement full freq and
492 * half freq in this version. So far, I haven't yet seen a machine
493 * supporting anything else.
495 valp = of_get_property(cpunode, "clock-frequency", NULL);
498 max_freq = (*valp)/1000;
499 g5_cpu_freqs[0].frequency = max_freq;
500 g5_cpu_freqs[1].frequency = max_freq/2;
503 g5_switch_freq = g5_scom_switch_freq;
504 g5_query_freq = g5_scom_query_freq;
505 freq_method = "SCOM";
507 /* Force apply current frequency to make sure everything is in
508 * sync (voltage is right for example). Firmware may leave us with
509 * a strange setting ...
511 g5_switch_volt(CPUFREQ_HIGH);
514 g5_switch_freq(g5_query_freq());
516 printk(KERN_INFO "Registering G5 CPU frequency driver\n");
517 printk(KERN_INFO "Frequency method: %s, Voltage method: %s\n",
518 freq_method, volt_method);
519 printk(KERN_INFO "Low: %d Mhz, High: %d Mhz, Cur: %d MHz\n",
520 g5_cpu_freqs[1].frequency/1000,
521 g5_cpu_freqs[0].frequency/1000,
522 g5_cpu_freqs[g5_pmode_cur].frequency/1000);
524 rc = cpufreq_register_driver(&g5_cpufreq_driver);
526 /* We keep the CPU node on hold... hopefully, Apple G5 don't have
527 * hotplug CPU with a dynamic device-tree ...
532 of_node_put(cpunode);
537 #endif /* CONFIG_PMAC_SMU */
540 static int __init g5_pm72_cpufreq_init(struct device_node *cpus)
542 struct device_node *cpuid = NULL, *hwclock = NULL, *cpunode = NULL;
543 const u8 *eeprom = NULL;
545 u64 max_freq, min_freq, ih, il;
546 int has_volt = 1, rc = 0;
548 DBG("cpufreq: Initializing for PowerMac7,2, PowerMac7,3 and"
551 /* Get first CPU node */
553 (cpunode = of_get_next_child(cpus, cpunode)) != NULL;) {
554 if (!strcmp(cpunode->type, "cpu"))
557 if (cpunode == NULL) {
558 printk(KERN_ERR "cpufreq: Can't find any CPU node\n");
562 /* Lookup the cpuid eeprom node */
563 cpuid = of_find_node_by_path("/u3@0,f8000000/i2c@f8001000/cpuid@a0");
565 eeprom = of_get_property(cpuid, "cpuid", NULL);
566 if (eeprom == NULL) {
567 printk(KERN_ERR "cpufreq: Can't find cpuid EEPROM !\n");
572 /* Lookup the i2c hwclock */
574 (hwclock = of_find_node_by_name(hwclock, "i2c-hwclock")) != NULL;){
575 const char *loc = of_get_property(hwclock,
576 "hwctrl-location", NULL);
579 if (strcmp(loc, "CPU CLOCK"))
581 if (!of_get_property(hwclock, "platform-get-frequency", NULL))
585 if (hwclock == NULL) {
586 printk(KERN_ERR "cpufreq: Can't find i2c clock chip !\n");
591 DBG("cpufreq: i2c clock chip found: %s\n", hwclock->full_name);
593 /* Now get all the platform functions */
595 pmf_find_function(hwclock, "get-frequency");
596 pfunc_cpu_setfreq_high =
597 pmf_find_function(hwclock, "set-frequency-high");
598 pfunc_cpu_setfreq_low =
599 pmf_find_function(hwclock, "set-frequency-low");
601 pmf_find_function(hwclock, "slewing-done");
602 pfunc_cpu0_volt_high =
603 pmf_find_function(hwclock, "set-voltage-high-0");
604 pfunc_cpu0_volt_low =
605 pmf_find_function(hwclock, "set-voltage-low-0");
606 pfunc_cpu1_volt_high =
607 pmf_find_function(hwclock, "set-voltage-high-1");
608 pfunc_cpu1_volt_low =
609 pmf_find_function(hwclock, "set-voltage-low-1");
611 /* Check we have minimum requirements */
612 if (pfunc_cpu_getfreq == NULL || pfunc_cpu_setfreq_high == NULL ||
613 pfunc_cpu_setfreq_low == NULL || pfunc_slewing_done == NULL) {
614 printk(KERN_ERR "cpufreq: Can't find platform functions !\n");
619 /* Check that we have complete sets */
620 if (pfunc_cpu0_volt_high == NULL || pfunc_cpu0_volt_low == NULL) {
621 pmf_put_function(pfunc_cpu0_volt_high);
622 pmf_put_function(pfunc_cpu0_volt_low);
623 pfunc_cpu0_volt_high = pfunc_cpu0_volt_low = NULL;
627 pfunc_cpu1_volt_high == NULL || pfunc_cpu1_volt_low == NULL) {
628 pmf_put_function(pfunc_cpu1_volt_high);
629 pmf_put_function(pfunc_cpu1_volt_low);
630 pfunc_cpu1_volt_high = pfunc_cpu1_volt_low = NULL;
633 /* Note: The device tree also contains a "platform-set-values"
634 * function for which I haven't quite figured out the usage. It
635 * might have to be called on init and/or wakeup, I'm not too sure
636 * but things seem to work fine without it so far ...
639 /* Get max frequency from device-tree */
640 valp = of_get_property(cpunode, "clock-frequency", NULL);
642 printk(KERN_ERR "cpufreq: Can't find CPU frequency !\n");
647 max_freq = (*valp)/1000;
649 /* Now calculate reduced frequency by using the cpuid input freq
650 * ratio. This requires 64 bits math unless we are willing to lose
653 ih = *((u32 *)(eeprom + 0x10));
654 il = *((u32 *)(eeprom + 0x20));
656 /* Check for machines with no useful settings */
658 printk(KERN_WARNING "cpufreq: No low frequency mode available"
659 " on this model !\n");
665 if (ih != 0 && il != 0)
666 min_freq = (max_freq * il) / ih;
669 if (min_freq >= max_freq || min_freq < 1000) {
670 printk(KERN_ERR "cpufreq: Can't calculate low frequency !\n");
674 g5_cpu_freqs[0].frequency = max_freq;
675 g5_cpu_freqs[1].frequency = min_freq;
678 g5_switch_volt = g5_pfunc_switch_volt;
679 g5_switch_freq = g5_pfunc_switch_freq;
680 g5_query_freq = g5_pfunc_query_freq;
682 /* Force apply current frequency to make sure everything is in
683 * sync (voltage is right for example). Firmware may leave us with
684 * a strange setting ...
686 g5_switch_volt(CPUFREQ_HIGH);
689 g5_switch_freq(g5_query_freq());
691 printk(KERN_INFO "Registering G5 CPU frequency driver\n");
692 printk(KERN_INFO "Frequency method: i2c/pfunc, "
693 "Voltage method: %s\n", has_volt ? "i2c/pfunc" : "none");
694 printk(KERN_INFO "Low: %d Mhz, High: %d Mhz, Cur: %d MHz\n",
695 g5_cpu_freqs[1].frequency/1000,
696 g5_cpu_freqs[0].frequency/1000,
697 g5_cpu_freqs[g5_pmode_cur].frequency/1000);
699 rc = cpufreq_register_driver(&g5_cpufreq_driver);
702 pmf_put_function(pfunc_cpu_getfreq);
703 pmf_put_function(pfunc_cpu_setfreq_high);
704 pmf_put_function(pfunc_cpu_setfreq_low);
705 pmf_put_function(pfunc_slewing_done);
706 pmf_put_function(pfunc_cpu0_volt_high);
707 pmf_put_function(pfunc_cpu0_volt_low);
708 pmf_put_function(pfunc_cpu1_volt_high);
709 pmf_put_function(pfunc_cpu1_volt_low);
711 of_node_put(hwclock);
713 of_node_put(cpunode);
718 static int __init g5_cpufreq_init(void)
720 struct device_node *cpus;
723 cpus = of_find_node_by_path("/cpus");
725 DBG("No /cpus node !\n");
729 if (machine_is_compatible("PowerMac7,2") ||
730 machine_is_compatible("PowerMac7,3") ||
731 machine_is_compatible("RackMac3,1"))
732 rc = g5_pm72_cpufreq_init(cpus);
733 #ifdef CONFIG_PMAC_SMU
735 rc = g5_neo2_cpufreq_init(cpus);
736 #endif /* CONFIG_PMAC_SMU */
742 module_init(g5_cpufreq_init);
745 MODULE_LICENSE("GPL");