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 .flags
= I2C_DF_NOTIFY
,
177 .attach_adapter
= attach_thermostat
,
178 .detach_adapter
= detach_thermostat
,
181 static int read_fan_speed(struct thermostat
*th
, u8 addr
)
186 /* should start with low byte */
187 tmp
[1] = read_reg(th
, addr
);
188 tmp
[0] = read_reg(th
, addr
+ 1);
190 res
= tmp
[1] + (tmp
[0] << 8);
191 /* "a value of 0xffff means that the fan has stopped" */
192 return (res
== 0xffff ? 0 : (90000*60)/res
);
195 static void write_both_fan_speed(struct thermostat
*th
, int speed
)
197 write_fan_speed(th
, speed
, 0);
198 if (therm_type
== ADT7460
)
199 write_fan_speed(th
, speed
, 1);
202 static void write_fan_speed(struct thermostat
*th
, int speed
, int fan
)
211 if (therm_type
== ADT7467
&& fan
== 1)
214 if (th
->last_speed
[fan
] != speed
) {
216 printk(KERN_DEBUG
"adt746x: Setting speed to automatic "
217 "for %s fan.\n", sensor_location
[fan
+1]);
219 printk(KERN_DEBUG
"adt746x: Setting speed to %d "
220 "for %s fan.\n", speed
, sensor_location
[fan
+1]);
225 manual
= read_reg(th
, MANUAL_MODE
[fan
]);
226 write_reg(th
, MANUAL_MODE
[fan
], manual
|MANUAL_MASK
);
227 write_reg(th
, FAN_SPD_SET
[fan
], speed
);
229 /* back to automatic */
230 if(therm_type
== ADT7460
) {
231 manual
= read_reg(th
,
232 MANUAL_MODE
[fan
]) & (~MANUAL_MASK
);
235 MANUAL_MODE
[fan
], manual
|REM_CONTROL
[fan
]);
237 manual
= read_reg(th
, MANUAL_MODE
[fan
]);
238 write_reg(th
, MANUAL_MODE
[fan
], manual
&(~AUTO_MASK
));
242 th
->last_speed
[fan
] = speed
;
245 static void read_sensors(struct thermostat
*th
)
249 for (i
= 0; i
< 3; i
++)
250 th
->temps
[i
] = read_reg(th
, TEMP_REG
[i
]);
254 static void display_stats(struct thermostat
*th
)
256 if (th
->temps
[0] != th
->cached_temp
[0]
257 || th
->temps
[1] != th
->cached_temp
[1]
258 || th
->temps
[2] != th
->cached_temp
[2]) {
259 printk(KERN_INFO
"adt746x: Temperature infos:"
260 " thermostats: %d,%d,%d;"
262 " fan speed: %d RPM\n",
263 th
->temps
[0], th
->temps
[1], th
->temps
[2],
264 th
->limits
[0], th
->limits
[1], th
->limits
[2],
265 read_fan_speed(th
, FAN_SPEED
[0]));
267 th
->cached_temp
[0] = th
->temps
[0];
268 th
->cached_temp
[1] = th
->temps
[1];
269 th
->cached_temp
[2] = th
->temps
[2];
273 static void update_fans_speed (struct thermostat
*th
)
275 int lastvar
= 0; /* last variation, for iBook */
278 /* we don't care about local sensor, so we start at sensor 1 */
279 for (i
= 1; i
< 3; i
++) {
281 int fan_number
= (therm_type
== ADT7460
&& i
== 2);
282 int var
= th
->temps
[i
] - th
->limits
[i
];
285 int step
= (255 - fan_speed
) / 7;
288 /* hysteresis : change fan speed only if variation is
289 * more than two degrees */
290 if (abs(var
- th
->last_var
[fan_number
]) < 2)
294 new_speed
= fan_speed
+ ((var
-1)*step
);
296 if (new_speed
< fan_speed
)
297 new_speed
= fan_speed
;
301 printk(KERN_DEBUG
"adt746x: setting fans speed to %d "
302 "(limit exceeded by %d on %s) \n",
304 sensor_location
[fan_number
+1]);
305 write_both_fan_speed(th
, new_speed
);
306 th
->last_var
[fan_number
] = var
;
307 } else if (var
< -2) {
308 /* don't stop fan if sensor2 is cold and sensor1 is not
309 * so cold (lastvar >= -1) */
310 if (i
== 2 && lastvar
< -1) {
311 if (th
->last_speed
[fan_number
] != 0)
312 printk(KERN_DEBUG
"adt746x: Stopping "
314 write_both_fan_speed(th
, 0);
321 return; /* we don't want to re-stop the fan
322 * if sensor1 is heating and sensor2 is not */
326 static int monitor_task(void *arg
)
328 struct thermostat
* th
= arg
;
330 while(!kthread_should_stop()) {
332 msleep_interruptible(2000);
342 update_fans_speed(th
);
353 static void set_limit(struct thermostat
*th
, int i
)
355 /* Set sensor1 limit higher to avoid powerdowns */
356 th
->limits
[i
] = default_limits_chip
[i
] + limit_adjust
;
357 write_reg(th
, LIMIT_REG
[i
], th
->limits
[i
]);
359 /* set our limits to normal */
360 th
->limits
[i
] = default_limits_local
[i
] + limit_adjust
;
363 static int attach_one_thermostat(struct i2c_adapter
*adapter
, int addr
,
366 struct thermostat
* th
;
373 th
= (struct thermostat
*)
374 kmalloc(sizeof(struct thermostat
), GFP_KERNEL
);
379 memset(th
, 0, sizeof(*th
));
381 th
->clt
.adapter
= adapter
;
382 th
->clt
.driver
= &thermostat_driver
;
383 strcpy(th
->clt
.name
, "thermostat");
385 rc
= read_reg(th
, 0);
387 printk(KERN_ERR
"adt746x: Thermostat failed to read config "
394 /* force manual control to start the fan quieter */
398 if(therm_type
== ADT7460
) {
399 printk(KERN_INFO
"adt746x: ADT7460 initializing\n");
400 /* The 7460 needs to be started explicitly */
401 write_reg(th
, CONFIG_REG
, 1);
403 printk(KERN_INFO
"adt746x: ADT7467 initializing\n");
405 for (i
= 0; i
< 3; i
++) {
406 th
->initial_limits
[i
] = read_reg(th
, LIMIT_REG
[i
]);
410 printk(KERN_INFO
"adt746x: Lowering max temperatures from %d, %d, %d"
412 th
->initial_limits
[0], th
->initial_limits
[1],
413 th
->initial_limits
[2], th
->limits
[0], th
->limits
[1],
418 if (i2c_attach_client(&th
->clt
)) {
419 printk(KERN_INFO
"adt746x: Thermostat failed to attach "
426 /* be sure to really write fan speed the first time */
427 th
->last_speed
[0] = -2;
428 th
->last_speed
[1] = -2;
429 th
->last_var
[0] = -80;
430 th
->last_var
[1] = -80;
432 if (fan_speed
!= -1) {
433 /* manual mode, stop fans */
434 write_both_fan_speed(th
, 0);
437 write_both_fan_speed(th
, -1);
440 thread_therm
= kthread_run(monitor_task
, th
, "kfand");
442 if (thread_therm
== ERR_PTR(-ENOMEM
)) {
443 printk(KERN_INFO
"adt746x: Kthread creation failed\n");
452 * Now, unfortunately, sysfs doesn't give us a nice void * we could
453 * pass around to the attribute functions, so we don't really have
454 * choice but implement a bunch of them...
456 * FIXME, it does now...
458 #define BUILD_SHOW_FUNC_INT(name, data) \
459 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
461 return sprintf(buf, "%d\n", data); \
464 #define BUILD_SHOW_FUNC_STR(name, data) \
465 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
467 return sprintf(buf, "%s\n", data); \
470 #define BUILD_SHOW_FUNC_FAN(name, data) \
471 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
473 return sprintf(buf, "%d (%d rpm)\n", \
474 thermostat->last_speed[data], \
475 read_fan_speed(thermostat, FAN_SPEED[data]) \
479 #define BUILD_STORE_FUNC_DEG(name, data) \
480 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
484 val = simple_strtol(buf, NULL, 10); \
485 printk(KERN_INFO "Adjusting limits by %d degrees\n", val); \
486 limit_adjust = val; \
487 for (i=0; i < 3; i++) \
488 set_limit(thermostat, i); \
492 #define BUILD_STORE_FUNC_INT(name, data) \
493 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
496 val = simple_strtoul(buf, NULL, 10); \
497 if (val < 0 || val > 255) \
499 printk(KERN_INFO "Setting specified fan speed to %d\n", val); \
504 BUILD_SHOW_FUNC_INT(sensor1_temperature
, (read_reg(thermostat
, TEMP_REG
[1])))
505 BUILD_SHOW_FUNC_INT(sensor2_temperature
, (read_reg(thermostat
, TEMP_REG
[2])))
506 BUILD_SHOW_FUNC_INT(sensor1_limit
, thermostat
->limits
[1])
507 BUILD_SHOW_FUNC_INT(sensor2_limit
, thermostat
->limits
[2])
508 BUILD_SHOW_FUNC_STR(sensor1_location
, sensor_location
[1])
509 BUILD_SHOW_FUNC_STR(sensor2_location
, sensor_location
[2])
511 BUILD_SHOW_FUNC_INT(specified_fan_speed
, fan_speed
)
512 BUILD_SHOW_FUNC_FAN(sensor1_fan_speed
, 0)
513 BUILD_SHOW_FUNC_FAN(sensor2_fan_speed
, 1)
515 BUILD_STORE_FUNC_INT(specified_fan_speed
,fan_speed
)
516 BUILD_SHOW_FUNC_INT(limit_adjust
, limit_adjust
)
517 BUILD_STORE_FUNC_DEG(limit_adjust
, thermostat
)
519 static DEVICE_ATTR(sensor1_temperature
, S_IRUGO
,
520 show_sensor1_temperature
,NULL
);
521 static DEVICE_ATTR(sensor2_temperature
, S_IRUGO
,
522 show_sensor2_temperature
,NULL
);
523 static DEVICE_ATTR(sensor1_limit
, S_IRUGO
,
524 show_sensor1_limit
, NULL
);
525 static DEVICE_ATTR(sensor2_limit
, S_IRUGO
,
526 show_sensor2_limit
, NULL
);
527 static DEVICE_ATTR(sensor1_location
, S_IRUGO
,
528 show_sensor1_location
, NULL
);
529 static DEVICE_ATTR(sensor2_location
, S_IRUGO
,
530 show_sensor2_location
, NULL
);
532 static DEVICE_ATTR(specified_fan_speed
, S_IRUSR
|S_IWUSR
|S_IRGRP
|S_IROTH
,
533 show_specified_fan_speed
,store_specified_fan_speed
);
535 static DEVICE_ATTR(sensor1_fan_speed
, S_IRUGO
,
536 show_sensor1_fan_speed
, NULL
);
537 static DEVICE_ATTR(sensor2_fan_speed
, S_IRUGO
,
538 show_sensor2_fan_speed
, NULL
);
540 static DEVICE_ATTR(limit_adjust
, S_IRUSR
|S_IWUSR
|S_IRGRP
|S_IROTH
,
541 show_limit_adjust
, store_limit_adjust
);
545 thermostat_init(void)
547 struct device_node
* np
;
549 int i
= 0, offset
= 0;
551 np
= of_find_node_by_name(NULL
, "fan");
554 if (device_is_compatible(np
, "adt7460"))
555 therm_type
= ADT7460
;
556 else if (device_is_compatible(np
, "adt7467"))
557 therm_type
= ADT7467
;
561 prop
= (u32
*)get_property(np
, "hwsensor-params-version", NULL
);
562 printk(KERN_INFO
"adt746x: version %d (%ssupported)\n", *prop
,
563 (*prop
== 1)?"":"un");
567 prop
= (u32
*)get_property(np
, "reg", NULL
);
571 /* look for bus either by path or using "reg" */
572 if (strstr(np
->full_name
, "/i2c-bus@") != NULL
) {
573 const char *tmp_bus
= (strstr(np
->full_name
, "/i2c-bus@") + 9);
574 therm_bus
= tmp_bus
[0]-'0';
576 therm_bus
= ((*prop
) >> 8) & 0x0f;
579 therm_address
= ((*prop
) & 0xff) >> 1;
581 printk(KERN_INFO
"adt746x: Thermostat bus: %d, address: 0x%02x, "
582 "limit_adjust: %d, fan_speed: %d\n",
583 therm_bus
, therm_address
, limit_adjust
, fan_speed
);
585 if (get_property(np
, "hwsensor-location", NULL
)) {
586 for (i
= 0; i
< 3; i
++) {
587 sensor_location
[i
] = get_property(np
,
588 "hwsensor-location", NULL
) + offset
;
590 if (sensor_location
[i
] == NULL
)
591 sensor_location
[i
] = "";
593 printk(KERN_INFO
"sensor %d: %s\n", i
, sensor_location
[i
]);
594 offset
+= strlen(sensor_location
[i
]) + 1;
597 sensor_location
[0] = "?";
598 sensor_location
[1] = "?";
599 sensor_location
[2] = "?";
602 of_dev
= of_platform_device_create(np
, "temperatures", NULL
);
604 if (of_dev
== NULL
) {
605 printk(KERN_ERR
"Can't register temperatures device !\n");
609 device_create_file(&of_dev
->dev
, &dev_attr_sensor1_temperature
);
610 device_create_file(&of_dev
->dev
, &dev_attr_sensor2_temperature
);
611 device_create_file(&of_dev
->dev
, &dev_attr_sensor1_limit
);
612 device_create_file(&of_dev
->dev
, &dev_attr_sensor2_limit
);
613 device_create_file(&of_dev
->dev
, &dev_attr_sensor1_location
);
614 device_create_file(&of_dev
->dev
, &dev_attr_sensor2_location
);
615 device_create_file(&of_dev
->dev
, &dev_attr_limit_adjust
);
616 device_create_file(&of_dev
->dev
, &dev_attr_specified_fan_speed
);
617 device_create_file(&of_dev
->dev
, &dev_attr_sensor1_fan_speed
);
618 if(therm_type
== ADT7460
)
619 device_create_file(&of_dev
->dev
, &dev_attr_sensor2_fan_speed
);
621 #ifndef CONFIG_I2C_KEYWEST
622 request_module("i2c-keywest");
625 return i2c_add_driver(&thermostat_driver
);
629 thermostat_exit(void)
632 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_temperature
);
633 device_remove_file(&of_dev
->dev
, &dev_attr_sensor2_temperature
);
634 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_limit
);
635 device_remove_file(&of_dev
->dev
, &dev_attr_sensor2_limit
);
636 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_location
);
637 device_remove_file(&of_dev
->dev
, &dev_attr_sensor2_location
);
638 device_remove_file(&of_dev
->dev
, &dev_attr_limit_adjust
);
639 device_remove_file(&of_dev
->dev
, &dev_attr_specified_fan_speed
);
640 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_fan_speed
);
642 if(therm_type
== ADT7460
)
643 device_remove_file(&of_dev
->dev
,
644 &dev_attr_sensor2_fan_speed
);
646 of_device_unregister(of_dev
);
648 i2c_del_driver(&thermostat_driver
);
651 module_init(thermostat_init
);
652 module_exit(thermostat_exit
);