blob: f52c162b1beab77ab451cd72759feac5f87d06a2 [file] [log] [blame]
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +01001/*
2 * IT8712F "Smart Guardian" Watchdog support
3 *
4 * Copyright (c) 2006-2007 Jorge Boncompte - DTI2 <jorge@dti2.net>
5 *
6 * Based on info and code taken from:
7 *
8 * drivers/char/watchdog/scx200_wdt.c
9 * drivers/hwmon/it87.c
Andrew Paprocki5e699602008-02-10 22:11:15 -050010 * IT8712F EC-LPC I/O Preliminary Specification 0.8.2
11 * IT8712F EC-LPC I/O Preliminary Specification 0.9.3
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010012 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of the
16 * License, or (at your option) any later version.
17 *
18 * The author(s) of this software shall not be held liable for damages
19 * of any nature resulting due to the use of this software. This
20 * software is provided AS-IS with no warranties.
21 */
22
23#include <linux/module.h>
24#include <linux/moduleparam.h>
25#include <linux/init.h>
26#include <linux/miscdevice.h>
27#include <linux/watchdog.h>
28#include <linux/notifier.h>
29#include <linux/reboot.h>
30#include <linux/fs.h>
31#include <linux/pci.h>
32#include <linux/spinlock.h>
Alan Coxd6547372008-08-04 17:54:01 +010033#include <linux/uaccess.h>
34#include <linux/io.h>
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010035
36#define NAME "it8712f_wdt"
37
38MODULE_AUTHOR("Jorge Boncompte - DTI2 <jorge@dti2.net>");
39MODULE_DESCRIPTION("IT8712F Watchdog Driver");
40MODULE_LICENSE("GPL");
41MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
42
Andrew Paprocki5e699602008-02-10 22:11:15 -050043static int max_units = 255;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010044static int margin = 60; /* in seconds */
45module_param(margin, int, 0);
46MODULE_PARM_DESC(margin, "Watchdog margin in seconds");
47
48static int nowayout = WATCHDOG_NOWAYOUT;
49module_param(nowayout, int, 0);
50MODULE_PARM_DESC(nowayout, "Disable watchdog shutdown on close");
51
Alan Coxd6547372008-08-04 17:54:01 +010052static unsigned long wdt_open;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010053static unsigned expect_close;
54static spinlock_t io_lock;
Andrew Paprocki5e699602008-02-10 22:11:15 -050055static unsigned char revision;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010056
57/* Dog Food address - We use the game port address */
58static unsigned short address;
59
60#define REG 0x2e /* The register to read/write */
61#define VAL 0x2f /* The value to read/write */
62
63#define LDN 0x07 /* Register: Logical device select */
64#define DEVID 0x20 /* Register: Device ID */
65#define DEVREV 0x22 /* Register: Device Revision */
66#define ACT_REG 0x30 /* LDN Register: Activation */
67#define BASE_REG 0x60 /* LDN Register: Base address */
68
69#define IT8712F_DEVID 0x8712
70
71#define LDN_GPIO 0x07 /* GPIO and Watch Dog Timer */
72#define LDN_GAME 0x09 /* Game Port */
73
74#define WDT_CONTROL 0x71 /* WDT Register: Control */
75#define WDT_CONFIG 0x72 /* WDT Register: Configuration */
76#define WDT_TIMEOUT 0x73 /* WDT Register: Timeout Value */
77
78#define WDT_RESET_GAME 0x10
79#define WDT_RESET_KBD 0x20
80#define WDT_RESET_MOUSE 0x40
81#define WDT_RESET_CIR 0x80
82
83#define WDT_UNIT_SEC 0x80 /* If 0 in MINUTES */
84
85#define WDT_OUT_PWROK 0x10
86#define WDT_OUT_KRST 0x40
87
Alan Coxd6547372008-08-04 17:54:01 +010088static int superio_inb(int reg)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010089{
90 outb(reg, REG);
91 return inb(VAL);
92}
93
Alan Coxd6547372008-08-04 17:54:01 +010094static void superio_outb(int val, int reg)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +010095{
96 outb(reg, REG);
97 outb(val, VAL);
98}
99
Alan Coxd6547372008-08-04 17:54:01 +0100100static int superio_inw(int reg)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100101{
102 int val;
103 outb(reg++, REG);
104 val = inb(VAL) << 8;
105 outb(reg, REG);
106 val |= inb(VAL);
107 return val;
108}
109
Alan Coxd6547372008-08-04 17:54:01 +0100110static inline void superio_select(int ldn)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100111{
112 outb(LDN, REG);
113 outb(ldn, VAL);
114}
115
Alan Coxd6547372008-08-04 17:54:01 +0100116static inline void superio_enter(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100117{
118 spin_lock(&io_lock);
119 outb(0x87, REG);
120 outb(0x01, REG);
121 outb(0x55, REG);
122 outb(0x55, REG);
123}
124
Alan Coxd6547372008-08-04 17:54:01 +0100125static inline void superio_exit(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100126{
127 outb(0x02, REG);
128 outb(0x02, VAL);
129 spin_unlock(&io_lock);
130}
131
Alan Coxd6547372008-08-04 17:54:01 +0100132static inline void it8712f_wdt_ping(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100133{
134 inb(address);
135}
136
Alan Coxd6547372008-08-04 17:54:01 +0100137static void it8712f_wdt_update_margin(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100138{
139 int config = WDT_OUT_KRST | WDT_OUT_PWROK;
Andrew Paprocki5e699602008-02-10 22:11:15 -0500140 int units = margin;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100141
Andrew Paprocki5e699602008-02-10 22:11:15 -0500142 /* Switch to minutes precision if the configured margin
143 * value does not fit within the register width.
144 */
145 if (units <= max_units) {
146 config |= WDT_UNIT_SEC; /* else UNIT is MINUTES */
147 printk(KERN_INFO NAME ": timer margin %d seconds\n", units);
148 } else {
149 units /= 60;
150 printk(KERN_INFO NAME ": timer margin %d minutes\n", units);
151 }
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100152 superio_outb(config, WDT_CONFIG);
153
Andrew Paprocki5e699602008-02-10 22:11:15 -0500154 if (revision >= 0x08)
Oliver Schuster0e45adb2008-04-01 17:06:21 +0200155 superio_outb(units >> 8, WDT_TIMEOUT + 1);
156 superio_outb(units, WDT_TIMEOUT);
Andrew Paprocki5e699602008-02-10 22:11:15 -0500157}
158
Alan Coxd6547372008-08-04 17:54:01 +0100159static int it8712f_wdt_get_status(void)
Andrew Paprocki5e699602008-02-10 22:11:15 -0500160{
161 if (superio_inb(WDT_CONTROL) & 0x01)
162 return WDIOF_CARDRESET;
163 else
164 return 0;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100165}
166
Alan Coxd6547372008-08-04 17:54:01 +0100167static void it8712f_wdt_enable(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100168{
169 printk(KERN_DEBUG NAME ": enabling watchdog timer\n");
170 superio_enter();
171 superio_select(LDN_GPIO);
172
173 superio_outb(WDT_RESET_GAME, WDT_CONTROL);
174
175 it8712f_wdt_update_margin();
176
177 superio_exit();
178
179 it8712f_wdt_ping();
180}
181
Alan Coxd6547372008-08-04 17:54:01 +0100182static void it8712f_wdt_disable(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100183{
184 printk(KERN_DEBUG NAME ": disabling watchdog timer\n");
185
186 superio_enter();
187 superio_select(LDN_GPIO);
188
189 superio_outb(0, WDT_CONFIG);
190 superio_outb(0, WDT_CONTROL);
Andrew Paprockicc1020f2008-04-02 02:43:19 -0400191 if (revision >= 0x08)
192 superio_outb(0, WDT_TIMEOUT + 1);
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100193 superio_outb(0, WDT_TIMEOUT);
194
195 superio_exit();
196}
197
Alan Coxd6547372008-08-04 17:54:01 +0100198static int it8712f_wdt_notify(struct notifier_block *this,
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100199 unsigned long code, void *unused)
200{
201 if (code == SYS_HALT || code == SYS_POWER_OFF)
202 if (!nowayout)
203 it8712f_wdt_disable();
204
205 return NOTIFY_DONE;
206}
207
208static struct notifier_block it8712f_wdt_notifier = {
209 .notifier_call = it8712f_wdt_notify,
210};
211
Alan Coxd6547372008-08-04 17:54:01 +0100212static ssize_t it8712f_wdt_write(struct file *file, const char __user *data,
213 size_t len, loff_t *ppos)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100214{
215 /* check for a magic close character */
216 if (len) {
217 size_t i;
218
219 it8712f_wdt_ping();
220
221 expect_close = 0;
222 for (i = 0; i < len; ++i) {
223 char c;
Wim Van Sebroeck7944d3a2008-08-06 20:19:41 +0000224 if (get_user(c, data + i))
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100225 return -EFAULT;
226 if (c == 'V')
227 expect_close = 42;
228 }
229 }
230
231 return len;
232}
233
Alan Coxd6547372008-08-04 17:54:01 +0100234static long it8712f_wdt_ioctl(struct file *file, unsigned int cmd,
235 unsigned long arg)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100236{
237 void __user *argp = (void __user *)arg;
238 int __user *p = argp;
Wim Van Sebroeck42747d72009-12-26 18:55:22 +0000239 static const struct watchdog_info ident = {
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100240 .identity = "IT8712F Watchdog",
241 .firmware_version = 1,
Wim Van Sebroecke73a7802009-05-11 18:33:00 +0000242 .options = WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING |
243 WDIOF_MAGICCLOSE,
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100244 };
Andrew Paprocki5e699602008-02-10 22:11:15 -0500245 int value;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100246
247 switch (cmd) {
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100248 case WDIOC_GETSUPPORT:
249 if (copy_to_user(argp, &ident, sizeof(ident)))
250 return -EFAULT;
251 return 0;
252 case WDIOC_GETSTATUS:
Andrew Paprocki5e699602008-02-10 22:11:15 -0500253 superio_enter();
254 superio_select(LDN_GPIO);
255
256 value = it8712f_wdt_get_status();
257
258 superio_exit();
259
260 return put_user(value, p);
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100261 case WDIOC_GETBOOTSTATUS:
262 return put_user(0, p);
263 case WDIOC_KEEPALIVE:
264 it8712f_wdt_ping();
265 return 0;
266 case WDIOC_SETTIMEOUT:
Andrew Paprocki5e699602008-02-10 22:11:15 -0500267 if (get_user(value, p))
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100268 return -EFAULT;
Andrew Paprocki5e699602008-02-10 22:11:15 -0500269 if (value < 1)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100270 return -EINVAL;
Andrew Paprocki5e699602008-02-10 22:11:15 -0500271 if (value > (max_units * 60))
272 return -EINVAL;
273 margin = value;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100274 superio_enter();
275 superio_select(LDN_GPIO);
276
277 it8712f_wdt_update_margin();
278
279 superio_exit();
280 it8712f_wdt_ping();
Andrew Paprocki5e699602008-02-10 22:11:15 -0500281 /* Fall through */
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100282 case WDIOC_GETTIMEOUT:
283 if (put_user(margin, p))
284 return -EFAULT;
285 return 0;
Wim Van Sebroeck0c060902008-07-18 11:41:17 +0000286 default:
287 return -ENOTTY;
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100288 }
289}
290
Alan Coxd6547372008-08-04 17:54:01 +0100291static int it8712f_wdt_open(struct inode *inode, struct file *file)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100292{
293 /* only allow one at a time */
Alan Coxd6547372008-08-04 17:54:01 +0100294 if (test_and_set_bit(0, &wdt_open))
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100295 return -EBUSY;
296 it8712f_wdt_enable();
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100297 return nonseekable_open(inode, file);
298}
299
Alan Coxd6547372008-08-04 17:54:01 +0100300static int it8712f_wdt_release(struct inode *inode, struct file *file)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100301{
302 if (expect_close != 42) {
303 printk(KERN_WARNING NAME
304 ": watchdog device closed unexpectedly, will not"
305 " disable the watchdog timer\n");
306 } else if (!nowayout) {
307 it8712f_wdt_disable();
308 }
309 expect_close = 0;
Alan Coxd6547372008-08-04 17:54:01 +0100310 clear_bit(0, &wdt_open);
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100311
312 return 0;
313}
314
Jan Engelhardtb47a1662008-01-22 20:48:10 +0100315static const struct file_operations it8712f_wdt_fops = {
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100316 .owner = THIS_MODULE,
317 .llseek = no_llseek,
318 .write = it8712f_wdt_write,
Alan Coxd6547372008-08-04 17:54:01 +0100319 .unlocked_ioctl = it8712f_wdt_ioctl,
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100320 .open = it8712f_wdt_open,
321 .release = it8712f_wdt_release,
322};
323
324static struct miscdevice it8712f_wdt_miscdev = {
325 .minor = WATCHDOG_MINOR,
326 .name = "watchdog",
327 .fops = &it8712f_wdt_fops,
328};
329
Alan Coxd6547372008-08-04 17:54:01 +0100330static int __init it8712f_wdt_find(unsigned short *address)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100331{
332 int err = -ENODEV;
333 int chip_type;
334
335 superio_enter();
336 chip_type = superio_inw(DEVID);
337 if (chip_type != IT8712F_DEVID)
338 goto exit;
339
340 superio_select(LDN_GAME);
341 superio_outb(1, ACT_REG);
342 if (!(superio_inb(ACT_REG) & 0x01)) {
343 printk(KERN_ERR NAME ": Device not activated, skipping\n");
344 goto exit;
345 }
346
347 *address = superio_inw(BASE_REG);
348 if (*address == 0) {
349 printk(KERN_ERR NAME ": Base address not set, skipping\n");
350 goto exit;
351 }
352
353 err = 0;
Andrew Paprocki5e699602008-02-10 22:11:15 -0500354 revision = superio_inb(DEVREV) & 0x0f;
355
356 /* Later revisions have 16-bit values per datasheet 0.9.1 */
357 if (revision >= 0x08)
358 max_units = 65535;
359
360 if (margin > (max_units * 60))
361 margin = (max_units * 60);
362
363 printk(KERN_INFO NAME ": Found IT%04xF chip revision %d - "
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100364 "using DogFood address 0x%x\n",
Andrew Paprocki5e699602008-02-10 22:11:15 -0500365 chip_type, revision, *address);
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100366
367exit:
368 superio_exit();
369 return err;
370}
371
Alan Coxd6547372008-08-04 17:54:01 +0100372static int __init it8712f_wdt_init(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100373{
374 int err = 0;
375
376 spin_lock_init(&io_lock);
377
378 if (it8712f_wdt_find(&address))
379 return -ENODEV;
380
381 if (!request_region(address, 1, "IT8712F Watchdog")) {
382 printk(KERN_WARNING NAME ": watchdog I/O region busy\n");
383 return -EBUSY;
384 }
385
386 it8712f_wdt_disable();
387
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100388 err = register_reboot_notifier(&it8712f_wdt_notifier);
389 if (err) {
390 printk(KERN_ERR NAME ": unable to register reboot notifier\n");
391 goto out;
392 }
393
394 err = misc_register(&it8712f_wdt_miscdev);
395 if (err) {
396 printk(KERN_ERR NAME
397 ": cannot register miscdev on minor=%d (err=%d)\n",
398 WATCHDOG_MINOR, err);
399 goto reboot_out;
400 }
401
402 return 0;
403
404
405reboot_out:
406 unregister_reboot_notifier(&it8712f_wdt_notifier);
407out:
408 release_region(address, 1);
409 return err;
410}
411
Alan Coxd6547372008-08-04 17:54:01 +0100412static void __exit it8712f_wdt_exit(void)
Jorge Boncompte [DTI2]38ff6fd2007-11-19 15:09:21 +0100413{
414 misc_deregister(&it8712f_wdt_miscdev);
415 unregister_reboot_notifier(&it8712f_wdt_notifier);
416 release_region(address, 1);
417}
418
419module_init(it8712f_wdt_init);
420module_exit(it8712f_wdt_exit);