xref: /freebsd/usr.sbin/bhyve/pci_uart.c (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 NetApp, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
15  *
16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``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 NETAPP, INC 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
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/types.h>
30 
31 #include <stdio.h>
32 
33 #include "bhyverun.h"
34 #include "config.h"
35 #include "debug.h"
36 #include "pci_emul.h"
37 #include "uart_emul.h"
38 
39 /*
40  * Pick a PCI vid/did of a chip with a single uart at
41  * BAR0, that most versions of FreeBSD can understand:
42  * Siig CyberSerial 1-port.
43  */
44 #define COM_VENDOR	0x131f
45 #define COM_DEV		0x2000
46 
47 static void
48 pci_uart_intr_assert(void *arg)
49 {
50 	struct pci_devinst *pi = arg;
51 
52 	pci_lintr_assert(pi);
53 }
54 
55 static void
56 pci_uart_intr_deassert(void *arg)
57 {
58 	struct pci_devinst *pi = arg;
59 
60 	pci_lintr_deassert(pi);
61 }
62 
63 static void
64 pci_uart_write(struct pci_devinst *pi, int baridx, uint64_t offset, int size,
65     uint64_t value)
66 {
67 	assert(baridx == 0);
68 	assert(size == 1);
69 
70 	uart_ns16550_write(pi->pi_arg, offset, value);
71 }
72 
73 static uint64_t
74 pci_uart_read(struct pci_devinst *pi, int baridx, uint64_t offset, int size)
75 {
76 	uint8_t val;
77 
78 	assert(baridx == 0);
79 	assert(size == 1);
80 
81 	val = uart_ns16550_read(pi->pi_arg, offset);
82 	return (val);
83 }
84 
85 static int
86 pci_uart_legacy_config(nvlist_t *nvl, const char *opts)
87 {
88 
89 	if (opts != NULL)
90 		set_config_value_node(nvl, "path", opts);
91 	return (0);
92 }
93 
94 static int
95 pci_uart_init(struct pci_devinst *pi, nvlist_t *nvl)
96 {
97 	struct uart_ns16550_softc *sc;
98 	const char *device;
99 
100 	pci_emul_alloc_bar(pi, 0, PCIBAR_IO, UART_NS16550_IO_BAR_SIZE);
101 	pci_lintr_request(pi);
102 
103 	/* initialize config space */
104 	pci_set_cfgdata16(pi, PCIR_DEVICE, COM_DEV);
105 	pci_set_cfgdata16(pi, PCIR_VENDOR, COM_VENDOR);
106 	pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
107 
108 	sc = uart_ns16550_init(pci_uart_intr_assert, pci_uart_intr_deassert,
109 	    pi);
110 	pi->pi_arg = sc;
111 
112 	device = get_config_value_node(nvl, "path");
113 	if (device != NULL && uart_ns16550_tty_open(sc, device) != 0) {
114 		EPRINTLN("Unable to initialize backend '%s' for "
115 		    "pci uart at %d:%d", device, pi->pi_slot, pi->pi_func);
116 		return (-1);
117 	}
118 
119 	return (0);
120 }
121 
122 static const struct pci_devemu pci_de_com = {
123 	.pe_emu =	"uart",
124 	.pe_init =	pci_uart_init,
125 	.pe_legacy_config = pci_uart_legacy_config,
126 	.pe_barwrite =	pci_uart_write,
127 	.pe_barread =	pci_uart_read
128 };
129 PCI_EMUL_SET(pci_de_com);
130