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/resource.h>
64 #include <sys/watchdog.h>
66 #include <dev/pci/pcivar.h>
67 #include <dev/amdsbwd/amd_chipset.h>
68 #include <isa/isavar.h>
71 * Registers in the Watchdog IO space.
72 * See SB7xx RRG 2.3.4, WDRT.
74 #define AMDSB_WD_CTRL 0x00
75 #define AMDSB_WD_RUN 0x01
76 #define AMDSB_WD_FIRED 0x02
77 #define AMDSB_WD_SHUTDOWN 0x04
78 #define AMDSB_WD_DISABLE 0x08
79 #define AMDSB_WD_RESERVED 0x70
80 #define AMDSB_WD_RELOAD 0x80
81 #define AMDSB_WD_COUNT 0x04
82 #define AMDSB_WD_COUNT_MASK 0xffff
83 #define AMDSB_WDIO_REG_WIDTH 4
85 #define amdsbwd_verbose_printf(dev, ...) \
88 device_printf(dev, __VA_ARGS__);\
91 struct amdsbwd_softc {
93 eventhandler_tag ev_tag;
94 struct resource *res_ctrl;
95 struct resource *res_count;
101 unsigned int timeout;
104 static void amdsbwd_identify(driver_t *driver, device_t parent);
105 static int amdsbwd_probe(device_t dev);
106 static int amdsbwd_attach(device_t dev);
107 static int amdsbwd_detach(device_t dev);
108 static int amdsbwd_suspend(device_t dev);
109 static int amdsbwd_resume(device_t dev);
111 static device_method_t amdsbwd_methods[] = {
112 DEVMETHOD(device_identify, amdsbwd_identify),
113 DEVMETHOD(device_probe, amdsbwd_probe),
114 DEVMETHOD(device_attach, amdsbwd_attach),
115 DEVMETHOD(device_detach, amdsbwd_detach),
116 DEVMETHOD(device_suspend, amdsbwd_suspend),
117 DEVMETHOD(device_resume, amdsbwd_resume),
119 DEVMETHOD(device_shutdown, amdsbwd_detach),
124 static devclass_t amdsbwd_devclass;
125 static driver_t amdsbwd_driver = {
128 sizeof(struct amdsbwd_softc)
131 DRIVER_MODULE(amdsbwd, isa, amdsbwd_driver, amdsbwd_devclass, NULL, NULL);
135 pmio_read(struct resource *res, uint8_t reg)
137 bus_write_1(res, 0, reg); /* Index */
138 return (bus_read_1(res, 1)); /* Data */
142 pmio_write(struct resource *res, uint8_t reg, uint8_t val)
144 bus_write_1(res, 0, reg); /* Index */
145 bus_write_1(res, 1, val); /* Data */
149 wdctrl_read(struct amdsbwd_softc *sc)
151 return (bus_read_4(sc->res_ctrl, 0));
155 wdctrl_write(struct amdsbwd_softc *sc, uint32_t val)
157 bus_write_4(sc->res_ctrl, 0, val);
160 static __unused uint32_t
161 wdcount_read(struct amdsbwd_softc *sc)
163 return (bus_read_4(sc->res_count, 0));
167 wdcount_write(struct amdsbwd_softc *sc, uint32_t val)
169 bus_write_4(sc->res_count, 0, val);
173 amdsbwd_tmr_enable(struct amdsbwd_softc *sc)
177 val = wdctrl_read(sc);
179 wdctrl_write(sc, val);
181 amdsbwd_verbose_printf(sc->dev, "timer enabled\n");
185 amdsbwd_tmr_disable(struct amdsbwd_softc *sc)
189 val = wdctrl_read(sc);
190 val &= ~AMDSB_WD_RUN;
191 wdctrl_write(sc, val);
193 amdsbwd_verbose_printf(sc->dev, "timer disabled\n");
197 amdsbwd_tmr_reload(struct amdsbwd_softc *sc)
201 val = wdctrl_read(sc);
202 val |= AMDSB_WD_RELOAD;
203 wdctrl_write(sc, val);
207 amdsbwd_tmr_set(struct amdsbwd_softc *sc, uint16_t timeout)
210 timeout &= AMDSB_WD_COUNT_MASK;
211 wdcount_write(sc, timeout);
212 sc->timeout = timeout;
213 amdsbwd_verbose_printf(sc->dev, "timeout set to %u ticks\n", timeout);
217 amdsbwd_event(void *arg, unsigned int cmd, int *error)
219 struct amdsbwd_softc *sc = arg;
225 if (cmd >= WD_TO_1MS) {
226 timeout = (uint64_t)1 << (cmd - WD_TO_1MS);
227 timeout = timeout / sc->ms_per_tick;
229 /* For a too short timeout use 1 tick. */
232 /* For a too long timeout stop the timer. */
233 if (timeout > sc->max_ticks)
240 if (timeout != sc->timeout)
241 amdsbwd_tmr_set(sc, timeout);
243 amdsbwd_tmr_enable(sc);
244 amdsbwd_tmr_reload(sc);
248 amdsbwd_tmr_disable(sc);
253 amdsbwd_identify(driver_t *driver, device_t parent)
258 if (resource_disabled("amdsbwd", 0))
260 if (device_find_child(parent, "amdsbwd", -1) != NULL)
264 * Try to identify SB600/SB7xx by PCI Device ID of SMBus device
265 * that should be present at bus 0, device 20, function 0.
267 smb_dev = pci_find_bsf(0, 20, 0);
270 if (pci_get_devid(smb_dev) != AMDSB_SMBUS_DEVID &&
271 pci_get_devid(smb_dev) != AMDFCH_SMBUS_DEVID &&
272 pci_get_devid(smb_dev) != AMDCZ_SMBUS_DEVID)
275 child = BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, "amdsbwd", -1);
277 device_printf(parent, "add amdsbwd child failed\n");
282 amdsbwd_probe_sb7xx(device_t dev, struct resource *pmres, uint32_t *addr)
287 /* Report cause of previous reset for user's convenience. */
288 val = pmio_read(pmres, AMDSB_PM_RESET_STATUS0);
290 amdsbwd_verbose_printf(dev, "ResetStatus0 = %#04x\n", val);
291 val = pmio_read(pmres, AMDSB_PM_RESET_STATUS1);
293 amdsbwd_verbose_printf(dev, "ResetStatus1 = %#04x\n", val);
294 if ((val & AMDSB_WD_RST_STS) != 0)
295 device_printf(dev, "Previous Reset was caused by Watchdog\n");
297 /* Find base address of memory mapped WDT registers. */
298 for (*addr = 0, i = 0; i < 4; i++) {
300 *addr |= pmio_read(pmres, AMDSB_PM_WDT_BASE_MSB - i);
304 /* Set watchdog timer tick to 1s. */
305 val = pmio_read(pmres, AMDSB_PM_WDT_CTRL);
306 val &= ~AMDSB_WDT_RES_MASK;
307 val |= AMDSB_WDT_RES_1S;
308 pmio_write(pmres, AMDSB_PM_WDT_CTRL, val);
310 /* Enable watchdog device (in stopped state). */
311 val = pmio_read(pmres, AMDSB_PM_WDT_CTRL);
312 val &= ~AMDSB_WDT_DISABLE;
313 pmio_write(pmres, AMDSB_PM_WDT_CTRL, val);
316 * XXX TODO: Ensure that watchdog decode is enabled
317 * (register 0x41, bit 3).
319 device_set_desc(dev, "AMD SB600/SB7xx Watchdog Timer");
323 amdsbwd_probe_sb8xx(device_t dev, struct resource *pmres, uint32_t *addr)
328 /* Report cause of previous reset for user's convenience. */
330 val = pmio_read(pmres, AMDSB8_PM_RESET_CTRL);
331 if ((val & AMDSB8_RST_STS_DIS) != 0) {
332 val &= ~AMDSB8_RST_STS_DIS;
333 pmio_write(pmres, AMDSB8_PM_RESET_CTRL, val);
336 for (i = 3; i >= 0; i--) {
338 val |= pmio_read(pmres, AMDSB8_PM_RESET_STATUS + i);
341 amdsbwd_verbose_printf(dev, "ResetStatus = 0x%08x\n", val);
342 if ((val & AMDSB8_WD_RST_STS) != 0)
343 device_printf(dev, "Previous Reset was caused by Watchdog\n");
345 /* Find base address of memory mapped WDT registers. */
346 for (*addr = 0, i = 0; i < 4; i++) {
348 *addr |= pmio_read(pmres, AMDSB8_PM_WDT_EN + 3 - i);
352 /* Set watchdog timer tick to 1s. */
353 val = pmio_read(pmres, AMDSB8_PM_WDT_CTRL);
354 val &= ~AMDSB8_WDT_RES_MASK;
355 val |= AMDSB8_WDT_1HZ;
356 pmio_write(pmres, AMDSB8_PM_WDT_CTRL, val);
358 val = pmio_read(pmres, AMDSB8_PM_WDT_CTRL);
359 amdsbwd_verbose_printf(dev, "AMDSB8_PM_WDT_CTRL value = %#04x\n", val);
363 * Enable watchdog device (in stopped state)
364 * and decoding of its address.
366 val = pmio_read(pmres, AMDSB8_PM_WDT_EN);
367 val &= ~AMDSB8_WDT_DISABLE;
368 val |= AMDSB8_WDT_DEC_EN;
369 pmio_write(pmres, AMDSB8_PM_WDT_EN, val);
371 val = pmio_read(pmres, AMDSB8_PM_WDT_EN);
372 device_printf(dev, "AMDSB8_PM_WDT_EN value = %#04x\n", val);
374 device_set_desc(dev, "AMD SB8xx/SB9xx/Axx Watchdog Timer");
378 amdsbwd_probe_fch41(device_t dev, struct resource *pmres, uint32_t *addr)
382 val = pmio_read(pmres, AMDFCH41_PM_ISA_CTRL);
383 if ((val & AMDFCH41_MMIO_EN) != 0) {
384 /* Fixed offset for the watchdog within ACPI MMIO range. */
385 amdsbwd_verbose_printf(dev, "ACPI MMIO range is enabled\n");
386 *addr = AMDFCH41_MMIO_ADDR + AMDFCH41_MMIO_WDT_OFF;
389 * Enable decoding of watchdog MMIO address.
391 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN0);
392 val |= AMDFCH41_WDT_EN;
393 pmio_write(pmres, AMDFCH41_PM_DECODE_EN0, val);
395 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN0);
396 device_printf(dev, "AMDFCH41_PM_DECODE_EN0 value = %#04x\n",
400 /* Special fixed MMIO range for the watchdog. */
401 *addr = AMDFCH41_WDT_FIXED_ADDR;
405 * Set watchdog timer tick to 1s and
406 * enable the watchdog device (in stopped state).
408 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN3);
409 val &= ~AMDFCH41_WDT_RES_MASK;
410 val |= AMDFCH41_WDT_RES_1S;
411 val &= ~AMDFCH41_WDT_EN_MASK;
412 val |= AMDFCH41_WDT_ENABLE;
413 pmio_write(pmres, AMDFCH41_PM_DECODE_EN3, val);
415 val = pmio_read(pmres, AMDFCH41_PM_DECODE_EN3);
416 amdsbwd_verbose_printf(dev, "AMDFCH41_PM_DECODE_EN3 value = %#04x\n",
419 device_set_desc(dev, "AMD FCH Rev 41h+ Watchdog Timer");
423 amdsbwd_probe(device_t dev)
425 struct resource *res;
433 /* Do not claim some ISA PnP device by accident. */
434 if (isa_get_logicalid(dev) != 0)
437 rc = bus_set_resource(dev, SYS_RES_IOPORT, 0, AMDSB_PMIO_INDEX,
440 device_printf(dev, "bus_set_resource for IO failed\n");
444 res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
445 RF_ACTIVE | RF_SHAREABLE);
447 device_printf(dev, "bus_alloc_resource for IO failed\n");
451 smb_dev = pci_find_bsf(0, 20, 0);
452 KASSERT(smb_dev != NULL, ("can't find SMBus PCI device\n"));
453 devid = pci_get_devid(smb_dev);
454 revid = pci_get_revid(smb_dev);
455 if (devid == AMDSB_SMBUS_DEVID && revid < AMDSB8_SMBUS_REVID)
456 amdsbwd_probe_sb7xx(dev, res, &addr);
457 else if (devid == AMDSB_SMBUS_DEVID ||
458 (devid == AMDFCH_SMBUS_DEVID && revid < AMDFCH41_SMBUS_REVID) ||
459 (devid == AMDCZ_SMBUS_DEVID && revid < AMDCZ49_SMBUS_REVID))
460 amdsbwd_probe_sb8xx(dev, res, &addr);
462 amdsbwd_probe_fch41(dev, res, &addr);
464 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
465 bus_delete_resource(dev, SYS_RES_IOPORT, rid);
467 amdsbwd_verbose_printf(dev, "memory base address = %#010x\n", addr);
468 rc = bus_set_resource(dev, SYS_RES_MEMORY, 0, addr + AMDSB_WD_CTRL,
469 AMDSB_WDIO_REG_WIDTH);
471 device_printf(dev, "bus_set_resource for control failed\n");
474 rc = bus_set_resource(dev, SYS_RES_MEMORY, 1, addr + AMDSB_WD_COUNT,
475 AMDSB_WDIO_REG_WIDTH);
477 device_printf(dev, "bus_set_resource for count failed\n");
485 amdsbwd_attach_sb(device_t dev, struct amdsbwd_softc *sc)
488 sc->max_ticks = UINT16_MAX;
492 sc->ms_per_tick = 1000;
494 sc->res_ctrl = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
495 &sc->rid_ctrl, RF_ACTIVE);
496 if (sc->res_ctrl == NULL) {
497 device_printf(dev, "bus_alloc_resource for ctrl failed\n");
500 sc->res_count = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
501 &sc->rid_count, RF_ACTIVE);
502 if (sc->res_count == NULL) {
503 device_printf(dev, "bus_alloc_resource for count failed\n");
510 amdsbwd_attach(device_t dev)
512 struct amdsbwd_softc *sc;
515 sc = device_get_softc(dev);
518 rc = amdsbwd_attach_sb(dev, sc);
523 device_printf(dev, "wd ctrl = %#04x\n", wdctrl_read(sc));
524 device_printf(dev, "wd count = %#04x\n", wdcount_read(sc));
527 /* Setup initial state of Watchdog Control. */
528 wdctrl_write(sc, AMDSB_WD_FIRED);
530 if (wdctrl_read(sc) & AMDSB_WD_DISABLE) {
531 device_printf(dev, "watchdog hardware is disabled\n");
535 sc->ev_tag = EVENTHANDLER_REGISTER(watchdog_list, amdsbwd_event, sc,
536 EVENTHANDLER_PRI_ANY);
546 amdsbwd_detach(device_t dev)
548 struct amdsbwd_softc *sc;
550 sc = device_get_softc(dev);
551 if (sc->ev_tag != NULL)
552 EVENTHANDLER_DEREGISTER(watchdog_list, sc->ev_tag);
555 amdsbwd_tmr_disable(sc);
557 if (sc->res_ctrl != NULL)
558 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ctrl,
561 if (sc->res_count != NULL)
562 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_count,
569 amdsbwd_suspend(device_t dev)
571 struct amdsbwd_softc *sc;
574 sc = device_get_softc(dev);
575 val = wdctrl_read(sc);
576 val &= ~AMDSB_WD_RUN;
577 wdctrl_write(sc, val);
582 amdsbwd_resume(device_t dev)
584 struct amdsbwd_softc *sc;
586 sc = device_get_softc(dev);
587 wdctrl_write(sc, AMDSB_WD_FIRED);
589 amdsbwd_tmr_set(sc, sc->timeout);
590 amdsbwd_tmr_enable(sc);
591 amdsbwd_tmr_reload(sc);