1 // SPDX-License-Identifier: GPL-2.0-only
3 * HiSilicon thermal sensor driver
5 * Copyright (c) 2014-2015 HiSilicon Limited.
6 * Copyright (c) 2014-2015 Linaro Limited.
8 * Xinwei Kong <kong.kongxinwei@hisilicon.com>
9 * Leo Yan <leo.yan@linaro.org>
12 #include <linux/cpufreq.h>
13 #include <linux/delay.h>
14 #include <linux/interrupt.h>
15 #include <linux/module.h>
16 #include <linux/platform_device.h>
18 #include <linux/of_device.h>
20 #include "thermal_core.h"
22 #define HI6220_TEMP0_LAG (0x0)
23 #define HI6220_TEMP0_TH (0x4)
24 #define HI6220_TEMP0_RST_TH (0x8)
25 #define HI6220_TEMP0_CFG (0xC)
26 #define HI6220_TEMP0_CFG_SS_MSK (0xF000)
27 #define HI6220_TEMP0_CFG_HDAK_MSK (0x30)
28 #define HI6220_TEMP0_EN (0x10)
29 #define HI6220_TEMP0_INT_EN (0x14)
30 #define HI6220_TEMP0_INT_CLR (0x18)
31 #define HI6220_TEMP0_RST_MSK (0x1C)
32 #define HI6220_TEMP0_VALUE (0x28)
34 #define HI3660_OFFSET(chan) ((chan) * 0x40)
35 #define HI3660_TEMP(chan) (HI3660_OFFSET(chan) + 0x1C)
36 #define HI3660_TH(chan) (HI3660_OFFSET(chan) + 0x20)
37 #define HI3660_LAG(chan) (HI3660_OFFSET(chan) + 0x28)
38 #define HI3660_INT_EN(chan) (HI3660_OFFSET(chan) + 0x2C)
39 #define HI3660_INT_CLR(chan) (HI3660_OFFSET(chan) + 0x30)
41 #define HI6220_TEMP_BASE (-60000)
42 #define HI6220_TEMP_RESET (100000)
43 #define HI6220_TEMP_STEP (785)
44 #define HI6220_TEMP_LAG (3500)
46 #define HI3660_TEMP_BASE (-63780)
47 #define HI3660_TEMP_STEP (205)
48 #define HI3660_TEMP_LAG (4000)
50 #define HI6220_CLUSTER0_SENSOR 2
51 #define HI6220_CLUSTER1_SENSOR 1
53 #define HI3660_LITTLE_SENSOR 0
54 #define HI3660_BIG_SENSOR 1
55 #define HI3660_G3D_SENSOR 2
56 #define HI3660_MODEM_SENSOR 3
58 struct hisi_thermal_data;
60 struct hisi_thermal_sensor {
61 struct hisi_thermal_data *data;
62 struct thermal_zone_device *tzd;
68 struct hisi_thermal_ops {
69 int (*get_temp)(struct hisi_thermal_sensor *sensor);
70 int (*enable_sensor)(struct hisi_thermal_sensor *sensor);
71 int (*disable_sensor)(struct hisi_thermal_sensor *sensor);
72 int (*irq_handler)(struct hisi_thermal_sensor *sensor);
73 int (*probe)(struct hisi_thermal_data *data);
76 struct hisi_thermal_data {
77 const struct hisi_thermal_ops *ops;
78 struct hisi_thermal_sensor *sensor;
79 struct platform_device *pdev;
86 * The temperature computation on the tsensor is as follow:
87 * Unit: millidegree Celsius
88 * Step: 200/255 (0.7843)
89 * Temperature base: -60°C
91 * The register is programmed in temperature steps, every step is 785
92 * millidegree and begins at -60 000 m°C
94 * The temperature from the steps:
96 * Temp = TempBase + (steps x 785)
98 * and the steps from the temperature:
100 * steps = (Temp - TempBase) / 785
103 static inline int hi6220_thermal_step_to_temp(int step)
105 return HI6220_TEMP_BASE + (step * HI6220_TEMP_STEP);
108 static inline int hi6220_thermal_temp_to_step(int temp)
110 return DIV_ROUND_UP(temp - HI6220_TEMP_BASE, HI6220_TEMP_STEP);
115 * Step: 189/922 (0.205)
116 * Temperature base: -63.780°C
118 * The register is programmed in temperature steps, every step is 205
119 * millidegree and begins at -63 780 m°C
121 static inline int hi3660_thermal_step_to_temp(int step)
123 return HI3660_TEMP_BASE + step * HI3660_TEMP_STEP;
126 static inline int hi3660_thermal_temp_to_step(int temp)
128 return DIV_ROUND_UP(temp - HI3660_TEMP_BASE, HI3660_TEMP_STEP);
132 * The lag register contains 5 bits encoding the temperature in steps.
134 * Each time the temperature crosses the threshold boundary, an
135 * interrupt is raised. It could be when the temperature is going
136 * above the threshold or below. However, if the temperature is
137 * fluctuating around this value due to the load, we can receive
138 * several interrupts which may not desired.
140 * We can setup a temperature representing the delta between the
141 * threshold and the current temperature when the temperature is
144 * For instance: the lag register is 5°C, the threshold is 65°C, when
145 * the temperature reaches 65°C an interrupt is raised and when the
146 * temperature decrease to 65°C - 5°C another interrupt is raised.
148 * A very short lag can lead to an interrupt storm, a long lag
149 * increase the latency to react to the temperature changes. In our
150 * case, that is not really a problem as we are polling the
153 * [0:4] : lag register
155 * The temperature is coded in steps, cf. HI6220_TEMP_STEP.
157 * Min : 0x00 : 0.0 °C
158 * Max : 0x1F : 24.3 °C
160 * The 'value' parameter is in milliCelsius.
162 static inline void hi6220_thermal_set_lag(void __iomem *addr, int value)
164 writel(DIV_ROUND_UP(value, HI6220_TEMP_STEP) & 0x1F,
165 addr + HI6220_TEMP0_LAG);
168 static inline void hi6220_thermal_alarm_clear(void __iomem *addr, int value)
170 writel(value, addr + HI6220_TEMP0_INT_CLR);
173 static inline void hi6220_thermal_alarm_enable(void __iomem *addr, int value)
175 writel(value, addr + HI6220_TEMP0_INT_EN);
178 static inline void hi6220_thermal_alarm_set(void __iomem *addr, int temp)
180 writel(hi6220_thermal_temp_to_step(temp) | 0x0FFFFFF00,
181 addr + HI6220_TEMP0_TH);
184 static inline void hi6220_thermal_reset_set(void __iomem *addr, int temp)
186 writel(hi6220_thermal_temp_to_step(temp), addr + HI6220_TEMP0_RST_TH);
189 static inline void hi6220_thermal_reset_enable(void __iomem *addr, int value)
191 writel(value, addr + HI6220_TEMP0_RST_MSK);
194 static inline void hi6220_thermal_enable(void __iomem *addr, int value)
196 writel(value, addr + HI6220_TEMP0_EN);
199 static inline int hi6220_thermal_get_temperature(void __iomem *addr)
201 return hi6220_thermal_step_to_temp(readl(addr + HI6220_TEMP0_VALUE));
207 * The temperature is coded in steps, cf. HI3660_TEMP_STEP.
209 * Min : 0x00 : 0.0 °C
210 * Max : 0x7F : 26.0 °C
213 static inline void hi3660_thermal_set_lag(void __iomem *addr,
216 writel(DIV_ROUND_UP(value, HI3660_TEMP_STEP) & 0x7F,
217 addr + HI3660_LAG(id));
220 static inline void hi3660_thermal_alarm_clear(void __iomem *addr,
223 writel(value, addr + HI3660_INT_CLR(id));
226 static inline void hi3660_thermal_alarm_enable(void __iomem *addr,
229 writel(value, addr + HI3660_INT_EN(id));
232 static inline void hi3660_thermal_alarm_set(void __iomem *addr,
235 writel(value, addr + HI3660_TH(id));
238 static inline int hi3660_thermal_get_temperature(void __iomem *addr, int id)
240 return hi3660_thermal_step_to_temp(readl(addr + HI3660_TEMP(id)));
244 * Temperature configuration register - Sensor selection
248 * 0x0: local sensor (default)
249 * 0x1: remote sensor 1 (ACPU cluster 1)
250 * 0x2: remote sensor 2 (ACPU cluster 0)
251 * 0x3: remote sensor 3 (G3D)
253 static inline void hi6220_thermal_sensor_select(void __iomem *addr, int sensor)
255 writel((readl(addr + HI6220_TEMP0_CFG) & ~HI6220_TEMP0_CFG_SS_MSK) |
256 (sensor << 12), addr + HI6220_TEMP0_CFG);
260 * Temperature configuration register - Hdak conversion polling interval
269 static inline void hi6220_thermal_hdak_set(void __iomem *addr, int value)
271 writel((readl(addr + HI6220_TEMP0_CFG) & ~HI6220_TEMP0_CFG_HDAK_MSK) |
272 (value << 4), addr + HI6220_TEMP0_CFG);
275 static int hi6220_thermal_irq_handler(struct hisi_thermal_sensor *sensor)
277 struct hisi_thermal_data *data = sensor->data;
279 hi6220_thermal_alarm_clear(data->regs, 1);
283 static int hi3660_thermal_irq_handler(struct hisi_thermal_sensor *sensor)
285 struct hisi_thermal_data *data = sensor->data;
287 hi3660_thermal_alarm_clear(data->regs, sensor->id, 1);
291 static int hi6220_thermal_get_temp(struct hisi_thermal_sensor *sensor)
293 struct hisi_thermal_data *data = sensor->data;
295 return hi6220_thermal_get_temperature(data->regs);
298 static int hi3660_thermal_get_temp(struct hisi_thermal_sensor *sensor)
300 struct hisi_thermal_data *data = sensor->data;
302 return hi3660_thermal_get_temperature(data->regs, sensor->id);
305 static int hi6220_thermal_disable_sensor(struct hisi_thermal_sensor *sensor)
307 struct hisi_thermal_data *data = sensor->data;
309 /* disable sensor module */
310 hi6220_thermal_enable(data->regs, 0);
311 hi6220_thermal_alarm_enable(data->regs, 0);
312 hi6220_thermal_reset_enable(data->regs, 0);
314 clk_disable_unprepare(data->clk);
319 static int hi3660_thermal_disable_sensor(struct hisi_thermal_sensor *sensor)
321 struct hisi_thermal_data *data = sensor->data;
323 /* disable sensor module */
324 hi3660_thermal_alarm_enable(data->regs, sensor->id, 0);
328 static int hi6220_thermal_enable_sensor(struct hisi_thermal_sensor *sensor)
330 struct hisi_thermal_data *data = sensor->data;
333 /* enable clock for tsensor */
334 ret = clk_prepare_enable(data->clk);
338 /* disable module firstly */
339 hi6220_thermal_reset_enable(data->regs, 0);
340 hi6220_thermal_enable(data->regs, 0);
342 /* select sensor id */
343 hi6220_thermal_sensor_select(data->regs, sensor->id);
345 /* setting the hdak time */
346 hi6220_thermal_hdak_set(data->regs, 0);
348 /* setting lag value between current temp and the threshold */
349 hi6220_thermal_set_lag(data->regs, HI6220_TEMP_LAG);
351 /* enable for interrupt */
352 hi6220_thermal_alarm_set(data->regs, sensor->thres_temp);
354 hi6220_thermal_reset_set(data->regs, HI6220_TEMP_RESET);
357 hi6220_thermal_reset_enable(data->regs, 1);
358 hi6220_thermal_enable(data->regs, 1);
360 hi6220_thermal_alarm_clear(data->regs, 0);
361 hi6220_thermal_alarm_enable(data->regs, 1);
366 static int hi3660_thermal_enable_sensor(struct hisi_thermal_sensor *sensor)
369 struct hisi_thermal_data *data = sensor->data;
371 /* disable interrupt */
372 hi3660_thermal_alarm_enable(data->regs, sensor->id, 0);
374 /* setting lag value between current temp and the threshold */
375 hi3660_thermal_set_lag(data->regs, sensor->id, HI3660_TEMP_LAG);
377 /* set interrupt threshold */
378 value = hi3660_thermal_temp_to_step(sensor->thres_temp);
379 hi3660_thermal_alarm_set(data->regs, sensor->id, value);
381 /* enable interrupt */
382 hi3660_thermal_alarm_clear(data->regs, sensor->id, 1);
383 hi3660_thermal_alarm_enable(data->regs, sensor->id, 1);
388 static int hi6220_thermal_probe(struct hisi_thermal_data *data)
390 struct platform_device *pdev = data->pdev;
391 struct device *dev = &pdev->dev;
394 data->clk = devm_clk_get(dev, "thermal_clk");
395 if (IS_ERR(data->clk)) {
396 ret = PTR_ERR(data->clk);
397 if (ret != -EPROBE_DEFER)
398 dev_err(dev, "failed to get thermal clk: %d\n", ret);
402 data->sensor = devm_kzalloc(dev, sizeof(*data->sensor), GFP_KERNEL);
406 data->sensor[0].id = HI6220_CLUSTER0_SENSOR;
407 data->sensor[0].irq_name = "tsensor_intr";
408 data->sensor[0].data = data;
409 data->nr_sensors = 1;
414 static int hi3660_thermal_probe(struct hisi_thermal_data *data)
416 struct platform_device *pdev = data->pdev;
417 struct device *dev = &pdev->dev;
419 data->nr_sensors = 1;
421 data->sensor = devm_kzalloc(dev, sizeof(*data->sensor) *
422 data->nr_sensors, GFP_KERNEL);
426 data->sensor[0].id = HI3660_BIG_SENSOR;
427 data->sensor[0].irq_name = "tsensor_a73";
428 data->sensor[0].data = data;
430 data->sensor[1].id = HI3660_LITTLE_SENSOR;
431 data->sensor[1].irq_name = "tsensor_a53";
432 data->sensor[1].data = data;
437 static int hisi_thermal_get_temp(struct thermal_zone_device *tz, int *temp)
439 struct hisi_thermal_sensor *sensor = tz->devdata;
440 struct hisi_thermal_data *data = sensor->data;
442 *temp = data->ops->get_temp(sensor);
444 dev_dbg(&data->pdev->dev, "tzd=%p, id=%d, temp=%d, thres=%d\n",
445 sensor->tzd, sensor->id, *temp, sensor->thres_temp);
450 static const struct thermal_zone_device_ops hisi_of_thermal_ops = {
451 .get_temp = hisi_thermal_get_temp,
454 static irqreturn_t hisi_thermal_alarm_irq_thread(int irq, void *dev)
456 struct hisi_thermal_sensor *sensor = dev;
457 struct hisi_thermal_data *data = sensor->data;
460 data->ops->irq_handler(sensor);
462 temp = data->ops->get_temp(sensor);
464 if (temp >= sensor->thres_temp) {
465 dev_crit(&data->pdev->dev,
466 "sensor <%d> THERMAL ALARM: %d > %d\n",
467 sensor->id, temp, sensor->thres_temp);
469 thermal_zone_device_update(sensor->tzd,
470 THERMAL_EVENT_UNSPECIFIED);
473 dev_crit(&data->pdev->dev,
474 "sensor <%d> THERMAL ALARM stopped: %d < %d\n",
475 sensor->id, temp, sensor->thres_temp);
481 static int hisi_thermal_register_sensor(struct platform_device *pdev,
482 struct hisi_thermal_sensor *sensor)
485 const struct thermal_trip *trip;
487 sensor->tzd = devm_thermal_of_zone_register(&pdev->dev,
489 &hisi_of_thermal_ops);
490 if (IS_ERR(sensor->tzd)) {
491 ret = PTR_ERR(sensor->tzd);
493 dev_err(&pdev->dev, "failed to register sensor id %d: %d\n",
498 trip = of_thermal_get_trip_points(sensor->tzd);
500 for (i = 0; i < of_thermal_get_ntrips(sensor->tzd); i++) {
501 if (trip[i].type == THERMAL_TRIP_PASSIVE) {
502 sensor->thres_temp = trip[i].temperature;
510 static const struct hisi_thermal_ops hi6220_ops = {
511 .get_temp = hi6220_thermal_get_temp,
512 .enable_sensor = hi6220_thermal_enable_sensor,
513 .disable_sensor = hi6220_thermal_disable_sensor,
514 .irq_handler = hi6220_thermal_irq_handler,
515 .probe = hi6220_thermal_probe,
518 static const struct hisi_thermal_ops hi3660_ops = {
519 .get_temp = hi3660_thermal_get_temp,
520 .enable_sensor = hi3660_thermal_enable_sensor,
521 .disable_sensor = hi3660_thermal_disable_sensor,
522 .irq_handler = hi3660_thermal_irq_handler,
523 .probe = hi3660_thermal_probe,
526 static const struct of_device_id of_hisi_thermal_match[] = {
528 .compatible = "hisilicon,tsensor",
532 .compatible = "hisilicon,hi3660-tsensor",
537 MODULE_DEVICE_TABLE(of, of_hisi_thermal_match);
539 static void hisi_thermal_toggle_sensor(struct hisi_thermal_sensor *sensor,
542 struct thermal_zone_device *tzd = sensor->tzd;
545 thermal_zone_device_enable(tzd);
547 thermal_zone_device_disable(tzd);
550 static int hisi_thermal_probe(struct platform_device *pdev)
552 struct hisi_thermal_data *data;
553 struct device *dev = &pdev->dev;
554 struct resource *res;
557 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
562 platform_set_drvdata(pdev, data);
563 data->ops = of_device_get_match_data(dev);
565 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
566 data->regs = devm_ioremap_resource(dev, res);
567 if (IS_ERR(data->regs))
568 return PTR_ERR(data->regs);
570 ret = data->ops->probe(data);
574 for (i = 0; i < data->nr_sensors; i++) {
575 struct hisi_thermal_sensor *sensor = &data->sensor[i];
577 ret = hisi_thermal_register_sensor(pdev, sensor);
579 dev_err(dev, "failed to register thermal sensor: %d\n",
584 ret = platform_get_irq(pdev, 0);
588 ret = devm_request_threaded_irq(dev, ret, NULL,
589 hisi_thermal_alarm_irq_thread,
590 IRQF_ONESHOT, sensor->irq_name,
593 dev_err(dev, "Failed to request alarm irq: %d\n", ret);
597 ret = data->ops->enable_sensor(sensor);
599 dev_err(dev, "Failed to setup the sensor: %d\n", ret);
603 hisi_thermal_toggle_sensor(sensor, true);
609 static int hisi_thermal_remove(struct platform_device *pdev)
611 struct hisi_thermal_data *data = platform_get_drvdata(pdev);
614 for (i = 0; i < data->nr_sensors; i++) {
615 struct hisi_thermal_sensor *sensor = &data->sensor[i];
617 hisi_thermal_toggle_sensor(sensor, false);
618 data->ops->disable_sensor(sensor);
624 static int hisi_thermal_suspend(struct device *dev)
626 struct hisi_thermal_data *data = dev_get_drvdata(dev);
629 for (i = 0; i < data->nr_sensors; i++)
630 data->ops->disable_sensor(&data->sensor[i]);
635 static int hisi_thermal_resume(struct device *dev)
637 struct hisi_thermal_data *data = dev_get_drvdata(dev);
640 for (i = 0; i < data->nr_sensors; i++)
641 ret |= data->ops->enable_sensor(&data->sensor[i]);
646 static DEFINE_SIMPLE_DEV_PM_OPS(hisi_thermal_pm_ops,
647 hisi_thermal_suspend, hisi_thermal_resume);
649 static struct platform_driver hisi_thermal_driver = {
651 .name = "hisi_thermal",
652 .pm = pm_sleep_ptr(&hisi_thermal_pm_ops),
653 .of_match_table = of_hisi_thermal_match,
655 .probe = hisi_thermal_probe,
656 .remove = hisi_thermal_remove,
659 module_platform_driver(hisi_thermal_driver);
661 MODULE_AUTHOR("Xinwei Kong <kong.kongxinwei@hisilicon.com>");
662 MODULE_AUTHOR("Leo Yan <leo.yan@linaro.org>");
663 MODULE_DESCRIPTION("HiSilicon thermal driver");
664 MODULE_LICENSE("GPL v2");