xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_var.h (revision e6bfd18d21b225af6a0ed67ceeaf1293b7b9eba5)
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/kernel.h>
34 #include <sys/taskqueue.h>
35 #include <sys/rman.h>
36 
37 #include <dev/pci/pcivar.h>
38 #include <dev/pci/pcib_private.h>
39 
40 /*
41  * NOTE: DO NOT CHANGE THIS.
42  */
43 #define VMBUS_SINT_MESSAGE	2
44 /*
45  * NOTE:
46  * - DO NOT set it to the same value as VMBUS_SINT_MESSAGE.
47  * - DO NOT set it to 0.
48  */
49 #define VMBUS_SINT_TIMER	4
50 
51 /*
52  * NOTE: DO NOT CHANGE THESE
53  */
54 #define VMBUS_CONNID_MESSAGE		1
55 #define VMBUS_CONNID_EVENT		2
56 
57 struct vmbus_message;
58 struct vmbus_softc;
59 
60 typedef void		(*vmbus_chanmsg_proc_t)(struct vmbus_softc *,
61 			    const struct vmbus_message *);
62 
63 #define VMBUS_CHANMSG_PROC(name, func)	\
64 	[VMBUS_CHANMSG_TYPE_##name] = func
65 #define VMBUS_CHANMSG_PROC_WAKEUP(name)	\
66 	VMBUS_CHANMSG_PROC(name, vmbus_msghc_wakeup)
67 
68 struct vmbus_pcpu_data {
69 	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
70 	struct vmbus_message	*message;	/* shared messages */
71 	uint32_t		vcpuid;		/* virtual cpuid */
72 	int			event_flags_cnt;/* # of event flags */
73 	struct vmbus_evtflags	*event_flags;	/* event flags from host */
74 
75 	/* Rarely used fields */
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 
81 struct 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 vmbus_channel *volatile *vmbus_chmap;
90 	struct vmbus_xact_ctx	*vmbus_xc;
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 
106 	void			*vmbus_mnf1;	/* monitored by VM, unused */
107 
108 	bool			vmbus_scandone;
109 	struct task		vmbus_scandone_task;
110 
111 	struct taskqueue	*vmbus_devtq;	/* for dev attach/detach */
112 	struct taskqueue	*vmbus_subchtq;	/* for sub-chan attach/detach */
113 
114 	/* Primary channels */
115 	struct mtx		vmbus_prichan_lock;
116 	TAILQ_HEAD(, vmbus_channel) vmbus_prichans;
117 
118 	/* Complete channel list */
119 	struct mtx		vmbus_chan_lock;
120 	TAILQ_HEAD(, vmbus_channel) vmbus_chans;
121 
122 	struct intr_config_hook	vmbus_intrhook;
123 
124 #ifdef NEW_PCIB
125 	/* The list of usable MMIO ranges for PCIe pass-through */
126 	struct pcib_host_resources vmbus_mmio_res;
127 #endif
128 
129 #if defined(__aarch64__)
130 	struct resource *ires;
131 	void *icookie;
132 	int vector;
133 #endif
134 };
135 
136 #define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
137 #define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
138 
139 #define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
140 #define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
141 
142 struct vmbus_channel;
143 struct trapframe;
144 struct vmbus_message;
145 struct vmbus_msghc;
146 
147 void		vmbus_handle_intr(struct trapframe *);
148 int		vmbus_add_child(struct vmbus_channel *);
149 int		vmbus_delete_child(struct vmbus_channel *);
150 #if !defined(__aarch64__)
151 void		vmbus_et_intr(struct trapframe *);
152 #endif
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 void    vmbus_handle_timer_intr1(struct vmbus_message *msg_base,
174         struct trapframe *frame);
175 
176 void    vmbus_synic_setup1(void *xsc);
177 void    vmbus_synic_teardown1(void);
178 int     vmbus_setup_intr1(struct vmbus_softc *sc);
179 void    vmbus_intr_teardown1(struct vmbus_softc *sc);
180 #endif	/* !_VMBUS_VAR_H_ */
181