[linux.git] / drivers / watchdog / sp805_wdt.c

/*
 * drivers/char/watchdog/sp805-wdt.c
 *
 * Watchdog driver for ARM SP805 watchdog module
 *
 * Copyright (C) 2010 ST Microelectronics
 * Viresh Kumar <[email protected]>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2 or later. This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#include <linux/device.h>
#include <linux/resource.h>
#include <linux/amba/bus.h>
#include <linux/bitops.h>
#include <linux/clk.h>
#include <linux/io.h>
#include <linux/ioport.h>
#include <linux/kernel.h>
#include <linux/math64.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/pm.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/watchdog.h>

/* default timeout in seconds */
#define DEFAULT_TIMEOUT		60

#define MODULE_NAME		"sp805-wdt"

/* watchdog register offsets and masks */
#define WDTLOAD			0x000
	#define LOAD_MIN	0x00000001
	#define LOAD_MAX	0xFFFFFFFF
#define WDTVALUE		0x004
#define WDTCONTROL		0x008
	/* control register masks */
	#define	INT_ENABLE	(1 << 0)
	#define	RESET_ENABLE	(1 << 1)
#define WDTINTCLR		0x00C
#define WDTRIS			0x010
#define WDTMIS			0x014
	#define INT_MASK	(1 << 0)
#define WDTLOCK			0xC00
	#define	UNLOCK		0x1ACCE551
	#define	LOCK		0x00000001

/**
 * struct sp805_wdt: sp805 wdt device structure
 * @wdd: instance of struct watchdog_device
 * @lock: spin lock protecting dev structure and io access
 * @base: base address of wdt
 * @clk: clock structure of wdt
 * @adev: amba device structure of wdt
 * @status: current status of wdt
 * @load_val: load value to be set for current timeout
 */
struct sp805_wdt {
	struct watchdog_device		wdd;
	spinlock_t			lock;
	void __iomem			*base;
	struct clk			*clk;
	struct amba_device		*adev;
	unsigned int			load_val;
};

static bool nowayout = WATCHDOG_NOWAYOUT;
module_param(nowayout, bool, 0);
MODULE_PARM_DESC(nowayout,
		"Set to 1 to keep watchdog running after device release");

/* This routine finds load value that will reset system in required timout */
static int wdt_setload(struct watchdog_device *wdd, unsigned int timeout)
{
	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
	u64 load, rate;

	rate = clk_get_rate(wdt->clk);

	/*
	 * sp805 runs counter with given value twice, after the end of first
	 * counter it gives an interrupt and then starts counter again. If
	 * interrupt already occurred then it resets the system. This is why
	 * load is half of what should be required.
	 */
	load = div_u64(rate, 2) * timeout - 1;

	load = (load > LOAD_MAX) ? LOAD_MAX : load;
	load = (load < LOAD_MIN) ? LOAD_MIN : load;

	spin_lock(&wdt->lock);
	wdt->load_val = load;
	/* roundup timeout to closest positive integer value */
	wdd->timeout = div_u64((load + 1) * 2 + (rate / 2), rate);
	spin_unlock(&wdt->lock);

	return 0;
}

/* returns number of seconds left for reset to occur */
static unsigned int wdt_timeleft(struct watchdog_device *wdd)
{
	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
	u64 load, rate;

	rate = clk_get_rate(wdt->clk);

	spin_lock(&wdt->lock);
	load = readl_relaxed(wdt->base + WDTVALUE);

	/*If the interrupt is inactive then time left is WDTValue + WDTLoad. */
	if (!(readl_relaxed(wdt->base + WDTRIS) & INT_MASK))
		load += wdt->load_val + 1;
	spin_unlock(&wdt->lock);

	return div_u64(load, rate);
}

static int wdt_config(struct watchdog_device *wdd, bool ping)
{
	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
	int ret;

	if (!ping) {

		ret = clk_prepare_enable(wdt->clk);
		if (ret) {
			dev_err(&wdt->adev->dev, "clock enable fail");
			return ret;
		}
	}

	spin_lock(&wdt->lock);

	writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
	writel_relaxed(wdt->load_val, wdt->base + WDTLOAD);

	if (!ping) {
		writel_relaxed(INT_MASK, wdt->base + WDTINTCLR);
		writel_relaxed(INT_ENABLE | RESET_ENABLE, wdt->base +
				WDTCONTROL);
	}

	writel_relaxed(LOCK, wdt->base + WDTLOCK);

	/* Flush posted writes. */
	readl_relaxed(wdt->base + WDTLOCK);
	spin_unlock(&wdt->lock);

	return 0;
}

