xref: /freebsd/usr.sbin/bhyve/uart_backend.h (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 NetApp, Inc.
5  * Copyright (c) 2013 Neel Natu <neel@freebsd.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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.
16  *
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
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef _UART_BACKEND_H_
31 #define	_UART_BACKEND_H_
32 
33 #include <stdbool.h>
34 
35 #include "mevent.h"
36 
37 struct uart_softc;
38 struct vm_snapshot_meta;
39 
40 void	uart_rxfifo_drain(struct uart_softc *sc, bool loopback);
41 int	uart_rxfifo_getchar(struct uart_softc *sc);
42 int	uart_rxfifo_numchars(struct uart_softc *sc);
43 int	uart_rxfifo_putchar(struct uart_softc *sc, uint8_t ch, bool loopback);
44 void	uart_rxfifo_reset(struct uart_softc *sc, int size);
45 int	uart_rxfifo_size(struct uart_softc *sc);
46 #ifdef BHYVE_SNAPSHOT
47 int	uart_rxfifo_snapshot(struct uart_softc *sc,
48 	    struct vm_snapshot_meta *meta);
49 #endif
50 
51 struct uart_softc *uart_init(void);
52 int	uart_tty_open(struct uart_softc *sc, const char *path,
53 	    void (*drain)(int, enum ev_type, void *), void *arg);
54 void	uart_softc_lock(struct uart_softc *sc);
55 void	uart_softc_unlock(struct uart_softc *sc);
56 #endif /* _UART_BACKEND_H_ */
57