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_priv_to_dev(priv) ((priv)->common->dev)
105 #define rcar_has_irq_support(priv) ((priv)->common->base)
106 #define rcar_id_to_shift(priv) ((priv)->id * 8)
108 static const struct of_device_id rcar_thermal_dt_ids[] = {
110 .compatible = "renesas,rcar-thermal",
111 .data = &rcar_thermal,
114 .compatible = "renesas,rcar-gen2-thermal",
115 .data = &rcar_gen2_thermal,
118 .compatible = "renesas,thermal-r8a774c0",
119 .data = &rcar_gen3_thermal,
122 .compatible = "renesas,thermal-r8a77970",
123 .data = &rcar_gen3_thermal,
126 .compatible = "renesas,thermal-r8a77990",
127 .data = &rcar_gen3_thermal,
130 .compatible = "renesas,thermal-r8a77995",
131 .data = &rcar_gen3_thermal,
135 MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);
140 #define rcar_thermal_common_read(c, r) \
141 _rcar_thermal_common_read(c, COMMON_ ##r)
142 static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
145 return ioread32(common->base + reg);
148 #define rcar_thermal_common_write(c, r, d) \
149 _rcar_thermal_common_write(c, COMMON_ ##r, d)
150 static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
153 iowrite32(data, common->base + reg);
156 #define rcar_thermal_common_bset(c, r, m, d) \
157 _rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
158 static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
159 u32 reg, u32 mask, u32 data)
163 val = ioread32(common->base + reg);
165 val |= (data & mask);
166 iowrite32(val, common->base + reg);
169 #define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
170 static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
172 return ioread32(priv->base + reg);
175 #define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
176 static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
179 iowrite32(data, priv->base + reg);
182 #define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
183 static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
188 val = ioread32(priv->base + reg);
190 val |= (data & mask);
191 iowrite32(val, priv->base + reg);
195 * zone device functions
197 static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
199 struct device *dev = rcar_priv_to_dev(priv);
200 int old, new, ctemp = -EINVAL;
203 mutex_lock(&priv->lock);
206 * TSC decides a value of CPTAP automatically,
207 * and this is the conditions which validate interrupt.
209 rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);
212 for (i = 0; i < 128; i++) {
214 * we need to wait 300us after changing comparator offset
215 * to get stable temperature.
216 * see "Usage Notes" on datasheet
218 usleep_range(300, 400);
220 new = rcar_thermal_read(priv, THSSR) & CTEMP;
229 dev_err(dev, "thermal sensor was broken\n");
236 if (rcar_has_irq_support(priv)) {
237 if (priv->chip->has_filonoff)
238 rcar_thermal_write(priv, FILONOFF, 0);
240 /* enable Rising/Falling edge interrupt */
241 rcar_thermal_write(priv, POSNEG, 0x1);
242 rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
243 ((ctemp - 1) << 0)));
247 mutex_unlock(&priv->lock);
252 static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
257 ctemp = rcar_thermal_update_temp(priv);
261 /* Guaranteed operating range is -45C to 125C. */
263 if (priv->chip->ctemp_bands == 1)
264 *temp = MCELSIUS((ctemp * 5) - 65);
266 *temp = MCELSIUS(((ctemp * 55) - 720) / 10);
268 *temp = MCELSIUS((ctemp * 5) - 60);
273 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
275 struct rcar_thermal_priv *priv = thermal_zone_device_priv(zone);
277 return rcar_thermal_get_current_temp(priv, temp);
280 static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
281 .get_temp = rcar_thermal_get_temp,
284 static struct thermal_trip trips[] = {
285 { .type = THERMAL_TRIP_CRITICAL, .temperature = 90000 }
291 #define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
292 #define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
293 static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
295 struct rcar_thermal_common *common = priv->common;
297 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
299 if (!rcar_has_irq_support(priv))
302 spin_lock_irqsave(&common->lock, flags);
304 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
306 spin_unlock_irqrestore(&common->lock, flags);
309 static void rcar_thermal_work(struct work_struct *work)
311 struct rcar_thermal_priv *priv;
314 priv = container_of(work, struct rcar_thermal_priv, work.work);
316 ret = rcar_thermal_update_temp(priv);
320 rcar_thermal_irq_enable(priv);
322 thermal_zone_device_update(priv->zone, THERMAL_EVENT_UNSPECIFIED);
325 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
327 struct device *dev = rcar_priv_to_dev(priv);
329 status = (status >> rcar_id_to_shift(priv)) & 0x3;
332 dev_dbg(dev, "thermal%d %s%s\n",
334 (status & 0x2) ? "Rising " : "",
335 (status & 0x1) ? "Falling" : "");
341 static irqreturn_t rcar_thermal_irq(int irq, void *data)
343 struct rcar_thermal_common *common = data;
344 struct rcar_thermal_priv *priv;
347 spin_lock(&common->lock);
349 mask = rcar_thermal_common_read(common, INTMSK);
350 status = rcar_thermal_common_read(common, STR);
351 rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
353 spin_unlock(&common->lock);
355 status = status & ~mask;
360 rcar_thermal_for_each_priv(priv, common) {
361 if (rcar_thermal_had_changed(priv, status)) {
362 rcar_thermal_irq_disable(priv);
363 queue_delayed_work(system_freezable_wq, &priv->work,
364 msecs_to_jiffies(300));
374 static int rcar_thermal_remove(struct platform_device *pdev)
376 struct rcar_thermal_common *common = platform_get_drvdata(pdev);
377 struct device *dev = &pdev->dev;
378 struct rcar_thermal_priv *priv;
380 rcar_thermal_for_each_priv(priv, common) {
381 rcar_thermal_irq_disable(priv);
382 cancel_delayed_work_sync(&priv->work);
383 if (priv->chip->use_of_thermal)
384 thermal_remove_hwmon_sysfs(priv->zone);
386 thermal_zone_device_unregister(priv->zone);
390 pm_runtime_disable(dev);
395 static int rcar_thermal_probe(struct platform_device *pdev)
397 struct rcar_thermal_common *common;
398 struct rcar_thermal_priv *priv;
399 struct device *dev = &pdev->dev;
400 struct resource *res;
401 const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
405 int idle = IDLE_INTERVAL;
408 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
412 platform_set_drvdata(pdev, common);
414 INIT_LIST_HEAD(&common->head);
415 spin_lock_init(&common->lock);
418 pm_runtime_enable(dev);
419 pm_runtime_get_sync(dev);
421 for (i = 0; i < chip->nirqs; i++) {
424 ret = platform_get_irq_optional(pdev, i);
425 if (ret < 0 && ret != -ENXIO)
426 goto error_unregister;
434 * platform has IRQ support.
435 * Then, driver uses common registers
436 * rcar_has_irq_support() will be enabled
438 res = platform_get_resource(pdev, IORESOURCE_MEM,
440 common->base = devm_ioremap_resource(dev, res);
441 if (IS_ERR(common->base)) {
442 ret = PTR_ERR(common->base);
443 goto error_unregister;
446 idle = 0; /* polling delay is not needed */
449 ret = devm_request_irq(dev, irq, rcar_thermal_irq,
450 IRQF_SHARED, dev_name(dev), common);
452 dev_err(dev, "irq request failed\n ");
453 goto error_unregister;
456 /* update ENR bits */
457 if (chip->irq_per_ch)
462 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
466 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
469 goto error_unregister;
472 priv->base = devm_ioremap_resource(dev, res);
473 if (IS_ERR(priv->base)) {
474 ret = PTR_ERR(priv->base);
475 goto error_unregister;
478 priv->common = common;
481 mutex_init(&priv->lock);
482 INIT_LIST_HEAD(&priv->list);
483 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
484 ret = rcar_thermal_update_temp(priv);
486 goto error_unregister;
488 if (chip->use_of_thermal) {
489 priv->zone = devm_thermal_of_zone_register(
491 &rcar_thermal_zone_ops);
493 priv->zone = thermal_zone_device_register_with_trips(
494 "rcar_thermal", trips, ARRAY_SIZE(trips), 0, priv,
495 &rcar_thermal_zone_ops, NULL, 0,
498 ret = thermal_zone_device_enable(priv->zone);
500 thermal_zone_device_unregister(priv->zone);
501 priv->zone = ERR_PTR(ret);
504 if (IS_ERR(priv->zone)) {
505 dev_err(dev, "can't register thermal zone\n");
506 ret = PTR_ERR(priv->zone);
508 goto error_unregister;
511 if (chip->use_of_thermal) {
513 * thermal_zone doesn't enable hwmon as default,
514 * but, enable it here to keep compatible
516 priv->zone->tzp->no_hwmon = false;
517 ret = thermal_add_hwmon_sysfs(priv->zone);
519 goto error_unregister;
522 rcar_thermal_irq_enable(priv);
524 list_move_tail(&priv->list, &common->head);
526 /* update ENR bits */
527 if (!chip->irq_per_ch)
528 enr_bits |= 3 << (i * 8);
531 if (common->base && enr_bits)
532 rcar_thermal_common_write(common, ENR, enr_bits);
534 dev_info(dev, "%d sensor probed\n", i);
539 rcar_thermal_remove(pdev);
544 #ifdef CONFIG_PM_SLEEP
545 static int rcar_thermal_suspend(struct device *dev)
547 struct rcar_thermal_common *common = dev_get_drvdata(dev);
548 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
549 typeof(*priv), list);
551 if (priv->chip->needs_suspend_resume) {
552 rcar_thermal_common_write(common, ENR, 0);
553 rcar_thermal_irq_disable(priv);
554 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
560 static int rcar_thermal_resume(struct device *dev)
562 struct rcar_thermal_common *common = dev_get_drvdata(dev);
563 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
564 typeof(*priv), list);
567 if (priv->chip->needs_suspend_resume) {
568 ret = rcar_thermal_update_temp(priv);
571 rcar_thermal_irq_enable(priv);
572 rcar_thermal_common_write(common, ENR, 0x03);
579 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
580 rcar_thermal_resume);
582 static struct platform_driver rcar_thermal_driver = {
584 .name = "rcar_thermal",
585 .pm = &rcar_thermal_pm_ops,
586 .of_match_table = rcar_thermal_dt_ids,
588 .probe = rcar_thermal_probe,
589 .remove = rcar_thermal_remove,
591 module_platform_driver(rcar_thermal_driver);
593 MODULE_LICENSE("GPL v2");
594 MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
595 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");