2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009 Andriy Gapon <avg@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * This is a driver for watchdog timer present in AMD SB600/SB7xx/SB8xx
32 * Please see the following specifications for the descriptions of the
33 * registers and flags:
34 * - AMD SB600 Register Reference Guide, Public Version, Rev. 3.03 (SB600 RRG)
35 * http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/46155_sb600_rrg_pub_3.03.pdf
36 * - AMD SB700/710/750 Register Reference Guide (RRG)
37 * http://developer.amd.com/assets/43009_sb7xx_rrg_pub_1.00.pdf
38 * - AMD SB700/710/750 Register Programming Requirements (RPR)
39 * http://developer.amd.com/assets/42413_sb7xx_rpr_pub_1.00.pdf
40 * - AMD SB800-Series Southbridges Register Reference Guide (RRG)
41 * http://support.amd.com/us/Embedded_TechDocs/45482.pdf
42 * Please see the following for Watchdog Resource Table specification:
43 * - Watchdog Timer Hardware Requirements for Windows Server 2003 (WDRT)
44 * http://www.microsoft.com/whdc/system/sysinternals/watchdog.mspx
45 * AMD SB600/SB7xx/SB8xx watchdog hardware seems to conform to the above
46 * specifications, but the table hasn't been spotted in the wild yet.
49 #include <sys/cdefs.h>
50 __FBSDID("$FreeBSD$");
52 #include "opt_amdsbwd.h"
54 #include <sys/param.h>
55 #include <sys/eventhandler.h>
56 #include <sys/kernel.h>
57 #include <sys/module.h>
58 #include <sys/systm.h>
59 #include <sys/sysctl.h>
61 #include <machine/bus.h>
63 #include <machine/cputypes.h>
64 #include <machine/md_var.h>
65 #include <machine/resource.h>
66 #include <sys/watchdog.h>
68 #include <dev/pci/pcivar.h>
69 #include <dev/amdsbwd/amd_chipset.h>
70 #include <isa/isavar.h>
73 * Registers in the Watchdog IO space.
74 * See SB7xx RRG 2.3.4, WDRT.
76 #define AMDSB_WD_CTRL 0x00
77 #define AMDSB_WD_RUN 0x01
78 #define AMDSB_WD_FIRED 0x02
79 #define AMDSB_WD_SHUTDOWN 0x04
80 #define AMDSB_WD_DISABLE 0x08
81 #define AMDSB_WD_RESERVED 0x70
82 #define AMDSB_WD_RELOAD 0x80
83 #define AMDSB_WD_COUNT 0x04
84 #define AMDSB_WD_COUNT_MASK 0xffff
85 #define AMDSB_WDIO_REG_WIDTH 4
87 #define amdsbwd_verbose_printf(dev, ...) \
90 device_printf(dev, __VA_ARGS__);\
93 struct amdsbwd_softc {
95 eventhandler_tag ev_tag;
96 struct resource *res_ctrl;
97 struct resource *res_count;
103 unsigned int timeout;
106 static void amdsbwd_identify(driver_t *driver, device_t parent);
107 static int amdsbwd_probe(device_t dev);
108 static int amdsbwd_attach(device_t dev);
109 static int amdsbwd_detach(device_t dev);
110 static int amdsbwd_suspend(device_t dev);
111 static int amdsbwd_resume(device_t dev);
113 static device_method_t amdsbwd_methods[] = {
114 DEVMETHOD(device_identify, amdsbwd_identify),
115 DEVMETHOD(device_probe, amdsbwd_probe),
116 DEVMETHOD(device_attach, amdsbwd_attach),
117 DEVMETHOD(device_detach, amdsbwd_detach),
118 DEVMETHOD(device_suspend, amdsbwd_suspend),
119 DEVMETHOD(device_resume, amdsbwd_resume),
121 DEVMETHOD(device_shutdown, amdsbwd_detach),
126 static devclass_t amdsbwd_devclass;
127 static driver_t amdsbwd_driver = {
130 sizeof(struct amdsbwd_softc)
133 DRIVER_MODULE(amdsbwd, isa, amdsbwd_driver, amdsbwd_devclass, NULL, NULL);
136 pmio_read(struct resource *res, uint8_t reg)
138 bus_write_1(res, 0, reg); /* Index */
139 return (bus_read_1(res, 1)); /* Data */
143 pmio_write(struct resource *res, uint8_t reg, uint8_t val)
145 bus_write_1(res, 0, reg); /* Index */
146 bus_write_1(res, 1, val); /* Data */
150 wdctrl_read(struct amdsbwd_softc *sc)
152 return (bus_read_4(sc->res_ctrl, 0));
156 wdctrl_write(struct amdsbwd_softc *sc, uint32_t val)
158 bus_write_4(sc->res_ctrl, 0, val);
161 static __unused uint32_t
162 wdcount_read(struct amdsbwd_softc *sc)
164 return (bus_read_4(sc->res_count, 0));
168 wdcount_write(struct amdsbwd_softc *sc, uint32_t val)
170 bus_write_4(sc->res_count, 0, val);
174 amdsbwd_tmr_enable(struct amdsbwd_softc *sc)
178 val = wdctrl_read(sc);
180 wdctrl_write(sc, val);
182 amdsbwd_verbose_printf(sc->dev, "timer enabled\n");
186 amdsbwd_tmr_disable(struct amdsbwd_softc *sc)
190 val = wdctrl_read(sc);
191 val &= ~AMDSB_WD_RUN;
192 wdctrl_write(sc, val);
194 amdsbwd_verbose_printf(sc->dev, "timer disabled\n");
198 amdsbwd_tmr_reload(struct amdsbwd_softc *sc)
202 val = wdctrl_read(sc);
203 val |= AMDSB_WD_RELOAD;
204 wdctrl_write(sc, val);
208 amdsbwd_tmr_set(struct amdsbwd_softc *sc, uint16_t timeout)
211 timeout &= AMDSB_WD_COUNT_MASK;
212 wdcount_write(sc, timeout);
213 sc->timeout = timeout;
214 amdsbwd_verbose_printf(sc->dev, "timeout set to %u ticks\n", timeout);
218 amdsbwd_event(void *arg, unsigned int cmd, int *error)
220 struct amdsbwd_softc *sc = arg;
226 if (cmd >= WD_TO_1MS) {
227 timeout = (uint64_t)1 << (cmd - WD_TO_1MS);
228 timeout = timeout / sc->ms_per_tick;
230 /* For a too short timeout use 1 tick. */
233 /* For a too long timeout stop the timer. */
234 if (timeout > sc->max_ticks)
241 if (timeout != sc->timeout)
242 amdsbwd_tmr_set(sc, timeout);
244 amdsbwd_tmr_enable(sc);
245 amdsbwd_tmr_reload(sc);
249 amdsbwd_tmr_disable(sc);
254 amdsbwd_identify(driver_t *driver, device_t parent)
259 if (resource_disabled("amdsbwd", 0))
261 if (device_find_child(parent, "amdsbwd", -1) != NULL)
265 * Try to identify SB600/SB7xx by PCI Device ID of SMBus device
266 * that should be present at bus 0, device 20, function 0.
268 smb_dev = pci_find_bsf(0, 20, 0);
271 if (pci_get_devid(smb_dev) != AMDSB_SMBUS_DEVID &&
272 pci_get_devid(smb_dev) != AMDFCH_SMBUS_DEVID &&
273 pci_get_devid(smb_dev) != AMDCZ_SMBUS_DEVID &&
274 pci_get_devid(smb_dev) != HYGONCZ_SMBUS_DEVID)
277 child = BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, "amdsbwd", -1);
279 device_printf(parent, "add amdsbwd child failed\n");
283 amdsbwd_probe_sb7xx(device_t dev, struct resource *pmres, uint32_t *addr)
288 /* Report cause of previous reset for user's convenience. */
289 val = pmio_read(pmres, AMDSB_PM_RESET_STATUS0);
291 amdsbwd_verbose_printf(dev, "ResetStatus0 = %#04x\n", val);
292 val = pmio_read(pmres, AMDSB_PM_RESET_STATUS1);
294 amdsbwd_verbose_printf(dev, "ResetStatus1 = %#04x\n", val);
295 if ((val & AMDSB_WD_RST_STS) != 0)
296 device_printf(dev, "Previous Reset was caused by Watchdog\n");
298 /* Find base address of memory mapped WDT registers. */
299 for (*addr = 0, i = 0; i < 4; i++) {
301 *addr |= pmio_read(pmres, AMDSB_PM_WDT_BASE_MSB - i);
305 /* Set watchdog timer tick to 1s. */
306 val = pmio_read(pmres, AMDSB_PM_WDT_CTRL);
307 val &= ~AMDSB_WDT_RES_MASK;
308 val |= AMDSB_WDT_RES_1S;
309 pmio_write(pmres, AMDSB_PM_WDT_CTRL, val);
311 /* Enable watchdog device (in stopped state). */
312 val = pmio_read(pmres, AMDSB_PM_WDT_CTRL);
313 val &= ~AMDSB_WDT_DISABLE;
314 pmio_write(pmres, AMDSB_PM_WDT_CTRL, val);
317 * XXX TODO: Ensure that watchdog decode is enabled
318 * (register 0x41, bit 3).
320 device_set_desc(dev, "AMD SB600/SB7xx Watchdog Timer");
324 amdsbwd_probe_sb8xx(device_t dev, struct resource *pmres, uint32_t *addr)
329 /* Report cause of previous reset for user's convenience. */
331 val = pmio_read(pmres, AMDSB8_PM_RESET_CTRL);
332 if ((val & AMDSB8_RST_STS_DIS) != 0) {
333 val &= ~AMDSB8_RST_STS_DIS;
334 pmio_write(pmres, AMDSB8_PM_RESET_CTRL, val);
337 for (i = 3; i >= 0; i--) {
339 val |= pmio_read(pmres, AMDSB8_PM_RESET_STATUS + i);
342 amdsbwd_verbose_printf(dev, "ResetStatus = 0x%08x\n", val);
343 if ((val & AMDSB8_WD_RST_STS) != 0)
344 device_printf(dev, "Previous Reset was caused by Watchdog\n");
346 /* Find base address of memory mapped WDT registers. */
347 for (*addr = 0, i = 0; i < 4; i++) {
349 *addr |= pmio_read(pmres, AMDSB8_PM_WDT_EN + 3 - i);
353 /* Set watchdog timer tick to 1s. */
354 val = pmio_read(pmres, AMDSB8_PM_WDT_CTRL);
355 val &= ~AMDSB8_WDT_RES_MASK;
356 val |= AMDSB8_WDT_1HZ;
357 pmio_write(pmres, AMDSB8_PM_WDT_CTRL, val);
359 val = pmio_read(pmres, AMDSB8_PM_WDT_CTRL);
360 amdsbwd_verbose_printf(dev, "AMDSB8_PM_WDT_CTRL value = %#04x\n", val);
364 * Enable watchdog device (in stopped state)
365 * and decoding of its address.
367 val = pmio_read(pmres, AMDSB8_PM_WDT_EN);
368 val &= ~AMDSB8_WDT_DISABLE;
369 val |= AMDSB8_WDT_DEC_EN;
370 pmio_write(pmres, AMDSB8_PM_WDT_EN, val);
372 val = pmio_read(pmres, AMDSB8_PM_WDT_EN);
373 device_printf(dev, "AMDSB8_PM_WDT_EN value = %#04x\n", val);
375 device_set_desc(dev, "AMD SB8xx/SB9xx/Axx Watchdog Timer");
379 amdsbwd_probe_fch41(device_t dev, struct resource *pmres, uint32_t *addr)
385 * Enable decoding of watchdog MMIO address.
387 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN0);
388 val |= AMDFCH41_WDT_EN;
389 pmio_write(pmres, AMDFCH41_PM_DECODE_EN0, val);
391 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN0);
392 device_printf(dev, "AMDFCH41_PM_DECODE_EN0 value = %#04x\n", val);
395 val = pmio_read(pmres, AMDFCH41_PM_ISA_CTRL);
396 if ((val & AMDFCH41_MMIO_EN) != 0) {
397 /* Fixed offset for the watchdog within ACPI MMIO range. */
398 amdsbwd_verbose_printf(dev, "ACPI MMIO range is enabled\n");
399 *addr = AMDFCH41_MMIO_ADDR + AMDFCH41_MMIO_WDT_OFF;
401 /* Special fixed MMIO range for the watchdog. */
402 *addr = AMDFCH41_WDT_FIXED_ADDR;
406 * Set watchdog timer tick to 1s and
407 * enable the watchdog device (in stopped state).
409 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN3);
410 val &= ~AMDFCH41_WDT_RES_MASK;
411 val |= AMDFCH41_WDT_RES_1S;
412 val &= ~AMDFCH41_WDT_EN_MASK;
413 val |= AMDFCH41_WDT_ENABLE;
414 pmio_write(pmres, AMDFCH41_PM_DECODE_EN3, val);
416 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN3);
417 amdsbwd_verbose_printf(dev, "AMDFCH41_PM_DECODE_EN3 value = %#04x\n",
420 snprintf(buf, sizeof(buf), "%s FCH Rev 41h+ Watchdog Timer",
421 cpu_vendor_id == CPU_VENDOR_HYGON ? "Hygon" : "AMD");
422 device_set_desc_copy(dev, buf);
426 amdsbwd_probe(device_t dev)
428 struct resource *res;
436 /* Do not claim some ISA PnP device by accident. */
437 if (isa_get_logicalid(dev) != 0)
440 rc = bus_set_resource(dev, SYS_RES_IOPORT, 0, AMDSB_PMIO_INDEX,
443 device_printf(dev, "bus_set_resource for IO failed\n");
447 res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
448 RF_ACTIVE | RF_SHAREABLE);
450 device_printf(dev, "bus_alloc_resource for IO failed\n");
454 smb_dev = pci_find_bsf(0, 20, 0);
455 KASSERT(smb_dev != NULL, ("can't find SMBus PCI device\n"));
456 devid = pci_get_devid(smb_dev);
457 revid = pci_get_revid(smb_dev);
458 if (devid == AMDSB_SMBUS_DEVID && revid < AMDSB8_SMBUS_REVID)
459 amdsbwd_probe_sb7xx(dev, res, &addr);
460 else if (devid == AMDSB_SMBUS_DEVID ||
461 (devid == AMDFCH_SMBUS_DEVID && revid < AMDFCH41_SMBUS_REVID) ||
462 (devid == AMDCZ_SMBUS_DEVID && revid < AMDCZ49_SMBUS_REVID))
463 amdsbwd_probe_sb8xx(dev, res, &addr);
465 amdsbwd_probe_fch41(dev, res, &addr);
467 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
468 bus_delete_resource(dev, SYS_RES_IOPORT, rid);
470 amdsbwd_verbose_printf(dev, "memory base address = %#010x\n", addr);
471 rc = bus_set_resource(dev, SYS_RES_MEMORY, 0, addr + AMDSB_WD_CTRL,
472 AMDSB_WDIO_REG_WIDTH);
474 device_printf(dev, "bus_set_resource for control failed\n");
477 rc = bus_set_resource(dev, SYS_RES_MEMORY, 1, addr + AMDSB_WD_COUNT,
478 AMDSB_WDIO_REG_WIDTH);
480 device_printf(dev, "bus_set_resource for count failed\n");
488 amdsbwd_attach_sb(device_t dev, struct amdsbwd_softc *sc)
491 sc->max_ticks = UINT16_MAX;
495 sc->ms_per_tick = 1000;
497 sc->res_ctrl = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
498 &sc->rid_ctrl, RF_ACTIVE);
499 if (sc->res_ctrl == NULL) {
500 device_printf(dev, "bus_alloc_resource for ctrl failed\n");
503 sc->res_count = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
504 &sc->rid_count, RF_ACTIVE);
505 if (sc->res_count == NULL) {
506 device_printf(dev, "bus_alloc_resource for count failed\n");
513 amdsbwd_attach(device_t dev)
515 struct amdsbwd_softc *sc;
518 sc = device_get_softc(dev);
521 rc = amdsbwd_attach_sb(dev, sc);
526 device_printf(dev, "wd ctrl = %#04x\n", wdctrl_read(sc));
527 device_printf(dev, "wd count = %#04x\n", wdcount_read(sc));
530 /* Setup initial state of Watchdog Control. */
531 wdctrl_write(sc, AMDSB_WD_FIRED);
533 if (wdctrl_read(sc) & AMDSB_WD_DISABLE) {
534 device_printf(dev, "watchdog hardware is disabled\n");
538 sc->ev_tag = EVENTHANDLER_REGISTER(watchdog_list, amdsbwd_event, sc,
539 EVENTHANDLER_PRI_ANY);
549 amdsbwd_detach(device_t dev)
551 struct amdsbwd_softc *sc;
553 sc = device_get_softc(dev);
554 if (sc->ev_tag != NULL)
555 EVENTHANDLER_DEREGISTER(watchdog_list, sc->ev_tag);
558 amdsbwd_tmr_disable(sc);
560 if (sc->res_ctrl != NULL)
561 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ctrl,
564 if (sc->res_count != NULL)
565 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_count,
572 amdsbwd_suspend(device_t dev)
574 struct amdsbwd_softc *sc;
577 sc = device_get_softc(dev);
578 val = wdctrl_read(sc);
579 val &= ~AMDSB_WD_RUN;
580 wdctrl_write(sc, val);
585 amdsbwd_resume(device_t dev)
587 struct amdsbwd_softc *sc;
589 sc = device_get_softc(dev);
590 wdctrl_write(sc, AMDSB_WD_FIRED);
592 amdsbwd_tmr_set(sc, sc->timeout);
593 amdsbwd_tmr_enable(sc);
594 amdsbwd_tmr_reload(sc);