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