1 /******************************************************************************
2  * privcmd.h
3  *
4  * Interface to /dev/xen/privcmd.
5  *
6  * Copyright (c) 2003-2005, K A Fraser
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License version 2
10  * as published by the Free Software Foundation; or, when distributed
11  * separately from the Linux kernel or incorporated into other
12  * software packages, subject to the following license:
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a copy
15  * of this source file (the "Software"), to deal in the Software without
16  * restriction, including without limitation the rights to use, copy, modify,
17  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
18  * and to permit persons to whom the Software is furnished to do so, subject to
19  * the following conditions:
20  *
21  * The above copyright notice and this permission notice shall be included in
22  * all copies or substantial portions of the Software.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * IN THE SOFTWARE.
31  */
32 
33 #ifndef __LINUX_PUBLIC_PRIVCMD_H__
34 #define __LINUX_PUBLIC_PRIVCMD_H__
35 
36 #include <linux/types.h>
37 
38 #ifndef __user
39 #define __user
40 #endif
41 
42 typedef struct privcmd_hypercall
43 {
44 	__u64 op;
45 	__u64 arg[5];
46 } privcmd_hypercall_t;
47 
48 typedef struct privcmd_mmap_entry {
49 	__u64 va;
50 	__u64 mfn;
51 	__u64 npages;
52 } privcmd_mmap_entry_t;
53 
54 typedef struct privcmd_mmap {
55 	int num;
56 	domid_t dom; /* target domain */
57 	privcmd_mmap_entry_t __user *entry;
58 } privcmd_mmap_t;
59 
60 typedef struct privcmd_mmapbatch {
61 	int num;     /* number of pages to populate */
62 	domid_t dom; /* target domain */
63 	__u64 addr;  /* virtual address */
64 	xen_pfn_t __user *arr; /* array of mfns - top nibble set on err */
65 } privcmd_mmapbatch_t;
66 
67 #define PRIVCMD_MMAPBATCH_MFN_ERROR     0xf0000000U
68 #define PRIVCMD_MMAPBATCH_PAGED_ERROR   0x80000000U
69 
70 typedef struct privcmd_mmapbatch_v2 {
71 	unsigned int num; /* number of pages to populate */
72 	domid_t dom;      /* target domain */
73 	__u64 addr;       /* virtual address */
74 	const xen_pfn_t __user *arr; /* array of mfns */
75 	int __user *err;  /* array of error codes */
76 } privcmd_mmapbatch_v2_t;
77 
78 typedef struct privcmd_dm_op_buf {
79 	void __user *uptr;
80 	size_t size;
81 } privcmd_dm_op_buf_t;
82 
83 typedef struct privcmd_dm_op {
84 	domid_t dom;
85 	__u16 num;
86 	const privcmd_dm_op_buf_t __user *ubufs;
87 } privcmd_dm_op_t;
88 
89 typedef struct privcmd_mmap_resource {
90 	domid_t dom;
91 	__u32 type;
92 	__u32 id;
93 	__u32 idx;
94 	__u64 num;
95 	__u64 addr;
96 } privcmd_mmap_resource_t;
97 
98 /*
99  * @cmd: IOCTL_PRIVCMD_HYPERCALL
100  * @arg: &privcmd_hypercall_t
101  * Return: Value returned from execution of the specified hypercall.
102  */
103 #define IOCTL_PRIVCMD_HYPERCALL					\
104 	_IOC(_IOC_NONE, 'P', 0, sizeof(privcmd_hypercall_t))
105 #define IOCTL_PRIVCMD_MMAP					\
106 	_IOC(_IOC_NONE, 'P', 2, sizeof(privcmd_mmap_t))
107 #define IOCTL_PRIVCMD_MMAPBATCH					\
108 	_IOC(_IOC_NONE, 'P', 3, sizeof(privcmd_mmapbatch_t))
109 #define IOCTL_PRIVCMD_MMAPBATCH_V2				\
110 	_IOC(_IOC_NONE, 'P', 4, sizeof(privcmd_mmapbatch_v2_t))
111 #define IOCTL_PRIVCMD_DM_OP					\
112 	_IOC(_IOC_NONE, 'P', 5, sizeof(privcmd_dm_op_t))
113 #define IOCTL_PRIVCMD_RESTRICT					\
114 	_IOC(_IOC_NONE, 'P', 6, sizeof(domid_t))
115 #define IOCTL_PRIVCMD_MMAP_RESOURCE				\
116 	_IOC(_IOC_NONE, 'P', 7, sizeof(privcmd_mmap_resource_t))
117 #define IOCTL_PRIVCMD_UNIMPLEMENTED				\
118 	_IOC(_IOC_NONE, 'P', 0xFF, 0)
119 
120 #endif /* __LINUX_PUBLIC_PRIVCMD_H__ */
121