2
* Intel_SCU 0.2: An Intel SCU IOH Based Watchdog Device
6
* Copyright (C) 2009-2010 Intel Corporation. All rights reserved.
8
* This program is free software; you can redistribute it and/or
9
* modify it under the terms of version 2 of the GNU General
10
* Public License as published by the Free Software Foundation.
12
* This program is distributed in the hope that it will be
13
* useful, but WITHOUT ANY WARRANTY; without even the implied
14
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15
* PURPOSE. See the GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public
17
* License along with this program; if not, write to the Free
18
* Software Foundation, Inc., 59 Temple Place - Suite 330,
19
* Boston, MA 02111-1307, USA.
20
* The full GNU General Public License is included in this
21
* distribution in the file called COPYING.
25
#include <linux/compiler.h>
26
#include <linux/module.h>
27
#include <linux/kernel.h>
28
#include <linux/moduleparam.h>
29
#include <linux/types.h>
30
#include <linux/miscdevice.h>
31
#include <linux/watchdog.h>
33
#include <linux/notifier.h>
34
#include <linux/reboot.h>
35
#include <linux/init.h>
36
#include <linux/jiffies.h>
37
#include <linux/uaccess.h>
38
#include <linux/slab.h>
40
#include <linux/interrupt.h>
41
#include <linux/delay.h>
42
#include <linux/sched.h>
43
#include <linux/signal.h>
44
#include <linux/sfi.h>
46
#include <linux/atomic.h>
47
#include <asm/intel_scu_ipc.h>
48
#include <asm/apb_timer.h>
51
#include "intel_scu_watchdog.h"
53
/* Bounds number of times we will retry loading time count */
54
/* This retry is a work around for a silicon bug. */
57
#define IPC_SET_WATCHDOG_TIMER 0xF8
59
static int timer_margin = DEFAULT_SOFT_TO_HARD_MARGIN;
60
module_param(timer_margin, int, 0);
61
MODULE_PARM_DESC(timer_margin,
62
"Watchdog timer margin"
63
"Time between interrupt and resetting the system"
64
"The range is from 1 to 160"
65
"This is the time for all keep alives to arrive");
67
static int timer_set = DEFAULT_TIME;
68
module_param(timer_set, int, 0);
69
MODULE_PARM_DESC(timer_set,
70
"Default Watchdog timer setting"
72
"The range is from 1 to 170"
73
"This is the time for all keep alives to arrive");
75
/* After watchdog device is closed, check force_boot. If:
76
* force_boot == 0, then force boot on next watchdog interrupt after close,
77
* force_boot == 1, then force boot immediately when device is closed.
79
static int force_boot;
80
module_param(force_boot, int, 0);
81
MODULE_PARM_DESC(force_boot,
82
"A value of 1 means that the driver will reboot"
83
"the system immediately if the /dev/watchdog device is closed"
84
"A value of 0 means that when /dev/watchdog device is closed"
85
"the watchdog timer will be refreshed for one more interval"
86
"of length: timer_set. At the end of this interval, the"
87
"watchdog timer will reset the system."
90
/* there is only one device in the system now; this can be made into
91
* an array in the future if we have more than one device */
93
static struct intel_scu_watchdog_dev watchdog_device;
95
/* Forces restart, if force_reboot is set */
96
static void watchdog_fire(void)
99
printk(KERN_CRIT PFX "Initiating system reboot.\n");
101
printk(KERN_CRIT PFX "Reboot didn't ?????\n");
105
printk(KERN_CRIT PFX "Immediate Reboot Disabled\n");
107
"System will reset when watchdog timer times out!\n");
111
static int check_timer_margin(int new_margin)
113
if ((new_margin < MIN_TIME_CYCLE) ||
114
(new_margin > MAX_TIME - timer_set)) {
115
pr_debug("Watchdog timer: value of new_margin %d is out of the range %d to %d\n",
116
new_margin, MIN_TIME_CYCLE, MAX_TIME - timer_set);
125
static int watchdog_set_ipc(int soft_threshold, int threshold)
128
u8 cbuf[16] = { '\0' };
131
ipc_wbuf = (u32 *)&cbuf;
132
ipc_wbuf[0] = soft_threshold;
133
ipc_wbuf[1] = threshold;
135
ipc_ret = intel_scu_ipc_command(
136
IPC_SET_WATCHDOG_TIMER,
144
pr_err("Error setting SCU watchdog timer: %x\n", ipc_ret);
150
* Intel_SCU operations
153
/* timer interrupt handler */
154
static irqreturn_t watchdog_timer_interrupt(int irq, void *dev_id)
157
int_status = ioread32(watchdog_device.timer_interrupt_status_addr);
159
pr_debug("Watchdog timer: irq, int_status: %x\n", int_status);
164
/* has the timer been started? If not, then this is spurious */
165
if (watchdog_device.timer_started == 0) {
166
pr_debug("Watchdog timer: spurious interrupt received\n");
170
/* temporarily disable the timer */
171
iowrite32(0x00000002, watchdog_device.timer_control_addr);
173
/* set the timer to the threshold */
174
iowrite32(watchdog_device.threshold,
175
watchdog_device.timer_load_count_addr);
177
/* allow the timer to run */
178
iowrite32(0x00000003, watchdog_device.timer_control_addr);
183
static int intel_scu_keepalive(void)
186
/* read eoi register - clears interrupt */
187
ioread32(watchdog_device.timer_clear_interrupt_addr);
189
/* temporarily disable the timer */
190
iowrite32(0x00000002, watchdog_device.timer_control_addr);
192
/* set the timer to the soft_threshold */
193
iowrite32(watchdog_device.soft_threshold,
194
watchdog_device.timer_load_count_addr);
196
/* allow the timer to run */
197
iowrite32(0x00000003, watchdog_device.timer_control_addr);
202
static int intel_scu_stop(void)
204
iowrite32(0, watchdog_device.timer_control_addr);
208
static int intel_scu_set_heartbeat(u32 t)
216
watchdog_device.timer_set = t;
217
watchdog_device.threshold =
218
timer_margin * watchdog_device.timer_tbl_ptr->freq_hz;
219
watchdog_device.soft_threshold =
220
(watchdog_device.timer_set - timer_margin)
221
* watchdog_device.timer_tbl_ptr->freq_hz;
223
pr_debug("Watchdog timer: set_heartbeat: timer freq is %d\n",
224
watchdog_device.timer_tbl_ptr->freq_hz);
225
pr_debug("Watchdog timer: set_heartbeat: timer_set is %x (hex)\n",
226
watchdog_device.timer_set);
227
pr_debug("Watchdog timer: set_hearbeat: timer_margin is %x (hex)\n",
229
pr_debug("Watchdog timer: set_heartbeat: threshold is %x (hex)\n",
230
watchdog_device.threshold);
231
pr_debug("Watchdog timer: set_heartbeat: soft_threshold is %x (hex)\n",
232
watchdog_device.soft_threshold);
234
/* Adjust thresholds by FREQ_ADJUSTMENT factor, to make the */
235
/* watchdog timing come out right. */
236
watchdog_device.threshold =
237
watchdog_device.threshold / FREQ_ADJUSTMENT;
238
watchdog_device.soft_threshold =
239
watchdog_device.soft_threshold / FREQ_ADJUSTMENT;
241
/* temporarily disable the timer */
242
iowrite32(0x00000002, watchdog_device.timer_control_addr);
244
/* send the threshold and soft_threshold via IPC to the processor */
245
ipc_ret = watchdog_set_ipc(watchdog_device.soft_threshold,
246
watchdog_device.threshold);
249
/* Make sure the watchdog timer is stopped */
254
/* Soft Threshold set loop. Early versions of silicon did */
255
/* not always set this count correctly. This loop checks */
256
/* the value and retries if it was not set correctly. */
259
soft_value = watchdog_device.soft_threshold & 0xFFFF0000;
262
/* Make sure timer is stopped */
265
if (MAX_RETRY < retry_count++) {
266
/* Unable to set timer value */
267
pr_err("Watchdog timer: Unable to set timer\n");
271
/* set the timer to the soft threshold */
272
iowrite32(watchdog_device.soft_threshold,
273
watchdog_device.timer_load_count_addr);
275
/* read count value before starting timer */
276
hw_pre_value = ioread32(watchdog_device.timer_load_count_addr);
277
hw_pre_value = hw_pre_value & 0xFFFF0000;
279
/* Start the timer */
280
iowrite32(0x00000003, watchdog_device.timer_control_addr);
282
/* read the value the time loaded into its count reg */
283
hw_value = ioread32(watchdog_device.timer_load_count_addr);
284
hw_value = hw_value & 0xFFFF0000;
287
} while (soft_value != hw_value);
289
watchdog_device.timer_started = 1;
295
* /dev/watchdog handling
298
static int intel_scu_open(struct inode *inode, struct file *file)
301
/* Set flag to indicate that watchdog device is open */
302
if (test_and_set_bit(0, &watchdog_device.driver_open))
305
/* Check for reopen of driver. Reopens are not allowed */
306
if (watchdog_device.driver_closed)
309
return nonseekable_open(inode, file);
312
static int intel_scu_release(struct inode *inode, struct file *file)
315
* This watchdog should not be closed, after the timer
316
* is started with the WDIPC_SETTIMEOUT ioctl
317
* If force_boot is set watchdog_fire() will cause an
318
* immediate reset. If force_boot is not set, the watchdog
319
* timer is refreshed for one more interval. At the end
320
* of that interval, the watchdog timer will reset the system.
323
if (!test_and_clear_bit(0, &watchdog_device.driver_open)) {
324
pr_debug("Watchdog timer: intel_scu_release, without open\n");
328
if (!watchdog_device.timer_started) {
329
/* Just close, since timer has not been started */
330
pr_debug("Watchdog timer: closed, without starting timer\n");
335
"Unexpected close of /dev/watchdog!\n");
337
/* Since the timer was started, prevent future reopens */
338
watchdog_device.driver_closed = 1;
340
/* Refresh the timer for one more interval */
341
intel_scu_keepalive();
343
/* Reboot system (if force_boot is set) */
346
/* We should only reach this point if force_boot is not set */
350
static ssize_t intel_scu_write(struct file *file,
356
if (watchdog_device.timer_started)
357
/* Watchdog already started, keep it alive */
358
intel_scu_keepalive();
360
/* Start watchdog with timer value set by init */
361
intel_scu_set_heartbeat(watchdog_device.timer_set);
366
static long intel_scu_ioctl(struct file *file,
370
void __user *argp = (void __user *)arg;
371
u32 __user *p = argp;
375
static const struct watchdog_info ident = {
376
.options = WDIOF_SETTIMEOUT
377
| WDIOF_KEEPALIVEPING,
378
.firmware_version = 0, /* @todo Get from SCU via
379
ipc_get_scu_fw_version()? */
380
.identity = "Intel_SCU IOH Watchdog" /* len < 32 */
384
case WDIOC_GETSUPPORT:
385
return copy_to_user(argp,
387
sizeof(ident)) ? -EFAULT : 0;
388
case WDIOC_GETSTATUS:
389
case WDIOC_GETBOOTSTATUS:
390
return put_user(0, p);
391
case WDIOC_KEEPALIVE:
392
intel_scu_keepalive();
395
case WDIOC_SETTIMEOUT:
396
if (get_user(new_margin, p))
399
if (check_timer_margin(new_margin))
402
if (intel_scu_set_heartbeat(new_margin))
405
case WDIOC_GETTIMEOUT:
406
return put_user(watchdog_device.soft_threshold, p);
414
* Notifier for system down
416
static int intel_scu_notify_sys(struct notifier_block *this,
418
void *another_unused)
420
if (code == SYS_DOWN || code == SYS_HALT)
421
/* Turn off the watchdog timer. */
429
static const struct file_operations intel_scu_fops = {
430
.owner = THIS_MODULE,
432
.write = intel_scu_write,
433
.unlocked_ioctl = intel_scu_ioctl,
434
.open = intel_scu_open,
435
.release = intel_scu_release,
438
static int __init intel_scu_watchdog_init(void)
441
u32 __iomem *tmp_addr;
444
* We don't really need to check this as the SFI timer get will fail
445
* but if we do so we can exit with a clearer reason and no noise.
447
* If it isn't an intel MID device then it doesn't have this watchdog
449
if (!mrst_identify_cpu())
452
/* Check boot parameters to verify that their initial values */
454
/* Check value of timer_set boot parameter */
455
if ((timer_set < MIN_TIME_CYCLE) ||
456
(timer_set > MAX_TIME - MIN_TIME_CYCLE)) {
457
pr_err("Watchdog timer: value of timer_set %x (hex) "
458
"is out of range from %x to %x (hex)\n",
459
timer_set, MIN_TIME_CYCLE, MAX_TIME - MIN_TIME_CYCLE);
463
/* Check value of timer_margin boot parameter */
464
if (check_timer_margin(timer_margin))
467
watchdog_device.timer_tbl_ptr = sfi_get_mtmr(sfi_mtimer_num-1);
469
if (watchdog_device.timer_tbl_ptr == NULL) {
470
pr_debug("Watchdog timer - Intel SCU watchdog: timer is not available\n");
473
/* make sure the timer exists */
474
if (watchdog_device.timer_tbl_ptr->phys_addr == 0) {
475
pr_debug("Watchdog timer - Intel SCU watchdog - timer %d does not have valid physical memory\n",
480
if (watchdog_device.timer_tbl_ptr->irq == 0) {
481
pr_debug("Watchdog timer: timer %d invalid irq\n",
486
tmp_addr = ioremap_nocache(watchdog_device.timer_tbl_ptr->phys_addr,
489
if (tmp_addr == NULL) {
490
pr_debug("Watchdog timer: timer unable to ioremap\n");
494
watchdog_device.timer_load_count_addr = tmp_addr++;
495
watchdog_device.timer_current_value_addr = tmp_addr++;
496
watchdog_device.timer_control_addr = tmp_addr++;
497
watchdog_device.timer_clear_interrupt_addr = tmp_addr++;
498
watchdog_device.timer_interrupt_status_addr = tmp_addr++;
500
/* Set the default time values in device structure */
502
watchdog_device.timer_set = timer_set;
503
watchdog_device.threshold =
504
timer_margin * watchdog_device.timer_tbl_ptr->freq_hz;
505
watchdog_device.soft_threshold =
506
(watchdog_device.timer_set - timer_margin)
507
* watchdog_device.timer_tbl_ptr->freq_hz;
510
watchdog_device.intel_scu_notifier.notifier_call =
511
intel_scu_notify_sys;
513
ret = register_reboot_notifier(&watchdog_device.intel_scu_notifier);
515
pr_err("Watchdog timer: cannot register notifier %d)\n", ret);
516
goto register_reboot_error;
519
watchdog_device.miscdev.minor = WATCHDOG_MINOR;
520
watchdog_device.miscdev.name = "watchdog";
521
watchdog_device.miscdev.fops = &intel_scu_fops;
523
ret = misc_register(&watchdog_device.miscdev);
525
pr_err("Watchdog timer: cannot register miscdev %d err =%d\n",
526
WATCHDOG_MINOR, ret);
527
goto misc_register_error;
530
ret = request_irq((unsigned int)watchdog_device.timer_tbl_ptr->irq,
531
watchdog_timer_interrupt,
532
IRQF_SHARED, "watchdog",
533
&watchdog_device.timer_load_count_addr);
535
pr_err("Watchdog timer: error requesting irq %d\n", ret);
536
goto request_irq_error;
538
/* Make sure timer is disabled before returning */
545
misc_deregister(&watchdog_device.miscdev);
547
unregister_reboot_notifier(&watchdog_device.intel_scu_notifier);
548
register_reboot_error:
550
iounmap(watchdog_device.timer_load_count_addr);
554
static void __exit intel_scu_watchdog_exit(void)
557
misc_deregister(&watchdog_device.miscdev);
558
unregister_reboot_notifier(&watchdog_device.intel_scu_notifier);
559
/* disable the timer */
560
iowrite32(0x00000002, watchdog_device.timer_control_addr);
561
iounmap(watchdog_device.timer_load_count_addr);
564
late_initcall(intel_scu_watchdog_init);
565
module_exit(intel_scu_watchdog_exit);
567
MODULE_AUTHOR("Intel Corporation");
568
MODULE_DESCRIPTION("Intel SCU Watchdog Device Driver");
569
MODULE_LICENSE("GPL");
570
MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
571
MODULE_VERSION(WDT_VER);