xref: /freebsd/sys/xen/privcmd.h (revision 02e9120893770924227138ba49df1edb3896112a)
1 /******************************************************************************
2  * SPDX-License-Identifier: MIT OR GPL-2.0-only
3  *
4  * privcmd.h
5  *
6  * Interface to /proc/xen/privcmd.
7  *
8  * Copyright (c) 2003-2005, K A Fraser
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License version 2
12  * as published by the Free Software Foundation; or, when distributed
13  * separately from the Linux kernel or incorporated into other
14  * software packages, subject to the following license:
15  *
16  * Permission is hereby granted, free of charge, to any person obtaining a copy
17  * of this source file (the "Software"), to deal in the Software without
18  * restriction, including without limitation the rights to use, copy, modify,
19  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
20  * and to permit persons to whom the Software is furnished to do so, subject to
21  * the following conditions:
22  *
23  * The above copyright notice and this permission notice shall be included in
24  * all copies or substantial portions of the Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
31  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
32  * IN THE SOFTWARE.
33  */
34 
35 #ifndef __XEN_PRIVCMD_H__
36 #define __XEN_PRIVCMD_H__
37 
38 struct ioctl_privcmd_hypercall
39 {
40 	unsigned long op; /* hypercall number */
41 	unsigned long arg[5]; /* arguments */
42 	long retval; /* return value */
43 };
44 
45 struct ioctl_privcmd_mmapbatch {
46 	int num;     /* number of pages to populate */
47 	domid_t dom; /* target domain */
48 	unsigned long addr;  /* virtual address */
49 	const xen_pfn_t *arr; /* array of mfns */
50 	int *err; /* array of error codes */
51 };
52 
53 struct ioctl_privcmd_mmapresource {
54 	domid_t dom; /* target domain */
55 	unsigned int type; /* type of resource to map */
56 	unsigned int id; /* type-specific resource identifier */
57 	unsigned int idx; /* the index of the initial frame to be mapped */
58 	unsigned long num; /* number of frames of the resource to be mapped */
59 	unsigned long addr; /* physical address to map into */
60 	/*
61 	 * Note: issuing an ioctl with num = addr = 0 will return the size of
62 	 * the resource.
63 	 */
64 };
65 
66 struct privcmd_dmop_buf {
67 	void *uptr; /* pointer to memory (in calling process) */
68 	size_t size; /* size of the buffer */
69 };
70 
71 struct ioctl_privcmd_dmop {
72 	domid_t dom; /* target domain */
73 	unsigned int num; /* num of buffers */
74 	const struct privcmd_dmop_buf *ubufs; /* array of buffers */
75 };
76 
77 #define IOCTL_PRIVCMD_HYPERCALL					\
78 	_IOWR('E', 0, struct ioctl_privcmd_hypercall)
79 #define IOCTL_PRIVCMD_MMAPBATCH					\
80 	_IOWR('E', 1, struct ioctl_privcmd_mmapbatch)
81 #define IOCTL_PRIVCMD_MMAP_RESOURCE				\
82 	_IOWR('E', 2, struct ioctl_privcmd_mmapresource)
83 #define IOCTL_PRIVCMD_DM_OP					\
84 	_IOW('E', 3, struct ioctl_privcmd_dmop)
85 #define IOCTL_PRIVCMD_RESTRICT					\
86 	_IOW('E', 4, domid_t)
87 
88 #endif /* !__XEN_PRIVCMD_H__ */
89