ca90c5192596f8c4f47628ced8d2aabdcdd82b37
[sfrench/cifs-2.6.git] / drivers / watchdog / it8712f_wdt.c
1 /*
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
10  *      IT8712F EC-LPC I/O Preliminary Specification 0.8.2
11  *      IT8712F EC-LPC I/O Preliminary Specification 0.9.3
12  *
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>
33
34 #include <asm/uaccess.h>
35 #include <asm/io.h>
36
37 #define NAME "it8712f_wdt"
38
39 MODULE_AUTHOR("Jorge Boncompte - DTI2 <jorge@dti2.net>");
40 MODULE_DESCRIPTION("IT8712F Watchdog Driver");
41 MODULE_LICENSE("GPL");
42 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
43
44 static int max_units = 255;
45 static int margin = 60;         /* in seconds */
46 module_param(margin, int, 0);
47 MODULE_PARM_DESC(margin, "Watchdog margin in seconds");
48
49 static int nowayout = WATCHDOG_NOWAYOUT;
50 module_param(nowayout, int, 0);
51 MODULE_PARM_DESC(nowayout, "Disable watchdog shutdown on close");
52
53 static struct semaphore it8712f_wdt_sem;
54 static unsigned expect_close;
55 static spinlock_t io_lock;
56 static unsigned char revision;
57
58 /* Dog Food address - We use the game port address */
59 static unsigned short address;
60
61 #define REG             0x2e    /* The register to read/write */
62 #define VAL             0x2f    /* The value to read/write */
63
64 #define LDN             0x07    /* Register: Logical device select */
65 #define DEVID           0x20    /* Register: Device ID */
66 #define DEVREV          0x22    /* Register: Device Revision */
67 #define ACT_REG         0x30    /* LDN Register: Activation */
68 #define BASE_REG        0x60    /* LDN Register: Base address */
69
70 #define IT8712F_DEVID   0x8712
71
72 #define LDN_GPIO        0x07    /* GPIO and Watch Dog Timer */
73 #define LDN_GAME        0x09    /* Game Port */
74
75 #define WDT_CONTROL     0x71    /* WDT Register: Control */
76 #define WDT_CONFIG      0x72    /* WDT Register: Configuration */
77 #define WDT_TIMEOUT     0x73    /* WDT Register: Timeout Value */
78
79 #define WDT_RESET_GAME  0x10
80 #define WDT_RESET_KBD   0x20
81 #define WDT_RESET_MOUSE 0x40
82 #define WDT_RESET_CIR   0x80
83
84 #define WDT_UNIT_SEC    0x80    /* If 0 in MINUTES */
85
86 #define WDT_OUT_PWROK   0x10
87 #define WDT_OUT_KRST    0x40
88
89 static int
90 superio_inb(int reg)
91 {
92         outb(reg, REG);
93         return inb(VAL);
94 }
95
96 static void
97 superio_outb(int val, int reg)
98 {
99         outb(reg, REG);
100         outb(val, VAL);
101 }
102
103 static int
104 superio_inw(int reg)
105 {
106         int val;
107         outb(reg++, REG);
108         val = inb(VAL) << 8;
109         outb(reg, REG);
110         val |= inb(VAL);
111         return val;
112 }
113
114 static inline void
115 superio_select(int ldn)
116 {
117         outb(LDN, REG);
118         outb(ldn, VAL);
119 }
120
121 static inline void
122 superio_enter(void)
123 {
124         spin_lock(&io_lock);
125         outb(0x87, REG);
126         outb(0x01, REG);
127         outb(0x55, REG);
128         outb(0x55, REG);
129 }
130
131 static inline void
132 superio_exit(void)
133 {
134         outb(0x02, REG);
135         outb(0x02, VAL);
136         spin_unlock(&io_lock);
137 }
138
139 static inline void
140 it8712f_wdt_ping(void)
141 {
142         inb(address);
143 }
144
145 static void
146 it8712f_wdt_update_margin(void)
147 {
148         int config = WDT_OUT_KRST | WDT_OUT_PWROK;
149         int units = margin;
150
151         /* Switch to minutes precision if the configured margin
152          * value does not fit within the register width.
153          */
154         if (units <= max_units) {
155                 config |= WDT_UNIT_SEC; /* else UNIT is MINUTES */
156                 printk(KERN_INFO NAME ": timer margin %d seconds\n", units);
157         } else {
158                 units /= 60;
159                 printk(KERN_INFO NAME ": timer margin %d minutes\n", units);
160         }
161         superio_outb(config, WDT_CONFIG);
162
163         if (revision >= 0x08)
164                 superio_outb(units >> 8, WDT_TIMEOUT + 1);
165         superio_outb(units, WDT_TIMEOUT);
166 }
167
168 static int
169 it8712f_wdt_get_status(void)
170 {
171         if (superio_inb(WDT_CONTROL) & 0x01)
172                 return WDIOF_CARDRESET;
173         else
174                 return 0;
175 }
176
177 static void
178 it8712f_wdt_enable(void)
179 {
180         printk(KERN_DEBUG NAME ": enabling watchdog timer\n");
181         superio_enter();
182         superio_select(LDN_GPIO);
183
184         superio_outb(WDT_RESET_GAME, WDT_CONTROL);
185
186         it8712f_wdt_update_margin();
187
188         superio_exit();
189
190         it8712f_wdt_ping();
191 }
192
193 static void
194 it8712f_wdt_disable(void)
195 {
196         printk(KERN_DEBUG NAME ": disabling watchdog timer\n");
197
198         superio_enter();
199         superio_select(LDN_GPIO);
200
201         superio_outb(0, WDT_CONFIG);
202         superio_outb(0, WDT_CONTROL);
203         superio_outb(0, WDT_TIMEOUT);
204
205         superio_exit();
206 }
207
208 static int
209 it8712f_wdt_notify(struct notifier_block *this,
210                     unsigned long code, void *unused)
211 {
212         if (code == SYS_HALT || code == SYS_POWER_OFF)
213                 if (!nowayout)
214                         it8712f_wdt_disable();
215
216         return NOTIFY_DONE;
217 }
218
219 static struct notifier_block it8712f_wdt_notifier = {
220         .notifier_call = it8712f_wdt_notify,
221 };
222
223 static ssize_t
224 it8712f_wdt_write(struct file *file, const char __user *data,
225         size_t len, loff_t *ppos)
226 {
227         /* check for a magic close character */
228         if (len) {
229                 size_t i;
230
231                 it8712f_wdt_ping();
232
233                 expect_close = 0;
234                 for (i = 0; i < len; ++i) {
235                         char c;
236                         if (get_user(c, data+i))
237                                 return -EFAULT;
238                         if (c == 'V')
239                                 expect_close = 42;
240                 }
241         }
242
243         return len;
244 }
245
246 static int
247 it8712f_wdt_ioctl(struct inode *inode, struct file *file,
248         unsigned int cmd, unsigned long arg)
249 {
250         void __user *argp = (void __user *)arg;
251         int __user *p = argp;
252         static struct watchdog_info ident = {
253                 .identity = "IT8712F Watchdog",
254                 .firmware_version = 1,
255                 .options = WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING,
256         };
257         int value;
258
259         switch (cmd) {
260         default:
261                 return -ENOTTY;
262         case WDIOC_GETSUPPORT:
263                 if (copy_to_user(argp, &ident, sizeof(ident)))
264                         return -EFAULT;
265                 return 0;
266         case WDIOC_GETSTATUS:
267                 superio_enter();
268                 superio_select(LDN_GPIO);
269
270                 value = it8712f_wdt_get_status();
271
272                 superio_exit();
273
274                 return put_user(value, p);
275         case WDIOC_GETBOOTSTATUS:
276                 return put_user(0, p);
277         case WDIOC_KEEPALIVE:
278                 it8712f_wdt_ping();
279                 return 0;
280         case WDIOC_SETTIMEOUT:
281                 if (get_user(value, p))
282                         return -EFAULT;
283                 if (value < 1)
284                         return -EINVAL;
285                 if (value > (max_units * 60))
286                         return -EINVAL;
287                 margin = value;
288                 superio_enter();
289                 superio_select(LDN_GPIO);
290
291                 it8712f_wdt_update_margin();
292
293                 superio_exit();
294                 it8712f_wdt_ping();
295                 /* Fall through */
296         case WDIOC_GETTIMEOUT:
297                 if (put_user(margin, p))
298                         return -EFAULT;
299                 return 0;
300         }
301 }
302
303 static int
304 it8712f_wdt_open(struct inode *inode, struct file *file)
305 {
306         /* only allow one at a time */
307         if (down_trylock(&it8712f_wdt_sem))
308                 return -EBUSY;
309         it8712f_wdt_enable();
310
311         return nonseekable_open(inode, file);
312 }
313
314 static int
315 it8712f_wdt_release(struct inode *inode, struct file *file)
316 {
317         if (expect_close != 42) {
318                 printk(KERN_WARNING NAME
319                         ": watchdog device closed unexpectedly, will not"
320                         " disable the watchdog timer\n");
321         } else if (!nowayout) {
322                 it8712f_wdt_disable();
323         }
324         expect_close = 0;
325         up(&it8712f_wdt_sem);
326
327         return 0;
328 }
329
330 static const struct file_operations it8712f_wdt_fops = {
331         .owner = THIS_MODULE,
332         .llseek = no_llseek,
333         .write = it8712f_wdt_write,
334         .ioctl = it8712f_wdt_ioctl,
335         .open = it8712f_wdt_open,
336         .release = it8712f_wdt_release,
337 };
338
339 static struct miscdevice it8712f_wdt_miscdev = {
340         .minor = WATCHDOG_MINOR,
341         .name = "watchdog",
342         .fops = &it8712f_wdt_fops,
343 };
344
345 static int __init
346 it8712f_wdt_find(unsigned short *address)
347 {
348         int err = -ENODEV;
349         int chip_type;
350
351         superio_enter();
352         chip_type = superio_inw(DEVID);
353         if (chip_type != IT8712F_DEVID)
354                 goto exit;
355
356         superio_select(LDN_GAME);
357         superio_outb(1, ACT_REG);
358         if (!(superio_inb(ACT_REG) & 0x01)) {
359                 printk(KERN_ERR NAME ": Device not activated, skipping\n");
360                 goto exit;
361         }
362
363         *address = superio_inw(BASE_REG);
364         if (*address == 0) {
365                 printk(KERN_ERR NAME ": Base address not set, skipping\n");
366                 goto exit;
367         }
368
369         err = 0;
370         revision = superio_inb(DEVREV) & 0x0f;
371
372         /* Later revisions have 16-bit values per datasheet 0.9.1 */
373         if (revision >= 0x08)
374                 max_units = 65535;
375
376         if (margin > (max_units * 60))
377                 margin = (max_units * 60);
378
379         printk(KERN_INFO NAME ": Found IT%04xF chip revision %d - "
380                 "using DogFood address 0x%x\n",
381                 chip_type, revision, *address);
382
383 exit:
384         superio_exit();
385         return err;
386 }
387
388 static int __init
389 it8712f_wdt_init(void)
390 {
391         int err = 0;
392
393         spin_lock_init(&io_lock);
394
395         if (it8712f_wdt_find(&address))
396                 return -ENODEV;
397
398         if (!request_region(address, 1, "IT8712F Watchdog")) {
399                 printk(KERN_WARNING NAME ": watchdog I/O region busy\n");
400                 return -EBUSY;
401         }
402
403         it8712f_wdt_disable();
404
405         sema_init(&it8712f_wdt_sem, 1);
406
407         err = register_reboot_notifier(&it8712f_wdt_notifier);
408         if (err) {
409                 printk(KERN_ERR NAME ": unable to register reboot notifier\n");
410                 goto out;
411         }
412
413         err = misc_register(&it8712f_wdt_miscdev);
414         if (err) {
415                 printk(KERN_ERR NAME
416                         ": cannot register miscdev on minor=%d (err=%d)\n",
417                         WATCHDOG_MINOR, err);
418                 goto reboot_out;
419         }
420
421         return 0;
422
423
424 reboot_out:
425         unregister_reboot_notifier(&it8712f_wdt_notifier);
426 out:
427         release_region(address, 1);
428         return err;
429 }
430
431 static void __exit
432 it8712f_wdt_exit(void)
433 {
434         misc_deregister(&it8712f_wdt_miscdev);
435         unregister_reboot_notifier(&it8712f_wdt_notifier);
436         release_region(address, 1);
437 }
438
439 module_init(it8712f_wdt_init);
440 module_exit(it8712f_wdt_exit);