2 * Device driver for the thermostats & fan controller of the
3 * Apple G5 "PowerMac7,2" desktop machines.
5 * (c) Copyright IBM Corp. 2003-2004
7 * Maintained by: Benjamin Herrenschmidt
8 * <benh@kernel.crashing.org>
11 * The algorithm used is the PID control algorithm, used the same
12 * way the published Darwin code does, using the same values that
13 * are present in the Darwin 7.0 snapshot property lists.
15 * As far as the CPUs control loops are concerned, I use the
16 * calibration & PID constants provided by the EEPROM,
17 * I do _not_ embed any value from the property lists, as the ones
18 * provided by Darwin 7.0 seem to always have an older version that
19 * what I've seen on the actual computers.
20 * It would be interesting to verify that though. Darwin has a
21 * version code of 1.0.0d11 for all control loops it seems, while
22 * so far, the machines EEPROMs contain a dataset versioned 1.0.0f
24 * Darwin doesn't provide source to all parts, some missing
25 * bits like the AppleFCU driver or the actual scale of some
26 * of the values returned by sensors had to be "guessed" some
27 * way... or based on what Open Firmware does.
29 * I didn't yet figure out how to get the slots power consumption
30 * out of the FCU, so that part has not been implemented yet and
31 * the slots fan is set to a fixed 50% PWM, hoping this value is
34 * Note: I have observed strange oscillations of the CPU control
35 * loop on a dual G5 here. When idle, the CPU exhaust fan tend to
36 * oscillates slowly (over several minutes) between the minimum
37 * of 300RPMs and approx. 1000 RPMs. I don't know what is causing
38 * this, it could be some incorrect constant or an error in the
39 * way I ported the algorithm, or it could be just normal. I
40 * don't have full understanding on the way Apple tweaked the PID
41 * algorithm for the CPU control, it is definitely not a standard
44 * TODO: - Check MPU structure version/signature
45 * - Add things like /sbin/overtemp for non-critical
46 * overtemp conditions so userland can take some policy
47 * decisions, like slewing down CPUs
48 * - Deal with fan and i2c failures in a better way
56 * - Read fan speed from FCU, low level fan routines now deal
57 * with errors & check fan status, though higher level don't
59 * - Move a bunch of definitions to .h file
62 * - Fix build on ppc64 kernel
63 * - Move back statics definitions to .c file
64 * - Avoid calling schedule_timeout with a negative number
67 * - Fix typo when reading back fan speed on 2 CPU machines
70 * - Rework code accessing the ADC chips, make it more robust and
71 * closer to the chip spec. Also make sure it is configured properly,
72 * I've seen yet unexplained cases where on startup, I would have stale
73 * values in the configuration register
74 * - Switch back to use of target fan speed for PID, thus lowering
78 #include <linux/config.h>
79 #include <linux/types.h>
80 #include <linux/module.h>
81 #include <linux/errno.h>
82 #include <linux/kernel.h>
83 #include <linux/delay.h>
84 #include <linux/sched.h>
85 #include <linux/i2c.h>
86 #include <linux/slab.h>
87 #include <linux/init.h>
88 #include <linux/spinlock.h>
89 #include <linux/smp_lock.h>
90 #include <linux/wait.h>
91 #include <linux/reboot.h>
92 #include <linux/kmod.h>
93 #include <linux/i2c.h>
94 #include <linux/i2c-dev.h>
96 #include <asm/machdep.h>
98 #include <asm/system.h>
99 #include <asm/sections.h>
100 #include <asm/of_device.h>
102 #include "therm_pm72.h"
104 #define VERSION "0.9"
109 #define DBG(args...) printk(args)
111 #define DBG(args...) do { } while(0)
119 static struct of_device * of_dev;
120 static struct i2c_adapter * u3_0;
121 static struct i2c_adapter * u3_1;
122 static struct i2c_client * fcu;
123 static struct cpu_pid_state cpu_state[2];
124 static struct backside_pid_state backside_state;
125 static struct drives_pid_state drives_state;
127 static int cpu_count;
128 static pid_t ctrl_task;
129 static struct completion ctrl_complete;
130 static int critical_state;
131 static DECLARE_MUTEX(driver_lock);
134 * i2c_driver structure to attach to the host i2c controller
137 static int therm_pm72_attach(struct i2c_adapter *adapter);
138 static int therm_pm72_detach(struct i2c_adapter *adapter);
140 static struct i2c_driver therm_pm72_driver =
142 .name = "therm_pm72",
144 .flags = I2C_DF_NOTIFY,
145 .attach_adapter = therm_pm72_attach,
146 .detach_adapter = therm_pm72_detach,
150 static inline void wait_ms(unsigned int ms)
152 set_current_state(TASK_UNINTERRUPTIBLE);
153 schedule_timeout(1 + (ms * HZ + 999) / 1000);
157 * Utility function to create an i2c_client structure and
158 * attach it to one of u3 adapters
160 static struct i2c_client *attach_i2c_chip(int id, const char *name)
162 struct i2c_client *clt;
163 struct i2c_adapter *adap;
172 clt = kmalloc(sizeof(struct i2c_client), GFP_KERNEL);
175 memset(clt, 0, sizeof(struct i2c_client));
177 clt->addr = (id >> 1) & 0x7f;
179 clt->driver = &therm_pm72_driver;
180 clt->id = 0xDEADBEEF;
181 strncpy(clt->name, name, I2C_NAME_SIZE-1);
183 if (i2c_attach_client(clt)) {
184 printk(KERN_ERR "therm_pm72: Failed to attach to i2c ID 0x%x\n", id);
192 * Utility function to get rid of the i2c_client structure
193 * (will also detach from the adapter hopepfully)
195 static void detach_i2c_chip(struct i2c_client *clt)
197 i2c_detach_client(clt);
202 * Here are the i2c chip access wrappers
205 static void initialize_adc(struct cpu_pid_state *state)
210 /* Read ADC the configuration register and cache it. We
211 * also make sure Config2 contains proper values, I've seen
212 * cases where we got stale grabage in there, thus preventing
213 * proper reading of conv. values
219 i2c_master_send(state->monitor, buf, 2);
221 /* Read & cache Config1 */
223 rc = i2c_master_send(state->monitor, buf, 1);
225 rc = i2c_master_recv(state->monitor, buf, 1);
227 state->adc_config = buf[0];
228 DBG("ADC config reg: %02x\n", state->adc_config);
229 /* Disable shutdown mode */
230 state->adc_config &= 0xfe;
232 buf[1] = state->adc_config;
233 rc = i2c_master_send(state->monitor, buf, 2);
237 printk(KERN_ERR "therm_pm72: Error reading ADC config"
241 static int read_smon_adc(struct cpu_pid_state *state, int chan)
243 int rc, data, tries = 0;
249 buf[1] = (state->adc_config & 0x1f) | (chan << 5);
250 rc = i2c_master_send(state->monitor, buf, 2);
253 /* Wait for convertion */
255 /* Switch to data register */
257 rc = i2c_master_send(state->monitor, buf, 1);
261 rc = i2c_master_recv(state->monitor, buf, 2);
264 data = ((u16)buf[0]) << 8 | (u16)buf[1];
267 DBG("Error reading ADC, retrying...\n");
269 printk(KERN_ERR "therm_pm72: Error reading ADC !\n");
276 static int fan_read_reg(int reg, unsigned char *buf, int nb)
283 nw = i2c_master_send(fcu, buf, 1);
284 if (nw > 0 || (nw < 0 && nw != -EIO) || tries >= 100)
290 printk(KERN_ERR "Failure writing address to FCU: %d", nw);
295 nr = i2c_master_recv(fcu, buf, nb);
296 if (nr > 0 || (nr < 0 && nr != ENODEV) || tries >= 100)
302 printk(KERN_ERR "Failure reading data from FCU: %d", nw);
306 static int fan_write_reg(int reg, const unsigned char *ptr, int nb)
309 unsigned char buf[16];
312 memcpy(buf+1, ptr, nb);
316 nw = i2c_master_send(fcu, buf, nb);
317 if (nw > 0 || (nw < 0 && nw != EIO) || tries >= 100)
323 printk(KERN_ERR "Failure writing to FCU: %d", nw);
327 static int set_rpm_fan(int fan, int rpm)
329 unsigned char buf[2];
338 rc = fan_write_reg(0x10 + (fan * 2), buf, 2);
344 static int get_rpm_fan(int fan, int programmed)
346 unsigned char failure;
347 unsigned char active;
348 unsigned char buf[2];
351 rc = fan_read_reg(0xb, &failure, 1);
354 if ((failure & (1 << fan)) != 0)
356 rc = fan_read_reg(0xd, &active, 1);
359 if ((active & (1 << fan)) == 0)
362 /* Programmed value or real current speed */
363 reg_base = programmed ? 0x10 : 0x11;
364 rc = fan_read_reg(reg_base + (fan * 2), buf, 2);
368 return (buf[0] << 5) | buf[1] >> 3;
371 static int set_pwm_fan(int fan, int pwm)
373 unsigned char buf[2];
380 pwm = (pwm * 2559) / 1000;
382 rc = fan_write_reg(0x30 + (fan * 2), buf, 1);
388 static int get_pwm_fan(int fan)
390 unsigned char failure;
391 unsigned char active;
392 unsigned char buf[2];
395 rc = fan_read_reg(0x2b, &failure, 1);
398 if ((failure & (1 << fan)) != 0)
400 rc = fan_read_reg(0x2d, &active, 1);
403 if ((active & (1 << fan)) == 0)
406 /* Programmed value or real current speed */
407 rc = fan_read_reg(0x30 + (fan * 2), buf, 1);
411 return (buf[0] * 1000) / 2559;
415 * Utility routine to read the CPU calibration EEPROM data
416 * from the device-tree
418 static int read_eeprom(int cpu, struct mpu_data *out)
420 struct device_node *np;
425 /* prom.c routine for finding a node by path is a bit brain dead
426 * and requires exact @xxx unit numbers. This is a bit ugly but
427 * will work for these machines
429 sprintf(nodename, "/u3@0,f8000000/i2c@f8001000/cpuid@a%d", cpu ? 2 : 0);
430 np = of_find_node_by_path(nodename);
432 printk(KERN_ERR "therm_pm72: Failed to retreive cpuid node from device-tree\n");
435 data = (u8 *)get_property(np, "cpuid", &len);
437 printk(KERN_ERR "therm_pm72: Failed to retreive cpuid property from device-tree\n");
441 memcpy(out, data, sizeof(struct mpu_data));
448 * Now, unfortunately, sysfs doesn't give us a nice void * we could
449 * pass around to the attribute functions, so we don't really have
450 * choice but implement a bunch of them...
452 * That sucks a bit, we take the lock because FIX32TOPRINT evaluates
453 * the input twice... I accept patches :)
455 #define BUILD_SHOW_FUNC_FIX(name, data) \
456 static ssize_t show_##name(struct device *dev, char *buf) \
459 down(&driver_lock); \
460 r = sprintf(buf, "%d.%03d", FIX32TOPRINT(data)); \
464 #define BUILD_SHOW_FUNC_INT(name, data) \
465 static ssize_t show_##name(struct device *dev, char *buf) \
467 return sprintf(buf, "%d", data); \
470 BUILD_SHOW_FUNC_FIX(cpu0_temperature, cpu_state[0].last_temp)
471 BUILD_SHOW_FUNC_FIX(cpu0_voltage, cpu_state[0].voltage)
472 BUILD_SHOW_FUNC_FIX(cpu0_current, cpu_state[0].current_a)
473 BUILD_SHOW_FUNC_INT(cpu0_exhaust_fan_rpm, cpu_state[0].rpm)
474 BUILD_SHOW_FUNC_INT(cpu0_intake_fan_rpm, cpu_state[0].intake_rpm)
476 BUILD_SHOW_FUNC_FIX(cpu1_temperature, cpu_state[1].last_temp)
477 BUILD_SHOW_FUNC_FIX(cpu1_voltage, cpu_state[1].voltage)
478 BUILD_SHOW_FUNC_FIX(cpu1_current, cpu_state[1].current_a)
479 BUILD_SHOW_FUNC_INT(cpu1_exhaust_fan_rpm, cpu_state[1].rpm)
480 BUILD_SHOW_FUNC_INT(cpu1_intake_fan_rpm, cpu_state[1].intake_rpm)
482 BUILD_SHOW_FUNC_FIX(backside_temperature, backside_state.last_temp)
483 BUILD_SHOW_FUNC_INT(backside_fan_pwm, backside_state.pwm)
485 BUILD_SHOW_FUNC_FIX(drives_temperature, drives_state.last_temp)
486 BUILD_SHOW_FUNC_INT(drives_fan_rpm, drives_state.rpm)
488 static DEVICE_ATTR(cpu0_temperature,S_IRUGO,show_cpu0_temperature,NULL);
489 static DEVICE_ATTR(cpu0_voltage,S_IRUGO,show_cpu0_voltage,NULL);
490 static DEVICE_ATTR(cpu0_current,S_IRUGO,show_cpu0_current,NULL);
491 static DEVICE_ATTR(cpu0_exhaust_fan_rpm,S_IRUGO,show_cpu0_exhaust_fan_rpm,NULL);
492 static DEVICE_ATTR(cpu0_intake_fan_rpm,S_IRUGO,show_cpu0_intake_fan_rpm,NULL);
494 static DEVICE_ATTR(cpu1_temperature,S_IRUGO,show_cpu1_temperature,NULL);
495 static DEVICE_ATTR(cpu1_voltage,S_IRUGO,show_cpu1_voltage,NULL);
496 static DEVICE_ATTR(cpu1_current,S_IRUGO,show_cpu1_current,NULL);
497 static DEVICE_ATTR(cpu1_exhaust_fan_rpm,S_IRUGO,show_cpu1_exhaust_fan_rpm,NULL);
498 static DEVICE_ATTR(cpu1_intake_fan_rpm,S_IRUGO,show_cpu1_intake_fan_rpm,NULL);
500 static DEVICE_ATTR(backside_temperature,S_IRUGO,show_backside_temperature,NULL);
501 static DEVICE_ATTR(backside_fan_pwm,S_IRUGO,show_backside_fan_pwm,NULL);
503 static DEVICE_ATTR(drives_temperature,S_IRUGO,show_drives_temperature,NULL);
504 static DEVICE_ATTR(drives_fan_rpm,S_IRUGO,show_drives_fan_rpm,NULL);
507 * CPUs fans control loop
509 static void do_monitor_cpu(struct cpu_pid_state *state)
511 s32 temp, voltage, current_a, power, power_target;
512 s32 integral, derivative, proportional, adj_in_target, sval;
513 s64 integ_p, deriv_p, prop_p, sum;
516 DBG("cpu %d:\n", state->index);
518 /* Read current fan status */
519 if (state->index == 0)
520 rc = get_rpm_fan(CPUA_EXHAUST_FAN_RPM_ID, !RPM_PID_USE_ACTUAL_SPEED);
522 rc = get_rpm_fan(CPUB_EXHAUST_FAN_RPM_ID, !RPM_PID_USE_ACTUAL_SPEED);
524 printk(KERN_WARNING "Error %d reading CPU %d exhaust fan !\n",
526 /* XXX What do we do now ? */
529 DBG(" current rpm: %d\n", state->rpm);
531 /* Get some sensor readings and scale it */
532 temp = read_smon_adc(state, 1);
537 voltage = read_smon_adc(state, 3);
538 current_a = read_smon_adc(state, 4);
540 /* Fixup temperature according to diode calibration
542 DBG(" temp raw: %04x, m_diode: %04x, b_diode: %04x\n",
543 temp, state->mpu.mdiode, state->mpu.bdiode);
544 temp = ((s32)temp * (s32)state->mpu.mdiode + ((s32)state->mpu.bdiode << 12)) >> 2;
545 state->last_temp = temp;
546 DBG(" temp: %d.%03d\n", FIX32TOPRINT(temp));
548 /* Check tmax, increment overtemp if we are there. At tmax+8, we go
549 * full blown immediately and try to trigger a shutdown
551 if (temp >= ((state->mpu.tmax + 8) << 16)) {
552 printk(KERN_WARNING "Warning ! CPU %d temperature way above maximum"
554 state->index, temp >> 16);
555 state->overtemp = CPU_MAX_OVERTEMP;
556 } else if (temp > (state->mpu.tmax << 16))
560 if (state->overtemp >= CPU_MAX_OVERTEMP)
562 if (state->overtemp > 0) {
563 state->rpm = state->mpu.rmaxn_exhaust_fan;
564 state->intake_rpm = intake = state->mpu.rmaxn_intake_fan;
568 /* Scale other sensor values according to fixed scales
569 * obtained in Darwin and calculate power from I and V
571 state->voltage = voltage *= ADC_CPU_VOLTAGE_SCALE;
572 state->current_a = current_a *= ADC_CPU_CURRENT_SCALE;
573 power = (((u64)current_a) * ((u64)voltage)) >> 16;
575 /* Calculate power target value (could be done once for all)
576 * and convert to a 16.16 fp number
578 power_target = ((u32)(state->mpu.pmaxh - state->mpu.padjmax)) << 16;
580 DBG(" current: %d.%03d, voltage: %d.%03d\n",
581 FIX32TOPRINT(current_a), FIX32TOPRINT(voltage));
582 DBG(" power: %d.%03d W, target: %d.%03d, error: %d.%03d\n", FIX32TOPRINT(power),
583 FIX32TOPRINT(power_target), FIX32TOPRINT(power_target - power));
585 /* Store temperature and power in history array */
586 state->cur_temp = (state->cur_temp + 1) % CPU_TEMP_HISTORY_SIZE;
587 state->temp_history[state->cur_temp] = temp;
588 state->cur_power = (state->cur_power + 1) % state->count_power;
589 state->power_history[state->cur_power] = power;
590 state->error_history[state->cur_power] = power_target - power;
592 /* If first loop, fill the history table */
594 for (i = 0; i < (state->count_power - 1); i++) {
595 state->cur_power = (state->cur_power + 1) % state->count_power;
596 state->power_history[state->cur_power] = power;
597 state->error_history[state->cur_power] = power_target - power;
599 for (i = 0; i < (CPU_TEMP_HISTORY_SIZE - 1); i++) {
600 state->cur_temp = (state->cur_temp + 1) % CPU_TEMP_HISTORY_SIZE;
601 state->temp_history[state->cur_temp] = temp;
606 /* Calculate the integral term normally based on the "power" values */
609 for (i = 0; i < state->count_power; i++)
610 integral += state->error_history[i];
611 integral *= CPU_PID_INTERVAL;
612 DBG(" integral: %08x\n", integral);
614 /* Calculate the adjusted input (sense value).
617 * so the result is 28.36
619 * input target is mpu.ttarget, input max is mpu.tmax
621 integ_p = ((s64)state->mpu.pid_gr) * (s64)integral;
622 DBG(" integ_p: %d\n", (int)(deriv_p >> 36));
623 sval = (state->mpu.tmax << 16) - ((integ_p >> 20) & 0xffffffff);
624 adj_in_target = (state->mpu.ttarget << 16);
625 if (adj_in_target > sval)
626 adj_in_target = sval;
627 DBG(" adj_in_target: %d.%03d, ttarget: %d\n", FIX32TOPRINT(adj_in_target),
630 /* Calculate the derivative term */
631 derivative = state->temp_history[state->cur_temp] -
632 state->temp_history[(state->cur_temp + CPU_TEMP_HISTORY_SIZE - 1)
633 % CPU_TEMP_HISTORY_SIZE];
634 derivative /= CPU_PID_INTERVAL;
635 deriv_p = ((s64)state->mpu.pid_gd) * (s64)derivative;
636 DBG(" deriv_p: %d\n", (int)(deriv_p >> 36));
639 /* Calculate the proportional term */
640 proportional = temp - adj_in_target;
641 prop_p = ((s64)state->mpu.pid_gp) * (s64)proportional;
642 DBG(" prop_p: %d\n", (int)(prop_p >> 36));
648 DBG(" sum: %d\n", (int)sum);
649 state->rpm += (s32)sum;
651 if (state->rpm < state->mpu.rminn_exhaust_fan)
652 state->rpm = state->mpu.rminn_exhaust_fan;
653 if (state->rpm > state->mpu.rmaxn_exhaust_fan)
654 state->rpm = state->mpu.rmaxn_exhaust_fan;
656 intake = (state->rpm * CPU_INTAKE_SCALE) >> 16;
657 if (intake < state->mpu.rminn_intake_fan)
658 intake = state->mpu.rminn_intake_fan;
659 if (intake > state->mpu.rmaxn_intake_fan)
660 intake = state->mpu.rmaxn_intake_fan;
661 state->intake_rpm = intake;
664 DBG("** CPU %d RPM: %d Ex, %d In, overtemp: %d\n",
665 state->index, (int)state->rpm, intake, state->overtemp);
667 /* We should check for errors, shouldn't we ? But then, what
668 * do we do once the error occurs ? For FCU notified fan
669 * failures (-EFAULT) we probably want to notify userland
672 if (state->index == 0) {
673 set_rpm_fan(CPUA_INTAKE_FAN_RPM_ID, intake);
674 set_rpm_fan(CPUA_EXHAUST_FAN_RPM_ID, state->rpm);
676 set_rpm_fan(CPUB_INTAKE_FAN_RPM_ID, intake);
677 set_rpm_fan(CPUB_EXHAUST_FAN_RPM_ID, state->rpm);
682 * Initialize the state structure for one CPU control loop
684 static int init_cpu_state(struct cpu_pid_state *state, int index)
686 state->index = index;
690 state->adc_config = 0x00;
693 state->monitor = attach_i2c_chip(SUPPLY_MONITOR_ID, "CPU0_monitor");
695 state->monitor = attach_i2c_chip(SUPPLY_MONITORB_ID, "CPU1_monitor");
696 if (state->monitor == NULL)
699 if (read_eeprom(index, &state->mpu))
702 state->count_power = state->mpu.tguardband;
703 if (state->count_power > CPU_POWER_HISTORY_SIZE) {
704 printk(KERN_WARNING "Warning ! too many power history slots\n");
705 state->count_power = CPU_POWER_HISTORY_SIZE;
707 DBG("CPU %d Using %d power history entries\n", index, state->count_power);
710 device_create_file(&of_dev->dev, &dev_attr_cpu0_temperature);
711 device_create_file(&of_dev->dev, &dev_attr_cpu0_voltage);
712 device_create_file(&of_dev->dev, &dev_attr_cpu0_current);
713 device_create_file(&of_dev->dev, &dev_attr_cpu0_exhaust_fan_rpm);
714 device_create_file(&of_dev->dev, &dev_attr_cpu0_intake_fan_rpm);
716 device_create_file(&of_dev->dev, &dev_attr_cpu1_temperature);
717 device_create_file(&of_dev->dev, &dev_attr_cpu1_voltage);
718 device_create_file(&of_dev->dev, &dev_attr_cpu1_current);
719 device_create_file(&of_dev->dev, &dev_attr_cpu1_exhaust_fan_rpm);
720 device_create_file(&of_dev->dev, &dev_attr_cpu1_intake_fan_rpm);
726 detach_i2c_chip(state->monitor);
727 state->monitor = NULL;
733 * Dispose of the state data for one CPU control loop
735 static void dispose_cpu_state(struct cpu_pid_state *state)
737 if (state->monitor == NULL)
740 if (state->index == 0) {
741 device_remove_file(&of_dev->dev, &dev_attr_cpu0_temperature);
742 device_remove_file(&of_dev->dev, &dev_attr_cpu0_voltage);
743 device_remove_file(&of_dev->dev, &dev_attr_cpu0_current);
744 device_remove_file(&of_dev->dev, &dev_attr_cpu0_exhaust_fan_rpm);
745 device_remove_file(&of_dev->dev, &dev_attr_cpu0_intake_fan_rpm);
747 device_remove_file(&of_dev->dev, &dev_attr_cpu1_temperature);
748 device_remove_file(&of_dev->dev, &dev_attr_cpu1_voltage);
749 device_remove_file(&of_dev->dev, &dev_attr_cpu1_current);
750 device_remove_file(&of_dev->dev, &dev_attr_cpu1_exhaust_fan_rpm);
751 device_remove_file(&of_dev->dev, &dev_attr_cpu1_intake_fan_rpm);
754 detach_i2c_chip(state->monitor);
755 state->monitor = NULL;
759 * Motherboard backside & U3 heatsink fan control loop
761 static void do_monitor_backside(struct backside_pid_state *state)
763 s32 temp, integral, derivative;
764 s64 integ_p, deriv_p, prop_p, sum;
767 if (--state->ticks != 0)
769 state->ticks = BACKSIDE_PID_INTERVAL;
773 /* Check fan status */
774 rc = get_pwm_fan(BACKSIDE_FAN_PWM_ID);
776 printk(KERN_WARNING "Error %d reading backside fan !\n", rc);
777 /* XXX What do we do now ? */
780 DBG(" current pwm: %d\n", state->pwm);
782 /* Get some sensor readings */
783 temp = i2c_smbus_read_byte_data(state->monitor, MAX6690_EXT_TEMP) << 16;
784 state->last_temp = temp;
785 DBG(" temp: %d.%03d, target: %d.%03d\n", FIX32TOPRINT(temp),
786 FIX32TOPRINT(BACKSIDE_PID_INPUT_TARGET));
788 /* Store temperature and error in history array */
789 state->cur_sample = (state->cur_sample + 1) % BACKSIDE_PID_HISTORY_SIZE;
790 state->sample_history[state->cur_sample] = temp;
791 state->error_history[state->cur_sample] = temp - BACKSIDE_PID_INPUT_TARGET;
793 /* If first loop, fill the history table */
795 for (i = 0; i < (BACKSIDE_PID_HISTORY_SIZE - 1); i++) {
796 state->cur_sample = (state->cur_sample + 1) %
797 BACKSIDE_PID_HISTORY_SIZE;
798 state->sample_history[state->cur_sample] = temp;
799 state->error_history[state->cur_sample] =
800 temp - BACKSIDE_PID_INPUT_TARGET;
805 /* Calculate the integral term */
808 for (i = 0; i < BACKSIDE_PID_HISTORY_SIZE; i++)
809 integral += state->error_history[i];
810 integral *= BACKSIDE_PID_INTERVAL;
811 DBG(" integral: %08x\n", integral);
812 integ_p = ((s64)BACKSIDE_PID_G_r) * (s64)integral;
813 DBG(" integ_p: %d\n", (int)(integ_p >> 36));
816 /* Calculate the derivative term */
817 derivative = state->error_history[state->cur_sample] -
818 state->error_history[(state->cur_sample + BACKSIDE_PID_HISTORY_SIZE - 1)
819 % BACKSIDE_PID_HISTORY_SIZE];
820 derivative /= BACKSIDE_PID_INTERVAL;
821 deriv_p = ((s64)BACKSIDE_PID_G_d) * (s64)derivative;
822 DBG(" deriv_p: %d\n", (int)(deriv_p >> 36));
825 /* Calculate the proportional term */
826 prop_p = ((s64)BACKSIDE_PID_G_p) * (s64)(state->error_history[state->cur_sample]);
827 DBG(" prop_p: %d\n", (int)(prop_p >> 36));
833 DBG(" sum: %d\n", (int)sum);
834 state->pwm += (s32)sum;
835 if (state->pwm < BACKSIDE_PID_OUTPUT_MIN)
836 state->pwm = BACKSIDE_PID_OUTPUT_MIN;
837 if (state->pwm > BACKSIDE_PID_OUTPUT_MAX)
838 state->pwm = BACKSIDE_PID_OUTPUT_MAX;
840 DBG("** BACKSIDE PWM: %d\n", (int)state->pwm);
841 set_pwm_fan(BACKSIDE_FAN_PWM_ID, state->pwm);
845 * Initialize the state structure for the backside fan control loop
847 static int init_backside_state(struct backside_pid_state *state)
853 state->monitor = attach_i2c_chip(BACKSIDE_MAX_ID, "backside_temp");
854 if (state->monitor == NULL)
857 device_create_file(&of_dev->dev, &dev_attr_backside_temperature);
858 device_create_file(&of_dev->dev, &dev_attr_backside_fan_pwm);
864 * Dispose of the state data for the backside control loop
866 static void dispose_backside_state(struct backside_pid_state *state)
868 if (state->monitor == NULL)
871 device_remove_file(&of_dev->dev, &dev_attr_backside_temperature);
872 device_remove_file(&of_dev->dev, &dev_attr_backside_fan_pwm);
874 detach_i2c_chip(state->monitor);
875 state->monitor = NULL;
879 * Drives bay fan control loop
881 static void do_monitor_drives(struct drives_pid_state *state)
883 s32 temp, integral, derivative;
884 s64 integ_p, deriv_p, prop_p, sum;
887 if (--state->ticks != 0)
889 state->ticks = DRIVES_PID_INTERVAL;
893 /* Check fan status */
894 rc = get_rpm_fan(DRIVES_FAN_RPM_ID, !RPM_PID_USE_ACTUAL_SPEED);
896 printk(KERN_WARNING "Error %d reading drives fan !\n", rc);
897 /* XXX What do we do now ? */
900 DBG(" current rpm: %d\n", state->rpm);
902 /* Get some sensor readings */
903 temp = le16_to_cpu(i2c_smbus_read_word_data(state->monitor, DS1775_TEMP)) << 8;
904 state->last_temp = temp;
905 DBG(" temp: %d.%03d, target: %d.%03d\n", FIX32TOPRINT(temp),
906 FIX32TOPRINT(DRIVES_PID_INPUT_TARGET));
908 /* Store temperature and error in history array */
909 state->cur_sample = (state->cur_sample + 1) % DRIVES_PID_HISTORY_SIZE;
910 state->sample_history[state->cur_sample] = temp;
911 state->error_history[state->cur_sample] = temp - DRIVES_PID_INPUT_TARGET;
913 /* If first loop, fill the history table */
915 for (i = 0; i < (DRIVES_PID_HISTORY_SIZE - 1); i++) {
916 state->cur_sample = (state->cur_sample + 1) %
917 DRIVES_PID_HISTORY_SIZE;
918 state->sample_history[state->cur_sample] = temp;
919 state->error_history[state->cur_sample] =
920 temp - DRIVES_PID_INPUT_TARGET;
925 /* Calculate the integral term */
928 for (i = 0; i < DRIVES_PID_HISTORY_SIZE; i++)
929 integral += state->error_history[i];
930 integral *= DRIVES_PID_INTERVAL;
931 DBG(" integral: %08x\n", integral);
932 integ_p = ((s64)DRIVES_PID_G_r) * (s64)integral;
933 DBG(" integ_p: %d\n", (int)(integ_p >> 36));
936 /* Calculate the derivative term */
937 derivative = state->error_history[state->cur_sample] -
938 state->error_history[(state->cur_sample + DRIVES_PID_HISTORY_SIZE - 1)
939 % DRIVES_PID_HISTORY_SIZE];
940 derivative /= DRIVES_PID_INTERVAL;
941 deriv_p = ((s64)DRIVES_PID_G_d) * (s64)derivative;
942 DBG(" deriv_p: %d\n", (int)(deriv_p >> 36));
945 /* Calculate the proportional term */
946 prop_p = ((s64)DRIVES_PID_G_p) * (s64)(state->error_history[state->cur_sample]);
947 DBG(" prop_p: %d\n", (int)(prop_p >> 36));
953 DBG(" sum: %d\n", (int)sum);
954 state->rpm += (s32)sum;
955 if (state->rpm < DRIVES_PID_OUTPUT_MIN)
956 state->rpm = DRIVES_PID_OUTPUT_MIN;
957 if (state->rpm > DRIVES_PID_OUTPUT_MAX)
958 state->rpm = DRIVES_PID_OUTPUT_MAX;
960 DBG("** DRIVES RPM: %d\n", (int)state->rpm);
961 set_rpm_fan(DRIVES_FAN_RPM_ID, state->rpm);
965 * Initialize the state structure for the drives bay fan control loop
967 static int init_drives_state(struct drives_pid_state *state)
973 state->monitor = attach_i2c_chip(DRIVES_DALLAS_ID, "drives_temp");
974 if (state->monitor == NULL)
977 device_create_file(&of_dev->dev, &dev_attr_drives_temperature);
978 device_create_file(&of_dev->dev, &dev_attr_drives_fan_rpm);
984 * Dispose of the state data for the drives control loop
986 static void dispose_drives_state(struct drives_pid_state *state)
988 if (state->monitor == NULL)
991 device_remove_file(&of_dev->dev, &dev_attr_drives_temperature);
992 device_remove_file(&of_dev->dev, &dev_attr_drives_fan_rpm);
994 detach_i2c_chip(state->monitor);
995 state->monitor = NULL;
998 static int call_critical_overtemp(void)
1000 char *argv[] = { critical_overtemp_path, NULL };
1001 static char *envp[] = { "HOME=/",
1003 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
1006 return call_usermodehelper(critical_overtemp_path, argv, envp, 0);
1011 * Here's the kernel thread that calls the various control loops
1013 static int main_control_loop(void *x)
1017 DBG("main_control_loop started\n");
1021 /* Set the PCI fan once for now */
1022 set_pwm_fan(SLOTS_FAN_PWM_ID, SLOTS_FAN_DEFAULT_PWM);
1024 /* Initialize ADCs */
1025 initialize_adc(&cpu_state[0]);
1026 if (cpu_state[1].monitor != NULL)
1027 initialize_adc(&cpu_state[1]);
1031 while (state == state_attached) {
1032 unsigned long elapsed, start;
1037 do_monitor_cpu(&cpu_state[0]);
1038 if (cpu_state[1].monitor != NULL)
1039 do_monitor_cpu(&cpu_state[1]);
1040 do_monitor_backside(&backside_state);
1041 do_monitor_drives(&drives_state);
1044 if (critical_state == 1) {
1045 printk(KERN_WARNING "Temperature control detected a critical condition\n");
1046 printk(KERN_WARNING "Attempting to shut down...\n");
1047 if (call_critical_overtemp()) {
1048 printk(KERN_WARNING "Can't call %s, power off now!\n",
1049 critical_overtemp_path);
1050 machine_power_off();
1053 if (critical_state > 0)
1055 if (critical_state > MAX_CRITICAL_STATE) {
1056 printk(KERN_WARNING "Shutdown timed out, power off now !\n");
1057 machine_power_off();
1060 // FIXME: Deal with signals
1061 set_current_state(TASK_INTERRUPTIBLE);
1062 elapsed = jiffies - start;
1064 schedule_timeout(HZ - elapsed);
1067 DBG("main_control_loop ended\n");
1070 complete_and_exit(&ctrl_complete, 0);
1074 * Dispose the control loops when tearing down
1076 static void dispose_control_loops(void)
1078 dispose_cpu_state(&cpu_state[0]);
1079 dispose_cpu_state(&cpu_state[1]);
1081 dispose_backside_state(&backside_state);
1082 dispose_drives_state(&drives_state);
1086 * Create the control loops. U3-0 i2c bus is up, so we can now
1087 * get to the various sensors
1089 static int create_control_loops(void)
1091 struct device_node *np;
1093 /* Count CPUs from the device-tree, we don't care how many are
1094 * actually used by Linux
1097 for (np = NULL; NULL != (np = of_find_node_by_type(np, "cpu"));)
1100 DBG("counted %d CPUs in the device-tree\n", cpu_count);
1102 /* Create control loops for everything. If any fail, everything
1105 if (init_cpu_state(&cpu_state[0], 0))
1107 if (cpu_count > 1 && init_cpu_state(&cpu_state[1], 1))
1109 if (init_backside_state(&backside_state))
1111 if (init_drives_state(&drives_state))
1114 DBG("all control loops up !\n");
1119 DBG("failure creating control loops, disposing\n");
1121 dispose_control_loops();
1127 * Start the control loops after everything is up, that is create
1128 * the thread that will make them run
1130 static void start_control_loops(void)
1132 init_completion(&ctrl_complete);
1134 ctrl_task = kernel_thread(main_control_loop, NULL, SIGCHLD | CLONE_KERNEL);
1138 * Stop the control loops when tearing down
1140 static void stop_control_loops(void)
1143 wait_for_completion(&ctrl_complete);
1147 * Attach to the i2c FCU after detecting U3-1 bus
1149 static int attach_fcu(void)
1151 fcu = attach_i2c_chip(FAN_CTRLER_ID, "fcu");
1155 DBG("FCU attached\n");
1161 * Detach from the i2c FCU when tearing down
1163 static void detach_fcu(void)
1166 detach_i2c_chip(fcu);
1171 * Attach to the i2c controller. We probe the various chips based
1172 * on the device-tree nodes and build everything for the driver to
1173 * run, we then kick the driver monitoring thread
1175 static int therm_pm72_attach(struct i2c_adapter *adapter)
1180 if (state == state_detached)
1181 state = state_attaching;
1182 if (state != state_attaching) {
1187 /* Check if we are looking for one of these */
1188 if (u3_0 == NULL && !strcmp(adapter->name, "u3 0")) {
1190 DBG("found U3-0, creating control loops\n");
1191 if (create_control_loops())
1193 } else if (u3_1 == NULL && !strcmp(adapter->name, "u3 1")) {
1195 DBG("found U3-1, attaching FCU\n");
1199 /* We got all we need, start control loops */
1200 if (u3_0 != NULL && u3_1 != NULL) {
1201 DBG("everything up, starting control loops\n");
1202 state = state_attached;
1203 start_control_loops();
1211 * Called on every adapter when the driver or the i2c controller
1214 static int therm_pm72_detach(struct i2c_adapter *adapter)
1218 if (state != state_detached)
1219 state = state_detaching;
1221 /* Stop control loops if any */
1222 DBG("stopping control loops\n");
1224 stop_control_loops();
1227 if (u3_0 != NULL && !strcmp(adapter->name, "u3 0")) {
1228 DBG("lost U3-0, disposing control loops\n");
1229 dispose_control_loops();
1233 if (u3_1 != NULL && !strcmp(adapter->name, "u3 1")) {
1234 DBG("lost U3-1, detaching FCU\n");
1238 if (u3_0 == NULL && u3_1 == NULL)
1239 state = state_detached;
1246 static int fcu_of_probe(struct of_device* dev, const struct of_match *match)
1250 state = state_detached;
1252 rc = i2c_add_driver(&therm_pm72_driver);
1258 static int fcu_of_remove(struct of_device* dev)
1260 i2c_del_driver(&therm_pm72_driver);
1265 static struct of_match fcu_of_match[] =
1268 .name = OF_ANY_MATCH,
1270 .compatible = OF_ANY_MATCH
1275 static struct of_platform_driver fcu_of_platform_driver =
1277 .name = "temperature",
1278 .match_table = fcu_of_match,
1279 .probe = fcu_of_probe,
1280 .remove = fcu_of_remove
1284 * Check machine type, attach to i2c controller
1286 static int __init therm_pm72_init(void)
1288 struct device_node *np;
1290 if (!machine_is_compatible("PowerMac7,2"))
1293 printk(KERN_INFO "PowerMac G5 Thermal control driver %s\n", VERSION);
1295 np = of_find_node_by_type(NULL, "fcu");
1297 printk(KERN_ERR "Can't find FCU in device-tree !\n");
1300 of_dev = of_platform_device_create(np, "temperature");
1301 if (of_dev == NULL) {
1302 printk(KERN_ERR "Can't register FCU platform device !\n");
1306 of_register_driver(&fcu_of_platform_driver);
1311 static void __exit therm_pm72_exit(void)
1313 of_unregister_driver(&fcu_of_platform_driver);
1316 of_device_unregister(of_dev);
1319 module_init(therm_pm72_init);
1320 module_exit(therm_pm72_exit);
1322 MODULE_AUTHOR("Benjamin Herrenschmidt <benh@kernel.crashing.org>");
1323 MODULE_DESCRIPTION("Driver for Apple's PowerMac7,2 G5 thermal control");
1324 MODULE_LICENSE("GPL");