2 * Driver for TI ADC128D818 System Monitor with Temperature Sensor
4 * Copyright (c) 2014 Guenter Roeck
7 * Copyright (C) 1998, 1999 Frodo Looijaard <frodol@dds.nl>
8 * and Philip Edelbrock <phil@netroedge.com>
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.
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/jiffies.h>
24 #include <linux/i2c.h>
25 #include <linux/hwmon.h>
26 #include <linux/hwmon-sysfs.h>
27 #include <linux/err.h>
28 #include <linux/regulator/consumer.h>
29 #include <linux/mutex.h>
30 #include <linux/bitops.h>
34 * The chip also supports addresses 0x35..0x37. Don't scan those addresses
35 * since they are also used by some EEPROMs, which may result in false
38 static const unsigned short normal_i2c
[] = {
39 0x1d, 0x1e, 0x1f, 0x2d, 0x2e, 0x2f, I2C_CLIENT_END
};
42 #define ADC128_REG_IN_MAX(nr) (0x2a + (nr) * 2)
43 #define ADC128_REG_IN_MIN(nr) (0x2b + (nr) * 2)
44 #define ADC128_REG_IN(nr) (0x20 + (nr))
46 #define ADC128_REG_TEMP 0x27
47 #define ADC128_REG_TEMP_MAX 0x38
48 #define ADC128_REG_TEMP_HYST 0x39
50 #define ADC128_REG_CONFIG 0x00
51 #define ADC128_REG_ALARM 0x01
52 #define ADC128_REG_MASK 0x03
53 #define ADC128_REG_CONV_RATE 0x07
54 #define ADC128_REG_ONESHOT 0x09
55 #define ADC128_REG_SHUTDOWN 0x0a
56 #define ADC128_REG_CONFIG_ADV 0x0b
57 #define ADC128_REG_BUSY_STATUS 0x0c
59 #define ADC128_REG_MAN_ID 0x3e
60 #define ADC128_REG_DEV_ID 0x3f
62 /* No. of voltage entries in adc128_attrs */
63 #define ADC128_ATTR_NUM_VOLT (8 * 4)
65 /* Voltage inputs visible per operation mode */
66 static const u8 num_inputs
[] = { 7, 8, 4, 6 };
69 struct i2c_client
*client
;
70 struct regulator
*regulator
;
71 int vref
; /* Reference voltage in mV */
72 struct mutex update_lock
;
73 u8 mode
; /* Operation mode */
74 bool valid
; /* true if following fields are valid */
75 unsigned long last_updated
; /* In jiffies */
77 u16 in
[3][8]; /* Register value, normalized to 12 bit
82 s16 temp
[3]; /* Register value, normalized to 9 bit
83 * 0: sensor 1: limit 2: hyst
85 u8 alarms
; /* alarm register value */
88 static struct adc128_data
*adc128_update_device(struct device
*dev
)
90 struct adc128_data
*data
= dev_get_drvdata(dev
);
91 struct i2c_client
*client
= data
->client
;
92 struct adc128_data
*ret
= data
;
95 mutex_lock(&data
->update_lock
);
97 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
98 for (i
= 0; i
< num_inputs
[data
->mode
]; i
++) {
99 rv
= i2c_smbus_read_word_swapped(client
,
103 data
->in
[0][i
] = rv
>> 4;
105 rv
= i2c_smbus_read_byte_data(client
,
106 ADC128_REG_IN_MIN(i
));
109 data
->in
[1][i
] = rv
<< 4;
111 rv
= i2c_smbus_read_byte_data(client
,
112 ADC128_REG_IN_MAX(i
));
115 data
->in
[2][i
] = rv
<< 4;
118 if (data
->mode
!= 1) {
119 rv
= i2c_smbus_read_word_swapped(client
,
123 data
->temp
[0] = rv
>> 7;
125 rv
= i2c_smbus_read_byte_data(client
,
126 ADC128_REG_TEMP_MAX
);
129 data
->temp
[1] = rv
<< 1;
131 rv
= i2c_smbus_read_byte_data(client
,
132 ADC128_REG_TEMP_HYST
);
135 data
->temp
[2] = rv
<< 1;
138 rv
= i2c_smbus_read_byte_data(client
, ADC128_REG_ALARM
);
143 data
->last_updated
= jiffies
;
152 mutex_unlock(&data
->update_lock
);
156 static ssize_t
adc128_show_in(struct device
*dev
, struct device_attribute
*attr
,
159 struct adc128_data
*data
= adc128_update_device(dev
);
160 int index
= to_sensor_dev_attr_2(attr
)->index
;
161 int nr
= to_sensor_dev_attr_2(attr
)->nr
;
165 return PTR_ERR(data
);
167 val
= DIV_ROUND_CLOSEST(data
->in
[index
][nr
] * data
->vref
, 4095);
168 return sprintf(buf
, "%d\n", val
);
171 static ssize_t
adc128_set_in(struct device
*dev
, struct device_attribute
*attr
,
172 const char *buf
, size_t count
)
174 struct adc128_data
*data
= dev_get_drvdata(dev
);
175 int index
= to_sensor_dev_attr_2(attr
)->index
;
176 int nr
= to_sensor_dev_attr_2(attr
)->nr
;
181 err
= kstrtol(buf
, 10, &val
);
185 mutex_lock(&data
->update_lock
);
186 /* 10 mV LSB on limit registers */
187 regval
= clamp_val(DIV_ROUND_CLOSEST(val
, 10), 0, 255);
188 data
->in
[index
][nr
] = regval
<< 4;
189 reg
= index
== 1 ? ADC128_REG_IN_MIN(nr
) : ADC128_REG_IN_MAX(nr
);
190 i2c_smbus_write_byte_data(data
->client
, reg
, regval
);
191 mutex_unlock(&data
->update_lock
);
196 static ssize_t
adc128_show_temp(struct device
*dev
,
197 struct device_attribute
*attr
, char *buf
)
199 struct adc128_data
*data
= adc128_update_device(dev
);
200 int index
= to_sensor_dev_attr(attr
)->index
;
204 return PTR_ERR(data
);
206 temp
= sign_extend32(data
->temp
[index
], 8);
207 return sprintf(buf
, "%d\n", temp
* 500);/* 0.5 degrees C resolution */
210 static ssize_t
adc128_set_temp(struct device
*dev
,
211 struct device_attribute
*attr
,
212 const char *buf
, size_t count
)
214 struct adc128_data
*data
= dev_get_drvdata(dev
);
215 int index
= to_sensor_dev_attr(attr
)->index
;
220 err
= kstrtol(buf
, 10, &val
);
224 mutex_lock(&data
->update_lock
);
225 regval
= clamp_val(DIV_ROUND_CLOSEST(val
, 1000), -128, 127);
226 data
->temp
[index
] = regval
<< 1;
227 i2c_smbus_write_byte_data(data
->client
,
228 index
== 1 ? ADC128_REG_TEMP_MAX
229 : ADC128_REG_TEMP_HYST
,
231 mutex_unlock(&data
->update_lock
);
236 static ssize_t
adc128_show_alarm(struct device
*dev
,
237 struct device_attribute
*attr
, char *buf
)
239 struct adc128_data
*data
= adc128_update_device(dev
);
240 int mask
= 1 << to_sensor_dev_attr(attr
)->index
;
244 return PTR_ERR(data
);
247 * Clear an alarm after reporting it to user space. If it is still
248 * active, the next update sequence will set the alarm bit again.
250 alarms
= data
->alarms
;
251 data
->alarms
&= ~mask
;
253 return sprintf(buf
, "%u\n", !!(alarms
& mask
));
256 static umode_t
adc128_is_visible(struct kobject
*kobj
,
257 struct attribute
*attr
, int index
)
259 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
260 struct adc128_data
*data
= dev_get_drvdata(dev
);
262 if (index
< ADC128_ATTR_NUM_VOLT
) {
263 /* Voltage, visible according to num_inputs[] */
264 if (index
>= num_inputs
[data
->mode
] * 4)
267 /* Temperature, visible if not in mode 1 */
275 static SENSOR_DEVICE_ATTR_2(in0_input
, S_IRUGO
,
276 adc128_show_in
, NULL
, 0, 0);
277 static SENSOR_DEVICE_ATTR_2(in0_min
, S_IWUSR
| S_IRUGO
,
278 adc128_show_in
, adc128_set_in
, 0, 1);
279 static SENSOR_DEVICE_ATTR_2(in0_max
, S_IWUSR
| S_IRUGO
,
280 adc128_show_in
, adc128_set_in
, 0, 2);
282 static SENSOR_DEVICE_ATTR_2(in1_input
, S_IRUGO
,
283 adc128_show_in
, NULL
, 1, 0);
284 static SENSOR_DEVICE_ATTR_2(in1_min
, S_IWUSR
| S_IRUGO
,
285 adc128_show_in
, adc128_set_in
, 1, 1);
286 static SENSOR_DEVICE_ATTR_2(in1_max
, S_IWUSR
| S_IRUGO
,
287 adc128_show_in
, adc128_set_in
, 1, 2);
289 static SENSOR_DEVICE_ATTR_2(in2_input
, S_IRUGO
,
290 adc128_show_in
, NULL
, 2, 0);
291 static SENSOR_DEVICE_ATTR_2(in2_min
, S_IWUSR
| S_IRUGO
,
292 adc128_show_in
, adc128_set_in
, 2, 1);
293 static SENSOR_DEVICE_ATTR_2(in2_max
, S_IWUSR
| S_IRUGO
,
294 adc128_show_in
, adc128_set_in
, 2, 2);
296 static SENSOR_DEVICE_ATTR_2(in3_input
, S_IRUGO
,
297 adc128_show_in
, NULL
, 3, 0);
298 static SENSOR_DEVICE_ATTR_2(in3_min
, S_IWUSR
| S_IRUGO
,
299 adc128_show_in
, adc128_set_in
, 3, 1);
300 static SENSOR_DEVICE_ATTR_2(in3_max
, S_IWUSR
| S_IRUGO
,
301 adc128_show_in
, adc128_set_in
, 3, 2);
303 static SENSOR_DEVICE_ATTR_2(in4_input
, S_IRUGO
,
304 adc128_show_in
, NULL
, 4, 0);
305 static SENSOR_DEVICE_ATTR_2(in4_min
, S_IWUSR
| S_IRUGO
,
306 adc128_show_in
, adc128_set_in
, 4, 1);
307 static SENSOR_DEVICE_ATTR_2(in4_max
, S_IWUSR
| S_IRUGO
,
308 adc128_show_in
, adc128_set_in
, 4, 2);
310 static SENSOR_DEVICE_ATTR_2(in5_input
, S_IRUGO
,
311 adc128_show_in
, NULL
, 5, 0);
312 static SENSOR_DEVICE_ATTR_2(in5_min
, S_IWUSR
| S_IRUGO
,
313 adc128_show_in
, adc128_set_in
, 5, 1);
314 static SENSOR_DEVICE_ATTR_2(in5_max
, S_IWUSR
| S_IRUGO
,
315 adc128_show_in
, adc128_set_in
, 5, 2);
317 static SENSOR_DEVICE_ATTR_2(in6_input
, S_IRUGO
,
318 adc128_show_in
, NULL
, 6, 0);
319 static SENSOR_DEVICE_ATTR_2(in6_min
, S_IWUSR
| S_IRUGO
,
320 adc128_show_in
, adc128_set_in
, 6, 1);
321 static SENSOR_DEVICE_ATTR_2(in6_max
, S_IWUSR
| S_IRUGO
,
322 adc128_show_in
, adc128_set_in
, 6, 2);
324 static SENSOR_DEVICE_ATTR_2(in7_input
, S_IRUGO
,
325 adc128_show_in
, NULL
, 7, 0);
326 static SENSOR_DEVICE_ATTR_2(in7_min
, S_IWUSR
| S_IRUGO
,
327 adc128_show_in
, adc128_set_in
, 7, 1);
328 static SENSOR_DEVICE_ATTR_2(in7_max
, S_IWUSR
| S_IRUGO
,
329 adc128_show_in
, adc128_set_in
, 7, 2);
331 static SENSOR_DEVICE_ATTR(temp1_input
, S_IRUGO
, adc128_show_temp
, NULL
, 0);
332 static SENSOR_DEVICE_ATTR(temp1_max
, S_IWUSR
| S_IRUGO
,
333 adc128_show_temp
, adc128_set_temp
, 1);
334 static SENSOR_DEVICE_ATTR(temp1_max_hyst
, S_IWUSR
| S_IRUGO
,
335 adc128_show_temp
, adc128_set_temp
, 2);
337 static SENSOR_DEVICE_ATTR(in0_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 0);
338 static SENSOR_DEVICE_ATTR(in1_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 1);
339 static SENSOR_DEVICE_ATTR(in2_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 2);
340 static SENSOR_DEVICE_ATTR(in3_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 3);
341 static SENSOR_DEVICE_ATTR(in4_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 4);
342 static SENSOR_DEVICE_ATTR(in5_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 5);
343 static SENSOR_DEVICE_ATTR(in6_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 6);
344 static SENSOR_DEVICE_ATTR(in7_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 7);
345 static SENSOR_DEVICE_ATTR(temp1_max_alarm
, S_IRUGO
, adc128_show_alarm
, NULL
, 7);
347 static struct attribute
*adc128_attrs
[] = {
348 &sensor_dev_attr_in0_alarm
.dev_attr
.attr
,
349 &sensor_dev_attr_in0_input
.dev_attr
.attr
,
350 &sensor_dev_attr_in0_max
.dev_attr
.attr
,
351 &sensor_dev_attr_in0_min
.dev_attr
.attr
,
352 &sensor_dev_attr_in1_alarm
.dev_attr
.attr
,
353 &sensor_dev_attr_in1_input
.dev_attr
.attr
,
354 &sensor_dev_attr_in1_max
.dev_attr
.attr
,
355 &sensor_dev_attr_in1_min
.dev_attr
.attr
,
356 &sensor_dev_attr_in2_alarm
.dev_attr
.attr
,
357 &sensor_dev_attr_in2_input
.dev_attr
.attr
,
358 &sensor_dev_attr_in2_max
.dev_attr
.attr
,
359 &sensor_dev_attr_in2_min
.dev_attr
.attr
,
360 &sensor_dev_attr_in3_alarm
.dev_attr
.attr
,
361 &sensor_dev_attr_in3_input
.dev_attr
.attr
,
362 &sensor_dev_attr_in3_max
.dev_attr
.attr
,
363 &sensor_dev_attr_in3_min
.dev_attr
.attr
,
364 &sensor_dev_attr_in4_alarm
.dev_attr
.attr
,
365 &sensor_dev_attr_in4_input
.dev_attr
.attr
,
366 &sensor_dev_attr_in4_max
.dev_attr
.attr
,
367 &sensor_dev_attr_in4_min
.dev_attr
.attr
,
368 &sensor_dev_attr_in5_alarm
.dev_attr
.attr
,
369 &sensor_dev_attr_in5_input
.dev_attr
.attr
,
370 &sensor_dev_attr_in5_max
.dev_attr
.attr
,
371 &sensor_dev_attr_in5_min
.dev_attr
.attr
,
372 &sensor_dev_attr_in6_alarm
.dev_attr
.attr
,
373 &sensor_dev_attr_in6_input
.dev_attr
.attr
,
374 &sensor_dev_attr_in6_max
.dev_attr
.attr
,
375 &sensor_dev_attr_in6_min
.dev_attr
.attr
,
376 &sensor_dev_attr_in7_alarm
.dev_attr
.attr
,
377 &sensor_dev_attr_in7_input
.dev_attr
.attr
,
378 &sensor_dev_attr_in7_max
.dev_attr
.attr
,
379 &sensor_dev_attr_in7_min
.dev_attr
.attr
,
380 &sensor_dev_attr_temp1_input
.dev_attr
.attr
,
381 &sensor_dev_attr_temp1_max
.dev_attr
.attr
,
382 &sensor_dev_attr_temp1_max_alarm
.dev_attr
.attr
,
383 &sensor_dev_attr_temp1_max_hyst
.dev_attr
.attr
,
387 static const struct attribute_group adc128_group
= {
388 .attrs
= adc128_attrs
,
389 .is_visible
= adc128_is_visible
,
391 __ATTRIBUTE_GROUPS(adc128
);
393 static int adc128_detect(struct i2c_client
*client
, struct i2c_board_info
*info
)
397 if (!i2c_check_functionality(client
->adapter
,
398 I2C_FUNC_SMBUS_BYTE_DATA
|
399 I2C_FUNC_SMBUS_WORD_DATA
))
402 man_id
= i2c_smbus_read_byte_data(client
, ADC128_REG_MAN_ID
);
403 dev_id
= i2c_smbus_read_byte_data(client
, ADC128_REG_DEV_ID
);
404 if (man_id
!= 0x01 || dev_id
!= 0x09)
407 /* Check unused bits for confirmation */
408 if (i2c_smbus_read_byte_data(client
, ADC128_REG_CONFIG
) & 0xf4)
410 if (i2c_smbus_read_byte_data(client
, ADC128_REG_CONV_RATE
) & 0xfe)
412 if (i2c_smbus_read_byte_data(client
, ADC128_REG_ONESHOT
) & 0xfe)
414 if (i2c_smbus_read_byte_data(client
, ADC128_REG_SHUTDOWN
) & 0xfe)
416 if (i2c_smbus_read_byte_data(client
, ADC128_REG_CONFIG_ADV
) & 0xf8)
418 if (i2c_smbus_read_byte_data(client
, ADC128_REG_BUSY_STATUS
) & 0xfc)
421 strlcpy(info
->type
, "adc128d818", I2C_NAME_SIZE
);
426 static int adc128_init_client(struct adc128_data
*data
)
428 struct i2c_client
*client
= data
->client
;
432 * Reset chip to defaults.
433 * This makes most other initializations unnecessary.
435 err
= i2c_smbus_write_byte_data(client
, ADC128_REG_CONFIG
, 0x80);
439 /* Set operation mode, if non-default */
440 if (data
->mode
!= 0) {
441 err
= i2c_smbus_write_byte_data(client
,
442 ADC128_REG_CONFIG_ADV
,
448 /* Start monitoring */
449 err
= i2c_smbus_write_byte_data(client
, ADC128_REG_CONFIG
, 0x01);
453 /* If external vref is selected, configure the chip to use it */
454 if (data
->regulator
) {
455 err
= i2c_smbus_write_byte_data(client
,
456 ADC128_REG_CONFIG_ADV
, 0x01);
464 static int adc128_probe(struct i2c_client
*client
,
465 const struct i2c_device_id
*id
)
467 struct device
*dev
= &client
->dev
;
468 struct regulator
*regulator
;
469 struct device
*hwmon_dev
;
470 struct adc128_data
*data
;
473 data
= devm_kzalloc(dev
, sizeof(struct adc128_data
), GFP_KERNEL
);
477 /* vref is optional. If specified, is used as chip reference voltage */
478 regulator
= devm_regulator_get_optional(dev
, "vref");
479 if (!IS_ERR(regulator
)) {
480 data
->regulator
= regulator
;
481 err
= regulator_enable(regulator
);
484 vref
= regulator_get_voltage(regulator
);
489 data
->vref
= DIV_ROUND_CLOSEST(vref
, 1000);
491 data
->vref
= 2560; /* 2.56V, in mV */
494 /* Operation mode is optional. If unspecified, keep current mode */
495 if (of_property_read_u8(dev
->of_node
, "ti,mode", &data
->mode
) == 0) {
496 if (data
->mode
> 3) {
497 dev_err(dev
, "invalid operation mode %d\n",
503 err
= i2c_smbus_read_byte_data(client
, ADC128_REG_CONFIG_ADV
);
506 data
->mode
= (err
>> 1) & ADC128_REG_MASK
;
509 data
->client
= client
;
510 i2c_set_clientdata(client
, data
);
511 mutex_init(&data
->update_lock
);
513 /* Initialize the chip */
514 err
= adc128_init_client(data
);
518 hwmon_dev
= devm_hwmon_device_register_with_groups(dev
, client
->name
,
519 data
, adc128_groups
);
520 if (IS_ERR(hwmon_dev
)) {
521 err
= PTR_ERR(hwmon_dev
);
529 regulator_disable(data
->regulator
);
533 static int adc128_remove(struct i2c_client
*client
)
535 struct adc128_data
*data
= i2c_get_clientdata(client
);
538 regulator_disable(data
->regulator
);
543 static const struct i2c_device_id adc128_id
[] = {
547 MODULE_DEVICE_TABLE(i2c
, adc128_id
);
549 static const struct of_device_id adc128_of_match
[] = {
550 { .compatible
= "ti,adc128d818" },
553 MODULE_DEVICE_TABLE(of
, adc128_of_match
);
555 static struct i2c_driver adc128_driver
= {
556 .class = I2C_CLASS_HWMON
,
558 .name
= "adc128d818",
559 .of_match_table
= of_match_ptr(adc128_of_match
),
561 .probe
= adc128_probe
,
562 .remove
= adc128_remove
,
563 .id_table
= adc128_id
,
564 .detect
= adc128_detect
,
565 .address_list
= normal_i2c
,
568 module_i2c_driver(adc128_driver
);
570 MODULE_AUTHOR("Guenter Roeck");
571 MODULE_DESCRIPTION("Driver for ADC128D818");
572 MODULE_LICENSE("GPL");