xref: /freebsd/sys/dev/beri/virtio/virtio.h (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1 /*-
2  * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
3  * All rights reserved.
4  *
5  * This software was developed by SRI International and the University of
6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7  * ("CTSRD"), as part of the DARPA CRASH research programme.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #define READ2(_sc, _reg) \
32 	bus_read_2((_sc)->res[0], _reg)
33 #define READ4(_sc, _reg) \
34 	bus_read_4((_sc)->res[0], _reg)
35 #define WRITE2(_sc, _reg, _val) \
36 	bus_write_2((_sc)->res[0], _reg, _val)
37 #define WRITE4(_sc, _reg, _val) \
38 	bus_write_4((_sc)->res[0], _reg, _val)
39 
40 #define	PAGE_SHIFT		12
41 #define	VRING_ALIGN		4096
42 
43 #define	VQ_ALLOC		0x01	/* set once we have a pfn */
44 #define	VQ_MAX_DESCRIPTORS	512
45 
46 struct vqueue_info {
47 	uint16_t vq_qsize;	/* size of this queue (a power of 2) */
48 	uint16_t vq_num;
49 	uint16_t vq_flags;
50 	uint16_t vq_last_avail;	/* a recent value of vq_avail->va_idx */
51 	uint16_t vq_save_used;	/* saved vq_used->vu_idx; see vq_endchains */
52 	uint32_t vq_pfn;	/* PFN of virt queue (not shifted!) */
53 
54 	volatile struct vring_desc *vq_desc;	/* descriptor array */
55 	volatile struct vring_avail *vq_avail;	/* the "avail" ring */
56 	volatile struct vring_used *vq_used;	/* the "used" ring */
57 };
58 
59 int vq_ring_ready(struct vqueue_info *vq);
60 int vq_has_descs(struct vqueue_info *vq);
61 void * paddr_map(uint32_t offset, uint32_t phys, uint32_t size);
62 void paddr_unmap(void *phys, uint32_t size);
63 int vq_getchain(uint32_t beri_mem_offset, struct vqueue_info *vq,
64 		struct iovec *iov, int n_iov, uint16_t *flags);
65 void vq_relchain(struct vqueue_info *vq, struct iovec *iov, int n, uint32_t iolen);
66 struct iovec * getcopy(struct iovec *iov, int n);
67 
68 int setup_pio(device_t dev, char *name, device_t *pio_dev);
69 int setup_offset(device_t dev, uint32_t *offset);
70