4 * Copyright (C) 2012 Texas Instruments Incorporated - https://www.ti.com/
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation version 2.
10 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
11 * kind, whether express or implied; without even the implied warranty
12 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 #include <linux/kernel.h>
17 #include <linux/err.h>
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/interrupt.h>
21 #include <linux/platform_device.h>
23 #include <linux/iio/iio.h>
25 #include <linux/of_device.h>
26 #include <linux/iio/machine.h>
27 #include <linux/iio/driver.h>
29 #include <linux/mfd/ti_am335x_tscadc.h>
30 #include <linux/iio/buffer.h>
31 #include <linux/iio/kfifo_buf.h>
33 #include <linux/dmaengine.h>
34 #include <linux/dma-mapping.h>
36 #define DMA_BUFFER_SIZE SZ_2K
39 struct dma_slave_config conf;
40 struct dma_chan *chan;
50 struct ti_tscadc_dev *mfd_tscadc;
52 struct mutex fifo1_lock; /* to protect fifo access */
57 int buffer_en_ch_steps;
59 u32 open_delay[8], sample_delay[8], step_avg[8];
62 static unsigned int tiadc_readl(struct tiadc_device *adc, unsigned int reg)
64 return readl(adc->mfd_tscadc->tscadc_base + reg);
67 static void tiadc_writel(struct tiadc_device *adc, unsigned int reg,
70 writel(val, adc->mfd_tscadc->tscadc_base + reg);
73 static u32 get_adc_step_mask(struct tiadc_device *adc_dev)
77 step_en = ((1 << adc_dev->channels) - 1);
78 step_en <<= TOTAL_STEPS - adc_dev->channels + 1;
82 static u32 get_adc_chan_step_mask(struct tiadc_device *adc_dev,
83 struct iio_chan_spec const *chan)
87 for (i = 0; i < ARRAY_SIZE(adc_dev->channel_step); i++) {
88 if (chan->channel == adc_dev->channel_line[i]) {
91 step = adc_dev->channel_step[i];
92 /* +1 for the charger */
93 return 1 << (step + 1);
100 static u32 get_adc_step_bit(struct tiadc_device *adc_dev, int chan)
102 return 1 << adc_dev->channel_step[chan];
105 static void tiadc_step_config(struct iio_dev *indio_dev)
107 struct tiadc_device *adc_dev = iio_priv(indio_dev);
108 struct device *dev = adc_dev->mfd_tscadc->dev;
109 unsigned int stepconfig;
113 * There are 16 configurable steps and 8 analog input
114 * lines available which are shared between Touchscreen and ADC.
116 * Steps forwards i.e. from 0 towards 16 are used by ADC
117 * depending on number of input lines needed.
118 * Channel would represent which analog input
119 * needs to be given to ADC to digitalize data.
123 for (i = 0; i < adc_dev->channels; i++) {
126 chan = adc_dev->channel_line[i];
128 if (adc_dev->step_avg[i] > STEPCONFIG_AVG_16) {
129 dev_warn(dev, "chan %d step_avg truncating to %d\n",
130 chan, STEPCONFIG_AVG_16);
131 adc_dev->step_avg[i] = STEPCONFIG_AVG_16;
134 if (adc_dev->step_avg[i])
136 STEPCONFIG_AVG(ffs(adc_dev->step_avg[i]) - 1) |
139 stepconfig = STEPCONFIG_FIFO1;
141 if (iio_buffer_enabled(indio_dev))
142 stepconfig |= STEPCONFIG_MODE_SWCNT;
144 tiadc_writel(adc_dev, REG_STEPCONFIG(steps),
145 stepconfig | STEPCONFIG_INP(chan) |
146 STEPCONFIG_INM_ADCREFM |
147 STEPCONFIG_RFP_VREFP |
148 STEPCONFIG_RFM_VREFN);
150 if (adc_dev->open_delay[i] > STEPDELAY_OPEN_MASK) {
151 dev_warn(dev, "chan %d open delay truncating to 0x3FFFF\n",
153 adc_dev->open_delay[i] = STEPDELAY_OPEN_MASK;
156 if (adc_dev->sample_delay[i] > 0xFF) {
157 dev_warn(dev, "chan %d sample delay truncating to 0xFF\n",
159 adc_dev->sample_delay[i] = 0xFF;
162 tiadc_writel(adc_dev, REG_STEPDELAY(steps),
163 STEPDELAY_OPEN(adc_dev->open_delay[i]) |
164 STEPDELAY_SAMPLE(adc_dev->sample_delay[i]));
166 adc_dev->channel_step[i] = steps;
171 static irqreturn_t tiadc_irq_h(int irq, void *private)
173 struct iio_dev *indio_dev = private;
174 struct tiadc_device *adc_dev = iio_priv(indio_dev);
175 unsigned int status, config, adc_fsm;
176 unsigned short count = 0;
178 status = tiadc_readl(adc_dev, REG_IRQSTATUS);
181 * ADC and touchscreen share the IRQ line.
182 * FIFO0 interrupts are used by TSC. Handle FIFO1 IRQs here only
184 if (status & IRQENB_FIFO1OVRRUN) {
185 /* FIFO Overrun. Clear flag. Disable/Enable ADC to recover */
186 config = tiadc_readl(adc_dev, REG_CTRL);
187 config &= ~(CNTRLREG_TSCSSENB);
188 tiadc_writel(adc_dev, REG_CTRL, config);
189 tiadc_writel(adc_dev, REG_IRQSTATUS, IRQENB_FIFO1OVRRUN
190 | IRQENB_FIFO1UNDRFLW | IRQENB_FIFO1THRES);
192 /* wait for idle state.
193 * ADC needs to finish the current conversion
194 * before disabling the module
197 adc_fsm = tiadc_readl(adc_dev, REG_ADCFSM);
198 } while (adc_fsm != 0x10 && count++ < 100);
200 tiadc_writel(adc_dev, REG_CTRL, (config | CNTRLREG_TSCSSENB));
202 } else if (status & IRQENB_FIFO1THRES) {
203 /* Disable irq and wake worker thread */
204 tiadc_writel(adc_dev, REG_IRQCLR, IRQENB_FIFO1THRES);
205 return IRQ_WAKE_THREAD;
211 static irqreturn_t tiadc_worker_h(int irq, void *private)
213 struct iio_dev *indio_dev = private;
214 struct tiadc_device *adc_dev = iio_priv(indio_dev);
215 int i, k, fifo1count, read;
216 u16 *data = adc_dev->data;
218 fifo1count = tiadc_readl(adc_dev, REG_FIFO1CNT);
219 for (k = 0; k < fifo1count; k = k + i) {
220 for (i = 0; i < (indio_dev->scan_bytes)/2; i++) {
221 read = tiadc_readl(adc_dev, REG_FIFO1);
222 data[i] = read & FIFOREAD_DATA_MASK;
224 iio_push_to_buffers(indio_dev, (u8 *) data);
227 tiadc_writel(adc_dev, REG_IRQSTATUS, IRQENB_FIFO1THRES);
228 tiadc_writel(adc_dev, REG_IRQENABLE, IRQENB_FIFO1THRES);
233 static void tiadc_dma_rx_complete(void *param)
235 struct iio_dev *indio_dev = param;
236 struct tiadc_device *adc_dev = iio_priv(indio_dev);
237 struct tiadc_dma *dma = &adc_dev->dma;
241 data = dma->buf + dma->current_period * dma->period_size;
242 dma->current_period = 1 - dma->current_period; /* swap the buffer ID */
244 for (i = 0; i < dma->period_size; i += indio_dev->scan_bytes) {
245 iio_push_to_buffers(indio_dev, data);
246 data += indio_dev->scan_bytes;
250 static int tiadc_start_dma(struct iio_dev *indio_dev)
252 struct tiadc_device *adc_dev = iio_priv(indio_dev);
253 struct tiadc_dma *dma = &adc_dev->dma;
254 struct dma_async_tx_descriptor *desc;
256 dma->current_period = 0; /* We start to fill period 0 */
258 * Make the fifo thresh as the multiple of total number of
259 * channels enabled, so make sure that cyclic DMA period
260 * length is also a multiple of total number of channels
261 * enabled. This ensures that no invalid data is reported
262 * to the stack via iio_push_to_buffers().
264 dma->fifo_thresh = rounddown(FIFO1_THRESHOLD + 1,
265 adc_dev->total_ch_enabled) - 1;
266 /* Make sure that period length is multiple of fifo thresh level */
267 dma->period_size = rounddown(DMA_BUFFER_SIZE / 2,
268 (dma->fifo_thresh + 1) * sizeof(u16));
270 dma->conf.src_maxburst = dma->fifo_thresh + 1;
271 dmaengine_slave_config(dma->chan, &dma->conf);
273 desc = dmaengine_prep_dma_cyclic(dma->chan, dma->addr,
274 dma->period_size * 2,
275 dma->period_size, DMA_DEV_TO_MEM,
280 desc->callback = tiadc_dma_rx_complete;
281 desc->callback_param = indio_dev;
283 dma->cookie = dmaengine_submit(desc);
285 dma_async_issue_pending(dma->chan);
287 tiadc_writel(adc_dev, REG_FIFO1THR, dma->fifo_thresh);
288 tiadc_writel(adc_dev, REG_DMA1REQ, dma->fifo_thresh);
289 tiadc_writel(adc_dev, REG_DMAENABLE_SET, DMA_FIFO1);
294 static int tiadc_buffer_preenable(struct iio_dev *indio_dev)
296 struct tiadc_device *adc_dev = iio_priv(indio_dev);
299 tiadc_writel(adc_dev, REG_IRQCLR, (IRQENB_FIFO1THRES |
301 IRQENB_FIFO1UNDRFLW));
303 /* Flush FIFO. Needed in corner cases in simultaneous tsc/adc use */
304 fifo1count = tiadc_readl(adc_dev, REG_FIFO1CNT);
305 for (i = 0; i < fifo1count; i++)
306 tiadc_readl(adc_dev, REG_FIFO1);
311 static int tiadc_buffer_postenable(struct iio_dev *indio_dev)
313 struct tiadc_device *adc_dev = iio_priv(indio_dev);
314 struct tiadc_dma *dma = &adc_dev->dma;
315 unsigned int irq_enable;
316 unsigned int enb = 0;
319 tiadc_step_config(indio_dev);
320 for_each_set_bit(bit, indio_dev->active_scan_mask, adc_dev->channels) {
321 enb |= (get_adc_step_bit(adc_dev, bit) << 1);
322 adc_dev->total_ch_enabled++;
324 adc_dev->buffer_en_ch_steps = enb;
327 tiadc_start_dma(indio_dev);
329 am335x_tsc_se_set_cache(adc_dev->mfd_tscadc, enb);
331 tiadc_writel(adc_dev, REG_IRQSTATUS, IRQENB_FIFO1THRES
332 | IRQENB_FIFO1OVRRUN | IRQENB_FIFO1UNDRFLW);
334 irq_enable = IRQENB_FIFO1OVRRUN;
336 irq_enable |= IRQENB_FIFO1THRES;
337 tiadc_writel(adc_dev, REG_IRQENABLE, irq_enable);
342 static int tiadc_buffer_predisable(struct iio_dev *indio_dev)
344 struct tiadc_device *adc_dev = iio_priv(indio_dev);
345 struct tiadc_dma *dma = &adc_dev->dma;
348 tiadc_writel(adc_dev, REG_IRQCLR, (IRQENB_FIFO1THRES |
349 IRQENB_FIFO1OVRRUN | IRQENB_FIFO1UNDRFLW));
350 am335x_tsc_se_clr(adc_dev->mfd_tscadc, adc_dev->buffer_en_ch_steps);
351 adc_dev->buffer_en_ch_steps = 0;
352 adc_dev->total_ch_enabled = 0;
354 tiadc_writel(adc_dev, REG_DMAENABLE_CLEAR, 0x2);
355 dmaengine_terminate_async(dma->chan);
358 /* Flush FIFO of leftover data in the time it takes to disable adc */
359 fifo1count = tiadc_readl(adc_dev, REG_FIFO1CNT);
360 for (i = 0; i < fifo1count; i++)
361 tiadc_readl(adc_dev, REG_FIFO1);
366 static int tiadc_buffer_postdisable(struct iio_dev *indio_dev)
368 tiadc_step_config(indio_dev);
373 static const struct iio_buffer_setup_ops tiadc_buffer_setup_ops = {
374 .preenable = &tiadc_buffer_preenable,
375 .postenable = &tiadc_buffer_postenable,
376 .predisable = &tiadc_buffer_predisable,
377 .postdisable = &tiadc_buffer_postdisable,
380 static int tiadc_iio_buffered_hardware_setup(struct device *dev,
381 struct iio_dev *indio_dev,
382 irqreturn_t (*pollfunc_bh)(int irq, void *p),
383 irqreturn_t (*pollfunc_th)(int irq, void *p),
386 const struct iio_buffer_setup_ops *setup_ops)
388 struct iio_buffer *buffer;
391 buffer = devm_iio_kfifo_allocate(dev);
395 iio_device_attach_buffer(indio_dev, buffer);
397 ret = devm_request_threaded_irq(dev, irq, pollfunc_th, pollfunc_bh,
398 flags, indio_dev->name, indio_dev);
402 indio_dev->setup_ops = setup_ops;
403 indio_dev->modes |= INDIO_BUFFER_SOFTWARE;
408 static const char * const chan_name_ain[] = {
419 static int tiadc_channel_init(struct device *dev, struct iio_dev *indio_dev,
422 struct tiadc_device *adc_dev = iio_priv(indio_dev);
423 struct iio_chan_spec *chan_array;
424 struct iio_chan_spec *chan;
427 indio_dev->num_channels = channels;
428 chan_array = devm_kcalloc(dev, channels, sizeof(*chan_array),
430 if (chan_array == NULL)
434 for (i = 0; i < channels; i++, chan++) {
436 chan->type = IIO_VOLTAGE;
438 chan->channel = adc_dev->channel_line[i];
439 chan->info_mask_separate = BIT(IIO_CHAN_INFO_RAW);
440 chan->datasheet_name = chan_name_ain[chan->channel];
441 chan->scan_index = i;
442 chan->scan_type.sign = 'u';
443 chan->scan_type.realbits = 12;
444 chan->scan_type.storagebits = 16;
447 indio_dev->channels = chan_array;
452 static int tiadc_read_raw(struct iio_dev *indio_dev,
453 struct iio_chan_spec const *chan,
454 int *val, int *val2, long mask)
456 struct tiadc_device *adc_dev = iio_priv(indio_dev);
457 int ret = IIO_VAL_INT;
459 unsigned int fifo1count, read, stepid;
462 unsigned long timeout;
464 if (iio_buffer_enabled(indio_dev))
467 step_en = get_adc_chan_step_mask(adc_dev, chan);
471 mutex_lock(&adc_dev->fifo1_lock);
472 fifo1count = tiadc_readl(adc_dev, REG_FIFO1CNT);
474 tiadc_readl(adc_dev, REG_FIFO1);
476 am335x_tsc_se_set_once(adc_dev->mfd_tscadc, step_en);
478 timeout = jiffies + msecs_to_jiffies
479 (IDLE_TIMEOUT * adc_dev->channels);
480 /* Wait for Fifo threshold interrupt */
482 fifo1count = tiadc_readl(adc_dev, REG_FIFO1CNT);
486 if (time_after(jiffies, timeout)) {
487 am335x_tsc_se_adc_done(adc_dev->mfd_tscadc);
492 map_val = adc_dev->channel_step[chan->scan_index];
495 * We check the complete FIFO. We programmed just one entry but in case
496 * something went wrong we left empty handed (-EAGAIN previously) and
497 * then the value apeared somehow in the FIFO we would have two entries.
498 * Therefore we read every item and keep only the latest version of the
501 for (i = 0; i < fifo1count; i++) {
502 read = tiadc_readl(adc_dev, REG_FIFO1);
503 stepid = read & FIFOREAD_CHNLID_MASK;
504 stepid = stepid >> 0x10;
506 if (stepid == map_val) {
507 read = read & FIFOREAD_DATA_MASK;
512 am335x_tsc_se_adc_done(adc_dev->mfd_tscadc);
518 mutex_unlock(&adc_dev->fifo1_lock);
522 static const struct iio_info tiadc_info = {
523 .read_raw = &tiadc_read_raw,
526 static int tiadc_request_dma(struct platform_device *pdev,
527 struct tiadc_device *adc_dev)
529 struct tiadc_dma *dma = &adc_dev->dma;
532 /* Default slave configuration parameters */
533 dma->conf.direction = DMA_DEV_TO_MEM;
534 dma->conf.src_addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES;
535 dma->conf.src_addr = adc_dev->mfd_tscadc->tscadc_phys_base + REG_FIFO1;
538 dma_cap_set(DMA_CYCLIC, mask);
540 /* Get a channel for RX */
541 dma->chan = dma_request_chan(adc_dev->mfd_tscadc->dev, "fifo1");
542 if (IS_ERR(dma->chan)) {
543 int ret = PTR_ERR(dma->chan);
550 dma->buf = dma_alloc_coherent(dma->chan->device->dev, DMA_BUFFER_SIZE,
551 &dma->addr, GFP_KERNEL);
557 dma_release_channel(dma->chan);
561 static int tiadc_parse_dt(struct platform_device *pdev,
562 struct tiadc_device *adc_dev)
564 struct device_node *node = pdev->dev.of_node;
565 struct property *prop;
570 of_property_for_each_u32(node, "ti,adc-channels", prop, cur, val) {
571 adc_dev->channel_line[channels] = val;
573 /* Set Default values for optional DT parameters */
574 adc_dev->open_delay[channels] = STEPCONFIG_OPENDLY;
575 adc_dev->sample_delay[channels] = STEPCONFIG_SAMPLEDLY;
576 adc_dev->step_avg[channels] = 16;
581 of_property_read_u32_array(node, "ti,chan-step-avg",
582 adc_dev->step_avg, channels);
583 of_property_read_u32_array(node, "ti,chan-step-opendelay",
584 adc_dev->open_delay, channels);
585 of_property_read_u32_array(node, "ti,chan-step-sampledelay",
586 adc_dev->sample_delay, channels);
588 adc_dev->channels = channels;
592 static int tiadc_probe(struct platform_device *pdev)
594 struct iio_dev *indio_dev;
595 struct tiadc_device *adc_dev;
596 struct device_node *node = pdev->dev.of_node;
600 dev_err(&pdev->dev, "Could not find valid DT data.\n");
604 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*adc_dev));
605 if (indio_dev == NULL) {
606 dev_err(&pdev->dev, "failed to allocate iio device\n");
609 adc_dev = iio_priv(indio_dev);
611 adc_dev->mfd_tscadc = ti_tscadc_dev_get(pdev);
612 tiadc_parse_dt(pdev, adc_dev);
614 indio_dev->name = dev_name(&pdev->dev);
615 indio_dev->modes = INDIO_DIRECT_MODE;
616 indio_dev->info = &tiadc_info;
618 tiadc_step_config(indio_dev);
619 tiadc_writel(adc_dev, REG_FIFO1THR, FIFO1_THRESHOLD);
620 mutex_init(&adc_dev->fifo1_lock);
622 err = tiadc_channel_init(&pdev->dev, indio_dev, adc_dev->channels);
626 err = tiadc_iio_buffered_hardware_setup(&pdev->dev, indio_dev,
629 adc_dev->mfd_tscadc->irq,
631 &tiadc_buffer_setup_ops);
634 goto err_free_channels;
636 err = iio_device_register(indio_dev);
638 goto err_buffer_unregister;
640 platform_set_drvdata(pdev, indio_dev);
642 err = tiadc_request_dma(pdev, adc_dev);
643 if (err && err == -EPROBE_DEFER)
649 iio_device_unregister(indio_dev);
650 err_buffer_unregister:
655 static int tiadc_remove(struct platform_device *pdev)
657 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
658 struct tiadc_device *adc_dev = iio_priv(indio_dev);
659 struct tiadc_dma *dma = &adc_dev->dma;
663 dma_free_coherent(dma->chan->device->dev, DMA_BUFFER_SIZE,
664 dma->buf, dma->addr);
665 dma_release_channel(dma->chan);
667 iio_device_unregister(indio_dev);
669 step_en = get_adc_step_mask(adc_dev);
670 am335x_tsc_se_clr(adc_dev->mfd_tscadc, step_en);
675 static int __maybe_unused tiadc_suspend(struct device *dev)
677 struct iio_dev *indio_dev = dev_get_drvdata(dev);
678 struct tiadc_device *adc_dev = iio_priv(indio_dev);
681 idle = tiadc_readl(adc_dev, REG_CTRL);
682 idle &= ~(CNTRLREG_TSCSSENB);
683 tiadc_writel(adc_dev, REG_CTRL, (idle |
684 CNTRLREG_POWERDOWN));
689 static int __maybe_unused tiadc_resume(struct device *dev)
691 struct iio_dev *indio_dev = dev_get_drvdata(dev);
692 struct tiadc_device *adc_dev = iio_priv(indio_dev);
693 unsigned int restore;
695 /* Make sure ADC is powered up */
696 restore = tiadc_readl(adc_dev, REG_CTRL);
697 restore &= ~(CNTRLREG_POWERDOWN);
698 tiadc_writel(adc_dev, REG_CTRL, restore);
700 tiadc_step_config(indio_dev);
701 am335x_tsc_se_set_cache(adc_dev->mfd_tscadc,
702 adc_dev->buffer_en_ch_steps);
706 static SIMPLE_DEV_PM_OPS(tiadc_pm_ops, tiadc_suspend, tiadc_resume);
708 static const struct of_device_id ti_adc_dt_ids[] = {
709 { .compatible = "ti,am3359-adc", },
712 MODULE_DEVICE_TABLE(of, ti_adc_dt_ids);
714 static struct platform_driver tiadc_driver = {
716 .name = "TI-am335x-adc",
718 .of_match_table = ti_adc_dt_ids,
720 .probe = tiadc_probe,
721 .remove = tiadc_remove,
723 module_platform_driver(tiadc_driver);
725 MODULE_DESCRIPTION("TI ADC controller driver");
726 MODULE_AUTHOR("Rachna Patil <rachna@ti.com>");
727 MODULE_LICENSE("GPL");