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_H_ 28 #define _VMBUS_H_ 29 30 #include <sys/param.h> 31 #include <sys/bus.h> 32 #include <sys/_iovec.h> 33 34 /* 35 * VMBUS version is 32 bit, upper 16 bit for major_number and lower 36 * 16 bit for minor_number. 37 * 38 * 0.13 -- Windows Server 2008 39 * 1.1 -- Windows 7 40 * 2.4 -- Windows 8 41 * 3.0 -- Windows 8.1 42 * 4.0 -- Windows 10 43 * 5.0 -- Newer Windows 10 44 */ 45 #define VMBUS_VERSION_WS2008 ((0 << 16) | (13)) 46 #define VMBUS_VERSION_WIN7 ((1 << 16) | (1)) 47 #define VMBUS_VERSION_WIN8 ((2 << 16) | (4)) 48 #define VMBUS_VERSION_WIN8_1 ((3 << 16) | (0)) 49 #define VMBUS_VERSION_WIN10 ((4 << 16) | (0)) 50 #define VMBUS_VERSION_WIN10_V5 ((5 << 16) | (0)) 51 52 #define VMBUS_VERSION_MAJOR(ver) (((uint32_t)(ver)) >> 16) 53 #define VMBUS_VERSION_MINOR(ver) (((uint32_t)(ver)) & 0xffff) 54 55 #define VMBUS_CHAN_POLLHZ_MIN 100 /* 10ms interval */ 56 #define VMBUS_CHAN_POLLHZ_MAX 1000000 /* 1us interval */ 57 58 /* 59 * GPA stuffs. 60 */ 61 struct vmbus_gpa_range { 62 uint32_t gpa_len; 63 uint32_t gpa_ofs; 64 uint64_t gpa_page[0]; 65 } __packed; 66 67 /* This is actually vmbus_gpa_range.gpa_page[1] */ 68 struct vmbus_gpa { 69 uint32_t gpa_len; 70 uint32_t gpa_ofs; 71 uint64_t gpa_page; 72 } __packed; 73 74 #define VMBUS_CHANPKT_SIZE_SHIFT 3 75 76 #define VMBUS_CHANPKT_GETLEN(pktlen) \ 77 (((int)(pktlen)) << VMBUS_CHANPKT_SIZE_SHIFT) 78 79 struct vmbus_chanpkt_hdr { 80 uint16_t cph_type; /* VMBUS_CHANPKT_TYPE_ */ 81 uint16_t cph_hlen; /* header len, in 8 bytes */ 82 uint16_t cph_tlen; /* total len, in 8 bytes */ 83 uint16_t cph_flags; /* VMBUS_CHANPKT_FLAG_ */ 84 uint64_t cph_xactid; 85 } __packed; 86 87 #define VMBUS_CHANPKT_TYPE_INBAND 0x0006 88 #define VMBUS_CHANPKT_TYPE_RXBUF 0x0007 89 #define VMBUS_CHANPKT_TYPE_GPA 0x0009 90 #define VMBUS_CHANPKT_TYPE_COMP 0x000b 91 92 #define VMBUS_CHANPKT_FLAG_NONE 0 93 #define VMBUS_CHANPKT_FLAG_RC 0x0001 /* report completion */ 94 95 #define VMBUS_CHANPKT_CONST_DATA(pkt) \ 96 (const void *)((const uint8_t *)(pkt) + \ 97 VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen)) 98 99 /* Include padding */ 100 #define VMBUS_CHANPKT_DATALEN(pkt) \ 101 (VMBUS_CHANPKT_GETLEN((pkt)->cph_tlen) -\ 102 VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen)) 103 104 struct vmbus_rxbuf_desc { 105 uint32_t rb_len; 106 uint32_t rb_ofs; 107 } __packed; 108 109 struct vmbus_chanpkt_rxbuf { 110 struct vmbus_chanpkt_hdr cp_hdr; 111 uint16_t cp_rxbuf_id; 112 uint16_t cp_rsvd; 113 uint32_t cp_rxbuf_cnt; 114 struct vmbus_rxbuf_desc cp_rxbuf[]; 115 } __packed; 116 117 struct vmbus_chan_br { 118 void *cbr; 119 bus_addr_t cbr_paddr; 120 int cbr_txsz; 121 int cbr_rxsz; 122 }; 123 124 struct vmbus_channel; 125 struct vmbus_xact; 126 struct vmbus_xact_ctx; 127 struct hyperv_guid; 128 struct task; 129 struct taskqueue; 130 131 typedef void (*vmbus_chan_callback_t)(struct vmbus_channel *, void *); 132 typedef int (*vmbus_br_copy_callback_t)(void *, int, void *); 133 typedef void (*vmbus_chan_rescind_callback_t)(struct vmbus_channel *); 134 135 static __inline struct vmbus_channel * 136 vmbus_get_channel(device_t dev) 137 { 138 return device_get_ivars(dev); 139 } 140 141 /* 142 * vmbus_chan_open_br() 143 * 144 * Return values: 145 * 0 Succeeded. 146 * EISCONN Failed, and the memory passed through 'br' is still 147 * connected. Callers must _not_ free the memory 148 * passed through 'br', if this error happens. 149 * other values Failed. The memory passed through 'br' is no longer 150 * connected. Callers are free to do anything with the 151 * memory passed through 'br'. 152 * 153 * 154 * 155 * vmbus_chan_close_direct() 156 * 157 * NOTE: 158 * Callers of this function _must_ make sure to close all sub-channels before 159 * closing the primary channel. 160 * 161 * Return values: 162 * 0 Succeeded. 163 * EISCONN Failed, and the memory associated with the bufring 164 * is still connected. Callers must _not_ free the the 165 * memory associated with the bufring, if this error 166 * happens. 167 * other values Failed. The memory associated with the bufring is 168 * no longer connected. Callers are free to do anything 169 * with the memory associated with the bufring. 170 */ 171 int vmbus_chan_open(struct vmbus_channel *chan, 172 int txbr_size, int rxbr_size, const void *udata, int udlen, 173 vmbus_chan_callback_t cb, void *cbarg); 174 int vmbus_chan_open_br(struct vmbus_channel *chan, 175 const struct vmbus_chan_br *cbr, const void *udata, 176 int udlen, vmbus_chan_callback_t cb, void *cbarg); 177 void vmbus_chan_close(struct vmbus_channel *chan); 178 int vmbus_chan_close_direct(struct vmbus_channel *chan); 179 void vmbus_chan_intr_drain(struct vmbus_channel *chan); 180 void vmbus_chan_run_task(struct vmbus_channel *chan, 181 struct task *task); 182 void vmbus_chan_set_orphan(struct vmbus_channel *chan, 183 struct vmbus_xact_ctx *); 184 void vmbus_chan_unset_orphan(struct vmbus_channel *chan); 185 const void *vmbus_chan_xact_wait(const struct vmbus_channel *chan, 186 struct vmbus_xact *xact, size_t *resp_len, bool can_sleep); 187 188 int vmbus_chan_gpadl_connect(struct vmbus_channel *chan, 189 bus_addr_t paddr, int size, uint32_t *gpadl); 190 int vmbus_chan_gpadl_disconnect(struct vmbus_channel *chan, 191 uint32_t gpadl); 192 193 void vmbus_chan_cpu_set(struct vmbus_channel *chan, int cpu); 194 void vmbus_chan_cpu_rr(struct vmbus_channel *chan); 195 void vmbus_chan_set_readbatch(struct vmbus_channel *chan, bool on); 196 197 struct vmbus_channel ** 198 vmbus_subchan_get(struct vmbus_channel *pri_chan, 199 int subchan_cnt); 200 void vmbus_subchan_rel(struct vmbus_channel **subchan, 201 int subchan_cnt); 202 void vmbus_subchan_drain(struct vmbus_channel *pri_chan); 203 204 int vmbus_chan_recv(struct vmbus_channel *chan, void *data, int *dlen, 205 uint64_t *xactid); 206 int vmbus_chan_recv_pkt(struct vmbus_channel *chan, 207 struct vmbus_chanpkt_hdr *pkt, int *pktlen); 208 209 int vmbus_chan_recv_idxadv(struct vmbus_channel *chan, 210 uint32_t advance); 211 int vmbus_chan_recv_peek(struct vmbus_channel *chan, 212 void *data, int data_len, uint32_t advance); 213 int vmbus_chan_recv_peek_call(struct vmbus_channel *chan, 214 int data_len, uint32_t skip, 215 vmbus_br_copy_callback_t cb, void *cbarg); 216 217 int vmbus_chan_send(struct vmbus_channel *chan, uint16_t type, 218 uint16_t flags, void *data, int dlen, uint64_t xactid); 219 int vmbus_chan_send_sglist(struct vmbus_channel *chan, 220 struct vmbus_gpa sg[], int sglen, void *data, int dlen, 221 uint64_t xactid); 222 int vmbus_chan_send_prplist(struct vmbus_channel *chan, 223 struct vmbus_gpa_range *prp, int prp_cnt, void *data, 224 int dlen, uint64_t xactid); 225 int vmbus_chan_iov_send(struct vmbus_channel *chan, 226 const struct iovec iov[], int iovlen, 227 vmbus_br_copy_callback_t cb, void *cbarg); 228 uint32_t vmbus_chan_write_available(struct vmbus_channel *chan); 229 uint32_t vmbus_chan_read_available(struct vmbus_channel *chan); 230 bool vmbus_chan_write_signal(struct vmbus_channel *chan, 231 int32_t min_signal_size); 232 void vmbus_chan_set_pending_send_size(struct vmbus_channel *chan, 233 uint32_t size); 234 235 uint32_t vmbus_chan_id(const struct vmbus_channel *chan); 236 uint32_t vmbus_chan_subidx(const struct vmbus_channel *chan); 237 bool vmbus_chan_is_primary(const struct vmbus_channel *chan); 238 bool vmbus_chan_is_revoked(const struct vmbus_channel *chan); 239 bool vmbus_chan_is_hvs(const struct vmbus_channel *chan); 240 bool vmbus_chan_is_hvs_conn_from_host( 241 const struct vmbus_channel *chan); 242 int vmbus_req_tl_connect(struct hyperv_guid *, 243 struct hyperv_guid *); 244 245 struct hyperv_guid * 246 vmbus_chan_guid_type(struct vmbus_channel *chan); 247 struct hyperv_guid * 248 vmbus_chan_guid_inst(struct vmbus_channel *chan); 249 int vmbus_chan_prplist_nelem(int br_size, int prpcnt_max, 250 int dlen_max); 251 bool vmbus_chan_rx_empty(const struct vmbus_channel *chan); 252 bool vmbus_chan_tx_empty(const struct vmbus_channel *chan); 253 struct taskqueue * 254 vmbus_chan_mgmt_tq(const struct vmbus_channel *chan); 255 256 void vmbus_chan_poll_enable(struct vmbus_channel *chan, 257 u_int pollhz); 258 void vmbus_chan_poll_disable(struct vmbus_channel *chan); 259 260 #endif /* !_VMBUS_H_ */ 261