2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2020 Adam Fenn <adam@fenn.io>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * Emulation of selected legacy test/debug interfaces expected by KVM-unit-tests
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/types.h>
37 #include <machine/vmm.h>
50 #include "pctestdev.h"
52 #define DEBUGEXIT_BASE 0xf4
53 #define DEBUGEXIT_LEN 4
54 #define DEBUGEXIT_NAME "isa-debug-exit"
56 #define IOMEM_BASE 0xff000000
57 #define IOMEM_LEN 0x10000
58 #define IOMEM_NAME "pc-testdev-iomem"
60 #define IOPORT_BASE 0xe0
62 #define IOPORT_NAME "pc-testdev-ioport"
64 #define IRQ_BASE 0x2000
65 #define IRQ_IOAPIC_PINCOUNT_MIN 24
66 #define IRQ_IOAPIC_PINCOUNT_MAX 32
67 #define IRQ_NAME "pc-testdev-irq-line"
69 #define PCTESTDEV_NAME "pc-testdev"
71 static bool pctestdev_inited;
72 static uint8_t pctestdev_iomem_buf[IOMEM_LEN];
73 static uint32_t pctestdev_ioport_data;
75 static int pctestdev_debugexit_io(struct vmctx *ctx, int vcpu, int in,
76 int port, int bytes, uint32_t *eax, void *arg);
77 static int pctestdev_iomem_io(struct vmctx *ctx, int vcpu, int dir,
78 uint64_t addr, int size, uint64_t *val, void *arg1,
80 static int pctestdev_ioport_io(struct vmctx *ctx, int vcpu, int in,
81 int port, int bytes, uint32_t *eax, void *arg);
82 static int pctestdev_irq_io(struct vmctx *ctx, int vcpu, int in,
83 int port, int bytes, uint32_t *eax, void *arg);
86 pctestdev_getname(void)
88 return (PCTESTDEV_NAME);
92 pctestdev_parse(const char *opts)
94 if (opts != NULL && *opts != '\0')
101 pctestdev_init(struct vmctx *ctx)
103 struct mem_range iomem;
104 struct inout_port debugexit, ioport, irq;
107 if (pctestdev_inited) {
108 EPRINTLN("Only one pc-testdev device is allowed.");
113 err = vm_ioapic_pincount(ctx, &pincount);
115 EPRINTLN("pc-testdev: Failed to obtain IOAPIC pin count.");
119 if (pincount < IRQ_IOAPIC_PINCOUNT_MIN ||
120 pincount > IRQ_IOAPIC_PINCOUNT_MAX) {
121 EPRINTLN("pc-testdev: Unsupported IOAPIC pin count: %d.",
127 debugexit.name = DEBUGEXIT_NAME;
128 debugexit.port = DEBUGEXIT_BASE;
129 debugexit.size = DEBUGEXIT_LEN;
130 debugexit.flags = IOPORT_F_INOUT;
131 debugexit.handler = pctestdev_debugexit_io;
132 debugexit.arg = NULL;
134 iomem.name = IOMEM_NAME;
135 iomem.flags = MEM_F_RW | MEM_F_IMMUTABLE;
136 iomem.handler = pctestdev_iomem_io;
139 iomem.base = IOMEM_BASE;
140 iomem.size = IOMEM_LEN;
142 ioport.name = IOPORT_NAME;
143 ioport.port = IOPORT_BASE;
144 ioport.size = IOPORT_LEN;
145 ioport.flags = IOPORT_F_INOUT;
146 ioport.handler = pctestdev_ioport_io;
152 irq.flags = IOPORT_F_INOUT;
153 irq.handler = pctestdev_irq_io;
156 err = register_inout(&debugexit);
160 err = register_inout(&ioport);
162 goto fail_after_debugexit_reg;
164 err = register_inout(&irq);
166 goto fail_after_ioport_reg;
168 err = register_mem(&iomem);
170 goto fail_after_irq_reg;
172 pctestdev_inited = true;
177 (void)unregister_inout(&irq);
179 fail_after_ioport_reg:
180 (void)unregister_inout(&ioport);
182 fail_after_debugexit_reg:
183 (void)unregister_inout(&debugexit);
190 pctestdev_debugexit_io(struct vmctx *ctx, int vcpu, int in, int port,
191 int bytes, uint32_t *eax, void *arg)
196 exit((*eax << 1) | 1);
202 pctestdev_iomem_io(struct vmctx *ctx, int vcpu, int dir, uint64_t addr,
203 int size, uint64_t *val, void *arg1, long arg2)
207 if (addr + size > IOMEM_BASE + IOMEM_LEN)
210 offset = addr - IOMEM_BASE;
211 if (dir == MEM_F_READ) {
212 (void)memcpy(val, pctestdev_iomem_buf + offset, size);
214 assert(dir == MEM_F_WRITE);
215 (void)memcpy(pctestdev_iomem_buf + offset, val, size);
222 pctestdev_ioport_io(struct vmctx *ctx, int vcpu, int in, int port,
223 int bytes, uint32_t *eax, void *arg)
228 if (port + bytes > IOPORT_BASE + IOPORT_LEN)
231 lsb = (port & 0x3) * 8;
232 mask = (-1UL >> (32 - (bytes * 8))) << lsb;
235 *eax = (pctestdev_ioport_data & mask) >> lsb;
237 pctestdev_ioport_data &= ~mask;
238 pctestdev_ioport_data |= *eax << lsb;
245 pctestdev_irq_io(struct vmctx *ctx, int vcpu, int in, int port, int bytes,
246 uint32_t *eax, void *arg)
257 irq = port - IRQ_BASE;
260 return (vm_isa_assert_irq(ctx, irq, irq));
262 return (vm_isa_deassert_irq(ctx, irq, irq));
265 return (vm_ioapic_assert_irq(ctx, irq));
267 return (vm_ioapic_deassert_irq(ctx, irq));