2 * lm90.c - Part of lm_sensors, Linux kernel modules for hardware
4 * Copyright (C) 2003-2005 Jean Delvare <khali@linux-fr.org>
6 * Based on the lm83 driver. The LM90 is a sensor chip made by National
7 * Semiconductor. It reports up to two temperatures (its own plus up to
8 * one external one) with a 0.125 deg resolution (1 deg for local
9 * temperature) and a 3-4 deg accuracy. Complete datasheet can be
10 * obtained from National's website at:
11 * http://www.national.com/pf/LM/LM90.html
13 * This driver also supports the LM89 and LM99, two other sensor chips
14 * made by National Semiconductor. Both have an increased remote
15 * temperature measurement accuracy (1 degree), and the LM99
16 * additionally shifts remote temperatures (measured and limits) by 16
17 * degrees, which allows for higher temperatures measurement. The
18 * driver doesn't handle it since it can be done easily in user-space.
19 * Complete datasheets can be obtained from National's website at:
20 * http://www.national.com/pf/LM/LM89.html
21 * http://www.national.com/pf/LM/LM99.html
22 * Note that there is no way to differentiate between both chips.
24 * This driver also supports the LM86, another sensor chip made by
25 * National Semiconductor. It is exactly similar to the LM90 except it
26 * has a higher accuracy.
27 * Complete datasheet can be obtained from National's website at:
28 * http://www.national.com/pf/LM/LM86.html
30 * This driver also supports the ADM1032, a sensor chip made by Analog
31 * Devices. That chip is similar to the LM90, with a few differences
32 * that are not handled by this driver. Complete datasheet can be
33 * obtained from Analog's website at:
34 * http://products.analog.com/products/info.asp?product=ADM1032
35 * Among others, it has a higher accuracy than the LM90, much like the
38 * This driver also supports the MAX6657, MAX6658 and MAX6659 sensor
39 * chips made by Maxim. These chips are similar to the LM86. Complete
40 * datasheet can be obtained at Maxim's website at:
41 * http://www.maxim-ic.com/quick_view2.cfm/qv_pk/2578
42 * Note that there is no easy way to differentiate between the three
43 * variants. The extra address and features of the MAX6659 are not
44 * supported by this driver.
46 * This driver also supports the ADT7461 chip from Analog Devices but
47 * only in its "compatability mode". If an ADT7461 chip is found but
48 * is configured in non-compatible mode (where its temperature
49 * register values are decoded differently) it is ignored by this
50 * driver. Complete datasheet can be obtained from Analog's website
52 * http://products.analog.com/products/info.asp?product=ADT7461
54 * Since the LM90 was the first chipset supported by this driver, most
55 * comments will refer to this chipset, but are actually general and
56 * concern all supported chipsets, unless mentioned otherwise.
58 * This program is free software; you can redistribute it and/or modify
59 * it under the terms of the GNU General Public License as published by
60 * the Free Software Foundation; either version 2 of the License, or
61 * (at your option) any later version.
63 * This program is distributed in the hope that it will be useful,
64 * but WITHOUT ANY WARRANTY; without even the implied warranty of
65 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
66 * GNU General Public License for more details.
68 * You should have received a copy of the GNU General Public License
69 * along with this program; if not, write to the Free Software
70 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
73 #include <linux/module.h>
74 #include <linux/init.h>
75 #include <linux/slab.h>
76 #include <linux/jiffies.h>
77 #include <linux/i2c.h>
78 #include <linux/i2c-sensor.h>
79 #include <linux/hwmon-sysfs.h>
80 #include <linux/hwmon.h>
81 #include <linux/err.h>
85 * Address is fully defined internally and cannot be changed except for
87 * LM86, LM89, LM90, LM99, ADM1032, MAX6657 and MAX6658 have address 0x4c.
88 * LM89-1, and LM99-1 have address 0x4d.
89 * MAX6659 can have address 0x4c, 0x4d or 0x4e (unsupported).
90 * ADT7461 always has address 0x4c.
93 static unsigned short normal_i2c[] = { 0x4c, 0x4d, I2C_CLIENT_END };
94 static unsigned int normal_isa[] = { I2C_CLIENT_ISA_END };
100 SENSORS_INSMOD_6(lm90, adm1032, lm99, lm86, max6657, adt7461);
106 #define LM90_REG_R_MAN_ID 0xFE
107 #define LM90_REG_R_CHIP_ID 0xFF
108 #define LM90_REG_R_CONFIG1 0x03
109 #define LM90_REG_W_CONFIG1 0x09
110 #define LM90_REG_R_CONFIG2 0xBF
111 #define LM90_REG_W_CONFIG2 0xBF
112 #define LM90_REG_R_CONVRATE 0x04
113 #define LM90_REG_W_CONVRATE 0x0A
114 #define LM90_REG_R_STATUS 0x02
115 #define LM90_REG_R_LOCAL_TEMP 0x00
116 #define LM90_REG_R_LOCAL_HIGH 0x05
117 #define LM90_REG_W_LOCAL_HIGH 0x0B
118 #define LM90_REG_R_LOCAL_LOW 0x06
119 #define LM90_REG_W_LOCAL_LOW 0x0C
120 #define LM90_REG_R_LOCAL_CRIT 0x20
121 #define LM90_REG_W_LOCAL_CRIT 0x20
122 #define LM90_REG_R_REMOTE_TEMPH 0x01
123 #define LM90_REG_R_REMOTE_TEMPL 0x10
124 #define LM90_REG_R_REMOTE_OFFSH 0x11
125 #define LM90_REG_W_REMOTE_OFFSH 0x11
126 #define LM90_REG_R_REMOTE_OFFSL 0x12
127 #define LM90_REG_W_REMOTE_OFFSL 0x12
128 #define LM90_REG_R_REMOTE_HIGHH 0x07
129 #define LM90_REG_W_REMOTE_HIGHH 0x0D
130 #define LM90_REG_R_REMOTE_HIGHL 0x13
131 #define LM90_REG_W_REMOTE_HIGHL 0x13
132 #define LM90_REG_R_REMOTE_LOWH 0x08
133 #define LM90_REG_W_REMOTE_LOWH 0x0E
134 #define LM90_REG_R_REMOTE_LOWL 0x14
135 #define LM90_REG_W_REMOTE_LOWL 0x14
136 #define LM90_REG_R_REMOTE_CRIT 0x19
137 #define LM90_REG_W_REMOTE_CRIT 0x19
138 #define LM90_REG_R_TCRIT_HYST 0x21
139 #define LM90_REG_W_TCRIT_HYST 0x21
142 * Conversions and various macros
143 * For local temperatures and limits, critical limits and the hysteresis
144 * value, the LM90 uses signed 8-bit values with LSB = 1 degree Celsius.
145 * For remote temperatures and limits, it uses signed 11-bit values with
146 * LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
149 #define TEMP1_FROM_REG(val) ((val) * 1000)
150 #define TEMP1_TO_REG(val) ((val) <= -128000 ? -128 : \
151 (val) >= 127000 ? 127 : \
152 (val) < 0 ? ((val) - 500) / 1000 : \
153 ((val) + 500) / 1000)
154 #define TEMP2_FROM_REG(val) ((val) / 32 * 125)
155 #define TEMP2_TO_REG(val) ((val) <= -128000 ? 0x8000 : \
156 (val) >= 127875 ? 0x7FE0 : \
157 (val) < 0 ? ((val) - 62) / 125 * 32 : \
158 ((val) + 62) / 125 * 32)
159 #define HYST_TO_REG(val) ((val) <= 0 ? 0 : (val) >= 30500 ? 31 : \
160 ((val) + 500) / 1000)
163 * ADT7461 is almost identical to LM90 except that attempts to write
164 * values that are outside the range 0 < temp < 127 are treated as
165 * the boundary value.
168 #define TEMP1_TO_REG_ADT7461(val) ((val) <= 0 ? 0 : \
169 (val) >= 127000 ? 127 : \
170 ((val) + 500) / 1000)
171 #define TEMP2_TO_REG_ADT7461(val) ((val) <= 0 ? 0 : \
172 (val) >= 127750 ? 0x7FC0 : \
173 ((val) + 125) / 250 * 64)
176 * Functions declaration
179 static int lm90_attach_adapter(struct i2c_adapter *adapter);
180 static int lm90_detect(struct i2c_adapter *adapter, int address,
182 static void lm90_init_client(struct i2c_client *client);
183 static int lm90_detach_client(struct i2c_client *client);
184 static struct lm90_data *lm90_update_device(struct device *dev);
187 * Driver data (common to all clients)
190 static struct i2c_driver lm90_driver = {
191 .owner = THIS_MODULE,
193 .id = I2C_DRIVERID_LM90,
194 .flags = I2C_DF_NOTIFY,
195 .attach_adapter = lm90_attach_adapter,
196 .detach_client = lm90_detach_client,
200 * Client data (each client gets its own)
204 struct i2c_client client;
205 struct class_device *class_dev;
206 struct semaphore update_lock;
207 char valid; /* zero until following fields are valid */
208 unsigned long last_updated; /* in jiffies */
211 /* registers values */
212 s8 temp8[5]; /* 0: local input
215 3: local critical limit
216 4: remote critical limit */
217 s16 temp11[3]; /* 0: remote input
219 2: remote high limit */
221 u8 alarms; /* bitvector */
228 static ssize_t show_temp8(struct device *dev, struct device_attribute *devattr,
231 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
232 struct lm90_data *data = lm90_update_device(dev);
233 return sprintf(buf, "%d\n", TEMP1_FROM_REG(data->temp8[attr->index]));
236 static ssize_t set_temp8(struct device *dev, struct device_attribute *devattr,
237 const char *buf, size_t count)
239 static const u8 reg[4] = {
240 LM90_REG_W_LOCAL_LOW,
241 LM90_REG_W_LOCAL_HIGH,
242 LM90_REG_W_LOCAL_CRIT,
243 LM90_REG_W_REMOTE_CRIT,
246 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
247 struct i2c_client *client = to_i2c_client(dev);
248 struct lm90_data *data = i2c_get_clientdata(client);
249 long val = simple_strtol(buf, NULL, 10);
250 int nr = attr->index;
252 down(&data->update_lock);
253 if (data->kind == adt7461)
254 data->temp8[nr] = TEMP1_TO_REG_ADT7461(val);
256 data->temp8[nr] = TEMP1_TO_REG(val);
257 i2c_smbus_write_byte_data(client, reg[nr - 1], data->temp8[nr]);
258 up(&data->update_lock);
262 static ssize_t show_temp11(struct device *dev, struct device_attribute *devattr,
265 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
266 struct lm90_data *data = lm90_update_device(dev);
267 return sprintf(buf, "%d\n", TEMP2_FROM_REG(data->temp11[attr->index]));
270 static ssize_t set_temp11(struct device *dev, struct device_attribute *devattr,
271 const char *buf, size_t count)
273 static const u8 reg[4] = {
274 LM90_REG_W_REMOTE_LOWH,
275 LM90_REG_W_REMOTE_LOWL,
276 LM90_REG_W_REMOTE_HIGHH,
277 LM90_REG_W_REMOTE_HIGHL,
280 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
281 struct i2c_client *client = to_i2c_client(dev);
282 struct lm90_data *data = i2c_get_clientdata(client);
283 long val = simple_strtol(buf, NULL, 10);
284 int nr = attr->index;
286 down(&data->update_lock);
287 if (data->kind == adt7461)
288 data->temp11[nr] = TEMP2_TO_REG_ADT7461(val);
290 data->temp11[nr] = TEMP2_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 up(&data->update_lock);
299 static ssize_t show_temphyst(struct device *dev, struct device_attribute *devattr,
302 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
303 struct lm90_data *data = lm90_update_device(dev);
304 return sprintf(buf, "%d\n", TEMP1_FROM_REG(data->temp8[attr->index])
305 - TEMP1_FROM_REG(data->temp_hyst));
308 static ssize_t set_temphyst(struct device *dev, struct device_attribute *dummy,
309 const char *buf, size_t count)
311 struct i2c_client *client = to_i2c_client(dev);
312 struct lm90_data *data = i2c_get_clientdata(client);
313 long val = simple_strtol(buf, NULL, 10);
316 down(&data->update_lock);
317 hyst = TEMP1_FROM_REG(data->temp8[3]) - val;
318 i2c_smbus_write_byte_data(client, LM90_REG_W_TCRIT_HYST,
320 up(&data->update_lock);
324 static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy,
327 struct lm90_data *data = lm90_update_device(dev);
328 return sprintf(buf, "%d\n", data->alarms);
331 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp8, NULL, 0);
332 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp11, NULL, 0);
333 static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp8,
335 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp11,
337 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp8,
339 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp11,
341 static SENSOR_DEVICE_ATTR(temp1_crit, S_IWUSR | S_IRUGO, show_temp8,
343 static SENSOR_DEVICE_ATTR(temp2_crit, S_IWUSR | S_IRUGO, show_temp8,
345 static SENSOR_DEVICE_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO, show_temphyst,
347 static SENSOR_DEVICE_ATTR(temp2_crit_hyst, S_IRUGO, show_temphyst, NULL, 4);
348 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
354 static int lm90_attach_adapter(struct i2c_adapter *adapter)
356 if (!(adapter->class & I2C_CLASS_HWMON))
358 return i2c_detect(adapter, &addr_data, lm90_detect);
362 * The following function does more than just detection. If detection
363 * succeeds, it also registers the new chip.
365 static int lm90_detect(struct i2c_adapter *adapter, int address, int kind)
367 struct i2c_client *new_client;
368 struct lm90_data *data;
370 const char *name = "";
372 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
375 if (!(data = kmalloc(sizeof(struct lm90_data), GFP_KERNEL))) {
379 memset(data, 0, sizeof(struct lm90_data));
381 /* The common I2C client data is placed right before the
382 LM90-specific data. */
383 new_client = &data->client;
384 i2c_set_clientdata(new_client, data);
385 new_client->addr = address;
386 new_client->adapter = adapter;
387 new_client->driver = &lm90_driver;
388 new_client->flags = 0;
391 * Now we do the remaining detection. A negative kind means that
392 * the driver was loaded with no force parameter (default), so we
393 * must both detect and identify the chip. A zero kind means that
394 * the driver was loaded with the force parameter, the detection
395 * step shall be skipped. A positive kind means that the driver
396 * was loaded with the force parameter and a given kind of chip is
397 * requested, so both the detection and the identification steps
401 /* Default to an LM90 if forced */
405 if (kind < 0) { /* detection and identification */
406 u8 man_id, chip_id, reg_config1, reg_convrate;
408 man_id = i2c_smbus_read_byte_data(new_client,
410 chip_id = i2c_smbus_read_byte_data(new_client,
412 reg_config1 = i2c_smbus_read_byte_data(new_client,
414 reg_convrate = i2c_smbus_read_byte_data(new_client,
415 LM90_REG_R_CONVRATE);
417 if (man_id == 0x01) { /* National Semiconductor */
420 reg_config2 = i2c_smbus_read_byte_data(new_client,
423 if ((reg_config1 & 0x2A) == 0x00
424 && (reg_config2 & 0xF8) == 0x00
425 && reg_convrate <= 0x09) {
427 && (chip_id & 0xF0) == 0x20) { /* LM90 */
430 if ((chip_id & 0xF0) == 0x30) { /* LM89/LM99 */
434 && (chip_id & 0xF0) == 0x10) { /* LM86 */
439 if (man_id == 0x41) { /* Analog Devices */
441 && (chip_id & 0xF0) == 0x40 /* ADM1032 */
442 && (reg_config1 & 0x3F) == 0x00
443 && reg_convrate <= 0x0A) {
447 && chip_id == 0x51 /* ADT7461 */
448 && (reg_config1 & 0x1F) == 0x00 /* check compat mode */
449 && reg_convrate <= 0x0A) {
453 if (man_id == 0x4D) { /* Maxim */
455 * The Maxim variants do NOT have a chip_id register.
456 * Reading from that address will return the last read
457 * value, which in our case is those of the man_id
458 * register. Likewise, the config1 register seems to
459 * lack a low nibble, so the value will be those of the
460 * previous read, so in our case those of the man_id
463 if (chip_id == man_id
464 && (reg_config1 & 0x1F) == (man_id & 0x0F)
465 && reg_convrate <= 0x09) {
470 if (kind <= 0) { /* identification failed */
471 dev_info(&adapter->dev,
472 "Unsupported chip (man_id=0x%02X, "
473 "chip_id=0x%02X).\n", man_id, chip_id);
480 } else if (kind == adm1032) {
482 } else if (kind == lm99) {
484 } else if (kind == lm86) {
486 } else if (kind == max6657) {
488 } else if (kind == adt7461) {
492 /* We can fill in the remaining client fields */
493 strlcpy(new_client->name, name, I2C_NAME_SIZE);
496 init_MUTEX(&data->update_lock);
498 /* Tell the I2C layer a new client has arrived */
499 if ((err = i2c_attach_client(new_client)))
502 /* Initialize the LM90 chip */
503 lm90_init_client(new_client);
505 /* Register sysfs hooks */
506 data->class_dev = hwmon_device_register(&new_client->dev);
507 if (IS_ERR(data->class_dev)) {
508 err = PTR_ERR(data->class_dev);
512 device_create_file(&new_client->dev,
513 &sensor_dev_attr_temp1_input.dev_attr);
514 device_create_file(&new_client->dev,
515 &sensor_dev_attr_temp2_input.dev_attr);
516 device_create_file(&new_client->dev,
517 &sensor_dev_attr_temp1_min.dev_attr);
518 device_create_file(&new_client->dev,
519 &sensor_dev_attr_temp2_min.dev_attr);
520 device_create_file(&new_client->dev,
521 &sensor_dev_attr_temp1_max.dev_attr);
522 device_create_file(&new_client->dev,
523 &sensor_dev_attr_temp2_max.dev_attr);
524 device_create_file(&new_client->dev,
525 &sensor_dev_attr_temp1_crit.dev_attr);
526 device_create_file(&new_client->dev,
527 &sensor_dev_attr_temp2_crit.dev_attr);
528 device_create_file(&new_client->dev,
529 &sensor_dev_attr_temp1_crit_hyst.dev_attr);
530 device_create_file(&new_client->dev,
531 &sensor_dev_attr_temp2_crit_hyst.dev_attr);
532 device_create_file(&new_client->dev, &dev_attr_alarms);
537 i2c_detach_client(new_client);
544 static void lm90_init_client(struct i2c_client *client)
549 * Start the conversions.
551 i2c_smbus_write_byte_data(client, LM90_REG_W_CONVRATE,
553 config = i2c_smbus_read_byte_data(client, LM90_REG_R_CONFIG1);
555 i2c_smbus_write_byte_data(client, LM90_REG_W_CONFIG1,
556 config & 0xBF); /* run */
559 static int lm90_detach_client(struct i2c_client *client)
561 struct lm90_data *data = i2c_get_clientdata(client);
564 hwmon_device_unregister(data->class_dev);
566 if ((err = i2c_detach_client(client))) {
567 dev_err(&client->dev, "Client deregistration failed, "
568 "client not detached.\n");
576 static struct lm90_data *lm90_update_device(struct device *dev)
578 struct i2c_client *client = to_i2c_client(dev);
579 struct lm90_data *data = i2c_get_clientdata(client);
581 down(&data->update_lock);
583 if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
586 dev_dbg(&client->dev, "Updating lm90 data.\n");
587 data->temp8[0] = i2c_smbus_read_byte_data(client,
588 LM90_REG_R_LOCAL_TEMP);
589 data->temp8[1] = i2c_smbus_read_byte_data(client,
590 LM90_REG_R_LOCAL_LOW);
591 data->temp8[2] = i2c_smbus_read_byte_data(client,
592 LM90_REG_R_LOCAL_HIGH);
593 data->temp8[3] = i2c_smbus_read_byte_data(client,
594 LM90_REG_R_LOCAL_CRIT);
595 data->temp8[4] = i2c_smbus_read_byte_data(client,
596 LM90_REG_R_REMOTE_CRIT);
597 data->temp_hyst = i2c_smbus_read_byte_data(client,
598 LM90_REG_R_TCRIT_HYST);
601 * There is a trick here. We have to read two registers to
602 * have the remote sensor temperature, but we have to beware
603 * a conversion could occur inbetween the readings. The
604 * datasheet says we should either use the one-shot
605 * conversion register, which we don't want to do (disables
606 * hardware monitoring) or monitor the busy bit, which is
607 * impossible (we can't read the values and monitor that bit
608 * at the exact same time). So the solution used here is to
609 * read the high byte once, then the low byte, then the high
610 * byte again. If the new high byte matches the old one,
611 * then we have a valid reading. Else we have to read the low
612 * byte again, and now we believe we have a correct reading.
614 oldh = i2c_smbus_read_byte_data(client,
615 LM90_REG_R_REMOTE_TEMPH);
616 data->temp11[0] = i2c_smbus_read_byte_data(client,
617 LM90_REG_R_REMOTE_TEMPL);
618 newh = i2c_smbus_read_byte_data(client,
619 LM90_REG_R_REMOTE_TEMPH);
621 data->temp11[0] = i2c_smbus_read_byte_data(client,
622 LM90_REG_R_REMOTE_TEMPL);
624 oldh = i2c_smbus_read_byte_data(client,
625 LM90_REG_R_REMOTE_TEMPH);
626 /* oldh is actually newer */
628 dev_warn(&client->dev, "Remote temperature may be "
632 data->temp11[0] |= (newh << 8);
634 data->temp11[1] = (i2c_smbus_read_byte_data(client,
635 LM90_REG_R_REMOTE_LOWH) << 8) +
636 i2c_smbus_read_byte_data(client,
637 LM90_REG_R_REMOTE_LOWL);
638 data->temp11[2] = (i2c_smbus_read_byte_data(client,
639 LM90_REG_R_REMOTE_HIGHH) << 8) +
640 i2c_smbus_read_byte_data(client,
641 LM90_REG_R_REMOTE_HIGHL);
642 data->alarms = i2c_smbus_read_byte_data(client,
645 data->last_updated = jiffies;
649 up(&data->update_lock);
654 static int __init sensors_lm90_init(void)
656 return i2c_add_driver(&lm90_driver);
659 static void __exit sensors_lm90_exit(void)
661 i2c_del_driver(&lm90_driver);
664 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
665 MODULE_DESCRIPTION("LM90/ADM1032 driver");
666 MODULE_LICENSE("GPL");
668 module_init(sensors_lm90_init);
669 module_exit(sensors_lm90_exit);