2 * Amlogic Meson Successive Approximation Register (SAR) A/D Converter
4 * Copyright (C) 2017 Martin Blumenstingl <martin.blumenstingl@googlemail.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * You should have received a copy of the GNU General Public License
11 * along with this program. If not, see <http://www.gnu.org/licenses/>.
14 #include <linux/bitfield.h>
15 #include <linux/clk.h>
16 #include <linux/clk-provider.h>
17 #include <linux/delay.h>
19 #include <linux/iio/iio.h>
20 #include <linux/module.h>
21 #include <linux/interrupt.h>
23 #include <linux/of_irq.h>
24 #include <linux/of_device.h>
25 #include <linux/platform_device.h>
26 #include <linux/regmap.h>
27 #include <linux/regulator/consumer.h>
29 #define MESON_SAR_ADC_REG0 0x00
30 #define MESON_SAR_ADC_REG0_PANEL_DETECT BIT(31)
31 #define MESON_SAR_ADC_REG0_BUSY_MASK GENMASK(30, 28)
32 #define MESON_SAR_ADC_REG0_DELTA_BUSY BIT(30)
33 #define MESON_SAR_ADC_REG0_AVG_BUSY BIT(29)
34 #define MESON_SAR_ADC_REG0_SAMPLE_BUSY BIT(28)
35 #define MESON_SAR_ADC_REG0_FIFO_FULL BIT(27)
36 #define MESON_SAR_ADC_REG0_FIFO_EMPTY BIT(26)
37 #define MESON_SAR_ADC_REG0_FIFO_COUNT_MASK GENMASK(25, 21)
38 #define MESON_SAR_ADC_REG0_ADC_BIAS_CTRL_MASK GENMASK(20, 19)
39 #define MESON_SAR_ADC_REG0_CURR_CHAN_ID_MASK GENMASK(18, 16)
40 #define MESON_SAR_ADC_REG0_ADC_TEMP_SEN_SEL BIT(15)
41 #define MESON_SAR_ADC_REG0_SAMPLING_STOP BIT(14)
42 #define MESON_SAR_ADC_REG0_CHAN_DELTA_EN_MASK GENMASK(13, 12)
43 #define MESON_SAR_ADC_REG0_DETECT_IRQ_POL BIT(10)
44 #define MESON_SAR_ADC_REG0_DETECT_IRQ_EN BIT(9)
45 #define MESON_SAR_ADC_REG0_FIFO_CNT_IRQ_MASK GENMASK(8, 4)
46 #define MESON_SAR_ADC_REG0_FIFO_IRQ_EN BIT(3)
47 #define MESON_SAR_ADC_REG0_SAMPLING_START BIT(2)
48 #define MESON_SAR_ADC_REG0_CONTINUOUS_EN BIT(1)
49 #define MESON_SAR_ADC_REG0_SAMPLE_ENGINE_ENABLE BIT(0)
51 #define MESON_SAR_ADC_CHAN_LIST 0x04
52 #define MESON_SAR_ADC_CHAN_LIST_MAX_INDEX_MASK GENMASK(26, 24)
53 #define MESON_SAR_ADC_CHAN_LIST_ENTRY_MASK(_chan) \
54 (GENMASK(2, 0) << ((_chan) * 3))
56 #define MESON_SAR_ADC_AVG_CNTL 0x08
57 #define MESON_SAR_ADC_AVG_CNTL_AVG_MODE_SHIFT(_chan) \
59 #define MESON_SAR_ADC_AVG_CNTL_AVG_MODE_MASK(_chan) \
60 (GENMASK(17, 16) << ((_chan) * 2))
61 #define MESON_SAR_ADC_AVG_CNTL_NUM_SAMPLES_SHIFT(_chan) \
63 #define MESON_SAR_ADC_AVG_CNTL_NUM_SAMPLES_MASK(_chan) \
64 (GENMASK(1, 0) << ((_chan) * 2))
66 #define MESON_SAR_ADC_REG3 0x0c
67 #define MESON_SAR_ADC_REG3_CNTL_USE_SC_DLY BIT(31)
68 #define MESON_SAR_ADC_REG3_CLK_EN BIT(30)
69 #define MESON_SAR_ADC_REG3_BL30_INITIALIZED BIT(28)
70 #define MESON_SAR_ADC_REG3_CTRL_CONT_RING_COUNTER_EN BIT(27)
71 #define MESON_SAR_ADC_REG3_CTRL_SAMPLING_CLOCK_PHASE BIT(26)
72 #define MESON_SAR_ADC_REG3_CTRL_CHAN7_MUX_SEL_MASK GENMASK(25, 23)
73 #define MESON_SAR_ADC_REG3_DETECT_EN BIT(22)
74 #define MESON_SAR_ADC_REG3_ADC_EN BIT(21)
75 #define MESON_SAR_ADC_REG3_PANEL_DETECT_COUNT_MASK GENMASK(20, 18)
76 #define MESON_SAR_ADC_REG3_PANEL_DETECT_FILTER_TB_MASK GENMASK(17, 16)
77 #define MESON_SAR_ADC_REG3_ADC_CLK_DIV_SHIFT 10
78 #define MESON_SAR_ADC_REG3_ADC_CLK_DIV_WIDTH 5
79 #define MESON_SAR_ADC_REG3_BLOCK_DLY_SEL_MASK GENMASK(9, 8)
80 #define MESON_SAR_ADC_REG3_BLOCK_DLY_MASK GENMASK(7, 0)
82 #define MESON_SAR_ADC_DELAY 0x10
83 #define MESON_SAR_ADC_DELAY_INPUT_DLY_SEL_MASK GENMASK(25, 24)
84 #define MESON_SAR_ADC_DELAY_BL30_BUSY BIT(15)
85 #define MESON_SAR_ADC_DELAY_KERNEL_BUSY BIT(14)
86 #define MESON_SAR_ADC_DELAY_INPUT_DLY_CNT_MASK GENMASK(23, 16)
87 #define MESON_SAR_ADC_DELAY_SAMPLE_DLY_SEL_MASK GENMASK(9, 8)
88 #define MESON_SAR_ADC_DELAY_SAMPLE_DLY_CNT_MASK GENMASK(7, 0)
90 #define MESON_SAR_ADC_LAST_RD 0x14
91 #define MESON_SAR_ADC_LAST_RD_LAST_CHANNEL1_MASK GENMASK(23, 16)
92 #define MESON_SAR_ADC_LAST_RD_LAST_CHANNEL0_MASK GENMASK(9, 0)
94 #define MESON_SAR_ADC_FIFO_RD 0x18
95 #define MESON_SAR_ADC_FIFO_RD_CHAN_ID_MASK GENMASK(14, 12)
96 #define MESON_SAR_ADC_FIFO_RD_SAMPLE_VALUE_MASK GENMASK(11, 0)
98 #define MESON_SAR_ADC_AUX_SW 0x1c
99 #define MESON_SAR_ADC_AUX_SW_MUX_SEL_CHAN_MASK(_chan) \
100 (GENMASK(10, 8) << (((_chan) - 2) * 2))
101 #define MESON_SAR_ADC_AUX_SW_VREF_P_MUX BIT(6)
102 #define MESON_SAR_ADC_AUX_SW_VREF_N_MUX BIT(5)
103 #define MESON_SAR_ADC_AUX_SW_MODE_SEL BIT(4)
104 #define MESON_SAR_ADC_AUX_SW_YP_DRIVE_SW BIT(3)
105 #define MESON_SAR_ADC_AUX_SW_XP_DRIVE_SW BIT(2)
106 #define MESON_SAR_ADC_AUX_SW_YM_DRIVE_SW BIT(1)
107 #define MESON_SAR_ADC_AUX_SW_XM_DRIVE_SW BIT(0)
109 #define MESON_SAR_ADC_CHAN_10_SW 0x20
110 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_MUX_SEL_MASK GENMASK(25, 23)
111 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_VREF_P_MUX BIT(22)
112 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_VREF_N_MUX BIT(21)
113 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_MODE_SEL BIT(20)
114 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_YP_DRIVE_SW BIT(19)
115 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_XP_DRIVE_SW BIT(18)
116 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_YM_DRIVE_SW BIT(17)
117 #define MESON_SAR_ADC_CHAN_10_SW_CHAN1_XM_DRIVE_SW BIT(16)
118 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_MUX_SEL_MASK GENMASK(9, 7)
119 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_VREF_P_MUX BIT(6)
120 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_VREF_N_MUX BIT(5)
121 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_MODE_SEL BIT(4)
122 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_YP_DRIVE_SW BIT(3)
123 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_XP_DRIVE_SW BIT(2)
124 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_YM_DRIVE_SW BIT(1)
125 #define MESON_SAR_ADC_CHAN_10_SW_CHAN0_XM_DRIVE_SW BIT(0)
127 #define MESON_SAR_ADC_DETECT_IDLE_SW 0x24
128 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_SW_EN BIT(26)
129 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_MUX_MASK GENMASK(25, 23)
130 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_VREF_P_MUX BIT(22)
131 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_VREF_N_MUX BIT(21)
132 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_MODE_SEL BIT(20)
133 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_YP_DRIVE_SW BIT(19)
134 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_XP_DRIVE_SW BIT(18)
135 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_YM_DRIVE_SW BIT(17)
136 #define MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_XM_DRIVE_SW BIT(16)
137 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_MUX_SEL_MASK GENMASK(9, 7)
138 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_VREF_P_MUX BIT(6)
139 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_VREF_N_MUX BIT(5)
140 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_MODE_SEL BIT(4)
141 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_YP_DRIVE_SW BIT(3)
142 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_XP_DRIVE_SW BIT(2)
143 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_YM_DRIVE_SW BIT(1)
144 #define MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_XM_DRIVE_SW BIT(0)
146 #define MESON_SAR_ADC_DELTA_10 0x28
147 #define MESON_SAR_ADC_DELTA_10_TEMP_SEL BIT(27)
148 #define MESON_SAR_ADC_DELTA_10_TS_REVE1 BIT(26)
149 #define MESON_SAR_ADC_DELTA_10_CHAN1_DELTA_VALUE_MASK GENMASK(25, 16)
150 #define MESON_SAR_ADC_DELTA_10_TS_REVE0 BIT(15)
151 #define MESON_SAR_ADC_DELTA_10_TS_C_SHIFT 11
152 #define MESON_SAR_ADC_DELTA_10_TS_C_MASK GENMASK(14, 11)
153 #define MESON_SAR_ADC_DELTA_10_TS_VBG_EN BIT(10)
154 #define MESON_SAR_ADC_DELTA_10_CHAN0_DELTA_VALUE_MASK GENMASK(9, 0)
157 * NOTE: registers from here are undocumented (the vendor Linux kernel driver
158 * and u-boot source served as reference). These only seem to be relevant on
161 #define MESON_SAR_ADC_REG11 0x2c
162 #define MESON_SAR_ADC_REG11_BANDGAP_EN BIT(13)
164 #define MESON_SAR_ADC_REG13 0x34
165 #define MESON_SAR_ADC_REG13_12BIT_CALIBRATION_MASK GENMASK(13, 8)
167 #define MESON_SAR_ADC_MAX_FIFO_SIZE 32
168 #define MESON_SAR_ADC_TIMEOUT 100 /* ms */
169 /* for use with IIO_VAL_INT_PLUS_MICRO */
170 #define MILLION 1000000
172 #define MESON_SAR_ADC_CHAN(_chan) { \
173 .type = IIO_VOLTAGE, \
176 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
177 BIT(IIO_CHAN_INFO_AVERAGE_RAW), \
178 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \
179 BIT(IIO_CHAN_INFO_CALIBBIAS) | \
180 BIT(IIO_CHAN_INFO_CALIBSCALE), \
181 .datasheet_name = "SAR_ADC_CH"#_chan, \
185 * TODO: the hardware supports IIO_TEMP for channel 6 as well which is
186 * currently not supported by this driver.
188 static const struct iio_chan_spec meson_sar_adc_iio_channels[] = {
189 MESON_SAR_ADC_CHAN(0),
190 MESON_SAR_ADC_CHAN(1),
191 MESON_SAR_ADC_CHAN(2),
192 MESON_SAR_ADC_CHAN(3),
193 MESON_SAR_ADC_CHAN(4),
194 MESON_SAR_ADC_CHAN(5),
195 MESON_SAR_ADC_CHAN(6),
196 MESON_SAR_ADC_CHAN(7),
197 IIO_CHAN_SOFT_TIMESTAMP(8),
200 enum meson_sar_adc_avg_mode {
202 MEAN_AVERAGING = 0x1,
203 MEDIAN_AVERAGING = 0x2,
206 enum meson_sar_adc_num_samples {
213 enum meson_sar_adc_chan7_mux_sel {
215 CHAN7_MUX_VDD_DIV4 = 0x1,
216 CHAN7_MUX_VDD_DIV2 = 0x2,
217 CHAN7_MUX_VDD_MUL3_DIV4 = 0x3,
219 CHAN7_MUX_CH7_INPUT = 0x7,
222 struct meson_sar_adc_data {
223 bool has_bl30_integration;
224 unsigned int resolution;
228 struct meson_sar_adc_priv {
229 struct regmap *regmap;
230 struct regulator *vref;
231 const struct meson_sar_adc_data *data;
233 struct clk *core_clk;
234 struct clk *sana_clk;
235 struct clk *adc_sel_clk;
237 struct clk_gate clk_gate;
238 struct clk *adc_div_clk;
239 struct clk_divider clk_div;
240 struct completion done;
245 static const struct regmap_config meson_sar_adc_regmap_config = {
249 .max_register = MESON_SAR_ADC_REG13,
252 static unsigned int meson_sar_adc_get_fifo_count(struct iio_dev *indio_dev)
254 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
257 regmap_read(priv->regmap, MESON_SAR_ADC_REG0, ®val);
259 return FIELD_GET(MESON_SAR_ADC_REG0_FIFO_COUNT_MASK, regval);
262 static int meson_sar_adc_calib_val(struct iio_dev *indio_dev, int val)
264 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
267 /* use val_calib = scale * val_raw + offset calibration function */
268 tmp = div_s64((s64)val * priv->calibscale, MILLION) + priv->calibbias;
270 return clamp(tmp, 0, (1 << priv->data->resolution) - 1);
273 static int meson_sar_adc_wait_busy_clear(struct iio_dev *indio_dev)
275 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
276 int regval, timeout = 10000;
279 * NOTE: we need a small delay before reading the status, otherwise
280 * the sample engine may not have started internally (which would
281 * seem to us that sampling is already finished).
285 regmap_read(priv->regmap, MESON_SAR_ADC_REG0, ®val);
286 } while (FIELD_GET(MESON_SAR_ADC_REG0_BUSY_MASK, regval) && timeout--);
294 static int meson_sar_adc_read_raw_sample(struct iio_dev *indio_dev,
295 const struct iio_chan_spec *chan,
298 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
299 int regval, fifo_chan, fifo_val, count;
301 if(!wait_for_completion_timeout(&priv->done,
302 msecs_to_jiffies(MESON_SAR_ADC_TIMEOUT)))
305 count = meson_sar_adc_get_fifo_count(indio_dev);
307 dev_err(&indio_dev->dev,
308 "ADC FIFO has %d element(s) instead of one\n", count);
312 regmap_read(priv->regmap, MESON_SAR_ADC_FIFO_RD, ®val);
313 fifo_chan = FIELD_GET(MESON_SAR_ADC_FIFO_RD_CHAN_ID_MASK, regval);
314 if (fifo_chan != chan->channel) {
315 dev_err(&indio_dev->dev,
316 "ADC FIFO entry belongs to channel %d instead of %d\n",
317 fifo_chan, chan->channel);
321 fifo_val = FIELD_GET(MESON_SAR_ADC_FIFO_RD_SAMPLE_VALUE_MASK, regval);
322 fifo_val &= GENMASK(priv->data->resolution - 1, 0);
323 *val = meson_sar_adc_calib_val(indio_dev, fifo_val);
328 static void meson_sar_adc_set_averaging(struct iio_dev *indio_dev,
329 const struct iio_chan_spec *chan,
330 enum meson_sar_adc_avg_mode mode,
331 enum meson_sar_adc_num_samples samples)
333 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
334 int val, channel = chan->channel;
336 val = samples << MESON_SAR_ADC_AVG_CNTL_NUM_SAMPLES_SHIFT(channel);
337 regmap_update_bits(priv->regmap, MESON_SAR_ADC_AVG_CNTL,
338 MESON_SAR_ADC_AVG_CNTL_NUM_SAMPLES_MASK(channel),
341 val = mode << MESON_SAR_ADC_AVG_CNTL_AVG_MODE_SHIFT(channel);
342 regmap_update_bits(priv->regmap, MESON_SAR_ADC_AVG_CNTL,
343 MESON_SAR_ADC_AVG_CNTL_AVG_MODE_MASK(channel), val);
346 static void meson_sar_adc_enable_channel(struct iio_dev *indio_dev,
347 const struct iio_chan_spec *chan)
349 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
353 * the SAR ADC engine allows sampling multiple channels at the same
354 * time. to keep it simple we're only working with one *internal*
355 * channel, which starts counting at index 0 (which means: count = 1).
357 regval = FIELD_PREP(MESON_SAR_ADC_CHAN_LIST_MAX_INDEX_MASK, 0);
358 regmap_update_bits(priv->regmap, MESON_SAR_ADC_CHAN_LIST,
359 MESON_SAR_ADC_CHAN_LIST_MAX_INDEX_MASK, regval);
361 /* map channel index 0 to the channel which we want to read */
362 regval = FIELD_PREP(MESON_SAR_ADC_CHAN_LIST_ENTRY_MASK(0),
364 regmap_update_bits(priv->regmap, MESON_SAR_ADC_CHAN_LIST,
365 MESON_SAR_ADC_CHAN_LIST_ENTRY_MASK(0), regval);
367 regval = FIELD_PREP(MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_MUX_MASK,
369 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DETECT_IDLE_SW,
370 MESON_SAR_ADC_DETECT_IDLE_SW_DETECT_MUX_MASK,
373 regval = FIELD_PREP(MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_MUX_SEL_MASK,
375 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DETECT_IDLE_SW,
376 MESON_SAR_ADC_DETECT_IDLE_SW_IDLE_MUX_SEL_MASK,
379 if (chan->channel == 6)
380 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELTA_10,
381 MESON_SAR_ADC_DELTA_10_TEMP_SEL, 0);
384 static void meson_sar_adc_set_chan7_mux(struct iio_dev *indio_dev,
385 enum meson_sar_adc_chan7_mux_sel sel)
387 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
390 regval = FIELD_PREP(MESON_SAR_ADC_REG3_CTRL_CHAN7_MUX_SEL_MASK, sel);
391 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG3,
392 MESON_SAR_ADC_REG3_CTRL_CHAN7_MUX_SEL_MASK, regval);
394 usleep_range(10, 20);
397 static void meson_sar_adc_start_sample_engine(struct iio_dev *indio_dev)
399 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
401 reinit_completion(&priv->done);
403 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
404 MESON_SAR_ADC_REG0_FIFO_IRQ_EN,
405 MESON_SAR_ADC_REG0_FIFO_IRQ_EN);
407 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
408 MESON_SAR_ADC_REG0_SAMPLE_ENGINE_ENABLE,
409 MESON_SAR_ADC_REG0_SAMPLE_ENGINE_ENABLE);
411 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
412 MESON_SAR_ADC_REG0_SAMPLING_START,
413 MESON_SAR_ADC_REG0_SAMPLING_START);
416 static void meson_sar_adc_stop_sample_engine(struct iio_dev *indio_dev)
418 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
420 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
421 MESON_SAR_ADC_REG0_FIFO_IRQ_EN, 0);
423 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
424 MESON_SAR_ADC_REG0_SAMPLING_STOP,
425 MESON_SAR_ADC_REG0_SAMPLING_STOP);
427 /* wait until all modules are stopped */
428 meson_sar_adc_wait_busy_clear(indio_dev);
430 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
431 MESON_SAR_ADC_REG0_SAMPLE_ENGINE_ENABLE, 0);
434 static int meson_sar_adc_lock(struct iio_dev *indio_dev)
436 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
437 int val, timeout = 10000;
439 mutex_lock(&indio_dev->mlock);
441 if (priv->data->has_bl30_integration) {
442 /* prevent BL30 from using the SAR ADC while we are using it */
443 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELAY,
444 MESON_SAR_ADC_DELAY_KERNEL_BUSY,
445 MESON_SAR_ADC_DELAY_KERNEL_BUSY);
448 * wait until BL30 releases it's lock (so we can use the SAR
453 regmap_read(priv->regmap, MESON_SAR_ADC_DELAY, &val);
454 } while (val & MESON_SAR_ADC_DELAY_BL30_BUSY && timeout--);
463 static void meson_sar_adc_unlock(struct iio_dev *indio_dev)
465 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
467 if (priv->data->has_bl30_integration)
468 /* allow BL30 to use the SAR ADC again */
469 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELAY,
470 MESON_SAR_ADC_DELAY_KERNEL_BUSY, 0);
472 mutex_unlock(&indio_dev->mlock);
475 static void meson_sar_adc_clear_fifo(struct iio_dev *indio_dev)
477 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
478 unsigned int count, tmp;
480 for (count = 0; count < MESON_SAR_ADC_MAX_FIFO_SIZE; count++) {
481 if (!meson_sar_adc_get_fifo_count(indio_dev))
484 regmap_read(priv->regmap, MESON_SAR_ADC_FIFO_RD, &tmp);
488 static int meson_sar_adc_get_sample(struct iio_dev *indio_dev,
489 const struct iio_chan_spec *chan,
490 enum meson_sar_adc_avg_mode avg_mode,
491 enum meson_sar_adc_num_samples avg_samples,
496 ret = meson_sar_adc_lock(indio_dev);
500 /* clear the FIFO to make sure we're not reading old values */
501 meson_sar_adc_clear_fifo(indio_dev);
503 meson_sar_adc_set_averaging(indio_dev, chan, avg_mode, avg_samples);
505 meson_sar_adc_enable_channel(indio_dev, chan);
507 meson_sar_adc_start_sample_engine(indio_dev);
508 ret = meson_sar_adc_read_raw_sample(indio_dev, chan, val);
509 meson_sar_adc_stop_sample_engine(indio_dev);
511 meson_sar_adc_unlock(indio_dev);
514 dev_warn(indio_dev->dev.parent,
515 "failed to read sample for channel %d: %d\n",
523 static int meson_sar_adc_iio_info_read_raw(struct iio_dev *indio_dev,
524 const struct iio_chan_spec *chan,
525 int *val, int *val2, long mask)
527 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
531 case IIO_CHAN_INFO_RAW:
532 return meson_sar_adc_get_sample(indio_dev, chan, NO_AVERAGING,
536 case IIO_CHAN_INFO_AVERAGE_RAW:
537 return meson_sar_adc_get_sample(indio_dev, chan,
538 MEAN_AVERAGING, EIGHT_SAMPLES,
542 case IIO_CHAN_INFO_SCALE:
543 ret = regulator_get_voltage(priv->vref);
545 dev_err(indio_dev->dev.parent,
546 "failed to get vref voltage: %d\n", ret);
551 *val2 = priv->data->resolution;
552 return IIO_VAL_FRACTIONAL_LOG2;
554 case IIO_CHAN_INFO_CALIBBIAS:
555 *val = priv->calibbias;
558 case IIO_CHAN_INFO_CALIBSCALE:
559 *val = priv->calibscale / MILLION;
560 *val2 = priv->calibscale % MILLION;
561 return IIO_VAL_INT_PLUS_MICRO;
568 static int meson_sar_adc_clk_init(struct iio_dev *indio_dev,
571 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
572 struct clk_init_data init;
573 const char *clk_parents[1];
575 init.name = devm_kasprintf(&indio_dev->dev, GFP_KERNEL, "%pOF#adc_div",
576 indio_dev->dev.of_node);
578 init.ops = &clk_divider_ops;
579 clk_parents[0] = __clk_get_name(priv->clkin);
580 init.parent_names = clk_parents;
581 init.num_parents = 1;
583 priv->clk_div.reg = base + MESON_SAR_ADC_REG3;
584 priv->clk_div.shift = MESON_SAR_ADC_REG3_ADC_CLK_DIV_SHIFT;
585 priv->clk_div.width = MESON_SAR_ADC_REG3_ADC_CLK_DIV_WIDTH;
586 priv->clk_div.hw.init = &init;
587 priv->clk_div.flags = 0;
589 priv->adc_div_clk = devm_clk_register(&indio_dev->dev,
591 if (WARN_ON(IS_ERR(priv->adc_div_clk)))
592 return PTR_ERR(priv->adc_div_clk);
594 init.name = devm_kasprintf(&indio_dev->dev, GFP_KERNEL, "%pOF#adc_en",
595 indio_dev->dev.of_node);
596 init.flags = CLK_SET_RATE_PARENT;
597 init.ops = &clk_gate_ops;
598 clk_parents[0] = __clk_get_name(priv->adc_div_clk);
599 init.parent_names = clk_parents;
600 init.num_parents = 1;
602 priv->clk_gate.reg = base + MESON_SAR_ADC_REG3;
603 priv->clk_gate.bit_idx = __ffs(MESON_SAR_ADC_REG3_CLK_EN);
604 priv->clk_gate.hw.init = &init;
606 priv->adc_clk = devm_clk_register(&indio_dev->dev, &priv->clk_gate.hw);
607 if (WARN_ON(IS_ERR(priv->adc_clk)))
608 return PTR_ERR(priv->adc_clk);
613 static int meson_sar_adc_init(struct iio_dev *indio_dev)
615 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
619 * make sure we start at CH7 input since the other muxes are only used
620 * for internal calibration.
622 meson_sar_adc_set_chan7_mux(indio_dev, CHAN7_MUX_CH7_INPUT);
624 if (priv->data->has_bl30_integration) {
626 * leave sampling delay and the input clocks as configured by
627 * BL30 to make sure BL30 gets the values it expects when
628 * reading the temperature sensor.
630 regmap_read(priv->regmap, MESON_SAR_ADC_REG3, ®val);
631 if (regval & MESON_SAR_ADC_REG3_BL30_INITIALIZED)
635 meson_sar_adc_stop_sample_engine(indio_dev);
637 /* update the channel 6 MUX to select the temperature sensor */
638 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
639 MESON_SAR_ADC_REG0_ADC_TEMP_SEN_SEL,
640 MESON_SAR_ADC_REG0_ADC_TEMP_SEN_SEL);
642 /* disable all channels by default */
643 regmap_write(priv->regmap, MESON_SAR_ADC_CHAN_LIST, 0x0);
645 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG3,
646 MESON_SAR_ADC_REG3_CTRL_SAMPLING_CLOCK_PHASE, 0);
647 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG3,
648 MESON_SAR_ADC_REG3_CNTL_USE_SC_DLY,
649 MESON_SAR_ADC_REG3_CNTL_USE_SC_DLY);
651 /* delay between two samples = (10+1) * 1uS */
652 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELAY,
653 MESON_SAR_ADC_DELAY_INPUT_DLY_CNT_MASK,
654 FIELD_PREP(MESON_SAR_ADC_DELAY_SAMPLE_DLY_CNT_MASK,
656 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELAY,
657 MESON_SAR_ADC_DELAY_SAMPLE_DLY_SEL_MASK,
658 FIELD_PREP(MESON_SAR_ADC_DELAY_SAMPLE_DLY_SEL_MASK,
661 /* delay between two samples = (10+1) * 1uS */
662 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELAY,
663 MESON_SAR_ADC_DELAY_INPUT_DLY_CNT_MASK,
664 FIELD_PREP(MESON_SAR_ADC_DELAY_INPUT_DLY_CNT_MASK,
666 regmap_update_bits(priv->regmap, MESON_SAR_ADC_DELAY,
667 MESON_SAR_ADC_DELAY_INPUT_DLY_SEL_MASK,
668 FIELD_PREP(MESON_SAR_ADC_DELAY_INPUT_DLY_SEL_MASK,
671 ret = clk_set_parent(priv->adc_sel_clk, priv->clkin);
673 dev_err(indio_dev->dev.parent,
674 "failed to set adc parent to clkin\n");
678 ret = clk_set_rate(priv->adc_clk, 1200000);
680 dev_err(indio_dev->dev.parent,
681 "failed to set adc clock rate\n");
688 static int meson_sar_adc_hw_enable(struct iio_dev *indio_dev)
690 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
694 ret = meson_sar_adc_lock(indio_dev);
698 ret = regulator_enable(priv->vref);
700 dev_err(indio_dev->dev.parent,
701 "failed to enable vref regulator\n");
705 ret = clk_prepare_enable(priv->core_clk);
707 dev_err(indio_dev->dev.parent, "failed to enable core clk\n");
711 ret = clk_prepare_enable(priv->sana_clk);
713 dev_err(indio_dev->dev.parent, "failed to enable sana clk\n");
717 regval = FIELD_PREP(MESON_SAR_ADC_REG0_FIFO_CNT_IRQ_MASK, 1);
718 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG0,
719 MESON_SAR_ADC_REG0_FIFO_CNT_IRQ_MASK, regval);
720 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG11,
721 MESON_SAR_ADC_REG11_BANDGAP_EN,
722 MESON_SAR_ADC_REG11_BANDGAP_EN);
723 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG3,
724 MESON_SAR_ADC_REG3_ADC_EN,
725 MESON_SAR_ADC_REG3_ADC_EN);
729 ret = clk_prepare_enable(priv->adc_clk);
731 dev_err(indio_dev->dev.parent, "failed to enable adc clk\n");
735 meson_sar_adc_unlock(indio_dev);
740 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG3,
741 MESON_SAR_ADC_REG3_ADC_EN, 0);
742 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG11,
743 MESON_SAR_ADC_REG11_BANDGAP_EN, 0);
744 clk_disable_unprepare(priv->sana_clk);
746 clk_disable_unprepare(priv->core_clk);
748 regulator_disable(priv->vref);
750 meson_sar_adc_unlock(indio_dev);
755 static int meson_sar_adc_hw_disable(struct iio_dev *indio_dev)
757 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
760 ret = meson_sar_adc_lock(indio_dev);
764 clk_disable_unprepare(priv->adc_clk);
766 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG3,
767 MESON_SAR_ADC_REG3_ADC_EN, 0);
768 regmap_update_bits(priv->regmap, MESON_SAR_ADC_REG11,
769 MESON_SAR_ADC_REG11_BANDGAP_EN, 0);
771 clk_disable_unprepare(priv->sana_clk);
772 clk_disable_unprepare(priv->core_clk);
774 regulator_disable(priv->vref);
776 meson_sar_adc_unlock(indio_dev);
781 static irqreturn_t meson_sar_adc_irq(int irq, void *data)
783 struct iio_dev *indio_dev = data;
784 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
785 unsigned int cnt, threshold;
788 regmap_read(priv->regmap, MESON_SAR_ADC_REG0, ®val);
789 cnt = FIELD_GET(MESON_SAR_ADC_REG0_FIFO_COUNT_MASK, regval);
790 threshold = FIELD_GET(MESON_SAR_ADC_REG0_FIFO_CNT_IRQ_MASK, regval);
795 complete(&priv->done);
800 static int meson_sar_adc_calib(struct iio_dev *indio_dev)
802 struct meson_sar_adc_priv *priv = iio_priv(indio_dev);
803 int ret, nominal0, nominal1, value0, value1;
805 /* use points 25% and 75% for calibration */
806 nominal0 = (1 << priv->data->resolution) / 4;
807 nominal1 = (1 << priv->data->resolution) * 3 / 4;
809 meson_sar_adc_set_chan7_mux(indio_dev, CHAN7_MUX_VDD_DIV4);
810 usleep_range(10, 20);
811 ret = meson_sar_adc_get_sample(indio_dev,
812 &meson_sar_adc_iio_channels[7],
813 MEAN_AVERAGING, EIGHT_SAMPLES, &value0);
817 meson_sar_adc_set_chan7_mux(indio_dev, CHAN7_MUX_VDD_MUL3_DIV4);
818 usleep_range(10, 20);
819 ret = meson_sar_adc_get_sample(indio_dev,
820 &meson_sar_adc_iio_channels[7],
821 MEAN_AVERAGING, EIGHT_SAMPLES, &value1);
825 if (value1 <= value0) {
830 priv->calibscale = div_s64((nominal1 - nominal0) * (s64)MILLION,
832 priv->calibbias = nominal0 - div_s64((s64)value0 * priv->calibscale,
836 meson_sar_adc_set_chan7_mux(indio_dev, CHAN7_MUX_CH7_INPUT);
841 static const struct iio_info meson_sar_adc_iio_info = {
842 .read_raw = meson_sar_adc_iio_info_read_raw,
845 static const struct meson_sar_adc_data meson_sar_adc_meson8_data = {
846 .has_bl30_integration = false,
848 .name = "meson-meson8-saradc",
851 static const struct meson_sar_adc_data meson_sar_adc_meson8b_data = {
852 .has_bl30_integration = false,
854 .name = "meson-meson8b-saradc",
857 static const struct meson_sar_adc_data meson_sar_adc_gxbb_data = {
858 .has_bl30_integration = true,
860 .name = "meson-gxbb-saradc",
863 static const struct meson_sar_adc_data meson_sar_adc_gxl_data = {
864 .has_bl30_integration = true,
866 .name = "meson-gxl-saradc",
869 static const struct meson_sar_adc_data meson_sar_adc_gxm_data = {
870 .has_bl30_integration = true,
872 .name = "meson-gxm-saradc",
875 static const struct of_device_id meson_sar_adc_of_match[] = {
877 .compatible = "amlogic,meson8-saradc",
878 .data = &meson_sar_adc_meson8_data,
881 .compatible = "amlogic,meson8b-saradc",
882 .data = &meson_sar_adc_meson8b_data,
885 .compatible = "amlogic,meson-gxbb-saradc",
886 .data = &meson_sar_adc_gxbb_data,
888 .compatible = "amlogic,meson-gxl-saradc",
889 .data = &meson_sar_adc_gxl_data,
891 .compatible = "amlogic,meson-gxm-saradc",
892 .data = &meson_sar_adc_gxm_data,
896 MODULE_DEVICE_TABLE(of, meson_sar_adc_of_match);
898 static int meson_sar_adc_probe(struct platform_device *pdev)
900 struct meson_sar_adc_priv *priv;
901 struct iio_dev *indio_dev;
902 struct resource *res;
904 const struct of_device_id *match;
907 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*priv));
909 dev_err(&pdev->dev, "failed allocating iio device\n");
913 priv = iio_priv(indio_dev);
914 init_completion(&priv->done);
916 match = of_match_device(meson_sar_adc_of_match, &pdev->dev);
918 dev_err(&pdev->dev, "failed to match device\n");
922 priv->data = match->data;
924 indio_dev->name = priv->data->name;
925 indio_dev->dev.parent = &pdev->dev;
926 indio_dev->dev.of_node = pdev->dev.of_node;
927 indio_dev->modes = INDIO_DIRECT_MODE;
928 indio_dev->info = &meson_sar_adc_iio_info;
930 indio_dev->channels = meson_sar_adc_iio_channels;
931 indio_dev->num_channels = ARRAY_SIZE(meson_sar_adc_iio_channels);
933 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
934 base = devm_ioremap_resource(&pdev->dev, res);
936 return PTR_ERR(base);
938 irq = irq_of_parse_and_map(pdev->dev.of_node, 0);
942 ret = devm_request_irq(&pdev->dev, irq, meson_sar_adc_irq, IRQF_SHARED,
943 dev_name(&pdev->dev), indio_dev);
947 priv->regmap = devm_regmap_init_mmio(&pdev->dev, base,
948 &meson_sar_adc_regmap_config);
949 if (IS_ERR(priv->regmap))
950 return PTR_ERR(priv->regmap);
952 priv->clkin = devm_clk_get(&pdev->dev, "clkin");
953 if (IS_ERR(priv->clkin)) {
954 dev_err(&pdev->dev, "failed to get clkin\n");
955 return PTR_ERR(priv->clkin);
958 priv->core_clk = devm_clk_get(&pdev->dev, "core");
959 if (IS_ERR(priv->core_clk)) {
960 dev_err(&pdev->dev, "failed to get core clk\n");
961 return PTR_ERR(priv->core_clk);
964 priv->sana_clk = devm_clk_get(&pdev->dev, "sana");
965 if (IS_ERR(priv->sana_clk)) {
966 if (PTR_ERR(priv->sana_clk) == -ENOENT) {
967 priv->sana_clk = NULL;
969 dev_err(&pdev->dev, "failed to get sana clk\n");
970 return PTR_ERR(priv->sana_clk);
974 priv->adc_clk = devm_clk_get(&pdev->dev, "adc_clk");
975 if (IS_ERR(priv->adc_clk)) {
976 if (PTR_ERR(priv->adc_clk) == -ENOENT) {
977 priv->adc_clk = NULL;
979 dev_err(&pdev->dev, "failed to get adc clk\n");
980 return PTR_ERR(priv->adc_clk);
984 priv->adc_sel_clk = devm_clk_get(&pdev->dev, "adc_sel");
985 if (IS_ERR(priv->adc_sel_clk)) {
986 if (PTR_ERR(priv->adc_sel_clk) == -ENOENT) {
987 priv->adc_sel_clk = NULL;
989 dev_err(&pdev->dev, "failed to get adc_sel clk\n");
990 return PTR_ERR(priv->adc_sel_clk);
994 /* on pre-GXBB SoCs the SAR ADC itself provides the ADC clock: */
995 if (!priv->adc_clk) {
996 ret = meson_sar_adc_clk_init(indio_dev, base);
1001 priv->vref = devm_regulator_get(&pdev->dev, "vref");
1002 if (IS_ERR(priv->vref)) {
1003 dev_err(&pdev->dev, "failed to get vref regulator\n");
1004 return PTR_ERR(priv->vref);
1007 priv->calibscale = MILLION;
1009 ret = meson_sar_adc_init(indio_dev);
1013 ret = meson_sar_adc_hw_enable(indio_dev);
1017 ret = meson_sar_adc_calib(indio_dev);
1019 dev_warn(&pdev->dev, "calibration failed\n");
1021 platform_set_drvdata(pdev, indio_dev);
1023 ret = iio_device_register(indio_dev);
1030 meson_sar_adc_hw_disable(indio_dev);
1035 static int meson_sar_adc_remove(struct platform_device *pdev)
1037 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
1039 iio_device_unregister(indio_dev);
1041 return meson_sar_adc_hw_disable(indio_dev);
1044 static int __maybe_unused meson_sar_adc_suspend(struct device *dev)
1046 struct iio_dev *indio_dev = dev_get_drvdata(dev);
1048 return meson_sar_adc_hw_disable(indio_dev);
1051 static int __maybe_unused meson_sar_adc_resume(struct device *dev)
1053 struct iio_dev *indio_dev = dev_get_drvdata(dev);
1055 return meson_sar_adc_hw_enable(indio_dev);
1058 static SIMPLE_DEV_PM_OPS(meson_sar_adc_pm_ops,
1059 meson_sar_adc_suspend, meson_sar_adc_resume);
1061 static struct platform_driver meson_sar_adc_driver = {
1062 .probe = meson_sar_adc_probe,
1063 .remove = meson_sar_adc_remove,
1065 .name = "meson-saradc",
1066 .of_match_table = meson_sar_adc_of_match,
1067 .pm = &meson_sar_adc_pm_ops,
1071 module_platform_driver(meson_sar_adc_driver);
1073 MODULE_AUTHOR("Martin Blumenstingl <martin.blumenstingl@googlemail.com>");
1074 MODULE_DESCRIPTION("Amlogic Meson SAR ADC driver");
1075 MODULE_LICENSE("GPL v2");