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;
85 static enum {ADT7460, ADT7467} therm_type;
86 static int therm_bus, therm_address;
87 static struct of_device * of_dev;
88 static struct thermostat* thermostat;
89 static struct task_struct *thread_therm = NULL;
91 static void write_both_fan_speed(struct thermostat *th, int speed);
92 static void write_fan_speed(struct thermostat *th, int speed, int fan);
93 static void thermostat_create_files(void);
94 static void thermostat_remove_files(void);
97 write_reg(struct thermostat* th, int reg, u8 data)
104 rc = i2c_master_send(th->clt, (const char *)tmp, 2);
113 read_reg(struct thermostat* th, int reg)
119 rc = i2c_master_send(th->clt, ®_addr, 1);
124 rc = i2c_master_recv(th->clt, (char *)&data, 1);
130 static struct i2c_driver thermostat_driver;
133 attach_thermostat(struct i2c_adapter *adapter)
135 unsigned long bus_no;
136 struct i2c_board_info info;
137 struct i2c_client *client;
139 if (strncmp(adapter->name, "uni-n", 5))
141 bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
142 if (bus_no != therm_bus)
145 memset(&info, 0, sizeof(struct i2c_board_info));
146 strlcpy(info.type, "therm_adt746x", I2C_NAME_SIZE);
147 info.addr = therm_address;
148 client = i2c_new_device(adapter, &info);
153 * Let i2c-core delete that device on driver removal.
154 * This is safe because i2c-core holds the core_lock mutex for us.
156 list_add_tail(&client->detected, &thermostat_driver.clients);
161 remove_thermostat(struct i2c_client *client)
163 struct thermostat *th = i2c_get_clientdata(client);
166 thermostat_remove_files();
168 if (thread_therm != NULL) {
169 kthread_stop(thread_therm);
172 printk(KERN_INFO "adt746x: Putting max temperatures back from "
173 "%d, %d, %d to %d, %d, %d\n",
174 th->limits[0], th->limits[1], th->limits[2],
175 th->initial_limits[0], th->initial_limits[1],
176 th->initial_limits[2]);
178 for (i = 0; i < 3; i++)
179 write_reg(th, LIMIT_REG[i], th->initial_limits[i]);
181 write_both_fan_speed(th, -1);
185 i2c_set_clientdata(client, NULL);
191 static int read_fan_speed(struct thermostat *th, u8 addr)
196 /* should start with low byte */
197 tmp[1] = read_reg(th, addr);
198 tmp[0] = read_reg(th, addr + 1);
200 res = tmp[1] + (tmp[0] << 8);
201 /* "a value of 0xffff means that the fan has stopped" */
202 return (res == 0xffff ? 0 : (90000*60)/res);
205 static void write_both_fan_speed(struct thermostat *th, int speed)
207 write_fan_speed(th, speed, 0);
208 if (therm_type == ADT7460)
209 write_fan_speed(th, speed, 1);
212 static void write_fan_speed(struct thermostat *th, int speed, int fan)
221 if (therm_type == ADT7467 && fan == 1)
224 if (th->last_speed[fan] != speed) {
227 printk(KERN_DEBUG "adt746x: Setting speed to automatic "
228 "for %s fan.\n", sensor_location[fan+1]);
230 printk(KERN_DEBUG "adt746x: Setting speed to %d "
231 "for %s fan.\n", speed, sensor_location[fan+1]);
237 manual = read_reg(th, MANUAL_MODE[fan]);
238 manual &= ~INVERT_MASK;
239 write_reg(th, MANUAL_MODE[fan],
240 manual | MANUAL_MASK | th->pwm_inv[fan]);
241 write_reg(th, FAN_SPD_SET[fan], speed);
243 /* back to automatic */
244 if(therm_type == ADT7460) {
245 manual = read_reg(th,
246 MANUAL_MODE[fan]) & (~MANUAL_MASK);
247 manual &= ~INVERT_MASK;
248 manual |= th->pwm_inv[fan];
250 MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
252 manual = read_reg(th, MANUAL_MODE[fan]);
253 manual &= ~INVERT_MASK;
254 manual |= th->pwm_inv[fan];
255 write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
259 th->last_speed[fan] = speed;
262 static void read_sensors(struct thermostat *th)
266 for (i = 0; i < 3; i++)
267 th->temps[i] = read_reg(th, TEMP_REG[i]);
271 static void display_stats(struct thermostat *th)
273 if (th->temps[0] != th->cached_temp[0]
274 || th->temps[1] != th->cached_temp[1]
275 || th->temps[2] != th->cached_temp[2]) {
276 printk(KERN_INFO "adt746x: Temperature infos:"
277 " thermostats: %d,%d,%d;"
279 " fan speed: %d RPM\n",
280 th->temps[0], th->temps[1], th->temps[2],
281 th->limits[0], th->limits[1], th->limits[2],
282 read_fan_speed(th, FAN_SPEED[0]));
284 th->cached_temp[0] = th->temps[0];
285 th->cached_temp[1] = th->temps[1];
286 th->cached_temp[2] = th->temps[2];
290 static void update_fans_speed (struct thermostat *th)
292 int lastvar = 0; /* last variation, for iBook */
295 /* we don't care about local sensor, so we start at sensor 1 */
296 for (i = 1; i < 3; i++) {
298 int fan_number = (therm_type == ADT7460 && i == 2);
299 int var = th->temps[i] - th->limits[i];
302 int step = (255 - fan_speed) / 7;
305 /* hysteresis : change fan speed only if variation is
306 * more than two degrees */
307 if (abs(var - th->last_var[fan_number]) < 2)
311 new_speed = fan_speed + ((var-1)*step);
313 if (new_speed < fan_speed)
314 new_speed = fan_speed;
319 printk(KERN_DEBUG "adt746x: Setting fans speed to %d "
320 "(limit exceeded by %d on %s)\n",
322 sensor_location[fan_number+1]);
323 write_both_fan_speed(th, new_speed);
324 th->last_var[fan_number] = var;
325 } else if (var < -2) {
326 /* don't stop fan if sensor2 is cold and sensor1 is not
327 * so cold (lastvar >= -1) */
328 if (i == 2 && lastvar < -1) {
329 if (th->last_speed[fan_number] != 0)
331 printk(KERN_DEBUG "adt746x: Stopping "
333 write_both_fan_speed(th, 0);
340 return; /* we don't want to re-stop the fan
341 * if sensor1 is heating and sensor2 is not */
345 static int monitor_task(void *arg)
347 struct thermostat* th = arg;
350 while(!kthread_should_stop()) {
352 msleep_interruptible(2000);
362 update_fans_speed(th);
373 static void set_limit(struct thermostat *th, int i)
375 /* Set sensor1 limit higher to avoid powerdowns */
376 th->limits[i] = default_limits_chip[i] + limit_adjust;
377 write_reg(th, LIMIT_REG[i], th->limits[i]);
379 /* set our limits to normal */
380 th->limits[i] = default_limits_local[i] + limit_adjust;
383 static int probe_thermostat(struct i2c_client *client,
384 const struct i2c_device_id *id)
386 struct thermostat* th;
393 th = kzalloc(sizeof(struct thermostat), GFP_KERNEL);
397 i2c_set_clientdata(client, th);
400 rc = read_reg(th, CONFIG_REG);
402 dev_err(&client->dev, "Thermostat failed to read config!\n");
403 i2c_set_clientdata(client, NULL);
408 /* force manual control to start the fan quieter */
412 if(therm_type == ADT7460) {
413 printk(KERN_INFO "adt746x: ADT7460 initializing\n");
414 /* The 7460 needs to be started explicitly */
415 write_reg(th, CONFIG_REG, 1);
417 printk(KERN_INFO "adt746x: ADT7467 initializing\n");
419 for (i = 0; i < 3; i++) {
420 th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
424 printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
426 th->initial_limits[0], th->initial_limits[1],
427 th->initial_limits[2], th->limits[0], th->limits[1],
432 /* record invert bit status because fw can corrupt it after suspend */
433 th->pwm_inv[0] = read_reg(th, MANUAL_MODE[0]) & INVERT_MASK;
434 th->pwm_inv[1] = read_reg(th, MANUAL_MODE[1]) & INVERT_MASK;
436 /* be sure to really write fan speed the first time */
437 th->last_speed[0] = -2;
438 th->last_speed[1] = -2;
439 th->last_var[0] = -80;
440 th->last_var[1] = -80;
442 if (fan_speed != -1) {
443 /* manual mode, stop fans */
444 write_both_fan_speed(th, 0);
447 write_both_fan_speed(th, -1);
450 thread_therm = kthread_run(monitor_task, th, "kfand");
452 if (thread_therm == ERR_PTR(-ENOMEM)) {
453 printk(KERN_INFO "adt746x: Kthread creation failed\n");
458 thermostat_create_files();
463 static const struct i2c_device_id therm_adt746x_id[] = {
464 { "therm_adt746x", 0 },
468 static struct i2c_driver thermostat_driver = {
470 .name = "therm_adt746x",
472 .attach_adapter = attach_thermostat,
473 .probe = probe_thermostat,
474 .remove = remove_thermostat,
475 .id_table = therm_adt746x_id,
479 * Now, unfortunately, sysfs doesn't give us a nice void * we could
480 * pass around to the attribute functions, so we don't really have
481 * choice but implement a bunch of them...
483 * FIXME, it does now...
485 #define BUILD_SHOW_FUNC_INT(name, data) \
486 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
488 return sprintf(buf, "%d\n", data); \
491 #define BUILD_SHOW_FUNC_STR(name, data) \
492 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
494 return sprintf(buf, "%s\n", data); \
497 #define BUILD_SHOW_FUNC_FAN(name, data) \
498 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
500 return sprintf(buf, "%d (%d rpm)\n", \
501 thermostat->last_speed[data], \
502 read_fan_speed(thermostat, FAN_SPEED[data]) \
506 #define BUILD_STORE_FUNC_DEG(name, data) \
507 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
511 val = simple_strtol(buf, NULL, 10); \
512 printk(KERN_INFO "Adjusting limits by %d degrees\n", val); \
513 limit_adjust = val; \
514 for (i=0; i < 3; i++) \
515 set_limit(thermostat, i); \
519 #define BUILD_STORE_FUNC_INT(name, data) \
520 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
523 val = simple_strtol(buf, NULL, 10); \
524 if (val < 0 || val > 255) \
526 printk(KERN_INFO "Setting specified fan speed to %d\n", val); \
531 BUILD_SHOW_FUNC_INT(sensor1_temperature, (read_reg(thermostat, TEMP_REG[1])))
532 BUILD_SHOW_FUNC_INT(sensor2_temperature, (read_reg(thermostat, TEMP_REG[2])))
533 BUILD_SHOW_FUNC_INT(sensor1_limit, thermostat->limits[1])
534 BUILD_SHOW_FUNC_INT(sensor2_limit, thermostat->limits[2])
535 BUILD_SHOW_FUNC_STR(sensor1_location, sensor_location[1])
536 BUILD_SHOW_FUNC_STR(sensor2_location, sensor_location[2])
538 BUILD_SHOW_FUNC_INT(specified_fan_speed, fan_speed)
539 BUILD_SHOW_FUNC_FAN(sensor1_fan_speed, 0)
540 BUILD_SHOW_FUNC_FAN(sensor2_fan_speed, 1)
542 BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)
543 BUILD_SHOW_FUNC_INT(limit_adjust, limit_adjust)
544 BUILD_STORE_FUNC_DEG(limit_adjust, thermostat)
546 static DEVICE_ATTR(sensor1_temperature, S_IRUGO,
547 show_sensor1_temperature,NULL);
548 static DEVICE_ATTR(sensor2_temperature, S_IRUGO,
549 show_sensor2_temperature,NULL);
550 static DEVICE_ATTR(sensor1_limit, S_IRUGO,
551 show_sensor1_limit, NULL);
552 static DEVICE_ATTR(sensor2_limit, S_IRUGO,
553 show_sensor2_limit, NULL);
554 static DEVICE_ATTR(sensor1_location, S_IRUGO,
555 show_sensor1_location, NULL);
556 static DEVICE_ATTR(sensor2_location, S_IRUGO,
557 show_sensor2_location, NULL);
559 static DEVICE_ATTR(specified_fan_speed, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
560 show_specified_fan_speed,store_specified_fan_speed);
562 static DEVICE_ATTR(sensor1_fan_speed, S_IRUGO,
563 show_sensor1_fan_speed, NULL);
564 static DEVICE_ATTR(sensor2_fan_speed, S_IRUGO,
565 show_sensor2_fan_speed, NULL);
567 static DEVICE_ATTR(limit_adjust, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
568 show_limit_adjust, store_limit_adjust);
572 thermostat_init(void)
574 struct device_node* np;
576 int i = 0, offset = 0;
578 np = of_find_node_by_name(NULL, "fan");
581 if (of_device_is_compatible(np, "adt7460"))
582 therm_type = ADT7460;
583 else if (of_device_is_compatible(np, "adt7467"))
584 therm_type = ADT7467;
590 prop = of_get_property(np, "hwsensor-params-version", NULL);
591 printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
592 (*prop == 1)?"":"un");
598 prop = of_get_property(np, "reg", NULL);
604 /* look for bus either by path or using "reg" */
605 if (strstr(np->full_name, "/i2c-bus@") != NULL) {
606 const char *tmp_bus = (strstr(np->full_name, "/i2c-bus@") + 9);
607 therm_bus = tmp_bus[0]-'0';
609 therm_bus = ((*prop) >> 8) & 0x0f;
612 therm_address = ((*prop) & 0xff) >> 1;
614 printk(KERN_INFO "adt746x: Thermostat bus: %d, address: 0x%02x, "
615 "limit_adjust: %d, fan_speed: %d\n",
616 therm_bus, therm_address, limit_adjust, fan_speed);
618 if (of_get_property(np, "hwsensor-location", NULL)) {
619 for (i = 0; i < 3; i++) {
620 sensor_location[i] = of_get_property(np,
621 "hwsensor-location", NULL) + offset;
623 if (sensor_location[i] == NULL)
624 sensor_location[i] = "";
626 printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
627 offset += strlen(sensor_location[i]) + 1;
630 sensor_location[0] = "?";
631 sensor_location[1] = "?";
632 sensor_location[2] = "?";
635 of_dev = of_platform_device_create(np, "temperatures", NULL);
638 if (of_dev == NULL) {
639 printk(KERN_ERR "Can't register temperatures device !\n");
643 #ifndef CONFIG_I2C_POWERMAC
644 request_module("i2c-powermac");
647 return i2c_add_driver(&thermostat_driver);
650 static void thermostat_create_files(void)
654 err = device_create_file(&of_dev->dev, &dev_attr_sensor1_temperature);
655 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_temperature);
656 err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_limit);
657 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_limit);
658 err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_location);
659 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_location);
660 err |= device_create_file(&of_dev->dev, &dev_attr_limit_adjust);
661 err |= device_create_file(&of_dev->dev, &dev_attr_specified_fan_speed);
662 err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
663 if(therm_type == ADT7460)
664 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_fan_speed);
667 "Failed to create tempertaure attribute file(s).\n");
670 static void thermostat_remove_files(void)
673 device_remove_file(&of_dev->dev, &dev_attr_sensor1_temperature);
674 device_remove_file(&of_dev->dev, &dev_attr_sensor2_temperature);
675 device_remove_file(&of_dev->dev, &dev_attr_sensor1_limit);
676 device_remove_file(&of_dev->dev, &dev_attr_sensor2_limit);
677 device_remove_file(&of_dev->dev, &dev_attr_sensor1_location);
678 device_remove_file(&of_dev->dev, &dev_attr_sensor2_location);
679 device_remove_file(&of_dev->dev, &dev_attr_limit_adjust);
680 device_remove_file(&of_dev->dev, &dev_attr_specified_fan_speed);
681 device_remove_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
683 if(therm_type == ADT7460)
684 device_remove_file(&of_dev->dev,
685 &dev_attr_sensor2_fan_speed);
691 thermostat_exit(void)
693 i2c_del_driver(&thermostat_driver);
694 of_device_unregister(of_dev);
697 module_init(thermostat_init);
698 module_exit(thermostat_exit);