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 { 0, NULL } 73 }; 74 75 /* Device independent features. */ 76 static struct virtio_feature_desc virtio_common_feature_desc[] = { 77 { VIRTIO_F_NOTIFY_ON_EMPTY, "NotifyOnEmpty" }, 78 { VIRTIO_RING_F_INDIRECT_DESC, "RingIndirect" }, 79 { VIRTIO_RING_F_EVENT_IDX, "EventIdx" }, 80 { VIRTIO_F_BAD_FEATURE, "BadFeature" }, 81 { VIRTIO_F_VERSION_1, "Version1" }, 82 { 0, NULL } 83 }; 84 85 const char * 86 virtio_device_name(uint16_t devid) 87 { 88 struct virtio_ident *ident; 89 90 for (ident = virtio_ident_table; ident->name != NULL; ident++) { 91 if (ident->devid == devid) 92 return (ident->name); 93 } 94 95 return (NULL); 96 } 97 98 static const char * 99 virtio_feature_name(uint64_t val, struct virtio_feature_desc *desc) 100 { 101 int i, j; 102 struct virtio_feature_desc *descs[2] = { desc, 103 virtio_common_feature_desc }; 104 105 for (i = 0; i < 2; i++) { 106 if (descs[i] == NULL) 107 continue; 108 109 for (j = 0; descs[i][j].vfd_val != 0; j++) { 110 if (val == descs[i][j].vfd_val) 111 return (descs[i][j].vfd_str); 112 } 113 } 114 115 return (NULL); 116 } 117 118 void 119 virtio_describe(device_t dev, const char *msg, 120 uint64_t features, struct virtio_feature_desc *desc) 121 { 122 struct sbuf sb; 123 uint64_t val; 124 char *buf; 125 const char *name; 126 int n; 127 128 if ((buf = malloc(512, M_TEMP, M_NOWAIT)) == NULL) { 129 device_printf(dev, "%s features: %#jx\n", msg, (uintmax_t) features); 130 return; 131 } 132 133 sbuf_new(&sb, buf, 512, SBUF_FIXEDLEN); 134 sbuf_printf(&sb, "%s features: %#jx", msg, (uintmax_t) features); 135 136 for (n = 0, val = 1ULL << 63; val != 0; val >>= 1) { 137 /* 138 * BAD_FEATURE is used to detect broken Linux clients 139 * and therefore is not applicable to FreeBSD. 140 */ 141 if (((features & val) == 0) || val == VIRTIO_F_BAD_FEATURE) 142 continue; 143 144 if (n++ == 0) 145 sbuf_cat(&sb, " <"); 146 else 147 sbuf_cat(&sb, ","); 148 149 name = virtio_feature_name(val, desc); 150 if (name == NULL) 151 sbuf_printf(&sb, "%#jx", (uintmax_t) val); 152 else 153 sbuf_cat(&sb, name); 154 } 155 156 if (n > 0) 157 sbuf_cat(&sb, ">"); 158 159 if (sbuf_finish(&sb) == 0) 160 device_printf(dev, "%s\n", sbuf_data(&sb)); 161 162 sbuf_delete(&sb); 163 free(buf, M_TEMP); 164 } 165 166 /* 167 * VirtIO bus method wrappers. 168 */ 169 170 void 171 virtio_read_ivar(device_t dev, int ivar, uintptr_t *val) 172 { 173 174 *val = -1; 175 BUS_READ_IVAR(device_get_parent(dev), dev, ivar, val); 176 } 177 178 void 179 virtio_write_ivar(device_t dev, int ivar, uintptr_t val) 180 { 181 182 BUS_WRITE_IVAR(device_get_parent(dev), dev, ivar, val); 183 } 184 185 uint64_t 186 virtio_negotiate_features(device_t dev, uint64_t child_features) 187 { 188 189 return (VIRTIO_BUS_NEGOTIATE_FEATURES(device_get_parent(dev), 190 child_features)); 191 } 192 193 int 194 virtio_alloc_virtqueues(device_t dev, int flags, int nvqs, 195 struct vq_alloc_info *info) 196 { 197 198 return (VIRTIO_BUS_ALLOC_VIRTQUEUES(device_get_parent(dev), flags, 199 nvqs, info)); 200 } 201 202 int 203 virtio_setup_intr(device_t dev, enum intr_type type) 204 { 205 206 return (VIRTIO_BUS_SETUP_INTR(device_get_parent(dev), type)); 207 } 208 209 int 210 virtio_with_feature(device_t dev, uint64_t feature) 211 { 212 213 return (VIRTIO_BUS_WITH_FEATURE(device_get_parent(dev), feature)); 214 } 215 216 void 217 virtio_stop(device_t dev) 218 { 219 220 VIRTIO_BUS_STOP(device_get_parent(dev)); 221 } 222 223 int 224 virtio_reinit(device_t dev, uint64_t features) 225 { 226 227 return (VIRTIO_BUS_REINIT(device_get_parent(dev), features)); 228 } 229 230 void 231 virtio_reinit_complete(device_t dev) 232 { 233 234 VIRTIO_BUS_REINIT_COMPLETE(device_get_parent(dev)); 235 } 236 237 int 238 virtio_config_generation(device_t dev) 239 { 240 241 return (VIRTIO_BUS_CONFIG_GENERATION(device_get_parent(dev))); 242 } 243 244 void 245 virtio_read_device_config(device_t dev, bus_size_t offset, void *dst, int len) 246 { 247 248 VIRTIO_BUS_READ_DEVICE_CONFIG(device_get_parent(dev), 249 offset, dst, len); 250 } 251 252 void 253 virtio_write_device_config(device_t dev, bus_size_t offset, void *dst, int len) 254 { 255 256 VIRTIO_BUS_WRITE_DEVICE_CONFIG(device_get_parent(dev), 257 offset, dst, len); 258 } 259 260 int 261 virtio_child_pnpinfo_str(device_t busdev __unused, device_t child, char *buf, 262 size_t buflen) 263 { 264 265 /* 266 * All of these PCI fields will be only 16 bits, but on the vtmmio bus 267 * the corresponding fields (only "vendor" and "device_type") are 32 268 * bits. Many virtio drivers can attach below either bus. 269 * Gratuitously expand these two fields to 32-bits to allow sharing PNP 270 * match table data between the mostly-similar buses. 271 * 272 * Subdevice and device_type are redundant in both buses, so I don't 273 * see a lot of PNP utility in exposing the same value under a 274 * different name. 275 */ 276 snprintf(buf, buflen, "vendor=0x%08x device=0x%04x subvendor=0x%04x " 277 "device_type=0x%08x", (unsigned)virtio_get_vendor(child), 278 (unsigned)virtio_get_device(child), 279 (unsigned)virtio_get_subvendor(child), 280 (unsigned)virtio_get_device_type(child)); 281 return (0); 282 } 283 284 static int 285 virtio_modevent(module_t mod, int type, void *unused) 286 { 287 int error; 288 289 switch (type) { 290 case MOD_LOAD: 291 case MOD_QUIESCE: 292 case MOD_UNLOAD: 293 case MOD_SHUTDOWN: 294 error = 0; 295 break; 296 default: 297 error = EOPNOTSUPP; 298 break; 299 } 300 301 return (error); 302 } 303 304 static moduledata_t virtio_mod = { 305 "virtio", 306 virtio_modevent, 307 0 308 }; 309 310 DECLARE_MODULE(virtio, virtio_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 311 MODULE_VERSION(virtio, 1); 312