3 * Copyright (C) 2007,2008 Hans de Goede <hdegoede@redhat.com>
4 * Preliminary tmp411 support by:
5 * Gabriel Konat, Sander Leget, Wouter Willems
6 * Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * Driver for the Texas Instruments TMP401 SMBUS temperature sensor IC.
26 * Note this IC is in some aspect similar to the LM90, but it has quite a
27 * few differences too, for example the local temp has a higher resolution
28 * and thus has 16 bits registers for its value and limit instead of 8 bits.
31 #include <linux/module.h>
32 #include <linux/init.h>
33 #include <linux/slab.h>
34 #include <linux/jiffies.h>
35 #include <linux/i2c.h>
36 #include <linux/hwmon.h>
37 #include <linux/hwmon-sysfs.h>
38 #include <linux/err.h>
39 #include <linux/mutex.h>
40 #include <linux/sysfs.h>
42 /* Addresses to scan */
43 static const unsigned short normal_i2c[] = { 0x4c, I2C_CLIENT_END };
45 enum chips { tmp401, tmp411 };
48 * The TMP401 registers, note some registers have different addresses for
51 #define TMP401_STATUS 0x02
52 #define TMP401_CONFIG_READ 0x03
53 #define TMP401_CONFIG_WRITE 0x09
54 #define TMP401_CONVERSION_RATE_READ 0x04
55 #define TMP401_CONVERSION_RATE_WRITE 0x0A
56 #define TMP401_TEMP_CRIT_HYST 0x21
57 #define TMP401_CONSECUTIVE_ALERT 0x22
58 #define TMP401_MANUFACTURER_ID_REG 0xFE
59 #define TMP401_DEVICE_ID_REG 0xFF
60 #define TMP411_N_FACTOR_REG 0x18
62 static const u8 TMP401_TEMP_MSB[2] = { 0x00, 0x01 };
63 static const u8 TMP401_TEMP_LSB[2] = { 0x15, 0x10 };
64 static const u8 TMP401_TEMP_LOW_LIMIT_MSB_READ[2] = { 0x06, 0x08 };
65 static const u8 TMP401_TEMP_LOW_LIMIT_MSB_WRITE[2] = { 0x0C, 0x0E };
66 static const u8 TMP401_TEMP_LOW_LIMIT_LSB[2] = { 0x17, 0x14 };
67 static const u8 TMP401_TEMP_HIGH_LIMIT_MSB_READ[2] = { 0x05, 0x07 };
68 static const u8 TMP401_TEMP_HIGH_LIMIT_MSB_WRITE[2] = { 0x0B, 0x0D };
69 static const u8 TMP401_TEMP_HIGH_LIMIT_LSB[2] = { 0x16, 0x13 };
70 /* These are called the THERM limit / hysteresis / mask in the datasheet */
71 static const u8 TMP401_TEMP_CRIT_LIMIT[2] = { 0x20, 0x19 };
73 static const u8 TMP411_TEMP_LOWEST_MSB[2] = { 0x30, 0x34 };
74 static const u8 TMP411_TEMP_LOWEST_LSB[2] = { 0x31, 0x35 };
75 static const u8 TMP411_TEMP_HIGHEST_MSB[2] = { 0x32, 0x36 };
76 static const u8 TMP411_TEMP_HIGHEST_LSB[2] = { 0x33, 0x37 };
79 #define TMP401_CONFIG_RANGE 0x04
80 #define TMP401_CONFIG_SHUTDOWN 0x40
81 #define TMP401_STATUS_LOCAL_CRIT 0x01
82 #define TMP401_STATUS_REMOTE_CRIT 0x02
83 #define TMP401_STATUS_REMOTE_OPEN 0x04
84 #define TMP401_STATUS_REMOTE_LOW 0x08
85 #define TMP401_STATUS_REMOTE_HIGH 0x10
86 #define TMP401_STATUS_LOCAL_LOW 0x20
87 #define TMP401_STATUS_LOCAL_HIGH 0x40
89 /* Manufacturer / Device ID's */
90 #define TMP401_MANUFACTURER_ID 0x55
91 #define TMP401_DEVICE_ID 0x11
92 #define TMP411_DEVICE_ID 0x12
95 * Driver data (common to all clients)
98 static const struct i2c_device_id tmp401_id[] = {
100 { "tmp411", tmp411 },
103 MODULE_DEVICE_TABLE(i2c, tmp401_id);
106 * Client data (each client gets its own)
110 struct device *hwmon_dev;
111 struct mutex update_lock;
112 char valid; /* zero until following fields are valid */
113 unsigned long last_updated; /* in jiffies */
116 /* register values */
129 * Sysfs attr show / store functions
132 static int tmp401_register_to_temp(u16 reg, u8 config)
136 if (config & TMP401_CONFIG_RANGE)
139 return (temp * 625 + 80) / 160;
142 static u16 tmp401_temp_to_register(long temp, u8 config)
144 if (config & TMP401_CONFIG_RANGE) {
145 temp = SENSORS_LIMIT(temp, -64000, 191000);
148 temp = SENSORS_LIMIT(temp, 0, 127000);
150 return (temp * 160 + 312) / 625;
153 static int tmp401_crit_register_to_temp(u8 reg, u8 config)
157 if (config & TMP401_CONFIG_RANGE)
163 static u8 tmp401_crit_temp_to_register(long temp, u8 config)
165 if (config & TMP401_CONFIG_RANGE) {
166 temp = SENSORS_LIMIT(temp, -64000, 191000);
169 temp = SENSORS_LIMIT(temp, 0, 127000);
171 return (temp + 500) / 1000;
174 static struct tmp401_data *tmp401_update_device_reg16(
175 struct i2c_client *client, struct tmp401_data *data)
179 for (i = 0; i < 2; i++) {
181 * High byte must be read first immediately followed
184 data->temp[i] = i2c_smbus_read_byte_data(client,
185 TMP401_TEMP_MSB[i]) << 8;
186 data->temp[i] |= i2c_smbus_read_byte_data(client,
188 data->temp_low[i] = i2c_smbus_read_byte_data(client,
189 TMP401_TEMP_LOW_LIMIT_MSB_READ[i]) << 8;
190 data->temp_low[i] |= i2c_smbus_read_byte_data(client,
191 TMP401_TEMP_LOW_LIMIT_LSB[i]);
192 data->temp_high[i] = i2c_smbus_read_byte_data(client,
193 TMP401_TEMP_HIGH_LIMIT_MSB_READ[i]) << 8;
194 data->temp_high[i] |= i2c_smbus_read_byte_data(client,
195 TMP401_TEMP_HIGH_LIMIT_LSB[i]);
196 data->temp_crit[i] = i2c_smbus_read_byte_data(client,
197 TMP401_TEMP_CRIT_LIMIT[i]);
199 if (data->kind == tmp411) {
200 data->temp_lowest[i] = i2c_smbus_read_byte_data(client,
201 TMP411_TEMP_LOWEST_MSB[i]) << 8;
202 data->temp_lowest[i] |= i2c_smbus_read_byte_data(
203 client, TMP411_TEMP_LOWEST_LSB[i]);
205 data->temp_highest[i] = i2c_smbus_read_byte_data(
206 client, TMP411_TEMP_HIGHEST_MSB[i]) << 8;
207 data->temp_highest[i] |= i2c_smbus_read_byte_data(
208 client, TMP411_TEMP_HIGHEST_LSB[i]);
214 static struct tmp401_data *tmp401_update_device(struct device *dev)
216 struct i2c_client *client = to_i2c_client(dev);
217 struct tmp401_data *data = i2c_get_clientdata(client);
219 mutex_lock(&data->update_lock);
221 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
222 data->status = i2c_smbus_read_byte_data(client, TMP401_STATUS);
223 data->config = i2c_smbus_read_byte_data(client,
225 tmp401_update_device_reg16(client, data);
227 data->temp_crit_hyst = i2c_smbus_read_byte_data(client,
228 TMP401_TEMP_CRIT_HYST);
230 data->last_updated = jiffies;
234 mutex_unlock(&data->update_lock);
239 static ssize_t show_temp_value(struct device *dev,
240 struct device_attribute *devattr, char *buf)
242 int index = to_sensor_dev_attr(devattr)->index;
243 struct tmp401_data *data = tmp401_update_device(dev);
245 return sprintf(buf, "%d\n",
246 tmp401_register_to_temp(data->temp[index], data->config));
249 static ssize_t show_temp_min(struct device *dev,
250 struct device_attribute *devattr, char *buf)
252 int index = to_sensor_dev_attr(devattr)->index;
253 struct tmp401_data *data = tmp401_update_device(dev);
255 return sprintf(buf, "%d\n",
256 tmp401_register_to_temp(data->temp_low[index], data->config));
259 static ssize_t show_temp_max(struct device *dev,
260 struct device_attribute *devattr, char *buf)
262 int index = to_sensor_dev_attr(devattr)->index;
263 struct tmp401_data *data = tmp401_update_device(dev);
265 return sprintf(buf, "%d\n",
266 tmp401_register_to_temp(data->temp_high[index], data->config));
269 static ssize_t show_temp_crit(struct device *dev,
270 struct device_attribute *devattr, char *buf)
272 int index = to_sensor_dev_attr(devattr)->index;
273 struct tmp401_data *data = tmp401_update_device(dev);
275 return sprintf(buf, "%d\n",
276 tmp401_crit_register_to_temp(data->temp_crit[index],
280 static ssize_t show_temp_crit_hyst(struct device *dev,
281 struct device_attribute *devattr, char *buf)
283 int temp, index = to_sensor_dev_attr(devattr)->index;
284 struct tmp401_data *data = tmp401_update_device(dev);
286 mutex_lock(&data->update_lock);
287 temp = tmp401_crit_register_to_temp(data->temp_crit[index],
289 temp -= data->temp_crit_hyst * 1000;
290 mutex_unlock(&data->update_lock);
292 return sprintf(buf, "%d\n", temp);
295 static ssize_t show_temp_lowest(struct device *dev,
296 struct device_attribute *devattr, char *buf)
298 int index = to_sensor_dev_attr(devattr)->index;
299 struct tmp401_data *data = tmp401_update_device(dev);
301 return sprintf(buf, "%d\n",
302 tmp401_register_to_temp(data->temp_lowest[index],
306 static ssize_t show_temp_highest(struct device *dev,
307 struct device_attribute *devattr, char *buf)
309 int index = to_sensor_dev_attr(devattr)->index;
310 struct tmp401_data *data = tmp401_update_device(dev);
312 return sprintf(buf, "%d\n",
313 tmp401_register_to_temp(data->temp_highest[index],
317 static ssize_t show_status(struct device *dev,
318 struct device_attribute *devattr, char *buf)
320 int mask = to_sensor_dev_attr(devattr)->index;
321 struct tmp401_data *data = tmp401_update_device(dev);
323 if (data->status & mask)
324 return sprintf(buf, "1\n");
326 return sprintf(buf, "0\n");
329 static ssize_t store_temp_min(struct device *dev, struct device_attribute
330 *devattr, const char *buf, size_t count)
332 int index = to_sensor_dev_attr(devattr)->index;
333 struct tmp401_data *data = tmp401_update_device(dev);
337 if (strict_strtol(buf, 10, &val))
340 reg = tmp401_temp_to_register(val, data->config);
342 mutex_lock(&data->update_lock);
344 i2c_smbus_write_byte_data(to_i2c_client(dev),
345 TMP401_TEMP_LOW_LIMIT_MSB_WRITE[index], reg >> 8);
346 i2c_smbus_write_byte_data(to_i2c_client(dev),
347 TMP401_TEMP_LOW_LIMIT_LSB[index], reg & 0xFF);
349 data->temp_low[index] = reg;
351 mutex_unlock(&data->update_lock);
356 static ssize_t store_temp_max(struct device *dev, struct device_attribute
357 *devattr, const char *buf, size_t count)
359 int index = to_sensor_dev_attr(devattr)->index;
360 struct tmp401_data *data = tmp401_update_device(dev);
364 if (strict_strtol(buf, 10, &val))
367 reg = tmp401_temp_to_register(val, data->config);
369 mutex_lock(&data->update_lock);
371 i2c_smbus_write_byte_data(to_i2c_client(dev),
372 TMP401_TEMP_HIGH_LIMIT_MSB_WRITE[index], reg >> 8);
373 i2c_smbus_write_byte_data(to_i2c_client(dev),
374 TMP401_TEMP_HIGH_LIMIT_LSB[index], reg & 0xFF);
376 data->temp_high[index] = reg;
378 mutex_unlock(&data->update_lock);
383 static ssize_t store_temp_crit(struct device *dev, struct device_attribute
384 *devattr, const char *buf, size_t count)
386 int index = to_sensor_dev_attr(devattr)->index;
387 struct tmp401_data *data = tmp401_update_device(dev);
391 if (strict_strtol(buf, 10, &val))
394 reg = tmp401_crit_temp_to_register(val, data->config);
396 mutex_lock(&data->update_lock);
398 i2c_smbus_write_byte_data(to_i2c_client(dev),
399 TMP401_TEMP_CRIT_LIMIT[index], reg);
401 data->temp_crit[index] = reg;
403 mutex_unlock(&data->update_lock);
408 static ssize_t store_temp_crit_hyst(struct device *dev, struct device_attribute
409 *devattr, const char *buf, size_t count)
411 int temp, index = to_sensor_dev_attr(devattr)->index;
412 struct tmp401_data *data = tmp401_update_device(dev);
416 if (strict_strtol(buf, 10, &val))
419 if (data->config & TMP401_CONFIG_RANGE)
420 val = SENSORS_LIMIT(val, -64000, 191000);
422 val = SENSORS_LIMIT(val, 0, 127000);
424 mutex_lock(&data->update_lock);
425 temp = tmp401_crit_register_to_temp(data->temp_crit[index],
427 val = SENSORS_LIMIT(val, temp - 255000, temp);
428 reg = ((temp - val) + 500) / 1000;
430 i2c_smbus_write_byte_data(to_i2c_client(dev),
431 TMP401_TEMP_CRIT_HYST, reg);
433 data->temp_crit_hyst = reg;
435 mutex_unlock(&data->update_lock);
441 * Resets the historical measurements of minimum and maximum temperatures.
442 * This is done by writing any value to any of the minimum/maximum registers
445 static ssize_t reset_temp_history(struct device *dev,
446 struct device_attribute *devattr, const char *buf, size_t count)
450 if (strict_strtol(buf, 10, &val))
454 dev_err(dev, "temp_reset_history value %ld not"
455 " supported. Use 1 to reset the history!\n", val);
458 i2c_smbus_write_byte_data(to_i2c_client(dev),
459 TMP411_TEMP_LOWEST_MSB[0], val);
464 static struct sensor_device_attribute tmp401_attr[] = {
465 SENSOR_ATTR(temp1_input, S_IRUGO, show_temp_value, NULL, 0),
466 SENSOR_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_min,
468 SENSOR_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max,
470 SENSOR_ATTR(temp1_crit, S_IWUSR | S_IRUGO, show_temp_crit,
472 SENSOR_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO, show_temp_crit_hyst,
473 store_temp_crit_hyst, 0),
474 SENSOR_ATTR(temp1_min_alarm, S_IRUGO, show_status, NULL,
475 TMP401_STATUS_LOCAL_LOW),
476 SENSOR_ATTR(temp1_max_alarm, S_IRUGO, show_status, NULL,
477 TMP401_STATUS_LOCAL_HIGH),
478 SENSOR_ATTR(temp1_crit_alarm, S_IRUGO, show_status, NULL,
479 TMP401_STATUS_LOCAL_CRIT),
480 SENSOR_ATTR(temp2_input, S_IRUGO, show_temp_value, NULL, 1),
481 SENSOR_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_min,
483 SENSOR_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_max,
485 SENSOR_ATTR(temp2_crit, S_IWUSR | S_IRUGO, show_temp_crit,
487 SENSOR_ATTR(temp2_crit_hyst, S_IRUGO, show_temp_crit_hyst, NULL, 1),
488 SENSOR_ATTR(temp2_fault, S_IRUGO, show_status, NULL,
489 TMP401_STATUS_REMOTE_OPEN),
490 SENSOR_ATTR(temp2_min_alarm, S_IRUGO, show_status, NULL,
491 TMP401_STATUS_REMOTE_LOW),
492 SENSOR_ATTR(temp2_max_alarm, S_IRUGO, show_status, NULL,
493 TMP401_STATUS_REMOTE_HIGH),
494 SENSOR_ATTR(temp2_crit_alarm, S_IRUGO, show_status, NULL,
495 TMP401_STATUS_REMOTE_CRIT),
499 * Additional features of the TMP411 chip.
500 * The TMP411 stores the minimum and maximum
501 * temperature measured since power-on, chip-reset, or
502 * minimum and maximum register reset for both the local
503 * and remote channels.
505 static struct sensor_device_attribute tmp411_attr[] = {
506 SENSOR_ATTR(temp1_highest, S_IRUGO, show_temp_highest, NULL, 0),
507 SENSOR_ATTR(temp1_lowest, S_IRUGO, show_temp_lowest, NULL, 0),
508 SENSOR_ATTR(temp2_highest, S_IRUGO, show_temp_highest, NULL, 1),
509 SENSOR_ATTR(temp2_lowest, S_IRUGO, show_temp_lowest, NULL, 1),
510 SENSOR_ATTR(temp_reset_history, S_IWUSR, NULL, reset_temp_history, 0),
514 * Begin non sysfs callback code (aka Real code)
517 static void tmp401_init_client(struct i2c_client *client)
519 int config, config_orig;
521 /* Set the conversion rate to 2 Hz */
522 i2c_smbus_write_byte_data(client, TMP401_CONVERSION_RATE_WRITE, 5);
524 /* Start conversions (disable shutdown if necessary) */
525 config = i2c_smbus_read_byte_data(client, TMP401_CONFIG_READ);
527 dev_warn(&client->dev, "Initialization failed!\n");
531 config_orig = config;
532 config &= ~TMP401_CONFIG_SHUTDOWN;
534 if (config != config_orig)
535 i2c_smbus_write_byte_data(client, TMP401_CONFIG_WRITE, config);
538 static int tmp401_detect(struct i2c_client *client,
539 struct i2c_board_info *info)
542 struct i2c_adapter *adapter = client->adapter;
545 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
548 /* Detect and identify the chip */
549 reg = i2c_smbus_read_byte_data(client, TMP401_MANUFACTURER_ID_REG);
550 if (reg != TMP401_MANUFACTURER_ID)
553 reg = i2c_smbus_read_byte_data(client, TMP401_DEVICE_ID_REG);
556 case TMP401_DEVICE_ID:
559 case TMP411_DEVICE_ID:
566 reg = i2c_smbus_read_byte_data(client, TMP401_CONFIG_READ);
570 reg = i2c_smbus_read_byte_data(client, TMP401_CONVERSION_RATE_READ);
571 /* Datasheet says: 0x1-0x6 */
575 strlcpy(info->type, tmp401_id[kind].name, I2C_NAME_SIZE);
580 static int tmp401_remove(struct i2c_client *client)
582 struct tmp401_data *data = i2c_get_clientdata(client);
586 hwmon_device_unregister(data->hwmon_dev);
588 for (i = 0; i < ARRAY_SIZE(tmp401_attr); i++)
589 device_remove_file(&client->dev, &tmp401_attr[i].dev_attr);
591 if (data->kind == tmp411) {
592 for (i = 0; i < ARRAY_SIZE(tmp411_attr); i++)
593 device_remove_file(&client->dev,
594 &tmp411_attr[i].dev_attr);
601 static int tmp401_probe(struct i2c_client *client,
602 const struct i2c_device_id *id)
605 struct tmp401_data *data;
606 const char *names[] = { "TMP401", "TMP411" };
608 data = kzalloc(sizeof(struct tmp401_data), GFP_KERNEL);
612 i2c_set_clientdata(client, data);
613 mutex_init(&data->update_lock);
614 data->kind = id->driver_data;
616 /* Initialize the TMP401 chip */
617 tmp401_init_client(client);
619 /* Register sysfs hooks */
620 for (i = 0; i < ARRAY_SIZE(tmp401_attr); i++) {
621 err = device_create_file(&client->dev,
622 &tmp401_attr[i].dev_attr);
627 /* Register aditional tmp411 sysfs hooks */
628 if (data->kind == tmp411) {
629 for (i = 0; i < ARRAY_SIZE(tmp411_attr); i++) {
630 err = device_create_file(&client->dev,
631 &tmp411_attr[i].dev_attr);
637 data->hwmon_dev = hwmon_device_register(&client->dev);
638 if (IS_ERR(data->hwmon_dev)) {
639 err = PTR_ERR(data->hwmon_dev);
640 data->hwmon_dev = NULL;
644 dev_info(&client->dev, "Detected TI %s chip\n", names[data->kind]);
649 tmp401_remove(client); /* will also free data for us */
653 static struct i2c_driver tmp401_driver = {
654 .class = I2C_CLASS_HWMON,
658 .probe = tmp401_probe,
659 .remove = tmp401_remove,
660 .id_table = tmp401_id,
661 .detect = tmp401_detect,
662 .address_list = normal_i2c,
665 static int __init tmp401_init(void)
667 return i2c_add_driver(&tmp401_driver);
670 static void __exit tmp401_exit(void)
672 i2c_del_driver(&tmp401_driver);
675 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
676 MODULE_DESCRIPTION("Texas Instruments TMP401 temperature sensor driver");
677 MODULE_LICENSE("GPL");
679 module_init(tmp401_init);
680 module_exit(tmp401_exit);