]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/iio/adc/ad7887.c
iio:adc:ad7887 Fix channel reported endianness from cpu to big endian
[mirror_ubuntu-artful-kernel.git] / drivers / iio / adc / ad7887.c
CommitLineData
2b4756aa
MH
1/*
2 * AD7887 SPI ADC driver
3 *
596d0609 4 * Copyright 2010-2011 Analog Devices Inc.
2b4756aa 5 *
596d0609 6 * Licensed under the GPL-2.
2b4756aa
MH
7 */
8
2b4756aa
MH
9#include <linux/device.h>
10#include <linux/kernel.h>
11#include <linux/slab.h>
12#include <linux/sysfs.h>
2b4756aa
MH
13#include <linux/spi/spi.h>
14#include <linux/regulator/consumer.h>
15#include <linux/err.h>
99c97852 16#include <linux/module.h>
65dd3d3d 17#include <linux/interrupt.h>
2b4756aa 18
06458e27
JC
19#include <linux/iio/iio.h>
20#include <linux/iio/sysfs.h>
21#include <linux/iio/buffer.h>
cdf38709 22
65dd3d3d
LPC
23#include <linux/iio/trigger_consumer.h>
24#include <linux/iio/triggered_buffer.h>
2b4756aa 25
4eb3ccf1 26#include <linux/platform_data/ad7887.h>
2b4756aa 27
65dd3d3d
LPC
28#define AD7887_REF_DIS (1 << 5) /* on-chip reference disable */
29#define AD7887_DUAL (1 << 4) /* dual-channel mode */
30#define AD7887_CH_AIN1 (1 << 3) /* convert on channel 1, DUAL=1 */
31#define AD7887_CH_AIN0 (0 << 3) /* convert on channel 0, DUAL=0,1 */
32#define AD7887_PM_MODE1 (0) /* CS based shutdown */
33#define AD7887_PM_MODE2 (1) /* full on */
34#define AD7887_PM_MODE3 (2) /* auto shutdown after conversion */
35#define AD7887_PM_MODE4 (3) /* standby mode */
36
37enum ad7887_channels {
38 AD7887_CH0,
39 AD7887_CH0_CH1,
40 AD7887_CH1,
41};
42
43#define RES_MASK(bits) ((1 << (bits)) - 1)
44
45/**
46 * struct ad7887_chip_info - chip specifc information
47 * @int_vref_mv: the internal reference voltage
48 * @channel: channel specification
49 */
50struct ad7887_chip_info {
51 u16 int_vref_mv;
52 struct iio_chan_spec channel[3];
53};
54
55struct ad7887_state {
56 struct spi_device *spi;
57 const struct ad7887_chip_info *chip_info;
58 struct regulator *reg;
59 struct spi_transfer xfer[4];
60 struct spi_message msg[3];
61 struct spi_message *ring_msg;
fce7c3ea 62 unsigned char tx_cmd_buf[4];
65dd3d3d
LPC
63
64 /*
65 * DMA (thus cache coherency maintenance) requires the
66 * transfer buffers to live in their own cache lines.
67 * Buffer needs to be large enough to hold two 16 bit samples and a
68 * 64 bit aligned 64 bit timestamp.
69 */
70 unsigned char data[ALIGN(4, sizeof(s64)) + sizeof(s64)]
71 ____cacheline_aligned;
72};
73
74enum ad7887_supported_device_ids {
75 ID_AD7887
76};
77
78static int ad7887_ring_preenable(struct iio_dev *indio_dev)
79{
80 struct ad7887_state *st = iio_priv(indio_dev);
65dd3d3d
LPC
81
82 /* We know this is a single long so can 'cheat' */
83 switch (*indio_dev->active_scan_mask) {
84 case (1 << 0):
85 st->ring_msg = &st->msg[AD7887_CH0];
86 break;
87 case (1 << 1):
88 st->ring_msg = &st->msg[AD7887_CH1];
89 /* Dummy read: push CH1 setting down to hardware */
90 spi_sync(st->spi, st->ring_msg);
91 break;
92 case ((1 << 1) | (1 << 0)):
93 st->ring_msg = &st->msg[AD7887_CH0_CH1];
94 break;
95 }
96
97 return 0;
98}
99
100static int ad7887_ring_postdisable(struct iio_dev *indio_dev)
101{
102 struct ad7887_state *st = iio_priv(indio_dev);
103
104 /* dummy read: restore default CH0 settin */
105 return spi_sync(st->spi, &st->msg[AD7887_CH0]);
106}
107
108/**
109 * ad7887_trigger_handler() bh of trigger launched polling to ring buffer
110 *
111 * Currently there is no option in this driver to disable the saving of
112 * timestamps within the ring.
113 **/
114static irqreturn_t ad7887_trigger_handler(int irq, void *p)
115{
116 struct iio_poll_func *pf = p;
117 struct iio_dev *indio_dev = pf->indio_dev;
118 struct ad7887_state *st = iio_priv(indio_dev);
65dd3d3d
LPC
119 int b_sent;
120
121 b_sent = spi_sync(st->spi, st->ring_msg);
122 if (b_sent)
123 goto done;
124
5afd602b
LPC
125 iio_push_to_buffers_with_timestamp(indio_dev, st->data,
126 iio_get_time_ns());
65dd3d3d
LPC
127done:
128 iio_trigger_notify_done(indio_dev->trig);
129
130 return IRQ_HANDLED;
131}
132
133static const struct iio_buffer_setup_ops ad7887_ring_setup_ops = {
134 .preenable = &ad7887_ring_preenable,
135 .postenable = &iio_triggered_buffer_postenable,
136 .predisable = &iio_triggered_buffer_predisable,
137 .postdisable = &ad7887_ring_postdisable,
138};
139
2b4756aa
MH
140static int ad7887_scan_direct(struct ad7887_state *st, unsigned ch)
141{
142 int ret = spi_sync(st->spi, &st->msg[ch]);
143 if (ret)
144 return ret;
145
146 return (st->data[(ch * 2)] << 8) | st->data[(ch * 2) + 1];
147}
148
84f79ecb 149static int ad7887_read_raw(struct iio_dev *indio_dev,
596d0609
MH
150 struct iio_chan_spec const *chan,
151 int *val,
152 int *val2,
153 long m)
2b4756aa 154{
2b4756aa 155 int ret;
84f79ecb 156 struct ad7887_state *st = iio_priv(indio_dev);
2b4756aa 157
596d0609 158 switch (m) {
b11f98ff 159 case IIO_CHAN_INFO_RAW:
84f79ecb
JC
160 mutex_lock(&indio_dev->mlock);
161 if (iio_buffer_enabled(indio_dev))
790d8759 162 ret = -EBUSY;
596d0609
MH
163 else
164 ret = ad7887_scan_direct(st, chan->address);
84f79ecb 165 mutex_unlock(&indio_dev->mlock);
596d0609
MH
166
167 if (ret < 0)
168 return ret;
98efb70a
LPC
169 *val = ret >> chan->scan_type.shift;
170 *val &= RES_MASK(chan->scan_type.realbits);
596d0609 171 return IIO_VAL_INT;
c8a9f805 172 case IIO_CHAN_INFO_SCALE:
bf5d2613
LPC
173 if (st->reg) {
174 *val = regulator_get_voltage(st->reg);
175 if (*val < 0)
176 return *val;
177 *val /= 1000;
178 } else {
179 *val = st->chip_info->int_vref_mv;
180 }
181
98efb70a 182 *val2 = chan->scan_type.realbits;
bf5d2613
LPC
183
184 return IIO_VAL_FRACTIONAL_LOG2;
596d0609
MH
185 }
186 return -EINVAL;
2b4756aa
MH
187}
188
2b4756aa
MH
189
190static const struct ad7887_chip_info ad7887_chip_info_tbl[] = {
191 /*
192 * More devices added in future
193 */
194 [ID_AD7887] = {
31bf47d5
JC
195 .channel[0] = {
196 .type = IIO_VOLTAGE,
197 .indexed = 1,
198 .channel = 1,
16d186b1
JC
199 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
200 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
31bf47d5
JC
201 .address = 1,
202 .scan_index = 1,
e39d9905
JC
203 .scan_type = {
204 .sign = 'u',
205 .realbits = 12,
206 .storagebits = 16,
207 .shift = 0,
208 .endianness = IIO_BE,
209 },
31bf47d5
JC
210 },
211 .channel[1] = {
212 .type = IIO_VOLTAGE,
213 .indexed = 1,
214 .channel = 0,
16d186b1
JC
215 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
216 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
31bf47d5
JC
217 .address = 0,
218 .scan_index = 0,
e39d9905
JC
219 .scan_type = {
220 .sign = 'u',
221 .realbits = 12,
222 .storagebits = 16,
223 .shift = 0,
224 .endianness = IIO_BE,
225 },
31bf47d5 226 },
596d0609 227 .channel[2] = IIO_CHAN_SOFT_TIMESTAMP(2),
2b4756aa
MH
228 .int_vref_mv = 2500,
229 },
230};
231
6fe8135f
JC
232static const struct iio_info ad7887_info = {
233 .read_raw = &ad7887_read_raw,
234 .driver_module = THIS_MODULE,
235};
236
fc52692c 237static int ad7887_probe(struct spi_device *spi)
2b4756aa
MH
238{
239 struct ad7887_platform_data *pdata = spi->dev.platform_data;
240 struct ad7887_state *st;
82429e0d 241 struct iio_dev *indio_dev;
fce7c3ea 242 uint8_t mode;
bf5d2613 243 int ret;
2b4756aa 244
82429e0d 245 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
f39e086a
MH
246 if (indio_dev == NULL)
247 return -ENOMEM;
248
249 st = iio_priv(indio_dev);
2b4756aa 250
bf5d2613 251 if (!pdata || !pdata->use_onchip_ref) {
82429e0d
SK
252 st->reg = devm_regulator_get(&spi->dev, "vref");
253 if (IS_ERR(st->reg))
254 return PTR_ERR(st->reg);
bf5d2613 255
2b4756aa
MH
256 ret = regulator_enable(st->reg);
257 if (ret)
82429e0d 258 return ret;
2b4756aa
MH
259 }
260
261 st->chip_info =
262 &ad7887_chip_info_tbl[spi_get_device_id(spi)->driver_data];
263
f39e086a 264 spi_set_drvdata(spi, indio_dev);
2b4756aa
MH
265 st->spi = spi;
266
2b4756aa 267 /* Estabilish that the iio_dev is a child of the spi device */
f39e086a
MH
268 indio_dev->dev.parent = &spi->dev;
269 indio_dev->name = spi_get_device_id(spi)->name;
6fe8135f 270 indio_dev->info = &ad7887_info;
f39e086a 271 indio_dev->modes = INDIO_DIRECT_MODE;
2b4756aa
MH
272
273 /* Setup default message */
274
fce7c3ea
LPC
275 mode = AD7887_PM_MODE4;
276 if (!pdata || !pdata->use_onchip_ref)
277 mode |= AD7887_REF_DIS;
278 if (pdata && pdata->en_dual)
279 mode |= AD7887_DUAL;
280
281 st->tx_cmd_buf[0] = AD7887_CH_AIN0 | mode;
2b4756aa
MH
282
283 st->xfer[0].rx_buf = &st->data[0];
284 st->xfer[0].tx_buf = &st->tx_cmd_buf[0];
285 st->xfer[0].len = 2;
286
287 spi_message_init(&st->msg[AD7887_CH0]);
288 spi_message_add_tail(&st->xfer[0], &st->msg[AD7887_CH0]);
289
290 if (pdata && pdata->en_dual) {
fce7c3ea 291 st->tx_cmd_buf[2] = AD7887_CH_AIN1 | mode;
2b4756aa
MH
292
293 st->xfer[1].rx_buf = &st->data[0];
294 st->xfer[1].tx_buf = &st->tx_cmd_buf[2];
295 st->xfer[1].len = 2;
296
297 st->xfer[2].rx_buf = &st->data[2];
fce7c3ea 298 st->xfer[2].tx_buf = &st->tx_cmd_buf[0];
2b4756aa
MH
299 st->xfer[2].len = 2;
300
301 spi_message_init(&st->msg[AD7887_CH0_CH1]);
302 spi_message_add_tail(&st->xfer[1], &st->msg[AD7887_CH0_CH1]);
303 spi_message_add_tail(&st->xfer[2], &st->msg[AD7887_CH0_CH1]);
304
fce7c3ea
LPC
305 st->xfer[3].rx_buf = &st->data[2];
306 st->xfer[3].tx_buf = &st->tx_cmd_buf[2];
2b4756aa
MH
307 st->xfer[3].len = 2;
308
309 spi_message_init(&st->msg[AD7887_CH1]);
310 spi_message_add_tail(&st->xfer[3], &st->msg[AD7887_CH1]);
311
f39e086a
MH
312 indio_dev->channels = st->chip_info->channel;
313 indio_dev->num_channels = 3;
2b4756aa 314 } else {
f39e086a
MH
315 indio_dev->channels = &st->chip_info->channel[1];
316 indio_dev->num_channels = 2;
596d0609 317 }
2b4756aa 318
65dd3d3d
LPC
319 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
320 &ad7887_trigger_handler, &ad7887_ring_setup_ops);
2b4756aa 321 if (ret)
f39e086a 322 goto error_disable_reg;
2b4756aa 323
26d25ae3
JC
324 ret = iio_device_register(indio_dev);
325 if (ret)
326 goto error_unregister_ring;
327
328 return 0;
329error_unregister_ring:
65dd3d3d 330 iio_triggered_buffer_cleanup(indio_dev);
2b4756aa 331error_disable_reg:
bf5d2613 332 if (st->reg)
2b4756aa 333 regulator_disable(st->reg);
f39e086a 334
2b4756aa
MH
335 return ret;
336}
337
fc52692c 338static int ad7887_remove(struct spi_device *spi)
2b4756aa 339{
f39e086a
MH
340 struct iio_dev *indio_dev = spi_get_drvdata(spi);
341 struct ad7887_state *st = iio_priv(indio_dev);
342
d2fffd6c 343 iio_device_unregister(indio_dev);
65dd3d3d 344 iio_triggered_buffer_cleanup(indio_dev);
82429e0d 345 if (st->reg)
2b4756aa 346 regulator_disable(st->reg);
f39e086a 347
2b4756aa
MH
348 return 0;
349}
350
351static const struct spi_device_id ad7887_id[] = {
352 {"ad7887", ID_AD7887},
353 {}
354};
55e4390c 355MODULE_DEVICE_TABLE(spi, ad7887_id);
2b4756aa
MH
356
357static struct spi_driver ad7887_driver = {
358 .driver = {
359 .name = "ad7887",
2b4756aa
MH
360 .owner = THIS_MODULE,
361 },
362 .probe = ad7887_probe,
fc52692c 363 .remove = ad7887_remove,
2b4756aa
MH
364 .id_table = ad7887_id,
365};
ae6ae6fe 366module_spi_driver(ad7887_driver);
2b4756aa
MH
367
368MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
369MODULE_DESCRIPTION("Analog Devices AD7887 ADC");
370MODULE_LICENSE("GPL v2");