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/config.h>
13 #include <linux/types.h>
14 #include <linux/module.h>
15 #include <linux/errno.h>
16 #include <linux/kernel.h>
17 #include <linux/delay.h>
18 #include <linux/sched.h>
19 #include <linux/i2c.h>
20 #include <linux/slab.h>
21 #include <linux/init.h>
22 #include <linux/spinlock.h>
23 #include <linux/smp_lock.h>
24 #include <linux/wait.h>
25 #include <linux/suspend.h>
26 #include <linux/kthread.h>
27 #include <linux/moduleparam.h>
30 #include <asm/machdep.h>
32 #include <asm/system.h>
33 #include <asm/sections.h>
34 #include <asm/of_device.h>
38 #define CONFIG_REG 0x40
39 #define MANUAL_MASK 0xe0
40 #define AUTO_MASK 0x20
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 char *sensor_location[3] = {NULL, NULL, NULL};
53 static int limit_adjust = 0;
54 static int fan_speed = -1;
56 MODULE_AUTHOR("Colin Leroy <colin@colino.net>");
57 MODULE_DESCRIPTION("Driver for ADT746x thermostat in iBook G4 and "
59 MODULE_LICENSE("GPL");
61 module_param(limit_adjust, int, 0644);
62 MODULE_PARM_DESC(limit_adjust,"Adjust maximum temperatures (50 sensor1, 70 sensor2) "
65 module_param(fan_speed, int, 0644);
66 MODULE_PARM_DESC(fan_speed,"Specify starting fan speed (0-255) "
70 struct i2c_client clt;
79 static enum {ADT7460, ADT7467} therm_type;
80 static int therm_bus, therm_address;
81 static struct of_device * of_dev;
82 static struct thermostat* thermostat;
83 static struct task_struct *thread_therm = NULL;
85 static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
88 static void write_both_fan_speed(struct thermostat *th, int speed);
89 static void write_fan_speed(struct thermostat *th, int speed, int fan);
92 write_reg(struct thermostat* th, int reg, u8 data)
99 rc = i2c_master_send(&th->clt, (const char *)tmp, 2);
108 read_reg(struct thermostat* th, int reg)
114 rc = i2c_master_send(&th->clt, ®_addr, 1);
119 rc = i2c_master_recv(&th->clt, (char *)&data, 1);
126 attach_thermostat(struct i2c_adapter *adapter)
128 unsigned long bus_no;
130 if (strncmp(adapter->name, "uni-n", 5))
132 bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
133 if (bus_no != therm_bus)
135 return attach_one_thermostat(adapter, therm_address, bus_no);
139 detach_thermostat(struct i2c_adapter *adapter)
141 struct thermostat* th;
144 if (thermostat == NULL)
149 if (thread_therm != NULL) {
150 kthread_stop(thread_therm);
153 printk(KERN_INFO "adt746x: Putting max temperatures back from "
154 "%d, %d, %d to %d, %d, %d\n",
155 th->limits[0], th->limits[1], th->limits[2],
156 th->initial_limits[0], th->initial_limits[1],
157 th->initial_limits[2]);
159 for (i = 0; i < 3; i++)
160 write_reg(th, LIMIT_REG[i], th->initial_limits[i]);
162 write_both_fan_speed(th, -1);
164 i2c_detach_client(&th->clt);
173 static struct i2c_driver thermostat_driver = {
174 .owner = THIS_MODULE,
175 .name = "therm_adt746x",
176 .attach_adapter = attach_thermostat,
177 .detach_adapter = detach_thermostat,
180 static int read_fan_speed(struct thermostat *th, u8 addr)
185 /* should start with low byte */
186 tmp[1] = read_reg(th, addr);
187 tmp[0] = read_reg(th, addr + 1);
189 res = tmp[1] + (tmp[0] << 8);
190 /* "a value of 0xffff means that the fan has stopped" */
191 return (res == 0xffff ? 0 : (90000*60)/res);
194 static void write_both_fan_speed(struct thermostat *th, int speed)
196 write_fan_speed(th, speed, 0);
197 if (therm_type == ADT7460)
198 write_fan_speed(th, speed, 1);
201 static void write_fan_speed(struct thermostat *th, int speed, int fan)
210 if (therm_type == ADT7467 && fan == 1)
213 if (th->last_speed[fan] != speed) {
215 printk(KERN_DEBUG "adt746x: Setting speed to automatic "
216 "for %s fan.\n", sensor_location[fan+1]);
218 printk(KERN_DEBUG "adt746x: Setting speed to %d "
219 "for %s fan.\n", speed, sensor_location[fan+1]);
224 manual = read_reg(th, MANUAL_MODE[fan]);
225 write_reg(th, MANUAL_MODE[fan], manual|MANUAL_MASK);
226 write_reg(th, FAN_SPD_SET[fan], speed);
228 /* back to automatic */
229 if(therm_type == ADT7460) {
230 manual = read_reg(th,
231 MANUAL_MODE[fan]) & (~MANUAL_MASK);
234 MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
236 manual = read_reg(th, MANUAL_MODE[fan]);
237 write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
241 th->last_speed[fan] = speed;
244 static void read_sensors(struct thermostat *th)
248 for (i = 0; i < 3; i++)
249 th->temps[i] = read_reg(th, TEMP_REG[i]);
253 static void display_stats(struct thermostat *th)
255 if (th->temps[0] != th->cached_temp[0]
256 || th->temps[1] != th->cached_temp[1]
257 || th->temps[2] != th->cached_temp[2]) {
258 printk(KERN_INFO "adt746x: Temperature infos:"
259 " thermostats: %d,%d,%d;"
261 " fan speed: %d RPM\n",
262 th->temps[0], th->temps[1], th->temps[2],
263 th->limits[0], th->limits[1], th->limits[2],
264 read_fan_speed(th, FAN_SPEED[0]));
266 th->cached_temp[0] = th->temps[0];
267 th->cached_temp[1] = th->temps[1];
268 th->cached_temp[2] = th->temps[2];
272 static void update_fans_speed (struct thermostat *th)
274 int lastvar = 0; /* last variation, for iBook */
277 /* we don't care about local sensor, so we start at sensor 1 */
278 for (i = 1; i < 3; i++) {
280 int fan_number = (therm_type == ADT7460 && i == 2);
281 int var = th->temps[i] - th->limits[i];
284 int step = (255 - fan_speed) / 7;
287 /* hysteresis : change fan speed only if variation is
288 * more than two degrees */
289 if (abs(var - th->last_var[fan_number]) < 2)
293 new_speed = fan_speed + ((var-1)*step);
295 if (new_speed < fan_speed)
296 new_speed = fan_speed;
300 printk(KERN_DEBUG "adt746x: setting fans speed to %d "
301 "(limit exceeded by %d on %s) \n",
303 sensor_location[fan_number+1]);
304 write_both_fan_speed(th, new_speed);
305 th->last_var[fan_number] = var;
306 } else if (var < -2) {
307 /* don't stop fan if sensor2 is cold and sensor1 is not
308 * so cold (lastvar >= -1) */
309 if (i == 2 && lastvar < -1) {
310 if (th->last_speed[fan_number] != 0)
311 printk(KERN_DEBUG "adt746x: Stopping "
313 write_both_fan_speed(th, 0);
320 return; /* we don't want to re-stop the fan
321 * if sensor1 is heating and sensor2 is not */
325 static int monitor_task(void *arg)
327 struct thermostat* th = arg;
329 while(!kthread_should_stop()) {
331 msleep_interruptible(2000);
341 update_fans_speed(th);
352 static void set_limit(struct thermostat *th, int i)
354 /* Set sensor1 limit higher to avoid powerdowns */
355 th->limits[i] = default_limits_chip[i] + limit_adjust;
356 write_reg(th, LIMIT_REG[i], th->limits[i]);
358 /* set our limits to normal */
359 th->limits[i] = default_limits_local[i] + limit_adjust;
362 static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
365 struct thermostat* th;
372 th = (struct thermostat *)
373 kmalloc(sizeof(struct thermostat), GFP_KERNEL);
378 memset(th, 0, sizeof(*th));
380 th->clt.adapter = adapter;
381 th->clt.driver = &thermostat_driver;
382 strcpy(th->clt.name, "thermostat");
384 rc = read_reg(th, 0);
386 printk(KERN_ERR "adt746x: Thermostat failed to read config "
393 /* force manual control to start the fan quieter */
397 if(therm_type == ADT7460) {
398 printk(KERN_INFO "adt746x: ADT7460 initializing\n");
399 /* The 7460 needs to be started explicitly */
400 write_reg(th, CONFIG_REG, 1);
402 printk(KERN_INFO "adt746x: ADT7467 initializing\n");
404 for (i = 0; i < 3; i++) {
405 th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
409 printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
411 th->initial_limits[0], th->initial_limits[1],
412 th->initial_limits[2], th->limits[0], th->limits[1],
417 if (i2c_attach_client(&th->clt)) {
418 printk(KERN_INFO "adt746x: Thermostat failed to attach "
425 /* be sure to really write fan speed the first time */
426 th->last_speed[0] = -2;
427 th->last_speed[1] = -2;
428 th->last_var[0] = -80;
429 th->last_var[1] = -80;
431 if (fan_speed != -1) {
432 /* manual mode, stop fans */
433 write_both_fan_speed(th, 0);
436 write_both_fan_speed(th, -1);
439 thread_therm = kthread_run(monitor_task, th, "kfand");
441 if (thread_therm == ERR_PTR(-ENOMEM)) {
442 printk(KERN_INFO "adt746x: Kthread creation failed\n");
451 * Now, unfortunately, sysfs doesn't give us a nice void * we could
452 * pass around to the attribute functions, so we don't really have
453 * choice but implement a bunch of them...
455 * FIXME, it does now...
457 #define BUILD_SHOW_FUNC_INT(name, data) \
458 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
460 return sprintf(buf, "%d\n", data); \
463 #define BUILD_SHOW_FUNC_STR(name, data) \
464 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
466 return sprintf(buf, "%s\n", data); \
469 #define BUILD_SHOW_FUNC_FAN(name, data) \
470 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
472 return sprintf(buf, "%d (%d rpm)\n", \
473 thermostat->last_speed[data], \
474 read_fan_speed(thermostat, FAN_SPEED[data]) \
478 #define BUILD_STORE_FUNC_DEG(name, data) \
479 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
483 val = simple_strtol(buf, NULL, 10); \
484 printk(KERN_INFO "Adjusting limits by %d degrees\n", val); \
485 limit_adjust = val; \
486 for (i=0; i < 3; i++) \
487 set_limit(thermostat, i); \
491 #define BUILD_STORE_FUNC_INT(name, data) \
492 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
495 val = simple_strtoul(buf, NULL, 10); \
496 if (val < 0 || val > 255) \
498 printk(KERN_INFO "Setting specified fan speed to %d\n", val); \
503 BUILD_SHOW_FUNC_INT(sensor1_temperature, (read_reg(thermostat, TEMP_REG[1])))
504 BUILD_SHOW_FUNC_INT(sensor2_temperature, (read_reg(thermostat, TEMP_REG[2])))
505 BUILD_SHOW_FUNC_INT(sensor1_limit, thermostat->limits[1])
506 BUILD_SHOW_FUNC_INT(sensor2_limit, thermostat->limits[2])
507 BUILD_SHOW_FUNC_STR(sensor1_location, sensor_location[1])
508 BUILD_SHOW_FUNC_STR(sensor2_location, sensor_location[2])
510 BUILD_SHOW_FUNC_INT(specified_fan_speed, fan_speed)
511 BUILD_SHOW_FUNC_FAN(sensor1_fan_speed, 0)
512 BUILD_SHOW_FUNC_FAN(sensor2_fan_speed, 1)
514 BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)
515 BUILD_SHOW_FUNC_INT(limit_adjust, limit_adjust)
516 BUILD_STORE_FUNC_DEG(limit_adjust, thermostat)
518 static DEVICE_ATTR(sensor1_temperature, S_IRUGO,
519 show_sensor1_temperature,NULL);
520 static DEVICE_ATTR(sensor2_temperature, S_IRUGO,
521 show_sensor2_temperature,NULL);
522 static DEVICE_ATTR(sensor1_limit, S_IRUGO,
523 show_sensor1_limit, NULL);
524 static DEVICE_ATTR(sensor2_limit, S_IRUGO,
525 show_sensor2_limit, NULL);
526 static DEVICE_ATTR(sensor1_location, S_IRUGO,
527 show_sensor1_location, NULL);
528 static DEVICE_ATTR(sensor2_location, S_IRUGO,
529 show_sensor2_location, NULL);
531 static DEVICE_ATTR(specified_fan_speed, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
532 show_specified_fan_speed,store_specified_fan_speed);
534 static DEVICE_ATTR(sensor1_fan_speed, S_IRUGO,
535 show_sensor1_fan_speed, NULL);
536 static DEVICE_ATTR(sensor2_fan_speed, S_IRUGO,
537 show_sensor2_fan_speed, NULL);
539 static DEVICE_ATTR(limit_adjust, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
540 show_limit_adjust, store_limit_adjust);
544 thermostat_init(void)
546 struct device_node* np;
548 int i = 0, offset = 0;
550 np = of_find_node_by_name(NULL, "fan");
553 if (device_is_compatible(np, "adt7460"))
554 therm_type = ADT7460;
555 else if (device_is_compatible(np, "adt7467"))
556 therm_type = ADT7467;
560 prop = (u32 *)get_property(np, "hwsensor-params-version", NULL);
561 printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
562 (*prop == 1)?"":"un");
566 prop = (u32 *)get_property(np, "reg", NULL);
570 /* look for bus either by path or using "reg" */
571 if (strstr(np->full_name, "/i2c-bus@") != NULL) {
572 const char *tmp_bus = (strstr(np->full_name, "/i2c-bus@") + 9);
573 therm_bus = tmp_bus[0]-'0';
575 therm_bus = ((*prop) >> 8) & 0x0f;
578 therm_address = ((*prop) & 0xff) >> 1;
580 printk(KERN_INFO "adt746x: Thermostat bus: %d, address: 0x%02x, "
581 "limit_adjust: %d, fan_speed: %d\n",
582 therm_bus, therm_address, limit_adjust, fan_speed);
584 if (get_property(np, "hwsensor-location", NULL)) {
585 for (i = 0; i < 3; i++) {
586 sensor_location[i] = get_property(np,
587 "hwsensor-location", NULL) + offset;
589 if (sensor_location[i] == NULL)
590 sensor_location[i] = "";
592 printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
593 offset += strlen(sensor_location[i]) + 1;
596 sensor_location[0] = "?";
597 sensor_location[1] = "?";
598 sensor_location[2] = "?";
601 of_dev = of_platform_device_create(np, "temperatures", NULL);
603 if (of_dev == NULL) {
604 printk(KERN_ERR "Can't register temperatures device !\n");
608 device_create_file(&of_dev->dev, &dev_attr_sensor1_temperature);
609 device_create_file(&of_dev->dev, &dev_attr_sensor2_temperature);
610 device_create_file(&of_dev->dev, &dev_attr_sensor1_limit);
611 device_create_file(&of_dev->dev, &dev_attr_sensor2_limit);
612 device_create_file(&of_dev->dev, &dev_attr_sensor1_location);
613 device_create_file(&of_dev->dev, &dev_attr_sensor2_location);
614 device_create_file(&of_dev->dev, &dev_attr_limit_adjust);
615 device_create_file(&of_dev->dev, &dev_attr_specified_fan_speed);
616 device_create_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
617 if(therm_type == ADT7460)
618 device_create_file(&of_dev->dev, &dev_attr_sensor2_fan_speed);
620 #ifndef CONFIG_I2C_KEYWEST
621 request_module("i2c-keywest");
624 return i2c_add_driver(&thermostat_driver);
628 thermostat_exit(void)
631 device_remove_file(&of_dev->dev, &dev_attr_sensor1_temperature);
632 device_remove_file(&of_dev->dev, &dev_attr_sensor2_temperature);
633 device_remove_file(&of_dev->dev, &dev_attr_sensor1_limit);
634 device_remove_file(&of_dev->dev, &dev_attr_sensor2_limit);
635 device_remove_file(&of_dev->dev, &dev_attr_sensor1_location);
636 device_remove_file(&of_dev->dev, &dev_attr_sensor2_location);
637 device_remove_file(&of_dev->dev, &dev_attr_limit_adjust);
638 device_remove_file(&of_dev->dev, &dev_attr_specified_fan_speed);
639 device_remove_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
641 if(therm_type == ADT7460)
642 device_remove_file(&of_dev->dev,
643 &dev_attr_sensor2_fan_speed);
645 of_device_unregister(of_dev);
647 i2c_del_driver(&thermostat_driver);
650 module_init(thermostat_init);
651 module_exit(thermostat_exit);