xref: /freebsd/usr.sbin/bhyve/pci_uart.c (revision 27c43fe1f3795622c5bd4bbfc465a29a800c0799)
1 /*-
2  * Copyright (c) 2012 NetApp, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/types.h>
33 
34 #include <stdio.h>
35 
36 #include "bhyverun.h"
37 #include "pci_emul.h"
38 #include "uart_emul.h"
39 
40 /*
41  * Pick a PCI vid/did of a chip with a single uart at
42  * BAR0, that most versions of FreeBSD can understand:
43  * Siig CyberSerial 1-port.
44  */
45 #define COM_VENDOR	0x131f
46 #define COM_DEV		0x2000
47 
48 static void
49 pci_uart_intr_assert(void *arg)
50 {
51 	struct pci_devinst *pi = arg;
52 
53 	pci_lintr_assert(pi);
54 }
55 
56 static void
57 pci_uart_intr_deassert(void *arg)
58 {
59 	struct pci_devinst *pi = arg;
60 
61 	pci_lintr_deassert(pi);
62 }
63 
64 static void
65 pci_uart_write(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
66 	       int baridx, uint64_t offset, int size, uint64_t value)
67 {
68 
69 	assert(baridx == 0);
70 	assert(size == 1);
71 
72 	uart_write(pi->pi_arg, offset, value);
73 }
74 
75 uint64_t
76 pci_uart_read(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
77 	      int baridx, uint64_t offset, int size)
78 {
79 	uint8_t val;
80 
81 	assert(baridx == 0);
82 	assert(size == 1);
83 
84 	val = uart_read(pi->pi_arg, offset);
85 	return (val);
86 }
87 
88 static int
89 pci_uart_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
90 {
91 	struct uart_softc *sc;
92 
93 	pci_emul_alloc_bar(pi, 0, PCIBAR_IO, UART_IO_BAR_SIZE);
94 	pci_lintr_request(pi);
95 
96 	/* initialize config space */
97 	pci_set_cfgdata16(pi, PCIR_DEVICE, COM_DEV);
98 	pci_set_cfgdata16(pi, PCIR_VENDOR, COM_VENDOR);
99 	pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
100 
101 	sc = uart_init(pci_uart_intr_assert, pci_uart_intr_deassert, pi);
102 	pi->pi_arg = sc;
103 
104 	if (uart_set_backend(sc, opts) != 0) {
105 		fprintf(stderr, "Unable to initialize backend '%s' for "
106 		    "pci uart at %d:%d\n", opts, pi->pi_slot, pi->pi_func);
107 		return (-1);
108 	}
109 
110 	return (0);
111 }
112 
113 struct pci_devemu pci_de_com = {
114 	.pe_emu =	"uart",
115 	.pe_init =	pci_uart_init,
116 	.pe_barwrite =	pci_uart_write,
117 	.pe_barread =	pci_uart_read
118 };
119 PCI_EMUL_SET(pci_de_com);
120