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/virtqueue.h,v 1.2 2012/04/14 05:48:04 grehan Exp $ 27 */ 28 29 #ifndef _VIRTIO_VIRTQUEUE_H 30 #define _VIRTIO_VIRTQUEUE_H 31 32 #include <sys/types.h> 33 #include <sys/serialize.h> 34 35 struct virtqueue; 36 struct sglist; 37 38 /* Support for indirect buffer descriptors. */ 39 #define VIRTIO_RING_F_INDIRECT_DESC (1 << 28) 40 41 /* The guest publishes the used index for which it expects an interrupt 42 * at the end of the avail ring. Host should ignore the avail->flags field. 43 * The host publishes the avail index for which it expects a kick 44 * at the end of the used ring. Guest should ignore the used->flags field. 45 */ 46 #define VIRTIO_RING_F_EVENT_IDX (1 << 29) 47 48 #define VIRTQUEUE_MAX_NAME_SZ 32 49 50 /* One for each virtqueue the device wishes to allocate. */ 51 struct vq_alloc_info { 52 char vqai_name[VIRTQUEUE_MAX_NAME_SZ]; 53 int vqai_maxindirsz; 54 struct virtqueue **vqai_vq; 55 }; 56 57 #define VQ_ALLOC_INFO_INIT(_i,_nsegs,_vqp,_str,...) do { \ 58 ksnprintf((_i)->vqai_name, VIRTQUEUE_MAX_NAME_SZ, _str, \ 59 ##__VA_ARGS__); \ 60 (_i)->vqai_maxindirsz = (_nsegs); \ 61 (_i)->vqai_vq = (_vqp); \ 62 } while (0) 63 64 uint64_t virtqueue_filter_features(uint64_t features); 65 66 int virtqueue_alloc(device_t dev, uint16_t queue, uint16_t size, 67 int align, vm_paddr_t highaddr, struct vq_alloc_info *info, 68 struct virtqueue **vqp); 69 void *virtqueue_drain(struct virtqueue *vq, int *last); 70 void virtqueue_free(struct virtqueue *vq); 71 int virtqueue_reinit(struct virtqueue *vq, uint16_t size); 72 73 int virtqueue_pending(struct virtqueue *vq); 74 int virtqueue_enable_intr(struct virtqueue *vq); 75 int virtqueue_postpone_intr(struct virtqueue *vq); 76 void virtqueue_disable_intr(struct virtqueue *vq); 77 78 /* Get physical address of the virtqueue ring. */ 79 vm_paddr_t virtqueue_paddr(struct virtqueue *vq); 80 81 int virtqueue_full(struct virtqueue *vq); 82 int virtqueue_empty(struct virtqueue *vq); 83 int virtqueue_size(struct virtqueue *vq); 84 int virtqueue_nused(struct virtqueue *vq); 85 void virtqueue_notify(struct virtqueue *vq, lwkt_serialize_t); 86 void virtqueue_dump(struct virtqueue *vq); 87 88 int virtqueue_enqueue(struct virtqueue *vq, void *cookie, 89 struct sglist *sg, int readable, int writable); 90 void *virtqueue_dequeue(struct virtqueue *vq, uint32_t *len); 91 void *virtqueue_poll(struct virtqueue *vq, uint32_t *len); 92 93 #endif /* _VIRTIO_VIRTQUEUE_H */ 94