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