1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Driver for TI ADC128D818 System Monitor with Temperature Sensor
5 * Copyright (c) 2014 Guenter Roeck
8 * Copyright (C) 1998, 1999 Frodo Looijaard <frodol@dds.nl>
9 * and Philip Edelbrock <phil@netroedge.com>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/jiffies.h>
15 #include <linux/i2c.h>
16 #include <linux/hwmon.h>
17 #include <linux/hwmon-sysfs.h>
18 #include <linux/err.h>
19 #include <linux/regulator/consumer.h>
20 #include <linux/mutex.h>
21 #include <linux/bitops.h>
25 * The chip also supports addresses 0x35..0x37. Don't scan those addresses
26 * since they are also used by some EEPROMs, which may result in false
29 static const unsigned short normal_i2c
[] = {
30 0x1d, 0x1e, 0x1f, 0x2d, 0x2e, 0x2f, I2C_CLIENT_END
};
33 #define ADC128_REG_IN_MAX(nr) (0x2a + (nr) * 2)
34 #define ADC128_REG_IN_MIN(nr) (0x2b + (nr) * 2)
35 #define ADC128_REG_IN(nr) (0x20 + (nr))
37 #define ADC128_REG_TEMP 0x27
38 #define ADC128_REG_TEMP_MAX 0x38
39 #define ADC128_REG_TEMP_HYST 0x39
41 #define ADC128_REG_CONFIG 0x00
42 #define ADC128_REG_ALARM 0x01
43 #define ADC128_REG_MASK 0x03
44 #define ADC128_REG_CONV_RATE 0x07
45 #define ADC128_REG_ONESHOT 0x09
46 #define ADC128_REG_SHUTDOWN 0x0a
47 #define ADC128_REG_CONFIG_ADV 0x0b
48 #define ADC128_REG_BUSY_STATUS 0x0c
50 #define ADC128_REG_MAN_ID 0x3e
51 #define ADC128_REG_DEV_ID 0x3f
53 /* No. of voltage entries in adc128_attrs */
54 #define ADC128_ATTR_NUM_VOLT (8 * 4)
56 /* Voltage inputs visible per operation mode */
57 static const u8 num_inputs
[] = { 7, 8, 4, 6 };
60 struct i2c_client
*client
;
61 struct regulator
*regulator
;
62 int vref
; /* Reference voltage in mV */
63 struct mutex update_lock
;
64 u8 mode
; /* Operation mode */
65 bool valid
; /* true if following fields are valid */
66 unsigned long last_updated
; /* In jiffies */
68 u16 in
[3][8]; /* Register value, normalized to 12 bit
73 s16 temp
[3]; /* Register value, normalized to 9 bit
74 * 0: sensor 1: limit 2: hyst
76 u8 alarms
; /* alarm register value */
79 static struct adc128_data
*adc128_update_device(struct device
*dev
)
81 struct adc128_data
*data
= dev_get_drvdata(dev
);
82 struct i2c_client
*client
= data
->client
;
83 struct adc128_data
*ret
= data
;
86 mutex_lock(&data
->update_lock
);
88 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
89 for (i
= 0; i
< num_inputs
[data
->mode
]; i
++) {
90 rv
= i2c_smbus_read_word_swapped(client
,
94 data
->in
[0][i
] = rv
>> 4;
96 rv
= i2c_smbus_read_byte_data(client
,
97 ADC128_REG_IN_MIN(i
));
100 data
->in
[1][i
] = rv
<< 4;
102 rv
= i2c_smbus_read_byte_data(client
,
103 ADC128_REG_IN_MAX(i
));
106 data
->in
[2][i
] = rv
<< 4;
109 if (data
->mode
!= 1) {
110 rv
= i2c_smbus_read_word_swapped(client
,
114 data
->temp
[0] = rv
>> 7;
116 rv
= i2c_smbus_read_byte_data(client
,
117 ADC128_REG_TEMP_MAX
);
120 data
->temp
[1] = rv
<< 1;
122 rv
= i2c_smbus_read_byte_data(client
,
123 ADC128_REG_TEMP_HYST
);
126 data
->temp
[2] = rv
<< 1;
129 rv
= i2c_smbus_read_byte_data(client
, ADC128_REG_ALARM
);
134 data
->last_updated
= jiffies
;
143 mutex_unlock(&data
->update_lock
);
147 static ssize_t
adc128_in_show(struct device
*dev
,
148 struct device_attribute
*attr
, char *buf
)
150 struct adc128_data
*data
= adc128_update_device(dev
);
151 int index
= to_sensor_dev_attr_2(attr
)->index
;
152 int nr
= to_sensor_dev_attr_2(attr
)->nr
;
156 return PTR_ERR(data
);
158 val
= DIV_ROUND_CLOSEST(data
->in
[index
][nr
] * data
->vref
, 4095);
159 return sprintf(buf
, "%d\n", val
);
162 static ssize_t
adc128_in_store(struct device
*dev
,
163 struct device_attribute
*attr
, const char *buf
,
166 struct adc128_data
*data
= dev_get_drvdata(dev
);
167 int index
= to_sensor_dev_attr_2(attr
)->index
;
168 int nr
= to_sensor_dev_attr_2(attr
)->nr
;
173 err
= kstrtol(buf
, 10, &val
);
177 mutex_lock(&data
->update_lock
);
178 /* 10 mV LSB on limit registers */
179 regval
= clamp_val(DIV_ROUND_CLOSEST(val
, 10), 0, 255);
180 data
->in
[index
][nr
] = regval
<< 4;
181 reg
= index
== 1 ? ADC128_REG_IN_MIN(nr
) : ADC128_REG_IN_MAX(nr
);
182 i2c_smbus_write_byte_data(data
->client
, reg
, regval
);
183 mutex_unlock(&data
->update_lock
);
188 static ssize_t
adc128_temp_show(struct device
*dev
,
189 struct device_attribute
*attr
, char *buf
)
191 struct adc128_data
*data
= adc128_update_device(dev
);
192 int index
= to_sensor_dev_attr(attr
)->index
;
196 return PTR_ERR(data
);
198 temp
= sign_extend32(data
->temp
[index
], 8);
199 return sprintf(buf
, "%d\n", temp
* 500);/* 0.5 degrees C resolution */
202 static ssize_t
adc128_temp_store(struct device
*dev
,
203 struct device_attribute
*attr
,
204 const char *buf
, size_t count
)
206 struct adc128_data
*data
= dev_get_drvdata(dev
);
207 int index
= to_sensor_dev_attr(attr
)->index
;
212 err
= kstrtol(buf
, 10, &val
);
216 mutex_lock(&data
->update_lock
);
217 regval
= clamp_val(DIV_ROUND_CLOSEST(val
, 1000), -128, 127);
218 data
->temp
[index
] = regval
<< 1;
219 i2c_smbus_write_byte_data(data
->client
,
220 index
== 1 ? ADC128_REG_TEMP_MAX
221 : ADC128_REG_TEMP_HYST
,
223 mutex_unlock(&data
->update_lock
);
228 static ssize_t
adc128_alarm_show(struct device
*dev
,
229 struct device_attribute
*attr
, char *buf
)
231 struct adc128_data
*data
= adc128_update_device(dev
);
232 int mask
= 1 << to_sensor_dev_attr(attr
)->index
;
236 return PTR_ERR(data
);
239 * Clear an alarm after reporting it to user space. If it is still
240 * active, the next update sequence will set the alarm bit again.
242 alarms
= data
->alarms
;
243 data
->alarms
&= ~mask
;
245 return sprintf(buf
, "%u\n", !!(alarms
& mask
));
248 static umode_t
adc128_is_visible(struct kobject
*kobj
,
249 struct attribute
*attr
, int index
)
251 struct device
*dev
= kobj_to_dev(kobj
);
252 struct adc128_data
*data
= dev_get_drvdata(dev
);
254 if (index
< ADC128_ATTR_NUM_VOLT
) {
255 /* Voltage, visible according to num_inputs[] */
256 if (index
>= num_inputs
[data
->mode
] * 4)
259 /* Temperature, visible if not in mode 1 */
267 static SENSOR_DEVICE_ATTR_2_RO(in0_input
, adc128_in
, 0, 0);
268 static SENSOR_DEVICE_ATTR_2_RW(in0_min
, adc128_in
, 0, 1);
269 static SENSOR_DEVICE_ATTR_2_RW(in0_max
, adc128_in
, 0, 2);
271 static SENSOR_DEVICE_ATTR_2_RO(in1_input
, adc128_in
, 1, 0);
272 static SENSOR_DEVICE_ATTR_2_RW(in1_min
, adc128_in
, 1, 1);
273 static SENSOR_DEVICE_ATTR_2_RW(in1_max
, adc128_in
, 1, 2);
275 static SENSOR_DEVICE_ATTR_2_RO(in2_input
, adc128_in
, 2, 0);
276 static SENSOR_DEVICE_ATTR_2_RW(in2_min
, adc128_in
, 2, 1);
277 static SENSOR_DEVICE_ATTR_2_RW(in2_max
, adc128_in
, 2, 2);
279 static SENSOR_DEVICE_ATTR_2_RO(in3_input
, adc128_in
, 3, 0);
280 static SENSOR_DEVICE_ATTR_2_RW(in3_min
, adc128_in
, 3, 1);
281 static SENSOR_DEVICE_ATTR_2_RW(in3_max
, adc128_in
, 3, 2);
283 static SENSOR_DEVICE_ATTR_2_RO(in4_input
, adc128_in
, 4, 0);
284 static SENSOR_DEVICE_ATTR_2_RW(in4_min
, adc128_in
, 4, 1);
285 static SENSOR_DEVICE_ATTR_2_RW(in4_max
, adc128_in
, 4, 2);
287 static SENSOR_DEVICE_ATTR_2_RO(in5_input
, adc128_in
, 5, 0);
288 static SENSOR_DEVICE_ATTR_2_RW(in5_min
, adc128_in
, 5, 1);
289 static SENSOR_DEVICE_ATTR_2_RW(in5_max
, adc128_in
, 5, 2);
291 static SENSOR_DEVICE_ATTR_2_RO(in6_input
, adc128_in
, 6, 0);
292 static SENSOR_DEVICE_ATTR_2_RW(in6_min
, adc128_in
, 6, 1);
293 static SENSOR_DEVICE_ATTR_2_RW(in6_max
, adc128_in
, 6, 2);
295 static SENSOR_DEVICE_ATTR_2_RO(in7_input
, adc128_in
, 7, 0);
296 static SENSOR_DEVICE_ATTR_2_RW(in7_min
, adc128_in
, 7, 1);
297 static SENSOR_DEVICE_ATTR_2_RW(in7_max
, adc128_in
, 7, 2);
299 static SENSOR_DEVICE_ATTR_RO(temp1_input
, adc128_temp
, 0);
300 static SENSOR_DEVICE_ATTR_RW(temp1_max
, adc128_temp
, 1);
301 static SENSOR_DEVICE_ATTR_RW(temp1_max_hyst
, adc128_temp
, 2);
303 static SENSOR_DEVICE_ATTR_RO(in0_alarm
, adc128_alarm
, 0);
304 static SENSOR_DEVICE_ATTR_RO(in1_alarm
, adc128_alarm
, 1);
305 static SENSOR_DEVICE_ATTR_RO(in2_alarm
, adc128_alarm
, 2);
306 static SENSOR_DEVICE_ATTR_RO(in3_alarm
, adc128_alarm
, 3);
307 static SENSOR_DEVICE_ATTR_RO(in4_alarm
, adc128_alarm
, 4);
308 static SENSOR_DEVICE_ATTR_RO(in5_alarm
, adc128_alarm
, 5);
309 static SENSOR_DEVICE_ATTR_RO(in6_alarm
, adc128_alarm
, 6);
310 static SENSOR_DEVICE_ATTR_RO(in7_alarm
, adc128_alarm
, 7);
311 static SENSOR_DEVICE_ATTR_RO(temp1_max_alarm
, adc128_alarm
, 7);
313 static struct attribute
*adc128_attrs
[] = {
314 &sensor_dev_attr_in0_alarm
.dev_attr
.attr
,
315 &sensor_dev_attr_in0_input
.dev_attr
.attr
,
316 &sensor_dev_attr_in0_max
.dev_attr
.attr
,
317 &sensor_dev_attr_in0_min
.dev_attr
.attr
,
318 &sensor_dev_attr_in1_alarm
.dev_attr
.attr
,
319 &sensor_dev_attr_in1_input
.dev_attr
.attr
,
320 &sensor_dev_attr_in1_max
.dev_attr
.attr
,
321 &sensor_dev_attr_in1_min
.dev_attr
.attr
,
322 &sensor_dev_attr_in2_alarm
.dev_attr
.attr
,
323 &sensor_dev_attr_in2_input
.dev_attr
.attr
,
324 &sensor_dev_attr_in2_max
.dev_attr
.attr
,
325 &sensor_dev_attr_in2_min
.dev_attr
.attr
,
326 &sensor_dev_attr_in3_alarm
.dev_attr
.attr
,
327 &sensor_dev_attr_in3_input
.dev_attr
.attr
,
328 &sensor_dev_attr_in3_max
.dev_attr
.attr
,
329 &sensor_dev_attr_in3_min
.dev_attr
.attr
,
330 &sensor_dev_attr_in4_alarm
.dev_attr
.attr
,
331 &sensor_dev_attr_in4_input
.dev_attr
.attr
,
332 &sensor_dev_attr_in4_max
.dev_attr
.attr
,
333 &sensor_dev_attr_in4_min
.dev_attr
.attr
,
334 &sensor_dev_attr_in5_alarm
.dev_attr
.attr
,
335 &sensor_dev_attr_in5_input
.dev_attr
.attr
,
336 &sensor_dev_attr_in5_max
.dev_attr
.attr
,
337 &sensor_dev_attr_in5_min
.dev_attr
.attr
,
338 &sensor_dev_attr_in6_alarm
.dev_attr
.attr
,
339 &sensor_dev_attr_in6_input
.dev_attr
.attr
,
340 &sensor_dev_attr_in6_max
.dev_attr
.attr
,
341 &sensor_dev_attr_in6_min
.dev_attr
.attr
,
342 &sensor_dev_attr_in7_alarm
.dev_attr
.attr
,
343 &sensor_dev_attr_in7_input
.dev_attr
.attr
,
344 &sensor_dev_attr_in7_max
.dev_attr
.attr
,
345 &sensor_dev_attr_in7_min
.dev_attr
.attr
,
346 &sensor_dev_attr_temp1_input
.dev_attr
.attr
,
347 &sensor_dev_attr_temp1_max
.dev_attr
.attr
,
348 &sensor_dev_attr_temp1_max_alarm
.dev_attr
.attr
,
349 &sensor_dev_attr_temp1_max_hyst
.dev_attr
.attr
,
353 static const struct attribute_group adc128_group
= {
354 .attrs
= adc128_attrs
,
355 .is_visible
= adc128_is_visible
,
357 __ATTRIBUTE_GROUPS(adc128
);
359 static int adc128_detect(struct i2c_client
*client
, struct i2c_board_info
*info
)
363 if (!i2c_check_functionality(client
->adapter
,
364 I2C_FUNC_SMBUS_BYTE_DATA
|
365 I2C_FUNC_SMBUS_WORD_DATA
))
368 man_id
= i2c_smbus_read_byte_data(client
, ADC128_REG_MAN_ID
);
369 dev_id
= i2c_smbus_read_byte_data(client
, ADC128_REG_DEV_ID
);
370 if (man_id
!= 0x01 || dev_id
!= 0x09)
373 /* Check unused bits for confirmation */
374 if (i2c_smbus_read_byte_data(client
, ADC128_REG_CONFIG
) & 0xf4)
376 if (i2c_smbus_read_byte_data(client
, ADC128_REG_CONV_RATE
) & 0xfe)
378 if (i2c_smbus_read_byte_data(client
, ADC128_REG_ONESHOT
) & 0xfe)
380 if (i2c_smbus_read_byte_data(client
, ADC128_REG_SHUTDOWN
) & 0xfe)
382 if (i2c_smbus_read_byte_data(client
, ADC128_REG_CONFIG_ADV
) & 0xf8)
384 if (i2c_smbus_read_byte_data(client
, ADC128_REG_BUSY_STATUS
) & 0xfc)
387 strlcpy(info
->type
, "adc128d818", I2C_NAME_SIZE
);
392 static int adc128_init_client(struct adc128_data
*data
)
394 struct i2c_client
*client
= data
->client
;
399 * Reset chip to defaults.
400 * This makes most other initializations unnecessary.
402 err
= i2c_smbus_write_byte_data(client
, ADC128_REG_CONFIG
, 0x80);
406 /* Set operation mode, if non-default */
408 regval
|= data
->mode
<< 1;
410 /* If external vref is selected, configure the chip to use it */
414 /* Write advanced configuration register */
416 err
= i2c_smbus_write_byte_data(client
, ADC128_REG_CONFIG_ADV
,
422 /* Start monitoring */
423 err
= i2c_smbus_write_byte_data(client
, ADC128_REG_CONFIG
, 0x01);
430 static int adc128_probe(struct i2c_client
*client
)
432 struct device
*dev
= &client
->dev
;
433 struct regulator
*regulator
;
434 struct device
*hwmon_dev
;
435 struct adc128_data
*data
;
438 data
= devm_kzalloc(dev
, sizeof(struct adc128_data
), GFP_KERNEL
);
442 /* vref is optional. If specified, is used as chip reference voltage */
443 regulator
= devm_regulator_get_optional(dev
, "vref");
444 if (!IS_ERR(regulator
)) {
445 data
->regulator
= regulator
;
446 err
= regulator_enable(regulator
);
449 vref
= regulator_get_voltage(regulator
);
454 data
->vref
= DIV_ROUND_CLOSEST(vref
, 1000);
456 data
->vref
= 2560; /* 2.56V, in mV */
459 /* Operation mode is optional. If unspecified, keep current mode */
460 if (of_property_read_u8(dev
->of_node
, "ti,mode", &data
->mode
) == 0) {
461 if (data
->mode
> 3) {
462 dev_err(dev
, "invalid operation mode %d\n",
468 err
= i2c_smbus_read_byte_data(client
, ADC128_REG_CONFIG_ADV
);
471 data
->mode
= (err
>> 1) & ADC128_REG_MASK
;
474 data
->client
= client
;
475 i2c_set_clientdata(client
, data
);
476 mutex_init(&data
->update_lock
);
478 /* Initialize the chip */
479 err
= adc128_init_client(data
);
483 hwmon_dev
= devm_hwmon_device_register_with_groups(dev
, client
->name
,
484 data
, adc128_groups
);
485 if (IS_ERR(hwmon_dev
)) {
486 err
= PTR_ERR(hwmon_dev
);
494 regulator_disable(data
->regulator
);
498 static int adc128_remove(struct i2c_client
*client
)
500 struct adc128_data
*data
= i2c_get_clientdata(client
);
503 regulator_disable(data
->regulator
);
508 static const struct i2c_device_id adc128_id
[] = {
512 MODULE_DEVICE_TABLE(i2c
, adc128_id
);
514 static const struct of_device_id __maybe_unused adc128_of_match
[] = {
515 { .compatible
= "ti,adc128d818" },
518 MODULE_DEVICE_TABLE(of
, adc128_of_match
);
520 static struct i2c_driver adc128_driver
= {
521 .class = I2C_CLASS_HWMON
,
523 .name
= "adc128d818",
524 .of_match_table
= of_match_ptr(adc128_of_match
),
526 .probe_new
= adc128_probe
,
527 .remove
= adc128_remove
,
528 .id_table
= adc128_id
,
529 .detect
= adc128_detect
,
530 .address_list
= normal_i2c
,
533 module_i2c_driver(adc128_driver
);
535 MODULE_AUTHOR("Guenter Roeck");
536 MODULE_DESCRIPTION("Driver for ADC128D818");
537 MODULE_LICENSE("GPL");