1221828Sgrehan/*-
2221828Sgrehan * Copyright (c) 2011 NetApp, Inc.
3221828Sgrehan * All rights reserved.
4221828Sgrehan *
5221828Sgrehan * Redistribution and use in source and binary forms, with or without
6221828Sgrehan * modification, are permitted provided that the following conditions
7221828Sgrehan * are met:
8221828Sgrehan * 1. Redistributions of source code must retain the above copyright
9221828Sgrehan *    notice, this list of conditions and the following disclaimer.
10221828Sgrehan * 2. Redistributions in binary form must reproduce the above copyright
11221828Sgrehan *    notice, this list of conditions and the following disclaimer in the
12221828Sgrehan *    documentation and/or other materials provided with the distribution.
13221828Sgrehan *
14221828Sgrehan * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15221828Sgrehan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16221828Sgrehan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17221828Sgrehan * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18221828Sgrehan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19221828Sgrehan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20221828Sgrehan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21221828Sgrehan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22221828Sgrehan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23221828Sgrehan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24221828Sgrehan * SUCH DAMAGE.
25221828Sgrehan *
26221828Sgrehan * $FreeBSD$
27221828Sgrehan */
28221828Sgrehan
29221828Sgrehan#ifndef _INOUT_H_
30221828Sgrehan#define	_INOUT_H_
31221828Sgrehan
32221828Sgrehan#include <sys/linker_set.h>
33221828Sgrehan
34221828Sgrehanstruct vmctx;
35268976Sjhbstruct vm_exit;
36221828Sgrehan
37270159Sgrehan/*
38270159Sgrehan * inout emulation handlers return 0 on success and -1 on failure.
39270159Sgrehan */
40221828Sgrehantypedef int (*inout_func_t)(struct vmctx *ctx, int vcpu, int in, int port,
41221828Sgrehan			    int bytes, uint32_t *eax, void *arg);
42221828Sgrehan
43221828Sgrehanstruct inout_port {
44221828Sgrehan	const char 	*name;
45221828Sgrehan	int		port;
46249321Sneel	int		size;
47221828Sgrehan	int		flags;
48221828Sgrehan	inout_func_t	handler;
49221828Sgrehan	void		*arg;
50221828Sgrehan};
51221828Sgrehan#define	IOPORT_F_IN		0x1
52221828Sgrehan#define	IOPORT_F_OUT		0x2
53257396Sneel#define	IOPORT_F_INOUT		(IOPORT_F_IN | IOPORT_F_OUT)
54221828Sgrehan
55257396Sneel/*
56257396Sneel * The following flags are used internally and must not be used by
57257396Sneel * device models.
58257396Sneel */
59257396Sneel#define	IOPORT_F_DEFAULT	0x80000000	/* claimed by default handler */
60257396Sneel
61221828Sgrehan#define	INOUT_PORT(name, port, flags, handler)				\
62221828Sgrehan	static struct inout_port __CONCAT(__inout_port, __LINE__) = {	\
63221828Sgrehan		#name,							\
64221828Sgrehan		(port),							\
65249321Sneel		1,							\
66221828Sgrehan		(flags),						\
67221942Sjhb		(handler),						\
68221942Sjhb		0							\
69221828Sgrehan	};								\
70221828Sgrehan	DATA_SET(inout_port_set, __CONCAT(__inout_port, __LINE__))
71221828Sgrehan
72221828Sgrehanvoid	init_inout(void);
73268976Sjhbint	emulate_inout(struct vmctx *, int vcpu, struct vm_exit *vmexit,
74268976Sjhb		      int strict);
75221828Sgrehanint	register_inout(struct inout_port *iop);
76249321Sneelint	unregister_inout(struct inout_port *iop);
77242192Sneelvoid	init_bvmcons(void);
78242192Sneel
79221828Sgrehan#endif	/* _INOUT_H_ */
80