usr.sbin/bhyve/pci_uart.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   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
  29 #include <sys/cdefs.h>
  30 #include <sys/types.h>
  31
  32 #include <stdio.h>
  33
  34 #include "bhyverun.h"
  35 #include "config.h"
  36 #include "debug.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 pci_devinst *pi, int baridx, uint64_t offset, int size,
  66     uint64_t value)
  67 {
  68         assert(baridx == 0);
  69         assert(size == 1);
  70
  71         uart_write(pi->pi_arg, offset, value);
  72 }
  73
  74 static uint64_t
  75 pci_uart_read(struct pci_devinst *pi, int baridx, uint64_t offset, int size)
  76 {
  77         uint8_t val;
  78
  79         assert(baridx == 0);
  80         assert(size == 1);
  81
  82         val = uart_read(pi->pi_arg, offset);
  83         return (val);
  84 }
  85
  86 static int
  87 pci_uart_legacy_config(nvlist_t *nvl, const char *opts)
  88 {
  89
  90         if (opts != NULL)
  91                 set_config_value_node(nvl, "path", opts);
  92         return (0);
  93 }
  94
  95 static int
  96 pci_uart_init(struct pci_devinst *pi, nvlist_t *nvl)
  97 {
  98         struct uart_softc *sc;
  99         const char *device;
 100
 101         pci_emul_alloc_bar(pi, 0, PCIBAR_IO, UART_IO_BAR_SIZE);
 102         pci_lintr_request(pi);
 103
 104         /* initialize config space */
 105         pci_set_cfgdata16(pi, PCIR_DEVICE, COM_DEV);
 106         pci_set_cfgdata16(pi, PCIR_VENDOR, COM_VENDOR);
 107         pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
 108
 109         sc = uart_init(pci_uart_intr_assert, pci_uart_intr_deassert, pi);
 110         pi->pi_arg = sc;
 111
 112         device = get_config_value_node(nvl, "path");
 113         if (uart_set_backend(sc, device) != 0) {
 114                 EPRINTLN("Unable to initialize backend '%s' for "
 115                     "pci uart at %d:%d", device, pi->pi_slot, pi->pi_func);
 116                 return (-1);
 117         }
 118
 119         return (0);
 120 }
 121
 122 static const struct pci_devemu pci_de_com = {
 123         .pe_emu =       "uart",
 124         .pe_init =      pci_uart_init,
 125         .pe_legacy_config = pci_uart_legacy_config,
 126         .pe_barwrite =  pci_uart_write,
 127         .pe_barread =   pci_uart_read
 128 };
 129 PCI_EMUL_SET(pci_de_com);