2 * ltc2497.c - Driver for Analog Devices/Linear Technology LTC2497 ADC
4 * Copyright (C) 2017 Analog Devices Inc.
6 * Licensed under the GPL-2.
8 * Datasheet: http://cds.linear.com/docs/en/datasheet/2497fd.pdf
11 #include <linux/delay.h>
12 #include <linux/i2c.h>
13 #include <linux/iio/iio.h>
14 #include <linux/iio/sysfs.h>
15 #include <linux/module.h>
17 #include <linux/regulator/consumer.h>
19 #define LTC2497_ENABLE 0xA0
20 #define LTC2497_SGL BIT(4)
21 #define LTC2497_DIFF 0
22 #define LTC2497_SIGN BIT(3)
23 #define LTC2497_CONFIG_DEFAULT LTC2497_ENABLE
24 #define LTC2497_CONVERSION_TIME_MS 150ULL
27 struct i2c_client *client;
28 struct regulator *ref;
32 * DMA (thus cache coherency maintenance) requires the
33 * transfer buffers to live in their own cache lines.
35 __be32 buf ____cacheline_aligned;
38 static int ltc2497_wait_conv(struct ltc2497_st *st)
42 time_elapsed = ktime_ms_delta(ktime_get(), st->time_prev);
44 if (time_elapsed < LTC2497_CONVERSION_TIME_MS) {
45 /* delay if conversion time not passed
46 * since last read or write
48 if (msleep_interruptible(
49 LTC2497_CONVERSION_TIME_MS - time_elapsed))
55 if (time_elapsed - LTC2497_CONVERSION_TIME_MS <= 0) {
56 /* We're in automatic mode -
57 * so the last reading is stil not outdated
65 static int ltc2497_read(struct ltc2497_st *st, u8 address, int *val)
67 struct i2c_client *client = st->client;
70 ret = ltc2497_wait_conv(st);
74 if (ret || st->addr_prev != address) {
75 ret = i2c_smbus_write_byte(st->client,
76 LTC2497_ENABLE | address);
79 st->addr_prev = address;
80 if (msleep_interruptible(LTC2497_CONVERSION_TIME_MS))
83 ret = i2c_master_recv(client, (char *)&st->buf, 3);
85 dev_err(&client->dev, "i2c_master_recv failed\n");
88 st->time_prev = ktime_get();
90 /* convert and shift the result,
91 * and finally convert from offset binary to signed integer
93 *val = (be32_to_cpu(st->buf) >> 14) - (1 << 17);
98 static int ltc2497_read_raw(struct iio_dev *indio_dev,
99 struct iio_chan_spec const *chan,
100 int *val, int *val2, long mask)
102 struct ltc2497_st *st = iio_priv(indio_dev);
106 case IIO_CHAN_INFO_RAW:
107 mutex_lock(&indio_dev->mlock);
108 ret = ltc2497_read(st, chan->address, val);
109 mutex_unlock(&indio_dev->mlock);
115 case IIO_CHAN_INFO_SCALE:
116 ret = regulator_get_voltage(st->ref);
123 return IIO_VAL_FRACTIONAL_LOG2;
130 #define LTC2497_CHAN(_chan, _addr) { \
131 .type = IIO_VOLTAGE, \
133 .channel = (_chan), \
134 .address = (_addr | (_chan / 2) | ((_chan & 1) ? LTC2497_SIGN : 0)), \
135 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
136 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
139 #define LTC2497_CHAN_DIFF(_chan, _addr) { \
140 .type = IIO_VOLTAGE, \
142 .channel = (_chan) * 2 + ((_addr) & LTC2497_SIGN ? 1 : 0), \
143 .channel2 = (_chan) * 2 + ((_addr) & LTC2497_SIGN ? 0 : 1),\
144 .address = (_addr | _chan), \
145 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
146 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
150 static const struct iio_chan_spec ltc2497_channel[] = {
151 LTC2497_CHAN(0, LTC2497_SGL),
152 LTC2497_CHAN(1, LTC2497_SGL),
153 LTC2497_CHAN(2, LTC2497_SGL),
154 LTC2497_CHAN(3, LTC2497_SGL),
155 LTC2497_CHAN(4, LTC2497_SGL),
156 LTC2497_CHAN(5, LTC2497_SGL),
157 LTC2497_CHAN(6, LTC2497_SGL),
158 LTC2497_CHAN(7, LTC2497_SGL),
159 LTC2497_CHAN(8, LTC2497_SGL),
160 LTC2497_CHAN(9, LTC2497_SGL),
161 LTC2497_CHAN(10, LTC2497_SGL),
162 LTC2497_CHAN(11, LTC2497_SGL),
163 LTC2497_CHAN(12, LTC2497_SGL),
164 LTC2497_CHAN(13, LTC2497_SGL),
165 LTC2497_CHAN(14, LTC2497_SGL),
166 LTC2497_CHAN(15, LTC2497_SGL),
167 LTC2497_CHAN_DIFF(0, LTC2497_DIFF),
168 LTC2497_CHAN_DIFF(1, LTC2497_DIFF),
169 LTC2497_CHAN_DIFF(2, LTC2497_DIFF),
170 LTC2497_CHAN_DIFF(3, LTC2497_DIFF),
171 LTC2497_CHAN_DIFF(4, LTC2497_DIFF),
172 LTC2497_CHAN_DIFF(5, LTC2497_DIFF),
173 LTC2497_CHAN_DIFF(6, LTC2497_DIFF),
174 LTC2497_CHAN_DIFF(7, LTC2497_DIFF),
175 LTC2497_CHAN_DIFF(0, LTC2497_DIFF | LTC2497_SIGN),
176 LTC2497_CHAN_DIFF(1, LTC2497_DIFF | LTC2497_SIGN),
177 LTC2497_CHAN_DIFF(2, LTC2497_DIFF | LTC2497_SIGN),
178 LTC2497_CHAN_DIFF(3, LTC2497_DIFF | LTC2497_SIGN),
179 LTC2497_CHAN_DIFF(4, LTC2497_DIFF | LTC2497_SIGN),
180 LTC2497_CHAN_DIFF(5, LTC2497_DIFF | LTC2497_SIGN),
181 LTC2497_CHAN_DIFF(6, LTC2497_DIFF | LTC2497_SIGN),
182 LTC2497_CHAN_DIFF(7, LTC2497_DIFF | LTC2497_SIGN),
185 static const struct iio_info ltc2497_info = {
186 .read_raw = ltc2497_read_raw,
187 .driver_module = THIS_MODULE,
190 static int ltc2497_probe(struct i2c_client *client,
191 const struct i2c_device_id *id)
193 struct iio_dev *indio_dev;
194 struct ltc2497_st *st;
197 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C |
198 I2C_FUNC_SMBUS_WRITE_BYTE))
201 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*st));
205 st = iio_priv(indio_dev);
206 i2c_set_clientdata(client, indio_dev);
209 indio_dev->dev.parent = &client->dev;
210 indio_dev->name = id->name;
211 indio_dev->info = <c2497_info;
212 indio_dev->modes = INDIO_DIRECT_MODE;
213 indio_dev->channels = ltc2497_channel;
214 indio_dev->num_channels = ARRAY_SIZE(ltc2497_channel);
216 st->ref = devm_regulator_get(&client->dev, "vref");
218 return PTR_ERR(st->ref);
220 ret = regulator_enable(st->ref);
224 ret = i2c_smbus_write_byte(st->client, LTC2497_CONFIG_DEFAULT);
226 goto err_regulator_disable;
228 st->addr_prev = LTC2497_CONFIG_DEFAULT;
229 st->time_prev = ktime_get();
231 ret = iio_device_register(indio_dev);
233 goto err_regulator_disable;
237 err_regulator_disable:
238 regulator_disable(st->ref);
243 static int ltc2497_remove(struct i2c_client *client)
245 struct iio_dev *indio_dev = i2c_get_clientdata(client);
246 struct ltc2497_st *st = iio_priv(indio_dev);
248 iio_device_unregister(indio_dev);
249 regulator_disable(st->ref);
254 static const struct i2c_device_id ltc2497_id[] = {
258 MODULE_DEVICE_TABLE(i2c, ltc2497_id);
260 static const struct of_device_id ltc2497_of_match[] = {
261 { .compatible = "lltc,ltc2497", },
264 MODULE_DEVICE_TABLE(of, ltc2497_of_match);
266 static struct i2c_driver ltc2497_driver = {
269 .of_match_table = of_match_ptr(ltc2497_of_match),
271 .probe = ltc2497_probe,
272 .remove = ltc2497_remove,
273 .id_table = ltc2497_id,
275 module_i2c_driver(ltc2497_driver);
277 MODULE_AUTHOR("Michael Hennerich <michael.hennerich@analog.com>");
278 MODULE_DESCRIPTION("Linear Technology LTC2497 ADC driver");
279 MODULE_LICENSE("GPL v2");