1 // SPDX-License-Identifier: GPL-2.0-only
3 * Qualcomm PM8xxx PMIC XOADC driver
5 * These ADCs are known as HK/XO (house keeping / chrystal oscillator)
6 * "XO" in "XOADC" means Chrystal Oscillator. It's a bunch of
7 * specific-purpose and general purpose ADC converters and channels.
9 * Copyright (C) 2017 Linaro Ltd.
13 #include <linux/iio/adc/qcom-vadc-common.h>
14 #include <linux/iio/iio.h>
15 #include <linux/iio/sysfs.h>
16 #include <linux/module.h>
17 #include <linux/mod_devicetable.h>
18 #include <linux/platform_device.h>
19 #include <linux/property.h>
20 #include <linux/regmap.h>
21 #include <linux/init.h>
22 #include <linux/interrupt.h>
23 #include <linux/regulator/consumer.h>
26 * Definitions for the "user processor" registers lifted from the v3.4
27 * Qualcomm tree. Their kernel has two out-of-tree drivers for the ADC:
28 * drivers/misc/pmic8058-xoadc.c
29 * drivers/hwmon/pm8xxx-adc.c
30 * None of them contain any complete register specification, so this is
31 * a best effort of combining the information.
34 /* These appear to be "battery monitor" registers */
35 #define ADC_ARB_BTM_CNTRL1 0x17e
36 #define ADC_ARB_BTM_CNTRL1_EN_BTM BIT(0)
37 #define ADC_ARB_BTM_CNTRL1_SEL_OP_MODE BIT(1)
38 #define ADC_ARB_BTM_CNTRL1_MEAS_INTERVAL1 BIT(2)
39 #define ADC_ARB_BTM_CNTRL1_MEAS_INTERVAL2 BIT(3)
40 #define ADC_ARB_BTM_CNTRL1_MEAS_INTERVAL3 BIT(4)
41 #define ADC_ARB_BTM_CNTRL1_MEAS_INTERVAL4 BIT(5)
42 #define ADC_ARB_BTM_CNTRL1_EOC BIT(6)
43 #define ADC_ARB_BTM_CNTRL1_REQ BIT(7)
45 #define ADC_ARB_BTM_AMUX_CNTRL 0x17f
46 #define ADC_ARB_BTM_ANA_PARAM 0x180
47 #define ADC_ARB_BTM_DIG_PARAM 0x181
48 #define ADC_ARB_BTM_RSV 0x182
49 #define ADC_ARB_BTM_DATA1 0x183
50 #define ADC_ARB_BTM_DATA0 0x184
51 #define ADC_ARB_BTM_BAT_COOL_THR1 0x185
52 #define ADC_ARB_BTM_BAT_COOL_THR0 0x186
53 #define ADC_ARB_BTM_BAT_WARM_THR1 0x187
54 #define ADC_ARB_BTM_BAT_WARM_THR0 0x188
55 #define ADC_ARB_BTM_CNTRL2 0x18c
57 /* Proper ADC registers */
59 #define ADC_ARB_USRP_CNTRL 0x197
60 #define ADC_ARB_USRP_CNTRL_EN_ARB BIT(0)
61 #define ADC_ARB_USRP_CNTRL_RSV1 BIT(1)
62 #define ADC_ARB_USRP_CNTRL_RSV2 BIT(2)
63 #define ADC_ARB_USRP_CNTRL_RSV3 BIT(3)
64 #define ADC_ARB_USRP_CNTRL_RSV4 BIT(4)
65 #define ADC_ARB_USRP_CNTRL_RSV5 BIT(5)
66 #define ADC_ARB_USRP_CNTRL_EOC BIT(6)
67 #define ADC_ARB_USRP_CNTRL_REQ BIT(7)
69 #define ADC_ARB_USRP_AMUX_CNTRL 0x198
71 * The channel mask includes the bits selecting channel mux and prescaler
72 * on PM8058, or channel mux and premux on PM8921.
74 #define ADC_ARB_USRP_AMUX_CNTRL_CHAN_MASK 0xfc
75 #define ADC_ARB_USRP_AMUX_CNTRL_RSV0 BIT(0)
76 #define ADC_ARB_USRP_AMUX_CNTRL_RSV1 BIT(1)
77 /* On PM8058 this is prescaling, on PM8921 this is premux */
78 #define ADC_ARB_USRP_AMUX_CNTRL_PRESCALEMUX0 BIT(2)
79 #define ADC_ARB_USRP_AMUX_CNTRL_PRESCALEMUX1 BIT(3)
80 #define ADC_ARB_USRP_AMUX_CNTRL_SEL0 BIT(4)
81 #define ADC_ARB_USRP_AMUX_CNTRL_SEL1 BIT(5)
82 #define ADC_ARB_USRP_AMUX_CNTRL_SEL2 BIT(6)
83 #define ADC_ARB_USRP_AMUX_CNTRL_SEL3 BIT(7)
84 #define ADC_AMUX_PREMUX_SHIFT 2
85 #define ADC_AMUX_SEL_SHIFT 4
87 /* We know very little about the bits in this register */
88 #define ADC_ARB_USRP_ANA_PARAM 0x199
89 #define ADC_ARB_USRP_ANA_PARAM_DIS 0xFE
90 #define ADC_ARB_USRP_ANA_PARAM_EN 0xFF
92 #define ADC_ARB_USRP_DIG_PARAM 0x19A
93 #define ADC_ARB_USRP_DIG_PARAM_SEL_SHIFT0 BIT(0)
94 #define ADC_ARB_USRP_DIG_PARAM_SEL_SHIFT1 BIT(1)
95 #define ADC_ARB_USRP_DIG_PARAM_CLK_RATE0 BIT(2)
96 #define ADC_ARB_USRP_DIG_PARAM_CLK_RATE1 BIT(3)
97 #define ADC_ARB_USRP_DIG_PARAM_EOC BIT(4)
99 * On a later ADC the decimation factors are defined as
100 * 00 = 512, 01 = 1024, 10 = 2048, 11 = 4096 so assume this
101 * holds also for this older XOADC.
103 #define ADC_ARB_USRP_DIG_PARAM_DEC_RATE0 BIT(5)
104 #define ADC_ARB_USRP_DIG_PARAM_DEC_RATE1 BIT(6)
105 #define ADC_ARB_USRP_DIG_PARAM_EN BIT(7)
106 #define ADC_DIG_PARAM_DEC_SHIFT 5
108 #define ADC_ARB_USRP_RSV 0x19B
109 #define ADC_ARB_USRP_RSV_RST BIT(0)
110 #define ADC_ARB_USRP_RSV_DTEST0 BIT(1)
111 #define ADC_ARB_USRP_RSV_DTEST1 BIT(2)
112 #define ADC_ARB_USRP_RSV_OP BIT(3)
113 #define ADC_ARB_USRP_RSV_IP_SEL0 BIT(4)
114 #define ADC_ARB_USRP_RSV_IP_SEL1 BIT(5)
115 #define ADC_ARB_USRP_RSV_IP_SEL2 BIT(6)
116 #define ADC_ARB_USRP_RSV_TRM BIT(7)
117 #define ADC_RSV_IP_SEL_SHIFT 4
119 #define ADC_ARB_USRP_DATA0 0x19D
120 #define ADC_ARB_USRP_DATA1 0x19C
123 * Physical channels which MUST exist on all PM variants in order to provide
124 * proper reference points for calibration.
126 * @PM8XXX_CHANNEL_INTERNAL: 625mV reference channel
127 * @PM8XXX_CHANNEL_125V: 1250mV reference channel
128 * @PM8XXX_CHANNEL_INTERNAL_2: 325mV reference channel
129 * @PM8XXX_CHANNEL_MUXOFF: channel to reduce input load on mux, apparently also
130 * measures XO temperature
132 #define PM8XXX_CHANNEL_INTERNAL 0x0c
133 #define PM8XXX_CHANNEL_125V 0x0d
134 #define PM8XXX_CHANNEL_INTERNAL_2 0x0e
135 #define PM8XXX_CHANNEL_MUXOFF 0x0f
138 * PM8058 AMUX premux scaling, two bits. This is done of the channel before
141 #define PM8058_AMUX_PRESCALE_0 0x0 /* No scaling on the signal */
142 #define PM8058_AMUX_PRESCALE_1 0x1 /* Unity scaling selected by the user */
143 #define PM8058_AMUX_PRESCALE_1_DIV3 0x2 /* 1/3 prescaler on the input */
145 /* Defines reference voltage for the XOADC */
146 #define AMUX_RSV0 0x0 /* XO_IN/XOADC_GND, special selection to read XO temp */
147 #define AMUX_RSV1 0x1 /* PMIC_IN/XOADC_GND */
148 #define AMUX_RSV2 0x2 /* PMIC_IN/BMS_CSP */
149 #define AMUX_RSV3 0x3 /* not used */
150 #define AMUX_RSV4 0x4 /* XOADC_GND/XOADC_GND */
151 #define AMUX_RSV5 0x5 /* XOADC_VREF/XOADC_GND */
152 #define XOADC_RSV_MAX 5 /* 3 bits 0..7, 3 and 6,7 are invalid */
155 * struct xoadc_channel - encodes channel properties and defaults
156 * @datasheet_name: the hardwarename of this channel
157 * @pre_scale_mux: prescale (PM8058) or premux (PM8921) for selecting
158 * this channel. Both this and the amux channel is needed to uniquely
159 * identify a channel. Values 0..3.
160 * @amux_channel: value of the ADC_ARB_USRP_AMUX_CNTRL register for this
161 * channel, bits 4..7, selects the amux, values 0..f
162 * @prescale: the channels have hard-coded prescale ratios defined
163 * by the hardware, this tells us what it is
164 * @type: corresponding IIO channel type, usually IIO_VOLTAGE or
166 * @scale_fn_type: the liner interpolation etc to convert the
167 * ADC code to the value that IIO expects, in uV or millicelsius
168 * etc. This scale function can be pretty elaborate if different
169 * thermistors are connected or other hardware characteristics are
171 * @amux_ip_rsv: ratiometric scale value used by the analog muxer: this
172 * selects the reference voltage for ratiometric scaling
174 struct xoadc_channel {
175 const char *datasheet_name;
178 const struct u32_fract prescale;
179 enum iio_chan_type type;
180 enum vadc_scale_fn_type scale_fn_type;
185 * struct xoadc_variant - encodes the XOADC variant characteristics
186 * @name: name of this PMIC variant
187 * @channels: the hardware channels and respective settings and defaults
188 * @broken_ratiometric: if the PMIC has broken ratiometric scaling (this
189 * is a known problem on PM8058)
190 * @prescaling: this variant uses AMUX bits 2 & 3 for prescaling (PM8058)
191 * @second_level_mux: this variant uses AMUX bits 2 & 3 for a second level
194 struct xoadc_variant {
196 const struct xoadc_channel *channels;
197 bool broken_ratiometric;
199 bool second_level_mux;
203 * XOADC_CHAN macro parameters:
204 * _dname: the name of the channel
205 * _presmux: prescaler (PM8058) or premux (PM8921) setting for this channel
206 * _amux: the value in bits 2..7 of the ADC_ARB_USRP_AMUX_CNTRL register
207 * for this channel. On some PMICs some of the bits select a prescaler, and
208 * on some PMICs some of the bits select various complex multiplex settings.
209 * _type: IIO channel type
210 * _prenum: prescaler numerator (dividend)
211 * _preden: prescaler denominator (divisor)
212 * _scale: scaling function type, this selects how the raw valued is mangled
213 * to output the actual processed measurement
214 * _amip: analog mux input parent when using ratiometric measurements
216 #define XOADC_CHAN(_dname, _presmux, _amux, _type, _prenum, _preden, _scale, _amip) \
218 .datasheet_name = __stringify(_dname), \
219 .pre_scale_mux = _presmux, \
220 .amux_channel = _amux, \
222 .numerator = _prenum, .denominator = _preden, \
225 .scale_fn_type = _scale, \
226 .amux_ip_rsv = _amip, \
230 * Taken from arch/arm/mach-msm/board-9615.c in the vendor tree:
231 * TODO: incomplete, needs testing.
233 static const struct xoadc_channel pm8018_xoadc_channels[] = {
234 XOADC_CHAN(VCOIN, 0x00, 0x00, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
235 XOADC_CHAN(VBAT, 0x00, 0x01, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
236 XOADC_CHAN(VPH_PWR, 0x00, 0x02, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
237 XOADC_CHAN(DIE_TEMP, 0x00, 0x0b, IIO_TEMP, 1, 1, SCALE_PMIC_THERM, AMUX_RSV1),
238 /* Used for battery ID or battery temperature */
239 XOADC_CHAN(AMUX8, 0x00, 0x08, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV2),
240 XOADC_CHAN(INTERNAL, 0x00, 0x0c, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
241 XOADC_CHAN(125V, 0x00, 0x0d, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
242 XOADC_CHAN(MUXOFF, 0x00, 0x0f, IIO_TEMP, 1, 1, SCALE_XOTHERM, AMUX_RSV0),
247 * Taken from arch/arm/mach-msm/board-8930-pmic.c in the vendor tree:
248 * TODO: needs testing.
250 static const struct xoadc_channel pm8038_xoadc_channels[] = {
251 XOADC_CHAN(VCOIN, 0x00, 0x00, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
252 XOADC_CHAN(VBAT, 0x00, 0x01, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
253 XOADC_CHAN(DCIN, 0x00, 0x02, IIO_VOLTAGE, 1, 6, SCALE_DEFAULT, AMUX_RSV1),
254 XOADC_CHAN(ICHG, 0x00, 0x03, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
255 XOADC_CHAN(VPH_PWR, 0x00, 0x04, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
256 XOADC_CHAN(AMUX5, 0x00, 0x05, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
257 XOADC_CHAN(AMUX6, 0x00, 0x06, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
258 XOADC_CHAN(AMUX7, 0x00, 0x07, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
259 /* AMUX8 used for battery temperature in most cases */
260 XOADC_CHAN(AMUX8, 0x00, 0x08, IIO_TEMP, 1, 1, SCALE_THERM_100K_PULLUP, AMUX_RSV2),
261 XOADC_CHAN(AMUX9, 0x00, 0x09, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
262 XOADC_CHAN(USB_VBUS, 0x00, 0x0a, IIO_VOLTAGE, 1, 4, SCALE_DEFAULT, AMUX_RSV1),
263 XOADC_CHAN(DIE_TEMP, 0x00, 0x0b, IIO_TEMP, 1, 1, SCALE_PMIC_THERM, AMUX_RSV1),
264 XOADC_CHAN(INTERNAL, 0x00, 0x0c, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
265 XOADC_CHAN(125V, 0x00, 0x0d, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
266 XOADC_CHAN(INTERNAL_2, 0x00, 0x0e, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
267 XOADC_CHAN(MUXOFF, 0x00, 0x0f, IIO_TEMP, 1, 1, SCALE_XOTHERM, AMUX_RSV0),
272 * This was created by cross-referencing the vendor tree
273 * arch/arm/mach-msm/board-msm8x60.c msm_adc_channels_data[]
274 * with the "channel types" (first field) to find the right
275 * configuration for these channels on an MSM8x60 i.e. PM8058
278 static const struct xoadc_channel pm8058_xoadc_channels[] = {
279 XOADC_CHAN(VCOIN, 0x00, 0x00, IIO_VOLTAGE, 1, 2, SCALE_DEFAULT, AMUX_RSV1),
280 XOADC_CHAN(VBAT, 0x00, 0x01, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
281 XOADC_CHAN(DCIN, 0x00, 0x02, IIO_VOLTAGE, 1, 10, SCALE_DEFAULT, AMUX_RSV1),
282 XOADC_CHAN(ICHG, 0x00, 0x03, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
283 XOADC_CHAN(VPH_PWR, 0x00, 0x04, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
285 * AMUX channels 5 thru 9 are referred to as MPP5 thru MPP9 in
286 * some code and documentation. But they are really just 5
287 * channels just like any other. They are connected to a switching
288 * matrix where they can be routed to any of the MPPs, not just
289 * 1-to-1 onto MPP5 thru 9, so naming them MPP5 thru MPP9 is
292 XOADC_CHAN(AMUX5, 0x00, 0x05, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
293 XOADC_CHAN(AMUX6, 0x00, 0x06, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
294 XOADC_CHAN(AMUX7, 0x00, 0x07, IIO_VOLTAGE, 1, 2, SCALE_DEFAULT, AMUX_RSV1),
295 XOADC_CHAN(AMUX8, 0x00, 0x08, IIO_VOLTAGE, 1, 2, SCALE_DEFAULT, AMUX_RSV1),
296 XOADC_CHAN(AMUX9, 0x00, 0x09, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
297 XOADC_CHAN(USB_VBUS, 0x00, 0x0a, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
298 XOADC_CHAN(DIE_TEMP, 0x00, 0x0b, IIO_TEMP, 1, 1, SCALE_PMIC_THERM, AMUX_RSV1),
299 XOADC_CHAN(INTERNAL, 0x00, 0x0c, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
300 XOADC_CHAN(125V, 0x00, 0x0d, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
301 XOADC_CHAN(INTERNAL_2, 0x00, 0x0e, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
302 XOADC_CHAN(MUXOFF, 0x00, 0x0f, IIO_TEMP, 1, 1, SCALE_XOTHERM, AMUX_RSV0),
303 /* There are also "unity" and divided by 3 channels (prescaler) but noone is using them */
308 * The PM8921 has some pre-muxing on its channels, this comes from the vendor tree
309 * include/linux/mfd/pm8xxx/pm8xxx-adc.h
310 * board-flo-pmic.c (Nexus 7) and board-8064-pmic.c
312 static const struct xoadc_channel pm8921_xoadc_channels[] = {
313 XOADC_CHAN(VCOIN, 0x00, 0x00, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
314 XOADC_CHAN(VBAT, 0x00, 0x01, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
315 XOADC_CHAN(DCIN, 0x00, 0x02, IIO_VOLTAGE, 1, 6, SCALE_DEFAULT, AMUX_RSV1),
316 /* channel "ICHG" is reserved and not used on PM8921 */
317 XOADC_CHAN(VPH_PWR, 0x00, 0x04, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
318 XOADC_CHAN(IBAT, 0x00, 0x05, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
319 /* CHAN 6 & 7 (MPP1 & MPP2) are reserved for MPP channels on PM8921 */
320 XOADC_CHAN(BATT_THERM, 0x00, 0x08, IIO_TEMP, 1, 1, SCALE_THERM_100K_PULLUP, AMUX_RSV1),
321 XOADC_CHAN(BATT_ID, 0x00, 0x09, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
322 XOADC_CHAN(USB_VBUS, 0x00, 0x0a, IIO_VOLTAGE, 1, 4, SCALE_DEFAULT, AMUX_RSV1),
323 XOADC_CHAN(DIE_TEMP, 0x00, 0x0b, IIO_TEMP, 1, 1, SCALE_PMIC_THERM, AMUX_RSV1),
324 XOADC_CHAN(INTERNAL, 0x00, 0x0c, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
325 XOADC_CHAN(125V, 0x00, 0x0d, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
326 /* FIXME: look into the scaling of this temperature */
327 XOADC_CHAN(CHG_TEMP, 0x00, 0x0e, IIO_TEMP, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
328 XOADC_CHAN(MUXOFF, 0x00, 0x0f, IIO_TEMP, 1, 1, SCALE_XOTHERM, AMUX_RSV0),
329 /* The following channels have premux bit 0 set to 1 (all end in 4) */
330 XOADC_CHAN(ATEST_8, 0x01, 0x00, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
331 /* Set scaling to 1/2 based on the name for these two */
332 XOADC_CHAN(USB_SNS_DIV20, 0x01, 0x01, IIO_VOLTAGE, 1, 2, SCALE_DEFAULT, AMUX_RSV1),
333 XOADC_CHAN(DCIN_SNS_DIV20, 0x01, 0x02, IIO_VOLTAGE, 1, 2, SCALE_DEFAULT, AMUX_RSV1),
334 XOADC_CHAN(AMUX3, 0x01, 0x03, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
335 XOADC_CHAN(AMUX4, 0x01, 0x04, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
336 XOADC_CHAN(AMUX5, 0x01, 0x05, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
337 XOADC_CHAN(AMUX6, 0x01, 0x06, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
338 XOADC_CHAN(AMUX7, 0x01, 0x07, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
339 XOADC_CHAN(AMUX8, 0x01, 0x08, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
340 /* Internal test signals, I think */
341 XOADC_CHAN(ATEST_1, 0x01, 0x09, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
342 XOADC_CHAN(ATEST_2, 0x01, 0x0a, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
343 XOADC_CHAN(ATEST_3, 0x01, 0x0b, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
344 XOADC_CHAN(ATEST_4, 0x01, 0x0c, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
345 XOADC_CHAN(ATEST_5, 0x01, 0x0d, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
346 XOADC_CHAN(ATEST_6, 0x01, 0x0e, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
347 XOADC_CHAN(ATEST_7, 0x01, 0x0f, IIO_VOLTAGE, 1, 1, SCALE_DEFAULT, AMUX_RSV1),
348 /* The following channels have premux bit 1 set to 1 (all end in 8) */
349 /* I guess even ATEST8 will be divided by 3 here */
350 XOADC_CHAN(ATEST_8, 0x02, 0x00, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
351 /* I guess div 2 div 3 becomes div 6 */
352 XOADC_CHAN(USB_SNS_DIV20_DIV3, 0x02, 0x01, IIO_VOLTAGE, 1, 6, SCALE_DEFAULT, AMUX_RSV1),
353 XOADC_CHAN(DCIN_SNS_DIV20_DIV3, 0x02, 0x02, IIO_VOLTAGE, 1, 6, SCALE_DEFAULT, AMUX_RSV1),
354 XOADC_CHAN(AMUX3_DIV3, 0x02, 0x03, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
355 XOADC_CHAN(AMUX4_DIV3, 0x02, 0x04, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
356 XOADC_CHAN(AMUX5_DIV3, 0x02, 0x05, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
357 XOADC_CHAN(AMUX6_DIV3, 0x02, 0x06, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
358 XOADC_CHAN(AMUX7_DIV3, 0x02, 0x07, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
359 XOADC_CHAN(AMUX8_DIV3, 0x02, 0x08, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
360 XOADC_CHAN(ATEST_1_DIV3, 0x02, 0x09, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
361 XOADC_CHAN(ATEST_2_DIV3, 0x02, 0x0a, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
362 XOADC_CHAN(ATEST_3_DIV3, 0x02, 0x0b, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
363 XOADC_CHAN(ATEST_4_DIV3, 0x02, 0x0c, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
364 XOADC_CHAN(ATEST_5_DIV3, 0x02, 0x0d, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
365 XOADC_CHAN(ATEST_6_DIV3, 0x02, 0x0e, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
366 XOADC_CHAN(ATEST_7_DIV3, 0x02, 0x0f, IIO_VOLTAGE, 1, 3, SCALE_DEFAULT, AMUX_RSV1),
371 * struct pm8xxx_chan_info - ADC channel information
372 * @name: name of this channel
373 * @hwchan: pointer to hardware channel information (muxing & scaling settings)
374 * @calibration: whether to use absolute or ratiometric calibration
375 * @scale_fn_type: scaling function type
376 * @decimation: 0,1,2,3
377 * @amux_ip_rsv: ratiometric scale value if using ratiometric
378 * calibration: 0, 1, 2, 4, 5.
380 struct pm8xxx_chan_info {
382 const struct xoadc_channel *hwchan;
383 enum vadc_calibration calibration;
389 * struct pm8xxx_xoadc - state container for the XOADC
390 * @dev: pointer to device
391 * @map: regmap to access registers
392 * @variant: XOADC variant characteristics
393 * @vref: reference voltage regulator
394 * characteristics of the channels, and sensible default settings
395 * @nchans: number of channels, configured by the device tree
396 * @chans: the channel information per-channel, configured by the device tree
397 * @iio_chans: IIO channel specifiers
398 * @graph: linear calibration parameters for absolute and
399 * ratiometric measurements
400 * @complete: completion to indicate end of conversion
401 * @lock: lock to restrict access to the hardware to one client at the time
403 struct pm8xxx_xoadc {
406 const struct xoadc_variant *variant;
407 struct regulator *vref;
409 struct pm8xxx_chan_info *chans;
410 struct iio_chan_spec *iio_chans;
411 struct vadc_linear_graph graph[2];
412 struct completion complete;
416 static irqreturn_t pm8xxx_eoc_irq(int irq, void *d)
418 struct iio_dev *indio_dev = d;
419 struct pm8xxx_xoadc *adc = iio_priv(indio_dev);
421 complete(&adc->complete);
426 static struct pm8xxx_chan_info *
427 pm8xxx_get_channel(struct pm8xxx_xoadc *adc, u8 chan)
431 for (i = 0; i < adc->nchans; i++) {
432 struct pm8xxx_chan_info *ch = &adc->chans[i];
433 if (ch->hwchan->amux_channel == chan)
439 static int pm8xxx_read_channel_rsv(struct pm8xxx_xoadc *adc,
440 const struct pm8xxx_chan_info *ch,
441 u8 rsv, u16 *adc_code,
442 bool force_ratiometric)
449 dev_dbg(adc->dev, "read channel \"%s\", amux %d, prescale/mux: %d, rsv %d\n",
450 ch->name, ch->hwchan->amux_channel, ch->hwchan->pre_scale_mux, rsv);
452 mutex_lock(&adc->lock);
454 /* Mux in this channel */
455 val = ch->hwchan->amux_channel << ADC_AMUX_SEL_SHIFT;
456 val |= ch->hwchan->pre_scale_mux << ADC_AMUX_PREMUX_SHIFT;
457 ret = regmap_write(adc->map, ADC_ARB_USRP_AMUX_CNTRL, val);
461 /* Set up ratiometric scale value, mask off all bits except these */
462 rsvmask = (ADC_ARB_USRP_RSV_RST | ADC_ARB_USRP_RSV_DTEST0 |
463 ADC_ARB_USRP_RSV_DTEST1 | ADC_ARB_USRP_RSV_OP);
464 if (adc->variant->broken_ratiometric && !force_ratiometric) {
466 * Apparently the PM8058 has some kind of bug which is
467 * reflected in the vendor tree drivers/misc/pmix8058-xoadc.c
468 * which just hardcodes the RSV selector to SEL1 (0x20) for
469 * most cases and SEL0 (0x10) for the MUXOFF channel only.
470 * If we force ratiometric (currently only done when attempting
471 * to do ratiometric calibration) this doesn't seem to work
472 * very well and I suspect ratiometric conversion is simply
473 * broken or not supported on the PM8058.
475 * Maybe IO_SEL2 doesn't exist on PM8058 and bits 4 & 5 select
478 * Some PM8058 register documentation would be nice to get
481 if (ch->hwchan->amux_channel == PM8XXX_CHANNEL_MUXOFF)
482 rsvval = ADC_ARB_USRP_RSV_IP_SEL0;
484 rsvval = ADC_ARB_USRP_RSV_IP_SEL1;
487 rsvval = (ch->amux_ip_rsv << ADC_RSV_IP_SEL_SHIFT) |
488 ADC_ARB_USRP_RSV_TRM;
490 rsvval = (rsv << ADC_RSV_IP_SEL_SHIFT) |
491 ADC_ARB_USRP_RSV_TRM;
494 ret = regmap_update_bits(adc->map,
501 ret = regmap_write(adc->map, ADC_ARB_USRP_ANA_PARAM,
502 ADC_ARB_USRP_ANA_PARAM_DIS);
506 /* Decimation factor */
507 ret = regmap_write(adc->map, ADC_ARB_USRP_DIG_PARAM,
508 ADC_ARB_USRP_DIG_PARAM_SEL_SHIFT0 |
509 ADC_ARB_USRP_DIG_PARAM_SEL_SHIFT1 |
510 ch->decimation << ADC_DIG_PARAM_DEC_SHIFT);
514 ret = regmap_write(adc->map, ADC_ARB_USRP_ANA_PARAM,
515 ADC_ARB_USRP_ANA_PARAM_EN);
519 /* Enable the arbiter, the Qualcomm code does it twice like this */
520 ret = regmap_write(adc->map, ADC_ARB_USRP_CNTRL,
521 ADC_ARB_USRP_CNTRL_EN_ARB);
524 ret = regmap_write(adc->map, ADC_ARB_USRP_CNTRL,
525 ADC_ARB_USRP_CNTRL_EN_ARB);
530 /* Fire a request! */
531 reinit_completion(&adc->complete);
532 ret = regmap_write(adc->map, ADC_ARB_USRP_CNTRL,
533 ADC_ARB_USRP_CNTRL_EN_ARB |
534 ADC_ARB_USRP_CNTRL_REQ);
538 /* Next the interrupt occurs */
539 ret = wait_for_completion_timeout(&adc->complete,
540 VADC_CONV_TIME_MAX_US);
542 dev_err(adc->dev, "conversion timed out\n");
547 ret = regmap_read(adc->map, ADC_ARB_USRP_DATA0, &val);
551 ret = regmap_read(adc->map, ADC_ARB_USRP_DATA1, &val);
555 *adc_code = (msb << 8) | lsb;
557 /* Turn off the ADC by setting the arbiter to 0 twice */
558 ret = regmap_write(adc->map, ADC_ARB_USRP_CNTRL, 0);
561 ret = regmap_write(adc->map, ADC_ARB_USRP_CNTRL, 0);
566 mutex_unlock(&adc->lock);
570 static int pm8xxx_read_channel(struct pm8xxx_xoadc *adc,
571 const struct pm8xxx_chan_info *ch,
575 * Normally we just use the ratiometric scale value (RSV) predefined
576 * for the channel, but during calibration we need to modify this
577 * so this wrapper is a helper hiding the more complex version.
579 return pm8xxx_read_channel_rsv(adc, ch, 0xff, adc_code, false);
582 static int pm8xxx_calibrate_device(struct pm8xxx_xoadc *adc)
584 const struct pm8xxx_chan_info *ch;
591 adc->graph[VADC_CALIB_ABSOLUTE].dx = VADC_ABSOLUTE_RANGE_UV;
592 adc->graph[VADC_CALIB_RATIOMETRIC].dx = VADC_RATIOMETRIC_RANGE;
594 /* Common reference channel calibration */
595 ch = pm8xxx_get_channel(adc, PM8XXX_CHANNEL_125V);
598 ret = pm8xxx_read_channel(adc, ch, &read_1250v);
600 dev_err(adc->dev, "could not read 1.25V reference channel\n");
603 ch = pm8xxx_get_channel(adc, PM8XXX_CHANNEL_INTERNAL);
606 ret = pm8xxx_read_channel(adc, ch, &read_0625v);
608 dev_err(adc->dev, "could not read 0.625V reference channel\n");
611 if (read_1250v == read_0625v) {
612 dev_err(adc->dev, "read same ADC code for 1.25V and 0.625V\n");
616 adc->graph[VADC_CALIB_ABSOLUTE].dy = read_1250v - read_0625v;
617 adc->graph[VADC_CALIB_ABSOLUTE].gnd = read_0625v;
619 dev_info(adc->dev, "absolute calibration dx = %d uV, dy = %d units\n",
620 VADC_ABSOLUTE_RANGE_UV, adc->graph[VADC_CALIB_ABSOLUTE].dy);
622 /* Ratiometric calibration */
623 ch = pm8xxx_get_channel(adc, PM8XXX_CHANNEL_MUXOFF);
626 ret = pm8xxx_read_channel_rsv(adc, ch, AMUX_RSV5,
627 &read_nomux_rsv5, true);
629 dev_err(adc->dev, "could not read MUXOFF reference channel\n");
632 ret = pm8xxx_read_channel_rsv(adc, ch, AMUX_RSV4,
633 &read_nomux_rsv4, true);
635 dev_err(adc->dev, "could not read MUXOFF reference channel\n");
638 adc->graph[VADC_CALIB_RATIOMETRIC].dy =
639 read_nomux_rsv5 - read_nomux_rsv4;
640 adc->graph[VADC_CALIB_RATIOMETRIC].gnd = read_nomux_rsv4;
642 dev_info(adc->dev, "ratiometric calibration dx = %d, dy = %d units\n",
643 VADC_RATIOMETRIC_RANGE,
644 adc->graph[VADC_CALIB_RATIOMETRIC].dy);
649 static int pm8xxx_read_raw(struct iio_dev *indio_dev,
650 struct iio_chan_spec const *chan,
651 int *val, int *val2, long mask)
653 struct pm8xxx_xoadc *adc = iio_priv(indio_dev);
654 const struct pm8xxx_chan_info *ch;
659 case IIO_CHAN_INFO_PROCESSED:
660 ch = pm8xxx_get_channel(adc, chan->address);
662 dev_err(adc->dev, "no such channel %lu\n",
666 ret = pm8xxx_read_channel(adc, ch, &adc_code);
670 ret = qcom_vadc_scale(ch->hwchan->scale_fn_type,
671 &adc->graph[ch->calibration],
672 &ch->hwchan->prescale,
673 (ch->calibration == VADC_CALIB_ABSOLUTE),
679 case IIO_CHAN_INFO_RAW:
680 ch = pm8xxx_get_channel(adc, chan->address);
682 dev_err(adc->dev, "no such channel %lu\n",
686 ret = pm8xxx_read_channel(adc, ch, &adc_code);
690 *val = (int)adc_code;
697 static int pm8xxx_fwnode_xlate(struct iio_dev *indio_dev,
698 const struct fwnode_reference_args *iiospec)
700 struct pm8xxx_xoadc *adc = iio_priv(indio_dev);
706 * First cell is prescaler or premux, second cell is analog
709 if (iiospec->nargs != 2) {
710 dev_err(&indio_dev->dev, "wrong number of arguments for %pfwP need 2 got %d\n",
715 pre_scale_mux = (u8)iiospec->args[0];
716 amux_channel = (u8)iiospec->args[1];
717 dev_dbg(&indio_dev->dev, "pre scale/mux: %02x, amux: %02x\n",
718 pre_scale_mux, amux_channel);
720 /* We need to match exactly on the prescale/premux and channel */
721 for (i = 0; i < adc->nchans; i++)
722 if (adc->chans[i].hwchan->pre_scale_mux == pre_scale_mux &&
723 adc->chans[i].hwchan->amux_channel == amux_channel)
729 static const struct iio_info pm8xxx_xoadc_info = {
730 .fwnode_xlate = pm8xxx_fwnode_xlate,
731 .read_raw = pm8xxx_read_raw,
734 static int pm8xxx_xoadc_parse_channel(struct device *dev,
735 struct fwnode_handle *fwnode,
736 const struct xoadc_channel *hw_channels,
737 struct iio_chan_spec *iio_chan,
738 struct pm8xxx_chan_info *ch)
740 const char *name = fwnode_get_name(fwnode);
741 const struct xoadc_channel *hwchan;
742 u32 pre_scale_mux, amux_channel, reg[2];
747 ret = fwnode_property_read_u32_array(fwnode, "reg", reg,
750 dev_err(dev, "invalid pre scale/mux or amux channel number %s\n",
755 pre_scale_mux = reg[0];
756 amux_channel = reg[1];
758 /* Find the right channel setting */
760 hwchan = &hw_channels[0];
761 while (hwchan->datasheet_name) {
762 if (hwchan->pre_scale_mux == pre_scale_mux &&
763 hwchan->amux_channel == amux_channel)
768 /* The sentinel does not have a name assigned */
769 if (!hwchan->datasheet_name) {
770 dev_err(dev, "could not locate channel %02x/%02x\n",
771 pre_scale_mux, amux_channel);
776 /* Everyone seems to use absolute calibration except in special cases */
777 ch->calibration = VADC_CALIB_ABSOLUTE;
778 /* Everyone seems to use default ("type 2") decimation */
779 ch->decimation = VADC_DEF_DECIMATION;
781 if (!fwnode_property_read_u32(fwnode, "qcom,ratiometric", &rsv)) {
782 ch->calibration = VADC_CALIB_RATIOMETRIC;
783 if (rsv > XOADC_RSV_MAX) {
784 dev_err(dev, "%s too large RSV value %d\n", name, rsv);
787 if (rsv == AMUX_RSV3) {
788 dev_err(dev, "%s invalid RSV value %d\n", name, rsv);
793 /* Optional decimation, if omitted we use the default */
794 ret = fwnode_property_read_u32(fwnode, "qcom,decimation", &dec);
796 ret = qcom_vadc_decimation_from_dt(dec);
798 dev_err(dev, "%s invalid decimation %d\n",
802 ch->decimation = ret;
805 iio_chan->channel = chid;
806 iio_chan->address = hwchan->amux_channel;
807 iio_chan->datasheet_name = hwchan->datasheet_name;
808 iio_chan->type = hwchan->type;
809 /* All channels are raw or processed */
810 iio_chan->info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
811 BIT(IIO_CHAN_INFO_PROCESSED);
812 iio_chan->indexed = 1;
815 "channel [PRESCALE/MUX: %02x AMUX: %02x] \"%s\" ref voltage: %d, decimation %d prescale %d/%d, scale function %d\n",
816 hwchan->pre_scale_mux, hwchan->amux_channel, ch->name,
817 ch->amux_ip_rsv, ch->decimation, hwchan->prescale.numerator,
818 hwchan->prescale.denominator, hwchan->scale_fn_type);
823 static int pm8xxx_xoadc_parse_channels(struct pm8xxx_xoadc *adc)
825 struct fwnode_handle *child;
826 struct pm8xxx_chan_info *ch;
830 adc->nchans = device_get_child_node_count(adc->dev);
832 dev_err(adc->dev, "no channel children\n");
835 dev_dbg(adc->dev, "found %d ADC channels\n", adc->nchans);
837 adc->iio_chans = devm_kcalloc(adc->dev, adc->nchans,
838 sizeof(*adc->iio_chans), GFP_KERNEL);
842 adc->chans = devm_kcalloc(adc->dev, adc->nchans,
843 sizeof(*adc->chans), GFP_KERNEL);
848 device_for_each_child_node(adc->dev, child) {
850 ret = pm8xxx_xoadc_parse_channel(adc->dev, child,
851 adc->variant->channels,
855 fwnode_handle_put(child);
861 /* Check for required channels */
862 ch = pm8xxx_get_channel(adc, PM8XXX_CHANNEL_125V);
864 dev_err(adc->dev, "missing 1.25V reference channel\n");
867 ch = pm8xxx_get_channel(adc, PM8XXX_CHANNEL_INTERNAL);
869 dev_err(adc->dev, "missing 0.625V reference channel\n");
872 ch = pm8xxx_get_channel(adc, PM8XXX_CHANNEL_MUXOFF);
874 dev_err(adc->dev, "missing MUXOFF reference channel\n");
881 static int pm8xxx_xoadc_probe(struct platform_device *pdev)
883 const struct xoadc_variant *variant;
884 struct pm8xxx_xoadc *adc;
885 struct iio_dev *indio_dev;
887 struct device *dev = &pdev->dev;
890 variant = device_get_match_data(dev);
894 indio_dev = devm_iio_device_alloc(dev, sizeof(*adc));
897 platform_set_drvdata(pdev, indio_dev);
899 adc = iio_priv(indio_dev);
901 adc->variant = variant;
902 init_completion(&adc->complete);
903 mutex_init(&adc->lock);
905 ret = pm8xxx_xoadc_parse_channels(adc);
909 map = dev_get_regmap(dev->parent, NULL);
911 dev_err(dev, "parent regmap unavailable.\n");
916 /* Bring up regulator */
917 adc->vref = devm_regulator_get(dev, "xoadc-ref");
918 if (IS_ERR(adc->vref))
919 return dev_err_probe(dev, PTR_ERR(adc->vref),
920 "failed to get XOADC VREF regulator\n");
921 ret = regulator_enable(adc->vref);
923 dev_err(dev, "failed to enable XOADC VREF regulator\n");
927 ret = devm_request_threaded_irq(dev, platform_get_irq(pdev, 0),
928 pm8xxx_eoc_irq, NULL, 0, variant->name, indio_dev);
930 dev_err(dev, "unable to request IRQ\n");
931 goto out_disable_vref;
934 indio_dev->name = variant->name;
935 indio_dev->modes = INDIO_DIRECT_MODE;
936 indio_dev->info = &pm8xxx_xoadc_info;
937 indio_dev->channels = adc->iio_chans;
938 indio_dev->num_channels = adc->nchans;
940 ret = iio_device_register(indio_dev);
942 goto out_disable_vref;
944 ret = pm8xxx_calibrate_device(adc);
946 goto out_unreg_device;
948 dev_info(dev, "%s XOADC driver enabled\n", variant->name);
953 iio_device_unregister(indio_dev);
955 regulator_disable(adc->vref);
960 static void pm8xxx_xoadc_remove(struct platform_device *pdev)
962 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
963 struct pm8xxx_xoadc *adc = iio_priv(indio_dev);
965 iio_device_unregister(indio_dev);
967 regulator_disable(adc->vref);
970 static const struct xoadc_variant pm8018_variant = {
971 .name = "PM8018-XOADC",
972 .channels = pm8018_xoadc_channels,
975 static const struct xoadc_variant pm8038_variant = {
976 .name = "PM8038-XOADC",
977 .channels = pm8038_xoadc_channels,
980 static const struct xoadc_variant pm8058_variant = {
981 .name = "PM8058-XOADC",
982 .channels = pm8058_xoadc_channels,
983 .broken_ratiometric = true,
987 static const struct xoadc_variant pm8921_variant = {
988 .name = "PM8921-XOADC",
989 .channels = pm8921_xoadc_channels,
990 .second_level_mux = true,
993 static const struct of_device_id pm8xxx_xoadc_id_table[] = {
995 .compatible = "qcom,pm8018-adc",
996 .data = &pm8018_variant,
999 .compatible = "qcom,pm8038-adc",
1000 .data = &pm8038_variant,
1003 .compatible = "qcom,pm8058-adc",
1004 .data = &pm8058_variant,
1007 .compatible = "qcom,pm8921-adc",
1008 .data = &pm8921_variant,
1012 MODULE_DEVICE_TABLE(of, pm8xxx_xoadc_id_table);
1014 static struct platform_driver pm8xxx_xoadc_driver = {
1016 .name = "pm8xxx-adc",
1017 .of_match_table = pm8xxx_xoadc_id_table,
1019 .probe = pm8xxx_xoadc_probe,
1020 .remove_new = pm8xxx_xoadc_remove,
1022 module_platform_driver(pm8xxx_xoadc_driver);
1024 MODULE_DESCRIPTION("PM8xxx XOADC driver");
1025 MODULE_LICENSE("GPL v2");
1026 MODULE_ALIAS("platform:pm8xxx-xoadc");