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 MCP9843_DEVID 0x0000 /* Also matches mcp9805 */
107 #define MCP9843_DEVID_MASK 0xfffe
110 #define SE97_DEVID 0xa200
111 #define SE97_DEVID_MASK 0xfffc
113 #define SE98_DEVID 0xa100
114 #define SE98_DEVID_MASK 0xfffc
116 /* ON Semiconductor */
117 #define CAT6095_DEVID 0x0800 /* Also matches CAT34TS02 */
118 #define CAT6095_DEVID_MASK 0xffe0
120 /* ST Microelectronics */
121 #define STTS424_DEVID 0x0101
122 #define STTS424_DEVID_MASK 0xffff
124 #define STTS424E_DEVID 0x0000
125 #define STTS424E_DEVID_MASK 0xfffe
127 #define STTS2002_DEVID 0x0300
128 #define STTS2002_DEVID_MASK 0xffff
130 #define STTS3000_DEVID 0x0200
131 #define STTS3000_DEVID_MASK 0xffff
133 static u16 jc42_hysteresis
[] = { 0, 1500, 3000, 6000 };
141 static struct jc42_chips jc42_chips
[] = {
142 { ADT_MANID
, ADT7408_DEVID
, ADT7408_DEVID_MASK
},
143 { ATMEL_MANID
, AT30TS00_DEVID
, AT30TS00_DEVID_MASK
},
144 { IDT_MANID
, TS3000B3_DEVID
, TS3000B3_DEVID_MASK
},
145 { IDT_MANID
, TS3000GB2_DEVID
, TS3000GB2_DEVID_MASK
},
146 { MAX_MANID
, MAX6604_DEVID
, MAX6604_DEVID_MASK
},
147 { MCP_MANID
, MCP9804_DEVID
, MCP9804_DEVID_MASK
},
148 { MCP_MANID
, MCP98242_DEVID
, MCP98242_DEVID_MASK
},
149 { MCP_MANID
, MCP98243_DEVID
, MCP98243_DEVID_MASK
},
150 { MCP_MANID
, MCP9843_DEVID
, MCP9843_DEVID_MASK
},
151 { NXP_MANID
, SE97_DEVID
, SE97_DEVID_MASK
},
152 { ONS_MANID
, CAT6095_DEVID
, CAT6095_DEVID_MASK
},
153 { NXP_MANID
, SE98_DEVID
, SE98_DEVID_MASK
},
154 { STM_MANID
, STTS424_DEVID
, STTS424_DEVID_MASK
},
155 { STM_MANID
, STTS424E_DEVID
, STTS424E_DEVID_MASK
},
156 { STM_MANID
, STTS2002_DEVID
, STTS2002_DEVID_MASK
},
157 { STM_MANID
, STTS3000_DEVID
, STTS3000_DEVID_MASK
},
160 /* Each client has this additional data */
162 struct device
*hwmon_dev
;
163 struct mutex update_lock
; /* protect register access */
164 bool extended
; /* true if extended range supported */
166 unsigned long last_updated
; /* In jiffies */
167 u16 orig_config
; /* original configuration */
168 u16 config
; /* current configuration */
169 u16 temp_input
; /* Temperatures */
175 static int jc42_probe(struct i2c_client
*client
,
176 const struct i2c_device_id
*id
);
177 static int jc42_detect(struct i2c_client
*client
, struct i2c_board_info
*info
);
178 static int jc42_remove(struct i2c_client
*client
);
180 static struct jc42_data
*jc42_update_device(struct device
*dev
);
182 static const struct i2c_device_id jc42_id
[] = {
186 MODULE_DEVICE_TABLE(i2c
, jc42_id
);
190 static int jc42_suspend(struct device
*dev
)
192 struct i2c_client
*client
= to_i2c_client(dev
);
193 struct jc42_data
*data
= i2c_get_clientdata(client
);
195 data
->config
|= JC42_CFG_SHUTDOWN
;
196 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, data
->config
);
200 static int jc42_resume(struct device
*dev
)
202 struct i2c_client
*client
= to_i2c_client(dev
);
203 struct jc42_data
*data
= i2c_get_clientdata(client
);
205 data
->config
&= ~JC42_CFG_SHUTDOWN
;
206 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, data
->config
);
210 static const struct dev_pm_ops jc42_dev_pm_ops
= {
211 .suspend
= jc42_suspend
,
212 .resume
= jc42_resume
,
215 #define JC42_DEV_PM_OPS (&jc42_dev_pm_ops)
217 #define JC42_DEV_PM_OPS NULL
218 #endif /* CONFIG_PM */
220 /* This is the driver that will be inserted */
221 static struct i2c_driver jc42_driver
= {
222 .class = I2C_CLASS_SPD
,
225 .pm
= JC42_DEV_PM_OPS
,
228 .remove
= jc42_remove
,
230 .detect
= jc42_detect
,
231 .address_list
= normal_i2c
,
234 #define JC42_TEMP_MIN_EXTENDED (-40000)
235 #define JC42_TEMP_MIN 0
236 #define JC42_TEMP_MAX 125000
238 static u16
jc42_temp_to_reg(int temp
, bool extended
)
240 int ntemp
= SENSORS_LIMIT(temp
,
241 extended
? JC42_TEMP_MIN_EXTENDED
:
242 JC42_TEMP_MIN
, JC42_TEMP_MAX
);
244 /* convert from 0.001 to 0.0625 resolution */
245 return (ntemp
* 2 / 125) & 0x1fff;
248 static int jc42_temp_from_reg(s16 reg
)
252 /* sign extend register */
256 /* convert from 0.0625 to 0.001 resolution */
257 return reg
* 125 / 2;
262 /* read routines for temperature limits */
263 #define show(value) \
264 static ssize_t show_##value(struct device *dev, \
265 struct device_attribute *attr, \
268 struct jc42_data *data = jc42_update_device(dev); \
270 return PTR_ERR(data); \
271 return sprintf(buf, "%d\n", jc42_temp_from_reg(data->value)); \
279 /* read routines for hysteresis values */
280 static ssize_t
show_temp_crit_hyst(struct device
*dev
,
281 struct device_attribute
*attr
, char *buf
)
283 struct jc42_data
*data
= jc42_update_device(dev
);
287 return PTR_ERR(data
);
289 temp
= jc42_temp_from_reg(data
->temp_crit
);
290 hyst
= jc42_hysteresis
[(data
->config
& JC42_CFG_HYST_MASK
)
291 >> JC42_CFG_HYST_SHIFT
];
292 return sprintf(buf
, "%d\n", temp
- hyst
);
295 static ssize_t
show_temp_max_hyst(struct device
*dev
,
296 struct device_attribute
*attr
, char *buf
)
298 struct jc42_data
*data
= jc42_update_device(dev
);
302 return PTR_ERR(data
);
304 temp
= jc42_temp_from_reg(data
->temp_max
);
305 hyst
= jc42_hysteresis
[(data
->config
& JC42_CFG_HYST_MASK
)
306 >> JC42_CFG_HYST_SHIFT
];
307 return sprintf(buf
, "%d\n", temp
- hyst
);
311 #define set(value, reg) \
312 static ssize_t set_##value(struct device *dev, \
313 struct device_attribute *attr, \
314 const char *buf, size_t count) \
316 struct i2c_client *client = to_i2c_client(dev); \
317 struct jc42_data *data = i2c_get_clientdata(client); \
318 int err, ret = count; \
320 if (kstrtol(buf, 10, &val) < 0) \
322 mutex_lock(&data->update_lock); \
323 data->value = jc42_temp_to_reg(val, data->extended); \
324 err = i2c_smbus_write_word_swapped(client, reg, data->value); \
327 mutex_unlock(&data->update_lock); \
331 set(temp_min
, JC42_REG_TEMP_LOWER
);
332 set(temp_max
, JC42_REG_TEMP_UPPER
);
333 set(temp_crit
, JC42_REG_TEMP_CRITICAL
);
336 * JC42.4 compliant chips only support four hysteresis values.
337 * Pick best choice and go from there.
339 static ssize_t
set_temp_crit_hyst(struct device
*dev
,
340 struct device_attribute
*attr
,
341 const char *buf
, size_t count
)
343 struct i2c_client
*client
= to_i2c_client(dev
);
344 struct jc42_data
*data
= i2c_get_clientdata(client
);
350 if (kstrtoul(buf
, 10, &val
) < 0)
353 diff
= jc42_temp_from_reg(data
->temp_crit
) - val
;
357 hyst
= 1; /* 1.5 degrees C */
358 else if (diff
< 4500)
359 hyst
= 2; /* 3.0 degrees C */
361 hyst
= 3; /* 6.0 degrees C */
364 mutex_lock(&data
->update_lock
);
365 data
->config
= (data
->config
& ~JC42_CFG_HYST_MASK
)
366 | (hyst
<< JC42_CFG_HYST_SHIFT
);
367 err
= i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
,
371 mutex_unlock(&data
->update_lock
);
375 static ssize_t
show_alarm(struct device
*dev
,
376 struct device_attribute
*attr
, char *buf
)
378 u16 bit
= to_sensor_dev_attr(attr
)->index
;
379 struct jc42_data
*data
= jc42_update_device(dev
);
383 return PTR_ERR(data
);
385 val
= data
->temp_input
;
386 if (bit
!= JC42_ALARM_CRIT_BIT
&& (data
->config
& JC42_CFG_CRIT_ONLY
))
388 return sprintf(buf
, "%u\n", (val
>> bit
) & 1);
391 static DEVICE_ATTR(temp1_input
, S_IRUGO
,
392 show_temp_input
, NULL
);
393 static DEVICE_ATTR(temp1_crit
, S_IRUGO
,
394 show_temp_crit
, set_temp_crit
);
395 static DEVICE_ATTR(temp1_min
, S_IRUGO
,
396 show_temp_min
, set_temp_min
);
397 static DEVICE_ATTR(temp1_max
, S_IRUGO
,
398 show_temp_max
, set_temp_max
);
400 static DEVICE_ATTR(temp1_crit_hyst
, S_IRUGO
,
401 show_temp_crit_hyst
, set_temp_crit_hyst
);
402 static DEVICE_ATTR(temp1_max_hyst
, S_IRUGO
,
403 show_temp_max_hyst
, NULL
);
405 static SENSOR_DEVICE_ATTR(temp1_crit_alarm
, S_IRUGO
, show_alarm
, NULL
,
406 JC42_ALARM_CRIT_BIT
);
407 static SENSOR_DEVICE_ATTR(temp1_min_alarm
, S_IRUGO
, show_alarm
, NULL
,
409 static SENSOR_DEVICE_ATTR(temp1_max_alarm
, S_IRUGO
, show_alarm
, NULL
,
412 static struct attribute
*jc42_attributes
[] = {
413 &dev_attr_temp1_input
.attr
,
414 &dev_attr_temp1_crit
.attr
,
415 &dev_attr_temp1_min
.attr
,
416 &dev_attr_temp1_max
.attr
,
417 &dev_attr_temp1_crit_hyst
.attr
,
418 &dev_attr_temp1_max_hyst
.attr
,
419 &sensor_dev_attr_temp1_crit_alarm
.dev_attr
.attr
,
420 &sensor_dev_attr_temp1_min_alarm
.dev_attr
.attr
,
421 &sensor_dev_attr_temp1_max_alarm
.dev_attr
.attr
,
425 static umode_t
jc42_attribute_mode(struct kobject
*kobj
,
426 struct attribute
*attr
, int index
)
428 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
429 struct i2c_client
*client
= to_i2c_client(dev
);
430 struct jc42_data
*data
= i2c_get_clientdata(client
);
431 unsigned int config
= data
->config
;
434 if (attr
== &dev_attr_temp1_crit
.attr
)
435 readonly
= config
& JC42_CFG_TCRIT_LOCK
;
436 else if (attr
== &dev_attr_temp1_min
.attr
||
437 attr
== &dev_attr_temp1_max
.attr
)
438 readonly
= config
& JC42_CFG_EVENT_LOCK
;
439 else if (attr
== &dev_attr_temp1_crit_hyst
.attr
)
440 readonly
= config
& (JC42_CFG_EVENT_LOCK
| JC42_CFG_TCRIT_LOCK
);
444 return S_IRUGO
| (readonly
? 0 : S_IWUSR
);
447 static const struct attribute_group jc42_group
= {
448 .attrs
= jc42_attributes
,
449 .is_visible
= jc42_attribute_mode
,
452 /* Return 0 if detection is successful, -ENODEV otherwise */
453 static int jc42_detect(struct i2c_client
*client
, struct i2c_board_info
*info
)
455 struct i2c_adapter
*adapter
= client
->adapter
;
456 int i
, config
, cap
, manid
, devid
;
458 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
|
459 I2C_FUNC_SMBUS_WORD_DATA
))
462 cap
= i2c_smbus_read_word_swapped(client
, JC42_REG_CAP
);
463 config
= i2c_smbus_read_word_swapped(client
, JC42_REG_CONFIG
);
464 manid
= i2c_smbus_read_word_swapped(client
, JC42_REG_MANID
);
465 devid
= i2c_smbus_read_word_swapped(client
, JC42_REG_DEVICEID
);
467 if (cap
< 0 || config
< 0 || manid
< 0 || devid
< 0)
470 if ((cap
& 0xff00) || (config
& 0xf800))
473 for (i
= 0; i
< ARRAY_SIZE(jc42_chips
); i
++) {
474 struct jc42_chips
*chip
= &jc42_chips
[i
];
475 if (manid
== chip
->manid
&&
476 (devid
& chip
->devid_mask
) == chip
->devid
) {
477 strlcpy(info
->type
, "jc42", I2C_NAME_SIZE
);
484 static int jc42_probe(struct i2c_client
*client
, const struct i2c_device_id
*id
)
486 struct jc42_data
*data
;
487 int config
, cap
, err
;
488 struct device
*dev
= &client
->dev
;
490 data
= devm_kzalloc(dev
, sizeof(struct jc42_data
), GFP_KERNEL
);
494 i2c_set_clientdata(client
, data
);
495 mutex_init(&data
->update_lock
);
497 cap
= i2c_smbus_read_word_swapped(client
, JC42_REG_CAP
);
501 data
->extended
= !!(cap
& JC42_CAP_RANGE
);
503 config
= i2c_smbus_read_word_swapped(client
, JC42_REG_CONFIG
);
507 data
->orig_config
= config
;
508 if (config
& JC42_CFG_SHUTDOWN
) {
509 config
&= ~JC42_CFG_SHUTDOWN
;
510 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, config
);
512 data
->config
= config
;
514 /* Register sysfs hooks */
515 err
= sysfs_create_group(&dev
->kobj
, &jc42_group
);
519 data
->hwmon_dev
= hwmon_device_register(dev
);
520 if (IS_ERR(data
->hwmon_dev
)) {
521 err
= PTR_ERR(data
->hwmon_dev
);
528 sysfs_remove_group(&dev
->kobj
, &jc42_group
);
532 static int jc42_remove(struct i2c_client
*client
)
534 struct jc42_data
*data
= i2c_get_clientdata(client
);
535 hwmon_device_unregister(data
->hwmon_dev
);
536 sysfs_remove_group(&client
->dev
.kobj
, &jc42_group
);
538 /* Restore original configuration except hysteresis */
539 if ((data
->config
& ~JC42_CFG_HYST_MASK
) !=
540 (data
->orig_config
& ~JC42_CFG_HYST_MASK
)) {
543 config
= (data
->orig_config
& ~JC42_CFG_HYST_MASK
)
544 | (data
->config
& JC42_CFG_HYST_MASK
);
545 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, config
);
550 static struct jc42_data
*jc42_update_device(struct device
*dev
)
552 struct i2c_client
*client
= to_i2c_client(dev
);
553 struct jc42_data
*data
= i2c_get_clientdata(client
);
554 struct jc42_data
*ret
= data
;
557 mutex_lock(&data
->update_lock
);
559 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
560 val
= i2c_smbus_read_word_swapped(client
, JC42_REG_TEMP
);
565 data
->temp_input
= val
;
567 val
= i2c_smbus_read_word_swapped(client
,
568 JC42_REG_TEMP_CRITICAL
);
573 data
->temp_crit
= val
;
575 val
= i2c_smbus_read_word_swapped(client
, JC42_REG_TEMP_LOWER
);
580 data
->temp_min
= val
;
582 val
= i2c_smbus_read_word_swapped(client
, JC42_REG_TEMP_UPPER
);
587 data
->temp_max
= val
;
589 data
->last_updated
= jiffies
;
593 mutex_unlock(&data
->update_lock
);
597 module_i2c_driver(jc42_driver
);
599 MODULE_AUTHOR("Guenter Roeck <linux@roeck-us.net>");
600 MODULE_DESCRIPTION("JC42 driver");
601 MODULE_LICENSE("GPL");