Release 4.12 drivers/watchdog/shwdt.c

/*
 * drivers/watchdog/shwdt.c
 *
 * Watchdog driver for integrated watchdog in the SuperH processors.
 *
 * Copyright (C) 2001 - 2012  Paul Mundt <lethal@linux-sh.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * 14-Dec-2001 Matt Domsch <Matt_Domsch@dell.com>
 *     Added nowayout module option to override CONFIG_WATCHDOG_NOWAYOUT
 *
 * 19-Apr-2002 Rob Radez <rob@osinvestor.com>
 *     Added expect close support, made emulated timeout runtime changeable
 *     general cleanups, add some ioctls
 */


#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/platform_device.h>
#include <linux/init.h>
#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/watchdog.h>
#include <linux/pm_runtime.h>
#include <linux/fs.h>
#include <linux/mm.h>
#include <linux/slab.h>
#include <linux/io.h>
#include <linux/clk.h>
#include <linux/err.h>
#include <asm/watchdog.h>


#define DRV_NAME "sh-wdt"

/*
 * Default clock division ratio is 5.25 msecs. For an additional table of
 * values, consult the asm-sh/watchdog.h. Overload this at module load
 * time.
 *
 * In order for this to work reliably we need to have HZ set to 1000 or
 * something quite higher than 100 (or we need a proper high-res timer
 * implementation that will deal with this properly), otherwise the 10ms
 * resolution of a jiffy is enough to trigger the overflow. For things like
 * the SH-4 and SH-5, this isn't necessarily that big of a problem, though
 * for the SH-2 and SH-3, this isn't recommended unless the WDT is absolutely
 * necssary.
 *
 * As a result of this timing problem, the only modes that are particularly
 * feasible are the 4096 and the 2048 divisors, which yield 5.25 and 2.62ms
 * overflow periods respectively.
 *
 * Also, since we can't really expect userspace to be responsive enough
 * before the overflow happens, we maintain two separate timers .. One in
 * the kernel for clearing out WOVF every 2ms or so (again, this depends on
 * HZ == 1000), and another for monitoring userspace writes to the WDT device.
 *
 * As such, we currently use a configurable heartbeat interval which defaults
 * to 30s. In this case, the userspace daemon is only responsible for periodic
 * writes to the device before the next heartbeat is scheduled. If the daemon
 * misses its deadline, the kernel timer will allow the WDT to overflow.
 */

static int clock_division_ratio = WTCSR_CKS_4096;

#define next_ping_period(cks)	(jiffies + msecs_to_jiffies(cks - 4))


#define WATCHDOG_HEARTBEAT 30			
/* 30 sec default heartbeat */

static int heartbeat = WATCHDOG_HEARTBEAT;	
/* in seconds */

static bool nowayout = WATCHDOG_NOWAYOUT;

static unsigned long next_heartbeat;


struct sh_wdt {
	
void __iomem		*base;
	
struct device		*dev;
	
struct clk		*clk;
	
spinlock_t		lock;

	
struct timer_list	timer;
};



