1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Copyright (C) 2007,2008 Hans de Goede <hdegoede@redhat.com>
5 * Preliminary tmp411 support by:
6 * Gabriel Konat, Sander Leget, Wouter Willems
7 * Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
9 * Cleanup and support for TMP431 and TMP432 by Guenter Roeck
10 * Copyright (c) 2013 Guenter Roeck <linux@roeck-us.net>
14 * Driver for the Texas Instruments TMP401 SMBUS temperature sensor IC.
16 * Note this IC is in some aspect similar to the LM90, but it has quite a
17 * few differences too, for example the local temp has a higher resolution
18 * and thus has 16 bits registers for its value and limit instead of 8 bits.
21 #include <linux/bitops.h>
22 #include <linux/err.h>
23 #include <linux/i2c.h>
24 #include <linux/hwmon.h>
25 #include <linux/init.h>
26 #include <linux/module.h>
27 #include <linux/mutex.h>
28 #include <linux/regmap.h>
29 #include <linux/slab.h>
31 /* Addresses to scan */
32 static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4c, 0x4d,
33 0x4e, 0x4f, I2C_CLIENT_END };
35 enum chips { tmp401, tmp411, tmp431, tmp432, tmp435 };
38 * The TMP401 registers, note some registers have different addresses for
41 #define TMP401_STATUS 0x02
42 #define TMP401_CONFIG 0x03
43 #define TMP401_CONVERSION_RATE 0x04
44 #define TMP401_TEMP_CRIT_HYST 0x21
45 #define TMP401_MANUFACTURER_ID_REG 0xFE
46 #define TMP401_DEVICE_ID_REG 0xFF
48 static const u8 TMP401_TEMP_MSB[7][3] = {
49 { 0x00, 0x01, 0x23 }, /* temp */
50 { 0x06, 0x08, 0x16 }, /* low limit */
51 { 0x05, 0x07, 0x15 }, /* high limit */
52 { 0x20, 0x19, 0x1a }, /* therm (crit) limit */
53 { 0x30, 0x34, 0x00 }, /* lowest */
54 { 0x32, 0xf6, 0x00 }, /* highest */
57 /* [0] = fault, [1] = low, [2] = high, [3] = therm/crit */
58 static const u8 TMP432_STATUS_REG[] = {
59 0x1b, 0x36, 0x35, 0x37 };
62 #define TMP401_CONFIG_RANGE BIT(2)
63 #define TMP401_CONFIG_SHUTDOWN BIT(6)
64 #define TMP401_STATUS_LOCAL_CRIT BIT(0)
65 #define TMP401_STATUS_REMOTE_CRIT BIT(1)
66 #define TMP401_STATUS_REMOTE_OPEN BIT(2)
67 #define TMP401_STATUS_REMOTE_LOW BIT(3)
68 #define TMP401_STATUS_REMOTE_HIGH BIT(4)
69 #define TMP401_STATUS_LOCAL_LOW BIT(5)
70 #define TMP401_STATUS_LOCAL_HIGH BIT(6)
72 /* On TMP432, each status has its own register */
73 #define TMP432_STATUS_LOCAL BIT(0)
74 #define TMP432_STATUS_REMOTE1 BIT(1)
75 #define TMP432_STATUS_REMOTE2 BIT(2)
77 /* Manufacturer / Device ID's */
78 #define TMP401_MANUFACTURER_ID 0x55
79 #define TMP401_DEVICE_ID 0x11
80 #define TMP411A_DEVICE_ID 0x12
81 #define TMP411B_DEVICE_ID 0x13
82 #define TMP411C_DEVICE_ID 0x10
83 #define TMP431_DEVICE_ID 0x31
84 #define TMP432_DEVICE_ID 0x32
85 #define TMP435_DEVICE_ID 0x35
88 * Driver data (common to all clients)
91 static const struct i2c_device_id tmp401_id[] = {
99 MODULE_DEVICE_TABLE(i2c, tmp401_id);
102 * Client data (each client gets its own)
106 struct i2c_client *client;
107 struct regmap *regmap;
108 struct mutex update_lock;
113 /* hwmon API configuration data */
114 u32 chip_channel_config[4];
115 struct hwmon_channel_info chip_info;
116 u32 temp_channel_config[4];
117 struct hwmon_channel_info temp_info;
118 const struct hwmon_channel_info *info[3];
119 struct hwmon_chip_info chip;
124 static bool tmp401_regmap_is_volatile(struct device *dev, unsigned int reg)
127 case 0: /* local temp msb */
128 case 1: /* remote temp msb */
130 case 0x10: /* remote temp lsb */
131 case 0x15: /* local temp lsb */
132 case 0x1b: /* status (tmp432) */
133 case 0x23 ... 0x24: /* remote temp 2 msb / lsb */
134 case 0x30 ... 0x37: /* lowest/highest temp; status (tmp432) */
141 static int tmp401_reg_read(void *context, unsigned int reg, unsigned int *val)
143 struct tmp401_data *data = context;
144 struct i2c_client *client = data->client;
148 case 0: /* local temp msb */
149 case 1: /* remote temp msb */
150 case 5: /* local temp high limit msb */
151 case 6: /* local temp low limit msb */
152 case 7: /* remote temp ligh limit msb */
153 case 8: /* remote temp low limit msb */
154 case 0x15: /* remote temp 2 high limit msb */
155 case 0x16: /* remote temp 2 low limit msb */
156 case 0x23: /* remote temp 2 msb */
157 case 0x30: /* local temp minimum, tmp411 */
158 case 0x32: /* local temp maximum, tmp411 */
159 case 0x34: /* remote temp minimum, tmp411 */
160 case 0xf6: /* remote temp maximum, tmp411 (really 0x36) */
161 /* work around register overlap between TMP411 and TMP432 */
164 regval = i2c_smbus_read_word_swapped(client, reg);
169 case 0x19: /* critical limits, 8-bit registers */
172 regval = i2c_smbus_read_byte_data(client, reg);
179 if (data->kind == tmp432) {
180 regval = i2c_smbus_read_byte_data(client, reg);
186 /* simulate TMP432 status registers */
187 regval = i2c_smbus_read_byte_data(client, TMP401_STATUS);
192 case 0x1b: /* open / fault */
193 if (regval & TMP401_STATUS_REMOTE_OPEN)
196 case 0x35: /* high limit */
197 if (regval & TMP401_STATUS_LOCAL_HIGH)
199 if (regval & TMP401_STATUS_REMOTE_HIGH)
202 case 0x36: /* low limit */
203 if (regval & TMP401_STATUS_LOCAL_LOW)
205 if (regval & TMP401_STATUS_REMOTE_LOW)
208 case 0x37: /* therm / crit limit */
209 if (regval & TMP401_STATUS_LOCAL_CRIT)
211 if (regval & TMP401_STATUS_REMOTE_CRIT)
217 regval = i2c_smbus_read_byte_data(client, reg);
226 static int tmp401_reg_write(void *context, unsigned int reg, unsigned int val)
228 struct tmp401_data *data = context;
229 struct i2c_client *client = data->client;
232 case 0x05: /* local temp high limit msb */
233 case 0x06: /* local temp low limit msb */
234 case 0x07: /* remote temp ligh limit msb */
235 case 0x08: /* remote temp low limit msb */
236 reg += 6; /* adjust for register write address */
238 case 0x15: /* remote temp 2 high limit msb */
239 case 0x16: /* remote temp 2 low limit msb */
240 return i2c_smbus_write_word_swapped(client, reg, val);
241 case 0x19: /* critical limits, 8-bit registers */
244 return i2c_smbus_write_byte_data(client, reg, val >> 8);
245 case TMP401_CONVERSION_RATE:
247 reg += 6; /* adjust for register write address */
250 return i2c_smbus_write_byte_data(client, reg, val);
254 static const struct regmap_config tmp401_regmap_config = {
257 .cache_type = REGCACHE_RBTREE,
258 .volatile_reg = tmp401_regmap_is_volatile,
259 .reg_read = tmp401_reg_read,
260 .reg_write = tmp401_reg_write,
263 /* temperature conversion */
265 static int tmp401_register_to_temp(u16 reg, bool extended)
272 return DIV_ROUND_CLOSEST(temp * 125, 32);
275 static u16 tmp401_temp_to_register(long temp, bool extended, int zbits)
278 temp = clamp_val(temp, -64000, 191000);
281 temp = clamp_val(temp, 0, 127000);
284 return DIV_ROUND_CLOSEST(temp * (1 << (8 - zbits)), 1000) << zbits;
287 /* hwmon API functions */
289 static const u8 tmp401_temp_reg_index[] = {
290 [hwmon_temp_input] = 0,
291 [hwmon_temp_min] = 1,
292 [hwmon_temp_max] = 2,
293 [hwmon_temp_crit] = 3,
294 [hwmon_temp_lowest] = 4,
295 [hwmon_temp_highest] = 5,
298 static const u8 tmp401_status_reg_index[] = {
299 [hwmon_temp_fault] = 0,
300 [hwmon_temp_min_alarm] = 1,
301 [hwmon_temp_max_alarm] = 2,
302 [hwmon_temp_crit_alarm] = 3,
305 static int tmp401_temp_read(struct device *dev, u32 attr, int channel, long *val)
307 struct tmp401_data *data = dev_get_drvdata(dev);
308 struct regmap *regmap = data->regmap;
313 case hwmon_temp_input:
316 case hwmon_temp_crit:
317 case hwmon_temp_lowest:
318 case hwmon_temp_highest:
319 reg = TMP401_TEMP_MSB[tmp401_temp_reg_index[attr]][channel];
320 ret = regmap_read(regmap, reg, ®val);
323 *val = tmp401_register_to_temp(regval, data->extended_range);
325 case hwmon_temp_crit_hyst:
326 mutex_lock(&data->update_lock);
327 reg = TMP401_TEMP_MSB[3][channel];
328 ret = regmap_read(regmap, reg, ®val);
331 *val = tmp401_register_to_temp(regval, data->extended_range);
332 ret = regmap_read(regmap, TMP401_TEMP_CRIT_HYST, ®val);
335 *val -= regval * 1000;
337 mutex_unlock(&data->update_lock);
341 case hwmon_temp_fault:
342 case hwmon_temp_min_alarm:
343 case hwmon_temp_max_alarm:
344 case hwmon_temp_crit_alarm:
345 reg = TMP432_STATUS_REG[tmp401_status_reg_index[attr]];
346 ret = regmap_read(regmap, reg, ®val);
349 *val = !!(regval & BIT(channel));
357 static int tmp401_temp_write(struct device *dev, u32 attr, int channel,
360 struct tmp401_data *data = dev_get_drvdata(dev);
361 struct regmap *regmap = data->regmap;
365 mutex_lock(&data->update_lock);
369 case hwmon_temp_crit:
370 reg = TMP401_TEMP_MSB[tmp401_temp_reg_index[attr]][channel];
371 regval = tmp401_temp_to_register(val, data->extended_range,
372 attr == hwmon_temp_crit ? 8 : 4);
373 ret = regmap_write(regmap, reg, regval);
375 case hwmon_temp_crit_hyst:
376 if (data->extended_range)
377 val = clamp_val(val, -64000, 191000);
379 val = clamp_val(val, 0, 127000);
381 reg = TMP401_TEMP_MSB[3][channel];
382 ret = regmap_read(regmap, reg, ®val);
385 temp = tmp401_register_to_temp(regval, data->extended_range);
386 val = clamp_val(val, temp - 255000, temp);
387 regval = ((temp - val) + 500) / 1000;
388 ret = regmap_write(regmap, TMP401_TEMP_CRIT_HYST, regval);
394 mutex_unlock(&data->update_lock);
398 static int tmp401_chip_read(struct device *dev, u32 attr, int channel, long *val)
400 struct tmp401_data *data = dev_get_drvdata(dev);
405 case hwmon_chip_update_interval:
406 ret = regmap_read(data->regmap, TMP401_CONVERSION_RATE, ®val);
409 *val = (1 << (7 - regval)) * 125;
411 case hwmon_chip_temp_reset_history:
421 static int tmp401_set_convrate(struct regmap *regmap, long val)
426 * For valid rates, interval can be calculated as
427 * interval = (1 << (7 - rate)) * 125;
428 * Rounded rate is therefore
429 * rate = 7 - __fls(interval * 4 / (125 * 3));
430 * Use clamp_val() to avoid overflows, and to ensure valid input
433 val = clamp_val(val, 125, 16000);
434 rate = 7 - __fls(val * 4 / (125 * 3));
435 return regmap_write(regmap, TMP401_CONVERSION_RATE, rate);
438 static int tmp401_chip_write(struct device *dev, u32 attr, int channel, long val)
440 struct tmp401_data *data = dev_get_drvdata(dev);
441 struct regmap *regmap = data->regmap;
444 mutex_lock(&data->update_lock);
446 case hwmon_chip_update_interval:
447 err = tmp401_set_convrate(regmap, val);
449 case hwmon_chip_temp_reset_history:
455 * Reset history by writing any value to any of the
456 * minimum/maximum registers (0x30-0x37).
458 err = regmap_write(regmap, 0x30, 0);
464 mutex_unlock(&data->update_lock);
469 static int tmp401_read(struct device *dev, enum hwmon_sensor_types type,
470 u32 attr, int channel, long *val)
474 return tmp401_chip_read(dev, attr, channel, val);
476 return tmp401_temp_read(dev, attr, channel, val);
482 static int tmp401_write(struct device *dev, enum hwmon_sensor_types type,
483 u32 attr, int channel, long val)
487 return tmp401_chip_write(dev, attr, channel, val);
489 return tmp401_temp_write(dev, attr, channel, val);
495 static umode_t tmp401_is_visible(const void *data, enum hwmon_sensor_types type,
496 u32 attr, int channel)
501 case hwmon_chip_update_interval:
502 case hwmon_chip_temp_reset_history:
510 case hwmon_temp_input:
511 case hwmon_temp_min_alarm:
512 case hwmon_temp_max_alarm:
513 case hwmon_temp_crit_alarm:
514 case hwmon_temp_fault:
515 case hwmon_temp_lowest:
516 case hwmon_temp_highest:
520 case hwmon_temp_crit:
521 case hwmon_temp_crit_hyst:
533 static const struct hwmon_ops tmp401_ops = {
534 .is_visible = tmp401_is_visible,
536 .write = tmp401_write,
539 /* chip initialization, detect, probe */
541 static int tmp401_init_client(struct tmp401_data *data)
543 struct regmap *regmap = data->regmap;
544 u32 config, config_orig;
547 /* Set conversion rate to 2 Hz */
548 ret = regmap_write(regmap, TMP401_CONVERSION_RATE, 5);
552 /* Start conversions (disable shutdown if necessary) */
553 ret = regmap_read(regmap, TMP401_CONFIG, &config);
557 config_orig = config;
558 config &= ~TMP401_CONFIG_SHUTDOWN;
560 data->extended_range = !!(config & TMP401_CONFIG_RANGE);
562 if (config != config_orig)
563 ret = regmap_write(regmap, TMP401_CONFIG, config);
568 static int tmp401_detect(struct i2c_client *client,
569 struct i2c_board_info *info)
572 struct i2c_adapter *adapter = client->adapter;
575 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
578 /* Detect and identify the chip */
579 reg = i2c_smbus_read_byte_data(client, TMP401_MANUFACTURER_ID_REG);
580 if (reg != TMP401_MANUFACTURER_ID)
583 reg = i2c_smbus_read_byte_data(client, TMP401_DEVICE_ID_REG);
586 case TMP401_DEVICE_ID:
587 if (client->addr != 0x4c)
591 case TMP411A_DEVICE_ID:
592 if (client->addr != 0x4c)
596 case TMP411B_DEVICE_ID:
597 if (client->addr != 0x4d)
601 case TMP411C_DEVICE_ID:
602 if (client->addr != 0x4e)
606 case TMP431_DEVICE_ID:
607 if (client->addr != 0x4c && client->addr != 0x4d)
611 case TMP432_DEVICE_ID:
612 if (client->addr != 0x4c && client->addr != 0x4d)
616 case TMP435_DEVICE_ID:
623 reg = i2c_smbus_read_byte_data(client, TMP401_CONFIG);
627 reg = i2c_smbus_read_byte_data(client, TMP401_CONVERSION_RATE);
628 /* Datasheet says: 0x1-0x6 */
632 strlcpy(info->type, tmp401_id[kind].name, I2C_NAME_SIZE);
637 static int tmp401_probe(struct i2c_client *client)
639 static const char * const names[] = {
640 "TMP401", "TMP411", "TMP431", "TMP432", "TMP435"
642 struct device *dev = &client->dev;
643 struct hwmon_channel_info *info;
644 struct device *hwmon_dev;
645 struct tmp401_data *data;
648 data = devm_kzalloc(dev, sizeof(struct tmp401_data), GFP_KERNEL);
652 data->client = client;
653 mutex_init(&data->update_lock);
654 data->kind = i2c_match_id(tmp401_id, client)->driver_data;
656 data->regmap = devm_regmap_init(dev, NULL, data, &tmp401_regmap_config);
657 if (IS_ERR(data->regmap))
658 return PTR_ERR(data->regmap);
660 /* initialize configuration data */
661 data->chip.ops = &tmp401_ops;
662 data->chip.info = data->info;
664 data->info[0] = &data->chip_info;
665 data->info[1] = &data->temp_info;
667 info = &data->chip_info;
668 info->type = hwmon_chip;
669 info->config = data->chip_channel_config;
671 data->chip_channel_config[0] = HWMON_C_UPDATE_INTERVAL;
673 info = &data->temp_info;
674 info->type = hwmon_temp;
675 info->config = data->temp_channel_config;
677 data->temp_channel_config[0] = HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
678 HWMON_T_CRIT | HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
679 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM;
680 data->temp_channel_config[1] = HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
681 HWMON_T_CRIT | HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
682 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM | HWMON_T_FAULT;
684 if (data->kind == tmp411) {
685 data->temp_channel_config[0] |= HWMON_T_HIGHEST | HWMON_T_LOWEST;
686 data->temp_channel_config[1] |= HWMON_T_HIGHEST | HWMON_T_LOWEST;
687 data->chip_channel_config[0] |= HWMON_C_TEMP_RESET_HISTORY;
690 if (data->kind == tmp432) {
691 data->temp_channel_config[2] = HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
692 HWMON_T_CRIT | HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
693 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM | HWMON_T_FAULT;
696 /* Initialize the TMP401 chip */
697 status = tmp401_init_client(data);
701 hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name, data,
703 if (IS_ERR(hwmon_dev))
704 return PTR_ERR(hwmon_dev);
706 dev_info(dev, "Detected TI %s chip\n", names[data->kind]);
711 static struct i2c_driver tmp401_driver = {
712 .class = I2C_CLASS_HWMON,
716 .probe_new = tmp401_probe,
717 .id_table = tmp401_id,
718 .detect = tmp401_detect,
719 .address_list = normal_i2c,
722 module_i2c_driver(tmp401_driver);
724 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
725 MODULE_DESCRIPTION("Texas Instruments TMP401 temperature sensor driver");
726 MODULE_LICENSE("GPL");