Loading...
Note: File does not exist in v6.13.7.
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * R-Car THS/TSC thermal sensor driver
4 *
5 * Copyright (C) 2012 Renesas Solutions Corp.
6 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 */
8#include <linux/delay.h>
9#include <linux/err.h>
10#include <linux/irq.h>
11#include <linux/interrupt.h>
12#include <linux/io.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>
21
22#include "thermal_hwmon.h"
23
24#define IDLE_INTERVAL 5000
25
26#define COMMON_STR 0x00
27#define COMMON_ENR 0x04
28#define COMMON_INTMSK 0x0c
29
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
35
36/* THSCR */
37#define CPCTL (1 << 12)
38
39/* THSSR */
40#define CTEMP 0x3f
41
42struct rcar_thermal_common {
43 void __iomem *base;
44 struct device *dev;
45 struct list_head head;
46 spinlock_t lock;
47};
48
49struct 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;
54 unsigned int nirqs;
55 unsigned int ctemp_bands;
56};
57
58static const struct rcar_thermal_chip rcar_thermal = {
59 .use_of_thermal = 0,
60 .has_filonoff = 1,
61 .irq_per_ch = 0,
62 .needs_suspend_resume = 0,
63 .nirqs = 1,
64 .ctemp_bands = 1,
65};
66
67static const struct rcar_thermal_chip rcar_gen2_thermal = {
68 .use_of_thermal = 1,
69 .has_filonoff = 1,
70 .irq_per_ch = 0,
71 .needs_suspend_resume = 0,
72 .nirqs = 1,
73 .ctemp_bands = 1,
74};
75
76static const struct rcar_thermal_chip rcar_gen3_thermal = {
77 .use_of_thermal = 1,
78 .has_filonoff = 0,
79 .irq_per_ch = 1,
80 .needs_suspend_resume = 1,
81 /*
82 * The Gen3 chip has 3 interrupts, but this driver uses only 2
83 * interrupts to detect a temperature change, rise or fall.
84 */
85 .nirqs = 2,
86 .ctemp_bands = 2,
87};
88
89struct rcar_thermal_priv {
90 void __iomem *base;
91 struct rcar_thermal_common *common;
92 struct thermal_zone_device *zone;
93 const struct rcar_thermal_chip *chip;
94 struct delayed_work work;
95 struct mutex lock;
96 struct list_head list;
97 int id;
98};
99
100#define rcar_thermal_for_each_priv(pos, common) \
101 list_for_each_entry(pos, &common->head, list)
102
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)
108
109static const struct of_device_id rcar_thermal_dt_ids[] = {
110 {
111 .compatible = "renesas,rcar-thermal",
112 .data = &rcar_thermal,
113 },
114 {
115 .compatible = "renesas,rcar-gen2-thermal",
116 .data = &rcar_gen2_thermal,
117 },
118 {
119 .compatible = "renesas,thermal-r8a774c0",
120 .data = &rcar_gen3_thermal,
121 },
122 {
123 .compatible = "renesas,thermal-r8a77970",
124 .data = &rcar_gen3_thermal,
125 },
126 {
127 .compatible = "renesas,thermal-r8a77990",
128 .data = &rcar_gen3_thermal,
129 },
130 {
131 .compatible = "renesas,thermal-r8a77995",
132 .data = &rcar_gen3_thermal,
133 },
134 {},
135};
136MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);
137
138/*
139 * basic functions
140 */
141#define rcar_thermal_common_read(c, r) \
142 _rcar_thermal_common_read(c, COMMON_ ##r)
143static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
144 u32 reg)
145{
146 return ioread32(common->base + reg);
147}
148
149#define rcar_thermal_common_write(c, r, d) \
150 _rcar_thermal_common_write(c, COMMON_ ##r, d)
151static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
152 u32 reg, u32 data)
153{
154 iowrite32(data, common->base + reg);
155}
156
157#define rcar_thermal_common_bset(c, r, m, d) \
158 _rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
159static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
160 u32 reg, u32 mask, u32 data)
161{
162 u32 val;
163
164 val = ioread32(common->base + reg);
165 val &= ~mask;
166 val |= (data & mask);
167 iowrite32(val, common->base + reg);
168}
169
170#define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
171static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
172{
173 return ioread32(priv->base + reg);
174}
175
176#define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
177static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
178 u32 reg, u32 data)
179{
180 iowrite32(data, priv->base + reg);
181}
182
183#define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
184static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
185 u32 mask, u32 data)
186{
187 u32 val;
188
189 val = ioread32(priv->base + reg);
190 val &= ~mask;
191 val |= (data & mask);
192 iowrite32(val, priv->base + reg);
193}
194
195/*
196 * zone device functions
197 */
198static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
199{
200 struct device *dev = rcar_priv_to_dev(priv);
201 int old, new, ctemp = -EINVAL;
202 unsigned int i;
203
204 mutex_lock(&priv->lock);
205
206 /*
207 * TSC decides a value of CPTAP automatically,
208 * and this is the conditions which validate interrupt.
209 */
210 rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);
211
212 old = ~0;
213 for (i = 0; i < 128; i++) {
214 /*
215 * we need to wait 300us after changing comparator offset
216 * to get stable temperature.
217 * see "Usage Notes" on datasheet
218 */
219 usleep_range(300, 400);
220
221 new = rcar_thermal_read(priv, THSSR) & CTEMP;
222 if (new == old) {
223 ctemp = new;
224 break;
225 }
226 old = new;
227 }
228
229 if (ctemp < 0) {
230 dev_err(dev, "thermal sensor was broken\n");
231 goto err_out_unlock;
232 }
233
234 /*
235 * enable IRQ
236 */
237 if (rcar_has_irq_support(priv)) {
238 if (priv->chip->has_filonoff)
239 rcar_thermal_write(priv, FILONOFF, 0);
240
241 /* enable Rising/Falling edge interrupt */
242 rcar_thermal_write(priv, POSNEG, 0x1);
243 rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
244 ((ctemp - 1) << 0)));
245 }
246
247err_out_unlock:
248 mutex_unlock(&priv->lock);
249
250 return ctemp;
251}
252
253static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
254 int *temp)
255{
256 int ctemp;
257
258 ctemp = rcar_thermal_update_temp(priv);
259 if (ctemp < 0)
260 return ctemp;
261
262 /* Guaranteed operating range is -45C to 125C. */
263
264 if (priv->chip->ctemp_bands == 1)
265 *temp = MCELSIUS((ctemp * 5) - 65);
266 else if (ctemp < 24)
267 *temp = MCELSIUS(((ctemp * 55) - 720) / 10);
268 else
269 *temp = MCELSIUS((ctemp * 5) - 60);
270
271 return 0;
272}
273
274static int rcar_thermal_of_get_temp(void *data, int *temp)
275{
276 struct rcar_thermal_priv *priv = data;
277
278 return rcar_thermal_get_current_temp(priv, temp);
279}
280
281static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
282{
283 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
284
285 return rcar_thermal_get_current_temp(priv, temp);
286}
287
288static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
289 int trip, enum thermal_trip_type *type)
290{
291 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
292 struct device *dev = rcar_priv_to_dev(priv);
293
294 /* see rcar_thermal_get_temp() */
295 switch (trip) {
296 case 0: /* +90 <= temp */
297 *type = THERMAL_TRIP_CRITICAL;
298 break;
299 default:
300 dev_err(dev, "rcar driver trip error\n");
301 return -EINVAL;
302 }
303
304 return 0;
305}
306
307static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
308 int trip, int *temp)
309{
310 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
311 struct device *dev = rcar_priv_to_dev(priv);
312
313 /* see rcar_thermal_get_temp() */
314 switch (trip) {
315 case 0: /* +90 <= temp */
316 *temp = MCELSIUS(90);
317 break;
318 default:
319 dev_err(dev, "rcar driver trip error\n");
320 return -EINVAL;
321 }
322
323 return 0;
324}
325
326static int rcar_thermal_notify(struct thermal_zone_device *zone,
327 int trip, enum thermal_trip_type type)
328{
329 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
330 struct device *dev = rcar_priv_to_dev(priv);
331
332 switch (type) {
333 case THERMAL_TRIP_CRITICAL:
334 /* FIXME */
335 dev_warn(dev, "Thermal reached to critical temperature\n");
336 break;
337 default:
338 break;
339 }
340
341 return 0;
342}
343
344static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
345 .get_temp = rcar_thermal_of_get_temp,
346};
347
348static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
349 .get_temp = rcar_thermal_get_temp,
350 .get_trip_type = rcar_thermal_get_trip_type,
351 .get_trip_temp = rcar_thermal_get_trip_temp,
352 .notify = rcar_thermal_notify,
353};
354
355/*
356 * interrupt
357 */
358#define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
359#define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
360static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
361{
362 struct rcar_thermal_common *common = priv->common;
363 unsigned long flags;
364 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
365
366 if (!rcar_has_irq_support(priv))
367 return;
368
369 spin_lock_irqsave(&common->lock, flags);
370
371 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
372
373 spin_unlock_irqrestore(&common->lock, flags);
374}
375
376static void rcar_thermal_work(struct work_struct *work)
377{
378 struct rcar_thermal_priv *priv;
379 int ret;
380
381 priv = container_of(work, struct rcar_thermal_priv, work.work);
382
383 ret = rcar_thermal_update_temp(priv);
384 if (ret < 0)
385 return;
386
387 rcar_thermal_irq_enable(priv);
388
389 thermal_zone_device_update(priv->zone, THERMAL_EVENT_UNSPECIFIED);
390}
391
392static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
393{
394 struct device *dev = rcar_priv_to_dev(priv);
395
396 status = (status >> rcar_id_to_shift(priv)) & 0x3;
397
398 if (status) {
399 dev_dbg(dev, "thermal%d %s%s\n",
400 priv->id,
401 (status & 0x2) ? "Rising " : "",
402 (status & 0x1) ? "Falling" : "");
403 }
404
405 return status;
406}
407
408static irqreturn_t rcar_thermal_irq(int irq, void *data)
409{
410 struct rcar_thermal_common *common = data;
411 struct rcar_thermal_priv *priv;
412 unsigned long flags;
413 u32 status, mask;
414
415 spin_lock_irqsave(&common->lock, flags);
416
417 mask = rcar_thermal_common_read(common, INTMSK);
418 status = rcar_thermal_common_read(common, STR);
419 rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
420
421 spin_unlock_irqrestore(&common->lock, flags);
422
423 status = status & ~mask;
424
425 /*
426 * check the status
427 */
428 rcar_thermal_for_each_priv(priv, common) {
429 if (rcar_thermal_had_changed(priv, status)) {
430 rcar_thermal_irq_disable(priv);
431 queue_delayed_work(system_freezable_wq, &priv->work,
432 msecs_to_jiffies(300));
433 }
434 }
435
436 return IRQ_HANDLED;
437}
438
439/*
440 * platform functions
441 */
442static int rcar_thermal_remove(struct platform_device *pdev)
443{
444 struct rcar_thermal_common *common = platform_get_drvdata(pdev);
445 struct device *dev = &pdev->dev;
446 struct rcar_thermal_priv *priv;
447
448 rcar_thermal_for_each_priv(priv, common) {
449 rcar_thermal_irq_disable(priv);
450 cancel_delayed_work_sync(&priv->work);
451 if (priv->chip->use_of_thermal)
452 thermal_remove_hwmon_sysfs(priv->zone);
453 else
454 thermal_zone_device_unregister(priv->zone);
455 }
456
457 pm_runtime_put(dev);
458 pm_runtime_disable(dev);
459
460 return 0;
461}
462
463static int rcar_thermal_probe(struct platform_device *pdev)
464{
465 struct rcar_thermal_common *common;
466 struct rcar_thermal_priv *priv;
467 struct device *dev = &pdev->dev;
468 struct resource *res, *irq;
469 const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
470 int mres = 0;
471 int i;
472 int ret = -ENODEV;
473 int idle = IDLE_INTERVAL;
474 u32 enr_bits = 0;
475
476 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
477 if (!common)
478 return -ENOMEM;
479
480 platform_set_drvdata(pdev, common);
481
482 INIT_LIST_HEAD(&common->head);
483 spin_lock_init(&common->lock);
484 common->dev = dev;
485
486 pm_runtime_enable(dev);
487 pm_runtime_get_sync(dev);
488
489 for (i = 0; i < chip->nirqs; i++) {
490 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
491 if (!irq)
492 continue;
493 if (!common->base) {
494 /*
495 * platform has IRQ support.
496 * Then, driver uses common registers
497 * rcar_has_irq_support() will be enabled
498 */
499 res = platform_get_resource(pdev, IORESOURCE_MEM,
500 mres++);
501 common->base = devm_ioremap_resource(dev, res);
502 if (IS_ERR(common->base)) {
503 ret = PTR_ERR(common->base);
504 goto error_unregister;
505 }
506
507 idle = 0; /* polling delay is not needed */
508 }
509
510 ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
511 IRQF_SHARED, dev_name(dev), common);
512 if (ret) {
513 dev_err(dev, "irq request failed\n ");
514 goto error_unregister;
515 }
516
517 /* update ENR bits */
518 if (chip->irq_per_ch)
519 enr_bits |= 1 << i;
520 }
521
522 for (i = 0;; i++) {
523 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
524 if (!res)
525 break;
526
527 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
528 if (!priv) {
529 ret = -ENOMEM;
530 goto error_unregister;
531 }
532
533 priv->base = devm_ioremap_resource(dev, res);
534 if (IS_ERR(priv->base)) {
535 ret = PTR_ERR(priv->base);
536 goto error_unregister;
537 }
538
539 priv->common = common;
540 priv->id = i;
541 priv->chip = chip;
542 mutex_init(&priv->lock);
543 INIT_LIST_HEAD(&priv->list);
544 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
545 ret = rcar_thermal_update_temp(priv);
546 if (ret < 0)
547 goto error_unregister;
548
549 if (chip->use_of_thermal)
550 priv->zone = devm_thermal_zone_of_sensor_register(
551 dev, i, priv,
552 &rcar_thermal_zone_of_ops);
553 else {
554 priv->zone = thermal_zone_device_register(
555 "rcar_thermal",
556 1, 0, priv,
557 &rcar_thermal_zone_ops, NULL, 0,
558 idle);
559
560 ret = thermal_zone_device_enable(priv->zone);
561 if (ret) {
562 thermal_zone_device_unregister(priv->zone);
563 priv->zone = ERR_PTR(ret);
564 }
565 }
566 if (IS_ERR(priv->zone)) {
567 dev_err(dev, "can't register thermal zone\n");
568 ret = PTR_ERR(priv->zone);
569 priv->zone = NULL;
570 goto error_unregister;
571 }
572
573 if (chip->use_of_thermal) {
574 /*
575 * thermal_zone doesn't enable hwmon as default,
576 * but, enable it here to keep compatible
577 */
578 priv->zone->tzp->no_hwmon = false;
579 ret = thermal_add_hwmon_sysfs(priv->zone);
580 if (ret)
581 goto error_unregister;
582 }
583
584 rcar_thermal_irq_enable(priv);
585
586 list_move_tail(&priv->list, &common->head);
587
588 /* update ENR bits */
589 if (!chip->irq_per_ch)
590 enr_bits |= 3 << (i * 8);
591 }
592
593 if (common->base && enr_bits)
594 rcar_thermal_common_write(common, ENR, enr_bits);
595
596 dev_info(dev, "%d sensor probed\n", i);
597
598 return 0;
599
600error_unregister:
601 rcar_thermal_remove(pdev);
602
603 return ret;
604}
605
606#ifdef CONFIG_PM_SLEEP
607static int rcar_thermal_suspend(struct device *dev)
608{
609 struct rcar_thermal_common *common = dev_get_drvdata(dev);
610 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
611 typeof(*priv), list);
612
613 if (priv->chip->needs_suspend_resume) {
614 rcar_thermal_common_write(common, ENR, 0);
615 rcar_thermal_irq_disable(priv);
616 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
617 }
618
619 return 0;
620}
621
622static int rcar_thermal_resume(struct device *dev)
623{
624 struct rcar_thermal_common *common = dev_get_drvdata(dev);
625 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
626 typeof(*priv), list);
627 int ret;
628
629 if (priv->chip->needs_suspend_resume) {
630 ret = rcar_thermal_update_temp(priv);
631 if (ret < 0)
632 return ret;
633 rcar_thermal_irq_enable(priv);
634 rcar_thermal_common_write(common, ENR, 0x03);
635 }
636
637 return 0;
638}
639#endif
640
641static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
642 rcar_thermal_resume);
643
644static struct platform_driver rcar_thermal_driver = {
645 .driver = {
646 .name = "rcar_thermal",
647 .pm = &rcar_thermal_pm_ops,
648 .of_match_table = rcar_thermal_dt_ids,
649 },
650 .probe = rcar_thermal_probe,
651 .remove = rcar_thermal_remove,
652};
653module_platform_driver(rcar_thermal_driver);
654
655MODULE_LICENSE("GPL v2");
656MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
657MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");