1 /*- 2 * Copyright (c) 2016 Microsoft Corp. 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 unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #ifndef _VMBUS_REG_H_ 28 #define _VMBUS_REG_H_ 29 30 #include <sys/param.h> 31 #include <dev/hyperv/include/hyperv.h> /* XXX for hyperv_guid */ 32 #include <dev/hyperv/include/vmbus.h> 33 #if defined(__aarch64__) 34 #include <dev/hyperv/vmbus/aarch64/hyperv_reg.h> 35 #else 36 #include <dev/hyperv/vmbus/x86/hyperv_reg.h> 37 #endif 38 #include <dev/hyperv/vmbus/hyperv_common_reg.h> 39 40 /* 41 * Hyper-V SynIC message format. 42 */ 43 44 #define VMBUS_MSG_DSIZE_MAX 240 45 #define VMBUS_MSG_SIZE 256 46 47 struct vmbus_message { 48 uint32_t msg_type; /* HYPERV_MSGTYPE_ */ 49 uint8_t msg_dsize; /* data size */ 50 uint8_t msg_flags; /* VMBUS_MSGFLAG_ */ 51 uint16_t msg_rsvd; 52 uint64_t msg_id; 53 uint8_t msg_data[VMBUS_MSG_DSIZE_MAX]; 54 } __packed; 55 CTASSERT(sizeof(struct vmbus_message) == VMBUS_MSG_SIZE); 56 57 #define VMBUS_MSGFLAG_PENDING 0x01 58 59 /* 60 * Hyper-V SynIC event flags 61 */ 62 63 #define VMBUS_EVTFLAG_LEN (sizeof(u_long) * 8) 64 #define VMBUS_EVTFLAG_MASK (VMBUS_EVTFLAG_LEN - 1) 65 #define VMBUS_EVTFLAGS_SIZE 256 66 #define VMBUS_EVTFLAGS_MAX (VMBUS_EVTFLAGS_SIZE / sizeof(u_long)) 67 68 struct vmbus_evtflags { 69 u_long evt_flags[VMBUS_EVTFLAGS_MAX]; 70 } __packed; 71 CTASSERT(sizeof(struct vmbus_evtflags) == VMBUS_EVTFLAGS_SIZE); 72 73 /* 74 * Hyper-V Monitor Notification Facility 75 */ 76 77 struct vmbus_mon_trig { 78 uint32_t mt_pending; 79 uint32_t mt_armed; 80 } __packed; 81 82 #define VMBUS_MONTRIGS_MAX 4 83 #define VMBUS_MONTRIG_LEN 32 84 85 struct vmbus_mnf { 86 uint32_t mnf_state; 87 uint32_t mnf_rsvd1; 88 89 struct vmbus_mon_trig mnf_trigs[VMBUS_MONTRIGS_MAX]; 90 uint8_t mnf_rsvd2[536]; 91 92 uint16_t mnf_lat[VMBUS_MONTRIGS_MAX][VMBUS_MONTRIG_LEN]; 93 uint8_t mnf_rsvd3[256]; 94 95 struct hyperv_mon_param 96 mnf_param[VMBUS_MONTRIGS_MAX][VMBUS_MONTRIG_LEN]; 97 uint8_t mnf_rsvd4[1984]; 98 } __packed; 99 CTASSERT(sizeof(struct vmbus_mnf) == PAGE_SIZE); 100 101 /* 102 * Buffer ring 103 */ 104 struct vmbus_bufring { 105 /* 106 * If br_windex == br_rindex, this bufring is empty; this 107 * means we can _not_ write data to the bufring, if the 108 * write is going to make br_windex same as br_rindex. 109 */ 110 volatile uint32_t br_windex; 111 volatile uint32_t br_rindex; 112 113 /* 114 * Interrupt mask {0,1} 115 * 116 * For TX bufring, host set this to 1, when it is processing 117 * the TX bufring, so that we can safely skip the TX event 118 * notification to host. 119 * 120 * For RX bufring, once this is set to 1 by us, host will not 121 * further dispatch interrupts to us, even if there are data 122 * pending on the RX bufring. This effectively disables the 123 * interrupt of the channel to which this RX bufring is attached. 124 */ 125 volatile uint32_t br_imask; 126 127 /* 128 * WS2012/Win8 and later versions of Hyper-V implement interrupt 129 * driven flow management. The feature bit feat_pending_snd_sz 130 * is set by the host on the host->guest buffer ring, and by the 131 * guest on the guest->host buffer ring. 132 * 133 * The meaning of the feature bit is a bit complex in that it has 134 * semantics that apply to both buffer rings. If the guest sets 135 * the feature bit in the guest->host buffer ring, the guest is 136 * telling the host that: 137 * 1) It will set the br_pending_snd_sz field in the guest->host buffer 138 * ring when it is waiting for space to become available, and 139 * 2) It will read the pending_send_sz field in the host->guest 140 * ring buffer and interrupt the host when it frees enough space 141 * 142 * Similarly, if the host sets the feature bit in the host->guest 143 * ring buffer, the host is telling the guest that: 144 * 1) It will set the pending_send_sz field in the host->guest ring 145 * buffer when it is waiting for space to become available, and 146 * 2) It will read the pending_send_sz field in the guest->host 147 * ring buffer and interrupt the guest when it frees enough space 148 * 149 * If either the guest or host does not set the feature bit that it 150 * owns, that guest or host must do polling if it encounters a full 151 * ring buffer, and not signal the other end with an interrupt. 152 */ 153 volatile uint32_t br_pending_snd_sz; 154 uint32_t br_rsvd1[12]; 155 union { 156 struct { 157 uint32_t feat_pending_snd_sz:1; 158 }; 159 uint32_t value; 160 } br_feature_bits; 161 162 /* Padding to PAGE_SIZE */ 163 uint8_t br_rsvd2[4020]; 164 165 /* 166 * Total guest to host interrupt count 167 * - For rx ring, this counts the guest signaling host when this rx 168 * ring changing from full to not full. 169 * 170 * - For tx ring, this counts the guest signaling host when this tx 171 * ring changing from empty to non empty. 172 */ 173 uint64_t br_g2h_intr_cnt; 174 175 uint8_t br_data[]; 176 } __packed; 177 CTASSERT(sizeof(struct vmbus_bufring) == PAGE_SIZE); 178 179 /* 180 * Channel 181 */ 182 183 #define VMBUS_CHAN_MAX_COMPAT 256 184 #define VMBUS_CHAN_MAX (VMBUS_EVTFLAG_LEN * VMBUS_EVTFLAGS_MAX) 185 186 /* 187 * Channel packets 188 */ 189 190 #define VMBUS_CHANPKT_SIZE_ALIGN (1 << VMBUS_CHANPKT_SIZE_SHIFT) 191 192 #define VMBUS_CHANPKT_SETLEN(pktlen, len) \ 193 do { \ 194 (pktlen) = (len) >> VMBUS_CHANPKT_SIZE_SHIFT; \ 195 } while (0) 196 197 #define VMBUS_CHANPKT_TOTLEN(tlen) \ 198 roundup2((tlen), VMBUS_CHANPKT_SIZE_ALIGN) 199 200 #define VMBUS_CHANPKT_HLEN_MIN \ 201 (sizeof(struct vmbus_chanpkt_hdr) >> VMBUS_CHANPKT_SIZE_SHIFT) 202 203 struct vmbus_chanpkt { 204 struct vmbus_chanpkt_hdr cp_hdr; 205 } __packed; 206 207 struct vmbus_chanpkt_sglist { 208 struct vmbus_chanpkt_hdr cp_hdr; 209 uint32_t cp_rsvd; 210 uint32_t cp_gpa_cnt; 211 struct vmbus_gpa cp_gpa[]; 212 } __packed; 213 214 struct vmbus_chanpkt_prplist { 215 struct vmbus_chanpkt_hdr cp_hdr; 216 uint32_t cp_rsvd; 217 uint32_t cp_range_cnt; 218 struct vmbus_gpa_range cp_range[]; 219 } __packed; 220 221 /* 222 * Channel messages 223 * - Embedded in vmbus_message.msg_data, e.g. response and notification. 224 * - Embedded in hypercall_postmsg_in.hc_data, e.g. request. 225 */ 226 227 #define VMBUS_CHANMSG_TYPE_CHOFFER 1 /* NOTE */ 228 #define VMBUS_CHANMSG_TYPE_CHRESCIND 2 /* NOTE */ 229 #define VMBUS_CHANMSG_TYPE_CHREQUEST 3 /* REQ */ 230 #define VMBUS_CHANMSG_TYPE_CHOFFER_DONE 4 /* NOTE */ 231 #define VMBUS_CHANMSG_TYPE_CHOPEN 5 /* REQ */ 232 #define VMBUS_CHANMSG_TYPE_CHOPEN_RESP 6 /* RESP */ 233 #define VMBUS_CHANMSG_TYPE_CHCLOSE 7 /* REQ */ 234 #define VMBUS_CHANMSG_TYPE_GPADL_CONN 8 /* REQ */ 235 #define VMBUS_CHANMSG_TYPE_GPADL_SUBCONN 9 /* REQ */ 236 #define VMBUS_CHANMSG_TYPE_GPADL_CONNRESP 10 /* RESP */ 237 #define VMBUS_CHANMSG_TYPE_GPADL_DISCONN 11 /* REQ */ 238 #define VMBUS_CHANMSG_TYPE_GPADL_DISCONNRESP 12 /* RESP */ 239 #define VMBUS_CHANMSG_TYPE_CHFREE 13 /* REQ */ 240 #define VMBUS_CHANMSG_TYPE_CONNECT 14 /* REQ */ 241 #define VMBUS_CHANMSG_TYPE_CONNECT_RESP 15 /* RESP */ 242 #define VMBUS_CHANMSG_TYPE_DISCONNECT 16 /* REQ */ 243 #define VMBUS_CHANMSG_TYPE_17 17 244 #define VMBUS_CHANMSG_TYPE_18 18 245 #define VMBUS_CHANMSG_TYPE_19 19 246 #define VMBUS_CHANMSG_TYPE_20 20 247 #define VMBUS_CHANMSG_TYPE_TL_CONN 21 /* REQ */ 248 #define VMBUS_CHANMSG_TYPE_22 22 249 #define VMBUS_CHANMSG_TYPE_TL_RESULT 23 /* RESP */ 250 #define VMBUS_CHANMSG_TYPE_MAX 24 251 252 struct vmbus_chanmsg_hdr { 253 uint32_t chm_type; /* VMBUS_CHANMSG_TYPE_ */ 254 uint32_t chm_rsvd; 255 } __packed; 256 257 /* VMBUS_CHANMSG_TYPE_CONNECT */ 258 struct vmbus_chanmsg_connect { 259 struct vmbus_chanmsg_hdr chm_hdr; 260 uint32_t chm_ver; 261 uint32_t chm_rsvd; 262 uint64_t chm_evtflags; 263 uint64_t chm_mnf1; 264 uint64_t chm_mnf2; 265 } __packed; 266 267 /* VMBUS_CHANMSG_TYPE_CONNECT_RESP */ 268 struct vmbus_chanmsg_connect_resp { 269 struct vmbus_chanmsg_hdr chm_hdr; 270 uint8_t chm_done; 271 } __packed; 272 273 /* VMBUS_CHANMSG_TYPE_CHREQUEST */ 274 struct vmbus_chanmsg_chrequest { 275 struct vmbus_chanmsg_hdr chm_hdr; 276 } __packed; 277 278 /* VMBUS_CHANMSG_TYPE_DISCONNECT */ 279 struct vmbus_chanmsg_disconnect { 280 struct vmbus_chanmsg_hdr chm_hdr; 281 } __packed; 282 283 /* VMBUS_CHANMSG_TYPE_TL_CONN */ 284 /* Hyper-V socket guest connect request */ 285 struct vmbus_chanmsg_tl_connect { 286 struct vmbus_chanmsg_hdr chm_hdr; 287 struct hyperv_guid guest_endpoint_id; 288 struct hyperv_guid host_service_id; 289 } __packed; 290 291 292 /* VMBUS_CHANMSG_TYPE_CHOPEN */ 293 struct vmbus_chanmsg_chopen { 294 struct vmbus_chanmsg_hdr chm_hdr; 295 uint32_t chm_chanid; 296 uint32_t chm_openid; 297 uint32_t chm_gpadl; 298 uint32_t chm_vcpuid; 299 uint32_t chm_txbr_pgcnt; 300 #define VMBUS_CHANMSG_CHOPEN_UDATA_SIZE 120 301 uint8_t chm_udata[VMBUS_CHANMSG_CHOPEN_UDATA_SIZE]; 302 } __packed; 303 304 /* VMBUS_CHANMSG_TYPE_CHOPEN_RESP */ 305 struct vmbus_chanmsg_chopen_resp { 306 struct vmbus_chanmsg_hdr chm_hdr; 307 uint32_t chm_chanid; 308 uint32_t chm_openid; 309 uint32_t chm_status; 310 } __packed; 311 312 /* VMBUS_CHANMSG_TYPE_GPADL_CONN */ 313 struct vmbus_chanmsg_gpadl_conn { 314 struct vmbus_chanmsg_hdr chm_hdr; 315 uint32_t chm_chanid; 316 uint32_t chm_gpadl; 317 uint16_t chm_range_len; 318 uint16_t chm_range_cnt; 319 struct vmbus_gpa_range chm_range; 320 } __packed; 321 322 #define VMBUS_CHANMSG_GPADL_CONN_PGMAX 26 323 CTASSERT(__offsetof(struct vmbus_chanmsg_gpadl_conn, 324 chm_range.gpa_page[VMBUS_CHANMSG_GPADL_CONN_PGMAX]) <= 325 HYPERCALL_POSTMSGIN_DSIZE_MAX); 326 327 /* VMBUS_CHANMSG_TYPE_GPADL_SUBCONN */ 328 struct vmbus_chanmsg_gpadl_subconn { 329 struct vmbus_chanmsg_hdr chm_hdr; 330 uint32_t chm_msgno; 331 uint32_t chm_gpadl; 332 uint64_t chm_gpa_page[]; 333 } __packed; 334 335 #define VMBUS_CHANMSG_GPADL_SUBCONN_PGMAX 28 336 CTASSERT(__offsetof(struct vmbus_chanmsg_gpadl_subconn, 337 chm_gpa_page[VMBUS_CHANMSG_GPADL_SUBCONN_PGMAX]) <= 338 HYPERCALL_POSTMSGIN_DSIZE_MAX); 339 340 /* VMBUS_CHANMSG_TYPE_GPADL_CONNRESP */ 341 struct vmbus_chanmsg_gpadl_connresp { 342 struct vmbus_chanmsg_hdr chm_hdr; 343 uint32_t chm_chanid; 344 uint32_t chm_gpadl; 345 uint32_t chm_status; 346 } __packed; 347 348 /* VMBUS_CHANMSG_TYPE_CHCLOSE */ 349 struct vmbus_chanmsg_chclose { 350 struct vmbus_chanmsg_hdr chm_hdr; 351 uint32_t chm_chanid; 352 } __packed; 353 354 /* VMBUS_CHANMSG_TYPE_GPADL_DISCONN */ 355 struct vmbus_chanmsg_gpadl_disconn { 356 struct vmbus_chanmsg_hdr chm_hdr; 357 uint32_t chm_chanid; 358 uint32_t chm_gpadl; 359 } __packed; 360 361 /* VMBUS_CHANMSG_TYPE_CHFREE */ 362 struct vmbus_chanmsg_chfree { 363 struct vmbus_chanmsg_hdr chm_hdr; 364 uint32_t chm_chanid; 365 } __packed; 366 367 /* VMBUS_CHANMSG_TYPE_CHRESCIND */ 368 struct vmbus_chanmsg_chrescind { 369 struct vmbus_chanmsg_hdr chm_hdr; 370 uint32_t chm_chanid; 371 } __packed; 372 373 /* Size of the user defined data buffer for non-pipe offers */ 374 #define VMBUS_CHANMSG_CHOFFER_UDATA_SIZE 120 375 376 /* Size of the user defined data buffer for pipe offers. */ 377 #define VMBUS_CHANMSG_CHOFFER_UDATA_PIPE_SIZE 116 378 379 /* VMBUS_CHANMSG_TYPE_CHOFFER */ 380 struct vmbus_chanmsg_choffer { 381 struct vmbus_chanmsg_hdr chm_hdr; 382 struct hyperv_guid chm_chtype; 383 struct hyperv_guid chm_chinst; 384 uint64_t chm_chlat; /* unit: 100ns */ 385 uint32_t chm_chrev; 386 uint32_t chm_svrctx_sz; 387 uint16_t chm_chflags; 388 uint16_t chm_mmio_sz; /* unit: MB */ 389 390 union { 391 /* Non-pipes */ 392 struct { 393 uint8_t user_def[VMBUS_CHANMSG_CHOFFER_UDATA_SIZE]; 394 } std; 395 /* 396 * Pipes: 397 * For integrated pipe protocol, which is implemented on 398 * top of standard user-defined data. Pipe clients have 399 * VMBUS_CHANMSG_CHOFFER_UDATA_PIPE_SIZE bytes left for 400 * their own user. 401 */ 402 struct { 403 uint32_t pipe_mode; 404 uint8_t 405 user_def[VMBUS_CHANMSG_CHOFFER_UDATA_PIPE_SIZE]; 406 } pipe; 407 } chm_udata; 408 409 uint16_t chm_subidx; 410 uint16_t chm_rsvd; 411 uint32_t chm_chanid; 412 uint8_t chm_montrig; 413 uint8_t chm_flags1; /* VMBUS_CHOFFER_FLAG1_ */ 414 uint16_t chm_flags2; 415 uint32_t chm_connid; 416 } __packed; 417 CTASSERT(sizeof(struct vmbus_chanmsg_choffer) <= VMBUS_MSG_DSIZE_MAX); 418 419 /* Server Flag */ 420 #define VMBUS_CHAN_TLNPI_PROVIDER_OFFER 0x2000 421 422 #define VMBUS_CHOFFER_FLAG1_HASMNF 0x01 423 424 #endif /* !_VMBUS_REG_H_ */ 425