1302876Ssephe/*- 2302876Ssephe * Copyright (c) 2016 Microsoft Corp. 3302876Ssephe * All rights reserved. 4302876Ssephe * 5302876Ssephe * Redistribution and use in source and binary forms, with or without 6302876Ssephe * modification, are permitted provided that the following conditions 7302876Ssephe * are met: 8302876Ssephe * 1. Redistributions of source code must retain the above copyright 9302876Ssephe * notice unmodified, this list of conditions, and the following 10302876Ssephe * disclaimer. 11302876Ssephe * 2. Redistributions in binary form must reproduce the above copyright 12302876Ssephe * notice, this list of conditions and the following disclaimer in the 13302876Ssephe * documentation and/or other materials provided with the distribution. 14302876Ssephe * 15302876Ssephe * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16302876Ssephe * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17302876Ssephe * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18302876Ssephe * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19302876Ssephe * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20302876Ssephe * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21302876Ssephe * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22302876Ssephe * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23302876Ssephe * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24302876Ssephe * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25302876Ssephe * 26302876Ssephe * $FreeBSD: stable/11/sys/dev/hyperv/include/vmbus.h 311375 2017-01-05 06:25:16Z sephe $ 27302876Ssephe */ 28302876Ssephe 29302876Ssephe#ifndef _VMBUS_H_ 30302876Ssephe#define _VMBUS_H_ 31302876Ssephe 32302876Ssephe#include <sys/param.h> 33307466Ssephe#include <sys/bus.h> 34302876Ssephe 35307455Ssephe/* 36307461Ssephe * VMBUS version is 32 bit, upper 16 bit for major_number and lower 37307461Ssephe * 16 bit for minor_number. 38307461Ssephe * 39307461Ssephe * 0.13 -- Windows Server 2008 40307461Ssephe * 1.1 -- Windows 7 41307461Ssephe * 2.4 -- Windows 8 42307461Ssephe * 3.0 -- Windows 8.1 43307461Ssephe */ 44307461Ssephe#define VMBUS_VERSION_WS2008 ((0 << 16) | (13)) 45307461Ssephe#define VMBUS_VERSION_WIN7 ((1 << 16) | (1)) 46307461Ssephe#define VMBUS_VERSION_WIN8 ((2 << 16) | (4)) 47307461Ssephe#define VMBUS_VERSION_WIN8_1 ((3 << 16) | (0)) 48307461Ssephe 49307461Ssephe#define VMBUS_VERSION_MAJOR(ver) (((uint32_t)(ver)) >> 16) 50307461Ssephe#define VMBUS_VERSION_MINOR(ver) (((uint32_t)(ver)) & 0xffff) 51307461Ssephe 52311375Ssephe#define VMBUS_CHAN_POLLHZ_MIN 100 /* 10ms interval */ 53311375Ssephe#define VMBUS_CHAN_POLLHZ_MAX 1000000 /* 1us interval */ 54311375Ssephe 55307461Ssephe/* 56307455Ssephe * GPA stuffs. 57307455Ssephe */ 58307455Ssephestruct vmbus_gpa_range { 59307455Ssephe uint32_t gpa_len; 60307455Ssephe uint32_t gpa_ofs; 61307455Ssephe uint64_t gpa_page[0]; 62307455Ssephe} __packed; 63307455Ssephe 64302876Ssephe/* This is actually vmbus_gpa_range.gpa_page[1] */ 65302876Ssephestruct vmbus_gpa { 66302876Ssephe uint32_t gpa_len; 67302876Ssephe uint32_t gpa_ofs; 68302876Ssephe uint64_t gpa_page; 69302876Ssephe} __packed; 70302876Ssephe 71307457Ssephe#define VMBUS_CHANPKT_SIZE_SHIFT 3 72307457Ssephe 73307457Ssephe#define VMBUS_CHANPKT_GETLEN(pktlen) \ 74307457Ssephe (((int)(pktlen)) << VMBUS_CHANPKT_SIZE_SHIFT) 75307457Ssephe 76307457Ssephestruct vmbus_chanpkt_hdr { 77307457Ssephe uint16_t cph_type; /* VMBUS_CHANPKT_TYPE_ */ 78307457Ssephe uint16_t cph_hlen; /* header len, in 8 bytes */ 79307457Ssephe uint16_t cph_tlen; /* total len, in 8 bytes */ 80307457Ssephe uint16_t cph_flags; /* VMBUS_CHANPKT_FLAG_ */ 81307457Ssephe uint64_t cph_xactid; 82307457Ssephe} __packed; 83307457Ssephe 84307455Ssephe#define VMBUS_CHANPKT_TYPE_INBAND 0x0006 85307455Ssephe#define VMBUS_CHANPKT_TYPE_RXBUF 0x0007 86307455Ssephe#define VMBUS_CHANPKT_TYPE_GPA 0x0009 87307455Ssephe#define VMBUS_CHANPKT_TYPE_COMP 0x000b 88302876Ssephe 89307476Ssephe#define VMBUS_CHANPKT_FLAG_NONE 0 90307455Ssephe#define VMBUS_CHANPKT_FLAG_RC 0x0001 /* report completion */ 91307455Ssephe 92307457Ssephe#define VMBUS_CHANPKT_CONST_DATA(pkt) \ 93307457Ssephe (const void *)((const uint8_t *)(pkt) + \ 94307457Ssephe VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen)) 95307457Ssephe 96307475Ssephe/* Include padding */ 97307475Ssephe#define VMBUS_CHANPKT_DATALEN(pkt) \ 98307475Ssephe (VMBUS_CHANPKT_GETLEN((pkt)->cph_tlen) -\ 99307475Ssephe VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen)) 100307475Ssephe 101307457Ssephestruct vmbus_rxbuf_desc { 102307457Ssephe uint32_t rb_len; 103307457Ssephe uint32_t rb_ofs; 104307457Ssephe} __packed; 105307457Ssephe 106307457Ssephestruct vmbus_chanpkt_rxbuf { 107307457Ssephe struct vmbus_chanpkt_hdr cp_hdr; 108307457Ssephe uint16_t cp_rxbuf_id; 109307457Ssephe uint16_t cp_rsvd; 110307457Ssephe uint32_t cp_rxbuf_cnt; 111307457Ssephe struct vmbus_rxbuf_desc cp_rxbuf[]; 112307457Ssephe} __packed; 113307457Ssephe 114307595Ssephestruct vmbus_chan_br { 115307595Ssephe void *cbr; 116307595Ssephe bus_addr_t cbr_paddr; 117307595Ssephe int cbr_txsz; 118307595Ssephe int cbr_rxsz; 119307595Ssephe}; 120307595Ssephe 121307461Ssephestruct vmbus_channel; 122311364Ssephestruct vmbus_xact; 123311359Ssephestruct vmbus_xact_ctx; 124307461Ssephestruct hyperv_guid; 125307614Ssephestruct task; 126308517Ssephestruct taskqueue; 127302876Ssephe 128307461Ssephetypedef void (*vmbus_chan_callback_t)(struct vmbus_channel *, void *); 129307461Ssephe 130307461Ssephestatic __inline struct vmbus_channel * 131307461Ssephevmbus_get_channel(device_t dev) 132307461Ssephe{ 133307461Ssephe return device_get_ivars(dev); 134307461Ssephe} 135307461Ssephe 136311364Ssephe/* 137311364Ssephe * vmbus_chan_open_br() 138311364Ssephe * 139311364Ssephe * Return values: 140311364Ssephe * 0 Succeeded. 141311364Ssephe * EISCONN Failed, and the memory passed through 'br' is still 142311364Ssephe * connected. Callers must _not_ free the the memory 143311364Ssephe * passed through 'br', if this error happens. 144311364Ssephe * other values Failed. The memory passed through 'br' is no longer 145311364Ssephe * connected. Callers are free to do anything with the 146311364Ssephe * memory passed through 'br'. 147311364Ssephe * 148311364Ssephe * 149311364Ssephe * 150311364Ssephe * vmbus_chan_close_direct() 151311364Ssephe * 152311364Ssephe * NOTE: 153311364Ssephe * Callers of this function _must_ make sure to close all sub-channels before 154311364Ssephe * closing the primary channel. 155311364Ssephe * 156311364Ssephe * Return values: 157311364Ssephe * 0 Succeeded. 158311364Ssephe * EISCONN Failed, and the memory associated with the bufring 159311364Ssephe * is still connected. Callers must _not_ free the the 160311364Ssephe * memory associated with the bufring, if this error 161311364Ssephe * happens. 162311364Ssephe * other values Failed. The memory associated with the bufring is 163311364Ssephe * no longer connected. Callers are free to do anything 164311364Ssephe * with the memory associated with the bufring. 165311364Ssephe */ 166307466Ssepheint vmbus_chan_open(struct vmbus_channel *chan, 167307466Ssephe int txbr_size, int rxbr_size, const void *udata, int udlen, 168307466Ssephe vmbus_chan_callback_t cb, void *cbarg); 169307595Ssepheint vmbus_chan_open_br(struct vmbus_channel *chan, 170307595Ssephe const struct vmbus_chan_br *cbr, const void *udata, 171307595Ssephe int udlen, vmbus_chan_callback_t cb, void *cbarg); 172307466Ssephevoid vmbus_chan_close(struct vmbus_channel *chan); 173311364Ssepheint vmbus_chan_close_direct(struct vmbus_channel *chan); 174307599Ssephevoid vmbus_chan_intr_drain(struct vmbus_channel *chan); 175307614Ssephevoid vmbus_chan_run_task(struct vmbus_channel *chan, 176307614Ssephe struct task *task); 177311359Ssephevoid vmbus_chan_set_orphan(struct vmbus_channel *chan, 178311359Ssephe struct vmbus_xact_ctx *); 179311359Ssephevoid vmbus_chan_unset_orphan(struct vmbus_channel *chan); 180311364Ssepheconst void *vmbus_chan_xact_wait(const struct vmbus_channel *chan, 181311364Ssephe struct vmbus_xact *xact, size_t *resp_len, bool can_sleep); 182307459Ssephe 183307466Ssepheint vmbus_chan_gpadl_connect(struct vmbus_channel *chan, 184307466Ssephe bus_addr_t paddr, int size, uint32_t *gpadl); 185307466Ssepheint vmbus_chan_gpadl_disconnect(struct vmbus_channel *chan, 186307466Ssephe uint32_t gpadl); 187307459Ssephe 188307466Ssephevoid vmbus_chan_cpu_set(struct vmbus_channel *chan, int cpu); 189307466Ssephevoid vmbus_chan_cpu_rr(struct vmbus_channel *chan); 190307466Ssephevoid vmbus_chan_set_readbatch(struct vmbus_channel *chan, bool on); 191307459Ssephe 192307461Ssephestruct vmbus_channel ** 193307466Ssephe vmbus_subchan_get(struct vmbus_channel *pri_chan, 194307466Ssephe int subchan_cnt); 195307466Ssephevoid vmbus_subchan_rel(struct vmbus_channel **subchan, 196307466Ssephe int subchan_cnt); 197307466Ssephevoid vmbus_subchan_drain(struct vmbus_channel *pri_chan); 198307459Ssephe 199307466Ssepheint vmbus_chan_recv(struct vmbus_channel *chan, void *data, int *dlen, 200307466Ssephe uint64_t *xactid); 201307466Ssepheint vmbus_chan_recv_pkt(struct vmbus_channel *chan, 202307466Ssephe struct vmbus_chanpkt_hdr *pkt, int *pktlen); 203307457Ssephe 204307466Ssepheint vmbus_chan_send(struct vmbus_channel *chan, uint16_t type, 205307466Ssephe uint16_t flags, void *data, int dlen, uint64_t xactid); 206307466Ssepheint vmbus_chan_send_sglist(struct vmbus_channel *chan, 207307466Ssephe struct vmbus_gpa sg[], int sglen, void *data, int dlen, 208307466Ssephe uint64_t xactid); 209307466Ssepheint vmbus_chan_send_prplist(struct vmbus_channel *chan, 210307466Ssephe struct vmbus_gpa_range *prp, int prp_cnt, void *data, 211307466Ssephe int dlen, uint64_t xactid); 212302876Ssephe 213307466Ssepheuint32_t vmbus_chan_id(const struct vmbus_channel *chan); 214307466Ssepheuint32_t vmbus_chan_subidx(const struct vmbus_channel *chan); 215307466Ssephebool vmbus_chan_is_primary(const struct vmbus_channel *chan); 216311359Ssephebool vmbus_chan_is_revoked(const struct vmbus_channel *chan); 217307461Ssepheconst struct hyperv_guid * 218307466Ssephe vmbus_chan_guid_inst(const struct vmbus_channel *chan); 219307486Ssepheint vmbus_chan_prplist_nelem(int br_size, int prpcnt_max, 220307486Ssephe int dlen_max); 221307599Ssephebool vmbus_chan_rx_empty(const struct vmbus_channel *chan); 222307599Ssephebool vmbus_chan_tx_empty(const struct vmbus_channel *chan); 223308517Ssephestruct taskqueue * 224308517Ssephe vmbus_chan_mgmt_tq(const struct vmbus_channel *chan); 225307461Ssephe 226311375Ssephevoid vmbus_chan_poll_enable(struct vmbus_channel *chan, 227311375Ssephe u_int pollhz); 228311375Ssephevoid vmbus_chan_poll_disable(struct vmbus_channel *chan); 229311375Ssephe 230302876Ssephe#endif /* !_VMBUS_H_ */ 231