xref: /illumos-gate/usr/src/cmd/bhyve/inout.h (revision 32640292)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2011 NetApp, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 /*
29  * This file and its contents are supplied under the terms of the
30  * Common Development and Distribution License ("CDDL"), version 1.0.
31  * You may only use this file in accordance with the terms of version
32  * 1.0 of the CDDL.
33  *
34  * A full copy of the text of the CDDL should have accompanied this
35  * source.  A copy of the CDDL is also available via the Internet at
36  * http://www.illumos.org/license/CDDL.
37  *
38  * Copyright 2014 Pluribus Networks Inc.
39  */
40 
41 #ifndef _INOUT_H_
42 #define	_INOUT_H_
43 
44 #include <sys/linker_set.h>
45 
46 struct vcpu;
47 struct vmctx;
48 struct vm_exit;
49 #ifndef __FreeBSD__
50 struct vm_inout;
51 #endif
52 
53 /*
54  * inout emulation handlers return 0 on success and -1 on failure.
55  */
56 typedef int (*inout_func_t)(struct vmctx *ctx, int in, int port,
57 			    int bytes, uint32_t *eax, void *arg);
58 
59 struct inout_port {
60 	const char 	*name;
61 	int		port;
62 	int		size;
63 	int		flags;
64 	inout_func_t	handler;
65 	void		*arg;
66 };
67 #define	IOPORT_F_IN		0x1
68 #define	IOPORT_F_OUT		0x2
69 #define	IOPORT_F_INOUT		(IOPORT_F_IN | IOPORT_F_OUT)
70 
71 /*
72  * The following flags are used internally and must not be used by
73  * device models.
74  */
75 #define	IOPORT_F_DEFAULT	0x80000000	/* claimed by default handler */
76 
77 #define	INOUT_PORT(name, port, flags, handler)				\
78 	static struct inout_port __CONCAT(__inout_port, __LINE__) = {	\
79 		#name,							\
80 		(port),							\
81 		1,							\
82 		(flags),						\
83 		(handler),						\
84 		0							\
85 	};								\
86 	DATA_SET(inout_port_set, __CONCAT(__inout_port, __LINE__))
87 
88 void	init_inout(void);
89 #ifdef __FreeBSD__
90 int	emulate_inout(struct vmctx *, struct vcpu *vcpu, struct vm_exit *vmexit);
91 #else
92 int	emulate_inout(struct vmctx *, struct vcpu *vcpu, struct vm_inout *inout);
93 #endif
94 int	register_inout(struct inout_port *iop);
95 int	unregister_inout(struct inout_port *iop);
96 
97 #endif	/* _INOUT_H_ */
98