1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2013 Neel Natu <neel@freebsd.org>
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#ifndef _UART_EMUL_H_
30#define	_UART_EMUL_H_
31
32#define	UART_NS16550_IO_BAR_SIZE	8
33
34struct uart_ns16550_softc;
35struct uart_pl011_softc;
36struct vm_snapshot_meta;
37
38typedef void (*uart_intr_func_t)(void *arg);
39
40int	uart_legacy_alloc(int unit, int *ioaddr, int *irq);
41
42struct uart_ns16550_softc *uart_ns16550_init(uart_intr_func_t intr_assert,
43	    uart_intr_func_t intr_deassert, void *arg);
44uint8_t	uart_ns16550_read(struct uart_ns16550_softc *sc, int offset);
45void	uart_ns16550_write(struct uart_ns16550_softc *sc, int offset,
46	    uint8_t value);
47int	uart_ns16550_tty_open(struct uart_ns16550_softc *sc,
48	    const char *device);
49#ifdef BHYVE_SNAPSHOT
50int	uart_ns16550_snapshot(struct uart_ns16550_softc *sc,
51	    struct vm_snapshot_meta *meta);
52#endif
53
54uint32_t uart_pl011_read(struct uart_pl011_softc *sc, int offset);
55void	uart_pl011_write(struct uart_pl011_softc *sc, int offset,
56	    uint32_t value);
57struct uart_pl011_softc *uart_pl011_init(uart_intr_func_t intr_assert,
58	    uart_intr_func_t intr_deassert, void *arg);
59int	uart_pl011_tty_open(struct uart_pl011_softc *sc, const char *device);
60
61#endif /* _UART_EMUL_H_ */
62