alim7101_wdt.c 10.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 *	ALi M7101 PMU Computer Watchdog Timer driver
 *
 *	Based on w83877f_wdt.c by Scott Jennings <linuxdrivers@oro.net>
 *	and the Cobalt kernel WDT timer driver by Tim Hockin
 *	                                      <thockin@cobaltnet.com>
 *
 *	(c)2002 Steve Hill <steve@navaho.co.uk>
 *
 *  This WDT driver is different from most other Linux WDT
 *  drivers in that the driver will ping the watchdog by itself,
 *  because this particular WDT has a very short timeout (1.6
 *  seconds) and it would be insane to count on any userspace
 *  daemon always getting scheduled within that time frame.
 *
 *  Additions:
 *   Aug 23, 2004 - Added use_gpio module parameter for use on revision a1d PMUs
 *                  found on very old cobalt hardware.
 *                  -- Mike Waychison <michael.waychison@sun.com>
 */

22 23
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

L
Linus Torvalds 已提交
24 25 26 27 28 29 30 31 32 33 34 35
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/types.h>
#include <linux/timer.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>
36 37
#include <linux/io.h>
#include <linux/uaccess.h>
W
Wim Van Sebroeck 已提交
38

L
Linus Torvalds 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

#define WDT_ENABLE 0x9C
#define WDT_DISABLE 0x8C

#define ALI_7101_WDT    0x92
#define ALI_7101_GPIO   0x7D
#define ALI_7101_GPIO_O 0x7E
#define ALI_WDT_ARM     0x01

/*
 * We're going to use a 1 second timeout.
 * If we reset the watchdog every ~250ms we should be safe.  */

#define WDT_INTERVAL (HZ/4+1)

/*
 * We must not require too good response from the userspace daemon.
 * Here we require the userspace daemon to send us a heartbeat
 * char to /dev/watchdog every 30 seconds.
 */

#define WATCHDOG_TIMEOUT 30            /* 30 sec default timeout */
61 62
/* in seconds, will be multiplied by HZ to get seconds to wait for a ping */
static int timeout = WATCHDOG_TIMEOUT;
L
Linus Torvalds 已提交
63
module_param(timeout, int, 0);
64 65 66
MODULE_PARM_DESC(timeout,
		"Watchdog timeout in seconds. (1<=timeout<=3600, default="
				__MODULE_STRING(WATCHDOG_TIMEOUT) ")");
L
Linus Torvalds 已提交
67

68
static int use_gpio; /* Use the pic (for a1d revision alim7101) */
L
Linus Torvalds 已提交
69
module_param(use_gpio, int, 0);
70 71
MODULE_PARM_DESC(use_gpio,
		"Use the gpio watchdog (required by old cobalt boards).");
L
Linus Torvalds 已提交
72 73

static void wdt_timer_ping(unsigned long);
74
static DEFINE_TIMER(timer, wdt_timer_ping);
L
Linus Torvalds 已提交
75 76 77 78 79
static unsigned long next_heartbeat;
static unsigned long wdt_is_open;
static char wdt_expect_close;
static struct pci_dev *alim7101_pmu;

W
Wim Van Sebroeck 已提交
80 81
static bool nowayout = WATCHDOG_NOWAYOUT;
module_param(nowayout, bool, 0);
82 83 84
MODULE_PARM_DESC(nowayout,
		"Watchdog cannot be stopped once started (default="
				__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
L
Linus Torvalds 已提交
85 86 87 88 89

/*
 *	Whack the dog
 */

90
static void wdt_timer_ping(unsigned long unused)
L
Linus Torvalds 已提交
91 92 93 94
{
	/* If we got a heartbeat pulse within the WDT_US_INTERVAL
	 * we agree to ping the WDT
	 */
95
	char tmp;
L
Linus Torvalds 已提交
96

97
	if (time_before(jiffies, next_heartbeat)) {
L
Linus Torvalds 已提交
98 99
		/* Ping the WDT (this is actually a disarm/arm sequence) */
		pci_read_config_byte(alim7101_pmu, 0x92, &tmp);
100 101 102 103
		pci_write_config_byte(alim7101_pmu,
					ALI_7101_WDT, (tmp & ~ALI_WDT_ARM));
		pci_write_config_byte(alim7101_pmu,
					ALI_7101_WDT, (tmp | ALI_WDT_ARM));
L
Linus Torvalds 已提交
104
		if (use_gpio) {
105 106 107 108 109 110
			pci_read_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, &tmp);
			pci_write_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, tmp | 0x20);
			pci_write_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, tmp & ~0x20);
L
Linus Torvalds 已提交
111 112
		}
	} else {
113
		pr_warn("Heartbeat lost! Will not ping the watchdog\n");
L
Linus Torvalds 已提交
114 115
	}
	/* Re-set the timer interval */
