1 /*- 2 * Copyright (c) 2011, Bryan Venteicher <bryanv@daemoninthecloset.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD: src/sys/dev/virtio/virtio.c,v 1.1 2011/11/18 05:43:43 grehan Exp $ 27 */ 28 29 #include <sys/param.h> 30 #include <sys/systm.h> 31 #include <sys/kernel.h> 32 #include <sys/malloc.h> 33 #include <sys/module.h> 34 #include <sys/sbuf.h> 35 36 #include <machine/inttypes.h> 37 #include <sys/bus.h> 38 #include <sys/serialize.h> 39 #include <sys/rman.h> 40 41 #include "virtio.h" 42 #include "virtqueue.h" 43 44 #include "virtio_if.h" 45 #include "virtio_bus_if.h" 46 47 static int virtio_modevent(module_t, int, void *); 48 static const char *virtio_feature_name(uint64_t, struct virtio_feature_desc *); 49 50 static struct virtio_ident { 51 uint16_t devid; 52 const char *name; 53 } virtio_ident_table[] = { 54 { VIRTIO_ID_NETWORK, "Network" }, 55 { VIRTIO_ID_BLOCK, "Block" }, 56 { VIRTIO_ID_CONSOLE, "Console" }, 57 { VIRTIO_ID_ENTROPY, "Entropy" }, 58 { VIRTIO_ID_BALLOON, "Balloon" }, 59 { VIRTIO_ID_IOMEMORY, "IOMemory" }, 60 { VIRTIO_ID_9P, "9P Transport" }, 61 62 { 0, NULL } 63 }; 64 65 /* Device independent features. */ 66 static struct virtio_feature_desc virtio_common_feature_desc[] = { 67 { VIRTIO_F_NOTIFY_ON_EMPTY, "NotifyOnEmpty" }, 68 { VIRTIO_F_ANY_LAYOUT, "AnyLayout" }, 69 { VIRTIO_RING_F_INDIRECT_DESC, "RingIndirect" }, 70 { VIRTIO_RING_F_EVENT_IDX, "EventIdx" }, 71 { VIRTIO_F_BAD_FEATURE, "BadFeature" }, 72 73 { 0, NULL } 74 }; 75 76 const char * 77 virtio_device_name(uint16_t devid) 78 { 79 struct virtio_ident *ident; 80 81 for (ident = virtio_ident_table; ident->name != NULL; ident++) { 82 if (ident->devid == devid) 83 return (ident->name); 84 } 85 86 return (NULL); 87 } 88 89 int 90 virtio_get_device_type(device_t dev) 91 { 92 uintptr_t devtype; 93 94 devtype = -1; 95 96 BUS_READ_IVAR(device_get_parent(dev), dev, 97 VIRTIO_IVAR_DEVTYPE, &devtype); 98 99 return ((int) devtype); 100 } 101 102 void 103 virtio_set_feature_desc(device_t dev, 104 struct virtio_feature_desc *feature_desc) 105 { 106 107 BUS_WRITE_IVAR(device_get_parent(dev), dev, 108 VIRTIO_IVAR_FEATURE_DESC, (uintptr_t) feature_desc); 109 } 110 111 void 112 virtio_describe(device_t dev, const char *msg, 113 uint64_t features, struct virtio_feature_desc *desc) 114 { 115 struct sbuf sb; 116 uint64_t val; 117 char *buf; 118 const char *name; 119 int n; 120 121 if ((buf = kmalloc(512, M_TEMP, M_NOWAIT)) == NULL) { 122 device_printf(dev, "%s features: 0x%"PRIx64"\n", msg, 123 features); 124 return; 125 } 126 127 sbuf_new(&sb, buf, 512, SBUF_FIXEDLEN); 128 sbuf_printf(&sb, "%s features: 0x%"PRIx64, msg, features); 129 130 for (n = 0, val = 1ULL << 63; val != 0; val >>= 1) { 131 /* 132 * BAD_FEATURE is used to detect broken Linux clients 133 * and therefore is not applicable to FreeBSD. 134 */ 135 if (((features & val) == 0) || val == VIRTIO_F_BAD_FEATURE) 136 continue; 137 138 if (n++ == 0) 139 sbuf_cat(&sb, " <"); 140 else 141 sbuf_cat(&sb, ","); 142 143 name = virtio_feature_name(val, desc); 144 if (name == NULL) 145 sbuf_printf(&sb, "%#jx", (uintmax_t) val); 146 else 147 sbuf_cat(&sb, name); 148 } 149 150 if (n > 0) 151 sbuf_cat(&sb, ">"); 152 153 if (sbuf_finish(&sb) == 0) 154 device_printf(dev, "%s\n", sbuf_data(&sb)); 155 156 sbuf_delete(&sb); 157 kfree(buf, M_TEMP); 158 } 159 160 static const char * 161 virtio_feature_name(uint64_t val, struct virtio_feature_desc *desc) 162 { 163 int i, j; 164 struct virtio_feature_desc *descs[2] = { desc, 165 virtio_common_feature_desc }; 166 167 for (i = 0; i < 2; i++) { 168 if (descs[i] == NULL) 169 continue; 170 171 for (j = 0; descs[i][j].vfd_val != 0; j++) { 172 if (val == descs[i][j].vfd_val) 173 return (descs[i][j].vfd_str); 174 } 175 } 176 177 return (NULL); 178 } 179 180 /* 181 * VirtIO bus method wrappers. 182 */ 183 184 uint64_t 185 virtio_negotiate_features(device_t dev, uint64_t child_features) 186 { 187 return (VIRTIO_BUS_NEGOTIATE_FEATURES(device_get_parent(dev), 188 child_features)); 189 } 190 191 int 192 virtio_alloc_virtqueues(device_t dev, int flags, int nvqs, 193 struct vq_alloc_info *info) 194 { 195 return (VIRTIO_BUS_ALLOC_VIRTQUEUES(device_get_parent(dev), flags, 196 nvqs, info)); 197 } 198 199 int 200 virtio_setup_intr(device_t dev, lwkt_serialize_t slz) 201 { 202 return (VIRTIO_BUS_SETUP_INTR(device_get_parent(dev), slz)); 203 } 204 205 int 206 virtio_with_feature(device_t dev, uint64_t feature) 207 { 208 return (VIRTIO_BUS_WITH_FEATURE(device_get_parent(dev), feature)); 209 } 210 211 void 212 virtio_stop(device_t dev) 213 { 214 VIRTIO_BUS_STOP(device_get_parent(dev)); 215 } 216 217 int 218 virtio_reinit(device_t dev, uint64_t features) 219 { 220 return (VIRTIO_BUS_REINIT(device_get_parent(dev), features)); 221 } 222 223 void 224 virtio_reinit_complete(device_t dev) 225 { 226 VIRTIO_BUS_REINIT_COMPLETE(device_get_parent(dev)); 227 } 228 229 void 230 virtio_read_device_config(device_t dev, bus_size_t offset, void *dst, int len) 231 { 232 VIRTIO_BUS_READ_DEVICE_CONFIG(device_get_parent(dev), 233 offset, dst, len); 234 } 235 236 void 237 virtio_write_device_config(device_t dev, bus_size_t offset, void *dst, int len) 238 { 239 VIRTIO_BUS_WRITE_DEVICE_CONFIG(device_get_parent(dev), 240 offset, dst, len); 241 } 242 243 static int 244 virtio_modevent(module_t mod, int type, void *unused) 245 { 246 int error; 247 248 error = 0; 249 250 switch (type) { 251 case MOD_LOAD: 252 case MOD_UNLOAD: 253 case MOD_SHUTDOWN: 254 break; 255 default: 256 error = EOPNOTSUPP; 257 break; 258 } 259 260 return (error); 261 } 262 263 static moduledata_t virtio_mod = { 264 "virtio", 265 virtio_modevent, 266 0 267 }; 268 269 DECLARE_MODULE(virtio, virtio_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 270 MODULE_VERSION(virtio, 1); 271