usr.sbin/bhyve/uart_emul.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * $FreeBSD$
  29  */
  30
  31 #ifndef _UART_EMUL_H_
  32 #define _UART_EMUL_H_
  33
  34 #define UART_IO_BAR_SIZE        8
  35
  36 struct uart_softc;
  37 struct vm_snapshot_meta;
  38
  39 typedef void (*uart_intr_func_t)(void *arg);
  40 struct uart_softc *uart_init(uart_intr_func_t intr_assert,
  41                 uart_intr_func_t intr_deassert, void *arg);
  42
  43 int     uart_legacy_alloc(int unit, int *ioaddr, int *irq);
  44 uint8_t uart_read(struct uart_softc *sc, int offset);
  45 void    uart_write(struct uart_softc *sc, int offset, uint8_t value);
  46 int     uart_set_backend(struct uart_softc *sc, const char *opt);
  47 #ifdef BHYVE_SNAPSHOT
  48 int     uart_snapshot(struct uart_softc *sc, struct vm_snapshot_meta *meta);
  49 #endif
  50 #endif