vmbus.h revision 308517
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 308517 2016-11-11 08:43:34Z 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 52307461Ssephe/* 53307455Ssephe * GPA stuffs. 54307455Ssephe */ 55307455Ssephestruct vmbus_gpa_range { 56307455Ssephe uint32_t gpa_len; 57307455Ssephe uint32_t gpa_ofs; 58307455Ssephe uint64_t gpa_page[0]; 59307455Ssephe} __packed; 60307455Ssephe 61302876Ssephe/* This is actually vmbus_gpa_range.gpa_page[1] */ 62302876Ssephestruct vmbus_gpa { 63302876Ssephe uint32_t gpa_len; 64302876Ssephe uint32_t gpa_ofs; 65302876Ssephe uint64_t gpa_page; 66302876Ssephe} __packed; 67302876Ssephe 68307457Ssephe#define VMBUS_CHANPKT_SIZE_SHIFT 3 69307457Ssephe 70307457Ssephe#define VMBUS_CHANPKT_GETLEN(pktlen) \ 71307457Ssephe (((int)(pktlen)) << VMBUS_CHANPKT_SIZE_SHIFT) 72307457Ssephe 73307457Ssephestruct vmbus_chanpkt_hdr { 74307457Ssephe uint16_t cph_type; /* VMBUS_CHANPKT_TYPE_ */ 75307457Ssephe uint16_t cph_hlen; /* header len, in 8 bytes */ 76307457Ssephe uint16_t cph_tlen; /* total len, in 8 bytes */ 77307457Ssephe uint16_t cph_flags; /* VMBUS_CHANPKT_FLAG_ */ 78307457Ssephe uint64_t cph_xactid; 79307457Ssephe} __packed; 80307457Ssephe 81307455Ssephe#define VMBUS_CHANPKT_TYPE_INBAND 0x0006 82307455Ssephe#define VMBUS_CHANPKT_TYPE_RXBUF 0x0007 83307455Ssephe#define VMBUS_CHANPKT_TYPE_GPA 0x0009 84307455Ssephe#define VMBUS_CHANPKT_TYPE_COMP 0x000b 85302876Ssephe 86307476Ssephe#define VMBUS_CHANPKT_FLAG_NONE 0 87307455Ssephe#define VMBUS_CHANPKT_FLAG_RC 0x0001 /* report completion */ 88307455Ssephe 89307457Ssephe#define VMBUS_CHANPKT_CONST_DATA(pkt) \ 90307457Ssephe (const void *)((const uint8_t *)(pkt) + \ 91307457Ssephe VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen)) 92307457Ssephe 93307475Ssephe/* Include padding */ 94307475Ssephe#define VMBUS_CHANPKT_DATALEN(pkt) \ 95307475Ssephe (VMBUS_CHANPKT_GETLEN((pkt)->cph_tlen) -\ 96307475Ssephe VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen)) 97307475Ssephe 98307457Ssephestruct vmbus_rxbuf_desc { 99307457Ssephe uint32_t rb_len; 100307457Ssephe uint32_t rb_ofs; 101307457Ssephe} __packed; 102307457Ssephe 103307457Ssephestruct vmbus_chanpkt_rxbuf { 104307457Ssephe struct vmbus_chanpkt_hdr cp_hdr; 105307457Ssephe uint16_t cp_rxbuf_id; 106307457Ssephe uint16_t cp_rsvd; 107307457Ssephe uint32_t cp_rxbuf_cnt; 108307457Ssephe struct vmbus_rxbuf_desc cp_rxbuf[]; 109307457Ssephe} __packed; 110307457Ssephe 111307595Ssephestruct vmbus_chan_br { 112307595Ssephe void *cbr; 113307595Ssephe bus_addr_t cbr_paddr; 114307595Ssephe int cbr_txsz; 115307595Ssephe int cbr_rxsz; 116307595Ssephe}; 117307595Ssephe 118307461Ssephestruct vmbus_channel; 119307461Ssephestruct hyperv_guid; 120307614Ssephestruct task; 121308517Ssephestruct taskqueue; 122302876Ssephe 123307461Ssephetypedef void (*vmbus_chan_callback_t)(struct vmbus_channel *, void *); 124307461Ssephe 125307461Ssephestatic __inline struct vmbus_channel * 126307461Ssephevmbus_get_channel(device_t dev) 127307461Ssephe{ 128307461Ssephe return device_get_ivars(dev); 129307461Ssephe} 130307461Ssephe 131307466Ssepheint vmbus_chan_open(struct vmbus_channel *chan, 132307466Ssephe int txbr_size, int rxbr_size, const void *udata, int udlen, 133307466Ssephe vmbus_chan_callback_t cb, void *cbarg); 134307595Ssepheint vmbus_chan_open_br(struct vmbus_channel *chan, 135307595Ssephe const struct vmbus_chan_br *cbr, const void *udata, 136307595Ssephe int udlen, vmbus_chan_callback_t cb, void *cbarg); 137307466Ssephevoid vmbus_chan_close(struct vmbus_channel *chan); 138307599Ssephevoid vmbus_chan_intr_drain(struct vmbus_channel *chan); 139307614Ssephevoid vmbus_chan_run_task(struct vmbus_channel *chan, 140307614Ssephe struct task *task); 141307459Ssephe 142307466Ssepheint vmbus_chan_gpadl_connect(struct vmbus_channel *chan, 143307466Ssephe bus_addr_t paddr, int size, uint32_t *gpadl); 144307466Ssepheint vmbus_chan_gpadl_disconnect(struct vmbus_channel *chan, 145307466Ssephe uint32_t gpadl); 146307459Ssephe 147307466Ssephevoid vmbus_chan_cpu_set(struct vmbus_channel *chan, int cpu); 148307466Ssephevoid vmbus_chan_cpu_rr(struct vmbus_channel *chan); 149307461Ssephestruct vmbus_channel * 150307466Ssephe vmbus_chan_cpu2chan(struct vmbus_channel *chan, int cpu); 151307466Ssephevoid vmbus_chan_set_readbatch(struct vmbus_channel *chan, bool on); 152307459Ssephe 153307461Ssephestruct vmbus_channel ** 154307466Ssephe vmbus_subchan_get(struct vmbus_channel *pri_chan, 155307466Ssephe int subchan_cnt); 156307466Ssephevoid vmbus_subchan_rel(struct vmbus_channel **subchan, 157307466Ssephe int subchan_cnt); 158307466Ssephevoid vmbus_subchan_drain(struct vmbus_channel *pri_chan); 159307459Ssephe 160307466Ssepheint vmbus_chan_recv(struct vmbus_channel *chan, void *data, int *dlen, 161307466Ssephe uint64_t *xactid); 162307466Ssepheint vmbus_chan_recv_pkt(struct vmbus_channel *chan, 163307466Ssephe struct vmbus_chanpkt_hdr *pkt, int *pktlen); 164307457Ssephe 165307466Ssepheint vmbus_chan_send(struct vmbus_channel *chan, uint16_t type, 166307466Ssephe uint16_t flags, void *data, int dlen, uint64_t xactid); 167307466Ssepheint vmbus_chan_send_sglist(struct vmbus_channel *chan, 168307466Ssephe struct vmbus_gpa sg[], int sglen, void *data, int dlen, 169307466Ssephe uint64_t xactid); 170307466Ssepheint vmbus_chan_send_prplist(struct vmbus_channel *chan, 171307466Ssephe struct vmbus_gpa_range *prp, int prp_cnt, void *data, 172307466Ssephe int dlen, uint64_t xactid); 173302876Ssephe 174307466Ssepheuint32_t vmbus_chan_id(const struct vmbus_channel *chan); 175307466Ssepheuint32_t vmbus_chan_subidx(const struct vmbus_channel *chan); 176307466Ssephebool vmbus_chan_is_primary(const struct vmbus_channel *chan); 177307461Ssepheconst struct hyperv_guid * 178307466Ssephe vmbus_chan_guid_inst(const struct vmbus_channel *chan); 179307486Ssepheint vmbus_chan_prplist_nelem(int br_size, int prpcnt_max, 180307486Ssephe int dlen_max); 181307599Ssephebool vmbus_chan_rx_empty(const struct vmbus_channel *chan); 182307599Ssephebool vmbus_chan_tx_empty(const struct vmbus_channel *chan); 183308517Ssephestruct taskqueue * 184308517Ssephe vmbus_chan_mgmt_tq(const struct vmbus_channel *chan); 185307461Ssephe 186302876Ssephe#endif /* !_VMBUS_H_ */ 187