treewide: Add SPDX license identifier for more missed files
[linux-2.6-block.git] / drivers / watchdog / pcwd.c
CommitLineData
09c434b8 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * PC Watchdog Driver
4 * by Ken Hollis (khollis@bitgate.com)
5 *
f9146f26 6 * Permission granted from Simon Machell (smachell@berkprod.com)
1da177e4
LT
7 * Written for the Linux Kernel, and GPLed by Ken Hollis
8 *
9 * 960107 Added request_region routines, modulized the whole thing.
10 * 960108 Fixed end-of-file pointer (Thanks to Dan Hollis), added
11 * WD_TIMEOUT define.
12 * 960216 Added eof marker on the file, and changed verbose messages.
13 * 960716 Made functional and cosmetic changes to the source for
14 * inclusion in Linux 2.0.x kernels, thanks to Alan Cox.
15 * 960717 Removed read/seek routines, replaced with ioctl. Also, added
16 * check_region command due to Alan's suggestion.
17 * 960821 Made changes to compile in newer 2.0.x kernels. Added
18 * "cold reboot sense" entry.
19 * 960825 Made a few changes to code, deleted some defines and made
20 * typedefs to replace them. Made heartbeat reset only available
21 * via ioctl, and removed the write routine.
22 * 960828 Added new items for PC Watchdog Rev.C card.
23 * 960829 Changed around all of the IOCTLs, added new features,
24 * added watchdog disable/re-enable routines. Added firmware
25 * version reporting. Added read routine for temperature.
26 * Removed some extra defines, added an autodetect Revision
27 * routine.
143a2e54
WVS
28 * 961006 Revised some documentation, fixed some cosmetic bugs. Made
29 * drivers to panic the system if it's overheating at bootup.
1da177e4
LT
30 * 961118 Changed some verbiage on some of the output, tidied up
31 * code bits, and added compatibility to 2.1.x.
143a2e54 32 * 970912 Enabled board on open and disable on close.
1da177e4 33 * 971107 Took account of recent VFS changes (broke read).
143a2e54
WVS
34 * 971210 Disable board on initialisation in case board already ticking.
35 * 971222 Changed open/close for temperature handling
36 * Michael Meskes <meskes@debian.org>.
37 * 980112 Used minor numbers from include/linux/miscdevice.h
38 * 990403 Clear reset status after reading control status register in
39 * pcwd_showprevstate(). [Marc Boucher <marc@mbsi.ca>]
1da177e4
LT
40 * 990605 Made changes to code to support Firmware 1.22a, added
41 * fairly useless proc entry.
42 * 990610 removed said useless proc code for the merge <alan>
43 * 000403 Removed last traces of proc code. <davej>
261dcc70
AC
44 * 011214 Added nowayout module option to override
45 * CONFIG_WATCHDOG_NOWAYOUT <Matt_Domsch@dell.com>
143a2e54 46 * Added timeout module option to override default
1da177e4
LT
47 */
48
49/*
50 * A bells and whistles driver is available from http://www.pcwd.de/
261dcc70
AC
51 * More info available at http://www.berkprod.com/ or
52 * http://www.pcwatchdog.com/
1da177e4
LT
53 */
54
27c766aa
JP
55#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
56
fd41fa61
WVS
57#include <linux/module.h> /* For module specific items */
58#include <linux/moduleparam.h> /* For new moduleparam's */
59#include <linux/types.h> /* For standard types (like size_t) */
60#include <linux/errno.h> /* For the -ENODEV/... values */
61#include <linux/kernel.h> /* For printk/panic/... */
62#include <linux/delay.h> /* For mdelay function */
63#include <linux/timer.h> /* For timer related operations */
64#include <linux/jiffies.h> /* For jiffies stuff */
487722cf 65#include <linux/miscdevice.h> /* For struct miscdevice */
fd41fa61 66#include <linux/watchdog.h> /* For the watchdog specific items */
5aa15050 67#include <linux/reboot.h> /* For kernel_power_off() */
fd41fa61
WVS
68#include <linux/init.h> /* For __init/__exit/... */
69#include <linux/fs.h> /* For file operations */
5aa15050 70#include <linux/isa.h> /* For isa devices */
fd41fa61
WVS
71#include <linux/ioport.h> /* For io-port access */
72#include <linux/spinlock.h> /* For spin_lock/spin_unlock/... */
261dcc70
AC
73#include <linux/uaccess.h> /* For copy_to_user/put_user/... */
74#include <linux/io.h> /* For inb/outb/... */
fd41fa61
WVS
75
76/* Module and version information */
5aa15050
WVS
77#define WATCHDOG_VERSION "1.20"
78#define WATCHDOG_DATE "18 Feb 2007"
a7122f91
WVS
79#define WATCHDOG_DRIVER_NAME "ISA-PC Watchdog"
80#define WATCHDOG_NAME "pcwd"
143a2e54 81#define DRIVER_VERSION WATCHDOG_DRIVER_NAME " driver, v" WATCHDOG_VERSION "\n"
1da177e4
LT
82
83/*
84 * It should be noted that PCWD_REVISION_B was removed because A and B
85 * are essentially the same types of card, with the exception that B
86 * has temperature reporting. Since I didn't receive a Rev.B card,
87 * the Rev.B card is not supported. (It's a good thing too, as they
88 * are no longer in production.)
89 */
90#define PCWD_REVISION_A 1
91#define PCWD_REVISION_C 2
92
5aa15050
WVS
93/*
94 * These are the auto-probe addresses available.
95 *
96 * Revision A only uses ports 0x270 and 0x370. Revision C introduced 0x350.
97 * Revision A has an address range of 2 addresses, while Revision C has 4.
98 */
99#define PCWD_ISA_NR_CARDS 3
100static int pcwd_ioports[] = { 0x270, 0x350, 0x370, 0x000 };
101
1da177e4 102/*
8f0235dc
WVS
103 * These are the defines that describe the control status bits for the
104 * PCI-PC Watchdog card.
105*/
106/* Port 1 : Control Status #1 for the PC Watchdog card, revision A. */
4206f0c4
WVS
107#define WD_WDRST 0x01 /* Previously reset state */
108#define WD_T110 0x02 /* Temperature overheat sense */
109#define WD_HRTBT 0x04 /* Heartbeat sense */
110#define WD_RLY2 0x08 /* External relay triggered */
111#define WD_SRLY2 0x80 /* Software external relay triggered */
8f0235dc 112/* Port 1 : Control Status #1 for the PC Watchdog card, revision C. */
4206f0c4
WVS
113#define WD_REVC_WTRP 0x01 /* Watchdog Trip status */
114#define WD_REVC_HRBT 0x02 /* Watchdog Heartbeat */
115#define WD_REVC_TTRP 0x04 /* Temperature Trip status */
261dcc70
AC
116#define WD_REVC_RL2A 0x08 /* Relay 2 activated by
117 on-board processor */
4206f0c4
WVS
118#define WD_REVC_RL1A 0x10 /* Relay 1 active */
119#define WD_REVC_R2DS 0x40 /* Relay 2 disable */
120#define WD_REVC_RLY2 0x80 /* Relay 2 activated? */
8f0235dc
WVS
121/* Port 2 : Control Status #2 */
122#define WD_WDIS 0x10 /* Watchdog Disabled */
123#define WD_ENTP 0x20 /* Watchdog Enable Temperature Trip */
261dcc70
AC
124#define WD_SSEL 0x40 /* Watchdog Switch Select
125 (1:SW1 <-> 0:SW2) */
8f0235dc 126#define WD_WCMD 0x80 /* Watchdog Command Mode */
1da177e4
LT
127
128/* max. time we give an ISA watchdog card to process a command */
129/* 500ms for each 4 bit response (according to spec.) */
130#define ISA_COMMAND_TIMEOUT 1000
131
132/* Watchdog's internal commands */
fd41fa61
WVS
133#define CMD_ISA_IDLE 0x00
134#define CMD_ISA_VERSION_INTEGER 0x01
135#define CMD_ISA_VERSION_TENTH 0x02
136#define CMD_ISA_VERSION_HUNDRETH 0x03
137#define CMD_ISA_VERSION_MINOR 0x04
138#define CMD_ISA_SWITCH_SETTINGS 0x05
369fa252
WVS
139#define CMD_ISA_RESET_PC 0x06
140#define CMD_ISA_ARM_0 0x07
141#define CMD_ISA_ARM_30 0x08
142#define CMD_ISA_ARM_60 0x09
fd41fa61
WVS
143#define CMD_ISA_DELAY_TIME_2SECS 0x0A
144#define CMD_ISA_DELAY_TIME_4SECS 0x0B
145#define CMD_ISA_DELAY_TIME_8SECS 0x0C
369fa252 146#define CMD_ISA_RESET_RELAYS 0x0D
1da177e4 147
f3dc0733 148/* Watchdog's Dip Switch heartbeat values */
7944d3a5 149static const int heartbeat_tbl[] = {
f3dc0733
WVS
150 20, /* OFF-OFF-OFF = 20 Sec */
151 40, /* OFF-OFF-ON = 40 Sec */
152 60, /* OFF-ON-OFF = 1 Min */
153 300, /* OFF-ON-ON = 5 Min */
154 600, /* ON-OFF-OFF = 10 Min */
155 1800, /* ON-OFF-ON = 30 Min */
156 3600, /* ON-ON-OFF = 1 Hour */
157 7200, /* ON-ON-ON = 2 hour */
158};
159
1da177e4
LT
160/*
161 * We are using an kernel timer to do the pinging of the watchdog
162 * every ~500ms. We try to set the internal heartbeat of the
163 * watchdog to 2 ms.
164 */
165
166#define WDT_INTERVAL (HZ/2+1)
167
168/* We can only use 1 card due to the /dev/watchdog restriction */
169static int cards_found;
170
171/* internal variables */
36cbaa87 172static unsigned long open_allowed;
1da177e4 173static char expect_close;
1da177e4 174static int temp_panic;
261dcc70
AC
175
176/* this is private data for each ISA-PC watchdog card */
177static struct {
2891b6ad 178 char fw_ver_str[6]; /* The cards firmware version */
a2be8786 179 int revision; /* The card's revision */
261dcc70
AC
180 int supports_temp; /* Whether or not the card has
181 a temperature device */
182 int command_mode; /* Whether or not the card is in
183 command mode */
a2be8786
WVS
184 int boot_status; /* The card's boot status */
185 int io_addr; /* The cards I/O address */
186 spinlock_t io_lock; /* the lock for io operations */
187 struct timer_list timer; /* The timer that pings the watchdog */
188 unsigned long next_heartbeat; /* the next_heartbeat for the timer */
189} pcwd_private;
1da177e4
LT
190
191/* module parameters */
c324ab42
WVS
192#define QUIET 0 /* Default */
193#define VERBOSE 1 /* Verbose */
194#define DEBUG 2 /* print fancy stuff too */
195static int debug = QUIET;
196module_param(debug, int, 0);
261dcc70
AC
197MODULE_PARM_DESC(debug,
198 "Debug level: 0=Quiet, 1=Verbose, 2=Debug (default=0)");
c324ab42 199
261dcc70
AC
200/* default heartbeat = delay-time from dip-switches */
201#define WATCHDOG_HEARTBEAT 0
1da177e4
LT
202static int heartbeat = WATCHDOG_HEARTBEAT;
203module_param(heartbeat, int, 0);
143a2e54
WVS
204MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
205 "(2 <= heartbeat <= 7200 or 0=delay-time from dip-switches, default="
206 __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
1da177e4 207
86a1e189
WVS
208static bool nowayout = WATCHDOG_NOWAYOUT;
209module_param(nowayout, bool, 0);
261dcc70
AC
210MODULE_PARM_DESC(nowayout,
211 "Watchdog cannot be stopped once started (default="
212 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
1da177e4
LT
213
214/*
215 * Internal functions
216 */
217
218static int send_isa_command(int cmd)
219{
220 int i;
221 int control_status;
222 int port0, last_port0; /* Double read for stabilising */
223
c324ab42 224 if (debug >= DEBUG)
27c766aa 225 pr_debug("sending following data cmd=0x%02x\n", cmd);
c324ab42 226
1da177e4 227 /* The WCMD bit must be 1 and the command is only 4 bits in size */
8f0235dc 228 control_status = (cmd & 0x0F) | WD_WCMD;
a2be8786 229 outb_p(control_status, pcwd_private.io_addr + 2);
1da177e4
LT
230 udelay(ISA_COMMAND_TIMEOUT);
231
a2be8786 232 port0 = inb_p(pcwd_private.io_addr);
1da177e4
LT
233 for (i = 0; i < 25; ++i) {
234 last_port0 = port0;
a2be8786 235 port0 = inb_p(pcwd_private.io_addr);
1da177e4
LT
236
237 if (port0 == last_port0)
238 break; /* Data is stable */
239
261dcc70 240 udelay(250);
1da177e4
LT
241 }
242
c324ab42 243 if (debug >= DEBUG)
27c766aa
JP
244 pr_debug("received following data for cmd=0x%02x: port0=0x%02x last_port0=0x%02x\n",
245 cmd, port0, last_port0);
c324ab42 246
1da177e4
LT
247 return port0;
248}
249
250static int set_command_mode(void)
251{
261dcc70 252 int i, found = 0, count = 0;
1da177e4
LT
253
254 /* Set the card into command mode */
a2be8786 255 spin_lock(&pcwd_private.io_lock);
1da177e4
LT
256 while ((!found) && (count < 3)) {
257 i = send_isa_command(CMD_ISA_IDLE);
258
259 if (i == 0x00)
260 found = 1;
261 else if (i == 0xF3) {
262 /* Card does not like what we've done to it */
a2be8786 263 outb_p(0x00, pcwd_private.io_addr + 2);
1da177e4 264 udelay(1200); /* Spec says wait 1ms */
a2be8786 265 outb_p(0x00, pcwd_private.io_addr + 2);
1da177e4
LT
266 udelay(ISA_COMMAND_TIMEOUT);
267 }
268 count++;
269 }
a2be8786
WVS
270 spin_unlock(&pcwd_private.io_lock);
271 pcwd_private.command_mode = found;
1da177e4 272
c324ab42 273 if (debug >= DEBUG)
27c766aa 274 pr_debug("command_mode=%d\n", pcwd_private.command_mode);
c324ab42 275
7944d3a5 276 return found;
1da177e4
LT
277}
278
279static void unset_command_mode(void)
280{
281 /* Set the card into normal mode */
a2be8786
WVS
282 spin_lock(&pcwd_private.io_lock);
283 outb_p(0x00, pcwd_private.io_addr + 2);
1da177e4 284 udelay(ISA_COMMAND_TIMEOUT);
a2be8786 285 spin_unlock(&pcwd_private.io_lock);
1da177e4 286
a2be8786 287 pcwd_private.command_mode = 0;
c324ab42
WVS
288
289 if (debug >= DEBUG)
27c766aa 290 pr_debug("command_mode=%d\n", pcwd_private.command_mode);
1da177e4
LT
291}
292
85875211
WVS
293static inline void pcwd_check_temperature_support(void)
294{
295 if (inb(pcwd_private.io_addr) != 0xF0)
296 pcwd_private.supports_temp = 1;
297}
298
2891b6ad 299static inline void pcwd_get_firmware(void)
af3b38d9
WVS
300{
301 int one, ten, hund, minor;
af3b38d9 302
6bbc20bc 303 strcpy(pcwd_private.fw_ver_str, "ERROR");
af3b38d9
WVS
304
305 if (set_command_mode()) {
306 one = send_isa_command(CMD_ISA_VERSION_INTEGER);
307 ten = send_isa_command(CMD_ISA_VERSION_TENTH);
308 hund = send_isa_command(CMD_ISA_VERSION_HUNDRETH);
309 minor = send_isa_command(CMD_ISA_VERSION_MINOR);
261dcc70
AC
310 sprintf(pcwd_private.fw_ver_str, "%c.%c%c%c",
311 one, ten, hund, minor);
af3b38d9 312 }
af3b38d9 313 unset_command_mode();
2891b6ad
WVS
314
315 return;
af3b38d9
WVS
316}
317
318static inline int pcwd_get_option_switches(void)
319{
261dcc70 320 int option_switches = 0;
af3b38d9
WVS
321
322 if (set_command_mode()) {
323 /* Get switch settings */
324 option_switches = send_isa_command(CMD_ISA_SWITCH_SETTINGS);
325 }
326
327 unset_command_mode();
7944d3a5 328 return option_switches;
af3b38d9
WVS
329}
330
331static void pcwd_show_card_info(void)
332{
af3b38d9
WVS
333 int option_switches;
334
335 /* Get some extra info from the hardware (in command/debug/diag mode) */
336 if (pcwd_private.revision == PCWD_REVISION_A)
27c766aa
JP
337 pr_info("ISA-PC Watchdog (REV.A) detected at port 0x%04x\n",
338 pcwd_private.io_addr);
af3b38d9 339 else if (pcwd_private.revision == PCWD_REVISION_C) {
2891b6ad 340 pcwd_get_firmware();
27c766aa 341 pr_info("ISA-PC Watchdog (REV.C) detected at port 0x%04x (Firmware version: %s)\n",
2891b6ad 342 pcwd_private.io_addr, pcwd_private.fw_ver_str);
af3b38d9 343 option_switches = pcwd_get_option_switches();
27c766aa 344 pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
af3b38d9
WVS
345 option_switches,
346 ((option_switches & 0x10) ? "ON" : "OFF"),
347 ((option_switches & 0x08) ? "ON" : "OFF"));
348
349 /* Reprogram internal heartbeat to 2 seconds */
350 if (set_command_mode()) {
351 send_isa_command(CMD_ISA_DELAY_TIME_2SECS);
352 unset_command_mode();
353 }
354 }
355
356 if (pcwd_private.supports_temp)
27c766aa 357 pr_info("Temperature Option Detected\n");
af3b38d9
WVS
358
359 if (pcwd_private.boot_status & WDIOF_CARDRESET)
27c766aa 360 pr_info("Previous reboot was caused by the card\n");
af3b38d9
WVS
361
362 if (pcwd_private.boot_status & WDIOF_OVERHEAT) {
27c766aa
JP
363 pr_emerg("Card senses a CPU Overheat. Panicking!\n");
364 pr_emerg("CPU Overheat\n");
af3b38d9
WVS
365 }
366
367 if (pcwd_private.boot_status == 0)
27c766aa 368 pr_info("No previous trip detected - Cold boot or reset\n");
af3b38d9
WVS
369}
370
e99e88a9 371static void pcwd_timer_ping(struct timer_list *unused)
1da177e4
LT
372{
373 int wdrst_stat;
374
375 /* If we got a heartbeat pulse within the WDT_INTERVAL
376 * we agree to ping the WDT */
261dcc70 377 if (time_before(jiffies, pcwd_private.next_heartbeat)) {
1da177e4 378 /* Ping the watchdog */
a2be8786
WVS
379 spin_lock(&pcwd_private.io_lock);
380 if (pcwd_private.revision == PCWD_REVISION_A) {
261dcc70
AC
381 /* Rev A cards are reset by setting the
382 WD_WDRST bit in register 1 */
a2be8786 383 wdrst_stat = inb_p(pcwd_private.io_addr);
1da177e4
LT
384 wdrst_stat &= 0x0F;
385 wdrst_stat |= WD_WDRST;
386
a2be8786 387 outb_p(wdrst_stat, pcwd_private.io_addr + 1);
1da177e4
LT
388 } else {
389 /* Re-trigger watchdog by writing to port 0 */
a2be8786 390 outb_p(0x00, pcwd_private.io_addr);
1da177e4
LT
391 }
392
393 /* Re-set the timer interval */
a2be8786 394 mod_timer(&pcwd_private.timer, jiffies + WDT_INTERVAL);
1da177e4 395
a2be8786 396 spin_unlock(&pcwd_private.io_lock);
1da177e4 397 } else {
27c766aa 398 pr_warn("Heartbeat lost! Will not ping the watchdog\n");
1da177e4
LT
399 }
400}
401
402static int pcwd_start(void)
403{
404 int stat_reg;
405
a2be8786 406 pcwd_private.next_heartbeat = jiffies + (heartbeat * HZ);
1da177e4
LT
407
408 /* Start the timer */
a2be8786 409 mod_timer(&pcwd_private.timer, jiffies + WDT_INTERVAL);
1da177e4
LT
410
411 /* Enable the port */
a2be8786
WVS
412 if (pcwd_private.revision == PCWD_REVISION_C) {
413 spin_lock(&pcwd_private.io_lock);
414 outb_p(0x00, pcwd_private.io_addr + 3);
1da177e4 415 udelay(ISA_COMMAND_TIMEOUT);
a2be8786
WVS
416 stat_reg = inb_p(pcwd_private.io_addr + 2);
417 spin_unlock(&pcwd_private.io_lock);
8f0235dc 418 if (stat_reg & WD_WDIS) {
27c766aa 419 pr_info("Could not start watchdog\n");
1da177e4
LT
420 return -EIO;
421 }
422 }
c324ab42
WVS
423
424 if (debug >= VERBOSE)
27c766aa 425 pr_debug("Watchdog started\n");
c324ab42 426
1da177e4
LT
427 return 0;
428}
429
430static int pcwd_stop(void)
431{
432 int stat_reg;
433
434 /* Stop the timer */
a2be8786 435 del_timer(&pcwd_private.timer);
1da177e4
LT
436
437 /* Disable the board */
a2be8786
WVS
438 if (pcwd_private.revision == PCWD_REVISION_C) {
439 spin_lock(&pcwd_private.io_lock);
440 outb_p(0xA5, pcwd_private.io_addr + 3);
1da177e4 441 udelay(ISA_COMMAND_TIMEOUT);
a2be8786 442 outb_p(0xA5, pcwd_private.io_addr + 3);
1da177e4 443 udelay(ISA_COMMAND_TIMEOUT);
a2be8786
WVS
444 stat_reg = inb_p(pcwd_private.io_addr + 2);
445 spin_unlock(&pcwd_private.io_lock);
8f0235dc 446 if ((stat_reg & WD_WDIS) == 0) {
27c766aa 447 pr_info("Could not stop watchdog\n");
1da177e4
LT
448 return -EIO;
449 }
450 }
c324ab42
WVS
451
452 if (debug >= VERBOSE)
27c766aa 453 pr_debug("Watchdog stopped\n");
c324ab42 454
1da177e4
LT
455 return 0;
456}
457
458static int pcwd_keepalive(void)
459{
460 /* user land ping */
a2be8786 461 pcwd_private.next_heartbeat = jiffies + (heartbeat * HZ);
c324ab42
WVS
462
463 if (debug >= DEBUG)
27c766aa 464 pr_debug("Watchdog keepalive signal send\n");
c324ab42 465
1da177e4
LT
466 return 0;
467}
468
469static int pcwd_set_heartbeat(int t)
470{
261dcc70 471 if (t < 2 || t > 7200) /* arbitrary upper limit */
1da177e4
LT
472 return -EINVAL;
473
474 heartbeat = t;
c324ab42
WVS
475
476 if (debug >= VERBOSE)
27c766aa 477 pr_debug("New heartbeat: %d\n", heartbeat);
c324ab42 478
1da177e4
LT
479 return 0;
480}
481
482static int pcwd_get_status(int *status)
483{
4206f0c4 484 int control_status;
1da177e4 485
261dcc70 486 *status = 0;
a2be8786
WVS
487 spin_lock(&pcwd_private.io_lock);
488 if (pcwd_private.revision == PCWD_REVISION_A)
1da177e4
LT
489 /* Rev A cards return status information from
490 * the base register, which is used for the
491 * temperature in other cards. */
4206f0c4 492 control_status = inb(pcwd_private.io_addr);
1da177e4
LT
493 else {
494 /* Rev C cards return card status in the base
495 * address + 1 register. And use different bits
496 * to indicate a card initiated reset, and an
497 * over-temperature condition. And the reboot
498 * status can be reset. */
4206f0c4 499 control_status = inb(pcwd_private.io_addr + 1);
1da177e4 500 }
a2be8786 501 spin_unlock(&pcwd_private.io_lock);
1da177e4 502
a2be8786 503 if (pcwd_private.revision == PCWD_REVISION_A) {
4206f0c4 504 if (control_status & WD_WDRST)
1da177e4
LT
505 *status |= WDIOF_CARDRESET;
506
4206f0c4 507 if (control_status & WD_T110) {
1da177e4
LT
508 *status |= WDIOF_OVERHEAT;
509 if (temp_panic) {
27c766aa 510 pr_info("Temperature overheat trip!\n");
68acc05d 511 kernel_power_off();
1da177e4
LT
512 }
513 }
514 } else {
4206f0c4 515 if (control_status & WD_REVC_WTRP)
1da177e4
LT
516 *status |= WDIOF_CARDRESET;
517
4206f0c4 518 if (control_status & WD_REVC_TTRP) {
1da177e4
LT
519 *status |= WDIOF_OVERHEAT;
520 if (temp_panic) {
27c766aa 521 pr_info("Temperature overheat trip!\n");
68acc05d 522 kernel_power_off();
1da177e4
LT
523 }
524 }
525 }
526
527 return 0;
528}
529
530static int pcwd_clear_status(void)
531{
4206f0c4
WVS
532 int control_status;
533
a2be8786
WVS
534 if (pcwd_private.revision == PCWD_REVISION_C) {
535 spin_lock(&pcwd_private.io_lock);
4206f0c4 536
c324ab42 537 if (debug >= VERBOSE)
27c766aa 538 pr_info("clearing watchdog trip status\n");
c324ab42 539
4206f0c4
WVS
540 control_status = inb_p(pcwd_private.io_addr + 1);
541
c324ab42 542 if (debug >= DEBUG) {
27c766aa
JP
543 pr_debug("status was: 0x%02x\n", control_status);
544 pr_debug("sending: 0x%02x\n",
545 (control_status & WD_REVC_R2DS));
c324ab42
WVS
546 }
547
4206f0c4 548 /* clear reset status & Keep Relay 2 disable state as it is */
261dcc70
AC
549 outb_p((control_status & WD_REVC_R2DS),
550 pcwd_private.io_addr + 1);
4206f0c4 551
a2be8786 552 spin_unlock(&pcwd_private.io_lock);
1da177e4
LT
553 }
554 return 0;
555}
556
557static int pcwd_get_temperature(int *temperature)
558{
559 /* check that port 0 gives temperature info and no command results */
a2be8786 560 if (pcwd_private.command_mode)
1da177e4
LT
561 return -1;
562
563 *temperature = 0;
a2be8786 564 if (!pcwd_private.supports_temp)
1da177e4
LT
565 return -ENODEV;
566
567 /*
568 * Convert celsius to fahrenheit, since this was
569 * the decided 'standard' for this return value.
570 */
a2be8786
WVS
571 spin_lock(&pcwd_private.io_lock);
572 *temperature = ((inb(pcwd_private.io_addr)) * 9 / 5) + 32;
573 spin_unlock(&pcwd_private.io_lock);
1da177e4 574
c324ab42 575 if (debug >= DEBUG) {
27c766aa 576 pr_debug("temperature is: %d F\n", *temperature);
c324ab42
WVS
577 }
578
1da177e4
LT
579 return 0;
580}
581
582/*
583 * /dev/watchdog handling
584 */
585
261dcc70 586static long pcwd_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1da177e4
LT
587{
588 int rv;
589 int status;
590 int temperature;
591 int new_heartbeat;
592 int __user *argp = (int __user *)arg;
42747d71 593 static const struct watchdog_info ident = {
1da177e4
LT
594 .options = WDIOF_OVERHEAT |
595 WDIOF_CARDRESET |
596 WDIOF_KEEPALIVEPING |
597 WDIOF_SETTIMEOUT |
598 WDIOF_MAGICCLOSE,
599 .firmware_version = 1,
600 .identity = "PCWD",
601 };
602
261dcc70 603 switch (cmd) {
1da177e4 604 case WDIOC_GETSUPPORT:
261dcc70 605 if (copy_to_user(argp, &ident, sizeof(ident)))
1da177e4
LT
606 return -EFAULT;
607 return 0;
608
609 case WDIOC_GETSTATUS:
610 pcwd_get_status(&status);
611 return put_user(status, argp);
612
613 case WDIOC_GETBOOTSTATUS:
a2be8786 614 return put_user(pcwd_private.boot_status, argp);
1da177e4
LT
615
616 case WDIOC_GETTEMP:
617 if (pcwd_get_temperature(&temperature))
618 return -EFAULT;
619
620 return put_user(temperature, argp);
621
622 case WDIOC_SETOPTIONS:
261dcc70
AC
623 if (pcwd_private.revision == PCWD_REVISION_C) {
624 if (get_user(rv, argp))
1da177e4
LT
625 return -EFAULT;
626
261dcc70
AC
627 if (rv & WDIOS_DISABLECARD) {
628 status = pcwd_stop();
629 if (status < 0)
630 return status;
1da177e4 631 }
261dcc70
AC
632 if (rv & WDIOS_ENABLECARD) {
633 status = pcwd_start();
634 if (status < 0)
635 return status;
1da177e4 636 }
1da177e4 637 if (rv & WDIOS_TEMPPANIC)
1da177e4 638 temp_panic = 1;
1da177e4
LT
639 }
640 return -EINVAL;
641
642 case WDIOC_KEEPALIVE:
643 pcwd_keepalive();
644 return 0;
645
646 case WDIOC_SETTIMEOUT:
647 if (get_user(new_heartbeat, argp))
648 return -EFAULT;
649
650 if (pcwd_set_heartbeat(new_heartbeat))
651 return -EINVAL;
652
653 pcwd_keepalive();
654 /* Fall */
655
656 case WDIOC_GETTIMEOUT:
657 return put_user(heartbeat, argp);
0c06090c
WVS
658
659 default:
660 return -ENOTTY;
1da177e4
LT
661 }
662
663 return 0;
664}
665
666static ssize_t pcwd_write(struct file *file, const char __user *buf, size_t len,
667 loff_t *ppos)
668{
669 if (len) {
670 if (!nowayout) {
671 size_t i;
672
673 /* In case it was set long ago */
674 expect_close = 0;
675
676 for (i = 0; i != len; i++) {
677 char c;
678
679 if (get_user(c, buf + i))
680 return -EFAULT;
681 if (c == 'V')
682 expect_close = 42;
683 }
684 }
685 pcwd_keepalive();
686 }
687 return len;
688}
689
690static int pcwd_open(struct inode *inode, struct file *file)
691{
261dcc70 692 if (test_and_set_bit(0, &open_allowed))
1da177e4 693 return -EBUSY;
1da177e4
LT
694 if (nowayout)
695 __module_get(THIS_MODULE);
1da177e4
LT
696 /* Activate */
697 pcwd_start();
698 pcwd_keepalive();
c5bf68fe 699 return stream_open(inode, file);
1da177e4
LT
700}
701
702static int pcwd_close(struct inode *inode, struct file *file)
703{
261dcc70 704 if (expect_close == 42)
1da177e4 705 pcwd_stop();
261dcc70 706 else {
27c766aa 707 pr_crit("Unexpected close, not stopping watchdog!\n");
1da177e4
LT
708 pcwd_keepalive();
709 }
710 expect_close = 0;
261dcc70 711 clear_bit(0, &open_allowed);
1da177e4
LT
712 return 0;
713}
714
715/*
716 * /dev/temperature handling
717 */
718
719static ssize_t pcwd_temp_read(struct file *file, char __user *buf, size_t count,
720 loff_t *ppos)
721{
722 int temperature;
723
724 if (pcwd_get_temperature(&temperature))
725 return -EFAULT;
726
727 if (copy_to_user(buf, &temperature, 1))
728 return -EFAULT;
729
730 return 1;
731}
732
733static int pcwd_temp_open(struct inode *inode, struct file *file)
734{
a2be8786 735 if (!pcwd_private.supports_temp)
1da177e4
LT
736 return -ENODEV;
737
c5bf68fe 738 return stream_open(inode, file);
1da177e4
LT
739}
740
741static int pcwd_temp_close(struct inode *inode, struct file *file)
742{
743 return 0;
744}
745
1da177e4
LT
746/*
747 * Kernel Interfaces
748 */
749
62322d25 750static const struct file_operations pcwd_fops = {
1da177e4
LT
751 .owner = THIS_MODULE,
752 .llseek = no_llseek,
753 .write = pcwd_write,
261dcc70 754 .unlocked_ioctl = pcwd_ioctl,
1da177e4
LT
755 .open = pcwd_open,
756 .release = pcwd_close,
757};
758
759static struct miscdevice pcwd_miscdev = {
760 .minor = WATCHDOG_MINOR,
761 .name = "watchdog",
762 .fops = &pcwd_fops,
763};
764
62322d25 765static const struct file_operations pcwd_temp_fops = {
1da177e4
LT
766 .owner = THIS_MODULE,
767 .llseek = no_llseek,
768 .read = pcwd_temp_read,
769 .open = pcwd_temp_open,
770 .release = pcwd_temp_close,
771};
772
773static struct miscdevice temp_miscdev = {
774 .minor = TEMP_MINOR,
775 .name = "temperature",
776 .fops = &pcwd_temp_fops,
777};
778
1da177e4
LT
779/*
780 * Init & exit routines
781 */
782
1da177e4
LT
783static inline int get_revision(void)
784{
785 int r = PCWD_REVISION_C;
786
a2be8786 787 spin_lock(&pcwd_private.io_lock);
1da177e4
LT
788 /* REV A cards use only 2 io ports; test
789 * presumes a floating bus reads as 0xff. */
a2be8786
WVS
790 if ((inb(pcwd_private.io_addr + 2) == 0xFF) ||
791 (inb(pcwd_private.io_addr + 3) == 0xFF))
261dcc70 792 r = PCWD_REVISION_A;
a2be8786 793 spin_unlock(&pcwd_private.io_lock);
1da177e4
LT
794
795 return r;
796}
797
5aa15050
WVS
798/*
799 * The ISA cards have a heartbeat bit in one of the registers, which
800 * register is card dependent. The heartbeat bit is monitored, and if
801 * found, is considered proof that a Berkshire card has been found.
802 * The initial rate is once per second at board start up, then twice
803 * per second for normal operation.
804 */
2d991a16 805static int pcwd_isa_match(struct device *dev, unsigned int id)
5aa15050 806{
261dcc70 807 int base_addr = pcwd_ioports[id];
5aa15050
WVS
808 int port0, last_port0; /* Reg 0, in case it's REV A */
809 int port1, last_port1; /* Register 1 for REV C cards */
810 int i;
811 int retval;
812
813 if (debug >= DEBUG)
27c766aa 814 pr_debug("pcwd_isa_match id=%d\n", id);
5aa15050 815
261dcc70 816 if (!request_region(base_addr, 4, "PCWD")) {
27c766aa 817 pr_info("Port 0x%04x unavailable\n", base_addr);
5aa15050
WVS
818 return 0;
819 }
820
821 retval = 0;
822
823 port0 = inb_p(base_addr); /* For REV A boards */
824 port1 = inb_p(base_addr + 1); /* For REV C boards */
825 if (port0 != 0xff || port1 != 0xff) {
826 /* Not an 'ff' from a floating bus, so must be a card! */
827 for (i = 0; i < 4; ++i) {
828
829 msleep(500);
830
831 last_port0 = port0;
832 last_port1 = port1;
833
834 port0 = inb_p(base_addr);
835 port1 = inb_p(base_addr + 1);
836
837 /* Has either hearbeat bit changed? */
838 if ((port0 ^ last_port0) & WD_HRTBT ||
839 (port1 ^ last_port1) & WD_REVC_HRBT) {
840 retval = 1;
841 break;
842 }
843 }
844 }
261dcc70 845 release_region(base_addr, 4);
5aa15050
WVS
846
847 return retval;
848}
849
2d991a16 850static int pcwd_isa_probe(struct device *dev, unsigned int id)
1da177e4
LT
851{
852 int ret;
1da177e4 853
5aa15050 854 if (debug >= DEBUG)
27c766aa 855 pr_debug("pcwd_isa_probe id=%d\n", id);
5aa15050 856
1da177e4
LT
857 cards_found++;
858 if (cards_found == 1)
27c766aa 859 pr_info("v%s Ken Hollis (kenji@bitgate.com)\n",
143a2e54 860 WATCHDOG_VERSION);
1da177e4
LT
861
862 if (cards_found > 1) {
27c766aa 863 pr_err("This driver only supports 1 device\n");
1da177e4
LT
864 return -ENODEV;
865 }
866
5aa15050 867 if (pcwd_ioports[id] == 0x0000) {
27c766aa 868 pr_err("No I/O-Address for card detected\n");
1da177e4
LT
869 return -ENODEV;
870 }
5aa15050
WVS
871 pcwd_private.io_addr = pcwd_ioports[id];
872
873 spin_lock_init(&pcwd_private.io_lock);
1da177e4
LT
874
875 /* Check card's revision */
a2be8786 876 pcwd_private.revision = get_revision();
1da177e4 877
261dcc70
AC
878 if (!request_region(pcwd_private.io_addr,
879 (pcwd_private.revision == PCWD_REVISION_A) ? 2 : 4, "PCWD")) {
27c766aa
JP
880 pr_err("I/O address 0x%04x already in use\n",
881 pcwd_private.io_addr);
261dcc70 882 ret = -EIO;
5aa15050 883 goto error_request_region;
1da177e4
LT
884 }
885
886 /* Initial variables */
a2be8786 887 pcwd_private.supports_temp = 0;
1da177e4 888 temp_panic = 0;
a2be8786 889 pcwd_private.boot_status = 0x0000;
1da177e4
LT
890
891 /* get the boot_status */
a2be8786 892 pcwd_get_status(&pcwd_private.boot_status);
1da177e4
LT
893
894 /* clear the "card caused reboot" flag */
895 pcwd_clear_status();
896
e99e88a9 897 timer_setup(&pcwd_private.timer, pcwd_timer_ping, 0);
1da177e4
LT
898
899 /* Disable the board */
900 pcwd_stop();
901
902 /* Check whether or not the card supports the temperature device */
85875211 903 pcwd_check_temperature_support();
1da177e4 904
af3b38d9
WVS
905 /* Show info about the card itself */
906 pcwd_show_card_info();
1da177e4 907
f3dc0733
WVS
908 /* If heartbeat = 0 then we use the heartbeat from the dip-switches */
909 if (heartbeat == 0)
910 heartbeat = heartbeat_tbl[(pcwd_get_option_switches() & 0x07)];
911
261dcc70
AC
912 /* Check that the heartbeat value is within it's range;
913 if not reset to the default */
fd41fa61
WVS
914 if (pcwd_set_heartbeat(heartbeat)) {
915 pcwd_set_heartbeat(WATCHDOG_HEARTBEAT);
27c766aa
JP
916 pr_info("heartbeat value must be 2 <= heartbeat <= 7200, using %d\n",
917 WATCHDOG_HEARTBEAT);
1da177e4
LT
918 }
919
a2be8786 920 if (pcwd_private.supports_temp) {
1da177e4
LT
921 ret = misc_register(&temp_miscdev);
922 if (ret) {
27c766aa
JP
923 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
924 TEMP_MINOR, ret);
5aa15050 925 goto error_misc_register_temp;
1da177e4
LT
926 }
927 }
928
929 ret = misc_register(&pcwd_miscdev);
930 if (ret) {
27c766aa
JP
931 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
932 WATCHDOG_MINOR, ret);
5aa15050 933 goto error_misc_register_watchdog;
1da177e4
LT
934 }
935
27c766aa 936 pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
1da177e4
LT
937 heartbeat, nowayout);
938
939 return 0;
5aa15050
WVS
940
941error_misc_register_watchdog:
942 if (pcwd_private.supports_temp)
943 misc_deregister(&temp_miscdev);
944error_misc_register_temp:
261dcc70
AC
945 release_region(pcwd_private.io_addr,
946 (pcwd_private.revision == PCWD_REVISION_A) ? 2 : 4);
5aa15050
WVS
947error_request_region:
948 pcwd_private.io_addr = 0x0000;
949 cards_found--;
950 return ret;
1da177e4
LT
951}
952
4b12b896 953static int pcwd_isa_remove(struct device *dev, unsigned int id)
1da177e4 954{
5aa15050 955 if (debug >= DEBUG)
27c766aa 956 pr_debug("pcwd_isa_remove id=%d\n", id);
5aa15050
WVS
957
958 if (!pcwd_private.io_addr)
959 return 1;
960
1da177e4
LT
961 /* Disable the board */
962 if (!nowayout)
963 pcwd_stop();
964
965 /* Deregister */
966 misc_deregister(&pcwd_miscdev);
a2be8786 967 if (pcwd_private.supports_temp)
1da177e4 968 misc_deregister(&temp_miscdev);
261dcc70
AC
969 release_region(pcwd_private.io_addr,
970 (pcwd_private.revision == PCWD_REVISION_A) ? 2 : 4);
a2be8786 971 pcwd_private.io_addr = 0x0000;
f1c3a056 972 cards_found--;
5aa15050
WVS
973
974 return 0;
1da177e4
LT
975}
976
5aa15050 977static void pcwd_isa_shutdown(struct device *dev, unsigned int id)
1da177e4 978{
5aa15050 979 if (debug >= DEBUG)
27c766aa 980 pr_debug("pcwd_isa_shutdown id=%d\n", id);
1da177e4 981
5aa15050 982 pcwd_stop();
1da177e4
LT
983}
984
5aa15050
WVS
985static struct isa_driver pcwd_isa_driver = {
986 .match = pcwd_isa_match,
987 .probe = pcwd_isa_probe,
82268714 988 .remove = pcwd_isa_remove,
5aa15050
WVS
989 .shutdown = pcwd_isa_shutdown,
990 .driver = {
991 .owner = THIS_MODULE,
992 .name = WATCHDOG_NAME,
993 },
994};
1da177e4 995
b7a8c420 996module_isa_driver(pcwd_isa_driver, PCWD_ISA_NR_CARDS);
1da177e4 997
143a2e54
WVS
998MODULE_AUTHOR("Ken Hollis <kenji@bitgate.com>, "
999 "Wim Van Sebroeck <wim@iguana.be>");
1da177e4 1000MODULE_DESCRIPTION("Berkshire ISA-PC Watchdog driver");
5aa15050 1001MODULE_VERSION(WATCHDOG_VERSION);
1da177e4 1002MODULE_LICENSE("GPL");