static int wdt_ping(struct watchdog_device *wdd)
{
	return wdt_config(wdd, true);
}

/* enables watchdog timers reset */
static int wdt_enable(struct watchdog_device *wdd)
{
	return wdt_config(wdd, false);
}

/* disables watchdog timers reset */
static int wdt_disable(struct watchdog_device *wdd)
{
	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);

	spin_lock(&wdt->lock);

	writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
	writel_relaxed(0, wdt->base + WDTCONTROL);
	writel_relaxed(LOCK, wdt->base + WDTLOCK);

	/* Flush posted writes. */
	readl_relaxed(wdt->base + WDTLOCK);
	spin_unlock(&wdt->lock);

	clk_disable_unprepare(wdt->clk);

	return 0;
}

static const struct watchdog_info wdt_info = {
	.options = WDIOF_MAGICCLOSE | WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING,
	.identity = MODULE_NAME,
};

static const struct watchdog_ops wdt_ops = {
	.owner		= THIS_MODULE,
	.start		= wdt_enable,
	.stop		= wdt_disable,
	.ping		= wdt_ping,
	.set_timeout	= wdt_setload,
	.get_timeleft	= wdt_timeleft,
};

static int
sp805_wdt_probe(struct amba_device *adev, const struct amba_id *id)
{
	struct sp805_wdt *wdt;
	int ret = 0;

	wdt = devm_kzalloc(&adev->dev, sizeof(*wdt), GFP_KERNEL);
	if (!wdt) {
		ret = -ENOMEM;
		goto err;
	}

	wdt->base = devm_ioremap_resource(&adev->dev, &adev->res);
	if (IS_ERR(wdt->base))
		return PTR_ERR(wdt->base);

	wdt->clk = devm_clk_get(&adev->dev, NULL);
	if (IS_ERR(wdt->clk)) {
		dev_warn(&adev->dev, "Clock not found\n");
		ret = PTR_ERR(wdt->clk);
		goto err;
	}

	wdt->adev = adev;
	wdt->wdd.info = &wdt_info;
	wdt->wdd.ops = &wdt_ops;
	wdt->wdd.parent = &adev->dev;

	spin_lock_init(&wdt->lock);
	watchdog_set_nowayout(&wdt->wdd, nowayout);
	watchdog_set_drvdata(&wdt->wdd, wdt);
	wdt_setload(&wdt->wdd, DEFAULT_TIMEOUT);

	ret = watchdog_register_device(&wdt->wdd);
	if (ret) {
		dev_err(&adev->dev, "watchdog_register_device() failed: %d\n",
				ret);
		goto err;
	}
	amba_set_drvdata(adev, wdt);

	dev_info(&adev->dev, "registration successful\n");
	return 0;

err:
	dev_err(&adev->dev, "Probe Failed!!!\n");
	return ret;
}

static int sp805_wdt_remove(struct amba_device *adev)
{
	struct sp805_wdt *wdt = amba_get_drvdata(adev);

	watchdog_unregister_device(&wdt->wdd);
	watchdog_set_drvdata(&wdt->wdd, NULL);

	return 0;
}

static int __maybe_unused sp805_wdt_suspend(struct device *dev)
{
	struct sp805_wdt *wdt = dev_get_drvdata(dev);

	if (watchdog_active(&wdt->wdd))
		return wdt_disable(&wdt->wdd);

	return 0;
}

static int __maybe_unused sp805_wdt_resume(struct device *dev)
{
	struct sp805_wdt *wdt = dev_get_drvdata(dev);

	if (watchdog_active(&wdt->wdd))
		return wdt_enable(&wdt->wdd);

	return 0;
}

static SIMPLE_DEV_PM_OPS(sp805_wdt_dev_pm_ops, sp805_wdt_suspend,
		sp805_wdt_resume);

static struct amba_id sp805_wdt_ids[] = {
	{
		.id	= 0x00141805,
		.mask	= 0x00ffffff,
	},
	{ 0, 0 },
};

MODULE_DEVICE_TABLE(amba, sp805_wdt_ids);

static struct amba_driver sp805_wdt_driver = {
	.drv = {
		.name	= MODULE_NAME,
		.pm	= &sp805_wdt_dev_pm_ops,
	},
	.id_table	= sp805_wdt_ids,
	.probe		= sp805_wdt_probe,
	.remove = sp805_wdt_remove,
};

module_amba_driver(sp805_wdt_driver);

