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_CHANVAR_H_ 30 #define _VMBUS_CHANVAR_H_ 31 32 #include <sys/param.h> 33 #include <sys/callout.h> 34 #include <sys/lock.h> 35 #include <sys/mutex.h> 36 #include <sys/queue.h> 37 #include <sys/sysctl.h> 38 #include <sys/sx.h> 39 #include <sys/taskqueue.h> 40 41 #include <dev/hyperv/include/hyperv.h> 42 #include <dev/hyperv/include/vmbus.h> 43 #include <dev/hyperv/vmbus/vmbus_brvar.h> 44 45 struct vmbus_channel { 46 /* 47 * NOTE: 48 * Fields before ch_txbr are only accessed on this channel's 49 * target CPU. 50 */ 51 uint32_t ch_flags; /* VMBUS_CHAN_FLAG_ */ 52 int ch_poll_flags; /* callout flags */ 53 54 /* 55 * RX bufring; immediately following ch_txbr. 56 */ 57 struct vmbus_rxbr ch_rxbr; 58 59 struct taskqueue *ch_tq; 60 struct task ch_task; 61 struct task ch_poll_task; 62 sbintime_t ch_poll_intvl; 63 struct callout ch_poll_timeo; 64 vmbus_chan_callback_t ch_cb; 65 void *ch_cbarg; 66 67 /* 68 * TX bufring; at the beginning of ch_bufring. 69 * 70 * NOTE: 71 * Put TX bufring and the following MNF/evtflag to a new 72 * cacheline, since they will be accessed on all CPUs by 73 * locking ch_txbr first. 74 * 75 * XXX 76 * TX bufring and following MNF/evtflags do _not_ fit in 77 * one 64B cacheline. 78 */ 79 struct vmbus_txbr ch_txbr __aligned(CACHE_LINE_SIZE); 80 uint32_t ch_txflags; /* VMBUS_CHAN_TXF_ */ 81 82 /* 83 * These are based on the vmbus_chanmsg_choffer.chm_montrig. 84 * Save it here for easy access. 85 */ 86 uint32_t ch_montrig_mask;/* MNF trig mask */ 87 volatile uint32_t *ch_montrig; /* MNF trigger loc. */ 88 89 /* 90 * These are based on the vmbus_chanmsg_choffer.chm_chanid. 91 * Save it here for easy access. 92 */ 93 u_long ch_evtflag_mask;/* event flag */ 94 volatile u_long *ch_evtflag; /* event flag loc. */ 95 96 /* 97 * Rarely used fields. 98 */ 99 100 struct hyperv_mon_param *ch_monprm; 101 102 uint32_t ch_id; /* channel id */ 103 device_t ch_dev; 104 struct vmbus_softc *ch_vmbus; 105 106 int ch_cpuid; /* owner cpu */ 107 /* 108 * Virtual cpuid for ch_cpuid; it is used to communicate cpuid 109 * related information w/ Hyper-V. If MSR_HV_VP_INDEX does not 110 * exist, ch_vcpuid will always be 0 for compatibility. 111 */ 112 uint32_t ch_vcpuid; 113 114 /* 115 * If this is a primary channel, ch_subchan* fields 116 * contain sub-channels belonging to this primary 117 * channel. 118 */ 119 struct mtx ch_subchan_lock; 120 TAILQ_HEAD(, vmbus_channel) ch_subchans; 121 int ch_subchan_cnt; 122 123 /* If this is a sub-channel */ 124 TAILQ_ENTRY(vmbus_channel) ch_sublink; /* sub-channel link */ 125 struct vmbus_channel *ch_prichan; /* owner primary chan */ 126 127 void *ch_bufring; /* TX+RX bufrings */ 128 size_t ch_bufring_size; 129 uint32_t ch_bufring_gpadl; 130 131 struct task ch_attach_task; /* run in ch_mgmt_tq */ 132 struct task ch_detach_task; /* run in ch_mgmt_tq */ 133 struct taskqueue *ch_mgmt_tq; 134 135 /* If this is a primary channel */ 136 TAILQ_ENTRY(vmbus_channel) ch_prilink; /* primary chan link */ 137 138 TAILQ_ENTRY(vmbus_channel) ch_link; /* channel link */ 139 uint32_t ch_subidx; /* subchan index */ 140 volatile uint32_t ch_stflags; /* atomic-op */ 141 /* VMBUS_CHAN_ST_ */ 142 struct hyperv_guid ch_guid_type; 143 struct hyperv_guid ch_guid_inst; 144 145 struct sx ch_orphan_lock; 146 struct vmbus_xact_ctx *ch_orphan_xact; 147 148 int ch_refs; 149 150 /* 151 * These are for HyperV socket channel only 152 */ 153 bool ch_is_hvs; 154 uint8_t ch_hvs_conn_from_host; 155 156 struct sysctl_ctx_list ch_sysctl_ctx; 157 } __aligned(CACHE_LINE_SIZE); 158 159 #define VMBUS_CHAN_ISPRIMARY(chan) ((chan)->ch_subidx == 0) 160 161 /* 162 * If this flag is set, this channel's interrupt will be masked in ISR, 163 * and the RX bufring will be drained before this channel's interrupt is 164 * unmasked. 165 * 166 * This flag is turned on by default. Drivers can turn it off according 167 * to their own requirement. 168 */ 169 #define VMBUS_CHAN_FLAG_BATCHREAD 0x0002 170 171 #define VMBUS_CHAN_TXF_HASMNF 0x0001 172 173 #define VMBUS_CHAN_ST_OPENED_SHIFT 0 174 #define VMBUS_CHAN_ST_ONPRIL_SHIFT 1 175 #define VMBUS_CHAN_ST_ONSUBL_SHIFT 2 176 #define VMBUS_CHAN_ST_ONLIST_SHIFT 3 177 #define VMBUS_CHAN_ST_REVOKED_SHIFT 4 /* sticky */ 178 #define VMBUS_CHAN_ST_OPENED (1 << VMBUS_CHAN_ST_OPENED_SHIFT) 179 #define VMBUS_CHAN_ST_ONPRIL (1 << VMBUS_CHAN_ST_ONPRIL_SHIFT) 180 #define VMBUS_CHAN_ST_ONSUBL (1 << VMBUS_CHAN_ST_ONSUBL_SHIFT) 181 #define VMBUS_CHAN_ST_ONLIST (1 << VMBUS_CHAN_ST_ONLIST_SHIFT) 182 #define VMBUS_CHAN_ST_REVOKED (1 << VMBUS_CHAN_ST_REVOKED_SHIFT) 183 184 struct vmbus_softc; 185 struct vmbus_message; 186 187 void vmbus_event_proc(struct vmbus_softc *, int); 188 void vmbus_event_proc_compat(struct vmbus_softc *, int); 189 void vmbus_chan_msgproc(struct vmbus_softc *, 190 const struct vmbus_message *); 191 void vmbus_chan_destroy_all(struct vmbus_softc *); 192 193 #endif /* !_VMBUS_CHANVAR_H_ */ 194