drivers/watchdog/ixp4xx_wdt.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * drivers/char/watchdog/ixp4xx_wdt.c
   4  *
   5  * Watchdog driver for Intel IXP4xx network processors
   6  *
   7  * Author: Deepak Saxena <dsaxena@plexity.net>
   8  * Author: Linus Walleij <linus.walleij@linaro.org>
   9  *
  10  * Copyright 2004 (c) MontaVista, Software, Inc.
  11  * Based on sa1100 driver, Copyright (C) 2000 Oleg Drokin <green@crimea.edu>
  12  */
  13
  14 #include <linux/module.h>
  15 #include <linux/types.h>
  16 #include <linux/kernel.h>
  17 #include <linux/watchdog.h>
  18 #include <linux/bits.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/clk.h>
  21 #include <linux/soc/ixp4xx/cpu.h>
  22
  23 struct ixp4xx_wdt {
  24         struct watchdog_device wdd;
  25         void __iomem *base;
  26         unsigned long rate;
  27 };
  28
  29 /* Fallback if we do not have a clock for this */
  30 #define IXP4XX_TIMER_FREQ       66666000
  31
  32 /* Registers after the timer registers */
  33 #define IXP4XX_OSWT_OFFSET      0x14  /* Watchdog Timer */
  34 #define IXP4XX_OSWE_OFFSET      0x18  /* Watchdog Enable */
  35 #define IXP4XX_OSWK_OFFSET      0x1C  /* Watchdog Key */
  36 #define IXP4XX_OSST_OFFSET      0x20  /* Timer Status */
  37
  38 #define IXP4XX_OSST_TIMER_WDOG_PEND     0x00000008
  39 #define IXP4XX_OSST_TIMER_WARM_RESET    0x00000010
  40 #define IXP4XX_WDT_KEY                  0x0000482E
  41 #define IXP4XX_WDT_RESET_ENABLE         0x00000001
  42 #define IXP4XX_WDT_IRQ_ENABLE           0x00000002
  43 #define IXP4XX_WDT_COUNT_ENABLE         0x00000004
  44
  45 static inline
  46 struct ixp4xx_wdt *to_ixp4xx_wdt(struct watchdog_device *wdd)
  47 {
  48         return container_of(wdd, struct ixp4xx_wdt, wdd);
  49 }
  50
  51 static int ixp4xx_wdt_start(struct watchdog_device *wdd)
  52 {
  53         struct ixp4xx_wdt *iwdt = to_ixp4xx_wdt(wdd);
  54
  55         __raw_writel(IXP4XX_WDT_KEY, iwdt->base + IXP4XX_OSWK_OFFSET);
  56         __raw_writel(0, iwdt->base + IXP4XX_OSWE_OFFSET);
  57         __raw_writel(wdd->timeout * iwdt->rate,
  58                      iwdt->base + IXP4XX_OSWT_OFFSET);
  59         __raw_writel(IXP4XX_WDT_COUNT_ENABLE | IXP4XX_WDT_RESET_ENABLE,
  60                      iwdt->base + IXP4XX_OSWE_OFFSET);
  61         __raw_writel(0, iwdt->base + IXP4XX_OSWK_OFFSET);
  62
  63         return 0;
  64 }
  65
  66 static int ixp4xx_wdt_stop(struct watchdog_device *wdd)
  67 {
  68         struct ixp4xx_wdt *iwdt = to_ixp4xx_wdt(wdd);
  69
  70         __raw_writel(IXP4XX_WDT_KEY, iwdt->base + IXP4XX_OSWK_OFFSET);
  71         __raw_writel(0, iwdt->base + IXP4XX_OSWE_OFFSET);
  72         __raw_writel(0, iwdt->base + IXP4XX_OSWK_OFFSET);
  73
  74         return 0;
  75 }
  76
  77 static int ixp4xx_wdt_set_timeout(struct watchdog_device *wdd,
  78                                   unsigned int timeout)
  79 {
  80         wdd->timeout = timeout;
  81         if (watchdog_active(wdd))
  82                 ixp4xx_wdt_start(wdd);
  83
  84         return 0;
  85 }
  86
  87 static int ixp4xx_wdt_restart(struct watchdog_device *wdd,
  88                               unsigned long action, void *data)
  89 {
  90         struct ixp4xx_wdt *iwdt = to_ixp4xx_wdt(wdd);
  91
  92         __raw_writel(IXP4XX_WDT_KEY, iwdt->base + IXP4XX_OSWK_OFFSET);
  93         __raw_writel(0, iwdt->base + IXP4XX_OSWT_OFFSET);
  94         __raw_writel(IXP4XX_WDT_COUNT_ENABLE | IXP4XX_WDT_RESET_ENABLE,
  95                      iwdt->base + IXP4XX_OSWE_OFFSET);
  96
  97         return 0;
  98 }
  99
 100 static const struct watchdog_ops ixp4xx_wdt_ops = {
 101         .start = ixp4xx_wdt_start,
 102         .stop = ixp4xx_wdt_stop,
 103         .set_timeout = ixp4xx_wdt_set_timeout,
 104         .restart = ixp4xx_wdt_restart,
 105         .owner = THIS_MODULE,
 106 };
 107
 108 /*
 109  * The A0 version of the IXP422 had a bug in the watchdog making
 110  * is useless, but we still need to use it to restart the system
 111  * as it is the only way, so in this special case we register a
 112  * "dummy" watchdog that doesn't really work, but will support
 113  * the restart operation.
 114  */
 115 static int ixp4xx_wdt_dummy(struct watchdog_device *wdd)
 116 {
 117         return 0;
 118 }
 119
 120 static const struct watchdog_ops ixp4xx_wdt_restart_only_ops = {
 121         .start = ixp4xx_wdt_dummy,
 122         .stop = ixp4xx_wdt_dummy,
 123         .restart = ixp4xx_wdt_restart,
 124         .owner = THIS_MODULE,
 125 };
 126
 127 static const struct watchdog_info ixp4xx_wdt_info = {
 128         .options = WDIOF_KEEPALIVEPING
 129                 | WDIOF_MAGICCLOSE
 130                 | WDIOF_SETTIMEOUT,
 131         .identity = KBUILD_MODNAME,
 132 };
 133
 134 /* Devres-handled clock disablement */
 135 static void ixp4xx_clock_action(void *d)
 136 {
 137         clk_disable_unprepare(d);
 138 }
 139
 140 static int ixp4xx_wdt_probe(struct platform_device *pdev)
 141 {
 142         static const struct watchdog_ops *iwdt_ops;
 143         struct device *dev = &pdev->dev;
 144         struct ixp4xx_wdt *iwdt;
 145         struct clk *clk;
 146         int ret;
 147
 148         if (!(read_cpuid_id() & 0xf) && !cpu_is_ixp46x()) {
 149                 dev_info(dev, "Rev. A0 IXP42x CPU detected - only restart supported\n");
 150                 iwdt_ops = &ixp4xx_wdt_restart_only_ops;
 151         } else {
 152                 iwdt_ops = &ixp4xx_wdt_ops;
 153         }
 154
 155         iwdt = devm_kzalloc(dev, sizeof(*iwdt), GFP_KERNEL);
 156         if (!iwdt)
 157                 return -ENOMEM;
 158         iwdt->base = (void __iomem *)dev->platform_data;
 159
 160         /*
 161          * Retrieve rate from a fixed clock from the device tree if
 162          * the parent has that, else use the default clock rate.
 163          */
 164         clk = devm_clk_get(dev->parent, NULL);
 165         if (!IS_ERR(clk)) {
 166                 ret = clk_prepare_enable(clk);
 167                 if (ret)
 168                         return ret;
 169                 ret = devm_add_action_or_reset(dev, ixp4xx_clock_action, clk);
 170                 if (ret)
 171                         return ret;
 172                 iwdt->rate = clk_get_rate(clk);
 173         }
 174         if (!iwdt->rate)
 175                 iwdt->rate = IXP4XX_TIMER_FREQ;
 176
 177         iwdt->wdd.info = &ixp4xx_wdt_info;
 178         iwdt->wdd.ops = iwdt_ops;
 179         iwdt->wdd.min_timeout = 1;
 180         iwdt->wdd.max_timeout = U32_MAX / iwdt->rate;
 181         iwdt->wdd.parent = dev;
 182         /* Default to 60 seconds */
 183         iwdt->wdd.timeout = 60U;
 184         watchdog_init_timeout(&iwdt->wdd, 0, dev);
 185
 186         if (__raw_readl(iwdt->base + IXP4XX_OSST_OFFSET) &
 187             IXP4XX_OSST_TIMER_WARM_RESET)
 188                 iwdt->wdd.bootstatus = WDIOF_CARDRESET;
 189
 190         ret = devm_watchdog_register_device(dev, &iwdt->wdd);
 191         if (ret)
 192                 return ret;
 193
 194         dev_info(dev, "IXP4xx watchdog available\n");
 195
 196         return 0;
 197 }
 198
 199 static struct platform_driver ixp4xx_wdt_driver = {
 200         .probe = ixp4xx_wdt_probe,
 201         .driver = {
 202                 .name   = "ixp4xx-watchdog",
 203         },
 204 };
 205 module_platform_driver(ixp4xx_wdt_driver);
 206
 207 MODULE_AUTHOR("Deepak Saxena <dsaxena@plexity.net>");
 208 MODULE_DESCRIPTION("IXP4xx Network Processor Watchdog");
 209 MODULE_LICENSE("GPL");