Linux Audio

Check our new training course

Loading...
  1/*
  2 * Driver for TI ADC128D818 System Monitor with Temperature Sensor
  3 *
  4 * Copyright (c) 2014 Guenter Roeck
  5 *
  6 * Derived from lm80.c
  7 * Copyright (C) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
  8 *			     and Philip Edelbrock <phil@netroedge.com>
  9 *
 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.
 14 *
 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.
 19 */
 20
 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>
 31#include <linux/of.h>
 32
 33/* Addresses to scan
 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
 36 * positives.
 37 */
 38static const unsigned short normal_i2c[] = {
 39	0x1d, 0x1e, 0x1f, 0x2d, 0x2e, 0x2f, I2C_CLIENT_END };
 40
 41/* registers */
 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))
 45
 46#define ADC128_REG_TEMP			0x27
 47#define ADC128_REG_TEMP_MAX		0x38
 48#define ADC128_REG_TEMP_HYST		0x39
 49
 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
 58
 59#define ADC128_REG_MAN_ID		0x3e
 60#define ADC128_REG_DEV_ID		0x3f
 61
 62/* No. of voltage entries in adc128_attrs */
 63#define ADC128_ATTR_NUM_VOLT		(8 * 4)
 64
 65/* Voltage inputs visible per operation mode */
 66static const u8 num_inputs[] = { 7, 8, 4, 6 };
 67
 68struct adc128_data {
 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 */
 76
 77	u16 in[3][8];		/* Register value, normalized to 12 bit
 78				 * 0: input voltage
 79				 * 1: min limit
 80				 * 2: max limit
 81				 */
 82	s16 temp[3];		/* Register value, normalized to 9 bit
 83				 * 0: sensor 1: limit 2: hyst
 84				 */
 85	u8 alarms;		/* alarm register value */
 86};
 87
 88static struct adc128_data *adc128_update_device(struct device *dev)
 89{
 90	struct adc128_data *data = dev_get_drvdata(dev);
 91	struct i2c_client *client = data->client;
 92	struct adc128_data *ret = data;
 93	int i, rv;
 94
 95	mutex_lock(&data->update_lock);
 96
 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,
100							 ADC128_REG_IN(i));
101			if (rv < 0)
102				goto abort;
103			data->in[0][i] = rv >> 4;
104
105			rv = i2c_smbus_read_byte_data(client,
106						      ADC128_REG_IN_MIN(i));
107			if (rv < 0)
108				goto abort;
109			data->in[1][i] = rv << 4;
110
111			rv = i2c_smbus_read_byte_data(client,
112						      ADC128_REG_IN_MAX(i));
113			if (rv < 0)
114				goto abort;
115			data->in[2][i] = rv << 4;
116		}
117
118		if (data->mode != 1) {
119			rv = i2c_smbus_read_word_swapped(client,
120							 ADC128_REG_TEMP);
121			if (rv < 0)
122				goto abort;
123			data->temp[0] = rv >> 7;
124
125			rv = i2c_smbus_read_byte_data(client,
126						      ADC128_REG_TEMP_MAX);
127			if (rv < 0)
128				goto abort;
129			data->temp[1] = rv << 1;
130
131			rv = i2c_smbus_read_byte_data(client,
132						      ADC128_REG_TEMP_HYST);
133			if (rv < 0)
134				goto abort;
135			data->temp[2] = rv << 1;
136		}
137
138		rv = i2c_smbus_read_byte_data(client, ADC128_REG_ALARM);
139		if (rv < 0)
140			goto abort;
141		data->alarms |= rv;
142
143		data->last_updated = jiffies;
144		data->valid = true;
145	}
146	goto done;
147
148abort:
149	ret = ERR_PTR(rv);
150	data->valid = false;
151done:
152	mutex_unlock(&data->update_lock);
153	return ret;
154}
155
156static ssize_t adc128_show_in(struct device *dev, struct device_attribute *attr,
157			      char *buf)
158{
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;
162	int val;
163
164	if (IS_ERR(data))
165		return PTR_ERR(data);
166
167	val = DIV_ROUND_CLOSEST(data->in[index][nr] * data->vref, 4095);
168	return sprintf(buf, "%d\n", val);
169}
170
171static ssize_t adc128_set_in(struct device *dev, struct device_attribute *attr,
172			     const char *buf, size_t count)
173{
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;
177	u8 reg, regval;
178	long val;
179	int err;
180
181	err = kstrtol(buf, 10, &val);
182	if (err < 0)
183		return err;
184
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);
192
193	return count;
194}
195
196static ssize_t adc128_show_temp(struct device *dev,
197				struct device_attribute *attr, char *buf)
198{
199	struct adc128_data *data = adc128_update_device(dev);
200	int index = to_sensor_dev_attr(attr)->index;
201	int temp;
202
203	if (IS_ERR(data))
204		return PTR_ERR(data);
205
206	temp = sign_extend32(data->temp[index], 8);
207	return sprintf(buf, "%d\n", temp * 500);/* 0.5 degrees C resolution */
208}
209
210static ssize_t adc128_set_temp(struct device *dev,
211			       struct device_attribute *attr,
212			       const char *buf, size_t count)
213{
214	struct adc128_data *data = dev_get_drvdata(dev);
215	int index = to_sensor_dev_attr(attr)->index;
216	long val;
217	int err;
218	s8 regval;
219
220	err = kstrtol(buf, 10, &val);
221	if (err < 0)
222		return err;
223
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,
230				  regval);
231	mutex_unlock(&data->update_lock);
232
233	return count;
234}
235
236static ssize_t adc128_show_alarm(struct device *dev,
237				 struct device_attribute *attr, char *buf)
238{
239	struct adc128_data *data = adc128_update_device(dev);
240	int mask = 1 << to_sensor_dev_attr(attr)->index;
241	u8 alarms;
242
243	if (IS_ERR(data))
244		return PTR_ERR(data);
245
246	/*
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.
249	 */
250	alarms = data->alarms;
251	data->alarms &= ~mask;
252
253	return sprintf(buf, "%u\n", !!(alarms & mask));
254}
255
256static umode_t adc128_is_visible(struct kobject *kobj,
257				 struct attribute *attr, int index)
258{
259	struct device *dev = container_of(kobj, struct device, kobj);
260	struct adc128_data *data = dev_get_drvdata(dev);
261
262	if (index < ADC128_ATTR_NUM_VOLT) {
263		/* Voltage, visible according to num_inputs[] */
264		if (index >= num_inputs[data->mode] * 4)
265			return 0;
266	} else {
267		/* Temperature, visible if not in mode 1 */
268		if (data->mode == 1)
269			return 0;
270	}
271
272	return attr->mode;
273}
274
275static SENSOR_DEVICE_ATTR_2(in0_input, S_IRUGO,
276			    adc128_show_in, NULL, 0, 0);
277static SENSOR_DEVICE_ATTR_2(in0_min, S_IWUSR | S_IRUGO,
278			    adc128_show_in, adc128_set_in, 0, 1);
279static SENSOR_DEVICE_ATTR_2(in0_max, S_IWUSR | S_IRUGO,
280			    adc128_show_in, adc128_set_in, 0, 2);
281
282static SENSOR_DEVICE_ATTR_2(in1_input, S_IRUGO,
283			    adc128_show_in, NULL, 1, 0);
284static SENSOR_DEVICE_ATTR_2(in1_min, S_IWUSR | S_IRUGO,
285			    adc128_show_in, adc128_set_in, 1, 1);
286static SENSOR_DEVICE_ATTR_2(in1_max, S_IWUSR | S_IRUGO,
287			    adc128_show_in, adc128_set_in, 1, 2);
288
289static SENSOR_DEVICE_ATTR_2(in2_input, S_IRUGO,
290			    adc128_show_in, NULL, 2, 0);
291static SENSOR_DEVICE_ATTR_2(in2_min, S_IWUSR | S_IRUGO,
292			    adc128_show_in, adc128_set_in, 2, 1);
293static SENSOR_DEVICE_ATTR_2(in2_max, S_IWUSR | S_IRUGO,
294			    adc128_show_in, adc128_set_in, 2, 2);
295
296static SENSOR_DEVICE_ATTR_2(in3_input, S_IRUGO,
297			    adc128_show_in, NULL, 3, 0);
298static SENSOR_DEVICE_ATTR_2(in3_min, S_IWUSR | S_IRUGO,
299			    adc128_show_in, adc128_set_in, 3, 1);
300static SENSOR_DEVICE_ATTR_2(in3_max, S_IWUSR | S_IRUGO,
301			    adc128_show_in, adc128_set_in, 3, 2);
302
303static SENSOR_DEVICE_ATTR_2(in4_input, S_IRUGO,
304			    adc128_show_in, NULL, 4, 0);
305static SENSOR_DEVICE_ATTR_2(in4_min, S_IWUSR | S_IRUGO,
306			    adc128_show_in, adc128_set_in, 4, 1);
307static SENSOR_DEVICE_ATTR_2(in4_max, S_IWUSR | S_IRUGO,
308			    adc128_show_in, adc128_set_in, 4, 2);
309
310static SENSOR_DEVICE_ATTR_2(in5_input, S_IRUGO,
311			    adc128_show_in, NULL, 5, 0);
312static SENSOR_DEVICE_ATTR_2(in5_min, S_IWUSR | S_IRUGO,
313			    adc128_show_in, adc128_set_in, 5, 1);
314static SENSOR_DEVICE_ATTR_2(in5_max, S_IWUSR | S_IRUGO,
315			    adc128_show_in, adc128_set_in, 5, 2);
316
317static SENSOR_DEVICE_ATTR_2(in6_input, S_IRUGO,
318			    adc128_show_in, NULL, 6, 0);
319static SENSOR_DEVICE_ATTR_2(in6_min, S_IWUSR | S_IRUGO,
320			    adc128_show_in, adc128_set_in, 6, 1);
321static SENSOR_DEVICE_ATTR_2(in6_max, S_IWUSR | S_IRUGO,
322			    adc128_show_in, adc128_set_in, 6, 2);
323
324static SENSOR_DEVICE_ATTR_2(in7_input, S_IRUGO,
325			    adc128_show_in, NULL, 7, 0);
326static SENSOR_DEVICE_ATTR_2(in7_min, S_IWUSR | S_IRUGO,
327			    adc128_show_in, adc128_set_in, 7, 1);
328static SENSOR_DEVICE_ATTR_2(in7_max, S_IWUSR | S_IRUGO,
329			    adc128_show_in, adc128_set_in, 7, 2);
330
331static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, adc128_show_temp, NULL, 0);
332static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
333			  adc128_show_temp, adc128_set_temp, 1);
334static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IWUSR | S_IRUGO,
335			  adc128_show_temp, adc128_set_temp, 2);
336
337static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, adc128_show_alarm, NULL, 0);
338static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, adc128_show_alarm, NULL, 1);
339static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, adc128_show_alarm, NULL, 2);
340static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, adc128_show_alarm, NULL, 3);
341static SENSOR_DEVICE_ATTR(in4_alarm, S_IRUGO, adc128_show_alarm, NULL, 4);
342static SENSOR_DEVICE_ATTR(in5_alarm, S_IRUGO, adc128_show_alarm, NULL, 5);
343static SENSOR_DEVICE_ATTR(in6_alarm, S_IRUGO, adc128_show_alarm, NULL, 6);
344static SENSOR_DEVICE_ATTR(in7_alarm, S_IRUGO, adc128_show_alarm, NULL, 7);
345static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, adc128_show_alarm, NULL, 7);
346
347static 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,
384	NULL
385};
386
387static const struct attribute_group adc128_group = {
388	.attrs = adc128_attrs,
389	.is_visible = adc128_is_visible,
390};
391__ATTRIBUTE_GROUPS(adc128);
392
393static int adc128_detect(struct i2c_client *client, struct i2c_board_info *info)
394{
395	int man_id, dev_id;
396
397	if (!i2c_check_functionality(client->adapter,
398				     I2C_FUNC_SMBUS_BYTE_DATA |
399				     I2C_FUNC_SMBUS_WORD_DATA))
400		return -ENODEV;
401
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)
405		return -ENODEV;
406
407	/* Check unused bits for confirmation */
408	if (i2c_smbus_read_byte_data(client, ADC128_REG_CONFIG) & 0xf4)
409		return -ENODEV;
410	if (i2c_smbus_read_byte_data(client, ADC128_REG_CONV_RATE) & 0xfe)
411		return -ENODEV;
412	if (i2c_smbus_read_byte_data(client, ADC128_REG_ONESHOT) & 0xfe)
413		return -ENODEV;
414	if (i2c_smbus_read_byte_data(client, ADC128_REG_SHUTDOWN) & 0xfe)
415		return -ENODEV;
416	if (i2c_smbus_read_byte_data(client, ADC128_REG_CONFIG_ADV) & 0xf8)
417		return -ENODEV;
418	if (i2c_smbus_read_byte_data(client, ADC128_REG_BUSY_STATUS) & 0xfc)
419		return -ENODEV;
420
421	strlcpy(info->type, "adc128d818", I2C_NAME_SIZE);
422
423	return 0;
424}
425
426static int adc128_init_client(struct adc128_data *data)
427{
428	struct i2c_client *client = data->client;
429	int err;
430
431	/*
432	 * Reset chip to defaults.
433	 * This makes most other initializations unnecessary.
434	 */
435	err = i2c_smbus_write_byte_data(client, ADC128_REG_CONFIG, 0x80);
436	if (err)
437		return err;
438
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,
443						data->mode << 1);
444		if (err)
445			return err;
446	}
447
448	/* Start monitoring */
449	err = i2c_smbus_write_byte_data(client, ADC128_REG_CONFIG, 0x01);
450	if (err)
451		return err;
452
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);
457		if (err)
458			return err;
459	}
460
461	return 0;
462}
463
464static int adc128_probe(struct i2c_client *client,
465			const struct i2c_device_id *id)
466{
467	struct device *dev = &client->dev;
468	struct regulator *regulator;
469	struct device *hwmon_dev;
470	struct adc128_data *data;
471	int err, vref;
472
473	data = devm_kzalloc(dev, sizeof(struct adc128_data), GFP_KERNEL);
474	if (!data)
475		return -ENOMEM;
476
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);
482		if (err < 0)
483			return err;
484		vref = regulator_get_voltage(regulator);
485		if (vref < 0) {
486			err = vref;
487			goto error;
488		}
489		data->vref = DIV_ROUND_CLOSEST(vref, 1000);
490	} else {
491		data->vref = 2560;	/* 2.56V, in mV */
492	}
493
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",
498				data->mode);
499			err = -EINVAL;
500			goto error;
501		}
502	} else {
503		err = i2c_smbus_read_byte_data(client, ADC128_REG_CONFIG_ADV);
504		if (err < 0)
505			goto error;
506		data->mode = (err >> 1) & ADC128_REG_MASK;
507	}
508
509	data->client = client;
510	i2c_set_clientdata(client, data);
511	mutex_init(&data->update_lock);
512
513	/* Initialize the chip */
514	err = adc128_init_client(data);
515	if (err < 0)
516		goto error;
517
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);
522		goto error;
523	}
524
525	return 0;
526
527error:
528	if (data->regulator)
529		regulator_disable(data->regulator);
530	return err;
531}
532
533static int adc128_remove(struct i2c_client *client)
534{
535	struct adc128_data *data = i2c_get_clientdata(client);
536
537	if (data->regulator)
538		regulator_disable(data->regulator);
539
540	return 0;
541}
542
543static const struct i2c_device_id adc128_id[] = {
544	{ "adc128d818", 0 },
545	{ }
546};
547MODULE_DEVICE_TABLE(i2c, adc128_id);
548
549static const struct of_device_id adc128_of_match[] = {
550	{ .compatible = "ti,adc128d818" },
551	{ },
552};
553MODULE_DEVICE_TABLE(of, adc128_of_match);
554
555static struct i2c_driver adc128_driver = {
556	.class		= I2C_CLASS_HWMON,
557	.driver = {
558		.name	= "adc128d818",
559		.of_match_table = of_match_ptr(adc128_of_match),
560	},
561	.probe		= adc128_probe,
562	.remove		= adc128_remove,
563	.id_table	= adc128_id,
564	.detect		= adc128_detect,
565	.address_list	= normal_i2c,
566};
567
568module_i2c_driver(adc128_driver);
569
570MODULE_AUTHOR("Guenter Roeck");
571MODULE_DESCRIPTION("Driver for ADC128D818");
572MODULE_LICENSE("GPL");
  1// SPDX-License-Identifier: GPL-2.0-or-later
  2/*
  3 * Driver for TI ADC128D818 System Monitor with Temperature Sensor
  4 *
  5 * Copyright (c) 2014 Guenter Roeck
  6 *
  7 * Derived from lm80.c
  8 * Copyright (C) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
  9 *			     and Philip Edelbrock <phil@netroedge.com>
 10 */
 11
 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>
 22#include <linux/of.h>
 23
 24/* Addresses to scan
 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
 27 * positives.
 28 */
 29static const unsigned short normal_i2c[] = {
 30	0x1d, 0x1e, 0x1f, 0x2d, 0x2e, 0x2f, I2C_CLIENT_END };
 31
 32/* registers */
 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))
 36
 37#define ADC128_REG_TEMP			0x27
 38#define ADC128_REG_TEMP_MAX		0x38
 39#define ADC128_REG_TEMP_HYST		0x39
 40
 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
 49
 50#define ADC128_REG_MAN_ID		0x3e
 51#define ADC128_REG_DEV_ID		0x3f
 52
 53/* No. of voltage entries in adc128_attrs */
 54#define ADC128_ATTR_NUM_VOLT		(8 * 4)
 55
 56/* Voltage inputs visible per operation mode */
 57static const u8 num_inputs[] = { 7, 8, 4, 6 };
 58
 59struct adc128_data {
 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 */
 67
 68	u16 in[3][8];		/* Register value, normalized to 12 bit
 69				 * 0: input voltage
 70				 * 1: min limit
 71				 * 2: max limit
 72				 */
 73	s16 temp[3];		/* Register value, normalized to 9 bit
 74				 * 0: sensor 1: limit 2: hyst
 75				 */
 76	u8 alarms;		/* alarm register value */
 77};
 78
 79static struct adc128_data *adc128_update_device(struct device *dev)
 80{
 81	struct adc128_data *data = dev_get_drvdata(dev);
 82	struct i2c_client *client = data->client;
 83	struct adc128_data *ret = data;
 84	int i, rv;
 85
 86	mutex_lock(&data->update_lock);
 87
 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,
 91							 ADC128_REG_IN(i));
 92			if (rv < 0)
 93				goto abort;
 94			data->in[0][i] = rv >> 4;
 95
 96			rv = i2c_smbus_read_byte_data(client,
 97						      ADC128_REG_IN_MIN(i));
 98			if (rv < 0)
 99				goto abort;
