drivers/watchdog/qcom-wdt.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /* Copyright (c) 2014, The Linux Foundation. All rights reserved.
   3  */
   4 #include <linux/bits.h>
   5 #include <linux/clk.h>
   6 #include <linux/delay.h>
   7 #include <linux/interrupt.h>
   8 #include <linux/io.h>
   9 #include <linux/kernel.h>
  10 #include <linux/module.h>
  11 #include <linux/of.h>
  12 #include <linux/platform_device.h>
  13 #include <linux/watchdog.h>
  14 #include <linux/of_device.h>
  15
  16 enum wdt_reg {
  17         WDT_RST,
  18         WDT_EN,
  19         WDT_STS,
  20         WDT_BARK_TIME,
  21         WDT_BITE_TIME,
  22 };
  23
  24 #define QCOM_WDT_ENABLE         BIT(0)
  25
  26 static const u32 reg_offset_data_apcs_tmr[] = {
  27         [WDT_RST] = 0x38,
  28         [WDT_EN] = 0x40,
  29         [WDT_STS] = 0x44,
  30         [WDT_BARK_TIME] = 0x4C,
  31         [WDT_BITE_TIME] = 0x5C,
  32 };
  33
  34 static const u32 reg_offset_data_kpss[] = {
  35         [WDT_RST] = 0x4,
  36         [WDT_EN] = 0x8,
  37         [WDT_STS] = 0xC,
  38         [WDT_BARK_TIME] = 0x10,
  39         [WDT_BITE_TIME] = 0x14,
  40 };
  41
  42 struct qcom_wdt_match_data {
  43         const u32 *offset;
  44         bool pretimeout;
  45 };
  46
  47 struct qcom_wdt {
  48         struct watchdog_device  wdd;
  49         unsigned long           rate;
  50         void __iomem            *base;
  51         const u32               *layout;
  52 };
  53
  54 static void __iomem *wdt_addr(struct qcom_wdt *wdt, enum wdt_reg reg)
  55 {
  56         return wdt->base + wdt->layout[reg];
  57 }
  58
  59 static inline
  60 struct qcom_wdt *to_qcom_wdt(struct watchdog_device *wdd)
  61 {
  62         return container_of(wdd, struct qcom_wdt, wdd);
  63 }
  64
  65 static irqreturn_t qcom_wdt_isr(int irq, void *arg)
  66 {
  67         struct watchdog_device *wdd = arg;
  68
  69         watchdog_notify_pretimeout(wdd);
  70
  71         return IRQ_HANDLED;
  72 }
  73
  74 static int qcom_wdt_start(struct watchdog_device *wdd)
  75 {
  76         struct qcom_wdt *wdt = to_qcom_wdt(wdd);
  77         unsigned int bark = wdd->timeout - wdd->pretimeout;
  78
  79         writel(0, wdt_addr(wdt, WDT_EN));
  80         writel(1, wdt_addr(wdt, WDT_RST));
  81         writel(bark * wdt->rate, wdt_addr(wdt, WDT_BARK_TIME));
  82         writel(wdd->timeout * wdt->rate, wdt_addr(wdt, WDT_BITE_TIME));
  83         writel(QCOM_WDT_ENABLE, wdt_addr(wdt, WDT_EN));
  84         return 0;
  85 }
  86
  87 static int qcom_wdt_stop(struct watchdog_device *wdd)
  88 {
  89         struct qcom_wdt *wdt = to_qcom_wdt(wdd);
  90
  91         writel(0, wdt_addr(wdt, WDT_EN));
  92         return 0;
  93 }
  94
  95 static int qcom_wdt_ping(struct watchdog_device *wdd)
  96 {
  97         struct qcom_wdt *wdt = to_qcom_wdt(wdd);
  98
  99         writel(1, wdt_addr(wdt, WDT_RST));
 100         return 0;
 101 }
 102
 103 static int qcom_wdt_set_timeout(struct watchdog_device *wdd,
 104                                 unsigned int timeout)
 105 {
 106         wdd->timeout = timeout;
 107         return qcom_wdt_start(wdd);
 108 }
 109
 110 static int qcom_wdt_set_pretimeout(struct watchdog_device *wdd,
 111                                    unsigned int timeout)
 112 {
 113         wdd->pretimeout = timeout;
 114         return qcom_wdt_start(wdd);
 115 }
 116
 117 static int qcom_wdt_restart(struct watchdog_device *wdd, unsigned long action,
 118                             void *data)
 119 {
 120         struct qcom_wdt *wdt = to_qcom_wdt(wdd);
 121         u32 timeout;
 122
 123         /*
 124          * Trigger watchdog bite:
 125          *    Setup BITE_TIME to be 128ms, and enable WDT.
 126          */
 127         timeout = 128 * wdt->rate / 1000;
 128
 129         writel(0, wdt_addr(wdt, WDT_EN));
 130         writel(1, wdt_addr(wdt, WDT_RST));
 131         writel(timeout, wdt_addr(wdt, WDT_BARK_TIME));
 132         writel(timeout, wdt_addr(wdt, WDT_BITE_TIME));
 133         writel(QCOM_WDT_ENABLE, wdt_addr(wdt, WDT_EN));
 134
 135         /*
 136          * Actually make sure the above sequence hits hardware before sleeping.
 137          */
 138         wmb();
 139
 140         mdelay(150);
 141         return 0;
 142 }
 143
 144 static int qcom_wdt_is_running(struct watchdog_device *wdd)
 145 {
 146         struct qcom_wdt *wdt = to_qcom_wdt(wdd);
 147
 148         return (readl(wdt_addr(wdt, WDT_EN)) & QCOM_WDT_ENABLE);
 149 }
 150
 151 static const struct watchdog_ops qcom_wdt_ops = {
 152         .start          = qcom_wdt_start,
 153         .stop           = qcom_wdt_stop,
 154         .ping           = qcom_wdt_ping,
 155         .set_timeout    = qcom_wdt_set_timeout,
 156         .set_pretimeout = qcom_wdt_set_pretimeout,
 157         .restart        = qcom_wdt_restart,
 158         .owner          = THIS_MODULE,
 159 };
 160
 161 static const struct watchdog_info qcom_wdt_info = {
 162         .options        = WDIOF_KEEPALIVEPING
 163                         | WDIOF_MAGICCLOSE
 164                         | WDIOF_SETTIMEOUT
 165                         | WDIOF_CARDRESET,
 166         .identity       = KBUILD_MODNAME,
 167 };
 168
 169 static const struct watchdog_info qcom_wdt_pt_info = {
 170         .options        = WDIOF_KEEPALIVEPING
 171                         | WDIOF_MAGICCLOSE
 172                         | WDIOF_SETTIMEOUT
 173                         | WDIOF_PRETIMEOUT
 174                         | WDIOF_CARDRESET,
 175         .identity       = KBUILD_MODNAME,
 176 };
 177
 178 static const struct qcom_wdt_match_data match_data_apcs_tmr = {
 179         .offset = reg_offset_data_apcs_tmr,
 180         .pretimeout = false,
 181 };
 182
 183 static const struct qcom_wdt_match_data match_data_kpss = {
 184         .offset = reg_offset_data_kpss,
 185         .pretimeout = true,
 186 };
 187
 188 static int qcom_wdt_probe(struct platform_device *pdev)
 189 {
 190         struct device *dev = &pdev->dev;
 191         struct qcom_wdt *wdt;
 192         struct resource *res;
 193         struct device_node *np = dev->of_node;
 194         const struct qcom_wdt_match_data *data;
 195         u32 percpu_offset;
 196         int irq, ret;
 197         struct clk *clk;
 198
 199         data = of_device_get_match_data(dev);
 200         if (!data) {
 201                 dev_err(dev, "Unsupported QCOM WDT module\n");
 202                 return -ENODEV;
 203         }
 204
 205         wdt = devm_kzalloc(dev, sizeof(*wdt), GFP_KERNEL);
 206         if (!wdt)
 207                 return -ENOMEM;
 208
 209         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 210         if (!res)
 211                 return -ENOMEM;
 212
 213         /* We use CPU0's DGT for the watchdog */
 214         if (of_property_read_u32(np, "cpu-offset", &percpu_offset))
 215                 percpu_offset = 0;
 216
 217         res->start += percpu_offset;
 218         res->end += percpu_offset;
 219
 220         wdt->base = devm_ioremap_resource(dev, res);
 221         if (IS_ERR(wdt->base))
 222                 return PTR_ERR(wdt->base);
 223
 224         clk = devm_clk_get_enabled(dev, NULL);
 225         if (IS_ERR(clk)) {
 226                 dev_err(dev, "failed to get input clock\n");
 227                 return PTR_ERR(clk);
 228         }
 229
 230         /*
 231          * We use the clock rate to calculate the max timeout, so ensure it's
 232          * not zero to avoid a divide-by-zero exception.
 233          *
 234          * WATCHDOG_CORE assumes units of seconds, if the WDT is clocked such
 235          * that it would bite before a second elapses it's usefulness is
 236          * limited.  Bail if this is the case.
 237          */
 238         wdt->rate = clk_get_rate(clk);
 239         if (wdt->rate == 0 ||
 240             wdt->rate > 0x10000000U) {
 241                 dev_err(dev, "invalid clock rate\n");
 242                 return -EINVAL;
 243         }
 244
 245         /* check if there is pretimeout support */
 246         irq = platform_get_irq_optional(pdev, 0);
 247         if (data->pretimeout && irq > 0) {
 248                 ret = devm_request_irq(dev, irq, qcom_wdt_isr, 0,
 249                                        "wdt_bark", &wdt->wdd);
 250                 if (ret)
 251                         return ret;
 252
 253                 wdt->wdd.info = &qcom_wdt_pt_info;
 254                 wdt->wdd.pretimeout = 1;
 255         } else {
 256                 if (irq == -EPROBE_DEFER)
 257                         return -EPROBE_DEFER;
 258
 259                 wdt->wdd.info = &qcom_wdt_info;
 260         }
 261
 262         wdt->wdd.ops = &qcom_wdt_ops;
 263         wdt->wdd.min_timeout = 1;
 264         wdt->wdd.max_timeout = 0x10000000U / wdt->rate;
 265         wdt->wdd.parent = dev;
 266         wdt->layout = data->offset;
 267
 268         if (readl(wdt_addr(wdt, WDT_STS)) & 1)
 269                 wdt->wdd.bootstatus = WDIOF_CARDRESET;
 270
 271         /*
 272          * If 'timeout-sec' unspecified in devicetree, assume a 30 second
 273          * default, unless the max timeout is less than 30 seconds, then use
 274          * the max instead.
 275          */
 276         wdt->wdd.timeout = min(wdt->wdd.max_timeout, 30U);
 277         watchdog_init_timeout(&wdt->wdd, 0, dev);
 278
 279         /*
 280          * If WDT is already running, call WDT start which
 281          * will stop the WDT, set timeouts as bootloader
 282          * might use different ones and set running bit
 283          * to inform the WDT subsystem to ping the WDT
 284          */
 285         if (qcom_wdt_is_running(&wdt->wdd)) {
 286                 qcom_wdt_start(&wdt->wdd);
 287                 set_bit(WDOG_HW_RUNNING, &wdt->wdd.status);
 288         }
 289
 290         ret = devm_watchdog_register_device(dev, &wdt->wdd);
 291         if (ret)
 292                 return ret;
 293
 294         platform_set_drvdata(pdev, wdt);
 295         return 0;
 296 }
 297
 298 static int __maybe_unused qcom_wdt_suspend(struct device *dev)
 299 {
 300         struct qcom_wdt *wdt = dev_get_drvdata(dev);
 301
 302         if (watchdog_active(&wdt->wdd))
 303                 qcom_wdt_stop(&wdt->wdd);
 304
 305         return 0;
 306 }
 307
 308 static int __maybe_unused qcom_wdt_resume(struct device *dev)
 309 {
 310         struct qcom_wdt *wdt = dev_get_drvdata(dev);
 311
 312         if (watchdog_active(&wdt->wdd))
 313                 qcom_wdt_start(&wdt->wdd);
 314
 315         return 0;
 316 }
 317
 318 static const struct dev_pm_ops qcom_wdt_pm_ops = {
 319         SET_LATE_SYSTEM_SLEEP_PM_OPS(qcom_wdt_suspend, qcom_wdt_resume)
 320 };
 321
 322 static const struct of_device_id qcom_wdt_of_table[] = {
 323         { .compatible = "qcom,kpss-timer", .data = &match_data_apcs_tmr },
 324         { .compatible = "qcom,scss-timer", .data = &match_data_apcs_tmr },
 325         { .compatible = "qcom,kpss-wdt", .data = &match_data_kpss },
 326         { },
 327 };
 328 MODULE_DEVICE_TABLE(of, qcom_wdt_of_table);
 329
 330 static struct platform_driver qcom_watchdog_driver = {
 331         .probe  = qcom_wdt_probe,
 332         .driver = {
 333                 .name           = KBUILD_MODNAME,
 334                 .of_match_table = qcom_wdt_of_table,
 335                 .pm             = &qcom_wdt_pm_ops,
 336         },
 337 };
 338 module_platform_driver(qcom_watchdog_driver);
 339
 340 MODULE_DESCRIPTION("QCOM KPSS Watchdog Driver");
 341 MODULE_LICENSE("GPL v2");