1*c2ac0d61Snonaka /* $NetBSD: vmbusvar.h,v 1.7 2022/05/20 13:55:17 nonaka Exp $ */
2afdb7e40Snonaka /* $OpenBSD: hypervvar.h,v 1.13 2017/06/23 19:05:42 mikeb Exp $ */
3afdb7e40Snonaka
4afdb7e40Snonaka /*
5afdb7e40Snonaka * Copyright (c) 2016 Mike Belopuhov <mike@esdenera.com>
6afdb7e40Snonaka *
7afdb7e40Snonaka * Permission to use, copy, modify, and distribute this software for any
8afdb7e40Snonaka * purpose with or without fee is hereby granted, provided that the above
9afdb7e40Snonaka * copyright notice and this permission notice appear in all copies.
10afdb7e40Snonaka *
11afdb7e40Snonaka * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12afdb7e40Snonaka * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13afdb7e40Snonaka * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14afdb7e40Snonaka * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15afdb7e40Snonaka * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16afdb7e40Snonaka * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17afdb7e40Snonaka * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18afdb7e40Snonaka */
19afdb7e40Snonaka
20afdb7e40Snonaka #ifndef _VMBUSVAR_H_
21afdb7e40Snonaka #define _VMBUSVAR_H_
22afdb7e40Snonaka
23afdb7e40Snonaka #include <sys/param.h>
24afdb7e40Snonaka #include <sys/device.h>
25afdb7e40Snonaka #include <sys/atomic.h>
26afdb7e40Snonaka #include <sys/bus.h>
27b4ad7757Snonaka #include <sys/condvar.h>
28afdb7e40Snonaka #include <sys/evcnt.h>
29afdb7e40Snonaka #include <sys/kcpuset.h>
30afdb7e40Snonaka #include <sys/mutex.h>
31afdb7e40Snonaka #include <sys/pool.h>
32afdb7e40Snonaka
33afdb7e40Snonaka #include <dev/hyperv/hypervreg.h>
34afdb7e40Snonaka #include <dev/hyperv/hypervvar.h>
35afdb7e40Snonaka
36afdb7e40Snonaka /* #define HYPERV_DEBUG */
37afdb7e40Snonaka
38afdb7e40Snonaka #ifdef HYPERV_DEBUG
39afdb7e40Snonaka #define DPRINTF(x...) printf(x)
40afdb7e40Snonaka #else
41afdb7e40Snonaka #define DPRINTF(x...)
42afdb7e40Snonaka #endif
43afdb7e40Snonaka
44afdb7e40Snonaka typedef void (*vmbus_channel_callback_t)(void *);
45afdb7e40Snonaka
46afdb7e40Snonaka struct vmbus_softc;
47b4ad7757Snonaka struct vmbus_channel;
48afdb7e40Snonaka
49afdb7e40Snonaka struct vmbus_msg {
50afdb7e40Snonaka uint64_t msg_flags;
51afdb7e40Snonaka #define MSGF_NOSLEEP __BIT(0)
52afdb7e40Snonaka #define MSGF_NOQUEUE __BIT(1)
53afdb7e40Snonaka #define MSGF_ORPHANED __BIT(2)
54afdb7e40Snonaka struct hyperv_hypercall_postmsg_in msg_req __aligned(8);
55afdb7e40Snonaka void *msg_rsp;
56afdb7e40Snonaka size_t msg_rsplen;
57afdb7e40Snonaka TAILQ_ENTRY(vmbus_msg) msg_entry;
58afdb7e40Snonaka };
59afdb7e40Snonaka __CTASSERT((offsetof(struct vmbus_msg, msg_req) % 8) == 0);
60afdb7e40Snonaka TAILQ_HEAD(vmbus_queue, vmbus_msg);
61afdb7e40Snonaka
62df2d8a61Snonaka struct vmbus_chev {
63df2d8a61Snonaka int vce_type;
64df2d8a61Snonaka #define VMBUS_CHEV_TYPE_OFFER 0
65df2d8a61Snonaka #define VMBUS_CHEV_TYPE_RESCIND 1
66df2d8a61Snonaka void *vce_arg;
67df2d8a61Snonaka SIMPLEQ_ENTRY(vmbus_chev) vce_entry;
68df2d8a61Snonaka };
69df2d8a61Snonaka SIMPLEQ_HEAD(vmbus_chevq, vmbus_chev);
70df2d8a61Snonaka
71b4ad7757Snonaka struct vmbus_dev {
72b4ad7757Snonaka int vd_type;
73b4ad7757Snonaka #define VMBUS_DEV_TYPE_ATTACH 0
74b4ad7757Snonaka #define VMBUS_DEV_TYPE_DETACH 1
75b4ad7757Snonaka struct vmbus_channel *vd_chan;
76b4ad7757Snonaka SIMPLEQ_ENTRY(vmbus_dev) vd_entry;
77afdb7e40Snonaka };
78b4ad7757Snonaka SIMPLEQ_HEAD(vmbus_devq, vmbus_dev);
79afdb7e40Snonaka
80afdb7e40Snonaka struct vmbus_ring_data {
81afdb7e40Snonaka struct vmbus_bufring *rd_ring;
82afdb7e40Snonaka uint32_t rd_size;
83afdb7e40Snonaka kmutex_t rd_lock;
84afdb7e40Snonaka uint32_t rd_prod;
85afdb7e40Snonaka uint32_t rd_cons;
86afdb7e40Snonaka uint32_t rd_dsize;
87afdb7e40Snonaka };
88afdb7e40Snonaka
89afdb7e40Snonaka TAILQ_HEAD(vmbus_channels, vmbus_channel);
90afdb7e40Snonaka
91afdb7e40Snonaka struct vmbus_channel {
92afdb7e40Snonaka struct vmbus_softc *ch_sc;
93afdb7e40Snonaka device_t ch_dev;
94afdb7e40Snonaka u_int ch_refs;
95afdb7e40Snonaka
96afdb7e40Snonaka int ch_state;
97afdb7e40Snonaka #define VMBUS_CHANSTATE_OFFERED 1
98afdb7e40Snonaka #define VMBUS_CHANSTATE_OPENED 2
99afdb7e40Snonaka #define VMBUS_CHANSTATE_CLOSING 3
100afdb7e40Snonaka #define VMBUS_CHANSTATE_CLOSED 4
101afdb7e40Snonaka uint32_t ch_id;
102afdb7e40Snonaka uint16_t ch_subidx;
103afdb7e40Snonaka
104afdb7e40Snonaka struct hyperv_guid ch_type;
105afdb7e40Snonaka struct hyperv_guid ch_inst;
106afdb7e40Snonaka char ch_ident[38];
107afdb7e40Snonaka
108afdb7e40Snonaka void *ch_ring;
109afdb7e40Snonaka uint32_t ch_ring_gpadl;
110afdb7e40Snonaka u_long ch_ring_size;
111afdb7e40Snonaka struct hyperv_dma ch_ring_dma;
112afdb7e40Snonaka
113afdb7e40Snonaka struct vmbus_ring_data ch_wrd;
114afdb7e40Snonaka struct vmbus_ring_data ch_rrd;
115afdb7e40Snonaka
116afdb7e40Snonaka int ch_cpuid;
117afdb7e40Snonaka uint32_t ch_vcpu;
118afdb7e40Snonaka
119afdb7e40Snonaka void (*ch_handler)(void *);
120afdb7e40Snonaka void *ch_ctx;
121afdb7e40Snonaka struct evcnt ch_evcnt;
122afdb7e40Snonaka void *ch_taskq;
123afdb7e40Snonaka
124*c2ac0d61Snonaka kmutex_t ch_event_lock;
125*c2ac0d61Snonaka kcondvar_t ch_event_cv;
126*c2ac0d61Snonaka
127afdb7e40Snonaka uint32_t ch_flags;
128afdb7e40Snonaka #define CHF_BATCHED __BIT(0)
129afdb7e40Snonaka #define CHF_MONITOR __BIT(1)
130b4ad7757Snonaka #define CHF_REVOKED __BIT(2)
131afdb7e40Snonaka
132afdb7e40Snonaka uint8_t ch_mgroup;
133afdb7e40Snonaka uint8_t ch_mindex;
134afdb7e40Snonaka struct hyperv_mon_param *ch_monprm;
135afdb7e40Snonaka struct hyperv_dma ch_monprm_dma;
136afdb7e40Snonaka
137df2d8a61Snonaka TAILQ_ENTRY(vmbus_channel) ch_prientry;
138afdb7e40Snonaka TAILQ_ENTRY(vmbus_channel) ch_entry;
139afdb7e40Snonaka
140afdb7e40Snonaka kmutex_t ch_subchannel_lock;
141*c2ac0d61Snonaka kcondvar_t ch_subchannel_cv;
142afdb7e40Snonaka struct vmbus_channels ch_subchannels;
143afdb7e40Snonaka u_int ch_subchannel_count;
144afdb7e40Snonaka TAILQ_ENTRY(vmbus_channel) ch_subentry;
145afdb7e40Snonaka struct vmbus_channel *ch_primary_channel;
146afdb7e40Snonaka };
147afdb7e40Snonaka
148afdb7e40Snonaka #define VMBUS_CHAN_ISPRIMARY(chan) ((chan)->ch_subidx == 0)
149afdb7e40Snonaka
150afdb7e40Snonaka struct vmbus_attach_args {
151afdb7e40Snonaka struct hyperv_guid *aa_type;
152afdb7e40Snonaka struct hyperv_guid *aa_inst;
153afdb7e40Snonaka char *aa_ident;
154afdb7e40Snonaka struct vmbus_channel *aa_chan;
155c270bf03Snonaka bus_space_tag_t aa_iot;
156c270bf03Snonaka bus_space_tag_t aa_memt;
157afdb7e40Snonaka };
158afdb7e40Snonaka
159afdb7e40Snonaka struct vmbus_percpu_data {
160afdb7e40Snonaka void *simp; /* Synthetic Interrupt Message Page */
161afdb7e40Snonaka void *siep; /* Synthetic Interrupt Event Flags Page */
162afdb7e40Snonaka
163afdb7e40Snonaka /* Rarely used fields */
164afdb7e40Snonaka struct hyperv_dma simp_dma;
165afdb7e40Snonaka struct hyperv_dma siep_dma;
166b306c882Syamaguchi
167b306c882Syamaguchi void *md_cookie;
168afdb7e40Snonaka } __aligned(CACHE_LINE_SIZE);
169afdb7e40Snonaka
170afdb7e40Snonaka struct vmbus_softc {
171afdb7e40Snonaka device_t sc_dev;
172c270bf03Snonaka bus_space_tag_t sc_iot;
173c270bf03Snonaka bus_space_tag_t sc_memt;
174afdb7e40Snonaka bus_dma_tag_t sc_dmat;
175afdb7e40Snonaka
176afdb7e40Snonaka pool_cache_t sc_msgpool;
177afdb7e40Snonaka
178afdb7e40Snonaka void *sc_msg_sih;
179afdb7e40Snonaka
180afdb7e40Snonaka u_long *sc_wevents; /* Write events */
181afdb7e40Snonaka u_long *sc_revents; /* Read events */
182*c2ac0d61Snonaka struct vmbus_channel * volatile *sc_chanmap;
183*c2ac0d61Snonaka volatile u_long sc_evtmask[VMBUS_EVTFLAGS_MAX];
184afdb7e40Snonaka struct vmbus_mnf *sc_monitor[2];
185afdb7e40Snonaka struct vmbus_percpu_data sc_percpu[MAXCPUS];
186afdb7e40Snonaka
187afdb7e40Snonaka /*
188afdb7e40Snonaka * Rarely used fields
189afdb7e40Snonaka */
190afdb7e40Snonaka uint32_t sc_flags;
191afdb7e40Snonaka #define VMBUS_SCFLAG_SYNIC __BIT(0)
192afdb7e40Snonaka #define VMBUS_SCFLAG_CONNECTED __BIT(1)
193afdb7e40Snonaka #define VMBUS_SCFLAG_OFFERS_DELIVERED __BIT(2)
194afdb7e40Snonaka uint32_t sc_proto;
195afdb7e40Snonaka int sc_channel_max;
196afdb7e40Snonaka
197afdb7e40Snonaka kcpuset_t *sc_intr_cpuset;
198afdb7e40Snonaka
199afdb7e40Snonaka /* Shared memory for Write/Read events */
200afdb7e40Snonaka void *sc_events;
201afdb7e40Snonaka struct hyperv_dma sc_events_dma;
202afdb7e40Snonaka
203afdb7e40Snonaka struct hyperv_dma sc_monitor_dma[2];
204afdb7e40Snonaka
205afdb7e40Snonaka struct vmbus_queue sc_reqs; /* Request queue */
206afdb7e40Snonaka kmutex_t sc_req_lock;
207afdb7e40Snonaka struct vmbus_queue sc_rsps; /* Response queue */
208afdb7e40Snonaka kmutex_t sc_rsp_lock;
209afdb7e40Snonaka
210df2d8a61Snonaka struct vmbus_chevq sc_chevq;
211df2d8a61Snonaka kmutex_t sc_chevq_lock;
212df2d8a61Snonaka kcondvar_t sc_chevq_cv;
213df2d8a61Snonaka
214b4ad7757Snonaka struct vmbus_devq sc_devq;
215b4ad7757Snonaka kmutex_t sc_devq_lock;
216b4ad7757Snonaka kcondvar_t sc_devq_cv;
217afdb7e40Snonaka
218df2d8a61Snonaka struct vmbus_devq sc_subch_devq;
219df2d8a61Snonaka kmutex_t sc_subch_devq_lock;
220df2d8a61Snonaka kcondvar_t sc_subch_devq_cv;
221df2d8a61Snonaka
222df2d8a61Snonaka struct vmbus_channels sc_prichans;
223df2d8a61Snonaka kmutex_t sc_prichan_lock;
224df2d8a61Snonaka
225afdb7e40Snonaka struct vmbus_channels sc_channels;
226afdb7e40Snonaka kmutex_t sc_channel_lock;
227afdb7e40Snonaka
228afdb7e40Snonaka volatile uint32_t sc_handle;
229afdb7e40Snonaka };
230afdb7e40Snonaka
231afdb7e40Snonaka static __inline void
clear_bit(u_int b,volatile void * p)232afdb7e40Snonaka clear_bit(u_int b, volatile void *p)
233afdb7e40Snonaka {
234afdb7e40Snonaka atomic_and_32(((volatile u_int *)p) + (b >> 5), ~(1 << (b & 0x1f)));
235afdb7e40Snonaka }
236afdb7e40Snonaka
237afdb7e40Snonaka static __inline void
set_bit(u_int b,volatile void * p)238afdb7e40Snonaka set_bit(u_int b, volatile void *p)
239afdb7e40Snonaka {
240afdb7e40Snonaka atomic_or_32(((volatile u_int *)p) + (b >> 5), 1 << (b & 0x1f));
241afdb7e40Snonaka }
242afdb7e40Snonaka
243afdb7e40Snonaka static __inline int
test_bit(u_int b,volatile void * p)244afdb7e40Snonaka test_bit(u_int b, volatile void *p)
245afdb7e40Snonaka {
246afdb7e40Snonaka return !!(((volatile u_int *)p)[b >> 5] & (1 << (b & 0x1f)));
247afdb7e40Snonaka }
248afdb7e40Snonaka
249afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_network;
250afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_ide;
251afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_scsi;
252afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_shutdown;
253afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_timesync;
254afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_heartbeat;
255afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_kvp;
256afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_vss;
257afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_dynmem;
258afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_mouse;
259afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_kbd;
260afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_video;
261afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_fc;
262afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_fcopy;
263afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_pcie;
264afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_netdir;
265afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_rdesktop;
266afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_avma1;
267afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_avma2;
268afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_avma3;
269afdb7e40Snonaka extern const struct hyperv_guid hyperv_guid_avma4;
270afdb7e40Snonaka
271afdb7e40Snonaka int vmbus_match(device_t, cfdata_t, void *);
272afdb7e40Snonaka int vmbus_attach(struct vmbus_softc *);
273afdb7e40Snonaka int vmbus_detach(struct vmbus_softc *, int);
274afdb7e40Snonaka
275afdb7e40Snonaka int vmbus_handle_alloc(struct vmbus_channel *, const struct hyperv_dma *,
276afdb7e40Snonaka uint32_t, uint32_t *);
277afdb7e40Snonaka void vmbus_handle_free(struct vmbus_channel *, uint32_t);
278afdb7e40Snonaka int vmbus_channel_open(struct vmbus_channel *, size_t, void *, size_t,
279afdb7e40Snonaka vmbus_channel_callback_t, void *);
280afdb7e40Snonaka int vmbus_channel_close(struct vmbus_channel *);
281afdb7e40Snonaka int vmbus_channel_close_direct(struct vmbus_channel *);
282afdb7e40Snonaka int vmbus_channel_setdeferred(struct vmbus_channel *, const char *);
283afdb7e40Snonaka void vmbus_channel_schedule(struct vmbus_channel *);
284afdb7e40Snonaka int vmbus_channel_send(struct vmbus_channel *, void *, uint32_t, uint64_t,
285afdb7e40Snonaka int, uint32_t);
286afdb7e40Snonaka int vmbus_channel_send_sgl(struct vmbus_channel *, struct vmbus_gpa *,
287afdb7e40Snonaka uint32_t, void *, uint32_t, uint64_t);
288afdb7e40Snonaka int vmbus_channel_send_prpl(struct vmbus_channel *,
289afdb7e40Snonaka struct vmbus_gpa_range *, uint32_t, void *, uint32_t, uint64_t);
290afdb7e40Snonaka int vmbus_channel_recv(struct vmbus_channel *, void *, uint32_t, uint32_t *,
291afdb7e40Snonaka uint64_t *, int);
292afdb7e40Snonaka void vmbus_channel_cpu_set(struct vmbus_channel *, int);
293afdb7e40Snonaka void vmbus_channel_cpu_rr(struct vmbus_channel *);
294b4ad7757Snonaka bool vmbus_channel_is_revoked(struct vmbus_channel *);
295*c2ac0d61Snonaka bool vmbus_channel_tx_empty(struct vmbus_channel *);
296*c2ac0d61Snonaka bool vmbus_channel_rx_empty(struct vmbus_channel *);
297*c2ac0d61Snonaka void vmbus_channel_pause(struct vmbus_channel *);
298*c2ac0d61Snonaka uint32_t vmbus_channel_unpause(struct vmbus_channel *);
299*c2ac0d61Snonaka uint32_t vmbus_channel_ready(struct vmbus_channel *);
300afdb7e40Snonaka
301afdb7e40Snonaka struct vmbus_channel **
302afdb7e40Snonaka vmbus_subchannel_get(struct vmbus_channel *, int);
303*c2ac0d61Snonaka void vmbus_subchannel_rel(struct vmbus_channel **, int);
304*c2ac0d61Snonaka void vmbus_subchannel_drain(struct vmbus_channel *);
305afdb7e40Snonaka
306afdb7e40Snonaka #endif /* _VMBUSVAR_H_ */
307