J
Jiri Slaby 已提交
116
	mod_timer(&timer, jiffies + WDT_INTERVAL);
L
Linus Torvalds 已提交
117 118 119 120 121 122 123 124
}

/*
 * Utility routines
 */

static void wdt_change(int writeval)
{
125
	char tmp;
L
Linus Torvalds 已提交
126 127 128

	pci_read_config_byte(alim7101_pmu, ALI_7101_WDT, &tmp);
	if (writeval == WDT_ENABLE) {
129 130
		pci_write_config_byte(alim7101_pmu,
					ALI_7101_WDT, (tmp | ALI_WDT_ARM));
L
Linus Torvalds 已提交
131
		if (use_gpio) {
132 133 134 135
			pci_read_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, &tmp);
			pci_write_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, tmp & ~0x20);
L
Linus Torvalds 已提交
136 137 138
		}

	} else {
139 140
		pci_write_config_byte(alim7101_pmu,
					ALI_7101_WDT, (tmp & ~ALI_WDT_ARM));
L
Linus Torvalds 已提交
141
		if (use_gpio) {
142 143 144 145
			pci_read_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, &tmp);
			pci_write_config_byte(alim7101_pmu,
					ALI_7101_GPIO_O, tmp | 0x20);
L
Linus Torvalds 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159
		}
	}
}

static void wdt_startup(void)
{
	next_heartbeat = jiffies + (timeout * HZ);

	/* We must enable before we kick off the timer in case the timer
	   occurs as we ping it */

	wdt_change(WDT_ENABLE);

	/* Start the timer */
J
Jiri Slaby 已提交
160
	mod_timer(&timer, jiffies + WDT_INTERVAL);
L
Linus Torvalds 已提交
161

162
	pr_info("Watchdog timer is now enabled\n");
L
Linus Torvalds 已提交
163 164 165 166 167 168 169
}

static void wdt_turnoff(void)
{
	/* Stop the timer */
	del_timer_sync(&timer);
	wdt_change(WDT_DISABLE);
170
	pr_info("Watchdog timer is now disabled...\n");
L
Linus Torvalds 已提交
171 172 173 174 175 176 177 178 179 180 181 182
}

static void wdt_keepalive(void)
{
	/* user land ping */
	next_heartbeat = jiffies + (timeout * HZ);
}

/*
 * /dev/watchdog handling
 */

183 184
static ssize_t fop_write(struct file *file, const char __user *buf,
						size_t count, loff_t *ppos)
L
Linus Torvalds 已提交
185 186
{
	/* See if we got the magic character 'V' and reload the timer */
187
	if (count) {
L
Linus Torvalds 已提交
188 189 190 191 192 193 194 195 196 197
		if (!nowayout) {
			size_t ofs;

			/* note: just in case someone wrote the magic character
			 * five months ago... */
			wdt_expect_close = 0;

			/* now scan */
			for (ofs = 0; ofs != count; ofs++) {
				char c;
198
				if (get_user(c, buf + ofs))
L
Linus Torvalds 已提交
199 200 201 202 203 204 205 206 207 208 209
					return -EFAULT;
				if (c == 'V')
					wdt_expect_close = 42;
			}
		}
		/* someone wrote to us, we should restart timer */
		wdt_keepalive();
	}
	return count;
}

210
static int fop_open(struct inode *inode, struct file *file)
L
Linus Torvalds 已提交
211 212
{
	/* Just in case we're already talking to someone... */
213
	if (test_and_set_bit(0, &wdt_is_open))
L
Linus Torvalds 已提交
214 215 216 217 218 219
		return -EBUSY;
	/* Good, fire up the show */
	wdt_startup();
	return nonseekable_open(inode, file);
}

220
static int fop_close(struct inode *inode, struct file *file)
L
Linus Torvalds 已提交
221
{
222
	if (wdt_expect_close == 42)
L
Linus Torvalds 已提交
223 224 225
		wdt_turnoff();
	else {
		/* wim: shouldn't there be a: del_timer(&timer); */
226
		pr_crit("device file closed unexpectedly. Will not stop the WDT!\n");
L
Linus Torvalds 已提交
227 228 229 230 231 232
	}
	clear_bit(0, &wdt_is_open);
	wdt_expect_close = 0;
	return 0;
}

