2 * Support code for Analog Devices Sigma-Delta ADCs
4 * Copyright 2012 Analog Devices Inc.
5 * Author: Lars-Peter Clausen <lars@metafoo.de>
7 * Licensed under the GPL-2.
10 #include <linux/interrupt.h>
11 #include <linux/device.h>
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/spi/spi.h>
15 #include <linux/err.h>
16 #include <linux/module.h>
18 #include <linux/iio/iio.h>
19 #include <linux/iio/sysfs.h>
20 #include <linux/iio/buffer.h>
21 #include <linux/iio/trigger.h>
22 #include <linux/iio/trigger_consumer.h>
23 #include <linux/iio/triggered_buffer.h>
24 #include <linux/iio/adc/ad_sigma_delta.h>
26 #include <asm/unaligned.h>
29 #define AD_SD_COMM_CHAN_MASK 0x3
31 #define AD_SD_REG_COMM 0x00
32 #define AD_SD_REG_DATA 0x03
35 * ad_sd_set_comm() - Set communications register
37 * @sigma_delta: The sigma delta device
38 * @comm: New value for the communications register
40 void ad_sd_set_comm(struct ad_sigma_delta *sigma_delta, uint8_t comm)
42 /* Some variants use the lower two bits of the communications register
43 * to select the channel */
44 sigma_delta->comm = comm & AD_SD_COMM_CHAN_MASK;
46 EXPORT_SYMBOL_GPL(ad_sd_set_comm);
49 * ad_sd_write_reg() - Write a register
51 * @sigma_delta: The sigma delta device
52 * @reg: Address of the register
53 * @size: Size of the register (0-3)
54 * @val: Value to write to the register
56 * Returns 0 on success, an error code otherwise.
58 int ad_sd_write_reg(struct ad_sigma_delta *sigma_delta, unsigned int reg,
59 unsigned int size, unsigned int val)
61 uint8_t *data = sigma_delta->data;
62 struct spi_transfer t = {
65 .cs_change = sigma_delta->bus_locked,
70 data[0] = (reg << sigma_delta->info->addr_shift) | sigma_delta->comm;
79 put_unaligned_be16(val, &data[1]);
91 spi_message_add_tail(&t, &m);
93 if (sigma_delta->bus_locked)
94 ret = spi_sync_locked(sigma_delta->spi, &m);
96 ret = spi_sync(sigma_delta->spi, &m);
100 EXPORT_SYMBOL_GPL(ad_sd_write_reg);
102 static int ad_sd_read_reg_raw(struct ad_sigma_delta *sigma_delta,
103 unsigned int reg, unsigned int size, uint8_t *val)
105 uint8_t *data = sigma_delta->data;
107 struct spi_transfer t[] = {
114 .cs_change = sigma_delta->bus_locked,
117 struct spi_message m;
119 spi_message_init(&m);
121 if (sigma_delta->info->has_registers) {
122 data[0] = reg << sigma_delta->info->addr_shift;
123 data[0] |= sigma_delta->info->read_mask;
124 data[0] |= sigma_delta->comm;
125 spi_message_add_tail(&t[0], &m);
127 spi_message_add_tail(&t[1], &m);
129 if (sigma_delta->bus_locked)
130 ret = spi_sync_locked(sigma_delta->spi, &m);
132 ret = spi_sync(sigma_delta->spi, &m);
138 * ad_sd_read_reg() - Read a register
140 * @sigma_delta: The sigma delta device
141 * @reg: Address of the register
142 * @size: Size of the register (1-4)
145 * Returns 0 on success, an error code otherwise.
147 int ad_sd_read_reg(struct ad_sigma_delta *sigma_delta,
148 unsigned int reg, unsigned int size, unsigned int *val)
152 ret = ad_sd_read_reg_raw(sigma_delta, reg, size, sigma_delta->data);
158 *val = get_unaligned_be32(sigma_delta->data);
161 *val = (sigma_delta->data[0] << 16) |
162 (sigma_delta->data[1] << 8) |
163 sigma_delta->data[2];
166 *val = get_unaligned_be16(sigma_delta->data);
169 *val = sigma_delta->data[0];
179 EXPORT_SYMBOL_GPL(ad_sd_read_reg);
182 * ad_sd_reset() - Reset the serial interface
184 * @sigma_delta: The sigma delta device
185 * @reset_length: Number of SCLKs with DIN = 1
187 * Returns 0 on success, an error code otherwise.
189 int ad_sd_reset(struct ad_sigma_delta *sigma_delta,
190 unsigned int reset_length)
196 size = DIV_ROUND_UP(reset_length, 8);
197 buf = kcalloc(size, sizeof(*buf), GFP_KERNEL);
201 memset(buf, 0xff, size);
202 ret = spi_write(sigma_delta->spi, buf, size);
207 EXPORT_SYMBOL_GPL(ad_sd_reset);
209 static int ad_sd_calibrate(struct ad_sigma_delta *sigma_delta,
210 unsigned int mode, unsigned int channel)
213 unsigned long timeout;
215 ret = ad_sigma_delta_set_channel(sigma_delta, channel);
219 spi_bus_lock(sigma_delta->spi->master);
220 sigma_delta->bus_locked = true;
221 reinit_completion(&sigma_delta->completion);
223 ret = ad_sigma_delta_set_mode(sigma_delta, mode);
227 sigma_delta->irq_dis = false;
228 enable_irq(sigma_delta->spi->irq);
229 timeout = wait_for_completion_timeout(&sigma_delta->completion, 2 * HZ);
231 sigma_delta->irq_dis = true;
232 disable_irq_nosync(sigma_delta->spi->irq);
238 sigma_delta->bus_locked = false;
239 spi_bus_unlock(sigma_delta->spi->master);
240 ad_sigma_delta_set_mode(sigma_delta, AD_SD_MODE_IDLE);
246 * ad_sd_calibrate_all() - Performs channel calibration
247 * @sigma_delta: The sigma delta device
248 * @cb: Array of channels and calibration type to perform
249 * @n: Number of items in cb
251 * Returns 0 on success, an error code otherwise.
253 int ad_sd_calibrate_all(struct ad_sigma_delta *sigma_delta,
254 const struct ad_sd_calib_data *cb, unsigned int n)
259 for (i = 0; i < n; i++) {
260 ret = ad_sd_calibrate(sigma_delta, cb[i].mode, cb[i].channel);
267 EXPORT_SYMBOL_GPL(ad_sd_calibrate_all);
270 * ad_sigma_delta_single_conversion() - Performs a single data conversion
271 * @indio_dev: The IIO device
272 * @chan: The conversion is done for this channel
273 * @val: Pointer to the location where to store the read value
275 * Returns: 0 on success, an error value otherwise.
277 int ad_sigma_delta_single_conversion(struct iio_dev *indio_dev,
278 const struct iio_chan_spec *chan, int *val)
280 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
281 unsigned int sample, raw_sample;
282 unsigned int data_reg;
285 if (iio_buffer_enabled(indio_dev))
288 mutex_lock(&indio_dev->mlock);
289 ad_sigma_delta_set_channel(sigma_delta, chan->address);
291 spi_bus_lock(sigma_delta->spi->master);
292 sigma_delta->bus_locked = true;
293 reinit_completion(&sigma_delta->completion);
295 ad_sigma_delta_set_mode(sigma_delta, AD_SD_MODE_SINGLE);
297 sigma_delta->irq_dis = false;
298 enable_irq(sigma_delta->spi->irq);
299 ret = wait_for_completion_interruptible_timeout(
300 &sigma_delta->completion, HZ);
302 sigma_delta->bus_locked = false;
303 spi_bus_unlock(sigma_delta->spi->master);
310 if (sigma_delta->info->data_reg != 0)
311 data_reg = sigma_delta->info->data_reg;
313 data_reg = AD_SD_REG_DATA;
315 ret = ad_sd_read_reg(sigma_delta, data_reg,
316 DIV_ROUND_UP(chan->scan_type.realbits + chan->scan_type.shift, 8),
320 if (!sigma_delta->irq_dis) {
321 disable_irq_nosync(sigma_delta->spi->irq);
322 sigma_delta->irq_dis = true;
325 ad_sigma_delta_set_mode(sigma_delta, AD_SD_MODE_IDLE);
326 mutex_unlock(&indio_dev->mlock);
331 sample = raw_sample >> chan->scan_type.shift;
332 sample &= (1 << chan->scan_type.realbits) - 1;
335 ret = ad_sigma_delta_postprocess_sample(sigma_delta, raw_sample);
341 EXPORT_SYMBOL_GPL(ad_sigma_delta_single_conversion);
343 static int ad_sd_buffer_postenable(struct iio_dev *indio_dev)
345 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
346 unsigned int channel;
349 ret = iio_triggered_buffer_postenable(indio_dev);
353 channel = find_first_bit(indio_dev->active_scan_mask,
354 indio_dev->masklength);
355 ret = ad_sigma_delta_set_channel(sigma_delta,
356 indio_dev->channels[channel].address);
360 spi_bus_lock(sigma_delta->spi->master);
361 sigma_delta->bus_locked = true;
362 ret = ad_sigma_delta_set_mode(sigma_delta, AD_SD_MODE_CONTINUOUS);
366 sigma_delta->irq_dis = false;
367 enable_irq(sigma_delta->spi->irq);
372 spi_bus_unlock(sigma_delta->spi->master);
378 static int ad_sd_buffer_postdisable(struct iio_dev *indio_dev)
380 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
382 reinit_completion(&sigma_delta->completion);
383 wait_for_completion_timeout(&sigma_delta->completion, HZ);
385 if (!sigma_delta->irq_dis) {
386 disable_irq_nosync(sigma_delta->spi->irq);
387 sigma_delta->irq_dis = true;
390 ad_sigma_delta_set_mode(sigma_delta, AD_SD_MODE_IDLE);
392 sigma_delta->bus_locked = false;
393 return spi_bus_unlock(sigma_delta->spi->master);
396 static irqreturn_t ad_sd_trigger_handler(int irq, void *p)
398 struct iio_poll_func *pf = p;
399 struct iio_dev *indio_dev = pf->indio_dev;
400 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
401 unsigned int reg_size;
402 unsigned int data_reg;
406 memset(data, 0x00, 16);
408 reg_size = indio_dev->channels[0].scan_type.realbits +
409 indio_dev->channels[0].scan_type.shift;
410 reg_size = DIV_ROUND_UP(reg_size, 8);
412 if (sigma_delta->info->data_reg != 0)
413 data_reg = sigma_delta->info->data_reg;
415 data_reg = AD_SD_REG_DATA;
421 ret = ad_sd_read_reg_raw(sigma_delta, data_reg, reg_size,
425 /* We store 24 bit samples in a 32 bit word. Keep the upper
426 * byte set to zero. */
427 ret = ad_sd_read_reg_raw(sigma_delta, data_reg, reg_size,
432 iio_push_to_buffers_with_timestamp(indio_dev, data, pf->timestamp);
434 iio_trigger_notify_done(indio_dev->trig);
435 sigma_delta->irq_dis = false;
436 enable_irq(sigma_delta->spi->irq);
441 static const struct iio_buffer_setup_ops ad_sd_buffer_setup_ops = {
442 .postenable = &ad_sd_buffer_postenable,
443 .predisable = &iio_triggered_buffer_predisable,
444 .postdisable = &ad_sd_buffer_postdisable,
445 .validate_scan_mask = &iio_validate_scan_mask_onehot,
448 static irqreturn_t ad_sd_data_rdy_trig_poll(int irq, void *private)
450 struct ad_sigma_delta *sigma_delta = private;
452 complete(&sigma_delta->completion);
453 disable_irq_nosync(irq);
454 sigma_delta->irq_dis = true;
455 iio_trigger_poll(sigma_delta->trig);
461 * ad_sd_validate_trigger() - validate_trigger callback for ad_sigma_delta devices
462 * @indio_dev: The IIO device
463 * @trig: The new trigger
465 * Returns: 0 if the 'trig' matches the trigger registered by the ad_sigma_delta
466 * device, -EINVAL otherwise.
468 int ad_sd_validate_trigger(struct iio_dev *indio_dev, struct iio_trigger *trig)
470 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
472 if (sigma_delta->trig != trig)
477 EXPORT_SYMBOL_GPL(ad_sd_validate_trigger);
479 static const struct iio_trigger_ops ad_sd_trigger_ops = {
482 static int ad_sd_probe_trigger(struct iio_dev *indio_dev)
484 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
487 sigma_delta->trig = iio_trigger_alloc("%s-dev%d", indio_dev->name,
489 if (sigma_delta->trig == NULL) {
493 sigma_delta->trig->ops = &ad_sd_trigger_ops;
494 init_completion(&sigma_delta->completion);
496 ret = request_irq(sigma_delta->spi->irq,
497 ad_sd_data_rdy_trig_poll,
502 goto error_free_trig;
504 if (!sigma_delta->irq_dis) {
505 sigma_delta->irq_dis = true;
506 disable_irq_nosync(sigma_delta->spi->irq);
508 sigma_delta->trig->dev.parent = &sigma_delta->spi->dev;
509 iio_trigger_set_drvdata(sigma_delta->trig, sigma_delta);
511 ret = iio_trigger_register(sigma_delta->trig);
515 /* select default trigger */
516 indio_dev->trig = iio_trigger_get(sigma_delta->trig);
521 free_irq(sigma_delta->spi->irq, sigma_delta);
523 iio_trigger_free(sigma_delta->trig);
528 static void ad_sd_remove_trigger(struct iio_dev *indio_dev)
530 struct ad_sigma_delta *sigma_delta = iio_device_get_drvdata(indio_dev);
532 iio_trigger_unregister(sigma_delta->trig);
533 free_irq(sigma_delta->spi->irq, sigma_delta);
534 iio_trigger_free(sigma_delta->trig);
538 * ad_sd_setup_buffer_and_trigger() -
539 * @indio_dev: The IIO device
541 int ad_sd_setup_buffer_and_trigger(struct iio_dev *indio_dev)
545 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
546 &ad_sd_trigger_handler, &ad_sd_buffer_setup_ops);
550 ret = ad_sd_probe_trigger(indio_dev);
552 iio_triggered_buffer_cleanup(indio_dev);
558 EXPORT_SYMBOL_GPL(ad_sd_setup_buffer_and_trigger);
561 * ad_sd_cleanup_buffer_and_trigger() -
562 * @indio_dev: The IIO device
564 void ad_sd_cleanup_buffer_and_trigger(struct iio_dev *indio_dev)
566 ad_sd_remove_trigger(indio_dev);
567 iio_triggered_buffer_cleanup(indio_dev);
569 EXPORT_SYMBOL_GPL(ad_sd_cleanup_buffer_and_trigger);
572 * ad_sd_init() - Initializes a ad_sigma_delta struct
573 * @sigma_delta: The ad_sigma_delta device
574 * @indio_dev: The IIO device which the Sigma Delta device is used for
575 * @spi: The SPI device for the ad_sigma_delta device
576 * @info: Device specific callbacks and options
578 * This function needs to be called before any other operations are performed on
579 * the ad_sigma_delta struct.
581 int ad_sd_init(struct ad_sigma_delta *sigma_delta, struct iio_dev *indio_dev,
582 struct spi_device *spi, const struct ad_sigma_delta_info *info)
584 sigma_delta->spi = spi;
585 sigma_delta->info = info;
586 iio_device_set_drvdata(indio_dev, sigma_delta);
590 EXPORT_SYMBOL_GPL(ad_sd_init);
592 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
593 MODULE_DESCRIPTION("Analog Devices Sigma-Delta ADCs");
594 MODULE_LICENSE("GPL v2");