drivers/thermal/rcar_thermal.c

   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)
 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)
 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)
 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)
 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)
 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)
 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  */
 198 static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
 199 {
 200         struct device *dev = rcar_priv_to_dev(priv);
 201         int i;
 202         u32 ctemp, old, new;
 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         ctemp = 0;
 213         old = ~0;
 214         for (i = 0; i < 128; i++) {
 215                 /*
 216                  * we need to wait 300us after changing comparator offset
 217                  * to get stable temperature.
 218                  * see "Usage Notes" on datasheet
 219                  */
 220                 usleep_range(300, 400);
 221
 222                 new = rcar_thermal_read(priv, THSSR) & CTEMP;
 223                 if (new == old) {
 224                         ctemp = new;
 225                         break;
 226                 }
 227                 old = new;
 228         }
 229
 230         if (!ctemp) {
 231                 dev_err(dev, "thermal sensor was broken\n");
 232                 goto err_out_unlock;
 233         }
 234
 235         /*
 236          * enable IRQ
 237          */
 238         if (rcar_has_irq_support(priv)) {
 239                 if (priv->chip->has_filonoff)
 240                         rcar_thermal_write(priv, FILONOFF, 0);
 241
 242                 /* enable Rising/Falling edge interrupt */
 243                 rcar_thermal_write(priv, POSNEG,  0x1);
 244                 rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
 245                                                    ((ctemp - 1) << 0)));
 246         }
 247
 248 err_out_unlock:
 249         mutex_unlock(&priv->lock);
 250
 251         return ctemp ? ctemp : -EINVAL;
 252 }
 253
 254 static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
 255                                          int *temp)
 256 {
 257         int ctemp, tmp;
 258
 259         ctemp = rcar_thermal_update_temp(priv);
 260         if (ctemp < 0)
 261                 return ctemp;
 262
 263         mutex_lock(&priv->lock);
 264         if (priv->chip->ctemp_bands == 1)
 265                 tmp = MCELSIUS((ctemp * 5) - 65);
 266         else if (ctemp < 24)
 267                 tmp = MCELSIUS(((ctemp * 55) - 720) / 10);
 268         else
 269                 tmp = MCELSIUS((ctemp * 5) - 60);
 270         mutex_unlock(&priv->lock);
 271
 272         /* Guaranteed operating range is -45C to 125C. */
 273
 274         *temp = tmp;
 275
 276         return 0;
 277 }
 278
 279 static int rcar_thermal_of_get_temp(void *data, int *temp)
 280 {
 281         struct rcar_thermal_priv *priv = data;
 282
 283         return rcar_thermal_get_current_temp(priv, temp);
 284 }
 285
 286 static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
 287 {
 288         struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
 289
 290         return rcar_thermal_get_current_temp(priv, temp);
 291 }
 292
 293 static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
 294                                       int trip, enum thermal_trip_type *type)
 295 {
 296         struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
 297         struct device *dev = rcar_priv_to_dev(priv);
 298
 299         /* see rcar_thermal_get_temp() */
 300         switch (trip) {
 301         case 0: /* +90 <= temp */
 302                 *type = THERMAL_TRIP_CRITICAL;
 303                 break;
 304         default:
 305                 dev_err(dev, "rcar driver trip error\n");
 306                 return -EINVAL;
 307         }
 308
 309         return 0;
 310 }
 311
 312 static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
 313                                       int trip, int *temp)
 314 {
 315         struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
 316         struct device *dev = rcar_priv_to_dev(priv);
 317
 318         /* see rcar_thermal_get_temp() */
 319         switch (trip) {
 320         case 0: /* +90 <= temp */
 321                 *temp = MCELSIUS(90);
 322                 break;
 323         default:
 324                 dev_err(dev, "rcar driver trip error\n");
 325                 return -EINVAL;
 326         }
 327
 328         return 0;
 329 }
 330
 331 static int rcar_thermal_notify(struct thermal_zone_device *zone,
 332                                int trip, enum thermal_trip_type type)
 333 {
 334         struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
 335         struct device *dev = rcar_priv_to_dev(priv);
 336
 337         switch (type) {
 338         case THERMAL_TRIP_CRITICAL:
 339                 /* FIXME */
 340                 dev_warn(dev, "Thermal reached to critical temperature\n");
 341                 break;
 342         default:
 343                 break;
 344         }
 345
 346         return 0;
 347 }
 348
 349 static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
 350         .get_temp       = rcar_thermal_of_get_temp,
 351 };
 352
 353 static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
 354         .get_temp       = rcar_thermal_get_temp,
 355         .get_trip_type  = rcar_thermal_get_trip_type,
 356         .get_trip_temp  = rcar_thermal_get_trip_temp,
 357         .notify         = rcar_thermal_notify,
 358 };
 359
 360 /*
 361  *              interrupt
 362  */
 363 #define rcar_thermal_irq_enable(p)      _rcar_thermal_irq_ctrl(p, 1)
 364 #define rcar_thermal_irq_disable(p)     _rcar_thermal_irq_ctrl(p, 0)
 365 static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
 366 {
 367         struct rcar_thermal_common *common = priv->common;
 368         unsigned long flags;
 369         u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
 370
 371         if (!rcar_has_irq_support(priv))
 372                 return;
 373
 374         spin_lock_irqsave(&common->lock, flags);
 375
 376         rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
 377
 378         spin_unlock_irqrestore(&common->lock, flags);
 379 }
 380
 381 static void rcar_thermal_work(struct work_struct *work)
 382 {
 383         struct rcar_thermal_priv *priv;
 384         int ret;
 385
 386         priv = container_of(work, struct rcar_thermal_priv, work.work);
 387
 388         ret = rcar_thermal_update_temp(priv);
 389         if (ret < 0)
 390                 return;
 391
 392         rcar_thermal_irq_enable(priv);
 393
 394         thermal_zone_device_update(priv->zone, THERMAL_EVENT_UNSPECIFIED);
 395 }
 396
 397 static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
 398 {
 399         struct device *dev = rcar_priv_to_dev(priv);
 400
 401         status = (status >> rcar_id_to_shift(priv)) & 0x3;
 402
 403         if (status) {
 404                 dev_dbg(dev, "thermal%d %s%s\n",
 405                         priv->id,
 406                         (status & 0x2) ? "Rising " : "",
 407                         (status & 0x1) ? "Falling" : "");
 408         }
 409
 410         return status;
 411 }
 412
 413 static irqreturn_t rcar_thermal_irq(int irq, void *data)
 414 {
 415         struct rcar_thermal_common *common = data;
 416         struct rcar_thermal_priv *priv;
 417         unsigned long flags;
 418         u32 status, mask;
 419
 420         spin_lock_irqsave(&common->lock, flags);
 421
 422         mask    = rcar_thermal_common_read(common, INTMSK);
 423         status  = rcar_thermal_common_read(common, STR);
 424         rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
 425
 426         spin_unlock_irqrestore(&common->lock, flags);
 427
 428         status = status & ~mask;
 429
 430         /*
 431          * check the status
 432          */
 433         rcar_thermal_for_each_priv(priv, common) {
 434                 if (rcar_thermal_had_changed(priv, status)) {
 435                         rcar_thermal_irq_disable(priv);
 436                         queue_delayed_work(system_freezable_wq, &priv->work,
 437                                            msecs_to_jiffies(300));
 438                 }
 439         }
 440
 441         return IRQ_HANDLED;
 442 }
 443
 444 /*
 445  *              platform functions
 446  */
 447 static int rcar_thermal_remove(struct platform_device *pdev)
 448 {
 449         struct rcar_thermal_common *common = platform_get_drvdata(pdev);
 450         struct device *dev = &pdev->dev;
 451         struct rcar_thermal_priv *priv;
 452
 453         rcar_thermal_for_each_priv(priv, common) {
 454                 rcar_thermal_irq_disable(priv);
 455                 cancel_delayed_work_sync(&priv->work);
 456                 if (priv->chip->use_of_thermal)
 457                         thermal_remove_hwmon_sysfs(priv->zone);
 458                 else
 459                         thermal_zone_device_unregister(priv->zone);
 460         }
 461
 462         pm_runtime_put(dev);
 463         pm_runtime_disable(dev);
 464
 465         return 0;
 466 }
 467
 468 static int rcar_thermal_probe(struct platform_device *pdev)
 469 {
 470         struct rcar_thermal_common *common;
 471         struct rcar_thermal_priv *priv;
 472         struct device *dev = &pdev->dev;
 473         struct resource *res, *irq;
 474         const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
 475         int mres = 0;
 476         int i;
 477         int ret = -ENODEV;
 478         int idle = IDLE_INTERVAL;
 479         u32 enr_bits = 0;
 480
 481         common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
 482         if (!common)
 483                 return -ENOMEM;
 484
 485         platform_set_drvdata(pdev, common);
 486
 487         INIT_LIST_HEAD(&common->head);
 488         spin_lock_init(&common->lock);
 489         common->dev = dev;
 490
 491         pm_runtime_enable(dev);
 492         pm_runtime_get_sync(dev);
 493
 494         for (i = 0; i < chip->nirqs; i++) {
 495                 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
 496                 if (!irq)
 497                         continue;
 498                 if (!common->base) {
 499                         /*
 500                          * platform has IRQ support.
 501                          * Then, driver uses common registers
 502                          * rcar_has_irq_support() will be enabled
 503                          */
 504                         res = platform_get_resource(pdev, IORESOURCE_MEM,
 505                                                     mres++);
 506                         common->base = devm_ioremap_resource(dev, res);
 507                         if (IS_ERR(common->base)) {
 508                                 ret = PTR_ERR(common->base);
 509                                 goto error_unregister;
 510                         }
 511
 512                         idle = 0; /* polling delay is not needed */
 513                 }
 514
 515                 ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
 516                                        IRQF_SHARED, dev_name(dev), common);
 517                 if (ret) {
 518                         dev_err(dev, "irq request failed\n ");
 519                         goto error_unregister;
 520                 }
 521
 522                 /* update ENR bits */
 523                 if (chip->irq_per_ch)
 524                         enr_bits |= 1 << i;
 525         }
 526
 527         for (i = 0;; i++) {
 528                 res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
 529                 if (!res)
 530                         break;
 531
 532                 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 533                 if (!priv) {
 534                         ret = -ENOMEM;
 535                         goto error_unregister;
 536                 }
 537
 538                 priv->base = devm_ioremap_resource(dev, res);
 539                 if (IS_ERR(priv->base)) {
 540                         ret = PTR_ERR(priv->base);
 541                         goto error_unregister;
 542                 }
 543
 544                 priv->common = common;
 545                 priv->id = i;
 546                 priv->chip = chip;
 547                 mutex_init(&priv->lock);
 548                 INIT_LIST_HEAD(&priv->list);
 549                 INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
 550                 ret = rcar_thermal_update_temp(priv);
 551                 if (ret < 0)
 552                         goto error_unregister;
 553
 554                 if (chip->use_of_thermal)
 555                         priv->zone = devm_thermal_zone_of_sensor_register(
 556                                                 dev, i, priv,
 557                                                 &rcar_thermal_zone_of_ops);
 558                 else
 559                         priv->zone = thermal_zone_device_register(
 560                                                 "rcar_thermal",
 561                                                 1, 0, priv,
 562                                                 &rcar_thermal_zone_ops, NULL, 0,
 563                                                 idle);
 564                 if (IS_ERR(priv->zone)) {
 565                         dev_err(dev, "can't register thermal zone\n");
 566                         ret = PTR_ERR(priv->zone);
 567                         priv->zone = NULL;
 568                         goto error_unregister;
 569                 }
 570
 571                 if (chip->use_of_thermal) {
 572                         /*
 573                          * thermal_zone doesn't enable hwmon as default,
 574                          * but, enable it here to keep compatible
 575                          */
 576                         priv->zone->tzp->no_hwmon = false;
 577                         ret = thermal_add_hwmon_sysfs(priv->zone);
 578                         if (ret)
 579                                 goto error_unregister;
 580                 }
 581
 582                 rcar_thermal_irq_enable(priv);
 583
 584                 list_move_tail(&priv->list, &common->head);
 585
 586                 /* update ENR bits */
 587                 if (!chip->irq_per_ch)
 588                         enr_bits |= 3 << (i * 8);
 589         }
 590
 591         if (common->base && enr_bits)
 592                 rcar_thermal_common_write(common, ENR, enr_bits);
 593
 594         dev_info(dev, "%d sensor probed\n", i);
 595
 596         return 0;
 597
 598 error_unregister:
 599         rcar_thermal_remove(pdev);
 600
 601         return ret;
 602 }
 603
 604 #ifdef CONFIG_PM_SLEEP
 605 static int rcar_thermal_suspend(struct device *dev)
 606 {
 607         struct rcar_thermal_common *common = dev_get_drvdata(dev);
 608         struct rcar_thermal_priv *priv = list_first_entry(&common->head,
 609                                                           typeof(*priv), list);
 610
 611         if (priv->chip->needs_suspend_resume) {
 612                 rcar_thermal_common_write(common, ENR, 0);
 613                 rcar_thermal_irq_disable(priv);
 614                 rcar_thermal_bset(priv, THSCR, CPCTL, 0);
 615         }
 616
 617         return 0;
 618 }
 619
 620 static int rcar_thermal_resume(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         int ret;
 626
 627         if (priv->chip->needs_suspend_resume) {
 628                 ret = rcar_thermal_update_temp(priv);
 629                 if (ret < 0)
 630                         return ret;
 631                 rcar_thermal_irq_enable(priv);
 632                 rcar_thermal_common_write(common, ENR, 0x03);
 633         }
 634
 635         return 0;
 636 }
 637 #endif
 638
 639 static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
 640                          rcar_thermal_resume);
 641
 642 static struct platform_driver rcar_thermal_driver = {
 643         .driver = {
 644                 .name   = "rcar_thermal",
 645                 .pm = &rcar_thermal_pm_ops,
 646                 .of_match_table = rcar_thermal_dt_ids,
 647         },
 648         .probe          = rcar_thermal_probe,
 649         .remove         = rcar_thermal_remove,
 650 };
 651 module_platform_driver(rcar_thermal_driver);
 652
 653 MODULE_LICENSE("GPL v2");
 654 MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
 655 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");