1 // SPDX-License-Identifier: GPL-2.0
3 * ADC driver for the Ingenic JZ47xx SoCs
4 * Copyright (c) 2019 Artur Rojek <contact@artur-rojek.eu>
6 * based on drivers/mfd/jz4740-adc.c
9 #include <dt-bindings/iio/adc/ingenic,adc.h>
10 #include <linux/clk.h>
11 #include <linux/iio/iio.h>
13 #include <linux/iopoll.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/mutex.h>
17 #include <linux/platform_device.h>
19 #define JZ_ADC_REG_ENABLE 0x00
20 #define JZ_ADC_REG_CFG 0x04
21 #define JZ_ADC_REG_CTRL 0x08
22 #define JZ_ADC_REG_STATUS 0x0c
23 #define JZ_ADC_REG_ADTCH 0x18
24 #define JZ_ADC_REG_ADBDAT 0x1c
25 #define JZ_ADC_REG_ADSDAT 0x20
26 #define JZ_ADC_REG_ADCLK 0x28
28 #define JZ_ADC_REG_ENABLE_PD BIT(7)
29 #define JZ_ADC_REG_CFG_AUX_MD (BIT(0) | BIT(1))
30 #define JZ_ADC_REG_CFG_BAT_MD BIT(4)
31 #define JZ_ADC_REG_ADCLK_CLKDIV_LSB 0
32 #define JZ4725B_ADC_REG_ADCLK_CLKDIV10US_LSB 16
33 #define JZ4770_ADC_REG_ADCLK_CLKDIV10US_LSB 8
34 #define JZ4770_ADC_REG_ADCLK_CLKDIVMS_LSB 16
36 #define JZ_ADC_AUX_VREF 3300
37 #define JZ_ADC_AUX_VREF_BITS 12
38 #define JZ_ADC_BATTERY_LOW_VREF 2500
39 #define JZ_ADC_BATTERY_LOW_VREF_BITS 12
40 #define JZ4725B_ADC_BATTERY_HIGH_VREF 7500
41 #define JZ4725B_ADC_BATTERY_HIGH_VREF_BITS 10
42 #define JZ4740_ADC_BATTERY_HIGH_VREF (7500 * 0.986)
43 #define JZ4740_ADC_BATTERY_HIGH_VREF_BITS 12
44 #define JZ4770_ADC_BATTERY_VREF 6600
45 #define JZ4770_ADC_BATTERY_VREF_BITS 12
49 struct ingenic_adc_soc_data {
50 unsigned int battery_high_vref;
51 unsigned int battery_high_vref_bits;
52 const int *battery_raw_avail;
53 size_t battery_raw_avail_size;
54 const int *battery_scale_avail;
55 size_t battery_scale_avail_size;
56 unsigned int battery_vref_mode: 1;
57 unsigned int has_aux2: 1;
58 const struct iio_chan_spec *channels;
59 unsigned int num_channels;
60 int (*init_clk_div)(struct device *dev, struct ingenic_adc *adc);
67 struct mutex aux_lock;
68 const struct ingenic_adc_soc_data *soc_data;
72 static void ingenic_adc_set_config(struct ingenic_adc *adc,
78 mutex_lock(&adc->lock);
80 cfg = readl(adc->base + JZ_ADC_REG_CFG) & ~mask;
82 writel(cfg, adc->base + JZ_ADC_REG_CFG);
84 mutex_unlock(&adc->lock);
87 static void ingenic_adc_enable(struct ingenic_adc *adc,
93 mutex_lock(&adc->lock);
94 val = readb(adc->base + JZ_ADC_REG_ENABLE);
101 writeb(val, adc->base + JZ_ADC_REG_ENABLE);
102 mutex_unlock(&adc->lock);
105 static int ingenic_adc_capture(struct ingenic_adc *adc,
111 ingenic_adc_enable(adc, engine, true);
112 ret = readb_poll_timeout(adc->base + JZ_ADC_REG_ENABLE, val,
113 !(val & BIT(engine)), 250, 1000);
115 ingenic_adc_enable(adc, engine, false);
120 static int ingenic_adc_write_raw(struct iio_dev *iio_dev,
121 struct iio_chan_spec const *chan,
126 struct ingenic_adc *adc = iio_priv(iio_dev);
127 struct device *dev = iio_dev->dev.parent;
131 case IIO_CHAN_INFO_SCALE:
132 switch (chan->channel) {
133 case INGENIC_ADC_BATTERY:
134 if (!adc->soc_data->battery_vref_mode)
137 ret = clk_enable(adc->clk);
139 dev_err(dev, "Failed to enable clock: %d\n",
144 if (val > JZ_ADC_BATTERY_LOW_VREF) {
145 ingenic_adc_set_config(adc,
146 JZ_ADC_REG_CFG_BAT_MD,
148 adc->low_vref_mode = false;
150 ingenic_adc_set_config(adc,
151 JZ_ADC_REG_CFG_BAT_MD,
152 JZ_ADC_REG_CFG_BAT_MD);
153 adc->low_vref_mode = true;
156 clk_disable(adc->clk);
167 static const int jz4725b_adc_battery_raw_avail[] = {
168 0, 1, (1 << JZ_ADC_BATTERY_LOW_VREF_BITS) - 1,
171 static const int jz4725b_adc_battery_scale_avail[] = {
172 JZ4725B_ADC_BATTERY_HIGH_VREF, JZ4725B_ADC_BATTERY_HIGH_VREF_BITS,
173 JZ_ADC_BATTERY_LOW_VREF, JZ_ADC_BATTERY_LOW_VREF_BITS,
176 static const int jz4740_adc_battery_raw_avail[] = {
177 0, 1, (1 << JZ_ADC_BATTERY_LOW_VREF_BITS) - 1,
180 static const int jz4740_adc_battery_scale_avail[] = {
181 JZ4740_ADC_BATTERY_HIGH_VREF, JZ4740_ADC_BATTERY_HIGH_VREF_BITS,
182 JZ_ADC_BATTERY_LOW_VREF, JZ_ADC_BATTERY_LOW_VREF_BITS,
185 static const int jz4770_adc_battery_raw_avail[] = {
186 0, 1, (1 << JZ4770_ADC_BATTERY_VREF_BITS) - 1,
189 static const int jz4770_adc_battery_scale_avail[] = {
190 JZ4770_ADC_BATTERY_VREF, JZ4770_ADC_BATTERY_VREF_BITS,
193 static int jz4725b_adc_init_clk_div(struct device *dev, struct ingenic_adc *adc)
195 struct clk *parent_clk;
196 unsigned long parent_rate, rate;
197 unsigned int div_main, div_10us;
199 parent_clk = clk_get_parent(adc->clk);
201 dev_err(dev, "ADC clock has no parent\n");
204 parent_rate = clk_get_rate(parent_clk);
207 * The JZ4725B ADC works at 500 kHz to 8 MHz.
208 * We pick the highest rate possible.
209 * In practice we typically get 6 MHz, half of the 12 MHz EXT clock.
211 div_main = DIV_ROUND_UP(parent_rate, 8000000);
212 div_main = clamp(div_main, 1u, 64u);
213 rate = parent_rate / div_main;
214 if (rate < 500000 || rate > 8000000) {
215 dev_err(dev, "No valid divider for ADC main clock\n");
219 /* We also need a divider that produces a 10us clock. */
220 div_10us = DIV_ROUND_UP(rate, 100000);
222 writel(((div_10us - 1) << JZ4725B_ADC_REG_ADCLK_CLKDIV10US_LSB) |
223 (div_main - 1) << JZ_ADC_REG_ADCLK_CLKDIV_LSB,
224 adc->base + JZ_ADC_REG_ADCLK);
229 static int jz4770_adc_init_clk_div(struct device *dev, struct ingenic_adc *adc)
231 struct clk *parent_clk;
232 unsigned long parent_rate, rate;
233 unsigned int div_main, div_ms, div_10us;
235 parent_clk = clk_get_parent(adc->clk);
237 dev_err(dev, "ADC clock has no parent\n");
240 parent_rate = clk_get_rate(parent_clk);
243 * The JZ4770 ADC works at 20 kHz to 200 kHz.
244 * We pick the highest rate possible.
246 div_main = DIV_ROUND_UP(parent_rate, 200000);
247 div_main = clamp(div_main, 1u, 256u);
248 rate = parent_rate / div_main;
249 if (rate < 20000 || rate > 200000) {
250 dev_err(dev, "No valid divider for ADC main clock\n");
254 /* We also need a divider that produces a 10us clock. */
255 div_10us = DIV_ROUND_UP(rate, 10000);
256 /* And another, which produces a 1ms clock. */
257 div_ms = DIV_ROUND_UP(rate, 1000);
259 writel(((div_ms - 1) << JZ4770_ADC_REG_ADCLK_CLKDIVMS_LSB) |
260 ((div_10us - 1) << JZ4770_ADC_REG_ADCLK_CLKDIV10US_LSB) |
261 (div_main - 1) << JZ_ADC_REG_ADCLK_CLKDIV_LSB,
262 adc->base + JZ_ADC_REG_ADCLK);
267 static const struct iio_chan_spec jz4740_channels[] = {
269 .extend_name = "aux",
271 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
272 BIT(IIO_CHAN_INFO_SCALE),
274 .channel = INGENIC_ADC_AUX,
278 .extend_name = "battery",
280 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
281 BIT(IIO_CHAN_INFO_SCALE),
282 .info_mask_separate_available = BIT(IIO_CHAN_INFO_RAW) |
283 BIT(IIO_CHAN_INFO_SCALE),
285 .channel = INGENIC_ADC_BATTERY,
290 static const struct iio_chan_spec jz4770_channels[] = {
292 .extend_name = "aux",
294 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
295 BIT(IIO_CHAN_INFO_SCALE),
297 .channel = INGENIC_ADC_AUX,
301 .extend_name = "battery",
303 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
304 BIT(IIO_CHAN_INFO_SCALE),
305 .info_mask_separate_available = BIT(IIO_CHAN_INFO_RAW) |
306 BIT(IIO_CHAN_INFO_SCALE),
308 .channel = INGENIC_ADC_BATTERY,
312 .extend_name = "aux2",
314 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
315 BIT(IIO_CHAN_INFO_SCALE),
317 .channel = INGENIC_ADC_AUX2,
322 static const struct ingenic_adc_soc_data jz4725b_adc_soc_data = {
323 .battery_high_vref = JZ4725B_ADC_BATTERY_HIGH_VREF,
324 .battery_high_vref_bits = JZ4725B_ADC_BATTERY_HIGH_VREF_BITS,
325 .battery_raw_avail = jz4725b_adc_battery_raw_avail,
326 .battery_raw_avail_size = ARRAY_SIZE(jz4725b_adc_battery_raw_avail),
327 .battery_scale_avail = jz4725b_adc_battery_scale_avail,
328 .battery_scale_avail_size = ARRAY_SIZE(jz4725b_adc_battery_scale_avail),
329 .battery_vref_mode = true,
331 .channels = jz4740_channels,
332 .num_channels = ARRAY_SIZE(jz4740_channels),
333 .init_clk_div = jz4725b_adc_init_clk_div,
336 static const struct ingenic_adc_soc_data jz4740_adc_soc_data = {
337 .battery_high_vref = JZ4740_ADC_BATTERY_HIGH_VREF,
338 .battery_high_vref_bits = JZ4740_ADC_BATTERY_HIGH_VREF_BITS,
339 .battery_raw_avail = jz4740_adc_battery_raw_avail,
340 .battery_raw_avail_size = ARRAY_SIZE(jz4740_adc_battery_raw_avail),
341 .battery_scale_avail = jz4740_adc_battery_scale_avail,
342 .battery_scale_avail_size = ARRAY_SIZE(jz4740_adc_battery_scale_avail),
343 .battery_vref_mode = true,
345 .channels = jz4740_channels,
346 .num_channels = ARRAY_SIZE(jz4740_channels),
347 .init_clk_div = NULL, /* no ADCLK register on JZ4740 */
350 static const struct ingenic_adc_soc_data jz4770_adc_soc_data = {
351 .battery_high_vref = JZ4770_ADC_BATTERY_VREF,
352 .battery_high_vref_bits = JZ4770_ADC_BATTERY_VREF_BITS,
353 .battery_raw_avail = jz4770_adc_battery_raw_avail,
354 .battery_raw_avail_size = ARRAY_SIZE(jz4770_adc_battery_raw_avail),
355 .battery_scale_avail = jz4770_adc_battery_scale_avail,
356 .battery_scale_avail_size = ARRAY_SIZE(jz4770_adc_battery_scale_avail),
357 .battery_vref_mode = false,
359 .channels = jz4770_channels,
360 .num_channels = ARRAY_SIZE(jz4770_channels),
361 .init_clk_div = jz4770_adc_init_clk_div,
364 static int ingenic_adc_read_avail(struct iio_dev *iio_dev,
365 struct iio_chan_spec const *chan,
371 struct ingenic_adc *adc = iio_priv(iio_dev);
374 case IIO_CHAN_INFO_RAW:
376 *length = adc->soc_data->battery_raw_avail_size;
377 *vals = adc->soc_data->battery_raw_avail;
378 return IIO_AVAIL_RANGE;
379 case IIO_CHAN_INFO_SCALE:
380 *type = IIO_VAL_FRACTIONAL_LOG2;
381 *length = adc->soc_data->battery_scale_avail_size;
382 *vals = adc->soc_data->battery_scale_avail;
383 return IIO_AVAIL_LIST;
389 static int ingenic_adc_read_chan_info_raw(struct iio_dev *iio_dev,
390 struct iio_chan_spec const *chan,
393 int bit, ret, engine = (chan->channel == INGENIC_ADC_BATTERY);
394 struct ingenic_adc *adc = iio_priv(iio_dev);
396 ret = clk_enable(adc->clk);
398 dev_err(iio_dev->dev.parent, "Failed to enable clock: %d\n",
403 /* We cannot sample AUX/AUX2 in parallel. */
404 mutex_lock(&adc->aux_lock);
405 if (adc->soc_data->has_aux2 && engine == 0) {
406 bit = BIT(chan->channel == INGENIC_ADC_AUX2);
407 ingenic_adc_set_config(adc, JZ_ADC_REG_CFG_AUX_MD, bit);
410 ret = ingenic_adc_capture(adc, engine);
414 switch (chan->channel) {
415 case INGENIC_ADC_AUX:
416 case INGENIC_ADC_AUX2:
417 *val = readw(adc->base + JZ_ADC_REG_ADSDAT);
419 case INGENIC_ADC_BATTERY:
420 *val = readw(adc->base + JZ_ADC_REG_ADBDAT);
426 mutex_unlock(&adc->aux_lock);
427 clk_disable(adc->clk);
432 static int ingenic_adc_read_raw(struct iio_dev *iio_dev,
433 struct iio_chan_spec const *chan,
438 struct ingenic_adc *adc = iio_priv(iio_dev);
441 case IIO_CHAN_INFO_RAW:
442 return ingenic_adc_read_chan_info_raw(iio_dev, chan, val);
443 case IIO_CHAN_INFO_SCALE:
444 switch (chan->channel) {
445 case INGENIC_ADC_AUX:
446 case INGENIC_ADC_AUX2:
447 *val = JZ_ADC_AUX_VREF;
448 *val2 = JZ_ADC_AUX_VREF_BITS;
450 case INGENIC_ADC_BATTERY:
451 if (adc->low_vref_mode) {
452 *val = JZ_ADC_BATTERY_LOW_VREF;
453 *val2 = JZ_ADC_BATTERY_LOW_VREF_BITS;
455 *val = adc->soc_data->battery_high_vref;
456 *val2 = adc->soc_data->battery_high_vref_bits;
461 return IIO_VAL_FRACTIONAL_LOG2;
467 static int ingenic_adc_of_xlate(struct iio_dev *iio_dev,
468 const struct of_phandle_args *iiospec)
472 if (!iiospec->args_count)
475 for (i = 0; i < iio_dev->num_channels; ++i)
476 if (iio_dev->channels[i].channel == iiospec->args[0])
482 static void ingenic_adc_clk_cleanup(void *data)
487 static const struct iio_info ingenic_adc_info = {
488 .write_raw = ingenic_adc_write_raw,
489 .read_raw = ingenic_adc_read_raw,
490 .read_avail = ingenic_adc_read_avail,
491 .of_xlate = ingenic_adc_of_xlate,
494 static int ingenic_adc_probe(struct platform_device *pdev)
496 struct device *dev = &pdev->dev;
497 struct iio_dev *iio_dev;
498 struct ingenic_adc *adc;
499 const struct ingenic_adc_soc_data *soc_data;
502 soc_data = device_get_match_data(dev);
506 iio_dev = devm_iio_device_alloc(dev, sizeof(*adc));
510 adc = iio_priv(iio_dev);
511 mutex_init(&adc->lock);
512 mutex_init(&adc->aux_lock);
513 adc->soc_data = soc_data;
515 adc->base = devm_platform_ioremap_resource(pdev, 0);
516 if (IS_ERR(adc->base))
517 return PTR_ERR(adc->base);
519 adc->clk = devm_clk_get(dev, "adc");
520 if (IS_ERR(adc->clk)) {
521 dev_err(dev, "Unable to get clock\n");
522 return PTR_ERR(adc->clk);
525 ret = clk_prepare_enable(adc->clk);
527 dev_err(dev, "Failed to enable clock\n");
531 /* Set clock dividers. */
532 if (soc_data->init_clk_div) {
533 ret = soc_data->init_clk_div(dev, adc);
535 clk_disable_unprepare(adc->clk);
540 /* Put hardware in a known passive state. */
541 writeb(0x00, adc->base + JZ_ADC_REG_ENABLE);
542 writeb(0xff, adc->base + JZ_ADC_REG_CTRL);
543 usleep_range(2000, 3000); /* Must wait at least 2ms. */
544 clk_disable(adc->clk);
546 ret = devm_add_action_or_reset(dev, ingenic_adc_clk_cleanup, adc->clk);
548 dev_err(dev, "Unable to add action\n");
552 iio_dev->dev.parent = dev;
553 iio_dev->name = "jz-adc";
554 iio_dev->modes = INDIO_DIRECT_MODE;
555 iio_dev->channels = soc_data->channels;
556 iio_dev->num_channels = soc_data->num_channels;
557 iio_dev->info = &ingenic_adc_info;
559 ret = devm_iio_device_register(dev, iio_dev);
561 dev_err(dev, "Unable to register IIO device\n");
567 static const struct of_device_id ingenic_adc_of_match[] = {
568 { .compatible = "ingenic,jz4725b-adc", .data = &jz4725b_adc_soc_data, },
569 { .compatible = "ingenic,jz4740-adc", .data = &jz4740_adc_soc_data, },
570 { .compatible = "ingenic,jz4770-adc", .data = &jz4770_adc_soc_data, },
573 MODULE_DEVICE_TABLE(of, ingenic_adc_of_match);
576 static struct platform_driver ingenic_adc_driver = {
578 .name = "ingenic-adc",
579 .of_match_table = of_match_ptr(ingenic_adc_of_match),
581 .probe = ingenic_adc_probe,
583 module_platform_driver(ingenic_adc_driver);
584 MODULE_LICENSE("GPL v2");