Linux 6.9-rc1
[linux-2.6-microblaze.git] / Documentation / watchdog / watchdog-parameters.rst
1 ==========================
2 WatchDog Module Parameters
3 ==========================
4
5 This file provides information on the module parameters of many of
6 the Linux watchdog drivers.  Watchdog driver parameter specs should
7 be listed here unless the driver has its own driver-specific information
8 file.
9
10 See Documentation/admin-guide/kernel-parameters.rst for information on
11 providing kernel parameters for builtin drivers versus loadable
12 modules.
13
14 -------------------------------------------------
15
16 watchdog core:
17     open_timeout:
18         Maximum time, in seconds, for which the watchdog framework will take
19         care of pinging a running hardware watchdog until userspace opens the
20         corresponding /dev/watchdogN device. A value of 0 means an infinite
21         timeout. Setting this to a non-zero value can be useful to ensure that
22         either userspace comes up properly, or the board gets reset and allows
23         fallback logic in the bootloader to try something else.
24
25 -------------------------------------------------
26
27 acquirewdt:
28     wdt_stop:
29         Acquire WDT 'stop' io port (default 0x43)
30     wdt_start:
31         Acquire WDT 'start' io port (default 0x443)
32     nowayout:
33         Watchdog cannot be stopped once started
34         (default=kernel config parameter)
35
36 -------------------------------------------------
37
38 advantechwdt:
39     wdt_stop:
40         Advantech WDT 'stop' io port (default 0x443)
41     wdt_start:
42         Advantech WDT 'start' io port (default 0x443)
43     timeout:
44         Watchdog timeout in seconds. 1<= timeout <=63, default=60.
45     nowayout:
46         Watchdog cannot be stopped once started
47         (default=kernel config parameter)
48
49 -------------------------------------------------
50
51 alim1535_wdt:
52     timeout:
53         Watchdog timeout in seconds. (0 < timeout < 18000, default=60
54     nowayout:
55         Watchdog cannot be stopped once started
56         (default=kernel config parameter)
57
58 -------------------------------------------------
59
60 alim7101_wdt:
61     timeout:
62         Watchdog timeout in seconds. (1<=timeout<=3600, default=30
63     use_gpio:
64         Use the gpio watchdog (required by old cobalt boards).
65         default=0/off/no
66     nowayout:
67         Watchdog cannot be stopped once started
68         (default=kernel config parameter)
69
70 -------------------------------------------------
71
72 ar7_wdt:
73     margin:
74         Watchdog margin in seconds (default=60)
75     nowayout:
76         Disable watchdog shutdown on close
77         (default=kernel config parameter)
78
79 -------------------------------------------------
80
81 armada_37xx_wdt:
82     timeout:
83         Watchdog timeout in seconds. (default=120)
84     nowayout:
85         Disable watchdog shutdown on close
86         (default=kernel config parameter)
87
88 -------------------------------------------------
89
90 at91rm9200_wdt:
91     wdt_time:
92         Watchdog time in seconds. (default=5)
93     nowayout:
94         Watchdog cannot be stopped once started
95         (default=kernel config parameter)
96
97 -------------------------------------------------
98
99 at91sam9_wdt:
100     heartbeat:
101         Watchdog heartbeats in seconds. (default = 15)
102     nowayout:
103         Watchdog cannot be stopped once started
104         (default=kernel config parameter)
105
106 -------------------------------------------------
107
108 bcm47xx_wdt:
109     wdt_time:
110         Watchdog time in seconds. (default=30)
111     nowayout:
112         Watchdog cannot be stopped once started
113         (default=kernel config parameter)
114
115 -------------------------------------------------
116
117 coh901327_wdt:
118     margin:
119         Watchdog margin in seconds (default 60s)
120
121 -------------------------------------------------
122
123 cpu5wdt:
124     port:
125         base address of watchdog card, default is 0x91
126     verbose:
127         be verbose, default is 0 (no)
128     ticks:
129         count down ticks, default is 10000
130
131 -------------------------------------------------
132
133 cpwd:
134     wd0_timeout:
135         Default watchdog0 timeout in 1/10secs
136     wd1_timeout:
137         Default watchdog1 timeout in 1/10secs
138     wd2_timeout:
139         Default watchdog2 timeout in 1/10secs
140
141 -------------------------------------------------
142
143 da9052wdt:
144     timeout:
145         Watchdog timeout in seconds. 2<= timeout <=131, default=2.048s
146     nowayout:
147         Watchdog cannot be stopped once started
148         (default=kernel config parameter)
149
150 -------------------------------------------------
151
152 davinci_wdt:
153     heartbeat:
154         Watchdog heartbeat period in seconds from 1 to 600, default 60
155
156 -------------------------------------------------
157
158 ebc-c384_wdt:
159     timeout:
160         Watchdog timeout in seconds. (1<=timeout<=15300, default=60)
161     nowayout:
162         Watchdog cannot be stopped once started
163
164 -------------------------------------------------
165
166 ep93xx_wdt:
167     nowayout:
168         Watchdog cannot be stopped once started
169     timeout:
170         Watchdog timeout in seconds. (1<=timeout<=3600, default=TBD)
171
172 -------------------------------------------------
173
174 eurotechwdt:
175     nowayout:
176         Watchdog cannot be stopped once started
177         (default=kernel config parameter)
178     io:
179         Eurotech WDT io port (default=0x3f0)
180     irq:
181         Eurotech WDT irq (default=10)
182     ev:
183         Eurotech WDT event type (default is `int`)
184
185 -------------------------------------------------
186
187 gef_wdt:
188     nowayout:
189         Watchdog cannot be stopped once started
190         (default=kernel config parameter)
191
192 -------------------------------------------------
193
194 geodewdt:
195     timeout:
196         Watchdog timeout in seconds. 1<= timeout <=131, default=60.
197     nowayout:
198         Watchdog cannot be stopped once started
199         (default=kernel config parameter)
200
201 -------------------------------------------------
202
203 i6300esb:
204     heartbeat:
205         Watchdog heartbeat in seconds. (1<heartbeat<2046, default=30)
206     nowayout:
207         Watchdog cannot be stopped once started
208         (default=kernel config parameter)
209
210 -------------------------------------------------
211
212 iTCO_wdt:
213     heartbeat:
214         Watchdog heartbeat in seconds.
215         (2<heartbeat<39 (TCO v1) or 613 (TCO v2), default=30)
216     nowayout:
217         Watchdog cannot be stopped once started
218         (default=kernel config parameter)
219
220 -------------------------------------------------
221
222 iTCO_vendor_support:
223     vendorsupport:
224         iTCO vendor specific support mode, default=0 (none),
225         1=SuperMicro Pent3, 2=SuperMicro Pent4+, 911=Broken SMI BIOS
226
227 -------------------------------------------------
228
229 ib700wdt:
230     timeout:
231         Watchdog timeout in seconds. 0<= timeout <=30, default=30.
232     nowayout:
233         Watchdog cannot be stopped once started
234         (default=kernel config parameter)
235
236 -------------------------------------------------
237
238 ibmasr:
239     nowayout:
240         Watchdog cannot be stopped once started
241         (default=kernel config parameter)
242
243 -------------------------------------------------
244
245 imx2_wdt:
246     timeout:
247         Watchdog timeout in seconds (default 60 s)
248     nowayout:
249         Watchdog cannot be stopped once started
250         (default=kernel config parameter)
251
252 -------------------------------------------------
253
254 indydog:
255     nowayout:
256         Watchdog cannot be stopped once started
257         (default=kernel config parameter)
258
259 -------------------------------------------------
260
261 iop_wdt:
262     nowayout:
263         Watchdog cannot be stopped once started
264         (default=kernel config parameter)
265
266 -------------------------------------------------
267
268 it8712f_wdt:
269     margin:
270         Watchdog margin in seconds (default 60)
271     nowayout:
272         Disable watchdog shutdown on close
273         (default=kernel config parameter)
274
275 -------------------------------------------------
276
277 it87_wdt:
278     nogameport:
279         Forbid the activation of game port, default=0
280     nocir:
281         Forbid the use of CIR (workaround for some buggy setups); set to 1 if
282 system resets despite watchdog daemon running, default=0
283     exclusive:
284         Watchdog exclusive device open, default=1
285     timeout:
286         Watchdog timeout in seconds, default=60
287     testmode:
288         Watchdog test mode (1 = no reboot), default=0
289     nowayout:
290         Watchdog cannot be stopped once started
291         (default=kernel config parameter)
292
293 -------------------------------------------------
294
295 ixp4xx_wdt:
296     heartbeat:
297         Watchdog heartbeat in seconds (default 60s)
298     nowayout:
299         Watchdog cannot be stopped once started
300         (default=kernel config parameter)
301
302 -------------------------------------------------
303
304 machzwd:
305     nowayout:
306         Watchdog cannot be stopped once started
307         (default=kernel config parameter)
308     action:
309         after watchdog resets, generate:
310         0 = RESET(*)  1 = SMI  2 = NMI  3 = SCI
311
312 -------------------------------------------------
313
314 max63xx_wdt:
315     heartbeat:
316         Watchdog heartbeat period in seconds from 1 to 60, default 60
317     nowayout:
318         Watchdog cannot be stopped once started
319         (default=kernel config parameter)
320     nodelay:
321         Force selection of a timeout setting without initial delay
322         (max6373/74 only, default=0)
323
324 -------------------------------------------------
325
326 mixcomwd:
327     nowayout:
328         Watchdog cannot be stopped once started
329         (default=kernel config parameter)
330
331 -------------------------------------------------
332
333 mpc8xxx_wdt:
334     timeout:
335         Watchdog timeout in ticks. (0<timeout<65536, default=65535)
336     reset:
337         Watchdog Interrupt/Reset Mode. 0 = interrupt, 1 = reset
338     nowayout:
339         Watchdog cannot be stopped once started
340         (default=kernel config parameter)
341
342 -------------------------------------------------
343
344 mv64x60_wdt:
345     nowayout:
346         Watchdog cannot be stopped once started
347         (default=kernel config parameter)
348
349 -------------------------------------------------
350
351 ni903x_wdt:
352     timeout:
353         Initial watchdog timeout in seconds (0<timeout<516, default=60)
354     nowayout:
355         Watchdog cannot be stopped once started
356         (default=kernel config parameter)
357
358 -------------------------------------------------
359
360 nic7018_wdt:
361     timeout:
362         Initial watchdog timeout in seconds (0<timeout<464, default=80)
363     nowayout:
364         Watchdog cannot be stopped once started
365         (default=kernel config parameter)
366
367 -------------------------------------------------
368
369 omap_wdt:
370     timer_margin:
371         initial watchdog timeout (in seconds)
372     early_enable:
373         Watchdog is started on module insertion (default=0
374     nowayout:
375         Watchdog cannot be stopped once started
376         (default=kernel config parameter)
377
378 -------------------------------------------------
379
380 orion_wdt:
381     heartbeat:
382         Initial watchdog heartbeat in seconds
383     nowayout:
384         Watchdog cannot be stopped once started
385         (default=kernel config parameter)
386
387 -------------------------------------------------
388
389 pc87413_wdt:
390     io:
391         pc87413 WDT I/O port (default: io).
392     timeout:
393         Watchdog timeout in minutes (default=timeout).
394     nowayout:
395         Watchdog cannot be stopped once started
396         (default=kernel config parameter)
397
398 -------------------------------------------------
399
400 pika_wdt:
401     heartbeat:
402         Watchdog heartbeats in seconds. (default = 15)
403     nowayout:
404         Watchdog cannot be stopped once started
405         (default=kernel config parameter)
406
407 -------------------------------------------------
408
409 pnx4008_wdt:
410     heartbeat:
411         Watchdog heartbeat period in seconds from 1 to 60, default 19
412     nowayout:
413         Set to 1 to keep watchdog running after device release
414
415 -------------------------------------------------
416
417 pnx833x_wdt:
418     timeout:
419         Watchdog timeout in Mhz. (68Mhz clock), default=2040000000 (30 seconds)
420     nowayout:
421         Watchdog cannot be stopped once started
422         (default=kernel config parameter)
423     start_enabled:
424         Watchdog is started on module insertion (default=1)
425
426 -------------------------------------------------
427
428 pseries-wdt:
429     action:
430         Action taken when watchdog expires: 0 (power off), 1 (restart),
431         2 (dump and restart). (default=1)
432     timeout:
433         Initial watchdog timeout in seconds. (default=60)
434     nowayout:
435         Watchdog cannot be stopped once started.
436         (default=kernel config parameter)
437
438 -------------------------------------------------
439
440 rc32434_wdt:
441     timeout:
442         Watchdog timeout value, in seconds (default=20)
443     nowayout:
444         Watchdog cannot be stopped once started
445         (default=kernel config parameter)
446
447 -------------------------------------------------
448
449 riowd:
450     riowd_timeout:
451         Watchdog timeout in minutes (default=1)
452
453 -------------------------------------------------
454
455 s3c2410_wdt:
456     tmr_margin:
457         Watchdog tmr_margin in seconds. (default=15)
458     tmr_atboot:
459         Watchdog is started at boot time if set to 1, default=0
460     nowayout:
461         Watchdog cannot be stopped once started
462         (default=kernel config parameter)
463     soft_noboot:
464         Watchdog action, set to 1 to ignore reboots, 0 to reboot
465     debug:
466         Watchdog debug, set to >1 for debug, (default 0)
467
468 -------------------------------------------------
469
470 sa1100_wdt:
471     margin:
472         Watchdog margin in seconds (default 60s)
473
474 -------------------------------------------------
475
476 sb_wdog:
477     timeout:
478         Watchdog timeout in microseconds (max/default 8388607 or 8.3ish secs)
479
480 -------------------------------------------------
481
482 sbc60xxwdt:
483     wdt_stop:
484         SBC60xx WDT 'stop' io port (default 0x45)
485     wdt_start:
486         SBC60xx WDT 'start' io port (default 0x443)
487     timeout:
488         Watchdog timeout in seconds. (1<=timeout<=3600, default=30)
489     nowayout:
490         Watchdog cannot be stopped once started
491         (default=kernel config parameter)
492
493 -------------------------------------------------
494
495 sbc7240_wdt:
496     timeout:
497         Watchdog timeout in seconds. (1<=timeout<=255, default=30)
498     nowayout:
499         Disable watchdog when closing device file
500
501 -------------------------------------------------
502
503 sbc8360:
504     timeout:
505         Index into timeout table (0-63) (default=27 (60s))
506     nowayout:
507         Watchdog cannot be stopped once started
508         (default=kernel config parameter)
509
510 -------------------------------------------------
511
512 sbc_epx_c3:
513     nowayout:
514         Watchdog cannot be stopped once started
515         (default=kernel config parameter)
516
517 -------------------------------------------------
518
519 sbc_fitpc2_wdt:
520     margin:
521         Watchdog margin in seconds (default 60s)
522     nowayout:
523         Watchdog cannot be stopped once started
524
525 -------------------------------------------------
526
527 sbsa_gwdt:
528     timeout:
529         Watchdog timeout in seconds. (default 10s)
530     action:
531         Watchdog action at the first stage timeout,
532         set to 0 to ignore, 1 to panic. (default=0)
533     nowayout:
534         Watchdog cannot be stopped once started
535         (default=kernel config parameter)
536
537 -------------------------------------------------
538
539 sc1200wdt:
540     isapnp:
541         When set to 0 driver ISA PnP support will be disabled (default=1)
542     io:
543         io port
544     timeout:
545         range is 0-255 minutes, default is 1
546     nowayout:
547         Watchdog cannot be stopped once started
548         (default=kernel config parameter)
549
550 -------------------------------------------------
551
552 sc520_wdt:
553     timeout:
554         Watchdog timeout in seconds. (1 <= timeout <= 3600, default=30)
555     nowayout:
556         Watchdog cannot be stopped once started
557         (default=kernel config parameter)
558
559 -------------------------------------------------
560
561 sch311x_wdt:
562     force_id:
563         Override the detected device ID
564     therm_trip:
565         Should a ThermTrip trigger the reset generator
566     timeout:
567         Watchdog timeout in seconds. 1<= timeout <=15300, default=60
568     nowayout:
569         Watchdog cannot be stopped once started
570         (default=kernel config parameter)
571
572 -------------------------------------------------
573
574 scx200_wdt:
575     margin:
576         Watchdog margin in seconds
577     nowayout:
578         Disable watchdog shutdown on close
579
580 -------------------------------------------------
581
582 shwdt:
583     clock_division_ratio:
584         Clock division ratio. Valid ranges are from 0x5 (1.31ms)
585         to 0x7 (5.25ms). (default=7)
586     heartbeat:
587         Watchdog heartbeat in seconds. (1 <= heartbeat <= 3600, default=30
588     nowayout:
589         Watchdog cannot be stopped once started
590         (default=kernel config parameter)
591
592 -------------------------------------------------
593
594 smsc37b787_wdt:
595     timeout:
596         range is 1-255 units, default is 60
597     nowayout:
598         Watchdog cannot be stopped once started
599         (default=kernel config parameter)
600
601 -------------------------------------------------
602
603 softdog:
604     soft_margin:
605         Watchdog soft_margin in seconds.
606         (0 < soft_margin < 65536, default=60)
607     nowayout:
608         Watchdog cannot be stopped once started
609         (default=kernel config parameter)
610     soft_noboot:
611         Softdog action, set to 1 to ignore reboots, 0 to reboot
612         (default=0)
613
614 -------------------------------------------------
615
616 stmp3xxx_wdt:
617     heartbeat:
618         Watchdog heartbeat period in seconds from 1 to 4194304, default 19
619
620 -------------------------------------------------
621
622 tegra_wdt:
623     heartbeat:
624         Watchdog heartbeats in seconds. (default = 120)
625     nowayout:
626         Watchdog cannot be stopped once started
627         (default=kernel config parameter)
628
629 -------------------------------------------------
630
631 ts72xx_wdt:
632     timeout:
633         Watchdog timeout in seconds. (1 <= timeout <= 8, default=8)
634     nowayout:
635         Disable watchdog shutdown on close
636
637 -------------------------------------------------
638
639 twl4030_wdt:
640     nowayout:
641         Watchdog cannot be stopped once started
642         (default=kernel config parameter)
643
644 -------------------------------------------------
645
646 txx9wdt:
647     timeout:
648         Watchdog timeout in seconds. (0<timeout<N, default=60)
649     nowayout:
650         Watchdog cannot be stopped once started
651         (default=kernel config parameter)
652
653 -------------------------------------------------
654
655 uniphier_wdt:
656     timeout:
657         Watchdog timeout in power of two seconds.
658         (1 <= timeout <= 128, default=64)
659     nowayout:
660         Watchdog cannot be stopped once started
661         (default=kernel config parameter)
662
663 -------------------------------------------------
664
665 w83627hf_wdt:
666     wdt_io:
667         w83627hf/thf WDT io port (default 0x2E)
668     timeout:
669         Watchdog timeout in seconds. 1 <= timeout <= 255, default=60.
670     nowayout:
671         Watchdog cannot be stopped once started
672         (default=kernel config parameter)
673
674 -------------------------------------------------
675
676 w83877f_wdt:
677     timeout:
678         Watchdog timeout in seconds. (1<=timeout<=3600, default=30)
679     nowayout:
680         Watchdog cannot be stopped once started
681         (default=kernel config parameter)
682
683 -------------------------------------------------
684
685 w83977f_wdt:
686     timeout:
687         Watchdog timeout in seconds (15..7635), default=45)
688     testmode:
689         Watchdog testmode (1 = no reboot), default=0
690     nowayout:
691         Watchdog cannot be stopped once started
692         (default=kernel config parameter)
693
694 -------------------------------------------------
695
696 wafer5823wdt:
697     timeout:
698         Watchdog timeout in seconds. 1 <= timeout <= 255, default=60.
699     nowayout:
700         Watchdog cannot be stopped once started
701         (default=kernel config parameter)
702
703 -------------------------------------------------
704
705 wdt285:
706     soft_margin:
707         Watchdog timeout in seconds (default=60)
708
709 -------------------------------------------------
710
711 wdt977:
712     timeout:
713         Watchdog timeout in seconds (60..15300, default=60)
714     testmode:
715         Watchdog testmode (1 = no reboot), default=0
716     nowayout:
717         Watchdog cannot be stopped once started
718         (default=kernel config parameter)
719
720 -------------------------------------------------
721
722 wm831x_wdt:
723     nowayout:
724         Watchdog cannot be stopped once started
725         (default=kernel config parameter)
726
727 -------------------------------------------------
728
729 wm8350_wdt:
730     nowayout:
731         Watchdog cannot be stopped once started
732         (default=kernel config parameter)
733
734 -------------------------------------------------
735
736 sun4v_wdt:
737     timeout_ms:
738         Watchdog timeout in milliseconds 1..180000, default=60000)
739     nowayout:
740         Watchdog cannot be stopped once started