Linux Audio

Check our new training course

Loading...
v5.9
  1// SPDX-License-Identifier: GPL-2.0-or-later
  2/***************************************************************************
  3 *   Copyright (C) 2006 by Hans Edgington <hans@edgington.nl>              *
  4 *   Copyright (C) 2007-2009 Hans de Goede <hdegoede@redhat.com>           *
  5 *   Copyright (C) 2010 Giel van Schijndel <me@mortis.eu>                  *
  6 *                                                                         *
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  7 ***************************************************************************/
  8
  9#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 10
 11#include <linux/err.h>
 12#include <linux/fs.h>
 13#include <linux/init.h>
 14#include <linux/io.h>
 15#include <linux/ioport.h>
 16#include <linux/miscdevice.h>
 17#include <linux/module.h>
 18#include <linux/mutex.h>
 19#include <linux/notifier.h>
 20#include <linux/reboot.h>
 21#include <linux/uaccess.h>
 22#include <linux/watchdog.h>
 23
 24#define DRVNAME "f71808e_wdt"
 25
 26#define SIO_F71808FG_LD_WDT	0x07	/* Watchdog timer logical device */
 27#define SIO_UNLOCK_KEY		0x87	/* Key to enable Super-I/O */
 28#define SIO_LOCK_KEY		0xAA	/* Key to disable Super-I/O */
 29
 30#define SIO_REG_LDSEL		0x07	/* Logical device select */
 31#define SIO_REG_DEVID		0x20	/* Device ID (2 bytes) */
 32#define SIO_REG_DEVREV		0x22	/* Device revision */
 33#define SIO_REG_MANID		0x23	/* Fintek ID (2 bytes) */
 34#define SIO_REG_CLOCK_SEL	0x26	/* Clock select */
 35#define SIO_REG_ROM_ADDR_SEL	0x27	/* ROM address select */
 36#define SIO_F81866_REG_PORT_SEL	0x27	/* F81866 Multi-Function Register */
 37#define SIO_REG_TSI_LEVEL_SEL	0x28	/* TSI Level select */
 38#define SIO_REG_MFUNCT1		0x29	/* Multi function select 1 */
 39#define SIO_REG_MFUNCT2		0x2a	/* Multi function select 2 */
 40#define SIO_REG_MFUNCT3		0x2b	/* Multi function select 3 */
 41#define SIO_F81866_REG_GPIO1	0x2c	/* F81866 GPIO1 Enable Register */
 42#define SIO_REG_ENABLE		0x30	/* Logical device enable */
 43#define SIO_REG_ADDR		0x60	/* Logical device address (2 bytes) */
 44
 45#define SIO_FINTEK_ID		0x1934	/* Manufacturers ID */
 46#define SIO_F71808_ID		0x0901	/* Chipset ID */
 47#define SIO_F71858_ID		0x0507	/* Chipset ID */
 48#define SIO_F71862_ID		0x0601	/* Chipset ID */
 49#define SIO_F71868_ID		0x1106	/* Chipset ID */
 50#define SIO_F71869_ID		0x0814	/* Chipset ID */
 51#define SIO_F71869A_ID		0x1007	/* Chipset ID */
 52#define SIO_F71882_ID		0x0541	/* Chipset ID */
 53#define SIO_F71889_ID		0x0723	/* Chipset ID */
 54#define SIO_F81803_ID		0x1210	/* Chipset ID */
 55#define SIO_F81865_ID		0x0704	/* Chipset ID */
 56#define SIO_F81866_ID		0x1010	/* Chipset ID */
 57
 58#define F71808FG_REG_WDO_CONF		0xf0
 59#define F71808FG_REG_WDT_CONF		0xf5
 60#define F71808FG_REG_WD_TIME		0xf6
 61
 62#define F71808FG_FLAG_WDOUT_EN		7
 63
 64#define F71808FG_FLAG_WDTMOUT_STS	6
 65#define F71808FG_FLAG_WD_EN		5
 66#define F71808FG_FLAG_WD_PULSE		4
 67#define F71808FG_FLAG_WD_UNIT		3
 68
 69#define F81865_REG_WDO_CONF		0xfa
 70#define F81865_FLAG_WDOUT_EN		0
 71
 72/* Default values */
 73#define WATCHDOG_TIMEOUT	60	/* 1 minute default timeout */
 74#define WATCHDOG_MAX_TIMEOUT	(60 * 255)
 75#define WATCHDOG_PULSE_WIDTH	125	/* 125 ms, default pulse width for
 76					   watchdog signal */
 77#define WATCHDOG_F71862FG_PIN	63	/* default watchdog reset output
 78					   pin number 63 */
 79
 80static unsigned short force_id;
 81module_param(force_id, ushort, 0);
 82MODULE_PARM_DESC(force_id, "Override the detected device ID");
 83
 84static const int max_timeout = WATCHDOG_MAX_TIMEOUT;
 85static int timeout = WATCHDOG_TIMEOUT;	/* default timeout in seconds */
 86module_param(timeout, int, 0);
 87MODULE_PARM_DESC(timeout,
 88	"Watchdog timeout in seconds. 1<= timeout <="
 89			__MODULE_STRING(WATCHDOG_MAX_TIMEOUT) " (default="
 90			__MODULE_STRING(WATCHDOG_TIMEOUT) ")");
 91
 92static unsigned int pulse_width = WATCHDOG_PULSE_WIDTH;
 93module_param(pulse_width, uint, 0);
 94MODULE_PARM_DESC(pulse_width,
 95	"Watchdog signal pulse width. 0(=level), 1, 25, 30, 125, 150, 5000 or 6000 ms"
 96			" (default=" __MODULE_STRING(WATCHDOG_PULSE_WIDTH) ")");
 97
 98static unsigned int f71862fg_pin = WATCHDOG_F71862FG_PIN;
 99module_param(f71862fg_pin, uint, 0);
