xref: /freebsd-13-stable/sys/dev/hyperv/vmbus/vmbus_var.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
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 <dev/hyperv/include/hyperv_busdma.h>
36 #include <dev/pci/pcivar.h>
37 #include <dev/pci/pcib_private.h>
38 
39 /*
40  * NOTE: DO NOT CHANGE THIS.
41  */
42 #define VMBUS_SINT_MESSAGE	2
43 /*
44  * NOTE:
45  * - DO NOT set it to the same value as VMBUS_SINT_MESSAGE.
46  * - DO NOT set it to 0.
47  */
48 #define VMBUS_SINT_TIMER	4
49 
50 /*
51  * NOTE: DO NOT CHANGE THESE
52  */
53 #define VMBUS_CONNID_MESSAGE		1
54 #define VMBUS_CONNID_EVENT		2
55 
56 struct vmbus_message;
57 struct vmbus_softc;
58 
59 typedef void		(*vmbus_chanmsg_proc_t)(struct vmbus_softc *,
60 			    const struct vmbus_message *);
61 
62 #define VMBUS_CHANMSG_PROC(name, func)	\
63 	[VMBUS_CHANMSG_TYPE_##name] = func
64 #define VMBUS_CHANMSG_PROC_WAKEUP(name)	\
65 	VMBUS_CHANMSG_PROC(name, vmbus_msghc_wakeup)
66 
67 struct vmbus_pcpu_data {
68 	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
69 	struct vmbus_message	*message;	/* shared messages */
70 	uint32_t		vcpuid;		/* virtual cpuid */
71 	int			event_flags_cnt;/* # of event flags */
72 	struct vmbus_evtflags	*event_flags;	/* event flags from host */
73 
74 	/* Rarely used fields */
75 	struct hyperv_dma	message_dma;	/* busdma glue */
76 	struct hyperv_dma	event_flags_dma;/* busdma glue */
77 	struct taskqueue	*event_tq;	/* event taskq */
78 	struct taskqueue	*message_tq;	/* message taskq */
79 	struct task		message_task;	/* message task */
80 } __aligned(CACHE_LINE_SIZE);
81 
82 #if __FreeBSD_version < 1100000
83 typedef u_long rman_res_t;
84 #endif
85 
86 struct vmbus_softc {
87 	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
88 	u_long			*vmbus_tx_evtflags;
89 						/* event flags to host */
90 	struct vmbus_mnf	*vmbus_mnf2;	/* monitored by host */
91 
92 	u_long			*vmbus_rx_evtflags;
93 						/* compat evtflgs from host */
94 	struct vmbus_channel *volatile *vmbus_chmap;
95 	struct vmbus_xact_ctx	*vmbus_xc;
96 	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
97 
98 	/*
99 	 * Rarely used fields
100 	 */
101 
102 	device_t		vmbus_dev;
103 	int			vmbus_idtvec;
104 	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
105 	uint32_t		vmbus_version;
106 	uint32_t		vmbus_gpadl;
107 
108 	/* Shared memory for vmbus_{rx,tx}_evtflags */
109 	void			*vmbus_evtflags;
110 	struct hyperv_dma	vmbus_evtflags_dma;
111 
112 	void			*vmbus_mnf1;	/* monitored by VM, unused */
113 	struct hyperv_dma	vmbus_mnf1_dma;
114 	struct hyperv_dma	vmbus_mnf2_dma;
115 
116 	bool			vmbus_scandone;
117 	struct task		vmbus_scandone_task;
118 
119 	struct taskqueue	*vmbus_devtq;	/* for dev attach/detach */
120 	struct taskqueue	*vmbus_subchtq;	/* for sub-chan attach/detach */
121 
122 	/* Primary channels */
123 	struct mtx		vmbus_prichan_lock;
124 	TAILQ_HEAD(, vmbus_channel) vmbus_prichans;
125 
126 	/* Complete channel list */
127 	struct mtx		vmbus_chan_lock;
128 	TAILQ_HEAD(, vmbus_channel) vmbus_chans;
129 
130 	struct intr_config_hook	vmbus_intrhook;
131 
132 #ifdef NEW_PCIB
133 	/* The list of usable MMIO ranges for PCIe pass-through */
134 	struct pcib_host_resources vmbus_mmio_res;
135 #endif
136 };
137 
138 #define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
139 #define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
140 
141 #define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
142 #define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
143 
144 struct vmbus_channel;
145 struct trapframe;
146 struct vmbus_message;
147 struct vmbus_msghc;
148 
149 void		vmbus_handle_intr(struct trapframe *);
150 int		vmbus_add_child(struct vmbus_channel *);
151 int		vmbus_delete_child(struct vmbus_channel *);
152 void		vmbus_et_intr(struct trapframe *);
153 uint32_t	vmbus_gpadl_alloc(struct vmbus_softc *);
154 
155 struct vmbus_msghc *
156 		vmbus_msghc_get(struct vmbus_softc *, size_t);
157 void		vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
158 void		*vmbus_msghc_dataptr(struct vmbus_msghc *);
159 int		vmbus_msghc_exec_noresult(struct vmbus_msghc *);
160 int		vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
161 void		vmbus_msghc_exec_cancel(struct vmbus_softc *,
162 		    struct vmbus_msghc *);
163 const struct vmbus_message *
164 		vmbus_msghc_wait_result(struct vmbus_softc *,
165 		    struct vmbus_msghc *);
166 const struct vmbus_message *
167 		vmbus_msghc_poll_result(struct vmbus_softc *,
168 		    struct vmbus_msghc *);
169 void		vmbus_msghc_wakeup(struct vmbus_softc *,
170 		    const struct vmbus_message *);
171 void		vmbus_msghc_reset(struct vmbus_msghc *, size_t);
172 
173 #endif	/* !_VMBUS_VAR_H_ */
174