xref: /freebsd/sys/dev/virtio/mmio/virtio_mmio.h (revision cddbc3b40812213ff00041f79174cac0be360a2a)
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  * $FreeBSD$
31  */
32 
33 #ifndef	_VIRTIO_MMIO_H
34 #define	_VIRTIO_MMIO_H
35 
36 DECLARE_CLASS(vtmmio_driver);
37 
38 struct vtmmio_virtqueue;
39 
40 struct vtmmio_softc {
41 	device_t			dev;
42 	device_t			platform;
43 	struct resource			*res[2];
44 
45 	uint64_t			vtmmio_features;
46 	uint32_t			vtmmio_flags;
47 
48 	/* This "bus" will only ever have one child. */
49 	device_t			vtmmio_child_dev;
50 	struct virtio_feature_desc	*vtmmio_child_feat_desc;
51 
52 	int				vtmmio_nvqs;
53 	struct vtmmio_virtqueue		*vtmmio_vqs;
54 	void				*ih;
55 };
56 
57 int vtmmio_attach(device_t);
58 
59 #define	VIRTIO_MMIO_MAGIC_VALUE		0x000
60 #define	VIRTIO_MMIO_VERSION		0x004
61 #define	VIRTIO_MMIO_DEVICE_ID		0x008
62 #define	VIRTIO_MMIO_VENDOR_ID		0x00c
63 #define	VIRTIO_MMIO_HOST_FEATURES	0x010
64 #define	VIRTIO_MMIO_HOST_FEATURES_SEL	0x014
65 #define	VIRTIO_MMIO_GUEST_FEATURES	0x020
66 #define	VIRTIO_MMIO_GUEST_FEATURES_SEL	0x024
67 #define	VIRTIO_MMIO_GUEST_PAGE_SIZE	0x028
68 #define	VIRTIO_MMIO_QUEUE_SEL		0x030
69 #define	VIRTIO_MMIO_QUEUE_NUM_MAX	0x034
70 #define	VIRTIO_MMIO_QUEUE_NUM		0x038
71 #define	VIRTIO_MMIO_QUEUE_ALIGN		0x03c
72 #define	VIRTIO_MMIO_QUEUE_PFN		0x040
73 #define	VIRTIO_MMIO_QUEUE_NOTIFY	0x050
74 #define	VIRTIO_MMIO_INTERRUPT_STATUS	0x060
75 #define	VIRTIO_MMIO_INTERRUPT_ACK	0x064
76 #define	VIRTIO_MMIO_STATUS		0x070
77 #define	VIRTIO_MMIO_CONFIG		0x100
78 #define	VIRTIO_MMIO_INT_VRING		(1 << 0)
79 #define	VIRTIO_MMIO_INT_CONFIG		(1 << 1)
80 #define	VIRTIO_MMIO_VRING_ALIGN		4096
81 
82 #endif /* _VIRTIO_MMIO_H */
83