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