233
static long fop_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
L
Linus Torvalds 已提交
234 235 236
{
	void __user *argp = (void __user *)arg;
	int __user *p = argp;
237
	static const struct watchdog_info ident = {
238 239
		.options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT
							| WDIOF_MAGICCLOSE,
L
Linus Torvalds 已提交
240 241 242 243
		.firmware_version = 1,
		.identity = "ALiM7101",
	};

244 245 246 247 248 249 250
	switch (cmd) {
	case WDIOC_GETSUPPORT:
		return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
	case WDIOC_GETSTATUS:
	case WDIOC_GETBOOTSTATUS:
		return put_user(0, p);
	case WDIOC_SETOPTIONS:
L
Linus Torvalds 已提交
251
	{
252
		int new_options, retval = -EINVAL;
L
Linus Torvalds 已提交
253

254 255 256 257 258
		if (get_user(new_options, p))
			return -EFAULT;
		if (new_options & WDIOS_DISABLECARD) {
			wdt_turnoff();
			retval = 0;
L
Linus Torvalds 已提交
259
		}
260 261 262
		if (new_options & WDIOS_ENABLECARD) {
			wdt_startup();
			retval = 0;
L
Linus Torvalds 已提交
263
		}
264 265
		return retval;
	}
266 267 268
	case WDIOC_KEEPALIVE:
		wdt_keepalive();
		return 0;
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
	case WDIOC_SETTIMEOUT:
	{
		int new_timeout;

		if (get_user(new_timeout, p))
			return -EFAULT;
		/* arbitrary upper limit */
		if (new_timeout < 1 || new_timeout > 3600)
			return -EINVAL;
		timeout = new_timeout;
		wdt_keepalive();
		/* Fall through */
	}
	case WDIOC_GETTIMEOUT:
		return put_user(timeout, p);
	default:
		return -ENOTTY;
L
Linus Torvalds 已提交
286 287 288
	}
}

289
static const struct file_operations wdt_fops = {
290 291 292 293 294 295
	.owner		=	THIS_MODULE,
	.llseek		=	no_llseek,
	.write		=	fop_write,
	.open		=	fop_open,
	.release	=	fop_close,
	.unlocked_ioctl	=	fop_ioctl,
L
Linus Torvalds 已提交
296 297 298
};

static struct miscdevice wdt_miscdev = {
299 300 301
	.minor	=	WATCHDOG_MINOR,
	.name	=	"watchdog",
	.fops	=	&wdt_fops,
L
Linus Torvalds 已提交
302 303
};

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
static int wdt_restart_handle(struct notifier_block *this, unsigned long mode,
			      void *cmd)
{
	/*
	 * Cobalt devices have no way of rebooting themselves other
	 * than getting the watchdog to pull reset, so we restart the
	 * watchdog on reboot with no heartbeat.
	 */
	wdt_change(WDT_ENABLE);

	/* loop until the watchdog fires */
	while (true)
		;

	return NOTIFY_DONE;
}

static struct notifier_block wdt_restart_handler = {
	.notifier_call = wdt_restart_handle,
	.priority = 128,
};

L
Linus Torvalds 已提交
326 327 328 329
/*
 *	Notifier for system down
 */

330 331
static int wdt_notify_sys(struct notifier_block *this,
					unsigned long code, void *unused)
L
Linus Torvalds 已提交
332
{
333
	if (code == SYS_DOWN || code == SYS_HALT)
L
Linus Torvalds 已提交
334 335 336 337 338 339 340 341 342 343
		wdt_turnoff();

	return NOTIFY_DONE;
}

/*
 *	The WDT needs to learn about soft shutdowns in order to
 *	turn the timebomb registers off.
 */

344
static struct notifier_block wdt_notifier = {
L
Linus Torvalds 已提交
345 346 347 348 349 350 351 352 353
	.notifier_call = wdt_notify_sys,
};

static void __exit alim7101_wdt_unload(void)
{
	wdt_turnoff();
	/* Deregister */
	misc_deregister(&wdt_miscdev);
	unregister_reboot_notifier(&wdt_notifier);
354
	unregister_restart_handler(&wdt_restart_handler);
355
	pci_dev_put(alim7101_pmu);
L
Linus Torvalds 已提交
356 357 358 359 360 361 362 363
}

