1 // SPDX-License-Identifier: GPL-2.0+
3 * NXP i.MX8QXP ADC driver
5 * Based on the work of Haibo Chen <haibo.chen@nxp.com>
6 * The initial developer of the original code is Haibo Chen.
7 * Portions created by Haibo Chen are Copyright (C) 2018 NXP.
10 * Copyright (C) 2018 NXP
11 * Copyright (C) 2021 Cai Huoqing
13 #include <linux/bitfield.h>
14 #include <linux/bits.h>
15 #include <linux/clk.h>
16 #include <linux/completion.h>
17 #include <linux/delay.h>
18 #include <linux/err.h>
19 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/regulator/consumer.h>
28 #include <linux/iio/iio.h>
30 #define ADC_DRIVER_NAME "imx8qxp-adc"
32 /* Register map definition */
33 #define IMX8QXP_ADR_ADC_CTRL 0x10
34 #define IMX8QXP_ADR_ADC_STAT 0x14
35 #define IMX8QXP_ADR_ADC_IE 0x18
36 #define IMX8QXP_ADR_ADC_DE 0x1c
37 #define IMX8QXP_ADR_ADC_CFG 0x20
38 #define IMX8QXP_ADR_ADC_FCTRL 0x30
39 #define IMX8QXP_ADR_ADC_SWTRIG 0x34
40 #define IMX8QXP_ADR_ADC_TCTRL(tid) (0xc0 + (tid) * 4)
41 #define IMX8QXP_ADR_ADC_CMDL(cid) (0x100 + (cid) * 8)
42 #define IMX8QXP_ADR_ADC_CMDH(cid) (0x104 + (cid) * 8)
43 #define IMX8QXP_ADR_ADC_RESFIFO 0x300
44 #define IMX8QXP_ADR_ADC_TST 0xffc
47 #define IMX8QXP_ADC_IE_FWMIE_MASK GENMASK(1, 0)
48 #define IMX8QXP_ADC_CTRL_FIFO_RESET_MASK BIT(8)
49 #define IMX8QXP_ADC_CTRL_SOFTWARE_RESET_MASK BIT(1)
50 #define IMX8QXP_ADC_CTRL_ADC_EN_MASK BIT(0)
51 #define IMX8QXP_ADC_TCTRL_TCMD_MASK GENMASK(31, 24)
52 #define IMX8QXP_ADC_TCTRL_TDLY_MASK GENMASK(23, 16)
53 #define IMX8QXP_ADC_TCTRL_TPRI_MASK GENMASK(15, 8)
54 #define IMX8QXP_ADC_TCTRL_HTEN_MASK GENMASK(7, 0)
55 #define IMX8QXP_ADC_CMDL_CSCALE_MASK GENMASK(13, 8)
56 #define IMX8QXP_ADC_CMDL_MODE_MASK BIT(7)
57 #define IMX8QXP_ADC_CMDL_DIFF_MASK BIT(6)
58 #define IMX8QXP_ADC_CMDL_ABSEL_MASK BIT(5)
59 #define IMX8QXP_ADC_CMDL_ADCH_MASK GENMASK(2, 0)
60 #define IMX8QXP_ADC_CMDH_NEXT_MASK GENMASK(31, 24)
61 #define IMX8QXP_ADC_CMDH_LOOP_MASK GENMASK(23, 16)
62 #define IMX8QXP_ADC_CMDH_AVGS_MASK GENMASK(15, 12)
63 #define IMX8QXP_ADC_CMDH_STS_MASK BIT(8)
64 #define IMX8QXP_ADC_CMDH_LWI_MASK GENMASK(7, 7)
65 #define IMX8QXP_ADC_CMDH_CMPEN_MASK GENMASK(0, 0)
66 #define IMX8QXP_ADC_CFG_PWREN_MASK BIT(28)
67 #define IMX8QXP_ADC_CFG_PUDLY_MASK GENMASK(23, 16)
68 #define IMX8QXP_ADC_CFG_REFSEL_MASK GENMASK(7, 6)
69 #define IMX8QXP_ADC_CFG_PWRSEL_MASK GENMASK(5, 4)
70 #define IMX8QXP_ADC_CFG_TPRICTRL_MASK GENMASK(3, 0)
71 #define IMX8QXP_ADC_FCTRL_FWMARK_MASK GENMASK(20, 16)
72 #define IMX8QXP_ADC_FCTRL_FCOUNT_MASK GENMASK(4, 0)
73 #define IMX8QXP_ADC_RESFIFO_VAL_MASK GENMASK(18, 3)
76 #define IMX8QXP_ADC_CMDL_CHANNEL_SCALE_FULL GENMASK(5, 0)
77 #define IMX8QXP_ADC_CMDL_SEL_A_A_B_CHANNEL 0
78 #define IMX8QXP_ADC_CMDL_STANDARD_RESOLUTION 0
79 #define IMX8QXP_ADC_CMDL_MODE_SINGLE 0
80 #define IMX8QXP_ADC_CMDH_LWI_INCREMENT_DIS 0
81 #define IMX8QXP_ADC_CMDH_CMPEN_DIS 0
82 #define IMX8QXP_ADC_PAUSE_EN BIT(31)
83 #define IMX8QXP_ADC_TCTRL_TPRI_PRIORITY_HIGH 0
85 #define IMX8QXP_ADC_TCTRL_HTEN_HW_TIRG_DIS 0
87 #define IMX8QXP_ADC_TIMEOUT msecs_to_jiffies(100)
89 #define IMX8QXP_ADC_MAX_FIFO_SIZE 16
96 struct regulator *vref;
97 /* Serialise ADC channel reads */
99 struct completion completion;
100 u32 fifo[IMX8QXP_ADC_MAX_FIFO_SIZE];
103 #define IMX8QXP_ADC_CHAN(_idx) { \
104 .type = IIO_VOLTAGE, \
107 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
108 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \
109 BIT(IIO_CHAN_INFO_SAMP_FREQ), \
112 static const struct iio_chan_spec imx8qxp_adc_iio_channels[] = {
123 static void imx8qxp_adc_reset(struct imx8qxp_adc *adc)
127 /*software reset, need to clear the set bit*/
128 ctrl = readl(adc->regs + IMX8QXP_ADR_ADC_CTRL);
129 ctrl |= FIELD_PREP(IMX8QXP_ADC_CTRL_SOFTWARE_RESET_MASK, 1);
130 writel(ctrl, adc->regs + IMX8QXP_ADR_ADC_CTRL);
132 ctrl &= ~FIELD_PREP(IMX8QXP_ADC_CTRL_SOFTWARE_RESET_MASK, 1);
133 writel(ctrl, adc->regs + IMX8QXP_ADR_ADC_CTRL);
136 ctrl |= FIELD_PREP(IMX8QXP_ADC_CTRL_FIFO_RESET_MASK, 1);
137 writel(ctrl, adc->regs + IMX8QXP_ADR_ADC_CTRL);
140 static void imx8qxp_adc_reg_config(struct imx8qxp_adc *adc, int channel)
142 u32 adc_cfg, adc_tctrl, adc_cmdl, adc_cmdh;
144 /* ADC configuration */
145 adc_cfg = FIELD_PREP(IMX8QXP_ADC_CFG_PWREN_MASK, 1) |
146 FIELD_PREP(IMX8QXP_ADC_CFG_PUDLY_MASK, 0x80)|
147 FIELD_PREP(IMX8QXP_ADC_CFG_REFSEL_MASK, 0) |
148 FIELD_PREP(IMX8QXP_ADC_CFG_PWRSEL_MASK, 3) |
149 FIELD_PREP(IMX8QXP_ADC_CFG_TPRICTRL_MASK, 0);
150 writel(adc_cfg, adc->regs + IMX8QXP_ADR_ADC_CFG);
152 /* config the trigger control */
153 adc_tctrl = FIELD_PREP(IMX8QXP_ADC_TCTRL_TCMD_MASK, 1) |
154 FIELD_PREP(IMX8QXP_ADC_TCTRL_TDLY_MASK, 0) |
155 FIELD_PREP(IMX8QXP_ADC_TCTRL_TPRI_MASK, IMX8QXP_ADC_TCTRL_TPRI_PRIORITY_HIGH) |
156 FIELD_PREP(IMX8QXP_ADC_TCTRL_HTEN_MASK, IMX8QXP_ADC_TCTRL_HTEN_HW_TIRG_DIS);
157 writel(adc_tctrl, adc->regs + IMX8QXP_ADR_ADC_TCTRL(0));
160 adc_cmdl = FIELD_PREP(IMX8QXP_ADC_CMDL_CSCALE_MASK, IMX8QXP_ADC_CMDL_CHANNEL_SCALE_FULL) |
161 FIELD_PREP(IMX8QXP_ADC_CMDL_MODE_MASK, IMX8QXP_ADC_CMDL_STANDARD_RESOLUTION) |
162 FIELD_PREP(IMX8QXP_ADC_CMDL_DIFF_MASK, IMX8QXP_ADC_CMDL_MODE_SINGLE) |
163 FIELD_PREP(IMX8QXP_ADC_CMDL_ABSEL_MASK, IMX8QXP_ADC_CMDL_SEL_A_A_B_CHANNEL) |
164 FIELD_PREP(IMX8QXP_ADC_CMDL_ADCH_MASK, channel);
165 writel(adc_cmdl, adc->regs + IMX8QXP_ADR_ADC_CMDL(0));
167 adc_cmdh = FIELD_PREP(IMX8QXP_ADC_CMDH_NEXT_MASK, 0) |
168 FIELD_PREP(IMX8QXP_ADC_CMDH_LOOP_MASK, 0) |
169 FIELD_PREP(IMX8QXP_ADC_CMDH_AVGS_MASK, 7) |
170 FIELD_PREP(IMX8QXP_ADC_CMDH_STS_MASK, 0) |
171 FIELD_PREP(IMX8QXP_ADC_CMDH_LWI_MASK, IMX8QXP_ADC_CMDH_LWI_INCREMENT_DIS) |
172 FIELD_PREP(IMX8QXP_ADC_CMDH_CMPEN_MASK, IMX8QXP_ADC_CMDH_CMPEN_DIS);
173 writel(adc_cmdh, adc->regs + IMX8QXP_ADR_ADC_CMDH(0));
176 static void imx8qxp_adc_fifo_config(struct imx8qxp_adc *adc)
178 u32 fifo_ctrl, interrupt_en;
180 fifo_ctrl = readl(adc->regs + IMX8QXP_ADR_ADC_FCTRL);
181 fifo_ctrl &= ~IMX8QXP_ADC_FCTRL_FWMARK_MASK;
182 /* set the watermark level to 1 */
183 fifo_ctrl |= FIELD_PREP(IMX8QXP_ADC_FCTRL_FWMARK_MASK, 0);
184 writel(fifo_ctrl, adc->regs + IMX8QXP_ADR_ADC_FCTRL);
186 /* FIFO Watermark Interrupt Enable */
187 interrupt_en = readl(adc->regs + IMX8QXP_ADR_ADC_IE);
188 interrupt_en |= FIELD_PREP(IMX8QXP_ADC_IE_FWMIE_MASK, 1);
189 writel(interrupt_en, adc->regs + IMX8QXP_ADR_ADC_IE);
192 static void imx8qxp_adc_disable(struct imx8qxp_adc *adc)
196 ctrl = readl(adc->regs + IMX8QXP_ADR_ADC_CTRL);
197 ctrl &= ~FIELD_PREP(IMX8QXP_ADC_CTRL_ADC_EN_MASK, 1);
198 writel(ctrl, adc->regs + IMX8QXP_ADR_ADC_CTRL);
201 static int imx8qxp_adc_read_raw(struct iio_dev *indio_dev,
202 struct iio_chan_spec const *chan,
203 int *val, int *val2, long mask)
205 struct imx8qxp_adc *adc = iio_priv(indio_dev);
206 struct device *dev = adc->dev;
212 case IIO_CHAN_INFO_RAW:
213 pm_runtime_get_sync(dev);
215 mutex_lock(&adc->lock);
216 reinit_completion(&adc->completion);
218 imx8qxp_adc_reg_config(adc, chan->channel);
220 imx8qxp_adc_fifo_config(adc);
223 ctrl = readl(adc->regs + IMX8QXP_ADR_ADC_CTRL);
224 ctrl |= FIELD_PREP(IMX8QXP_ADC_CTRL_ADC_EN_MASK, 1);
225 writel(ctrl, adc->regs + IMX8QXP_ADR_ADC_CTRL);
227 writel(1, adc->regs + IMX8QXP_ADR_ADC_SWTRIG);
229 ret = wait_for_completion_interruptible_timeout(&adc->completion,
230 IMX8QXP_ADC_TIMEOUT);
232 pm_runtime_mark_last_busy(dev);
233 pm_runtime_put_sync_autosuspend(dev);
236 mutex_unlock(&adc->lock);
240 mutex_unlock(&adc->lock);
246 mutex_unlock(&adc->lock);
249 case IIO_CHAN_INFO_SCALE:
250 ret = regulator_get_voltage(adc->vref);
255 return IIO_VAL_FRACTIONAL_LOG2;
257 case IIO_CHAN_INFO_SAMP_FREQ:
258 *val = clk_get_rate(adc->clk) / 3;
266 static irqreturn_t imx8qxp_adc_isr(int irq, void *dev_id)
268 struct imx8qxp_adc *adc = dev_id;
272 fifo_count = FIELD_GET(IMX8QXP_ADC_FCTRL_FCOUNT_MASK,
273 readl(adc->regs + IMX8QXP_ADR_ADC_FCTRL));
275 for (i = 0; i < fifo_count; i++)
276 adc->fifo[i] = FIELD_GET(IMX8QXP_ADC_RESFIFO_VAL_MASK,
277 readl_relaxed(adc->regs + IMX8QXP_ADR_ADC_RESFIFO));
280 complete(&adc->completion);
285 static int imx8qxp_adc_reg_access(struct iio_dev *indio_dev, unsigned int reg,
286 unsigned int writeval, unsigned int *readval)
288 struct imx8qxp_adc *adc = iio_priv(indio_dev);
289 struct device *dev = adc->dev;
291 if (!readval || reg % 4 || reg > IMX8QXP_ADR_ADC_TST)
294 pm_runtime_get_sync(dev);
296 *readval = readl(adc->regs + reg);
298 pm_runtime_mark_last_busy(dev);
299 pm_runtime_put_sync_autosuspend(dev);
304 static const struct iio_info imx8qxp_adc_iio_info = {
305 .read_raw = &imx8qxp_adc_read_raw,
306 .debugfs_reg_access = &imx8qxp_adc_reg_access,
309 static int imx8qxp_adc_probe(struct platform_device *pdev)
311 struct imx8qxp_adc *adc;
312 struct iio_dev *indio_dev;
313 struct device *dev = &pdev->dev;
317 indio_dev = devm_iio_device_alloc(dev, sizeof(*adc));
319 dev_err(dev, "Failed allocating iio device\n");
323 adc = iio_priv(indio_dev);
326 mutex_init(&adc->lock);
327 adc->regs = devm_platform_ioremap_resource(pdev, 0);
328 if (IS_ERR(adc->regs))
329 return PTR_ERR(adc->regs);
331 irq = platform_get_irq(pdev, 0);
335 adc->clk = devm_clk_get(dev, "per");
336 if (IS_ERR(adc->clk))
337 return dev_err_probe(dev, PTR_ERR(adc->clk), "Failed getting clock\n");
339 adc->ipg_clk = devm_clk_get(dev, "ipg");
340 if (IS_ERR(adc->ipg_clk))
341 return dev_err_probe(dev, PTR_ERR(adc->ipg_clk), "Failed getting clock\n");
343 adc->vref = devm_regulator_get(dev, "vref");
344 if (IS_ERR(adc->vref))
345 return dev_err_probe(dev, PTR_ERR(adc->vref), "Failed getting reference voltage\n");
347 ret = regulator_enable(adc->vref);
349 dev_err(dev, "Can't enable adc reference top voltage\n");
353 platform_set_drvdata(pdev, indio_dev);
355 init_completion(&adc->completion);
357 indio_dev->name = ADC_DRIVER_NAME;
358 indio_dev->info = &imx8qxp_adc_iio_info;
359 indio_dev->modes = INDIO_DIRECT_MODE;
360 indio_dev->channels = imx8qxp_adc_iio_channels;
361 indio_dev->num_channels = ARRAY_SIZE(imx8qxp_adc_iio_channels);
363 ret = clk_prepare_enable(adc->clk);
365 dev_err(&pdev->dev, "Could not prepare or enable the clock.\n");
366 goto error_regulator_disable;
369 ret = clk_prepare_enable(adc->ipg_clk);
371 dev_err(&pdev->dev, "Could not prepare or enable the clock.\n");
372 goto error_adc_clk_disable;
375 ret = devm_request_irq(dev, irq, imx8qxp_adc_isr, 0, ADC_DRIVER_NAME, adc);
377 dev_err(dev, "Failed requesting irq, irq = %d\n", irq);
378 goto error_ipg_clk_disable;
381 imx8qxp_adc_reset(adc);
383 ret = iio_device_register(indio_dev);
385 imx8qxp_adc_disable(adc);
386 dev_err(dev, "Couldn't register the device.\n");
387 goto error_ipg_clk_disable;
390 pm_runtime_set_active(dev);
391 pm_runtime_set_autosuspend_delay(dev, 50);
392 pm_runtime_use_autosuspend(dev);
393 pm_runtime_enable(dev);
397 error_ipg_clk_disable:
398 clk_disable_unprepare(adc->ipg_clk);
399 error_adc_clk_disable:
400 clk_disable_unprepare(adc->clk);
401 error_regulator_disable:
402 regulator_disable(adc->vref);
407 static int imx8qxp_adc_remove(struct platform_device *pdev)
409 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
410 struct imx8qxp_adc *adc = iio_priv(indio_dev);
411 struct device *dev = adc->dev;
413 pm_runtime_get_sync(dev);
415 iio_device_unregister(indio_dev);
417 imx8qxp_adc_disable(adc);
419 clk_disable_unprepare(adc->clk);
420 clk_disable_unprepare(adc->ipg_clk);
421 regulator_disable(adc->vref);
423 pm_runtime_disable(dev);
424 pm_runtime_put_noidle(dev);
429 static int imx8qxp_adc_runtime_suspend(struct device *dev)
431 struct iio_dev *indio_dev = dev_get_drvdata(dev);
432 struct imx8qxp_adc *adc = iio_priv(indio_dev);
434 imx8qxp_adc_disable(adc);
436 clk_disable_unprepare(adc->clk);
437 clk_disable_unprepare(adc->ipg_clk);
438 regulator_disable(adc->vref);
443 static int imx8qxp_adc_runtime_resume(struct device *dev)
445 struct iio_dev *indio_dev = dev_get_drvdata(dev);
446 struct imx8qxp_adc *adc = iio_priv(indio_dev);
449 ret = regulator_enable(adc->vref);
451 dev_err(dev, "Can't enable adc reference top voltage, err = %d\n", ret);
455 ret = clk_prepare_enable(adc->clk);
457 dev_err(dev, "Could not prepare or enable clock.\n");
458 goto err_disable_reg;
461 ret = clk_prepare_enable(adc->ipg_clk);
463 dev_err(dev, "Could not prepare or enable clock.\n");
464 goto err_unprepare_clk;
467 imx8qxp_adc_reset(adc);
472 clk_disable_unprepare(adc->clk);
475 regulator_disable(adc->vref);
480 static DEFINE_RUNTIME_DEV_PM_OPS(imx8qxp_adc_pm_ops,
481 imx8qxp_adc_runtime_suspend,
482 imx8qxp_adc_runtime_resume, NULL);
484 static const struct of_device_id imx8qxp_adc_match[] = {
485 { .compatible = "nxp,imx8qxp-adc", },
488 MODULE_DEVICE_TABLE(of, imx8qxp_adc_match);
490 static struct platform_driver imx8qxp_adc_driver = {
491 .probe = imx8qxp_adc_probe,
492 .remove = imx8qxp_adc_remove,
494 .name = ADC_DRIVER_NAME,
495 .of_match_table = imx8qxp_adc_match,
496 .pm = pm_ptr(&imx8qxp_adc_pm_ops),
500 module_platform_driver(imx8qxp_adc_driver);
502 MODULE_DESCRIPTION("i.MX8QuadXPlus ADC driver");
503 MODULE_LICENSE("GPL v2");