1*9d617949SNiklas Söderlund // SPDX-License-Identifier: GPL-2.0
2*9d617949SNiklas Söderlund /*
3*9d617949SNiklas Söderlund * Renesas RZ/G2L TSU Thermal Sensor Driver
4*9d617949SNiklas Söderlund *
5*9d617949SNiklas Söderlund * Copyright (C) 2021 Renesas Electronics Corporation
6*9d617949SNiklas Söderlund */
7*9d617949SNiklas Söderlund #include <linux/delay.h>
8*9d617949SNiklas Söderlund #include <linux/err.h>
9*9d617949SNiklas Söderlund #include <linux/io.h>
10*9d617949SNiklas Söderlund #include <linux/iopoll.h>
11*9d617949SNiklas Söderlund #include <linux/math.h>
12*9d617949SNiklas Söderlund #include <linux/mod_devicetable.h>
13*9d617949SNiklas Söderlund #include <linux/module.h>
14*9d617949SNiklas Söderlund #include <linux/platform_device.h>
15*9d617949SNiklas Söderlund #include <linux/pm_runtime.h>
16*9d617949SNiklas Söderlund #include <linux/reset.h>
17*9d617949SNiklas Söderlund #include <linux/thermal.h>
18*9d617949SNiklas Söderlund #include <linux/units.h>
19*9d617949SNiklas Söderlund
20*9d617949SNiklas Söderlund #include "../thermal_hwmon.h"
21*9d617949SNiklas Söderlund
22*9d617949SNiklas Söderlund #define CTEMP_MASK 0xFFF
23*9d617949SNiklas Söderlund
24*9d617949SNiklas Söderlund /* default calibration values, if FUSE values are missing */
25*9d617949SNiklas Söderlund #define SW_CALIB0_VAL 3148
26*9d617949SNiklas Söderlund #define SW_CALIB1_VAL 503
27*9d617949SNiklas Söderlund
28*9d617949SNiklas Söderlund /* Register offsets */
29*9d617949SNiklas Söderlund #define TSU_SM 0x00
30*9d617949SNiklas Söderlund #define TSU_ST 0x04
31*9d617949SNiklas Söderlund #define TSU_SAD 0x0C
32*9d617949SNiklas Söderlund #define TSU_SS 0x10
33*9d617949SNiklas Söderlund
34*9d617949SNiklas Söderlund #define OTPTSUTRIM_REG(n) (0x18 + ((n) * 0x4))
35*9d617949SNiklas Söderlund #define OTPTSUTRIM_EN_MASK BIT(31)
36*9d617949SNiklas Söderlund #define OTPTSUTRIM_MASK GENMASK(11, 0)
37*9d617949SNiklas Söderlund
38*9d617949SNiklas Söderlund /* Sensor Mode Register(TSU_SM) */
39*9d617949SNiklas Söderlund #define TSU_SM_EN_TS BIT(0)
40*9d617949SNiklas Söderlund #define TSU_SM_ADC_EN_TS BIT(1)
41*9d617949SNiklas Söderlund #define TSU_SM_NORMAL_MODE (TSU_SM_EN_TS | TSU_SM_ADC_EN_TS)
42*9d617949SNiklas Söderlund
43*9d617949SNiklas Söderlund /* TSU_ST bits */
44*9d617949SNiklas Söderlund #define TSU_ST_START BIT(0)
45*9d617949SNiklas Söderlund
46*9d617949SNiklas Söderlund #define TSU_SS_CONV_RUNNING BIT(0)
47*9d617949SNiklas Söderlund
48*9d617949SNiklas Söderlund #define TS_CODE_AVE_SCALE(x) ((x) * 1000000)
49*9d617949SNiklas Söderlund #define MCELSIUS(temp) ((temp) * MILLIDEGREE_PER_DEGREE)
50*9d617949SNiklas Söderlund #define TS_CODE_CAP_TIMES 8 /* Total number of ADC data samples */
51*9d617949SNiklas Söderlund
52*9d617949SNiklas Söderlund #define RZG2L_THERMAL_GRAN 500 /* milli Celsius */
53*9d617949SNiklas Söderlund #define RZG2L_TSU_SS_TIMEOUT_US 1000
54*9d617949SNiklas Söderlund
55*9d617949SNiklas Söderlund #define CURVATURE_CORRECTION_CONST 13
56*9d617949SNiklas Söderlund
57*9d617949SNiklas Söderlund struct rzg2l_thermal_priv {
58*9d617949SNiklas Söderlund struct device *dev;
59*9d617949SNiklas Söderlund void __iomem *base;
60*9d617949SNiklas Söderlund struct thermal_zone_device *zone;
61*9d617949SNiklas Söderlund struct reset_control *rstc;
62*9d617949SNiklas Söderlund u32 calib0, calib1;
63*9d617949SNiklas Söderlund };
64*9d617949SNiklas Söderlund
rzg2l_thermal_read(struct rzg2l_thermal_priv * priv,u32 reg)65*9d617949SNiklas Söderlund static inline u32 rzg2l_thermal_read(struct rzg2l_thermal_priv *priv, u32 reg)
66*9d617949SNiklas Söderlund {
67*9d617949SNiklas Söderlund return ioread32(priv->base + reg);
68*9d617949SNiklas Söderlund }
69*9d617949SNiklas Söderlund
rzg2l_thermal_write(struct rzg2l_thermal_priv * priv,u32 reg,u32 data)70*9d617949SNiklas Söderlund static inline void rzg2l_thermal_write(struct rzg2l_thermal_priv *priv, u32 reg,
71*9d617949SNiklas Söderlund u32 data)
72*9d617949SNiklas Söderlund {
73*9d617949SNiklas Söderlund iowrite32(data, priv->base + reg);
74*9d617949SNiklas Söderlund }
75*9d617949SNiklas Söderlund
rzg2l_thermal_get_temp(struct thermal_zone_device * tz,int * temp)76*9d617949SNiklas Söderlund static int rzg2l_thermal_get_temp(struct thermal_zone_device *tz, int *temp)
77*9d617949SNiklas Söderlund {
78*9d617949SNiklas Söderlund struct rzg2l_thermal_priv *priv = thermal_zone_device_priv(tz);
79*9d617949SNiklas Söderlund u32 result = 0, dsensor, ts_code_ave;
80*9d617949SNiklas Söderlund int val, i;
81*9d617949SNiklas Söderlund
82*9d617949SNiklas Söderlund for (i = 0; i < TS_CODE_CAP_TIMES ; i++) {
83*9d617949SNiklas Söderlund /*
84*9d617949SNiklas Söderlund * TSU repeats measurement at 20 microseconds intervals and
85*9d617949SNiklas Söderlund * automatically updates the results of measurement. As per
86*9d617949SNiklas Söderlund * the HW manual for measuring temperature we need to read 8
87*9d617949SNiklas Söderlund * values consecutively and then take the average.
88*9d617949SNiklas Söderlund * ts_code_ave = (ts_code[0] + ⋯ + ts_code[7]) / 8
89*9d617949SNiklas Söderlund */
90*9d617949SNiklas Söderlund result += rzg2l_thermal_read(priv, TSU_SAD) & CTEMP_MASK;
91*9d617949SNiklas Söderlund usleep_range(20, 30);
92*9d617949SNiklas Söderlund }
93*9d617949SNiklas Söderlund
94*9d617949SNiklas Söderlund ts_code_ave = result / TS_CODE_CAP_TIMES;
95*9d617949SNiklas Söderlund
96*9d617949SNiklas Söderlund /*
97*9d617949SNiklas Söderlund * Calculate actual sensor value by applying curvature correction formula
98*9d617949SNiklas Söderlund * dsensor = ts_code_ave / (1 + ts_code_ave * 0.000013). Here we are doing
99*9d617949SNiklas Söderlund * integer calculation by scaling all the values by 1000000.
100*9d617949SNiklas Söderlund */
101*9d617949SNiklas Söderlund dsensor = TS_CODE_AVE_SCALE(ts_code_ave) /
102*9d617949SNiklas Söderlund (TS_CODE_AVE_SCALE(1) + (ts_code_ave * CURVATURE_CORRECTION_CONST));
103*9d617949SNiklas Söderlund
104*9d617949SNiklas Söderlund /*
105*9d617949SNiklas Söderlund * The temperature Tj is calculated by the formula
106*9d617949SNiklas Söderlund * Tj = (dsensor − calib1) * 165/ (calib0 − calib1) − 40
107*9d617949SNiklas Söderlund * where calib0 and calib1 are the calibration values.
108*9d617949SNiklas Söderlund */
109*9d617949SNiklas Söderlund val = ((dsensor - priv->calib1) * (MCELSIUS(165) /
110*9d617949SNiklas Söderlund (priv->calib0 - priv->calib1))) - MCELSIUS(40);
111*9d617949SNiklas Söderlund
112*9d617949SNiklas Söderlund *temp = roundup(val, RZG2L_THERMAL_GRAN);
113*9d617949SNiklas Söderlund
114*9d617949SNiklas Söderlund return 0;
115*9d617949SNiklas Söderlund }
116*9d617949SNiklas Söderlund
117*9d617949SNiklas Söderlund static const struct thermal_zone_device_ops rzg2l_tz_of_ops = {
118*9d617949SNiklas Söderlund .get_temp = rzg2l_thermal_get_temp,
119*9d617949SNiklas Söderlund };
120*9d617949SNiklas Söderlund
rzg2l_thermal_init(struct rzg2l_thermal_priv * priv)121*9d617949SNiklas Söderlund static int rzg2l_thermal_init(struct rzg2l_thermal_priv *priv)
122*9d617949SNiklas Söderlund {
123*9d617949SNiklas Söderlund u32 reg_val;
124*9d617949SNiklas Söderlund
125*9d617949SNiklas Söderlund rzg2l_thermal_write(priv, TSU_SM, TSU_SM_NORMAL_MODE);
126*9d617949SNiklas Söderlund rzg2l_thermal_write(priv, TSU_ST, 0);
127*9d617949SNiklas Söderlund
128*9d617949SNiklas Söderlund /*
129*9d617949SNiklas Söderlund * Before setting the START bit, TSU should be in normal operating
130*9d617949SNiklas Söderlund * mode. As per the HW manual, it will take 60 µs to place the TSU
131*9d617949SNiklas Söderlund * into normal operating mode.
132*9d617949SNiklas Söderlund */
133*9d617949SNiklas Söderlund usleep_range(60, 80);
134*9d617949SNiklas Söderlund
135*9d617949SNiklas Söderlund reg_val = rzg2l_thermal_read(priv, TSU_ST);
136*9d617949SNiklas Söderlund reg_val |= TSU_ST_START;
137*9d617949SNiklas Söderlund rzg2l_thermal_write(priv, TSU_ST, reg_val);
138*9d617949SNiklas Söderlund
139*9d617949SNiklas Söderlund return readl_poll_timeout(priv->base + TSU_SS, reg_val,
140*9d617949SNiklas Söderlund reg_val == TSU_SS_CONV_RUNNING, 50,
141*9d617949SNiklas Söderlund RZG2L_TSU_SS_TIMEOUT_US);
142*9d617949SNiklas Söderlund }
143*9d617949SNiklas Söderlund
rzg2l_thermal_reset_assert_pm_disable_put(struct platform_device * pdev)144*9d617949SNiklas Söderlund static void rzg2l_thermal_reset_assert_pm_disable_put(struct platform_device *pdev)
145*9d617949SNiklas Söderlund {
146*9d617949SNiklas Söderlund struct rzg2l_thermal_priv *priv = dev_get_drvdata(&pdev->dev);
147*9d617949SNiklas Söderlund
148*9d617949SNiklas Söderlund pm_runtime_put(&pdev->dev);
149*9d617949SNiklas Söderlund pm_runtime_disable(&pdev->dev);
150*9d617949SNiklas Söderlund reset_control_assert(priv->rstc);
151*9d617949SNiklas Söderlund }
152*9d617949SNiklas Söderlund
rzg2l_thermal_remove(struct platform_device * pdev)153*9d617949SNiklas Söderlund static void rzg2l_thermal_remove(struct platform_device *pdev)
154*9d617949SNiklas Söderlund {
155*9d617949SNiklas Söderlund struct rzg2l_thermal_priv *priv = dev_get_drvdata(&pdev->dev);
156*9d617949SNiklas Söderlund
157*9d617949SNiklas Söderlund thermal_remove_hwmon_sysfs(priv->zone);
158*9d617949SNiklas Söderlund rzg2l_thermal_reset_assert_pm_disable_put(pdev);
159*9d617949SNiklas Söderlund }
160*9d617949SNiklas Söderlund
rzg2l_thermal_probe(struct platform_device * pdev)161*9d617949SNiklas Söderlund static int rzg2l_thermal_probe(struct platform_device *pdev)
162*9d617949SNiklas Söderlund {
163*9d617949SNiklas Söderlund struct thermal_zone_device *zone;
164*9d617949SNiklas Söderlund struct rzg2l_thermal_priv *priv;
165*9d617949SNiklas Söderlund struct device *dev = &pdev->dev;
166*9d617949SNiklas Söderlund int ret;
167*9d617949SNiklas Söderlund
168*9d617949SNiklas Söderlund priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
169*9d617949SNiklas Söderlund if (!priv)
170*9d617949SNiklas Söderlund return -ENOMEM;
171*9d617949SNiklas Söderlund
172*9d617949SNiklas Söderlund priv->base = devm_platform_ioremap_resource(pdev, 0);
173*9d617949SNiklas Söderlund if (IS_ERR(priv->base))
174*9d617949SNiklas Söderlund return PTR_ERR(priv->base);
175*9d617949SNiklas Söderlund
176*9d617949SNiklas Söderlund priv->dev = dev;
177*9d617949SNiklas Söderlund priv->rstc = devm_reset_control_get_exclusive(dev, NULL);
178*9d617949SNiklas Söderlund if (IS_ERR(priv->rstc))
179*9d617949SNiklas Söderlund return dev_err_probe(dev, PTR_ERR(priv->rstc),
180*9d617949SNiklas Söderlund "failed to get cpg reset");
181*9d617949SNiklas Söderlund
182*9d617949SNiklas Söderlund ret = reset_control_deassert(priv->rstc);
183*9d617949SNiklas Söderlund if (ret)
184*9d617949SNiklas Söderlund return dev_err_probe(dev, ret, "failed to deassert");
185*9d617949SNiklas Söderlund
186*9d617949SNiklas Söderlund pm_runtime_enable(dev);
187*9d617949SNiklas Söderlund pm_runtime_get_sync(dev);
188*9d617949SNiklas Söderlund
189*9d617949SNiklas Söderlund priv->calib0 = rzg2l_thermal_read(priv, OTPTSUTRIM_REG(0));
190*9d617949SNiklas Söderlund if (priv->calib0 & OTPTSUTRIM_EN_MASK)
191*9d617949SNiklas Söderlund priv->calib0 &= OTPTSUTRIM_MASK;
192*9d617949SNiklas Söderlund else
193*9d617949SNiklas Söderlund priv->calib0 = SW_CALIB0_VAL;
194*9d617949SNiklas Söderlund
195*9d617949SNiklas Söderlund priv->calib1 = rzg2l_thermal_read(priv, OTPTSUTRIM_REG(1));
196*9d617949SNiklas Söderlund if (priv->calib1 & OTPTSUTRIM_EN_MASK)
197*9d617949SNiklas Söderlund priv->calib1 &= OTPTSUTRIM_MASK;
198*9d617949SNiklas Söderlund else
199*9d617949SNiklas Söderlund priv->calib1 = SW_CALIB1_VAL;
200*9d617949SNiklas Söderlund
201*9d617949SNiklas Söderlund platform_set_drvdata(pdev, priv);
202*9d617949SNiklas Söderlund ret = rzg2l_thermal_init(priv);
203*9d617949SNiklas Söderlund if (ret) {
204*9d617949SNiklas Söderlund dev_err(dev, "Failed to start TSU");
205*9d617949SNiklas Söderlund goto err;
206*9d617949SNiklas Söderlund }
207*9d617949SNiklas Söderlund
208*9d617949SNiklas Söderlund zone = devm_thermal_of_zone_register(dev, 0, priv,
209*9d617949SNiklas Söderlund &rzg2l_tz_of_ops);
210*9d617949SNiklas Söderlund if (IS_ERR(zone)) {
211*9d617949SNiklas Söderlund dev_err(dev, "Can't register thermal zone");
212*9d617949SNiklas Söderlund ret = PTR_ERR(zone);
213*9d617949SNiklas Söderlund goto err;
214*9d617949SNiklas Söderlund }
215*9d617949SNiklas Söderlund
216*9d617949SNiklas Söderlund priv->zone = zone;
217*9d617949SNiklas Söderlund ret = thermal_add_hwmon_sysfs(priv->zone);
218*9d617949SNiklas Söderlund if (ret)
219*9d617949SNiklas Söderlund goto err;
220*9d617949SNiklas Söderlund
221*9d617949SNiklas Söderlund dev_dbg(dev, "TSU probed with %s calibration values",
222*9d617949SNiklas Söderlund rzg2l_thermal_read(priv, OTPTSUTRIM_REG(0)) ? "hw" : "sw");
223*9d617949SNiklas Söderlund
224*9d617949SNiklas Söderlund return 0;
225*9d617949SNiklas Söderlund
226*9d617949SNiklas Söderlund err:
227*9d617949SNiklas Söderlund rzg2l_thermal_reset_assert_pm_disable_put(pdev);
228*9d617949SNiklas Söderlund return ret;
229*9d617949SNiklas Söderlund }
230*9d617949SNiklas Söderlund
231*9d617949SNiklas Söderlund static const struct of_device_id rzg2l_thermal_dt_ids[] = {
232*9d617949SNiklas Söderlund { .compatible = "renesas,rzg2l-tsu", },
233*9d617949SNiklas Söderlund { /* sentinel */ }
234*9d617949SNiklas Söderlund };
235*9d617949SNiklas Söderlund MODULE_DEVICE_TABLE(of, rzg2l_thermal_dt_ids);
236*9d617949SNiklas Söderlund
237*9d617949SNiklas Söderlund static struct platform_driver rzg2l_thermal_driver = {
238*9d617949SNiklas Söderlund .driver = {
239*9d617949SNiklas Söderlund .name = "rzg2l_thermal",
240*9d617949SNiklas Söderlund .of_match_table = rzg2l_thermal_dt_ids,
241*9d617949SNiklas Söderlund },
242*9d617949SNiklas Söderlund .probe = rzg2l_thermal_probe,
243*9d617949SNiklas Söderlund .remove_new = rzg2l_thermal_remove,
244*9d617949SNiklas Söderlund };
245*9d617949SNiklas Söderlund module_platform_driver(rzg2l_thermal_driver);
246*9d617949SNiklas Söderlund
247*9d617949SNiklas Söderlund MODULE_DESCRIPTION("Renesas RZ/G2L TSU Thermal Sensor Driver");
248*9d617949SNiklas Söderlund MODULE_AUTHOR("Biju Das <biju.das.jz@bp.renesas.com>");
249*9d617949SNiklas Söderlund MODULE_LICENSE("GPL v2");
250