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 KELVINMIL_CELSIUSMIL 273150
42 #define PMIC5_CHG_TEMP_SCALE_FACTOR 377500
43 #define PMIC5_SMB_TEMP_CONSTANT 419400
44 #define PMIC5_SMB_TEMP_SCALE_FACTOR 356
45
46 #define PMI_CHG_SCALE_1 -138890
47 #define PMI_CHG_SCALE_2 391750000000LL
48
49 #define VADC5_MAX_CODE 0x7fff
50 #define ADC5_FULL_SCALE_CODE 0x70e4
51 #define ADC5_USR_DATA_CHECK 0x8000
52
53 /**
54 * struct vadc_map_pt - Map the graph representation for ADC channel
55 * @x: Represent the ADC digitized code.
56 * @y: Represent the physical data which can be temperature, voltage,
57 * resistance.
58 */
59 struct vadc_map_pt {
60 s32 x;
61 s32 y;
62 };
63
64 /*
65 * VADC_CALIB_ABSOLUTE: uses the 625mV and 1.25V as reference channels.
66 * VADC_CALIB_RATIOMETRIC: uses the reference voltage (1.8V) and GND for
67 * calibration.
68 */
69 enum vadc_calibration {
70 VADC_CALIB_ABSOLUTE = 0,
71 VADC_CALIB_RATIOMETRIC
72 };
73
74 /**
75 * struct vadc_linear_graph - Represent ADC characteristics.
76 * @dy: numerator slope to calculate the gain.
77 * @dx: denominator slope to calculate the gain.
78 * @gnd: A/D word of the ground reference used for the channel.
79 *
80 * Each ADC device has different offset and gain parameters which are
81 * computed to calibrate the device.
82 */
83 struct vadc_linear_graph {
84 s32 dy;
85 s32 dx;
86 s32 gnd;
87 };
88
89 /**
90 * struct vadc_prescale_ratio - Represent scaling ratio for ADC input.
91 * @num: the inverse numerator of the gain applied to the input channel.
92 * @den: the inverse denominator of the gain applied to the input channel.
93 */
94 struct vadc_prescale_ratio {
95 u32 num;
96 u32 den;
97 };
98
99 /**
100 * enum vadc_scale_fn_type - Scaling function to convert ADC code to
101 * physical scaled units for the channel.
102 * SCALE_DEFAULT: Default scaling to convert raw adc code to voltage (uV).
103 * SCALE_THERM_100K_PULLUP: Returns temperature in millidegC.
104 * Uses a mapping table with 100K pullup.
105 * SCALE_PMIC_THERM: Returns result in milli degree's Centigrade.
106 * SCALE_XOTHERM: Returns XO thermistor voltage in millidegC.
107 * SCALE_PMI_CHG_TEMP: Conversion for PMI CHG temp
108 * SCALE_HW_CALIB_DEFAULT: Default scaling to convert raw adc code to
109 * voltage (uV) with hardware applied offset/slope values to adc code.
110 * SCALE_HW_CALIB_THERM_100K_PULLUP: Returns temperature in millidegC using
111 * lookup table. The hardware applies offset/slope to adc code.
112 * SCALE_HW_CALIB_XOTHERM: Returns XO thermistor voltage in millidegC using
113 * 100k pullup. The hardware applies offset/slope to adc code.
114 * SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade.
115 * The hardware applies offset/slope to adc code.
116 * SCALE_HW_CALIB_PM5_CHG_TEMP: Returns result in millidegrees for PMIC5
117 * charger temperature.
118 * SCALE_HW_CALIB_PM5_SMB_TEMP: Returns result in millidegrees for PMIC5
119 * SMB1390 temperature.
120 */
121 enum vadc_scale_fn_type {
122 SCALE_DEFAULT = 0,
123 SCALE_THERM_100K_PULLUP,
124 SCALE_PMIC_THERM,
125 SCALE_XOTHERM,
126 SCALE_PMI_CHG_TEMP,
127 SCALE_HW_CALIB_DEFAULT,
128 SCALE_HW_CALIB_THERM_100K_PULLUP,
129 SCALE_HW_CALIB_XOTHERM,
130 SCALE_HW_CALIB_PMIC_THERM,
131 SCALE_HW_CALIB_PM5_CHG_TEMP,
132 SCALE_HW_CALIB_PM5_SMB_TEMP,
133 SCALE_HW_CALIB_INVALID,
134 };
135
136 struct adc5_data {
137 const u32 full_scale_code_volt;
138 const u32 full_scale_code_cur;
139 const struct adc5_channels *adc_chans;
140 unsigned int *decimation;
141 unsigned int *hw_settle_1;
142 unsigned int *hw_settle_2;
143 };
144
145 int qcom_vadc_scale(enum vadc_scale_fn_type scaletype,
146 const struct vadc_linear_graph *calib_graph,
147 const struct vadc_prescale_ratio *prescale,
148 bool absolute,
149 u16 adc_code, int *result_mdec);
150
151 struct qcom_adc5_scale_type {
152 int (*scale_fn)(const struct vadc_prescale_ratio *prescale,
153 const struct adc5_data *data, u16 adc_code, int *result);
154 };
155
156 int qcom_adc5_hw_scale(enum vadc_scale_fn_type scaletype,
157 const struct vadc_prescale_ratio *prescale,
158 const struct adc5_data *data,
159 u16 adc_code, int *result_mdec);
160
161 int qcom_vadc_decimation_from_dt(u32 value);
162
163 #endif /* QCOM_VADC_COMMON_H */