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