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 /* Insmod parameters */
46 I2C_CLIENT_INSMOD_2(tmp401
, tmp411
);
49 * The TMP401 registers, note some registers have different addresses for
52 #define TMP401_STATUS 0x02
53 #define TMP401_CONFIG_READ 0x03
54 #define TMP401_CONFIG_WRITE 0x09
55 #define TMP401_CONVERSION_RATE_READ 0x04
56 #define TMP401_CONVERSION_RATE_WRITE 0x0A
57 #define TMP401_TEMP_CRIT_HYST 0x21
58 #define TMP401_CONSECUTIVE_ALERT 0x22
59 #define TMP401_MANUFACTURER_ID_REG 0xFE
60 #define TMP401_DEVICE_ID_REG 0xFF
61 #define TMP411_N_FACTOR_REG 0x18
63 static const u8 TMP401_TEMP_MSB
[2] = { 0x00, 0x01 };
64 static const u8 TMP401_TEMP_LSB
[2] = { 0x15, 0x10 };
65 static const u8 TMP401_TEMP_LOW_LIMIT_MSB_READ
[2] = { 0x06, 0x08 };
66 static const u8 TMP401_TEMP_LOW_LIMIT_MSB_WRITE
[2] = { 0x0C, 0x0E };
67 static const u8 TMP401_TEMP_LOW_LIMIT_LSB
[2] = { 0x17, 0x14 };
68 static const u8 TMP401_TEMP_HIGH_LIMIT_MSB_READ
[2] = { 0x05, 0x07 };
69 static const u8 TMP401_TEMP_HIGH_LIMIT_MSB_WRITE
[2] = { 0x0B, 0x0D };
70 static const u8 TMP401_TEMP_HIGH_LIMIT_LSB
[2] = { 0x16, 0x13 };
71 /* These are called the THERM limit / hysteresis / mask in the datasheet */
72 static const u8 TMP401_TEMP_CRIT_LIMIT
[2] = { 0x20, 0x19 };
74 static const u8 TMP411_TEMP_LOWEST_MSB
[2] = { 0x30, 0x34 };
75 static const u8 TMP411_TEMP_LOWEST_LSB
[2] = { 0x31, 0x35 };
76 static const u8 TMP411_TEMP_HIGHEST_MSB
[2] = { 0x32, 0x36 };
77 static const u8 TMP411_TEMP_HIGHEST_LSB
[2] = { 0x33, 0x37 };
80 #define TMP401_CONFIG_RANGE 0x04
81 #define TMP401_CONFIG_SHUTDOWN 0x40
82 #define TMP401_STATUS_LOCAL_CRIT 0x01
83 #define TMP401_STATUS_REMOTE_CRIT 0x02
84 #define TMP401_STATUS_REMOTE_OPEN 0x04
85 #define TMP401_STATUS_REMOTE_LOW 0x08
86 #define TMP401_STATUS_REMOTE_HIGH 0x10
87 #define TMP401_STATUS_LOCAL_LOW 0x20
88 #define TMP401_STATUS_LOCAL_HIGH 0x40
90 /* Manufacturer / Device ID's */
91 #define TMP401_MANUFACTURER_ID 0x55
92 #define TMP401_DEVICE_ID 0x11
93 #define TMP411_DEVICE_ID 0x12
96 * Functions declarations
99 static int tmp401_probe(struct i2c_client
*client
,
100 const struct i2c_device_id
*id
);
101 static int tmp401_detect(struct i2c_client
*client
, int kind
,
102 struct i2c_board_info
*info
);
103 static int tmp401_remove(struct i2c_client
*client
);
104 static struct tmp401_data
*tmp401_update_device(struct device
*dev
);
107 * Driver data (common to all clients)
110 static const struct i2c_device_id tmp401_id
[] = {
111 { "tmp401", tmp401
},
112 { "tmp411", tmp411
},
115 MODULE_DEVICE_TABLE(i2c
, tmp401_id
);
117 static struct i2c_driver tmp401_driver
= {
118 .class = I2C_CLASS_HWMON
,
122 .probe
= tmp401_probe
,
123 .remove
= tmp401_remove
,
124 .id_table
= tmp401_id
,
125 .detect
= tmp401_detect
,
126 .address_data
= &addr_data
,
130 * Client data (each client gets its own)
134 struct device
*hwmon_dev
;
135 struct mutex update_lock
;
136 char valid
; /* zero until following fields are valid */
137 unsigned long last_updated
; /* in jiffies */
140 /* register values */
153 * Sysfs attr show / store functions
156 static int tmp401_register_to_temp(u16 reg
, u8 config
)
160 if (config
& TMP401_CONFIG_RANGE
)
163 return (temp
* 625 + 80) / 160;
166 static u16
tmp401_temp_to_register(long temp
, u8 config
)
168 if (config
& TMP401_CONFIG_RANGE
) {
169 temp
= SENSORS_LIMIT(temp
, -64000, 191000);
172 temp
= SENSORS_LIMIT(temp
, 0, 127000);
174 return (temp
* 160 + 312) / 625;
177 static int tmp401_crit_register_to_temp(u8 reg
, u8 config
)
181 if (config
& TMP401_CONFIG_RANGE
)
187 static u8
tmp401_crit_temp_to_register(long temp
, u8 config
)
189 if (config
& TMP401_CONFIG_RANGE
) {
190 temp
= SENSORS_LIMIT(temp
, -64000, 191000);
193 temp
= SENSORS_LIMIT(temp
, 0, 127000);
195 return (temp
+ 500) / 1000;
198 static ssize_t
show_temp_value(struct device
*dev
,
199 struct device_attribute
*devattr
, char *buf
)
201 int index
= to_sensor_dev_attr(devattr
)->index
;
202 struct tmp401_data
*data
= tmp401_update_device(dev
);
204 return sprintf(buf
, "%d\n",
205 tmp401_register_to_temp(data
->temp
[index
], data
->config
));
208 static ssize_t
show_temp_min(struct device
*dev
,
209 struct device_attribute
*devattr
, char *buf
)
211 int index
= to_sensor_dev_attr(devattr
)->index
;
212 struct tmp401_data
*data
= tmp401_update_device(dev
);
214 return sprintf(buf
, "%d\n",
215 tmp401_register_to_temp(data
->temp_low
[index
], data
->config
));
218 static ssize_t
show_temp_max(struct device
*dev
,
219 struct device_attribute
*devattr
, char *buf
)
221 int index
= to_sensor_dev_attr(devattr
)->index
;
222 struct tmp401_data
*data
= tmp401_update_device(dev
);
224 return sprintf(buf
, "%d\n",
225 tmp401_register_to_temp(data
->temp_high
[index
], data
->config
));
228 static ssize_t
show_temp_crit(struct device
*dev
,
229 struct device_attribute
*devattr
, char *buf
)
231 int index
= to_sensor_dev_attr(devattr
)->index
;
232 struct tmp401_data
*data
= tmp401_update_device(dev
);
234 return sprintf(buf
, "%d\n",
235 tmp401_crit_register_to_temp(data
->temp_crit
[index
],
239 static ssize_t
show_temp_crit_hyst(struct device
*dev
,
240 struct device_attribute
*devattr
, char *buf
)
242 int temp
, index
= to_sensor_dev_attr(devattr
)->index
;
243 struct tmp401_data
*data
= tmp401_update_device(dev
);
245 mutex_lock(&data
->update_lock
);
246 temp
= tmp401_crit_register_to_temp(data
->temp_crit
[index
],
248 temp
-= data
->temp_crit_hyst
* 1000;
249 mutex_unlock(&data
->update_lock
);
251 return sprintf(buf
, "%d\n", temp
);
254 static ssize_t
show_temp_lowest(struct device
*dev
,
255 struct device_attribute
*devattr
, char *buf
)
257 int index
= to_sensor_dev_attr(devattr
)->index
;
258 struct tmp401_data
*data
= tmp401_update_device(dev
);
260 return sprintf(buf
, "%d\n",
261 tmp401_register_to_temp(data
->temp_lowest
[index
],
265 static ssize_t
show_temp_highest(struct device
*dev
,
266 struct device_attribute
*devattr
, char *buf
)
268 int index
= to_sensor_dev_attr(devattr
)->index
;
269 struct tmp401_data
*data
= tmp401_update_device(dev
);
271 return sprintf(buf
, "%d\n",
272 tmp401_register_to_temp(data
->temp_highest
[index
],
276 static ssize_t
show_status(struct device
*dev
,
277 struct device_attribute
*devattr
, char *buf
)
279 int mask
= to_sensor_dev_attr(devattr
)->index
;
280 struct tmp401_data
*data
= tmp401_update_device(dev
);
282 if (data
->status
& mask
)
283 return sprintf(buf
, "1\n");
285 return sprintf(buf
, "0\n");
288 static ssize_t
store_temp_min(struct device
*dev
, struct device_attribute
289 *devattr
, const char *buf
, size_t count
)
291 int index
= to_sensor_dev_attr(devattr
)->index
;
292 struct tmp401_data
*data
= tmp401_update_device(dev
);
296 if (strict_strtol(buf
, 10, &val
))
299 reg
= tmp401_temp_to_register(val
, data
->config
);
301 mutex_lock(&data
->update_lock
);
303 i2c_smbus_write_byte_data(to_i2c_client(dev
),
304 TMP401_TEMP_LOW_LIMIT_MSB_WRITE
[index
], reg
>> 8);
305 i2c_smbus_write_byte_data(to_i2c_client(dev
),
306 TMP401_TEMP_LOW_LIMIT_LSB
[index
], reg
& 0xFF);
308 data
->temp_low
[index
] = reg
;
310 mutex_unlock(&data
->update_lock
);
315 static ssize_t
store_temp_max(struct device
*dev
, struct device_attribute
316 *devattr
, const char *buf
, size_t count
)
318 int index
= to_sensor_dev_attr(devattr
)->index
;
319 struct tmp401_data
*data
= tmp401_update_device(dev
);
323 if (strict_strtol(buf
, 10, &val
))
326 reg
= tmp401_temp_to_register(val
, data
->config
);
328 mutex_lock(&data
->update_lock
);
330 i2c_smbus_write_byte_data(to_i2c_client(dev
),
331 TMP401_TEMP_HIGH_LIMIT_MSB_WRITE
[index
], reg
>> 8);
332 i2c_smbus_write_byte_data(to_i2c_client(dev
),
333 TMP401_TEMP_HIGH_LIMIT_LSB
[index
], reg
& 0xFF);
335 data
->temp_high
[index
] = reg
;
337 mutex_unlock(&data
->update_lock
);
342 static ssize_t
store_temp_crit(struct device
*dev
, struct device_attribute
343 *devattr
, const char *buf
, size_t count
)
345 int index
= to_sensor_dev_attr(devattr
)->index
;
346 struct tmp401_data
*data
= tmp401_update_device(dev
);
350 if (strict_strtol(buf
, 10, &val
))
353 reg
= tmp401_crit_temp_to_register(val
, data
->config
);
355 mutex_lock(&data
->update_lock
);
357 i2c_smbus_write_byte_data(to_i2c_client(dev
),
358 TMP401_TEMP_CRIT_LIMIT
[index
], reg
);
360 data
->temp_crit
[index
] = reg
;
362 mutex_unlock(&data
->update_lock
);
367 static ssize_t
store_temp_crit_hyst(struct device
*dev
, struct device_attribute
368 *devattr
, const char *buf
, size_t count
)
370 int temp
, index
= to_sensor_dev_attr(devattr
)->index
;
371 struct tmp401_data
*data
= tmp401_update_device(dev
);
375 if (strict_strtol(buf
, 10, &val
))
378 if (data
->config
& TMP401_CONFIG_RANGE
)
379 val
= SENSORS_LIMIT(val
, -64000, 191000);
381 val
= SENSORS_LIMIT(val
, 0, 127000);
383 mutex_lock(&data
->update_lock
);
384 temp
= tmp401_crit_register_to_temp(data
->temp_crit
[index
],
386 val
= SENSORS_LIMIT(val
, temp
- 255000, temp
);
387 reg
= ((temp
- val
) + 500) / 1000;
389 i2c_smbus_write_byte_data(to_i2c_client(dev
),
390 TMP401_TEMP_CRIT_HYST
, reg
);
392 data
->temp_crit_hyst
= reg
;
394 mutex_unlock(&data
->update_lock
);
400 * Resets the historical measurements of minimum and maximum temperatures.
401 * This is done by writing any value to any of the minimum/maximum registers
404 static ssize_t
reset_temp_history(struct device
*dev
,
405 struct device_attribute
*devattr
, const char *buf
, size_t count
)
409 if (strict_strtol(buf
, 10, &val
))
413 dev_err(dev
, "temp_reset_history value %ld not"
414 " supported. Use 1 to reset the history!\n", val
);
417 i2c_smbus_write_byte_data(to_i2c_client(dev
),
418 TMP411_TEMP_LOWEST_MSB
[0], val
);
423 static struct sensor_device_attribute tmp401_attr
[] = {
424 SENSOR_ATTR(temp1_input
, 0444, show_temp_value
, NULL
, 0),
425 SENSOR_ATTR(temp1_min
, 0644, show_temp_min
, store_temp_min
, 0),
426 SENSOR_ATTR(temp1_max
, 0644, show_temp_max
, store_temp_max
, 0),
427 SENSOR_ATTR(temp1_crit
, 0644, show_temp_crit
, store_temp_crit
, 0),
428 SENSOR_ATTR(temp1_crit_hyst
, 0644, show_temp_crit_hyst
,
429 store_temp_crit_hyst
, 0),
430 SENSOR_ATTR(temp1_min_alarm
, 0444, show_status
, NULL
,
431 TMP401_STATUS_LOCAL_LOW
),
432 SENSOR_ATTR(temp1_max_alarm
, 0444, show_status
, NULL
,
433 TMP401_STATUS_LOCAL_HIGH
),
434 SENSOR_ATTR(temp1_crit_alarm
, 0444, show_status
, NULL
,
435 TMP401_STATUS_LOCAL_CRIT
),
436 SENSOR_ATTR(temp2_input
, 0444, show_temp_value
, NULL
, 1),
437 SENSOR_ATTR(temp2_min
, 0644, show_temp_min
, store_temp_min
, 1),
438 SENSOR_ATTR(temp2_max
, 0644, show_temp_max
, store_temp_max
, 1),
439 SENSOR_ATTR(temp2_crit
, 0644, show_temp_crit
, store_temp_crit
, 1),
440 SENSOR_ATTR(temp2_crit_hyst
, 0444, show_temp_crit_hyst
, NULL
, 1),
441 SENSOR_ATTR(temp2_fault
, 0444, show_status
, NULL
,
442 TMP401_STATUS_REMOTE_OPEN
),
443 SENSOR_ATTR(temp2_min_alarm
, 0444, show_status
, NULL
,
444 TMP401_STATUS_REMOTE_LOW
),
445 SENSOR_ATTR(temp2_max_alarm
, 0444, show_status
, NULL
,
446 TMP401_STATUS_REMOTE_HIGH
),
447 SENSOR_ATTR(temp2_crit_alarm
, 0444, show_status
, NULL
,
448 TMP401_STATUS_REMOTE_CRIT
),
452 * Additional features of the TMP411 chip.
453 * The TMP411 stores the minimum and maximum
454 * temperature measured since power-on, chip-reset, or
455 * minimum and maximum register reset for both the local
456 * and remote channels.
458 static struct sensor_device_attribute tmp411_attr
[] = {
459 SENSOR_ATTR(temp1_highest
, 0444, show_temp_highest
, NULL
, 0),
460 SENSOR_ATTR(temp1_lowest
, 0444, show_temp_lowest
, NULL
, 0),
461 SENSOR_ATTR(temp2_highest
, 0444, show_temp_highest
, NULL
, 1),
462 SENSOR_ATTR(temp2_lowest
, 0444, show_temp_lowest
, NULL
, 1),
463 SENSOR_ATTR(temp_reset_history
, 0200, NULL
, reset_temp_history
, 0),
467 * Begin non sysfs callback code (aka Real code)
470 static void tmp401_init_client(struct i2c_client
*client
)
472 int config
, config_orig
;
474 /* Set the conversion rate to 2 Hz */
475 i2c_smbus_write_byte_data(client
, TMP401_CONVERSION_RATE_WRITE
, 5);
477 /* Start conversions (disable shutdown if necessary) */
478 config
= i2c_smbus_read_byte_data(client
, TMP401_CONFIG_READ
);
480 dev_warn(&client
->dev
, "Initialization failed!\n");
484 config_orig
= config
;
485 config
&= ~TMP401_CONFIG_SHUTDOWN
;
487 if (config
!= config_orig
)
488 i2c_smbus_write_byte_data(client
, TMP401_CONFIG_WRITE
, config
);
491 static int tmp401_detect(struct i2c_client
*client
, int kind
,
492 struct i2c_board_info
*info
)
494 struct i2c_adapter
*adapter
= client
->adapter
;
496 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
))
499 /* Detect and identify the chip */
503 reg
= i2c_smbus_read_byte_data(client
,
504 TMP401_MANUFACTURER_ID_REG
);
505 if (reg
!= TMP401_MANUFACTURER_ID
)
508 reg
= i2c_smbus_read_byte_data(client
, TMP401_DEVICE_ID_REG
);
511 case TMP401_DEVICE_ID
:
514 case TMP411_DEVICE_ID
:
521 reg
= i2c_smbus_read_byte_data(client
, TMP401_CONFIG_READ
);
525 reg
= i2c_smbus_read_byte_data(client
,
526 TMP401_CONVERSION_RATE_READ
);
527 /* Datasheet says: 0x1-0x6 */
531 strlcpy(info
->type
, tmp401_id
[kind
- 1].name
, I2C_NAME_SIZE
);
536 static int tmp401_probe(struct i2c_client
*client
,
537 const struct i2c_device_id
*id
)
540 struct tmp401_data
*data
;
541 const char *names
[] = { "TMP401", "TMP411" };
543 data
= kzalloc(sizeof(struct tmp401_data
), GFP_KERNEL
);
547 i2c_set_clientdata(client
, data
);
548 mutex_init(&data
->update_lock
);
549 data
->kind
= id
->driver_data
;
551 /* Initialize the TMP401 chip */
552 tmp401_init_client(client
);
554 /* Register sysfs hooks */
555 for (i
= 0; i
< ARRAY_SIZE(tmp401_attr
); i
++) {
556 err
= device_create_file(&client
->dev
,
557 &tmp401_attr
[i
].dev_attr
);
562 /* Register aditional tmp411 sysfs hooks */
563 if (data
->kind
== tmp411
) {
564 for (i
= 0; i
< ARRAY_SIZE(tmp411_attr
); i
++) {
565 err
= device_create_file(&client
->dev
,
566 &tmp411_attr
[i
].dev_attr
);
572 data
->hwmon_dev
= hwmon_device_register(&client
->dev
);
573 if (IS_ERR(data
->hwmon_dev
)) {
574 err
= PTR_ERR(data
->hwmon_dev
);
575 data
->hwmon_dev
= NULL
;
579 dev_info(&client
->dev
, "Detected TI %s chip\n",
580 names
[data
->kind
- 1]);
585 tmp401_remove(client
); /* will also free data for us */
589 static int tmp401_remove(struct i2c_client
*client
)
591 struct tmp401_data
*data
= i2c_get_clientdata(client
);
595 hwmon_device_unregister(data
->hwmon_dev
);
597 for (i
= 0; i
< ARRAY_SIZE(tmp401_attr
); i
++)
598 device_remove_file(&client
->dev
, &tmp401_attr
[i
].dev_attr
);
600 if (data
->kind
== tmp411
) {
601 for (i
= 0; i
< ARRAY_SIZE(tmp411_attr
); i
++)
602 device_remove_file(&client
->dev
,
603 &tmp411_attr
[i
].dev_attr
);
610 static struct tmp401_data
*tmp401_update_device_reg16(
611 struct i2c_client
*client
, struct tmp401_data
*data
)
615 for (i
= 0; i
< 2; i
++) {
617 * High byte must be read first immediately followed
620 data
->temp
[i
] = i2c_smbus_read_byte_data(client
,
621 TMP401_TEMP_MSB
[i
]) << 8;
622 data
->temp
[i
] |= i2c_smbus_read_byte_data(client
,
624 data
->temp_low
[i
] = i2c_smbus_read_byte_data(client
,
625 TMP401_TEMP_LOW_LIMIT_MSB_READ
[i
]) << 8;
626 data
->temp_low
[i
] |= i2c_smbus_read_byte_data(client
,
627 TMP401_TEMP_LOW_LIMIT_LSB
[i
]);
628 data
->temp_high
[i
] = i2c_smbus_read_byte_data(client
,
629 TMP401_TEMP_HIGH_LIMIT_MSB_READ
[i
]) << 8;
630 data
->temp_high
[i
] |= i2c_smbus_read_byte_data(client
,
631 TMP401_TEMP_HIGH_LIMIT_LSB
[i
]);
632 data
->temp_crit
[i
] = i2c_smbus_read_byte_data(client
,
633 TMP401_TEMP_CRIT_LIMIT
[i
]);
635 if (data
->kind
== tmp411
) {
636 data
->temp_lowest
[i
] = i2c_smbus_read_byte_data(client
,
637 TMP411_TEMP_LOWEST_MSB
[i
]) << 8;
638 data
->temp_lowest
[i
] |= i2c_smbus_read_byte_data(
639 client
, TMP411_TEMP_LOWEST_LSB
[i
]);
641 data
->temp_highest
[i
] = i2c_smbus_read_byte_data(
642 client
, TMP411_TEMP_HIGHEST_MSB
[i
]) << 8;
643 data
->temp_highest
[i
] |= i2c_smbus_read_byte_data(
644 client
, TMP411_TEMP_HIGHEST_LSB
[i
]);
650 static struct tmp401_data
*tmp401_update_device(struct device
*dev
)
652 struct i2c_client
*client
= to_i2c_client(dev
);
653 struct tmp401_data
*data
= i2c_get_clientdata(client
);
655 mutex_lock(&data
->update_lock
);
657 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
658 data
->status
= i2c_smbus_read_byte_data(client
, TMP401_STATUS
);
659 data
->config
= i2c_smbus_read_byte_data(client
,
661 tmp401_update_device_reg16(client
, data
);
663 data
->temp_crit_hyst
= i2c_smbus_read_byte_data(client
,
664 TMP401_TEMP_CRIT_HYST
);
666 data
->last_updated
= jiffies
;
670 mutex_unlock(&data
->update_lock
);
675 static int __init
tmp401_init(void)
677 return i2c_add_driver(&tmp401_driver
);
680 static void __exit
tmp401_exit(void)
682 i2c_del_driver(&tmp401_driver
);
685 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
686 MODULE_DESCRIPTION("Texas Instruments TMP401 temperature sensor driver");
687 MODULE_LICENSE("GPL");
689 module_init(tmp401_init
);
690 module_exit(tmp401_exit
);