xref: /freebsd/sys/sys/watchdog.h (revision aa0a1e58)
1 /*-
2  * Copyright (c) 2003 Poul-Henning Kamp
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 #ifndef _SYS_WATCHDOG_H
29 #define	_SYS_WATCHDOG_H
30 
31 #include <sys/ioccom.h>
32 
33 #define	_PATH_WATCHDOG	"fido"
34 
35 #define WDIOCPATPAT	_IOW('W', 42, u_int)
36 
37 #define WD_ACTIVE	0x8000000
38 	/*
39 	 * Watchdog reset, timeout set to value in WD_INTERVAL field.
40 	 * The kernel will arm the watchdog and unless the userland
41 	 * program calls WDIOCPATPAT again before the timer expires
42 	 * the system will reinitialize.
43 	 */
44 
45 #define WD_PASSIVE	0x0400000
46 	/*
47 	 * Set the watchdog in passive mode.
48 	 * The kernel will chose an appropriate timeout duration and
49 	 * periodically reset the timer provided everything looks all
50 	 * right to the kernel.
51  	 */
52 
53 #define WD_INTERVAL	0x00000ff
54 	/*
55 	 * Mask for duration bits.
56 	 * The watchdog will have a nominal patience of 2^N * nanoseconds.
57 	 * Example:  N == 30 gives a patience of 2^30 nanoseconds ~= 1 second.
58 	 * NB: Expect variance in the +/- 10-20% range.
59 	 */
60 
61 /* Handy macros for humans not used to power of two nanoseconds */
62 #define WD_TO_NEVER	0
63 #define WD_TO_1MS	20
64 #define WD_TO_125MS	27
65 #define WD_TO_250MS	28
66 #define WD_TO_500MS	29
67 #define WD_TO_1SEC	30
68 #define WD_TO_2SEC	31
69 #define WD_TO_4SEC	32
70 #define WD_TO_8SEC	33
71 #define WD_TO_16SEC	34
72 #define WD_TO_32SEC	35
73 
74 #ifdef _KERNEL
75 
76 #include <sys/eventhandler.h>
77 
78 typedef void (*watchdog_fn)(void *, u_int, int *);
79 
80 EVENTHANDLER_DECLARE(watchdog_list, watchdog_fn);
81 #endif
82 
83 #endif /* _SYS_WATCHDOG_H */
84