1/*-
2 * Copyright (c) 2011 NetApp, Inc.
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 NETAPP, INC ``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 NETAPP, INC 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
29#ifndef _INOUT_H_
30#define	_INOUT_H_
31
32#include <sys/linker_set.h>
33
34struct vmctx;
35struct vm_exit;
36
37/*
38 * inout emulation handlers return 0 on success and -1 on failure.
39 */
40typedef int (*inout_func_t)(struct vmctx *ctx, int vcpu, int in, int port,
41			    int bytes, uint32_t *eax, void *arg);
42
43struct inout_port {
44	const char 	*name;
45	int		port;
46	int		size;
47	int		flags;
48	inout_func_t	handler;
49	void		*arg;
50};
51#define	IOPORT_F_IN		0x1
52#define	IOPORT_F_OUT		0x2
53#define	IOPORT_F_INOUT		(IOPORT_F_IN | IOPORT_F_OUT)
54
55/*
56 * The following flags are used internally and must not be used by
57 * device models.
58 */
59#define	IOPORT_F_DEFAULT	0x80000000	/* claimed by default handler */
60
61#define	INOUT_PORT(name, port, flags, handler)				\
62	static struct inout_port __CONCAT(__inout_port, __LINE__) = {	\
63		#name,							\
64		(port),							\
65		1,							\
66		(flags),						\
67		(handler),						\
68		0							\
69	};								\
70	DATA_SET(inout_port_set, __CONCAT(__inout_port, __LINE__))
71
72void	init_inout(void);
73int	emulate_inout(struct vmctx *, int vcpu, struct vm_exit *vmexit,
74		      int strict);
75int	register_inout(struct inout_port *iop);
76int	unregister_inout(struct inout_port *iop);
77void	init_bvmcons(void);
78
79#endif	/* _INOUT_H_ */
80