blob: f6f08196564709f1adc18cf0c683811e85fc2a30 [file] [log] [blame]
Kyle Swenson8d8f6542021-03-15 11:02:55 -06001/*
2 * Xilinx XADC driver
3 *
4 * Copyright 2013 Analog Devices Inc.
5 * Author: Lars-Peter Clauen <lars@metafoo.de>
6 *
7 * Licensed under the GPL-2.
8 */
9
10#ifndef __IIO_XILINX_XADC__
11#define __IIO_XILINX_XADC__
12
13#include <linux/interrupt.h>
14#include <linux/mutex.h>
15#include <linux/spinlock.h>
16
17struct iio_dev;
18struct clk;
19struct xadc_ops;
20struct platform_device;
21
22void xadc_handle_events(struct iio_dev *indio_dev, unsigned long events);
23
24int xadc_read_event_config(struct iio_dev *indio_dev,
25 const struct iio_chan_spec *chan, enum iio_event_type type,
26 enum iio_event_direction dir);
27int xadc_write_event_config(struct iio_dev *indio_dev,
28 const struct iio_chan_spec *chan, enum iio_event_type type,
29 enum iio_event_direction dir, int state);
30int xadc_read_event_value(struct iio_dev *indio_dev,
31 const struct iio_chan_spec *chan, enum iio_event_type type,
32 enum iio_event_direction dir, enum iio_event_info info,
33 int *val, int *val2);
34int xadc_write_event_value(struct iio_dev *indio_dev,
35 const struct iio_chan_spec *chan, enum iio_event_type type,
36 enum iio_event_direction dir, enum iio_event_info info,
37 int val, int val2);
38
39enum xadc_external_mux_mode {
40 XADC_EXTERNAL_MUX_NONE,
41 XADC_EXTERNAL_MUX_SINGLE,
42 XADC_EXTERNAL_MUX_DUAL,
43};
44
45struct xadc {
46 void __iomem *base;
47 struct clk *clk;
48
49 const struct xadc_ops *ops;
50
51 uint16_t threshold[16];
52 uint16_t temp_hysteresis;
53 unsigned int alarm_mask;
54
55 uint16_t *data;
56
57 struct iio_trigger *trigger;
58 struct iio_trigger *convst_trigger;
59 struct iio_trigger *samplerate_trigger;
60
61 enum xadc_external_mux_mode external_mux_mode;
62
63 unsigned int zynq_masked_alarm;
64 unsigned int zynq_intmask;
65 struct delayed_work zynq_unmask_work;
66
67 struct mutex mutex;
68 spinlock_t lock;
69
70 struct completion completion;
71};
72
73struct xadc_ops {
74 int (*read)(struct xadc *, unsigned int, uint16_t *);
75 int (*write)(struct xadc *, unsigned int, uint16_t);
76 int (*setup)(struct platform_device *pdev, struct iio_dev *indio_dev,
77 int irq);
78 void (*update_alarm)(struct xadc *, unsigned int);
79 unsigned long (*get_dclk_rate)(struct xadc *);
80 irqreturn_t (*interrupt_handler)(int, void *);
81
82 unsigned int flags;
83};
84
85static inline int _xadc_read_adc_reg(struct xadc *xadc, unsigned int reg,
86 uint16_t *val)
87{
88 lockdep_assert_held(&xadc->mutex);
89 return xadc->ops->read(xadc, reg, val);
90}
91
92static inline int _xadc_write_adc_reg(struct xadc *xadc, unsigned int reg,
93 uint16_t val)
94{
95 lockdep_assert_held(&xadc->mutex);
96 return xadc->ops->write(xadc, reg, val);
97}
98
99static inline int xadc_read_adc_reg(struct xadc *xadc, unsigned int reg,
100 uint16_t *val)
101{
102 int ret;
103
104 mutex_lock(&xadc->mutex);
105 ret = _xadc_read_adc_reg(xadc, reg, val);
106 mutex_unlock(&xadc->mutex);
107 return ret;
108}
109
110static inline int xadc_write_adc_reg(struct xadc *xadc, unsigned int reg,
111 uint16_t val)
112{
113 int ret;
114
115 mutex_lock(&xadc->mutex);
116 ret = _xadc_write_adc_reg(xadc, reg, val);
117 mutex_unlock(&xadc->mutex);
118 return ret;
119}
120
121/* XADC hardmacro register definitions */
122#define XADC_REG_TEMP 0x00
123#define XADC_REG_VCCINT 0x01
124#define XADC_REG_VCCAUX 0x02
125#define XADC_REG_VPVN 0x03
126#define XADC_REG_VREFP 0x04
127#define XADC_REG_VREFN 0x05
128#define XADC_REG_VCCBRAM 0x06
129
130#define XADC_REG_VCCPINT 0x0d
131#define XADC_REG_VCCPAUX 0x0e
132#define XADC_REG_VCCO_DDR 0x0f
133#define XADC_REG_VAUX(x) (0x10 + (x))
134
135#define XADC_REG_MAX_TEMP 0x20
136#define XADC_REG_MAX_VCCINT 0x21
137#define XADC_REG_MAX_VCCAUX 0x22
138#define XADC_REG_MAX_VCCBRAM 0x23
139#define XADC_REG_MIN_TEMP 0x24
140#define XADC_REG_MIN_VCCINT 0x25
141#define XADC_REG_MIN_VCCAUX 0x26
142#define XADC_REG_MIN_VCCBRAM 0x27
143#define XADC_REG_MAX_VCCPINT 0x28
144#define XADC_REG_MAX_VCCPAUX 0x29
145#define XADC_REG_MAX_VCCO_DDR 0x2a
146#define XADC_REG_MIN_VCCPINT 0x2c
147#define XADC_REG_MIN_VCCPAUX 0x2d
148#define XADC_REG_MIN_VCCO_DDR 0x2e
149
150#define XADC_REG_CONF0 0x40
151#define XADC_REG_CONF1 0x41
152#define XADC_REG_CONF2 0x42
153#define XADC_REG_SEQ(x) (0x48 + (x))
154#define XADC_REG_INPUT_MODE(x) (0x4c + (x))
155#define XADC_REG_THRESHOLD(x) (0x50 + (x))
156
157#define XADC_REG_FLAG 0x3f
158
159#define XADC_CONF0_EC BIT(9)
160#define XADC_CONF0_ACQ BIT(8)
161#define XADC_CONF0_MUX BIT(11)
162#define XADC_CONF0_CHAN(x) (x)
163
164#define XADC_CONF1_SEQ_MASK (0xf << 12)
165#define XADC_CONF1_SEQ_DEFAULT (0 << 12)
166#define XADC_CONF1_SEQ_SINGLE_PASS (1 << 12)
167#define XADC_CONF1_SEQ_CONTINUOUS (2 << 12)
168#define XADC_CONF1_SEQ_SINGLE_CHANNEL (3 << 12)
169#define XADC_CONF1_SEQ_SIMULTANEOUS (4 << 12)
170#define XADC_CONF1_SEQ_INDEPENDENT (8 << 12)
171#define XADC_CONF1_ALARM_MASK 0x0f0f
172
173#define XADC_CONF2_DIV_MASK 0xff00
174#define XADC_CONF2_DIV_OFFSET 8
175
176#define XADC_CONF2_PD_MASK (0x3 << 4)
177#define XADC_CONF2_PD_NONE (0x0 << 4)
178#define XADC_CONF2_PD_ADC_B (0x2 << 4)
179#define XADC_CONF2_PD_BOTH (0x3 << 4)
180
181#define XADC_ALARM_TEMP_MASK BIT(0)
182#define XADC_ALARM_VCCINT_MASK BIT(1)
183#define XADC_ALARM_VCCAUX_MASK BIT(2)
184#define XADC_ALARM_OT_MASK BIT(3)
185#define XADC_ALARM_VCCBRAM_MASK BIT(4)
186#define XADC_ALARM_VCCPINT_MASK BIT(5)
187#define XADC_ALARM_VCCPAUX_MASK BIT(6)
188#define XADC_ALARM_VCCODDR_MASK BIT(7)
189
190#define XADC_THRESHOLD_TEMP_MAX 0x0
191#define XADC_THRESHOLD_VCCINT_MAX 0x1
192#define XADC_THRESHOLD_VCCAUX_MAX 0x2
193#define XADC_THRESHOLD_OT_MAX 0x3
194#define XADC_THRESHOLD_TEMP_MIN 0x4
195#define XADC_THRESHOLD_VCCINT_MIN 0x5
196#define XADC_THRESHOLD_VCCAUX_MIN 0x6
197#define XADC_THRESHOLD_OT_MIN 0x7
198#define XADC_THRESHOLD_VCCBRAM_MAX 0x8
199#define XADC_THRESHOLD_VCCPINT_MAX 0x9
200#define XADC_THRESHOLD_VCCPAUX_MAX 0xa
201#define XADC_THRESHOLD_VCCODDR_MAX 0xb
202#define XADC_THRESHOLD_VCCBRAM_MIN 0xc
203#define XADC_THRESHOLD_VCCPINT_MIN 0xd
204#define XADC_THRESHOLD_VCCPAUX_MIN 0xe
205#define XADC_THRESHOLD_VCCODDR_MIN 0xf
206
207#endif