xref: /openbmc/linux/drivers/iio/adc/ti-adc081c.c (revision 2634682fdffd9ba6e74b76be8aa91cf8b2e05c41)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * TI ADC081C/ADC101C/ADC121C 8/10/12-bit ADC driver
4  *
5  * Copyright (C) 2012 Avionic Design GmbH
6  * Copyright (C) 2016 Intel
7  *
8  * Datasheets:
9  *	https://www.ti.com/lit/ds/symlink/adc081c021.pdf
10  *	https://www.ti.com/lit/ds/symlink/adc101c021.pdf
11  *	https://www.ti.com/lit/ds/symlink/adc121c021.pdf
12  *
13  * The devices have a very similar interface and differ mostly in the number of
14  * bits handled. For the 8-bit and 10-bit models the least-significant 4 or 2
15  * bits of value registers are reserved.
16  */
17 
18 #include <linux/err.h>
19 #include <linux/i2c.h>
20 #include <linux/module.h>
21 #include <linux/mod_devicetable.h>
22 #include <linux/acpi.h>
23 
24 #include <linux/iio/iio.h>
25 #include <linux/iio/buffer.h>
26 #include <linux/iio/trigger_consumer.h>
27 #include <linux/iio/triggered_buffer.h>
28 #include <linux/regulator/consumer.h>
29 
30 struct adc081c {
31 	struct i2c_client *i2c;
32 	struct regulator *ref;
33 
34 	/* 8, 10 or 12 */
35 	int bits;
36 
37 	/* Ensure natural alignment of buffer elements */
38 	struct {
39 		u16 channel;
40 		s64 ts __aligned(8);
41 	} scan;
42 };
43 
44 #define REG_CONV_RES 0x00
45 
46 static int adc081c_read_raw(struct iio_dev *iio,
47 			    struct iio_chan_spec const *channel, int *value,
48 			    int *shift, long mask)
49 {
50 	struct adc081c *adc = iio_priv(iio);
51 	int err;
52 
53 	switch (mask) {
54 	case IIO_CHAN_INFO_RAW:
55 		err = i2c_smbus_read_word_swapped(adc->i2c, REG_CONV_RES);
56 		if (err < 0)
57 			return err;
58 
59 		*value = (err & 0xFFF) >> (12 - adc->bits);
60 		return IIO_VAL_INT;
61 
62 	case IIO_CHAN_INFO_SCALE:
63 		err = regulator_get_voltage(adc->ref);
64 		if (err < 0)
65 			return err;
66 
67 		*value = err / 1000;
68 		*shift = adc->bits;
69 
70 		return IIO_VAL_FRACTIONAL_LOG2;
71 
72 	default:
73 		break;
74 	}
75 
76 	return -EINVAL;
77 }
78 
79 #define ADCxx1C_CHAN(_bits) {					\
80 	.type = IIO_VOLTAGE,					\
81 	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),	\
82 	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),		\
83 	.scan_type = {						\
84 		.sign = 'u',					\
85 		.realbits = (_bits),				\
86 		.storagebits = 16,				\
87 		.shift = 12 - (_bits),				\
88 		.endianness = IIO_CPU,				\
89 	},							\
90 }
91 
92 #define DEFINE_ADCxx1C_CHANNELS(_name, _bits)				\
93 	static const struct iio_chan_spec _name ## _channels[] = {	\
94 		ADCxx1C_CHAN((_bits)),					\
95 		IIO_CHAN_SOFT_TIMESTAMP(1),				\
96 	};								\
97 
98 #define ADC081C_NUM_CHANNELS 2
99 
100 struct adcxx1c_model {
101 	const struct iio_chan_spec* channels;
102 	int bits;
103 };
104 
105 #define ADCxx1C_MODEL(_name, _bits)					\
106 	{								\
107 		.channels = _name ## _channels,				\
108 		.bits = (_bits),					\
109 	}
110 
111 DEFINE_ADCxx1C_CHANNELS(adc081c,  8);
112 DEFINE_ADCxx1C_CHANNELS(adc101c, 10);
113 DEFINE_ADCxx1C_CHANNELS(adc121c, 12);
114 
115 /* Model ids are indexes in _models array */
116 enum adcxx1c_model_id {
117 	ADC081C = 0,
118 	ADC101C = 1,
119 	ADC121C = 2,
120 };
121 
122 static struct adcxx1c_model adcxx1c_models[] = {
123 	ADCxx1C_MODEL(adc081c,  8),
124 	ADCxx1C_MODEL(adc101c, 10),
125 	ADCxx1C_MODEL(adc121c, 12),
126 };
127 
128 static const struct iio_info adc081c_info = {
129 	.read_raw = adc081c_read_raw,
130 };
131 
132 static irqreturn_t adc081c_trigger_handler(int irq, void *p)
133 {
134 	struct iio_poll_func *pf = p;
135 	struct iio_dev *indio_dev = pf->indio_dev;
136 	struct adc081c *data = iio_priv(indio_dev);
137 	int ret;
138 
139 	ret = i2c_smbus_read_word_swapped(data->i2c, REG_CONV_RES);
140 	if (ret < 0)
141 		goto out;
142 	data->scan.channel = ret;
143 	iio_push_to_buffers_with_timestamp(indio_dev, &data->scan,
144 					   iio_get_time_ns(indio_dev));
145 out:
146 	iio_trigger_notify_done(indio_dev->trig);
147 	return IRQ_HANDLED;
148 }
149 
150 static int adc081c_probe(struct i2c_client *client,
151 			 const struct i2c_device_id *id)
152 {
153 	struct iio_dev *iio;
154 	struct adc081c *adc;
155 	struct adcxx1c_model *model;
156 	int err;
157 
158 	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WORD_DATA))
159 		return -EOPNOTSUPP;
160 
161 	if (ACPI_COMPANION(&client->dev)) {
162 		const struct acpi_device_id *ad_id;
163 
164 		ad_id = acpi_match_device(client->dev.driver->acpi_match_table,
165 					  &client->dev);
166 		if (!ad_id)
167 			return -ENODEV;
168 		model = &adcxx1c_models[ad_id->driver_data];
169 	} else {
170 		model = &adcxx1c_models[id->driver_data];
171 	}
172 
173 	iio = devm_iio_device_alloc(&client->dev, sizeof(*adc));
174 	if (!iio)
175 		return -ENOMEM;
176 
177 	adc = iio_priv(iio);
178 	adc->i2c = client;
179 	adc->bits = model->bits;
180 
181 	adc->ref = devm_regulator_get(&client->dev, "vref");
182 	if (IS_ERR(adc->ref))
183 		return PTR_ERR(adc->ref);
184 
185 	err = regulator_enable(adc->ref);
186 	if (err < 0)
187 		return err;
188 
189 	iio->name = dev_name(&client->dev);
190 	iio->modes = INDIO_DIRECT_MODE;
191 	iio->info = &adc081c_info;
192 
193 	iio->channels = model->channels;
194 	iio->num_channels = ADC081C_NUM_CHANNELS;
195 
196 	err = iio_triggered_buffer_setup(iio, NULL, adc081c_trigger_handler, NULL);
197 	if (err < 0) {
198 		dev_err(&client->dev, "iio triggered buffer setup failed\n");
199 		goto err_regulator_disable;
200 	}
201 
202 	err = iio_device_register(iio);
203 	if (err < 0)
204 		goto err_buffer_cleanup;
205 
206 	i2c_set_clientdata(client, iio);
207 
208 	return 0;
209 
210 err_buffer_cleanup:
211 	iio_triggered_buffer_cleanup(iio);
212 err_regulator_disable:
213 	regulator_disable(adc->ref);
214 
215 	return err;
216 }
217 
218 static int adc081c_remove(struct i2c_client *client)
219 {
220 	struct iio_dev *iio = i2c_get_clientdata(client);
221 	struct adc081c *adc = iio_priv(iio);
222 
223 	iio_device_unregister(iio);
224 	iio_triggered_buffer_cleanup(iio);
225 	regulator_disable(adc->ref);
226 
227 	return 0;
228 }
229 
230 static const struct i2c_device_id adc081c_id[] = {
231 	{ "adc081c", ADC081C },
232 	{ "adc101c", ADC101C },
233 	{ "adc121c", ADC121C },
234 	{ }
235 };
236 MODULE_DEVICE_TABLE(i2c, adc081c_id);
237 
238 static const struct of_device_id adc081c_of_match[] = {
239 	{ .compatible = "ti,adc081c" },
240 	{ .compatible = "ti,adc101c" },
241 	{ .compatible = "ti,adc121c" },
242 	{ }
243 };
244 MODULE_DEVICE_TABLE(of, adc081c_of_match);
245 
246 #ifdef CONFIG_ACPI
247 static const struct acpi_device_id adc081c_acpi_match[] = {
248 	{ "ADC081C", ADC081C },
249 	{ "ADC101C", ADC101C },
250 	{ "ADC121C", ADC121C },
251 	{ }
252 };
253 MODULE_DEVICE_TABLE(acpi, adc081c_acpi_match);
254 #endif
255 
256 static struct i2c_driver adc081c_driver = {
257 	.driver = {
258 		.name = "adc081c",
259 		.of_match_table = adc081c_of_match,
260 		.acpi_match_table = ACPI_PTR(adc081c_acpi_match),
261 	},
262 	.probe = adc081c_probe,
263 	.remove = adc081c_remove,
264 	.id_table = adc081c_id,
265 };
266 module_i2c_driver(adc081c_driver);
267 
268 MODULE_AUTHOR("Thierry Reding <thierry.reding@avionic-design.de>");
269 MODULE_DESCRIPTION("Texas Instruments ADC081C/ADC101C/ADC121C driver");
270 MODULE_LICENSE("GPL v2");
271