2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2013 Neel Natu <neel@freebsd.org>
5 * Copyright (c) 2013 Tycho Nightingale <tycho.nightingale@pluribusnetworks.com>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/types.h>
36 #include <machine/vmm.h>
37 #include <machine/vmm_snapshot.h>
52 #include "uart_emul.h"
57 SET_DECLARE(lpc_dsdt_set, struct lpc_dsdt);
58 SET_DECLARE(lpc_sysres_set, struct lpc_sysres);
60 #define ELCR_PORT 0x4d0
61 SYSRES_IO(ELCR_PORT, 2);
63 #define IO_TIMER1_PORT 0x40
65 #define NMISC_PORT 0x61
66 SYSRES_IO(NMISC_PORT, 1);
68 static struct pci_devinst *lpc_bridge;
70 static const char *romfile;
72 #define LPC_UART_NUM 2
73 static struct lpc_uart_softc {
74 struct uart_softc *uart_softc;
79 } lpc_uart_softc[LPC_UART_NUM];
81 static const char *lpc_uart_names[LPC_UART_NUM] = { "COM1", "COM2" };
84 * LPC device configuration is in the following form:
85 * <lpc_device_name>[,<options>]
86 * For e.g. "com1,stdio" or "bootrom,/var/romfile"
89 lpc_device_parse(const char *opts)
92 char *str, *cpy, *lpcdev;
95 str = cpy = strdup(opts);
96 lpcdev = strsep(&str, ",");
98 if (strcasecmp(lpcdev, "bootrom") == 0) {
103 for (unit = 0; unit < LPC_UART_NUM; unit++) {
104 if (strcasecmp(lpcdev, lpc_uart_names[unit]) == 0) {
105 lpc_uart_softc[unit].opts = str;
120 lpc_print_supported_devices()
125 for (i = 0; i < LPC_UART_NUM; i++)
126 printf("%s\n", lpc_uart_names[i]);
137 lpc_uart_intr_assert(void *arg)
139 struct lpc_uart_softc *sc = arg;
141 assert(sc->irq >= 0);
143 vm_isa_pulse_irq(lpc_bridge->pi_vmctx, sc->irq, sc->irq);
147 lpc_uart_intr_deassert(void *arg)
150 * The COM devices on the LPC bus generate edge triggered interrupts,
151 * so nothing more to do here.
156 lpc_uart_io_handler(struct vmctx *ctx, int vcpu, int in, int port, int bytes,
157 uint32_t *eax, void *arg)
160 struct lpc_uart_softc *sc = arg;
162 offset = port - sc->iobase;
167 *eax = uart_read(sc->uart_softc, offset);
169 uart_write(sc->uart_softc, offset, *eax);
173 *eax = uart_read(sc->uart_softc, offset);
174 *eax |= uart_read(sc->uart_softc, offset + 1) << 8;
176 uart_write(sc->uart_softc, offset, *eax);
177 uart_write(sc->uart_softc, offset + 1, *eax >> 8);
188 lpc_init(struct vmctx *ctx)
190 struct lpc_uart_softc *sc;
191 struct inout_port iop;
195 if (romfile != NULL) {
196 error = bootrom_loadrom(ctx, romfile);
202 for (unit = 0; unit < LPC_UART_NUM; unit++) {
203 sc = &lpc_uart_softc[unit];
204 name = lpc_uart_names[unit];
206 if (uart_legacy_alloc(unit, &sc->iobase, &sc->irq) != 0) {
207 EPRINTLN("Unable to allocate resources for "
208 "LPC device %s", name);
211 pci_irq_reserve(sc->irq);
213 sc->uart_softc = uart_init(lpc_uart_intr_assert,
214 lpc_uart_intr_deassert, sc);
216 if (uart_set_backend(sc->uart_softc, sc->opts) != 0) {
217 EPRINTLN("Unable to initialize backend '%s' "
218 "for LPC device %s", sc->opts, name);
222 bzero(&iop, sizeof(struct inout_port));
224 iop.port = sc->iobase;
225 iop.size = UART_IO_BAR_SIZE;
226 iop.flags = IOPORT_F_INOUT;
227 iop.handler = lpc_uart_io_handler;
230 error = register_inout(&iop);
239 pci_lpc_write_dsdt(struct pci_devinst *pi)
241 struct lpc_dsdt **ldpp, *ldp;
244 dsdt_line("Device (ISA)");
246 dsdt_line(" Name (_ADR, 0x%04X%04X)", pi->pi_slot, pi->pi_func);
247 dsdt_line(" OperationRegion (LPCR, PCI_Config, 0x00, 0x100)");
248 dsdt_line(" Field (LPCR, AnyAcc, NoLock, Preserve)");
250 dsdt_line(" Offset (0x60),");
251 dsdt_line(" PIRA, 8,");
252 dsdt_line(" PIRB, 8,");
253 dsdt_line(" PIRC, 8,");
254 dsdt_line(" PIRD, 8,");
255 dsdt_line(" Offset (0x68),");
256 dsdt_line(" PIRE, 8,");
257 dsdt_line(" PIRF, 8,");
258 dsdt_line(" PIRG, 8,");
259 dsdt_line(" PIRH, 8");
264 SET_FOREACH(ldpp, lpc_dsdt_set) {
270 dsdt_line("Device (PIC)");
272 dsdt_line(" Name (_HID, EisaId (\"PNP0000\"))");
273 dsdt_line(" Name (_CRS, ResourceTemplate ()");
276 dsdt_fixed_ioport(IO_ICU1, 2);
277 dsdt_fixed_ioport(IO_ICU2, 2);
284 dsdt_line("Device (TIMR)");
286 dsdt_line(" Name (_HID, EisaId (\"PNP0100\"))");
287 dsdt_line(" Name (_CRS, ResourceTemplate ()");
290 dsdt_fixed_ioport(IO_TIMER1_PORT, 4);
301 pci_lpc_sysres_dsdt(void)
303 struct lpc_sysres **lspp, *lsp;
306 dsdt_line("Device (SIO)");
308 dsdt_line(" Name (_HID, EisaId (\"PNP0C02\"))");
309 dsdt_line(" Name (_CRS, ResourceTemplate ()");
313 SET_FOREACH(lspp, lpc_sysres_set) {
317 dsdt_fixed_ioport(lsp->base, lsp->length);
320 dsdt_fixed_mem32(lsp->base, lsp->length);
329 LPC_DSDT(pci_lpc_sysres_dsdt);
332 pci_lpc_uart_dsdt(void)
334 struct lpc_uart_softc *sc;
337 for (unit = 0; unit < LPC_UART_NUM; unit++) {
338 sc = &lpc_uart_softc[unit];
342 dsdt_line("Device (%s)", lpc_uart_names[unit]);
344 dsdt_line(" Name (_HID, EisaId (\"PNP0501\"))");
345 dsdt_line(" Name (_UID, %d)", unit + 1);
346 dsdt_line(" Name (_CRS, ResourceTemplate ()");
349 dsdt_fixed_ioport(sc->iobase, UART_IO_BAR_SIZE);
350 dsdt_fixed_irq(sc->irq);
356 LPC_DSDT(pci_lpc_uart_dsdt);
359 pci_lpc_cfgwrite(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
360 int coff, int bytes, uint32_t val)
366 if (coff >= 0x60 && coff <= 0x63)
367 pirq_pin = coff - 0x60 + 1;
368 if (coff >= 0x68 && coff <= 0x6b)
369 pirq_pin = coff - 0x68 + 5;
371 pirq_write(ctx, pirq_pin, val);
372 pci_set_cfgdata8(pi, coff, pirq_read(pirq_pin));
380 pci_lpc_write(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
381 int baridx, uint64_t offset, int size, uint64_t value)
386 pci_lpc_read(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
387 int baridx, uint64_t offset, int size)
392 #define LPC_DEV 0x7000
393 #define LPC_VENDOR 0x8086
396 pci_lpc_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
400 * Do not allow more than one LPC bridge to be configured.
402 if (lpc_bridge != NULL) {
403 EPRINTLN("Only one LPC bridge is allowed.");
408 * Enforce that the LPC can only be configured on bus 0. This
409 * simplifies the ACPI DSDT because it can provide a decode for
410 * all legacy i/o ports behind bus 0.
412 if (pi->pi_bus != 0) {
413 EPRINTLN("LPC bridge can be present only on bus 0.");
417 if (lpc_init(ctx) != 0)
420 /* initialize config space */
421 pci_set_cfgdata16(pi, PCIR_DEVICE, LPC_DEV);
422 pci_set_cfgdata16(pi, PCIR_VENDOR, LPC_VENDOR);
423 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_BRIDGE);
424 pci_set_cfgdata8(pi, PCIR_SUBCLASS, PCIS_BRIDGE_ISA);
432 lpc_pirq_name(int pin)
436 if (lpc_bridge == NULL)
438 asprintf(&name, "\\_SB.PC00.ISA.LNK%c,", 'A' + pin - 1);
443 lpc_pirq_routed(void)
447 if (lpc_bridge == NULL)
450 for (pin = 0; pin < 4; pin++)
451 pci_set_cfgdata8(lpc_bridge, 0x60 + pin, pirq_read(pin + 1));
452 for (pin = 0; pin < 4; pin++)
453 pci_set_cfgdata8(lpc_bridge, 0x68 + pin, pirq_read(pin + 5));
456 #ifdef BHYVE_SNAPSHOT
458 pci_lpc_snapshot(struct vm_snapshot_meta *meta)
461 struct uart_softc *sc;
463 for (unit = 0; unit < LPC_UART_NUM; unit++) {
464 sc = lpc_uart_softc[unit].uart_softc;
466 ret = uart_snapshot(sc, meta);
476 struct pci_devemu pci_de_lpc = {
478 .pe_init = pci_lpc_init,
479 .pe_write_dsdt = pci_lpc_write_dsdt,
480 .pe_cfgwrite = pci_lpc_cfgwrite,
481 .pe_barwrite = pci_lpc_write,
482 .pe_barread = pci_lpc_read,
483 #ifdef BHYVE_SNAPSHOT
484 .pe_snapshot = pci_lpc_snapshot,
487 PCI_EMUL_SET(pci_de_lpc);