2 * lm63.c - driver for the National Semiconductor LM63 temperature sensor
3 * with integrated fan control
4 * Copyright (C) 2004-2006 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/hwmon-sysfs.h>
46 #include <linux/hwmon.h>
47 #include <linux/err.h>
48 #include <linux/mutex.h>
49 #include <linux/sysfs.h>
53 * Address is fully defined internally and cannot be changed.
56 static unsigned short normal_i2c[] = { 0x4c, I2C_CLIENT_END };
62 I2C_CLIENT_INSMOD_1(lm63);
68 #define LM63_REG_CONFIG1 0x03
69 #define LM63_REG_CONFIG2 0xBF
70 #define LM63_REG_CONFIG_FAN 0x4A
72 #define LM63_REG_TACH_COUNT_MSB 0x47
73 #define LM63_REG_TACH_COUNT_LSB 0x46
74 #define LM63_REG_TACH_LIMIT_MSB 0x49
75 #define LM63_REG_TACH_LIMIT_LSB 0x48
77 #define LM63_REG_PWM_VALUE 0x4C
78 #define LM63_REG_PWM_FREQ 0x4D
80 #define LM63_REG_LOCAL_TEMP 0x00
81 #define LM63_REG_LOCAL_HIGH 0x05
83 #define LM63_REG_REMOTE_TEMP_MSB 0x01
84 #define LM63_REG_REMOTE_TEMP_LSB 0x10
85 #define LM63_REG_REMOTE_OFFSET_MSB 0x11
86 #define LM63_REG_REMOTE_OFFSET_LSB 0x12
87 #define LM63_REG_REMOTE_HIGH_MSB 0x07
88 #define LM63_REG_REMOTE_HIGH_LSB 0x13
89 #define LM63_REG_REMOTE_LOW_MSB 0x08
90 #define LM63_REG_REMOTE_LOW_LSB 0x14
91 #define LM63_REG_REMOTE_TCRIT 0x19
92 #define LM63_REG_REMOTE_TCRIT_HYST 0x21
94 #define LM63_REG_ALERT_STATUS 0x02
95 #define LM63_REG_ALERT_MASK 0x16
97 #define LM63_REG_MAN_ID 0xFE
98 #define LM63_REG_CHIP_ID 0xFF
101 * Conversions and various macros
102 * For tachometer counts, the LM63 uses 16-bit values.
103 * For local temperature and high limit, remote critical limit and hysteresis
104 * value, it uses signed 8-bit values with LSB = 1 degree Celsius.
105 * For remote temperature, low and high limits, it uses signed 11-bit values
106 * with LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
109 #define FAN_FROM_REG(reg) ((reg) == 0xFFFC || (reg) == 0 ? 0 : \
111 #define FAN_TO_REG(val) ((val) <= 82 ? 0xFFFC : \
112 (5400000 / (val)) & 0xFFFC)
113 #define TEMP8_FROM_REG(reg) ((reg) * 1000)
114 #define TEMP8_TO_REG(val) ((val) <= -128000 ? -128 : \
115 (val) >= 127000 ? 127 : \
116 (val) < 0 ? ((val) - 500) / 1000 : \
117 ((val) + 500) / 1000)
118 #define TEMP11_FROM_REG(reg) ((reg) / 32 * 125)
119 #define TEMP11_TO_REG(val) ((val) <= -128000 ? 0x8000 : \
120 (val) >= 127875 ? 0x7FE0 : \
121 (val) < 0 ? ((val) - 62) / 125 * 32 : \
122 ((val) + 62) / 125 * 32)
123 #define HYST_TO_REG(val) ((val) <= 0 ? 0 : \
124 (val) >= 127000 ? 127 : \
125 ((val) + 500) / 1000)
128 * Functions declaration
131 static int lm63_attach_adapter(struct i2c_adapter *adapter);
132 static int lm63_detach_client(struct i2c_client *client);
134 static struct lm63_data *lm63_update_device(struct device *dev);
136 static int lm63_detect(struct i2c_adapter *adapter, int address, int kind);
137 static void lm63_init_client(struct i2c_client *client);
140 * Driver data (common to all clients)
143 static struct i2c_driver lm63_driver = {
147 .attach_adapter = lm63_attach_adapter,
148 .detach_client = lm63_detach_client,
152 * Client data (each client gets its own)
156 struct i2c_client client;
157 struct class_device *class_dev;
158 struct mutex update_lock;
159 char valid; /* zero until following fields are valid */
160 unsigned long last_updated; /* in jiffies */
162 /* registers values */
163 u8 config, config_fan;
164 u16 fan[2]; /* 0: input
168 s8 temp8[3]; /* 0: local input
170 2: remote critical limit */
171 s16 temp11[3]; /* 0: remote input
173 2: remote high limit */
179 * Sysfs callback functions and files
182 static ssize_t show_fan(struct device *dev, struct device_attribute *devattr,
185 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
186 struct lm63_data *data = lm63_update_device(dev);
187 return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[attr->index]));
190 static ssize_t set_fan(struct device *dev, struct device_attribute *dummy,
191 const char *buf, size_t count)
193 struct i2c_client *client = to_i2c_client(dev);
194 struct lm63_data *data = i2c_get_clientdata(client);
195 unsigned long val = simple_strtoul(buf, NULL, 10);
197 mutex_lock(&data->update_lock);
198 data->fan[1] = FAN_TO_REG(val);
199 i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_LSB,
200 data->fan[1] & 0xFF);
201 i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_MSB,
203 mutex_unlock(&data->update_lock);
207 static ssize_t show_pwm1(struct device *dev, struct device_attribute *dummy,
210 struct lm63_data *data = lm63_update_device(dev);
211 return sprintf(buf, "%d\n", data->pwm1_value >= 2 * data->pwm1_freq ?
212 255 : (data->pwm1_value * 255 + data->pwm1_freq) /
213 (2 * data->pwm1_freq));
216 static ssize_t set_pwm1(struct device *dev, struct device_attribute *dummy,
217 const char *buf, size_t count)
219 struct i2c_client *client = to_i2c_client(dev);
220 struct lm63_data *data = i2c_get_clientdata(client);
223 if (!(data->config_fan & 0x20)) /* register is read-only */
226 val = simple_strtoul(buf, NULL, 10);
227 mutex_lock(&data->update_lock);
228 data->pwm1_value = val <= 0 ? 0 :
229 val >= 255 ? 2 * data->pwm1_freq :
230 (val * data->pwm1_freq * 2 + 127) / 255;
231 i2c_smbus_write_byte_data(client, LM63_REG_PWM_VALUE, data->pwm1_value);
232 mutex_unlock(&data->update_lock);
236 static ssize_t show_pwm1_enable(struct device *dev, struct device_attribute *dummy,
239 struct lm63_data *data = lm63_update_device(dev);
240 return sprintf(buf, "%d\n", data->config_fan & 0x20 ? 1 : 2);
243 static ssize_t show_temp8(struct device *dev, struct device_attribute *devattr,
246 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
247 struct lm63_data *data = lm63_update_device(dev);
248 return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[attr->index]));
251 static ssize_t set_temp8(struct device *dev, struct device_attribute *dummy,
252 const char *buf, size_t count)
254 struct i2c_client *client = to_i2c_client(dev);
255 struct lm63_data *data = i2c_get_clientdata(client);
256 long val = simple_strtol(buf, NULL, 10);
258 mutex_lock(&data->update_lock);
259 data->temp8[1] = TEMP8_TO_REG(val);
260 i2c_smbus_write_byte_data(client, LM63_REG_LOCAL_HIGH, data->temp8[1]);
261 mutex_unlock(&data->update_lock);
265 static ssize_t show_temp11(struct device *dev, struct device_attribute *devattr,
268 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
269 struct lm63_data *data = lm63_update_device(dev);
270 return sprintf(buf, "%d\n", TEMP11_FROM_REG(data->temp11[attr->index]));
273 static ssize_t set_temp11(struct device *dev, struct device_attribute *devattr,
274 const char *buf, size_t count)
276 static const u8 reg[4] = {
277 LM63_REG_REMOTE_LOW_MSB,
278 LM63_REG_REMOTE_LOW_LSB,
279 LM63_REG_REMOTE_HIGH_MSB,
280 LM63_REG_REMOTE_HIGH_LSB,
283 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
284 struct i2c_client *client = to_i2c_client(dev);
285 struct lm63_data *data = i2c_get_clientdata(client);
286 long val = simple_strtol(buf, NULL, 10);
287 int nr = attr->index;
289 mutex_lock(&data->update_lock);
290 data->temp11[nr] = TEMP11_TO_REG(val);
291 i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2],
292 data->temp11[nr] >> 8);
293 i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2 + 1],
294 data->temp11[nr] & 0xff);
295 mutex_unlock(&data->update_lock);
299 /* Hysteresis register holds a relative value, while we want to present
300 an absolute to user-space */
301 static ssize_t show_temp2_crit_hyst(struct device *dev, struct device_attribute *dummy,
304 struct lm63_data *data = lm63_update_device(dev);
305 return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[2])
306 - TEMP8_FROM_REG(data->temp2_crit_hyst));
309 /* And now the other way around, user-space provides an absolute
310 hysteresis value and we have to store a relative one */
311 static ssize_t set_temp2_crit_hyst(struct device *dev, struct device_attribute *dummy,
312 const char *buf, size_t count)
314 struct i2c_client *client = to_i2c_client(dev);
315 struct lm63_data *data = i2c_get_clientdata(client);
316 long val = simple_strtol(buf, NULL, 10);
319 mutex_lock(&data->update_lock);
320 hyst = TEMP8_FROM_REG(data->temp8[2]) - val;
321 i2c_smbus_write_byte_data(client, LM63_REG_REMOTE_TCRIT_HYST,
323 mutex_unlock(&data->update_lock);
327 static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy,
330 struct lm63_data *data = lm63_update_device(dev);
331 return sprintf(buf, "%u\n", data->alarms);
334 static ssize_t show_alarm(struct device *dev, struct device_attribute *devattr,
337 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
338 struct lm63_data *data = lm63_update_device(dev);
339 int bitnr = attr->index;
341 return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
344 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
345 static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR | S_IRUGO, show_fan,
348 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, show_pwm1, set_pwm1);
349 static DEVICE_ATTR(pwm1_enable, S_IRUGO, show_pwm1_enable, NULL);
351 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp8, NULL, 0);
352 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp8,
355 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp11, NULL, 0);
356 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp11,
358 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp11,
360 static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_temp8, NULL, 2);
361 static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp2_crit_hyst,
362 set_temp2_crit_hyst);
364 /* Individual alarm files */
365 static SENSOR_DEVICE_ATTR(fan1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
366 static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
367 static SENSOR_DEVICE_ATTR(temp2_input_fault, S_IRUGO, show_alarm, NULL, 2);
368 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
369 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
370 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
371 /* Raw alarm file for compatibility */
372 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
374 static struct attribute *lm63_attributes[] = {
376 &dev_attr_pwm1_enable.attr,
377 &sensor_dev_attr_temp1_input.dev_attr.attr,
378 &sensor_dev_attr_temp2_input.dev_attr.attr,
379 &sensor_dev_attr_temp2_min.dev_attr.attr,
380 &sensor_dev_attr_temp1_max.dev_attr.attr,
381 &sensor_dev_attr_temp2_max.dev_attr.attr,
382 &sensor_dev_attr_temp2_crit.dev_attr.attr,
383 &dev_attr_temp2_crit_hyst.attr,
385 &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
386 &sensor_dev_attr_temp2_input_fault.dev_attr.attr,
387 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
388 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
389 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
390 &dev_attr_alarms.attr,
394 static const struct attribute_group lm63_group = {
395 .attrs = lm63_attributes,
398 static struct attribute *lm63_attributes_fan1[] = {
399 &sensor_dev_attr_fan1_input.dev_attr.attr,
400 &sensor_dev_attr_fan1_min.dev_attr.attr,
402 &sensor_dev_attr_fan1_min_alarm.dev_attr.attr,
406 static const struct attribute_group lm63_group_fan1 = {
407 .attrs = lm63_attributes_fan1,
414 static int lm63_attach_adapter(struct i2c_adapter *adapter)
416 if (!(adapter->class & I2C_CLASS_HWMON))
418 return i2c_probe(adapter, &addr_data, lm63_detect);
422 * The following function does more than just detection. If detection
423 * succeeds, it also registers the new chip.
425 static int lm63_detect(struct i2c_adapter *adapter, int address, int kind)
427 struct i2c_client *new_client;
428 struct lm63_data *data;
431 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
434 if (!(data = kzalloc(sizeof(struct lm63_data), GFP_KERNEL))) {
439 /* The common I2C client data is placed right before the
440 LM63-specific data. */
441 new_client = &data->client;
442 i2c_set_clientdata(new_client, data);
443 new_client->addr = address;
444 new_client->adapter = adapter;
445 new_client->driver = &lm63_driver;
446 new_client->flags = 0;
448 /* Default to an LM63 if forced */
452 if (kind < 0) { /* must identify */
453 u8 man_id, chip_id, reg_config1, reg_config2;
454 u8 reg_alert_status, reg_alert_mask;
456 man_id = i2c_smbus_read_byte_data(new_client,
458 chip_id = i2c_smbus_read_byte_data(new_client,
460 reg_config1 = i2c_smbus_read_byte_data(new_client,
462 reg_config2 = i2c_smbus_read_byte_data(new_client,
464 reg_alert_status = i2c_smbus_read_byte_data(new_client,
465 LM63_REG_ALERT_STATUS);
466 reg_alert_mask = i2c_smbus_read_byte_data(new_client,
467 LM63_REG_ALERT_MASK);
469 if (man_id == 0x01 /* National Semiconductor */
470 && chip_id == 0x41 /* LM63 */
471 && (reg_config1 & 0x18) == 0x00
472 && (reg_config2 & 0xF8) == 0x00
473 && (reg_alert_status & 0x20) == 0x00
474 && (reg_alert_mask & 0xA4) == 0xA4) {
476 } else { /* failed */
477 dev_dbg(&adapter->dev, "Unsupported chip "
478 "(man_id=0x%02X, chip_id=0x%02X).\n",
484 strlcpy(new_client->name, "lm63", I2C_NAME_SIZE);
486 mutex_init(&data->update_lock);
488 /* Tell the I2C layer a new client has arrived */
489 if ((err = i2c_attach_client(new_client)))
492 /* Initialize the LM63 chip */
493 lm63_init_client(new_client);
495 /* Register sysfs hooks */
496 if ((err = sysfs_create_group(&new_client->dev.kobj,
499 if (data->config & 0x04) { /* tachometer enabled */
500 if ((err = sysfs_create_group(&new_client->dev.kobj,
502 goto exit_remove_files;
505 data->class_dev = hwmon_device_register(&new_client->dev);
506 if (IS_ERR(data->class_dev)) {
507 err = PTR_ERR(data->class_dev);
508 goto exit_remove_files;
514 sysfs_remove_group(&new_client->dev.kobj, &lm63_group);
515 sysfs_remove_group(&new_client->dev.kobj, &lm63_group_fan1);
517 i2c_detach_client(new_client);
524 /* Idealy we shouldn't have to initialize anything, since the BIOS
525 should have taken care of everything */
526 static void lm63_init_client(struct i2c_client *client)
528 struct lm63_data *data = i2c_get_clientdata(client);
530 data->config = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
531 data->config_fan = i2c_smbus_read_byte_data(client,
532 LM63_REG_CONFIG_FAN);
534 /* Start converting if needed */
535 if (data->config & 0x40) { /* standby */
536 dev_dbg(&client->dev, "Switching to operational mode");
537 data->config &= 0xA7;
538 i2c_smbus_write_byte_data(client, LM63_REG_CONFIG1,
542 /* We may need pwm1_freq before ever updating the client data */
543 data->pwm1_freq = i2c_smbus_read_byte_data(client, LM63_REG_PWM_FREQ);
544 if (data->pwm1_freq == 0)
547 /* Show some debug info about the LM63 configuration */
548 dev_dbg(&client->dev, "Alert/tach pin configured for %s\n",
549 (data->config & 0x04) ? "tachometer input" :
551 dev_dbg(&client->dev, "PWM clock %s kHz, output frequency %u Hz\n",
552 (data->config_fan & 0x08) ? "1.4" : "360",
553 ((data->config_fan & 0x08) ? 700 : 180000) / data->pwm1_freq);
554 dev_dbg(&client->dev, "PWM output active %s, %s mode\n",
555 (data->config_fan & 0x10) ? "low" : "high",
556 (data->config_fan & 0x20) ? "manual" : "auto");
559 static int lm63_detach_client(struct i2c_client *client)
561 struct lm63_data *data = i2c_get_clientdata(client);
564 hwmon_device_unregister(data->class_dev);
565 sysfs_remove_group(&client->dev.kobj, &lm63_group);
566 sysfs_remove_group(&client->dev.kobj, &lm63_group_fan1);
568 if ((err = i2c_detach_client(client)))
575 static struct lm63_data *lm63_update_device(struct device *dev)
577 struct i2c_client *client = to_i2c_client(dev);
578 struct lm63_data *data = i2c_get_clientdata(client);
580 mutex_lock(&data->update_lock);
582 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
583 if (data->config & 0x04) { /* tachometer enabled */
584 /* order matters for fan1_input */
585 data->fan[0] = i2c_smbus_read_byte_data(client,
586 LM63_REG_TACH_COUNT_LSB) & 0xFC;
587 data->fan[0] |= i2c_smbus_read_byte_data(client,
588 LM63_REG_TACH_COUNT_MSB) << 8;
589 data->fan[1] = (i2c_smbus_read_byte_data(client,
590 LM63_REG_TACH_LIMIT_LSB) & 0xFC)
591 | (i2c_smbus_read_byte_data(client,
592 LM63_REG_TACH_LIMIT_MSB) << 8);
595 data->pwm1_freq = i2c_smbus_read_byte_data(client,
597 if (data->pwm1_freq == 0)
599 data->pwm1_value = i2c_smbus_read_byte_data(client,
602 data->temp8[0] = i2c_smbus_read_byte_data(client,
603 LM63_REG_LOCAL_TEMP);
604 data->temp8[1] = i2c_smbus_read_byte_data(client,
605 LM63_REG_LOCAL_HIGH);
607 /* order matters for temp2_input */
608 data->temp11[0] = i2c_smbus_read_byte_data(client,
609 LM63_REG_REMOTE_TEMP_MSB) << 8;
610 data->temp11[0] |= i2c_smbus_read_byte_data(client,
611 LM63_REG_REMOTE_TEMP_LSB);
612 data->temp11[1] = (i2c_smbus_read_byte_data(client,
613 LM63_REG_REMOTE_LOW_MSB) << 8)
614 | i2c_smbus_read_byte_data(client,
615 LM63_REG_REMOTE_LOW_LSB);
616 data->temp11[2] = (i2c_smbus_read_byte_data(client,
617 LM63_REG_REMOTE_HIGH_MSB) << 8)
618 | i2c_smbus_read_byte_data(client,
619 LM63_REG_REMOTE_HIGH_LSB);
620 data->temp8[2] = i2c_smbus_read_byte_data(client,
621 LM63_REG_REMOTE_TCRIT);
622 data->temp2_crit_hyst = i2c_smbus_read_byte_data(client,
623 LM63_REG_REMOTE_TCRIT_HYST);
625 data->alarms = i2c_smbus_read_byte_data(client,
626 LM63_REG_ALERT_STATUS) & 0x7F;
628 data->last_updated = jiffies;
632 mutex_unlock(&data->update_lock);
637 static int __init sensors_lm63_init(void)
639 return i2c_add_driver(&lm63_driver);
642 static void __exit sensors_lm63_exit(void)
644 i2c_del_driver(&lm63_driver);
647 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
648 MODULE_DESCRIPTION("LM63 driver");
649 MODULE_LICENSE("GPL");
651 module_init(sensors_lm63_init);
652 module_exit(sensors_lm63_exit);