drivers/thermal/broadcom/bcm2835_thermal.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Driver for Broadcom BCM2835 SoC temperature sensor
   4  *
   5  * Copyright (C) 2016 Martin Sperl
   6  */
   7
   8 #include <linux/clk.h>
   9 #include <linux/debugfs.h>
  10 #include <linux/device.h>
  11 #include <linux/err.h>
  12 #include <linux/io.h>
  13 #include <linux/kernel.h>
  14 #include <linux/module.h>
  15 #include <linux/of.h>
  16 #include <linux/of_address.h>
  17 #include <linux/of_device.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/thermal.h>
  20
  21 #include "../thermal_hwmon.h"
  22
  23 #define BCM2835_TS_TSENSCTL                     0x00
  24 #define BCM2835_TS_TSENSSTAT                    0x04
  25
  26 #define BCM2835_TS_TSENSCTL_PRWDW               BIT(0)
  27 #define BCM2835_TS_TSENSCTL_RSTB                BIT(1)
  28
  29 /*
  30  * bandgap reference voltage in 6 mV increments
  31  * 000b = 1178 mV, 001b = 1184 mV, ... 111b = 1220 mV
  32  */
  33 #define BCM2835_TS_TSENSCTL_CTRL_BITS           3
  34 #define BCM2835_TS_TSENSCTL_CTRL_SHIFT          2
  35 #define BCM2835_TS_TSENSCTL_CTRL_MASK               \
  36         GENMASK(BCM2835_TS_TSENSCTL_CTRL_BITS +     \
  37                 BCM2835_TS_TSENSCTL_CTRL_SHIFT - 1, \
  38                 BCM2835_TS_TSENSCTL_CTRL_SHIFT)
  39 #define BCM2835_TS_TSENSCTL_CTRL_DEFAULT        1
  40 #define BCM2835_TS_TSENSCTL_EN_INT              BIT(5)
  41 #define BCM2835_TS_TSENSCTL_DIRECT              BIT(6)
  42 #define BCM2835_TS_TSENSCTL_CLR_INT             BIT(7)
  43 #define BCM2835_TS_TSENSCTL_THOLD_SHIFT         8
  44 #define BCM2835_TS_TSENSCTL_THOLD_BITS          10
  45 #define BCM2835_TS_TSENSCTL_THOLD_MASK               \
  46         GENMASK(BCM2835_TS_TSENSCTL_THOLD_BITS +     \
  47                 BCM2835_TS_TSENSCTL_THOLD_SHIFT - 1, \
  48                 BCM2835_TS_TSENSCTL_THOLD_SHIFT)
  49 /*
  50  * time how long the block to be asserted in reset
  51  * which based on a clock counter (TSENS clock assumed)
  52  */
  53 #define BCM2835_TS_TSENSCTL_RSTDELAY_SHIFT      18
  54 #define BCM2835_TS_TSENSCTL_RSTDELAY_BITS       8
  55 #define BCM2835_TS_TSENSCTL_REGULEN             BIT(26)
  56
  57 #define BCM2835_TS_TSENSSTAT_DATA_BITS          10
  58 #define BCM2835_TS_TSENSSTAT_DATA_SHIFT         0
  59 #define BCM2835_TS_TSENSSTAT_DATA_MASK               \
  60         GENMASK(BCM2835_TS_TSENSSTAT_DATA_BITS +     \
  61                 BCM2835_TS_TSENSSTAT_DATA_SHIFT - 1, \
  62                 BCM2835_TS_TSENSSTAT_DATA_SHIFT)
  63 #define BCM2835_TS_TSENSSTAT_VALID              BIT(10)
  64 #define BCM2835_TS_TSENSSTAT_INTERRUPT          BIT(11)
  65
  66 struct bcm2835_thermal_data {
  67         struct thermal_zone_device *tz;
  68         void __iomem *regs;
  69         struct clk *clk;
  70         struct dentry *debugfsdir;
  71 };
  72
  73 static int bcm2835_thermal_adc2temp(u32 adc, int offset, int slope)
  74 {
  75         return offset + slope * adc;
  76 }
  77
  78 static int bcm2835_thermal_temp2adc(int temp, int offset, int slope)
  79 {
  80         temp -= offset;
  81         temp /= slope;
  82
  83         if (temp < 0)
  84                 temp = 0;
  85         if (temp >= BIT(BCM2835_TS_TSENSSTAT_DATA_BITS))
  86                 temp = BIT(BCM2835_TS_TSENSSTAT_DATA_BITS) - 1;
  87
  88         return temp;
  89 }
  90
  91 static int bcm2835_thermal_get_temp(void *d, int *temp)
  92 {
  93         struct bcm2835_thermal_data *data = d;
  94         u32 val = readl(data->regs + BCM2835_TS_TSENSSTAT);
  95
  96         if (!(val & BCM2835_TS_TSENSSTAT_VALID))
  97                 return -EIO;
  98
  99         val &= BCM2835_TS_TSENSSTAT_DATA_MASK;
 100
 101         *temp = bcm2835_thermal_adc2temp(
 102                 val,
 103                 thermal_zone_get_offset(data->tz),
 104                 thermal_zone_get_slope(data->tz));
 105
 106         return 0;
 107 }
 108
 109 static const struct debugfs_reg32 bcm2835_thermal_regs[] = {
 110         {
 111                 .name = "ctl",
 112                 .offset = 0
 113         },
 114         {
 115                 .name = "stat",
 116                 .offset = 4
 117         }
 118 };
 119
 120 static void bcm2835_thermal_debugfs(struct platform_device *pdev)
 121 {
 122         struct bcm2835_thermal_data *data = platform_get_drvdata(pdev);
 123         struct debugfs_regset32 *regset;
 124
 125         data->debugfsdir = debugfs_create_dir("bcm2835_thermal", NULL);
 126
 127         regset = devm_kzalloc(&pdev->dev, sizeof(*regset), GFP_KERNEL);
 128         if (!regset)
 129                 return;
 130
 131         regset->regs = bcm2835_thermal_regs;
 132         regset->nregs = ARRAY_SIZE(bcm2835_thermal_regs);
 133         regset->base = data->regs;
 134
 135         debugfs_create_regset32("regset", 0444, data->debugfsdir, regset);
 136 }
 137
 138 static const struct thermal_zone_of_device_ops bcm2835_thermal_ops = {
 139         .get_temp = bcm2835_thermal_get_temp,
 140 };
 141
 142 /*
 143  * Note: as per Raspberry Foundation FAQ
 144  * (https://www.raspberrypi.org/help/faqs/#performanceOperatingTemperature)
 145  * the recommended temperature range for the SoC -40C to +85C
 146  * so the trip limit is set to 80C.
 147  * this applies to all the BCM283X SoC
 148  */
 149
 150 static const struct of_device_id bcm2835_thermal_of_match_table[] = {
 151         {
 152                 .compatible = "brcm,bcm2835-thermal",
 153         },
 154         {
 155                 .compatible = "brcm,bcm2836-thermal",
 156         },
 157         {
 158                 .compatible = "brcm,bcm2837-thermal",
 159         },
 160         {},
 161 };
 162 MODULE_DEVICE_TABLE(of, bcm2835_thermal_of_match_table);
 163
 164 static int bcm2835_thermal_probe(struct platform_device *pdev)
 165 {
 166         const struct of_device_id *match;
 167         struct thermal_zone_device *tz;
 168         struct bcm2835_thermal_data *data;
 169         struct resource *res;
 170         int err = 0;
 171         u32 val;
 172         unsigned long rate;
 173
 174         data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
 175         if (!data)
 176                 return -ENOMEM;
 177
 178         match = of_match_device(bcm2835_thermal_of_match_table,
 179                                 &pdev->dev);
 180         if (!match)
 181                 return -EINVAL;
 182
 183         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 184         data->regs = devm_ioremap_resource(&pdev->dev, res);
 185         if (IS_ERR(data->regs)) {
 186                 err = PTR_ERR(data->regs);
 187                 return err;
 188         }
 189
 190         data->clk = devm_clk_get(&pdev->dev, NULL);
 191         if (IS_ERR(data->clk)) {
 192                 err = PTR_ERR(data->clk);
 193                 if (err != -EPROBE_DEFER)
 194                         dev_err(&pdev->dev, "Could not get clk: %d\n", err);
 195                 return err;
 196         }
 197
 198         err = clk_prepare_enable(data->clk);
 199         if (err)
 200                 return err;
 201
 202         rate = clk_get_rate(data->clk);
 203         if ((rate < 1920000) || (rate > 5000000))
 204                 dev_warn(&pdev->dev,
 205                          "Clock %pCn running at %lu Hz is outside of the recommended range: 1.92 to 5MHz\n",
 206                          data->clk, rate);
 207
 208         /* register of thermal sensor and get info from DT */
 209         tz = thermal_zone_of_sensor_register(&pdev->dev, 0, data,
 210                                              &bcm2835_thermal_ops);
 211         if (IS_ERR(tz)) {
 212                 err = PTR_ERR(tz);
 213                 dev_err(&pdev->dev,
 214                         "Failed to register the thermal device: %d\n",
 215                         err);
 216                 goto err_clk;
 217         }
 218
 219         /*
 220          * right now the FW does set up the HW-block, so we are not
 221          * touching the configuration registers.
 222          * But if the HW is not enabled, then set it up
 223          * using "sane" values used by the firmware right now.
 224          */
 225         val = readl(data->regs + BCM2835_TS_TSENSCTL);
 226         if (!(val & BCM2835_TS_TSENSCTL_RSTB)) {
 227                 int trip_temp, offset, slope;
 228
 229                 slope = thermal_zone_get_slope(tz);
 230                 offset = thermal_zone_get_offset(tz);
 231                 /*
 232                  * For now we deal only with critical, otherwise
 233                  * would need to iterate
 234                  */
 235                 err = tz->ops->get_trip_temp(tz, 0, &trip_temp);
 236                 if (err < 0) {
 237                         dev_err(&pdev->dev,
 238                                 "Not able to read trip_temp: %d\n",
 239                                 err);
 240                         goto err_tz;
 241                 }
 242
 243                 /* set bandgap reference voltage and enable voltage regulator */
 244                 val = (BCM2835_TS_TSENSCTL_CTRL_DEFAULT <<
 245                        BCM2835_TS_TSENSCTL_CTRL_SHIFT) |
 246                       BCM2835_TS_TSENSCTL_REGULEN;
 247
 248                 /* use the recommended reset duration */
 249                 val |= (0xFE << BCM2835_TS_TSENSCTL_RSTDELAY_SHIFT);
 250
 251                 /*  trip_adc value from info */
 252                 val |= bcm2835_thermal_temp2adc(trip_temp,
 253                                                 offset,
 254                                                 slope)
 255                         << BCM2835_TS_TSENSCTL_THOLD_SHIFT;
 256
 257                 /* write the value back to the register as 2 steps */
 258                 writel(val, data->regs + BCM2835_TS_TSENSCTL);
 259                 val |= BCM2835_TS_TSENSCTL_RSTB;
 260                 writel(val, data->regs + BCM2835_TS_TSENSCTL);
 261         }
 262
 263         data->tz = tz;
 264
 265         platform_set_drvdata(pdev, data);
 266
 267         /*
 268          * Thermal_zone doesn't enable hwmon as default,
 269          * enable it here
 270          */
 271         tz->tzp->no_hwmon = false;
 272         err = thermal_add_hwmon_sysfs(tz);
 273         if (err)
 274                 goto err_tz;
 275
 276         bcm2835_thermal_debugfs(pdev);
 277
 278         return 0;
 279 err_tz:
 280         thermal_zone_of_sensor_unregister(&pdev->dev, tz);
 281 err_clk:
 282         clk_disable_unprepare(data->clk);
 283
 284         return err;
 285 }
 286
 287 static int bcm2835_thermal_remove(struct platform_device *pdev)
 288 {
 289         struct bcm2835_thermal_data *data = platform_get_drvdata(pdev);
 290         struct thermal_zone_device *tz = data->tz;
 291
 292         debugfs_remove_recursive(data->debugfsdir);
 293         thermal_zone_of_sensor_unregister(&pdev->dev, tz);
 294         clk_disable_unprepare(data->clk);
 295
 296         return 0;
 297 }
 298
 299 static struct platform_driver bcm2835_thermal_driver = {
 300         .probe = bcm2835_thermal_probe,
 301         .remove = bcm2835_thermal_remove,
 302         .driver = {
 303                 .name = "bcm2835_thermal",
 304                 .of_match_table = bcm2835_thermal_of_match_table,
 305         },
 306 };
 307 module_platform_driver(bcm2835_thermal_driver);
 308
 309 MODULE_AUTHOR("Martin Sperl");
 310 MODULE_DESCRIPTION("Thermal driver for bcm2835 chip");
 311 MODULE_LICENSE("GPL");