1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2012 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 * $FreeBSD: stable/11/usr.sbin/bhyve/mem.h 336161 2018-07-10 04:26:32Z araujo $
29 */
30
31#ifndef _MEM_H_
32#define	_MEM_H_
33
34#include <sys/linker_set.h>
35
36struct vmctx;
37
38typedef int (*mem_func_t)(struct vmctx *ctx, int vcpu, int dir, uint64_t addr,
39			  int size, uint64_t *val, void *arg1, long arg2);
40
41struct mem_range {
42	const char 	*name;
43	int		flags;
44	mem_func_t	handler;
45	void		*arg1;
46	long		arg2;
47	uint64_t  	base;
48	uint64_t  	size;
49};
50#define	MEM_F_READ		0x1
51#define	MEM_F_WRITE		0x2
52#define	MEM_F_RW		0x3
53#define	MEM_F_IMMUTABLE		0x4	/* mem_range cannot be unregistered */
54
55void	init_mem(void);
56int     emulate_mem(struct vmctx *, int vcpu, uint64_t paddr, struct vie *vie,
57		    struct vm_guest_paging *paging);
58
59int	register_mem(struct mem_range *memp);
60int	register_mem_fallback(struct mem_range *memp);
61int	unregister_mem(struct mem_range *memp);
62
63#endif	/* _MEM_H_ */
64