xref: /freebsd/usr.sbin/bhyve/pci_uart.c (revision 68d75eff68281c1b445e3010bb975eae07aac225)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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  * $FreeBSD$
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include <sys/types.h>
35 
36 #include <stdio.h>
37 
38 #include "bhyverun.h"
39 #include "debug.h"
40 #include "pci_emul.h"
41 #include "uart_emul.h"
42 
43 /*
44  * Pick a PCI vid/did of a chip with a single uart at
45  * BAR0, that most versions of FreeBSD can understand:
46  * Siig CyberSerial 1-port.
47  */
48 #define COM_VENDOR	0x131f
49 #define COM_DEV		0x2000
50 
51 static void
52 pci_uart_intr_assert(void *arg)
53 {
54 	struct pci_devinst *pi = arg;
55 
56 	pci_lintr_assert(pi);
57 }
58 
59 static void
60 pci_uart_intr_deassert(void *arg)
61 {
62 	struct pci_devinst *pi = arg;
63 
64 	pci_lintr_deassert(pi);
65 }
66 
67 static void
68 pci_uart_write(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
69 	       int baridx, uint64_t offset, int size, uint64_t value)
70 {
71 
72 	assert(baridx == 0);
73 	assert(size == 1);
74 
75 	uart_write(pi->pi_arg, offset, value);
76 }
77 
78 uint64_t
79 pci_uart_read(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
80 	      int baridx, uint64_t offset, int size)
81 {
82 	uint8_t val;
83 
84 	assert(baridx == 0);
85 	assert(size == 1);
86 
87 	val = uart_read(pi->pi_arg, offset);
88 	return (val);
89 }
90 
91 static int
92 pci_uart_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
93 {
94 	struct uart_softc *sc;
95 
96 	pci_emul_alloc_bar(pi, 0, PCIBAR_IO, UART_IO_BAR_SIZE);
97 	pci_lintr_request(pi);
98 
99 	/* initialize config space */
100 	pci_set_cfgdata16(pi, PCIR_DEVICE, COM_DEV);
101 	pci_set_cfgdata16(pi, PCIR_VENDOR, COM_VENDOR);
102 	pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
103 
104 	sc = uart_init(pci_uart_intr_assert, pci_uart_intr_deassert, pi);
105 	pi->pi_arg = sc;
106 
107 	if (uart_set_backend(sc, opts) != 0) {
108 		EPRINTLN("Unable to initialize backend '%s' for "
109 		    "pci uart at %d:%d", opts, pi->pi_slot, pi->pi_func);
110 		return (-1);
111 	}
112 
113 	return (0);
114 }
115 
116 struct pci_devemu pci_de_com = {
117 	.pe_emu =	"uart",
118 	.pe_init =	pci_uart_init,
119 	.pe_barwrite =	pci_uart_write,
120 	.pe_barread =	pci_uart_read
121 };
122 PCI_EMUL_SET(pci_de_com);
123