100			data->in[1][i] = rv << 4;
101
102			rv = i2c_smbus_read_byte_data(client,
103						      ADC128_REG_IN_MAX(i));
104			if (rv < 0)
105				goto abort;
106			data->in[2][i] = rv << 4;
107		}
108
109		if (data->mode != 1) {
110			rv = i2c_smbus_read_word_swapped(client,
111							 ADC128_REG_TEMP);
112			if (rv < 0)
113				goto abort;
114			data->temp[0] = rv >> 7;
115
116			rv = i2c_smbus_read_byte_data(client,
117						      ADC128_REG_TEMP_MAX);
118			if (rv < 0)
119				goto abort;
120			data->temp[1] = rv << 1;
121
122			rv = i2c_smbus_read_byte_data(client,
123						      ADC128_REG_TEMP_HYST);
124			if (rv < 0)
125				goto abort;
126			data->temp[2] = rv << 1;
127		}
128
129		rv = i2c_smbus_read_byte_data(client, ADC128_REG_ALARM);
130		if (rv < 0)
131			goto abort;
132		data->alarms |= rv;
133
134		data->last_updated = jiffies;
135		data->valid = true;
136	}
137	goto done;
138
139abort:
140	ret = ERR_PTR(rv);
141	data->valid = false;
142done:
143	mutex_unlock(&data->update_lock);
144	return ret;
145}
146
147static ssize_t adc128_in_show(struct device *dev,
148			      struct device_attribute *attr, char *buf)
149{
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;
153	int val;
154
155	if (IS_ERR(data))
156		return PTR_ERR(data);
157
158	val = DIV_ROUND_CLOSEST(data->in[index][nr] * data->vref, 4095);
159	return sprintf(buf, "%d\n", val);
160}
161
162static ssize_t adc128_in_store(struct device *dev,
163			       struct device_attribute *attr, const char *buf,
164			       size_t count)
165{
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;
169	u8 reg, regval;
170	long val;
171	int err;
172
173	err = kstrtol(buf, 10, &val);
174	if (err < 0)
175		return err;
176
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);
184
185	return count;
186}
187
188static ssize_t adc128_temp_show(struct device *dev,
189				struct device_attribute *attr, char *buf)
190{
191	struct adc128_data *data = adc128_update_device(dev);
192	int index = to_sensor_dev_attr(attr)->index;
193	int temp;
194
195	if (IS_ERR(data))
196		return PTR_ERR(data);
197
198	temp = sign_extend32(data->temp[index], 8);
199	return sprintf(buf, "%d\n", temp * 500);/* 0.5 degrees C resolution */
200}
201
202static ssize_t adc128_temp_store(struct device *dev,
203				 struct device_attribute *attr,
204				 const char *buf, size_t count)
205{
206	struct adc128_data *data = dev_get_drvdata(dev);
207	int index = to_sensor_dev_attr(attr)->index;
208	long val;
209	int err;
210	s8 regval;
211
212	err = kstrtol(buf, 10, &val);
213	if (err < 0)
214		return err;
215
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,
222				  regval);
223	mutex_unlock(&data->update_lock);
224
225	return count;
226}
227
228static ssize_t adc128_alarm_show(struct device *dev,
229				 struct device_attribute *attr, char *buf)
230{
231	struct adc128_data *data = adc128_update_device(dev);
232	int mask = 1 << to_sensor_dev_attr(attr)->index;
233	u8 alarms;
234
235	if (IS_ERR(data))
236		return PTR_ERR(data);
237
238	/*
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.
241	 */
242	alarms = data->alarms;
243	data->alarms &= ~mask;
244
245	return sprintf(buf, "%u\n", !!(alarms & mask));
246}
247
248static umode_t adc128_is_visible(struct kobject *kobj,
249				 struct attribute *attr, int index)
250{
251	struct device *dev = container_of(kobj, struct device, kobj);
252	struct adc128_data *data = dev_get_drvdata(dev);
253
254	if (index < ADC128_ATTR_NUM_VOLT) {
255		/* Voltage, visible according to num_inputs[] */
256		if (index >= num_inputs[data->mode] * 4)
257			return 0;
258	} else {
259		/* Temperature, visible if not in mode 1 */
260		if (data->mode == 1)
261			return 0;
262	}
263
264	return attr->mode;
265}
266
267static SENSOR_DEVICE_ATTR_2_RO(in0_input, adc128_in, 0, 0);
268static SENSOR_DEVICE_ATTR_2_RW(in0_min, adc128_in, 0, 1);
269static SENSOR_DEVICE_ATTR_2_RW(in0_max, adc128_in, 0, 2);
270
271static SENSOR_DEVICE_ATTR_2_RO(in1_input, adc128_in, 1, 0);
272static SENSOR_DEVICE_ATTR_2_RW(in1_min, adc128_in, 1, 1);
273static SENSOR_DEVICE_ATTR_2_RW(in1_max, adc128_in, 1, 2);
274
275static SENSOR_DEVICE_ATTR_2_RO(in2_input, adc128_in, 2, 0);
276static SENSOR_DEVICE_ATTR_2_RW(in2_min, adc128_in, 2, 1);
277static SENSOR_DEVICE_ATTR_2_RW(in2_max, adc128_in, 2, 2);
278
279static SENSOR_DEVICE_ATTR_2_RO(in3_input, adc128_in, 3, 0);
280static SENSOR_DEVICE_ATTR_2_RW(in3_min, adc128_in, 3, 1);
281static SENSOR_DEVICE_ATTR_2_RW(in3_max, adc128_in, 3, 2);
282
283static SENSOR_DEVICE_ATTR_2_RO(in4_input, adc128_in, 4, 0);
284static SENSOR_DEVICE_ATTR_2_RW(in4_min, adc128_in, 4, 1);
285static SENSOR_DEVICE_ATTR_2_RW(in4_max, adc128_in, 4, 2);
286
287static SENSOR_DEVICE_ATTR_2_RO(in5_input, adc128_in, 5, 0);
288static SENSOR_DEVICE_ATTR_2_RW(in5_min, adc128_in, 5, 1);
289static SENSOR_DEVICE_ATTR_2_RW(in5_max, adc128_in, 5, 2);
290
291static SENSOR_DEVICE_ATTR_2_RO(in6_input, adc128_in, 6, 0);
292static SENSOR_DEVICE_ATTR_2_RW(in6_min, adc128_in, 6, 1);
293static SENSOR_DEVICE_ATTR_2_RW(in6_max, adc128_in, 6, 2);
294
295static SENSOR_DEVICE_ATTR_2_RO(in7_input, adc128_in, 7, 0);
296static SENSOR_DEVICE_ATTR_2_RW(in7_min, adc128_in, 7, 1);
297static SENSOR_DEVICE_ATTR_2_RW(in7_max, adc128_in, 7, 2);
298
299static SENSOR_DEVICE_ATTR_RO(temp1_input, adc128_temp, 0);
300static SENSOR_DEVICE_ATTR_RW(temp1_max, adc128_temp, 1);
301static SENSOR_DEVICE_ATTR_RW(temp1_max_hyst, adc128_temp, 2);
302
303static SENSOR_DEVICE_ATTR_RO(in0_alarm, adc128_alarm, 0);
304static SENSOR_DEVICE_ATTR_RO(in1_alarm, adc128_alarm, 1);
305static SENSOR_DEVICE_ATTR_RO(in2_alarm, adc128_alarm, 2);
306static SENSOR_DEVICE_ATTR_RO(in3_alarm, adc128_alarm, 3);
307static SENSOR_DEVICE_ATTR_RO(in4_alarm, adc128_alarm, 4);
308static SENSOR_DEVICE_ATTR_RO(in5_alarm, adc128_alarm, 5);
309static SENSOR_DEVICE_ATTR_RO(in6_alarm, adc128_alarm, 6);
310static SENSOR_DEVICE_ATTR_RO(in7_alarm, adc128_alarm, 7);
311static SENSOR_DEVICE_ATTR_RO(temp1_max_alarm, adc128_alarm, 7);
312
313static 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,
350	NULL
351};
352
353static const struct attribute_group adc128_group = {
354	.attrs = adc128_attrs,
355	.is_visible = adc128_is_visible,
356};
357__ATTRIBUTE_GROUPS(adc128);
358
359static int adc128_detect(struct i2c_client *client, struct i2c_board_info *info)
360{
361	int man_id, dev_id;
362
363	if (!i2c_check_functionality(client->adapter,
364				     I2C_FUNC_SMBUS_BYTE_DATA |
365				     I2C_FUNC_SMBUS_WORD_DATA))
366		return -ENODEV;
367
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)
371		return -ENODEV;
372
373	/* Check unused bits for confirmation */
374	if (i2c_smbus_read_byte_data(client, ADC128_REG_CONFIG) & 0xf4)
375		return -ENODEV;
376	if (i2c_smbus_read_byte_data(client, ADC128_REG_CONV_RATE) & 0xfe)
377		return -ENODEV;
378	if (i2c_smbus_read_byte_data(client, ADC128_REG_ONESHOT) & 0xfe)
379		return -ENODEV;
380	if (i2c_smbus_read_byte_data(client, ADC128_REG_SHUTDOWN) & 0xfe)
381		return -ENODEV;
382	if (i2c_smbus_read_byte_data(client, ADC128_REG_CONFIG_ADV) & 0xf8)
383		return -ENODEV;
384	if (i2c_smbus_read_byte_data(client, ADC128_REG_BUSY_STATUS) & 0xfc)
385		return -ENODEV;
386
387	strlcpy(info->type, "adc128d818", I2C_NAME_SIZE);
388
389	return 0;
390}
391
392static int adc128_init_client(struct adc128_data *data)
393{
394	struct i2c_client *client = data->client;
395	int err;
396
397	/*
398	 * Reset chip to defaults.
399	 * This makes most other initializations unnecessary.
400	 */
401	err = i2c_smbus_write_byte_data(client, ADC128_REG_CONFIG, 0x80);
402	if (err)
403		return err;
404
405	/* Set operation mode, if non-default */
406	if (data->mode != 0) {
407		err = i2c_smbus_write_byte_data(client,
408						ADC128_REG_CONFIG_ADV,
409						data->mode << 1);
410		if (err)
411			return err;
412	}
413
414	/* Start monitoring */
415	err = i2c_smbus_write_byte_data(client, ADC128_REG_CONFIG, 0x01);
416	if (err)
417		return err;
418
419	/* If external vref is selected, configure the chip to use it */
420	if (data->regulator) {
421		err = i2c_smbus_write_byte_data(client,
422						ADC128_REG_CONFIG_ADV, 0x01);
423		if (err)
424			return err;
425	}
426
427	return 0;
428}
429
430static int adc128_probe(struct i2c_client *client,
431			const struct i2c_device_id *id)
432{
433	struct device *dev = &client->dev;
434	struct regulator *regulator;
435	struct device *hwmon_dev;
436	struct adc128_data *data;
437	int err, vref;
438
439	data = devm_kzalloc(dev, sizeof(struct adc128_data), GFP_KERNEL);
440	if (!data)
441		return -ENOMEM;
442
443	/* vref is optional. If specified, is used as chip reference voltage */
444	regulator = devm_regulator_get_optional(dev, "vref");
445	if (!IS_ERR(regulator)) {
446		data->regulator = regulator;
447		err = regulator_enable(regulator);
448		if (err < 0)
449			return err;
450		vref = regulator_get_voltage(regulator);
451		if (vref < 0) {
452			err = vref;
453			goto error;
454		}
455		data->vref = DIV_ROUND_CLOSEST(vref, 1000);
456	} else {
457		data->vref = 2560;	/* 2.56V, in mV */
458	}
459
460	/* Operation mode is optional. If unspecified, keep current mode */
461	if (of_property_read_u8(dev->of_node, "ti,mode", &data->mode) == 0) {
462		if (data->mode > 3) {
463			dev_err(dev, "invalid operation mode %d\n",
464				data->mode);
465			err = -EINVAL;
466			goto error;
467		}
468	} else {
469		err = i2c_smbus_read_byte_data(client, ADC128_REG_CONFIG_ADV);
470		if (err < 0)
471			goto error;
472		data->mode = (err >> 1) & ADC128_REG_MASK;
473	}
474
475	data->client = client;
476	i2c_set_clientdata(client, data);
477	mutex_init(&data->update_lock);
478
479	/* Initialize the chip */
480	err = adc128_init_client(data);
481	if (err < 0)
482		goto error;
483
484	hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
485							   data, adc128_groups);
486	if (IS_ERR(hwmon_dev)) {
487		err = PTR_ERR(hwmon_dev);
488		goto error;
489	}
490
491	return 0;
492
493error:
494	if (data->regulator)
495		regulator_disable(data->regulator);
496	return err;
497}
498
499static int adc128_remove(struct i2c_client *client)
500{
501	struct adc128_data *data = i2c_get_clientdata(client);
502
503	if (data->regulator)
504		regulator_disable(data->regulator);
505
506	return 0;
507}
508
509static const struct i2c_device_id adc128_id[] = {
510	{ "adc128d818", 0 },
511	{ }
512};
513MODULE_DEVICE_TABLE(i2c, adc128_id);
514
515static const struct of_device_id __maybe_unused adc128_of_match[] = {
516	{ .compatible = "ti,adc128d818" },
517	{ },
518};
519MODULE_DEVICE_TABLE(of, adc128_of_match);
520
521static struct i2c_driver adc128_driver = {
522	.class		= I2C_CLASS_HWMON,
523	.driver = {
524		.name	= "adc128d818",
525		.of_match_table = of_match_ptr(adc128_of_match),
526	},
527	.probe		= adc128_probe,
528	.remove		= adc128_remove,
529	.id_table	= adc128_id,
530	.detect		= adc128_detect,
531	.address_list	= normal_i2c,
532};
533
534module_i2c_driver(adc128_driver);
535
536MODULE_AUTHOR("Guenter Roeck");
537MODULE_DESCRIPTION("Driver for ADC128D818");
538MODULE_LICENSE("GPL");