drivers/watchdog/omap_wdt.c

   1 /*
   2  * omap_wdt.c
   3  *
   4  * Watchdog driver for the TI OMAP 16xx & 24xx/34xx 32KHz (non-secure) watchdog
   5  *
   6  * Author: MontaVista Software, Inc.
   7  *       <gdavis@mvista.com> or <source@mvista.com>
   8  *
   9  * 2003 (c) MontaVista Software, Inc. This file is licensed under the
  10  * terms of the GNU General Public License version 2. This program is
  11  * licensed "as is" without any warranty of any kind, whether express
  12  * or implied.
  13  *
  14  * History:
  15  *
  16  * 20030527: George G. Davis <gdavis@mvista.com>
  17  *      Initially based on linux-2.4.19-rmk7-pxa1/drivers/char/sa1100_wdt.c
  18  *      (c) Copyright 2000 Oleg Drokin <green@crimea.edu>
  19  *      Based on SoftDog driver by Alan Cox <alan@lxorguk.ukuu.org.uk>
  20  *
  21  * Copyright (c) 2004 Texas Instruments.
  22  *      1. Modified to support OMAP1610 32-KHz watchdog timer
  23  *      2. Ported to 2.6 kernel
  24  *
  25  * Copyright (c) 2005 David Brownell
  26  *      Use the driver model and standard identifiers; handle bigger timeouts.
  27  */
  28
  29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  30
  31 #include <linux/module.h>
  32 #include <linux/types.h>
  33 #include <linux/kernel.h>
  34 #include <linux/fs.h>
  35 #include <linux/mm.h>
  36 #include <linux/miscdevice.h>
  37 #include <linux/watchdog.h>
  38 #include <linux/reboot.h>
  39 #include <linux/init.h>
  40 #include <linux/err.h>
  41 #include <linux/platform_device.h>
  42 #include <linux/moduleparam.h>
  43 #include <linux/bitops.h>
  44 #include <linux/io.h>
  45 #include <linux/uaccess.h>
  46 #include <linux/slab.h>
  47 #include <linux/pm_runtime.h>
  48 #include <mach/hardware.h>
  49
  50 #include <linux/platform_data/omap-wd-timer.h>
  51
  52 #include "omap_wdt.h"
  53
  54 static struct platform_device *omap_wdt_dev;
  55
  56 static unsigned timer_margin;
  57 module_param(timer_margin, uint, 0);
  58 MODULE_PARM_DESC(timer_margin, "initial watchdog timeout (in seconds)");
  59
  60 static unsigned int wdt_trgr_pattern = 0x1234;
  61 static DEFINE_SPINLOCK(wdt_lock);
  62
  63 struct omap_wdt_dev {
  64         void __iomem    *base;          /* physical */
  65         struct device   *dev;
  66         int             omap_wdt_users;
  67         struct resource *mem;
  68         struct miscdevice omap_wdt_miscdev;
  69 };
  70
  71 static void omap_wdt_ping(struct omap_wdt_dev *wdev)
  72 {
  73         void __iomem    *base = wdev->base;
  74
  75         /* wait for posted write to complete */
  76         while ((__raw_readl(base + OMAP_WATCHDOG_WPS)) & 0x08)
  77                 cpu_relax();
  78
  79         wdt_trgr_pattern = ~wdt_trgr_pattern;
  80         __raw_writel(wdt_trgr_pattern, (base + OMAP_WATCHDOG_TGR));
  81
  82         /* wait for posted write to complete */
  83         while ((__raw_readl(base + OMAP_WATCHDOG_WPS)) & 0x08)
  84                 cpu_relax();
  85         /* reloaded WCRR from WLDR */
  86 }
  87
  88 static void omap_wdt_enable(struct omap_wdt_dev *wdev)
  89 {
  90         void __iomem *base = wdev->base;
  91
  92         /* Sequence to enable the watchdog */
  93         __raw_writel(0xBBBB, base + OMAP_WATCHDOG_SPR);
  94         while ((__raw_readl(base + OMAP_WATCHDOG_WPS)) & 0x10)
  95                 cpu_relax();
  96
  97         __raw_writel(0x4444, base + OMAP_WATCHDOG_SPR);
  98         while ((__raw_readl(base + OMAP_WATCHDOG_WPS)) & 0x10)
  99                 cpu_relax();
 100 }
 101
 102 static void omap_wdt_disable(struct omap_wdt_dev *wdev)
 103 {
 104         void __iomem *base = wdev->base;
 105
 106         /* sequence required to disable watchdog */
 107         __raw_writel(0xAAAA, base + OMAP_WATCHDOG_SPR); /* TIMER_MODE */
 108         while (__raw_readl(base + OMAP_WATCHDOG_WPS) & 0x10)
 109                 cpu_relax();
 110
 111         __raw_writel(0x5555, base + OMAP_WATCHDOG_SPR); /* TIMER_MODE */
 112         while (__raw_readl(base + OMAP_WATCHDOG_WPS) & 0x10)
 113                 cpu_relax();
 114 }
 115
 116 static void omap_wdt_adjust_timeout(unsigned new_timeout)
 117 {
 118         if (new_timeout < TIMER_MARGIN_MIN)
 119                 new_timeout = TIMER_MARGIN_DEFAULT;
 120         if (new_timeout > TIMER_MARGIN_MAX)
 121                 new_timeout = TIMER_MARGIN_MAX;
 122         timer_margin = new_timeout;
 123 }
 124
 125 static void omap_wdt_set_timeout(struct omap_wdt_dev *wdev)
 126 {
 127         u32 pre_margin = GET_WLDR_VAL(timer_margin);
 128         void __iomem *base = wdev->base;
 129
 130         /* just count up at 32 KHz */
 131         while (__raw_readl(base + OMAP_WATCHDOG_WPS) & 0x04)
 132                 cpu_relax();
 133
 134         __raw_writel(pre_margin, base + OMAP_WATCHDOG_LDR);
 135         while (__raw_readl(base + OMAP_WATCHDOG_WPS) & 0x04)
 136                 cpu_relax();
 137 }
 138
 139 /*
 140  *      Allow only one task to hold it open
 141  */
 142 static int omap_wdt_open(struct inode *inode, struct file *file)
 143 {
 144         struct omap_wdt_dev *wdev = platform_get_drvdata(omap_wdt_dev);
 145         void __iomem *base = wdev->base;
 146
 147         if (test_and_set_bit(1, (unsigned long *)&(wdev->omap_wdt_users)))
 148                 return -EBUSY;
 149
 150         pm_runtime_get_sync(wdev->dev);
 151
 152         /* initialize prescaler */
 153         while (__raw_readl(base + OMAP_WATCHDOG_WPS) & 0x01)
 154                 cpu_relax();
 155
 156         __raw_writel((1 << 5) | (PTV << 2), base + OMAP_WATCHDOG_CNTRL);
 157         while (__raw_readl(base + OMAP_WATCHDOG_WPS) & 0x01)
 158                 cpu_relax();
 159
 160         file->private_data = (void *) wdev;
 161
 162         omap_wdt_set_timeout(wdev);
 163         omap_wdt_ping(wdev); /* trigger loading of new timeout value */
 164         omap_wdt_enable(wdev);
 165
 166         return nonseekable_open(inode, file);
 167 }
 168
 169 static int omap_wdt_release(struct inode *inode, struct file *file)
 170 {
 171         struct omap_wdt_dev *wdev = file->private_data;
 172
 173         /*
 174          *      Shut off the timer unless NOWAYOUT is defined.
 175          */
 176 #ifndef CONFIG_WATCHDOG_NOWAYOUT
 177         omap_wdt_disable(wdev);
 178
 179         pm_runtime_put_sync(wdev->dev);
 180 #else
 181         pr_crit("Unexpected close, not stopping!\n");
 182 #endif
 183         wdev->omap_wdt_users = 0;
 184
 185         return 0;
 186 }
 187
 188 static ssize_t omap_wdt_write(struct file *file, const char __user *data,
 189                 size_t len, loff_t *ppos)
 190 {
 191         struct omap_wdt_dev *wdev = file->private_data;
 192
 193         /* Refresh LOAD_TIME. */
 194         if (len) {
 195                 spin_lock(&wdt_lock);
 196                 omap_wdt_ping(wdev);
 197                 spin_unlock(&wdt_lock);
 198         }
 199         return len;
 200 }
 201
 202 static long omap_wdt_ioctl(struct file *file, unsigned int cmd,
 203                                                 unsigned long arg)
 204 {
 205         struct omap_wd_timer_platform_data *pdata;
 206         struct omap_wdt_dev *wdev;
 207         u32 rs;
 208         int new_margin, bs;
 209         static const struct watchdog_info ident = {
 210                 .identity = "OMAP Watchdog",
 211                 .options = WDIOF_SETTIMEOUT,
 212                 .firmware_version = 0,
 213         };
 214
 215         wdev = file->private_data;
 216         pdata = wdev->dev->platform_data;
 217
 218         switch (cmd) {
 219         case WDIOC_GETSUPPORT:
 220                 return copy_to_user((struct watchdog_info __user *)arg, &ident,
 221                                 sizeof(ident));
 222         case WDIOC_GETSTATUS:
 223                 return put_user(0, (int __user *)arg);
 224         case WDIOC_GETBOOTSTATUS:
 225                 if (!pdata || !pdata->read_reset_sources)
 226                         return put_user(0, (int __user *)arg);
 227                 rs = pdata->read_reset_sources();
 228                 bs = (rs & (1 << OMAP_MPU_WD_RST_SRC_ID_SHIFT)) ?
 229                         WDIOF_CARDRESET : 0;
 230                 return put_user(bs, (int __user *)arg);
 231         case WDIOC_KEEPALIVE:
 232                 spin_lock(&wdt_lock);
 233                 omap_wdt_ping(wdev);
 234                 spin_unlock(&wdt_lock);
 235                 return 0;
 236         case WDIOC_SETTIMEOUT:
 237                 if (get_user(new_margin, (int __user *)arg))
 238                         return -EFAULT;
 239                 omap_wdt_adjust_timeout(new_margin);
 240
 241                 spin_lock(&wdt_lock);
 242                 omap_wdt_disable(wdev);
 243                 omap_wdt_set_timeout(wdev);
 244                 omap_wdt_enable(wdev);
 245
 246                 omap_wdt_ping(wdev);
 247                 spin_unlock(&wdt_lock);
 248                 /* Fall */
 249         case WDIOC_GETTIMEOUT:
 250                 return put_user(timer_margin, (int __user *)arg);
 251         default:
 252                 return -ENOTTY;
 253         }
 254 }
 255
 256 static const struct file_operations omap_wdt_fops = {
 257         .owner = THIS_MODULE,
 258         .write = omap_wdt_write,
 259         .unlocked_ioctl = omap_wdt_ioctl,
 260         .open = omap_wdt_open,
 261         .release = omap_wdt_release,
 262         .llseek = no_llseek,
 263 };
 264
 265 static int __devinit omap_wdt_probe(struct platform_device *pdev)
 266 {
 267         struct resource *res, *mem;
 268         struct omap_wdt_dev *wdev;
 269         int ret;
 270
 271         /* reserve static register mappings */
 272         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 273         if (!res) {
 274                 ret = -ENOENT;
 275                 goto err_get_resource;
 276         }
 277
 278         if (omap_wdt_dev) {
 279                 ret = -EBUSY;
 280                 goto err_busy;
 281         }
 282
 283         mem = request_mem_region(res->start, resource_size(res), pdev->name);
 284         if (!mem) {
 285                 ret = -EBUSY;
 286                 goto err_busy;
 287         }
 288
 289         wdev = kzalloc(sizeof(struct omap_wdt_dev), GFP_KERNEL);
 290         if (!wdev) {
 291                 ret = -ENOMEM;
 292                 goto err_kzalloc;
 293         }
 294
 295         wdev->omap_wdt_users = 0;
 296         wdev->mem = mem;
 297         wdev->dev = &pdev->dev;
 298
 299         wdev->base = ioremap(res->start, resource_size(res));
 300         if (!wdev->base) {
 301                 ret = -ENOMEM;
 302                 goto err_ioremap;
 303         }
 304
 305         platform_set_drvdata(pdev, wdev);
 306
 307         pm_runtime_enable(wdev->dev);
 308         pm_runtime_get_sync(wdev->dev);
 309
 310         omap_wdt_disable(wdev);
 311         omap_wdt_adjust_timeout(timer_margin);
 312
 313         wdev->omap_wdt_miscdev.parent = &pdev->dev;
 314         wdev->omap_wdt_miscdev.minor = WATCHDOG_MINOR;
 315         wdev->omap_wdt_miscdev.name = "watchdog";
 316         wdev->omap_wdt_miscdev.fops = &omap_wdt_fops;
 317
 318         ret = misc_register(&(wdev->omap_wdt_miscdev));
 319         if (ret)
 320                 goto err_misc;
 321
 322         pr_info("OMAP Watchdog Timer Rev 0x%02x: initial timeout %d sec\n",
 323                 __raw_readl(wdev->base + OMAP_WATCHDOG_REV) & 0xFF,
 324                 timer_margin);
 325
 326         pm_runtime_put_sync(wdev->dev);
 327
 328         omap_wdt_dev = pdev;
 329
 330         return 0;
 331
 332 err_misc:
 333         pm_runtime_disable(wdev->dev);
 334         platform_set_drvdata(pdev, NULL);
 335         iounmap(wdev->base);
 336
 337 err_ioremap:
 338         wdev->base = NULL;
 339         kfree(wdev);
 340
 341 err_kzalloc:
 342         release_mem_region(res->start, resource_size(res));
 343
 344 err_busy:
 345 err_get_resource:
 346
 347         return ret;
 348 }
 349
 350 static void omap_wdt_shutdown(struct platform_device *pdev)
 351 {
 352         struct omap_wdt_dev *wdev = platform_get_drvdata(pdev);
 353
 354         if (wdev->omap_wdt_users) {
 355                 omap_wdt_disable(wdev);
 356                 pm_runtime_put_sync(wdev->dev);
 357         }
 358 }
 359
 360 static int __devexit omap_wdt_remove(struct platform_device *pdev)
 361 {
 362         struct omap_wdt_dev *wdev = platform_get_drvdata(pdev);
 363         struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 364
 365         pm_runtime_disable(wdev->dev);
 366         if (!res)
 367                 return -ENOENT;
 368
 369         misc_deregister(&(wdev->omap_wdt_miscdev));
 370         release_mem_region(res->start, resource_size(res));
 371         platform_set_drvdata(pdev, NULL);
 372
 373         iounmap(wdev->base);
 374
 375         kfree(wdev);
 376         omap_wdt_dev = NULL;
 377
 378         return 0;
 379 }
 380
 381 #ifdef  CONFIG_PM
 382
 383 /* REVISIT ... not clear this is the best way to handle system suspend; and
 384  * it's very inappropriate for selective device suspend (e.g. suspending this
 385  * through sysfs rather than by stopping the watchdog daemon).  Also, this
 386  * may not play well enough with NOWAYOUT...
 387  */
 388
 389 static int omap_wdt_suspend(struct platform_device *pdev, pm_message_t state)
 390 {
 391         struct omap_wdt_dev *wdev = platform_get_drvdata(pdev);
 392
 393         if (wdev->omap_wdt_users) {
 394                 omap_wdt_disable(wdev);
 395                 pm_runtime_put_sync(wdev->dev);
 396         }
 397
 398         return 0;
 399 }
 400
 401 static int omap_wdt_resume(struct platform_device *pdev)
 402 {
 403         struct omap_wdt_dev *wdev = platform_get_drvdata(pdev);
 404
 405         if (wdev->omap_wdt_users) {
 406                 pm_runtime_get_sync(wdev->dev);
 407                 omap_wdt_enable(wdev);
 408                 omap_wdt_ping(wdev);
 409         }
 410
 411         return 0;
 412 }
 413
 414 #else
 415 #define omap_wdt_suspend        NULL
 416 #define omap_wdt_resume         NULL
 417 #endif
 418
 419 static const struct of_device_id omap_wdt_of_match[] = {
 420         { .compatible = "ti,omap3-wdt", },
 421         {},
 422 };
 423 MODULE_DEVICE_TABLE(of, omap_wdt_of_match);
 424
 425 static struct platform_driver omap_wdt_driver = {
 426         .probe          = omap_wdt_probe,
 427         .remove         = __devexit_p(omap_wdt_remove),
 428         .shutdown       = omap_wdt_shutdown,
 429         .suspend        = omap_wdt_suspend,
 430         .resume         = omap_wdt_resume,
 431         .driver         = {
 432                 .owner  = THIS_MODULE,
 433                 .name   = "omap_wdt",
 434                 .of_match_table = omap_wdt_of_match,
 435         },
 436 };
 437
 438 module_platform_driver(omap_wdt_driver);
 439
 440 MODULE_AUTHOR("George G. Davis");
 441 MODULE_LICENSE("GPL");
 442 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
 443 MODULE_ALIAS("platform:omap_wdt");