100MODULE_PARM_DESC(f71862fg_pin,
101	"Watchdog f71862fg reset output pin configuration. Choose pin 56 or 63"
102			" (default=" __MODULE_STRING(WATCHDOG_F71862FG_PIN)")");
103
104static bool nowayout = WATCHDOG_NOWAYOUT;
105module_param(nowayout, bool, 0444);
106MODULE_PARM_DESC(nowayout, "Disable watchdog shutdown on close");
107
108static unsigned int start_withtimeout;
109module_param(start_withtimeout, uint, 0);
110MODULE_PARM_DESC(start_withtimeout, "Start watchdog timer on module load with"
111	" given initial timeout. Zero (default) disables this feature.");
112
113enum chips { f71808fg, f71858fg, f71862fg, f71868, f71869, f71882fg, f71889fg,
114	     f81803, f81865, f81866};
115
116static const char *f71808e_names[] = {
117	"f71808fg",
118	"f71858fg",
119	"f71862fg",
120	"f71868",
121	"f71869",
122	"f71882fg",
123	"f71889fg",
124	"f81803",
125	"f81865",
126	"f81866",
127};
128
129/* Super-I/O Function prototypes */
130static inline int superio_inb(int base, int reg);
131static inline int superio_inw(int base, int reg);
132static inline void superio_outb(int base, int reg, u8 val);
133static inline void superio_set_bit(int base, int reg, int bit);
134static inline void superio_clear_bit(int base, int reg, int bit);
135static inline int superio_enter(int base);
136static inline void superio_select(int base, int ld);
137static inline void superio_exit(int base);
138
139struct watchdog_data {
140	unsigned short	sioaddr;
141	enum chips	type;
142	unsigned long	opened;
143	struct mutex	lock;
144	char		expect_close;
145	struct watchdog_info ident;
146
147	unsigned short	timeout;
148	u8		timer_val;	/* content for the wd_time register */
149	char		minutes_mode;
150	u8		pulse_val;	/* pulse width flag */
151	char		pulse_mode;	/* enable pulse output mode? */
152	char		caused_reboot;	/* last reboot was by the watchdog */
153};
154
155static struct watchdog_data watchdog = {
156	.lock = __MUTEX_INITIALIZER(watchdog.lock),
157};
158
159/* Super I/O functions */
160static inline int superio_inb(int base, int reg)
161{
162	outb(reg, base);
163	return inb(base + 1);
164}
165
166static int superio_inw(int base, int reg)
167{
168	int val;
169	val  = superio_inb(base, reg) << 8;
170	val |= superio_inb(base, reg + 1);
171	return val;
172}
173
174static inline void superio_outb(int base, int reg, u8 val)
175{
176	outb(reg, base);
177	outb(val, base + 1);
178}
179
180static inline void superio_set_bit(int base, int reg, int bit)
181{
182	unsigned long val = superio_inb(base, reg);
183	__set_bit(bit, &val);
184	superio_outb(base, reg, val);
185}
186
187static inline void superio_clear_bit(int base, int reg, int bit)
188{
189	unsigned long val = superio_inb(base, reg);
190	__clear_bit(bit, &val);
191	superio_outb(base, reg, val);
192}
193
194static inline int superio_enter(int base)
195{
196	/* Don't step on other drivers' I/O space by accident */
197	if (!request_muxed_region(base, 2, DRVNAME)) {
198		pr_err("I/O address 0x%04x already in use\n", (int)base);
199		return -EBUSY;
200	}
201
202	/* according to the datasheet the key must be sent twice! */
203	outb(SIO_UNLOCK_KEY, base);
204	outb(SIO_UNLOCK_KEY, base);
205
206	return 0;
207}
208
209static inline void superio_select(int base, int ld)
210{
211	outb(SIO_REG_LDSEL, base);
212	outb(ld, base + 1);
213}
214
215static inline void superio_exit(int base)
216{
217	outb(SIO_LOCK_KEY, base);
218	release_region(base, 2);
219}
220
221static int watchdog_set_timeout(int timeout)
222{
223	if (timeout <= 0
224	 || timeout >  max_timeout) {
225		pr_err("watchdog timeout out of range\n");
226		return -EINVAL;
227	}
228
229	mutex_lock(&watchdog.lock);
230
231	watchdog.timeout = timeout;
232	if (timeout > 0xff) {
233		watchdog.timer_val = DIV_ROUND_UP(timeout, 60);
234		watchdog.minutes_mode = true;
235	} else {
236		watchdog.timer_val = timeout;
237		watchdog.minutes_mode = false;
238	}
239
240	mutex_unlock(&watchdog.lock);
241
242	return 0;
243}
244
245static int watchdog_set_pulse_width(unsigned int pw)
246{
247	int err = 0;
248	unsigned int t1 = 25, t2 = 125, t3 = 5000;
249
250	if (watchdog.type == f71868) {
251		t1 = 30;
252		t2 = 150;
253		t3 = 6000;
254	}
255
256	mutex_lock(&watchdog.lock);
257
258	if        (pw <=  1) {
259		watchdog.pulse_val = 0;
260	} else if (pw <= t1) {
261		watchdog.pulse_val = 1;
262	} else if (pw <= t2) {
263		watchdog.pulse_val = 2;
264	} else if (pw <= t3) {
265		watchdog.pulse_val = 3;
266	} else {
267		pr_err("pulse width out of range\n");
268		err = -EINVAL;
269		goto exit_unlock;
270	}
271
272	watchdog.pulse_mode = pw;
273
274exit_unlock:
275	mutex_unlock(&watchdog.lock);
276	return err;
277}
278
279static int watchdog_keepalive(void)
280{
281	int err = 0;
282
283	mutex_lock(&watchdog.lock);
284	err = superio_enter(watchdog.sioaddr);
285	if (err)
286		goto exit_unlock;
287	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
288
289	if (watchdog.minutes_mode)
290		/* select minutes for timer units */
291		superio_set_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
292				F71808FG_FLAG_WD_UNIT);
293	else
294		/* select seconds for timer units */
295		superio_clear_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
296				F71808FG_FLAG_WD_UNIT);
297
298	/* Set timer value */
299	superio_outb(watchdog.sioaddr, F71808FG_REG_WD_TIME,
300			   watchdog.timer_val);
301
302	superio_exit(watchdog.sioaddr);
303
304exit_unlock:
305	mutex_unlock(&watchdog.lock);
306	return err;
307}
308
309static int watchdog_start(void)
310{
311	int err;
312	u8 tmp;
313
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
314	/* Make sure we don't die as soon as the watchdog is enabled below */
315	err = watchdog_keepalive();
316	if (err)
317		return err;
318
319	mutex_lock(&watchdog.lock);
320	err = superio_enter(watchdog.sioaddr);
321	if (err)
322		goto exit_unlock;
323	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
324
325	/* Watchdog pin configuration */
326	switch (watchdog.type) {
327	case f71808fg:
328		/* Set pin 21 to GPIO23/WDTRST#, then to WDTRST# */
329		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT2, 3);
330		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT3, 3);
331		break;
332
333	case f71862fg:
334		if (f71862fg_pin == 63) {
335			/* SPI must be disabled first to use this pin! */
336			superio_clear_bit(watchdog.sioaddr, SIO_REG_ROM_ADDR_SEL, 6);
337			superio_set_bit(watchdog.sioaddr, SIO_REG_MFUNCT3, 4);
338		} else if (f71862fg_pin == 56) {
339			superio_set_bit(watchdog.sioaddr, SIO_REG_MFUNCT1, 1);
340		}
341		break;
342
343	case f71868:
344	case f71869:
345		/* GPIO14 --> WDTRST# */
346		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT1, 4);
347		break;
348
349	case f71882fg:
350		/* Set pin 56 to WDTRST# */
351		superio_set_bit(watchdog.sioaddr, SIO_REG_MFUNCT1, 1);
352		break;
353
354	case f71889fg:
355		/* set pin 40 to WDTRST# */
356		superio_outb(watchdog.sioaddr, SIO_REG_MFUNCT3,
357			superio_inb(watchdog.sioaddr, SIO_REG_MFUNCT3) & 0xcf);
358		break;
359
360	case f81803:
361		/* Enable TSI Level register bank */
362		superio_clear_bit(watchdog.sioaddr, SIO_REG_CLOCK_SEL, 3);
363		/* Set pin 27 to WDTRST# */
364		superio_outb(watchdog.sioaddr, SIO_REG_TSI_LEVEL_SEL, 0x5f &
365			superio_inb(watchdog.sioaddr, SIO_REG_TSI_LEVEL_SEL));
366		break;
367
368	case f81865:
369		/* Set pin 70 to WDTRST# */
370		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT3, 5);
371		break;
372
373	case f81866:
 
 
 
 
 