static int sh_wdt_start(struct watchdog_device *wdt_dev)
{
	struct sh_wdt *wdt = watchdog_get_drvdata(wdt_dev);
	unsigned long flags;
	u8 csr;

	pm_runtime_get_sync(wdt->dev);
	clk_enable(wdt->clk);

	spin_lock_irqsave(&wdt->lock, flags);

	next_heartbeat = jiffies + (heartbeat * HZ);
	mod_timer(&wdt->timer, next_ping_period(clock_division_ratio));

	csr = sh_wdt_read_csr();
	csr |= WTCSR_WT | clock_division_ratio;
	sh_wdt_write_csr(csr);

	sh_wdt_write_cnt(0);

	/*
         * These processors have a bit of an inconsistent initialization
         * process.. starting with SH-3, RSTS was moved to WTCSR, and the
         * RSTCSR register was removed.
         *
         * On the SH-2 however, in addition with bits being in different
         * locations, we must deal with RSTCSR outright..
         */
	csr = sh_wdt_read_csr();
	csr |= WTCSR_TME;
	csr &= ~WTCSR_RSTS;
	sh_wdt_write_csr(csr);

#ifdef CONFIG_CPU_SH2
	csr = sh_wdt_read_rstcsr();
	csr &= ~RSTCSR_RSTS;
	sh_wdt_write_rstcsr(csr);
#endif
	spin_unlock_irqrestore(&wdt->lock, flags);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
94
63.09%
6
60.00%
Linus Torvalds
27
18.12%
2
20.00%
Alan Cox
18
12.08%
1
10.00%
Wim Van Sebroeck
10
6.71%
1
10.00%
Total
149
100.00%
10
100.00%



static int sh_wdt_stop(struct watchdog_device *wdt_dev)
{
	struct sh_wdt *wdt = watchdog_get_drvdata(wdt_dev);
	unsigned long flags;
	u8 csr;

	spin_lock_irqsave(&wdt->lock, flags);

	del_timer(&wdt->timer);

	csr = sh_wdt_read_csr();
	csr &= ~WTCSR_TME;
	sh_wdt_write_csr(csr);

	spin_unlock_irqrestore(&wdt->lock, flags);

	clk_disable(wdt->clk);
	pm_runtime_put_sync(wdt->dev);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
54
61.36%
6
66.67%
Alan Cox
18
20.45%
1
11.11%
Linus Torvalds
16
18.18%
2
22.22%
Total
88
100.00%
9
100.00%



static int sh_wdt_keepalive(struct watchdog_device *wdt_dev)
{
	struct sh_wdt *wdt = watchdog_get_drvdata(wdt_dev);
	unsigned long flags;

	spin_lock_irqsave(&wdt->lock, flags);
	next_heartbeat = jiffies + (heartbeat * HZ);
	spin_unlock_irqrestore(&wdt->lock, flags);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
24
41.38%
3
60.00%
Alan Cox
18
31.03%
1
20.00%
Wim Van Sebroeck
16
27.59%
1
20.00%
Total
58
100.00%
5
100.00%



static int sh_wdt_set_heartbeat(struct watchdog_device *wdt_dev, unsigned t)
{
	struct sh_wdt *wdt = watchdog_get_drvdata(wdt_dev);
	unsigned long flags;

	if (unlikely(t < 1 || t > 3600)) /* arbitrary upper limit */
		return -EINVAL;

	spin_lock_irqsave(&wdt->lock, flags);
	heartbeat = t;
	wdt_dev->timeout = t;
	spin_unlock_irqrestore(&wdt->lock, flags);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
31
39.24%
3
60.00%
Wim Van Sebroeck
30
37.97%
1
20.00%
Alan Cox
18
22.78%
1
20.00%
Total
79
100.00%
5
100.00%



static void sh_wdt_ping(unsigned long data)
{
	struct sh_wdt *wdt = (struct sh_wdt *)data;
	unsigned long flags;

	spin_lock_irqsave(&wdt->lock, flags);
	if (time_before(jiffies, next_heartbeat)) {
		u8 csr;

		csr = sh_wdt_read_csr();
		csr &= ~WTCSR_IOVF;
		sh_wdt_write_csr(csr);

		sh_wdt_write_cnt(0);

		mod_timer(&wdt->timer, next_ping_period(clock_division_ratio));
	} else
		dev_warn(wdt->dev, "Heartbeat lost! Will not ping "
		         "the watchdog\n");
	spin_unlock_irqrestore(&wdt->lock, flags);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
66
63.46%
4
50.00%
Linus Torvalds
24
23.08%
2
25.00%
Alan Cox
11
10.58%
1
12.50%
Wim Van Sebroeck
3
2.88%
1
12.50%
Total
104
100.00%
8
100.00%


static const struct watchdog_info sh_wdt_info = {
	.options		= WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT |
				  WDIOF_MAGICCLOSE,
	.firmware_version	= 1,
	.identity		= "SH WDT",
};


static const struct watchdog_ops sh_wdt_ops = {
	.owner		= THIS_MODULE,
	.start		= sh_wdt_start,
	.stop		= sh_wdt_stop,
	.ping		= sh_wdt_keepalive,
	.set_timeout	= sh_wdt_set_heartbeat,
};


static struct watchdog_device sh_wdt_dev = {
	.info	= &sh_wdt_info,
	.ops	= &sh_wdt_ops,
};



static int sh_wdt_probe(struct platform_device *pdev)
{
	struct sh_wdt *wdt;
	struct resource *res;
	int rc;

	/*
         * As this driver only covers the global watchdog case, reject
         * any attempts to register per-CPU watchdogs.
         */
	if (pdev->id != -1)
		return -EINVAL;

	wdt = devm_kzalloc(&pdev->dev, sizeof(struct sh_wdt), GFP_KERNEL);
	if (unlikely(!wdt))
		return -ENOMEM;

	wdt->dev = &pdev->dev;

	wdt->clk = devm_clk_get(&pdev->dev, NULL);
	if (IS_ERR(wdt->clk)) {
		/*
                 * Clock framework support is optional, continue on
                 * anyways if we don't find a matching clock.
                 */
		wdt->clk = NULL;
	}

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	wdt->base = devm_ioremap_resource(wdt->dev, res);
	if (IS_ERR(wdt->base))
		return PTR_ERR(wdt->base);

	watchdog_set_nowayout(&sh_wdt_dev, nowayout);
	watchdog_set_drvdata(&sh_wdt_dev, wdt);
	sh_wdt_dev.parent = &pdev->dev;

	spin_lock_init(&wdt->lock);

	rc = sh_wdt_set_heartbeat(&sh_wdt_dev, heartbeat);
	if (unlikely(rc)) {
		/* Default timeout if invalid */
		sh_wdt_set_heartbeat(&sh_wdt_dev, WATCHDOG_HEARTBEAT);

		dev_warn(&pdev->dev,
			 "heartbeat value must be 1<=x<=3600, using %d\n",
			 sh_wdt_dev.timeout);
	}

	dev_info(&pdev->dev, "configured with heartbeat=%d sec (nowayout=%d)\n",
		 sh_wdt_dev.timeout, nowayout);

	rc = watchdog_register_device(&sh_wdt_dev);
	if (unlikely(rc)) {
		dev_err(&pdev->dev, "Can't register watchdog (err=%d)\n", rc);
		return rc;
	}

	setup_timer(&wdt->timer, sh_wdt_ping, (unsigned long)wdt);
	wdt->timer.expires	= next_ping_period(clock_division_ratio);

	dev_info(&pdev->dev, "initialized.\n");

	pm_runtime_enable(&pdev->dev);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
263
81.93%
6
42.86%
George Cherian
11
3.43%
1
7.14%
Wim Van Sebroeck
10
3.12%
1
7.14%
Pratyush Anand
9
2.80%
1
7.14%
Linus Torvalds
8
2.49%
1
7.14%
Sachin Kamat
8
2.49%
1
7.14%
Jingoo Han
6
1.87%
1
7.14%
Muhammad Falak R Wani
4
1.25%
1
7.14%
Andrew Morton
2
0.62%
1
7.14%
Total
321
100.00%
14
100.00%



static int sh_wdt_remove(struct platform_device *pdev)
{
	watchdog_unregister_device(&sh_wdt_dev);

	pm_runtime_disable(&pdev->dev);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
24
85.71%
3
75.00%
Linus Torvalds
4
14.29%
1
25.00%
Total
28
100.00%
4
100.00%



static void sh_wdt_shutdown(struct platform_device *pdev)
{
	sh_wdt_stop(&sh_wdt_dev);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
17
100.00%
2
100.00%
Total
17
100.00%
2
100.00%


static struct platform_driver sh_wdt_driver = {
	.driver		= {
		.name	= DRV_NAME,
        },

	.probe		= sh_wdt_probe,
	.remove		= sh_wdt_remove,
	.shutdown	= sh_wdt_shutdown,
};



static int __init sh_wdt_init(void)
{
	if (unlikely(clock_division_ratio < 0x5 ||
		     clock_division_ratio > 0x7)) {
		clock_division_ratio = WTCSR_CKS_4096;

		pr_info("divisor must be 0x5<=x<=0x7, using %d\n",
			clock_division_ratio);
	}

	return platform_driver_register(&sh_wdt_driver);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
41
97.62%
1
50.00%
Joe Perches
1
2.38%
1
50.00%
Total
42
100.00%
2
100.00%



static void __exit sh_wdt_exit(void)
{
	platform_driver_unregister(&sh_wdt_driver);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Linus Torvalds
12
80.00%
1
50.00%
Paul Mundt
3
20.00%
1
50.00%
Total
15
100.00%
2
100.00%


module_init(sh_wdt_init);

module_exit(sh_wdt_exit);

MODULE_AUTHOR("Paul Mundt <lethal@linux-sh.org>");
MODULE_DESCRIPTION("SuperH watchdog driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:" DRV_NAME);

module_param(clock_division_ratio, int, 0);
MODULE_PARM_DESC(clock_division_ratio,
	"Clock division ratio. Valid ranges are from 0x5 (1.31ms) "
	"to 0x7 (5.25ms). (default=" __MODULE_STRING(WTCSR_CKS_4096) ")");

module_param(heartbeat, int, 0);
MODULE_PARM_DESC(heartbeat,
	"Watchdog heartbeat in seconds. (1 <= heartbeat <= 3600, default="
				__MODULE_STRING(WATCHDOG_HEARTBEAT) ")");

module_param(nowayout, bool, 0);
MODULE_PARM_DESC(nowayout,
	"Watchdog cannot be stopped once started (default="
				__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
Paul Mundt
783
63.76%
10
29.41%
Linus Torvalds
170
13.84%
2
5.88%
Wim Van Sebroeck
102
8.31%
3
8.82%
Alan Cox
86
7.00%
1
2.94%
Dave Jones
14
1.14%
3
8.82%
Andrew Morton
12
0.98%
2
5.88%
Sachin Kamat
11
0.90%
1
2.94%
George Cherian
11
0.90%
1
2.94%
Pratyush Anand
9
0.73%
1
2.94%
Joe Perches
8
0.65%
1
2.94%
Jingoo Han
6
0.49%
1
2.94%
Art Haas
6
0.49%
1
2.94%
Muhammad Falak R Wani
4
0.33%
1
2.94%
Arjan van de Ven
1
0.08%
1
2.94%
Randy Dunlap
1
0.08%
1
2.94%
David Engraf
1
0.08%
1
2.94%
Andrey Panin
1
0.08%
1
2.94%
Adrian Bunk
1
0.08%
1
2.94%
Lucas De Marchi
1
0.08%
1
2.94%
Total
1228
100.00%
34
100.00%
Directory: drivers/watchdog

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.