xref: /freebsd/sys/dev/virtio/virtio_bus_if.m (revision 81b22a98) 
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# $FreeBSD$
27
28#include <sys/bus.h>
29#include <machine/bus.h>
30
31INTERFACE virtio_bus;
32
33HEADER {
34struct vq_alloc_info;
35};
36
37CODE {
38	static int
39	virtio_bus_default_finalize_features(device_t dev)
40	{
41		return (0);
42	}
43
44	static int
45	virtio_bus_default_config_generation(device_t dev)
46	{
47		return (0);
48	}
49};
50
51METHOD uint64_t negotiate_features {
52	device_t	dev;
53	uint64_t	child_features;
54};
55
56METHOD int finalize_features {
57	device_t	dev;
58} DEFAULT virtio_bus_default_finalize_features;
59
60METHOD int with_feature {
61	device_t	dev;
62	uint64_t	feature;
63};
64
65METHOD int alloc_virtqueues {
66	device_t	dev;
67	int		flags;
68	int		nvqs;
69	struct vq_alloc_info *info;
70};
71
72METHOD int setup_intr {
73	device_t	dev;
74	enum intr_type	type;
75};
76
77METHOD void stop {
78	device_t	dev;
79};
80
81METHOD int reinit {
82	device_t	dev;
83	uint64_t	features;
84};
85
86METHOD void reinit_complete {
87	device_t	dev;
88};
89
90METHOD void notify_vq {
91	device_t	dev;
92	uint16_t	queue;
93	bus_size_t	offset;
94};
95
96METHOD int config_generation {
97	device_t	dev;
98} DEFAULT virtio_bus_default_config_generation;
99
100METHOD void read_device_config {
101	device_t	dev;
102	bus_size_t	offset;
103	void		*dst;
104	int		len;
105};
106
107METHOD void write_device_config {
108	device_t	dev;
109	bus_size_t	offset;
110	const void	*src;
111	int		len;
112};
113
114METHOD void poll {
115	device_t	dev;
116};
117
118