1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (C) 2018 Spreadtrum Communications Inc.
4 #include <linux/hwspinlock.h>
5 #include <linux/iio/iio.h>
6 #include <linux/interrupt.h>
7 #include <linux/module.h>
8 #include <linux/nvmem-consumer.h>
10 #include <linux/of_device.h>
11 #include <linux/platform_device.h>
12 #include <linux/regmap.h>
13 #include <linux/slab.h>
15 /* PMIC global registers definition */
16 #define SC27XX_MODULE_EN 0xc08
17 #define SC27XX_MODULE_ADC_EN BIT(5)
18 #define SC27XX_ARM_CLK_EN 0xc10
19 #define SC27XX_CLK_ADC_EN BIT(5)
20 #define SC27XX_CLK_ADC_CLK_EN BIT(6)
22 /* ADC controller registers definition */
23 #define SC27XX_ADC_CTL 0x0
24 #define SC27XX_ADC_CH_CFG 0x4
25 #define SC27XX_ADC_DATA 0x4c
26 #define SC27XX_ADC_INT_EN 0x50
27 #define SC27XX_ADC_INT_CLR 0x54
28 #define SC27XX_ADC_INT_STS 0x58
29 #define SC27XX_ADC_INT_RAW 0x5c
31 /* Bits and mask definition for SC27XX_ADC_CTL register */
32 #define SC27XX_ADC_EN BIT(0)
33 #define SC27XX_ADC_CHN_RUN BIT(1)
34 #define SC27XX_ADC_12BIT_MODE BIT(2)
35 #define SC27XX_ADC_RUN_NUM_MASK GENMASK(7, 4)
36 #define SC27XX_ADC_RUN_NUM_SHIFT 4
38 /* Bits and mask definition for SC27XX_ADC_CH_CFG register */
39 #define SC27XX_ADC_CHN_ID_MASK GENMASK(4, 0)
40 #define SC27XX_ADC_SCALE_MASK GENMASK(10, 8)
41 #define SC27XX_ADC_SCALE_SHIFT 8
43 /* Bits definitions for SC27XX_ADC_INT_EN registers */
44 #define SC27XX_ADC_IRQ_EN BIT(0)
46 /* Bits definitions for SC27XX_ADC_INT_CLR registers */
47 #define SC27XX_ADC_IRQ_CLR BIT(0)
49 /* Mask definition for SC27XX_ADC_DATA register */
50 #define SC27XX_ADC_DATA_MASK GENMASK(11, 0)
52 /* Timeout (ms) for the trylock of hardware spinlocks */
53 #define SC27XX_ADC_HWLOCK_TIMEOUT 5000
55 /* Maximum ADC channel number */
56 #define SC27XX_ADC_CHANNEL_MAX 32
58 /* ADC voltage ratio definition */
59 #define SC27XX_VOLT_RATIO(n, d) \
60 (((n) << SC27XX_RATIO_NUMERATOR_OFFSET) | (d))
61 #define SC27XX_RATIO_NUMERATOR_OFFSET 16
62 #define SC27XX_RATIO_DENOMINATOR_MASK GENMASK(15, 0)
64 struct sc27xx_adc_data {
66 struct regmap *regmap;
68 * One hardware spinlock to synchronize between the multiple
69 * subsystems which will access the unique ADC controller.
71 struct hwspinlock *hwlock;
72 struct completion completion;
73 int channel_scale[SC27XX_ADC_CHANNEL_MAX];
79 struct sc27xx_adc_linear_graph {
87 * According to the datasheet, we can convert one ADC value to one voltage value
88 * through 2 points in the linear graph. If the voltage is less than 1.2v, we
89 * should use the small-scale graph, and if more than 1.2v, we should use the
92 static struct sc27xx_adc_linear_graph big_scale_graph = {
97 static struct sc27xx_adc_linear_graph small_scale_graph = {
102 static const struct sc27xx_adc_linear_graph big_scale_graph_calib = {
107 static const struct sc27xx_adc_linear_graph small_scale_graph_calib = {
112 static int sc27xx_adc_get_calib_data(u32 calib_data, int calib_adc)
114 return ((calib_data & 0xff) + calib_adc - 128) * 4;
117 static int sc27xx_adc_scale_calibration(struct sc27xx_adc_data *data,
120 const struct sc27xx_adc_linear_graph *calib_graph;
121 struct sc27xx_adc_linear_graph *graph;
122 struct nvmem_cell *cell;
123 const char *cell_name;
129 calib_graph = &big_scale_graph_calib;
130 graph = &big_scale_graph;
131 cell_name = "big_scale_calib";
133 calib_graph = &small_scale_graph_calib;
134 graph = &small_scale_graph;
135 cell_name = "small_scale_calib";
138 cell = nvmem_cell_get(data->dev, cell_name);
140 return PTR_ERR(cell);
142 buf = nvmem_cell_read(cell, &len);
143 nvmem_cell_put(cell);
148 memcpy(&calib_data, buf, min(len, sizeof(u32)));
150 /* Only need to calibrate the adc values in the linear graph. */
151 graph->adc0 = sc27xx_adc_get_calib_data(calib_data, calib_graph->adc0);
152 graph->adc1 = sc27xx_adc_get_calib_data(calib_data >> 8,
159 static int sc27xx_adc_get_ratio(int channel, int scale)
166 return scale ? SC27XX_VOLT_RATIO(400, 1025) :
167 SC27XX_VOLT_RATIO(1, 1);
169 return SC27XX_VOLT_RATIO(7, 29);
171 return SC27XX_VOLT_RATIO(375, 9000);
174 return scale ? SC27XX_VOLT_RATIO(100, 125) :
175 SC27XX_VOLT_RATIO(1, 1);
177 return SC27XX_VOLT_RATIO(1, 3);
179 return SC27XX_VOLT_RATIO(1, 1);
181 return SC27XX_VOLT_RATIO(1, 1);
184 static int sc27xx_adc_read(struct sc27xx_adc_data *data, int channel,
190 reinit_completion(&data->completion);
192 ret = hwspin_lock_timeout_raw(data->hwlock, SC27XX_ADC_HWLOCK_TIMEOUT);
194 dev_err(data->dev, "timeout to get the hwspinlock\n");
198 ret = regmap_update_bits(data->regmap, data->base + SC27XX_ADC_CTL,
199 SC27XX_ADC_EN, SC27XX_ADC_EN);
203 /* Configure the channel id and scale */
204 tmp = (scale << SC27XX_ADC_SCALE_SHIFT) & SC27XX_ADC_SCALE_MASK;
205 tmp |= channel & SC27XX_ADC_CHN_ID_MASK;
206 ret = regmap_update_bits(data->regmap, data->base + SC27XX_ADC_CH_CFG,
207 SC27XX_ADC_CHN_ID_MASK | SC27XX_ADC_SCALE_MASK,
212 /* Select 12bit conversion mode, and only sample 1 time */
213 tmp = SC27XX_ADC_12BIT_MODE;
214 tmp |= (0 << SC27XX_ADC_RUN_NUM_SHIFT) & SC27XX_ADC_RUN_NUM_MASK;
215 ret = regmap_update_bits(data->regmap, data->base + SC27XX_ADC_CTL,
216 SC27XX_ADC_RUN_NUM_MASK | SC27XX_ADC_12BIT_MODE,
221 ret = regmap_update_bits(data->regmap, data->base + SC27XX_ADC_CTL,
222 SC27XX_ADC_CHN_RUN, SC27XX_ADC_CHN_RUN);
226 wait_for_completion(&data->completion);
229 regmap_update_bits(data->regmap, data->base + SC27XX_ADC_CTL,
232 hwspin_unlock_raw(data->hwlock);
240 static irqreturn_t sc27xx_adc_isr(int irq, void *dev_id)
242 struct sc27xx_adc_data *data = dev_id;
245 ret = regmap_update_bits(data->regmap, data->base + SC27XX_ADC_INT_CLR,
246 SC27XX_ADC_IRQ_CLR, SC27XX_ADC_IRQ_CLR);
248 return IRQ_RETVAL(ret);
250 ret = regmap_read(data->regmap, data->base + SC27XX_ADC_DATA,
253 return IRQ_RETVAL(ret);
255 data->value &= SC27XX_ADC_DATA_MASK;
256 complete(&data->completion);
261 static void sc27xx_adc_volt_ratio(struct sc27xx_adc_data *data,
262 int channel, int scale,
263 u32 *div_numerator, u32 *div_denominator)
265 u32 ratio = sc27xx_adc_get_ratio(channel, scale);
267 *div_numerator = ratio >> SC27XX_RATIO_NUMERATOR_OFFSET;
268 *div_denominator = ratio & SC27XX_RATIO_DENOMINATOR_MASK;
271 static int sc27xx_adc_to_volt(struct sc27xx_adc_linear_graph *graph,
276 tmp = (graph->volt0 - graph->volt1) * (raw_adc - graph->adc1);
277 tmp /= (graph->adc0 - graph->adc1);
280 return tmp < 0 ? 0 : tmp;
283 static int sc27xx_adc_convert_volt(struct sc27xx_adc_data *data, int channel,
284 int scale, int raw_adc)
286 u32 numerator, denominator;
290 * Convert ADC values to voltage values according to the linear graph,
291 * and channel 5 and channel 1 has been calibrated, so we can just
292 * return the voltage values calculated by the linear graph. But other
293 * channels need be calculated to the real voltage values with the
298 return sc27xx_adc_to_volt(&big_scale_graph, raw_adc);
301 return sc27xx_adc_to_volt(&small_scale_graph, raw_adc);
304 volt = sc27xx_adc_to_volt(&small_scale_graph, raw_adc);
308 sc27xx_adc_volt_ratio(data, channel, scale, &numerator, &denominator);
310 return (volt * denominator + numerator / 2) / numerator;
313 static int sc27xx_adc_read_processed(struct sc27xx_adc_data *data,
314 int channel, int scale, int *val)
318 ret = sc27xx_adc_read(data, channel, scale, &raw_adc);
322 *val = sc27xx_adc_convert_volt(data, channel, scale, raw_adc);
326 static int sc27xx_adc_read_raw(struct iio_dev *indio_dev,
327 struct iio_chan_spec const *chan,
328 int *val, int *val2, long mask)
330 struct sc27xx_adc_data *data = iio_priv(indio_dev);
331 int scale = data->channel_scale[chan->channel];
335 case IIO_CHAN_INFO_RAW:
336 mutex_lock(&indio_dev->mlock);
337 ret = sc27xx_adc_read(data, chan->channel, scale, &tmp);
338 mutex_unlock(&indio_dev->mlock);
346 case IIO_CHAN_INFO_PROCESSED:
347 mutex_lock(&indio_dev->mlock);
348 ret = sc27xx_adc_read_processed(data, chan->channel, scale,
350 mutex_unlock(&indio_dev->mlock);
358 case IIO_CHAN_INFO_SCALE:
367 static int sc27xx_adc_write_raw(struct iio_dev *indio_dev,
368 struct iio_chan_spec const *chan,
369 int val, int val2, long mask)
371 struct sc27xx_adc_data *data = iio_priv(indio_dev);
374 case IIO_CHAN_INFO_SCALE:
375 data->channel_scale[chan->channel] = val;
383 static const struct iio_info sc27xx_info = {
384 .read_raw = &sc27xx_adc_read_raw,
385 .write_raw = &sc27xx_adc_write_raw,
388 #define SC27XX_ADC_CHANNEL(index, mask) { \
389 .type = IIO_VOLTAGE, \
391 .info_mask_separate = mask | BIT(IIO_CHAN_INFO_SCALE), \
392 .datasheet_name = "CH##index", \
396 static const struct iio_chan_spec sc27xx_channels[] = {
397 SC27XX_ADC_CHANNEL(0, BIT(IIO_CHAN_INFO_PROCESSED)),
398 SC27XX_ADC_CHANNEL(1, BIT(IIO_CHAN_INFO_PROCESSED)),
399 SC27XX_ADC_CHANNEL(2, BIT(IIO_CHAN_INFO_PROCESSED)),
400 SC27XX_ADC_CHANNEL(3, BIT(IIO_CHAN_INFO_PROCESSED)),
401 SC27XX_ADC_CHANNEL(4, BIT(IIO_CHAN_INFO_PROCESSED)),
402 SC27XX_ADC_CHANNEL(5, BIT(IIO_CHAN_INFO_PROCESSED)),
403 SC27XX_ADC_CHANNEL(6, BIT(IIO_CHAN_INFO_PROCESSED)),
404 SC27XX_ADC_CHANNEL(7, BIT(IIO_CHAN_INFO_PROCESSED)),
405 SC27XX_ADC_CHANNEL(8, BIT(IIO_CHAN_INFO_PROCESSED)),
406 SC27XX_ADC_CHANNEL(9, BIT(IIO_CHAN_INFO_PROCESSED)),
407 SC27XX_ADC_CHANNEL(10, BIT(IIO_CHAN_INFO_PROCESSED)),
408 SC27XX_ADC_CHANNEL(11, BIT(IIO_CHAN_INFO_PROCESSED)),
409 SC27XX_ADC_CHANNEL(12, BIT(IIO_CHAN_INFO_PROCESSED)),
410 SC27XX_ADC_CHANNEL(13, BIT(IIO_CHAN_INFO_PROCESSED)),
411 SC27XX_ADC_CHANNEL(14, BIT(IIO_CHAN_INFO_PROCESSED)),
412 SC27XX_ADC_CHANNEL(15, BIT(IIO_CHAN_INFO_PROCESSED)),
413 SC27XX_ADC_CHANNEL(16, BIT(IIO_CHAN_INFO_PROCESSED)),
414 SC27XX_ADC_CHANNEL(17, BIT(IIO_CHAN_INFO_PROCESSED)),
415 SC27XX_ADC_CHANNEL(18, BIT(IIO_CHAN_INFO_PROCESSED)),
416 SC27XX_ADC_CHANNEL(19, BIT(IIO_CHAN_INFO_PROCESSED)),
417 SC27XX_ADC_CHANNEL(20, BIT(IIO_CHAN_INFO_RAW)),
418 SC27XX_ADC_CHANNEL(21, BIT(IIO_CHAN_INFO_PROCESSED)),
419 SC27XX_ADC_CHANNEL(22, BIT(IIO_CHAN_INFO_PROCESSED)),
420 SC27XX_ADC_CHANNEL(23, BIT(IIO_CHAN_INFO_PROCESSED)),
421 SC27XX_ADC_CHANNEL(24, BIT(IIO_CHAN_INFO_PROCESSED)),
422 SC27XX_ADC_CHANNEL(25, BIT(IIO_CHAN_INFO_PROCESSED)),
423 SC27XX_ADC_CHANNEL(26, BIT(IIO_CHAN_INFO_PROCESSED)),
424 SC27XX_ADC_CHANNEL(27, BIT(IIO_CHAN_INFO_PROCESSED)),
425 SC27XX_ADC_CHANNEL(28, BIT(IIO_CHAN_INFO_PROCESSED)),
426 SC27XX_ADC_CHANNEL(29, BIT(IIO_CHAN_INFO_PROCESSED)),
427 SC27XX_ADC_CHANNEL(30, BIT(IIO_CHAN_INFO_PROCESSED)),
428 SC27XX_ADC_CHANNEL(31, BIT(IIO_CHAN_INFO_PROCESSED)),
431 static int sc27xx_adc_enable(struct sc27xx_adc_data *data)
435 ret = regmap_update_bits(data->regmap, SC27XX_MODULE_EN,
436 SC27XX_MODULE_ADC_EN, SC27XX_MODULE_ADC_EN);
440 /* Enable ADC work clock and controller clock */
441 ret = regmap_update_bits(data->regmap, SC27XX_ARM_CLK_EN,
442 SC27XX_CLK_ADC_EN | SC27XX_CLK_ADC_CLK_EN,
443 SC27XX_CLK_ADC_EN | SC27XX_CLK_ADC_CLK_EN);
447 ret = regmap_update_bits(data->regmap, data->base + SC27XX_ADC_INT_EN,
448 SC27XX_ADC_IRQ_EN, SC27XX_ADC_IRQ_EN);
452 /* ADC channel scales' calibration from nvmem device */
453 ret = sc27xx_adc_scale_calibration(data, true);
457 ret = sc27xx_adc_scale_calibration(data, false);
464 regmap_update_bits(data->regmap, SC27XX_ARM_CLK_EN,
465 SC27XX_CLK_ADC_EN | SC27XX_CLK_ADC_CLK_EN, 0);
467 regmap_update_bits(data->regmap, SC27XX_MODULE_EN,
468 SC27XX_MODULE_ADC_EN, 0);
473 static void sc27xx_adc_disable(void *_data)
475 struct sc27xx_adc_data *data = _data;
477 regmap_update_bits(data->regmap, data->base + SC27XX_ADC_INT_EN,
478 SC27XX_ADC_IRQ_EN, 0);
480 /* Disable ADC work clock and controller clock */
481 regmap_update_bits(data->regmap, SC27XX_ARM_CLK_EN,
482 SC27XX_CLK_ADC_EN | SC27XX_CLK_ADC_CLK_EN, 0);
484 regmap_update_bits(data->regmap, SC27XX_MODULE_EN,
485 SC27XX_MODULE_ADC_EN, 0);
488 static void sc27xx_adc_free_hwlock(void *_data)
490 struct hwspinlock *hwlock = _data;
492 hwspin_lock_free(hwlock);
495 static int sc27xx_adc_probe(struct platform_device *pdev)
497 struct device_node *np = pdev->dev.of_node;
498 struct sc27xx_adc_data *sc27xx_data;
499 struct iio_dev *indio_dev;
502 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*sc27xx_data));
506 sc27xx_data = iio_priv(indio_dev);
508 sc27xx_data->regmap = dev_get_regmap(pdev->dev.parent, NULL);
509 if (!sc27xx_data->regmap) {
510 dev_err(&pdev->dev, "failed to get ADC regmap\n");
514 ret = of_property_read_u32(np, "reg", &sc27xx_data->base);
516 dev_err(&pdev->dev, "failed to get ADC base address\n");
520 sc27xx_data->irq = platform_get_irq(pdev, 0);
521 if (sc27xx_data->irq < 0) {
522 dev_err(&pdev->dev, "failed to get ADC irq number\n");
523 return sc27xx_data->irq;
526 ret = of_hwspin_lock_get_id(np, 0);
528 dev_err(&pdev->dev, "failed to get hwspinlock id\n");
532 sc27xx_data->hwlock = hwspin_lock_request_specific(ret);
533 if (!sc27xx_data->hwlock) {
534 dev_err(&pdev->dev, "failed to request hwspinlock\n");
538 ret = devm_add_action(&pdev->dev, sc27xx_adc_free_hwlock,
539 sc27xx_data->hwlock);
541 sc27xx_adc_free_hwlock(sc27xx_data->hwlock);
542 dev_err(&pdev->dev, "failed to add hwspinlock action\n");
546 init_completion(&sc27xx_data->completion);
547 sc27xx_data->dev = &pdev->dev;
549 ret = sc27xx_adc_enable(sc27xx_data);
551 dev_err(&pdev->dev, "failed to enable ADC module\n");
555 ret = devm_add_action(&pdev->dev, sc27xx_adc_disable, sc27xx_data);
557 sc27xx_adc_disable(sc27xx_data);
558 dev_err(&pdev->dev, "failed to add ADC disable action\n");
562 ret = devm_request_threaded_irq(&pdev->dev, sc27xx_data->irq, NULL,
563 sc27xx_adc_isr, IRQF_ONESHOT,
564 pdev->name, sc27xx_data);
566 dev_err(&pdev->dev, "failed to request ADC irq\n");
570 indio_dev->dev.parent = &pdev->dev;
571 indio_dev->name = dev_name(&pdev->dev);
572 indio_dev->modes = INDIO_DIRECT_MODE;
573 indio_dev->info = &sc27xx_info;
574 indio_dev->channels = sc27xx_channels;
575 indio_dev->num_channels = ARRAY_SIZE(sc27xx_channels);
576 ret = devm_iio_device_register(&pdev->dev, indio_dev);
578 dev_err(&pdev->dev, "could not register iio (ADC)");
583 static const struct of_device_id sc27xx_adc_of_match[] = {
584 { .compatible = "sprd,sc2731-adc", },
588 static struct platform_driver sc27xx_adc_driver = {
589 .probe = sc27xx_adc_probe,
591 .name = "sc27xx-adc",
592 .of_match_table = sc27xx_adc_of_match,
596 module_platform_driver(sc27xx_adc_driver);
599 MODULE_DESCRIPTION("Spreadtrum SC27XX ADC Driver");
600 MODULE_LICENSE("GPL v2");