xref: /freebsd/sys/powerpc/pseries/phyp-hvcall.h (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
1 /*-
2  * Copyright (C) 2010 Andreas Tobler
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #ifndef	_PSERIES_PHYP_HVCALL_H_
29 #define	_PSERIES_PHYP_HVCALL_H_
30 
31 /* Information taken from: Power.org PAPR, Version 2.4 (December 7, 2009). */
32 
33 #include <sys/types.h>
34 
35 /* Return codes. */
36 
37 #define H_SUCCESS       0
38 #define H_BUSY          1  /* Hardware Busy -- Retry Later. */
39 #define H_CLOSED        2  /* Virtual I/O connection is closed. */
40 #define H_NOT_AVAILABLE 3
41 #define H_CONSTRAINED   4  /* The request called for resources in excess of
42 			      the maximum allowed. The resultant allocation
43 			      was constrained to maximum allowed. */
44 #define H_PARTIAL       5  /* The request completed only partially successful.
45 			      Parameters were valid but some specific hcall
46 			      function condition prevented fully completing the
47 			      architected function, see the specific hcall
48 			      definition for possible reasons. */
49 #define H_IN_PROGRESS     14
50 #define H_PAGE_REGISTERED 15
51 #define H_PARTIAL_STORE   16
52 #define H_PENDING         17
53 #define H_CONTINUE        18
54 
55 #define H_LONG_BUSY_ORDER_1_MS   9900  /* This return code is identical to
56 					  H_BUSY, but with the added bonus of a
57 					  hint to the partition OS. If the
58 					  partition OS can delay for 1
59 					  millisecond, the hcall will likely
60 					  succeed on a new hcall with no further
61 					  busy return codes. If the partition OS
62 					  cannot handle a delay, they are
63 					  certainly free to immediately turn
64 					  around and try again. */
65 #define H_LONG_BUSY_ORDER_10_MS  9901  /* Similar to H_LONG_BUSY_ORDER_1_MS, but
66 					  the hint is 10mSec wait this time. */
67 
68 #define H_LONG_BUSY_ORDER_100_MS 9902  /* Similar to H_LONG_BUSY_ORDER_1_MS, but
69 					  the hint is 100mSec wait this time. */
70 
71 #define H_LONG_BUSY_ORDER_1_S    9903  /* Similar to H_LONG_BUSY_ORDER_1_MS, but
72 					  the hint is 1Sec wait this time. */
73 #define H_LONG_BUSY_ORDER_10_S   9904  /* Similar to H_LONG_BUSY_ORDER_1_MS, but
74 					  the hint is 10Sec wait this time. */
75 #define H_LONG_BUSY_ORDER_100_S  9905  /* Similar to H_LONG_BUSY_ORDER_1_MS, but
76 					  the hint is 100Sec wait this time. */
77 
78 #define H_HARDWARE   -1  /* Error. */
79 #define H_FUNCTION   -2  /* Not supported. */
80 #define H_PRIVILEGE  -3  /* Caller not in privileged mode. */
81 #define H_PARAMETER  -4  /* Outside valid range for partition or conflicting. */
82 #define H_BAD_MODE   -5  /* Illegal MSR value. */
83 #define H_PTEG_FULL  -6  /* The requested pteg was full. */
84 #define H_NOT_FOUND  -7  /* The requested entitiy was not found. */
85 #define H_RESERVED_DABR -8  /* The requested address is reserved by the
86 			       hypervisor on this processor. */
87 #define H_NOMEM      -9
88 #define H_AUTHORITY -10  /* The caller did not have authority to perform the
89 			    function. */
90 #define H_PERMISSION -11  /* The mapping specified by the request does not
91 			     allow for the requested transfer. */
92 #define H_DROPPED   -12  /* One or more packets could not be delivered to
93 			    their requested destinations. */
94 #define H_S_PARM   -13  /* The source parameter is illegal. */
95 #define H_D_PARM   -14  /* The destination parameter is illegal. */
96 #define H_R_PARM   -15  /* The remote TCE mapping is illegal. */
97 #define H_RESOURCE  -16  /* One or more required resources are in use. */
98 #define H_ADAPTER_PARM -17  /* Invalid adapter. */
99 #define H_RH_PARM  -18  /* Resource not valid or logical partition
100 			   conflicting. */
101 #define H_RCQ_PARM -19  /* RCQ not valid or logical partition conflicting. */
102 #define H_SCQ_PARM -20  /* SCQ not valid or logical partition conflicting. */
103 #define H_EQ_PARM -21  /* EQ not valid or logical partition conflicting. */
104 #define H_RT_PARM -22  /* Invalid resource type. */
105 #define H_ST_PARM -23  /* Invalid service type. */
106 #define H_SIGT_PARM -24 /* Invalid signalling type. */
107 #define H_TOKEN_PARM -25  /* Invalid token. */
108 #define H_MLENGTH_PARM -27  /* Invalid memory length. */
109 #define H_MEM_PARM -28  /* Invalid memory I/O virtual address. */
110 #define H_MEM_ACCESS_PARM -29  /* Invalid memory access control. */
111 #define H_ATTR_PARM -30  /* Invalid attribute value. */
112 #define H_PORT_PARM -31  /* Invalid port number. */
113 #define H_MCG_PARM -32  /* Invalid multicast group. */
114 #define H_VL_PARM -33  /* Invalid virtual lane. */
115 #define H_TSIZE_PARM -34  /* Invalid trace size. */
116 #define H_TRACE_PARM -35  /* Invalid trace buffer. */
117 #define H_MASK_PARM -37  /* Invalid mask value. */
118 #define H_MCG_FULL -38  /* Multicast attachments exceeded. */
119 #define H_ALIAS_EXIST -39  /* Alias QP already defined. */
120 #define H_P_COUNTER -40  /* Invalid counter specification. */
121 #define H_TABLE_FULL -41  /* Resource page table full. */
122 #define H_ALT_TABLE -42  /* Alternate table already exists / alternate page
123 			    table not available. */
124 #define H_MR_CONDITION -43  /* Invalid memory region condition. */
125 #define H_NOT_ENOUGH_RESOURCES -44  /* Insufficient resources. */
126 #define H_R_STATE -45  /* Invalid resource state condition or sequencing
127 			  error. */
128 #define H_RESCINDED -46
129 #define H_ABORTED -54
130 #define H_P2 -55
131 #define H_P3 -56
132 #define H_P4 -57
133 #define H_P5 -58
134 #define H_P6 -59
135 #define H_P7 -60
136 #define H_P8 -61
137 #define H_P9 -62
138 #define H_NOOP -63
139 #define H_TOO_BIG -64
140 
141 #define H_UNSUPPORTED -67  /* Parameter value outside of the range supported
142 			      by this implementation. */
143 
144 /* Flags. */
145 /* Table 168. Page Frame Table Access flags field definition. */
146 #define H_EXACT                 (1UL<<(63-24))
147 #define H_R_XLATE               (1UL<<(63-25))
148 #define H_READ_4                (1UL<<(63-26))
149 
150 /* Table 178. CMO Page Usage State flags Definition. */
151 #define H_PAGE_STATE_CHANGE     (1UL<<(63-28))
152 #define H_PAGE_UNUSED           ((1UL<<(63-29)) | (1UL<<(63-30)))
153 #define H_PAGE_SET_UNUSED       (H_PAGE_STATE_CHANGE | H_PAGE_UNUSED)
154 #define H_PAGE_SET_LOANED       (H_PAGE_SET_UNUSED | (1UL<<(63-31)))
155 #define H_PAGE_SET_ACTIVE       H_PAGE_STATE_CHANGE
156 
157 /* Table 168. Page Frame Table Access flags field definition. */
158 #define H_AVPN                  (1UL<<(63-32))
159 #define H_ANDCOND               (1UL<<(63-33))
160 
161 #define H_ICACHE_INVALIDATE     (1UL<<(63-40))
162 #define H_ICACHE_SYNCHRONIZE    (1UL<<(63-41))
163 
164 #define H_ZERO_PAGE             (1UL<<(63-48))
165 #define H_COPY_PAGE             (1UL<<(63-49))
166 
167 #define H_N (1UL<<(63-61))
168 #define H_PP1 (1UL<<(63-62))
169 #define H_PP2 (1UL<<(63-63))
170 
171 /* pSeries hypervisor opcodes. */
172 #define H_REMOVE		0x04
173 #define H_ENTER			0x08
174 #define H_READ			0x0c
175 #define H_CLEAR_MOD		0x10
176 #define H_CLEAR_REF		0x14
177 #define H_PROTECT		0x18
178 #define H_GET_TCE		0x1c
179 #define H_PUT_TCE		0x20
180 #define H_SET_SPRG0		0x24
181 #define H_SET_DABR		0x28
182 #define H_PAGE_INIT		0x2c
183 #define H_SET_ASR		0x30
184 #define H_ASR_ON		0x34
185 #define H_ASR_OFF		0x38
186 #define H_LOGICAL_CI_LOAD	0x3c
187 #define H_LOGICAL_CI_STORE	0x40
188 #define H_LOGICAL_CACHE_LOAD	0x44
189 #define H_LOGICAL_CACHE_STORE	0x48
190 #define H_LOGICAL_ICBI		0x4c
191 #define H_LOGICAL_DCBF		0x50
192 #define H_GET_TERM_CHAR		0x54
193 #define H_PUT_TERM_CHAR		0x58
194 #define H_REAL_TO_LOGICAL	0x5c
195 #define H_HYPERVISOR_DATA	0x60
196 #define H_EOI			0x64
197 #define H_CPPR			0x68
198 #define H_IPI			0x6c
199 #define H_IPOLL			0x70
200 #define H_XIRR			0x74
201 #define H_MIGRATE_DMA		0x78
202 #define H_PERFMON		0x7c
203 #define H_REGISTER_VPA		0xdc
204 #define H_CEDE			0xe0
205 #define H_CONFER		0xe4
206 #define H_PROD			0xe8
207 #define H_GET_PPP		0xec
208 #define H_SET_PPP		0xf0
209 #define H_PURR			0xf4
210 #define H_PIC			0xf8
211 #define H_REG_CRQ		0xfc
212 #define H_FREE_CRQ		0x100
213 #define H_VIO_SIGNAL		0x104
214 #define H_SEND_CRQ		0x108
215 #define H_PUT_RTCE              0x10c
216 #define H_COPY_RDMA		0x110
217 #define H_REGISTER_LOGICAL_LAN	0x114
218 #define H_FREE_LOGICAL_LAN	0x118
219 #define H_ADD_LOGICAL_LAN_BUFFER 0x11c
220 #define H_SEND_LOGICAL_LAN	0x120
221 #define H_BULK_REMOVE		0x124
222 #define H_WRITE_RDMA            0x128
223 #define H_READ_RDMA             0x12c
224 #define H_MULTICAST_CTRL	0x130
225 #define H_SET_XDABR		0x134
226 #define H_STUFF_TCE		0x138
227 #define H_PUT_TCE_INDIRECT	0x13c
228 #define H_PUT_RTCE_INDIRECT	0x140
229 #define H_CHANGE_LOGICAL_LAN_MAC 0x14c
230 #define H_VTERM_PARTNER_INFO	0x150
231 #define H_REGISTER_VTERM	0x154
232 #define H_FREE_VTERM		0x158
233 /* Reserved ....
234 #define H_RESET_EVENTS          0x15c
235 #define H_ALLOC_RESOURCE        0x160
236 #define H_FREE_RESOURCE         0x164
237 #define H_MODIFY_QP             0x168
238 #define H_QUERY_QP              0x16c
239 #define H_REREGISTER_PMR        0x170
240 #define H_REGISTER_SMR          0x174
241 #define H_QUERY_MR              0x178
242 #define H_QUERY_MW              0x17c
243 #define H_QUERY_HCA             0x180
244 #define H_QUERY_PORT            0x184
245 #define H_MODIFY_PORT           0x188
246 #define H_DEFINE_AQP1           0x18c
247 #define H_GET_TRACE_BUFFER      0x190
248 #define H_DEFINE_AQP0           0x194
249 #define H_RESIZE_MR             0x198
250 #define H_ATTACH_MCQP           0x19c
251 #define H_DETACH_MCQP           0x1a0
252 #define H_CREATE_RPT            0x1a4
253 #define H_REMOVE_RPT            0x1a8
254 #define H_REGISTER_RPAGES       0x1ac
255 #define H_DISABLE_AND_GETC      0x1b0
256 #define H_ERROR_DATA            0x1b4
257 #define H_GET_HCA_INFO          0x1b8
258 #define H_GET_PERF_COUNT        0x1bc
259 #define H_MANAGE_TRACE          0x1c0
260 .... */
261 #define H_FREE_LOGICAL_LAN_BUFFER 0x1d4
262 #define H_POLL_PENDING		0x1d8
263 /* Reserved ....
264 #define H_QUERY_INT_STATE       0x1e4
265 .... */
266 #define H_LIOBN_ATTRIBUTES	0x240
267 #define H_ILLAN_ATTRIBUTES	0x244
268 #define H_REMOVE_RTCE	        0x24c
269 /* Reserved ...
270 #define H_MODIFY_HEA_QP		0x250
271 #define H_QUERY_HEA_QP		0x254
272 #define H_QUERY_HEA		0x258
273 #define H_QUERY_HEA_PORT	0x25c
274 #define H_MODIFY_HEA_PORT	0x260
275 #define H_REG_BCMC		0x264
276 #define H_DEREG_BCMC		0x268
277 #define H_REGISTER_HEA_RPAGES	0x26c
278 #define H_DISABLE_AND_GET_HEA	0x270
279 #define H_GET_HEA_INFO		0x274
280 #define H_ALLOC_HEA_RESOURCE	0x278
281 #define H_ADD_CONN		0x284
282 #define H_DEL_CONN		0x288
283 ... */
284 #define H_JOIN			0x298
285 #define H_DONOR_OPERATION	0x29c
286 #define H_VASI_SIGNAL	       	0x2a0
287 #define H_VASI_STATE            0x2a4
288 #define H_VIOCTL	       	0x2a8
289 #define H_VRMASD	       	0x2ac
290 #define H_ENABLE_CRQ		0x2b0
291 /* Reserved ...
292 #define H_GET_EM_PARMS		0x2b8
293 ... */
294 #define H_VPM_STAT	       	0x2bc
295 #define H_SET_MPP		0x2d0
296 #define H_GET_MPP		0x2d4
297 #define MAX_HCALL_OPCODE	H_GET_MPP
298 
299 int64_t phyp_hcall(uint64_t opcode, ...);
300 int64_t phyp_pft_hcall(uint64_t opcode, uint64_t flags, uint64_t pteidx,
301     uint64_t pte_hi, uint64_t pte_lo, uint64_t *pteidx_out, uint64_t *ptelo_out,
302     uint64_t *r6);
303 
304 #endif /* _PSERIES_PHYP_HVCALL_H_ */
305 
306