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;
101 #define rcar_thermal_for_each_priv(pos, common) \
102 list_for_each_entry(pos, &common->head, list)
104 #define MCELSIUS(temp) ((temp) * 1000)
105 #define rcar_zone_to_priv(zone) ((zone)->devdata)
106 #define rcar_priv_to_dev(priv) ((priv)->common->dev)
107 #define rcar_has_irq_support(priv) ((priv)->common->base)
108 #define rcar_id_to_shift(priv) ((priv)->id * 8)
110 static const struct of_device_id rcar_thermal_dt_ids[] = {
112 .compatible = "renesas,rcar-thermal",
113 .data = &rcar_thermal,
116 .compatible = "renesas,rcar-gen2-thermal",
117 .data = &rcar_gen2_thermal,
120 .compatible = "renesas,thermal-r8a774c0",
121 .data = &rcar_gen3_thermal,
124 .compatible = "renesas,thermal-r8a77970",
125 .data = &rcar_gen3_thermal,
128 .compatible = "renesas,thermal-r8a77990",
129 .data = &rcar_gen3_thermal,
132 .compatible = "renesas,thermal-r8a77995",
133 .data = &rcar_gen3_thermal,
137 MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);
142 #define rcar_thermal_common_read(c, r) \
143 _rcar_thermal_common_read(c, COMMON_ ##r)
144 static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
147 return ioread32(common->base + reg);
150 #define rcar_thermal_common_write(c, r, d) \
151 _rcar_thermal_common_write(c, COMMON_ ##r, d)
152 static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
155 iowrite32(data, common->base + reg);
158 #define rcar_thermal_common_bset(c, r, m, d) \
159 _rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
160 static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
161 u32 reg, u32 mask, u32 data)
165 val = ioread32(common->base + reg);
167 val |= (data & mask);
168 iowrite32(val, common->base + reg);
171 #define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
172 static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
174 return ioread32(priv->base + reg);
177 #define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
178 static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
181 iowrite32(data, priv->base + reg);
184 #define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
185 static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
190 val = ioread32(priv->base + reg);
192 val |= (data & mask);
193 iowrite32(val, priv->base + reg);
197 * zone device functions
199 static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
201 struct device *dev = rcar_priv_to_dev(priv);
206 mutex_lock(&priv->lock);
209 * TSC decides a value of CPTAP automatically,
210 * and this is the conditions which validate interrupt.
212 rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);
216 for (i = 0; i < 128; i++) {
218 * we need to wait 300us after changing comparator offset
219 * to get stable temperature.
220 * see "Usage Notes" on datasheet
222 usleep_range(300, 400);
224 new = rcar_thermal_read(priv, THSSR) & CTEMP;
233 dev_err(dev, "thermal sensor was broken\n");
240 if (rcar_has_irq_support(priv)) {
241 if (priv->chip->has_filonoff)
242 rcar_thermal_write(priv, FILONOFF, 0);
244 /* enable Rising/Falling edge interrupt */
245 rcar_thermal_write(priv, POSNEG, 0x1);
246 rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
247 ((ctemp - 1) << 0)));
250 dev_dbg(dev, "thermal%d %d -> %d\n", priv->id, priv->ctemp, ctemp);
255 mutex_unlock(&priv->lock);
259 static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
265 ret = rcar_thermal_update_temp(priv);
269 mutex_lock(&priv->lock);
270 if (priv->chip->ctemp_bands == 1)
271 tmp = MCELSIUS((priv->ctemp * 5) - 65);
272 else if (priv->ctemp < 24)
273 tmp = MCELSIUS(((priv->ctemp * 55) - 720) / 10);
275 tmp = MCELSIUS((priv->ctemp * 5) - 60);
276 mutex_unlock(&priv->lock);
278 /* Guaranteed operating range is -45C to 125C. */
285 static int rcar_thermal_of_get_temp(void *data, int *temp)
287 struct rcar_thermal_priv *priv = data;
289 return rcar_thermal_get_current_temp(priv, temp);
292 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
294 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
296 return rcar_thermal_get_current_temp(priv, temp);
299 static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
300 int trip, enum thermal_trip_type *type)
302 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
303 struct device *dev = rcar_priv_to_dev(priv);
305 /* see rcar_thermal_get_temp() */
307 case 0: /* +90 <= temp */
308 *type = THERMAL_TRIP_CRITICAL;
311 dev_err(dev, "rcar driver trip error\n");
318 static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
321 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
322 struct device *dev = rcar_priv_to_dev(priv);
324 /* see rcar_thermal_get_temp() */
326 case 0: /* +90 <= temp */
327 *temp = MCELSIUS(90);
330 dev_err(dev, "rcar driver trip error\n");
337 static int rcar_thermal_notify(struct thermal_zone_device *zone,
338 int trip, enum thermal_trip_type type)
340 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
341 struct device *dev = rcar_priv_to_dev(priv);
344 case THERMAL_TRIP_CRITICAL:
346 dev_warn(dev, "Thermal reached to critical temperature\n");
355 static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
356 .get_temp = rcar_thermal_of_get_temp,
359 static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
360 .get_temp = rcar_thermal_get_temp,
361 .get_trip_type = rcar_thermal_get_trip_type,
362 .get_trip_temp = rcar_thermal_get_trip_temp,
363 .notify = rcar_thermal_notify,
369 #define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
370 #define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
371 static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
373 struct rcar_thermal_common *common = priv->common;
375 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
377 if (!rcar_has_irq_support(priv))
380 spin_lock_irqsave(&common->lock, flags);
382 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
384 spin_unlock_irqrestore(&common->lock, flags);
387 static void rcar_thermal_work(struct work_struct *work)
389 struct rcar_thermal_priv *priv;
393 priv = container_of(work, struct rcar_thermal_priv, work.work);
395 ret = rcar_thermal_get_current_temp(priv, &cctemp);
399 ret = rcar_thermal_update_temp(priv);
403 rcar_thermal_irq_enable(priv);
405 ret = rcar_thermal_get_current_temp(priv, &nctemp);
409 if (nctemp != cctemp)
410 thermal_zone_device_update(priv->zone,
411 THERMAL_EVENT_UNSPECIFIED);
414 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
416 struct device *dev = rcar_priv_to_dev(priv);
418 status = (status >> rcar_id_to_shift(priv)) & 0x3;
421 dev_dbg(dev, "thermal%d %s%s\n",
423 (status & 0x2) ? "Rising " : "",
424 (status & 0x1) ? "Falling" : "");
430 static irqreturn_t rcar_thermal_irq(int irq, void *data)
432 struct rcar_thermal_common *common = data;
433 struct rcar_thermal_priv *priv;
437 spin_lock_irqsave(&common->lock, flags);
439 mask = rcar_thermal_common_read(common, INTMSK);
440 status = rcar_thermal_common_read(common, STR);
441 rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
443 spin_unlock_irqrestore(&common->lock, flags);
445 status = status & ~mask;
450 rcar_thermal_for_each_priv(priv, common) {
451 if (rcar_thermal_had_changed(priv, status)) {
452 rcar_thermal_irq_disable(priv);
453 queue_delayed_work(system_freezable_wq, &priv->work,
454 msecs_to_jiffies(300));
464 static int rcar_thermal_remove(struct platform_device *pdev)
466 struct rcar_thermal_common *common = platform_get_drvdata(pdev);
467 struct device *dev = &pdev->dev;
468 struct rcar_thermal_priv *priv;
470 rcar_thermal_for_each_priv(priv, common) {
471 rcar_thermal_irq_disable(priv);
472 cancel_delayed_work_sync(&priv->work);
473 if (priv->chip->use_of_thermal)
474 thermal_remove_hwmon_sysfs(priv->zone);
476 thermal_zone_device_unregister(priv->zone);
480 pm_runtime_disable(dev);
485 static int rcar_thermal_probe(struct platform_device *pdev)
487 struct rcar_thermal_common *common;
488 struct rcar_thermal_priv *priv;
489 struct device *dev = &pdev->dev;
490 struct resource *res, *irq;
491 const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
495 int idle = IDLE_INTERVAL;
498 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
502 platform_set_drvdata(pdev, common);
504 INIT_LIST_HEAD(&common->head);
505 spin_lock_init(&common->lock);
508 pm_runtime_enable(dev);
509 pm_runtime_get_sync(dev);
511 for (i = 0; i < chip->nirqs; i++) {
512 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
517 * platform has IRQ support.
518 * Then, driver uses common registers
519 * rcar_has_irq_support() will be enabled
521 res = platform_get_resource(pdev, IORESOURCE_MEM,
523 common->base = devm_ioremap_resource(dev, res);
524 if (IS_ERR(common->base))
525 return PTR_ERR(common->base);
527 idle = 0; /* polling delay is not needed */
530 ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
531 IRQF_SHARED, dev_name(dev), common);
533 dev_err(dev, "irq request failed\n ");
534 goto error_unregister;
537 /* update ENR bits */
538 if (chip->irq_per_ch)
543 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
547 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
550 goto error_unregister;
553 priv->base = devm_ioremap_resource(dev, res);
554 if (IS_ERR(priv->base)) {
555 ret = PTR_ERR(priv->base);
556 goto error_unregister;
559 priv->common = common;
562 mutex_init(&priv->lock);
563 INIT_LIST_HEAD(&priv->list);
564 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
565 ret = rcar_thermal_update_temp(priv);
567 goto error_unregister;
569 if (chip->use_of_thermal)
570 priv->zone = devm_thermal_zone_of_sensor_register(
572 &rcar_thermal_zone_of_ops);
574 priv->zone = thermal_zone_device_register(
577 &rcar_thermal_zone_ops, NULL, 0,
579 if (IS_ERR(priv->zone)) {
580 dev_err(dev, "can't register thermal zone\n");
581 ret = PTR_ERR(priv->zone);
583 goto error_unregister;
586 if (chip->use_of_thermal) {
588 * thermal_zone doesn't enable hwmon as default,
589 * but, enable it here to keep compatible
591 priv->zone->tzp->no_hwmon = false;
592 ret = thermal_add_hwmon_sysfs(priv->zone);
594 goto error_unregister;
597 rcar_thermal_irq_enable(priv);
599 list_move_tail(&priv->list, &common->head);
601 /* update ENR bits */
602 if (!chip->irq_per_ch)
603 enr_bits |= 3 << (i * 8);
606 if (common->base && enr_bits)
607 rcar_thermal_common_write(common, ENR, enr_bits);
609 dev_info(dev, "%d sensor probed\n", i);
614 rcar_thermal_remove(pdev);
619 #ifdef CONFIG_PM_SLEEP
620 static int rcar_thermal_suspend(struct device *dev)
622 struct rcar_thermal_common *common = dev_get_drvdata(dev);
623 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
624 typeof(*priv), list);
626 if (priv->chip->needs_suspend_resume) {
627 rcar_thermal_common_write(common, ENR, 0);
628 rcar_thermal_irq_disable(priv);
629 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
635 static int rcar_thermal_resume(struct device *dev)
637 struct rcar_thermal_common *common = dev_get_drvdata(dev);
638 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
639 typeof(*priv), list);
642 if (priv->chip->needs_suspend_resume) {
643 ret = rcar_thermal_update_temp(priv);
646 rcar_thermal_irq_enable(priv);
647 rcar_thermal_common_write(common, ENR, 0x03);
654 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
655 rcar_thermal_resume);
657 static struct platform_driver rcar_thermal_driver = {
659 .name = "rcar_thermal",
660 .pm = &rcar_thermal_pm_ops,
661 .of_match_table = rcar_thermal_dt_ids,
663 .probe = rcar_thermal_probe,
664 .remove = rcar_thermal_remove,
666 module_platform_driver(rcar_thermal_driver);
668 MODULE_LICENSE("GPL v2");
669 MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
670 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");