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>
25 #include <linux/of_device.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, 0, CPUFREQ_TABLE_END
},
73 /* Power mode data is an array of the 32 bits PCR values to use for
74 * the various frequencies, retrieved from the device-tree
76 static int g5_pmode_cur
;
78 static void (*g5_switch_volt
)(int speed_mode
);
79 static int (*g5_switch_freq
)(int speed_mode
);
80 static int (*g5_query_freq
)(void);
82 static unsigned long transition_latency
;
84 #ifdef CONFIG_PMAC_SMU
86 static const u32
*g5_pmode_data
;
87 static int g5_pmode_max
;
89 static struct smu_sdbp_fvt
*g5_fvt_table
; /* table of op. points */
90 static int g5_fvt_count
; /* number of op. points */
91 static int g5_fvt_cur
; /* current op. point */
94 * SMU based voltage switching for Neo2 platforms
97 static void g5_smu_switch_volt(int speed_mode
)
99 struct smu_simple_cmd cmd
;
101 DECLARE_COMPLETION_ONSTACK(comp
);
102 smu_queue_simple(&cmd
, SMU_CMD_POWER_COMMAND
, 8, smu_done_complete
,
103 &comp
, 'V', 'S', 'L', 'E', 'W',
104 0xff, g5_fvt_cur
+1, speed_mode
);
105 wait_for_completion(&comp
);
109 * Platform function based voltage/vdnap switching for Neo2
112 static struct pmf_function
*pfunc_set_vdnap0
;
113 static struct pmf_function
*pfunc_vdnap0_complete
;
115 static void g5_vdnap_switch_volt(int speed_mode
)
117 struct pmf_args args
;
119 unsigned long timeout
;
121 slew
= (speed_mode
== CPUFREQ_LOW
) ? 1 : 0;
125 pmf_call_one(pfunc_set_vdnap0
, &args
);
127 /* It's an irq GPIO so we should be able to just block here,
128 * I'll do that later after I've properly tested the IRQ code for
131 timeout
= jiffies
+ HZ
/10;
132 while(!time_after(jiffies
, timeout
)) {
135 pmf_call_one(pfunc_vdnap0_complete
, &args
);
138 usleep_range(1000, 1000);
141 printk(KERN_WARNING
"cpufreq: Timeout in clock slewing !\n");
146 * SCOM based frequency switching for 970FX rev3
148 static int g5_scom_switch_freq(int speed_mode
)
153 /* If frequency is going up, first ramp up the voltage */
154 if (speed_mode
< g5_pmode_cur
)
155 g5_switch_volt(speed_mode
);
157 local_irq_save(flags
);
160 scom970_write(SCOM_PCR
, 0);
162 scom970_write(SCOM_PCR
, PCR_HILO_SELECT
| 0);
164 scom970_write(SCOM_PCR
, PCR_HILO_SELECT
|
165 g5_pmode_data
[speed_mode
]);
167 /* Wait for completion */
168 for (to
= 0; to
< 10; to
++) {
169 unsigned long psr
= scom970_read(SCOM_PSR
);
171 if ((psr
& PSR_CMD_RECEIVED
) == 0 &&
172 (((psr
>> PSR_CUR_SPEED_SHIFT
) ^
173 (g5_pmode_data
[speed_mode
] >> PCR_SPEED_SHIFT
)) & 0x3)
176 if (psr
& PSR_CMD_COMPLETED
)
181 local_irq_restore(flags
);
183 /* If frequency is going down, last ramp the voltage */
184 if (speed_mode
> g5_pmode_cur
)
185 g5_switch_volt(speed_mode
);
187 g5_pmode_cur
= speed_mode
;
188 ppc_proc_freq
= g5_cpu_freqs
[speed_mode
].frequency
* 1000ul;
193 static int g5_scom_query_freq(void)
195 unsigned long psr
= scom970_read(SCOM_PSR
);
198 for (i
= 0; i
<= g5_pmode_max
; i
++)
199 if ((((psr
>> PSR_CUR_SPEED_SHIFT
) ^
200 (g5_pmode_data
[i
] >> PCR_SPEED_SHIFT
)) & 0x3) == 0)
206 * Fake voltage switching for platforms with missing support
209 static void g5_dummy_switch_volt(int speed_mode
)
213 #endif /* CONFIG_PMAC_SMU */
216 * Platform function based voltage switching for PowerMac7,2 & 7,3
219 static struct pmf_function
*pfunc_cpu0_volt_high
;
220 static struct pmf_function
*pfunc_cpu0_volt_low
;
221 static struct pmf_function
*pfunc_cpu1_volt_high
;
222 static struct pmf_function
*pfunc_cpu1_volt_low
;
224 static void g5_pfunc_switch_volt(int speed_mode
)
226 if (speed_mode
== CPUFREQ_HIGH
) {
227 if (pfunc_cpu0_volt_high
)
228 pmf_call_one(pfunc_cpu0_volt_high
, NULL
);
229 if (pfunc_cpu1_volt_high
)
230 pmf_call_one(pfunc_cpu1_volt_high
, NULL
);
232 if (pfunc_cpu0_volt_low
)
233 pmf_call_one(pfunc_cpu0_volt_low
, NULL
);
234 if (pfunc_cpu1_volt_low
)
235 pmf_call_one(pfunc_cpu1_volt_low
, NULL
);
237 usleep_range(10000, 10000); /* should be faster , to fix */
241 * Platform function based frequency switching for PowerMac7,2 & 7,3
244 static struct pmf_function
*pfunc_cpu_setfreq_high
;
245 static struct pmf_function
*pfunc_cpu_setfreq_low
;
246 static struct pmf_function
*pfunc_cpu_getfreq
;
247 static struct pmf_function
*pfunc_slewing_done
;
249 static int g5_pfunc_switch_freq(int speed_mode
)
251 struct pmf_args args
;
253 unsigned long timeout
;
256 DBG("g5_pfunc_switch_freq(%d)\n", speed_mode
);
258 /* If frequency is going up, first ramp up the voltage */
259 if (speed_mode
< g5_pmode_cur
)
260 g5_switch_volt(speed_mode
);
263 if (speed_mode
== CPUFREQ_HIGH
)
264 rc
= pmf_call_one(pfunc_cpu_setfreq_high
, NULL
);
266 rc
= pmf_call_one(pfunc_cpu_setfreq_low
, NULL
);
269 printk(KERN_WARNING
"cpufreq: pfunc switch error %d\n", rc
);
271 /* It's an irq GPIO so we should be able to just block here,
272 * I'll do that later after I've properly tested the IRQ code for
275 timeout
= jiffies
+ HZ
/10;
276 while(!time_after(jiffies
, timeout
)) {
279 pmf_call_one(pfunc_slewing_done
, &args
);
282 usleep_range(500, 500);
285 printk(KERN_WARNING
"cpufreq: Timeout in clock slewing !\n");
287 /* If frequency is going down, last ramp the voltage */
288 if (speed_mode
> g5_pmode_cur
)
289 g5_switch_volt(speed_mode
);
291 g5_pmode_cur
= speed_mode
;
292 ppc_proc_freq
= g5_cpu_freqs
[speed_mode
].frequency
* 1000ul;
297 static int g5_pfunc_query_freq(void)
299 struct pmf_args args
;
304 pmf_call_one(pfunc_cpu_getfreq
, &args
);
305 return val
? CPUFREQ_HIGH
: CPUFREQ_LOW
;
310 * Common interface to the cpufreq core
313 static int g5_cpufreq_target(struct cpufreq_policy
*policy
, unsigned int index
)
315 return g5_switch_freq(index
);
318 static unsigned int g5_cpufreq_get_speed(unsigned int cpu
)
320 return g5_cpu_freqs
[g5_pmode_cur
].frequency
;
323 static int g5_cpufreq_cpu_init(struct cpufreq_policy
*policy
)
325 return cpufreq_generic_init(policy
, g5_cpu_freqs
, transition_latency
);
328 static struct cpufreq_driver g5_cpufreq_driver
= {
330 .flags
= CPUFREQ_CONST_LOOPS
,
331 .init
= g5_cpufreq_cpu_init
,
332 .verify
= cpufreq_generic_frequency_table_verify
,
333 .target_index
= g5_cpufreq_target
,
334 .get
= g5_cpufreq_get_speed
,
335 .attr
= cpufreq_generic_attr
,
339 #ifdef CONFIG_PMAC_SMU
341 static int __init
g5_neo2_cpufreq_init(struct device_node
*cpunode
)
343 unsigned int psize
, ssize
;
344 unsigned long max_freq
;
345 char *freq_method
, *volt_method
;
348 int use_volts_vdnap
= 0;
349 int use_volts_smu
= 0;
352 /* Check supported platforms */
353 if (of_machine_is_compatible("PowerMac8,1") ||
354 of_machine_is_compatible("PowerMac8,2") ||
355 of_machine_is_compatible("PowerMac9,1") ||
356 of_machine_is_compatible("PowerMac12,1"))
358 else if (of_machine_is_compatible("PowerMac11,2"))
363 /* Check 970FX for now */
364 valp
= of_get_property(cpunode
, "cpu-version", NULL
);
366 DBG("No cpu-version property !\n");
369 pvr_hi
= (*valp
) >> 16;
370 if (pvr_hi
!= 0x3c && pvr_hi
!= 0x44) {
371 printk(KERN_ERR
"cpufreq: Unsupported CPU version\n");
375 /* Look for the powertune data in the device-tree */
376 g5_pmode_data
= of_get_property(cpunode
, "power-mode-data",&psize
);
377 if (!g5_pmode_data
) {
378 DBG("No power-mode-data !\n");
381 g5_pmode_max
= psize
/ sizeof(u32
) - 1;
384 const struct smu_sdbp_header
*shdr
;
386 /* Look for the FVT table */
387 shdr
= smu_get_sdb_partition(SMU_SDB_FVT_ID
, NULL
);
390 g5_fvt_table
= (struct smu_sdbp_fvt
*)&shdr
[1];
391 ssize
= (shdr
->len
* sizeof(u32
)) - sizeof(*shdr
);
392 g5_fvt_count
= ssize
/ sizeof(*g5_fvt_table
);
395 /* Sanity checking */
396 if (g5_fvt_count
< 1 || g5_pmode_max
< 1)
399 g5_switch_volt
= g5_smu_switch_volt
;
401 } else if (use_volts_vdnap
) {
402 struct device_node
*root
;
404 root
= of_find_node_by_path("/");
406 printk(KERN_ERR
"cpufreq: Can't find root of "
410 pfunc_set_vdnap0
= pmf_find_function(root
, "set-vdnap0");
411 pfunc_vdnap0_complete
=
412 pmf_find_function(root
, "slewing-done");
413 if (pfunc_set_vdnap0
== NULL
||
414 pfunc_vdnap0_complete
== NULL
) {
415 printk(KERN_ERR
"cpufreq: Can't find required "
416 "platform function\n");
420 g5_switch_volt
= g5_vdnap_switch_volt
;
421 volt_method
= "GPIO";
423 g5_switch_volt
= g5_dummy_switch_volt
;
424 volt_method
= "none";
428 * From what I see, clock-frequency is always the maximal frequency.
429 * The current driver can not slew sysclk yet, so we really only deal
430 * with powertune steps for now. We also only implement full freq and
431 * half freq in this version. So far, I haven't yet seen a machine
432 * supporting anything else.
434 valp
= of_get_property(cpunode
, "clock-frequency", NULL
);
437 max_freq
= (*valp
)/1000;
438 g5_cpu_freqs
[0].frequency
= max_freq
;
439 g5_cpu_freqs
[1].frequency
= max_freq
/2;
442 transition_latency
= 12000;
443 g5_switch_freq
= g5_scom_switch_freq
;
444 g5_query_freq
= g5_scom_query_freq
;
445 freq_method
= "SCOM";
447 /* Force apply current frequency to make sure everything is in
448 * sync (voltage is right for example). Firmware may leave us with
449 * a strange setting ...
451 g5_switch_volt(CPUFREQ_HIGH
);
454 g5_switch_freq(g5_query_freq());
456 printk(KERN_INFO
"Registering G5 CPU frequency driver\n");
457 printk(KERN_INFO
"Frequency method: %s, Voltage method: %s\n",
458 freq_method
, volt_method
);
459 printk(KERN_INFO
"Low: %d Mhz, High: %d Mhz, Cur: %d MHz\n",
460 g5_cpu_freqs
[1].frequency
/1000,
461 g5_cpu_freqs
[0].frequency
/1000,
462 g5_cpu_freqs
[g5_pmode_cur
].frequency
/1000);
464 rc
= cpufreq_register_driver(&g5_cpufreq_driver
);
466 /* We keep the CPU node on hold... hopefully, Apple G5 don't have
467 * hotplug CPU with a dynamic device-tree ...
472 of_node_put(cpunode
);
477 #endif /* CONFIG_PMAC_SMU */
480 static int __init
g5_pm72_cpufreq_init(struct device_node
*cpunode
)
482 struct device_node
*cpuid
= NULL
, *hwclock
= NULL
;
483 const u8
*eeprom
= NULL
;
485 u64 max_freq
, min_freq
, ih
, il
;
486 int has_volt
= 1, rc
= 0;
488 DBG("cpufreq: Initializing for PowerMac7,2, PowerMac7,3 and"
491 /* Lookup the cpuid eeprom node */
492 cpuid
= of_find_node_by_path("/u3@0,f8000000/i2c@f8001000/cpuid@a0");
494 eeprom
= of_get_property(cpuid
, "cpuid", NULL
);
495 if (eeprom
== NULL
) {
496 printk(KERN_ERR
"cpufreq: Can't find cpuid EEPROM !\n");
501 /* Lookup the i2c hwclock */
502 for_each_node_by_name(hwclock
, "i2c-hwclock") {
503 const char *loc
= of_get_property(hwclock
,
504 "hwctrl-location", NULL
);
507 if (strcmp(loc
, "CPU CLOCK"))
509 if (!of_get_property(hwclock
, "platform-get-frequency", NULL
))
513 if (hwclock
== NULL
) {
514 printk(KERN_ERR
"cpufreq: Can't find i2c clock chip !\n");
519 DBG("cpufreq: i2c clock chip found: %s\n", hwclock
->full_name
);
521 /* Now get all the platform functions */
523 pmf_find_function(hwclock
, "get-frequency");
524 pfunc_cpu_setfreq_high
=
525 pmf_find_function(hwclock
, "set-frequency-high");
526 pfunc_cpu_setfreq_low
=
527 pmf_find_function(hwclock
, "set-frequency-low");
529 pmf_find_function(hwclock
, "slewing-done");
530 pfunc_cpu0_volt_high
=
531 pmf_find_function(hwclock
, "set-voltage-high-0");
532 pfunc_cpu0_volt_low
=
533 pmf_find_function(hwclock
, "set-voltage-low-0");
534 pfunc_cpu1_volt_high
=
535 pmf_find_function(hwclock
, "set-voltage-high-1");
536 pfunc_cpu1_volt_low
=
537 pmf_find_function(hwclock
, "set-voltage-low-1");
539 /* Check we have minimum requirements */
540 if (pfunc_cpu_getfreq
== NULL
|| pfunc_cpu_setfreq_high
== NULL
||
541 pfunc_cpu_setfreq_low
== NULL
|| pfunc_slewing_done
== NULL
) {
542 printk(KERN_ERR
"cpufreq: Can't find platform functions !\n");
547 /* Check that we have complete sets */
548 if (pfunc_cpu0_volt_high
== NULL
|| pfunc_cpu0_volt_low
== NULL
) {
549 pmf_put_function(pfunc_cpu0_volt_high
);
550 pmf_put_function(pfunc_cpu0_volt_low
);
551 pfunc_cpu0_volt_high
= pfunc_cpu0_volt_low
= NULL
;
555 pfunc_cpu1_volt_high
== NULL
|| pfunc_cpu1_volt_low
== NULL
) {
556 pmf_put_function(pfunc_cpu1_volt_high
);
557 pmf_put_function(pfunc_cpu1_volt_low
);
558 pfunc_cpu1_volt_high
= pfunc_cpu1_volt_low
= NULL
;
561 /* Note: The device tree also contains a "platform-set-values"
562 * function for which I haven't quite figured out the usage. It
563 * might have to be called on init and/or wakeup, I'm not too sure
564 * but things seem to work fine without it so far ...
567 /* Get max frequency from device-tree */
568 valp
= of_get_property(cpunode
, "clock-frequency", NULL
);
570 printk(KERN_ERR
"cpufreq: Can't find CPU frequency !\n");
575 max_freq
= (*valp
)/1000;
577 /* Now calculate reduced frequency by using the cpuid input freq
578 * ratio. This requires 64 bits math unless we are willing to lose
581 ih
= *((u32
*)(eeprom
+ 0x10));
582 il
= *((u32
*)(eeprom
+ 0x20));
584 /* Check for machines with no useful settings */
586 printk(KERN_WARNING
"cpufreq: No low frequency mode available"
587 " on this model !\n");
593 if (ih
!= 0 && il
!= 0)
594 min_freq
= (max_freq
* il
) / ih
;
597 if (min_freq
>= max_freq
|| min_freq
< 1000) {
598 printk(KERN_ERR
"cpufreq: Can't calculate low frequency !\n");
602 g5_cpu_freqs
[0].frequency
= max_freq
;
603 g5_cpu_freqs
[1].frequency
= min_freq
;
605 /* Based on a measurement on Xserve G5, rounded up. */
606 transition_latency
= 10 * NSEC_PER_MSEC
;
609 g5_switch_volt
= g5_pfunc_switch_volt
;
610 g5_switch_freq
= g5_pfunc_switch_freq
;
611 g5_query_freq
= g5_pfunc_query_freq
;
613 /* Force apply current frequency to make sure everything is in
614 * sync (voltage is right for example). Firmware may leave us with
615 * a strange setting ...
617 g5_switch_volt(CPUFREQ_HIGH
);
620 g5_switch_freq(g5_query_freq());
622 printk(KERN_INFO
"Registering G5 CPU frequency driver\n");
623 printk(KERN_INFO
"Frequency method: i2c/pfunc, "
624 "Voltage method: %s\n", has_volt
? "i2c/pfunc" : "none");
625 printk(KERN_INFO
"Low: %d Mhz, High: %d Mhz, Cur: %d MHz\n",
626 g5_cpu_freqs
[1].frequency
/1000,
627 g5_cpu_freqs
[0].frequency
/1000,
628 g5_cpu_freqs
[g5_pmode_cur
].frequency
/1000);
630 rc
= cpufreq_register_driver(&g5_cpufreq_driver
);
633 pmf_put_function(pfunc_cpu_getfreq
);
634 pmf_put_function(pfunc_cpu_setfreq_high
);
635 pmf_put_function(pfunc_cpu_setfreq_low
);
636 pmf_put_function(pfunc_slewing_done
);
637 pmf_put_function(pfunc_cpu0_volt_high
);
638 pmf_put_function(pfunc_cpu0_volt_low
);
639 pmf_put_function(pfunc_cpu1_volt_high
);
640 pmf_put_function(pfunc_cpu1_volt_low
);
642 of_node_put(hwclock
);
644 of_node_put(cpunode
);
649 static int __init
g5_cpufreq_init(void)
651 struct device_node
*cpunode
;
654 /* Get first CPU node */
655 cpunode
= of_cpu_device_node_get(0);
656 if (cpunode
== NULL
) {
657 pr_err("cpufreq: Can't find any CPU node\n");
661 if (of_machine_is_compatible("PowerMac7,2") ||
662 of_machine_is_compatible("PowerMac7,3") ||
663 of_machine_is_compatible("RackMac3,1"))
664 rc
= g5_pm72_cpufreq_init(cpunode
);
665 #ifdef CONFIG_PMAC_SMU
667 rc
= g5_neo2_cpufreq_init(cpunode
);
668 #endif /* CONFIG_PMAC_SMU */
673 module_init(g5_cpufreq_init
);
676 MODULE_LICENSE("GPL");