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>
17 #include <linux/platform_device.h>
19 #include <linux/thermal.h>
21 #define HI6220_TEMP0_LAG (0x0)
22 #define HI6220_TEMP0_TH (0x4)
23 #define HI6220_TEMP0_RST_TH (0x8)
24 #define HI6220_TEMP0_CFG (0xC)
25 #define HI6220_TEMP0_CFG_SS_MSK (0xF000)
26 #define HI6220_TEMP0_CFG_HDAK_MSK (0x30)
27 #define HI6220_TEMP0_EN (0x10)
28 #define HI6220_TEMP0_INT_EN (0x14)
29 #define HI6220_TEMP0_INT_CLR (0x18)
30 #define HI6220_TEMP0_RST_MSK (0x1C)
31 #define HI6220_TEMP0_VALUE (0x28)
33 #define HI3660_OFFSET(chan) ((chan) * 0x40)
34 #define HI3660_TEMP(chan) (HI3660_OFFSET(chan) + 0x1C)
35 #define HI3660_TH(chan) (HI3660_OFFSET(chan) + 0x20)
36 #define HI3660_LAG(chan) (HI3660_OFFSET(chan) + 0x28)
37 #define HI3660_INT_EN(chan) (HI3660_OFFSET(chan) + 0x2C)
38 #define HI3660_INT_CLR(chan) (HI3660_OFFSET(chan) + 0x30)
40 #define HI6220_TEMP_BASE (-60000)
41 #define HI6220_TEMP_RESET (100000)
42 #define HI6220_TEMP_STEP (785)
43 #define HI6220_TEMP_LAG (3500)
45 #define HI3660_TEMP_BASE (-63780)
46 #define HI3660_TEMP_STEP (205)
47 #define HI3660_TEMP_LAG (4000)
49 #define HI6220_CLUSTER0_SENSOR 2
50 #define HI6220_CLUSTER1_SENSOR 1
52 #define HI3660_LITTLE_SENSOR 0
53 #define HI3660_BIG_SENSOR 1
54 #define HI3660_G3D_SENSOR 2
55 #define HI3660_MODEM_SENSOR 3
57 struct hisi_thermal_data
;
59 struct hisi_thermal_sensor
{
60 struct hisi_thermal_data
*data
;
61 struct thermal_zone_device
*tzd
;
67 struct hisi_thermal_ops
{
68 int (*get_temp
)(struct hisi_thermal_sensor
*sensor
);
69 int (*enable_sensor
)(struct hisi_thermal_sensor
*sensor
);
70 int (*disable_sensor
)(struct hisi_thermal_sensor
*sensor
);
71 int (*irq_handler
)(struct hisi_thermal_sensor
*sensor
);
72 int (*probe
)(struct hisi_thermal_data
*data
);
75 struct hisi_thermal_data
{
76 const struct hisi_thermal_ops
*ops
;
77 struct hisi_thermal_sensor
*sensor
;
78 struct platform_device
*pdev
;
85 * The temperature computation on the tsensor is as follow:
86 * Unit: millidegree Celsius
87 * Step: 200/255 (0.7843)
88 * Temperature base: -60°C
90 * The register is programmed in temperature steps, every step is 785
91 * millidegree and begins at -60 000 m°C
93 * The temperature from the steps:
95 * Temp = TempBase + (steps x 785)
97 * and the steps from the temperature:
99 * steps = (Temp - TempBase) / 785
102 static inline int hi6220_thermal_step_to_temp(int step
)
104 return HI6220_TEMP_BASE
+ (step
* HI6220_TEMP_STEP
);
107 static inline int hi6220_thermal_temp_to_step(int temp
)
109 return DIV_ROUND_UP(temp
- HI6220_TEMP_BASE
, HI6220_TEMP_STEP
);
114 * Step: 189/922 (0.205)
115 * Temperature base: -63.780°C
117 * The register is programmed in temperature steps, every step is 205
118 * millidegree and begins at -63 780 m°C
120 static inline int hi3660_thermal_step_to_temp(int step
)
122 return HI3660_TEMP_BASE
+ step
* HI3660_TEMP_STEP
;
125 static inline int hi3660_thermal_temp_to_step(int temp
)
127 return DIV_ROUND_UP(temp
- HI3660_TEMP_BASE
, HI3660_TEMP_STEP
);
131 * The lag register contains 5 bits encoding the temperature in steps.
133 * Each time the temperature crosses the threshold boundary, an
134 * interrupt is raised. It could be when the temperature is going
135 * above the threshold or below. However, if the temperature is
136 * fluctuating around this value due to the load, we can receive
137 * several interrupts which may not desired.
139 * We can setup a temperature representing the delta between the
140 * threshold and the current temperature when the temperature is
143 * For instance: the lag register is 5°C, the threshold is 65°C, when
144 * the temperature reaches 65°C an interrupt is raised and when the
145 * temperature decrease to 65°C - 5°C another interrupt is raised.
147 * A very short lag can lead to an interrupt storm, a long lag
148 * increase the latency to react to the temperature changes. In our
149 * case, that is not really a problem as we are polling the
152 * [0:4] : lag register
154 * The temperature is coded in steps, cf. HI6220_TEMP_STEP.
156 * Min : 0x00 : 0.0 °C
157 * Max : 0x1F : 24.3 °C
159 * The 'value' parameter is in milliCelsius.
161 static inline void hi6220_thermal_set_lag(void __iomem
*addr
, int value
)
163 writel(DIV_ROUND_UP(value
, HI6220_TEMP_STEP
) & 0x1F,
164 addr
+ HI6220_TEMP0_LAG
);
167 static inline void hi6220_thermal_alarm_clear(void __iomem
*addr
, int value
)
169 writel(value
, addr
+ HI6220_TEMP0_INT_CLR
);
172 static inline void hi6220_thermal_alarm_enable(void __iomem
*addr
, int value
)
174 writel(value
, addr
+ HI6220_TEMP0_INT_EN
);
177 static inline void hi6220_thermal_alarm_set(void __iomem
*addr
, int temp
)
179 writel(hi6220_thermal_temp_to_step(temp
) | 0x0FFFFFF00,
180 addr
+ HI6220_TEMP0_TH
);
183 static inline void hi6220_thermal_reset_set(void __iomem
*addr
, int temp
)
185 writel(hi6220_thermal_temp_to_step(temp
), addr
+ HI6220_TEMP0_RST_TH
);
188 static inline void hi6220_thermal_reset_enable(void __iomem
*addr
, int value
)
190 writel(value
, addr
+ HI6220_TEMP0_RST_MSK
);
193 static inline void hi6220_thermal_enable(void __iomem
*addr
, int value
)
195 writel(value
, addr
+ HI6220_TEMP0_EN
);
198 static inline int hi6220_thermal_get_temperature(void __iomem
*addr
)
200 return hi6220_thermal_step_to_temp(readl(addr
+ HI6220_TEMP0_VALUE
));
206 * The temperature is coded in steps, cf. HI3660_TEMP_STEP.
208 * Min : 0x00 : 0.0 °C
209 * Max : 0x7F : 26.0 °C
212 static inline void hi3660_thermal_set_lag(void __iomem
*addr
,
215 writel(DIV_ROUND_UP(value
, HI3660_TEMP_STEP
) & 0x7F,
216 addr
+ HI3660_LAG(id
));
219 static inline void hi3660_thermal_alarm_clear(void __iomem
*addr
,
222 writel(value
, addr
+ HI3660_INT_CLR(id
));
225 static inline void hi3660_thermal_alarm_enable(void __iomem
*addr
,
228 writel(value
, addr
+ HI3660_INT_EN(id
));
231 static inline void hi3660_thermal_alarm_set(void __iomem
*addr
,
234 writel(value
, addr
+ HI3660_TH(id
));
237 static inline int hi3660_thermal_get_temperature(void __iomem
*addr
, int id
)
239 return hi3660_thermal_step_to_temp(readl(addr
+ HI3660_TEMP(id
)));
243 * Temperature configuration register - Sensor selection
247 * 0x0: local sensor (default)
248 * 0x1: remote sensor 1 (ACPU cluster 1)
249 * 0x2: remote sensor 2 (ACPU cluster 0)
250 * 0x3: remote sensor 3 (G3D)
252 static inline void hi6220_thermal_sensor_select(void __iomem
*addr
, int sensor
)
254 writel((readl(addr
+ HI6220_TEMP0_CFG
) & ~HI6220_TEMP0_CFG_SS_MSK
) |
255 (sensor
<< 12), addr
+ HI6220_TEMP0_CFG
);
259 * Temperature configuration register - Hdak conversion polling interval
268 static inline void hi6220_thermal_hdak_set(void __iomem
*addr
, int value
)
270 writel((readl(addr
+ HI6220_TEMP0_CFG
) & ~HI6220_TEMP0_CFG_HDAK_MSK
) |
271 (value
<< 4), addr
+ HI6220_TEMP0_CFG
);
274 static int hi6220_thermal_irq_handler(struct hisi_thermal_sensor
*sensor
)
276 struct hisi_thermal_data
*data
= sensor
->data
;
278 hi6220_thermal_alarm_clear(data
->regs
, 1);
282 static int hi3660_thermal_irq_handler(struct hisi_thermal_sensor
*sensor
)
284 struct hisi_thermal_data
*data
= sensor
->data
;
286 hi3660_thermal_alarm_clear(data
->regs
, sensor
->id
, 1);
290 static int hi6220_thermal_get_temp(struct hisi_thermal_sensor
*sensor
)
292 struct hisi_thermal_data
*data
= sensor
->data
;
294 return hi6220_thermal_get_temperature(data
->regs
);
297 static int hi3660_thermal_get_temp(struct hisi_thermal_sensor
*sensor
)
299 struct hisi_thermal_data
*data
= sensor
->data
;
301 return hi3660_thermal_get_temperature(data
->regs
, sensor
->id
);
304 static int hi6220_thermal_disable_sensor(struct hisi_thermal_sensor
*sensor
)
306 struct hisi_thermal_data
*data
= sensor
->data
;
308 /* disable sensor module */
309 hi6220_thermal_enable(data
->regs
, 0);
310 hi6220_thermal_alarm_enable(data
->regs
, 0);
311 hi6220_thermal_reset_enable(data
->regs
, 0);
313 clk_disable_unprepare(data
->clk
);
318 static int hi3660_thermal_disable_sensor(struct hisi_thermal_sensor
*sensor
)
320 struct hisi_thermal_data
*data
= sensor
->data
;
322 /* disable sensor module */
323 hi3660_thermal_alarm_enable(data
->regs
, sensor
->id
, 0);
327 static int hi6220_thermal_enable_sensor(struct hisi_thermal_sensor
*sensor
)
329 struct hisi_thermal_data
*data
= sensor
->data
;
332 /* enable clock for tsensor */
333 ret
= clk_prepare_enable(data
->clk
);
337 /* disable module firstly */
338 hi6220_thermal_reset_enable(data
->regs
, 0);
339 hi6220_thermal_enable(data
->regs
, 0);
341 /* select sensor id */
342 hi6220_thermal_sensor_select(data
->regs
, sensor
->id
);
344 /* setting the hdak time */
345 hi6220_thermal_hdak_set(data
->regs
, 0);
347 /* setting lag value between current temp and the threshold */
348 hi6220_thermal_set_lag(data
->regs
, HI6220_TEMP_LAG
);
350 /* enable for interrupt */
351 hi6220_thermal_alarm_set(data
->regs
, sensor
->thres_temp
);
353 hi6220_thermal_reset_set(data
->regs
, HI6220_TEMP_RESET
);
356 hi6220_thermal_reset_enable(data
->regs
, 1);
357 hi6220_thermal_enable(data
->regs
, 1);
359 hi6220_thermal_alarm_clear(data
->regs
, 0);
360 hi6220_thermal_alarm_enable(data
->regs
, 1);
365 static int hi3660_thermal_enable_sensor(struct hisi_thermal_sensor
*sensor
)
368 struct hisi_thermal_data
*data
= sensor
->data
;
370 /* disable interrupt */
371 hi3660_thermal_alarm_enable(data
->regs
, sensor
->id
, 0);
373 /* setting lag value between current temp and the threshold */
374 hi3660_thermal_set_lag(data
->regs
, sensor
->id
, HI3660_TEMP_LAG
);
376 /* set interrupt threshold */
377 value
= hi3660_thermal_temp_to_step(sensor
->thres_temp
);
378 hi3660_thermal_alarm_set(data
->regs
, sensor
->id
, value
);
380 /* enable interrupt */
381 hi3660_thermal_alarm_clear(data
->regs
, sensor
->id
, 1);
382 hi3660_thermal_alarm_enable(data
->regs
, sensor
->id
, 1);
387 static int hi6220_thermal_probe(struct hisi_thermal_data
*data
)
389 struct platform_device
*pdev
= data
->pdev
;
390 struct device
*dev
= &pdev
->dev
;
392 data
->clk
= devm_clk_get(dev
, "thermal_clk");
393 if (IS_ERR(data
->clk
))
394 return dev_err_probe(dev
, PTR_ERR(data
->clk
), "failed to get thermal clk\n");
396 data
->sensor
= devm_kzalloc(dev
, sizeof(*data
->sensor
), GFP_KERNEL
);
400 data
->sensor
[0].id
= HI6220_CLUSTER0_SENSOR
;
401 data
->sensor
[0].irq_name
= "tsensor_intr";
402 data
->sensor
[0].data
= data
;
403 data
->nr_sensors
= 1;
408 static int hi3660_thermal_probe(struct hisi_thermal_data
*data
)
410 struct platform_device
*pdev
= data
->pdev
;
411 struct device
*dev
= &pdev
->dev
;
413 data
->nr_sensors
= 1;
415 data
->sensor
= devm_kzalloc(dev
, sizeof(*data
->sensor
) *
416 data
->nr_sensors
, GFP_KERNEL
);
420 data
->sensor
[0].id
= HI3660_BIG_SENSOR
;
421 data
->sensor
[0].irq_name
= "tsensor_a73";
422 data
->sensor
[0].data
= data
;
427 static int hisi_thermal_get_temp(struct thermal_zone_device
*tz
, int *temp
)
429 struct hisi_thermal_sensor
*sensor
= thermal_zone_device_priv(tz
);
430 struct hisi_thermal_data
*data
= sensor
->data
;
432 *temp
= data
->ops
->get_temp(sensor
);
437 static const struct thermal_zone_device_ops hisi_of_thermal_ops
= {
438 .get_temp
= hisi_thermal_get_temp
,
441 static irqreturn_t
hisi_thermal_alarm_irq_thread(int irq
, void *dev
)
443 struct hisi_thermal_sensor
*sensor
= dev
;
444 struct hisi_thermal_data
*data
= sensor
->data
;
447 data
->ops
->irq_handler(sensor
);
449 temp
= data
->ops
->get_temp(sensor
);
451 if (temp
>= sensor
->thres_temp
) {
452 dev_crit(&data
->pdev
->dev
,
453 "sensor <%d> THERMAL ALARM: %d > %d\n",
454 sensor
->id
, temp
, sensor
->thres_temp
);
456 thermal_zone_device_update(sensor
->tzd
,
457 THERMAL_EVENT_UNSPECIFIED
);
460 dev_crit(&data
->pdev
->dev
,
461 "sensor <%d> THERMAL ALARM stopped: %d < %d\n",
462 sensor
->id
, temp
, sensor
->thres_temp
);
468 static int hisi_trip_walk_cb(struct thermal_trip
*trip
, void *arg
)
470 struct hisi_thermal_sensor
*sensor
= arg
;
472 if (trip
->type
!= THERMAL_TRIP_PASSIVE
)
475 sensor
->thres_temp
= trip
->temperature
;
476 /* Return nonzero to terminate the search. */
480 static int hisi_thermal_register_sensor(struct platform_device
*pdev
,
481 struct hisi_thermal_sensor
*sensor
)
485 sensor
->tzd
= devm_thermal_of_zone_register(&pdev
->dev
,
487 &hisi_of_thermal_ops
);
488 if (IS_ERR(sensor
->tzd
)) {
489 ret
= PTR_ERR(sensor
->tzd
);
491 dev_err(&pdev
->dev
, "failed to register sensor id %d: %d\n",
496 thermal_zone_for_each_trip(sensor
->tzd
, hisi_trip_walk_cb
, sensor
);
501 static const struct hisi_thermal_ops hi6220_ops
= {
502 .get_temp
= hi6220_thermal_get_temp
,
503 .enable_sensor
= hi6220_thermal_enable_sensor
,
504 .disable_sensor
= hi6220_thermal_disable_sensor
,
505 .irq_handler
= hi6220_thermal_irq_handler
,
506 .probe
= hi6220_thermal_probe
,
509 static const struct hisi_thermal_ops hi3660_ops
= {
510 .get_temp
= hi3660_thermal_get_temp
,
511 .enable_sensor
= hi3660_thermal_enable_sensor
,
512 .disable_sensor
= hi3660_thermal_disable_sensor
,
513 .irq_handler
= hi3660_thermal_irq_handler
,
514 .probe
= hi3660_thermal_probe
,
517 static const struct of_device_id of_hisi_thermal_match
[] = {
519 .compatible
= "hisilicon,tsensor",
523 .compatible
= "hisilicon,hi3660-tsensor",
528 MODULE_DEVICE_TABLE(of
, of_hisi_thermal_match
);
530 static void hisi_thermal_toggle_sensor(struct hisi_thermal_sensor
*sensor
,
533 struct thermal_zone_device
*tzd
= sensor
->tzd
;
536 thermal_zone_device_enable(tzd
);
538 thermal_zone_device_disable(tzd
);
541 static int hisi_thermal_probe(struct platform_device
*pdev
)
543 struct hisi_thermal_data
*data
;
544 struct device
*dev
= &pdev
->dev
;
547 data
= devm_kzalloc(dev
, sizeof(*data
), GFP_KERNEL
);
552 platform_set_drvdata(pdev
, data
);
553 data
->ops
= of_device_get_match_data(dev
);
555 data
->regs
= devm_platform_ioremap_resource(pdev
, 0);
556 if (IS_ERR(data
->regs
))
557 return PTR_ERR(data
->regs
);
559 ret
= data
->ops
->probe(data
);
563 for (i
= 0; i
< data
->nr_sensors
; i
++) {
564 struct hisi_thermal_sensor
*sensor
= &data
->sensor
[i
];
566 ret
= hisi_thermal_register_sensor(pdev
, sensor
);
568 dev_err(dev
, "failed to register thermal sensor: %d\n",
573 ret
= platform_get_irq(pdev
, 0);
577 ret
= devm_request_threaded_irq(dev
, ret
, NULL
,
578 hisi_thermal_alarm_irq_thread
,
579 IRQF_ONESHOT
, sensor
->irq_name
,
582 dev_err(dev
, "Failed to request alarm irq: %d\n", ret
);
586 ret
= data
->ops
->enable_sensor(sensor
);
588 dev_err(dev
, "Failed to setup the sensor: %d\n", ret
);
592 hisi_thermal_toggle_sensor(sensor
, true);
598 static void hisi_thermal_remove(struct platform_device
*pdev
)
600 struct hisi_thermal_data
*data
= platform_get_drvdata(pdev
);
603 for (i
= 0; i
< data
->nr_sensors
; i
++) {
604 struct hisi_thermal_sensor
*sensor
= &data
->sensor
[i
];
606 hisi_thermal_toggle_sensor(sensor
, false);
607 data
->ops
->disable_sensor(sensor
);
611 static int hisi_thermal_suspend(struct device
*dev
)
613 struct hisi_thermal_data
*data
= dev_get_drvdata(dev
);
616 for (i
= 0; i
< data
->nr_sensors
; i
++)
617 data
->ops
->disable_sensor(&data
->sensor
[i
]);
622 static int hisi_thermal_resume(struct device
*dev
)
624 struct hisi_thermal_data
*data
= dev_get_drvdata(dev
);
627 for (i
= 0; i
< data
->nr_sensors
; i
++)
628 ret
|= data
->ops
->enable_sensor(&data
->sensor
[i
]);
633 static DEFINE_SIMPLE_DEV_PM_OPS(hisi_thermal_pm_ops
,
634 hisi_thermal_suspend
, hisi_thermal_resume
);
636 static struct platform_driver hisi_thermal_driver
= {
638 .name
= "hisi_thermal",
639 .pm
= pm_sleep_ptr(&hisi_thermal_pm_ops
),
640 .of_match_table
= of_hisi_thermal_match
,
642 .probe
= hisi_thermal_probe
,
643 .remove
= hisi_thermal_remove
,
646 module_platform_driver(hisi_thermal_driver
);
648 MODULE_AUTHOR("Xinwei Kong <kong.kongxinwei@hisilicon.com>");
649 MODULE_AUTHOR("Leo Yan <leo.yan@linaro.org>");
650 MODULE_DESCRIPTION("HiSilicon thermal driver");
651 MODULE_LICENSE("GPL v2");