alim1535_wdt.c 9.9 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9
/*
 *	Watchdog for the 7101 PMU version found in the ALi M1535 chipsets
 *
 *	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.
 */

10 11
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

Linus Torvalds's avatar
Linus Torvalds committed
12 13 14 15 16 17 18 19 20 21 22
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/types.h>
#include <linux/miscdevice.h>
#include <linux/watchdog.h>
#include <linux/ioport.h>
#include <linux/notifier.h>
#include <linux/reboot.h>
#include <linux/init.h>
#include <linux/fs.h>
#include <linux/pci.h>
23 24
#include <linux/uaccess.h>
#include <linux/io.h>
Linus Torvalds's avatar
Linus Torvalds committed
25 26 27 28 29 30 31 32

#define WATCHDOG_NAME "ALi_M1535"
#define WATCHDOG_TIMEOUT 60	/* 60 sec default timeout */

/* internal variables */
static unsigned long ali_is_open;
static char ali_expect_release;
static struct pci_dev *ali_pci;
33
static u32 ali_timeout_bits;		/* stores the computed timeout */
34
static DEFINE_SPINLOCK(ali_lock);	/* Guards the hardware */
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38

/* module parameters */
static int timeout = WATCHDOG_TIMEOUT;
module_param(timeout, int, 0);
39 40 41
MODULE_PARM_DESC(timeout,
		"Watchdog timeout in seconds. (0 < timeout < 18000, default="
				__MODULE_STRING(WATCHDOG_TIMEOUT) ")");
Linus Torvalds's avatar
Linus Torvalds committed
42

