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;
57 static const struct rcar_thermal_chip rcar_thermal = {
61 .needs_suspend_resume = 0,
65 static const struct rcar_thermal_chip rcar_gen2_thermal = {
69 .needs_suspend_resume = 0,
73 static const struct rcar_thermal_chip rcar_gen3_thermal = {
77 .needs_suspend_resume = 1,
79 * The Gen3 chip has 3 interrupts, but this driver uses only 2
80 * interrupts to detect a temperature change, rise or fall.
85 struct rcar_thermal_priv {
87 struct rcar_thermal_common *common;
88 struct thermal_zone_device *zone;
89 const struct rcar_thermal_chip *chip;
90 struct delayed_work work;
92 struct list_head list;
97 #define rcar_thermal_for_each_priv(pos, common) \
98 list_for_each_entry(pos, &common->head, list)
100 #define MCELSIUS(temp) ((temp) * 1000)
101 #define rcar_zone_to_priv(zone) ((zone)->devdata)
102 #define rcar_priv_to_dev(priv) ((priv)->common->dev)
103 #define rcar_has_irq_support(priv) ((priv)->common->base)
104 #define rcar_id_to_shift(priv) ((priv)->id * 8)
106 static const struct of_device_id rcar_thermal_dt_ids[] = {
108 .compatible = "renesas,rcar-thermal",
109 .data = &rcar_thermal,
112 .compatible = "renesas,rcar-gen2-thermal",
113 .data = &rcar_gen2_thermal,
116 .compatible = "renesas,thermal-r8a77995",
117 .data = &rcar_gen3_thermal,
121 MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);
126 #define rcar_thermal_common_read(c, r) \
127 _rcar_thermal_common_read(c, COMMON_ ##r)
128 static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
131 return ioread32(common->base + reg);
134 #define rcar_thermal_common_write(c, r, d) \
135 _rcar_thermal_common_write(c, COMMON_ ##r, d)
136 static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
139 iowrite32(data, common->base + reg);
142 #define rcar_thermal_common_bset(c, r, m, d) \
143 _rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
144 static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
145 u32 reg, u32 mask, u32 data)
149 val = ioread32(common->base + reg);
151 val |= (data & mask);
152 iowrite32(val, common->base + reg);
155 #define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
156 static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
158 return ioread32(priv->base + reg);
161 #define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
162 static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
165 iowrite32(data, priv->base + reg);
168 #define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
169 static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
174 val = ioread32(priv->base + reg);
176 val |= (data & mask);
177 iowrite32(val, priv->base + reg);
181 * zone device functions
183 static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
185 struct device *dev = rcar_priv_to_dev(priv);
190 mutex_lock(&priv->lock);
193 * TSC decides a value of CPTAP automatically,
194 * and this is the conditions which validate interrupt.
196 rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);
200 for (i = 0; i < 128; i++) {
202 * we need to wait 300us after changing comparator offset
203 * to get stable temperature.
204 * see "Usage Notes" on datasheet
208 new = rcar_thermal_read(priv, THSSR) & CTEMP;
217 dev_err(dev, "thermal sensor was broken\n");
224 if (rcar_has_irq_support(priv)) {
225 if (priv->chip->has_filonoff)
226 rcar_thermal_write(priv, FILONOFF, 0);
228 /* enable Rising/Falling edge interrupt */
229 rcar_thermal_write(priv, POSNEG, 0x1);
230 rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
231 ((ctemp - 1) << 0)));
234 dev_dbg(dev, "thermal%d %d -> %d\n", priv->id, priv->ctemp, ctemp);
239 mutex_unlock(&priv->lock);
243 static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
249 ret = rcar_thermal_update_temp(priv);
253 mutex_lock(&priv->lock);
254 tmp = MCELSIUS((priv->ctemp * 5) - 65);
255 mutex_unlock(&priv->lock);
257 if ((tmp < MCELSIUS(-45)) || (tmp > MCELSIUS(125))) {
258 struct device *dev = rcar_priv_to_dev(priv);
260 dev_err(dev, "it couldn't measure temperature correctly\n");
269 static int rcar_thermal_of_get_temp(void *data, int *temp)
271 struct rcar_thermal_priv *priv = data;
273 return rcar_thermal_get_current_temp(priv, temp);
276 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
278 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
280 return rcar_thermal_get_current_temp(priv, temp);
283 static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
284 int trip, enum thermal_trip_type *type)
286 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
287 struct device *dev = rcar_priv_to_dev(priv);
289 /* see rcar_thermal_get_temp() */
291 case 0: /* +90 <= temp */
292 *type = THERMAL_TRIP_CRITICAL;
295 dev_err(dev, "rcar driver trip error\n");
302 static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
305 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
306 struct device *dev = rcar_priv_to_dev(priv);
308 /* see rcar_thermal_get_temp() */
310 case 0: /* +90 <= temp */
311 *temp = MCELSIUS(90);
314 dev_err(dev, "rcar driver trip error\n");
321 static int rcar_thermal_notify(struct thermal_zone_device *zone,
322 int trip, enum thermal_trip_type type)
324 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
325 struct device *dev = rcar_priv_to_dev(priv);
328 case THERMAL_TRIP_CRITICAL:
330 dev_warn(dev, "Thermal reached to critical temperature\n");
339 static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
340 .get_temp = rcar_thermal_of_get_temp,
343 static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
344 .get_temp = rcar_thermal_get_temp,
345 .get_trip_type = rcar_thermal_get_trip_type,
346 .get_trip_temp = rcar_thermal_get_trip_temp,
347 .notify = rcar_thermal_notify,
353 #define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
354 #define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
355 static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
357 struct rcar_thermal_common *common = priv->common;
359 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
361 if (!rcar_has_irq_support(priv))
364 spin_lock_irqsave(&common->lock, flags);
366 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
368 spin_unlock_irqrestore(&common->lock, flags);
371 static void rcar_thermal_work(struct work_struct *work)
373 struct rcar_thermal_priv *priv;
377 priv = container_of(work, struct rcar_thermal_priv, work.work);
379 ret = rcar_thermal_get_current_temp(priv, &cctemp);
383 ret = rcar_thermal_update_temp(priv);
387 rcar_thermal_irq_enable(priv);
389 ret = rcar_thermal_get_current_temp(priv, &nctemp);
393 if (nctemp != cctemp)
394 thermal_zone_device_update(priv->zone,
395 THERMAL_EVENT_UNSPECIFIED);
398 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
400 struct device *dev = rcar_priv_to_dev(priv);
402 status = (status >> rcar_id_to_shift(priv)) & 0x3;
405 dev_dbg(dev, "thermal%d %s%s\n",
407 (status & 0x2) ? "Rising " : "",
408 (status & 0x1) ? "Falling" : "");
414 static irqreturn_t rcar_thermal_irq(int irq, void *data)
416 struct rcar_thermal_common *common = data;
417 struct rcar_thermal_priv *priv;
421 spin_lock_irqsave(&common->lock, flags);
423 mask = rcar_thermal_common_read(common, INTMSK);
424 status = rcar_thermal_common_read(common, STR);
425 rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
427 spin_unlock_irqrestore(&common->lock, flags);
429 status = status & ~mask;
434 rcar_thermal_for_each_priv(priv, common) {
435 if (rcar_thermal_had_changed(priv, status)) {
436 rcar_thermal_irq_disable(priv);
437 queue_delayed_work(system_freezable_wq, &priv->work,
438 msecs_to_jiffies(300));
448 static int rcar_thermal_remove(struct platform_device *pdev)
450 struct rcar_thermal_common *common = platform_get_drvdata(pdev);
451 struct device *dev = &pdev->dev;
452 struct rcar_thermal_priv *priv;
454 rcar_thermal_for_each_priv(priv, common) {
455 rcar_thermal_irq_disable(priv);
456 cancel_delayed_work_sync(&priv->work);
457 if (priv->chip->use_of_thermal)
458 thermal_remove_hwmon_sysfs(priv->zone);
460 thermal_zone_device_unregister(priv->zone);
464 pm_runtime_disable(dev);
469 static int rcar_thermal_probe(struct platform_device *pdev)
471 struct rcar_thermal_common *common;
472 struct rcar_thermal_priv *priv;
473 struct device *dev = &pdev->dev;
474 struct resource *res, *irq;
475 const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
479 int idle = IDLE_INTERVAL;
482 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
486 platform_set_drvdata(pdev, common);
488 INIT_LIST_HEAD(&common->head);
489 spin_lock_init(&common->lock);
492 pm_runtime_enable(dev);
493 pm_runtime_get_sync(dev);
495 for (i = 0; i < chip->nirqs; i++) {
496 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
501 * platform has IRQ support.
502 * Then, driver uses common registers
503 * rcar_has_irq_support() will be enabled
505 res = platform_get_resource(pdev, IORESOURCE_MEM,
507 common->base = devm_ioremap_resource(dev, res);
508 if (IS_ERR(common->base)) {
509 ret = PTR_ERR(common->base);
510 goto error_unregister;
513 idle = 0; /* polling delay is not needed */
516 ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
517 IRQF_SHARED, dev_name(dev), common);
519 dev_err(dev, "irq request failed\n ");
520 goto error_unregister;
523 /* update ENR bits */
524 if (chip->irq_per_ch)
529 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
533 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
536 goto error_unregister;
539 priv->base = devm_ioremap_resource(dev, res);
540 if (IS_ERR(priv->base)) {
541 ret = PTR_ERR(priv->base);
542 goto error_unregister;
545 priv->common = common;
548 mutex_init(&priv->lock);
549 INIT_LIST_HEAD(&priv->list);
550 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
551 ret = rcar_thermal_update_temp(priv);
553 goto error_unregister;
555 if (chip->use_of_thermal)
556 priv->zone = devm_thermal_zone_of_sensor_register(
558 &rcar_thermal_zone_of_ops);
560 priv->zone = thermal_zone_device_register(
563 &rcar_thermal_zone_ops, NULL, 0,
565 if (IS_ERR(priv->zone)) {
566 dev_err(dev, "can't register thermal zone\n");
567 ret = PTR_ERR(priv->zone);
569 goto error_unregister;
572 if (chip->use_of_thermal) {
574 * thermal_zone doesn't enable hwmon as default,
575 * but, enable it here to keep compatible
577 priv->zone->tzp->no_hwmon = false;
578 ret = thermal_add_hwmon_sysfs(priv->zone);
580 goto error_unregister;
583 rcar_thermal_irq_enable(priv);
585 list_move_tail(&priv->list, &common->head);
587 /* update ENR bits */
588 if (!chip->irq_per_ch)
589 enr_bits |= 3 << (i * 8);
592 if (common->base && enr_bits)
593 rcar_thermal_common_write(common, ENR, enr_bits);
595 dev_info(dev, "%d sensor probed\n", i);
600 rcar_thermal_remove(pdev);
605 #ifdef CONFIG_PM_SLEEP
606 static int rcar_thermal_suspend(struct device *dev)
608 struct rcar_thermal_common *common = dev_get_drvdata(dev);
609 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
610 typeof(*priv), list);
612 if (priv->chip->needs_suspend_resume) {
613 rcar_thermal_common_write(common, ENR, 0);
614 rcar_thermal_irq_disable(priv);
615 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
621 static int rcar_thermal_resume(struct device *dev)
623 struct rcar_thermal_common *common = dev_get_drvdata(dev);
624 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
625 typeof(*priv), list);
628 if (priv->chip->needs_suspend_resume) {
629 ret = rcar_thermal_update_temp(priv);
632 rcar_thermal_irq_enable(priv);
633 rcar_thermal_common_write(common, ENR, 0x03);
640 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
641 rcar_thermal_resume);
643 static struct platform_driver rcar_thermal_driver = {
645 .name = "rcar_thermal",
646 .pm = &rcar_thermal_pm_ops,
647 .of_match_table = rcar_thermal_dt_ids,
649 .probe = rcar_thermal_probe,
650 .remove = rcar_thermal_remove,
652 module_platform_driver(rcar_thermal_driver);
654 MODULE_LICENSE("GPL v2");
655 MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
656 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");