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 u32 ctemp; 99 }; 100 101 #define rcar_thermal_for_each_priv(pos, common) \ 102 list_for_each_entry(pos, &common->head, list) 103 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) 109 110 static const struct of_device_id rcar_thermal_dt_ids[] = { 111 { 112 .compatible = "renesas,rcar-thermal", 113 .data = &rcar_thermal, 114 }, 115 { 116 .compatible = "renesas,rcar-gen2-thermal", 117 .data = &rcar_gen2_thermal, 118 }, 119 { 120 .compatible = "renesas,thermal-r8a774c0", 121 .data = &rcar_gen3_thermal, 122 }, 123 { 124 .compatible = "renesas,thermal-r8a77970", 125 .data = &rcar_gen3_thermal, 126 }, 127 { 128 .compatible = "renesas,thermal-r8a77990", 129 .data = &rcar_gen3_thermal, 130 }, 131 { 132 .compatible = "renesas,thermal-r8a77995", 133 .data = &rcar_gen3_thermal, 134 }, 135 {}, 136 }; 137 MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids); 138 139 /* 140 * basic functions 141 */ 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, 145 u32 reg) 146 { 147 return ioread32(common->base + reg); 148 } 149 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, 153 u32 reg, u32 data) 154 { 155 iowrite32(data, common->base + reg); 156 } 157 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) 162 { 163 u32 val; 164 165 val = ioread32(common->base + reg); 166 val &= ~mask; 167 val |= (data & mask); 168 iowrite32(val, common->base + reg); 169 } 170 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) 173 { 174 return ioread32(priv->base + reg); 175 } 176 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, 179 u32 reg, u32 data) 180 { 181 iowrite32(data, priv->base + reg); 182 } 183 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, 186 u32 mask, u32 data) 187 { 188 u32 val; 189 190 val = ioread32(priv->base + reg); 191 val &= ~mask; 192 val |= (data & mask); 193 iowrite32(val, priv->base + reg); 194 } 195 196 /* 197 * zone device functions 198 */ 199 static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv) 200 { 201 struct device *dev = rcar_priv_to_dev(priv); 202 int i; 203 u32 ctemp, old, new; 204 int ret = -EINVAL; 205 206 mutex_lock(&priv->lock); 207 208 /* 209 * TSC decides a value of CPTAP automatically, 210 * and this is the conditions which validate interrupt. 211 */ 212 rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL); 213 214 ctemp = 0; 215 old = ~0; 216 for (i = 0; i < 128; i++) { 217 /* 218 * we need to wait 300us after changing comparator offset 219 * to get stable temperature. 220 * see "Usage Notes" on datasheet 221 */ 222 usleep_range(300, 400); 223 224 new = rcar_thermal_read(priv, THSSR) & CTEMP; 225 if (new == old) { 226 ctemp = new; 227 break; 228 } 229 old = new; 230 } 231 232 if (!ctemp) { 233 dev_err(dev, "thermal sensor was broken\n"); 234 goto err_out_unlock; 235 } 236 237 /* 238 * enable IRQ 239 */ 240 if (rcar_has_irq_support(priv)) { 241 if (priv->chip->has_filonoff) 242 rcar_thermal_write(priv, FILONOFF, 0); 243 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))); 248 } 249 250 dev_dbg(dev, "thermal%d %d -> %d\n", priv->id, priv->ctemp, ctemp); 251 252 priv->ctemp = ctemp; 253 ret = 0; 254 err_out_unlock: 255 mutex_unlock(&priv->lock); 256 return ret; 257 } 258 259 static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv, 260 int *temp) 261 { 262 int tmp; 263 int ret; 264 265 ret = rcar_thermal_update_temp(priv); 266 if (ret < 0) 267 return ret; 268 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); 274 else 275 tmp = MCELSIUS((priv->ctemp * 5) - 60); 276 mutex_unlock(&priv->lock); 277 278 /* Guaranteed operating range is -45C to 125C. */ 279 280 *temp = tmp; 281 282 return 0; 283 } 284 285 static int rcar_thermal_of_get_temp(void *data, int *temp) 286 { 287 struct rcar_thermal_priv *priv = data; 288 289 return rcar_thermal_get_current_temp(priv, temp); 290 } 291 292 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp) 293 { 294 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone); 295 296 return rcar_thermal_get_current_temp(priv, temp); 297 } 298 299 static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone, 300 int trip, enum thermal_trip_type *type) 301 { 302 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone); 303 struct device *dev = rcar_priv_to_dev(priv); 304 305 /* see rcar_thermal_get_temp() */ 306 switch (trip) { 307 case 0: /* +90 <= temp */ 308 *type = THERMAL_TRIP_CRITICAL; 309 break; 310 default: 311 dev_err(dev, "rcar driver trip error\n"); 312 return -EINVAL; 313 } 314 315 return 0; 316 } 317 318 static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone, 319 int trip, int *temp) 320 { 321 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone); 322 struct device *dev = rcar_priv_to_dev(priv); 323 324 /* see rcar_thermal_get_temp() */ 325 switch (trip) { 326 case 0: /* +90 <= temp */ 327 *temp = MCELSIUS(90); 328 break; 329 default: 330 dev_err(dev, "rcar driver trip error\n"); 331 return -EINVAL; 332 } 333 334 return 0; 335 } 336 337 static int rcar_thermal_notify(struct thermal_zone_device *zone, 338 int trip, enum thermal_trip_type type) 339 { 340 struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone); 341 struct device *dev = rcar_priv_to_dev(priv); 342 343 switch (type) { 344 case THERMAL_TRIP_CRITICAL: 345 /* FIXME */ 346 dev_warn(dev, "Thermal reached to critical temperature\n"); 347 break; 348 default: 349 break; 350 } 351 352 return 0; 353 } 354 355 static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = { 356 .get_temp = rcar_thermal_of_get_temp, 357 }; 358 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, 364 }; 365 366 /* 367 * interrupt 368 */ 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) 372 { 373 struct rcar_thermal_common *common = priv->common; 374 unsigned long flags; 375 u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */ 376 377 if (!rcar_has_irq_support(priv)) 378 return; 379 380 spin_lock_irqsave(&common->lock, flags); 381 382 rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask); 383 384 spin_unlock_irqrestore(&common->lock, flags); 385 } 386 387 static void rcar_thermal_work(struct work_struct *work) 388 { 389 struct rcar_thermal_priv *priv; 390 int cctemp, nctemp; 391 int ret; 392 393 priv = container_of(work, struct rcar_thermal_priv, work.work); 394 395 ret = rcar_thermal_get_current_temp(priv, &cctemp); 396 if (ret < 0) 397 return; 398 399 ret = rcar_thermal_update_temp(priv); 400 if (ret < 0) 401 return; 402 403 rcar_thermal_irq_enable(priv); 404 405 ret = rcar_thermal_get_current_temp(priv, &nctemp); 406 if (ret < 0) 407 return; 408 409 if (nctemp != cctemp) 410 thermal_zone_device_update(priv->zone, 411 THERMAL_EVENT_UNSPECIFIED); 412 } 413 414 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status) 415 { 416 struct device *dev = rcar_priv_to_dev(priv); 417 418 status = (status >> rcar_id_to_shift(priv)) & 0x3; 419 420 if (status) { 421 dev_dbg(dev, "thermal%d %s%s\n", 422 priv->id, 423 (status & 0x2) ? "Rising " : "", 424 (status & 0x1) ? "Falling" : ""); 425 } 426 427 return status; 428 } 429 430 static irqreturn_t rcar_thermal_irq(int irq, void *data) 431 { 432 struct rcar_thermal_common *common = data; 433 struct rcar_thermal_priv *priv; 434 unsigned long flags; 435 u32 status, mask; 436 437 spin_lock_irqsave(&common->lock, flags); 438 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); 442 443 spin_unlock_irqrestore(&common->lock, flags); 444 445 status = status & ~mask; 446 447 /* 448 * check the status 449 */ 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)); 455 } 456 } 457 458 return IRQ_HANDLED; 459 } 460 461 /* 462 * platform functions 463 */ 464 static int rcar_thermal_remove(struct platform_device *pdev) 465 { 466 struct rcar_thermal_common *common = platform_get_drvdata(pdev); 467 struct device *dev = &pdev->dev; 468 struct rcar_thermal_priv *priv; 469 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); 475 else 476 thermal_zone_device_unregister(priv->zone); 477 } 478 479 pm_runtime_put(dev); 480 pm_runtime_disable(dev); 481 482 return 0; 483 } 484 485 static int rcar_thermal_probe(struct platform_device *pdev) 486 { 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); 492 int mres = 0; 493 int i; 494 int ret = -ENODEV; 495 int idle = IDLE_INTERVAL; 496 u32 enr_bits = 0; 497 498 common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL); 499 if (!common) 500 return -ENOMEM; 501 502 platform_set_drvdata(pdev, common); 503 504 INIT_LIST_HEAD(&common->head); 505 spin_lock_init(&common->lock); 506 common->dev = dev; 507 508 pm_runtime_enable(dev); 509 pm_runtime_get_sync(dev); 510 511 for (i = 0; i < chip->nirqs; i++) { 512 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i); 513 if (!irq) 514 continue; 515 if (!common->base) { 516 /* 517 * platform has IRQ support. 518 * Then, driver uses common registers 519 * rcar_has_irq_support() will be enabled 520 */ 521 res = platform_get_resource(pdev, IORESOURCE_MEM, 522 mres++); 523 common->base = devm_ioremap_resource(dev, res); 524 if (IS_ERR(common->base)) 525 return PTR_ERR(common->base); 526 527 idle = 0; /* polling delay is not needed */ 528 } 529 530 ret = devm_request_irq(dev, irq->start, rcar_thermal_irq, 531 IRQF_SHARED, dev_name(dev), common); 532 if (ret) { 533 dev_err(dev, "irq request failed\n "); 534 goto error_unregister; 535 } 536 537 /* update ENR bits */ 538 if (chip->irq_per_ch) 539 enr_bits |= 1 << i; 540 } 541 542 for (i = 0;; i++) { 543 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++); 544 if (!res) 545 break; 546 547 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); 548 if (!priv) { 549 ret = -ENOMEM; 550 goto error_unregister; 551 } 552 553 priv->base = devm_ioremap_resource(dev, res); 554 if (IS_ERR(priv->base)) { 555 ret = PTR_ERR(priv->base); 556 goto error_unregister; 557 } 558 559 priv->common = common; 560 priv->id = i; 561 priv->chip = chip; 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); 566 if (ret < 0) 567 goto error_unregister; 568 569 if (chip->use_of_thermal) 570 priv->zone = devm_thermal_zone_of_sensor_register( 571 dev, i, priv, 572 &rcar_thermal_zone_of_ops); 573 else 574 priv->zone = thermal_zone_device_register( 575 "rcar_thermal", 576 1, 0, priv, 577 &rcar_thermal_zone_ops, NULL, 0, 578 idle); 579 if (IS_ERR(priv->zone)) { 580 dev_err(dev, "can't register thermal zone\n"); 581 ret = PTR_ERR(priv->zone); 582 priv->zone = NULL; 583 goto error_unregister; 584 } 585 586 if (chip->use_of_thermal) { 587 /* 588 * thermal_zone doesn't enable hwmon as default, 589 * but, enable it here to keep compatible 590 */ 591 priv->zone->tzp->no_hwmon = false; 592 ret = thermal_add_hwmon_sysfs(priv->zone); 593 if (ret) 594 goto error_unregister; 595 } 596 597 rcar_thermal_irq_enable(priv); 598 599 list_move_tail(&priv->list, &common->head); 600 601 /* update ENR bits */ 602 if (!chip->irq_per_ch) 603 enr_bits |= 3 << (i * 8); 604 } 605 606 if (common->base && enr_bits) 607 rcar_thermal_common_write(common, ENR, enr_bits); 608 609 dev_info(dev, "%d sensor probed\n", i); 610 611 return 0; 612 613 error_unregister: 614 rcar_thermal_remove(pdev); 615 616 return ret; 617 } 618 619 #ifdef CONFIG_PM_SLEEP 620 static int rcar_thermal_suspend(struct device *dev) 621 { 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); 625 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); 630 } 631 632 return 0; 633 } 634 635 static int rcar_thermal_resume(struct device *dev) 636 { 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); 640 int ret; 641 642 if (priv->chip->needs_suspend_resume) { 643 ret = rcar_thermal_update_temp(priv); 644 if (ret < 0) 645 return ret; 646 rcar_thermal_irq_enable(priv); 647 rcar_thermal_common_write(common, ENR, 0x03); 648 } 649 650 return 0; 651 } 652 #endif 653 654 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend, 655 rcar_thermal_resume); 656 657 static struct platform_driver rcar_thermal_driver = { 658 .driver = { 659 .name = "rcar_thermal", 660 .pm = &rcar_thermal_pm_ops, 661 .of_match_table = rcar_thermal_dt_ids, 662 }, 663 .probe = rcar_thermal_probe, 664 .remove = rcar_thermal_remove, 665 }; 666 module_platform_driver(rcar_thermal_driver); 667 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>"); 671