sys/dev/virtio/virtio.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2011, Bryan Venteicher <bryanv@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 unmodified, this list of conditions, and the following
  12  *    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 THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/malloc.h>
  36 #include <sys/module.h>
  37 #include <sys/sbuf.h>
  38
  39 #include <machine/bus.h>
  40 #include <machine/resource.h>
  41 #include <sys/bus.h>
  42 #include <sys/rman.h>
  43
  44 #include <dev/virtio/virtio.h>
  45 #include <dev/virtio/virtio_config.h>
  46 #include <dev/virtio/virtqueue.h>
  47
  48 #include "virtio_bus_if.h"
  49
  50 static int virtio_modevent(module_t, int, void *);
  51 static const char *virtio_feature_name(uint64_t, struct virtio_feature_desc *);
  52
  53 static struct virtio_ident {
  54         uint16_t        devid;
  55         const char      *name;
  56 } virtio_ident_table[] = {
  57         { VIRTIO_ID_NETWORK,            "Network"                       },
  58         { VIRTIO_ID_BLOCK,              "Block"                         },
  59         { VIRTIO_ID_CONSOLE,            "Console"                       },
  60         { VIRTIO_ID_ENTROPY,            "Entropy"                       },
  61         { VIRTIO_ID_BALLOON,            "Balloon"                       },
  62         { VIRTIO_ID_IOMEMORY,           "IOMemory"                      },
  63         { VIRTIO_ID_RPMSG,              "Remote Processor Messaging"    },
  64         { VIRTIO_ID_SCSI,               "SCSI"                          },
  65         { VIRTIO_ID_9P,                 "9P Transport"                  },
  66         { VIRTIO_ID_RPROC_SERIAL,       "Remote Processor Serial"       },
  67         { VIRTIO_ID_CAIF,               "CAIF"                          },
  68         { VIRTIO_ID_GPU,                "GPU"                           },
  69         { VIRTIO_ID_INPUT,              "Input"                         },
  70         { VIRTIO_ID_VSOCK,              "VSOCK Transport"               },
  71         { VIRTIO_ID_CRYPTO,             "Crypto"                        },
  72
  73         { 0, NULL }
  74 };
  75
  76 /* Device independent features. */
  77 static struct virtio_feature_desc virtio_common_feature_desc[] = {
  78         { VIRTIO_F_NOTIFY_ON_EMPTY,     "NotifyOnEmpty" },
  79         { VIRTIO_RING_F_INDIRECT_DESC,  "RingIndirect"  },
  80         { VIRTIO_RING_F_EVENT_IDX,      "EventIdx"      },
  81         { VIRTIO_F_BAD_FEATURE,         "BadFeature"    },
  82         { VIRTIO_F_VERSION_1,           "Version1"      },
  83
  84         { 0, NULL }
  85 };
  86
  87 const char *
  88 virtio_device_name(uint16_t devid)
  89 {
  90         struct virtio_ident *ident;
  91
  92         for (ident = virtio_ident_table; ident->name != NULL; ident++) {
  93                 if (ident->devid == devid)
  94                         return (ident->name);
  95         }
  96
  97         return (NULL);
  98 }
  99
 100 static const char *
 101 virtio_feature_name(uint64_t val, struct virtio_feature_desc *desc)
 102 {
 103         int i, j;
 104         struct virtio_feature_desc *descs[2] = { desc,
 105             virtio_common_feature_desc };
 106
 107         for (i = 0; i < 2; i++) {
 108                 if (descs[i] == NULL)
 109                         continue;
 110
 111                 for (j = 0; descs[i][j].vfd_val != 0; j++) {
 112                         if (val == descs[i][j].vfd_val)
 113                                 return (descs[i][j].vfd_str);
 114                 }
 115         }
 116
 117         return (NULL);
 118 }
 119
 120 void
 121 virtio_describe(device_t dev, const char *msg,
 122     uint64_t features, struct virtio_feature_desc *desc)
 123 {
 124         struct sbuf sb;
 125         uint64_t val;
 126         char *buf;
 127         const char *name;
 128         int n;
 129
 130         if ((buf = malloc(512, M_TEMP, M_NOWAIT)) == NULL) {
 131                 device_printf(dev, "%s features: %#jx\n", msg, (uintmax_t) features);
 132                 return;
 133         }
 134
 135         sbuf_new(&sb, buf, 512, SBUF_FIXEDLEN);
 136         sbuf_printf(&sb, "%s features: %#jx", msg, (uintmax_t) features);
 137
 138         for (n = 0, val = 1ULL << 63; val != 0; val >>= 1) {
 139                 /*
 140                  * BAD_FEATURE is used to detect broken Linux clients
 141                  * and therefore is not applicable to FreeBSD.
 142                  */
 143                 if (((features & val) == 0) || val == VIRTIO_F_BAD_FEATURE)
 144                         continue;
 145
 146                 if (n++ == 0)
 147                         sbuf_cat(&sb, " <");
 148                 else
 149                         sbuf_cat(&sb, ",");
 150
 151                 name = virtio_feature_name(val, desc);
 152                 if (name == NULL)
 153                         sbuf_printf(&sb, "%#jx", (uintmax_t) val);
 154                 else
 155                         sbuf_cat(&sb, name);
 156         }
 157
 158         if (n > 0)
 159                 sbuf_cat(&sb, ">");
 160
 161         if (sbuf_finish(&sb) == 0)
 162                 device_printf(dev, "%s\n", sbuf_data(&sb));
 163
 164         sbuf_delete(&sb);
 165         free(buf, M_TEMP);
 166 }
 167
 168 /*
 169  * VirtIO bus method wrappers.
 170  */
 171
 172 void
 173 virtio_read_ivar(device_t dev, int ivar, uintptr_t *val)
 174 {
 175
 176         *val = -1;
 177         BUS_READ_IVAR(device_get_parent(dev), dev, ivar, val);
 178 }
 179
 180 void
 181 virtio_write_ivar(device_t dev, int ivar, uintptr_t val)
 182 {
 183
 184         BUS_WRITE_IVAR(device_get_parent(dev), dev, ivar, val);
 185 }
 186
 187 uint64_t
 188 virtio_negotiate_features(device_t dev, uint64_t child_features)
 189 {
 190
 191         return (VIRTIO_BUS_NEGOTIATE_FEATURES(device_get_parent(dev),
 192             child_features));
 193 }
 194
 195 int
 196 virtio_alloc_virtqueues(device_t dev, int flags, int nvqs,
 197     struct vq_alloc_info *info)
 198 {
 199
 200         return (VIRTIO_BUS_ALLOC_VIRTQUEUES(device_get_parent(dev), flags,
 201             nvqs, info));
 202 }
 203
 204 int
 205 virtio_setup_intr(device_t dev, enum intr_type type)
 206 {
 207
 208         return (VIRTIO_BUS_SETUP_INTR(device_get_parent(dev), type));
 209 }
 210
 211 int
 212 virtio_with_feature(device_t dev, uint64_t feature)
 213 {
 214
 215         return (VIRTIO_BUS_WITH_FEATURE(device_get_parent(dev), feature));
 216 }
 217
 218 void
 219 virtio_stop(device_t dev)
 220 {
 221
 222         VIRTIO_BUS_STOP(device_get_parent(dev));
 223 }
 224
 225 int
 226 virtio_reinit(device_t dev, uint64_t features)
 227 {
 228
 229         return (VIRTIO_BUS_REINIT(device_get_parent(dev), features));
 230 }
 231
 232 void
 233 virtio_reinit_complete(device_t dev)
 234 {
 235
 236         VIRTIO_BUS_REINIT_COMPLETE(device_get_parent(dev));
 237 }
 238
 239 int
 240 virtio_config_generation(device_t dev)
 241 {
 242
 243         return (VIRTIO_BUS_CONFIG_GENERATION(device_get_parent(dev)));
 244 }
 245
 246 void
 247 virtio_read_device_config(device_t dev, bus_size_t offset, void *dst, int len)
 248 {
 249
 250         VIRTIO_BUS_READ_DEVICE_CONFIG(device_get_parent(dev),
 251             offset, dst, len);
 252 }
 253
 254 void
 255 virtio_write_device_config(device_t dev, bus_size_t offset, void *dst, int len)
 256 {
 257
 258         VIRTIO_BUS_WRITE_DEVICE_CONFIG(device_get_parent(dev),
 259             offset, dst, len);
 260 }
 261
 262 int
 263 virtio_child_pnpinfo_str(device_t busdev __unused, device_t child, char *buf,
 264     size_t buflen)
 265 {
 266
 267         /*
 268          * All of these PCI fields will be only 16 bits, but on the vtmmio bus
 269          * the corresponding fields (only "vendor" and "device_type") are 32
 270          * bits.  Many virtio drivers can attach below either bus.
 271          * Gratuitously expand these two fields to 32-bits to allow sharing PNP
 272          * match table data between the mostly-similar buses.
 273          *
 274          * Subdevice and device_type are redundant in both buses, so I don't
 275          * see a lot of PNP utility in exposing the same value under a
 276          * different name.
 277          */
 278         snprintf(buf, buflen, "vendor=0x%08x device=0x%04x subvendor=0x%04x "
 279             "device_type=0x%08x", (unsigned)virtio_get_vendor(child),
 280             (unsigned)virtio_get_device(child),
 281             (unsigned)virtio_get_subvendor(child),
 282             (unsigned)virtio_get_device_type(child));
 283         return (0);
 284 }
 285
 286 static int
 287 virtio_modevent(module_t mod, int type, void *unused)
 288 {
 289         int error;
 290
 291         switch (type) {
 292         case MOD_LOAD:
 293         case MOD_QUIESCE:
 294         case MOD_UNLOAD:
 295         case MOD_SHUTDOWN:
 296                 error = 0;
 297                 break;
 298         default:
 299                 error = EOPNOTSUPP;
 300                 break;
 301         }
 302
 303         return (error);
 304 }
 305
 306 static moduledata_t virtio_mod = {
 307         "virtio",
 308         virtio_modevent,
 309         0
 310 };
 311
 312 DECLARE_MODULE(virtio, virtio_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
 313 MODULE_VERSION(virtio, 1);