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