4 * Copyright 2013-2014 Analog Devices Inc.
7 * Licensed under the GPL-2.
9 * Documentation for the parts can be found at:
10 * - XADC hardmacro: Xilinx UG480
11 * - ZYNQ XADC interface: Xilinx UG585
12 * - AXI XADC interface: Xilinx PG019
15 #include <linux/clk.h>
16 #include <linux/device.h>
17 #include <linux/err.h>
18 #include <linux/interrupt.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
23 #include <linux/platform_device.h>
24 #include <linux/slab.h>
25 #include <linux/sysfs.h>
27 #include <linux/iio/buffer.h>
28 #include <linux/iio/events.h>
29 #include <linux/iio/iio.h>
30 #include <linux/iio/sysfs.h>
31 #include <linux/iio/trigger.h>
32 #include <linux/iio/trigger_consumer.h>
33 #include <linux/iio/triggered_buffer.h>
35 #include "xilinx-xadc.h"
37 static const unsigned int XADC_ZYNQ_UNMASK_TIMEOUT = 500;
39 /* ZYNQ register definitions */
40 #define XADC_ZYNQ_REG_CFG 0x00
41 #define XADC_ZYNQ_REG_INTSTS 0x04
42 #define XADC_ZYNQ_REG_INTMSK 0x08
43 #define XADC_ZYNQ_REG_STATUS 0x0c
44 #define XADC_ZYNQ_REG_CFIFO 0x10
45 #define XADC_ZYNQ_REG_DFIFO 0x14
46 #define XADC_ZYNQ_REG_CTL 0x18
48 #define XADC_ZYNQ_CFG_ENABLE BIT(31)
49 #define XADC_ZYNQ_CFG_CFIFOTH_MASK (0xf << 20)
50 #define XADC_ZYNQ_CFG_CFIFOTH_OFFSET 20
51 #define XADC_ZYNQ_CFG_DFIFOTH_MASK (0xf << 16)
52 #define XADC_ZYNQ_CFG_DFIFOTH_OFFSET 16
53 #define XADC_ZYNQ_CFG_WEDGE BIT(13)
54 #define XADC_ZYNQ_CFG_REDGE BIT(12)
55 #define XADC_ZYNQ_CFG_TCKRATE_MASK (0x3 << 8)
56 #define XADC_ZYNQ_CFG_TCKRATE_DIV2 (0x0 << 8)
57 #define XADC_ZYNQ_CFG_TCKRATE_DIV4 (0x1 << 8)
58 #define XADC_ZYNQ_CFG_TCKRATE_DIV8 (0x2 << 8)
59 #define XADC_ZYNQ_CFG_TCKRATE_DIV16 (0x3 << 8)
60 #define XADC_ZYNQ_CFG_IGAP_MASK 0x1f
61 #define XADC_ZYNQ_CFG_IGAP(x) (x)
63 #define XADC_ZYNQ_INT_CFIFO_LTH BIT(9)
64 #define XADC_ZYNQ_INT_DFIFO_GTH BIT(8)
65 #define XADC_ZYNQ_INT_ALARM_MASK 0xff
66 #define XADC_ZYNQ_INT_ALARM_OFFSET 0
68 #define XADC_ZYNQ_STATUS_CFIFO_LVL_MASK (0xf << 16)
69 #define XADC_ZYNQ_STATUS_CFIFO_LVL_OFFSET 16
70 #define XADC_ZYNQ_STATUS_DFIFO_LVL_MASK (0xf << 12)
71 #define XADC_ZYNQ_STATUS_DFIFO_LVL_OFFSET 12
72 #define XADC_ZYNQ_STATUS_CFIFOF BIT(11)
73 #define XADC_ZYNQ_STATUS_CFIFOE BIT(10)
74 #define XADC_ZYNQ_STATUS_DFIFOF BIT(9)
75 #define XADC_ZYNQ_STATUS_DFIFOE BIT(8)
76 #define XADC_ZYNQ_STATUS_OT BIT(7)
77 #define XADC_ZYNQ_STATUS_ALM(x) BIT(x)
79 #define XADC_ZYNQ_CTL_RESET BIT(4)
81 #define XADC_ZYNQ_CMD_NOP 0x00
82 #define XADC_ZYNQ_CMD_READ 0x01
83 #define XADC_ZYNQ_CMD_WRITE 0x02
85 #define XADC_ZYNQ_CMD(cmd, addr, data) (((cmd) << 26) | ((addr) << 16) | (data))
87 /* AXI register definitions */
88 #define XADC_AXI_REG_RESET 0x00
89 #define XADC_AXI_REG_STATUS 0x04
90 #define XADC_AXI_REG_ALARM_STATUS 0x08
91 #define XADC_AXI_REG_CONVST 0x0c
92 #define XADC_AXI_REG_XADC_RESET 0x10
93 #define XADC_AXI_REG_GIER 0x5c
94 #define XADC_AXI_REG_IPISR 0x60
95 #define XADC_AXI_REG_IPIER 0x68
96 #define XADC_AXI_ADC_REG_OFFSET 0x200
98 #define XADC_AXI_RESET_MAGIC 0xa
99 #define XADC_AXI_GIER_ENABLE BIT(31)
101 #define XADC_AXI_INT_EOS BIT(4)
102 #define XADC_AXI_INT_ALARM_MASK 0x3c0f
104 #define XADC_FLAGS_BUFFERED BIT(0)
106 static void xadc_write_reg(struct xadc *xadc, unsigned int reg,
109 writel(val, xadc->base + reg);
112 static void xadc_read_reg(struct xadc *xadc, unsigned int reg,
115 *val = readl(xadc->base + reg);
119 * The ZYNQ interface uses two asynchronous FIFOs for communication with the
120 * XADC. Reads and writes to the XADC register are performed by submitting a
121 * request to the command FIFO (CFIFO), once the request has been completed the
122 * result can be read from the data FIFO (DFIFO). The method currently used in
123 * this driver is to submit the request for a read/write operation, then go to
124 * sleep and wait for an interrupt that signals that a response is available in
128 static void xadc_zynq_write_fifo(struct xadc *xadc, uint32_t *cmd,
133 for (i = 0; i < n; i++)
134 xadc_write_reg(xadc, XADC_ZYNQ_REG_CFIFO, cmd[i]);
137 static void xadc_zynq_drain_fifo(struct xadc *xadc)
139 uint32_t status, tmp;
141 xadc_read_reg(xadc, XADC_ZYNQ_REG_STATUS, &status);
143 while (!(status & XADC_ZYNQ_STATUS_DFIFOE)) {
144 xadc_read_reg(xadc, XADC_ZYNQ_REG_DFIFO, &tmp);
145 xadc_read_reg(xadc, XADC_ZYNQ_REG_STATUS, &status);
149 static void xadc_zynq_update_intmsk(struct xadc *xadc, unsigned int mask,
152 xadc->zynq_intmask &= ~mask;
153 xadc->zynq_intmask |= val;
155 xadc_write_reg(xadc, XADC_ZYNQ_REG_INTMSK,
156 xadc->zynq_intmask | xadc->zynq_masked_alarm);
159 static int xadc_zynq_write_adc_reg(struct xadc *xadc, unsigned int reg,
166 spin_lock_irq(&xadc->lock);
167 xadc_zynq_update_intmsk(xadc, XADC_ZYNQ_INT_DFIFO_GTH,
168 XADC_ZYNQ_INT_DFIFO_GTH);
170 reinit_completion(&xadc->completion);
172 cmd[0] = XADC_ZYNQ_CMD(XADC_ZYNQ_CMD_WRITE, reg, val);
173 xadc_zynq_write_fifo(xadc, cmd, ARRAY_SIZE(cmd));
174 xadc_read_reg(xadc, XADC_ZYNQ_REG_CFG, &tmp);
175 tmp &= ~XADC_ZYNQ_CFG_DFIFOTH_MASK;
176 tmp |= 0 << XADC_ZYNQ_CFG_DFIFOTH_OFFSET;
177 xadc_write_reg(xadc, XADC_ZYNQ_REG_CFG, tmp);
179 xadc_zynq_update_intmsk(xadc, XADC_ZYNQ_INT_DFIFO_GTH, 0);
180 spin_unlock_irq(&xadc->lock);
182 ret = wait_for_completion_interruptible_timeout(&xadc->completion, HZ);
188 xadc_read_reg(xadc, XADC_ZYNQ_REG_DFIFO, &tmp);
193 static int xadc_zynq_read_adc_reg(struct xadc *xadc, unsigned int reg,
200 cmd[0] = XADC_ZYNQ_CMD(XADC_ZYNQ_CMD_READ, reg, 0);
201 cmd[1] = XADC_ZYNQ_CMD(XADC_ZYNQ_CMD_NOP, 0, 0);
203 spin_lock_irq(&xadc->lock);
204 xadc_zynq_update_intmsk(xadc, XADC_ZYNQ_INT_DFIFO_GTH,
205 XADC_ZYNQ_INT_DFIFO_GTH);
206 xadc_zynq_drain_fifo(xadc);
207 reinit_completion(&xadc->completion);
209 xadc_zynq_write_fifo(xadc, cmd, ARRAY_SIZE(cmd));
210 xadc_read_reg(xadc, XADC_ZYNQ_REG_CFG, &tmp);
211 tmp &= ~XADC_ZYNQ_CFG_DFIFOTH_MASK;
212 tmp |= 1 << XADC_ZYNQ_CFG_DFIFOTH_OFFSET;
213 xadc_write_reg(xadc, XADC_ZYNQ_REG_CFG, tmp);
215 xadc_zynq_update_intmsk(xadc, XADC_ZYNQ_INT_DFIFO_GTH, 0);
216 spin_unlock_irq(&xadc->lock);
217 ret = wait_for_completion_interruptible_timeout(&xadc->completion, HZ);
223 xadc_read_reg(xadc, XADC_ZYNQ_REG_DFIFO, &resp);
224 xadc_read_reg(xadc, XADC_ZYNQ_REG_DFIFO, &resp);
226 *val = resp & 0xffff;
231 static unsigned int xadc_zynq_transform_alarm(unsigned int alarm)
233 return ((alarm & 0x80) >> 4) |
234 ((alarm & 0x78) << 1) |
239 * The ZYNQ threshold interrupts are level sensitive. Since we can't make the
240 * threshold condition go way from within the interrupt handler, this means as
241 * soon as a threshold condition is present we would enter the interrupt handler
242 * again and again. To work around this we mask all active thresholds interrupts
243 * in the interrupt handler and start a timer. In this timer we poll the
244 * interrupt status and only if the interrupt is inactive we unmask it again.
246 static void xadc_zynq_unmask_worker(struct work_struct *work)
248 struct xadc *xadc = container_of(work, struct xadc, zynq_unmask_work.work);
249 unsigned int misc_sts, unmask;
251 xadc_read_reg(xadc, XADC_ZYNQ_REG_STATUS, &misc_sts);
253 misc_sts &= XADC_ZYNQ_INT_ALARM_MASK;
255 spin_lock_irq(&xadc->lock);
257 /* Clear those bits which are not active anymore */
258 unmask = (xadc->zynq_masked_alarm ^ misc_sts) & xadc->zynq_masked_alarm;
259 xadc->zynq_masked_alarm &= misc_sts;
261 /* Also clear those which are masked out anyway */
262 xadc->zynq_masked_alarm &= ~xadc->zynq_intmask;
264 /* Clear the interrupts before we unmask them */
265 xadc_write_reg(xadc, XADC_ZYNQ_REG_INTSTS, unmask);
267 xadc_zynq_update_intmsk(xadc, 0, 0);
269 spin_unlock_irq(&xadc->lock);
271 /* if still pending some alarm re-trigger the timer */
272 if (xadc->zynq_masked_alarm) {
273 schedule_delayed_work(&xadc->zynq_unmask_work,
274 msecs_to_jiffies(XADC_ZYNQ_UNMASK_TIMEOUT));
278 static irqreturn_t xadc_zynq_threaded_interrupt_handler(int irq, void *devid)
280 struct iio_dev *indio_dev = devid;
281 struct xadc *xadc = iio_priv(indio_dev);
284 spin_lock_irq(&xadc->lock);
285 alarm = xadc->zynq_alarm;
286 xadc->zynq_alarm = 0;
287 spin_unlock_irq(&xadc->lock);
289 xadc_handle_events(indio_dev, xadc_zynq_transform_alarm(alarm));
291 /* unmask the required interrupts in timer. */
292 schedule_delayed_work(&xadc->zynq_unmask_work,
293 msecs_to_jiffies(XADC_ZYNQ_UNMASK_TIMEOUT));
298 static irqreturn_t xadc_zynq_interrupt_handler(int irq, void *devid)
300 struct iio_dev *indio_dev = devid;
301 struct xadc *xadc = iio_priv(indio_dev);
302 irqreturn_t ret = IRQ_HANDLED;
305 xadc_read_reg(xadc, XADC_ZYNQ_REG_INTSTS, &status);
307 status &= ~(xadc->zynq_intmask | xadc->zynq_masked_alarm);
312 spin_lock(&xadc->lock);
314 xadc_write_reg(xadc, XADC_ZYNQ_REG_INTSTS, status);
316 if (status & XADC_ZYNQ_INT_DFIFO_GTH) {
317 xadc_zynq_update_intmsk(xadc, XADC_ZYNQ_INT_DFIFO_GTH,
318 XADC_ZYNQ_INT_DFIFO_GTH);
319 complete(&xadc->completion);
322 status &= XADC_ZYNQ_INT_ALARM_MASK;
324 xadc->zynq_alarm |= status;
325 xadc->zynq_masked_alarm |= status;
327 * mask the current event interrupt,
328 * unmask it when the interrupt is no more active.
330 xadc_zynq_update_intmsk(xadc, 0, 0);
331 ret = IRQ_WAKE_THREAD;
333 spin_unlock(&xadc->lock);
338 #define XADC_ZYNQ_TCK_RATE_MAX 50000000
339 #define XADC_ZYNQ_IGAP_DEFAULT 20
341 static int xadc_zynq_setup(struct platform_device *pdev,
342 struct iio_dev *indio_dev, int irq)
344 struct xadc *xadc = iio_priv(indio_dev);
345 unsigned long pcap_rate;
346 unsigned int tck_div;
349 unsigned int tck_rate;
351 /* TODO: Figure out how to make igap and tck_rate configurable */
352 igap = XADC_ZYNQ_IGAP_DEFAULT;
353 tck_rate = XADC_ZYNQ_TCK_RATE_MAX;
355 xadc->zynq_intmask = ~0;
357 pcap_rate = clk_get_rate(xadc->clk);
359 if (tck_rate > XADC_ZYNQ_TCK_RATE_MAX)
360 tck_rate = XADC_ZYNQ_TCK_RATE_MAX;
361 if (tck_rate > pcap_rate / 2) {
364 div = pcap_rate / tck_rate;
365 if (pcap_rate / div > XADC_ZYNQ_TCK_RATE_MAX)
370 tck_div = XADC_ZYNQ_CFG_TCKRATE_DIV2;
372 tck_div = XADC_ZYNQ_CFG_TCKRATE_DIV4;
374 tck_div = XADC_ZYNQ_CFG_TCKRATE_DIV8;
376 tck_div = XADC_ZYNQ_CFG_TCKRATE_DIV16;
378 xadc_write_reg(xadc, XADC_ZYNQ_REG_CTL, XADC_ZYNQ_CTL_RESET);
379 xadc_write_reg(xadc, XADC_ZYNQ_REG_CTL, 0);
380 xadc_write_reg(xadc, XADC_ZYNQ_REG_INTSTS, ~0);
381 xadc_write_reg(xadc, XADC_ZYNQ_REG_INTMSK, xadc->zynq_intmask);
382 xadc_write_reg(xadc, XADC_ZYNQ_REG_CFG, XADC_ZYNQ_CFG_ENABLE |
383 XADC_ZYNQ_CFG_REDGE | XADC_ZYNQ_CFG_WEDGE |
384 tck_div | XADC_ZYNQ_CFG_IGAP(igap));
389 static unsigned long xadc_zynq_get_dclk_rate(struct xadc *xadc)
394 xadc_read_reg(xadc, XADC_ZYNQ_REG_CFG, &val);
396 switch (val & XADC_ZYNQ_CFG_TCKRATE_MASK) {
397 case XADC_ZYNQ_CFG_TCKRATE_DIV4:
400 case XADC_ZYNQ_CFG_TCKRATE_DIV8:
403 case XADC_ZYNQ_CFG_TCKRATE_DIV16:
411 return clk_get_rate(xadc->clk) / div;
414 static void xadc_zynq_update_alarm(struct xadc *xadc, unsigned int alarm)
419 /* Move OT to bit 7 */
420 alarm = ((alarm & 0x08) << 4) | ((alarm & 0xf0) >> 1) | (alarm & 0x07);
422 spin_lock_irqsave(&xadc->lock, flags);
424 /* Clear previous interrupts if any. */
425 xadc_read_reg(xadc, XADC_ZYNQ_REG_INTSTS, &status);
426 xadc_write_reg(xadc, XADC_ZYNQ_REG_INTSTS, status & alarm);
428 xadc_zynq_update_intmsk(xadc, XADC_ZYNQ_INT_ALARM_MASK,
429 ~alarm & XADC_ZYNQ_INT_ALARM_MASK);
431 spin_unlock_irqrestore(&xadc->lock, flags);
434 static const struct xadc_ops xadc_zynq_ops = {
435 .read = xadc_zynq_read_adc_reg,
436 .write = xadc_zynq_write_adc_reg,
437 .setup = xadc_zynq_setup,
438 .get_dclk_rate = xadc_zynq_get_dclk_rate,
439 .interrupt_handler = xadc_zynq_interrupt_handler,
440 .threaded_interrupt_handler = xadc_zynq_threaded_interrupt_handler,
441 .update_alarm = xadc_zynq_update_alarm,
444 static int xadc_axi_read_adc_reg(struct xadc *xadc, unsigned int reg,
449 xadc_read_reg(xadc, XADC_AXI_ADC_REG_OFFSET + reg * 4, &val32);
450 *val = val32 & 0xffff;
455 static int xadc_axi_write_adc_reg(struct xadc *xadc, unsigned int reg,
458 xadc_write_reg(xadc, XADC_AXI_ADC_REG_OFFSET + reg * 4, val);
463 static int xadc_axi_setup(struct platform_device *pdev,
464 struct iio_dev *indio_dev, int irq)
466 struct xadc *xadc = iio_priv(indio_dev);
468 xadc_write_reg(xadc, XADC_AXI_REG_RESET, XADC_AXI_RESET_MAGIC);
469 xadc_write_reg(xadc, XADC_AXI_REG_GIER, XADC_AXI_GIER_ENABLE);
474 static irqreturn_t xadc_axi_interrupt_handler(int irq, void *devid)
476 struct iio_dev *indio_dev = devid;
477 struct xadc *xadc = iio_priv(indio_dev);
478 uint32_t status, mask;
481 xadc_read_reg(xadc, XADC_AXI_REG_IPISR, &status);
482 xadc_read_reg(xadc, XADC_AXI_REG_IPIER, &mask);
488 if ((status & XADC_AXI_INT_EOS) && xadc->trigger)
489 iio_trigger_poll(xadc->trigger);
491 if (status & XADC_AXI_INT_ALARM_MASK) {
493 * The order of the bits in the AXI-XADC status register does
494 * not match the order of the bits in the XADC alarm enable
495 * register. xadc_handle_events() expects the events to be in
496 * the same order as the XADC alarm enable register.
498 events = (status & 0x000e) >> 1;
499 events |= (status & 0x0001) << 3;
500 events |= (status & 0x3c00) >> 6;
501 xadc_handle_events(indio_dev, events);
504 xadc_write_reg(xadc, XADC_AXI_REG_IPISR, status);
509 static void xadc_axi_update_alarm(struct xadc *xadc, unsigned int alarm)
515 * The order of the bits in the AXI-XADC status register does not match
516 * the order of the bits in the XADC alarm enable register. We get
517 * passed the alarm mask in the same order as in the XADC alarm enable
520 alarm = ((alarm & 0x07) << 1) | ((alarm & 0x08) >> 3) |
521 ((alarm & 0xf0) << 6);
523 spin_lock_irqsave(&xadc->lock, flags);
524 xadc_read_reg(xadc, XADC_AXI_REG_IPIER, &val);
525 val &= ~XADC_AXI_INT_ALARM_MASK;
527 xadc_write_reg(xadc, XADC_AXI_REG_IPIER, val);
528 spin_unlock_irqrestore(&xadc->lock, flags);
531 static unsigned long xadc_axi_get_dclk(struct xadc *xadc)
533 return clk_get_rate(xadc->clk);
536 static const struct xadc_ops xadc_axi_ops = {
537 .read = xadc_axi_read_adc_reg,
538 .write = xadc_axi_write_adc_reg,
539 .setup = xadc_axi_setup,
540 .get_dclk_rate = xadc_axi_get_dclk,
541 .update_alarm = xadc_axi_update_alarm,
542 .interrupt_handler = xadc_axi_interrupt_handler,
543 .flags = XADC_FLAGS_BUFFERED,
546 static int _xadc_update_adc_reg(struct xadc *xadc, unsigned int reg,
547 uint16_t mask, uint16_t val)
552 ret = _xadc_read_adc_reg(xadc, reg, &tmp);
556 return _xadc_write_adc_reg(xadc, reg, (tmp & ~mask) | val);
559 static int xadc_update_adc_reg(struct xadc *xadc, unsigned int reg,
560 uint16_t mask, uint16_t val)
564 mutex_lock(&xadc->mutex);
565 ret = _xadc_update_adc_reg(xadc, reg, mask, val);
566 mutex_unlock(&xadc->mutex);
571 static unsigned long xadc_get_dclk_rate(struct xadc *xadc)
573 return xadc->ops->get_dclk_rate(xadc);
576 static int xadc_update_scan_mode(struct iio_dev *indio_dev,
577 const unsigned long *mask)
579 struct xadc *xadc = iio_priv(indio_dev);
582 n = bitmap_weight(mask, indio_dev->masklength);
585 xadc->data = kcalloc(n, sizeof(*xadc->data), GFP_KERNEL);
592 static unsigned int xadc_scan_index_to_channel(unsigned int scan_index)
594 switch (scan_index) {
596 return XADC_REG_VCCPINT;
598 return XADC_REG_VCCPAUX;
600 return XADC_REG_VCCO_DDR;
602 return XADC_REG_TEMP;
604 return XADC_REG_VCCINT;
606 return XADC_REG_VCCAUX;
608 return XADC_REG_VPVN;
610 return XADC_REG_VREFP;
612 return XADC_REG_VREFN;
614 return XADC_REG_VCCBRAM;
616 return XADC_REG_VAUX(scan_index - 16);
620 static irqreturn_t xadc_trigger_handler(int irq, void *p)
622 struct iio_poll_func *pf = p;
623 struct iio_dev *indio_dev = pf->indio_dev;
624 struct xadc *xadc = iio_priv(indio_dev);
632 for_each_set_bit(i, indio_dev->active_scan_mask,
633 indio_dev->masklength) {
634 chan = xadc_scan_index_to_channel(i);
635 xadc_read_adc_reg(xadc, chan, &xadc->data[j]);
639 iio_push_to_buffers(indio_dev, xadc->data);
642 iio_trigger_notify_done(indio_dev->trig);
647 static int xadc_trigger_set_state(struct iio_trigger *trigger, bool state)
649 struct xadc *xadc = iio_trigger_get_drvdata(trigger);
655 mutex_lock(&xadc->mutex);
658 /* Only one of the two triggers can be active at the a time. */
659 if (xadc->trigger != NULL) {
663 xadc->trigger = trigger;
664 if (trigger == xadc->convst_trigger)
665 convst = XADC_CONF0_EC;
669 ret = _xadc_update_adc_reg(xadc, XADC_REG_CONF1, XADC_CONF0_EC,
674 xadc->trigger = NULL;
677 spin_lock_irqsave(&xadc->lock, flags);
678 xadc_read_reg(xadc, XADC_AXI_REG_IPIER, &val);
679 xadc_write_reg(xadc, XADC_AXI_REG_IPISR, val & XADC_AXI_INT_EOS);
681 val |= XADC_AXI_INT_EOS;
683 val &= ~XADC_AXI_INT_EOS;
684 xadc_write_reg(xadc, XADC_AXI_REG_IPIER, val);
685 spin_unlock_irqrestore(&xadc->lock, flags);
688 mutex_unlock(&xadc->mutex);
693 static const struct iio_trigger_ops xadc_trigger_ops = {
694 .owner = THIS_MODULE,
695 .set_trigger_state = &xadc_trigger_set_state,
698 static struct iio_trigger *xadc_alloc_trigger(struct iio_dev *indio_dev,
701 struct iio_trigger *trig;
704 trig = iio_trigger_alloc("%s%d-%s", indio_dev->name,
705 indio_dev->id, name);
707 return ERR_PTR(-ENOMEM);
709 trig->dev.parent = indio_dev->dev.parent;
710 trig->ops = &xadc_trigger_ops;
711 iio_trigger_set_drvdata(trig, iio_priv(indio_dev));
713 ret = iio_trigger_register(trig);
715 goto error_free_trig;
720 iio_trigger_free(trig);
724 static int xadc_power_adc_b(struct xadc *xadc, unsigned int seq_mode)
729 case XADC_CONF1_SEQ_SIMULTANEOUS:
730 case XADC_CONF1_SEQ_INDEPENDENT:
731 val = XADC_CONF2_PD_ADC_B;
738 return xadc_update_adc_reg(xadc, XADC_REG_CONF2, XADC_CONF2_PD_MASK,
742 static int xadc_get_seq_mode(struct xadc *xadc, unsigned long scan_mode)
744 unsigned int aux_scan_mode = scan_mode >> 16;
746 if (xadc->external_mux_mode == XADC_EXTERNAL_MUX_DUAL)
747 return XADC_CONF1_SEQ_SIMULTANEOUS;
749 if ((aux_scan_mode & 0xff00) == 0 ||
750 (aux_scan_mode & 0x00ff) == 0)
751 return XADC_CONF1_SEQ_CONTINUOUS;
753 return XADC_CONF1_SEQ_SIMULTANEOUS;
756 static int xadc_postdisable(struct iio_dev *indio_dev)
758 struct xadc *xadc = iio_priv(indio_dev);
759 unsigned long scan_mask;
763 scan_mask = 1; /* Run calibration as part of the sequence */
764 for (i = 0; i < indio_dev->num_channels; i++)
765 scan_mask |= BIT(indio_dev->channels[i].scan_index);
767 /* Enable all channels and calibration */
768 ret = xadc_write_adc_reg(xadc, XADC_REG_SEQ(0), scan_mask & 0xffff);
772 ret = xadc_write_adc_reg(xadc, XADC_REG_SEQ(1), scan_mask >> 16);
776 ret = xadc_update_adc_reg(xadc, XADC_REG_CONF1, XADC_CONF1_SEQ_MASK,
777 XADC_CONF1_SEQ_CONTINUOUS);
781 return xadc_power_adc_b(xadc, XADC_CONF1_SEQ_CONTINUOUS);
784 static int xadc_preenable(struct iio_dev *indio_dev)
786 struct xadc *xadc = iio_priv(indio_dev);
787 unsigned long scan_mask;
791 ret = xadc_update_adc_reg(xadc, XADC_REG_CONF1, XADC_CONF1_SEQ_MASK,
792 XADC_CONF1_SEQ_DEFAULT);
796 scan_mask = *indio_dev->active_scan_mask;
797 seq_mode = xadc_get_seq_mode(xadc, scan_mask);
799 ret = xadc_write_adc_reg(xadc, XADC_REG_SEQ(0), scan_mask & 0xffff);
803 ret = xadc_write_adc_reg(xadc, XADC_REG_SEQ(1), scan_mask >> 16);
807 ret = xadc_power_adc_b(xadc, seq_mode);
811 ret = xadc_update_adc_reg(xadc, XADC_REG_CONF1, XADC_CONF1_SEQ_MASK,
818 xadc_postdisable(indio_dev);
822 static struct iio_buffer_setup_ops xadc_buffer_ops = {
823 .preenable = &xadc_preenable,
824 .postenable = &iio_triggered_buffer_postenable,
825 .predisable = &iio_triggered_buffer_predisable,
826 .postdisable = &xadc_postdisable,
829 static int xadc_read_raw(struct iio_dev *indio_dev,
830 struct iio_chan_spec const *chan, int *val, int *val2, long info)
832 struct xadc *xadc = iio_priv(indio_dev);
838 case IIO_CHAN_INFO_RAW:
839 if (iio_buffer_enabled(indio_dev))
841 ret = xadc_read_adc_reg(xadc, chan->address, &val16);
846 if (chan->scan_type.sign == 'u')
849 *val = sign_extend32(val16, 11);
852 case IIO_CHAN_INFO_SCALE:
853 switch (chan->type) {
855 /* V = (val * 3.0) / 4096 */
856 switch (chan->address) {
857 case XADC_REG_VCCINT:
858 case XADC_REG_VCCAUX:
860 case XADC_REG_VCCBRAM:
861 case XADC_REG_VCCPINT:
862 case XADC_REG_VCCPAUX:
863 case XADC_REG_VCCO_DDR:
871 return IIO_VAL_FRACTIONAL_LOG2;
873 /* Temp in C = (val * 503.975) / 4096 - 273.15 */
876 return IIO_VAL_FRACTIONAL_LOG2;
880 case IIO_CHAN_INFO_OFFSET:
881 /* Only the temperature channel has an offset */
882 *val = -((273150 << 12) / 503975);
884 case IIO_CHAN_INFO_SAMP_FREQ:
885 ret = xadc_read_adc_reg(xadc, XADC_REG_CONF2, &val16);
889 div = (val16 & XADC_CONF2_DIV_MASK) >> XADC_CONF2_DIV_OFFSET;
893 *val = xadc_get_dclk_rate(xadc) / div / 26;
901 static int xadc_write_raw(struct iio_dev *indio_dev,
902 struct iio_chan_spec const *chan, int val, int val2, long info)
904 struct xadc *xadc = iio_priv(indio_dev);
905 unsigned long clk_rate = xadc_get_dclk_rate(xadc);
908 if (info != IIO_CHAN_INFO_SAMP_FREQ)
925 * We want to round down, but only if we do not exceed the 150 kSPS
928 div = clk_rate / val;
929 if (clk_rate / div / 26 > 150000)
936 return xadc_update_adc_reg(xadc, XADC_REG_CONF2, XADC_CONF2_DIV_MASK,
937 div << XADC_CONF2_DIV_OFFSET);
940 static const struct iio_event_spec xadc_temp_events[] = {
942 .type = IIO_EV_TYPE_THRESH,
943 .dir = IIO_EV_DIR_RISING,
944 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
945 BIT(IIO_EV_INFO_VALUE) |
946 BIT(IIO_EV_INFO_HYSTERESIS),
950 /* Separate values for upper and lower thresholds, but only a shared enabled */
951 static const struct iio_event_spec xadc_voltage_events[] = {
953 .type = IIO_EV_TYPE_THRESH,
954 .dir = IIO_EV_DIR_RISING,
955 .mask_separate = BIT(IIO_EV_INFO_VALUE),
957 .type = IIO_EV_TYPE_THRESH,
958 .dir = IIO_EV_DIR_FALLING,
959 .mask_separate = BIT(IIO_EV_INFO_VALUE),
961 .type = IIO_EV_TYPE_THRESH,
962 .dir = IIO_EV_DIR_EITHER,
963 .mask_separate = BIT(IIO_EV_INFO_ENABLE),
967 #define XADC_CHAN_TEMP(_chan, _scan_index, _addr) { \
970 .channel = (_chan), \
971 .address = (_addr), \
972 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
973 BIT(IIO_CHAN_INFO_SCALE) | \
974 BIT(IIO_CHAN_INFO_OFFSET), \
975 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ), \
976 .event_spec = xadc_temp_events, \
977 .num_event_specs = ARRAY_SIZE(xadc_temp_events), \
978 .scan_index = (_scan_index), \
984 .endianness = IIO_CPU, \
988 #define XADC_CHAN_VOLTAGE(_chan, _scan_index, _addr, _ext, _alarm) { \
989 .type = IIO_VOLTAGE, \
991 .channel = (_chan), \
992 .address = (_addr), \
993 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
994 BIT(IIO_CHAN_INFO_SCALE), \
995 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ), \
996 .event_spec = (_alarm) ? xadc_voltage_events : NULL, \
997 .num_event_specs = (_alarm) ? ARRAY_SIZE(xadc_voltage_events) : 0, \
998 .scan_index = (_scan_index), \
1000 .sign = ((_addr) == XADC_REG_VREFN) ? 's' : 'u', \
1002 .storagebits = 16, \
1004 .endianness = IIO_CPU, \
1006 .extend_name = _ext, \
1009 static const struct iio_chan_spec xadc_channels[] = {
1010 XADC_CHAN_TEMP(0, 8, XADC_REG_TEMP),
1011 XADC_CHAN_VOLTAGE(0, 9, XADC_REG_VCCINT, "vccint", true),
1012 XADC_CHAN_VOLTAGE(1, 10, XADC_REG_VCCAUX, "vccaux", true),
1013 XADC_CHAN_VOLTAGE(2, 14, XADC_REG_VCCBRAM, "vccbram", true),
1014 XADC_CHAN_VOLTAGE(3, 5, XADC_REG_VCCPINT, "vccpint", true),
1015 XADC_CHAN_VOLTAGE(4, 6, XADC_REG_VCCPAUX, "vccpaux", true),
1016 XADC_CHAN_VOLTAGE(5, 7, XADC_REG_VCCO_DDR, "vccoddr", true),
1017 XADC_CHAN_VOLTAGE(6, 12, XADC_REG_VREFP, "vrefp", false),
1018 XADC_CHAN_VOLTAGE(7, 13, XADC_REG_VREFN, "vrefn", false),
1019 XADC_CHAN_VOLTAGE(8, 11, XADC_REG_VPVN, NULL, false),
1020 XADC_CHAN_VOLTAGE(9, 16, XADC_REG_VAUX(0), NULL, false),
1021 XADC_CHAN_VOLTAGE(10, 17, XADC_REG_VAUX(1), NULL, false),
1022 XADC_CHAN_VOLTAGE(11, 18, XADC_REG_VAUX(2), NULL, false),
1023 XADC_CHAN_VOLTAGE(12, 19, XADC_REG_VAUX(3), NULL, false),
1024 XADC_CHAN_VOLTAGE(13, 20, XADC_REG_VAUX(4), NULL, false),
1025 XADC_CHAN_VOLTAGE(14, 21, XADC_REG_VAUX(5), NULL, false),
1026 XADC_CHAN_VOLTAGE(15, 22, XADC_REG_VAUX(6), NULL, false),
1027 XADC_CHAN_VOLTAGE(16, 23, XADC_REG_VAUX(7), NULL, false),
1028 XADC_CHAN_VOLTAGE(17, 24, XADC_REG_VAUX(8), NULL, false),
1029 XADC_CHAN_VOLTAGE(18, 25, XADC_REG_VAUX(9), NULL, false),
1030 XADC_CHAN_VOLTAGE(19, 26, XADC_REG_VAUX(10), NULL, false),
1031 XADC_CHAN_VOLTAGE(20, 27, XADC_REG_VAUX(11), NULL, false),
1032 XADC_CHAN_VOLTAGE(21, 28, XADC_REG_VAUX(12), NULL, false),
1033 XADC_CHAN_VOLTAGE(22, 29, XADC_REG_VAUX(13), NULL, false),
1034 XADC_CHAN_VOLTAGE(23, 30, XADC_REG_VAUX(14), NULL, false),
1035 XADC_CHAN_VOLTAGE(24, 31, XADC_REG_VAUX(15), NULL, false),
1038 static const struct iio_info xadc_info = {
1039 .read_raw = &xadc_read_raw,
1040 .write_raw = &xadc_write_raw,
1041 .read_event_config = &xadc_read_event_config,
1042 .write_event_config = &xadc_write_event_config,
1043 .read_event_value = &xadc_read_event_value,
1044 .write_event_value = &xadc_write_event_value,
1045 .update_scan_mode = &xadc_update_scan_mode,
1046 .driver_module = THIS_MODULE,
1049 static const struct of_device_id xadc_of_match_table[] = {
1050 { .compatible = "xlnx,zynq-xadc-1.00.a", (void *)&xadc_zynq_ops },
1051 { .compatible = "xlnx,axi-xadc-1.00.a", (void *)&xadc_axi_ops },
1054 MODULE_DEVICE_TABLE(of, xadc_of_match_table);
1056 static int xadc_parse_dt(struct iio_dev *indio_dev, struct device_node *np,
1059 struct xadc *xadc = iio_priv(indio_dev);
1060 struct iio_chan_spec *channels, *chan;
1061 struct device_node *chan_node, *child;
1062 unsigned int num_channels;
1063 const char *external_mux;
1070 ret = of_property_read_string(np, "xlnx,external-mux", &external_mux);
1071 if (ret < 0 || strcasecmp(external_mux, "none") == 0)
1072 xadc->external_mux_mode = XADC_EXTERNAL_MUX_NONE;
1073 else if (strcasecmp(external_mux, "single") == 0)
1074 xadc->external_mux_mode = XADC_EXTERNAL_MUX_SINGLE;
1075 else if (strcasecmp(external_mux, "dual") == 0)
1076 xadc->external_mux_mode = XADC_EXTERNAL_MUX_DUAL;
1080 if (xadc->external_mux_mode != XADC_EXTERNAL_MUX_NONE) {
1081 ret = of_property_read_u32(np, "xlnx,external-mux-channel",
1086 if (xadc->external_mux_mode == XADC_EXTERNAL_MUX_SINGLE) {
1087 if (ext_mux_chan == 0)
1088 ext_mux_chan = XADC_REG_VPVN;
1089 else if (ext_mux_chan <= 16)
1090 ext_mux_chan = XADC_REG_VAUX(ext_mux_chan - 1);
1094 if (ext_mux_chan > 0 && ext_mux_chan <= 8)
1095 ext_mux_chan = XADC_REG_VAUX(ext_mux_chan - 1);
1100 *conf |= XADC_CONF0_MUX | XADC_CONF0_CHAN(ext_mux_chan);
1103 channels = kmemdup(xadc_channels, sizeof(xadc_channels), GFP_KERNEL);
1108 chan = &channels[9];
1110 chan_node = of_get_child_by_name(np, "xlnx,channels");
1112 for_each_child_of_node(chan_node, child) {
1113 if (num_channels >= ARRAY_SIZE(xadc_channels)) {
1118 ret = of_property_read_u32(child, "reg", ®);
1119 if (ret || reg > 16)
1122 if (of_property_read_bool(child, "xlnx,bipolar"))
1123 chan->scan_type.sign = 's';
1126 chan->scan_index = 11;
1127 chan->address = XADC_REG_VPVN;
1129 chan->scan_index = 15 + reg;
1130 chan->address = XADC_REG_VAUX(reg - 1);
1136 of_node_put(chan_node);
1138 indio_dev->num_channels = num_channels;
1139 indio_dev->channels = krealloc(channels, sizeof(*channels) *
1140 num_channels, GFP_KERNEL);
1141 /* If we can't resize the channels array, just use the original */
1142 if (!indio_dev->channels)
1143 indio_dev->channels = channels;
1148 static int xadc_probe(struct platform_device *pdev)
1150 const struct of_device_id *id;
1151 struct iio_dev *indio_dev;
1152 unsigned int bipolar_mask;
1153 struct resource *mem;
1160 if (!pdev->dev.of_node)
1163 id = of_match_node(xadc_of_match_table, pdev->dev.of_node);
1167 irq = platform_get_irq(pdev, 0);
1171 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*xadc));
1175 xadc = iio_priv(indio_dev);
1176 xadc->ops = id->data;
1177 init_completion(&xadc->completion);
1178 mutex_init(&xadc->mutex);
1179 spin_lock_init(&xadc->lock);
1180 INIT_DELAYED_WORK(&xadc->zynq_unmask_work, xadc_zynq_unmask_worker);
1182 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1183 xadc->base = devm_ioremap_resource(&pdev->dev, mem);
1184 if (IS_ERR(xadc->base))
1185 return PTR_ERR(xadc->base);
1187 indio_dev->dev.parent = &pdev->dev;
1188 indio_dev->dev.of_node = pdev->dev.of_node;
1189 indio_dev->name = "xadc";
1190 indio_dev->modes = INDIO_DIRECT_MODE;
1191 indio_dev->info = &xadc_info;
1193 ret = xadc_parse_dt(indio_dev, pdev->dev.of_node, &conf0);
1195 goto err_device_free;
1197 if (xadc->ops->flags & XADC_FLAGS_BUFFERED) {
1198 ret = iio_triggered_buffer_setup(indio_dev,
1199 &iio_pollfunc_store_time, &xadc_trigger_handler,
1202 goto err_device_free;
1204 xadc->convst_trigger = xadc_alloc_trigger(indio_dev, "convst");
1205 if (IS_ERR(xadc->convst_trigger)) {
1206 ret = PTR_ERR(xadc->convst_trigger);
1207 goto err_triggered_buffer_cleanup;
1209 xadc->samplerate_trigger = xadc_alloc_trigger(indio_dev,
1211 if (IS_ERR(xadc->samplerate_trigger)) {
1212 ret = PTR_ERR(xadc->samplerate_trigger);
1213 goto err_free_convst_trigger;
1217 xadc->clk = devm_clk_get(&pdev->dev, NULL);
1218 if (IS_ERR(xadc->clk)) {
1219 ret = PTR_ERR(xadc->clk);
1220 goto err_free_samplerate_trigger;
1222 clk_prepare_enable(xadc->clk);
1224 ret = xadc->ops->setup(pdev, indio_dev, irq);
1226 goto err_free_samplerate_trigger;
1228 ret = request_threaded_irq(irq, xadc->ops->interrupt_handler,
1229 xadc->ops->threaded_interrupt_handler,
1230 0, dev_name(&pdev->dev), indio_dev);
1232 goto err_clk_disable_unprepare;
1234 for (i = 0; i < 16; i++)
1235 xadc_read_adc_reg(xadc, XADC_REG_THRESHOLD(i),
1236 &xadc->threshold[i]);
1238 ret = xadc_write_adc_reg(xadc, XADC_REG_CONF0, conf0);
1243 for (i = 0; i < indio_dev->num_channels; i++) {
1244 if (indio_dev->channels[i].scan_type.sign == 's')
1245 bipolar_mask |= BIT(indio_dev->channels[i].scan_index);
1248 ret = xadc_write_adc_reg(xadc, XADC_REG_INPUT_MODE(0), bipolar_mask);
1251 ret = xadc_write_adc_reg(xadc, XADC_REG_INPUT_MODE(1),
1252 bipolar_mask >> 16);
1256 /* Disable all alarms */
1257 xadc_update_adc_reg(xadc, XADC_REG_CONF1, XADC_CONF1_ALARM_MASK,
1258 XADC_CONF1_ALARM_MASK);
1260 /* Set thresholds to min/max */
1261 for (i = 0; i < 16; i++) {
1263 * Set max voltage threshold and both temperature thresholds to
1264 * 0xffff, min voltage threshold to 0.
1266 if (i % 8 < 4 || i == 7)
1267 xadc->threshold[i] = 0xffff;
1269 xadc->threshold[i] = 0;
1270 xadc_write_adc_reg(xadc, XADC_REG_THRESHOLD(i),
1271 xadc->threshold[i]);
1274 /* Go to non-buffered mode */
1275 xadc_postdisable(indio_dev);
1277 ret = iio_device_register(indio_dev);
1281 platform_set_drvdata(pdev, indio_dev);
1286 free_irq(irq, indio_dev);
1287 err_free_samplerate_trigger:
1288 if (xadc->ops->flags & XADC_FLAGS_BUFFERED)
1289 iio_trigger_free(xadc->samplerate_trigger);
1290 err_free_convst_trigger:
1291 if (xadc->ops->flags & XADC_FLAGS_BUFFERED)
1292 iio_trigger_free(xadc->convst_trigger);
1293 err_triggered_buffer_cleanup:
1294 if (xadc->ops->flags & XADC_FLAGS_BUFFERED)
1295 iio_triggered_buffer_cleanup(indio_dev);
1296 err_clk_disable_unprepare:
1297 clk_disable_unprepare(xadc->clk);
1299 kfree(indio_dev->channels);
1304 static int xadc_remove(struct platform_device *pdev)
1306 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
1307 struct xadc *xadc = iio_priv(indio_dev);
1308 int irq = platform_get_irq(pdev, 0);
1310 iio_device_unregister(indio_dev);
1311 if (xadc->ops->flags & XADC_FLAGS_BUFFERED) {
1312 iio_trigger_free(xadc->samplerate_trigger);
1313 iio_trigger_free(xadc->convst_trigger);
1314 iio_triggered_buffer_cleanup(indio_dev);
1316 free_irq(irq, indio_dev);
1317 clk_disable_unprepare(xadc->clk);
1318 cancel_delayed_work(&xadc->zynq_unmask_work);
1320 kfree(indio_dev->channels);
1325 static struct platform_driver xadc_driver = {
1326 .probe = xadc_probe,
1327 .remove = xadc_remove,
1330 .of_match_table = xadc_of_match_table,
1333 module_platform_driver(xadc_driver);
1335 MODULE_LICENSE("GPL v2");
1337 MODULE_DESCRIPTION("Xilinx XADC IIO driver");