2 * Windfarm PowerMac thermal control. SMU based 1 CPU desktop control loops
4 * (c) Copyright 2005 Benjamin Herrenschmidt, IBM Corp.
5 * <benh@kernel.crashing.org>
7 * Released under the term of the GNU GPL v2.
9 * The algorithm used is the PID control algorithm, used the same
10 * way the published Darwin code does, using the same values that
11 * are present in the Darwin 8.2 snapshot property lists (note however
12 * that none of the code has been re-used, it's a complete re-implementation
14 * The various control loops found in Darwin config file are:
19 * Has 3 control loops: CPU fans is similar to PowerMac8,1 (though it doesn't
20 * try to play with other control loops fans). Drive bay is rather basic PID
21 * with one sensor and one fan. Slots area is a bit different as the Darwin
22 * driver is supposed to be capable of working in a special "AGP" mode which
23 * involves the presence of an AGP sensor and an AGP fan (possibly on the
24 * AGP card itself). I can't deal with that special mode as I don't have
25 * access to those additional sensor/fans for now (though ultimately, it would
26 * be possible to add sensor objects for them) so I'm only implementing the
27 * basic PCI slot control loop
30 #include <linux/types.h>
31 #include <linux/errno.h>
32 #include <linux/kernel.h>
33 #include <linux/delay.h>
34 #include <linux/slab.h>
35 #include <linux/init.h>
36 #include <linux/spinlock.h>
37 #include <linux/wait.h>
38 #include <linux/kmod.h>
39 #include <linux/device.h>
40 #include <linux/platform_device.h>
42 #include <asm/machdep.h>
44 #include <asm/sections.h>
48 #include "windfarm_pid.h"
55 #define DBG(args...) printk(args)
57 #define DBG(args...) do { } while(0)
60 /* define this to force CPU overtemp to 74 degree, useful for testing
63 #undef HACKED_OVERTEMP
65 /* Controls & sensors */
66 static struct wf_sensor
*sensor_cpu_power
;
67 static struct wf_sensor
*sensor_cpu_temp
;
68 static struct wf_sensor
*sensor_hd_temp
;
69 static struct wf_sensor
*sensor_slots_power
;
70 static struct wf_control
*fan_cpu_main
;
71 static struct wf_control
*fan_cpu_second
;
72 static struct wf_control
*fan_cpu_third
;
73 static struct wf_control
*fan_hd
;
74 static struct wf_control
*fan_slots
;
75 static struct wf_control
*cpufreq_clamp
;
77 /* Set to kick the control loop into life */
78 static int wf_smu_all_controls_ok
, wf_smu_all_sensors_ok
;
79 static bool wf_smu_started
;
80 static bool wf_smu_overtemp
;
82 /* Failure handling.. could be nicer */
83 #define FAILURE_FAN 0x01
84 #define FAILURE_SENSOR 0x02
85 #define FAILURE_OVERTEMP 0x04
87 static unsigned int wf_smu_failure_state
;
88 static int wf_smu_readjust
, wf_smu_skipping
;
91 * ****** CPU Fans Control Loop ******
96 #define WF_SMU_CPU_FANS_INTERVAL 1
97 #define WF_SMU_CPU_FANS_MAX_HISTORY 16
99 /* State data used by the cpu fans control loop
101 struct wf_smu_cpu_fans_state
{
104 struct wf_cpu_pid_state pid
;
107 static struct wf_smu_cpu_fans_state
*wf_smu_cpu_fans
;
112 * ****** Drive Fan Control Loop ******
116 struct wf_smu_drive_fans_state
{
119 struct wf_pid_state pid
;
122 static struct wf_smu_drive_fans_state
*wf_smu_drive_fans
;
125 * ****** Slots Fan Control Loop ******
129 struct wf_smu_slots_fans_state
{
132 struct wf_pid_state pid
;
135 static struct wf_smu_slots_fans_state
*wf_smu_slots_fans
;
138 * ***** Implementation *****
143 static void wf_smu_create_cpu_fans(void)
145 struct wf_cpu_pid_param pid_param
;
146 const struct smu_sdbp_header
*hdr
;
147 struct smu_sdbp_cpupiddata
*piddata
;
148 struct smu_sdbp_fvt
*fvt
;
149 s32 tmax
, tdelta
, maxpow
, powadj
;
151 /* First, locate the PID params in SMU SBD */
152 hdr
= smu_get_sdb_partition(SMU_SDB_CPUPIDDATA_ID
, NULL
);
154 printk(KERN_WARNING
"windfarm: CPU PID fan config not found "
158 piddata
= (struct smu_sdbp_cpupiddata
*)&hdr
[1];
160 /* Get the FVT params for operating point 0 (the only supported one
161 * for now) in order to get tmax
163 hdr
= smu_get_sdb_partition(SMU_SDB_FVT_ID
, NULL
);
165 fvt
= (struct smu_sdbp_fvt
*)&hdr
[1];
166 tmax
= ((s32
)fvt
->maxtemp
) << 16;
168 tmax
= 0x5e0000; /* 94 degree default */
170 /* Alloc & initialize state */
171 wf_smu_cpu_fans
= kmalloc(sizeof(struct wf_smu_cpu_fans_state
),
173 if (wf_smu_cpu_fans
== NULL
)
175 wf_smu_cpu_fans
->ticks
= 1;
177 /* Fill PID params */
178 pid_param
.interval
= WF_SMU_CPU_FANS_INTERVAL
;
179 pid_param
.history_len
= piddata
->history_len
;
180 if (pid_param
.history_len
> WF_CPU_PID_MAX_HISTORY
) {
181 printk(KERN_WARNING
"windfarm: History size overflow on "
182 "CPU control loop (%d)\n", piddata
->history_len
);
183 pid_param
.history_len
= WF_CPU_PID_MAX_HISTORY
;
185 pid_param
.gd
= piddata
->gd
;
186 pid_param
.gp
= piddata
->gp
;
187 pid_param
.gr
= piddata
->gr
/ pid_param
.history_len
;
189 tdelta
= ((s32
)piddata
->target_temp_delta
) << 16;
190 maxpow
= ((s32
)piddata
->max_power
) << 16;
191 powadj
= ((s32
)piddata
->power_adj
) << 16;
193 pid_param
.tmax
= tmax
;
194 pid_param
.ttarget
= tmax
- tdelta
;
195 pid_param
.pmaxadj
= maxpow
- powadj
;
197 pid_param
.min
= wf_control_get_min(fan_cpu_main
);
198 pid_param
.max
= wf_control_get_max(fan_cpu_main
);
200 wf_cpu_pid_init(&wf_smu_cpu_fans
->pid
, &pid_param
);
202 DBG("wf: CPU Fan control initialized.\n");
203 DBG(" ttarget=%d.%03d, tmax=%d.%03d, min=%d RPM, max=%d RPM\n",
204 FIX32TOPRINT(pid_param
.ttarget
), FIX32TOPRINT(pid_param
.tmax
),
205 pid_param
.min
, pid_param
.max
);
210 printk(KERN_WARNING
"windfarm: CPU fan config not found\n"
211 "for this machine model, max fan speed\n");
214 wf_control_set_max(cpufreq_clamp
);
216 wf_control_set_max(fan_cpu_main
);
219 static void wf_smu_cpu_fans_tick(struct wf_smu_cpu_fans_state
*st
)
221 s32 new_setpoint
, temp
, power
;
224 if (--st
->ticks
!= 0) {
229 st
->ticks
= WF_SMU_CPU_FANS_INTERVAL
;
231 rc
= wf_sensor_get(sensor_cpu_temp
, &temp
);
233 printk(KERN_WARNING
"windfarm: CPU temp sensor error %d\n",
235 wf_smu_failure_state
|= FAILURE_SENSOR
;
239 rc
= wf_sensor_get(sensor_cpu_power
, &power
);
241 printk(KERN_WARNING
"windfarm: CPU power sensor error %d\n",
243 wf_smu_failure_state
|= FAILURE_SENSOR
;
247 DBG("wf_smu: CPU Fans tick ! CPU temp: %d.%03d, power: %d.%03d\n",
248 FIX32TOPRINT(temp
), FIX32TOPRINT(power
));
250 #ifdef HACKED_OVERTEMP
252 wf_smu_failure_state
|= FAILURE_OVERTEMP
;
254 if (temp
> st
->pid
.param
.tmax
)
255 wf_smu_failure_state
|= FAILURE_OVERTEMP
;
257 new_setpoint
= wf_cpu_pid_run(&st
->pid
, power
, temp
);
259 DBG("wf_smu: new_setpoint: %d RPM\n", (int)new_setpoint
);
261 if (st
->cpu_setpoint
== new_setpoint
)
263 st
->cpu_setpoint
= new_setpoint
;
265 if (fan_cpu_main
&& wf_smu_failure_state
== 0) {
266 rc
= wf_control_set(fan_cpu_main
, st
->cpu_setpoint
);
268 printk(KERN_WARNING
"windfarm: CPU main fan"
270 wf_smu_failure_state
|= FAILURE_FAN
;
273 if (fan_cpu_second
&& wf_smu_failure_state
== 0) {
274 rc
= wf_control_set(fan_cpu_second
, st
->cpu_setpoint
);
276 printk(KERN_WARNING
"windfarm: CPU second fan"
278 wf_smu_failure_state
|= FAILURE_FAN
;
281 if (fan_cpu_third
&& wf_smu_failure_state
== 0) {
282 rc
= wf_control_set(fan_cpu_third
, st
->cpu_setpoint
);
284 printk(KERN_WARNING
"windfarm: CPU third fan"
286 wf_smu_failure_state
|= FAILURE_FAN
;
291 static void wf_smu_create_drive_fans(void)
293 struct wf_pid_param param
= {
299 .itarget
= 0x00200000,
302 /* Alloc & initialize state */
303 wf_smu_drive_fans
= kmalloc(sizeof(struct wf_smu_drive_fans_state
),
305 if (wf_smu_drive_fans
== NULL
) {
306 printk(KERN_WARNING
"windfarm: Memory allocation error"
310 wf_smu_drive_fans
->ticks
= 1;
312 /* Fill PID params */
313 param
.additive
= (fan_hd
->type
== WF_CONTROL_RPM_FAN
);
314 param
.min
= wf_control_get_min(fan_hd
);
315 param
.max
= wf_control_get_max(fan_hd
);
316 wf_pid_init(&wf_smu_drive_fans
->pid
, ¶m
);
318 DBG("wf: Drive Fan control initialized.\n");
319 DBG(" itarged=%d.%03d, min=%d RPM, max=%d RPM\n",
320 FIX32TOPRINT(param
.itarget
), param
.min
, param
.max
);
325 wf_control_set_max(fan_hd
);
328 static void wf_smu_drive_fans_tick(struct wf_smu_drive_fans_state
*st
)
330 s32 new_setpoint
, temp
;
333 if (--st
->ticks
!= 0) {
338 st
->ticks
= st
->pid
.param
.interval
;
340 rc
= wf_sensor_get(sensor_hd_temp
, &temp
);
342 printk(KERN_WARNING
"windfarm: HD temp sensor error %d\n",
344 wf_smu_failure_state
|= FAILURE_SENSOR
;
348 DBG("wf_smu: Drive Fans tick ! HD temp: %d.%03d\n",
351 if (temp
> (st
->pid
.param
.itarget
+ 0x50000))
352 wf_smu_failure_state
|= FAILURE_OVERTEMP
;
354 new_setpoint
= wf_pid_run(&st
->pid
, temp
);
356 DBG("wf_smu: new_setpoint: %d\n", (int)new_setpoint
);
358 if (st
->setpoint
== new_setpoint
)
360 st
->setpoint
= new_setpoint
;
362 if (fan_hd
&& wf_smu_failure_state
== 0) {
363 rc
= wf_control_set(fan_hd
, st
->setpoint
);
365 printk(KERN_WARNING
"windfarm: HD fan error %d\n",
367 wf_smu_failure_state
|= FAILURE_FAN
;
372 static void wf_smu_create_slots_fans(void)
374 struct wf_pid_param param
= {
380 .itarget
= 0x00000000
383 /* Alloc & initialize state */
384 wf_smu_slots_fans
= kmalloc(sizeof(struct wf_smu_slots_fans_state
),
386 if (wf_smu_slots_fans
== NULL
) {
387 printk(KERN_WARNING
"windfarm: Memory allocation error"
391 wf_smu_slots_fans
->ticks
= 1;
393 /* Fill PID params */
394 param
.additive
= (fan_slots
->type
== WF_CONTROL_RPM_FAN
);
395 param
.min
= wf_control_get_min(fan_slots
);
396 param
.max
= wf_control_get_max(fan_slots
);
397 wf_pid_init(&wf_smu_slots_fans
->pid
, ¶m
);
399 DBG("wf: Slots Fan control initialized.\n");
400 DBG(" itarged=%d.%03d, min=%d RPM, max=%d RPM\n",
401 FIX32TOPRINT(param
.itarget
), param
.min
, param
.max
);
406 wf_control_set_max(fan_slots
);
409 static void wf_smu_slots_fans_tick(struct wf_smu_slots_fans_state
*st
)
411 s32 new_setpoint
, power
;
414 if (--st
->ticks
!= 0) {
419 st
->ticks
= st
->pid
.param
.interval
;
421 rc
= wf_sensor_get(sensor_slots_power
, &power
);
423 printk(KERN_WARNING
"windfarm: Slots power sensor error %d\n",
425 wf_smu_failure_state
|= FAILURE_SENSOR
;
429 DBG("wf_smu: Slots Fans tick ! Slots power: %d.%03d\n",
430 FIX32TOPRINT(power
));
432 #if 0 /* Check what makes a good overtemp condition */
433 if (power
> (st
->pid
.param
.itarget
+ 0x50000))
434 wf_smu_failure_state
|= FAILURE_OVERTEMP
;
437 new_setpoint
= wf_pid_run(&st
->pid
, power
);
439 DBG("wf_smu: new_setpoint: %d\n", (int)new_setpoint
);
441 if (st
->setpoint
== new_setpoint
)
443 st
->setpoint
= new_setpoint
;
445 if (fan_slots
&& wf_smu_failure_state
== 0) {
446 rc
= wf_control_set(fan_slots
, st
->setpoint
);
448 printk(KERN_WARNING
"windfarm: Slots fan error %d\n",
450 wf_smu_failure_state
|= FAILURE_FAN
;
457 * ****** Setup / Init / Misc ... ******
461 static void wf_smu_tick(void)
463 unsigned int last_failure
= wf_smu_failure_state
;
464 unsigned int new_failure
;
466 if (!wf_smu_started
) {
467 DBG("wf: creating control loops !\n");
468 wf_smu_create_drive_fans();
469 wf_smu_create_slots_fans();
470 wf_smu_create_cpu_fans();
471 wf_smu_started
= true;
475 if (wf_smu_skipping
&& --wf_smu_skipping
)
478 wf_smu_failure_state
= 0;
479 if (wf_smu_drive_fans
)
480 wf_smu_drive_fans_tick(wf_smu_drive_fans
);
481 if (wf_smu_slots_fans
)
482 wf_smu_slots_fans_tick(wf_smu_slots_fans
);
484 wf_smu_cpu_fans_tick(wf_smu_cpu_fans
);
487 new_failure
= wf_smu_failure_state
& ~last_failure
;
489 /* If entering failure mode, clamp cpufreq and ramp all
490 * fans to full speed.
492 if (wf_smu_failure_state
&& !last_failure
) {
494 wf_control_set_max(cpufreq_clamp
);
496 wf_control_set_max(fan_cpu_main
);
498 wf_control_set_max(fan_cpu_second
);
500 wf_control_set_max(fan_cpu_third
);
502 wf_control_set_max(fan_hd
);
504 wf_control_set_max(fan_slots
);
507 /* If leaving failure mode, unclamp cpufreq and readjust
508 * all fans on next iteration
510 if (!wf_smu_failure_state
&& last_failure
) {
512 wf_control_set_min(cpufreq_clamp
);
516 /* Overtemp condition detected, notify and start skipping a couple
517 * ticks to let the temperature go down
519 if (new_failure
& FAILURE_OVERTEMP
) {
522 wf_smu_overtemp
= true;
525 /* We only clear the overtemp condition if overtemp is cleared
526 * _and_ no other failure is present. Since a sensor error will
527 * clear the overtemp condition (can't measure temperature) at
528 * the control loop levels, but we don't want to keep it clear
531 if (!wf_smu_failure_state
&& wf_smu_overtemp
) {
533 wf_smu_overtemp
= false;
538 static void wf_smu_new_control(struct wf_control
*ct
)
540 if (wf_smu_all_controls_ok
)
543 if (fan_cpu_main
== NULL
&& !strcmp(ct
->name
, "cpu-rear-fan-0")) {
544 if (wf_get_control(ct
) == 0)
548 if (fan_cpu_second
== NULL
&& !strcmp(ct
->name
, "cpu-rear-fan-1")) {
549 if (wf_get_control(ct
) == 0)
553 if (fan_cpu_third
== NULL
&& !strcmp(ct
->name
, "cpu-front-fan-0")) {
554 if (wf_get_control(ct
) == 0)
558 if (cpufreq_clamp
== NULL
&& !strcmp(ct
->name
, "cpufreq-clamp")) {
559 if (wf_get_control(ct
) == 0)
563 if (fan_hd
== NULL
&& !strcmp(ct
->name
, "drive-bay-fan")) {
564 if (wf_get_control(ct
) == 0)
568 if (fan_slots
== NULL
&& !strcmp(ct
->name
, "slots-fan")) {
569 if (wf_get_control(ct
) == 0)
573 if (fan_cpu_main
&& (fan_cpu_second
|| fan_cpu_third
) && fan_hd
&&
574 fan_slots
&& cpufreq_clamp
)
575 wf_smu_all_controls_ok
= 1;
578 static void wf_smu_new_sensor(struct wf_sensor
*sr
)
580 if (wf_smu_all_sensors_ok
)
583 if (sensor_cpu_power
== NULL
&& !strcmp(sr
->name
, "cpu-power")) {
584 if (wf_get_sensor(sr
) == 0)
585 sensor_cpu_power
= sr
;
588 if (sensor_cpu_temp
== NULL
&& !strcmp(sr
->name
, "cpu-temp")) {
589 if (wf_get_sensor(sr
) == 0)
590 sensor_cpu_temp
= sr
;
593 if (sensor_hd_temp
== NULL
&& !strcmp(sr
->name
, "hd-temp")) {
594 if (wf_get_sensor(sr
) == 0)
598 if (sensor_slots_power
== NULL
&& !strcmp(sr
->name
, "slots-power")) {
599 if (wf_get_sensor(sr
) == 0)
600 sensor_slots_power
= sr
;
603 if (sensor_cpu_power
&& sensor_cpu_temp
&&
604 sensor_hd_temp
&& sensor_slots_power
)
605 wf_smu_all_sensors_ok
= 1;
609 static int wf_smu_notify(struct notifier_block
*self
,
610 unsigned long event
, void *data
)
613 case WF_EVENT_NEW_CONTROL
:
614 DBG("wf: new control %s detected\n",
615 ((struct wf_control
*)data
)->name
);
616 wf_smu_new_control(data
);
619 case WF_EVENT_NEW_SENSOR
:
620 DBG("wf: new sensor %s detected\n",
621 ((struct wf_sensor
*)data
)->name
);
622 wf_smu_new_sensor(data
);
625 if (wf_smu_all_controls_ok
&& wf_smu_all_sensors_ok
)
632 static struct notifier_block wf_smu_events
= {
633 .notifier_call
= wf_smu_notify
,
636 static int wf_init_pm(void)
638 printk(KERN_INFO
"windfarm: Initializing for Desktop G5 model\n");
643 static int wf_smu_probe(struct platform_device
*ddev
)
645 wf_register_client(&wf_smu_events
);
650 static int wf_smu_remove(struct platform_device
*ddev
)
652 wf_unregister_client(&wf_smu_events
);
654 /* XXX We don't have yet a guarantee that our callback isn't
655 * in progress when returning from wf_unregister_client, so
656 * we add an arbitrary delay. I'll have to fix that in the core
660 /* Release all sensors */
661 /* One more crappy race: I don't think we have any guarantee here
662 * that the attribute callback won't race with the sensor beeing
663 * disposed of, and I'm not 100% certain what best way to deal
664 * with that except by adding locks all over... I'll do that
665 * eventually but heh, who ever rmmod this module anyway ?
667 if (sensor_cpu_power
)
668 wf_put_sensor(sensor_cpu_power
);
670 wf_put_sensor(sensor_cpu_temp
);
672 wf_put_sensor(sensor_hd_temp
);
673 if (sensor_slots_power
)
674 wf_put_sensor(sensor_slots_power
);
676 /* Release all controls */
678 wf_put_control(fan_cpu_main
);
680 wf_put_control(fan_cpu_second
);
682 wf_put_control(fan_cpu_third
);
684 wf_put_control(fan_hd
);
686 wf_put_control(fan_slots
);
688 wf_put_control(cpufreq_clamp
);
690 /* Destroy control loops state structures */
691 kfree(wf_smu_slots_fans
);
692 kfree(wf_smu_drive_fans
);
693 kfree(wf_smu_cpu_fans
);
698 static struct platform_driver wf_smu_driver
= {
699 .probe
= wf_smu_probe
,
700 .remove
= wf_smu_remove
,
707 static int __init
wf_smu_init(void)
711 if (of_machine_is_compatible("PowerMac9,1"))
716 request_module("windfarm_smu_controls");
717 request_module("windfarm_smu_sensors");
718 request_module("windfarm_lm75_sensor");
719 request_module("windfarm_cpufreq_clamp");
722 platform_driver_register(&wf_smu_driver
);
728 static void __exit
wf_smu_exit(void)
731 platform_driver_unregister(&wf_smu_driver
);
735 module_init(wf_smu_init
);
736 module_exit(wf_smu_exit
);
738 MODULE_AUTHOR("Benjamin Herrenschmidt <benh@kernel.crashing.org>");
739 MODULE_DESCRIPTION("Thermal control logic for PowerMac9,1");
740 MODULE_LICENSE("GPL");
742 MODULE_ALIAS("platform:windfarm");