1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for the Diolan DLN-2 USB-ADC adapter
5 * Copyright (c) 2017 Jack Andersen
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/types.h>
11 #include <linux/platform_device.h>
12 #include <linux/mfd/dln2.h>
14 #include <linux/iio/iio.h>
15 #include <linux/iio/sysfs.h>
16 #include <linux/iio/trigger.h>
17 #include <linux/iio/trigger_consumer.h>
18 #include <linux/iio/triggered_buffer.h>
19 #include <linux/iio/buffer.h>
20 #include <linux/iio/kfifo_buf.h>
22 #define DLN2_ADC_MOD_NAME "dln2-adc"
24 #define DLN2_ADC_ID 0x06
26 #define DLN2_ADC_GET_CHANNEL_COUNT DLN2_CMD(0x01, DLN2_ADC_ID)
27 #define DLN2_ADC_ENABLE DLN2_CMD(0x02, DLN2_ADC_ID)
28 #define DLN2_ADC_DISABLE DLN2_CMD(0x03, DLN2_ADC_ID)
29 #define DLN2_ADC_CHANNEL_ENABLE DLN2_CMD(0x05, DLN2_ADC_ID)
30 #define DLN2_ADC_CHANNEL_DISABLE DLN2_CMD(0x06, DLN2_ADC_ID)
31 #define DLN2_ADC_SET_RESOLUTION DLN2_CMD(0x08, DLN2_ADC_ID)
32 #define DLN2_ADC_CHANNEL_GET_VAL DLN2_CMD(0x0A, DLN2_ADC_ID)
33 #define DLN2_ADC_CHANNEL_GET_ALL_VAL DLN2_CMD(0x0B, DLN2_ADC_ID)
34 #define DLN2_ADC_CHANNEL_SET_CFG DLN2_CMD(0x0C, DLN2_ADC_ID)
35 #define DLN2_ADC_CHANNEL_GET_CFG DLN2_CMD(0x0D, DLN2_ADC_ID)
36 #define DLN2_ADC_CONDITION_MET_EV DLN2_CMD(0x10, DLN2_ADC_ID)
38 #define DLN2_ADC_EVENT_NONE 0
39 #define DLN2_ADC_EVENT_BELOW 1
40 #define DLN2_ADC_EVENT_LEVEL_ABOVE 2
41 #define DLN2_ADC_EVENT_OUTSIDE 3
42 #define DLN2_ADC_EVENT_INSIDE 4
43 #define DLN2_ADC_EVENT_ALWAYS 5
45 #define DLN2_ADC_MAX_CHANNELS 8
46 #define DLN2_ADC_DATA_BITS 10
49 * Plays similar role to iio_demux_table in subsystem core; except allocated
50 * in a fixed 8-element array.
52 struct dln2_adc_demux_table {
59 struct platform_device *pdev;
60 struct iio_chan_spec iio_channels[DLN2_ADC_MAX_CHANNELS + 1];
61 int port, trigger_chan;
62 struct iio_trigger *trig;
64 /* Cached sample period in milliseconds */
65 unsigned int sample_period;
67 unsigned int demux_count;
68 struct dln2_adc_demux_table demux[DLN2_ADC_MAX_CHANNELS];
69 /* Precomputed timestamp padding offset and length */
70 unsigned int ts_pad_offset, ts_pad_length;
73 struct dln2_adc_port_chan {
78 struct dln2_adc_get_all_vals {
80 __le16 values[DLN2_ADC_MAX_CHANNELS];
83 static void dln2_adc_add_demux(struct dln2_adc *dln2,
84 unsigned int in_loc, unsigned int out_loc,
87 struct dln2_adc_demux_table *p = dln2->demux_count ?
88 &dln2->demux[dln2->demux_count - 1] : NULL;
90 if (p && p->from + p->length == in_loc &&
91 p->to + p->length == out_loc) {
93 } else if (dln2->demux_count < DLN2_ADC_MAX_CHANNELS) {
94 p = &dln2->demux[dln2->demux_count++];
101 static void dln2_adc_update_demux(struct dln2_adc *dln2)
103 int in_ind = -1, out_ind;
104 unsigned int in_loc = 0, out_loc = 0;
105 struct iio_dev *indio_dev = platform_get_drvdata(dln2->pdev);
107 /* Clear out any old demux */
108 dln2->demux_count = 0;
110 /* Optimize all 8-channels case */
111 if (indio_dev->masklength &&
112 (*indio_dev->active_scan_mask & 0xff) == 0xff) {
113 dln2_adc_add_demux(dln2, 0, 0, 16);
114 dln2->ts_pad_offset = 0;
115 dln2->ts_pad_length = 0;
119 /* Build demux table from fixed 8-channels to active_scan_mask */
120 for_each_set_bit(out_ind,
121 indio_dev->active_scan_mask,
122 indio_dev->masklength) {
123 /* Handle timestamp separately */
124 if (out_ind == DLN2_ADC_MAX_CHANNELS)
126 for (++in_ind; in_ind != out_ind; ++in_ind)
128 dln2_adc_add_demux(dln2, in_loc, out_loc, 2);
133 if (indio_dev->scan_timestamp) {
134 size_t ts_offset = indio_dev->scan_bytes / sizeof(int64_t) - 1;
136 dln2->ts_pad_offset = out_loc;
137 dln2->ts_pad_length = ts_offset * sizeof(int64_t) - out_loc;
139 dln2->ts_pad_offset = 0;
140 dln2->ts_pad_length = 0;
144 static int dln2_adc_get_chan_count(struct dln2_adc *dln2)
147 u8 port = dln2->port;
149 int olen = sizeof(count);
151 ret = dln2_transfer(dln2->pdev, DLN2_ADC_GET_CHANNEL_COUNT,
152 &port, sizeof(port), &count, &olen);
154 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
157 if (olen < sizeof(count))
163 static int dln2_adc_set_port_resolution(struct dln2_adc *dln2)
166 struct dln2_adc_port_chan port_chan = {
168 .chan = DLN2_ADC_DATA_BITS,
171 ret = dln2_transfer_tx(dln2->pdev, DLN2_ADC_SET_RESOLUTION,
172 &port_chan, sizeof(port_chan));
174 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
179 static int dln2_adc_set_chan_enabled(struct dln2_adc *dln2,
180 int channel, bool enable)
183 struct dln2_adc_port_chan port_chan = {
187 u16 cmd = enable ? DLN2_ADC_CHANNEL_ENABLE : DLN2_ADC_CHANNEL_DISABLE;
189 ret = dln2_transfer_tx(dln2->pdev, cmd, &port_chan, sizeof(port_chan));
191 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
196 static int dln2_adc_set_port_enabled(struct dln2_adc *dln2, bool enable,
200 u8 port = dln2->port;
202 int olen = sizeof(conflict);
203 u16 cmd = enable ? DLN2_ADC_ENABLE : DLN2_ADC_DISABLE;
208 ret = dln2_transfer(dln2->pdev, cmd, &port, sizeof(port),
211 dev_dbg(&dln2->pdev->dev, "Problem in %s(%d)\n",
212 __func__, (int)enable);
213 if (conflict_out && enable && olen >= sizeof(conflict))
214 *conflict_out = le16_to_cpu(conflict);
217 if (enable && olen < sizeof(conflict))
223 static int dln2_adc_set_chan_period(struct dln2_adc *dln2,
224 unsigned int channel, unsigned int period)
228 struct dln2_adc_port_chan port_chan;
233 } __packed set_cfg = {
234 .port_chan.port = dln2->port,
235 .port_chan.chan = channel,
236 .type = period ? DLN2_ADC_EVENT_ALWAYS : DLN2_ADC_EVENT_NONE,
237 .period = cpu_to_le16(period)
240 ret = dln2_transfer_tx(dln2->pdev, DLN2_ADC_CHANNEL_SET_CFG,
241 &set_cfg, sizeof(set_cfg));
243 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
248 static int dln2_adc_read(struct dln2_adc *dln2, unsigned int channel)
253 int olen = sizeof(value);
254 struct dln2_adc_port_chan port_chan = {
259 ret = dln2_adc_set_chan_enabled(dln2, channel, true);
263 ret = dln2_adc_set_port_enabled(dln2, true, &conflict);
266 dev_err(&dln2->pdev->dev,
267 "ADC pins conflict with mask %04X\n",
275 * Call GET_VAL twice due to initial zero-return immediately after
278 for (i = 0; i < 2; ++i) {
279 ret = dln2_transfer(dln2->pdev, DLN2_ADC_CHANNEL_GET_VAL,
280 &port_chan, sizeof(port_chan),
283 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
286 if (olen < sizeof(value)) {
292 ret = le16_to_cpu(value);
295 dln2_adc_set_port_enabled(dln2, false, NULL);
297 dln2_adc_set_chan_enabled(dln2, channel, false);
302 static int dln2_adc_read_all(struct dln2_adc *dln2,
303 struct dln2_adc_get_all_vals *get_all_vals)
306 __u8 port = dln2->port;
307 int olen = sizeof(*get_all_vals);
309 ret = dln2_transfer(dln2->pdev, DLN2_ADC_CHANNEL_GET_ALL_VAL,
310 &port, sizeof(port), get_all_vals, &olen);
312 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
315 if (olen < sizeof(*get_all_vals))
321 static int dln2_adc_read_raw(struct iio_dev *indio_dev,
322 struct iio_chan_spec const *chan,
328 unsigned int microhertz;
329 struct dln2_adc *dln2 = iio_priv(indio_dev);
332 case IIO_CHAN_INFO_RAW:
333 ret = iio_device_claim_direct_mode(indio_dev);
337 mutex_lock(&dln2->mutex);
338 ret = dln2_adc_read(dln2, chan->channel);
339 mutex_unlock(&dln2->mutex);
341 iio_device_release_direct_mode(indio_dev);
349 case IIO_CHAN_INFO_SCALE:
351 * Voltage reference is fixed at 3.3v
352 * 3.3 / (1 << 10) * 1000000000
356 return IIO_VAL_INT_PLUS_NANO;
358 case IIO_CHAN_INFO_SAMP_FREQ:
359 if (dln2->sample_period) {
360 microhertz = 1000000000 / dln2->sample_period;
361 *val = microhertz / 1000000;
362 *val2 = microhertz % 1000000;
368 return IIO_VAL_INT_PLUS_MICRO;
375 static int dln2_adc_write_raw(struct iio_dev *indio_dev,
376 struct iio_chan_spec const *chan,
382 unsigned int microhertz;
383 struct dln2_adc *dln2 = iio_priv(indio_dev);
386 case IIO_CHAN_INFO_SAMP_FREQ:
387 microhertz = 1000000 * val + val2;
389 mutex_lock(&dln2->mutex);
391 dln2->sample_period =
392 microhertz ? 1000000000 / microhertz : UINT_MAX;
393 if (dln2->sample_period > 65535) {
394 dln2->sample_period = 65535;
395 dev_warn(&dln2->pdev->dev,
396 "clamping period to 65535ms\n");
400 * The first requested channel is arbitrated as a shared
401 * trigger source, so only one event is registered with the
402 * DLN. The event handler will then read all enabled channel
403 * values using DLN2_ADC_CHANNEL_GET_ALL_VAL to maintain
404 * synchronization between ADC readings.
406 if (dln2->trigger_chan != -1)
407 ret = dln2_adc_set_chan_period(dln2,
408 dln2->trigger_chan, dln2->sample_period);
412 mutex_unlock(&dln2->mutex);
421 static int dln2_update_scan_mode(struct iio_dev *indio_dev,
422 const unsigned long *scan_mask)
424 struct dln2_adc *dln2 = iio_priv(indio_dev);
425 int chan_count = indio_dev->num_channels - 1;
428 mutex_lock(&dln2->mutex);
430 for (i = 0; i < chan_count; ++i) {
431 ret = dln2_adc_set_chan_enabled(dln2, i,
432 test_bit(i, scan_mask));
434 for (j = 0; j < i; ++j)
435 dln2_adc_set_chan_enabled(dln2, j, false);
436 mutex_unlock(&dln2->mutex);
437 dev_err(&dln2->pdev->dev,
438 "Unable to enable ADC channel %d\n", i);
443 dln2_adc_update_demux(dln2);
445 mutex_unlock(&dln2->mutex);
450 #define DLN2_ADC_CHAN(lval, idx) { \
451 lval.type = IIO_VOLTAGE; \
452 lval.channel = idx; \
454 lval.info_mask_separate = BIT(IIO_CHAN_INFO_RAW); \
455 lval.info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SCALE) | \
456 BIT(IIO_CHAN_INFO_SAMP_FREQ); \
457 lval.scan_index = idx; \
458 lval.scan_type.sign = 'u'; \
459 lval.scan_type.realbits = DLN2_ADC_DATA_BITS; \
460 lval.scan_type.storagebits = 16; \
461 lval.scan_type.endianness = IIO_LE; \
464 /* Assignment version of IIO_CHAN_SOFT_TIMESTAMP */
465 #define IIO_CHAN_SOFT_TIMESTAMP_ASSIGN(lval, _si) { \
466 lval.type = IIO_TIMESTAMP; \
468 lval.scan_index = _si; \
469 lval.scan_type.sign = 's'; \
470 lval.scan_type.realbits = 64; \
471 lval.scan_type.storagebits = 64; \
474 static const struct iio_info dln2_adc_info = {
475 .read_raw = dln2_adc_read_raw,
476 .write_raw = dln2_adc_write_raw,
477 .update_scan_mode = dln2_update_scan_mode,
480 static irqreturn_t dln2_adc_trigger_h(int irq, void *p)
482 struct iio_poll_func *pf = p;
483 struct iio_dev *indio_dev = pf->indio_dev;
485 __le16 values[DLN2_ADC_MAX_CHANNELS];
486 int64_t timestamp_space;
488 struct dln2_adc_get_all_vals dev_data;
489 struct dln2_adc *dln2 = iio_priv(indio_dev);
490 const struct dln2_adc_demux_table *t;
493 mutex_lock(&dln2->mutex);
494 ret = dln2_adc_read_all(dln2, &dev_data);
495 mutex_unlock(&dln2->mutex);
499 /* Demux operation */
500 for (i = 0; i < dln2->demux_count; ++i) {
502 memcpy((void *)data.values + t->to,
503 (void *)dev_data.values + t->from, t->length);
506 /* Zero padding space between values and timestamp */
507 if (dln2->ts_pad_length)
508 memset((void *)data.values + dln2->ts_pad_offset,
509 0, dln2->ts_pad_length);
511 iio_push_to_buffers_with_timestamp(indio_dev, &data,
512 iio_get_time_ns(indio_dev));
515 iio_trigger_notify_done(indio_dev->trig);
519 static int dln2_adc_triggered_buffer_postenable(struct iio_dev *indio_dev)
522 struct dln2_adc *dln2 = iio_priv(indio_dev);
524 unsigned int trigger_chan;
526 mutex_lock(&dln2->mutex);
529 ret = dln2_adc_set_port_enabled(dln2, true, &conflict);
531 mutex_unlock(&dln2->mutex);
532 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
534 dev_err(&dln2->pdev->dev,
535 "ADC pins conflict with mask %04X\n",
542 /* Assign trigger channel based on first enabled channel */
543 trigger_chan = find_first_bit(indio_dev->active_scan_mask,
544 indio_dev->masklength);
545 if (trigger_chan < DLN2_ADC_MAX_CHANNELS) {
546 dln2->trigger_chan = trigger_chan;
547 ret = dln2_adc_set_chan_period(dln2, dln2->trigger_chan,
548 dln2->sample_period);
549 mutex_unlock(&dln2->mutex);
551 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
555 dln2->trigger_chan = -1;
556 mutex_unlock(&dln2->mutex);
562 static int dln2_adc_triggered_buffer_predisable(struct iio_dev *indio_dev)
565 struct dln2_adc *dln2 = iio_priv(indio_dev);
567 mutex_lock(&dln2->mutex);
569 /* Disable trigger channel */
570 if (dln2->trigger_chan != -1) {
571 dln2_adc_set_chan_period(dln2, dln2->trigger_chan, 0);
572 dln2->trigger_chan = -1;
576 ret = dln2_adc_set_port_enabled(dln2, false, NULL);
578 mutex_unlock(&dln2->mutex);
580 dev_dbg(&dln2->pdev->dev, "Problem in %s\n", __func__);
585 static const struct iio_buffer_setup_ops dln2_adc_buffer_setup_ops = {
586 .postenable = dln2_adc_triggered_buffer_postenable,
587 .predisable = dln2_adc_triggered_buffer_predisable,
590 static void dln2_adc_event(struct platform_device *pdev, u16 echo,
591 const void *data, int len)
593 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
594 struct dln2_adc *dln2 = iio_priv(indio_dev);
596 /* Called via URB completion handler */
597 iio_trigger_poll(dln2->trig);
600 static int dln2_adc_probe(struct platform_device *pdev)
602 struct device *dev = &pdev->dev;
603 struct dln2_adc *dln2;
604 struct dln2_platform_data *pdata = dev_get_platdata(&pdev->dev);
605 struct iio_dev *indio_dev;
608 indio_dev = devm_iio_device_alloc(dev, sizeof(*dln2));
610 dev_err(dev, "failed allocating iio device\n");
614 dln2 = iio_priv(indio_dev);
616 dln2->port = pdata->port;
617 dln2->trigger_chan = -1;
618 mutex_init(&dln2->mutex);
620 platform_set_drvdata(pdev, indio_dev);
622 ret = dln2_adc_set_port_resolution(dln2);
624 dev_err(dev, "failed to set ADC resolution to 10 bits\n");
628 chans = dln2_adc_get_chan_count(dln2);
630 dev_err(dev, "failed to get channel count: %d\n", chans);
633 if (chans > DLN2_ADC_MAX_CHANNELS) {
634 chans = DLN2_ADC_MAX_CHANNELS;
635 dev_warn(dev, "clamping channels to %d\n",
636 DLN2_ADC_MAX_CHANNELS);
639 for (i = 0; i < chans; ++i)
640 DLN2_ADC_CHAN(dln2->iio_channels[i], i)
641 IIO_CHAN_SOFT_TIMESTAMP_ASSIGN(dln2->iio_channels[i], i);
643 indio_dev->name = DLN2_ADC_MOD_NAME;
644 indio_dev->info = &dln2_adc_info;
645 indio_dev->modes = INDIO_DIRECT_MODE;
646 indio_dev->channels = dln2->iio_channels;
647 indio_dev->num_channels = chans + 1;
648 indio_dev->setup_ops = &dln2_adc_buffer_setup_ops;
650 dln2->trig = devm_iio_trigger_alloc(dev, "%s-dev%d",
652 iio_device_id(indio_dev));
654 dev_err(dev, "failed to allocate trigger\n");
657 iio_trigger_set_drvdata(dln2->trig, dln2);
658 ret = devm_iio_trigger_register(dev, dln2->trig);
660 dev_err(dev, "failed to register trigger: %d\n", ret);
663 iio_trigger_set_immutable(indio_dev, dln2->trig);
665 ret = devm_iio_triggered_buffer_setup(dev, indio_dev, NULL,
667 &dln2_adc_buffer_setup_ops);
669 dev_err(dev, "failed to allocate triggered buffer: %d\n", ret);
673 ret = dln2_register_event_cb(pdev, DLN2_ADC_CONDITION_MET_EV,
676 dev_err(dev, "failed to setup DLN2 periodic event: %d\n", ret);
680 ret = iio_device_register(indio_dev);
682 dev_err(dev, "failed to register iio device: %d\n", ret);
683 goto unregister_event;
689 dln2_unregister_event_cb(pdev, DLN2_ADC_CONDITION_MET_EV);
694 static int dln2_adc_remove(struct platform_device *pdev)
696 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
698 iio_device_unregister(indio_dev);
699 dln2_unregister_event_cb(pdev, DLN2_ADC_CONDITION_MET_EV);
703 static struct platform_driver dln2_adc_driver = {
704 .driver.name = DLN2_ADC_MOD_NAME,
705 .probe = dln2_adc_probe,
706 .remove = dln2_adc_remove,
709 module_platform_driver(dln2_adc_driver);
711 MODULE_AUTHOR("Jack Andersen <jackoalan@gmail.com");
712 MODULE_DESCRIPTION("Driver for the Diolan DLN2 ADC interface");
713 MODULE_LICENSE("GPL v2");
714 MODULE_ALIAS("platform:dln2-adc");