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