374		/*
375		 * GPIO1 Control Register when 27h BIT3:2 = 01 & BIT0 = 0.
376		 * The PIN 70(GPIO15/WDTRST) is controlled by 2Ch:
377		 *     BIT5: 0 -> WDTRST#
378		 *           1 -> GPIO15
379		 */
380		tmp = superio_inb(watchdog.sioaddr, SIO_F81866_REG_PORT_SEL);
381		tmp &= ~(BIT(3) | BIT(0));
382		tmp |= BIT(2);
383		superio_outb(watchdog.sioaddr, SIO_F81866_REG_PORT_SEL, tmp);
384
385		superio_clear_bit(watchdog.sioaddr, SIO_F81866_REG_GPIO1, 5);
386		break;
387
388	default:
389		/*
390		 * 'default' label to shut up the compiler and catch
391		 * programmer errors
392		 */
393		err = -ENODEV;
394		goto exit_superio;
395	}
396
397	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
398	superio_set_bit(watchdog.sioaddr, SIO_REG_ENABLE, 0);
399
400	if (watchdog.type == f81865 || watchdog.type == f81866)
401		superio_set_bit(watchdog.sioaddr, F81865_REG_WDO_CONF,
402				F81865_FLAG_WDOUT_EN);
403	else
404		superio_set_bit(watchdog.sioaddr, F71808FG_REG_WDO_CONF,
405				F71808FG_FLAG_WDOUT_EN);
406
407	superio_set_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
408			F71808FG_FLAG_WD_EN);
409
410	if (watchdog.pulse_mode) {
411		/* Select "pulse" output mode with given duration */
412		u8 wdt_conf = superio_inb(watchdog.sioaddr,
413				F71808FG_REG_WDT_CONF);
414
415		/* Set WD_PSWIDTH bits (1:0) */
416		wdt_conf = (wdt_conf & 0xfc) | (watchdog.pulse_val & 0x03);
417		/* Set WD_PULSE to "pulse" mode */
418		wdt_conf |= BIT(F71808FG_FLAG_WD_PULSE);
419
420		superio_outb(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
421				wdt_conf);
422	} else {
423		/* Select "level" output mode */
424		superio_clear_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
425				F71808FG_FLAG_WD_PULSE);
426	}
427
428exit_superio:
429	superio_exit(watchdog.sioaddr);
430exit_unlock:
431	mutex_unlock(&watchdog.lock);
432
433	return err;
434}
435
436static int watchdog_stop(void)
437{
438	int err = 0;
439
440	mutex_lock(&watchdog.lock);
441	err = superio_enter(watchdog.sioaddr);
442	if (err)
443		goto exit_unlock;
444	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
445
446	superio_clear_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
447			F71808FG_FLAG_WD_EN);
448
449	superio_exit(watchdog.sioaddr);
450
451exit_unlock:
452	mutex_unlock(&watchdog.lock);
453
454	return err;
455}
456
457static int watchdog_get_status(void)
458{
459	int status = 0;
460
461	mutex_lock(&watchdog.lock);
462	status = (watchdog.caused_reboot) ? WDIOF_CARDRESET : 0;
463	mutex_unlock(&watchdog.lock);
464
465	return status;
466}
467
468static bool watchdog_is_running(void)
469{
470	/*
471	 * if we fail to determine the watchdog's status assume it to be
472	 * running to be on the safe side
473	 */
474	bool is_running = true;
475
476	mutex_lock(&watchdog.lock);
477	if (superio_enter(watchdog.sioaddr))
478		goto exit_unlock;
479	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
480
481	is_running = (superio_inb(watchdog.sioaddr, SIO_REG_ENABLE) & BIT(0))
482		&& (superio_inb(watchdog.sioaddr, F71808FG_REG_WDT_CONF)
483			& BIT(F71808FG_FLAG_WD_EN));
484
485	superio_exit(watchdog.sioaddr);
486
487exit_unlock:
488	mutex_unlock(&watchdog.lock);
489	return is_running;
490}
491
492/* /dev/watchdog api */
493
494static int watchdog_open(struct inode *inode, struct file *file)
495{
496	int err;
497
498	/* If the watchdog is alive we don't need to start it again */
499	if (test_and_set_bit(0, &watchdog.opened))
500		return -EBUSY;
501
502	err = watchdog_start();
503	if (err) {
504		clear_bit(0, &watchdog.opened);
505		return err;
506	}
507
508	if (nowayout)
509		__module_get(THIS_MODULE);
510
511	watchdog.expect_close = 0;
512	return stream_open(inode, file);
513}
514
515static int watchdog_release(struct inode *inode, struct file *file)
516{
517	clear_bit(0, &watchdog.opened);
518
519	if (!watchdog.expect_close) {
520		watchdog_keepalive();
521		pr_crit("Unexpected close, not stopping watchdog!\n");
522	} else if (!nowayout) {
523		watchdog_stop();
524	}
525	return 0;
526}
527
528/*
529 *      watchdog_write:
530 *      @file: file handle to the watchdog
531 *      @buf: buffer to write
532 *      @count: count of bytes
533 *      @ppos: pointer to the position to write. No seeks allowed
534 *
535 *      A write to a watchdog device is defined as a keepalive signal. Any
536 *      write of data will do, as we we don't define content meaning.
537 */
538
539static ssize_t watchdog_write(struct file *file, const char __user *buf,
540			    size_t count, loff_t *ppos)
541{
542	if (count) {
543		if (!nowayout) {
544			size_t i;
545
546			/* In case it was set long ago */
547			bool expect_close = false;
548
549			for (i = 0; i != count; i++) {
550				char c;
551				if (get_user(c, buf + i))
552					return -EFAULT;
553				if (c == 'V')
554					expect_close = true;
555			}
556
557			/* Properly order writes across fork()ed processes */
558			mutex_lock(&watchdog.lock);
559			watchdog.expect_close = expect_close;
560			mutex_unlock(&watchdog.lock);
561		}
562
563		/* someone wrote to us, we should restart timer */
564		watchdog_keepalive();
565	}
566	return count;
567}
568
569/*
570 *      watchdog_ioctl:
571 *      @inode: inode of the device
572 *      @file: file handle to the device
573 *      @cmd: watchdog command
574 *      @arg: argument pointer
575 *
576 *      The watchdog API defines a common set of functions for all watchdogs
577 *      according to their available features.
578 */
579static long watchdog_ioctl(struct file *file, unsigned int cmd,
580	unsigned long arg)
581{
582	int status;
583	int new_options;
584	int new_timeout;
585	union {
586		struct watchdog_info __user *ident;
587		int __user *i;
588	} uarg;
589
590	uarg.i = (int __user *)arg;
591
592	switch (cmd) {
593	case WDIOC_GETSUPPORT:
594		return copy_to_user(uarg.ident, &watchdog.ident,
595			sizeof(watchdog.ident)) ? -EFAULT : 0;
596
597	case WDIOC_GETSTATUS:
598		status = watchdog_get_status();
599		if (status < 0)
600			return status;
601		return put_user(status, uarg.i);
602
603	case WDIOC_GETBOOTSTATUS:
604		return put_user(0, uarg.i);
605
606	case WDIOC_SETOPTIONS:
607		if (get_user(new_options, uarg.i))
608			return -EFAULT;
609
610		if (new_options & WDIOS_DISABLECARD)
611			watchdog_stop();
612
613		if (new_options & WDIOS_ENABLECARD)
614			return watchdog_start();
615		fallthrough;
616
617	case WDIOC_KEEPALIVE:
618		watchdog_keepalive();
619		return 0;
620
621	case WDIOC_SETTIMEOUT:
622		if (get_user(new_timeout, uarg.i))
623			return -EFAULT;
624
625		if (watchdog_set_timeout(new_timeout))
626			return -EINVAL;
627
628		watchdog_keepalive();
629		fallthrough;
630
631	case WDIOC_GETTIMEOUT:
632		return put_user(watchdog.timeout, uarg.i);
633
634	default:
635		return -ENOTTY;
636
637	}
638}
639
640static int watchdog_notify_sys(struct notifier_block *this, unsigned long code,
641	void *unused)
642{
643	if (code == SYS_DOWN || code == SYS_HALT)
644		watchdog_stop();
645	return NOTIFY_DONE;
646}
647
648static const struct file_operations watchdog_fops = {
649	.owner		= THIS_MODULE,
650	.llseek		= no_llseek,
651	.open		= watchdog_open,
652	.release	= watchdog_release,
653	.write		= watchdog_write,
654	.unlocked_ioctl	= watchdog_ioctl,
655	.compat_ioctl	= compat_ptr_ioctl,
656};
657
658static struct miscdevice watchdog_miscdev = {
659	.minor		= WATCHDOG_MINOR,
660	.name		= "watchdog",
661	.fops		= &watchdog_fops,
662};
663
664static struct notifier_block watchdog_notifier = {
665	.notifier_call = watchdog_notify_sys,
666};
667
668static int __init watchdog_init(int sioaddr)
669{
670	int wdt_conf, err = 0;
671
672	/* No need to lock watchdog.lock here because no entry points
673	 * into the module have been registered yet.
674	 */
675	watchdog.sioaddr = sioaddr;
676	watchdog.ident.options = WDIOF_MAGICCLOSE
677				| WDIOF_KEEPALIVEPING
678				| WDIOF_CARDRESET;
679
680	snprintf(watchdog.ident.identity,
681		sizeof(watchdog.ident.identity), "%s watchdog",
682		f71808e_names[watchdog.type]);
683
684	err = superio_enter(sioaddr);
685	if (err)
686		return err;
687	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
688
689	wdt_conf = superio_inb(sioaddr, F71808FG_REG_WDT_CONF);
690	watchdog.caused_reboot = wdt_conf & BIT(F71808FG_FLAG_WDTMOUT_STS);
691
692	/*
693	 * We don't want WDTMOUT_STS to stick around till regular reboot.
694	 * Write 1 to the bit to clear it to zero.
695	 */
696	superio_outb(sioaddr, F71808FG_REG_WDT_CONF,
697		     wdt_conf | BIT(F71808FG_FLAG_WDTMOUT_STS));
698
699	superio_exit(sioaddr);
700
701	err = watchdog_set_timeout(timeout);
702	if (err)
703		return err;
704	err = watchdog_set_pulse_width(pulse_width);
705	if (err)
706		return err;
707
708	err = register_reboot_notifier(&watchdog_notifier);
709	if (err)
710		return err;
711
712	err = misc_register(&watchdog_miscdev);
713	if (err) {
714		pr_err("cannot register miscdev on minor=%d\n",
715		       watchdog_miscdev.minor);
716		goto exit_reboot;
717	}
718
719	if (start_withtimeout) {
720		if (start_withtimeout <= 0
721		 || start_withtimeout >  max_timeout) {
722			pr_err("starting timeout out of range\n");
723			err = -EINVAL;
724			goto exit_miscdev;
725		}
726
727		err = watchdog_start();
728		if (err) {
729			pr_err("cannot start watchdog timer\n");
730			goto exit_miscdev;
731		}
732
733		mutex_lock(&watchdog.lock);
734		err = superio_enter(sioaddr);
735		if (err)
736			goto exit_unlock;
737		superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
738
739		if (start_withtimeout > 0xff) {
740			/* select minutes for timer units */
741			superio_set_bit(sioaddr, F71808FG_REG_WDT_CONF,
742				F71808FG_FLAG_WD_UNIT);
743			superio_outb(sioaddr, F71808FG_REG_WD_TIME,
744				DIV_ROUND_UP(start_withtimeout, 60));
745		} else {
746			/* select seconds for timer units */
747			superio_clear_bit(sioaddr, F71808FG_REG_WDT_CONF,
748				F71808FG_FLAG_WD_UNIT);
749			superio_outb(sioaddr, F71808FG_REG_WD_TIME,
750				start_withtimeout);
751		}
752
753		superio_exit(sioaddr);
754		mutex_unlock(&watchdog.lock);
755
756		if (nowayout)
757			__module_get(THIS_MODULE);
758
759		pr_info("watchdog started with initial timeout of %u sec\n",
760			start_withtimeout);
761	}
762
763	return 0;
764
765exit_unlock:
766	mutex_unlock(&watchdog.lock);
767exit_miscdev:
768	misc_deregister(&watchdog_miscdev);
769exit_reboot:
770	unregister_reboot_notifier(&watchdog_notifier);
771
772	return err;
773}
774
775static int __init f71808e_find(int sioaddr)
776{
777	u16 devid;
778	int err = superio_enter(sioaddr);
779	if (err)
780		return err;
781
782	devid = superio_inw(sioaddr, SIO_REG_MANID);
783	if (devid != SIO_FINTEK_ID) {
784		pr_debug("Not a Fintek device\n");
785		err = -ENODEV;
786		goto exit;
787	}
788
789	devid = force_id ? force_id : superio_inw(sioaddr, SIO_REG_DEVID);
790	switch (devid) {
791	case SIO_F71808_ID:
792		watchdog.type = f71808fg;
793		break;
794	case SIO_F71862_ID:
795		watchdog.type = f71862fg;
 
796		break;
797	case SIO_F71868_ID:
798		watchdog.type = f71868;
799		break;
800	case SIO_F71869_ID:
801	case SIO_F71869A_ID:
802		watchdog.type = f71869;
803		break;
804	case SIO_F71882_ID:
805		watchdog.type = f71882fg;
806		break;
807	case SIO_F71889_ID:
808		watchdog.type = f71889fg;
809		break;
810	case SIO_F71858_ID:
811		/* Confirmed (by datasheet) not to have a watchdog. */
812		err = -ENODEV;
813		goto exit;
814	case SIO_F81803_ID:
815		watchdog.type = f81803;
816		break;
817	case SIO_F81865_ID:
818		watchdog.type = f81865;
819		break;
820	case SIO_F81866_ID:
821		watchdog.type = f81866;
822		break;
823	default:
824		pr_info("Unrecognized Fintek device: %04x\n",
825			(unsigned int)devid);
826		err = -ENODEV;
827		goto exit;
828	}
829
830	pr_info("Found %s watchdog chip, revision %d\n",
831		f71808e_names[watchdog.type],
832		(int)superio_inb(sioaddr, SIO_REG_DEVREV));
833exit:
834	superio_exit(sioaddr);
835	return err;
836}
837
838static int __init f71808e_init(void)
839{
840	static const unsigned short addrs[] = { 0x2e, 0x4e };
841	int err = -ENODEV;
842	int i;
843
844	if (f71862fg_pin != 63 && f71862fg_pin != 56) {
845		pr_err("Invalid argument f71862fg_pin=%d\n", f71862fg_pin);
846		return -EINVAL;
847	}
848
849	for (i = 0; i < ARRAY_SIZE(addrs); i++) {
850		err = f71808e_find(addrs[i]);
851		if (err == 0)
852			break;
853	}
854	if (i == ARRAY_SIZE(addrs))
855		return err;
856
857	return watchdog_init(addrs[i]);
858}
859
860static void __exit f71808e_exit(void)
861{
862	if (watchdog_is_running()) {
863		pr_warn("Watchdog timer still running, stopping it\n");
864		watchdog_stop();
865	}
866	misc_deregister(&watchdog_miscdev);
867	unregister_reboot_notifier(&watchdog_notifier);
868}
869
870MODULE_DESCRIPTION("F71808E Watchdog Driver");
871MODULE_AUTHOR("Giel van Schijndel <me@mortis.eu>");
872MODULE_LICENSE("GPL");
873
874module_init(f71808e_init);
875module_exit(f71808e_exit);
v4.17
 
  1/***************************************************************************
  2 *   Copyright (C) 2006 by Hans Edgington <hans@edgington.nl>              *
  3 *   Copyright (C) 2007-2009 Hans de Goede <hdegoede@redhat.com>           *
  4 *   Copyright (C) 2010 Giel van Schijndel <me@mortis.eu>                  *
  5 *                                                                         *
  6 *   This program is free software; you can redistribute it and/or modify  *
  7 *   it under the terms of the GNU General Public License as published by  *
  8 *   the Free Software Foundation; either version 2 of the License, or     *
  9 *   (at your option) any later version.                                   *
 10 *                                                                         *
 11 *   This program is distributed in the hope that it will be useful,       *
 12 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 13 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 14 *   GNU General Public License for more details.                          *
 15 *                                                                         *
 16 *   You should have received a copy of the GNU General Public License     *
 17 *   along with this program; if not, write to the                         *
 18 *   Free Software Foundation, Inc.,                                       *
 19 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 20 ***************************************************************************/
 21
 22#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 23
 24#include <linux/err.h>
 25#include <linux/fs.h>
 26#include <linux/init.h>
 27#include <linux/io.h>
 28#include <linux/ioport.h>
 29#include <linux/miscdevice.h>
 30#include <linux/module.h>
 31#include <linux/mutex.h>
 32#include <linux/notifier.h>
 33#include <linux/reboot.h>
 34#include <linux/uaccess.h>
 35#include <linux/watchdog.h>
 36
 37#define DRVNAME "f71808e_wdt"
 38
 39#define SIO_F71808FG_LD_WDT	0x07	/* Watchdog timer logical device */
 40#define SIO_UNLOCK_KEY		0x87	/* Key to enable Super-I/O */
 41#define SIO_LOCK_KEY		0xAA	/* Key to disable Super-I/O */
 42
 43#define SIO_REG_LDSEL		0x07	/* Logical device select */
 44#define SIO_REG_DEVID		0x20	/* Device ID (2 bytes) */
 45#define SIO_REG_DEVREV		0x22	/* Device revision */
 46#define SIO_REG_MANID		0x23	/* Fintek ID (2 bytes) */
 
 47#define SIO_REG_ROM_ADDR_SEL	0x27	/* ROM address select */
 48#define SIO_F81866_REG_PORT_SEL	0x27	/* F81866 Multi-Function Register */
 
 49#define SIO_REG_MFUNCT1		0x29	/* Multi function select 1 */
 50#define SIO_REG_MFUNCT2		0x2a	/* Multi function select 2 */
 51#define SIO_REG_MFUNCT3		0x2b	/* Multi function select 3 */
 52#define SIO_F81866_REG_GPIO1	0x2c	/* F81866 GPIO1 Enable Register */
 53#define SIO_REG_ENABLE		0x30	/* Logical device enable */
 54#define SIO_REG_ADDR		0x60	/* Logical device address (2 bytes) */
 55
 56#define SIO_FINTEK_ID		0x1934	/* Manufacturers ID */
 57#define SIO_F71808_ID		0x0901	/* Chipset ID */
 58#define SIO_F71858_ID		0x0507	/* Chipset ID */
 59#define SIO_F71862_ID		0x0601	/* Chipset ID */
 60#define SIO_F71868_ID		0x1106	/* Chipset ID */
 61#define SIO_F71869_ID		0x0814	/* Chipset ID */
 62#define SIO_F71869A_ID		0x1007	/* Chipset ID */
 63#define SIO_F71882_ID		0x0541	/* Chipset ID */
 64#define SIO_F71889_ID		0x0723	/* Chipset ID */
 
 65#define SIO_F81865_ID		0x0704	/* Chipset ID */
 66#define SIO_F81866_ID		0x1010	/* Chipset ID */
 67
 68#define F71808FG_REG_WDO_CONF		0xf0
 69#define F71808FG_REG_WDT_CONF		0xf5
 70#define F71808FG_REG_WD_TIME		0xf6
 71
 72#define F71808FG_FLAG_WDOUT_EN		7
 73
 74#define F71808FG_FLAG_WDTMOUT_STS	6
 75#define F71808FG_FLAG_WD_EN		5
 76#define F71808FG_FLAG_WD_PULSE		4
 77#define F71808FG_FLAG_WD_UNIT		3
 78
 79#define F81865_REG_WDO_CONF		0xfa
 80#define F81865_FLAG_WDOUT_EN		0
 81
 82/* Default values */
 83#define WATCHDOG_TIMEOUT	60	/* 1 minute default timeout */
 84#define WATCHDOG_MAX_TIMEOUT	(60 * 255)
 85#define WATCHDOG_PULSE_WIDTH	125	/* 125 ms, default pulse width for
 86					   watchdog signal */
 87#define WATCHDOG_F71862FG_PIN	63	/* default watchdog reset output
 88					   pin number 63 */
 89
 90static unsigned short force_id;
 91module_param(force_id, ushort, 0);
 92MODULE_PARM_DESC(force_id, "Override the detected device ID");
 93
 94static const int max_timeout = WATCHDOG_MAX_TIMEOUT;
 95static int timeout = WATCHDOG_TIMEOUT;	/* default timeout in seconds */
 96module_param(timeout, int, 0);
 97MODULE_PARM_DESC(timeout,
 98	"Watchdog timeout in seconds. 1<= timeout <="
 99			__MODULE_STRING(WATCHDOG_MAX_TIMEOUT) " (default="
100			__MODULE_STRING(WATCHDOG_TIMEOUT) ")");
101
102static unsigned int pulse_width = WATCHDOG_PULSE_WIDTH;
103module_param(pulse_width, uint, 0);
104MODULE_PARM_DESC(pulse_width,
105	"Watchdog signal pulse width. 0(=level), 1, 25, 30, 125, 150, 5000 or 6000 ms"
106			" (default=" __MODULE_STRING(WATCHDOG_PULSE_WIDTH) ")");
107
108static unsigned int f71862fg_pin = WATCHDOG_F71862FG_PIN;
109module_param(f71862fg_pin, uint, 0);
110MODULE_PARM_DESC(f71862fg_pin,
111	"Watchdog f71862fg reset output pin configuration. Choose pin 56 or 63"
112			" (default=" __MODULE_STRING(WATCHDOG_F71862FG_PIN)")");
113
114static bool nowayout = WATCHDOG_NOWAYOUT;
115module_param(nowayout, bool, 0444);
116MODULE_PARM_DESC(nowayout, "Disable watchdog shutdown on close");
117
118static unsigned int start_withtimeout;
119module_param(start_withtimeout, uint, 0);
120MODULE_PARM_DESC(start_withtimeout, "Start watchdog timer on module load with"
121	" given initial timeout. Zero (default) disables this feature.");
122
123enum chips { f71808fg, f71858fg, f71862fg, f71868, f71869, f71882fg, f71889fg,
124	     f81865, f81866};
125
126static const char *f71808e_names[] = {
127	"f71808fg",
128	"f71858fg",
129	"f71862fg",
130	"f71868",
131	"f71869",
132	"f71882fg",
133	"f71889fg",
 
134	"f81865",
135	"f81866",
136};
137
138/* Super-I/O Function prototypes */
139static inline int superio_inb(int base, int reg);
140static inline int superio_inw(int base, int reg);
141static inline void superio_outb(int base, int reg, u8 val);
142static inline void superio_set_bit(int base, int reg, int bit);
143static inline void superio_clear_bit(int base, int reg, int bit);
144static inline int superio_enter(int base);
145static inline void superio_select(int base, int ld);
146static inline void superio_exit(int base);
147
148struct watchdog_data {
149	unsigned short	sioaddr;
150	enum chips	type;
151	unsigned long	opened;
152	struct mutex	lock;
153	char		expect_close;
154	struct watchdog_info ident;
155
156	unsigned short	timeout;
157	u8		timer_val;	/* content for the wd_time register */
158	char		minutes_mode;
159	u8		pulse_val;	/* pulse width flag */
160	char		pulse_mode;	/* enable pulse output mode? */
161	char		caused_reboot;	/* last reboot was by the watchdog */
162};
163
164static struct watchdog_data watchdog = {
165	.lock = __MUTEX_INITIALIZER(watchdog.lock),
166};
167
168/* Super I/O functions */
169static inline int superio_inb(int base, int reg)
170{
171	outb(reg, base);
172	return inb(base + 1);
173}
174
175static int superio_inw(int base, int reg)
176{
177	int val;
178	val  = superio_inb(base, reg) << 8;
179	val |= superio_inb(base, reg + 1);
180	return val;
181}
182
183static inline void superio_outb(int base, int reg, u8 val)
184{
185	outb(reg, base);
186	outb(val, base + 1);
187}
188
189static inline void superio_set_bit(int base, int reg, int bit)
190{
191	unsigned long val = superio_inb(base, reg);
192	__set_bit(bit, &val);
193	superio_outb(base, reg, val);
194}
195
196static inline void superio_clear_bit(int base, int reg, int bit)
197{
198	unsigned long val = superio_inb(base, reg);
199	__clear_bit(bit, &val);
200	superio_outb(base, reg, val);
201}
202
203static inline int superio_enter(int base)
204{
205	/* Don't step on other drivers' I/O space by accident */
206	if (!request_muxed_region(base, 2, DRVNAME)) {
207		pr_err("I/O address 0x%04x already in use\n", (int)base);
208		return -EBUSY;
209	}
210
211	/* according to the datasheet the key must be sent twice! */
212	outb(SIO_UNLOCK_KEY, base);
213	outb(SIO_UNLOCK_KEY, base);
214
215	return 0;
216}
217
218static inline void superio_select(int base, int ld)
219{
220	outb(SIO_REG_LDSEL, base);
221	outb(ld, base + 1);
222}
223
224static inline void superio_exit(int base)
225{
226	outb(SIO_LOCK_KEY, base);
227	release_region(base, 2);
228}
229
230static int watchdog_set_timeout(int timeout)
231{
232	if (timeout <= 0
233	 || timeout >  max_timeout) {
234		pr_err("watchdog timeout out of range\n");
235		return -EINVAL;
236	}
237
238	mutex_lock(&watchdog.lock);
239
240	watchdog.timeout = timeout;
241	if (timeout > 0xff) {
242		watchdog.timer_val = DIV_ROUND_UP(timeout, 60);
243		watchdog.minutes_mode = true;
244	} else {
245		watchdog.timer_val = timeout;
246		watchdog.minutes_mode = false;
247	}
248
249	mutex_unlock(&watchdog.lock);
250
251	return 0;
252}
253
254static int watchdog_set_pulse_width(unsigned int pw)
255{
256	int err = 0;
257	unsigned int t1 = 25, t2 = 125, t3 = 5000;
258
259	if (watchdog.type == f71868) {
260		t1 = 30;
261		t2 = 150;
262		t3 = 6000;
263	}
264
265	mutex_lock(&watchdog.lock);
266
267	if        (pw <=  1) {
268		watchdog.pulse_val = 0;
269	} else if (pw <= t1) {
270		watchdog.pulse_val = 1;
271	} else if (pw <= t2) {
272		watchdog.pulse_val = 2;
273	} else if (pw <= t3) {
274		watchdog.pulse_val = 3;
275	} else {
276		pr_err("pulse width out of range\n");
277		err = -EINVAL;
278		goto exit_unlock;
279	}
280
281	watchdog.pulse_mode = pw;
282
283exit_unlock:
284	mutex_unlock(&watchdog.lock);
285	return err;
286}
287
288static int watchdog_keepalive(void)
289{
290	int err = 0;
291
292	mutex_lock(&watchdog.lock);
293	err = superio_enter(watchdog.sioaddr);
294	if (err)
295		goto exit_unlock;
296	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
297
298	if (watchdog.minutes_mode)
299		/* select minutes for timer units */
300		superio_set_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
301				F71808FG_FLAG_WD_UNIT);
302	else
303		/* select seconds for timer units */
304		superio_clear_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
305				F71808FG_FLAG_WD_UNIT);
306
307	/* Set timer value */
308	superio_outb(watchdog.sioaddr, F71808FG_REG_WD_TIME,
309			   watchdog.timer_val);
310
311	superio_exit(watchdog.sioaddr);
312
313exit_unlock:
314	mutex_unlock(&watchdog.lock);
315	return err;
316}
317
318static int f71862fg_pin_configure(unsigned short ioaddr)
319{
320	/* When ioaddr is non-zero the calling function has to take care of
321	   mutex handling and superio preparation! */
322
323	if (f71862fg_pin == 63) {
324		if (ioaddr) {
325			/* SPI must be disabled first to use this pin! */
326			superio_clear_bit(ioaddr, SIO_REG_ROM_ADDR_SEL, 6);
327			superio_set_bit(ioaddr, SIO_REG_MFUNCT3, 4);
328		}
329	} else if (f71862fg_pin == 56) {
330		if (ioaddr)
331			superio_set_bit(ioaddr, SIO_REG_MFUNCT1, 1);
332	} else {
333		pr_err("Invalid argument f71862fg_pin=%d\n", f71862fg_pin);
334		return -EINVAL;
335	}
336	return 0;
337}
338
339static int watchdog_start(void)
340{
341	/* Make sure we don't die as soon as the watchdog is enabled below */
342	int err = watchdog_keepalive();
343	if (err)
344		return err;
345
346	mutex_lock(&watchdog.lock);
347	err = superio_enter(watchdog.sioaddr);
348	if (err)
349		goto exit_unlock;
350	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
351
352	/* Watchdog pin configuration */
353	switch (watchdog.type) {
354	case f71808fg:
355		/* Set pin 21 to GPIO23/WDTRST#, then to WDTRST# */
356		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT2, 3);
357		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT3, 3);
358		break;
359
360	case f71862fg:
361		err = f71862fg_pin_configure(watchdog.sioaddr);
362		if (err)
363			goto exit_superio;
 
 
 
 
364		break;
365
366	case f71868:
367	case f71869:
368		/* GPIO14 --> WDTRST# */
369		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT1, 4);
370		break;
371
372	case f71882fg:
373		/* Set pin 56 to WDTRST# */
374		superio_set_bit(watchdog.sioaddr, SIO_REG_MFUNCT1, 1);
375		break;
376
377	case f71889fg:
378		/* set pin 40 to WDTRST# */
379		superio_outb(watchdog.sioaddr, SIO_REG_MFUNCT3,
380			superio_inb(watchdog.sioaddr, SIO_REG_MFUNCT3) & 0xcf);
381		break;
382
 
 
 
 
 
 
 
 
383	case f81865:
384		/* Set pin 70 to WDTRST# */
385		superio_clear_bit(watchdog.sioaddr, SIO_REG_MFUNCT3, 5);
386		break;
387
388	case f81866:
389		/* Set pin 70 to WDTRST# */
390		superio_clear_bit(watchdog.sioaddr, SIO_F81866_REG_PORT_SEL,
391				  BIT(3) | BIT(0));
392		superio_set_bit(watchdog.sioaddr, SIO_F81866_REG_PORT_SEL,
393				BIT(2));
394		/*
395		 * GPIO1 Control Register when 27h BIT3:2 = 01 & BIT0 = 0.
396		 * The PIN 70(GPIO15/WDTRST) is controlled by 2Ch:
397		 *     BIT5: 0 -> WDTRST#
398		 *           1 -> GPIO15
399		 */
400		superio_clear_bit(watchdog.sioaddr, SIO_F81866_REG_GPIO1,
401				  BIT(5));
 
 
 
 
402		break;
403
404	default:
405		/*
406		 * 'default' label to shut up the compiler and catch
407		 * programmer errors
408		 */
409		err = -ENODEV;
410		goto exit_superio;
411	}
412
413	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
414	superio_set_bit(watchdog.sioaddr, SIO_REG_ENABLE, 0);
415
416	if (watchdog.type == f81865 || watchdog.type == f81866)
417		superio_set_bit(watchdog.sioaddr, F81865_REG_WDO_CONF,
418				F81865_FLAG_WDOUT_EN);
419	else
420		superio_set_bit(watchdog.sioaddr, F71808FG_REG_WDO_CONF,
421				F71808FG_FLAG_WDOUT_EN);
422
423	superio_set_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
424			F71808FG_FLAG_WD_EN);
425
426	if (watchdog.pulse_mode) {
427		/* Select "pulse" output mode with given duration */
428		u8 wdt_conf = superio_inb(watchdog.sioaddr,
429				F71808FG_REG_WDT_CONF);
430
431		/* Set WD_PSWIDTH bits (1:0) */
432		wdt_conf = (wdt_conf & 0xfc) | (watchdog.pulse_val & 0x03);
433		/* Set WD_PULSE to "pulse" mode */
434		wdt_conf |= BIT(F71808FG_FLAG_WD_PULSE);
435
436		superio_outb(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
437				wdt_conf);
438	} else {
439		/* Select "level" output mode */
440		superio_clear_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
441				F71808FG_FLAG_WD_PULSE);
442	}
443
444exit_superio:
445	superio_exit(watchdog.sioaddr);
446exit_unlock:
447	mutex_unlock(&watchdog.lock);
448
449	return err;
450}
451
452static int watchdog_stop(void)
453{
454	int err = 0;
455
456	mutex_lock(&watchdog.lock);
457	err = superio_enter(watchdog.sioaddr);
458	if (err)
459		goto exit_unlock;
460	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
461
462	superio_clear_bit(watchdog.sioaddr, F71808FG_REG_WDT_CONF,
463			F71808FG_FLAG_WD_EN);
464
465	superio_exit(watchdog.sioaddr);
466
467exit_unlock:
468	mutex_unlock(&watchdog.lock);
469
470	return err;
471}
472
473static int watchdog_get_status(void)
474{
475	int status = 0;
476
477	mutex_lock(&watchdog.lock);
478	status = (watchdog.caused_reboot) ? WDIOF_CARDRESET : 0;
479	mutex_unlock(&watchdog.lock);
480
481	return status;
482}
483
484static bool watchdog_is_running(void)
485{
486	/*
487	 * if we fail to determine the watchdog's status assume it to be
488	 * running to be on the safe side
489	 */
490	bool is_running = true;
491
492	mutex_lock(&watchdog.lock);
493	if (superio_enter(watchdog.sioaddr))
494		goto exit_unlock;
495	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
496
497	is_running = (superio_inb(watchdog.sioaddr, SIO_REG_ENABLE) & BIT(0))
498		&& (superio_inb(watchdog.sioaddr, F71808FG_REG_WDT_CONF)
499			& BIT(F71808FG_FLAG_WD_EN));
500
501	superio_exit(watchdog.sioaddr);
502
503exit_unlock:
504	mutex_unlock(&watchdog.lock);
505	return is_running;
506}
507
508/* /dev/watchdog api */
509
510static int watchdog_open(struct inode *inode, struct file *file)
511{
512	int err;
513
514	/* If the watchdog is alive we don't need to start it again */
515	if (test_and_set_bit(0, &watchdog.opened))
516		return -EBUSY;
517
518	err = watchdog_start();
519	if (err) {
520		clear_bit(0, &watchdog.opened);
521		return err;
522	}
523
524	if (nowayout)
525		__module_get(THIS_MODULE);
526
527	watchdog.expect_close = 0;
528	return nonseekable_open(inode, file);
529}
530
531static int watchdog_release(struct inode *inode, struct file *file)
532{
533	clear_bit(0, &watchdog.opened);
534
535	if (!watchdog.expect_close) {
536		watchdog_keepalive();
537		pr_crit("Unexpected close, not stopping watchdog!\n");
538	} else if (!nowayout) {
539		watchdog_stop();
540	}
541	return 0;
542}
543
544/*
545 *      watchdog_write:
546 *      @file: file handle to the watchdog
547 *      @buf: buffer to write
548 *      @count: count of bytes
549 *      @ppos: pointer to the position to write. No seeks allowed
550 *
551 *      A write to a watchdog device is defined as a keepalive signal. Any
552 *      write of data will do, as we we don't define content meaning.
553 */
554
555static ssize_t watchdog_write(struct file *file, const char __user *buf,
556			    size_t count, loff_t *ppos)
557{
558	if (count) {
559		if (!nowayout) {
560			size_t i;
561
562			/* In case it was set long ago */
563			bool expect_close = false;
564
565			for (i = 0; i != count; i++) {
566				char c;
567				if (get_user(c, buf + i))
568					return -EFAULT;
569				if (c == 'V')
570					expect_close = true;
571			}
572
573			/* Properly order writes across fork()ed processes */
574			mutex_lock(&watchdog.lock);
575			watchdog.expect_close = expect_close;
576			mutex_unlock(&watchdog.lock);
577		}
578
579		/* someone wrote to us, we should restart timer */
580		watchdog_keepalive();
581	}
582	return count;
583}
584
585/*
586 *      watchdog_ioctl:
587 *      @inode: inode of the device
588 *      @file: file handle to the device
589 *      @cmd: watchdog command
590 *      @arg: argument pointer
591 *
592 *      The watchdog API defines a common set of functions for all watchdogs
593 *      according to their available features.
594 */
595static long watchdog_ioctl(struct file *file, unsigned int cmd,
596	unsigned long arg)
597{
598	int status;
599	int new_options;
600	int new_timeout;
601	union {
602		struct watchdog_info __user *ident;
603		int __user *i;
604	} uarg;
605
606	uarg.i = (int __user *)arg;
607
608	switch (cmd) {
609	case WDIOC_GETSUPPORT:
610		return copy_to_user(uarg.ident, &watchdog.ident,
611			sizeof(watchdog.ident)) ? -EFAULT : 0;
612
613	case WDIOC_GETSTATUS:
614		status = watchdog_get_status();
615		if (status < 0)
616			return status;
617		return put_user(status, uarg.i);
618
619	case WDIOC_GETBOOTSTATUS:
620		return put_user(0, uarg.i);
621
622	case WDIOC_SETOPTIONS:
623		if (get_user(new_options, uarg.i))
624			return -EFAULT;
625
626		if (new_options & WDIOS_DISABLECARD)
627			watchdog_stop();
628
629		if (new_options & WDIOS_ENABLECARD)
630			return watchdog_start();
631		/* fall through */
632
633	case WDIOC_KEEPALIVE:
634		watchdog_keepalive();
635		return 0;
636
637	case WDIOC_SETTIMEOUT:
638		if (get_user(new_timeout, uarg.i))
639			return -EFAULT;
640
641		if (watchdog_set_timeout(new_timeout))
642			return -EINVAL;
643
644		watchdog_keepalive();
645		/* fall through */
646
647	case WDIOC_GETTIMEOUT:
648		return put_user(watchdog.timeout, uarg.i);
649
650	default:
651		return -ENOTTY;
652
653	}
654}
655
656static int watchdog_notify_sys(struct notifier_block *this, unsigned long code,
657	void *unused)
658{
659	if (code == SYS_DOWN || code == SYS_HALT)
660		watchdog_stop();
661	return NOTIFY_DONE;
662}
663
664static const struct file_operations watchdog_fops = {
665	.owner		= THIS_MODULE,
666	.llseek		= no_llseek,
667	.open		= watchdog_open,
668	.release	= watchdog_release,
669	.write		= watchdog_write,
670	.unlocked_ioctl	= watchdog_ioctl,
 
671};
672
673static struct miscdevice watchdog_miscdev = {
674	.minor		= WATCHDOG_MINOR,
675	.name		= "watchdog",
676	.fops		= &watchdog_fops,
677};
678
679static struct notifier_block watchdog_notifier = {
680	.notifier_call = watchdog_notify_sys,
681};
682
683static int __init watchdog_init(int sioaddr)
684{
685	int wdt_conf, err = 0;
686
687	/* No need to lock watchdog.lock here because no entry points
688	 * into the module have been registered yet.
689	 */
690	watchdog.sioaddr = sioaddr;
691	watchdog.ident.options = WDIOC_SETTIMEOUT
692				| WDIOF_MAGICCLOSE
693				| WDIOF_KEEPALIVEPING;
694
695	snprintf(watchdog.ident.identity,
696		sizeof(watchdog.ident.identity), "%s watchdog",
697		f71808e_names[watchdog.type]);
698
699	err = superio_enter(sioaddr);
700	if (err)
701		return err;
702	superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
703
704	wdt_conf = superio_inb(sioaddr, F71808FG_REG_WDT_CONF);
705	watchdog.caused_reboot = wdt_conf & BIT(F71808FG_FLAG_WDTMOUT_STS);
706
 
 
 
 
 
 
 
707	superio_exit(sioaddr);
708
709	err = watchdog_set_timeout(timeout);
710	if (err)
711		return err;
712	err = watchdog_set_pulse_width(pulse_width);
713	if (err)
714		return err;
715
716	err = register_reboot_notifier(&watchdog_notifier);
717	if (err)
718		return err;
719
720	err = misc_register(&watchdog_miscdev);
721	if (err) {
722		pr_err("cannot register miscdev on minor=%d\n",
723		       watchdog_miscdev.minor);
724		goto exit_reboot;
725	}
726
727	if (start_withtimeout) {
728		if (start_withtimeout <= 0
729		 || start_withtimeout >  max_timeout) {
730			pr_err("starting timeout out of range\n");
731			err = -EINVAL;
732			goto exit_miscdev;
733		}
734
735		err = watchdog_start();
736		if (err) {
737			pr_err("cannot start watchdog timer\n");
738			goto exit_miscdev;
739		}
740
741		mutex_lock(&watchdog.lock);
742		err = superio_enter(sioaddr);
743		if (err)
744			goto exit_unlock;
745		superio_select(watchdog.sioaddr, SIO_F71808FG_LD_WDT);
746
747		if (start_withtimeout > 0xff) {
748			/* select minutes for timer units */
749			superio_set_bit(sioaddr, F71808FG_REG_WDT_CONF,
750				F71808FG_FLAG_WD_UNIT);
751			superio_outb(sioaddr, F71808FG_REG_WD_TIME,
752				DIV_ROUND_UP(start_withtimeout, 60));
753		} else {
754			/* select seconds for timer units */
755			superio_clear_bit(sioaddr, F71808FG_REG_WDT_CONF,
756				F71808FG_FLAG_WD_UNIT);
757			superio_outb(sioaddr, F71808FG_REG_WD_TIME,
758				start_withtimeout);
759		}
760
761		superio_exit(sioaddr);
762		mutex_unlock(&watchdog.lock);
763
764		if (nowayout)
765			__module_get(THIS_MODULE);
766
767		pr_info("watchdog started with initial timeout of %u sec\n",
768			start_withtimeout);
769	}
770
771	return 0;
772
773exit_unlock:
774	mutex_unlock(&watchdog.lock);
775exit_miscdev:
776	misc_deregister(&watchdog_miscdev);
777exit_reboot:
778	unregister_reboot_notifier(&watchdog_notifier);
779
780	return err;
781}
782
783static int __init f71808e_find(int sioaddr)
784{
785	u16 devid;
786	int err = superio_enter(sioaddr);
787	if (err)
788		return err;
789
790	devid = superio_inw(sioaddr, SIO_REG_MANID);
791	if (devid != SIO_FINTEK_ID) {
792		pr_debug("Not a Fintek device\n");
793		err = -ENODEV;
794		goto exit;
795	}
796
797	devid = force_id ? force_id : superio_inw(sioaddr, SIO_REG_DEVID);
798	switch (devid) {
799	case SIO_F71808_ID:
800		watchdog.type = f71808fg;
801		break;
802	case SIO_F71862_ID:
803		watchdog.type = f71862fg;
804		err = f71862fg_pin_configure(0); /* validate module parameter */
805		break;
806	case SIO_F71868_ID:
807		watchdog.type = f71868;
808		break;
809	case SIO_F71869_ID:
810	case SIO_F71869A_ID:
811		watchdog.type = f71869;
812		break;
813	case SIO_F71882_ID:
814		watchdog.type = f71882fg;
815		break;
816	case SIO_F71889_ID:
817		watchdog.type = f71889fg;
818		break;
819	case SIO_F71858_ID:
820		/* Confirmed (by datasheet) not to have a watchdog. */
821		err = -ENODEV;
822		goto exit;
 
 
 
823	case SIO_F81865_ID:
824		watchdog.type = f81865;
825		break;
826	case SIO_F81866_ID:
827		watchdog.type = f81866;
828		break;
829	default:
830		pr_info("Unrecognized Fintek device: %04x\n",
831			(unsigned int)devid);
832		err = -ENODEV;
833		goto exit;
834	}
835
836	pr_info("Found %s watchdog chip, revision %d\n",
837		f71808e_names[watchdog.type],
838		(int)superio_inb(sioaddr, SIO_REG_DEVREV));
839exit:
840	superio_exit(sioaddr);
841	return err;
842}
843
844static int __init f71808e_init(void)
845{
846	static const unsigned short addrs[] = { 0x2e, 0x4e };
847	int err = -ENODEV;
848	int i;
 
 
 
 
 
849
850	for (i = 0; i < ARRAY_SIZE(addrs); i++) {
851		err = f71808e_find(addrs[i]);
852		if (err == 0)
853			break;
854	}
855	if (i == ARRAY_SIZE(addrs))
856		return err;
857
858	return watchdog_init(addrs[i]);
859}
860
861static void __exit f71808e_exit(void)
862{
863	if (watchdog_is_running()) {
864		pr_warn("Watchdog timer still running, stopping it\n");
865		watchdog_stop();
866	}
867	misc_deregister(&watchdog_miscdev);
868	unregister_reboot_notifier(&watchdog_notifier);
869}
870
871MODULE_DESCRIPTION("F71808E Watchdog Driver");
872MODULE_AUTHOR("Giel van Schijndel <me@mortis.eu>");
873MODULE_LICENSE("GPL");
874
875module_init(f71808e_init);
876module_exit(f71808e_exit);