nvmm.h revision 1.1.2.2 1 1.1.2.2 pgoyette /* $NetBSD: nvmm.h,v 1.1.2.2 2018/11/26 01:52:13 pgoyette Exp $ */
2 1.1.2.2 pgoyette
3 1.1.2.2 pgoyette /*
4 1.1.2.2 pgoyette * Copyright (c) 2018 The NetBSD Foundation, Inc.
5 1.1.2.2 pgoyette * All rights reserved.
6 1.1.2.2 pgoyette *
7 1.1.2.2 pgoyette * This code is derived from software contributed to The NetBSD Foundation
8 1.1.2.2 pgoyette * by Maxime Villard.
9 1.1.2.2 pgoyette *
10 1.1.2.2 pgoyette * Redistribution and use in source and binary forms, with or without
11 1.1.2.2 pgoyette * modification, are permitted provided that the following conditions
12 1.1.2.2 pgoyette * are met:
13 1.1.2.2 pgoyette * 1. Redistributions of source code must retain the above copyright
14 1.1.2.2 pgoyette * notice, this list of conditions and the following disclaimer.
15 1.1.2.2 pgoyette * 2. Redistributions in binary form must reproduce the above copyright
16 1.1.2.2 pgoyette * notice, this list of conditions and the following disclaimer in the
17 1.1.2.2 pgoyette * documentation and/or other materials provided with the distribution.
18 1.1.2.2 pgoyette *
19 1.1.2.2 pgoyette * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1.2.2 pgoyette * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1.2.2 pgoyette * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1.2.2 pgoyette * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1.2.2 pgoyette * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1.2.2 pgoyette * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1.2.2 pgoyette * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1.2.2 pgoyette * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1.2.2 pgoyette * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1.2.2 pgoyette * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1.2.2 pgoyette * POSSIBILITY OF SUCH DAMAGE.
30 1.1.2.2 pgoyette */
31 1.1.2.2 pgoyette
32 1.1.2.2 pgoyette #ifndef _LIBNVMM_H_
33 1.1.2.2 pgoyette #define _LIBNVMM_H_
34 1.1.2.2 pgoyette
35 1.1.2.2 pgoyette #include <stdint.h>
36 1.1.2.2 pgoyette #include <stdbool.h>
37 1.1.2.2 pgoyette
38 1.1.2.2 pgoyette #include <dev/nvmm/nvmm.h>
39 1.1.2.2 pgoyette #include <dev/nvmm/nvmm_ioctl.h>
40 1.1.2.2 pgoyette #ifdef __x86_64__
41 1.1.2.2 pgoyette #include <dev/nvmm/x86/nvmm_x86.h>
42 1.1.2.2 pgoyette #endif
43 1.1.2.2 pgoyette
44 1.1.2.2 pgoyette struct nvmm_area {
45 1.1.2.2 pgoyette gpaddr_t gpa;
46 1.1.2.2 pgoyette uintptr_t hva;
47 1.1.2.2 pgoyette size_t size;
48 1.1.2.2 pgoyette };
49 1.1.2.2 pgoyette
50 1.1.2.2 pgoyette struct nvmm_machine {
51 1.1.2.2 pgoyette nvmm_machid_t machid;
52 1.1.2.2 pgoyette struct nvmm_area *areas;
53 1.1.2.2 pgoyette size_t nareas;
54 1.1.2.2 pgoyette };
55 1.1.2.2 pgoyette
56 1.1.2.2 pgoyette struct nvmm_io {
57 1.1.2.2 pgoyette uint64_t port;
58 1.1.2.2 pgoyette bool in;
59 1.1.2.2 pgoyette size_t size;
60 1.1.2.2 pgoyette uint8_t data[8];
61 1.1.2.2 pgoyette };
62 1.1.2.2 pgoyette
63 1.1.2.2 pgoyette struct nvmm_mem {
64 1.1.2.2 pgoyette gvaddr_t gva;
65 1.1.2.2 pgoyette gpaddr_t gpa;
66 1.1.2.2 pgoyette bool write;
67 1.1.2.2 pgoyette size_t size;
68 1.1.2.2 pgoyette uint8_t data[8];
69 1.1.2.2 pgoyette };
70 1.1.2.2 pgoyette
71 1.1.2.2 pgoyette #define NVMM_PROT_READ 0x01
72 1.1.2.2 pgoyette #define NVMM_PROT_WRITE 0x02
73 1.1.2.2 pgoyette #define NVMM_PROT_EXEC 0x04
74 1.1.2.2 pgoyette #define NVMM_PROT_USER 0x08
75 1.1.2.2 pgoyette #define NVMM_PROT_ALL 0x0F
76 1.1.2.2 pgoyette typedef uint64_t nvmm_prot_t;
77 1.1.2.2 pgoyette
78 1.1.2.2 pgoyette int nvmm_capability(struct nvmm_capability *);
79 1.1.2.2 pgoyette
80 1.1.2.2 pgoyette int nvmm_machine_create(struct nvmm_machine *);
81 1.1.2.2 pgoyette int nvmm_machine_destroy(struct nvmm_machine *);
82 1.1.2.2 pgoyette int nvmm_machine_configure(struct nvmm_machine *, uint64_t, void *);
83 1.1.2.2 pgoyette
84 1.1.2.2 pgoyette int nvmm_vcpu_create(struct nvmm_machine *, nvmm_cpuid_t);
85 1.1.2.2 pgoyette int nvmm_vcpu_destroy(struct nvmm_machine *, nvmm_cpuid_t);
86 1.1.2.2 pgoyette int nvmm_vcpu_setstate(struct nvmm_machine *, nvmm_cpuid_t, void *, uint64_t);
87 1.1.2.2 pgoyette int nvmm_vcpu_getstate(struct nvmm_machine *, nvmm_cpuid_t, void *, uint64_t);
88 1.1.2.2 pgoyette int nvmm_vcpu_inject(struct nvmm_machine *, nvmm_cpuid_t, struct nvmm_event *);
89 1.1.2.2 pgoyette int nvmm_vcpu_run(struct nvmm_machine *, nvmm_cpuid_t, struct nvmm_exit *);
90 1.1.2.2 pgoyette
91 1.1.2.2 pgoyette int nvmm_gpa_map(struct nvmm_machine *, uintptr_t, gpaddr_t, size_t, int);
92 1.1.2.2 pgoyette int nvmm_gpa_unmap(struct nvmm_machine *, uintptr_t, gpaddr_t, size_t);
93 1.1.2.2 pgoyette
94 1.1.2.2 pgoyette int nvmm_gva_to_gpa(struct nvmm_machine *, nvmm_cpuid_t, gvaddr_t, gpaddr_t *,
95 1.1.2.2 pgoyette nvmm_prot_t *);
96 1.1.2.2 pgoyette int nvmm_gpa_to_hva(struct nvmm_machine *, gpaddr_t, uintptr_t *);
97 1.1.2.2 pgoyette
98 1.1.2.2 pgoyette int nvmm_assist_io(struct nvmm_machine *, nvmm_cpuid_t, struct nvmm_exit *,
99 1.1.2.2 pgoyette void (*)(struct nvmm_io *));
100 1.1.2.2 pgoyette int nvmm_assist_mem(struct nvmm_machine *, nvmm_cpuid_t, struct nvmm_exit *,
101 1.1.2.2 pgoyette void (*)(struct nvmm_mem *));
102 1.1.2.2 pgoyette
103 1.1.2.2 pgoyette #endif /* _LIBNVMM_H_ */
104