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/cpufreq.h>
22 #include <linux/init.h>
23 #include <linux/completion.h>
24 #include <linux/mutex.h>
26 #include <asm/machdep.h>
28 #include <asm/sections.h>
29 #include <asm/cputable.h>
32 #include <asm/pmac_pfunc.h>
34 #define DBG(fmt...) pr_debug(fmt)
36 /* see 970FX user manual */
38 #define SCOM_PCR 0x0aa001 /* PCR scom addr */
40 #define PCR_HILO_SELECT 0x80000000U /* 1 = PCR, 0 = PCRH */
41 #define PCR_SPEED_FULL 0x00000000U /* 1:1 speed value */
42 #define PCR_SPEED_HALF 0x00020000U /* 1:2 speed value */
43 #define PCR_SPEED_QUARTER 0x00040000U /* 1:4 speed value */
44 #define PCR_SPEED_MASK 0x000e0000U /* speed mask */
45 #define PCR_SPEED_SHIFT 17
46 #define PCR_FREQ_REQ_VALID 0x00010000U /* freq request valid */
47 #define PCR_VOLT_REQ_VALID 0x00008000U /* volt request valid */
48 #define PCR_TARGET_TIME_MASK 0x00006000U /* target time */
49 #define PCR_STATLAT_MASK 0x00001f00U /* STATLAT value */
50 #define PCR_SNOOPLAT_MASK 0x000000f0U /* SNOOPLAT value */
51 #define PCR_SNOOPACC_MASK 0x0000000fU /* SNOOPACC value */
53 #define SCOM_PSR 0x408001 /* PSR scom addr */
54 /* warning: PSR is a 64 bits register */
55 #define PSR_CMD_RECEIVED 0x2000000000000000U /* command received */
56 #define PSR_CMD_COMPLETED 0x1000000000000000U /* command completed */
57 #define PSR_CUR_SPEED_MASK 0x0300000000000000U /* current speed */
58 #define PSR_CUR_SPEED_SHIFT (56)
61 * The G5 only supports two frequencies (Quarter speed is not supported)
63 #define CPUFREQ_HIGH 0
66 static struct cpufreq_frequency_table g5_cpu_freqs
[] = {
69 {0, CPUFREQ_TABLE_END
},
72 static struct freq_attr
* g5_cpu_freqs_attr
[] = {
73 &cpufreq_freq_attr_scaling_available_freqs
,
77 /* Power mode data is an array of the 32 bits PCR values to use for
78 * the various frequencies, retrieved from the device-tree
80 static int g5_pmode_cur
;
82 static void (*g5_switch_volt
)(int speed_mode
);
83 static int (*g5_switch_freq
)(int speed_mode
);
84 static int (*g5_query_freq
)(void);
86 static DEFINE_MUTEX(g5_switch_mutex
);
88 static unsigned long transition_latency
;
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
;
343 cpufreq_notify_transition(policy
, &freqs
, CPUFREQ_PRECHANGE
);
344 rc
= g5_switch_freq(newstate
);
345 cpufreq_notify_transition(policy
, &freqs
, CPUFREQ_POSTCHANGE
);
347 mutex_unlock(&g5_switch_mutex
);
352 static unsigned int g5_cpufreq_get_speed(unsigned int cpu
)
354 return g5_cpu_freqs
[g5_pmode_cur
].frequency
;
357 static int g5_cpufreq_cpu_init(struct cpufreq_policy
*policy
)
359 policy
->cpuinfo
.transition_latency
= transition_latency
;
360 policy
->cur
= g5_cpu_freqs
[g5_query_freq()].frequency
;
361 /* secondary CPUs are tied to the primary one by the
362 * cpufreq core if in the secondary policy we tell it that
363 * it actually must be one policy together with all others. */
364 cpumask_copy(policy
->cpus
, cpu_online_mask
);
365 cpufreq_frequency_table_get_attr(g5_cpu_freqs
, policy
->cpu
);
367 return cpufreq_frequency_table_cpuinfo(policy
,
372 static struct cpufreq_driver g5_cpufreq_driver
= {
374 .owner
= THIS_MODULE
,
375 .flags
= CPUFREQ_CONST_LOOPS
,
376 .init
= g5_cpufreq_cpu_init
,
377 .verify
= g5_cpufreq_verify
,
378 .target
= g5_cpufreq_target
,
379 .get
= g5_cpufreq_get_speed
,
380 .attr
= g5_cpu_freqs_attr
,
384 #ifdef CONFIG_PMAC_SMU
386 static int __init
g5_neo2_cpufreq_init(struct device_node
*cpus
)
388 struct device_node
*cpunode
;
389 unsigned int psize
, ssize
;
390 unsigned long max_freq
;
391 char *freq_method
, *volt_method
;
394 int use_volts_vdnap
= 0;
395 int use_volts_smu
= 0;
398 /* Check supported platforms */
399 if (of_machine_is_compatible("PowerMac8,1") ||
400 of_machine_is_compatible("PowerMac8,2") ||
401 of_machine_is_compatible("PowerMac9,1"))
403 else if (of_machine_is_compatible("PowerMac11,2"))
408 /* Get first CPU node */
410 (cpunode
= of_get_next_child(cpus
, cpunode
)) != NULL
;) {
411 const u32
*reg
= of_get_property(cpunode
, "reg", NULL
);
412 if (reg
== NULL
|| (*reg
) != 0)
414 if (!strcmp(cpunode
->type
, "cpu"))
417 if (cpunode
== NULL
) {
418 printk(KERN_ERR
"cpufreq: Can't find any CPU 0 node\n");
422 /* Check 970FX for now */
423 valp
= of_get_property(cpunode
, "cpu-version", NULL
);
425 DBG("No cpu-version property !\n");
428 pvr_hi
= (*valp
) >> 16;
429 if (pvr_hi
!= 0x3c && pvr_hi
!= 0x44) {
430 printk(KERN_ERR
"cpufreq: Unsupported CPU version\n");
434 /* Look for the powertune data in the device-tree */
435 g5_pmode_data
= of_get_property(cpunode
, "power-mode-data",&psize
);
436 if (!g5_pmode_data
) {
437 DBG("No power-mode-data !\n");
440 g5_pmode_max
= psize
/ sizeof(u32
) - 1;
443 const struct smu_sdbp_header
*shdr
;
445 /* Look for the FVT table */
446 shdr
= smu_get_sdb_partition(SMU_SDB_FVT_ID
, NULL
);
449 g5_fvt_table
= (struct smu_sdbp_fvt
*)&shdr
[1];
450 ssize
= (shdr
->len
* sizeof(u32
)) -
451 sizeof(struct smu_sdbp_header
);
452 g5_fvt_count
= ssize
/ sizeof(struct smu_sdbp_fvt
);
455 /* Sanity checking */
456 if (g5_fvt_count
< 1 || g5_pmode_max
< 1)
459 g5_switch_volt
= g5_smu_switch_volt
;
461 } else if (use_volts_vdnap
) {
462 struct device_node
*root
;
464 root
= of_find_node_by_path("/");
466 printk(KERN_ERR
"cpufreq: Can't find root of "
470 pfunc_set_vdnap0
= pmf_find_function(root
, "set-vdnap0");
471 pfunc_vdnap0_complete
=
472 pmf_find_function(root
, "slewing-done");
473 if (pfunc_set_vdnap0
== NULL
||
474 pfunc_vdnap0_complete
== NULL
) {
475 printk(KERN_ERR
"cpufreq: Can't find required "
476 "platform function\n");
480 g5_switch_volt
= g5_vdnap_switch_volt
;
481 volt_method
= "GPIO";
483 g5_switch_volt
= g5_dummy_switch_volt
;
484 volt_method
= "none";
488 * From what I see, clock-frequency is always the maximal frequency.
489 * The current driver can not slew sysclk yet, so we really only deal
490 * with powertune steps for now. We also only implement full freq and
491 * half freq in this version. So far, I haven't yet seen a machine
492 * supporting anything else.
494 valp
= of_get_property(cpunode
, "clock-frequency", NULL
);
497 max_freq
= (*valp
)/1000;
498 g5_cpu_freqs
[0].frequency
= max_freq
;
499 g5_cpu_freqs
[1].frequency
= max_freq
/2;
502 transition_latency
= 12000;
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 transition_latency
= CPUFREQ_ETERNAL
;
679 g5_switch_volt
= g5_pfunc_switch_volt
;
680 g5_switch_freq
= g5_pfunc_switch_freq
;
681 g5_query_freq
= g5_pfunc_query_freq
;
683 /* Force apply current frequency to make sure everything is in
684 * sync (voltage is right for example). Firmware may leave us with
685 * a strange setting ...
687 g5_switch_volt(CPUFREQ_HIGH
);
690 g5_switch_freq(g5_query_freq());
692 printk(KERN_INFO
"Registering G5 CPU frequency driver\n");
693 printk(KERN_INFO
"Frequency method: i2c/pfunc, "
694 "Voltage method: %s\n", has_volt
? "i2c/pfunc" : "none");
695 printk(KERN_INFO
"Low: %d Mhz, High: %d Mhz, Cur: %d MHz\n",
696 g5_cpu_freqs
[1].frequency
/1000,
697 g5_cpu_freqs
[0].frequency
/1000,
698 g5_cpu_freqs
[g5_pmode_cur
].frequency
/1000);
700 rc
= cpufreq_register_driver(&g5_cpufreq_driver
);
703 pmf_put_function(pfunc_cpu_getfreq
);
704 pmf_put_function(pfunc_cpu_setfreq_high
);
705 pmf_put_function(pfunc_cpu_setfreq_low
);
706 pmf_put_function(pfunc_slewing_done
);
707 pmf_put_function(pfunc_cpu0_volt_high
);
708 pmf_put_function(pfunc_cpu0_volt_low
);
709 pmf_put_function(pfunc_cpu1_volt_high
);
710 pmf_put_function(pfunc_cpu1_volt_low
);
712 of_node_put(hwclock
);
714 of_node_put(cpunode
);
719 static int __init
g5_cpufreq_init(void)
721 struct device_node
*cpus
;
724 cpus
= of_find_node_by_path("/cpus");
726 DBG("No /cpus node !\n");
730 if (of_machine_is_compatible("PowerMac7,2") ||
731 of_machine_is_compatible("PowerMac7,3") ||
732 of_machine_is_compatible("RackMac3,1"))
733 rc
= g5_pm72_cpufreq_init(cpus
);
734 #ifdef CONFIG_PMAC_SMU
736 rc
= g5_neo2_cpufreq_init(cpus
);
737 #endif /* CONFIG_PMAC_SMU */
743 module_init(g5_cpufreq_init
);
746 MODULE_LICENSE("GPL");