xref: /freebsd/sys/dev/virtio/mmio/virtio_mmio_if.m (revision 2008043f386721d58158e37e0d7e50df8095942d)
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
32#include <sys/types.h>
33
34#
35# This is optional interface to virtio mmio backend.
36# Useful when backend is implemented not by the hardware but software, e.g.
37# by using another cpu core.
38#
39
40INTERFACE virtio_mmio;
41
42CODE {
43	static int
44	virtio_mmio_prewrite(device_t dev, size_t offset, int val)
45	{
46
47		return (1);
48	}
49
50	static int
51	virtio_mmio_note(device_t dev, size_t offset, int val)
52	{
53
54		return (1);
55	}
56
57	static int
58	virtio_mmio_setup_intr(device_t dev, device_t mmio_dev,
59					void *handler, void *ih_user)
60	{
61
62		return (1);
63	}
64};
65
66#
67# Inform backend we are going to write data at offset.
68#
69METHOD int prewrite {
70	device_t	dev;
71	size_t		offset;
72	int		val;
73} DEFAULT virtio_mmio_prewrite;
74
75#
76# Inform backend we have data wrotten to offset.
77#
78METHOD int note {
79	device_t	dev;
80	size_t		offset;
81	int		val;
82} DEFAULT virtio_mmio_note;
83
84#
85# Inform backend we are going to poll virtqueue.
86#
87METHOD int poll {
88	device_t	dev;
89};
90
91#
92# Setup backend-specific interrupts.
93#
94METHOD int setup_intr {
95	device_t	dev;
96	device_t	mmio_dev;
97	void		*handler;
98	void		*ih_user;
99} DEFAULT virtio_mmio_setup_intr;
100