1 // SPDX-License-Identifier: GPL-2.0+
3 * intel TCO Watchdog Driver
5 * (c) Copyright 2006-2011 Wim Van Sebroeck <wim@iguana.be>.
7 * Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
8 * provide warranty for any of this software. This material is
9 * provided "AS-IS" and at no charge.
11 * The TCO watchdog is implemented in the following I/O controller hubs:
12 * (See the intel documentation on http://developer.intel.com.)
13 * document number 290655-003, 290677-014: 82801AA (ICH), 82801AB (ICHO)
14 * document number 290687-002, 298242-027: 82801BA (ICH2)
15 * document number 290733-003, 290739-013: 82801CA (ICH3-S)
16 * document number 290716-001, 290718-007: 82801CAM (ICH3-M)
17 * document number 290744-001, 290745-025: 82801DB (ICH4)
18 * document number 252337-001, 252663-008: 82801DBM (ICH4-M)
19 * document number 273599-001, 273645-002: 82801E (C-ICH)
20 * document number 252516-001, 252517-028: 82801EB (ICH5), 82801ER (ICH5R)
21 * document number 300641-004, 300884-013: 6300ESB
22 * document number 301473-002, 301474-026: 82801F (ICH6)
23 * document number 313082-001, 313075-006: 631xESB, 632xESB
24 * document number 307013-003, 307014-024: 82801G (ICH7)
25 * document number 322896-001, 322897-001: NM10
26 * document number 313056-003, 313057-017: 82801H (ICH8)
27 * document number 316972-004, 316973-012: 82801I (ICH9)
28 * document number 319973-002, 319974-002: 82801J (ICH10)
29 * document number 322169-001, 322170-003: 5 Series, 3400 Series (PCH)
30 * document number 320066-003, 320257-008: EP80597 (IICH)
31 * document number 324645-001, 324646-001: Cougar Point (CPT)
32 * document number TBD : Patsburg (PBG)
33 * document number TBD : DH89xxCC
34 * document number TBD : Panther Point
35 * document number TBD : Lynx Point
36 * document number TBD : Lynx Point-LP
40 * Includes, defines, variables, module parameters, ...
43 /* Module and version information */
44 #define DRV_NAME "iTCO_wdt"
45 #define DRV_VERSION "1.11"
48 #include <linux/acpi.h> /* For ACPI support */
49 #include <linux/bits.h> /* For BIT() */
50 #include <linux/module.h> /* For module specific items */
51 #include <linux/moduleparam.h> /* For new moduleparam's */
52 #include <linux/types.h> /* For standard types (like size_t) */
53 #include <linux/errno.h> /* For the -ENODEV/... values */
54 #include <linux/kernel.h> /* For printk/panic/... */
55 #include <linux/watchdog.h> /* For the watchdog specific items */
56 #include <linux/init.h> /* For __init/__exit/... */
57 #include <linux/fs.h> /* For file operations */
58 #include <linux/platform_device.h> /* For platform_driver framework */
59 #include <linux/pci.h> /* For pci functions */
60 #include <linux/ioport.h> /* For io-port access */
61 #include <linux/spinlock.h> /* For spin_lock/spin_unlock/... */
62 #include <linux/uaccess.h> /* For copy_to_user/put_user/... */
63 #include <linux/io.h> /* For inb/outb/... */
64 #include <linux/platform_data/itco_wdt.h>
65 #include <linux/mfd/intel_pmc_bxt.h>
67 #include "iTCO_vendor.h"
69 /* Address definitions for the TCO */
70 /* TCO base address */
71 #define TCOBASE(p) ((p)->tco_res->start)
72 /* SMI Control and Enable Register */
73 #define SMI_EN(p) ((p)->smi_res->start)
75 #define TCO_RLD(p) (TCOBASE(p) + 0x00) /* TCO Timer Reload/Curr. Value */
76 #define TCOv1_TMR(p) (TCOBASE(p) + 0x01) /* TCOv1 Timer Initial Value*/
77 #define TCO_DAT_IN(p) (TCOBASE(p) + 0x02) /* TCO Data In Register */
78 #define TCO_DAT_OUT(p) (TCOBASE(p) + 0x03) /* TCO Data Out Register */
79 #define TCO1_STS(p) (TCOBASE(p) + 0x04) /* TCO1 Status Register */
80 #define TCO2_STS(p) (TCOBASE(p) + 0x06) /* TCO2 Status Register */
81 #define TCO1_CNT(p) (TCOBASE(p) + 0x08) /* TCO1 Control Register */
82 #define TCO2_CNT(p) (TCOBASE(p) + 0x0a) /* TCO2 Control Register */
83 #define TCOv2_TMR(p) (TCOBASE(p) + 0x12) /* TCOv2 Timer Initial Value*/
86 * NMI_NOW is bit 8 of TCO1_CNT register
88 * This bit is implemented as RW but has no effect on HW.
90 #define NMI_NOW BIT(8)
92 /* internal variables */
93 struct iTCO_wdt_private
{
94 struct watchdog_device wddev
;
96 /* TCO version/generation */
97 unsigned int iTCO_version
;
98 struct resource
*tco_res
;
99 struct resource
*smi_res
;
101 * NO_REBOOT flag is Memory-Mapped GCS register bit 5 (TCO version 2),
102 * or memory-mapped PMC register bit 4 (TCO version 3).
104 unsigned long __iomem
*gcs_pmc
;
105 /* the lock for io operations */
108 struct pci_dev
*pci_dev
;
109 /* whether or not the watchdog has been suspended */
111 /* no reboot API private data */
112 void *no_reboot_priv
;
113 /* no reboot update function pointer */
114 int (*update_no_reboot_bit
)(void *p
, bool set
);
117 /* module parameters */
118 #define WATCHDOG_TIMEOUT 30 /* 30 sec default heartbeat */
119 static int heartbeat
= WATCHDOG_TIMEOUT
; /* in seconds */
120 module_param(heartbeat
, int, 0);
121 MODULE_PARM_DESC(heartbeat
, "Watchdog timeout in seconds. "
122 "5..76 (TCO v1) or 3..614 (TCO v2), default="
123 __MODULE_STRING(WATCHDOG_TIMEOUT
) ")");
125 static bool nowayout
= WATCHDOG_NOWAYOUT
;
126 module_param(nowayout
, bool, 0);
127 MODULE_PARM_DESC(nowayout
,
128 "Watchdog cannot be stopped once started (default="
129 __MODULE_STRING(WATCHDOG_NOWAYOUT
) ")");
131 static int turn_SMI_watchdog_clear_off
= 1;
132 module_param(turn_SMI_watchdog_clear_off
, int, 0);
133 MODULE_PARM_DESC(turn_SMI_watchdog_clear_off
,
134 "Turn off SMI clearing watchdog (depends on TCO-version)(default=1)");
137 * Some TCO specific functions
141 * The iTCO v1 and v2's internal timer is stored as ticks which decrement
142 * every 0.6 seconds. v3's internal timer is stored as seconds (some
143 * datasheets incorrectly state 0.6 seconds).
145 static inline unsigned int seconds_to_ticks(struct iTCO_wdt_private
*p
,
148 return p
->iTCO_version
== 3 ? secs
: (secs
* 10) / 6;
151 static inline unsigned int ticks_to_seconds(struct iTCO_wdt_private
*p
,
154 return p
->iTCO_version
== 3 ? ticks
: (ticks
* 6) / 10;
157 static inline u32
no_reboot_bit(struct iTCO_wdt_private
*p
)
161 switch (p
->iTCO_version
) {
164 enable_bit
= 0x00000010;
167 enable_bit
= 0x00000020;
172 enable_bit
= 0x00000002;
179 static int update_no_reboot_bit_def(void *priv
, bool set
)
184 static int update_no_reboot_bit_pci(void *priv
, bool set
)
186 struct iTCO_wdt_private
*p
= priv
;
187 u32 val32
= 0, newval32
= 0;
189 pci_read_config_dword(p
->pci_dev
, 0xd4, &val32
);
191 val32
|= no_reboot_bit(p
);
193 val32
&= ~no_reboot_bit(p
);
194 pci_write_config_dword(p
->pci_dev
, 0xd4, val32
);
195 pci_read_config_dword(p
->pci_dev
, 0xd4, &newval32
);
197 /* make sure the update is successful */
198 if (val32
!= newval32
)
204 static int update_no_reboot_bit_mem(void *priv
, bool set
)
206 struct iTCO_wdt_private
*p
= priv
;
207 u32 val32
= 0, newval32
= 0;
209 val32
= readl(p
->gcs_pmc
);
211 val32
|= no_reboot_bit(p
);
213 val32
&= ~no_reboot_bit(p
);
214 writel(val32
, p
->gcs_pmc
);
215 newval32
= readl(p
->gcs_pmc
);
217 /* make sure the update is successful */
218 if (val32
!= newval32
)
224 static int update_no_reboot_bit_cnt(void *priv
, bool set
)
226 struct iTCO_wdt_private
*p
= priv
;
230 * writing back 1b1 to NMI_NOW of TCO1_CNT register
231 * causes NMI_NOW bit inversion what consequently does
232 * not allow to perform the register's value comparison
235 * NMI_NOW bit masking for TCO1_CNT register values
236 * helps to avoid possible NMI_NOW bit inversions on
237 * following write operation.
239 val
= inw(TCO1_CNT(p
)) & ~NMI_NOW
;
244 outw(val
, TCO1_CNT(p
));
245 newval
= inw(TCO1_CNT(p
)) & ~NMI_NOW
;
247 /* make sure the update is successful */
248 return val
!= newval
? -EIO
: 0;
251 static int update_no_reboot_bit_pmc(void *priv
, bool set
)
253 struct intel_pmc_dev
*pmc
= priv
;
254 u32 bits
= PMC_CFG_NO_REBOOT_EN
;
255 u32 value
= set
? bits
: 0;
257 return intel_pmc_gcr_update(pmc
, PMC_GCR_PMC_CFG_REG
, bits
, value
);
260 static void iTCO_wdt_no_reboot_bit_setup(struct iTCO_wdt_private
*p
,
261 struct platform_device
*pdev
,
262 struct itco_wdt_platform_data
*pdata
)
264 if (pdata
->no_reboot_use_pmc
) {
265 struct intel_pmc_dev
*pmc
= dev_get_drvdata(pdev
->dev
.parent
);
267 p
->update_no_reboot_bit
= update_no_reboot_bit_pmc
;
268 p
->no_reboot_priv
= pmc
;
272 if (p
->iTCO_version
>= 6)
273 p
->update_no_reboot_bit
= update_no_reboot_bit_cnt
;
274 else if (p
->iTCO_version
>= 2)
275 p
->update_no_reboot_bit
= update_no_reboot_bit_mem
;
276 else if (p
->iTCO_version
== 1)
277 p
->update_no_reboot_bit
= update_no_reboot_bit_pci
;
279 p
->update_no_reboot_bit
= update_no_reboot_bit_def
;
281 p
->no_reboot_priv
= p
;
284 static int iTCO_wdt_start(struct watchdog_device
*wd_dev
)
286 struct iTCO_wdt_private
*p
= watchdog_get_drvdata(wd_dev
);
289 spin_lock(&p
->io_lock
);
291 iTCO_vendor_pre_start(p
->smi_res
, wd_dev
->timeout
);
293 /* disable chipset's NO_REBOOT bit */
294 if (p
->update_no_reboot_bit(p
->no_reboot_priv
, false)) {
295 spin_unlock(&p
->io_lock
);
296 dev_err(wd_dev
->parent
, "failed to reset NO_REBOOT flag, reboot disabled by hardware/BIOS\n");
300 /* Force the timer to its reload value by writing to the TCO_RLD
302 if (p
->iTCO_version
>= 2)
303 outw(0x01, TCO_RLD(p
));
304 else if (p
->iTCO_version
== 1)
305 outb(0x01, TCO_RLD(p
));
307 /* Bit 11: TCO Timer Halt -> 0 = The TCO timer is enabled to count */
308 val
= inw(TCO1_CNT(p
));
310 outw(val
, TCO1_CNT(p
));
311 val
= inw(TCO1_CNT(p
));
312 spin_unlock(&p
->io_lock
);
319 static int iTCO_wdt_stop(struct watchdog_device
*wd_dev
)
321 struct iTCO_wdt_private
*p
= watchdog_get_drvdata(wd_dev
);
324 spin_lock(&p
->io_lock
);
326 iTCO_vendor_pre_stop(p
->smi_res
);
328 /* Bit 11: TCO Timer Halt -> 1 = The TCO timer is disabled */
329 val
= inw(TCO1_CNT(p
));
331 outw(val
, TCO1_CNT(p
));
332 val
= inw(TCO1_CNT(p
));
334 /* Set the NO_REBOOT bit to prevent later reboots, just for sure */
335 p
->update_no_reboot_bit(p
->no_reboot_priv
, true);
337 spin_unlock(&p
->io_lock
);
339 if ((val
& 0x0800) == 0)
344 static int iTCO_wdt_ping(struct watchdog_device
*wd_dev
)
346 struct iTCO_wdt_private
*p
= watchdog_get_drvdata(wd_dev
);
348 spin_lock(&p
->io_lock
);
350 /* Reload the timer by writing to the TCO Timer Counter register */
351 if (p
->iTCO_version
>= 2) {
352 outw(0x01, TCO_RLD(p
));
353 } else if (p
->iTCO_version
== 1) {
354 /* Reset the timeout status bit so that the timer
355 * needs to count down twice again before rebooting */
356 outw(0x0008, TCO1_STS(p
)); /* write 1 to clear bit */
358 outb(0x01, TCO_RLD(p
));
361 spin_unlock(&p
->io_lock
);
365 static int iTCO_wdt_set_timeout(struct watchdog_device
*wd_dev
, unsigned int t
)
367 struct iTCO_wdt_private
*p
= watchdog_get_drvdata(wd_dev
);
372 tmrval
= seconds_to_ticks(p
, t
);
374 /* For TCO v1 the timer counts down twice before rebooting */
375 if (p
->iTCO_version
== 1)
378 /* from the specs: */
379 /* "Values of 0h-3h are ignored and should not be attempted" */
382 if ((p
->iTCO_version
>= 2 && tmrval
> 0x3ff) ||
383 (p
->iTCO_version
== 1 && tmrval
> 0x03f))
386 /* Write new heartbeat to watchdog */
387 if (p
->iTCO_version
>= 2) {
388 spin_lock(&p
->io_lock
);
389 val16
= inw(TCOv2_TMR(p
));
392 outw(val16
, TCOv2_TMR(p
));
393 val16
= inw(TCOv2_TMR(p
));
394 spin_unlock(&p
->io_lock
);
396 if ((val16
& 0x3ff) != tmrval
)
398 } else if (p
->iTCO_version
== 1) {
399 spin_lock(&p
->io_lock
);
400 val8
= inb(TCOv1_TMR(p
));
402 val8
|= (tmrval
& 0xff);
403 outb(val8
, TCOv1_TMR(p
));
404 val8
= inb(TCOv1_TMR(p
));
405 spin_unlock(&p
->io_lock
);
407 if ((val8
& 0x3f) != tmrval
)
415 static unsigned int iTCO_wdt_get_timeleft(struct watchdog_device
*wd_dev
)
417 struct iTCO_wdt_private
*p
= watchdog_get_drvdata(wd_dev
);
420 unsigned int time_left
= 0;
422 /* read the TCO Timer */
423 if (p
->iTCO_version
>= 2) {
424 spin_lock(&p
->io_lock
);
425 val16
= inw(TCO_RLD(p
));
427 spin_unlock(&p
->io_lock
);
429 time_left
= ticks_to_seconds(p
, val16
);
430 } else if (p
->iTCO_version
== 1) {
431 spin_lock(&p
->io_lock
);
432 val8
= inb(TCO_RLD(p
));
434 if (!(inw(TCO1_STS(p
)) & 0x0008))
435 val8
+= (inb(TCOv1_TMR(p
)) & 0x3f);
436 spin_unlock(&p
->io_lock
);
438 time_left
= ticks_to_seconds(p
, val8
);
443 /* Returns true if the watchdog was running */
444 static bool iTCO_wdt_set_running(struct iTCO_wdt_private
*p
)
448 /* Bit 11: TCO Timer Halt -> 0 = The TCO timer is enabled */
449 val
= inw(TCO1_CNT(p
));
450 if (!(val
& BIT(11))) {
451 set_bit(WDOG_HW_RUNNING
, &p
->wddev
.status
);
461 static struct watchdog_info ident
= {
462 .options
= WDIOF_SETTIMEOUT
|
463 WDIOF_KEEPALIVEPING
|
465 .identity
= DRV_NAME
,
468 static const struct watchdog_ops iTCO_wdt_ops
= {
469 .owner
= THIS_MODULE
,
470 .start
= iTCO_wdt_start
,
471 .stop
= iTCO_wdt_stop
,
472 .ping
= iTCO_wdt_ping
,
473 .set_timeout
= iTCO_wdt_set_timeout
,
474 .get_timeleft
= iTCO_wdt_get_timeleft
,
478 * Init & exit routines
481 static int iTCO_wdt_probe(struct platform_device
*pdev
)
483 struct device
*dev
= &pdev
->dev
;
484 struct itco_wdt_platform_data
*pdata
= dev_get_platdata(dev
);
485 struct iTCO_wdt_private
*p
;
492 p
= devm_kzalloc(dev
, sizeof(*p
), GFP_KERNEL
);
496 spin_lock_init(&p
->io_lock
);
498 p
->tco_res
= platform_get_resource(pdev
, IORESOURCE_IO
, ICH_RES_IO_TCO
);
502 p
->iTCO_version
= pdata
->version
;
503 p
->pci_dev
= to_pci_dev(dev
->parent
);
505 p
->smi_res
= platform_get_resource(pdev
, IORESOURCE_IO
, ICH_RES_IO_SMI
);
507 /* The TCO logic uses the TCO_EN bit in the SMI_EN register */
508 if (!devm_request_region(dev
, p
->smi_res
->start
,
509 resource_size(p
->smi_res
),
511 dev_err(dev
, "I/O address 0x%04llx already in use, device disabled\n",
515 } else if (iTCO_vendorsupport
||
516 turn_SMI_watchdog_clear_off
>= p
->iTCO_version
) {
517 dev_err(dev
, "SMI I/O resource is missing\n");
521 iTCO_wdt_no_reboot_bit_setup(p
, pdev
, pdata
);
524 * Get the Memory-Mapped GCS or PMC register, we need it for the
525 * NO_REBOOT flag (TCO v2 and v3).
527 if (p
->iTCO_version
>= 2 && p
->iTCO_version
< 6 &&
528 !pdata
->no_reboot_use_pmc
) {
529 p
->gcs_pmc
= devm_platform_ioremap_resource(pdev
, ICH_RES_MEM_GCS_PMC
);
530 if (IS_ERR(p
->gcs_pmc
))
531 return PTR_ERR(p
->gcs_pmc
);
534 /* Check chipset's NO_REBOOT bit */
535 if (p
->update_no_reboot_bit(p
->no_reboot_priv
, false) &&
536 iTCO_vendor_check_noreboot_on()) {
537 dev_info(dev
, "unable to reset NO_REBOOT flag, device disabled by hardware/BIOS\n");
538 return -ENODEV
; /* Cannot reset NO_REBOOT bit */
541 if (turn_SMI_watchdog_clear_off
>= p
->iTCO_version
) {
543 * Bit 13: TCO_EN -> 0
544 * Disables TCO logic generating an SMI#
546 val32
= inl(SMI_EN(p
));
547 val32
&= 0xffffdfff; /* Turn off SMI clearing watchdog */
548 outl(val32
, SMI_EN(p
));
551 if (!devm_request_region(dev
, p
->tco_res
->start
,
552 resource_size(p
->tco_res
),
554 dev_err(dev
, "I/O address 0x%04llx already in use, device disabled\n",
559 dev_info(dev
, "Found a %s TCO device (Version=%d, TCOBASE=0x%04llx)\n",
560 pdata
->name
, pdata
->version
, (u64
)TCOBASE(p
));
562 /* Clear out the (probably old) status */
563 switch (p
->iTCO_version
) {
567 outw(0x0008, TCO1_STS(p
)); /* Clear the Time Out Status bit */
568 outw(0x0002, TCO2_STS(p
)); /* Clear SECOND_TO_STS bit */
571 outl(0x20008, TCO1_STS(p
));
576 outw(0x0008, TCO1_STS(p
)); /* Clear the Time Out Status bit */
577 outw(0x0002, TCO2_STS(p
)); /* Clear SECOND_TO_STS bit */
578 outw(0x0004, TCO2_STS(p
)); /* Clear BOOT_STS bit */
582 ident
.firmware_version
= p
->iTCO_version
;
583 p
->wddev
.info
= &ident
;
584 p
->wddev
.ops
= &iTCO_wdt_ops
;
585 p
->wddev
.bootstatus
= 0;
586 p
->wddev
.timeout
= WATCHDOG_TIMEOUT
;
587 watchdog_set_nowayout(&p
->wddev
, nowayout
);
588 p
->wddev
.parent
= dev
;
590 watchdog_set_drvdata(&p
->wddev
, p
);
591 platform_set_drvdata(pdev
, p
);
593 if (!iTCO_wdt_set_running(p
)) {
595 * If the watchdog was not running set NO_REBOOT now to
596 * prevent later reboots.
598 p
->update_no_reboot_bit(p
->no_reboot_priv
, true);
601 /* Check that the heartbeat value is within it's range;
602 if not reset to the default */
603 if (iTCO_wdt_set_timeout(&p
->wddev
, heartbeat
)) {
604 iTCO_wdt_set_timeout(&p
->wddev
, WATCHDOG_TIMEOUT
);
605 dev_info(dev
, "timeout value out of range, using %d\n",
609 watchdog_stop_on_reboot(&p
->wddev
);
610 watchdog_stop_on_unregister(&p
->wddev
);
611 ret
= devm_watchdog_register_device(dev
, &p
->wddev
);
615 dev_info(dev
, "initialized. heartbeat=%d sec (nowayout=%d)\n",
616 heartbeat
, nowayout
);
622 * Suspend-to-idle requires this, because it stops the ticks and timekeeping, so
623 * the watchdog cannot be pinged while in that state. In ACPI sleep states the
624 * watchdog is stopped by the platform firmware.
628 static inline bool __maybe_unused
need_suspend(void)
630 return acpi_target_system_state() == ACPI_STATE_S0
;
633 static inline bool __maybe_unused
need_suspend(void) { return true; }
636 static int __maybe_unused
iTCO_wdt_suspend_noirq(struct device
*dev
)
638 struct iTCO_wdt_private
*p
= dev_get_drvdata(dev
);
641 p
->suspended
= false;
642 if (watchdog_active(&p
->wddev
) && need_suspend()) {
643 ret
= iTCO_wdt_stop(&p
->wddev
);
650 static int __maybe_unused
iTCO_wdt_resume_noirq(struct device
*dev
)
652 struct iTCO_wdt_private
*p
= dev_get_drvdata(dev
);
655 iTCO_wdt_start(&p
->wddev
);
660 static const struct dev_pm_ops iTCO_wdt_pm
= {
661 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(iTCO_wdt_suspend_noirq
,
662 iTCO_wdt_resume_noirq
)
665 static struct platform_driver iTCO_wdt_driver
= {
666 .probe
= iTCO_wdt_probe
,
673 module_platform_driver(iTCO_wdt_driver
);
675 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
676 MODULE_DESCRIPTION("Intel TCO WatchDog Timer Driver");
677 MODULE_VERSION(DRV_VERSION
);
678 MODULE_LICENSE("GPL");
679 MODULE_ALIAS("platform:" DRV_NAME
);