xref: /OK3568_Linux_fs/kernel/drivers/iio/adc/ltc2497-core.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * ltc2497-core.c - Common code for Analog Devices/Linear Technology
4*4882a593Smuzhiyun  * LTC2496 and LTC2497 ADCs
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Copyright (C) 2017 Analog Devices Inc.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/delay.h>
10*4882a593Smuzhiyun #include <linux/iio/iio.h>
11*4882a593Smuzhiyun #include <linux/iio/driver.h>
12*4882a593Smuzhiyun #include <linux/module.h>
13*4882a593Smuzhiyun #include <linux/regulator/consumer.h>
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #include "ltc2497.h"
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #define LTC2497_SGL			BIT(4)
18*4882a593Smuzhiyun #define LTC2497_DIFF			0
19*4882a593Smuzhiyun #define LTC2497_SIGN			BIT(3)
20*4882a593Smuzhiyun 
ltc2497core_wait_conv(struct ltc2497core_driverdata * ddata)21*4882a593Smuzhiyun static int ltc2497core_wait_conv(struct ltc2497core_driverdata *ddata)
22*4882a593Smuzhiyun {
23*4882a593Smuzhiyun 	s64 time_elapsed;
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun 	time_elapsed = ktime_ms_delta(ktime_get(), ddata->time_prev);
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun 	if (time_elapsed < LTC2497_CONVERSION_TIME_MS) {
28*4882a593Smuzhiyun 		/* delay if conversion time not passed
29*4882a593Smuzhiyun 		 * since last read or write
30*4882a593Smuzhiyun 		 */
31*4882a593Smuzhiyun 		if (msleep_interruptible(
32*4882a593Smuzhiyun 		    LTC2497_CONVERSION_TIME_MS - time_elapsed))
33*4882a593Smuzhiyun 			return -ERESTARTSYS;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun 		return 0;
36*4882a593Smuzhiyun 	}
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun 	if (time_elapsed - LTC2497_CONVERSION_TIME_MS <= 0) {
39*4882a593Smuzhiyun 		/* We're in automatic mode -
40*4882a593Smuzhiyun 		 * so the last reading is still not outdated
41*4882a593Smuzhiyun 		 */
42*4882a593Smuzhiyun 		return 0;
43*4882a593Smuzhiyun 	}
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	return 1;
46*4882a593Smuzhiyun }
47*4882a593Smuzhiyun 
ltc2497core_read(struct ltc2497core_driverdata * ddata,u8 address,int * val)48*4882a593Smuzhiyun static int ltc2497core_read(struct ltc2497core_driverdata *ddata, u8 address, int *val)
49*4882a593Smuzhiyun {
50*4882a593Smuzhiyun 	int ret;
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	ret = ltc2497core_wait_conv(ddata);
53*4882a593Smuzhiyun 	if (ret < 0)
54*4882a593Smuzhiyun 		return ret;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	if (ret || ddata->addr_prev != address) {
57*4882a593Smuzhiyun 		ret = ddata->result_and_measure(ddata, address, NULL);
58*4882a593Smuzhiyun 		if (ret < 0)
59*4882a593Smuzhiyun 			return ret;
60*4882a593Smuzhiyun 		ddata->addr_prev = address;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 		if (msleep_interruptible(LTC2497_CONVERSION_TIME_MS))
63*4882a593Smuzhiyun 			return -ERESTARTSYS;
64*4882a593Smuzhiyun 	}
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun 	ret = ddata->result_and_measure(ddata, address, val);
67*4882a593Smuzhiyun 	if (ret < 0)
68*4882a593Smuzhiyun 		return ret;
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	ddata->time_prev = ktime_get();
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	return ret;
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun 
ltc2497core_read_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int * val,int * val2,long mask)75*4882a593Smuzhiyun static int ltc2497core_read_raw(struct iio_dev *indio_dev,
76*4882a593Smuzhiyun 			    struct iio_chan_spec const *chan,
77*4882a593Smuzhiyun 			    int *val, int *val2, long mask)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun 	struct ltc2497core_driverdata *ddata = iio_priv(indio_dev);
80*4882a593Smuzhiyun 	int ret;
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 	switch (mask) {
83*4882a593Smuzhiyun 	case IIO_CHAN_INFO_RAW:
84*4882a593Smuzhiyun 		mutex_lock(&indio_dev->mlock);
85*4882a593Smuzhiyun 		ret = ltc2497core_read(ddata, chan->address, val);
86*4882a593Smuzhiyun 		mutex_unlock(&indio_dev->mlock);
87*4882a593Smuzhiyun 		if (ret < 0)
88*4882a593Smuzhiyun 			return ret;
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 		return IIO_VAL_INT;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	case IIO_CHAN_INFO_SCALE:
93*4882a593Smuzhiyun 		ret = regulator_get_voltage(ddata->ref);
94*4882a593Smuzhiyun 		if (ret < 0)
95*4882a593Smuzhiyun 			return ret;
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 		*val = ret / 1000;
98*4882a593Smuzhiyun 		*val2 = 17;
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 		return IIO_VAL_FRACTIONAL_LOG2;
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	default:
103*4882a593Smuzhiyun 		return -EINVAL;
104*4882a593Smuzhiyun 	}
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun #define LTC2497_CHAN(_chan, _addr, _ds_name) { \
108*4882a593Smuzhiyun 	.type = IIO_VOLTAGE, \
109*4882a593Smuzhiyun 	.indexed = 1, \
110*4882a593Smuzhiyun 	.channel = (_chan), \
111*4882a593Smuzhiyun 	.address = (_addr | (_chan / 2) | ((_chan & 1) ? LTC2497_SIGN : 0)), \
112*4882a593Smuzhiyun 	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
113*4882a593Smuzhiyun 	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
114*4882a593Smuzhiyun 	.datasheet_name = (_ds_name), \
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun #define LTC2497_CHAN_DIFF(_chan, _addr) { \
118*4882a593Smuzhiyun 	.type = IIO_VOLTAGE, \
119*4882a593Smuzhiyun 	.indexed = 1, \
120*4882a593Smuzhiyun 	.channel = (_chan) * 2 + ((_addr) & LTC2497_SIGN ? 1 : 0), \
121*4882a593Smuzhiyun 	.channel2 = (_chan) * 2 + ((_addr) & LTC2497_SIGN ? 0 : 1),\
122*4882a593Smuzhiyun 	.address = (_addr | _chan), \
123*4882a593Smuzhiyun 	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
124*4882a593Smuzhiyun 	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
125*4882a593Smuzhiyun 	.differential = 1, \
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun static const struct iio_chan_spec ltc2497core_channel[] = {
129*4882a593Smuzhiyun 	LTC2497_CHAN(0, LTC2497_SGL, "CH0"),
130*4882a593Smuzhiyun 	LTC2497_CHAN(1, LTC2497_SGL, "CH1"),
131*4882a593Smuzhiyun 	LTC2497_CHAN(2, LTC2497_SGL, "CH2"),
132*4882a593Smuzhiyun 	LTC2497_CHAN(3, LTC2497_SGL, "CH3"),
133*4882a593Smuzhiyun 	LTC2497_CHAN(4, LTC2497_SGL, "CH4"),
134*4882a593Smuzhiyun 	LTC2497_CHAN(5, LTC2497_SGL, "CH5"),
135*4882a593Smuzhiyun 	LTC2497_CHAN(6, LTC2497_SGL, "CH6"),
136*4882a593Smuzhiyun 	LTC2497_CHAN(7, LTC2497_SGL, "CH7"),
137*4882a593Smuzhiyun 	LTC2497_CHAN(8, LTC2497_SGL, "CH8"),
138*4882a593Smuzhiyun 	LTC2497_CHAN(9, LTC2497_SGL, "CH9"),
139*4882a593Smuzhiyun 	LTC2497_CHAN(10, LTC2497_SGL, "CH10"),
140*4882a593Smuzhiyun 	LTC2497_CHAN(11, LTC2497_SGL, "CH11"),
141*4882a593Smuzhiyun 	LTC2497_CHAN(12, LTC2497_SGL, "CH12"),
142*4882a593Smuzhiyun 	LTC2497_CHAN(13, LTC2497_SGL, "CH13"),
143*4882a593Smuzhiyun 	LTC2497_CHAN(14, LTC2497_SGL, "CH14"),
144*4882a593Smuzhiyun 	LTC2497_CHAN(15, LTC2497_SGL, "CH15"),
145*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(0, LTC2497_DIFF),
146*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(1, LTC2497_DIFF),
147*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(2, LTC2497_DIFF),
148*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(3, LTC2497_DIFF),
149*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(4, LTC2497_DIFF),
150*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(5, LTC2497_DIFF),
151*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(6, LTC2497_DIFF),
152*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(7, LTC2497_DIFF),
153*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(0, LTC2497_DIFF | LTC2497_SIGN),
154*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(1, LTC2497_DIFF | LTC2497_SIGN),
155*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(2, LTC2497_DIFF | LTC2497_SIGN),
156*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(3, LTC2497_DIFF | LTC2497_SIGN),
157*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(4, LTC2497_DIFF | LTC2497_SIGN),
158*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(5, LTC2497_DIFF | LTC2497_SIGN),
159*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(6, LTC2497_DIFF | LTC2497_SIGN),
160*4882a593Smuzhiyun 	LTC2497_CHAN_DIFF(7, LTC2497_DIFF | LTC2497_SIGN),
161*4882a593Smuzhiyun };
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun static const struct iio_info ltc2497core_info = {
164*4882a593Smuzhiyun 	.read_raw = ltc2497core_read_raw,
165*4882a593Smuzhiyun };
166*4882a593Smuzhiyun 
ltc2497core_probe(struct device * dev,struct iio_dev * indio_dev)167*4882a593Smuzhiyun int ltc2497core_probe(struct device *dev, struct iio_dev *indio_dev)
168*4882a593Smuzhiyun {
169*4882a593Smuzhiyun 	struct ltc2497core_driverdata *ddata = iio_priv(indio_dev);
170*4882a593Smuzhiyun 	int ret;
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 	indio_dev->name = dev_name(dev);
173*4882a593Smuzhiyun 	indio_dev->info = &ltc2497core_info;
174*4882a593Smuzhiyun 	indio_dev->modes = INDIO_DIRECT_MODE;
175*4882a593Smuzhiyun 	indio_dev->channels = ltc2497core_channel;
176*4882a593Smuzhiyun 	indio_dev->num_channels = ARRAY_SIZE(ltc2497core_channel);
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 	ret = ddata->result_and_measure(ddata, LTC2497_CONFIG_DEFAULT, NULL);
179*4882a593Smuzhiyun 	if (ret < 0)
180*4882a593Smuzhiyun 		return ret;
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 	ddata->ref = devm_regulator_get(dev, "vref");
183*4882a593Smuzhiyun 	if (IS_ERR(ddata->ref))
184*4882a593Smuzhiyun 		return dev_err_probe(dev, PTR_ERR(ddata->ref),
185*4882a593Smuzhiyun 				     "Failed to get vref regulator\n");
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun 	ret = regulator_enable(ddata->ref);
188*4882a593Smuzhiyun 	if (ret < 0) {
189*4882a593Smuzhiyun 		dev_err(dev, "Failed to enable vref regulator: %pe\n",
190*4882a593Smuzhiyun 			ERR_PTR(ret));
191*4882a593Smuzhiyun 		return ret;
192*4882a593Smuzhiyun 	}
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun 	if (dev->platform_data) {
195*4882a593Smuzhiyun 		struct iio_map *plat_data;
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 		plat_data = (struct iio_map *)dev->platform_data;
198*4882a593Smuzhiyun 
199*4882a593Smuzhiyun 		ret = iio_map_array_register(indio_dev, plat_data);
200*4882a593Smuzhiyun 		if (ret) {
201*4882a593Smuzhiyun 			dev_err(&indio_dev->dev, "iio map err: %d\n", ret);
202*4882a593Smuzhiyun 			goto err_regulator_disable;
203*4882a593Smuzhiyun 		}
204*4882a593Smuzhiyun 	}
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	ddata->addr_prev = LTC2497_CONFIG_DEFAULT;
207*4882a593Smuzhiyun 	ddata->time_prev = ktime_get();
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun 	ret = iio_device_register(indio_dev);
210*4882a593Smuzhiyun 	if (ret < 0)
211*4882a593Smuzhiyun 		goto err_array_unregister;
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun 	return 0;
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun err_array_unregister:
216*4882a593Smuzhiyun 	iio_map_array_unregister(indio_dev);
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun err_regulator_disable:
219*4882a593Smuzhiyun 	regulator_disable(ddata->ref);
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	return ret;
222*4882a593Smuzhiyun }
223*4882a593Smuzhiyun EXPORT_SYMBOL_NS(ltc2497core_probe, LTC2497);
224*4882a593Smuzhiyun 
ltc2497core_remove(struct iio_dev * indio_dev)225*4882a593Smuzhiyun void ltc2497core_remove(struct iio_dev *indio_dev)
226*4882a593Smuzhiyun {
227*4882a593Smuzhiyun 	struct ltc2497core_driverdata *ddata = iio_priv(indio_dev);
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun 	iio_device_unregister(indio_dev);
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun 	iio_map_array_unregister(indio_dev);
232*4882a593Smuzhiyun 
233*4882a593Smuzhiyun 	regulator_disable(ddata->ref);
234*4882a593Smuzhiyun }
235*4882a593Smuzhiyun EXPORT_SYMBOL_NS(ltc2497core_remove, LTC2497);
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun MODULE_DESCRIPTION("common code for LTC2496/LTC2497 drivers");
238*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
239