2 * exynos_adc.c - Support for ADC in EXYNOS SoCs
4 * 8 ~ 10 channel, 10/12-bit ADC
6 * Copyright (C) 2013 Naveen Krishna Chatradhi <ch.naveen@samsung.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/interrupt.h>
26 #include <linux/delay.h>
27 #include <linux/errno.h>
28 #include <linux/kernel.h>
29 #include <linux/slab.h>
31 #include <linux/clk.h>
32 #include <linux/completion.h>
34 #include <linux/of_irq.h>
35 #include <linux/regulator/consumer.h>
36 #include <linux/of_platform.h>
37 #include <linux/err.h>
39 #include <linux/iio/iio.h>
40 #include <linux/iio/machine.h>
41 #include <linux/iio/driver.h>
43 /* S3C/EXYNOS4412/5250 ADC_V1 registers definitions */
44 #define ADC_V1_CON(x) ((x) + 0x00)
45 #define ADC_V1_DLY(x) ((x) + 0x08)
46 #define ADC_V1_DATX(x) ((x) + 0x0C)
47 #define ADC_V1_INTCLR(x) ((x) + 0x18)
48 #define ADC_V1_MUX(x) ((x) + 0x1c)
50 /* Future ADC_V2 registers definitions */
51 #define ADC_V2_CON1(x) ((x) + 0x00)
52 #define ADC_V2_CON2(x) ((x) + 0x04)
53 #define ADC_V2_STAT(x) ((x) + 0x08)
54 #define ADC_V2_INT_EN(x) ((x) + 0x10)
55 #define ADC_V2_INT_ST(x) ((x) + 0x14)
56 #define ADC_V2_VER(x) ((x) + 0x20)
58 /* Bit definitions for ADC_V1 */
59 #define ADC_V1_CON_RES (1u << 16)
60 #define ADC_V1_CON_PRSCEN (1u << 14)
61 #define ADC_V1_CON_PRSCLV(x) (((x) & 0xFF) << 6)
62 #define ADC_V1_CON_STANDBY (1u << 2)
64 /* Bit definitions for S3C2410 ADC */
65 #define ADC_S3C2410_CON_SELMUX(x) (((x) & 7) << 3)
67 /* Bit definitions for ADC_V2 */
68 #define ADC_V2_CON1_SOFT_RESET (1u << 2)
70 #define ADC_V2_CON2_OSEL (1u << 10)
71 #define ADC_V2_CON2_ESEL (1u << 9)
72 #define ADC_V2_CON2_HIGHF (1u << 8)
73 #define ADC_V2_CON2_C_TIME(x) (((x) & 7) << 4)
74 #define ADC_V2_CON2_ACH_SEL(x) (((x) & 0xF) << 0)
75 #define ADC_V2_CON2_ACH_MASK 0xF
77 #define MAX_ADC_V2_CHANNELS 10
78 #define MAX_ADC_V1_CHANNELS 8
79 #define MAX_EXYNOS3250_ADC_CHANNELS 2
81 /* Bit definitions common for ADC_V1 and ADC_V2 */
82 #define ADC_CON_EN_START (1u << 0)
83 #define ADC_DATX_MASK 0xFFF
85 #define EXYNOS_ADC_TIMEOUT (msecs_to_jiffies(100))
88 struct exynos_adc_data *data;
91 void __iomem *enable_reg;
95 struct regulator *vdd;
97 struct completion completion;
100 unsigned int version;
103 struct exynos_adc_data {
107 void (*init_hw)(struct exynos_adc *info);
108 void (*exit_hw)(struct exynos_adc *info);
109 void (*clear_irq)(struct exynos_adc *info);
110 void (*start_conv)(struct exynos_adc *info, unsigned long addr);
113 static void exynos_adc_unprepare_clk(struct exynos_adc *info)
115 if (info->data->needs_sclk)
116 clk_unprepare(info->sclk);
117 clk_unprepare(info->clk);
120 static int exynos_adc_prepare_clk(struct exynos_adc *info)
124 ret = clk_prepare(info->clk);
126 dev_err(info->dev, "failed preparing adc clock: %d\n", ret);
130 if (info->data->needs_sclk) {
131 ret = clk_prepare(info->sclk);
133 clk_unprepare(info->clk);
135 "failed preparing sclk_adc clock: %d\n", ret);
143 static void exynos_adc_disable_clk(struct exynos_adc *info)
145 if (info->data->needs_sclk)
146 clk_disable(info->sclk);
147 clk_disable(info->clk);
150 static int exynos_adc_enable_clk(struct exynos_adc *info)
154 ret = clk_enable(info->clk);
156 dev_err(info->dev, "failed enabling adc clock: %d\n", ret);
160 if (info->data->needs_sclk) {
161 ret = clk_enable(info->sclk);
163 clk_disable(info->clk);
165 "failed enabling sclk_adc clock: %d\n", ret);
173 static void exynos_adc_v1_init_hw(struct exynos_adc *info)
177 writel(1, info->enable_reg);
179 /* set default prescaler values and Enable prescaler */
180 con1 = ADC_V1_CON_PRSCLV(49) | ADC_V1_CON_PRSCEN;
182 /* Enable 12-bit ADC resolution */
183 con1 |= ADC_V1_CON_RES;
184 writel(con1, ADC_V1_CON(info->regs));
187 static void exynos_adc_v1_exit_hw(struct exynos_adc *info)
191 writel(0, info->enable_reg);
193 con = readl(ADC_V1_CON(info->regs));
194 con |= ADC_V1_CON_STANDBY;
195 writel(con, ADC_V1_CON(info->regs));
198 static void exynos_adc_v1_clear_irq(struct exynos_adc *info)
200 writel(1, ADC_V1_INTCLR(info->regs));
203 static void exynos_adc_v1_start_conv(struct exynos_adc *info,
208 writel(addr, ADC_V1_MUX(info->regs));
210 con1 = readl(ADC_V1_CON(info->regs));
211 writel(con1 | ADC_CON_EN_START, ADC_V1_CON(info->regs));
214 static const struct exynos_adc_data exynos_adc_v1_data = {
215 .num_channels = MAX_ADC_V1_CHANNELS,
217 .init_hw = exynos_adc_v1_init_hw,
218 .exit_hw = exynos_adc_v1_exit_hw,
219 .clear_irq = exynos_adc_v1_clear_irq,
220 .start_conv = exynos_adc_v1_start_conv,
223 static void exynos_adc_s3c64xx_start_conv(struct exynos_adc *info,
228 con1 = readl(ADC_V1_CON(info->regs));
229 con1 &= ~ADC_S3C2410_CON_SELMUX(0x7);
230 con1 |= ADC_S3C2410_CON_SELMUX(addr);
231 writel(con1 | ADC_CON_EN_START, ADC_V1_CON(info->regs));
234 static struct exynos_adc_data const exynos_adc_s3c64xx_data = {
235 .num_channels = MAX_ADC_V1_CHANNELS,
237 .init_hw = exynos_adc_v1_init_hw,
238 .exit_hw = exynos_adc_v1_exit_hw,
239 .clear_irq = exynos_adc_v1_clear_irq,
240 .start_conv = exynos_adc_s3c64xx_start_conv,
243 static void exynos_adc_v2_init_hw(struct exynos_adc *info)
247 writel(1, info->enable_reg);
249 con1 = ADC_V2_CON1_SOFT_RESET;
250 writel(con1, ADC_V2_CON1(info->regs));
252 con2 = ADC_V2_CON2_OSEL | ADC_V2_CON2_ESEL |
253 ADC_V2_CON2_HIGHF | ADC_V2_CON2_C_TIME(0);
254 writel(con2, ADC_V2_CON2(info->regs));
256 /* Enable interrupts */
257 writel(1, ADC_V2_INT_EN(info->regs));
260 static void exynos_adc_v2_exit_hw(struct exynos_adc *info)
264 writel(0, info->enable_reg);
266 con = readl(ADC_V2_CON1(info->regs));
267 con &= ~ADC_CON_EN_START;
268 writel(con, ADC_V2_CON1(info->regs));
271 static void exynos_adc_v2_clear_irq(struct exynos_adc *info)
273 writel(1, ADC_V2_INT_ST(info->regs));
276 static void exynos_adc_v2_start_conv(struct exynos_adc *info,
281 con2 = readl(ADC_V2_CON2(info->regs));
282 con2 &= ~ADC_V2_CON2_ACH_MASK;
283 con2 |= ADC_V2_CON2_ACH_SEL(addr);
284 writel(con2, ADC_V2_CON2(info->regs));
286 con1 = readl(ADC_V2_CON1(info->regs));
287 writel(con1 | ADC_CON_EN_START, ADC_V2_CON1(info->regs));
290 static const struct exynos_adc_data exynos_adc_v2_data = {
291 .num_channels = MAX_ADC_V2_CHANNELS,
293 .init_hw = exynos_adc_v2_init_hw,
294 .exit_hw = exynos_adc_v2_exit_hw,
295 .clear_irq = exynos_adc_v2_clear_irq,
296 .start_conv = exynos_adc_v2_start_conv,
299 static const struct exynos_adc_data exynos3250_adc_data = {
300 .num_channels = MAX_EXYNOS3250_ADC_CHANNELS,
303 .init_hw = exynos_adc_v2_init_hw,
304 .exit_hw = exynos_adc_v2_exit_hw,
305 .clear_irq = exynos_adc_v2_clear_irq,
306 .start_conv = exynos_adc_v2_start_conv,
309 static const struct of_device_id exynos_adc_match[] = {
311 .compatible = "samsung,s3c6410-adc",
312 .data = &exynos_adc_s3c64xx_data,
314 .compatible = "samsung,exynos-adc-v1",
315 .data = &exynos_adc_v1_data,
317 .compatible = "samsung,exynos-adc-v2",
318 .data = &exynos_adc_v2_data,
320 .compatible = "samsung,exynos3250-adc",
321 .data = &exynos3250_adc_data,
325 MODULE_DEVICE_TABLE(of, exynos_adc_match);
327 static struct exynos_adc_data *exynos_adc_get_data(struct platform_device *pdev)
329 const struct of_device_id *match;
331 match = of_match_node(exynos_adc_match, pdev->dev.of_node);
332 return (struct exynos_adc_data *)match->data;
335 static int exynos_read_raw(struct iio_dev *indio_dev,
336 struct iio_chan_spec const *chan,
341 struct exynos_adc *info = iio_priv(indio_dev);
342 unsigned long timeout;
345 if (mask != IIO_CHAN_INFO_RAW)
348 mutex_lock(&indio_dev->mlock);
349 reinit_completion(&info->completion);
351 /* Select the channel to be used and Trigger conversion */
352 if (info->data->start_conv)
353 info->data->start_conv(info, chan->address);
355 timeout = wait_for_completion_timeout
356 (&info->completion, EXYNOS_ADC_TIMEOUT);
358 dev_warn(&indio_dev->dev, "Conversion timed out! Resetting\n");
359 if (info->data->init_hw)
360 info->data->init_hw(info);
368 mutex_unlock(&indio_dev->mlock);
373 static irqreturn_t exynos_adc_isr(int irq, void *dev_id)
375 struct exynos_adc *info = (struct exynos_adc *)dev_id;
378 info->value = readl(ADC_V1_DATX(info->regs)) & ADC_DATX_MASK;
381 if (info->data->clear_irq)
382 info->data->clear_irq(info);
384 complete(&info->completion);
389 static int exynos_adc_reg_access(struct iio_dev *indio_dev,
390 unsigned reg, unsigned writeval,
393 struct exynos_adc *info = iio_priv(indio_dev);
398 *readval = readl(info->regs + reg);
403 static const struct iio_info exynos_adc_iio_info = {
404 .read_raw = &exynos_read_raw,
405 .debugfs_reg_access = &exynos_adc_reg_access,
406 .driver_module = THIS_MODULE,
409 #define ADC_CHANNEL(_index, _id) { \
410 .type = IIO_VOLTAGE, \
414 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
415 .datasheet_name = _id, \
418 static const struct iio_chan_spec exynos_adc_iio_channels[] = {
419 ADC_CHANNEL(0, "adc0"),
420 ADC_CHANNEL(1, "adc1"),
421 ADC_CHANNEL(2, "adc2"),
422 ADC_CHANNEL(3, "adc3"),
423 ADC_CHANNEL(4, "adc4"),
424 ADC_CHANNEL(5, "adc5"),
425 ADC_CHANNEL(6, "adc6"),
426 ADC_CHANNEL(7, "adc7"),
427 ADC_CHANNEL(8, "adc8"),
428 ADC_CHANNEL(9, "adc9"),
431 static int exynos_adc_remove_devices(struct device *dev, void *c)
433 struct platform_device *pdev = to_platform_device(dev);
435 platform_device_unregister(pdev);
440 static int exynos_adc_probe(struct platform_device *pdev)
442 struct exynos_adc *info = NULL;
443 struct device_node *np = pdev->dev.of_node;
444 struct iio_dev *indio_dev = NULL;
445 struct resource *mem;
452 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(struct exynos_adc));
454 dev_err(&pdev->dev, "failed allocating iio device\n");
458 info = iio_priv(indio_dev);
460 info->data = exynos_adc_get_data(pdev);
462 dev_err(&pdev->dev, "failed getting exynos_adc_data\n");
466 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
467 info->regs = devm_ioremap_resource(&pdev->dev, mem);
468 if (IS_ERR(info->regs))
469 return PTR_ERR(info->regs);
471 mem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
472 info->enable_reg = devm_ioremap_resource(&pdev->dev, mem);
473 if (IS_ERR(info->enable_reg))
474 return PTR_ERR(info->enable_reg);
476 irq = platform_get_irq(pdev, 0);
478 dev_err(&pdev->dev, "no irq resource?\n");
483 info->dev = &pdev->dev;
485 init_completion(&info->completion);
487 info->clk = devm_clk_get(&pdev->dev, "adc");
488 if (IS_ERR(info->clk)) {
489 dev_err(&pdev->dev, "failed getting clock, err = %ld\n",
491 return PTR_ERR(info->clk);
494 if (info->data->needs_sclk) {
495 info->sclk = devm_clk_get(&pdev->dev, "sclk");
496 if (IS_ERR(info->sclk)) {
498 "failed getting sclk clock, err = %ld\n",
499 PTR_ERR(info->sclk));
500 return PTR_ERR(info->sclk);
504 info->vdd = devm_regulator_get(&pdev->dev, "vdd");
505 if (IS_ERR(info->vdd)) {
506 dev_err(&pdev->dev, "failed getting regulator, err = %ld\n",
508 return PTR_ERR(info->vdd);
511 ret = regulator_enable(info->vdd);
515 ret = exynos_adc_prepare_clk(info);
517 goto err_disable_reg;
519 ret = exynos_adc_enable_clk(info);
521 goto err_unprepare_clk;
523 platform_set_drvdata(pdev, indio_dev);
525 indio_dev->name = dev_name(&pdev->dev);
526 indio_dev->dev.parent = &pdev->dev;
527 indio_dev->dev.of_node = pdev->dev.of_node;
528 indio_dev->info = &exynos_adc_iio_info;
529 indio_dev->modes = INDIO_DIRECT_MODE;
530 indio_dev->channels = exynos_adc_iio_channels;
531 indio_dev->num_channels = info->data->num_channels;
533 ret = request_irq(info->irq, exynos_adc_isr,
534 0, dev_name(&pdev->dev), info);
536 dev_err(&pdev->dev, "failed requesting irq, irq = %d\n",
538 goto err_disable_clk;
541 ret = iio_device_register(indio_dev);
545 if (info->data->init_hw)
546 info->data->init_hw(info);
548 ret = of_platform_populate(np, exynos_adc_match, NULL, &indio_dev->dev);
550 dev_err(&pdev->dev, "failed adding child nodes\n");
551 goto err_of_populate;
557 device_for_each_child(&indio_dev->dev, NULL,
558 exynos_adc_remove_devices);
559 iio_device_unregister(indio_dev);
561 free_irq(info->irq, info);
563 if (info->data->exit_hw)
564 info->data->exit_hw(info);
565 exynos_adc_disable_clk(info);
567 exynos_adc_unprepare_clk(info);
569 regulator_disable(info->vdd);
573 static int exynos_adc_remove(struct platform_device *pdev)
575 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
576 struct exynos_adc *info = iio_priv(indio_dev);
578 device_for_each_child(&indio_dev->dev, NULL,
579 exynos_adc_remove_devices);
580 iio_device_unregister(indio_dev);
581 free_irq(info->irq, info);
582 if (info->data->exit_hw)
583 info->data->exit_hw(info);
584 exynos_adc_disable_clk(info);
585 exynos_adc_unprepare_clk(info);
586 regulator_disable(info->vdd);
591 #ifdef CONFIG_PM_SLEEP
592 static int exynos_adc_suspend(struct device *dev)
594 struct iio_dev *indio_dev = dev_get_drvdata(dev);
595 struct exynos_adc *info = iio_priv(indio_dev);
597 if (info->data->exit_hw)
598 info->data->exit_hw(info);
599 exynos_adc_disable_clk(info);
600 regulator_disable(info->vdd);
605 static int exynos_adc_resume(struct device *dev)
607 struct iio_dev *indio_dev = dev_get_drvdata(dev);
608 struct exynos_adc *info = iio_priv(indio_dev);
611 ret = regulator_enable(info->vdd);
615 ret = exynos_adc_enable_clk(info);
619 if (info->data->init_hw)
620 info->data->init_hw(info);
626 static SIMPLE_DEV_PM_OPS(exynos_adc_pm_ops,
630 static struct platform_driver exynos_adc_driver = {
631 .probe = exynos_adc_probe,
632 .remove = exynos_adc_remove,
634 .name = "exynos-adc",
635 .owner = THIS_MODULE,
636 .of_match_table = exynos_adc_match,
637 .pm = &exynos_adc_pm_ops,
641 module_platform_driver(exynos_adc_driver);
643 MODULE_AUTHOR("Naveen Krishna Chatradhi <ch.naveen@samsung.com>");
644 MODULE_DESCRIPTION("Samsung EXYNOS5 ADC driver");
645 MODULE_LICENSE("GPL v2");