2 * jc42.c - driver for Jedec JC42.4 compliant temperature sensors
4 * Copyright (c) 2010 Ericsson AB.
6 * Derived from lm77.c by Andras BALI <drewie@freemail.hu>.
8 * JC42.4 compliant temperature sensors are typically used on memory modules.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <linux/jiffies.h>
29 #include <linux/i2c.h>
30 #include <linux/hwmon.h>
31 #include <linux/hwmon-sysfs.h>
32 #include <linux/err.h>
33 #include <linux/mutex.h>
35 /* Addresses to scan */
36 static const unsigned short normal_i2c[] = {
37 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, I2C_CLIENT_END };
39 /* JC42 registers. All registers are 16 bit. */
40 #define JC42_REG_CAP 0x00
41 #define JC42_REG_CONFIG 0x01
42 #define JC42_REG_TEMP_UPPER 0x02
43 #define JC42_REG_TEMP_LOWER 0x03
44 #define JC42_REG_TEMP_CRITICAL 0x04
45 #define JC42_REG_TEMP 0x05
46 #define JC42_REG_MANID 0x06
47 #define JC42_REG_DEVICEID 0x07
49 /* Status bits in temperature register */
50 #define JC42_ALARM_CRIT_BIT 15
51 #define JC42_ALARM_MAX_BIT 14
52 #define JC42_ALARM_MIN_BIT 13
54 /* Configuration register defines */
55 #define JC42_CFG_CRIT_ONLY (1 << 2)
56 #define JC42_CFG_TCRIT_LOCK (1 << 6)
57 #define JC42_CFG_EVENT_LOCK (1 << 7)
58 #define JC42_CFG_SHUTDOWN (1 << 8)
59 #define JC42_CFG_HYST_SHIFT 9
60 #define JC42_CFG_HYST_MASK (0x03 << 9)
63 #define JC42_CAP_RANGE (1 << 2)
65 /* Manufacturer IDs */
66 #define ADT_MANID 0x11d4 /* Analog Devices */
67 #define ATMEL_MANID 0x001f /* Atmel */
68 #define ATMEL_MANID2 0x1114 /* Atmel */
69 #define MAX_MANID 0x004d /* Maxim */
70 #define IDT_MANID 0x00b3 /* IDT */
71 #define MCP_MANID 0x0054 /* Microchip */
72 #define NXP_MANID 0x1131 /* NXP Semiconductors */
73 #define ONS_MANID 0x1b09 /* ON Semiconductor */
74 #define STM_MANID 0x104a /* ST Microelectronics */
79 #define ADT7408_DEVID 0x0801
80 #define ADT7408_DEVID_MASK 0xffff
83 #define AT30TS00_DEVID 0x8201
84 #define AT30TS00_DEVID_MASK 0xffff
86 #define AT30TSE004_DEVID 0x2200
87 #define AT30TSE004_DEVID_MASK 0xffff
90 #define TSE2004_DEVID 0x2200
91 #define TSE2004_DEVID_MASK 0xff00
93 #define TS3000_DEVID 0x2900 /* Also matches TSE2002 */
94 #define TS3000_DEVID_MASK 0xff00
96 #define TS3001_DEVID 0x3000
97 #define TS3001_DEVID_MASK 0xff00
100 #define MAX6604_DEVID 0x3e00
101 #define MAX6604_DEVID_MASK 0xffff
104 #define MCP9804_DEVID 0x0200
105 #define MCP9804_DEVID_MASK 0xfffc
107 #define MCP9808_DEVID 0x0400
108 #define MCP9808_DEVID_MASK 0xfffc
110 #define MCP98242_DEVID 0x2000
111 #define MCP98242_DEVID_MASK 0xfffc
113 #define MCP98243_DEVID 0x2100
114 #define MCP98243_DEVID_MASK 0xfffc
116 #define MCP98244_DEVID 0x2200
117 #define MCP98244_DEVID_MASK 0xfffc
119 #define MCP9843_DEVID 0x0000 /* Also matches mcp9805 */
120 #define MCP9843_DEVID_MASK 0xfffe
123 #define SE97_DEVID 0xa200
124 #define SE97_DEVID_MASK 0xfffc
126 #define SE98_DEVID 0xa100
127 #define SE98_DEVID_MASK 0xfffc
129 /* ON Semiconductor */
130 #define CAT6095_DEVID 0x0800 /* Also matches CAT34TS02 */
131 #define CAT6095_DEVID_MASK 0xffe0
133 /* ST Microelectronics */
134 #define STTS424_DEVID 0x0101
135 #define STTS424_DEVID_MASK 0xffff
137 #define STTS424E_DEVID 0x0000
138 #define STTS424E_DEVID_MASK 0xfffe
140 #define STTS2002_DEVID 0x0300
141 #define STTS2002_DEVID_MASK 0xffff
143 #define STTS2004_DEVID 0x2201
144 #define STTS2004_DEVID_MASK 0xffff
146 #define STTS3000_DEVID 0x0200
147 #define STTS3000_DEVID_MASK 0xffff
149 static u16 jc42_hysteresis[] = { 0, 1500, 3000, 6000 };
157 static struct jc42_chips jc42_chips[] = {
158 { ADT_MANID, ADT7408_DEVID, ADT7408_DEVID_MASK },
159 { ATMEL_MANID, AT30TS00_DEVID, AT30TS00_DEVID_MASK },
160 { ATMEL_MANID2, AT30TSE004_DEVID, AT30TSE004_DEVID_MASK },
161 { IDT_MANID, TSE2004_DEVID, TSE2004_DEVID_MASK },
162 { IDT_MANID, TS3000_DEVID, TS3000_DEVID_MASK },
163 { IDT_MANID, TS3001_DEVID, TS3001_DEVID_MASK },
164 { MAX_MANID, MAX6604_DEVID, MAX6604_DEVID_MASK },
165 { MCP_MANID, MCP9804_DEVID, MCP9804_DEVID_MASK },
166 { MCP_MANID, MCP9808_DEVID, MCP9808_DEVID_MASK },
167 { MCP_MANID, MCP98242_DEVID, MCP98242_DEVID_MASK },
168 { MCP_MANID, MCP98243_DEVID, MCP98243_DEVID_MASK },
169 { MCP_MANID, MCP98244_DEVID, MCP98244_DEVID_MASK },
170 { MCP_MANID, MCP9843_DEVID, MCP9843_DEVID_MASK },
171 { NXP_MANID, SE97_DEVID, SE97_DEVID_MASK },
172 { ONS_MANID, CAT6095_DEVID, CAT6095_DEVID_MASK },
173 { NXP_MANID, SE98_DEVID, SE98_DEVID_MASK },
174 { STM_MANID, STTS424_DEVID, STTS424_DEVID_MASK },
175 { STM_MANID, STTS424E_DEVID, STTS424E_DEVID_MASK },
176 { STM_MANID, STTS2002_DEVID, STTS2002_DEVID_MASK },
177 { STM_MANID, STTS2004_DEVID, STTS2004_DEVID_MASK },
178 { STM_MANID, STTS3000_DEVID, STTS3000_DEVID_MASK },
189 static const u8 temp_regs[t_num_temp] = {
190 [t_input] = JC42_REG_TEMP,
191 [t_crit] = JC42_REG_TEMP_CRITICAL,
192 [t_min] = JC42_REG_TEMP_LOWER,
193 [t_max] = JC42_REG_TEMP_UPPER,
196 /* Each client has this additional data */
198 struct i2c_client *client;
199 struct mutex update_lock; /* protect register access */
200 bool extended; /* true if extended range supported */
202 unsigned long last_updated; /* In jiffies */
203 u16 orig_config; /* original configuration */
204 u16 config; /* current configuration */
205 u16 temp[t_num_temp];/* Temperatures */
208 #define JC42_TEMP_MIN_EXTENDED (-40000)
209 #define JC42_TEMP_MIN 0
210 #define JC42_TEMP_MAX 125000
212 static u16 jc42_temp_to_reg(long temp, bool extended)
214 int ntemp = clamp_val(temp,
215 extended ? JC42_TEMP_MIN_EXTENDED :
216 JC42_TEMP_MIN, JC42_TEMP_MAX);
218 /* convert from 0.001 to 0.0625 resolution */
219 return (ntemp * 2 / 125) & 0x1fff;
222 static int jc42_temp_from_reg(s16 reg)
224 reg = sign_extend32(reg, 12);
226 /* convert from 0.0625 to 0.001 resolution */
227 return reg * 125 / 2;
230 static struct jc42_data *jc42_update_device(struct device *dev)
232 struct jc42_data *data = dev_get_drvdata(dev);
233 struct i2c_client *client = data->client;
234 struct jc42_data *ret = data;
237 mutex_lock(&data->update_lock);
239 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
240 for (i = 0; i < t_num_temp; i++) {
241 val = i2c_smbus_read_word_swapped(client, temp_regs[i]);
248 data->last_updated = jiffies;
252 mutex_unlock(&data->update_lock);
256 /* sysfs functions */
258 static ssize_t show_temp(struct device *dev, struct device_attribute *devattr,
261 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
262 struct jc42_data *data = jc42_update_device(dev);
264 return PTR_ERR(data);
265 return sprintf(buf, "%d\n",
266 jc42_temp_from_reg(data->temp[attr->index]));
269 static ssize_t show_temp_hyst(struct device *dev,
270 struct device_attribute *devattr, char *buf)
272 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
273 struct jc42_data *data = jc42_update_device(dev);
277 return PTR_ERR(data);
279 temp = jc42_temp_from_reg(data->temp[attr->index]);
280 hyst = jc42_hysteresis[(data->config & JC42_CFG_HYST_MASK)
281 >> JC42_CFG_HYST_SHIFT];
282 return sprintf(buf, "%d\n", temp - hyst);
285 static ssize_t set_temp(struct device *dev, struct device_attribute *devattr,
286 const char *buf, size_t count)
288 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
289 struct jc42_data *data = dev_get_drvdata(dev);
290 int err, ret = count;
291 int nr = attr->index;
294 if (kstrtol(buf, 10, &val) < 0)
296 mutex_lock(&data->update_lock);
297 data->temp[nr] = jc42_temp_to_reg(val, data->extended);
298 err = i2c_smbus_write_word_swapped(data->client, temp_regs[nr],
302 mutex_unlock(&data->update_lock);
307 * JC42.4 compliant chips only support four hysteresis values.
308 * Pick best choice and go from there.
310 static ssize_t set_temp_crit_hyst(struct device *dev,
311 struct device_attribute *attr,
312 const char *buf, size_t count)
314 struct jc42_data *data = dev_get_drvdata(dev);
320 if (kstrtol(buf, 10, &val) < 0)
323 val = clamp_val(val, (data->extended ? JC42_TEMP_MIN_EXTENDED :
324 JC42_TEMP_MIN) - 6000, JC42_TEMP_MAX);
325 diff = jc42_temp_from_reg(data->temp[t_crit]) - val;
330 hyst = 1; /* 1.5 degrees C */
331 else if (diff < 4500)
332 hyst = 2; /* 3.0 degrees C */
334 hyst = 3; /* 6.0 degrees C */
337 mutex_lock(&data->update_lock);
338 data->config = (data->config & ~JC42_CFG_HYST_MASK)
339 | (hyst << JC42_CFG_HYST_SHIFT);
340 err = i2c_smbus_write_word_swapped(data->client, JC42_REG_CONFIG,
344 mutex_unlock(&data->update_lock);
348 static ssize_t show_alarm(struct device *dev,
349 struct device_attribute *attr, char *buf)
351 u16 bit = to_sensor_dev_attr(attr)->index;
352 struct jc42_data *data = jc42_update_device(dev);
356 return PTR_ERR(data);
358 val = data->temp[t_input];
359 if (bit != JC42_ALARM_CRIT_BIT && (data->config & JC42_CFG_CRIT_ONLY))
361 return sprintf(buf, "%u\n", (val >> bit) & 1);
364 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, t_input);
365 static SENSOR_DEVICE_ATTR(temp1_crit, S_IRUGO, show_temp, set_temp, t_crit);
366 static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO, show_temp, set_temp, t_min);
367 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, set_temp, t_max);
369 static SENSOR_DEVICE_ATTR(temp1_crit_hyst, S_IRUGO, show_temp_hyst,
370 set_temp_crit_hyst, t_crit);
371 static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IRUGO, show_temp_hyst, NULL, t_max);
373 static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL,
374 JC42_ALARM_CRIT_BIT);
375 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL,
377 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL,
380 static struct attribute *jc42_attributes[] = {
381 &sensor_dev_attr_temp1_input.dev_attr.attr,
382 &sensor_dev_attr_temp1_crit.dev_attr.attr,
383 &sensor_dev_attr_temp1_min.dev_attr.attr,
384 &sensor_dev_attr_temp1_max.dev_attr.attr,
385 &sensor_dev_attr_temp1_crit_hyst.dev_attr.attr,
386 &sensor_dev_attr_temp1_max_hyst.dev_attr.attr,
387 &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr,
388 &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
389 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
393 static umode_t jc42_attribute_mode(struct kobject *kobj,
394 struct attribute *attr, int index)
396 struct device *dev = container_of(kobj, struct device, kobj);
397 struct jc42_data *data = dev_get_drvdata(dev);
398 unsigned int config = data->config;
401 if (attr == &sensor_dev_attr_temp1_crit.dev_attr.attr)
402 readonly = config & JC42_CFG_TCRIT_LOCK;
403 else if (attr == &sensor_dev_attr_temp1_min.dev_attr.attr ||
404 attr == &sensor_dev_attr_temp1_max.dev_attr.attr)
405 readonly = config & JC42_CFG_EVENT_LOCK;
406 else if (attr == &sensor_dev_attr_temp1_crit_hyst.dev_attr.attr)
407 readonly = config & (JC42_CFG_EVENT_LOCK | JC42_CFG_TCRIT_LOCK);
411 return S_IRUGO | (readonly ? 0 : S_IWUSR);
414 static const struct attribute_group jc42_group = {
415 .attrs = jc42_attributes,
416 .is_visible = jc42_attribute_mode,
418 __ATTRIBUTE_GROUPS(jc42);
420 /* Return 0 if detection is successful, -ENODEV otherwise */
421 static int jc42_detect(struct i2c_client *client, struct i2c_board_info *info)
423 struct i2c_adapter *adapter = client->adapter;
424 int i, config, cap, manid, devid;
426 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
427 I2C_FUNC_SMBUS_WORD_DATA))
430 cap = i2c_smbus_read_word_swapped(client, JC42_REG_CAP);
431 config = i2c_smbus_read_word_swapped(client, JC42_REG_CONFIG);
432 manid = i2c_smbus_read_word_swapped(client, JC42_REG_MANID);
433 devid = i2c_smbus_read_word_swapped(client, JC42_REG_DEVICEID);
435 if (cap < 0 || config < 0 || manid < 0 || devid < 0)
438 if ((cap & 0xff00) || (config & 0xf800))
441 for (i = 0; i < ARRAY_SIZE(jc42_chips); i++) {
442 struct jc42_chips *chip = &jc42_chips[i];
443 if (manid == chip->manid &&
444 (devid & chip->devid_mask) == chip->devid) {
445 strlcpy(info->type, "jc42", I2C_NAME_SIZE);
452 static int jc42_probe(struct i2c_client *client, const struct i2c_device_id *id)
454 struct device *dev = &client->dev;
455 struct device *hwmon_dev;
456 struct jc42_data *data;
459 data = devm_kzalloc(dev, sizeof(struct jc42_data), GFP_KERNEL);
463 data->client = client;
464 i2c_set_clientdata(client, data);
465 mutex_init(&data->update_lock);
467 cap = i2c_smbus_read_word_swapped(client, JC42_REG_CAP);
471 data->extended = !!(cap & JC42_CAP_RANGE);
473 config = i2c_smbus_read_word_swapped(client, JC42_REG_CONFIG);
477 data->orig_config = config;
478 if (config & JC42_CFG_SHUTDOWN) {
479 config &= ~JC42_CFG_SHUTDOWN;
480 i2c_smbus_write_word_swapped(client, JC42_REG_CONFIG, config);
482 data->config = config;
484 hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
487 return PTR_ERR_OR_ZERO(hwmon_dev);
490 static int jc42_remove(struct i2c_client *client)
492 struct jc42_data *data = i2c_get_clientdata(client);
494 /* Restore original configuration except hysteresis */
495 if ((data->config & ~JC42_CFG_HYST_MASK) !=
496 (data->orig_config & ~JC42_CFG_HYST_MASK)) {
499 config = (data->orig_config & ~JC42_CFG_HYST_MASK)
500 | (data->config & JC42_CFG_HYST_MASK);
501 i2c_smbus_write_word_swapped(client, JC42_REG_CONFIG, config);
508 static int jc42_suspend(struct device *dev)
510 struct jc42_data *data = dev_get_drvdata(dev);
512 data->config |= JC42_CFG_SHUTDOWN;
513 i2c_smbus_write_word_swapped(data->client, JC42_REG_CONFIG,
518 static int jc42_resume(struct device *dev)
520 struct jc42_data *data = dev_get_drvdata(dev);
522 data->config &= ~JC42_CFG_SHUTDOWN;
523 i2c_smbus_write_word_swapped(data->client, JC42_REG_CONFIG,
528 static const struct dev_pm_ops jc42_dev_pm_ops = {
529 .suspend = jc42_suspend,
530 .resume = jc42_resume,
533 #define JC42_DEV_PM_OPS (&jc42_dev_pm_ops)
535 #define JC42_DEV_PM_OPS NULL
536 #endif /* CONFIG_PM */
538 static const struct i2c_device_id jc42_id[] = {
542 MODULE_DEVICE_TABLE(i2c, jc42_id);
544 static struct i2c_driver jc42_driver = {
545 .class = I2C_CLASS_SPD | I2C_CLASS_HWMON,
548 .pm = JC42_DEV_PM_OPS,
551 .remove = jc42_remove,
553 .detect = jc42_detect,
554 .address_list = normal_i2c,
557 module_i2c_driver(jc42_driver);
559 MODULE_AUTHOR("Guenter Roeck <linux@roeck-us.net>");
560 MODULE_DESCRIPTION("JC42 driver");
561 MODULE_LICENSE("GPL");