Wim Van Sebroeck's avatar
Wim Van Sebroeck committed
43 44
static bool nowayout = WATCHDOG_NOWAYOUT;
module_param(nowayout, bool, 0);
45 46 47
MODULE_PARM_DESC(nowayout,
		"Watchdog cannot be stopped once started (default="
				__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
Linus Torvalds's avatar
Linus Torvalds committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

/*
 *	ali_start	-	start watchdog countdown
 *
 *	Starts the timer running providing the timer has a counter
 *	configuration set.
 */

static void ali_start(void)
{
	u32 val;

	spin_lock(&ali_lock);

	pci_read_config_dword(ali_pci, 0xCC, &val);
	val &= ~0x3F;	/* Mask count */
64
	val |= (1 << 25) | ali_timeout_bits;
Linus Torvalds's avatar
Linus Torvalds committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
	pci_write_config_dword(ali_pci, 0xCC, val);

	spin_unlock(&ali_lock);
}

/*
 *	ali_stop	-	stop the timer countdown
 *
 *	Stop the ALi watchdog countdown
 */

static void ali_stop(void)
{
	u32 val;

	spin_lock(&ali_lock);

	pci_read_config_dword(ali_pci, 0xCC, &val);
83 84
	val &= ~0x3F;		/* Mask count to zero (disabled) */
	val &= ~(1 << 25);	/* and for safety mask the reset enable */
Linus Torvalds's avatar
Linus Torvalds committed
85 86 87 88 89 90 91 92
	pci_write_config_dword(ali_pci, 0xCC, val);

	spin_unlock(&ali_lock);
}

/*
 *	ali_keepalive	-	send a keepalive to the watchdog
 *
93
 *	Send a keepalive to the timer (actually we restart the timer).
Linus Torvalds's avatar
Linus Torvalds committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
 */

static void ali_keepalive(void)
{
	ali_start();
}

/*
 *	ali_settimer	-	compute the timer reload value
 *	@t: time in seconds
 *
 *	Computes the timeout values needed
 */

static int ali_settimer(int t)
{
110
	if (t < 0)
Linus Torvalds's avatar
Linus Torvalds committed
111
		return -EINVAL;
112
	else if (t < 60)
113
		ali_timeout_bits = t|(1 << 6);
114
	else if (t < 3600)
115
		ali_timeout_bits = (t / 60)|(1 << 7);
116
	else if (t < 18000)
117
		ali_timeout_bits = (t / 300)|(1 << 6)|(1 << 7);
118 119
	else
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

	timeout = t;
	return 0;
}

/*
 *	/dev/watchdog handling
 */

/*
 *	ali_write	-	writes to ALi watchdog
 *	@file: file from VFS
 *	@data: user address of data
 *	@len: length of data
 *	@ppos: pointer to the file offset
 *
 *	Handle a write to the ALi watchdog. Writing to the file pings
 *	the watchdog and resets it. Writing the magic 'V' sequence allows
 *	the next close to turn off the watchdog.
 */

static ssize_t ali_write(struct file *file, const char __user *data,
142
						size_t len, loff_t *ppos)
Linus Torvalds's avatar
Linus Torvalds committed
143 144 145 146 147 148
{
	/* See if we got the magic character 'V' and reload the timer */
	if (len) {
		if (!nowayout) {
			size_t i;

149 150
			/* note: just in case someone wrote the
			   magic character five months ago... */
Linus Torvalds's avatar
Linus Torvalds committed
151 152
			ali_expect_release = 0;

153 154
			/* scan to see whether or not we got
			   the magic character */
Linus Torvalds's avatar
Linus Torvalds committed
155 156
			for (i = 0; i != len; i++) {
				char c;
157
				if (get_user(c, data + i))
Linus Torvalds's avatar
Linus Torvalds committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
					return -EFAULT;
				if (c == 'V')
					ali_expect_release = 42;
			}
		}

		/* someone wrote to us, we should reload the timer */
		ali_start();
	}
	return len;
}

/*
 *	ali_ioctl	-	handle watchdog ioctls
 *	@file: VFS file pointer
 *	@cmd: ioctl number
 *	@arg: arguments to the ioctl
 *
 *	Handle the watchdog ioctls supported by the ALi driver. Really
 *	we want an extension to enable irq ack monitoring and the like
 */

180
static long ali_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
181 182 183
{
	void __user *argp = (void __user *)arg;
	int __user *p = argp;
184
	static const struct watchdog_info ident = {
Linus Torvalds's avatar
Linus Torvalds committed
185 186 187 188 189 190 191 192
		.options =		WDIOF_KEEPALIVEPING |
					WDIOF_SETTIMEOUT |
					WDIOF_MAGICCLOSE,
		.firmware_version =	0,
		.identity =		"ALi M1535 WatchDog Timer",
	};

	switch (cmd) {
193 194
	case WDIOC_GETSUPPORT:
		return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
Linus Torvalds's avatar
Linus Torvalds committed
195

196 197 198 199 200 201 202 203 204 205 206 207
	case WDIOC_GETSTATUS:
	case WDIOC_GETBOOTSTATUS:
		return put_user(0, p);
	case WDIOC_SETOPTIONS:
	{
		int new_options, retval = -EINVAL;

		if (get_user(new_options, p))
			return -EFAULT;
		if (new_options & WDIOS_DISABLECARD) {
			ali_stop();
			retval = 0;
Linus Torvalds's avatar
Linus Torvalds committed
208
		}
209 210 211
		if (new_options & WDIOS_ENABLECARD) {
			ali_start();
			retval = 0;
Linus Torvalds's avatar
Linus Torvalds committed
212
		}
213 214
		return retval;
	}
215 216 217
	case WDIOC_KEEPALIVE:
		ali_keepalive();
		return 0;
218 219 220 221 222 223 224 225 226 227 228 229 230 231
	case WDIOC_SETTIMEOUT:
	{
		int new_timeout;
		if (get_user(new_timeout, p))
			return -EFAULT;
		if (ali_settimer(new_timeout))
			return -EINVAL;
		ali_keepalive();
		/* Fall */
	}
	case WDIOC_GETTIMEOUT:
		return put_user(timeout, p);
	default:
		return -ENOTTY;
Linus Torvalds's avatar
Linus Torvalds committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
	}
}

/*
 *	ali_open	-	handle open of ali watchdog
 *	@inode: inode from VFS
 *	@file: file from VFS
 *
 *	Open the ALi watchdog device. Ensure only one person opens it
 *	at a time. Also start the watchdog running.
 */

static int ali_open(struct inode *inode, struct file *file)
{
	/* /dev/watchdog can only be opened once */
	if (test_and_set_bit(0, &ali_is_open))
		return -EBUSY;

	/* Activate */
	ali_start();
	return nonseekable_open(inode, file);
}

/*
 *	ali_release	-	close an ALi watchdog
 *	@inode: inode from VFS
 *	@file: file from VFS
 *
 *	Close the ALi watchdog device. Actual shutdown of the timer
 *	only occurs if the magic sequence has been set.
 */

static int ali_release(struct inode *inode, struct file *file)
{
	/*
	 *      Shut off the timer.
	 */
269
	if (ali_expect_release == 42)
Linus Torvalds's avatar
Linus Torvalds committed
270
		ali_stop();
271
	else {
272
		pr_crit("Unexpected close, not stopping watchdog!\n");
Linus Torvalds's avatar
Linus Torvalds committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286
		ali_keepalive();
	}
	clear_bit(0, &ali_is_open);
	ali_expect_release = 0;
	return 0;
}

/*
 *	ali_notify_sys	-	System down notifier
 *
 *	Notifier for system down
 */


287 288
static int ali_notify_sys(struct notifier_block *this,
					unsigned long code, void *unused)
Linus Torvalds's avatar
Linus Torvalds committed
289
{
290 291
	if (code == SYS_DOWN || code == SYS_HALT)
		ali_stop();		/* Turn the WDT off */
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294 295 296 297 298 299 300 301 302 303
	return NOTIFY_DONE;
}

/*
 *	Data for PCI driver interface
 *
 *	This data only exists for exporting the supported
 *	PCI ids via MODULE_DEVICE_TABLE.  We do not actually
 *	register a pci_driver, because someone else might one day
 *	want to register another driver on the same PCI id.
 */

304
static const struct pci_device_id ali_pci_tbl[] __used = {
305
	{ PCI_VENDOR_ID_AL, 0x1533, PCI_ANY_ID, PCI_ANY_ID,},
306
	{ PCI_VENDOR_ID_AL, 0x1535, PCI_ANY_ID, PCI_ANY_ID,},
Linus Torvalds's avatar
Linus Torvalds committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
	{ 0, },
};
MODULE_DEVICE_TABLE(pci, ali_pci_tbl);

/*
 *	ali_find_watchdog	-	find a 1535 and 7101
 *
 *	Scans the PCI hardware for a 1535 series bridge and matching 7101
 *	watchdog device. This may be overtight but it is better to be safe
 */

static int __init ali_find_watchdog(void)
{
	struct pci_dev *pdev;
	u32 wdog;

323
	/* Check for a 1533/1535 series bridge */
324
	pdev = pci_get_device(PCI_VENDOR_ID_AL, 0x1535, NULL);
325 326 327
	if (pdev == NULL)
		pdev = pci_get_device(PCI_VENDOR_ID_AL, 0x1533, NULL);
	if (pdev == NULL)
Linus Torvalds's avatar
Linus Torvalds committed
328
		return -ENODEV;
329
	pci_dev_put(pdev);
Linus Torvalds's avatar
Linus Torvalds committed
330 331

	/* Check for the a 7101 PMU */
332
	pdev = pci_get_device(PCI_VENDOR_ID_AL, 0x7101, NULL);
333
	if (pdev == NULL)
Linus Torvalds's avatar
Linus Torvalds committed
334 335
		return -ENODEV;

336
	if (pci_enable_device(pdev)) {
337
		pci_dev_put(pdev);
Linus Torvalds's avatar
Linus Torvalds committed
338
		return -EIO;
339
	}
Linus Torvalds's avatar
Linus Torvalds committed
340 341 342 343 344 345 346 347

	ali_pci = pdev;

	/*
	 *	Initialize the timer bits
	 */
	pci_read_config_dword(pdev, 0xCC, &wdog);

348 349 350
	/* Timer bits */
	wdog &= ~0x3F;
	/* Issued events */
351
	wdog &= ~((1 << 27)|(1 << 26)|(1 << 25)|(1 << 24));
352
	/* No monitor bits */
353
	wdog &= ~((1 << 16)|(1 << 13)|(1 << 12)|(1 << 11)|(1 << 10)|(1 << 9));
Linus Torvalds's avatar
Linus Torvalds committed
354 355 356 357 358 359 360 361 362 363

	pci_write_config_dword(pdev, 0xCC, wdog);

	return 0;
}

/*
 *	Kernel Interfaces
 */

364
static const struct file_operations ali_fops = {
365 366
	.owner		=	THIS_MODULE,
	.llseek		=	no_llseek,
367 368
	.write		=	ali_write,
	.unlocked_ioctl =	ali_ioctl,
369 370
	.open		=	ali_open,
	.release	=	ali_release,
Linus Torvalds's avatar
Linus Torvalds committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
};

static struct miscdevice ali_miscdev = {
	.minor =	WATCHDOG_MINOR,
	.name =		"watchdog",
	.fops =		&ali_fops,
};

static struct notifier_block ali_notifier = {
	.notifier_call =	ali_notify_sys,
};

/*
 *	watchdog_init	-	module initialiser
 *
 *	Scan for a suitable watchdog and if so initialize it. Return an error
 *	if we cannot, the error causes the module to unload
 */

static int __init watchdog_init(void)
{
	int ret;

	/* Check whether or not the hardware watchdog is there */
395
	if (ali_find_watchdog() != 0)
Linus Torvalds's avatar
Linus Torvalds committed
396 397
		return -ENODEV;

398 399
	/* Check that the timeout value is within it's range;
	   if not reset to the default */
Linus Torvalds's avatar
Linus Torvalds committed
400 401
	if (timeout < 1 || timeout >= 18000) {
		timeout = WATCHDOG_TIMEOUT;
402 403
		pr_info("timeout value must be 0 < timeout < 18000, using %d\n",
			timeout);
Linus Torvalds's avatar
Linus Torvalds committed
404 405 406 407 408
	}

	/* Calculate the watchdog's timeout */
	ali_settimer(timeout);

409
	ret = register_reboot_notifier(&ali_notifier);
Linus Torvalds's avatar
Linus Torvalds committed
410
	if (ret != 0) {
411
		pr_err("cannot register reboot notifier (err=%d)\n", ret);
Linus Torvalds's avatar
Linus Torvalds committed
412 413 414
		goto out;
	}

415
	ret = misc_register(&ali_miscdev);
Linus Torvalds's avatar
Linus Torvalds committed
416
	if (ret != 0) {
417 418
		pr_err("cannot register miscdev on minor=%d (err=%d)\n",
		       WATCHDOG_MINOR, ret);
419
		goto unreg_reboot;
Linus Torvalds's avatar
Linus Torvalds committed
420 421
	}

422
	pr_info("initialized. timeout=%d sec (nowayout=%d)\n",
Linus Torvalds's avatar
Linus Torvalds committed
423 424 425 426
		timeout, nowayout);

out:
	return ret;
427 428
unreg_reboot:
	unregister_reboot_notifier(&ali_notifier);
Linus Torvalds's avatar
Linus Torvalds committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
	goto out;
}

/*
 *	watchdog_exit	-	module de-initialiser
 *
 *	Called while unloading a successfully installed watchdog module.
 */

static void __exit watchdog_exit(void)
{
	/* Stop the timer before we leave */
	ali_stop();

	/* Deregister */
	misc_deregister(&ali_miscdev);
445
	unregister_reboot_notifier(&ali_notifier);
446
	pci_dev_put(ali_pci);
Linus Torvalds's avatar
Linus Torvalds committed
447 448 449 450 451 452 453 454
}

module_init(watchdog_init);
module_exit(watchdog_exit);

MODULE_AUTHOR("Alan Cox");
MODULE_DESCRIPTION("ALi M1535 PMU Watchdog Timer driver");
MODULE_LICENSE("GPL");