xref: /freebsd/sys/dev/virtio/virtio_bus_if.m (revision abcdc1b9) 
1#-
2# Copyright (c) 2011, Bryan Venteicher <bryanv@FreeBSD.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, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26
27#include <sys/bus.h>
28#include <machine/bus.h>
29
30INTERFACE virtio_bus;
31
32HEADER {
33struct vq_alloc_info;
34};
35
36CODE {
37	static int
38	virtio_bus_default_finalize_features(device_t dev)
39	{
40		return (0);
41	}
42
43	static int
44	virtio_bus_default_config_generation(device_t dev)
45	{
46		return (0);
47	}
48};
49
50METHOD uint64_t negotiate_features {
51	device_t	dev;
52	uint64_t	child_features;
53};
54
55METHOD int finalize_features {
56	device_t	dev;
57} DEFAULT virtio_bus_default_finalize_features;
58
59METHOD bool with_feature {
60	device_t	dev;
61	uint64_t	feature;
62};
63
64METHOD int alloc_virtqueues {
65	device_t	dev;
66	int		nvqs;
67	struct vq_alloc_info *info;
68};
69
70METHOD int setup_intr {
71	device_t	dev;
72	enum intr_type	type;
73};
74
75METHOD void stop {
76	device_t	dev;
77};
78
79METHOD int reinit {
80	device_t	dev;
81	uint64_t	features;
82};
83
84METHOD void reinit_complete {
85	device_t	dev;
86};
87
88METHOD void notify_vq {
89	device_t	dev;
90	uint16_t	queue;
91	bus_size_t	offset;
92};
93
94METHOD int config_generation {
95	device_t	dev;
96} DEFAULT virtio_bus_default_config_generation;
97
98METHOD void read_device_config {
99	device_t	dev;
100	bus_size_t	offset;
101	void		*dst;
102	int		len;
103};
104
105METHOD void write_device_config {
106	device_t	dev;
107	bus_size_t	offset;
108	const void	*src;
109	int		len;
110};
111
112METHOD void poll {
113	device_t	dev;
114};
115
116