1 // SPDX-License-Identifier: GPL-2.0
3 * R-Car THS/TSC thermal sensor driver
5 * Copyright (C) 2012 Renesas Solutions Corp.
6 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
8 #include <linux/delay.h>
10 #include <linux/irq.h>
11 #include <linux/interrupt.h>
13 #include <linux/module.h>
14 #include <linux/of_device.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/reboot.h>
18 #include <linux/slab.h>
19 #include <linux/spinlock.h>
20 #include <linux/thermal.h>
22 #include "thermal_hwmon.h"
24 #define IDLE_INTERVAL 5000
26 #define COMMON_STR 0x00
27 #define COMMON_ENR 0x04
28 #define COMMON_INTMSK 0x0c
30 #define REG_POSNEG 0x20
31 #define REG_FILONOFF 0x28
32 #define REG_THSCR 0x2c
33 #define REG_THSSR 0x30
34 #define REG_INTCTRL 0x34
37 #define CPCTL (1 << 12)
42 struct rcar_thermal_common {
45 struct list_head head;
49 struct rcar_thermal_chip {
50 unsigned int use_of_thermal : 1;
51 unsigned int has_filonoff : 1;
52 unsigned int irq_per_ch : 1;
53 unsigned int needs_suspend_resume : 1;
55 unsigned int ctemp_bands;
58 static const struct rcar_thermal_chip rcar_thermal = {
62 .needs_suspend_resume = 0,
67 static const struct rcar_thermal_chip rcar_gen2_thermal = {
71 .needs_suspend_resume = 0,
76 static const struct rcar_thermal_chip rcar_gen3_thermal = {
80 .needs_suspend_resume = 1,
82 * The Gen3 chip has 3 interrupts, but this driver uses only 2
83 * interrupts to detect a temperature change, rise or fall.
89 struct rcar_thermal_priv {
91 struct rcar_thermal_common *common;
92 struct thermal_zone_device *zone;
93 const struct rcar_thermal_chip *chip;
94 struct delayed_work work;
96 struct list_head list;
100 #define rcar_thermal_for_each_priv(pos, common) \
101 list_for_each_entry(pos, &common->head, list)
103 #define MCELSIUS(temp) ((temp) * 1000)
104 #define rcar_zone_to_priv(zone) ((zone)->devdata)
105 #define rcar_priv_to_dev(priv) ((priv)->common->dev)
106 #define rcar_has_irq_support(priv) ((priv)->common->base)
107 #define rcar_id_to_shift(priv) ((priv)->id * 8)
109 static const struct of_device_id rcar_thermal_dt_ids[] = {
111 .compatible = "renesas,rcar-thermal",
112 .data = &rcar_thermal,
115 .compatible = "renesas,rcar-gen2-thermal",
116 .data = &rcar_gen2_thermal,
119 .compatible = "renesas,thermal-r8a774c0",
120 .data = &rcar_gen3_thermal,
123 .compatible = "renesas,thermal-r8a77970",
124 .data = &rcar_gen3_thermal,
127 .compatible = "renesas,thermal-r8a77990",
128 .data = &rcar_gen3_thermal,
131 .compatible = "renesas,thermal-r8a77995",
132 .data = &rcar_gen3_thermal,
136 MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);
141 #define rcar_thermal_common_read(c, r) \
142 _rcar_thermal_common_read(c, COMMON_ ##r)
143 static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
146 return ioread32(common->base + reg);
149 #define rcar_thermal_common_write(c, r, d) \
150 _rcar_thermal_common_write(c, COMMON_ ##r, d)
151 static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
154 iowrite32(data, common->base + reg);
157 #define rcar_thermal_common_bset(c, r, m, d) \
158 _rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
159 static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
160 u32 reg, u32 mask, u32 data)
164 val = ioread32(common->base + reg);
166 val |= (data & mask);
167 iowrite32(val, common->base + reg);
170 #define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
171 static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
173 return ioread32(priv->base + reg);
176 #define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
177 static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
180 iowrite32(data, priv->base + reg);
183 #define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
184 static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
189 val = ioread32(priv->base + reg);
191 val |= (data & mask);
192 iowrite32(val, priv->base + reg);
196 * zone device functions
198 static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
200 struct device *dev = rcar_priv_to_dev(priv);
204 mutex_lock(&priv->lock);
207 * TSC decides a value of CPTAP automatically,
208 * and this is the conditions which validate interrupt.
210 rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);
214 for (i = 0; i < 128; i++) {
216 * we need to wait 300us after changing comparator offset
217 * to get stable temperature.
218 * see "Usage Notes" on datasheet
220 usleep_range(300, 400);
222 new = rcar_thermal_read(priv, THSSR) & CTEMP;
231 dev_err(dev, "thermal sensor was broken\n");
238 if (rcar_has_irq_support(priv)) {
239 if (priv->chip->has_filonoff)
240 rcar_thermal_write(priv, FILONOFF, 0);
242 /* enable Rising/Falling edge interrupt */
243 rcar_thermal_write(priv, POSNEG, 0x1);
244 rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
245 ((ctemp - 1) << 0)));
249 mutex_unlock(&priv->lock);
251 return ctemp ? ctemp : -EINVAL;
254 static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
259 ctemp = rcar_thermal_update_temp(priv);
263 /* Guaranteed operating range is -45C to 125C. */
265 if (priv->chip->ctemp_bands == 1)
266 *temp = MCELSIUS((ctemp * 5) - 65);
268 *temp = MCELSIUS(((ctemp * 55) - 720) / 10);
270 *temp = MCELSIUS((ctemp * 5) - 60);
275 static int rcar_thermal_of_get_temp(void *data, int *temp)
277 struct rcar_thermal_priv *priv = data;
279 return rcar_thermal_get_current_temp(priv, temp);
282 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
284 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
286 return rcar_thermal_get_current_temp(priv, temp);
289 static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
290 int trip, enum thermal_trip_type *type)
292 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
293 struct device *dev = rcar_priv_to_dev(priv);
295 /* see rcar_thermal_get_temp() */
297 case 0: /* +90 <= temp */
298 *type = THERMAL_TRIP_CRITICAL;
301 dev_err(dev, "rcar driver trip error\n");
308 static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
311 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
312 struct device *dev = rcar_priv_to_dev(priv);
314 /* see rcar_thermal_get_temp() */
316 case 0: /* +90 <= temp */
317 *temp = MCELSIUS(90);
320 dev_err(dev, "rcar driver trip error\n");
327 static int rcar_thermal_notify(struct thermal_zone_device *zone,
328 int trip, enum thermal_trip_type type)
330 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
331 struct device *dev = rcar_priv_to_dev(priv);
334 case THERMAL_TRIP_CRITICAL:
336 dev_warn(dev, "Thermal reached to critical temperature\n");
345 static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
346 .get_temp = rcar_thermal_of_get_temp,
349 static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
350 .get_temp = rcar_thermal_get_temp,
351 .get_trip_type = rcar_thermal_get_trip_type,
352 .get_trip_temp = rcar_thermal_get_trip_temp,
353 .notify = rcar_thermal_notify,
359 #define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
360 #define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
361 static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
363 struct rcar_thermal_common *common = priv->common;
365 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
367 if (!rcar_has_irq_support(priv))
370 spin_lock_irqsave(&common->lock, flags);
372 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
374 spin_unlock_irqrestore(&common->lock, flags);
377 static void rcar_thermal_work(struct work_struct *work)
379 struct rcar_thermal_priv *priv;
382 priv = container_of(work, struct rcar_thermal_priv, work.work);
384 ret = rcar_thermal_update_temp(priv);
388 rcar_thermal_irq_enable(priv);
390 thermal_zone_device_update(priv->zone, THERMAL_EVENT_UNSPECIFIED);
393 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
395 struct device *dev = rcar_priv_to_dev(priv);
397 status = (status >> rcar_id_to_shift(priv)) & 0x3;
400 dev_dbg(dev, "thermal%d %s%s\n",
402 (status & 0x2) ? "Rising " : "",
403 (status & 0x1) ? "Falling" : "");
409 static irqreturn_t rcar_thermal_irq(int irq, void *data)
411 struct rcar_thermal_common *common = data;
412 struct rcar_thermal_priv *priv;
416 spin_lock_irqsave(&common->lock, flags);
418 mask = rcar_thermal_common_read(common, INTMSK);
419 status = rcar_thermal_common_read(common, STR);
420 rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
422 spin_unlock_irqrestore(&common->lock, flags);
424 status = status & ~mask;
429 rcar_thermal_for_each_priv(priv, common) {
430 if (rcar_thermal_had_changed(priv, status)) {
431 rcar_thermal_irq_disable(priv);
432 queue_delayed_work(system_freezable_wq, &priv->work,
433 msecs_to_jiffies(300));
443 static int rcar_thermal_remove(struct platform_device *pdev)
445 struct rcar_thermal_common *common = platform_get_drvdata(pdev);
446 struct device *dev = &pdev->dev;
447 struct rcar_thermal_priv *priv;
449 rcar_thermal_for_each_priv(priv, common) {
450 rcar_thermal_irq_disable(priv);
451 cancel_delayed_work_sync(&priv->work);
452 if (priv->chip->use_of_thermal)
453 thermal_remove_hwmon_sysfs(priv->zone);
455 thermal_zone_device_unregister(priv->zone);
459 pm_runtime_disable(dev);
464 static int rcar_thermal_probe(struct platform_device *pdev)
466 struct rcar_thermal_common *common;
467 struct rcar_thermal_priv *priv;
468 struct device *dev = &pdev->dev;
469 struct resource *res, *irq;
470 const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
474 int idle = IDLE_INTERVAL;
477 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
481 platform_set_drvdata(pdev, common);
483 INIT_LIST_HEAD(&common->head);
484 spin_lock_init(&common->lock);
487 pm_runtime_enable(dev);
488 pm_runtime_get_sync(dev);
490 for (i = 0; i < chip->nirqs; i++) {
491 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
496 * platform has IRQ support.
497 * Then, driver uses common registers
498 * rcar_has_irq_support() will be enabled
500 res = platform_get_resource(pdev, IORESOURCE_MEM,
502 common->base = devm_ioremap_resource(dev, res);
503 if (IS_ERR(common->base)) {
504 ret = PTR_ERR(common->base);
505 goto error_unregister;
508 idle = 0; /* polling delay is not needed */
511 ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
512 IRQF_SHARED, dev_name(dev), common);
514 dev_err(dev, "irq request failed\n ");
515 goto error_unregister;
518 /* update ENR bits */
519 if (chip->irq_per_ch)
524 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
528 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
531 goto error_unregister;
534 priv->base = devm_ioremap_resource(dev, res);
535 if (IS_ERR(priv->base)) {
536 ret = PTR_ERR(priv->base);
537 goto error_unregister;
540 priv->common = common;
543 mutex_init(&priv->lock);
544 INIT_LIST_HEAD(&priv->list);
545 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
546 ret = rcar_thermal_update_temp(priv);
548 goto error_unregister;
550 if (chip->use_of_thermal)
551 priv->zone = devm_thermal_zone_of_sensor_register(
553 &rcar_thermal_zone_of_ops);
555 priv->zone = thermal_zone_device_register(
558 &rcar_thermal_zone_ops, NULL, 0,
560 if (IS_ERR(priv->zone)) {
561 dev_err(dev, "can't register thermal zone\n");
562 ret = PTR_ERR(priv->zone);
564 goto error_unregister;
567 if (chip->use_of_thermal) {
569 * thermal_zone doesn't enable hwmon as default,
570 * but, enable it here to keep compatible
572 priv->zone->tzp->no_hwmon = false;
573 ret = thermal_add_hwmon_sysfs(priv->zone);
575 goto error_unregister;
578 rcar_thermal_irq_enable(priv);
580 list_move_tail(&priv->list, &common->head);
582 /* update ENR bits */
583 if (!chip->irq_per_ch)
584 enr_bits |= 3 << (i * 8);
587 if (common->base && enr_bits)
588 rcar_thermal_common_write(common, ENR, enr_bits);
590 dev_info(dev, "%d sensor probed\n", i);
595 rcar_thermal_remove(pdev);
600 #ifdef CONFIG_PM_SLEEP
601 static int rcar_thermal_suspend(struct device *dev)
603 struct rcar_thermal_common *common = dev_get_drvdata(dev);
604 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
605 typeof(*priv), list);
607 if (priv->chip->needs_suspend_resume) {
608 rcar_thermal_common_write(common, ENR, 0);
609 rcar_thermal_irq_disable(priv);
610 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
616 static int rcar_thermal_resume(struct device *dev)
618 struct rcar_thermal_common *common = dev_get_drvdata(dev);
619 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
620 typeof(*priv), list);
623 if (priv->chip->needs_suspend_resume) {
624 ret = rcar_thermal_update_temp(priv);
627 rcar_thermal_irq_enable(priv);
628 rcar_thermal_common_write(common, ENR, 0x03);
635 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
636 rcar_thermal_resume);
638 static struct platform_driver rcar_thermal_driver = {
640 .name = "rcar_thermal",
641 .pm = &rcar_thermal_pm_ops,
642 .of_match_table = rcar_thermal_dt_ids,
644 .probe = rcar_thermal_probe,
645 .remove = rcar_thermal_remove,
647 module_platform_driver(rcar_thermal_driver);
649 MODULE_LICENSE("GPL v2");
650 MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
651 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");