2 * lm63.c - driver for the National Semiconductor LM63 temperature sensor
3 * with integrated fan control
4 * Copyright (C) 2004-2005 Jean Delvare <khali@linux-fr.org>
5 * Based on the lm90 driver.
7 * The LM63 is a sensor chip made by National Semiconductor. It measures
8 * two temperatures (its own and one external one) and the speed of one
9 * fan, those speed it can additionally control. Complete datasheet can be
10 * obtained from National's website at:
11 * http://www.national.com/pf/LM/LM63.html
13 * The LM63 is basically an LM86 with fan speed monitoring and control
14 * capabilities added. It misses some of the LM86 features though:
15 * - No low limit for local temperature.
16 * - No critical limit for local temperature.
17 * - Critical limit for remote temperature can be changed only once. We
18 * will consider that the critical limit is read-only.
20 * The datasheet isn't very clear about what the tachometer reading is.
21 * I had a explanation from National Semiconductor though. The two lower
22 * bits of the read value have to be masked out. The value is still 16 bit
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
40 #include <linux/module.h>
41 #include <linux/init.h>
42 #include <linux/slab.h>
43 #include <linux/jiffies.h>
44 #include <linux/i2c.h>
45 #include <linux/i2c-sensor.h>
46 #include <linux/hwmon-sysfs.h>
47 #include <linux/hwmon.h>
48 #include <linux/err.h>
52 * Address is fully defined internally and cannot be changed.
55 static unsigned short normal_i2c
[] = { 0x4c, I2C_CLIENT_END
};
61 SENSORS_INSMOD_1(lm63
);
67 #define LM63_REG_CONFIG1 0x03
68 #define LM63_REG_CONFIG2 0xBF
69 #define LM63_REG_CONFIG_FAN 0x4A
71 #define LM63_REG_TACH_COUNT_MSB 0x47
72 #define LM63_REG_TACH_COUNT_LSB 0x46
73 #define LM63_REG_TACH_LIMIT_MSB 0x49
74 #define LM63_REG_TACH_LIMIT_LSB 0x48
76 #define LM63_REG_PWM_VALUE 0x4C
77 #define LM63_REG_PWM_FREQ 0x4D
79 #define LM63_REG_LOCAL_TEMP 0x00
80 #define LM63_REG_LOCAL_HIGH 0x05
82 #define LM63_REG_REMOTE_TEMP_MSB 0x01
83 #define LM63_REG_REMOTE_TEMP_LSB 0x10
84 #define LM63_REG_REMOTE_OFFSET_MSB 0x11
85 #define LM63_REG_REMOTE_OFFSET_LSB 0x12
86 #define LM63_REG_REMOTE_HIGH_MSB 0x07
87 #define LM63_REG_REMOTE_HIGH_LSB 0x13
88 #define LM63_REG_REMOTE_LOW_MSB 0x08
89 #define LM63_REG_REMOTE_LOW_LSB 0x14
90 #define LM63_REG_REMOTE_TCRIT 0x19
91 #define LM63_REG_REMOTE_TCRIT_HYST 0x21
93 #define LM63_REG_ALERT_STATUS 0x02
94 #define LM63_REG_ALERT_MASK 0x16
96 #define LM63_REG_MAN_ID 0xFE
97 #define LM63_REG_CHIP_ID 0xFF
100 * Conversions and various macros
101 * For tachometer counts, the LM63 uses 16-bit values.
102 * For local temperature and high limit, remote critical limit and hysteresis
103 * value, it uses signed 8-bit values with LSB = 1 degree Celsius.
104 * For remote temperature, low and high limits, it uses signed 11-bit values
105 * with LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
108 #define FAN_FROM_REG(reg) ((reg) == 0xFFFC || (reg) == 0 ? 0 : \
110 #define FAN_TO_REG(val) ((val) <= 82 ? 0xFFFC : \
111 (5400000 / (val)) & 0xFFFC)
112 #define TEMP8_FROM_REG(reg) ((reg) * 1000)
113 #define TEMP8_TO_REG(val) ((val) <= -128000 ? -128 : \
114 (val) >= 127000 ? 127 : \
115 (val) < 0 ? ((val) - 500) / 1000 : \
116 ((val) + 500) / 1000)
117 #define TEMP11_FROM_REG(reg) ((reg) / 32 * 125)
118 #define TEMP11_TO_REG(val) ((val) <= -128000 ? 0x8000 : \
119 (val) >= 127875 ? 0x7FE0 : \
120 (val) < 0 ? ((val) - 62) / 125 * 32 : \
121 ((val) + 62) / 125 * 32)
122 #define HYST_TO_REG(val) ((val) <= 0 ? 0 : \
123 (val) >= 127000 ? 127 : \
124 ((val) + 500) / 1000)
127 * Functions declaration
130 static int lm63_attach_adapter(struct i2c_adapter
*adapter
);
131 static int lm63_detach_client(struct i2c_client
*client
);
133 static struct lm63_data
*lm63_update_device(struct device
*dev
);
135 static int lm63_detect(struct i2c_adapter
*adapter
, int address
, int kind
);
136 static void lm63_init_client(struct i2c_client
*client
);
139 * Driver data (common to all clients)
142 static struct i2c_driver lm63_driver
= {
143 .owner
= THIS_MODULE
,
145 .flags
= I2C_DF_NOTIFY
,
146 .attach_adapter
= lm63_attach_adapter
,
147 .detach_client
= lm63_detach_client
,
151 * Client data (each client gets its own)
155 struct i2c_client client
;
156 struct class_device
*class_dev
;
157 struct semaphore update_lock
;
158 char valid
; /* zero until following fields are valid */
159 unsigned long last_updated
; /* in jiffies */
161 /* registers values */
162 u8 config
, config_fan
;
163 u16 fan
[2]; /* 0: input
167 s8 temp8
[3]; /* 0: local input
169 2: remote critical limit */
170 s16 temp11
[3]; /* 0: remote input
172 2: remote high limit */
178 * Sysfs callback functions and files
181 static ssize_t
show_fan(struct device
*dev
, struct device_attribute
*devattr
,
184 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
185 struct lm63_data
*data
= lm63_update_device(dev
);
186 return sprintf(buf
, "%d\n", FAN_FROM_REG(data
->fan
[attr
->index
]));
189 static ssize_t
set_fan(struct device
*dev
, struct device_attribute
*dummy
,
190 const char *buf
, size_t count
)
192 struct i2c_client
*client
= to_i2c_client(dev
);
193 struct lm63_data
*data
= i2c_get_clientdata(client
);
194 unsigned long val
= simple_strtoul(buf
, NULL
, 10);
196 down(&data
->update_lock
);
197 data
->fan
[1] = FAN_TO_REG(val
);
198 i2c_smbus_write_byte_data(client
, LM63_REG_TACH_LIMIT_LSB
,
199 data
->fan
[1] & 0xFF);
200 i2c_smbus_write_byte_data(client
, LM63_REG_TACH_LIMIT_MSB
,
202 up(&data
->update_lock
);
206 static ssize_t
show_pwm1(struct device
*dev
, struct device_attribute
*dummy
,
209 struct lm63_data
*data
= lm63_update_device(dev
);
210 return sprintf(buf
, "%d\n", data
->pwm1_value
>= 2 * data
->pwm1_freq
?
211 255 : (data
->pwm1_value
* 255 + data
->pwm1_freq
) /
212 (2 * data
->pwm1_freq
));
215 static ssize_t
set_pwm1(struct device
*dev
, struct device_attribute
*dummy
,
216 const char *buf
, size_t count
)
218 struct i2c_client
*client
= to_i2c_client(dev
);
219 struct lm63_data
*data
= i2c_get_clientdata(client
);
222 if (!(data
->config_fan
& 0x20)) /* register is read-only */
225 val
= simple_strtoul(buf
, NULL
, 10);
226 down(&data
->update_lock
);
227 data
->pwm1_value
= val
<= 0 ? 0 :
228 val
>= 255 ? 2 * data
->pwm1_freq
:
229 (val
* data
->pwm1_freq
* 2 + 127) / 255;
230 i2c_smbus_write_byte_data(client
, LM63_REG_PWM_VALUE
, data
->pwm1_value
);
231 up(&data
->update_lock
);
235 static ssize_t
show_pwm1_enable(struct device
*dev
, struct device_attribute
*dummy
,
238 struct lm63_data
*data
= lm63_update_device(dev
);
239 return sprintf(buf
, "%d\n", data
->config_fan
& 0x20 ? 1 : 2);
242 static ssize_t
show_temp8(struct device
*dev
, struct device_attribute
*devattr
,
245 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
246 struct lm63_data
*data
= lm63_update_device(dev
);
247 return sprintf(buf
, "%d\n", TEMP8_FROM_REG(data
->temp8
[attr
->index
]));
250 static ssize_t
set_temp8(struct device
*dev
, struct device_attribute
*dummy
,
251 const char *buf
, size_t count
)
253 struct i2c_client
*client
= to_i2c_client(dev
);
254 struct lm63_data
*data
= i2c_get_clientdata(client
);
255 long val
= simple_strtol(buf
, NULL
, 10);
257 down(&data
->update_lock
);
258 data
->temp8
[1] = TEMP8_TO_REG(val
);
259 i2c_smbus_write_byte_data(client
, LM63_REG_LOCAL_HIGH
, data
->temp8
[1]);
260 up(&data
->update_lock
);
264 static ssize_t
show_temp11(struct device
*dev
, struct device_attribute
*devattr
,
267 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
268 struct lm63_data
*data
= lm63_update_device(dev
);
269 return sprintf(buf
, "%d\n", TEMP11_FROM_REG(data
->temp11
[attr
->index
]));
272 static ssize_t
set_temp11(struct device
*dev
, struct device_attribute
*devattr
,
273 const char *buf
, size_t count
)
275 static const u8 reg
[4] = {
276 LM63_REG_REMOTE_LOW_MSB
,
277 LM63_REG_REMOTE_LOW_LSB
,
278 LM63_REG_REMOTE_HIGH_MSB
,
279 LM63_REG_REMOTE_HIGH_LSB
,
282 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
283 struct i2c_client
*client
= to_i2c_client(dev
);
284 struct lm63_data
*data
= i2c_get_clientdata(client
);
285 long val
= simple_strtol(buf
, NULL
, 10);
286 int nr
= attr
->index
;
288 down(&data
->update_lock
);
289 data
->temp11
[nr
] = TEMP11_TO_REG(val
);
290 i2c_smbus_write_byte_data(client
, reg
[(nr
- 1) * 2],
291 data
->temp11
[nr
] >> 8);
292 i2c_smbus_write_byte_data(client
, reg
[(nr
- 1) * 2 + 1],
293 data
->temp11
[nr
] & 0xff);
294 up(&data
->update_lock
);
298 /* Hysteresis register holds a relative value, while we want to present
299 an absolute to user-space */
300 static ssize_t
show_temp2_crit_hyst(struct device
*dev
, struct device_attribute
*dummy
,
303 struct lm63_data
*data
= lm63_update_device(dev
);
304 return sprintf(buf
, "%d\n", TEMP8_FROM_REG(data
->temp8
[2])
305 - TEMP8_FROM_REG(data
->temp2_crit_hyst
));
308 /* And now the other way around, user-space provides an absolute
309 hysteresis value and we have to store a relative one */
310 static ssize_t
set_temp2_crit_hyst(struct device
*dev
, struct device_attribute
*dummy
,
311 const char *buf
, size_t count
)
313 struct i2c_client
*client
= to_i2c_client(dev
);
314 struct lm63_data
*data
= i2c_get_clientdata(client
);
315 long val
= simple_strtol(buf
, NULL
, 10);
318 down(&data
->update_lock
);
319 hyst
= TEMP8_FROM_REG(data
->temp8
[2]) - val
;
320 i2c_smbus_write_byte_data(client
, LM63_REG_REMOTE_TCRIT_HYST
,
322 up(&data
->update_lock
);
326 static ssize_t
show_alarms(struct device
*dev
, struct device_attribute
*dummy
,
329 struct lm63_data
*data
= lm63_update_device(dev
);
330 return sprintf(buf
, "%u\n", data
->alarms
);
333 static SENSOR_DEVICE_ATTR(fan1_input
, S_IRUGO
, show_fan
, NULL
, 0);
334 static SENSOR_DEVICE_ATTR(fan1_min
, S_IWUSR
| S_IRUGO
, show_fan
,
337 static DEVICE_ATTR(pwm1
, S_IWUSR
| S_IRUGO
, show_pwm1
, set_pwm1
);
338 static DEVICE_ATTR(pwm1_enable
, S_IRUGO
, show_pwm1_enable
, NULL
);
340 static SENSOR_DEVICE_ATTR(temp1_input
, S_IRUGO
, show_temp8
, NULL
, 0);
341 static SENSOR_DEVICE_ATTR(temp1_max
, S_IWUSR
| S_IRUGO
, show_temp8
,
344 static SENSOR_DEVICE_ATTR(temp2_input
, S_IRUGO
, show_temp11
, NULL
, 0);
345 static SENSOR_DEVICE_ATTR(temp2_min
, S_IWUSR
| S_IRUGO
, show_temp11
,
347 static SENSOR_DEVICE_ATTR(temp2_max
, S_IWUSR
| S_IRUGO
, show_temp11
,
349 static SENSOR_DEVICE_ATTR(temp2_crit
, S_IRUGO
, show_temp8
, NULL
, 2);
350 static DEVICE_ATTR(temp2_crit_hyst
, S_IWUSR
| S_IRUGO
, show_temp2_crit_hyst
,
351 set_temp2_crit_hyst
);
353 static DEVICE_ATTR(alarms
, S_IRUGO
, show_alarms
, NULL
);
359 static int lm63_attach_adapter(struct i2c_adapter
*adapter
)
361 if (!(adapter
->class & I2C_CLASS_HWMON
))
363 return i2c_detect(adapter
, &addr_data
, lm63_detect
);
367 * The following function does more than just detection. If detection
368 * succeeds, it also registers the new chip.
370 static int lm63_detect(struct i2c_adapter
*adapter
, int address
, int kind
)
372 struct i2c_client
*new_client
;
373 struct lm63_data
*data
;
376 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
))
379 if (!(data
= kmalloc(sizeof(struct lm63_data
), GFP_KERNEL
))) {
383 memset(data
, 0, sizeof(struct lm63_data
));
385 /* The common I2C client data is placed right before the
386 LM63-specific data. */
387 new_client
= &data
->client
;
388 i2c_set_clientdata(new_client
, data
);
389 new_client
->addr
= address
;
390 new_client
->adapter
= adapter
;
391 new_client
->driver
= &lm63_driver
;
392 new_client
->flags
= 0;
394 /* Default to an LM63 if forced */
398 if (kind
< 0) { /* must identify */
399 u8 man_id
, chip_id
, reg_config1
, reg_config2
;
400 u8 reg_alert_status
, reg_alert_mask
;
402 man_id
= i2c_smbus_read_byte_data(new_client
,
404 chip_id
= i2c_smbus_read_byte_data(new_client
,
406 reg_config1
= i2c_smbus_read_byte_data(new_client
,
408 reg_config2
= i2c_smbus_read_byte_data(new_client
,
410 reg_alert_status
= i2c_smbus_read_byte_data(new_client
,
411 LM63_REG_ALERT_STATUS
);
412 reg_alert_mask
= i2c_smbus_read_byte_data(new_client
,
413 LM63_REG_ALERT_MASK
);
415 if (man_id
== 0x01 /* National Semiconductor */
416 && chip_id
== 0x41 /* LM63 */
417 && (reg_config1
& 0x18) == 0x00
418 && (reg_config2
& 0xF8) == 0x00
419 && (reg_alert_status
& 0x20) == 0x00
420 && (reg_alert_mask
& 0xA4) == 0xA4) {
422 } else { /* failed */
423 dev_dbg(&adapter
->dev
, "Unsupported chip "
424 "(man_id=0x%02X, chip_id=0x%02X).\n",
430 strlcpy(new_client
->name
, "lm63", I2C_NAME_SIZE
);
432 init_MUTEX(&data
->update_lock
);
434 /* Tell the I2C layer a new client has arrived */
435 if ((err
= i2c_attach_client(new_client
)))
438 /* Initialize the LM63 chip */
439 lm63_init_client(new_client
);
441 /* Register sysfs hooks */
442 data
->class_dev
= hwmon_device_register(&new_client
->dev
);
443 if (IS_ERR(data
->class_dev
)) {
444 err
= PTR_ERR(data
->class_dev
);
448 if (data
->config
& 0x04) { /* tachometer enabled */
449 device_create_file(&new_client
->dev
,
450 &sensor_dev_attr_fan1_input
.dev_attr
);
451 device_create_file(&new_client
->dev
,
452 &sensor_dev_attr_fan1_min
.dev_attr
);
454 device_create_file(&new_client
->dev
, &dev_attr_pwm1
);
455 device_create_file(&new_client
->dev
, &dev_attr_pwm1_enable
);
456 device_create_file(&new_client
->dev
,
457 &sensor_dev_attr_temp1_input
.dev_attr
);
458 device_create_file(&new_client
->dev
,
459 &sensor_dev_attr_temp2_input
.dev_attr
);
460 device_create_file(&new_client
->dev
,
461 &sensor_dev_attr_temp2_min
.dev_attr
);
462 device_create_file(&new_client
->dev
,
463 &sensor_dev_attr_temp1_max
.dev_attr
);
464 device_create_file(&new_client
->dev
,
465 &sensor_dev_attr_temp2_max
.dev_attr
);
466 device_create_file(&new_client
->dev
,
467 &sensor_dev_attr_temp2_crit
.dev_attr
);
468 device_create_file(&new_client
->dev
, &dev_attr_temp2_crit_hyst
);
469 device_create_file(&new_client
->dev
, &dev_attr_alarms
);
474 i2c_detach_client(new_client
);
481 /* Idealy we shouldn't have to initialize anything, since the BIOS
482 should have taken care of everything */
483 static void lm63_init_client(struct i2c_client
*client
)
485 struct lm63_data
*data
= i2c_get_clientdata(client
);
487 data
->config
= i2c_smbus_read_byte_data(client
, LM63_REG_CONFIG1
);
488 data
->config_fan
= i2c_smbus_read_byte_data(client
,
489 LM63_REG_CONFIG_FAN
);
491 /* Start converting if needed */
492 if (data
->config
& 0x40) { /* standby */
493 dev_dbg(&client
->dev
, "Switching to operational mode");
494 data
->config
&= 0xA7;
495 i2c_smbus_write_byte_data(client
, LM63_REG_CONFIG1
,
499 /* We may need pwm1_freq before ever updating the client data */
500 data
->pwm1_freq
= i2c_smbus_read_byte_data(client
, LM63_REG_PWM_FREQ
);
501 if (data
->pwm1_freq
== 0)
504 /* Show some debug info about the LM63 configuration */
505 dev_dbg(&client
->dev
, "Alert/tach pin configured for %s\n",
506 (data
->config
& 0x04) ? "tachometer input" :
508 dev_dbg(&client
->dev
, "PWM clock %s kHz, output frequency %u Hz\n",
509 (data
->config_fan
& 0x08) ? "1.4" : "360",
510 ((data
->config_fan
& 0x08) ? 700 : 180000) / data
->pwm1_freq
);
511 dev_dbg(&client
->dev
, "PWM output active %s, %s mode\n",
512 (data
->config_fan
& 0x10) ? "low" : "high",
513 (data
->config_fan
& 0x20) ? "manual" : "auto");
516 static int lm63_detach_client(struct i2c_client
*client
)
518 struct lm63_data
*data
= i2c_get_clientdata(client
);
521 hwmon_device_unregister(data
->class_dev
);
523 if ((err
= i2c_detach_client(client
)))
530 static struct lm63_data
*lm63_update_device(struct device
*dev
)
532 struct i2c_client
*client
= to_i2c_client(dev
);
533 struct lm63_data
*data
= i2c_get_clientdata(client
);
535 down(&data
->update_lock
);
537 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
538 if (data
->config
& 0x04) { /* tachometer enabled */
539 /* order matters for fan1_input */
540 data
->fan
[0] = i2c_smbus_read_byte_data(client
,
541 LM63_REG_TACH_COUNT_LSB
) & 0xFC;
542 data
->fan
[0] |= i2c_smbus_read_byte_data(client
,
543 LM63_REG_TACH_COUNT_MSB
) << 8;
544 data
->fan
[1] = (i2c_smbus_read_byte_data(client
,
545 LM63_REG_TACH_LIMIT_LSB
) & 0xFC)
546 | (i2c_smbus_read_byte_data(client
,
547 LM63_REG_TACH_LIMIT_MSB
) << 8);
550 data
->pwm1_freq
= i2c_smbus_read_byte_data(client
,
552 if (data
->pwm1_freq
== 0)
554 data
->pwm1_value
= i2c_smbus_read_byte_data(client
,
557 data
->temp8
[0] = i2c_smbus_read_byte_data(client
,
558 LM63_REG_LOCAL_TEMP
);
559 data
->temp8
[1] = i2c_smbus_read_byte_data(client
,
560 LM63_REG_LOCAL_HIGH
);
562 /* order matters for temp2_input */
563 data
->temp11
[0] = i2c_smbus_read_byte_data(client
,
564 LM63_REG_REMOTE_TEMP_MSB
) << 8;
565 data
->temp11
[0] |= i2c_smbus_read_byte_data(client
,
566 LM63_REG_REMOTE_TEMP_LSB
);
567 data
->temp11
[1] = (i2c_smbus_read_byte_data(client
,
568 LM63_REG_REMOTE_LOW_MSB
) << 8)
569 | i2c_smbus_read_byte_data(client
,
570 LM63_REG_REMOTE_LOW_LSB
);
571 data
->temp11
[2] = (i2c_smbus_read_byte_data(client
,
572 LM63_REG_REMOTE_HIGH_MSB
) << 8)
573 | i2c_smbus_read_byte_data(client
,
574 LM63_REG_REMOTE_HIGH_LSB
);
575 data
->temp8
[2] = i2c_smbus_read_byte_data(client
,
576 LM63_REG_REMOTE_TCRIT
);
577 data
->temp2_crit_hyst
= i2c_smbus_read_byte_data(client
,
578 LM63_REG_REMOTE_TCRIT_HYST
);
580 data
->alarms
= i2c_smbus_read_byte_data(client
,
581 LM63_REG_ALERT_STATUS
) & 0x7F;
583 data
->last_updated
= jiffies
;
587 up(&data
->update_lock
);
592 static int __init
sensors_lm63_init(void)
594 return i2c_add_driver(&lm63_driver
);
597 static void __exit
sensors_lm63_exit(void)
599 i2c_del_driver(&lm63_driver
);
602 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
603 MODULE_DESCRIPTION("LM63 driver");
604 MODULE_LICENSE("GPL");
606 module_init(sensors_lm63_init
);
607 module_exit(sensors_lm63_exit
);