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
);
95 write_reg(struct thermostat
* th
, int reg
, u8 data
)
102 rc
= i2c_master_send(th
->clt
, (const char *)tmp
, 2);
111 read_reg(struct thermostat
* th
, int reg
)
117 rc
= i2c_master_send(th
->clt
, ®_addr
, 1);
122 rc
= i2c_master_recv(th
->clt
, (char *)&data
, 1);
128 static struct i2c_driver thermostat_driver
;
131 attach_thermostat(struct i2c_adapter
*adapter
)
133 unsigned long bus_no
;
134 struct i2c_board_info info
;
135 struct i2c_client
*client
;
137 if (strncmp(adapter
->name
, "uni-n", 5))
139 bus_no
= simple_strtoul(adapter
->name
+ 6, NULL
, 10);
140 if (bus_no
!= therm_bus
)
143 memset(&info
, 0, sizeof(struct i2c_board_info
));
144 strlcpy(info
.type
, "therm_adt746x", I2C_NAME_SIZE
);
145 info
.addr
= therm_address
;
146 client
= i2c_new_device(adapter
, &info
);
151 * Let i2c-core delete that device on driver removal.
152 * This is safe because i2c-core holds the core_lock mutex for us.
154 list_add_tail(&client
->detected
, &thermostat_driver
.clients
);
159 remove_thermostat(struct i2c_client
*client
)
161 struct thermostat
*th
= i2c_get_clientdata(client
);
164 if (thread_therm
!= NULL
) {
165 kthread_stop(thread_therm
);
168 printk(KERN_INFO
"adt746x: Putting max temperatures back from "
169 "%d, %d, %d to %d, %d, %d\n",
170 th
->limits
[0], th
->limits
[1], th
->limits
[2],
171 th
->initial_limits
[0], th
->initial_limits
[1],
172 th
->initial_limits
[2]);
174 for (i
= 0; i
< 3; i
++)
175 write_reg(th
, LIMIT_REG
[i
], th
->initial_limits
[i
]);
177 write_both_fan_speed(th
, -1);
186 static int read_fan_speed(struct thermostat
*th
, u8 addr
)
191 /* should start with low byte */
192 tmp
[1] = read_reg(th
, addr
);
193 tmp
[0] = read_reg(th
, addr
+ 1);
195 res
= tmp
[1] + (tmp
[0] << 8);
196 /* "a value of 0xffff means that the fan has stopped" */
197 return (res
== 0xffff ? 0 : (90000*60)/res
);
200 static void write_both_fan_speed(struct thermostat
*th
, int speed
)
202 write_fan_speed(th
, speed
, 0);
203 if (therm_type
== ADT7460
)
204 write_fan_speed(th
, speed
, 1);
207 static void write_fan_speed(struct thermostat
*th
, int speed
, int fan
)
216 if (therm_type
== ADT7467
&& fan
== 1)
219 if (th
->last_speed
[fan
] != speed
) {
222 printk(KERN_DEBUG
"adt746x: Setting speed to automatic "
223 "for %s fan.\n", sensor_location
[fan
+1]);
225 printk(KERN_DEBUG
"adt746x: Setting speed to %d "
226 "for %s fan.\n", speed
, sensor_location
[fan
+1]);
232 manual
= read_reg(th
, MANUAL_MODE
[fan
]);
233 manual
&= ~INVERT_MASK
;
234 write_reg(th
, MANUAL_MODE
[fan
],
235 manual
| MANUAL_MASK
| th
->pwm_inv
[fan
]);
236 write_reg(th
, FAN_SPD_SET
[fan
], speed
);
238 /* back to automatic */
239 if(therm_type
== ADT7460
) {
240 manual
= read_reg(th
,
241 MANUAL_MODE
[fan
]) & (~MANUAL_MASK
);
242 manual
&= ~INVERT_MASK
;
243 manual
|= th
->pwm_inv
[fan
];
245 MANUAL_MODE
[fan
], manual
|REM_CONTROL
[fan
]);
247 manual
= read_reg(th
, MANUAL_MODE
[fan
]);
248 manual
&= ~INVERT_MASK
;
249 manual
|= th
->pwm_inv
[fan
];
250 write_reg(th
, MANUAL_MODE
[fan
], manual
&(~AUTO_MASK
));
254 th
->last_speed
[fan
] = speed
;
257 static void read_sensors(struct thermostat
*th
)
261 for (i
= 0; i
< 3; i
++)
262 th
->temps
[i
] = read_reg(th
, TEMP_REG
[i
]);
266 static void display_stats(struct thermostat
*th
)
268 if (th
->temps
[0] != th
->cached_temp
[0]
269 || th
->temps
[1] != th
->cached_temp
[1]
270 || th
->temps
[2] != th
->cached_temp
[2]) {
271 printk(KERN_INFO
"adt746x: Temperature infos:"
272 " thermostats: %d,%d,%d;"
274 " fan speed: %d RPM\n",
275 th
->temps
[0], th
->temps
[1], th
->temps
[2],
276 th
->limits
[0], th
->limits
[1], th
->limits
[2],
277 read_fan_speed(th
, FAN_SPEED
[0]));
279 th
->cached_temp
[0] = th
->temps
[0];
280 th
->cached_temp
[1] = th
->temps
[1];
281 th
->cached_temp
[2] = th
->temps
[2];
285 static void update_fans_speed (struct thermostat
*th
)
287 int lastvar
= 0; /* last variation, for iBook */
290 /* we don't care about local sensor, so we start at sensor 1 */
291 for (i
= 1; i
< 3; i
++) {
293 int fan_number
= (therm_type
== ADT7460
&& i
== 2);
294 int var
= th
->temps
[i
] - th
->limits
[i
];
297 int step
= (255 - fan_speed
) / 7;
300 /* hysteresis : change fan speed only if variation is
301 * more than two degrees */
302 if (abs(var
- th
->last_var
[fan_number
]) < 2)
306 new_speed
= fan_speed
+ ((var
-1)*step
);
308 if (new_speed
< fan_speed
)
309 new_speed
= fan_speed
;
314 printk(KERN_DEBUG
"adt746x: Setting fans speed to %d "
315 "(limit exceeded by %d on %s) \n",
317 sensor_location
[fan_number
+1]);
318 write_both_fan_speed(th
, new_speed
);
319 th
->last_var
[fan_number
] = var
;
320 } else if (var
< -2) {
321 /* don't stop fan if sensor2 is cold and sensor1 is not
322 * so cold (lastvar >= -1) */
323 if (i
== 2 && lastvar
< -1) {
324 if (th
->last_speed
[fan_number
] != 0)
326 printk(KERN_DEBUG
"adt746x: Stopping "
328 write_both_fan_speed(th
, 0);
335 return; /* we don't want to re-stop the fan
336 * if sensor1 is heating and sensor2 is not */
340 static int monitor_task(void *arg
)
342 struct thermostat
* th
= arg
;
345 while(!kthread_should_stop()) {
347 msleep_interruptible(2000);
357 update_fans_speed(th
);
368 static void set_limit(struct thermostat
*th
, int i
)
370 /* Set sensor1 limit higher to avoid powerdowns */
371 th
->limits
[i
] = default_limits_chip
[i
] + limit_adjust
;
372 write_reg(th
, LIMIT_REG
[i
], th
->limits
[i
]);
374 /* set our limits to normal */
375 th
->limits
[i
] = default_limits_local
[i
] + limit_adjust
;
378 static int probe_thermostat(struct i2c_client
*client
,
379 const struct i2c_device_id
*id
)
381 struct thermostat
* th
;
388 th
= kzalloc(sizeof(struct thermostat
), GFP_KERNEL
);
392 i2c_set_clientdata(client
, th
);
395 rc
= read_reg(th
, CONFIG_REG
);
397 dev_err(&client
->dev
, "Thermostat failed to read config!\n");
402 /* force manual control to start the fan quieter */
406 if(therm_type
== ADT7460
) {
407 printk(KERN_INFO
"adt746x: ADT7460 initializing\n");
408 /* The 7460 needs to be started explicitly */
409 write_reg(th
, CONFIG_REG
, 1);
411 printk(KERN_INFO
"adt746x: ADT7467 initializing\n");
413 for (i
= 0; i
< 3; i
++) {
414 th
->initial_limits
[i
] = read_reg(th
, LIMIT_REG
[i
]);
418 printk(KERN_INFO
"adt746x: Lowering max temperatures from %d, %d, %d"
420 th
->initial_limits
[0], th
->initial_limits
[1],
421 th
->initial_limits
[2], th
->limits
[0], th
->limits
[1],
426 /* record invert bit status because fw can corrupt it after suspend */
427 th
->pwm_inv
[0] = read_reg(th
, MANUAL_MODE
[0]) & INVERT_MASK
;
428 th
->pwm_inv
[1] = read_reg(th
, MANUAL_MODE
[1]) & INVERT_MASK
;
430 /* be sure to really write fan speed the first time */
431 th
->last_speed
[0] = -2;
432 th
->last_speed
[1] = -2;
433 th
->last_var
[0] = -80;
434 th
->last_var
[1] = -80;
436 if (fan_speed
!= -1) {
437 /* manual mode, stop fans */
438 write_both_fan_speed(th
, 0);
441 write_both_fan_speed(th
, -1);
444 thread_therm
= kthread_run(monitor_task
, th
, "kfand");
446 if (thread_therm
== ERR_PTR(-ENOMEM
)) {
447 printk(KERN_INFO
"adt746x: Kthread creation failed\n");
455 static const struct i2c_device_id therm_adt746x_id
[] = {
456 { "therm_adt746x", 0 },
460 static struct i2c_driver thermostat_driver
= {
462 .name
= "therm_adt746x",
464 .attach_adapter
= attach_thermostat
,
465 .probe
= probe_thermostat
,
466 .remove
= remove_thermostat
,
467 .id_table
= therm_adt746x_id
,
471 * Now, unfortunately, sysfs doesn't give us a nice void * we could
472 * pass around to the attribute functions, so we don't really have
473 * choice but implement a bunch of them...
475 * FIXME, it does now...
477 #define BUILD_SHOW_FUNC_INT(name, data) \
478 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
480 return sprintf(buf, "%d\n", data); \
483 #define BUILD_SHOW_FUNC_STR(name, data) \
484 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
486 return sprintf(buf, "%s\n", data); \
489 #define BUILD_SHOW_FUNC_FAN(name, data) \
490 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf) \
492 return sprintf(buf, "%d (%d rpm)\n", \
493 thermostat->last_speed[data], \
494 read_fan_speed(thermostat, FAN_SPEED[data]) \
498 #define BUILD_STORE_FUNC_DEG(name, data) \
499 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
503 val = simple_strtol(buf, NULL, 10); \
504 printk(KERN_INFO "Adjusting limits by %d degrees\n", val); \
505 limit_adjust = val; \
506 for (i=0; i < 3; i++) \
507 set_limit(thermostat, i); \
511 #define BUILD_STORE_FUNC_INT(name, data) \
512 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
515 val = simple_strtol(buf, NULL, 10); \
516 if (val < 0 || val > 255) \
518 printk(KERN_INFO "Setting specified fan speed to %d\n", val); \
523 BUILD_SHOW_FUNC_INT(sensor1_temperature
, (read_reg(thermostat
, TEMP_REG
[1])))
524 BUILD_SHOW_FUNC_INT(sensor2_temperature
, (read_reg(thermostat
, TEMP_REG
[2])))
525 BUILD_SHOW_FUNC_INT(sensor1_limit
, thermostat
->limits
[1])
526 BUILD_SHOW_FUNC_INT(sensor2_limit
, thermostat
->limits
[2])
527 BUILD_SHOW_FUNC_STR(sensor1_location
, sensor_location
[1])
528 BUILD_SHOW_FUNC_STR(sensor2_location
, sensor_location
[2])
530 BUILD_SHOW_FUNC_INT(specified_fan_speed
, fan_speed
)
531 BUILD_SHOW_FUNC_FAN(sensor1_fan_speed
, 0)
532 BUILD_SHOW_FUNC_FAN(sensor2_fan_speed
, 1)
534 BUILD_STORE_FUNC_INT(specified_fan_speed
,fan_speed
)
535 BUILD_SHOW_FUNC_INT(limit_adjust
, limit_adjust
)
536 BUILD_STORE_FUNC_DEG(limit_adjust
, thermostat
)
538 static DEVICE_ATTR(sensor1_temperature
, S_IRUGO
,
539 show_sensor1_temperature
,NULL
);
540 static DEVICE_ATTR(sensor2_temperature
, S_IRUGO
,
541 show_sensor2_temperature
,NULL
);
542 static DEVICE_ATTR(sensor1_limit
, S_IRUGO
,
543 show_sensor1_limit
, NULL
);
544 static DEVICE_ATTR(sensor2_limit
, S_IRUGO
,
545 show_sensor2_limit
, NULL
);
546 static DEVICE_ATTR(sensor1_location
, S_IRUGO
,
547 show_sensor1_location
, NULL
);
548 static DEVICE_ATTR(sensor2_location
, S_IRUGO
,
549 show_sensor2_location
, NULL
);
551 static DEVICE_ATTR(specified_fan_speed
, S_IRUSR
|S_IWUSR
|S_IRGRP
|S_IROTH
,
552 show_specified_fan_speed
,store_specified_fan_speed
);
554 static DEVICE_ATTR(sensor1_fan_speed
, S_IRUGO
,
555 show_sensor1_fan_speed
, NULL
);
556 static DEVICE_ATTR(sensor2_fan_speed
, S_IRUGO
,
557 show_sensor2_fan_speed
, NULL
);
559 static DEVICE_ATTR(limit_adjust
, S_IRUSR
|S_IWUSR
|S_IRGRP
|S_IROTH
,
560 show_limit_adjust
, store_limit_adjust
);
564 thermostat_init(void)
566 struct device_node
* np
;
568 int i
= 0, offset
= 0;
571 np
= of_find_node_by_name(NULL
, "fan");
574 if (of_device_is_compatible(np
, "adt7460"))
575 therm_type
= ADT7460
;
576 else if (of_device_is_compatible(np
, "adt7467"))
577 therm_type
= ADT7467
;
583 prop
= of_get_property(np
, "hwsensor-params-version", NULL
);
584 printk(KERN_INFO
"adt746x: version %d (%ssupported)\n", *prop
,
585 (*prop
== 1)?"":"un");
591 prop
= of_get_property(np
, "reg", NULL
);
597 /* look for bus either by path or using "reg" */
598 if (strstr(np
->full_name
, "/i2c-bus@") != NULL
) {
599 const char *tmp_bus
= (strstr(np
->full_name
, "/i2c-bus@") + 9);
600 therm_bus
= tmp_bus
[0]-'0';
602 therm_bus
= ((*prop
) >> 8) & 0x0f;
605 therm_address
= ((*prop
) & 0xff) >> 1;
607 printk(KERN_INFO
"adt746x: Thermostat bus: %d, address: 0x%02x, "
608 "limit_adjust: %d, fan_speed: %d\n",
609 therm_bus
, therm_address
, limit_adjust
, fan_speed
);
611 if (of_get_property(np
, "hwsensor-location", NULL
)) {
612 for (i
= 0; i
< 3; i
++) {
613 sensor_location
[i
] = of_get_property(np
,
614 "hwsensor-location", NULL
) + offset
;
616 if (sensor_location
[i
] == NULL
)
617 sensor_location
[i
] = "";
619 printk(KERN_INFO
"sensor %d: %s\n", i
, sensor_location
[i
]);
620 offset
+= strlen(sensor_location
[i
]) + 1;
623 sensor_location
[0] = "?";
624 sensor_location
[1] = "?";
625 sensor_location
[2] = "?";
628 of_dev
= of_platform_device_create(np
, "temperatures", NULL
);
631 if (of_dev
== NULL
) {
632 printk(KERN_ERR
"Can't register temperatures device !\n");
636 err
= device_create_file(&of_dev
->dev
, &dev_attr_sensor1_temperature
);
637 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor2_temperature
);
638 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor1_limit
);
639 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor2_limit
);
640 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor1_location
);
641 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor2_location
);
642 err
|= device_create_file(&of_dev
->dev
, &dev_attr_limit_adjust
);
643 err
|= device_create_file(&of_dev
->dev
, &dev_attr_specified_fan_speed
);
644 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor1_fan_speed
);
645 if(therm_type
== ADT7460
)
646 err
|= device_create_file(&of_dev
->dev
, &dev_attr_sensor2_fan_speed
);
649 "Failed to create tempertaure attribute file(s).\n");
651 #ifndef CONFIG_I2C_POWERMAC
652 request_module("i2c-powermac");
655 return i2c_add_driver(&thermostat_driver
);
659 thermostat_exit(void)
662 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_temperature
);
663 device_remove_file(&of_dev
->dev
, &dev_attr_sensor2_temperature
);
664 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_limit
);
665 device_remove_file(&of_dev
->dev
, &dev_attr_sensor2_limit
);
666 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_location
);
667 device_remove_file(&of_dev
->dev
, &dev_attr_sensor2_location
);
668 device_remove_file(&of_dev
->dev
, &dev_attr_limit_adjust
);
669 device_remove_file(&of_dev
->dev
, &dev_attr_specified_fan_speed
);
670 device_remove_file(&of_dev
->dev
, &dev_attr_sensor1_fan_speed
);
672 if(therm_type
== ADT7460
)
673 device_remove_file(&of_dev
->dev
,
674 &dev_attr_sensor2_fan_speed
);
676 of_device_unregister(of_dev
);
678 i2c_del_driver(&thermostat_driver
);
681 module_init(thermostat_init
);
682 module_exit(thermostat_exit
);