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
 
  41 static u8 TEMP_REG[3]    = {0x26, 0x25, 0x27}; /* local, sensor1, sensor2 */
 
  42 static u8 LIMIT_REG[3]   = {0x6b, 0x6a, 0x6c}; /* local, sensor1, sensor2 */
 
  43 static u8 MANUAL_MODE[2] = {0x5c, 0x5d};       
 
  44 static u8 REM_CONTROL[2] = {0x00, 0x40};
 
  45 static u8 FAN_SPEED[2]   = {0x28, 0x2a};
 
  46 static u8 FAN_SPD_SET[2] = {0x30, 0x31};
 
  48 static u8 default_limits_local[3] = {70, 50, 70};    /* local, sensor1, sensor2 */
 
  49 static u8 default_limits_chip[3] = {80, 65, 80};    /* local, sensor1, sensor2 */
 
  50 static const char *sensor_location[3];
 
  52 static int limit_adjust;
 
  53 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) "
 
  69 module_param(verbose, bool, 0);
 
  70 MODULE_PARM_DESC(verbose,"Verbose log operations "
 
  74         struct i2c_client       clt;
 
  83 static enum {ADT7460, ADT7467} therm_type;
 
  84 static int therm_bus, therm_address;
 
  85 static struct of_device * of_dev;
 
  86 static struct thermostat* thermostat;
 
  87 static struct task_struct *thread_therm = NULL;
 
  89 static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
 
  92 static void write_both_fan_speed(struct thermostat *th, int speed);
 
  93 static void write_fan_speed(struct thermostat *th, int speed, int fan);
 
  96 write_reg(struct thermostat* th, int reg, u8 data)
 
 103         rc = i2c_master_send(&th->clt, (const char *)tmp, 2);
 
 112 read_reg(struct thermostat* th, int reg)
 
 118         rc = i2c_master_send(&th->clt, ®_addr, 1);
 
 123         rc = i2c_master_recv(&th->clt, (char *)&data, 1);
 
 130 attach_thermostat(struct i2c_adapter *adapter)
 
 132         unsigned long bus_no;
 
 134         if (strncmp(adapter->name, "uni-n", 5))
 
 136         bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
 
 137         if (bus_no != therm_bus)
 
 139         return attach_one_thermostat(adapter, therm_address, bus_no);
 
 143 detach_thermostat(struct i2c_adapter *adapter)
 
 145         struct thermostat* th;
 
 148         if (thermostat == NULL)
 
 153         if (thread_therm != NULL) {
 
 154                 kthread_stop(thread_therm);
 
 157         printk(KERN_INFO "adt746x: Putting max temperatures back from "
 
 158                          "%d, %d, %d to %d, %d, %d\n",
 
 159                 th->limits[0], th->limits[1], th->limits[2],
 
 160                 th->initial_limits[0], th->initial_limits[1],
 
 161                 th->initial_limits[2]);
 
 163         for (i = 0; i < 3; i++)
 
 164                 write_reg(th, LIMIT_REG[i], th->initial_limits[i]);
 
 166         write_both_fan_speed(th, -1);
 
 168         i2c_detach_client(&th->clt);
 
 177 static struct i2c_driver thermostat_driver = {  
 
 179                 .name   = "therm_adt746x",
 
 181         .attach_adapter = attach_thermostat,
 
 182         .detach_adapter = detach_thermostat,
 
 185 static int read_fan_speed(struct thermostat *th, u8 addr)
 
 190         /* should start with low byte */
 
 191         tmp[1] = read_reg(th, addr);
 
 192         tmp[0] = read_reg(th, addr + 1);
 
 194         res = tmp[1] + (tmp[0] << 8);
 
 195         /* "a value of 0xffff means that the fan has stopped" */
 
 196         return (res == 0xffff ? 0 : (90000*60)/res);
 
 199 static void write_both_fan_speed(struct thermostat *th, int speed)
 
 201         write_fan_speed(th, speed, 0);
 
 202         if (therm_type == ADT7460)
 
 203                 write_fan_speed(th, speed, 1);
 
 206 static void write_fan_speed(struct thermostat *th, int speed, int fan)
 
 215         if (therm_type == ADT7467 && fan == 1)
 
 218         if (th->last_speed[fan] != speed) {
 
 221                                 printk(KERN_DEBUG "adt746x: Setting speed to automatic "
 
 222                                         "for %s fan.\n", sensor_location[fan+1]);
 
 224                                 printk(KERN_DEBUG "adt746x: Setting speed to %d "
 
 225                                         "for %s fan.\n", speed, sensor_location[fan+1]);
 
 231                 manual = read_reg(th, MANUAL_MODE[fan]);
 
 232                 write_reg(th, MANUAL_MODE[fan], manual|MANUAL_MASK);
 
 233                 write_reg(th, FAN_SPD_SET[fan], speed);
 
 235                 /* back to automatic */
 
 236                 if(therm_type == ADT7460) {
 
 237                         manual = read_reg(th,
 
 238                                 MANUAL_MODE[fan]) & (~MANUAL_MASK);
 
 241                                 MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
 
 243                         manual = read_reg(th, MANUAL_MODE[fan]);
 
 244                         write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
 
 248         th->last_speed[fan] = speed;                    
 
 251 static void read_sensors(struct thermostat *th)
 
 255         for (i = 0; i < 3; i++)
 
 256                 th->temps[i]  = read_reg(th, TEMP_REG[i]);
 
 260 static void display_stats(struct thermostat *th)
 
 262         if (th->temps[0] != th->cached_temp[0]
 
 263         ||  th->temps[1] != th->cached_temp[1]
 
 264         ||  th->temps[2] != th->cached_temp[2]) {
 
 265                 printk(KERN_INFO "adt746x: Temperature infos:"
 
 266                                  " thermostats: %d,%d,%d;"
 
 268                                  " fan speed: %d RPM\n",
 
 269                                  th->temps[0], th->temps[1], th->temps[2],
 
 270                                  th->limits[0],  th->limits[1],  th->limits[2],
 
 271                                  read_fan_speed(th, FAN_SPEED[0]));
 
 273         th->cached_temp[0] = th->temps[0];
 
 274         th->cached_temp[1] = th->temps[1];
 
 275         th->cached_temp[2] = th->temps[2];
 
 279 static void update_fans_speed (struct thermostat *th)
 
 281         int lastvar = 0; /* last variation, for iBook */
 
 284         /* we don't care about local sensor, so we start at sensor 1 */
 
 285         for (i = 1; i < 3; i++) {
 
 287                 int fan_number = (therm_type == ADT7460 && i == 2);
 
 288                 int var = th->temps[i] - th->limits[i];
 
 291                         int step = (255 - fan_speed) / 7;
 
 294                         /* hysteresis : change fan speed only if variation is
 
 295                          * more than two degrees */
 
 296                         if (abs(var - th->last_var[fan_number]) < 2)
 
 300                         new_speed = fan_speed + ((var-1)*step);
 
 302                         if (new_speed < fan_speed)
 
 303                                 new_speed = fan_speed;
 
 308                                 printk(KERN_DEBUG "adt746x: Setting fans speed to %d "
 
 309                                                  "(limit exceeded by %d on %s) \n",
 
 311                                                 sensor_location[fan_number+1]);
 
 312                         write_both_fan_speed(th, new_speed);
 
 313                         th->last_var[fan_number] = var;
 
 314                 } else if (var < -2) {
 
 315                         /* don't stop fan if sensor2 is cold and sensor1 is not
 
 316                          * so cold (lastvar >= -1) */
 
 317                         if (i == 2 && lastvar < -1) {
 
 318                                 if (th->last_speed[fan_number] != 0)
 
 320                                                 printk(KERN_DEBUG "adt746x: Stopping "
 
 322                                 write_both_fan_speed(th, 0);
 
 329                         return; /* we don't want to re-stop the fan
 
 330                                 * if sensor1 is heating and sensor2 is not */
 
 334 static int monitor_task(void *arg)
 
 336         struct thermostat* th = arg;
 
 339         while(!kthread_should_stop()) {
 
 341                 msleep_interruptible(2000);
 
 351                         update_fans_speed(th);
 
 362 static void set_limit(struct thermostat *th, int i)
 
 364                 /* Set sensor1 limit higher to avoid powerdowns */
 
 365                 th->limits[i] = default_limits_chip[i] + limit_adjust;
 
 366                 write_reg(th, LIMIT_REG[i], th->limits[i]);
 
 368                 /* set our limits to normal */
 
 369                 th->limits[i] = default_limits_local[i] + limit_adjust;
 
 372 static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
 
 375         struct thermostat* th;
 
 382         th = kzalloc(sizeof(struct thermostat), GFP_KERNEL);
 
 387         th->clt.adapter = adapter;
 
 388         th->clt.driver = &thermostat_driver;
 
 389         strcpy(th->clt.name, "thermostat");
 
 391         rc = read_reg(th, 0);
 
 393                 printk(KERN_ERR "adt746x: Thermostat failed to read config "
 
 400         /* force manual control to start the fan quieter */
 
 404         if(therm_type == ADT7460) {
 
 405                 printk(KERN_INFO "adt746x: ADT7460 initializing\n");
 
 406                 /* The 7460 needs to be started explicitly */
 
 407                 write_reg(th, CONFIG_REG, 1);
 
 409                 printk(KERN_INFO "adt746x: ADT7467 initializing\n");
 
 411         for (i = 0; i < 3; i++) {
 
 412                 th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
 
 416         printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
 
 418                          th->initial_limits[0], th->initial_limits[1],
 
 419                          th->initial_limits[2], th->limits[0], th->limits[1],
 
 424         if (i2c_attach_client(&th->clt)) {
 
 425                 printk(KERN_INFO "adt746x: Thermostat failed to attach "
 
 432         /* be sure to really write fan speed the first time */
 
 433         th->last_speed[0] = -2;
 
 434         th->last_speed[1] = -2;
 
 435         th->last_var[0] = -80;
 
 436         th->last_var[1] = -80;
 
 438         if (fan_speed != -1) {
 
 439                 /* manual mode, stop fans */
 
 440                 write_both_fan_speed(th, 0);
 
 443                 write_both_fan_speed(th, -1);
 
 446         thread_therm = kthread_run(monitor_task, th, "kfand");
 
 448         if (thread_therm == ERR_PTR(-ENOMEM)) {
 
 449                 printk(KERN_INFO "adt746x: Kthread creation failed\n");
 
 458  * Now, unfortunately, sysfs doesn't give us a nice void * we could
 
 459  * pass around to the attribute functions, so we don't really have
 
 460  * choice but implement a bunch of them...
 
 462  * FIXME, it does now...
 
 464 #define BUILD_SHOW_FUNC_INT(name, data)                         \
 
 465 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)        \
 
 467         return sprintf(buf, "%d\n", data);                      \
 
 470 #define BUILD_SHOW_FUNC_STR(name, data)                         \
 
 471 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)       \
 
 473         return sprintf(buf, "%s\n", data);                      \
 
 476 #define BUILD_SHOW_FUNC_FAN(name, data)                         \
 
 477 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)       \
 
 479         return sprintf(buf, "%d (%d rpm)\n",                    \
 
 480                 thermostat->last_speed[data],                   \
 
 481                 read_fan_speed(thermostat, FAN_SPEED[data])     \
 
 485 #define BUILD_STORE_FUNC_DEG(name, data)                        \
 
 486 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
 
 490         val = simple_strtol(buf, NULL, 10);                     \
 
 491         printk(KERN_INFO "Adjusting limits by %d degrees\n", val);      \
 
 492         limit_adjust = val;                                     \
 
 493         for (i=0; i < 3; i++)                                   \
 
 494                 set_limit(thermostat, i);                       \
 
 498 #define BUILD_STORE_FUNC_INT(name, data)                        \
 
 499 static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
 
 502         val = simple_strtoul(buf, NULL, 10);                    \
 
 503         if (val < 0 || val > 255)                               \
 
 505         printk(KERN_INFO "Setting specified fan speed to %d\n", val);   \
 
 510 BUILD_SHOW_FUNC_INT(sensor1_temperature,         (read_reg(thermostat, TEMP_REG[1])))
 
 511 BUILD_SHOW_FUNC_INT(sensor2_temperature,         (read_reg(thermostat, TEMP_REG[2])))
 
 512 BUILD_SHOW_FUNC_INT(sensor1_limit,               thermostat->limits[1])
 
 513 BUILD_SHOW_FUNC_INT(sensor2_limit,               thermostat->limits[2])
 
 514 BUILD_SHOW_FUNC_STR(sensor1_location,            sensor_location[1])
 
 515 BUILD_SHOW_FUNC_STR(sensor2_location,            sensor_location[2])
 
 517 BUILD_SHOW_FUNC_INT(specified_fan_speed, fan_speed)
 
 518 BUILD_SHOW_FUNC_FAN(sensor1_fan_speed,   0)
 
 519 BUILD_SHOW_FUNC_FAN(sensor2_fan_speed,   1)
 
 521 BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)
 
 522 BUILD_SHOW_FUNC_INT(limit_adjust,        limit_adjust)
 
 523 BUILD_STORE_FUNC_DEG(limit_adjust,       thermostat)
 
 525 static DEVICE_ATTR(sensor1_temperature, S_IRUGO,
 
 526                    show_sensor1_temperature,NULL);
 
 527 static DEVICE_ATTR(sensor2_temperature, S_IRUGO,
 
 528                    show_sensor2_temperature,NULL);
 
 529 static DEVICE_ATTR(sensor1_limit, S_IRUGO,
 
 530                    show_sensor1_limit,  NULL);
 
 531 static DEVICE_ATTR(sensor2_limit, S_IRUGO,
 
 532                    show_sensor2_limit,  NULL);
 
 533 static DEVICE_ATTR(sensor1_location, S_IRUGO,
 
 534                    show_sensor1_location, NULL);
 
 535 static DEVICE_ATTR(sensor2_location, S_IRUGO,
 
 536                    show_sensor2_location, NULL);
 
 538 static DEVICE_ATTR(specified_fan_speed, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
 
 539                    show_specified_fan_speed,store_specified_fan_speed);
 
 541 static DEVICE_ATTR(sensor1_fan_speed,   S_IRUGO,
 
 542                    show_sensor1_fan_speed,      NULL);
 
 543 static DEVICE_ATTR(sensor2_fan_speed,   S_IRUGO,
 
 544                    show_sensor2_fan_speed,      NULL);
 
 546 static DEVICE_ATTR(limit_adjust,        S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
 
 547                    show_limit_adjust,   store_limit_adjust);
 
 551 thermostat_init(void)
 
 553         struct device_node* np;
 
 555         int i = 0, offset = 0;
 
 558         np = of_find_node_by_name(NULL, "fan");
 
 561         if (of_device_is_compatible(np, "adt7460"))
 
 562                 therm_type = ADT7460;
 
 563         else if (of_device_is_compatible(np, "adt7467"))
 
 564                 therm_type = ADT7467;
 
 570         prop = of_get_property(np, "hwsensor-params-version", NULL);
 
 571         printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
 
 572                          (*prop == 1)?"":"un");
 
 578         prop = of_get_property(np, "reg", NULL);
 
 584         /* look for bus either by path or using "reg" */
 
 585         if (strstr(np->full_name, "/i2c-bus@") != NULL) {
 
 586                 const char *tmp_bus = (strstr(np->full_name, "/i2c-bus@") + 9);
 
 587                 therm_bus = tmp_bus[0]-'0';
 
 589                 therm_bus = ((*prop) >> 8) & 0x0f;
 
 592         therm_address = ((*prop) & 0xff) >> 1;
 
 594         printk(KERN_INFO "adt746x: Thermostat bus: %d, address: 0x%02x, "
 
 595                          "limit_adjust: %d, fan_speed: %d\n",
 
 596                          therm_bus, therm_address, limit_adjust, fan_speed);
 
 598         if (of_get_property(np, "hwsensor-location", NULL)) {
 
 599                 for (i = 0; i < 3; i++) {
 
 600                         sensor_location[i] = of_get_property(np,
 
 601                                         "hwsensor-location", NULL) + offset;
 
 603                         if (sensor_location[i] == NULL)
 
 604                                 sensor_location[i] = "";
 
 606                         printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
 
 607                         offset += strlen(sensor_location[i]) + 1;
 
 610                 sensor_location[0] = "?";
 
 611                 sensor_location[1] = "?";
 
 612                 sensor_location[2] = "?";
 
 615         of_dev = of_platform_device_create(np, "temperatures", NULL);
 
 618         if (of_dev == NULL) {
 
 619                 printk(KERN_ERR "Can't register temperatures device !\n");
 
 623         err = device_create_file(&of_dev->dev, &dev_attr_sensor1_temperature);
 
 624         err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_temperature);
 
 625         err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_limit);
 
 626         err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_limit);
 
 627         err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_location);
 
 628         err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_location);
 
 629         err |= device_create_file(&of_dev->dev, &dev_attr_limit_adjust);
 
 630         err |= device_create_file(&of_dev->dev, &dev_attr_specified_fan_speed);
 
 631         err |= device_create_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
 
 632         if(therm_type == ADT7460)
 
 633                 err |= device_create_file(&of_dev->dev, &dev_attr_sensor2_fan_speed);
 
 636                         "Failed to create tempertaure attribute file(s).\n");
 
 638 #ifndef CONFIG_I2C_POWERMAC
 
 639         request_module("i2c-powermac");
 
 642         return i2c_add_driver(&thermostat_driver);
 
 646 thermostat_exit(void)
 
 649                 device_remove_file(&of_dev->dev, &dev_attr_sensor1_temperature);
 
 650                 device_remove_file(&of_dev->dev, &dev_attr_sensor2_temperature);
 
 651                 device_remove_file(&of_dev->dev, &dev_attr_sensor1_limit);
 
 652                 device_remove_file(&of_dev->dev, &dev_attr_sensor2_limit);
 
 653                 device_remove_file(&of_dev->dev, &dev_attr_sensor1_location);
 
 654                 device_remove_file(&of_dev->dev, &dev_attr_sensor2_location);
 
 655                 device_remove_file(&of_dev->dev, &dev_attr_limit_adjust);
 
 656                 device_remove_file(&of_dev->dev, &dev_attr_specified_fan_speed);
 
 657                 device_remove_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
 
 659                 if(therm_type == ADT7460)
 
 660                         device_remove_file(&of_dev->dev,
 
 661                                            &dev_attr_sensor2_fan_speed);
 
 663                 of_device_unregister(of_dev);
 
 665         i2c_del_driver(&thermostat_driver);
 
 668 module_init(thermostat_init);
 
 669 module_exit(thermostat_exit);