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
42 struct rcar_thermal_common {
43 void __iomem *base;
44 struct device *dev;
45 struct list_head head;
46 spinlock_t lock;
47 };
48
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;
54 unsigned int nirqs;
55 unsigned int ctemp_bands;
56 };
57
58 static 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
67 static 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
76 static 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
89 struct 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
109 static 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 };
136 MODULE_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)
_rcar_thermal_common_read(struct rcar_thermal_common * common,u32 reg)143 static 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)
_rcar_thermal_common_write(struct rcar_thermal_common * common,u32 reg,u32 data)151 static 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)
_rcar_thermal_common_bset(struct rcar_thermal_common * common,u32 reg,u32 mask,u32 data)159 static 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)
_rcar_thermal_read(struct rcar_thermal_priv * priv,u32 reg)171 static 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)
_rcar_thermal_write(struct rcar_thermal_priv * priv,u32 reg,u32 data)177 static 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)
_rcar_thermal_bset(struct rcar_thermal_priv * priv,u32 reg,u32 mask,u32 data)184 static 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 */
rcar_thermal_update_temp(struct rcar_thermal_priv * priv)198 static 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
247 err_out_unlock:
248 mutex_unlock(&priv->lock);
249
250 return ctemp;
251 }
252
rcar_thermal_get_current_temp(struct rcar_thermal_priv * priv,int * temp)253 static 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
rcar_thermal_get_temp(struct thermal_zone_device * zone,int * temp)274 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
275 {
276 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
277
278 return rcar_thermal_get_current_temp(priv, temp);
279 }
280
281 static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
282 .get_temp = rcar_thermal_get_temp,
283 };
284
285 static struct thermal_trip trips[] = {
286 { .type = THERMAL_TRIP_CRITICAL, .temperature = 90000 }
287 };
288
289 /*
290 * interrupt
291 */
292 #define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
293 #define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
_rcar_thermal_irq_ctrl(struct rcar_thermal_priv * priv,int enable)294 static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
295 {
296 struct rcar_thermal_common *common = priv->common;
297 unsigned long flags;
298 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
299
300 if (!rcar_has_irq_support(priv))
301 return;
302
303 spin_lock_irqsave(&common->lock, flags);
304
305 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
306
307 spin_unlock_irqrestore(&common->lock, flags);
308 }
309
rcar_thermal_work(struct work_struct * work)310 static void rcar_thermal_work(struct work_struct *work)
311 {
312 struct rcar_thermal_priv *priv;
313 int ret;
314
315 priv = container_of(work, struct rcar_thermal_priv, work.work);
316
317 ret = rcar_thermal_update_temp(priv);
318 if (ret < 0)
319 return;
320
321 rcar_thermal_irq_enable(priv);
322
323 thermal_zone_device_update(priv->zone, THERMAL_EVENT_UNSPECIFIED);
324 }
325
rcar_thermal_had_changed(struct rcar_thermal_priv * priv,u32 status)326 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
327 {
328 struct device *dev = rcar_priv_to_dev(priv);
329
330 status = (status >> rcar_id_to_shift(priv)) & 0x3;
331
332 if (status) {
333 dev_dbg(dev, "thermal%d %s%s\n",
334 priv->id,
335 (status & 0x2) ? "Rising " : "",
336 (status & 0x1) ? "Falling" : "");
337 }
338
339 return status;
340 }
341
rcar_thermal_irq(int irq,void * data)342 static irqreturn_t rcar_thermal_irq(int irq, void *data)
343 {
344 struct rcar_thermal_common *common = data;
345 struct rcar_thermal_priv *priv;
346 u32 status, mask;
347
348 spin_lock(&common->lock);
349
350 mask = rcar_thermal_common_read(common, INTMSK);
351 status = rcar_thermal_common_read(common, STR);
352 rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
353
354 spin_unlock(&common->lock);
355
356 status = status & ~mask;
357
358 /*
359 * check the status
360 */
361 rcar_thermal_for_each_priv(priv, common) {
362 if (rcar_thermal_had_changed(priv, status)) {
363 rcar_thermal_irq_disable(priv);
364 queue_delayed_work(system_freezable_wq, &priv->work,
365 msecs_to_jiffies(300));
366 }
367 }
368
369 return IRQ_HANDLED;
370 }
371
372 /*
373 * platform functions
374 */
rcar_thermal_remove(struct platform_device * pdev)375 static int rcar_thermal_remove(struct platform_device *pdev)
376 {
377 struct rcar_thermal_common *common = platform_get_drvdata(pdev);
378 struct device *dev = &pdev->dev;
379 struct rcar_thermal_priv *priv;
380
381 rcar_thermal_for_each_priv(priv, common) {
382 rcar_thermal_irq_disable(priv);
383 cancel_delayed_work_sync(&priv->work);
384 if (priv->chip->use_of_thermal)
385 thermal_remove_hwmon_sysfs(priv->zone);
386 else
387 thermal_zone_device_unregister(priv->zone);
388 }
389
390 pm_runtime_put(dev);
391 pm_runtime_disable(dev);
392
393 return 0;
394 }
395
rcar_thermal_probe(struct platform_device * pdev)396 static int rcar_thermal_probe(struct platform_device *pdev)
397 {
398 struct rcar_thermal_common *common;
399 struct rcar_thermal_priv *priv;
400 struct device *dev = &pdev->dev;
401 struct resource *res;
402 const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
403 int mres = 0;
404 int i;
405 int ret = -ENODEV;
406 int idle = IDLE_INTERVAL;
407 u32 enr_bits = 0;
408
409 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
410 if (!common)
411 return -ENOMEM;
412
413 platform_set_drvdata(pdev, common);
414
415 INIT_LIST_HEAD(&common->head);
416 spin_lock_init(&common->lock);
417 common->dev = dev;
418
419 pm_runtime_enable(dev);
420 pm_runtime_get_sync(dev);
421
422 for (i = 0; i < chip->nirqs; i++) {
423 int irq;
424
425 ret = platform_get_irq_optional(pdev, i);
426 if (ret < 0 && ret != -ENXIO)
427 goto error_unregister;
428 if (ret > 0)
429 irq = ret;
430 else
431 break;
432
433 if (!common->base) {
434 /*
435 * platform has IRQ support.
436 * Then, driver uses common registers
437 * rcar_has_irq_support() will be enabled
438 */
439 res = platform_get_resource(pdev, IORESOURCE_MEM,
440 mres++);
441 common->base = devm_ioremap_resource(dev, res);
442 if (IS_ERR(common->base)) {
443 ret = PTR_ERR(common->base);
444 goto error_unregister;
445 }
446
447 idle = 0; /* polling delay is not needed */
448 }
449
450 ret = devm_request_irq(dev, irq, rcar_thermal_irq,
451 IRQF_SHARED, dev_name(dev), common);
452 if (ret) {
453 dev_err(dev, "irq request failed\n ");
454 goto error_unregister;
455 }
456
457 /* update ENR bits */
458 if (chip->irq_per_ch)
459 enr_bits |= 1 << i;
460 }
461
462 for (i = 0;; i++) {
463 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
464 if (!res)
465 break;
466
467 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
468 if (!priv) {
469 ret = -ENOMEM;
470 goto error_unregister;
471 }
472
473 priv->base = devm_ioremap_resource(dev, res);
474 if (IS_ERR(priv->base)) {
475 ret = PTR_ERR(priv->base);
476 goto error_unregister;
477 }
478
479 priv->common = common;
480 priv->id = i;
481 priv->chip = chip;
482 mutex_init(&priv->lock);
483 INIT_LIST_HEAD(&priv->list);
484 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
485 ret = rcar_thermal_update_temp(priv);
486 if (ret < 0)
487 goto error_unregister;
488
489 if (chip->use_of_thermal) {
490 priv->zone = devm_thermal_of_zone_register(
491 dev, i, priv,
492 &rcar_thermal_zone_ops);
493 } else {
494 priv->zone = thermal_zone_device_register_with_trips(
495 "rcar_thermal", trips, ARRAY_SIZE(trips), 0, priv,
496 &rcar_thermal_zone_ops, NULL, 0,
497 idle);
498
499 ret = thermal_zone_device_enable(priv->zone);
500 if (ret) {
501 thermal_zone_device_unregister(priv->zone);
502 priv->zone = ERR_PTR(ret);
503 }
504 }
505 if (IS_ERR(priv->zone)) {
506 dev_err(dev, "can't register thermal zone\n");
507 ret = PTR_ERR(priv->zone);
508 priv->zone = NULL;
509 goto error_unregister;
510 }
511
512 if (chip->use_of_thermal) {
513 /*
514 * thermal_zone doesn't enable hwmon as default,
515 * but, enable it here to keep compatible
516 */
517 priv->zone->tzp->no_hwmon = false;
518 ret = thermal_add_hwmon_sysfs(priv->zone);
519 if (ret)
520 goto error_unregister;
521 }
522
523 rcar_thermal_irq_enable(priv);
524
525 list_move_tail(&priv->list, &common->head);
526
527 /* update ENR bits */
528 if (!chip->irq_per_ch)
529 enr_bits |= 3 << (i * 8);
530 }
531
532 if (common->base && enr_bits)
533 rcar_thermal_common_write(common, ENR, enr_bits);
534
535 dev_info(dev, "%d sensor probed\n", i);
536
537 return 0;
538
539 error_unregister:
540 rcar_thermal_remove(pdev);
541
542 return ret;
543 }
544
545 #ifdef CONFIG_PM_SLEEP
rcar_thermal_suspend(struct device * dev)546 static int rcar_thermal_suspend(struct device *dev)
547 {
548 struct rcar_thermal_common *common = dev_get_drvdata(dev);
549 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
550 typeof(*priv), list);
551
552 if (priv->chip->needs_suspend_resume) {
553 rcar_thermal_common_write(common, ENR, 0);
554 rcar_thermal_irq_disable(priv);
555 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
556 }
557
558 return 0;
559 }
560
rcar_thermal_resume(struct device * dev)561 static int rcar_thermal_resume(struct device *dev)
562 {
563 struct rcar_thermal_common *common = dev_get_drvdata(dev);
564 struct rcar_thermal_priv *priv = list_first_entry(&common->head,
565 typeof(*priv), list);
566 int ret;
567
568 if (priv->chip->needs_suspend_resume) {
569 ret = rcar_thermal_update_temp(priv);
570 if (ret < 0)
571 return ret;
572 rcar_thermal_irq_enable(priv);
573 rcar_thermal_common_write(common, ENR, 0x03);
574 }
575
576 return 0;
577 }
578 #endif
579
580 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
581 rcar_thermal_resume);
582
583 static struct platform_driver rcar_thermal_driver = {
584 .driver = {
585 .name = "rcar_thermal",
586 .pm = &rcar_thermal_pm_ops,
587 .of_match_table = rcar_thermal_dt_ids,
588 },
589 .probe = rcar_thermal_probe,
590 .remove = rcar_thermal_remove,
591 };
592 module_platform_driver(rcar_thermal_driver);
593
594 MODULE_LICENSE("GPL v2");
595 MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
596 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
597