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 MAX_MANID 0x004d /* Maxim */
69 #define IDT_MANID 0x00b3 /* IDT */
70 #define MCP_MANID 0x0054 /* Microchip */
71 #define NXP_MANID 0x1131 /* NXP Semiconductors */
72 #define ONS_MANID 0x1b09 /* ON Semiconductor */
73 #define STM_MANID 0x104a /* ST Microelectronics */
78 #define ADT7408_DEVID 0x0801
79 #define ADT7408_DEVID_MASK 0xffff
82 #define AT30TS00_DEVID 0x8201
83 #define AT30TS00_DEVID_MASK 0xffff
86 #define TS3000B3_DEVID 0x2903 /* Also matches TSE2002B3 */
87 #define TS3000B3_DEVID_MASK 0xffff
89 #define TS3000GB2_DEVID 0x2912 /* Also matches TSE2002GB2 */
90 #define TS3000GB2_DEVID_MASK 0xffff
93 #define MAX6604_DEVID 0x3e00
94 #define MAX6604_DEVID_MASK 0xffff
97 #define MCP9804_DEVID 0x0200
98 #define MCP9804_DEVID_MASK 0xfffc
100 #define MCP98242_DEVID 0x2000
101 #define MCP98242_DEVID_MASK 0xfffc
103 #define MCP98243_DEVID 0x2100
104 #define MCP98243_DEVID_MASK 0xfffc
106 #define MCP98244_DEVID 0x2200
107 #define MCP98244_DEVID_MASK 0xfffc
109 #define MCP9843_DEVID 0x0000 /* Also matches mcp9805 */
110 #define MCP9843_DEVID_MASK 0xfffe
113 #define SE97_DEVID 0xa200
114 #define SE97_DEVID_MASK 0xfffc
116 #define SE98_DEVID 0xa100
117 #define SE98_DEVID_MASK 0xfffc
119 /* ON Semiconductor */
120 #define CAT6095_DEVID 0x0800 /* Also matches CAT34TS02 */
121 #define CAT6095_DEVID_MASK 0xffe0
123 /* ST Microelectronics */
124 #define STTS424_DEVID 0x0101
125 #define STTS424_DEVID_MASK 0xffff
127 #define STTS424E_DEVID 0x0000
128 #define STTS424E_DEVID_MASK 0xfffe
130 #define STTS2002_DEVID 0x0300
131 #define STTS2002_DEVID_MASK 0xffff
133 #define STTS3000_DEVID 0x0200
134 #define STTS3000_DEVID_MASK 0xffff
136 static u16 jc42_hysteresis
[] = { 0, 1500, 3000, 6000 };
144 static struct jc42_chips jc42_chips
[] = {
145 { ADT_MANID
, ADT7408_DEVID
, ADT7408_DEVID_MASK
},
146 { ATMEL_MANID
, AT30TS00_DEVID
, AT30TS00_DEVID_MASK
},
147 { IDT_MANID
, TS3000B3_DEVID
, TS3000B3_DEVID_MASK
},
148 { IDT_MANID
, TS3000GB2_DEVID
, TS3000GB2_DEVID_MASK
},
149 { MAX_MANID
, MAX6604_DEVID
, MAX6604_DEVID_MASK
},
150 { MCP_MANID
, MCP9804_DEVID
, MCP9804_DEVID_MASK
},
151 { MCP_MANID
, MCP98242_DEVID
, MCP98242_DEVID_MASK
},
152 { MCP_MANID
, MCP98243_DEVID
, MCP98243_DEVID_MASK
},
153 { MCP_MANID
, MCP98244_DEVID
, MCP98244_DEVID_MASK
},
154 { MCP_MANID
, MCP9843_DEVID
, MCP9843_DEVID_MASK
},
155 { NXP_MANID
, SE97_DEVID
, SE97_DEVID_MASK
},
156 { ONS_MANID
, CAT6095_DEVID
, CAT6095_DEVID_MASK
},
157 { NXP_MANID
, SE98_DEVID
, SE98_DEVID_MASK
},
158 { STM_MANID
, STTS424_DEVID
, STTS424_DEVID_MASK
},
159 { STM_MANID
, STTS424E_DEVID
, STTS424E_DEVID_MASK
},
160 { STM_MANID
, STTS2002_DEVID
, STTS2002_DEVID_MASK
},
161 { STM_MANID
, STTS3000_DEVID
, STTS3000_DEVID_MASK
},
164 /* Each client has this additional data */
166 struct device
*hwmon_dev
;
167 struct mutex update_lock
; /* protect register access */
168 bool extended
; /* true if extended range supported */
170 unsigned long last_updated
; /* In jiffies */
171 u16 orig_config
; /* original configuration */
172 u16 config
; /* current configuration */
173 u16 temp_input
; /* Temperatures */
179 static int jc42_probe(struct i2c_client
*client
,
180 const struct i2c_device_id
*id
);
181 static int jc42_detect(struct i2c_client
*client
, struct i2c_board_info
*info
);
182 static int jc42_remove(struct i2c_client
*client
);
184 static struct jc42_data
*jc42_update_device(struct device
*dev
);
186 static const struct i2c_device_id jc42_id
[] = {
190 MODULE_DEVICE_TABLE(i2c
, jc42_id
);
194 static int jc42_suspend(struct device
*dev
)
196 struct i2c_client
*client
= to_i2c_client(dev
);
197 struct jc42_data
*data
= i2c_get_clientdata(client
);
199 data
->config
|= JC42_CFG_SHUTDOWN
;
200 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, data
->config
);
204 static int jc42_resume(struct device
*dev
)
206 struct i2c_client
*client
= to_i2c_client(dev
);
207 struct jc42_data
*data
= i2c_get_clientdata(client
);
209 data
->config
&= ~JC42_CFG_SHUTDOWN
;
210 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, data
->config
);
214 static const struct dev_pm_ops jc42_dev_pm_ops
= {
215 .suspend
= jc42_suspend
,
216 .resume
= jc42_resume
,
219 #define JC42_DEV_PM_OPS (&jc42_dev_pm_ops)
221 #define JC42_DEV_PM_OPS NULL
222 #endif /* CONFIG_PM */
224 /* This is the driver that will be inserted */
225 static struct i2c_driver jc42_driver
= {
226 .class = I2C_CLASS_SPD
,
229 .pm
= JC42_DEV_PM_OPS
,
232 .remove
= jc42_remove
,
234 .detect
= jc42_detect
,
235 .address_list
= normal_i2c
,
238 #define JC42_TEMP_MIN_EXTENDED (-40000)
239 #define JC42_TEMP_MIN 0
240 #define JC42_TEMP_MAX 125000
242 static u16
jc42_temp_to_reg(int temp
, bool extended
)
244 int ntemp
= clamp_val(temp
,
245 extended
? JC42_TEMP_MIN_EXTENDED
:
246 JC42_TEMP_MIN
, JC42_TEMP_MAX
);
248 /* convert from 0.001 to 0.0625 resolution */
249 return (ntemp
* 2 / 125) & 0x1fff;
252 static int jc42_temp_from_reg(s16 reg
)
256 /* sign extend register */
260 /* convert from 0.0625 to 0.001 resolution */
261 return reg
* 125 / 2;
266 /* read routines for temperature limits */
267 #define show(value) \
268 static ssize_t show_##value(struct device *dev, \
269 struct device_attribute *attr, \
272 struct jc42_data *data = jc42_update_device(dev); \
274 return PTR_ERR(data); \
275 return sprintf(buf, "%d\n", jc42_temp_from_reg(data->value)); \
283 /* read routines for hysteresis values */
284 static ssize_t
show_temp_crit_hyst(struct device
*dev
,
285 struct device_attribute
*attr
, char *buf
)
287 struct jc42_data
*data
= jc42_update_device(dev
);
291 return PTR_ERR(data
);
293 temp
= jc42_temp_from_reg(data
->temp_crit
);
294 hyst
= jc42_hysteresis
[(data
->config
& JC42_CFG_HYST_MASK
)
295 >> JC42_CFG_HYST_SHIFT
];
296 return sprintf(buf
, "%d\n", temp
- hyst
);
299 static ssize_t
show_temp_max_hyst(struct device
*dev
,
300 struct device_attribute
*attr
, char *buf
)
302 struct jc42_data
*data
= jc42_update_device(dev
);
306 return PTR_ERR(data
);
308 temp
= jc42_temp_from_reg(data
->temp_max
);
309 hyst
= jc42_hysteresis
[(data
->config
& JC42_CFG_HYST_MASK
)
310 >> JC42_CFG_HYST_SHIFT
];
311 return sprintf(buf
, "%d\n", temp
- hyst
);
315 #define set(value, reg) \
316 static ssize_t set_##value(struct device *dev, \
317 struct device_attribute *attr, \
318 const char *buf, size_t count) \
320 struct i2c_client *client = to_i2c_client(dev); \
321 struct jc42_data *data = i2c_get_clientdata(client); \
322 int err, ret = count; \
324 if (kstrtol(buf, 10, &val) < 0) \
326 mutex_lock(&data->update_lock); \
327 data->value = jc42_temp_to_reg(val, data->extended); \
328 err = i2c_smbus_write_word_swapped(client, reg, data->value); \
331 mutex_unlock(&data->update_lock); \
335 set(temp_min
, JC42_REG_TEMP_LOWER
);
336 set(temp_max
, JC42_REG_TEMP_UPPER
);
337 set(temp_crit
, JC42_REG_TEMP_CRITICAL
);
340 * JC42.4 compliant chips only support four hysteresis values.
341 * Pick best choice and go from there.
343 static ssize_t
set_temp_crit_hyst(struct device
*dev
,
344 struct device_attribute
*attr
,
345 const char *buf
, size_t count
)
347 struct i2c_client
*client
= to_i2c_client(dev
);
348 struct jc42_data
*data
= i2c_get_clientdata(client
);
354 if (kstrtoul(buf
, 10, &val
) < 0)
357 diff
= jc42_temp_from_reg(data
->temp_crit
) - val
;
361 hyst
= 1; /* 1.5 degrees C */
362 else if (diff
< 4500)
363 hyst
= 2; /* 3.0 degrees C */
365 hyst
= 3; /* 6.0 degrees C */
368 mutex_lock(&data
->update_lock
);
369 data
->config
= (data
->config
& ~JC42_CFG_HYST_MASK
)
370 | (hyst
<< JC42_CFG_HYST_SHIFT
);
371 err
= i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
,
375 mutex_unlock(&data
->update_lock
);
379 static ssize_t
show_alarm(struct device
*dev
,
380 struct device_attribute
*attr
, char *buf
)
382 u16 bit
= to_sensor_dev_attr(attr
)->index
;
383 struct jc42_data
*data
= jc42_update_device(dev
);
387 return PTR_ERR(data
);
389 val
= data
->temp_input
;
390 if (bit
!= JC42_ALARM_CRIT_BIT
&& (data
->config
& JC42_CFG_CRIT_ONLY
))
392 return sprintf(buf
, "%u\n", (val
>> bit
) & 1);
395 static DEVICE_ATTR(temp1_input
, S_IRUGO
,
396 show_temp_input
, NULL
);
397 static DEVICE_ATTR(temp1_crit
, S_IRUGO
,
398 show_temp_crit
, set_temp_crit
);
399 static DEVICE_ATTR(temp1_min
, S_IRUGO
,
400 show_temp_min
, set_temp_min
);
401 static DEVICE_ATTR(temp1_max
, S_IRUGO
,
402 show_temp_max
, set_temp_max
);
404 static DEVICE_ATTR(temp1_crit_hyst
, S_IRUGO
,
405 show_temp_crit_hyst
, set_temp_crit_hyst
);
406 static DEVICE_ATTR(temp1_max_hyst
, S_IRUGO
,
407 show_temp_max_hyst
, NULL
);
409 static SENSOR_DEVICE_ATTR(temp1_crit_alarm
, S_IRUGO
, show_alarm
, NULL
,
410 JC42_ALARM_CRIT_BIT
);
411 static SENSOR_DEVICE_ATTR(temp1_min_alarm
, S_IRUGO
, show_alarm
, NULL
,
413 static SENSOR_DEVICE_ATTR(temp1_max_alarm
, S_IRUGO
, show_alarm
, NULL
,
416 static struct attribute
*jc42_attributes
[] = {
417 &dev_attr_temp1_input
.attr
,
418 &dev_attr_temp1_crit
.attr
,
419 &dev_attr_temp1_min
.attr
,
420 &dev_attr_temp1_max
.attr
,
421 &dev_attr_temp1_crit_hyst
.attr
,
422 &dev_attr_temp1_max_hyst
.attr
,
423 &sensor_dev_attr_temp1_crit_alarm
.dev_attr
.attr
,
424 &sensor_dev_attr_temp1_min_alarm
.dev_attr
.attr
,
425 &sensor_dev_attr_temp1_max_alarm
.dev_attr
.attr
,
429 static umode_t
jc42_attribute_mode(struct kobject
*kobj
,
430 struct attribute
*attr
, int index
)
432 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
433 struct i2c_client
*client
= to_i2c_client(dev
);
434 struct jc42_data
*data
= i2c_get_clientdata(client
);
435 unsigned int config
= data
->config
;
438 if (attr
== &dev_attr_temp1_crit
.attr
)
439 readonly
= config
& JC42_CFG_TCRIT_LOCK
;
440 else if (attr
== &dev_attr_temp1_min
.attr
||
441 attr
== &dev_attr_temp1_max
.attr
)
442 readonly
= config
& JC42_CFG_EVENT_LOCK
;
443 else if (attr
== &dev_attr_temp1_crit_hyst
.attr
)
444 readonly
= config
& (JC42_CFG_EVENT_LOCK
| JC42_CFG_TCRIT_LOCK
);
448 return S_IRUGO
| (readonly
? 0 : S_IWUSR
);
451 static const struct attribute_group jc42_group
= {
452 .attrs
= jc42_attributes
,
453 .is_visible
= jc42_attribute_mode
,
456 /* Return 0 if detection is successful, -ENODEV otherwise */
457 static int jc42_detect(struct i2c_client
*client
, struct i2c_board_info
*info
)
459 struct i2c_adapter
*adapter
= client
->adapter
;
460 int i
, config
, cap
, manid
, devid
;
462 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
|
463 I2C_FUNC_SMBUS_WORD_DATA
))
466 cap
= i2c_smbus_read_word_swapped(client
, JC42_REG_CAP
);
467 config
= i2c_smbus_read_word_swapped(client
, JC42_REG_CONFIG
);
468 manid
= i2c_smbus_read_word_swapped(client
, JC42_REG_MANID
);
469 devid
= i2c_smbus_read_word_swapped(client
, JC42_REG_DEVICEID
);
471 if (cap
< 0 || config
< 0 || manid
< 0 || devid
< 0)
474 if ((cap
& 0xff00) || (config
& 0xf800))
477 for (i
= 0; i
< ARRAY_SIZE(jc42_chips
); i
++) {
478 struct jc42_chips
*chip
= &jc42_chips
[i
];
479 if (manid
== chip
->manid
&&
480 (devid
& chip
->devid_mask
) == chip
->devid
) {
481 strlcpy(info
->type
, "jc42", I2C_NAME_SIZE
);
488 static int jc42_probe(struct i2c_client
*client
, const struct i2c_device_id
*id
)
490 struct jc42_data
*data
;
491 int config
, cap
, err
;
492 struct device
*dev
= &client
->dev
;
494 data
= devm_kzalloc(dev
, sizeof(struct jc42_data
), GFP_KERNEL
);
498 i2c_set_clientdata(client
, data
);
499 mutex_init(&data
->update_lock
);
501 cap
= i2c_smbus_read_word_swapped(client
, JC42_REG_CAP
);
505 data
->extended
= !!(cap
& JC42_CAP_RANGE
);
507 config
= i2c_smbus_read_word_swapped(client
, JC42_REG_CONFIG
);
511 data
->orig_config
= config
;
512 if (config
& JC42_CFG_SHUTDOWN
) {
513 config
&= ~JC42_CFG_SHUTDOWN
;
514 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, config
);
516 data
->config
= config
;
518 /* Register sysfs hooks */
519 err
= sysfs_create_group(&dev
->kobj
, &jc42_group
);
523 data
->hwmon_dev
= hwmon_device_register(dev
);
524 if (IS_ERR(data
->hwmon_dev
)) {
525 err
= PTR_ERR(data
->hwmon_dev
);
532 sysfs_remove_group(&dev
->kobj
, &jc42_group
);
536 static int jc42_remove(struct i2c_client
*client
)
538 struct jc42_data
*data
= i2c_get_clientdata(client
);
539 hwmon_device_unregister(data
->hwmon_dev
);
540 sysfs_remove_group(&client
->dev
.kobj
, &jc42_group
);
542 /* Restore original configuration except hysteresis */
543 if ((data
->config
& ~JC42_CFG_HYST_MASK
) !=
544 (data
->orig_config
& ~JC42_CFG_HYST_MASK
)) {
547 config
= (data
->orig_config
& ~JC42_CFG_HYST_MASK
)
548 | (data
->config
& JC42_CFG_HYST_MASK
);
549 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, config
);
554 static struct jc42_data
*jc42_update_device(struct device
*dev
)
556 struct i2c_client
*client
= to_i2c_client(dev
);
557 struct jc42_data
*data
= i2c_get_clientdata(client
);
558 struct jc42_data
*ret
= data
;
561 mutex_lock(&data
->update_lock
);
563 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
564 val
= i2c_smbus_read_word_swapped(client
, JC42_REG_TEMP
);
569 data
->temp_input
= val
;
571 val
= i2c_smbus_read_word_swapped(client
,
572 JC42_REG_TEMP_CRITICAL
);
577 data
->temp_crit
= val
;
579 val
= i2c_smbus_read_word_swapped(client
, JC42_REG_TEMP_LOWER
);
584 data
->temp_min
= val
;
586 val
= i2c_smbus_read_word_swapped(client
, JC42_REG_TEMP_UPPER
);
591 data
->temp_max
= val
;
593 data
->last_updated
= jiffies
;
597 mutex_unlock(&data
->update_lock
);
601 module_i2c_driver(jc42_driver
);
603 MODULE_AUTHOR("Guenter Roeck <linux@roeck-us.net>");
604 MODULE_DESCRIPTION("JC42 driver");
605 MODULE_LICENSE("GPL");