static int __init alim7101_wdt_init(void)
{
	int rc = -EBUSY;
	struct pci_dev *ali1543_south;
	char tmp;

364
	pr_info("Steve Hill <steve@navaho.co.uk>\n");
365 366
	alim7101_pmu = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M7101,
		NULL);
L
Linus Torvalds 已提交
367
	if (!alim7101_pmu) {
368
		pr_info("ALi M7101 PMU not present - WDT not set\n");
L
Linus Torvalds 已提交
369 370 371 372 373 374
		return -EBUSY;
	}

	/* Set the WDT in the PMU to 1 second */
	pci_write_config_byte(alim7101_pmu, ALI_7101_WDT, 0x02);

375 376
	ali1543_south = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533,
		NULL);
L
Linus Torvalds 已提交
377
	if (!ali1543_south) {
378
		pr_info("ALi 1543 South-Bridge not present - WDT not set\n");
379
		goto err_out;
L
Linus Torvalds 已提交
380 381
	}
	pci_read_config_byte(ali1543_south, 0x5e, &tmp);
382
	pci_dev_put(ali1543_south);
L
Linus Torvalds 已提交
383 384
	if ((tmp & 0x1e) == 0x00) {
		if (!use_gpio) {
385
			pr_info("Detected old alim7101 revision 'a1d'.  If this is a cobalt board, set the 'use_gpio' module parameter.\n");
386
			goto err_out;
387
		}
L
Linus Torvalds 已提交
388 389
		nowayout = 1;
	} else if ((tmp & 0x1e) != 0x12 && (tmp & 0x1e) != 0x00) {
390
		pr_info("ALi 1543 South-Bridge does not have the correct revision number (???1001?) - WDT not set\n");
391
		goto err_out;
L
Linus Torvalds 已提交
392 393
	}

394 395
	if (timeout < 1 || timeout > 3600) {
		/* arbitrary upper limit */
L
Linus Torvalds 已提交
396
		timeout = WATCHDOG_TIMEOUT;
397 398
		pr_info("timeout value must be 1 <= x <= 3600, using %d\n",
			timeout);
L
Linus Torvalds 已提交
399 400
	}

401
	rc = register_reboot_notifier(&wdt_notifier);
L
Linus Torvalds 已提交
402
	if (rc) {
403
		pr_err("cannot register reboot notifier (err=%d)\n", rc);
L
Linus Torvalds 已提交
404 405 406
		goto err_out;
	}

407 408 409 410 411 412
	rc = register_restart_handler(&wdt_restart_handler);
	if (rc) {
		pr_err("cannot register restart handler (err=%d)\n", rc);
		goto err_out_reboot;
	}

413
	rc = misc_register(&wdt_miscdev);
L
Linus Torvalds 已提交
414
	if (rc) {
415 416
		pr_err("cannot register miscdev on minor=%d (err=%d)\n",
		       wdt_miscdev.minor, rc);
417
		goto err_out_restart;
L
Linus Torvalds 已提交
418 419
	}

420
	if (nowayout)
L
Linus Torvalds 已提交
421 422
		__module_get(THIS_MODULE);

423
	pr_info("WDT driver for ALi M7101 initialised. timeout=%d sec (nowayout=%d)\n",
L
Linus Torvalds 已提交
424 425 426
		timeout, nowayout);
	return 0;

427 428
err_out_restart:
	unregister_restart_handler(&wdt_restart_handler);
429 430
err_out_reboot:
	unregister_reboot_notifier(&wdt_notifier);
L
Linus Torvalds 已提交
431
err_out:
432
	pci_dev_put(alim7101_pmu);
L
Linus Torvalds 已提交
433 434 435 436 437 438
	return rc;
}

module_init(alim7101_wdt_init);
module_exit(alim7101_wdt_unload);

439
static const struct pci_device_id alim7101_pci_tbl[] __used = {
440 441
	{ PCI_DEVICE(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533) },
	{ PCI_DEVICE(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M7101) },
442 443 444 445 446
	{ }
};

MODULE_DEVICE_TABLE(pci, alim7101_pci_tbl);

L
Linus Torvalds 已提交
447 448 449
MODULE_AUTHOR("Steve Hill");
MODULE_DESCRIPTION("ALi M7101 PMU Computer Watchdog Timer driver");
MODULE_LICENSE("GPL");