1 // SPDX-License-Identifier: GPL-2.0+
3 * Amlogic Thermal Sensor Driver
5 * Copyright (C) 2017 Huan Biao <huan.biao@amlogic.com>
6 * Copyright (C) 2019 Guillaume La Roque <glaroque@baylibre.com>
8 * Register value to celsius temperature formulas:
10 * U = ---------, Uptat = ---------
13 * Temperature = A * ( Uptat + u_efuse / 2^16 )- B
15 * A B m n : calibration parameters
16 * u_efuse : fused calibration value, it's a signed 16 bits value
19 #include <linux/bitfield.h>
20 #include <linux/clk.h>
22 #include <linux/mfd/syscon.h>
23 #include <linux/module.h>
25 #include <linux/of_address.h>
26 #include <linux/of_device.h>
27 #include <linux/platform_device.h>
28 #include <linux/regmap.h>
29 #include <linux/thermal.h>
31 #include "thermal_core.h"
33 #define TSENSOR_CFG_REG1 0x4
34 #define TSENSOR_CFG_REG1_RSET_VBG BIT(12)
35 #define TSENSOR_CFG_REG1_RSET_ADC BIT(11)
36 #define TSENSOR_CFG_REG1_VCM_EN BIT(10)
37 #define TSENSOR_CFG_REG1_VBG_EN BIT(9)
38 #define TSENSOR_CFG_REG1_OUT_CTL BIT(6)
39 #define TSENSOR_CFG_REG1_FILTER_EN BIT(5)
40 #define TSENSOR_CFG_REG1_DEM_EN BIT(3)
41 #define TSENSOR_CFG_REG1_CH_SEL GENMASK(1, 0)
42 #define TSENSOR_CFG_REG1_ENABLE \
43 (TSENSOR_CFG_REG1_FILTER_EN | \
44 TSENSOR_CFG_REG1_VCM_EN | \
45 TSENSOR_CFG_REG1_VBG_EN | \
46 TSENSOR_CFG_REG1_DEM_EN | \
47 TSENSOR_CFG_REG1_CH_SEL)
49 #define TSENSOR_STAT0 0x40
51 #define TSENSOR_STAT9 0x64
53 #define TSENSOR_READ_TEMP_MASK GENMASK(15, 0)
54 #define TSENSOR_TEMP_MASK GENMASK(11, 0)
56 #define TSENSOR_TRIM_SIGN_MASK BIT(15)
57 #define TSENSOR_TRIM_TEMP_MASK GENMASK(14, 0)
58 #define TSENSOR_TRIM_VERSION_MASK GENMASK(31, 24)
60 #define TSENSOR_TRIM_VERSION(_version) \
61 FIELD_GET(TSENSOR_TRIM_VERSION_MASK, _version)
63 #define TSENSOR_TRIM_CALIB_VALID_MASK (GENMASK(3, 2) | BIT(7))
65 #define TSENSOR_CALIB_OFFSET 1
66 #define TSENSOR_CALIB_SHIFT 4
69 * struct amlogic_thermal_soc_calib_data
70 * @A, B, m, n: calibration parameters
71 * This structure is required for configuration of amlogic thermal driver.
73 struct amlogic_thermal_soc_calib_data {
81 * struct amlogic_thermal_data
82 * @u_efuse_off: register offset to read fused calibration value
83 * @calibration_parameters: calibration parameters structure pointer
84 * @regmap_config: regmap config for the device
85 * This structure is required for configuration of amlogic thermal driver.
87 struct amlogic_thermal_data {
89 const struct amlogic_thermal_soc_calib_data *calibration_parameters;
90 const struct regmap_config *regmap_config;
93 struct amlogic_thermal {
94 struct platform_device *pdev;
95 const struct amlogic_thermal_data *data;
96 struct regmap *regmap;
97 struct regmap *sec_ao_map;
99 struct thermal_zone_device *tzd;
104 * Calculate a temperature value from a temperature code.
105 * The unit of the temperature is degree milliCelsius.
107 static int amlogic_thermal_code_to_millicelsius(struct amlogic_thermal *pdata,
110 const struct amlogic_thermal_soc_calib_data *param =
111 pdata->data->calibration_parameters;
113 s64 factor, Uptat, uefuse;
115 uefuse = pdata->trim_info & TSENSOR_TRIM_SIGN_MASK ?
116 ~(pdata->trim_info & TSENSOR_TRIM_TEMP_MASK) + 1 :
117 (pdata->trim_info & TSENSOR_TRIM_TEMP_MASK);
119 factor = param->n * temp_code;
120 factor = div_s64(factor, 100);
122 Uptat = temp_code * param->m;
123 Uptat = div_s64(Uptat, 100);
124 Uptat = Uptat * BIT(16);
125 Uptat = div_s64(Uptat, BIT(16) + factor);
127 temp = (Uptat + uefuse) * param->A;
128 temp = div_s64(temp, BIT(16));
129 temp = (temp - param->B) * 100;
134 static int amlogic_thermal_initialize(struct amlogic_thermal *pdata)
139 regmap_read(pdata->sec_ao_map, pdata->data->u_efuse_off,
142 ver = TSENSOR_TRIM_VERSION(pdata->trim_info);
144 if ((ver & TSENSOR_TRIM_CALIB_VALID_MASK) == 0) {
146 dev_err(&pdata->pdev->dev,
147 "tsensor thermal calibration not supported: 0x%x!\n",
154 static int amlogic_thermal_enable(struct amlogic_thermal *data)
158 ret = clk_prepare_enable(data->clk);
162 regmap_update_bits(data->regmap, TSENSOR_CFG_REG1,
163 TSENSOR_CFG_REG1_ENABLE, TSENSOR_CFG_REG1_ENABLE);
168 static int amlogic_thermal_disable(struct amlogic_thermal *data)
170 regmap_update_bits(data->regmap, TSENSOR_CFG_REG1,
171 TSENSOR_CFG_REG1_ENABLE, 0);
172 clk_disable_unprepare(data->clk);
177 static int amlogic_thermal_get_temp(void *data, int *temp)
180 struct amlogic_thermal *pdata = data;
185 regmap_read(pdata->regmap, TSENSOR_STAT0, &tval);
187 amlogic_thermal_code_to_millicelsius(pdata,
188 tval & TSENSOR_READ_TEMP_MASK);
193 static const struct thermal_zone_of_device_ops amlogic_thermal_ops = {
194 .get_temp = amlogic_thermal_get_temp,
197 static const struct regmap_config amlogic_thermal_regmap_config_g12a = {
201 .max_register = TSENSOR_STAT9,
204 static const struct amlogic_thermal_soc_calib_data amlogic_thermal_g12a = {
211 static const struct amlogic_thermal_data amlogic_thermal_g12a_cpu_param = {
212 .u_efuse_off = 0x128,
213 .calibration_parameters = &amlogic_thermal_g12a,
214 .regmap_config = &amlogic_thermal_regmap_config_g12a,
217 static const struct amlogic_thermal_data amlogic_thermal_g12a_ddr_param = {
219 .calibration_parameters = &amlogic_thermal_g12a,
220 .regmap_config = &amlogic_thermal_regmap_config_g12a,
223 static const struct of_device_id of_amlogic_thermal_match[] = {
225 .compatible = "amlogic,g12a-ddr-thermal",
226 .data = &amlogic_thermal_g12a_ddr_param,
229 .compatible = "amlogic,g12a-cpu-thermal",
230 .data = &amlogic_thermal_g12a_cpu_param,
234 MODULE_DEVICE_TABLE(of, of_amlogic_thermal_match);
236 static int amlogic_thermal_probe(struct platform_device *pdev)
238 struct amlogic_thermal *pdata;
239 struct device *dev = &pdev->dev;
243 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
247 pdata->data = of_device_get_match_data(dev);
249 platform_set_drvdata(pdev, pdata);
251 base = devm_platform_ioremap_resource(pdev, 0);
253 dev_err(dev, "failed to get io address\n");
254 return PTR_ERR(base);
257 pdata->regmap = devm_regmap_init_mmio(dev, base,
258 pdata->data->regmap_config);
259 if (IS_ERR(pdata->regmap))
260 return PTR_ERR(pdata->regmap);
262 pdata->clk = devm_clk_get(dev, NULL);
263 if (IS_ERR(pdata->clk)) {
264 if (PTR_ERR(pdata->clk) != -EPROBE_DEFER)
265 dev_err(dev, "failed to get clock\n");
266 return PTR_ERR(pdata->clk);
269 pdata->sec_ao_map = syscon_regmap_lookup_by_phandle
270 (pdev->dev.of_node, "amlogic,ao-secure");
271 if (IS_ERR(pdata->sec_ao_map)) {
272 dev_err(dev, "syscon regmap lookup failed.\n");
273 return PTR_ERR(pdata->sec_ao_map);
276 pdata->tzd = devm_thermal_zone_of_sensor_register(&pdev->dev,
279 &amlogic_thermal_ops);
280 if (IS_ERR(pdata->tzd)) {
281 ret = PTR_ERR(pdata->tzd);
282 dev_err(dev, "Failed to register tsensor: %d\n", ret);
286 ret = amlogic_thermal_initialize(pdata);
290 ret = amlogic_thermal_enable(pdata);
295 static int amlogic_thermal_remove(struct platform_device *pdev)
297 struct amlogic_thermal *data = platform_get_drvdata(pdev);
299 return amlogic_thermal_disable(data);
302 static int __maybe_unused amlogic_thermal_suspend(struct device *dev)
304 struct amlogic_thermal *data = dev_get_drvdata(dev);
306 return amlogic_thermal_disable(data);
309 static int __maybe_unused amlogic_thermal_resume(struct device *dev)
311 struct amlogic_thermal *data = dev_get_drvdata(dev);
313 return amlogic_thermal_enable(data);
316 static SIMPLE_DEV_PM_OPS(amlogic_thermal_pm_ops,
317 amlogic_thermal_suspend, amlogic_thermal_resume);
319 static struct platform_driver amlogic_thermal_driver = {
321 .name = "amlogic_thermal",
322 .pm = &amlogic_thermal_pm_ops,
323 .of_match_table = of_amlogic_thermal_match,
325 .probe = amlogic_thermal_probe,
326 .remove = amlogic_thermal_remove,
329 module_platform_driver(amlogic_thermal_driver);
331 MODULE_AUTHOR("Guillaume La Roque <glaroque@baylibre.com>");
332 MODULE_DESCRIPTION("Amlogic thermal driver");
333 MODULE_LICENSE("GPL v2");