2 * Device driver for the i2c thermostat found on the iBook G4, Albook G4
4 * Copyright (C) 2003, 2004 Colin Leroy, Rasmus Rohde, Benjamin Herrenschmidt
7 * http://www.analog.com/UploadedFiles/Data_Sheets/115254175ADT7467_pra.pdf
8 * http://www.analog.com/UploadedFiles/Data_Sheets/3686221171167ADT7460_b.pdf
12 #include <linux/types.h>
13 #include <linux/module.h>
14 #include <linux/errno.h>
15 #include <linux/kernel.h>
16 #include <linux/delay.h>
17 #include <linux/sched.h>
18 #include <linux/i2c.h>
19 #include <linux/slab.h>
20 #include <linux/init.h>
21 #include <linux/spinlock.h>
22 #include <linux/wait.h>
23 #include <linux/suspend.h>
24 #include <linux/kthread.h>
25 #include <linux/moduleparam.h>
26 #include <linux/freezer.h>
27 #include <linux/of_platform.h>
30 #include <asm/machdep.h>
32 #include <asm/system.h>
33 #include <asm/sections.h>
37 #define CONFIG_REG 0x40
38 #define MANUAL_MASK 0xe0
39 #define AUTO_MASK 0x20
40 #define INVERT_MASK 0x10
42 static u8 TEMP_REG[3] = {0x26, 0x25, 0x27}; /* local, sensor1, sensor2 */
43 static u8 LIMIT_REG[3] = {0x6b, 0x6a, 0x6c}; /* local, sensor1, sensor2 */
44 static u8 MANUAL_MODE[2] = {0x5c, 0x5d};
45 static u8 REM_CONTROL[2] = {0x00, 0x40};
46 static u8 FAN_SPEED[2] = {0x28, 0x2a};
47 static u8 FAN_SPD_SET[2] = {0x30, 0x31};
49 static u8 default_limits_local[3] = {70, 50, 70}; /* local, sensor1, sensor2 */
50 static u8 default_limits_chip[3] = {80, 65, 80}; /* local, sensor1, sensor2 */
51 static const char *sensor_location[3];
53 static int limit_adjust;
54 static int fan_speed = -1;
57 MODULE_AUTHOR("Colin Leroy <colin@colino.net>");
58 MODULE_DESCRIPTION("Driver for ADT746x thermostat in iBook G4 and "
60 MODULE_LICENSE("GPL");
62 module_param(limit_adjust, int, 0644);
63 MODULE_PARM_DESC(limit_adjust,"Adjust maximum temperatures (50 sensor1, 70 sensor2) "
66 module_param(fan_speed, int, 0644);
67 MODULE_PARM_DESC(fan_speed,"Specify starting fan speed (0-255) "
70 module_param(verbose, bool, 0);
71 MODULE_PARM_DESC(verbose,"Verbose log operations "
75 struct i2c_client *clt;
84 static enum {ADT7460, ADT7467} therm_type;
85 static int therm_bus, therm_address;
86 static struct of_device * of_dev;
87 static struct thermostat* thermostat;
88 static struct task_struct *thread_therm = NULL;
90 static void write_both_fan_speed(struct thermostat *th, int speed);
91 static void write_fan_speed(struct thermostat *th, int speed, int fan);
94 write_reg(struct thermostat* th, int reg, u8 data)
101 rc = i2c_master_send(th->clt, (const char *)tmp, 2);
110 read_reg(struct thermostat* th, int reg)
116 rc = i2c_master_send(th->clt, ®_addr, 1);
121 rc = i2c_master_recv(th->clt, (char *)&data, 1);
128 attach_thermostat(struct i2c_adapter *adapter)
130 unsigned long bus_no;
131 struct i2c_board_info info;
132 struct i2c_client *client;
134 if (strncmp(adapter->name, "uni-n", 5))
136 bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
137 if (bus_no != therm_bus)
140 memset(&info, 0, sizeof(struct i2c_board_info));
141 strlcpy(info.type, "therm_adt746x", I2C_NAME_SIZE);
142 info.addr = therm_address;
143 client = i2c_new_device(adapter, &info);
148 * Let i2c-core delete that device on driver removal.
149 * This is safe because i2c-core holds the core_lock mutex for us.
151 list_add_tail(&client->detected, &client->driver->clients);
156 remove_thermostat(struct i2c_client *client)
158 struct thermostat *th = i2c_get_clientdata(client);
161 if (thread_therm != NULL) {
162 kthread_stop(thread_therm);
165 printk(KERN_INFO "adt746x: Putting max temperatures back from "
166 "%d, %d, %d to %d, %d, %d\n",
167 th->limits[0], th->limits[1], th->limits[2],
168 th->initial_limits[0], th->initial_limits[1],
169 th->initial_limits[2]);
171 for (i = 0; i < 3; i++)
172 write_reg(th, LIMIT_REG[i], th->initial_limits[i]);
174 write_both_fan_speed(th, -1);
183 static int read_fan_speed(struct thermostat *th, u8 addr)
188 /* should start with low byte */
189 tmp[1] = read_reg(th, addr);
190 tmp[0] = read_reg(th, addr + 1);
192 res = tmp[1] + (tmp[0] << 8);
193 /* "a value of 0xffff means that the fan has stopped" */
194 return (res == 0xffff ? 0 : (90000*60)/res);
197 static void write_both_fan_speed(struct thermostat *th, int speed)
199 write_fan_speed(th, speed, 0);
200 if (therm_type == ADT7460)
201 write_fan_speed(th, speed, 1);
204 static void write_fan_speed(struct thermostat *th, int speed, int fan)
213 if (therm_type == ADT7467 && fan == 1)
216 if (th->last_speed[fan] != speed) {
219 printk(KERN_DEBUG "adt746x: Setting speed to automatic "
220 "for %s fan.\n", sensor_location[fan+1]);
222 printk(KERN_DEBUG "adt746x: Setting speed to %d "
223 "for %s fan.\n", speed, sensor_location[fan+1]);
229 manual = read_reg(th, MANUAL_MODE[fan]);
230 write_reg(th, MANUAL_MODE[fan],
231 (manual|MANUAL_MASK) & (~INVERT_MASK));
232 write_reg(th, FAN_SPD_SET[fan], speed);
234 /* back to automatic */
235 if(therm_type == ADT7460) {
236 manual = read_reg(th,
237 MANUAL_MODE[fan]) & (~MANUAL_MASK);
240 MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
242 manual = read_reg(th, MANUAL_MODE[fan]);
243 write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
247 th->last_speed[fan] = speed;
250 static void read_sensors(struct thermostat *th)
254 for (i = 0; i < 3; i++)
255 th->temps[i] = read_reg(th, TEMP_REG[i]);
259 static void display_stats(struct thermostat *th)
261 if (th->temps[0] != th->cached_temp[0]
262 || th->temps[1] != th->cached_temp[1]
263 || th->temps[2] != th->cached_temp[2]) {
264 printk(KERN_INFO "adt746x: Temperature infos:"
265 " thermostats: %d,%d,%d;"
267 " fan speed: %d RPM\n",
268 th->temps[0], th->temps[1], th->temps[2],
269 th->limits[0], th->limits[1], th->limits[2],
270 read_fan_speed(th, FAN_SPEED[0]));
272 th->cached_temp[0] = th->temps[0];
273 th->cached_temp[1] = th->temps[1];
274 th->cached_temp[2] = th->temps[2];
278 static void update_fans_speed (struct thermostat *th)
280 int lastvar = 0; /* last variation, for iBook */
283 /* we don't care about local sensor, so we start at sensor 1 */
284 for (i = 1; i < 3; i++) {
286 int fan_number = (therm_type == ADT7460 && i == 2);
287 int var = th->temps[i] - th->limits[i];
290 int step = (255 - fan_speed) / 7;
293 /* hysteresis : change fan speed only if variation is
294 * more than two degrees */
295 if (abs(var - th->last_var[fan_number]) < 2)
299 new_speed = fan_speed + ((var-1)*step);
301 if (new_speed < fan_speed)
302 new_speed = fan_speed;
307 printk(KERN_DEBUG "adt746x: Setting fans speed to %d "
308 "(limit exceeded by %d on %s) \n",
310 sensor_location[fan_number+1]);
311 write_both_fan_speed(th, new_speed);
312 th->last_var[fan_number] = var;
313 } else if (var < -2) {
314 /* don't stop fan if sensor2 is cold and sensor1 is not
315 * so cold (lastvar >= -1) */
316 if (i == 2 && lastvar < -1) {
317 if (th->last_speed[fan_number] != 0)
319 printk(KERN_DEBUG "adt746x: Stopping "
321 write_both_fan_speed(th, 0);
328 return; /* we don't want to re-stop the fan
329 * if sensor1 is heating and sensor2 is not */
333 static int monitor_task(void *arg)
335 struct thermostat* th = arg;
338 while(!kthread_should_stop()) {
340 msleep_interruptible(2000);
350 update_fans_speed(th);
361 static void set_limit(struct thermostat *th, int i)
363 /* Set sensor1 limit higher to avoid powerdowns */
364 th->limits[i] = default_limits_chip[i] + limit_adjust;
365 write_reg(th, LIMIT_REG[i], th->limits[i]);
367 /* set our limits to normal */
368 th->limits[i] = default_limits_local[i] + limit_adjust;
371 static int probe_thermostat(struct i2c_client *client,
372 const struct i2c_device_id *id)
374 struct thermostat* th;
381 th = kzalloc(sizeof(struct thermostat), GFP_KERNEL);
385 i2c_set_clientdata(client, th);
388 rc = read_reg(th, 0);
390 dev_err(&client->dev, "Thermostat failed to read config!\n");
395 /* force manual control to start the fan quieter */
399 if(therm_type == ADT7460) {
400 printk(KERN_INFO "adt746x: ADT7460 initializing\n");
401 /* The 7460 needs to be started explicitly */
402 write_reg(th, CONFIG_REG, 1);
404 printk(KERN_INFO "adt746x: ADT7467 initializing\n");
406 for (i = 0; i < 3; i++) {
407 th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
411 printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
413 th->initial_limits[0], th->initial_limits[1],
414 th->initial_limits[2], th->limits[0], th->limits[1],
419 /* be sure to really write fan speed the first time */
420 th->last_speed[0] = -2;
421 th->last_speed[1] = -2;
422 th->last_var[0] = -80;
423 th->last_var[1] = -80;
425 if (fan_speed != -1) {
426 /* manual mode, stop fans */
427 write_both_fan_speed(th, 0);
430 write_both_fan_speed(th, -1);
433 thread_therm = kthread_run(monitor_task, th, "kfand");
435 if (thread_therm == ERR_PTR(-ENOMEM)) {
436 printk(KERN_INFO "adt746x: Kthread creation failed\n");
444 static const struct i2c_device_id therm_adt746x_id[] = {
445 { "therm_adt746x", 0 },
449 static struct i2c_driver thermostat_driver = {
451 .name = "therm_adt746x",
453 .attach_adapter = attach_thermostat,
454 .probe = probe_thermostat,
455 .remove = remove_thermostat,
456 .id_table = therm_adt746x_id,
460 * Now, unfortunately, sysfs doesn't give us a nice void * we could
461 * pass around to the attribute functions, so we don't really have
462 * choice but implement a bunch of them...
464 * FIXME, it does now...
466 #define BUILD_SHOW_FUNC_INT(name, data) \
467 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
469 return sprintf(buf, "%d\n", data); \
472 #define BUILD_SHOW_FUNC_STR(name, data) \
473 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
475 return sprintf(buf, "%s\n", data); \
478 #define BUILD_SHOW_FUNC_FAN(name, data) \
479 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
481 return sprintf(buf, "%d (%d rpm)\n", \
482 thermostat->last_speed[data], \
483 read_fan_speed(thermostat, FAN_SPEED[data]) \
487 #define BUILD_STORE_FUNC_DEG(name, data) \
488 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
492 val = simple_strtol(buf, NULL, 10); \
493 printk(KERN_INFO "Adjusting limits by %d degrees\n", val); \
494 limit_adjust = val; \
495 for (i=0; i < 3; i++) \
496 set_limit(thermostat, i); \
500 #define BUILD_STORE_FUNC_INT(name, data) \
501 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
504 val = simple_strtol(buf, NULL, 10); \
505 if (val < 0 || val > 255) \
507 printk(KERN_INFO "Setting specified fan speed to %d\n", val); \
512 BUILD_SHOW_FUNC_INT(sensor1_temperature, (read_reg(thermostat, TEMP_REG[1])))
513 BUILD_SHOW_FUNC_INT(sensor2_temperature, (read_reg(thermostat, TEMP_REG[2])))
514 BUILD_SHOW_FUNC_INT(sensor1_limit, thermostat->limits[1])
515 BUILD_SHOW_FUNC_INT(sensor2_limit, thermostat->limits[2])
516 BUILD_SHOW_FUNC_STR(sensor1_location, sensor_location[1])
517 BUILD_SHOW_FUNC_STR(sensor2_location, sensor_location[2])
519 BUILD_SHOW_FUNC_INT(specified_fan_speed, fan_speed)
520 BUILD_SHOW_FUNC_FAN(sensor1_fan_speed, 0)
521 BUILD_SHOW_FUNC_FAN(sensor2_fan_speed, 1)
523 BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)
524 BUILD_SHOW_FUNC_INT(limit_adjust, limit_adjust)
525 BUILD_STORE_FUNC_DEG(limit_adjust, thermostat)
527 static DEVICE_ATTR(sensor1_temperature, S_IRUGO,
528 show_sensor1_temperature,NULL);
529 static DEVICE_ATTR(sensor2_temperature, S_IRUGO,
530 show_sensor2_temperature,NULL);
531 static DEVICE_ATTR(sensor1_limit, S_IRUGO,
532 show_sensor1_limit, NULL);
533 static DEVICE_ATTR(sensor2_limit, S_IRUGO,
534 show_sensor2_limit, NULL);
535 static DEVICE_ATTR(sensor1_location, S_IRUGO,
536 show_sensor1_location, NULL);
537 static DEVICE_ATTR(sensor2_location, S_IRUGO,
538 show_sensor2_location, NULL);
540 static DEVICE_ATTR(specified_fan_speed, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
541 show_specified_fan_speed,store_specified_fan_speed);
543 static DEVICE_ATTR(sensor1_fan_speed, S_IRUGO,
544 show_sensor1_fan_speed, NULL);
545 static DEVICE_ATTR(sensor2_fan_speed, S_IRUGO,
546 show_sensor2_fan_speed, NULL);
548 static DEVICE_ATTR(limit_adjust, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
549 show_limit_adjust, store_limit_adjust);
553 thermostat_init(void)
555 struct device_node* np;
557 int i = 0, offset = 0;
560 np = of_find_node_by_name(NULL, "fan");
563 if (of_device_is_compatible(np, "adt7460"))
564 therm_type = ADT7460;
565 else if (of_device_is_compatible(np, "adt7467"))
566 therm_type = ADT7467;
572 prop = of_get_property(np, "hwsensor-params-version", NULL);
573 printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
574 (*prop == 1)?"":"un");
580 prop = of_get_property(np, "reg", NULL);
586 /* look for bus either by path or using "reg" */
587 if (strstr(np->full_name, "/i2c-bus@") != NULL) {
588 const char *tmp_bus = (strstr(np->full_name, "/i2c-bus@") + 9);
589 therm_bus = tmp_bus[0]-'0';
591 therm_bus = ((*prop) >> 8) & 0x0f;
594 therm_address = ((*prop) & 0xff) >> 1;
596 printk(KERN_INFO "adt746x: Thermostat bus: %d, address: 0x%02x, "
597 "limit_adjust: %d, fan_speed: %d\n",
598 therm_bus, therm_address, limit_adjust, fan_speed);
600 if (of_get_property(np, "hwsensor-location", NULL)) {
601 for (i = 0; i < 3; i++) {
602 sensor_location[i] = of_get_property(np,
603 "hwsensor-location", NULL) + offset;
605 if (sensor_location[i] == NULL)
606 sensor_location[i] = "";
608 printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
609 offset += strlen(sensor_location[i]) + 1;
612 sensor_location[0] = "?";
613 sensor_location[1] = "?";
614 sensor_location[2] = "?";
617 of_dev = of_platform_device_create(np, "temperatures", NULL);
620 if (of_dev == NULL) {
621 printk(KERN_ERR "Can't register temperatures device !\n");
625 err = device_create_file(&of_dev->dev, &dev_attr_sensor1_temperature);
626 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_temperature);
627 err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_limit);
628 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_limit);
629 err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_location);
630 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_location);
631 err |= device_create_file(&of_dev->dev, &dev_attr_limit_adjust);
632 err |= device_create_file(&of_dev->dev, &dev_attr_specified_fan_speed);
633 err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
634 if(therm_type == ADT7460)
635 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_fan_speed);
638 "Failed to create tempertaure attribute file(s).\n");
640 #ifndef CONFIG_I2C_POWERMAC
641 request_module("i2c-powermac");
644 return i2c_add_driver(&thermostat_driver);
648 thermostat_exit(void)
651 device_remove_file(&of_dev->dev, &dev_attr_sensor1_temperature);
652 device_remove_file(&of_dev->dev, &dev_attr_sensor2_temperature);
653 device_remove_file(&of_dev->dev, &dev_attr_sensor1_limit);
654 device_remove_file(&of_dev->dev, &dev_attr_sensor2_limit);
655 device_remove_file(&of_dev->dev, &dev_attr_sensor1_location);
656 device_remove_file(&of_dev->dev, &dev_attr_sensor2_location);
657 device_remove_file(&of_dev->dev, &dev_attr_limit_adjust);
658 device_remove_file(&of_dev->dev, &dev_attr_specified_fan_speed);
659 device_remove_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
661 if(therm_type == ADT7460)
662 device_remove_file(&of_dev->dev,
663 &dev_attr_sensor2_fan_speed);
665 of_device_unregister(of_dev);
667 i2c_del_driver(&thermostat_driver);
670 module_init(thermostat_init);
671 module_exit(thermostat_exit);