MODULE_AUTHOR("Viresh Kumar <[email protected]>");
MODULE_DESCRIPTION("ARM SP805 Watchdog Driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
4a370278 VK	1	/*
	2	* drivers/char/watchdog/sp805-wdt.c
	3	*
	4	* Watchdog driver for ARM SP805 watchdog module
	5	*
	6	* Copyright (C) 2010 ST Microelectronics
da89947b	7	* Viresh Kumar <[email protected]>
4a370278 VK	8	*
	9	* This file is licensed under the terms of the GNU General Public
	10	* License version 2 or later. This program is licensed "as is" without any
	11	* warranty of any kind, whether express or implied.
	12	*/
	13
	14	#include <linux/device.h>
	15	#include <linux/resource.h>
	16	#include <linux/amba/bus.h>
	17	#include <linux/bitops.h>
	18	#include <linux/clk.h>
4a370278 VK	19	#include <linux/io.h>
	20	#include <linux/ioport.h>
	21	#include <linux/kernel.h>
	22	#include <linux/math64.h>
4a370278 VK	23	#include <linux/module.h>
4a370278 VK	24	#include <linux/moduleparam.h>
16ac4abe	25	#include <linux/pm.h>
4a370278 VK	26	#include <linux/slab.h>
	27	#include <linux/spinlock.h>
	28	#include <linux/types.h>
4a370278 VK	29	#include <linux/watchdog.h>
	30
	31	/* default timeout in seconds */
	32	#define DEFAULT_TIMEOUT 60
	33
	34	#define MODULE_NAME "sp805-wdt"
	35
	36	/* watchdog register offsets and masks */
	37	#define WDTLOAD 0x000
	38	#define LOAD_MIN 0x00000001
	39	#define LOAD_MAX 0xFFFFFFFF
	40	#define WDTVALUE 0x004
	41	#define WDTCONTROL 0x008
	42	/* control register masks */
	43	#define INT_ENABLE (1 << 0)
	44	#define RESET_ENABLE (1 << 1)
	45	#define WDTINTCLR 0x00C
	46	#define WDTRIS 0x010
	47	#define WDTMIS 0x014
	48	#define INT_MASK (1 << 0)
	49	#define WDTLOCK 0xC00
	50	#define UNLOCK 0x1ACCE551
	51	#define LOCK 0x00000001
	52
	53	/**
	54	* struct sp805_wdt: sp805 wdt device structure
4a516539	55	* @wdd: instance of struct watchdog_device
bfae14b6 VK	56	* @lock: spin lock protecting dev structure and io access
	57	* @base: base address of wdt
	58	* @clk: clock structure of wdt
	59	* @adev: amba device structure of wdt
	60	* @status: current status of wdt
	61	* @load_val: load value to be set for current timeout
4a370278 VK	62	*/
4a370278 VK	63	struct sp805_wdt {
4a516539	64	struct watchdog_device wdd;
4a370278 VK	65	spinlock_t lock;
	66	void __iomem *base;
	67	struct clk *clk;
	68	struct amba_device *adev;
4a370278	69	unsigned int load_val;
4a370278 VK	70	};
4a370278 VK	71
86a1e189	72	static bool nowayout = WATCHDOG_NOWAYOUT;
4a516539 VK	73	module_param(nowayout, bool, 0);
	74	MODULE_PARM_DESC(nowayout,
	75	"Set to 1 to keep watchdog running after device release");
4a370278 VK	76
4a370278 VK	77	/* This routine finds load value that will reset system in required timout */
4a516539	78	static int wdt_setload(struct watchdog_device *wdd, unsigned int timeout)
4a370278	79	{
4a516539	80	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
4a370278 VK	81	u64 load, rate;
	82
	83	rate = clk_get_rate(wdt->clk);
	84
	85	/*
	86	* sp805 runs counter with given value twice, after the end of first
	87	* counter it gives an interrupt and then starts counter again. If
25985edc	88	* interrupt already occurred then it resets the system. This is why
4a370278 VK	89	* load is half of what should be required.
	90	*/
	91	load = div_u64(rate, 2) * timeout - 1;
	92
	93	load = (load > LOAD_MAX) ? LOAD_MAX : load;
	94	load = (load < LOAD_MIN) ? LOAD_MIN : load;
	95
	96	spin_lock(&wdt->lock);
	97	wdt->load_val = load;
	98	/* roundup timeout to closest positive integer value */
938626d9	99	wdd->timeout = div_u64((load + 1) * 2 + (rate / 2), rate);
4a370278	100	spin_unlock(&wdt->lock);
4a516539 VK	101
4a516539 VK	102	return 0;
4a370278 VK	103	}
	104
	105	/* returns number of seconds left for reset to occur */
4a516539	106	static unsigned int wdt_timeleft(struct watchdog_device *wdd)
4a370278	107	{
4a516539	108	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
4a370278 VK	109	u64 load, rate;
	110
	111	rate = clk_get_rate(wdt->clk);
	112
	113	spin_lock(&wdt->lock);
d2e8919b	114	load = readl_relaxed(wdt->base + WDTVALUE);
4a370278 VK	115
4a370278 VK	116	/If the interrupt is inactive then time left is WDTValue + WDTLoad. /
d2e8919b	117	if (!(readl_relaxed(wdt->base + WDTRIS) & INT_MASK))
4a370278 VK	118	load += wdt->load_val + 1;
	119	spin_unlock(&wdt->lock);
	120
	121	return div_u64(load, rate);
	122	}
	123
4a516539	124	static int wdt_config(struct watchdog_device *wdd, bool ping)
4a370278	125	{
4a516539 VK	126	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
	127	int ret;
	128
	129	if (!ping) {
d9df0ef1	130
63fbbc16	131	ret = clk_prepare_enable(wdt->clk);
4a516539 VK	132	if (ret) {
	133	dev_err(&wdt->adev->dev, "clock enable fail");
	134	return ret;
	135	}
	136	}
	137
4a370278 VK	138	spin_lock(&wdt->lock);
4a370278 VK	139
d2e8919b VK	140	writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
d2e8919b VK	141	writel_relaxed(wdt->load_val, wdt->base + WDTLOAD);
4a370278	142
4a516539 VK	143	if (!ping) {
	144	writel_relaxed(INT_MASK, wdt->base + WDTINTCLR);
	145	writel_relaxed(INT_ENABLE \| RESET_ENABLE, wdt->base +
	146	WDTCONTROL);
	147	}
4a370278	148
d2e8919b	149	writel_relaxed(LOCK, wdt->base + WDTLOCK);
4a370278	150
081d83a3	151	/* Flush posted writes. */
d2e8919b	152	readl_relaxed(wdt->base + WDTLOCK);
4a370278	153	spin_unlock(&wdt->lock);
4a516539 VK	154
4a516539 VK	155	return 0;
4a370278 VK	156	}
4a370278 VK	157
4a516539	158	static int wdt_ping(struct watchdog_device *wdd)
4a370278	159	{
4a516539	160	return wdt_config(wdd, true);
4a370278 VK	161	}
4a370278 VK	162
4a516539 VK	163	/* enables watchdog timers reset */
4a516539 VK	164	static int wdt_enable(struct watchdog_device *wdd)
4a370278	165	{
4a516539	166	return wdt_config(wdd, false);
4a370278 VK	167	}
4a370278 VK	168
4a516539 VK	169	/* disables watchdog timers reset */
4a516539 VK	170	static int wdt_disable(struct watchdog_device *wdd)
4a370278	171	{
4a516539	172	struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
4a370278	173
4a516539	174	spin_lock(&wdt->lock);
4a370278	175
4a516539 VK	176	writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
	177	writel_relaxed(0, wdt->base + WDTCONTROL);
	178	writel_relaxed(LOCK, wdt->base + WDTLOCK);
4a370278	179
4a516539 VK	180	/* Flush posted writes. */
	181	readl_relaxed(wdt->base + WDTLOCK);
	182	spin_unlock(&wdt->lock);
4a370278	183
63fbbc16	184	clk_disable_unprepare(wdt->clk);
4a370278 VK	185
	186	return 0;
	187	}
	188
4a516539 VK	189	static const struct watchdog_info wdt_info = {
	190	.options = WDIOF_MAGICCLOSE \| WDIOF_SETTIMEOUT \| WDIOF_KEEPALIVEPING,
	191	.identity = MODULE_NAME,
4a370278 VK	192	};
4a370278 VK	193
4a516539 VK	194	static const struct watchdog_ops wdt_ops = {
	195	.owner = THIS_MODULE,
	196	.start = wdt_enable,
	197	.stop = wdt_disable,
	198	.ping = wdt_ping,
	199	.set_timeout = wdt_setload,
	200	.get_timeleft = wdt_timeleft,
4a370278 VK	201	};
4a370278 VK	202
2d991a16	203	static int
aa25afad	204	sp805_wdt_probe(struct amba_device adev, const struct amba_id id)
4a370278	205	{
4a516539	206	struct sp805_wdt *wdt;
4a370278 VK	207	int ret = 0;
4a370278 VK	208
fb35a5ad	209	wdt = devm_kzalloc(&adev->dev, sizeof(*wdt), GFP_KERNEL);
4a370278	210	if (!wdt) {
4a370278	211	ret = -ENOMEM;
fb35a5ad VK	212	goto err;
	213	}
	214
9d11e4f8 JH	215	wdt->base = devm_ioremap_resource(&adev->dev, &adev->res);
	216	if (IS_ERR(wdt->base))
	217	return PTR_ERR(wdt->base);
4a370278	218
07bf971a	219	wdt->clk = devm_clk_get(&adev->dev, NULL);
4a370278 VK	220	if (IS_ERR(wdt->clk)) {
	221	dev_warn(&adev->dev, "Clock not found\n");
	222	ret = PTR_ERR(wdt->clk);
fb35a5ad	223	goto err;
4a370278 VK	224	}
	225
	226	wdt->adev = adev;
4a516539 VK	227	wdt->wdd.info = &wdt_info;
4a516539 VK	228	wdt->wdd.ops = &wdt_ops;
6551881c	229	wdt->wdd.parent = &adev->dev;
4a516539	230
4a370278	231	spin_lock_init(&wdt->lock);
4a516539 VK	232	watchdog_set_nowayout(&wdt->wdd, nowayout);
	233	watchdog_set_drvdata(&wdt->wdd, wdt);
	234	wdt_setload(&wdt->wdd, DEFAULT_TIMEOUT);
4a370278	235
4a516539 VK	236	ret = watchdog_register_device(&wdt->wdd);
	237	if (ret) {
	238	dev_err(&adev->dev, "watchdog_register_device() failed: %d\n",
	239	ret);
07bf971a	240	goto err;
4a370278	241	}
4a516539	242	amba_set_drvdata(adev, wdt);
4a370278 VK	243
	244	dev_info(&adev->dev, "registration successful\n");
	245	return 0;
	246
4a370278 VK	247	err:
	248	dev_err(&adev->dev, "Probe Failed!!!\n");
	249	return ret;
	250	}
	251
4b12b896	252	static int sp805_wdt_remove(struct amba_device *adev)
4a370278	253	{
4a516539 VK	254	struct sp805_wdt *wdt = amba_get_drvdata(adev);
	255
	256	watchdog_unregister_device(&wdt->wdd);
4a516539	257	watchdog_set_drvdata(&wdt->wdd, NULL);
4a370278 VK	258
	259	return 0;
	260	}
	261
60d6dd53	262	static int __maybe_unused sp805_wdt_suspend(struct device *dev)
16ac4abe	263	{
4a516539 VK	264	struct sp805_wdt *wdt = dev_get_drvdata(dev);
	265
	266	if (watchdog_active(&wdt->wdd))
	267	return wdt_disable(&wdt->wdd);
16ac4abe VK	268
	269	return 0;
	270	}
	271
60d6dd53	272	static int __maybe_unused sp805_wdt_resume(struct device *dev)
16ac4abe	273	{
4a516539	274	struct sp805_wdt *wdt = dev_get_drvdata(dev);
16ac4abe	275
4a516539 VK	276	if (watchdog_active(&wdt->wdd))
4a516539 VK	277	return wdt_enable(&wdt->wdd);
16ac4abe	278
4a516539	279	return 0;
16ac4abe	280	}
16ac4abe VK	281
	282	static SIMPLE_DEV_PM_OPS(sp805_wdt_dev_pm_ops, sp805_wdt_suspend,
	283	sp805_wdt_resume);
	284
bb558dac	285	static struct amba_id sp805_wdt_ids[] = {
4a370278 VK	286	{
	287	.id = 0x00141805,
	288	.mask = 0x00ffffff,
	289	},
	290	{ 0, 0 },
	291	};
	292
17885b05 DM	293	MODULE_DEVICE_TABLE(amba, sp805_wdt_ids);
17885b05 DM	294
4a370278 VK	295	static struct amba_driver sp805_wdt_driver = {
	296	.drv = {
	297	.name = MODULE_NAME,
16ac4abe	298	.pm = &sp805_wdt_dev_pm_ops,
4a370278 VK	299	},
	300	.id_table = sp805_wdt_ids,
	301	.probe = sp805_wdt_probe,
82268714	302	.remove = sp805_wdt_remove,
4a370278 VK	303	};
4a370278 VK	304
9e5ed094	305	module_amba_driver(sp805_wdt_driver);
4a370278	306
da89947b	307	MODULE_AUTHOR("Viresh Kumar <[email protected]>");
4a370278 VK	308	MODULE_DESCRIPTION("ARM SP805 Watchdog Driver");
4a370278 VK	309	MODULE_LICENSE("GPL");