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 TMP4XX_N_FACTOR_REG 0x18
45 #define TMP43X_BETA_RANGE 0x25
46 #define TMP401_TEMP_CRIT_HYST 0x21
47 #define TMP401_MANUFACTURER_ID_REG 0xFE
48 #define TMP401_DEVICE_ID_REG 0xFF
50 static const u8 TMP401_TEMP_MSB[7][3] = {
51 { 0x00, 0x01, 0x23 }, /* temp */
52 { 0x06, 0x08, 0x16 }, /* low limit */
53 { 0x05, 0x07, 0x15 }, /* high limit */
54 { 0x20, 0x19, 0x1a }, /* therm (crit) limit */
55 { 0x30, 0x34, 0x00 }, /* lowest */
56 { 0x32, 0xf6, 0x00 }, /* highest */
59 /* [0] = fault, [1] = low, [2] = high, [3] = therm/crit */
60 static const u8 TMP432_STATUS_REG[] = {
61 0x1b, 0x36, 0x35, 0x37 };
64 #define TMP401_CONFIG_RANGE BIT(2)
65 #define TMP401_CONFIG_SHUTDOWN BIT(6)
66 #define TMP401_STATUS_LOCAL_CRIT BIT(0)
67 #define TMP401_STATUS_REMOTE_CRIT BIT(1)
68 #define TMP401_STATUS_REMOTE_OPEN BIT(2)
69 #define TMP401_STATUS_REMOTE_LOW BIT(3)
70 #define TMP401_STATUS_REMOTE_HIGH BIT(4)
71 #define TMP401_STATUS_LOCAL_LOW BIT(5)
72 #define TMP401_STATUS_LOCAL_HIGH BIT(6)
74 /* On TMP432, each status has its own register */
75 #define TMP432_STATUS_LOCAL BIT(0)
76 #define TMP432_STATUS_REMOTE1 BIT(1)
77 #define TMP432_STATUS_REMOTE2 BIT(2)
79 /* Manufacturer / Device ID's */
80 #define TMP401_MANUFACTURER_ID 0x55
81 #define TMP401_DEVICE_ID 0x11
82 #define TMP411A_DEVICE_ID 0x12
83 #define TMP411B_DEVICE_ID 0x13
84 #define TMP411C_DEVICE_ID 0x10
85 #define TMP431_DEVICE_ID 0x31
86 #define TMP432_DEVICE_ID 0x32
87 #define TMP435_DEVICE_ID 0x35
90 * Driver data (common to all clients)
93 static const struct i2c_device_id tmp401_id[] = {
101 MODULE_DEVICE_TABLE(i2c, tmp401_id);
104 * Client data (each client gets its own)
108 struct i2c_client *client;
109 struct regmap *regmap;
110 struct mutex update_lock;
115 /* hwmon API configuration data */
116 u32 chip_channel_config[4];
117 struct hwmon_channel_info chip_info;
118 u32 temp_channel_config[4];
119 struct hwmon_channel_info temp_info;
120 const struct hwmon_channel_info *info[3];
121 struct hwmon_chip_info chip;
126 static bool tmp401_regmap_is_volatile(struct device *dev, unsigned int reg)
129 case 0: /* local temp msb */
130 case 1: /* remote temp msb */
132 case 0x10: /* remote temp lsb */
133 case 0x15: /* local temp lsb */
134 case 0x1b: /* status (tmp432) */
135 case 0x23 ... 0x24: /* remote temp 2 msb / lsb */
136 case 0x30 ... 0x37: /* lowest/highest temp; status (tmp432) */
143 static int tmp401_reg_read(void *context, unsigned int reg, unsigned int *val)
145 struct tmp401_data *data = context;
146 struct i2c_client *client = data->client;
150 case 0: /* local temp msb */
151 case 1: /* remote temp msb */
152 case 5: /* local temp high limit msb */
153 case 6: /* local temp low limit msb */
154 case 7: /* remote temp ligh limit msb */
155 case 8: /* remote temp low limit msb */
156 case 0x15: /* remote temp 2 high limit msb */
157 case 0x16: /* remote temp 2 low limit msb */
158 case 0x23: /* remote temp 2 msb */
159 case 0x30: /* local temp minimum, tmp411 */
160 case 0x32: /* local temp maximum, tmp411 */
161 case 0x34: /* remote temp minimum, tmp411 */
162 case 0xf6: /* remote temp maximum, tmp411 (really 0x36) */
163 /* work around register overlap between TMP411 and TMP432 */
166 regval = i2c_smbus_read_word_swapped(client, reg);
171 case 0x19: /* critical limits, 8-bit registers */
174 regval = i2c_smbus_read_byte_data(client, reg);
181 if (data->kind == tmp432) {
182 regval = i2c_smbus_read_byte_data(client, reg);
188 /* simulate TMP432 status registers */
189 regval = i2c_smbus_read_byte_data(client, TMP401_STATUS);
194 case 0x1b: /* open / fault */
195 if (regval & TMP401_STATUS_REMOTE_OPEN)
198 case 0x35: /* high limit */
199 if (regval & TMP401_STATUS_LOCAL_HIGH)
201 if (regval & TMP401_STATUS_REMOTE_HIGH)
204 case 0x36: /* low limit */
205 if (regval & TMP401_STATUS_LOCAL_LOW)
207 if (regval & TMP401_STATUS_REMOTE_LOW)
210 case 0x37: /* therm / crit limit */
211 if (regval & TMP401_STATUS_LOCAL_CRIT)
213 if (regval & TMP401_STATUS_REMOTE_CRIT)
219 regval = i2c_smbus_read_byte_data(client, reg);
228 static int tmp401_reg_write(void *context, unsigned int reg, unsigned int val)
230 struct tmp401_data *data = context;
231 struct i2c_client *client = data->client;
234 case 0x05: /* local temp high limit msb */
235 case 0x06: /* local temp low limit msb */
236 case 0x07: /* remote temp ligh limit msb */
237 case 0x08: /* remote temp low limit msb */
238 reg += 6; /* adjust for register write address */
240 case 0x15: /* remote temp 2 high limit msb */
241 case 0x16: /* remote temp 2 low limit msb */
242 return i2c_smbus_write_word_swapped(client, reg, val);
243 case 0x19: /* critical limits, 8-bit registers */
246 return i2c_smbus_write_byte_data(client, reg, val >> 8);
247 case TMP401_CONVERSION_RATE:
249 reg += 6; /* adjust for register write address */
252 return i2c_smbus_write_byte_data(client, reg, val);
256 static const struct regmap_config tmp401_regmap_config = {
259 .cache_type = REGCACHE_RBTREE,
260 .volatile_reg = tmp401_regmap_is_volatile,
261 .reg_read = tmp401_reg_read,
262 .reg_write = tmp401_reg_write,
265 /* temperature conversion */
267 static int tmp401_register_to_temp(u16 reg, bool extended)
274 return DIV_ROUND_CLOSEST(temp * 125, 32);
277 static u16 tmp401_temp_to_register(long temp, bool extended, int zbits)
280 temp = clamp_val(temp, -64000, 191000);
283 temp = clamp_val(temp, 0, 127000);
286 return DIV_ROUND_CLOSEST(temp * (1 << (8 - zbits)), 1000) << zbits;
289 /* hwmon API functions */
291 static const u8 tmp401_temp_reg_index[] = {
292 [hwmon_temp_input] = 0,
293 [hwmon_temp_min] = 1,
294 [hwmon_temp_max] = 2,
295 [hwmon_temp_crit] = 3,
296 [hwmon_temp_lowest] = 4,
297 [hwmon_temp_highest] = 5,
300 static const u8 tmp401_status_reg_index[] = {
301 [hwmon_temp_fault] = 0,
302 [hwmon_temp_min_alarm] = 1,
303 [hwmon_temp_max_alarm] = 2,
304 [hwmon_temp_crit_alarm] = 3,
307 static int tmp401_temp_read(struct device *dev, u32 attr, int channel, long *val)
309 struct tmp401_data *data = dev_get_drvdata(dev);
310 struct regmap *regmap = data->regmap;
315 case hwmon_temp_input:
318 case hwmon_temp_crit:
319 case hwmon_temp_lowest:
320 case hwmon_temp_highest:
321 reg = TMP401_TEMP_MSB[tmp401_temp_reg_index[attr]][channel];
322 ret = regmap_read(regmap, reg, ®val);
325 *val = tmp401_register_to_temp(regval, data->extended_range);
327 case hwmon_temp_crit_hyst:
328 mutex_lock(&data->update_lock);
329 reg = TMP401_TEMP_MSB[3][channel];
330 ret = regmap_read(regmap, reg, ®val);
333 *val = tmp401_register_to_temp(regval, data->extended_range);
334 ret = regmap_read(regmap, TMP401_TEMP_CRIT_HYST, ®val);
337 *val -= regval * 1000;
339 mutex_unlock(&data->update_lock);
343 case hwmon_temp_fault:
344 case hwmon_temp_min_alarm:
345 case hwmon_temp_max_alarm:
346 case hwmon_temp_crit_alarm:
347 reg = TMP432_STATUS_REG[tmp401_status_reg_index[attr]];
348 ret = regmap_read(regmap, reg, ®val);
351 *val = !!(regval & BIT(channel));
359 static int tmp401_temp_write(struct device *dev, u32 attr, int channel,
362 struct tmp401_data *data = dev_get_drvdata(dev);
363 struct regmap *regmap = data->regmap;
367 mutex_lock(&data->update_lock);
371 case hwmon_temp_crit:
372 reg = TMP401_TEMP_MSB[tmp401_temp_reg_index[attr]][channel];
373 regval = tmp401_temp_to_register(val, data->extended_range,
374 attr == hwmon_temp_crit ? 8 : 4);
375 ret = regmap_write(regmap, reg, regval);
377 case hwmon_temp_crit_hyst:
378 if (data->extended_range)
379 val = clamp_val(val, -64000, 191000);
381 val = clamp_val(val, 0, 127000);
383 reg = TMP401_TEMP_MSB[3][channel];
384 ret = regmap_read(regmap, reg, ®val);
387 temp = tmp401_register_to_temp(regval, data->extended_range);
388 val = clamp_val(val, temp - 255000, temp);
389 regval = ((temp - val) + 500) / 1000;
390 ret = regmap_write(regmap, TMP401_TEMP_CRIT_HYST, regval);
396 mutex_unlock(&data->update_lock);
400 static int tmp401_chip_read(struct device *dev, u32 attr, int channel, long *val)
402 struct tmp401_data *data = dev_get_drvdata(dev);
407 case hwmon_chip_update_interval:
408 ret = regmap_read(data->regmap, TMP401_CONVERSION_RATE, ®val);
411 *val = (1 << (7 - regval)) * 125;
413 case hwmon_chip_temp_reset_history:
423 static int tmp401_set_convrate(struct regmap *regmap, long val)
428 * For valid rates, interval can be calculated as
429 * interval = (1 << (7 - rate)) * 125;
430 * Rounded rate is therefore
431 * rate = 7 - __fls(interval * 4 / (125 * 3));
432 * Use clamp_val() to avoid overflows, and to ensure valid input
435 val = clamp_val(val, 125, 16000);
436 rate = 7 - __fls(val * 4 / (125 * 3));
437 return regmap_write(regmap, TMP401_CONVERSION_RATE, rate);
440 static int tmp401_chip_write(struct device *dev, u32 attr, int channel, long val)
442 struct tmp401_data *data = dev_get_drvdata(dev);
443 struct regmap *regmap = data->regmap;
446 mutex_lock(&data->update_lock);
448 case hwmon_chip_update_interval:
449 err = tmp401_set_convrate(regmap, val);
451 case hwmon_chip_temp_reset_history:
457 * Reset history by writing any value to any of the
458 * minimum/maximum registers (0x30-0x37).
460 err = regmap_write(regmap, 0x30, 0);
466 mutex_unlock(&data->update_lock);
471 static int tmp401_read(struct device *dev, enum hwmon_sensor_types type,
472 u32 attr, int channel, long *val)
476 return tmp401_chip_read(dev, attr, channel, val);
478 return tmp401_temp_read(dev, attr, channel, val);
484 static int tmp401_write(struct device *dev, enum hwmon_sensor_types type,
485 u32 attr, int channel, long val)
489 return tmp401_chip_write(dev, attr, channel, val);
491 return tmp401_temp_write(dev, attr, channel, val);
497 static umode_t tmp401_is_visible(const void *data, enum hwmon_sensor_types type,
498 u32 attr, int channel)
503 case hwmon_chip_update_interval:
504 case hwmon_chip_temp_reset_history:
512 case hwmon_temp_input:
513 case hwmon_temp_min_alarm:
514 case hwmon_temp_max_alarm:
515 case hwmon_temp_crit_alarm:
516 case hwmon_temp_fault:
517 case hwmon_temp_lowest:
518 case hwmon_temp_highest:
522 case hwmon_temp_crit:
523 case hwmon_temp_crit_hyst:
535 static const struct hwmon_ops tmp401_ops = {
536 .is_visible = tmp401_is_visible,
538 .write = tmp401_write,
541 /* chip initialization, detect, probe */
543 static int tmp401_init_client(struct tmp401_data *data)
545 struct regmap *regmap = data->regmap;
546 u32 config, config_orig;
551 /* Set conversion rate to 2 Hz */
552 ret = regmap_write(regmap, TMP401_CONVERSION_RATE, 5);
556 /* Start conversions (disable shutdown if necessary) */
557 ret = regmap_read(regmap, TMP401_CONFIG, &config);
561 config_orig = config;
562 config &= ~TMP401_CONFIG_SHUTDOWN;
564 if (of_property_read_bool(data->client->dev.of_node, "ti,extended-range-enable")) {
565 /* Enable measurement over extended temperature range */
566 config |= TMP401_CONFIG_RANGE;
569 data->extended_range = !!(config & TMP401_CONFIG_RANGE);
571 if (config != config_orig) {
572 ret = regmap_write(regmap, TMP401_CONFIG, config);
577 ret = of_property_read_u32(data->client->dev.of_node, "ti,n-factor", &nfactor);
579 if (data->kind == tmp401) {
580 dev_err(&data->client->dev, "ti,tmp401 does not support n-factor correction\n");
583 if (nfactor < -128 || nfactor > 127) {
584 dev_err(&data->client->dev, "n-factor is invalid (%d)\n", nfactor);
587 ret = regmap_write(regmap, TMP4XX_N_FACTOR_REG, (unsigned int)nfactor);
592 ret = of_property_read_u32(data->client->dev.of_node, "ti,beta-compensation", &val);
594 if (data->kind == tmp401 || data->kind == tmp411) {
595 dev_err(&data->client->dev, "ti,tmp401 or ti,tmp411 does not support beta compensation\n");
599 dev_err(&data->client->dev, "beta-compensation is invalid (%u)\n", val);
602 ret = regmap_write(regmap, TMP43X_BETA_RANGE, val);
610 static int tmp401_detect(struct i2c_client *client,
611 struct i2c_board_info *info)
614 struct i2c_adapter *adapter = client->adapter;
617 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
620 /* Detect and identify the chip */
621 reg = i2c_smbus_read_byte_data(client, TMP401_MANUFACTURER_ID_REG);
622 if (reg != TMP401_MANUFACTURER_ID)
625 reg = i2c_smbus_read_byte_data(client, TMP401_DEVICE_ID_REG);
628 case TMP401_DEVICE_ID:
629 if (client->addr != 0x4c)
633 case TMP411A_DEVICE_ID:
634 if (client->addr != 0x4c)
638 case TMP411B_DEVICE_ID:
639 if (client->addr != 0x4d)
643 case TMP411C_DEVICE_ID:
644 if (client->addr != 0x4e)
648 case TMP431_DEVICE_ID:
649 if (client->addr != 0x4c && client->addr != 0x4d)
653 case TMP432_DEVICE_ID:
654 if (client->addr != 0x4c && client->addr != 0x4d)
658 case TMP435_DEVICE_ID:
665 reg = i2c_smbus_read_byte_data(client, TMP401_CONFIG);
669 reg = i2c_smbus_read_byte_data(client, TMP401_CONVERSION_RATE);
670 /* Datasheet says: 0x1-0x6 */
674 strscpy(info->type, tmp401_id[kind].name, I2C_NAME_SIZE);
679 static int tmp401_probe(struct i2c_client *client)
681 static const char * const names[] = {
682 "TMP401", "TMP411", "TMP431", "TMP432", "TMP435"
684 struct device *dev = &client->dev;
685 struct hwmon_channel_info *info;
686 struct device *hwmon_dev;
687 struct tmp401_data *data;
690 data = devm_kzalloc(dev, sizeof(struct tmp401_data), GFP_KERNEL);
694 data->client = client;
695 mutex_init(&data->update_lock);
696 data->kind = i2c_match_id(tmp401_id, client)->driver_data;
698 data->regmap = devm_regmap_init(dev, NULL, data, &tmp401_regmap_config);
699 if (IS_ERR(data->regmap))
700 return PTR_ERR(data->regmap);
702 /* initialize configuration data */
703 data->chip.ops = &tmp401_ops;
704 data->chip.info = data->info;
706 data->info[0] = &data->chip_info;
707 data->info[1] = &data->temp_info;
709 info = &data->chip_info;
710 info->type = hwmon_chip;
711 info->config = data->chip_channel_config;
713 data->chip_channel_config[0] = HWMON_C_UPDATE_INTERVAL;
715 info = &data->temp_info;
716 info->type = hwmon_temp;
717 info->config = data->temp_channel_config;
719 data->temp_channel_config[0] = HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
720 HWMON_T_CRIT | HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
721 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM;
722 data->temp_channel_config[1] = HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
723 HWMON_T_CRIT | HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
724 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM | HWMON_T_FAULT;
726 if (data->kind == tmp411) {
727 data->temp_channel_config[0] |= HWMON_T_HIGHEST | HWMON_T_LOWEST;
728 data->temp_channel_config[1] |= HWMON_T_HIGHEST | HWMON_T_LOWEST;
729 data->chip_channel_config[0] |= HWMON_C_TEMP_RESET_HISTORY;
732 if (data->kind == tmp432) {
733 data->temp_channel_config[2] = HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
734 HWMON_T_CRIT | HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
735 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM | HWMON_T_FAULT;
738 /* Initialize the TMP401 chip */
739 status = tmp401_init_client(data);
743 hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name, data,
745 if (IS_ERR(hwmon_dev))
746 return PTR_ERR(hwmon_dev);
748 dev_info(dev, "Detected TI %s chip\n", names[data->kind]);
753 static const struct of_device_id __maybe_unused tmp4xx_of_match[] = {
754 { .compatible = "ti,tmp401", },
755 { .compatible = "ti,tmp411", },
756 { .compatible = "ti,tmp431", },
757 { .compatible = "ti,tmp432", },
758 { .compatible = "ti,tmp435", },
761 MODULE_DEVICE_TABLE(of, tmp4xx_of_match);
763 static struct i2c_driver tmp401_driver = {
764 .class = I2C_CLASS_HWMON,
767 .of_match_table = of_match_ptr(tmp4xx_of_match),
769 .probe_new = tmp401_probe,
770 .id_table = tmp401_id,
771 .detect = tmp401_detect,
772 .address_list = normal_i2c,
775 module_i2c_driver(tmp401_driver);
777 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
778 MODULE_DESCRIPTION("Texas Instruments TMP401 temperature sensor driver");
779 MODULE_LICENSE("GPL");