inout.h revision 261090 
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: stable/10/usr.sbin/bhyve/inout.h 261090 2014-01-23 20:35:32Z jhb $
27 */
28
29#ifndef _INOUT_H_
30#define	_INOUT_H_
31
32#include <sys/linker_set.h>
33
34struct vmctx;
35
36/* Handler return values. */
37#define	INOUT_ERROR	-1
38#define	INOUT_OK	0
39#define	INOUT_RESET	1
40#define	INOUT_POWEROFF	2
41
42typedef int (*inout_func_t)(struct vmctx *ctx, int vcpu, int in, int port,
43			    int bytes, uint32_t *eax, void *arg);
44
45struct inout_port {
46	const char 	*name;
47	int		port;
48	int		size;
49	int		flags;
50	inout_func_t	handler;
51	void		*arg;
52};
53#define	IOPORT_F_IN		0x1
54#define	IOPORT_F_OUT		0x2
55#define	IOPORT_F_INOUT		(IOPORT_F_IN | IOPORT_F_OUT)
56
57/*
58 * The following flags are used internally and must not be used by
59 * device models.
60 */
61#define	IOPORT_F_DEFAULT	0x80000000	/* claimed by default handler */
62
63#define	INOUT_PORT(name, port, flags, handler)				\
64	static struct inout_port __CONCAT(__inout_port, __LINE__) = {	\
65		#name,							\
66		(port),							\
67		1,							\
68		(flags),						\
69		(handler),						\
70		0							\
71	};								\
72	DATA_SET(inout_port_set, __CONCAT(__inout_port, __LINE__))
73
74void	init_inout(void);
75int	emulate_inout(struct vmctx *, int vcpu, int in, int port, int bytes,
76		      uint32_t *eax, int strict);
77int	register_inout(struct inout_port *iop);
78int	unregister_inout(struct inout_port *iop);
79void	init_bvmcons(void);
80
81#endif	/* _INOUT_H_ */
82