1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Code shared between the different Qualcomm PMIC voltage ADCs
4  */
5 
6 #ifndef QCOM_VADC_COMMON_H
7 #define QCOM_VADC_COMMON_H
8 
9 #define VADC_CONV_TIME_MIN_US			2000
10 #define VADC_CONV_TIME_MAX_US			2100
11 
12 /* Min ADC code represents 0V */
13 #define VADC_MIN_ADC_CODE			0x6000
14 /* Max ADC code represents full-scale range of 1.8V */
15 #define VADC_MAX_ADC_CODE			0xa800
16 
17 #define VADC_ABSOLUTE_RANGE_UV			625000
18 #define VADC_RATIOMETRIC_RANGE			1800
19 
20 #define VADC_DEF_PRESCALING			0 /* 1:1 */
21 #define VADC_DEF_DECIMATION			0 /* 512 */
22 #define VADC_DEF_HW_SETTLE_TIME			0 /* 0 us */
23 #define VADC_DEF_AVG_SAMPLES			0 /* 1 sample */
24 #define VADC_DEF_CALIB_TYPE			VADC_CALIB_ABSOLUTE
25 
26 #define VADC_DECIMATION_MIN			512
27 #define VADC_DECIMATION_MAX			4096
28 #define ADC5_DEF_VBAT_PRESCALING		1 /* 1:3 */
29 #define ADC5_DECIMATION_SHORT			250
30 #define ADC5_DECIMATION_MEDIUM			420
31 #define ADC5_DECIMATION_LONG			840
32 /* Default decimation - 1024 for rev2, 840 for pmic5 */
33 #define ADC5_DECIMATION_DEFAULT			2
34 #define ADC5_DECIMATION_SAMPLES_MAX		3
35 
36 #define VADC_HW_SETTLE_DELAY_MAX		10000
37 #define VADC_HW_SETTLE_SAMPLES_MAX		16
38 #define VADC_AVG_SAMPLES_MAX			512
39 #define ADC5_AVG_SAMPLES_MAX			16
40 
41 #define PMIC5_CHG_TEMP_SCALE_FACTOR		377500
42 #define PMIC5_SMB_TEMP_CONSTANT			419400
43 #define PMIC5_SMB_TEMP_SCALE_FACTOR		356
44 
45 #define PMI_CHG_SCALE_1				-138890
46 #define PMI_CHG_SCALE_2				391750000000LL
47 
48 #define VADC5_MAX_CODE				0x7fff
49 #define ADC5_FULL_SCALE_CODE			0x70e4
50 #define ADC5_USR_DATA_CHECK			0x8000
51 
52 #define R_PU_100K				100000
53 #define RATIO_MAX_ADC7				BIT(14)
54 
55 #define DIE_TEMP_ADC7_SCALE_1			-60000
56 #define DIE_TEMP_ADC7_SCALE_2			20000
57 #define DIE_TEMP_ADC7_SCALE_FACTOR		1000
58 #define DIE_TEMP_ADC7_MAX			160000
59 
60 /**
61  * struct vadc_map_pt - Map the graph representation for ADC channel
62  * @x: Represent the ADC digitized code.
63  * @y: Represent the physical data which can be temperature, voltage,
64  *     resistance.
65  */
66 struct vadc_map_pt {
67 	s32 x;
68 	s32 y;
69 };
70 
71 /*
72  * VADC_CALIB_ABSOLUTE: uses the 625mV and 1.25V as reference channels.
73  * VADC_CALIB_RATIOMETRIC: uses the reference voltage (1.8V) and GND for
74  * calibration.
75  */
76 enum vadc_calibration {
77 	VADC_CALIB_ABSOLUTE = 0,
78 	VADC_CALIB_RATIOMETRIC
79 };
80 
81 /**
82  * struct vadc_linear_graph - Represent ADC characteristics.
83  * @dy: numerator slope to calculate the gain.
84  * @dx: denominator slope to calculate the gain.
85  * @gnd: A/D word of the ground reference used for the channel.
86  *
87  * Each ADC device has different offset and gain parameters which are
88  * computed to calibrate the device.
89  */
90 struct vadc_linear_graph {
91 	s32 dy;
92 	s32 dx;
93 	s32 gnd;
94 };
95 
96 /**
97  * struct vadc_prescale_ratio - Represent scaling ratio for ADC input.
98  * @num: the inverse numerator of the gain applied to the input channel.
99  * @den: the inverse denominator of the gain applied to the input channel.
100  */
101 struct vadc_prescale_ratio {
102 	u32 num;
103 	u32 den;
104 };
105 
106 /**
107  * enum vadc_scale_fn_type - Scaling function to convert ADC code to
108  *				physical scaled units for the channel.
109  * SCALE_DEFAULT: Default scaling to convert raw adc code to voltage (uV).
110  * SCALE_THERM_100K_PULLUP: Returns temperature in millidegC.
111  *				 Uses a mapping table with 100K pullup.
112  * SCALE_PMIC_THERM: Returns result in milli degree's Centigrade.
113  * SCALE_XOTHERM: Returns XO thermistor voltage in millidegC.
114  * SCALE_PMI_CHG_TEMP: Conversion for PMI CHG temp
115  * SCALE_HW_CALIB_DEFAULT: Default scaling to convert raw adc code to
116  *	voltage (uV) with hardware applied offset/slope values to adc code.
117  * SCALE_HW_CALIB_THERM_100K_PULLUP: Returns temperature in millidegC using
118  *	lookup table. The hardware applies offset/slope to adc code.
119  * SCALE_HW_CALIB_XOTHERM: Returns XO thermistor voltage in millidegC using
120  *	100k pullup. The hardware applies offset/slope to adc code.
121  * SCALE_HW_CALIB_THERM_100K_PU_PM7: Returns temperature in millidegC using
122  *	lookup table for PMIC7. The hardware applies offset/slope to adc code.
123  * SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade.
124  *	The hardware applies offset/slope to adc code.
125  * SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade.
126  *	The hardware applies offset/slope to adc code. This is for PMIC7.
127  * SCALE_HW_CALIB_PM5_CHG_TEMP: Returns result in millidegrees for PMIC5
128  *	charger temperature.
129  * SCALE_HW_CALIB_PM5_SMB_TEMP: Returns result in millidegrees for PMIC5
130  *	SMB1390 temperature.
131  */
132 enum vadc_scale_fn_type {
133 	SCALE_DEFAULT = 0,
134 	SCALE_THERM_100K_PULLUP,
135 	SCALE_PMIC_THERM,
136 	SCALE_XOTHERM,
137 	SCALE_PMI_CHG_TEMP,
138 	SCALE_HW_CALIB_DEFAULT,
139 	SCALE_HW_CALIB_THERM_100K_PULLUP,
140 	SCALE_HW_CALIB_XOTHERM,
141 	SCALE_HW_CALIB_THERM_100K_PU_PM7,
142 	SCALE_HW_CALIB_PMIC_THERM,
143 	SCALE_HW_CALIB_PMIC_THERM_PM7,
144 	SCALE_HW_CALIB_PM5_CHG_TEMP,
145 	SCALE_HW_CALIB_PM5_SMB_TEMP,
146 	SCALE_HW_CALIB_INVALID,
147 };
148 
149 struct adc5_data {
150 	const u32	full_scale_code_volt;
151 	const u32	full_scale_code_cur;
152 	const struct adc5_channels *adc_chans;
153 	const struct iio_info *info;
154 	unsigned int	*decimation;
155 	unsigned int	*hw_settle_1;
156 	unsigned int	*hw_settle_2;
157 };
158 
159 int qcom_vadc_scale(enum vadc_scale_fn_type scaletype,
160 		    const struct vadc_linear_graph *calib_graph,
161 		    const struct vadc_prescale_ratio *prescale,
162 		    bool absolute,
163 		    u16 adc_code, int *result_mdec);
164 
165 struct qcom_adc5_scale_type {
166 	int (*scale_fn)(const struct vadc_prescale_ratio *prescale,
167 		const struct adc5_data *data, u16 adc_code, int *result);
168 };
169 
170 int qcom_adc5_hw_scale(enum vadc_scale_fn_type scaletype,
171 		    const struct vadc_prescale_ratio *prescale,
172 		    const struct adc5_data *data,
173 		    u16 adc_code, int *result_mdec);
174 
175 int qcom_vadc_decimation_from_dt(u32 value);
176 
177 #endif /* QCOM_VADC_COMMON_H */
178