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/module.h>
7 #include <linux/nvmem-consumer.h>
9 #include <linux/of_device.h>
10 #include <linux/platform_device.h>
11 #include <linux/regmap.h>
12 #include <linux/slab.h>
14 /* PMIC global registers definition */
15 #define SC27XX_MODULE_EN 0xc08
16 #define SC27XX_MODULE_ADC_EN BIT(5)
17 #define SC27XX_ARM_CLK_EN 0xc10
18 #define SC27XX_CLK_ADC_EN BIT(5)
19 #define SC27XX_CLK_ADC_CLK_EN BIT(6)
21 /* ADC controller registers definition */
22 #define SC27XX_ADC_CTL 0x0
23 #define SC27XX_ADC_CH_CFG 0x4
24 #define SC27XX_ADC_DATA 0x4c
25 #define SC27XX_ADC_INT_EN 0x50
26 #define SC27XX_ADC_INT_CLR 0x54
27 #define SC27XX_ADC_INT_STS 0x58
28 #define SC27XX_ADC_INT_RAW 0x5c
30 /* Bits and mask definition for SC27XX_ADC_CTL register */
31 #define SC27XX_ADC_EN BIT(0)
32 #define SC27XX_ADC_CHN_RUN BIT(1)
33 #define SC27XX_ADC_12BIT_MODE BIT(2)
34 #define SC27XX_ADC_RUN_NUM_MASK GENMASK(7, 4)
35 #define SC27XX_ADC_RUN_NUM_SHIFT 4
37 /* Bits and mask definition for SC27XX_ADC_CH_CFG register */
38 #define SC27XX_ADC_CHN_ID_MASK GENMASK(4, 0)
39 #define SC27XX_ADC_SCALE_MASK GENMASK(10, 8)
40 #define SC27XX_ADC_SCALE_SHIFT 8
42 /* Bits definitions for SC27XX_ADC_INT_EN registers */
43 #define SC27XX_ADC_IRQ_EN BIT(0)
45 /* Bits definitions for SC27XX_ADC_INT_CLR registers */
46 #define SC27XX_ADC_IRQ_CLR BIT(0)
48 /* Bits definitions for SC27XX_ADC_INT_RAW registers */
49 #define SC27XX_ADC_IRQ_RAW BIT(0)
51 /* Mask definition for SC27XX_ADC_DATA register */
52 #define SC27XX_ADC_DATA_MASK GENMASK(11, 0)
54 /* Timeout (ms) for the trylock of hardware spinlocks */
55 #define SC27XX_ADC_HWLOCK_TIMEOUT 5000
57 /* Timeout (us) for ADC data conversion according to ADC datasheet */
58 #define SC27XX_ADC_RDY_TIMEOUT 1000000
59 #define SC27XX_ADC_POLL_RAW_STATUS 500
61 /* Maximum ADC channel number */
62 #define SC27XX_ADC_CHANNEL_MAX 32
64 /* ADC voltage ratio definition */
65 #define SC27XX_VOLT_RATIO(n, d) \
66 (((n) << SC27XX_RATIO_NUMERATOR_OFFSET) | (d))
67 #define SC27XX_RATIO_NUMERATOR_OFFSET 16
68 #define SC27XX_RATIO_DENOMINATOR_MASK GENMASK(15, 0)
70 struct sc27xx_adc_data
{
72 struct regmap
*regmap
;
74 * One hardware spinlock to synchronize between the multiple
75 * subsystems which will access the unique ADC controller.
77 struct hwspinlock
*hwlock
;
78 int channel_scale
[SC27XX_ADC_CHANNEL_MAX
];
83 struct sc27xx_adc_linear_graph
{
91 * According to the datasheet, we can convert one ADC value to one voltage value
92 * through 2 points in the linear graph. If the voltage is less than 1.2v, we
93 * should use the small-scale graph, and if more than 1.2v, we should use the
96 static struct sc27xx_adc_linear_graph big_scale_graph
= {
101 static struct sc27xx_adc_linear_graph small_scale_graph
= {
106 static const struct sc27xx_adc_linear_graph big_scale_graph_calib
= {
111 static const struct sc27xx_adc_linear_graph small_scale_graph_calib
= {
116 static int sc27xx_adc_get_calib_data(u32 calib_data
, int calib_adc
)
118 return ((calib_data
& 0xff) + calib_adc
- 128) * 4;
121 static int sc27xx_adc_scale_calibration(struct sc27xx_adc_data
*data
,
124 const struct sc27xx_adc_linear_graph
*calib_graph
;
125 struct sc27xx_adc_linear_graph
*graph
;
126 struct nvmem_cell
*cell
;
127 const char *cell_name
;
133 calib_graph
= &big_scale_graph_calib
;
134 graph
= &big_scale_graph
;
135 cell_name
= "big_scale_calib";
137 calib_graph
= &small_scale_graph_calib
;
138 graph
= &small_scale_graph
;
139 cell_name
= "small_scale_calib";
142 cell
= nvmem_cell_get(data
->dev
, cell_name
);
144 return PTR_ERR(cell
);
146 buf
= nvmem_cell_read(cell
, &len
);
147 nvmem_cell_put(cell
);
152 memcpy(&calib_data
, buf
, min(len
, sizeof(u32
)));
154 /* Only need to calibrate the adc values in the linear graph. */
155 graph
->adc0
= sc27xx_adc_get_calib_data(calib_data
, calib_graph
->adc0
);
156 graph
->adc1
= sc27xx_adc_get_calib_data(calib_data
>> 8,
163 static int sc27xx_adc_get_ratio(int channel
, int scale
)
170 return scale
? SC27XX_VOLT_RATIO(400, 1025) :
171 SC27XX_VOLT_RATIO(1, 1);
173 return SC27XX_VOLT_RATIO(7, 29);
175 return SC27XX_VOLT_RATIO(375, 9000);
178 return scale
? SC27XX_VOLT_RATIO(100, 125) :
179 SC27XX_VOLT_RATIO(1, 1);
181 return SC27XX_VOLT_RATIO(1, 3);
183 return SC27XX_VOLT_RATIO(1, 1);
185 return SC27XX_VOLT_RATIO(1, 1);
188 static int sc27xx_adc_read(struct sc27xx_adc_data
*data
, int channel
,
192 u32 tmp
, value
, status
;
194 ret
= hwspin_lock_timeout_raw(data
->hwlock
, SC27XX_ADC_HWLOCK_TIMEOUT
);
196 dev_err(data
->dev
, "timeout to get the hwspinlock\n");
200 ret
= regmap_update_bits(data
->regmap
, data
->base
+ SC27XX_ADC_CTL
,
201 SC27XX_ADC_EN
, SC27XX_ADC_EN
);
205 ret
= regmap_update_bits(data
->regmap
, data
->base
+ SC27XX_ADC_INT_CLR
,
206 SC27XX_ADC_IRQ_CLR
, SC27XX_ADC_IRQ_CLR
);
210 /* Configure the channel id and scale */
211 tmp
= (scale
<< SC27XX_ADC_SCALE_SHIFT
) & SC27XX_ADC_SCALE_MASK
;
212 tmp
|= channel
& SC27XX_ADC_CHN_ID_MASK
;
213 ret
= regmap_update_bits(data
->regmap
, data
->base
+ SC27XX_ADC_CH_CFG
,
214 SC27XX_ADC_CHN_ID_MASK
| SC27XX_ADC_SCALE_MASK
,
219 /* Select 12bit conversion mode, and only sample 1 time */
220 tmp
= SC27XX_ADC_12BIT_MODE
;
221 tmp
|= (0 << SC27XX_ADC_RUN_NUM_SHIFT
) & SC27XX_ADC_RUN_NUM_MASK
;
222 ret
= regmap_update_bits(data
->regmap
, data
->base
+ SC27XX_ADC_CTL
,
223 SC27XX_ADC_RUN_NUM_MASK
| SC27XX_ADC_12BIT_MODE
,
228 ret
= regmap_update_bits(data
->regmap
, data
->base
+ SC27XX_ADC_CTL
,
229 SC27XX_ADC_CHN_RUN
, SC27XX_ADC_CHN_RUN
);
233 ret
= regmap_read_poll_timeout(data
->regmap
,
234 data
->base
+ SC27XX_ADC_INT_RAW
,
235 status
, (status
& SC27XX_ADC_IRQ_RAW
),
236 SC27XX_ADC_POLL_RAW_STATUS
,
237 SC27XX_ADC_RDY_TIMEOUT
);
239 dev_err(data
->dev
, "read adc timeout, status = 0x%x\n", status
);
243 ret
= regmap_read(data
->regmap
, data
->base
+ SC27XX_ADC_DATA
, &value
);
247 value
&= SC27XX_ADC_DATA_MASK
;
250 regmap_update_bits(data
->regmap
, data
->base
+ SC27XX_ADC_CTL
,
253 hwspin_unlock_raw(data
->hwlock
);
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 /* ADC channel scales' calibration from nvmem device */
448 ret
= sc27xx_adc_scale_calibration(data
, true);
452 ret
= sc27xx_adc_scale_calibration(data
, false);
459 regmap_update_bits(data
->regmap
, SC27XX_ARM_CLK_EN
,
460 SC27XX_CLK_ADC_EN
| SC27XX_CLK_ADC_CLK_EN
, 0);
462 regmap_update_bits(data
->regmap
, SC27XX_MODULE_EN
,
463 SC27XX_MODULE_ADC_EN
, 0);
468 static void sc27xx_adc_disable(void *_data
)
470 struct sc27xx_adc_data
*data
= _data
;
472 /* Disable ADC work clock and controller clock */
473 regmap_update_bits(data
->regmap
, SC27XX_ARM_CLK_EN
,
474 SC27XX_CLK_ADC_EN
| SC27XX_CLK_ADC_CLK_EN
, 0);
476 regmap_update_bits(data
->regmap
, SC27XX_MODULE_EN
,
477 SC27XX_MODULE_ADC_EN
, 0);
480 static int sc27xx_adc_probe(struct platform_device
*pdev
)
482 struct device
*dev
= &pdev
->dev
;
483 struct device_node
*np
= dev
->of_node
;
484 struct sc27xx_adc_data
*sc27xx_data
;
485 struct iio_dev
*indio_dev
;
488 indio_dev
= devm_iio_device_alloc(dev
, sizeof(*sc27xx_data
));
492 sc27xx_data
= iio_priv(indio_dev
);
494 sc27xx_data
->regmap
= dev_get_regmap(dev
->parent
, NULL
);
495 if (!sc27xx_data
->regmap
) {
496 dev_err(dev
, "failed to get ADC regmap\n");
500 ret
= of_property_read_u32(np
, "reg", &sc27xx_data
->base
);
502 dev_err(dev
, "failed to get ADC base address\n");
506 sc27xx_data
->irq
= platform_get_irq(pdev
, 0);
507 if (sc27xx_data
->irq
< 0)
508 return sc27xx_data
->irq
;
510 ret
= of_hwspin_lock_get_id(np
, 0);
512 dev_err(dev
, "failed to get hwspinlock id\n");
516 sc27xx_data
->hwlock
= devm_hwspin_lock_request_specific(dev
, ret
);
517 if (!sc27xx_data
->hwlock
) {
518 dev_err(dev
, "failed to request hwspinlock\n");
522 sc27xx_data
->dev
= dev
;
524 ret
= sc27xx_adc_enable(sc27xx_data
);
526 dev_err(dev
, "failed to enable ADC module\n");
530 ret
= devm_add_action_or_reset(dev
, sc27xx_adc_disable
, sc27xx_data
);
532 dev_err(dev
, "failed to add ADC disable action\n");
536 indio_dev
->name
= dev_name(dev
);
537 indio_dev
->modes
= INDIO_DIRECT_MODE
;
538 indio_dev
->info
= &sc27xx_info
;
539 indio_dev
->channels
= sc27xx_channels
;
540 indio_dev
->num_channels
= ARRAY_SIZE(sc27xx_channels
);
541 ret
= devm_iio_device_register(dev
, indio_dev
);
543 dev_err(dev
, "could not register iio (ADC)");
548 static const struct of_device_id sc27xx_adc_of_match
[] = {
549 { .compatible
= "sprd,sc2731-adc", },
553 static struct platform_driver sc27xx_adc_driver
= {
554 .probe
= sc27xx_adc_probe
,
556 .name
= "sc27xx-adc",
557 .of_match_table
= sc27xx_adc_of_match
,
561 module_platform_driver(sc27xx_adc_driver
);
563 MODULE_AUTHOR("Freeman Liu <freeman.liu@spreadtrum.com>");
564 MODULE_DESCRIPTION("Spreadtrum SC27XX ADC Driver");
565 MODULE_LICENSE("GPL v2");