virtiovar.h revision 1.22
1 /* $NetBSD: virtiovar.h,v 1.22 2021/10/21 05:37:43 yamaguchi Exp $ */ 2 3 /* 4 * Copyright (c) 2010 Minoura Makoto. 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 THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 /* 29 * Part of the file derived from `Virtio PCI Card Specification v0.8.6 DRAFT' 30 * Appendix A. 31 */ 32 /* An interface for efficient virtio implementation. 33 * 34 * This header is BSD licensed so anyone can use the definitions 35 * to implement compatible drivers/servers. 36 * 37 * Copyright 2007, 2009, IBM Corporation 38 * All rights reserved. 39 * 40 * Redistribution and use in source and binary forms, with or without 41 * modification, are permitted provided that the following conditions 42 * are met: 43 * 1. Redistributions of source code must retain the above copyright 44 * notice, this list of conditions and the following disclaimer. 45 * 2. Redistributions in binary form must reproduce the above copyright 46 * notice, this list of conditions and the following disclaimer in the 47 * documentation and/or other materials provided with the distribution. 48 * 3. Neither the name of IBM nor the names of its contributors 49 * may be used to endorse or promote products derived from this software 50 * without specific prior written permission. 51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND 52 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 53 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 54 * ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE 55 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 56 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 57 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 58 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 59 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 60 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 61 * SUCH DAMAGE. 62 */ 63 64 65 #ifndef _DEV_PCI_VIRTIOVAR_H_ 66 #define _DEV_PCI_VIRTIOVAR_H_ 67 68 #include <sys/types.h> 69 #include <sys/queue.h> 70 #include <sys/bus.h> 71 #include <dev/pci/virtioreg.h> 72 73 74 struct vq_entry { 75 SIMPLEQ_ENTRY(vq_entry) qe_list; /* free list */ 76 uint16_t qe_index; /* index in vq_desc array */ 77 /* followings are used only when it is the `head' entry */ 78 int16_t qe_next; /* next enq slot */ 79 bool qe_indirect; /* 1 if using indirect */ 80 struct vring_desc *qe_desc_base; 81 }; 82 83 struct virtqueue { 84 struct virtio_softc *vq_owner; 85 unsigned int vq_num; /* queue size (# of entries) */ 86 int vq_index; /* queue number (0, 1, ...) */ 87 88 /* vring pointers (KVA) */ 89 struct vring_desc *vq_desc; 90 struct vring_avail *vq_avail; 91 struct vring_used *vq_used; 92 void *vq_indirect; 93 uint16_t *vq_used_event; /* trails avail */ 94 uint16_t *vq_avail_event; /* trails used */ 95 96 /* virtqueue allocation info */ 97 void *vq_vaddr; 98 int vq_availoffset; 99 int vq_usedoffset; 100 int vq_indirectoffset; 101 bus_dma_segment_t vq_segs[1]; 102 unsigned int vq_bytesize; 103 bus_dmamap_t vq_dmamap; 104 105 int vq_maxsegsize; 106 int vq_maxnsegs; 107 108 /* free entry management */ 109 struct vq_entry *vq_entries; 110 SIMPLEQ_HEAD(, vq_entry) vq_freelist; 111 kmutex_t vq_freelist_lock; 112 113 /* enqueue/dequeue status */ 114 uint16_t vq_avail_idx; 115 uint16_t vq_used_idx; 116 int vq_queued; 117 kmutex_t vq_aring_lock; 118 kmutex_t vq_uring_lock; 119 120 /* interrupt handler */ 121 int (*vq_done)(struct virtqueue*); 122 int (*vq_intrhand)(void *); 123 void *vq_intrhand_arg; 124 125 /* for 1.0 */ 126 uint32_t vq_notify_off; 127 }; 128 129 struct virtio_attach_args { 130 int sc_childdevid; 131 }; 132 133 typedef int (*virtio_callback)(struct virtio_softc*); 134 135 #ifdef VIRTIO_PRIVATE 136 struct virtio_ops { 137 void (*kick)(struct virtio_softc *, uint16_t); 138 uint16_t (*read_queue_size)(struct virtio_softc *, uint16_t); 139 void (*setup_queue)(struct virtio_softc *, uint16_t, uint64_t); 140 void (*set_status)(struct virtio_softc *, int); 141 void (*neg_features)(struct virtio_softc *, uint64_t); 142 int (*alloc_interrupts)(struct virtio_softc *); 143 void (*free_interrupts)(struct virtio_softc *); 144 int (*setup_interrupts)(struct virtio_softc *, int); 145 }; 146 147 struct virtio_softc { 148 device_t sc_dev; 149 const struct virtio_ops *sc_ops; 150 bus_dma_tag_t sc_dmat; 151 152 int sc_bus_endian; 153 int sc_struct_endian; 154 155 bus_space_tag_t sc_devcfg_iot; 156 bus_space_handle_t sc_devcfg_ioh; 157 bus_size_t sc_devcfg_iosize; 158 159 int sc_ipl; /* set by child */ 160 void *sc_soft_ih; 161 162 int sc_flags; /* set by child */ 163 164 uint64_t sc_active_features; 165 bool sc_indirect; 166 bool sc_version_1; 167 bool sc_finished_called; 168 169 int sc_nvqs; /* set by child */ 170 struct virtqueue *sc_vqs; /* set by child */ 171 172 int sc_childdevid; 173 device_t sc_child; /* set by child */ 174 bool sc_child_mq; 175 virtio_callback sc_config_change; /* set by child */ 176 virtio_callback sc_intrhand; /* set by child */ 177 }; 178 #else 179 struct virtio_softc; 180 #endif 181 182 183 /* interupt types, stored in virtio_softc->sc_flags */ 184 #define VIRTIO_F_INTR_MPSAFE (1 << 0) 185 #define VIRTIO_F_INTR_SOFTINT (1 << 1) 186 #define VIRTIO_F_INTR_MSIX (1 << 2) 187 188 189 #define VIRTIO_CHILD_FAILED ((void *)1) 190 191 /* public interface */ 192 void virtio_negotiate_features(struct virtio_softc*, uint64_t); 193 194 uint8_t virtio_read_device_config_1(struct virtio_softc *, int); 195 uint16_t virtio_read_device_config_2(struct virtio_softc *, int); 196 uint32_t virtio_read_device_config_4(struct virtio_softc *, int); 197 uint64_t virtio_read_device_config_8(struct virtio_softc *, int); 198 uint16_t virtio_read_device_config_le_2(struct virtio_softc *, int); 199 uint32_t virtio_read_device_config_le_4(struct virtio_softc *, int); 200 void virtio_write_device_config_1(struct virtio_softc *, int, uint8_t); 201 void virtio_write_device_config_2(struct virtio_softc *, int, uint16_t); 202 void virtio_write_device_config_4(struct virtio_softc *, int, uint32_t); 203 void virtio_write_device_config_8(struct virtio_softc *, int, uint64_t); 204 void virtio_write_device_config_le_2(struct virtio_softc *, int, uint16_t); 205 void virtio_write_device_config_le_4(struct virtio_softc *, int, uint32_t); 206 207 int virtio_alloc_vq(struct virtio_softc*, struct virtqueue*, int, int, int, 208 const char*); 209 int virtio_free_vq(struct virtio_softc*, struct virtqueue*); 210 void virtio_reset(struct virtio_softc *); 211 void virtio_reinit_start(struct virtio_softc *); 212 void virtio_reinit_end(struct virtio_softc *); 213 void virtio_child_attach_start(struct virtio_softc *, device_t, int, 214 struct virtqueue *, 215 virtio_callback, virtio_callback, int, 216 int, const char *); 217 void virtio_child_attach_set_vqs(struct virtio_softc *, 218 struct virtqueue *, int); 219 int virtio_child_attach_finish(struct virtio_softc *); 220 void virtio_child_attach_failed(struct virtio_softc *); 221 void virtio_child_detach(struct virtio_softc *); 222 223 int virtio_enqueue_prep(struct virtio_softc*, struct virtqueue*, int*); 224 int virtio_enqueue_reserve(struct virtio_softc*, struct virtqueue*, int, int); 225 int virtio_enqueue(struct virtio_softc*, struct virtqueue*, int, 226 bus_dmamap_t, bool); 227 int virtio_enqueue_p(struct virtio_softc*, struct virtqueue*, int, 228 bus_dmamap_t, bus_addr_t, bus_size_t, bool); 229 int virtio_enqueue_commit(struct virtio_softc*, struct virtqueue*, int, bool); 230 int virtio_enqueue_abort(struct virtio_softc*, struct virtqueue*, int); 231 232 int virtio_dequeue(struct virtio_softc*, struct virtqueue*, int *, int *); 233 int virtio_dequeue_commit(struct virtio_softc*, struct virtqueue*, int); 234 235 bool virtio_vq_is_enqueued(struct virtio_softc *, struct virtqueue *); 236 int virtio_vq_intr(struct virtio_softc *); 237 int virtio_vq_intrhand(struct virtio_softc *); 238 int virtio_postpone_intr(struct virtio_softc *sc, struct virtqueue *vq, 239 uint16_t nslots); 240 int virtio_postpone_intr_smart(struct virtio_softc *sc, struct virtqueue *vq); 241 int virtio_postpone_intr_far(struct virtio_softc *sc, struct virtqueue *vq); 242 void virtio_stop_vq_intr(struct virtio_softc *, struct virtqueue *); 243 int virtio_start_vq_intr(struct virtio_softc *, struct virtqueue *); 244 245 /* encapsulation */ 246 bus_dma_tag_t virtio_dmat(struct virtio_softc *); 247 device_t virtio_child(struct virtio_softc *); 248 int virtio_intrhand(struct virtio_softc *); 249 uint64_t virtio_features(struct virtio_softc *); 250 251 /* autoconf(9) common */ 252 void virtio_set_status(struct virtio_softc *, int); 253 void virtio_print_device_type(device_t, int, int); 254 int virtio_attach_failed(struct virtio_softc *); 255 256 #define virtio_device_reset(sc) virtio_set_status((sc), 0) 257 258 /* endian conversion */ 259 260 /* 261 * Virtio structures are read/written in host endian for 0.9 but little endian 262 * for 1.0. One notable exception is AArch BE that always uses little endian. 263 */ 264 uint16_t virtio_rw16(struct virtio_softc *sc, uint16_t val); 265 uint32_t virtio_rw32(struct virtio_softc *sc, uint32_t val); 266 uint64_t virtio_rw64(struct virtio_softc *sc, uint64_t val); 267 268 #endif /* _DEV_PCI_VIRTIOVAR_H_ */ 269
Indexes created Fri Sep 26 20:09:58 GMT 2025