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>
36 /* Addresses to scan */
37 static const unsigned short normal_i2c
[] = {
38 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, I2C_CLIENT_END
};
40 /* JC42 registers. All registers are 16 bit. */
41 #define JC42_REG_CAP 0x00
42 #define JC42_REG_CONFIG 0x01
43 #define JC42_REG_TEMP_UPPER 0x02
44 #define JC42_REG_TEMP_LOWER 0x03
45 #define JC42_REG_TEMP_CRITICAL 0x04
46 #define JC42_REG_TEMP 0x05
47 #define JC42_REG_MANID 0x06
48 #define JC42_REG_DEVICEID 0x07
50 /* Status bits in temperature register */
51 #define JC42_ALARM_CRIT_BIT 15
52 #define JC42_ALARM_MAX_BIT 14
53 #define JC42_ALARM_MIN_BIT 13
55 /* Configuration register defines */
56 #define JC42_CFG_CRIT_ONLY (1 << 2)
57 #define JC42_CFG_TCRIT_LOCK (1 << 6)
58 #define JC42_CFG_EVENT_LOCK (1 << 7)
59 #define JC42_CFG_SHUTDOWN (1 << 8)
60 #define JC42_CFG_HYST_SHIFT 9
61 #define JC42_CFG_HYST_MASK (0x03 << 9)
64 #define JC42_CAP_RANGE (1 << 2)
66 /* Manufacturer IDs */
67 #define ADT_MANID 0x11d4 /* Analog Devices */
68 #define ATMEL_MANID 0x001f /* Atmel */
69 #define ATMEL_MANID2 0x1114 /* Atmel */
70 #define MAX_MANID 0x004d /* Maxim */
71 #define IDT_MANID 0x00b3 /* IDT */
72 #define MCP_MANID 0x0054 /* Microchip */
73 #define NXP_MANID 0x1131 /* NXP Semiconductors */
74 #define ONS_MANID 0x1b09 /* ON Semiconductor */
75 #define STM_MANID 0x104a /* ST Microelectronics */
80 #define ADT7408_DEVID 0x0801
81 #define ADT7408_DEVID_MASK 0xffff
84 #define AT30TS00_DEVID 0x8201
85 #define AT30TS00_DEVID_MASK 0xffff
87 #define AT30TSE004_DEVID 0x2200
88 #define AT30TSE004_DEVID_MASK 0xffff
91 #define TSE2004_DEVID 0x2200
92 #define TSE2004_DEVID_MASK 0xff00
94 #define TS3000_DEVID 0x2900 /* Also matches TSE2002 */
95 #define TS3000_DEVID_MASK 0xff00
97 #define TS3001_DEVID 0x3000
98 #define TS3001_DEVID_MASK 0xff00
101 #define MAX6604_DEVID 0x3e00
102 #define MAX6604_DEVID_MASK 0xffff
105 #define MCP9804_DEVID 0x0200
106 #define MCP9804_DEVID_MASK 0xfffc
108 #define MCP9808_DEVID 0x0400
109 #define MCP9808_DEVID_MASK 0xfffc
111 #define MCP98242_DEVID 0x2000
112 #define MCP98242_DEVID_MASK 0xfffc
114 #define MCP98243_DEVID 0x2100
115 #define MCP98243_DEVID_MASK 0xfffc
117 #define MCP98244_DEVID 0x2200
118 #define MCP98244_DEVID_MASK 0xfffc
120 #define MCP9843_DEVID 0x0000 /* Also matches mcp9805 */
121 #define MCP9843_DEVID_MASK 0xfffe
124 #define SE97_DEVID 0xa200
125 #define SE97_DEVID_MASK 0xfffc
127 #define SE98_DEVID 0xa100
128 #define SE98_DEVID_MASK 0xfffc
130 /* ON Semiconductor */
131 #define CAT6095_DEVID 0x0800 /* Also matches CAT34TS02 */
132 #define CAT6095_DEVID_MASK 0xffe0
134 /* ST Microelectronics */
135 #define STTS424_DEVID 0x0101
136 #define STTS424_DEVID_MASK 0xffff
138 #define STTS424E_DEVID 0x0000
139 #define STTS424E_DEVID_MASK 0xfffe
141 #define STTS2002_DEVID 0x0300
142 #define STTS2002_DEVID_MASK 0xffff
144 #define STTS2004_DEVID 0x2201
145 #define STTS2004_DEVID_MASK 0xffff
147 #define STTS3000_DEVID 0x0200
148 #define STTS3000_DEVID_MASK 0xffff
150 static u16 jc42_hysteresis
[] = { 0, 1500, 3000, 6000 };
158 static struct jc42_chips jc42_chips
[] = {
159 { ADT_MANID
, ADT7408_DEVID
, ADT7408_DEVID_MASK
},
160 { ATMEL_MANID
, AT30TS00_DEVID
, AT30TS00_DEVID_MASK
},
161 { ATMEL_MANID2
, AT30TSE004_DEVID
, AT30TSE004_DEVID_MASK
},
162 { IDT_MANID
, TSE2004_DEVID
, TSE2004_DEVID_MASK
},
163 { IDT_MANID
, TS3000_DEVID
, TS3000_DEVID_MASK
},
164 { IDT_MANID
, TS3001_DEVID
, TS3001_DEVID_MASK
},
165 { MAX_MANID
, MAX6604_DEVID
, MAX6604_DEVID_MASK
},
166 { MCP_MANID
, MCP9804_DEVID
, MCP9804_DEVID_MASK
},
167 { MCP_MANID
, MCP9808_DEVID
, MCP9808_DEVID_MASK
},
168 { MCP_MANID
, MCP98242_DEVID
, MCP98242_DEVID_MASK
},
169 { MCP_MANID
, MCP98243_DEVID
, MCP98243_DEVID_MASK
},
170 { MCP_MANID
, MCP98244_DEVID
, MCP98244_DEVID_MASK
},
171 { MCP_MANID
, MCP9843_DEVID
, MCP9843_DEVID_MASK
},
172 { NXP_MANID
, SE97_DEVID
, SE97_DEVID_MASK
},
173 { ONS_MANID
, CAT6095_DEVID
, CAT6095_DEVID_MASK
},
174 { NXP_MANID
, SE98_DEVID
, SE98_DEVID_MASK
},
175 { STM_MANID
, STTS424_DEVID
, STTS424_DEVID_MASK
},
176 { STM_MANID
, STTS424E_DEVID
, STTS424E_DEVID_MASK
},
177 { STM_MANID
, STTS2002_DEVID
, STTS2002_DEVID_MASK
},
178 { STM_MANID
, STTS2004_DEVID
, STTS2004_DEVID_MASK
},
179 { STM_MANID
, STTS3000_DEVID
, STTS3000_DEVID_MASK
},
190 static const u8 temp_regs
[t_num_temp
] = {
191 [t_input
] = JC42_REG_TEMP
,
192 [t_crit
] = JC42_REG_TEMP_CRITICAL
,
193 [t_min
] = JC42_REG_TEMP_LOWER
,
194 [t_max
] = JC42_REG_TEMP_UPPER
,
197 /* Each client has this additional data */
199 struct i2c_client
*client
;
200 struct mutex update_lock
; /* protect register access */
201 bool extended
; /* true if extended range supported */
203 unsigned long last_updated
; /* In jiffies */
204 u16 orig_config
; /* original configuration */
205 u16 config
; /* current configuration */
206 u16 temp
[t_num_temp
];/* Temperatures */
209 #define JC42_TEMP_MIN_EXTENDED (-40000)
210 #define JC42_TEMP_MIN 0
211 #define JC42_TEMP_MAX 125000
213 static u16
jc42_temp_to_reg(long temp
, bool extended
)
215 int ntemp
= clamp_val(temp
,
216 extended
? JC42_TEMP_MIN_EXTENDED
:
217 JC42_TEMP_MIN
, JC42_TEMP_MAX
);
219 /* convert from 0.001 to 0.0625 resolution */
220 return (ntemp
* 2 / 125) & 0x1fff;
223 static int jc42_temp_from_reg(s16 reg
)
225 reg
= sign_extend32(reg
, 12);
227 /* convert from 0.0625 to 0.001 resolution */
228 return reg
* 125 / 2;
231 static struct jc42_data
*jc42_update_device(struct device
*dev
)
233 struct jc42_data
*data
= dev_get_drvdata(dev
);
234 struct i2c_client
*client
= data
->client
;
235 struct jc42_data
*ret
= data
;
238 mutex_lock(&data
->update_lock
);
240 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
241 for (i
= 0; i
< t_num_temp
; i
++) {
242 val
= i2c_smbus_read_word_swapped(client
, temp_regs
[i
]);
249 data
->last_updated
= jiffies
;
253 mutex_unlock(&data
->update_lock
);
257 /* sysfs functions */
259 static ssize_t
show_temp(struct device
*dev
, struct device_attribute
*devattr
,
262 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
263 struct jc42_data
*data
= jc42_update_device(dev
);
265 return PTR_ERR(data
);
266 return sprintf(buf
, "%d\n",
267 jc42_temp_from_reg(data
->temp
[attr
->index
]));
270 static ssize_t
show_temp_hyst(struct device
*dev
,
271 struct device_attribute
*devattr
, char *buf
)
273 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
274 struct jc42_data
*data
= jc42_update_device(dev
);
278 return PTR_ERR(data
);
280 temp
= jc42_temp_from_reg(data
->temp
[attr
->index
]);
281 hyst
= jc42_hysteresis
[(data
->config
& JC42_CFG_HYST_MASK
)
282 >> JC42_CFG_HYST_SHIFT
];
283 return sprintf(buf
, "%d\n", temp
- hyst
);
286 static ssize_t
set_temp(struct device
*dev
, struct device_attribute
*devattr
,
287 const char *buf
, size_t count
)
289 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
290 struct jc42_data
*data
= dev_get_drvdata(dev
);
291 int err
, ret
= count
;
292 int nr
= attr
->index
;
295 if (kstrtol(buf
, 10, &val
) < 0)
297 mutex_lock(&data
->update_lock
);
298 data
->temp
[nr
] = jc42_temp_to_reg(val
, data
->extended
);
299 err
= i2c_smbus_write_word_swapped(data
->client
, temp_regs
[nr
],
303 mutex_unlock(&data
->update_lock
);
308 * JC42.4 compliant chips only support four hysteresis values.
309 * Pick best choice and go from there.
311 static ssize_t
set_temp_crit_hyst(struct device
*dev
,
312 struct device_attribute
*attr
,
313 const char *buf
, size_t count
)
315 struct jc42_data
*data
= dev_get_drvdata(dev
);
321 if (kstrtol(buf
, 10, &val
) < 0)
324 val
= clamp_val(val
, (data
->extended
? JC42_TEMP_MIN_EXTENDED
:
325 JC42_TEMP_MIN
) - 6000, JC42_TEMP_MAX
);
326 diff
= jc42_temp_from_reg(data
->temp
[t_crit
]) - val
;
331 hyst
= 1; /* 1.5 degrees C */
332 else if (diff
< 4500)
333 hyst
= 2; /* 3.0 degrees C */
335 hyst
= 3; /* 6.0 degrees C */
338 mutex_lock(&data
->update_lock
);
339 data
->config
= (data
->config
& ~JC42_CFG_HYST_MASK
)
340 | (hyst
<< JC42_CFG_HYST_SHIFT
);
341 err
= i2c_smbus_write_word_swapped(data
->client
, JC42_REG_CONFIG
,
345 mutex_unlock(&data
->update_lock
);
349 static ssize_t
show_alarm(struct device
*dev
,
350 struct device_attribute
*attr
, char *buf
)
352 u16 bit
= to_sensor_dev_attr(attr
)->index
;
353 struct jc42_data
*data
= jc42_update_device(dev
);
357 return PTR_ERR(data
);
359 val
= data
->temp
[t_input
];
360 if (bit
!= JC42_ALARM_CRIT_BIT
&& (data
->config
& JC42_CFG_CRIT_ONLY
))
362 return sprintf(buf
, "%u\n", (val
>> bit
) & 1);
365 static SENSOR_DEVICE_ATTR(temp1_input
, S_IRUGO
, show_temp
, NULL
, t_input
);
366 static SENSOR_DEVICE_ATTR(temp1_crit
, S_IRUGO
, show_temp
, set_temp
, t_crit
);
367 static SENSOR_DEVICE_ATTR(temp1_min
, S_IRUGO
, show_temp
, set_temp
, t_min
);
368 static SENSOR_DEVICE_ATTR(temp1_max
, S_IRUGO
, show_temp
, set_temp
, t_max
);
370 static SENSOR_DEVICE_ATTR(temp1_crit_hyst
, S_IRUGO
, show_temp_hyst
,
371 set_temp_crit_hyst
, t_crit
);
372 static SENSOR_DEVICE_ATTR(temp1_max_hyst
, S_IRUGO
, show_temp_hyst
, NULL
, t_max
);
374 static SENSOR_DEVICE_ATTR(temp1_crit_alarm
, S_IRUGO
, show_alarm
, NULL
,
375 JC42_ALARM_CRIT_BIT
);
376 static SENSOR_DEVICE_ATTR(temp1_min_alarm
, S_IRUGO
, show_alarm
, NULL
,
378 static SENSOR_DEVICE_ATTR(temp1_max_alarm
, S_IRUGO
, show_alarm
, NULL
,
381 static struct attribute
*jc42_attributes
[] = {
382 &sensor_dev_attr_temp1_input
.dev_attr
.attr
,
383 &sensor_dev_attr_temp1_crit
.dev_attr
.attr
,
384 &sensor_dev_attr_temp1_min
.dev_attr
.attr
,
385 &sensor_dev_attr_temp1_max
.dev_attr
.attr
,
386 &sensor_dev_attr_temp1_crit_hyst
.dev_attr
.attr
,
387 &sensor_dev_attr_temp1_max_hyst
.dev_attr
.attr
,
388 &sensor_dev_attr_temp1_crit_alarm
.dev_attr
.attr
,
389 &sensor_dev_attr_temp1_min_alarm
.dev_attr
.attr
,
390 &sensor_dev_attr_temp1_max_alarm
.dev_attr
.attr
,
394 static umode_t
jc42_attribute_mode(struct kobject
*kobj
,
395 struct attribute
*attr
, int index
)
397 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
398 struct jc42_data
*data
= dev_get_drvdata(dev
);
399 unsigned int config
= data
->config
;
402 if (attr
== &sensor_dev_attr_temp1_crit
.dev_attr
.attr
)
403 readonly
= config
& JC42_CFG_TCRIT_LOCK
;
404 else if (attr
== &sensor_dev_attr_temp1_min
.dev_attr
.attr
||
405 attr
== &sensor_dev_attr_temp1_max
.dev_attr
.attr
)
406 readonly
= config
& JC42_CFG_EVENT_LOCK
;
407 else if (attr
== &sensor_dev_attr_temp1_crit_hyst
.dev_attr
.attr
)
408 readonly
= config
& (JC42_CFG_EVENT_LOCK
| JC42_CFG_TCRIT_LOCK
);
412 return S_IRUGO
| (readonly
? 0 : S_IWUSR
);
415 static const struct attribute_group jc42_group
= {
416 .attrs
= jc42_attributes
,
417 .is_visible
= jc42_attribute_mode
,
419 __ATTRIBUTE_GROUPS(jc42
);
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 strlcpy(info
->type
, "jc42", I2C_NAME_SIZE
);
453 static int jc42_probe(struct i2c_client
*client
, const struct i2c_device_id
*id
)
455 struct device
*dev
= &client
->dev
;
456 struct device
*hwmon_dev
;
457 struct jc42_data
*data
;
460 data
= devm_kzalloc(dev
, sizeof(struct jc42_data
), GFP_KERNEL
);
464 data
->client
= client
;
465 i2c_set_clientdata(client
, data
);
466 mutex_init(&data
->update_lock
);
468 cap
= i2c_smbus_read_word_swapped(client
, JC42_REG_CAP
);
472 data
->extended
= !!(cap
& JC42_CAP_RANGE
);
474 config
= i2c_smbus_read_word_swapped(client
, JC42_REG_CONFIG
);
478 data
->orig_config
= config
;
479 if (config
& JC42_CFG_SHUTDOWN
) {
480 config
&= ~JC42_CFG_SHUTDOWN
;
481 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, config
);
483 data
->config
= config
;
485 hwmon_dev
= devm_hwmon_device_register_with_groups(dev
, client
->name
,
488 return PTR_ERR_OR_ZERO(hwmon_dev
);
491 static int jc42_remove(struct i2c_client
*client
)
493 struct jc42_data
*data
= i2c_get_clientdata(client
);
495 /* Restore original configuration except hysteresis */
496 if ((data
->config
& ~JC42_CFG_HYST_MASK
) !=
497 (data
->orig_config
& ~JC42_CFG_HYST_MASK
)) {
500 config
= (data
->orig_config
& ~JC42_CFG_HYST_MASK
)
501 | (data
->config
& JC42_CFG_HYST_MASK
);
502 i2c_smbus_write_word_swapped(client
, JC42_REG_CONFIG
, config
);
509 static int jc42_suspend(struct device
*dev
)
511 struct jc42_data
*data
= dev_get_drvdata(dev
);
513 data
->config
|= JC42_CFG_SHUTDOWN
;
514 i2c_smbus_write_word_swapped(data
->client
, JC42_REG_CONFIG
,
519 static int jc42_resume(struct device
*dev
)
521 struct jc42_data
*data
= dev_get_drvdata(dev
);
523 data
->config
&= ~JC42_CFG_SHUTDOWN
;
524 i2c_smbus_write_word_swapped(data
->client
, JC42_REG_CONFIG
,
529 static const struct dev_pm_ops jc42_dev_pm_ops
= {
530 .suspend
= jc42_suspend
,
531 .resume
= jc42_resume
,
534 #define JC42_DEV_PM_OPS (&jc42_dev_pm_ops)
536 #define JC42_DEV_PM_OPS NULL
537 #endif /* CONFIG_PM */
539 static const struct i2c_device_id jc42_id
[] = {
543 MODULE_DEVICE_TABLE(i2c
, jc42_id
);
546 static const struct of_device_id jc42_of_ids
[] = {
547 { .compatible
= "jedec,jc-42.4-temp", },
550 MODULE_DEVICE_TABLE(of
, jc42_of_ids
);
553 static struct i2c_driver jc42_driver
= {
554 .class = I2C_CLASS_SPD
| I2C_CLASS_HWMON
,
557 .pm
= JC42_DEV_PM_OPS
,
558 .of_match_table
= of_match_ptr(jc42_of_ids
),
561 .remove
= jc42_remove
,
563 .detect
= jc42_detect
,
564 .address_list
= normal_i2c
,
567 module_i2c_driver(jc42_driver
);
569 MODULE_AUTHOR("Guenter Roeck <linux@roeck-us.net>");
570 MODULE_DESCRIPTION("JC42 driver");
571 MODULE_LICENSE("GPL");