xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_var.h (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
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/pci/pcivar.h>
36 #include <dev/pci/pcib_private.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_message;
56 struct vmbus_softc;
57 
58 typedef 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 
66 struct 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 taskqueue	*event_tq;	/* event taskq */
75 	struct taskqueue	*message_tq;	/* message taskq */
76 	struct task		message_task;	/* message task */
77 } __aligned(CACHE_LINE_SIZE);
78 
79 struct vmbus_softc {
80 	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
81 	u_long			*vmbus_tx_evtflags;
82 						/* event flags to host */
83 	struct vmbus_mnf	*vmbus_mnf2;	/* monitored by host */
84 
85 	u_long			*vmbus_rx_evtflags;
86 						/* compat evtflgs from host */
87 	struct vmbus_channel *volatile *vmbus_chmap;
88 	struct vmbus_xact_ctx	*vmbus_xc;
89 	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
90 
91 	/*
92 	 * Rarely used fields
93 	 */
94 
95 	device_t		vmbus_dev;
96 	int			vmbus_idtvec;
97 	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
98 	uint32_t		vmbus_version;
99 	uint32_t		vmbus_gpadl;
100 
101 	/* Shared memory for vmbus_{rx,tx}_evtflags */
102 	void			*vmbus_evtflags;
103 
104 	void			*vmbus_mnf1;	/* monitored by VM, unused */
105 
106 	bool			vmbus_scandone;
107 	struct task		vmbus_scandone_task;
108 
109 	struct taskqueue	*vmbus_devtq;	/* for dev attach/detach */
110 	struct taskqueue	*vmbus_subchtq;	/* for sub-chan attach/detach */
111 
112 	/* Primary channels */
113 	struct mtx		vmbus_prichan_lock;
114 	TAILQ_HEAD(, vmbus_channel) vmbus_prichans;
115 
116 	/* Complete channel list */
117 	struct mtx		vmbus_chan_lock;
118 	TAILQ_HEAD(, vmbus_channel) vmbus_chans;
119 
120 	struct intr_config_hook	vmbus_intrhook;
121 
122 #ifdef NEW_PCIB
123 	/* The list of usable MMIO ranges for PCIe pass-through */
124 	struct pcib_host_resources vmbus_mmio_res;
125 #endif
126 
127 #if defined(__aarch64__)
128 	struct resource *ires;
129 	void *icookie;
130 	int vector;
131 #endif
132 	bus_dma_tag_t   dmat;
133 };
134 
135 #define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
136 #define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
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 
141 struct vmbus_channel;
142 struct trapframe;
143 struct vmbus_message;
144 struct vmbus_msghc;
145 
146 void		vmbus_handle_intr(struct trapframe *);
147 int		vmbus_add_child(struct vmbus_channel *);
148 int		vmbus_delete_child(struct vmbus_channel *);
149 #if !defined(__aarch64__)
150 void		vmbus_et_intr(struct trapframe *);
151 #endif
152 uint32_t	vmbus_gpadl_alloc(struct vmbus_softc *);
153 
154 struct vmbus_msghc *
155 		vmbus_msghc_get(struct vmbus_softc *, size_t);
156 void		vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
157 void		*vmbus_msghc_dataptr(struct vmbus_msghc *);
158 int		vmbus_msghc_exec_noresult(struct vmbus_msghc *);
159 int		vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
160 void		vmbus_msghc_exec_cancel(struct vmbus_softc *,
161 		    struct vmbus_msghc *);
162 const struct vmbus_message *
163 		vmbus_msghc_wait_result(struct vmbus_softc *,
164 		    struct vmbus_msghc *);
165 const struct vmbus_message *
166 		vmbus_msghc_poll_result(struct vmbus_softc *,
167 		    struct vmbus_msghc *);
168 void		vmbus_msghc_wakeup(struct vmbus_softc *,
169 		    const struct vmbus_message *);
170 void		vmbus_msghc_reset(struct vmbus_msghc *, size_t);
171 
172 void    vmbus_handle_timer_intr1(struct vmbus_message *msg_base,
173         struct trapframe *frame);
174 
175 void    vmbus_synic_setup1(void *xsc);
176 void    vmbus_synic_teardown1(void);
177 int     vmbus_setup_intr1(struct vmbus_softc *sc);
178 void    vmbus_intr_teardown1(struct vmbus_softc *sc);
179 #endif	/* !_VMBUS_VAR_H_ */
180