usr.sbin/bhyve/pci_uart.c

   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 "config.h"
  40 #include "debug.h"
  41 #include "pci_emul.h"
  42 #include "uart_emul.h"
  43
  44 /*
  45  * Pick a PCI vid/did of a chip with a single uart at
  46  * BAR0, that most versions of FreeBSD can understand:
  47  * Siig CyberSerial 1-port.
  48  */
  49 #define COM_VENDOR      0x131f
  50 #define COM_DEV         0x2000
  51
  52 static void
  53 pci_uart_intr_assert(void *arg)
  54 {
  55         struct pci_devinst *pi = arg;
  56
  57         pci_lintr_assert(pi);
  58 }
  59
  60 static void
  61 pci_uart_intr_deassert(void *arg)
  62 {
  63         struct pci_devinst *pi = arg;
  64
  65         pci_lintr_deassert(pi);
  66 }
  67
  68 static void
  69 pci_uart_write(struct pci_devinst *pi, int baridx, uint64_t offset, int size,
  70     uint64_t value)
  71 {
  72         assert(baridx == 0);
  73         assert(size == 1);
  74
  75         uart_write(pi->pi_arg, offset, value);
  76 }
  77
  78 static uint64_t
  79 pci_uart_read(struct pci_devinst *pi, 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_legacy_config(nvlist_t *nvl, const char *opts)
  92 {
  93
  94         if (opts != NULL)
  95                 set_config_value_node(nvl, "path", opts);
  96         return (0);
  97 }
  98
  99 static int
 100 pci_uart_init(struct pci_devinst *pi, nvlist_t *nvl)
 101 {
 102         struct uart_softc *sc;
 103         const char *device;
 104
 105         pci_emul_alloc_bar(pi, 0, PCIBAR_IO, UART_IO_BAR_SIZE);
 106         pci_lintr_request(pi);
 107
 108         /* initialize config space */
 109         pci_set_cfgdata16(pi, PCIR_DEVICE, COM_DEV);
 110         pci_set_cfgdata16(pi, PCIR_VENDOR, COM_VENDOR);
 111         pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
 112
 113         sc = uart_init(pci_uart_intr_assert, pci_uart_intr_deassert, pi);
 114         pi->pi_arg = sc;
 115
 116         device = get_config_value_node(nvl, "path");
 117         if (uart_set_backend(sc, device) != 0) {
 118                 EPRINTLN("Unable to initialize backend '%s' for "
 119                     "pci uart at %d:%d", device, pi->pi_slot, pi->pi_func);
 120                 return (-1);
 121         }
 122
 123         return (0);
 124 }
 125
 126 static const struct pci_devemu pci_de_com = {
 127         .pe_emu =       "uart",
 128         .pe_init =      pci_uart_init,
 129         .pe_legacy_config = pci_uart_legacy_config,
 130         .pe_barwrite =  pci_uart_write,
 131         .pe_barread =   pci_uart_read
 132 };
 133 PCI_EMUL_SET(pci_de_com);