xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_var.h (revision 8415a654d02e1c4268885e667c539873db570576)
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 
27 #ifndef _VMBUS_VAR_H_
28 #define _VMBUS_VAR_H_
29 
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/taskqueue.h>
33 #include <sys/rman.h>
34 
35 #include <vm/vm.h>
36 #include <vm/vm_extern.h>
37 #include <vm/vm_param.h>
38 #include <vm/pmap.h>
39 
40 #include <dev/pci/pcivar.h>
41 #include <dev/pci/pcib_private.h>
42 
43 /*
44  * NOTE: DO NOT CHANGE THIS.
45  */
46 #define VMBUS_SINT_MESSAGE	2
47 /*
48  * NOTE:
49  * - DO NOT set it to the same value as VMBUS_SINT_MESSAGE.
50  * - DO NOT set it to 0.
51  */
52 #define VMBUS_SINT_TIMER	4
53 
54 /*
55  * NOTE: DO NOT CHANGE THESE
56  */
57 #define VMBUS_CONNID_MESSAGE		1
58 #define VMBUS_CONNID_EVENT		2
59 
60 struct vmbus_message;
61 struct vmbus_softc;
62 
63 typedef void		(*vmbus_chanmsg_proc_t)(struct vmbus_softc *,
64 			    const struct vmbus_message *);
65 
66 #define VMBUS_CHANMSG_PROC(name, func)	\
67 	[VMBUS_CHANMSG_TYPE_##name] = func
68 #define VMBUS_CHANMSG_PROC_WAKEUP(name)	\
69 	VMBUS_CHANMSG_PROC(name, vmbus_msghc_wakeup)
70 
71 struct vmbus_pcpu_data {
72 	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
73 	struct vmbus_message	*message;	/* shared messages */
74 	uint32_t		vcpuid;		/* virtual cpuid */
75 	int			event_flags_cnt;/* # of event flags */
76 	struct vmbus_evtflags	*event_flags;	/* event flags from host */
77 #if defined(__x86_64__)
78 	void			*cpu_mem;	/* For Hyper-V tlb hypercall */
79 #endif
80 
81 	/* Rarely used fields */
82 	struct taskqueue	*event_tq;	/* event taskq */
83 	struct taskqueue	*message_tq;	/* message taskq */
84 	struct task		message_task;	/* message task */
85 } __aligned(CACHE_LINE_SIZE);
86 
87 struct vmbus_softc {
88 	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
89 	u_long			*vmbus_tx_evtflags;
90 						/* event flags to host */
91 	struct vmbus_mnf	*vmbus_mnf2;	/* monitored by host */
92 
93 	u_long			*vmbus_rx_evtflags;
94 						/* compat evtflgs from host */
95 	struct vmbus_channel *volatile *vmbus_chmap;
96 	struct vmbus_xact_ctx	*vmbus_xc;
97 	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
98 
99 	/*
100 	 * Rarely used fields
101 	 */
102 
103 	device_t		vmbus_dev;
104 	int			vmbus_idtvec;
105 	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
106 	uint32_t		vmbus_version;
107 	uint32_t		vmbus_gpadl;
108 
109 	/* Shared memory for vmbus_{rx,tx}_evtflags */
110 	void			*vmbus_evtflags;
111 
112 	void			*vmbus_mnf1;	/* monitored by VM, unused */
113 
114 	bool			vmbus_scandone;
115 	struct task		vmbus_scandone_task;
116 
117 	struct taskqueue	*vmbus_devtq;	/* for dev attach/detach */
118 	struct taskqueue	*vmbus_subchtq;	/* for sub-chan attach/detach */
119 
120 	/* Primary channels */
121 	struct mtx		vmbus_prichan_lock;
122 	TAILQ_HEAD(, vmbus_channel) vmbus_prichans;
123 
124 	/* Complete channel list */
125 	struct mtx		vmbus_chan_lock;
126 	TAILQ_HEAD(, vmbus_channel) vmbus_chans;
127 
128 	struct intr_config_hook	vmbus_intrhook;
129 
130 	/* The list of usable MMIO ranges for PCIe pass-through */
131 	struct pcib_host_resources vmbus_mmio_res;
132 
133 #if defined(__aarch64__)
134 	struct resource *ires;
135 	void *icookie;
136 	int vector;
137 #endif
138 	bus_dma_tag_t   dmat;
139 };
140 
141 #define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
142 #define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
143 
144 #define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
145 #define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
146 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE	0x0002
147 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE_EX	0x0013
148 #define HV_FLUSH_ALL_PROCESSORS		BIT(0)
149 #define HV_FLUSH_ALL_VIRTUAL_ADDRESS_SPACES	BIT(1)
150 #define HV_FLUSH_NON_GLOBAL_MAPPINGS_ONLY	BIT(2)
151 #define HV_TLB_FLUSH_UNIT	(4096 * PAGE_SIZE)
152 
153 
154 #define BIT(n)		(1ULL << (n))
155 #define BITS_PER_LONG	(sizeof(long) * NBBY)
156 #define BIT_MASK(nr)	(1UL << ((nr) & (BITS_PER_LONG - 1)))
157 #define BIT_WORD(nr)	((nr) / BITS_PER_LONG)
158 #define set_bit(i, a)			\
159 	 atomic_set_long(&((volatile unsigned long *)(a))[BIT_WORD(i)], BIT_MASK(i))
160 
161 #define GENMASK_ULL(h, l)  (((~0ULL) >> (64 - (h) - 1)) & ((~0ULL) << (l)))
162 
163 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_LIST	0x0003
164 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_LIST_EX	0x0014
165 #define HYPERV_X64_EX_PROCESSOR_MASKS_RECOMMENDED	BIT(11)
166 #define HV_HYPERCALL_RESULT_MASK	GENMASK_ULL(15, 0)
167 #define HV_STATUS_SUCCESS	0
168 #define HV_HYPERCALL_REP_COMP_MASK	GENMASK_ULL(43, 32)
169 #define HV_HYPERCALL_REP_COMP_OFFSET	32
170 
171 #define HV_HYPERCALL_VARHEAD_OFFSET	17
172 
173 #define HV_HYPERCALL_REP_START_MASK	GENMASK_ULL(59, 48)
174 #define HV_HYPERCALL_REP_START_OFFSET	48
175 
176 enum HV_GENERIC_SET_FORMAT {
177 	HV_GENERIC_SET_SPARSE_4K,
178 	HV_GENERIC_SET_ALL,
179 };
180 
181 struct vmbus_channel;
182 struct trapframe;
183 struct vmbus_message;
184 struct vmbus_msghc;
185 
186 void		vmbus_handle_intr(struct trapframe *);
187 int		vmbus_add_child(struct vmbus_channel *);
188 int		vmbus_delete_child(struct vmbus_channel *);
189 #if !defined(__aarch64__)
190 void		vmbus_et_intr(struct trapframe *);
191 #endif
192 uint32_t	vmbus_gpadl_alloc(struct vmbus_softc *);
193 
194 struct vmbus_msghc *
195 		vmbus_msghc_get(struct vmbus_softc *, size_t);
196 void		vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
197 void		*vmbus_msghc_dataptr(struct vmbus_msghc *);
198 int		vmbus_msghc_exec_noresult(struct vmbus_msghc *);
199 int		vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
200 void		vmbus_msghc_exec_cancel(struct vmbus_softc *,
201 		    struct vmbus_msghc *);
202 const struct vmbus_message *
203 		vmbus_msghc_wait_result(struct vmbus_softc *,
204 		    struct vmbus_msghc *);
205 const struct vmbus_message *
206 		vmbus_msghc_poll_result(struct vmbus_softc *,
207 		    struct vmbus_msghc *);
208 void		vmbus_msghc_wakeup(struct vmbus_softc *,
209 		    const struct vmbus_message *);
210 void		vmbus_msghc_reset(struct vmbus_msghc *, size_t);
211 
212 void    vmbus_handle_timer_intr1(struct vmbus_message *msg_base,
213         struct trapframe *frame);
214 
215 void    vmbus_synic_setup1(void *xsc);
216 void    vmbus_synic_teardown1(void);
217 int     vmbus_setup_intr1(struct vmbus_softc *sc);
218 void    vmbus_intr_teardown1(struct vmbus_softc *sc);
219 
220 extern uint32_t hv_max_vp_index;
221 
222 
223 #if defined(__x86_64__)
224 void		hyperv_vm_tlb_flush(pmap_t, vm_offset_t,
225 		    vm_offset_t, smp_invl_local_cb_t, enum invl_op_codes);
226 uint64_t	hv_flush_tlb_others_ex(pmap_t, vm_offset_t, vm_offset_t,
227 		    cpuset_t, enum invl_op_codes, struct vmbus_softc *);
228 void		hv_vm_tlb_flush(pmap_t, vm_offset_t, vm_offset_t,
229 		    enum invl_op_codes, struct vmbus_softc *,
230 		    smp_invl_local_cb_t);
231 #endif /* __x86_64__ */
232 #endif	/* !_VMBUS_VAR_H_ */
233