xref: /illumos-gate/usr/src/cmd/bhyve/mem.h (revision 32640292)
1bf21cd93STycho Nightingale /*-
2*32640292SAndy Fiddaman  * SPDX-License-Identifier: BSD-2-Clause
34c87aefeSPatrick Mooney  *
4bf21cd93STycho Nightingale  * Copyright (c) 2012 NetApp, Inc.
5bf21cd93STycho Nightingale  * All rights reserved.
6bf21cd93STycho Nightingale  *
7bf21cd93STycho Nightingale  * Redistribution and use in source and binary forms, with or without
8bf21cd93STycho Nightingale  * modification, are permitted provided that the following conditions
9bf21cd93STycho Nightingale  * are met:
10bf21cd93STycho Nightingale  * 1. Redistributions of source code must retain the above copyright
11bf21cd93STycho Nightingale  *    notice, this list of conditions and the following disclaimer.
12bf21cd93STycho Nightingale  * 2. Redistributions in binary form must reproduce the above copyright
13bf21cd93STycho Nightingale  *    notice, this list of conditions and the following disclaimer in the
14bf21cd93STycho Nightingale  *    documentation and/or other materials provided with the distribution.
15bf21cd93STycho Nightingale  *
16bf21cd93STycho Nightingale  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17bf21cd93STycho Nightingale  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18bf21cd93STycho Nightingale  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19bf21cd93STycho Nightingale  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20bf21cd93STycho Nightingale  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21bf21cd93STycho Nightingale  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22bf21cd93STycho Nightingale  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23bf21cd93STycho Nightingale  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24bf21cd93STycho Nightingale  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25bf21cd93STycho Nightingale  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26bf21cd93STycho Nightingale  * SUCH DAMAGE.
27bf21cd93STycho Nightingale  */
28bf21cd93STycho Nightingale 
29bf21cd93STycho Nightingale #ifndef _MEM_H_
30bf21cd93STycho Nightingale #define	_MEM_H_
31bf21cd93STycho Nightingale 
32bf21cd93STycho Nightingale #include <sys/linker_set.h>
33bf21cd93STycho Nightingale 
34*32640292SAndy Fiddaman struct vcpu;
35bf21cd93STycho Nightingale 
36*32640292SAndy Fiddaman typedef int (*mem_func_t)(struct vcpu *vcpu, int dir, uint64_t addr,
37bf21cd93STycho Nightingale 			  int size, uint64_t *val, void *arg1, long arg2);
38bf21cd93STycho Nightingale 
39bf21cd93STycho Nightingale struct mem_range {
40bf21cd93STycho Nightingale 	const char 	*name;
41bf21cd93STycho Nightingale 	int		flags;
42bf21cd93STycho Nightingale 	mem_func_t	handler;
43bf21cd93STycho Nightingale 	void		*arg1;
44bf21cd93STycho Nightingale 	long		arg2;
45bf21cd93STycho Nightingale 	uint64_t  	base;
46bf21cd93STycho Nightingale 	uint64_t  	size;
47bf21cd93STycho Nightingale };
48bf21cd93STycho Nightingale #define	MEM_F_READ		0x1
49bf21cd93STycho Nightingale #define	MEM_F_WRITE		0x2
50bf21cd93STycho Nightingale #define	MEM_F_RW		0x3
51bf21cd93STycho Nightingale #define	MEM_F_IMMUTABLE		0x4	/* mem_range cannot be unregistered */
52bf21cd93STycho Nightingale 
53d7b72f7bSAndy Fiddaman void	init_mem(int ncpu);
54e0c0d44eSPatrick Mooney 
55*32640292SAndy Fiddaman int	emulate_mem(struct vcpu *vcpu, struct vm_mmio *mmio);
564c87aefeSPatrick Mooney 
57*32640292SAndy Fiddaman int	read_mem(struct vcpu *vpu, uint64_t gpa, uint64_t *rval, int size);
58bf21cd93STycho Nightingale int	register_mem(struct mem_range *memp);
59bf21cd93STycho Nightingale int	register_mem_fallback(struct mem_range *memp);
60bf21cd93STycho Nightingale int	unregister_mem(struct mem_range *memp);
61*32640292SAndy Fiddaman int	write_mem(struct vcpu *vcpu, uint64_t gpa, uint64_t wval, int size);
62bf21cd93STycho Nightingale 
63bf21cd93STycho Nightingale #endif	/* _MEM_H_ */
64