vmbus_var.h revision 307451 
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: stable/11/sys/dev/hyperv/vmbus/vmbus_var.h 307451 2016-10-17 02:12:49Z sephe $
27 */
28
29#ifndef _VMBUS_VAR_H_
30#define _VMBUS_VAR_H_
31
32#include <sys/param.h>
33#include <sys/bus_dma.h>
34#include <sys/taskqueue.h>
35
36#include <dev/hyperv/include/hyperv_busdma.h>
37
38/*
39 * NOTE: DO NOT CHANGE THIS.
40 */
41#define VMBUS_SINT_MESSAGE	2
42/*
43 * NOTE:
44 * - DO NOT set it to the same value as VMBUS_SINT_MESSAGE.
45 * - DO NOT set it to 0.
46 */
47#define VMBUS_SINT_TIMER	4
48
49/*
50 * NOTE: DO NOT CHANGE THESE
51 */
52#define VMBUS_CONNID_MESSAGE		1
53#define VMBUS_CONNID_EVENT		2
54
55struct vmbus_message;
56struct vmbus_softc;
57
58typedef void		(*vmbus_chanmsg_proc_t)(struct vmbus_softc *,
59			    const struct vmbus_message *);
60
61#define VMBUS_CHANMSG_PROC(name, func)	\
62	[VMBUS_CHANMSG_TYPE_##name] = func
63#define VMBUS_CHANMSG_PROC_WAKEUP(name)	\
64	VMBUS_CHANMSG_PROC(name, vmbus_msghc_wakeup)
65
66struct vmbus_pcpu_data {
67	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
68	struct vmbus_message	*message;	/* shared messages */
69	uint32_t		vcpuid;		/* virtual cpuid */
70	int			event_flags_cnt;/* # of event flags */
71	struct vmbus_evtflags	*event_flags;	/* event flags from host */
72
73	/* Rarely used fields */
74	struct hyperv_dma	message_dma;	/* busdma glue */
75	struct hyperv_dma	event_flags_dma;/* busdma glue */
76	struct taskqueue	*event_tq;	/* event taskq */
77	struct taskqueue	*message_tq;	/* message taskq */
78	struct task		message_task;	/* message task */
79} __aligned(CACHE_LINE_SIZE);
80
81struct vmbus_softc {
82	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
83	u_long			*vmbus_tx_evtflags;
84						/* event flags to host */
85	struct vmbus_mnf	*vmbus_mnf2;	/* monitored by host */
86
87	u_long			*vmbus_rx_evtflags;
88						/* compat evtflgs from host */
89	struct hv_vmbus_channel	**vmbus_chmap;
90	struct vmbus_msghc_ctx	*vmbus_msg_hc;
91	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
92
93	/*
94	 * Rarely used fields
95	 */
96
97	device_t		vmbus_dev;
98	int			vmbus_idtvec;
99	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
100	uint32_t		vmbus_version;
101	uint32_t		vmbus_gpadl;
102
103	/* Shared memory for vmbus_{rx,tx}_evtflags */
104	void			*vmbus_evtflags;
105	struct hyperv_dma	vmbus_evtflags_dma;
106
107	void			*vmbus_mnf1;	/* monitored by VM, unused */
108	struct hyperv_dma	vmbus_mnf1_dma;
109	struct hyperv_dma	vmbus_mnf2_dma;
110
111	struct mtx		vmbus_scan_lock;
112	uint32_t		vmbus_scan_chcnt;
113#define VMBUS_SCAN_CHCNT_DONE	0x80000000
114	uint32_t		vmbus_scan_devcnt;
115
116	/* Primary channels */
117	struct mtx		vmbus_prichan_lock;
118	TAILQ_HEAD(, hv_vmbus_channel) vmbus_prichans;
119};
120
121#define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
122#define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
123
124extern struct vmbus_softc	*vmbus_sc;
125
126static __inline struct vmbus_softc *
127vmbus_get_softc(void)
128{
129	return vmbus_sc;
130}
131
132static __inline device_t
133vmbus_get_device(void)
134{
135	return vmbus_sc->vmbus_dev;
136}
137
138#define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
139#define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
140
141struct hv_vmbus_channel;
142struct trapframe;
143struct vmbus_message;
144struct vmbus_msghc;
145
146void	vmbus_event_proc(struct vmbus_softc *, int);
147void	vmbus_event_proc_compat(struct vmbus_softc *, int);
148void	vmbus_handle_intr(struct trapframe *);
149
150void	vmbus_et_intr(struct trapframe *);
151
152void	vmbus_chan_msgproc(struct vmbus_softc *, const struct vmbus_message *);
153void	vmbus_chan_destroy_all(struct vmbus_softc *);
154
155struct vmbus_msghc *vmbus_msghc_get(struct vmbus_softc *, size_t);
156void	vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
157void	*vmbus_msghc_dataptr(struct vmbus_msghc *);
158int	vmbus_msghc_exec_noresult(struct vmbus_msghc *);
159int	vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
160const struct vmbus_message *vmbus_msghc_wait_result(struct vmbus_softc *,
161	    struct vmbus_msghc *);
162void	vmbus_msghc_wakeup(struct vmbus_softc *, const struct vmbus_message *);
163void	vmbus_msghc_reset(struct vmbus_msghc *, size_t);
164
165uint32_t vmbus_gpadl_alloc(struct vmbus_softc *);
166
167#endif	/* !_VMBUS_VAR_H_ */
168