2
* Virtual hardware watchdog.
4
* Copyright (C) 2009 Red Hat Inc.
6
* This program is free software; you can redistribute it and/or
7
* modify it under the terms of the GNU General Public License
8
* as published by the Free Software Foundation; either version 2
9
* of the License, or (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, see <http://www.gnu.org/licenses/>.
19
* By Richard W.M. Jones (rjones@redhat.com).
22
#include "qemu/osdep.h"
24
#include "qemu-common.h"
25
#include "qemu/timer.h"
26
#include "sysemu/watchdog.h"
28
#include "hw/pci/pci.h"
30
/*#define I6300ESB_DEBUG 1*/
33
#define i6300esb_debug(fs,...) \
34
fprintf(stderr,"i6300esb: %s: "fs,__func__,##__VA_ARGS__)
36
#define i6300esb_debug(fs,...)
39
/* PCI configuration registers */
40
#define ESB_CONFIG_REG 0x60 /* Config register */
41
#define ESB_LOCK_REG 0x68 /* WDT lock register */
43
/* Memory mapped registers (offset from base address) */
44
#define ESB_TIMER1_REG 0x00 /* Timer1 value after each reset */
45
#define ESB_TIMER2_REG 0x04 /* Timer2 value after each reset */
46
#define ESB_GINTSR_REG 0x08 /* General Interrupt Status Register */
47
#define ESB_RELOAD_REG 0x0c /* Reload register */
49
/* Lock register bits */
50
#define ESB_WDT_FUNC (0x01 << 2) /* Watchdog functionality */
51
#define ESB_WDT_ENABLE (0x01 << 1) /* Enable WDT */
52
#define ESB_WDT_LOCK (0x01 << 0) /* Lock (nowayout) */
54
/* Config register bits */
55
#define ESB_WDT_REBOOT (0x01 << 5) /* Enable reboot on timeout */
56
#define ESB_WDT_FREQ (0x01 << 2) /* Decrement frequency */
57
#define ESB_WDT_INTTYPE (0x11 << 0) /* Interrupt type on timer1 timeout */
59
/* Reload register bits */
60
#define ESB_WDT_RELOAD (0x01 << 8) /* prevent timeout */
63
#define ESB_UNLOCK1 0x80 /* Step 1 to unlock reset registers */
64
#define ESB_UNLOCK2 0x86 /* Step 2 to unlock reset registers */
71
int reboot_enabled; /* "Reboot" on timer expiry. The real action
72
* performed depends on the -watchdog-action
73
* param passed on QEMU command line.
75
int clock_scale; /* Clock scale. */
76
#define CLOCK_SCALE_1KHZ 0
77
#define CLOCK_SCALE_1MHZ 1
79
int int_type; /* Interrupt type generated. */
80
#define INT_TYPE_IRQ 0 /* APIC 1, INT 10 */
81
#define INT_TYPE_SMI 2
82
#define INT_TYPE_DISABLED 3
84
int free_run; /* If true, reload timer on expiry. */
85
int locked; /* If true, enabled field cannot be changed. */
86
int enabled; /* If true, watchdog is enabled. */
88
QEMUTimer *timer; /* The actual watchdog timer. */
90
uint32_t timer1_preload; /* Values preloaded into timer1, timer2. */
91
uint32_t timer2_preload;
92
int stage; /* Stage (1 or 2). */
94
int unlock_state; /* Guest writes 0x80, 0x86 to unlock the
95
* registers, and we transition through
96
* states 0 -> 1 -> 2 when this happens.
99
int previous_reboot_flag; /* If the watchdog caused the previous
100
* reboot, this flag will be set.
104
typedef struct I6300State I6300State;
106
#define TYPE_WATCHDOG_I6300ESB_DEVICE "i6300esb"
107
#define WATCHDOG_I6300ESB_DEVICE(obj) \
108
OBJECT_CHECK(I6300State, (obj), TYPE_WATCHDOG_I6300ESB_DEVICE)
110
/* This function is called when the watchdog has either been enabled
111
* (hence it starts counting down) or has been keep-alived.
113
static void i6300esb_restart_timer(I6300State *d, int stage)
123
timeout = d->timer1_preload;
125
timeout = d->timer2_preload;
127
if (d->clock_scale == CLOCK_SCALE_1KHZ)
132
/* Get the timeout in nanoseconds. */
134
timeout = timeout * 30; /* on a PCI bus, 1 tick is 30 ns*/
136
i6300esb_debug("stage %d, timeout %" PRIi64 "\n", d->stage, timeout);
138
timer_mod(d->timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + timeout);
141
/* This is called when the guest disables the watchdog. */
142
static void i6300esb_disable_timer(I6300State *d)
144
i6300esb_debug("timer disabled\n");
149
static void i6300esb_reset(DeviceState *dev)
151
PCIDevice *pdev = PCI_DEVICE(dev);
152
I6300State *d = WATCHDOG_I6300ESB_DEVICE(pdev);
154
i6300esb_debug("I6300State = %p\n", d);
156
i6300esb_disable_timer(d);
158
/* NB: Don't change d->previous_reboot_flag in this function. */
160
d->reboot_enabled = 1;
161
d->clock_scale = CLOCK_SCALE_1KHZ;
162
d->int_type = INT_TYPE_IRQ;
166
d->timer1_preload = 0xfffff;
167
d->timer2_preload = 0xfffff;
172
/* This function is called when the watchdog expires. Note that
173
* the hardware has two timers, and so expiry happens in two stages.
174
* If d->stage == 1 then we perform the first stage action (usually,
175
* sending an interrupt) and then restart the timer again for the
176
* second stage. If the second stage expires then the watchdog
177
* really has run out.
179
static void i6300esb_timer_expired(void *vp)
183
i6300esb_debug("stage %d\n", d->stage);
186
/* What to do at the end of stage 1? */
187
switch (d->int_type) {
189
fprintf(stderr, "i6300esb_timer_expired: I would send APIC 1 INT 10 here if I knew how (XXX)\n");
192
fprintf(stderr, "i6300esb_timer_expired: I would send SMI here if I knew how (XXX)\n");
196
/* Start the second stage. */
197
i6300esb_restart_timer(d, 2);
199
/* Second stage expired, reboot for real. */
200
if (d->reboot_enabled) {
201
d->previous_reboot_flag = 1;
202
watchdog_perform_action(); /* This reboots, exits, etc */
203
i6300esb_reset(&d->dev.qdev);
206
/* In "free running mode" we start stage 1 again. */
208
i6300esb_restart_timer(d, 1);
212
static void i6300esb_config_write(PCIDevice *dev, uint32_t addr,
213
uint32_t data, int len)
215
I6300State *d = WATCHDOG_I6300ESB_DEVICE(dev);
218
i6300esb_debug("addr = %x, data = %x, len = %d\n", addr, data, len);
220
if (addr == ESB_CONFIG_REG && len == 2) {
221
d->reboot_enabled = (data & ESB_WDT_REBOOT) == 0;
223
(data & ESB_WDT_FREQ) != 0 ? CLOCK_SCALE_1MHZ : CLOCK_SCALE_1KHZ;
224
d->int_type = (data & ESB_WDT_INTTYPE);
225
} else if (addr == ESB_LOCK_REG && len == 1) {
227
d->locked = (data & ESB_WDT_LOCK) != 0;
228
d->free_run = (data & ESB_WDT_FUNC) != 0;
230
d->enabled = (data & ESB_WDT_ENABLE) != 0;
231
if (!old && d->enabled) /* Enabled transitioned from 0 -> 1 */
232
i6300esb_restart_timer(d, 1);
233
else if (!d->enabled)
234
i6300esb_disable_timer(d);
237
pci_default_write_config(dev, addr, data, len);
241
static uint32_t i6300esb_config_read(PCIDevice *dev, uint32_t addr, int len)
243
I6300State *d = WATCHDOG_I6300ESB_DEVICE(dev);
246
i6300esb_debug ("addr = %x, len = %d\n", addr, len);
248
if (addr == ESB_CONFIG_REG && len == 2) {
250
(d->reboot_enabled ? 0 : ESB_WDT_REBOOT) |
251
(d->clock_scale == CLOCK_SCALE_1MHZ ? ESB_WDT_FREQ : 0) |
254
} else if (addr == ESB_LOCK_REG && len == 1) {
256
(d->free_run ? ESB_WDT_FUNC : 0) |
257
(d->locked ? ESB_WDT_LOCK : 0) |
258
(d->enabled ? ESB_WDT_ENABLE : 0);
261
return pci_default_read_config(dev, addr, len);
265
static uint32_t i6300esb_mem_readb(void *vp, hwaddr addr)
267
i6300esb_debug ("addr = %x\n", (int) addr);
272
static uint32_t i6300esb_mem_readw(void *vp, hwaddr addr)
277
i6300esb_debug("addr = %x\n", (int) addr);
280
/* The previous reboot flag is really bit 9, but there is
281
* a bug in the Linux driver where it thinks it's bit 12.
284
data = d->previous_reboot_flag ? 0x1200 : 0;
290
static uint32_t i6300esb_mem_readl(void *vp, hwaddr addr)
292
i6300esb_debug("addr = %x\n", (int) addr);
297
static void i6300esb_mem_writeb(void *vp, hwaddr addr, uint32_t val)
301
i6300esb_debug("addr = %x, val = %x\n", (int) addr, val);
303
if (addr == 0xc && val == 0x80)
305
else if (addr == 0xc && val == 0x86 && d->unlock_state == 1)
309
static void i6300esb_mem_writew(void *vp, hwaddr addr, uint32_t val)
313
i6300esb_debug("addr = %x, val = %x\n", (int) addr, val);
315
if (addr == 0xc && val == 0x80)
317
else if (addr == 0xc && val == 0x86 && d->unlock_state == 1)
320
if (d->unlock_state == 2) {
322
if ((val & 0x100) != 0)
323
/* This is the "ping" from the userspace watchdog in
326
i6300esb_restart_timer(d, 1);
328
/* Setting bit 9 resets the previous reboot flag.
329
* There's a bug in the Linux driver where it sets
332
if ((val & 0x200) != 0 || (val & 0x1000) != 0) {
333
d->previous_reboot_flag = 0;
342
static void i6300esb_mem_writel(void *vp, hwaddr addr, uint32_t val)
346
i6300esb_debug ("addr = %x, val = %x\n", (int) addr, val);
348
if (addr == 0xc && val == 0x80)
350
else if (addr == 0xc && val == 0x86 && d->unlock_state == 1)
353
if (d->unlock_state == 2) {
355
d->timer1_preload = val & 0xfffff;
357
d->timer2_preload = val & 0xfffff;
364
static const MemoryRegionOps i6300esb_ops = {
377
.endianness = DEVICE_LITTLE_ENDIAN,
380
static const VMStateDescription vmstate_i6300esb = {
381
.name = "i6300esb_wdt",
382
/* With this VMSD's introduction, version_id/minimum_version_id were
383
* erroneously set to sizeof(I6300State), causing a somewhat random
384
* version_id to be set for every build. This eventually broke
387
* To correct this without breaking old->new migration for older
388
* versions of QEMU, we've set version_id to a value high enough
389
* to exceed all past values of sizeof(I6300State) across various
390
* build environments, and have reset minimum_version_id to 1,
391
* since this VMSD has never changed and thus can accept all past
394
* For future changes we can treat these values as we normally would.
397
.minimum_version_id = 1,
398
.fields = (VMStateField[]) {
399
VMSTATE_PCI_DEVICE(dev, I6300State),
400
VMSTATE_INT32(reboot_enabled, I6300State),
401
VMSTATE_INT32(clock_scale, I6300State),
402
VMSTATE_INT32(int_type, I6300State),
403
VMSTATE_INT32(free_run, I6300State),
404
VMSTATE_INT32(locked, I6300State),
405
VMSTATE_INT32(enabled, I6300State),
406
VMSTATE_TIMER_PTR(timer, I6300State),
407
VMSTATE_UINT32(timer1_preload, I6300State),
408
VMSTATE_UINT32(timer2_preload, I6300State),
409
VMSTATE_INT32(stage, I6300State),
410
VMSTATE_INT32(unlock_state, I6300State),
411
VMSTATE_INT32(previous_reboot_flag, I6300State),
412
VMSTATE_END_OF_LIST()
416
static void i6300esb_realize(PCIDevice *dev, Error **errp)
418
I6300State *d = WATCHDOG_I6300ESB_DEVICE(dev);
420
i6300esb_debug("I6300State = %p\n", d);
422
d->timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, i6300esb_timer_expired, d);
423
d->previous_reboot_flag = 0;
425
memory_region_init_io(&d->io_mem, OBJECT(d), &i6300esb_ops, d,
427
pci_register_bar(&d->dev, 0, 0, &d->io_mem);
428
/* qemu_register_coalesced_mmio (addr, 0x10); ? */
431
static WatchdogTimerModel model = {
432
.wdt_name = "i6300esb",
433
.wdt_description = "Intel 6300ESB",
436
static void i6300esb_class_init(ObjectClass *klass, void *data)
438
DeviceClass *dc = DEVICE_CLASS(klass);
439
PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
441
k->config_read = i6300esb_config_read;
442
k->config_write = i6300esb_config_write;
443
k->realize = i6300esb_realize;
444
k->vendor_id = PCI_VENDOR_ID_INTEL;
445
k->device_id = PCI_DEVICE_ID_INTEL_ESB_9;
446
k->class_id = PCI_CLASS_SYSTEM_OTHER;
447
dc->reset = i6300esb_reset;
448
dc->vmsd = &vmstate_i6300esb;
449
set_bit(DEVICE_CATEGORY_MISC, dc->categories);
452
static const TypeInfo i6300esb_info = {
453
.name = TYPE_WATCHDOG_I6300ESB_DEVICE,
454
.parent = TYPE_PCI_DEVICE,
455
.instance_size = sizeof(I6300State),
456
.class_init = i6300esb_class_init,
459
static void i6300esb_register_types(void)
461
watchdog_add_model(&model);
462
type_register_static(&i6300esb_info);
465
type_init(i6300esb_register_types)