1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * jc42.c - driver for Jedec JC42.4 compliant temperature sensors
5 * Copyright (c) 2010 Ericsson AB.
7 * Derived from lm77.c by Andras BALI <drewie@freemail.hu>.
9 * JC42.4 compliant temperature sensors are typically used on memory modules.
12 #include <linux/bitops.h>
13 #include <linux/bitfield.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/slab.h>
17 #include <linux/jiffies.h>
18 #include <linux/i2c.h>
19 #include <linux/hwmon.h>
20 #include <linux/err.h>
21 #include <linux/mutex.h>
23 #include <linux/regmap.h>
25 /* Addresses to scan */
26 static const unsigned short normal_i2c[] = {
27 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, I2C_CLIENT_END };
29 /* JC42 registers. All registers are 16 bit. */
30 #define JC42_REG_CAP 0x00
31 #define JC42_REG_CONFIG 0x01
32 #define JC42_REG_TEMP_UPPER 0x02
33 #define JC42_REG_TEMP_LOWER 0x03
34 #define JC42_REG_TEMP_CRITICAL 0x04
35 #define JC42_REG_TEMP 0x05
36 #define JC42_REG_MANID 0x06
37 #define JC42_REG_DEVICEID 0x07
38 #define JC42_REG_SMBUS 0x22 /* NXP and Atmel, possibly others? */
40 /* Status bits in temperature register */
41 #define JC42_ALARM_CRIT BIT(15)
42 #define JC42_ALARM_MAX BIT(14)
43 #define JC42_ALARM_MIN BIT(13)
45 /* Configuration register defines */
46 #define JC42_CFG_CRIT_ONLY BIT(2)
47 #define JC42_CFG_TCRIT_LOCK BIT(6)
48 #define JC42_CFG_EVENT_LOCK BIT(7)
49 #define JC42_CFG_SHUTDOWN BIT(8)
50 #define JC42_CFG_HYST_MASK GENMASK(10, 9)
53 #define JC42_CAP_RANGE BIT(2)
55 /* Manufacturer IDs */
56 #define ADT_MANID 0x11d4 /* Analog Devices */
57 #define ATMEL_MANID 0x001f /* Atmel */
58 #define ATMEL_MANID2 0x1114 /* Atmel */
59 #define MAX_MANID 0x004d /* Maxim */
60 #define IDT_MANID 0x00b3 /* IDT */
61 #define MCP_MANID 0x0054 /* Microchip */
62 #define NXP_MANID 0x1131 /* NXP Semiconductors */
63 #define ONS_MANID 0x1b09 /* ON Semiconductor */
64 #define STM_MANID 0x104a /* ST Microelectronics */
65 #define GT_MANID 0x1c68 /* Giantec */
66 #define GT_MANID2 0x132d /* Giantec, 2nd mfg ID */
67 #define SI_MANID 0x1c85 /* Seiko Instruments */
70 #define SMBUS_STMOUT BIT(7) /* SMBus time-out, active low */
75 #define ADT7408_DEVID 0x0801
76 #define ADT7408_DEVID_MASK 0xffff
79 #define AT30TS00_DEVID 0x8201
80 #define AT30TS00_DEVID_MASK 0xffff
82 #define AT30TSE004_DEVID 0x2200
83 #define AT30TSE004_DEVID_MASK 0xffff
86 #define GT30TS00_DEVID 0x2200
87 #define GT30TS00_DEVID_MASK 0xff00
89 #define GT34TS02_DEVID 0x3300
90 #define GT34TS02_DEVID_MASK 0xff00
93 #define TSE2004_DEVID 0x2200
94 #define TSE2004_DEVID_MASK 0xff00
96 #define TS3000_DEVID 0x2900 /* Also matches TSE2002 */
97 #define TS3000_DEVID_MASK 0xff00
99 #define TS3001_DEVID 0x3000
100 #define TS3001_DEVID_MASK 0xff00
103 #define MAX6604_DEVID 0x3e00
104 #define MAX6604_DEVID_MASK 0xffff
107 #define MCP9804_DEVID 0x0200
108 #define MCP9804_DEVID_MASK 0xfffc
110 #define MCP9808_DEVID 0x0400
111 #define MCP9808_DEVID_MASK 0xfffc
113 #define MCP98242_DEVID 0x2000
114 #define MCP98242_DEVID_MASK 0xfffc
116 #define MCP98243_DEVID 0x2100
117 #define MCP98243_DEVID_MASK 0xfffc
119 #define MCP98244_DEVID 0x2200
120 #define MCP98244_DEVID_MASK 0xfffc
122 #define MCP9843_DEVID 0x0000 /* Also matches mcp9805 */
123 #define MCP9843_DEVID_MASK 0xfffe
126 #define SE97_DEVID 0xa200
127 #define SE97_DEVID_MASK 0xfffc
129 #define SE98_DEVID 0xa100
130 #define SE98_DEVID_MASK 0xfffc
132 /* ON Semiconductor */
133 #define CAT6095_DEVID 0x0800 /* Also matches CAT34TS02 */
134 #define CAT6095_DEVID_MASK 0xffe0
136 #define CAT34TS02C_DEVID 0x0a00
137 #define CAT34TS02C_DEVID_MASK 0xfff0
139 #define CAT34TS04_DEVID 0x2200
140 #define CAT34TS04_DEVID_MASK 0xfff0
142 #define N34TS04_DEVID 0x2230
143 #define N34TS04_DEVID_MASK 0xfff0
145 /* ST Microelectronics */
146 #define STTS424_DEVID 0x0101
147 #define STTS424_DEVID_MASK 0xffff
149 #define STTS424E_DEVID 0x0000
150 #define STTS424E_DEVID_MASK 0xfffe
152 #define STTS2002_DEVID 0x0300
153 #define STTS2002_DEVID_MASK 0xffff
155 #define STTS2004_DEVID 0x2201
156 #define STTS2004_DEVID_MASK 0xffff
158 #define STTS3000_DEVID 0x0200
159 #define STTS3000_DEVID_MASK 0xffff
161 /* Seiko Instruments */
162 #define S34TS04A_DEVID 0x2221
163 #define S34TS04A_DEVID_MASK 0xffff
165 static u16 jc42_hysteresis[] = { 0, 1500, 3000, 6000 };
173 static struct jc42_chips jc42_chips[] = {
174 { ADT_MANID, ADT7408_DEVID, ADT7408_DEVID_MASK },
175 { ATMEL_MANID, AT30TS00_DEVID, AT30TS00_DEVID_MASK },
176 { ATMEL_MANID2, AT30TSE004_DEVID, AT30TSE004_DEVID_MASK },
177 { GT_MANID, GT30TS00_DEVID, GT30TS00_DEVID_MASK },
178 { GT_MANID2, GT34TS02_DEVID, GT34TS02_DEVID_MASK },
179 { IDT_MANID, TSE2004_DEVID, TSE2004_DEVID_MASK },
180 { IDT_MANID, TS3000_DEVID, TS3000_DEVID_MASK },
181 { IDT_MANID, TS3001_DEVID, TS3001_DEVID_MASK },
182 { MAX_MANID, MAX6604_DEVID, MAX6604_DEVID_MASK },
183 { MCP_MANID, MCP9804_DEVID, MCP9804_DEVID_MASK },
184 { MCP_MANID, MCP9808_DEVID, MCP9808_DEVID_MASK },
185 { MCP_MANID, MCP98242_DEVID, MCP98242_DEVID_MASK },
186 { MCP_MANID, MCP98243_DEVID, MCP98243_DEVID_MASK },
187 { MCP_MANID, MCP98244_DEVID, MCP98244_DEVID_MASK },
188 { MCP_MANID, MCP9843_DEVID, MCP9843_DEVID_MASK },
189 { NXP_MANID, SE97_DEVID, SE97_DEVID_MASK },
190 { ONS_MANID, CAT6095_DEVID, CAT6095_DEVID_MASK },
191 { ONS_MANID, CAT34TS02C_DEVID, CAT34TS02C_DEVID_MASK },
192 { ONS_MANID, CAT34TS04_DEVID, CAT34TS04_DEVID_MASK },
193 { ONS_MANID, N34TS04_DEVID, N34TS04_DEVID_MASK },
194 { NXP_MANID, SE98_DEVID, SE98_DEVID_MASK },
195 { SI_MANID, S34TS04A_DEVID, S34TS04A_DEVID_MASK },
196 { STM_MANID, STTS424_DEVID, STTS424_DEVID_MASK },
197 { STM_MANID, STTS424E_DEVID, STTS424E_DEVID_MASK },
198 { STM_MANID, STTS2002_DEVID, STTS2002_DEVID_MASK },
199 { STM_MANID, STTS2004_DEVID, STTS2004_DEVID_MASK },
200 { STM_MANID, STTS3000_DEVID, STTS3000_DEVID_MASK },
203 /* Each client has this additional data */
205 struct mutex update_lock; /* protect register access */
206 struct regmap *regmap;
207 bool extended; /* true if extended range supported */
209 u16 orig_config; /* original configuration */
210 u16 config; /* current configuration */
213 #define JC42_TEMP_MIN_EXTENDED (-40000)
214 #define JC42_TEMP_MIN 0
215 #define JC42_TEMP_MAX 125000
217 static u16 jc42_temp_to_reg(long temp, bool extended)
219 int ntemp = clamp_val(temp,
220 extended ? JC42_TEMP_MIN_EXTENDED :
221 JC42_TEMP_MIN, JC42_TEMP_MAX);
223 /* convert from 0.001 to 0.0625 resolution */
224 return (ntemp * 2 / 125) & 0x1fff;
227 static int jc42_temp_from_reg(s16 reg)
229 reg = sign_extend32(reg, 12);
231 /* convert from 0.0625 to 0.001 resolution */
232 return reg * 125 / 2;
235 static int jc42_read(struct device *dev, enum hwmon_sensor_types type,
236 u32 attr, int channel, long *val)
238 struct jc42_data *data = dev_get_drvdata(dev);
242 mutex_lock(&data->update_lock);
245 case hwmon_temp_input:
246 ret = regmap_read(data->regmap, JC42_REG_TEMP, ®val);
250 *val = jc42_temp_from_reg(regval);
253 ret = regmap_read(data->regmap, JC42_REG_TEMP_LOWER, ®val);
257 *val = jc42_temp_from_reg(regval);
260 ret = regmap_read(data->regmap, JC42_REG_TEMP_UPPER, ®val);
264 *val = jc42_temp_from_reg(regval);
266 case hwmon_temp_crit:
267 ret = regmap_read(data->regmap, JC42_REG_TEMP_CRITICAL,
272 *val = jc42_temp_from_reg(regval);
274 case hwmon_temp_max_hyst:
275 ret = regmap_read(data->regmap, JC42_REG_TEMP_UPPER, ®val);
279 temp = jc42_temp_from_reg(regval);
280 hyst = jc42_hysteresis[FIELD_GET(JC42_CFG_HYST_MASK,
284 case hwmon_temp_crit_hyst:
285 ret = regmap_read(data->regmap, JC42_REG_TEMP_CRITICAL,
290 temp = jc42_temp_from_reg(regval);
291 hyst = jc42_hysteresis[FIELD_GET(JC42_CFG_HYST_MASK,
295 case hwmon_temp_min_alarm:
296 ret = regmap_read(data->regmap, JC42_REG_TEMP, ®val);
300 *val = FIELD_GET(JC42_ALARM_MIN, regval);
302 case hwmon_temp_max_alarm:
303 ret = regmap_read(data->regmap, JC42_REG_TEMP, ®val);
307 *val = FIELD_GET(JC42_ALARM_MAX, regval);
309 case hwmon_temp_crit_alarm:
310 ret = regmap_read(data->regmap, JC42_REG_TEMP, ®val);
314 *val = FIELD_GET(JC42_ALARM_CRIT, regval);
321 mutex_unlock(&data->update_lock);
326 static int jc42_write(struct device *dev, enum hwmon_sensor_types type,
327 u32 attr, int channel, long val)
329 struct jc42_data *data = dev_get_drvdata(dev);
334 mutex_lock(&data->update_lock);
338 ret = regmap_write(data->regmap, JC42_REG_TEMP_LOWER,
339 jc42_temp_to_reg(val, data->extended));
342 ret = regmap_write(data->regmap, JC42_REG_TEMP_UPPER,
343 jc42_temp_to_reg(val, data->extended));
345 case hwmon_temp_crit:
346 ret = regmap_write(data->regmap, JC42_REG_TEMP_CRITICAL,
347 jc42_temp_to_reg(val, data->extended));
349 case hwmon_temp_crit_hyst:
350 ret = regmap_read(data->regmap, JC42_REG_TEMP_CRITICAL,
356 * JC42.4 compliant chips only support four hysteresis values.
357 * Pick best choice and go from there.
359 val = clamp_val(val, (data->extended ? JC42_TEMP_MIN_EXTENDED
360 : JC42_TEMP_MIN) - 6000,
362 diff = jc42_temp_from_reg(regval) - val;
366 hyst = 1; /* 1.5 degrees C */
367 else if (diff < 4500)
368 hyst = 2; /* 3.0 degrees C */
370 hyst = 3; /* 6.0 degrees C */
372 data->config = (data->config & ~JC42_CFG_HYST_MASK) |
373 FIELD_PREP(JC42_CFG_HYST_MASK, hyst);
374 ret = regmap_write(data->regmap, JC42_REG_CONFIG,
382 mutex_unlock(&data->update_lock);
387 static umode_t jc42_is_visible(const void *_data, enum hwmon_sensor_types type,
388 u32 attr, int channel)
390 const struct jc42_data *data = _data;
391 unsigned int config = data->config;
397 if (!(config & JC42_CFG_EVENT_LOCK))
400 case hwmon_temp_crit:
401 if (!(config & JC42_CFG_TCRIT_LOCK))
404 case hwmon_temp_crit_hyst:
405 if (!(config & (JC42_CFG_EVENT_LOCK | JC42_CFG_TCRIT_LOCK)))
408 case hwmon_temp_input:
409 case hwmon_temp_max_hyst:
410 case hwmon_temp_min_alarm:
411 case hwmon_temp_max_alarm:
412 case hwmon_temp_crit_alarm:
421 /* Return 0 if detection is successful, -ENODEV otherwise */
422 static int jc42_detect(struct i2c_client *client, struct i2c_board_info *info)
424 struct i2c_adapter *adapter = client->adapter;
425 int i, config, cap, manid, devid;
427 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
428 I2C_FUNC_SMBUS_WORD_DATA))
431 cap = i2c_smbus_read_word_swapped(client, JC42_REG_CAP);
432 config = i2c_smbus_read_word_swapped(client, JC42_REG_CONFIG);
433 manid = i2c_smbus_read_word_swapped(client, JC42_REG_MANID);
434 devid = i2c_smbus_read_word_swapped(client, JC42_REG_DEVICEID);
436 if (cap < 0 || config < 0 || manid < 0 || devid < 0)
439 if ((cap & 0xff00) || (config & 0xf800))
442 for (i = 0; i < ARRAY_SIZE(jc42_chips); i++) {
443 struct jc42_chips *chip = &jc42_chips[i];
444 if (manid == chip->manid &&
445 (devid & chip->devid_mask) == chip->devid) {
446 strscpy(info->type, "jc42", I2C_NAME_SIZE);
453 static const struct hwmon_channel_info * const jc42_info[] = {
454 HWMON_CHANNEL_INFO(chip,
455 HWMON_C_REGISTER_TZ | HWMON_C_UPDATE_INTERVAL),
456 HWMON_CHANNEL_INFO(temp,
457 HWMON_T_INPUT | HWMON_T_MIN | HWMON_T_MAX |
458 HWMON_T_CRIT | HWMON_T_MAX_HYST |
459 HWMON_T_CRIT_HYST | HWMON_T_MIN_ALARM |
460 HWMON_T_MAX_ALARM | HWMON_T_CRIT_ALARM),
464 static const struct hwmon_ops jc42_hwmon_ops = {
465 .is_visible = jc42_is_visible,
470 static const struct hwmon_chip_info jc42_chip_info = {
471 .ops = &jc42_hwmon_ops,
475 static bool jc42_readable_reg(struct device *dev, unsigned int reg)
477 return (reg >= JC42_REG_CAP && reg <= JC42_REG_DEVICEID) ||
478 reg == JC42_REG_SMBUS;
481 static bool jc42_writable_reg(struct device *dev, unsigned int reg)
483 return (reg >= JC42_REG_CONFIG && reg <= JC42_REG_TEMP_CRITICAL) ||
484 reg == JC42_REG_SMBUS;
487 static bool jc42_volatile_reg(struct device *dev, unsigned int reg)
489 return reg == JC42_REG_CONFIG || reg == JC42_REG_TEMP;
492 static const struct regmap_config jc42_regmap_config = {
495 .val_format_endian = REGMAP_ENDIAN_BIG,
496 .max_register = JC42_REG_SMBUS,
497 .writeable_reg = jc42_writable_reg,
498 .readable_reg = jc42_readable_reg,
499 .volatile_reg = jc42_volatile_reg,
500 .cache_type = REGCACHE_RBTREE,
503 static int jc42_probe(struct i2c_client *client)
505 struct device *dev = &client->dev;
506 struct device *hwmon_dev;
507 unsigned int config, cap;
508 struct jc42_data *data;
511 data = devm_kzalloc(dev, sizeof(struct jc42_data), GFP_KERNEL);
515 data->regmap = devm_regmap_init_i2c(client, &jc42_regmap_config);
516 if (IS_ERR(data->regmap))
517 return PTR_ERR(data->regmap);
519 i2c_set_clientdata(client, data);
520 mutex_init(&data->update_lock);
522 ret = regmap_read(data->regmap, JC42_REG_CAP, &cap);
526 data->extended = !!(cap & JC42_CAP_RANGE);
528 if (device_property_read_bool(dev, "smbus-timeout-disable")) {
530 * Not all chips support this register, but from a
531 * quick read of various datasheets no chip appears
532 * incompatible with the below attempt to disable
533 * the timeout. And the whole thing is opt-in...
535 ret = regmap_set_bits(data->regmap, JC42_REG_SMBUS,
541 ret = regmap_read(data->regmap, JC42_REG_CONFIG, &config);
545 data->orig_config = config;
546 if (config & JC42_CFG_SHUTDOWN) {
547 config &= ~JC42_CFG_SHUTDOWN;
548 regmap_write(data->regmap, JC42_REG_CONFIG, config);
550 data->config = config;
552 hwmon_dev = devm_hwmon_device_register_with_info(dev, "jc42",
553 data, &jc42_chip_info,
555 return PTR_ERR_OR_ZERO(hwmon_dev);
558 static void jc42_remove(struct i2c_client *client)
560 struct jc42_data *data = i2c_get_clientdata(client);
562 /* Restore original configuration except hysteresis */
563 if ((data->config & ~JC42_CFG_HYST_MASK) !=
564 (data->orig_config & ~JC42_CFG_HYST_MASK)) {
567 config = (data->orig_config & ~JC42_CFG_HYST_MASK)
568 | (data->config & JC42_CFG_HYST_MASK);
569 regmap_write(data->regmap, JC42_REG_CONFIG, config);
575 static int jc42_suspend(struct device *dev)
577 struct jc42_data *data = dev_get_drvdata(dev);
579 data->config |= JC42_CFG_SHUTDOWN;
580 regmap_write(data->regmap, JC42_REG_CONFIG, data->config);
582 regcache_cache_only(data->regmap, true);
583 regcache_mark_dirty(data->regmap);
588 static int jc42_resume(struct device *dev)
590 struct jc42_data *data = dev_get_drvdata(dev);
592 regcache_cache_only(data->regmap, false);
594 data->config &= ~JC42_CFG_SHUTDOWN;
595 regmap_write(data->regmap, JC42_REG_CONFIG, data->config);
597 /* Restore cached register values to hardware */
598 return regcache_sync(data->regmap);
601 static const struct dev_pm_ops jc42_dev_pm_ops = {
602 .suspend = jc42_suspend,
603 .resume = jc42_resume,
606 #define JC42_DEV_PM_OPS (&jc42_dev_pm_ops)
608 #define JC42_DEV_PM_OPS NULL
609 #endif /* CONFIG_PM */
611 static const struct i2c_device_id jc42_id[] = {
615 MODULE_DEVICE_TABLE(i2c, jc42_id);
618 static const struct of_device_id jc42_of_ids[] = {
619 { .compatible = "jedec,jc-42.4-temp", },
622 MODULE_DEVICE_TABLE(of, jc42_of_ids);
625 static struct i2c_driver jc42_driver = {
626 .class = I2C_CLASS_SPD | I2C_CLASS_HWMON,
629 .pm = JC42_DEV_PM_OPS,
630 .of_match_table = of_match_ptr(jc42_of_ids),
633 .remove = jc42_remove,
635 .detect = jc42_detect,
636 .address_list = normal_i2c,
639 module_i2c_driver(jc42_driver);
641 MODULE_AUTHOR("Guenter Roeck <linux@roeck-us.net>");
642 MODULE_DESCRIPTION("JC42 driver");
643 MODULE_LICENSE("GPL");