1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Watchdog Timer Driver
4 * for ITE IT87xx Environment Control - Low Pin Count Input / Output
6 * (c) Copyright 2007 Oliver Schuster <olivers137@aol.com>
8 * Based on softdog.c by Alan Cox,
9 * 83977f_wdt.c by Jose Goncalves,
10 * it87.c by Chris Gauthron, Jean Delvare
12 * Data-sheets: Publicly available at the ITE website
13 * http://www.ite.com.tw/
15 * Support of the watchdog timers, which are available on
16 * IT8607, IT8613, IT8620, IT8622, IT8625, IT8628, IT8655, IT8665,
17 * IT8686, IT8702, IT8712, IT8716, IT8718, IT8720, IT8721, IT8726,
18 * IT8728, IT8772, IT8783 and IT8784.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/init.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/types.h>
29 #include <linux/watchdog.h>
31 #define WATCHDOG_NAME "IT87 WDT"
33 /* Defaults for Module Parameter */
34 #define DEFAULT_TIMEOUT 60
35 #define DEFAULT_TESTMODE 0
36 #define DEFAULT_NOWAYOUT WATCHDOG_NOWAYOUT
42 /* Logical device Numbers LDN */
45 /* Configuration Registers and Functions */
51 #define NO_DEV_ID 0xffff
52 #define IT8607_ID 0x8607
53 #define IT8613_ID 0x8613
54 #define IT8620_ID 0x8620
55 #define IT8622_ID 0x8622
56 #define IT8625_ID 0x8625
57 #define IT8628_ID 0x8628
58 #define IT8655_ID 0x8655
59 #define IT8665_ID 0x8665
60 #define IT8686_ID 0x8686
61 #define IT8702_ID 0x8702
62 #define IT8705_ID 0x8705
63 #define IT8712_ID 0x8712
64 #define IT8716_ID 0x8716
65 #define IT8718_ID 0x8718
66 #define IT8720_ID 0x8720
67 #define IT8721_ID 0x8721
68 #define IT8726_ID 0x8726 /* the data sheet suggest wrongly 0x8716 */
69 #define IT8728_ID 0x8728
70 #define IT8772_ID 0x8772
71 #define IT8783_ID 0x8783
72 #define IT8784_ID 0x8784
73 #define IT8786_ID 0x8786
75 /* GPIO Configuration Registers LDN=0x07 */
78 #define WDTVALLSB 0x73
79 #define WDTVALMSB 0x74
81 /* GPIO Bits WDTCFG */
85 #define WDT_PWROK 0x10 /* not in it8721 */
86 #define WDT_INT_MASK 0x0f
88 static unsigned int max_units, chip_type;
90 static unsigned int timeout = DEFAULT_TIMEOUT;
91 static int testmode = DEFAULT_TESTMODE;
92 static bool nowayout = DEFAULT_NOWAYOUT;
94 module_param(timeout, int, 0);
95 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds, default="
96 __MODULE_STRING(DEFAULT_TIMEOUT));
97 module_param(testmode, int, 0);
98 MODULE_PARM_DESC(testmode, "Watchdog test mode (1 = no reboot), default="
99 __MODULE_STRING(DEFAULT_TESTMODE));
100 module_param(nowayout, bool, 0);
101 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started, default="
102 __MODULE_STRING(WATCHDOG_NOWAYOUT));
106 static inline int superio_enter(void)
109 * Try to reserve REG and REG + 1 for exclusive access.
111 if (!request_muxed_region(REG, 2, WATCHDOG_NAME))
121 static inline void superio_exit(void)
125 release_region(REG, 2);
128 static inline void superio_select(int ldn)
134 static inline int superio_inb(int reg)
140 static inline void superio_outb(int val, int reg)
146 static inline int superio_inw(int reg)
156 /* Internal function, should be called after superio_select(GPIO) */
157 static void _wdt_update_timeout(unsigned int t)
159 unsigned char cfg = WDT_KRST;
169 if (chip_type != IT8721_ID)
172 superio_outb(cfg, WDTCFG);
173 superio_outb(t, WDTVALLSB);
175 superio_outb(t >> 8, WDTVALMSB);
178 static int wdt_update_timeout(unsigned int t)
182 ret = superio_enter();
186 superio_select(GPIO);
187 _wdt_update_timeout(t);
193 static int wdt_round_time(int t)
200 /* watchdog timer handling */
202 static int wdt_start(struct watchdog_device *wdd)
204 return wdt_update_timeout(wdd->timeout);
207 static int wdt_stop(struct watchdog_device *wdd)
209 return wdt_update_timeout(0);
213 * wdt_set_timeout - set a new timeout value with watchdog ioctl
214 * @t: timeout value in seconds
216 * The hardware device has a 8 or 16 bit watchdog timer (depends on
217 * chip version) that can be configured to count seconds or minutes.
219 * Used within WDIOC_SETTIMEOUT watchdog device ioctl.
222 static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)
227 t = wdt_round_time(t);
231 if (watchdog_hw_running(wdd))
232 ret = wdt_update_timeout(t);
237 static const struct watchdog_info ident = {
238 .options = WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE | WDIOF_KEEPALIVEPING,
239 .firmware_version = 1,
240 .identity = WATCHDOG_NAME,
243 static const struct watchdog_ops wdt_ops = {
244 .owner = THIS_MODULE,
247 .set_timeout = wdt_set_timeout,
250 static struct watchdog_device wdt_dev = {
256 static int __init it87_wdt_init(void)
261 rc = superio_enter();
265 chip_type = superio_inw(CHIPID);
266 chip_rev = superio_inb(CHIPREV) & 0x0f;
274 max_units = (chip_rev < 8) ? 255 : 65535;
300 pr_err("Unsupported Chip found, Chip %04x Revision %02x\n",
301 chip_type, chip_rev);
304 pr_err("no device\n");
307 pr_err("Unknown Chip found, Chip %04x Revision %04x\n",
308 chip_type, chip_rev);
312 rc = superio_enter();
316 superio_select(GPIO);
317 superio_outb(WDT_TOV1, WDTCFG);
318 superio_outb(0x00, WDTCTRL);
321 if (timeout < 1 || timeout > max_units * 60) {
322 timeout = DEFAULT_TIMEOUT;
323 pr_warn("Timeout value out of range, use default %d sec\n",
327 if (timeout > max_units)
328 timeout = wdt_round_time(timeout);
330 wdt_dev.timeout = timeout;
331 wdt_dev.max_timeout = max_units * 60;
333 watchdog_stop_on_reboot(&wdt_dev);
334 rc = watchdog_register_device(&wdt_dev);
336 pr_err("Cannot register watchdog device (err=%d)\n", rc);
340 pr_info("Chip IT%04x revision %d initialized. timeout=%d sec (nowayout=%d testmode=%d)\n",
341 chip_type, chip_rev, timeout, nowayout, testmode);
346 static void __exit it87_wdt_exit(void)
348 watchdog_unregister_device(&wdt_dev);
351 module_init(it87_wdt_init);
352 module_exit(it87_wdt_exit);
354 MODULE_AUTHOR("Oliver Schuster");
355 MODULE_DESCRIPTION("Hardware Watchdog Device Driver for IT87xx EC-LPC I/O");
356 MODULE_LICENSE("GPL");