f62c16fab42bf78a663dc3896f0e32fe43abe92f
[safe/jmp/linux-2.6] / drivers / macintosh / therm_adt746x.c
1 /*
2  * Device driver for the i2c thermostat found on the iBook G4, Albook G4
3  *
4  * Copyright (C) 2003, 2004 Colin Leroy, Rasmus Rohde, Benjamin Herrenschmidt
5  *
6  * Documentation from
7  * http://www.analog.com/UploadedFiles/Data_Sheets/115254175ADT7467_pra.pdf
8  * http://www.analog.com/UploadedFiles/Data_Sheets/3686221171167ADT7460_b.pdf
9  *
10  */
11
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>
28
29 #include <asm/prom.h>
30 #include <asm/machdep.h>
31 #include <asm/io.h>
32 #include <asm/system.h>
33 #include <asm/sections.h>
34 #include <asm/of_device.h>
35
36 #undef DEBUG
37
38 #define CONFIG_REG   0x40
39 #define MANUAL_MASK  0xe0
40 #define AUTO_MASK    0x20
41
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};
48
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};
52
53 static int limit_adjust = 0;
54 static int fan_speed = -1;
55
56 MODULE_AUTHOR("Colin Leroy <colin@colino.net>");
57 MODULE_DESCRIPTION("Driver for ADT746x thermostat in iBook G4 and "
58                    "Powerbook G4 Alu");
59 MODULE_LICENSE("GPL");
60
61 module_param(limit_adjust, int, 0644);
62 MODULE_PARM_DESC(limit_adjust,"Adjust maximum temperatures (50 sensor1, 70 sensor2) "
63                  "by N degrees.");
64
65 module_param(fan_speed, int, 0644);
66 MODULE_PARM_DESC(fan_speed,"Specify starting fan speed (0-255) "
67                  "(default 64)");
68
69 struct thermostat {
70         struct i2c_client       clt;
71         u8                      temps[3];
72         u8                      cached_temp[3];
73         u8                      initial_limits[3];
74         u8                      limits[3];
75         int                     last_speed[2];
76         int                     last_var[2];
77 };
78
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;
84
85 static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
86                                  int busno);
87
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);
90
91 static int
92 write_reg(struct thermostat* th, int reg, u8 data)
93 {
94         u8 tmp[2];
95         int rc;
96         
97         tmp[0] = reg;
98         tmp[1] = data;
99         rc = i2c_master_send(&th->clt, (const char *)tmp, 2);
100         if (rc < 0)
101                 return rc;
102         if (rc != 2)
103                 return -ENODEV;
104         return 0;
105 }
106
107 static int
108 read_reg(struct thermostat* th, int reg)
109 {
110         u8 reg_addr, data;
111         int rc;
112
113         reg_addr = (u8)reg;
114         rc = i2c_master_send(&th->clt, &reg_addr, 1);
115         if (rc < 0)
116                 return rc;
117         if (rc != 1)
118                 return -ENODEV;
119         rc = i2c_master_recv(&th->clt, (char *)&data, 1);
120         if (rc < 0)
121                 return rc;
122         return data;
123 }
124
125 static int
126 attach_thermostat(struct i2c_adapter *adapter)
127 {
128         unsigned long bus_no;
129
130         if (strncmp(adapter->name, "uni-n", 5))
131                 return -ENODEV;
132         bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
133         if (bus_no != therm_bus)
134                 return -ENODEV;
135         return attach_one_thermostat(adapter, therm_address, bus_no);
136 }
137
138 static int
139 detach_thermostat(struct i2c_adapter *adapter)
140 {
141         struct thermostat* th;
142         int i;
143         
144         if (thermostat == NULL)
145                 return 0;
146
147         th = thermostat;
148
149         if (thread_therm != NULL) {
150                 kthread_stop(thread_therm);
151         }
152                 
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]);
158         
159         for (i = 0; i < 3; i++)
160                 write_reg(th, LIMIT_REG[i], th->initial_limits[i]);
161
162         write_both_fan_speed(th, -1);
163
164         i2c_detach_client(&th->clt);
165
166         thermostat = NULL;
167
168         kfree(th);
169
170         return 0;
171 }
172
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,
178 };
179
180 static int read_fan_speed(struct thermostat *th, u8 addr)
181 {
182         u8 tmp[2];
183         u16 res;
184         
185         /* should start with low byte */
186         tmp[1] = read_reg(th, addr);
187         tmp[0] = read_reg(th, addr + 1);
188         
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);
192 }
193
194 static void write_both_fan_speed(struct thermostat *th, int speed)
195 {
196         write_fan_speed(th, speed, 0);
197         if (therm_type == ADT7460)
198                 write_fan_speed(th, speed, 1);
199 }
200
201 static void write_fan_speed(struct thermostat *th, int speed, int fan)
202 {
203         u8 manual;
204         
205         if (speed > 0xff) 
206                 speed = 0xff;
207         else if (speed < -1) 
208                 speed = 0;
209         
210         if (therm_type == ADT7467 && fan == 1)
211                 return;
212         
213         if (th->last_speed[fan] != speed) {
214                 if (speed == -1)
215                         printk(KERN_DEBUG "adt746x: Setting speed to automatic "
216                                 "for %s fan.\n", sensor_location[fan+1]);
217                 else
218                         printk(KERN_DEBUG "adt746x: Setting speed to %d "
219                                 "for %s fan.\n", speed, sensor_location[fan+1]);
220         } else
221                 return;
222         
223         if (speed >= 0) {
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);
227         } else {
228                 /* back to automatic */
229                 if(therm_type == ADT7460) {
230                         manual = read_reg(th,
231                                 MANUAL_MODE[fan]) & (~MANUAL_MASK);
232
233                         write_reg(th,
234                                 MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
235                 } else {
236                         manual = read_reg(th, MANUAL_MODE[fan]);
237                         write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
238                 }
239         }
240         
241         th->last_speed[fan] = speed;                    
242 }
243
244 static void read_sensors(struct thermostat *th)
245 {
246         int i = 0;
247
248         for (i = 0; i < 3; i++)
249                 th->temps[i]  = read_reg(th, TEMP_REG[i]);
250 }
251
252 #ifdef DEBUG
253 static void display_stats(struct thermostat *th)
254 {
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;"
260                                  " limits: %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]));
265         }
266         th->cached_temp[0] = th->temps[0];
267         th->cached_temp[1] = th->temps[1];
268         th->cached_temp[2] = th->temps[2];
269 }
270 #endif
271
272 static void update_fans_speed (struct thermostat *th)
273 {
274         int lastvar = 0; /* last variation, for iBook */
275         int i = 0;
276
277         /* we don't care about local sensor, so we start at sensor 1 */
278         for (i = 1; i < 3; i++) {
279                 int started = 0;
280                 int fan_number = (therm_type == ADT7460 && i == 2);
281                 int var = th->temps[i] - th->limits[i];
282
283                 if (var > -1) {
284                         int step = (255 - fan_speed) / 7;
285                         int new_speed = 0;
286
287                         /* hysteresis : change fan speed only if variation is
288                          * more than two degrees */
289                         if (abs(var - th->last_var[fan_number]) < 2)
290                                 continue;
291
292                         started = 1;
293                         new_speed = fan_speed + ((var-1)*step);
294
295                         if (new_speed < fan_speed)
296                                 new_speed = fan_speed;
297                         if (new_speed > 255)
298                                 new_speed = 255;
299
300                         printk(KERN_DEBUG "adt746x: setting fans speed to %d "
301                                          "(limit exceeded by %d on %s) \n",
302                                         new_speed, var,
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 "
312                                                 "fans.\n");
313                                 write_both_fan_speed(th, 0);
314                         }
315                 }
316
317                 lastvar = var;
318
319                 if (started)
320                         return; /* we don't want to re-stop the fan
321                                 * if sensor1 is heating and sensor2 is not */
322         }
323 }
324
325 static int monitor_task(void *arg)
326 {
327         struct thermostat* th = arg;
328
329         while(!kthread_should_stop()) {
330                 try_to_freeze();
331                 msleep_interruptible(2000);
332
333 #ifndef DEBUG
334                 if (fan_speed != -1)
335                         read_sensors(th);
336 #else
337                 read_sensors(th);
338 #endif          
339
340                 if (fan_speed != -1)
341                         update_fans_speed(th);
342
343 #ifdef DEBUG
344                 display_stats(th);
345 #endif
346
347         }
348
349         return 0;
350 }
351
352 static void set_limit(struct thermostat *th, int i)
353 {
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]);
357                 
358                 /* set our limits to normal */
359                 th->limits[i] = default_limits_local[i] + limit_adjust;
360 }
361
362 static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
363                                  int busno)
364 {
365         struct thermostat* th;
366         int rc;
367         int i;
368
369         if (thermostat)
370                 return 0;
371
372         th = (struct thermostat *)
373                 kmalloc(sizeof(struct thermostat), GFP_KERNEL);
374
375         if (!th)
376                 return -ENOMEM;
377
378         memset(th, 0, sizeof(*th));
379         th->clt.addr = addr;
380         th->clt.adapter = adapter;
381         th->clt.driver = &thermostat_driver;
382         strcpy(th->clt.name, "thermostat");
383
384         rc = read_reg(th, 0);
385         if (rc < 0) {
386                 printk(KERN_ERR "adt746x: Thermostat failed to read config "
387                                 "from bus %d !\n",
388                                 busno);
389                 kfree(th);
390                 return -ENODEV;
391         }
392
393         /* force manual control to start the fan quieter */
394         if (fan_speed == -1)
395                 fan_speed = 64;
396         
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);
401         } else
402                 printk(KERN_INFO "adt746x: ADT7467 initializing\n");
403
404         for (i = 0; i < 3; i++) {
405                 th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
406                 set_limit(th, i);
407         }
408         
409         printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
410                          " to %d, %d, %d\n",
411                          th->initial_limits[0], th->initial_limits[1],
412                          th->initial_limits[2], th->limits[0], th->limits[1],
413                          th->limits[2]);
414
415         thermostat = th;
416
417         if (i2c_attach_client(&th->clt)) {
418                 printk(KERN_INFO "adt746x: Thermostat failed to attach "
419                                  "client !\n");
420                 thermostat = NULL;
421                 kfree(th);
422                 return -ENODEV;
423         }
424
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;
430
431         if (fan_speed != -1) {
432                 /* manual mode, stop fans */
433                 write_both_fan_speed(th, 0);
434         } else {
435                 /* automatic mode */
436                 write_both_fan_speed(th, -1);
437         }
438         
439         thread_therm = kthread_run(monitor_task, th, "kfand");
440
441         if (thread_therm == ERR_PTR(-ENOMEM)) {
442                 printk(KERN_INFO "adt746x: Kthread creation failed\n");
443                 thread_therm = NULL;
444                 return -ENOMEM;
445         }
446
447         return 0;
448 }
449
450 /* 
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...
454  *
455  * FIXME, it does now...
456  */
457 #define BUILD_SHOW_FUNC_INT(name, data)                         \
458 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)        \
459 {                                                               \
460         return sprintf(buf, "%d\n", data);                      \
461 }
462
463 #define BUILD_SHOW_FUNC_STR(name, data)                         \
464 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)       \
465 {                                                               \
466         return sprintf(buf, "%s\n", data);                      \
467 }
468
469 #define BUILD_SHOW_FUNC_FAN(name, data)                         \
470 static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)       \
471 {                                                               \
472         return sprintf(buf, "%d (%d rpm)\n",                    \
473                 thermostat->last_speed[data],                   \
474                 read_fan_speed(thermostat, FAN_SPEED[data])     \
475                 );                                              \
476 }
477
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) \
480 {                                                               \
481         int val;                                                \
482         int i;                                                  \
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);                       \
488         return n;                                               \
489 }
490
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) \
493 {                                                               \
494         u32 val;                                                \
495         val = simple_strtoul(buf, NULL, 10);                    \
496         if (val < 0 || val > 255)                               \
497                 return -EINVAL;                                 \
498         printk(KERN_INFO "Setting specified fan speed to %d\n", val);   \
499         data = val;                                             \
500         return n;                                               \
501 }
502
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])
509
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)
513
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)
517                 
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);
530
531 static DEVICE_ATTR(specified_fan_speed, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
532                    show_specified_fan_speed,store_specified_fan_speed);
533
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);
538
539 static DEVICE_ATTR(limit_adjust,        S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
540                    show_limit_adjust,   store_limit_adjust);
541
542
543 static int __init
544 thermostat_init(void)
545 {
546         struct device_node* np;
547         u32 *prop;
548         int i = 0, offset = 0;
549         
550         np = of_find_node_by_name(NULL, "fan");
551         if (!np)
552                 return -ENODEV;
553         if (device_is_compatible(np, "adt7460"))
554                 therm_type = ADT7460;
555         else if (device_is_compatible(np, "adt7467"))
556                 therm_type = ADT7467;
557         else
558                 return -ENODEV;
559
560         prop = (u32 *)get_property(np, "hwsensor-params-version", NULL);
561         printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
562                          (*prop == 1)?"":"un");
563         if (*prop != 1)
564                 return -ENODEV;
565
566         prop = (u32 *)get_property(np, "reg", NULL);
567         if (!prop)
568                 return -ENODEV;
569
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';
574         } else {
575                 therm_bus = ((*prop) >> 8) & 0x0f;
576         }
577
578         therm_address = ((*prop) & 0xff) >> 1;
579
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);
583
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;
588
589                         if (sensor_location[i] == NULL)
590                                 sensor_location[i] = "";
591
592                         printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
593                         offset += strlen(sensor_location[i]) + 1;
594                 }
595         } else {
596                 sensor_location[0] = "?";
597                 sensor_location[1] = "?";
598                 sensor_location[2] = "?";
599         }
600
601         of_dev = of_platform_device_create(np, "temperatures", NULL);
602         
603         if (of_dev == NULL) {
604                 printk(KERN_ERR "Can't register temperatures device !\n");
605                 return -ENODEV;
606         }
607         
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);
619
620 #ifndef CONFIG_I2C_KEYWEST
621         request_module("i2c-keywest");
622 #endif
623
624         return i2c_add_driver(&thermostat_driver);
625 }
626
627 static void __exit
628 thermostat_exit(void)
629 {
630         if (of_dev) {
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);
640
641                 if(therm_type == ADT7460)
642                         device_remove_file(&of_dev->dev,
643                                            &dev_attr_sensor2_fan_speed);
644
645                 of_device_unregister(of_dev);
646         }
647         i2c_del_driver(&thermostat_driver);
648 }
649
650 module_init(thermostat_init);
651 module_exit(thermostat_exit);