1 // SPDX-License-Identifier: GPL-2.0
3 * max31827.c - Support for Maxim Low-Power Switch
5 * Copyright (c) 2023 Daniel Matyas <daniel.matyas@analog.com>
8 #include <linux/bitfield.h>
9 #include <linux/bitops.h>
10 #include <linux/delay.h>
11 #include <linux/hwmon.h>
12 #include <linux/i2c.h>
13 #include <linux/mutex.h>
14 #include <linux/of_device.h>
15 #include <linux/regmap.h>
16 #include <linux/regulator/consumer.h>
18 #define MAX31827_T_REG 0x0
19 #define MAX31827_CONFIGURATION_REG 0x2
20 #define MAX31827_TH_REG 0x4
21 #define MAX31827_TL_REG 0x6
22 #define MAX31827_TH_HYST_REG 0x8
23 #define MAX31827_TL_HYST_REG 0xA
25 #define MAX31827_CONFIGURATION_1SHOT_MASK BIT(0)
26 #define MAX31827_CONFIGURATION_CNV_RATE_MASK GENMASK(3, 1)
27 #define MAX31827_CONFIGURATION_TIMEOUT_MASK BIT(5)
28 #define MAX31827_CONFIGURATION_RESOLUTION_MASK GENMASK(7, 6)
29 #define MAX31827_CONFIGURATION_ALRM_POL_MASK BIT(8)
30 #define MAX31827_CONFIGURATION_COMP_INT_MASK BIT(9)
31 #define MAX31827_CONFIGURATION_FLT_Q_MASK GENMASK(11, 10)
32 #define MAX31827_CONFIGURATION_U_TEMP_STAT_MASK BIT(14)
33 #define MAX31827_CONFIGURATION_O_TEMP_STAT_MASK BIT(15)
35 #define MAX31827_ALRM_POL_LOW 0x0
36 #define MAX31827_ALRM_POL_HIGH 0x1
37 #define MAX31827_FLT_Q_1 0x0
38 #define MAX31827_FLT_Q_4 0x2
40 #define MAX31827_8_BIT_CNV_TIME 9
41 #define MAX31827_9_BIT_CNV_TIME 18
42 #define MAX31827_10_BIT_CNV_TIME 35
43 #define MAX31827_12_BIT_CNV_TIME 140
45 #define MAX31827_16_BIT_TO_M_DGR(x) (sign_extend32(x, 15) * 1000 / 16)
46 #define MAX31827_M_DGR_TO_16_BIT(x) (((x) << 4) / 1000)
47 #define MAX31827_DEVICE_ENABLE(x) ((x) ? 0xA : 0x0)
49 enum chips { max31827 = 1, max31828, max31829 };
52 MAX31827_CNV_1_DIV_64_HZ = 1,
53 MAX31827_CNV_1_DIV_32_HZ,
54 MAX31827_CNV_1_DIV_16_HZ,
55 MAX31827_CNV_1_DIV_4_HZ,
61 static const u16 max31827_conversions[] = {
62 [MAX31827_CNV_1_DIV_64_HZ] = 64000,
63 [MAX31827_CNV_1_DIV_32_HZ] = 32000,
64 [MAX31827_CNV_1_DIV_16_HZ] = 16000,
65 [MAX31827_CNV_1_DIV_4_HZ] = 4000,
66 [MAX31827_CNV_1_HZ] = 1000,
67 [MAX31827_CNV_4_HZ] = 250,
68 [MAX31827_CNV_8_HZ] = 125,
71 enum max31827_resolution {
72 MAX31827_RES_8_BIT = 0,
78 static const u16 max31827_resolutions[] = {
79 [MAX31827_RES_8_BIT] = 1000,
80 [MAX31827_RES_9_BIT] = 500,
81 [MAX31827_RES_10_BIT] = 250,
82 [MAX31827_RES_12_BIT] = 62,
85 static const u16 max31827_conv_times[] = {
86 [MAX31827_RES_8_BIT] = MAX31827_8_BIT_CNV_TIME,
87 [MAX31827_RES_9_BIT] = MAX31827_9_BIT_CNV_TIME,
88 [MAX31827_RES_10_BIT] = MAX31827_10_BIT_CNV_TIME,
89 [MAX31827_RES_12_BIT] = MAX31827_12_BIT_CNV_TIME,
92 struct max31827_state {
94 * Prevent simultaneous access to the i2c client.
97 struct regmap *regmap;
99 unsigned int resolution;
100 unsigned int update_interval;
103 static const struct regmap_config max31827_regmap = {
109 static int shutdown_write(struct max31827_state *st, unsigned int reg,
110 unsigned int mask, unsigned int val)
113 unsigned int cnv_rate;
117 * Before the Temperature Threshold Alarm, Alarm Hysteresis Threshold
118 * and Resolution bits from Configuration register are changed over I2C,
119 * the part must be in shutdown mode.
121 * Mutex is used to ensure, that some other process doesn't change the
122 * configuration register.
124 mutex_lock(&st->lock);
128 ret = regmap_write(st->regmap, reg, val);
130 ret = regmap_update_bits(st->regmap, reg, mask, val);
134 ret = regmap_read(st->regmap, MAX31827_CONFIGURATION_REG, &cfg);
138 cnv_rate = MAX31827_CONFIGURATION_CNV_RATE_MASK & cfg;
139 cfg = cfg & ~(MAX31827_CONFIGURATION_1SHOT_MASK |
140 MAX31827_CONFIGURATION_CNV_RATE_MASK);
141 ret = regmap_write(st->regmap, MAX31827_CONFIGURATION_REG, cfg);
146 ret = regmap_write(st->regmap, reg, val);
148 ret = regmap_update_bits(st->regmap, reg, mask, val);
153 ret = regmap_update_bits(st->regmap, MAX31827_CONFIGURATION_REG,
154 MAX31827_CONFIGURATION_CNV_RATE_MASK,
158 mutex_unlock(&st->lock);
162 static int write_alarm_val(struct max31827_state *st, unsigned int reg,
165 val = MAX31827_M_DGR_TO_16_BIT(val);
167 return shutdown_write(st, reg, 0, val);
170 static umode_t max31827_is_visible(const void *state,
171 enum hwmon_sensor_types type, u32 attr,
174 if (type == hwmon_temp) {
176 case hwmon_temp_enable:
179 case hwmon_temp_max_hyst:
180 case hwmon_temp_min_hyst:
182 case hwmon_temp_input:
183 case hwmon_temp_min_alarm:
184 case hwmon_temp_max_alarm:
189 } else if (type == hwmon_chip) {
190 if (attr == hwmon_chip_update_interval)
197 static int max31827_read(struct device *dev, enum hwmon_sensor_types type,
198 u32 attr, int channel, long *val)
200 struct max31827_state *st = dev_get_drvdata(dev);
207 case hwmon_temp_enable:
208 ret = regmap_read(st->regmap,
209 MAX31827_CONFIGURATION_REG, &uval);
213 uval = FIELD_GET(MAX31827_CONFIGURATION_1SHOT_MASK |
214 MAX31827_CONFIGURATION_CNV_RATE_MASK,
219 case hwmon_temp_input:
220 mutex_lock(&st->lock);
224 * This operation requires mutex protection,
225 * because the chip configuration should not
226 * be changed during the conversion process.
229 ret = regmap_update_bits(st->regmap,
230 MAX31827_CONFIGURATION_REG,
231 MAX31827_CONFIGURATION_1SHOT_MASK,
234 mutex_unlock(&st->lock);
237 msleep(max31827_conv_times[st->resolution]);
241 * For 12-bit resolution the conversion time is 140 ms,
242 * thus an additional 15 ms is needed to complete the
243 * conversion: 125 ms + 15 ms = 140 ms
245 if (max31827_resolutions[st->resolution] == 12 &&
246 st->update_interval == 125)
247 usleep_range(15000, 20000);
249 ret = regmap_read(st->regmap, MAX31827_T_REG, &uval);
251 mutex_unlock(&st->lock);
256 *val = MAX31827_16_BIT_TO_M_DGR(uval);
260 ret = regmap_read(st->regmap, MAX31827_TH_REG, &uval);
264 *val = MAX31827_16_BIT_TO_M_DGR(uval);
266 case hwmon_temp_max_hyst:
267 ret = regmap_read(st->regmap, MAX31827_TH_HYST_REG,
272 *val = MAX31827_16_BIT_TO_M_DGR(uval);
274 case hwmon_temp_max_alarm:
275 ret = regmap_read(st->regmap,
276 MAX31827_CONFIGURATION_REG, &uval);
280 *val = FIELD_GET(MAX31827_CONFIGURATION_O_TEMP_STAT_MASK,
284 ret = regmap_read(st->regmap, MAX31827_TL_REG, &uval);
288 *val = MAX31827_16_BIT_TO_M_DGR(uval);
290 case hwmon_temp_min_hyst:
291 ret = regmap_read(st->regmap, MAX31827_TL_HYST_REG,
296 *val = MAX31827_16_BIT_TO_M_DGR(uval);
298 case hwmon_temp_min_alarm:
299 ret = regmap_read(st->regmap,
300 MAX31827_CONFIGURATION_REG, &uval);
304 *val = FIELD_GET(MAX31827_CONFIGURATION_U_TEMP_STAT_MASK,
315 if (attr == hwmon_chip_update_interval) {
316 ret = regmap_read(st->regmap,
317 MAX31827_CONFIGURATION_REG, &uval);
321 uval = FIELD_GET(MAX31827_CONFIGURATION_CNV_RATE_MASK,
323 *val = max31827_conversions[uval];
335 static int max31827_write(struct device *dev, enum hwmon_sensor_types type,
336 u32 attr, int channel, long val)
338 struct max31827_state *st = dev_get_drvdata(dev);
345 case hwmon_temp_enable:
349 mutex_lock(&st->lock);
351 * The chip should not be enabled while a conversion is
352 * performed. Neither should the chip be enabled when
353 * the alarm values are changed.
358 ret = regmap_update_bits(st->regmap,
359 MAX31827_CONFIGURATION_REG,
360 MAX31827_CONFIGURATION_1SHOT_MASK |
361 MAX31827_CONFIGURATION_CNV_RATE_MASK,
362 MAX31827_DEVICE_ENABLE(val));
364 mutex_unlock(&st->lock);
369 return write_alarm_val(st, MAX31827_TH_REG, val);
371 case hwmon_temp_max_hyst:
372 return write_alarm_val(st, MAX31827_TH_HYST_REG, val);
375 return write_alarm_val(st, MAX31827_TL_REG, val);
377 case hwmon_temp_min_hyst:
378 return write_alarm_val(st, MAX31827_TL_HYST_REG, val);
385 if (attr == hwmon_chip_update_interval) {
390 * Convert the desired conversion rate into register
391 * bits. res is already initialized with 1.
393 * This was inspired by lm73 driver.
395 while (res < ARRAY_SIZE(max31827_conversions) &&
396 val < max31827_conversions[res])
399 if (res == ARRAY_SIZE(max31827_conversions))
400 res = ARRAY_SIZE(max31827_conversions) - 1;
402 res = FIELD_PREP(MAX31827_CONFIGURATION_CNV_RATE_MASK,
405 ret = regmap_update_bits(st->regmap,
406 MAX31827_CONFIGURATION_REG,
407 MAX31827_CONFIGURATION_CNV_RATE_MASK,
412 st->update_interval = val;
423 static ssize_t temp1_resolution_show(struct device *dev,
424 struct device_attribute *devattr,
427 struct max31827_state *st = dev_get_drvdata(dev);
431 ret = regmap_read(st->regmap, MAX31827_CONFIGURATION_REG, &val);
435 val = FIELD_GET(MAX31827_CONFIGURATION_RESOLUTION_MASK, val);
437 return scnprintf(buf, PAGE_SIZE, "%u\n", max31827_resolutions[val]);
440 static ssize_t temp1_resolution_store(struct device *dev,
441 struct device_attribute *devattr,
442 const char *buf, size_t count)
444 struct max31827_state *st = dev_get_drvdata(dev);
445 unsigned int idx = 0;
449 ret = kstrtouint(buf, 10, &val);
454 * Convert the desired resolution into register
455 * bits. idx is already initialized with 0.
457 * This was inspired by lm73 driver.
459 while (idx < ARRAY_SIZE(max31827_resolutions) &&
460 val < max31827_resolutions[idx])
463 if (idx == ARRAY_SIZE(max31827_resolutions))
464 idx = ARRAY_SIZE(max31827_resolutions) - 1;
466 st->resolution = idx;
468 ret = shutdown_write(st, MAX31827_CONFIGURATION_REG,
469 MAX31827_CONFIGURATION_RESOLUTION_MASK,
470 FIELD_PREP(MAX31827_CONFIGURATION_RESOLUTION_MASK,
473 return ret ? ret : count;
476 static DEVICE_ATTR_RW(temp1_resolution);
478 static struct attribute *max31827_attrs[] = {
479 &dev_attr_temp1_resolution.attr,
482 ATTRIBUTE_GROUPS(max31827);
484 static const struct i2c_device_id max31827_i2c_ids[] = {
485 { "max31827", max31827 },
486 { "max31828", max31828 },
487 { "max31829", max31829 },
490 MODULE_DEVICE_TABLE(i2c, max31827_i2c_ids);
492 static int max31827_init_client(struct max31827_state *st,
495 struct fwnode_handle *fwnode;
496 unsigned int res = 0;
502 fwnode = dev_fwnode(dev);
505 res |= MAX31827_DEVICE_ENABLE(1);
507 res |= MAX31827_CONFIGURATION_RESOLUTION_MASK;
509 prop = fwnode_property_read_bool(fwnode, "adi,comp-int");
510 res |= FIELD_PREP(MAX31827_CONFIGURATION_COMP_INT_MASK, prop);
512 prop = fwnode_property_read_bool(fwnode, "adi,timeout-enable");
513 res |= FIELD_PREP(MAX31827_CONFIGURATION_TIMEOUT_MASK, !prop);
515 type = (enum chips)(uintptr_t)device_get_match_data(dev);
517 if (fwnode_property_present(fwnode, "adi,alarm-pol")) {
518 ret = fwnode_property_read_u32(fwnode, "adi,alarm-pol", &data);
522 res |= FIELD_PREP(MAX31827_CONFIGURATION_ALRM_POL_MASK, !!data);
530 res |= FIELD_PREP(MAX31827_CONFIGURATION_ALRM_POL_MASK,
531 MAX31827_ALRM_POL_LOW);
534 res |= FIELD_PREP(MAX31827_CONFIGURATION_ALRM_POL_MASK,
535 MAX31827_ALRM_POL_HIGH);
542 if (fwnode_property_present(fwnode, "adi,fault-q")) {
543 ret = fwnode_property_read_u32(fwnode, "adi,fault-q", &data);
548 * Convert the desired fault queue into register bits.
551 lsb_idx = __ffs(data);
553 if (hweight32(data) != 1 || lsb_idx > 4) {
554 dev_err(dev, "Invalid data in adi,fault-q\n");
558 res |= FIELD_PREP(MAX31827_CONFIGURATION_FLT_Q_MASK, lsb_idx);
565 res |= FIELD_PREP(MAX31827_CONFIGURATION_FLT_Q_MASK,
570 res |= FIELD_PREP(MAX31827_CONFIGURATION_FLT_Q_MASK,
578 return regmap_write(st->regmap, MAX31827_CONFIGURATION_REG, res);
581 static const struct hwmon_channel_info *max31827_info[] = {
582 HWMON_CHANNEL_INFO(temp, HWMON_T_ENABLE | HWMON_T_INPUT | HWMON_T_MIN |
583 HWMON_T_MIN_HYST | HWMON_T_MIN_ALARM |
584 HWMON_T_MAX | HWMON_T_MAX_HYST |
586 HWMON_CHANNEL_INFO(chip, HWMON_C_UPDATE_INTERVAL),
590 static const struct hwmon_ops max31827_hwmon_ops = {
591 .is_visible = max31827_is_visible,
592 .read = max31827_read,
593 .write = max31827_write,
596 static const struct hwmon_chip_info max31827_chip_info = {
597 .ops = &max31827_hwmon_ops,
598 .info = max31827_info,
601 static int max31827_probe(struct i2c_client *client)
603 struct device *dev = &client->dev;
604 struct device *hwmon_dev;
605 struct max31827_state *st;
608 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WORD_DATA))
611 st = devm_kzalloc(dev, sizeof(*st), GFP_KERNEL);
615 mutex_init(&st->lock);
617 st->regmap = devm_regmap_init_i2c(client, &max31827_regmap);
618 if (IS_ERR(st->regmap))
619 return dev_err_probe(dev, PTR_ERR(st->regmap),
620 "Failed to allocate regmap.\n");
622 err = devm_regulator_get_enable(dev, "vref");
624 return dev_err_probe(dev, err, "failed to enable regulator\n");
626 err = max31827_init_client(st, dev);
630 hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name, st,
634 return PTR_ERR_OR_ZERO(hwmon_dev);
637 static const struct of_device_id max31827_of_match[] = {
639 .compatible = "adi,max31827",
640 .data = (void *)max31827
643 .compatible = "adi,max31828",
644 .data = (void *)max31828
647 .compatible = "adi,max31829",
648 .data = (void *)max31829
652 MODULE_DEVICE_TABLE(of, max31827_of_match);
654 static struct i2c_driver max31827_driver = {
655 .class = I2C_CLASS_HWMON,
658 .of_match_table = max31827_of_match,
660 .probe = max31827_probe,
661 .id_table = max31827_i2c_ids,
663 module_i2c_driver(max31827_driver);
665 MODULE_AUTHOR("Daniel Matyas <daniel.matyas@analog.com>");
666 MODULE_DESCRIPTION("Maxim MAX31827 low-power temperature switch driver");
667 MODULE_LICENSE("GPL");