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 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 in
,
81 int port
, int bytes
, uint32_t *eax
, void *arg
);
82 static int pctestdev_irq_io(struct vmctx
*ctx
, int in
,
83 int port
, int bytes
, uint32_t *eax
, void *arg
);
86 pctestdev_getname(void)
88 return (PCTESTDEV_NAME
);
92 pctestdev_init(struct vmctx
*ctx
)
94 struct mem_range iomem
;
95 struct inout_port debugexit
, ioport
, irq
;
98 if (pctestdev_inited
) {
99 EPRINTLN("Only one pc-testdev device is allowed.");
104 err
= vm_ioapic_pincount(ctx
, &pincount
);
106 EPRINTLN("pc-testdev: Failed to obtain IOAPIC pin count.");
110 if (pincount
< IRQ_IOAPIC_PINCOUNT_MIN
||
111 pincount
> IRQ_IOAPIC_PINCOUNT_MAX
) {
112 EPRINTLN("pc-testdev: Unsupported IOAPIC pin count: %d.",
118 debugexit
.name
= DEBUGEXIT_NAME
;
119 debugexit
.port
= DEBUGEXIT_BASE
;
120 debugexit
.size
= DEBUGEXIT_LEN
;
121 debugexit
.flags
= IOPORT_F_INOUT
;
122 debugexit
.handler
= pctestdev_debugexit_io
;
123 debugexit
.arg
= NULL
;
125 iomem
.name
= IOMEM_NAME
;
126 iomem
.flags
= MEM_F_RW
| MEM_F_IMMUTABLE
;
127 iomem
.handler
= pctestdev_iomem_io
;
130 iomem
.base
= IOMEM_BASE
;
131 iomem
.size
= IOMEM_LEN
;
133 ioport
.name
= IOPORT_NAME
;
134 ioport
.port
= IOPORT_BASE
;
135 ioport
.size
= IOPORT_LEN
;
136 ioport
.flags
= IOPORT_F_INOUT
;
137 ioport
.handler
= pctestdev_ioport_io
;
143 irq
.flags
= IOPORT_F_INOUT
;
144 irq
.handler
= pctestdev_irq_io
;
147 err
= register_inout(&debugexit
);
151 err
= register_inout(&ioport
);
153 goto fail_after_debugexit_reg
;
155 err
= register_inout(&irq
);
157 goto fail_after_ioport_reg
;
159 err
= register_mem(&iomem
);
161 goto fail_after_irq_reg
;
163 pctestdev_inited
= true;
168 (void)unregister_inout(&irq
);
170 fail_after_ioport_reg
:
171 (void)unregister_inout(&ioport
);
173 fail_after_debugexit_reg
:
174 (void)unregister_inout(&debugexit
);
181 pctestdev_debugexit_io(struct vmctx
*ctx __unused
, int in
,
182 int port __unused
, int bytes __unused
, uint32_t *eax
, void *arg __unused
)
187 exit((*eax
<< 1) | 1);
193 pctestdev_iomem_io(struct vmctx
*ctx __unused
, int vcpu __unused
, int dir
,
194 uint64_t addr
, int size
, uint64_t *val
, void *arg1 __unused
,
199 if (addr
+ size
> IOMEM_BASE
+ IOMEM_LEN
)
202 offset
= addr
- IOMEM_BASE
;
203 if (dir
== MEM_F_READ
) {
204 (void)memcpy(val
, pctestdev_iomem_buf
+ offset
, size
);
206 assert(dir
== MEM_F_WRITE
);
207 (void)memcpy(pctestdev_iomem_buf
+ offset
, val
, size
);
214 pctestdev_ioport_io(struct vmctx
*ctx __unused
, int in
,
215 int port
, int bytes
, uint32_t *eax
, void *arg __unused
)
220 if (port
+ bytes
> IOPORT_BASE
+ IOPORT_LEN
)
223 lsb
= (port
& 0x3) * 8;
224 mask
= (-1UL >> (32 - (bytes
* 8))) << lsb
;
227 *eax
= (pctestdev_ioport_data
& mask
) >> lsb
;
229 pctestdev_ioport_data
&= ~mask
;
230 pctestdev_ioport_data
|= *eax
<< lsb
;
237 pctestdev_irq_io(struct vmctx
*ctx
, int in
, int port
,
238 int bytes
, uint32_t *eax
, void *arg __unused
)
249 irq
= port
- IRQ_BASE
;
252 return (vm_isa_assert_irq(ctx
, irq
, irq
));
254 return (vm_isa_deassert_irq(ctx
, irq
, irq
));
257 return (vm_ioapic_assert_irq(ctx
, irq
));
259 return (vm_ioapic_deassert_irq(ctx
, irq
));