xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_var.h (revision 884d26c84cba3ffc3d4e626306098fcdfe6a0c2b)
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_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 
55 struct vmbus_pcpu_data {
56 	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
57 	struct vmbus_message	*message;	/* shared messages */
58 	uint32_t		vcpuid;		/* virtual cpuid */
59 	int			event_flags_cnt;/* # of event flags */
60 	struct vmbus_evtflags	*event_flags;	/* event flags from host */
61 
62 	/* Rarely used fields */
63 	struct hyperv_dma	message_dma;	/* busdma glue */
64 	struct hyperv_dma	event_flags_dma;/* busdma glue */
65 	struct taskqueue	*event_tq;	/* event taskq */
66 	struct taskqueue	*message_tq;	/* message taskq */
67 	struct task		message_task;	/* message task */
68 } __aligned(CACHE_LINE_SIZE);
69 
70 struct vmbus_softc {
71 	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
72 	u_long			*vmbus_tx_evtflags;
73 						/* event flags to host */
74 	void			*vmbus_mnf2;	/* monitored by host */
75 
76 	u_long			*vmbus_rx_evtflags;
77 						/* compat evtflgs from host */
78 	struct hv_vmbus_channel	**vmbus_chmap;
79 	struct vmbus_msghc_ctx	*vmbus_msg_hc;
80 	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
81 
82 	/*
83 	 * Rarely used fields
84 	 */
85 
86 	device_t		vmbus_dev;
87 	int			vmbus_idtvec;
88 	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
89 	uint32_t		vmbus_version;
90 	uint32_t		vmbus_gpadl;
91 
92 	/* Shared memory for vmbus_{rx,tx}_evtflags */
93 	void			*vmbus_evtflags;
94 	struct hyperv_dma	vmbus_evtflags_dma;
95 
96 	void			*vmbus_mnf1;	/* monitored by VM, unused */
97 	struct hyperv_dma	vmbus_mnf1_dma;
98 	struct hyperv_dma	vmbus_mnf2_dma;
99 
100 	struct mtx		vmbus_scan_lock;
101 	uint32_t		vmbus_scan_chcnt;
102 #define VMBUS_SCAN_CHCNT_DONE	0x80000000
103 	uint32_t		vmbus_scan_devcnt;
104 
105 	struct mtx		vmbus_chlist_lock;
106 	TAILQ_HEAD(, hv_vmbus_channel) vmbus_chlist;
107 };
108 
109 #define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
110 #define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
111 
112 extern struct vmbus_softc	*vmbus_sc;
113 
114 static __inline struct vmbus_softc *
115 vmbus_get_softc(void)
116 {
117 	return vmbus_sc;
118 }
119 
120 static __inline device_t
121 vmbus_get_device(void)
122 {
123 	return vmbus_sc->vmbus_dev;
124 }
125 
126 #define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
127 #define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
128 
129 struct hv_vmbus_channel;
130 struct trapframe;
131 struct vmbus_message;
132 struct vmbus_msghc;
133 
134 void	vmbus_event_proc(struct vmbus_softc *, int);
135 void	vmbus_event_proc_compat(struct vmbus_softc *, int);
136 void	vmbus_handle_intr(struct trapframe *);
137 
138 void	vmbus_et_intr(struct trapframe *);
139 
140 void	vmbus_chan_msgproc(struct vmbus_softc *, const struct vmbus_message *);
141 
142 struct vmbus_msghc *vmbus_msghc_get(struct vmbus_softc *, size_t);
143 void	vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
144 void	*vmbus_msghc_dataptr(struct vmbus_msghc *);
145 int	vmbus_msghc_exec_noresult(struct vmbus_msghc *);
146 int	vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
147 const struct vmbus_message *vmbus_msghc_wait_result(struct vmbus_softc *,
148 	    struct vmbus_msghc *);
149 void	vmbus_msghc_wakeup(struct vmbus_softc *, const struct vmbus_message *);
150 void	vmbus_msghc_reset(struct vmbus_msghc *, size_t);
151 
152 void	vmbus_scan_done(struct vmbus_softc *);
153 void	vmbus_scan_newchan(struct vmbus_softc *);
154 
155 uint32_t vmbus_gpadl_alloc(struct vmbus_softc *);
156 
157 #endif	/* !_VMBUS_VAR_H_ */
158