xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_var.h (revision 3f68b24e10aeb1a1cd85f2d349da44138d52c501)
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 struct vmbus_pcpu_data {
50 	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
51 	struct vmbus_message	*message;	/* shared messages */
52 	uint32_t		vcpuid;		/* virtual cpuid */
53 	int			event_flags_cnt;/* # of event flags */
54 	struct vmbus_evtflags	*event_flags;	/* event flags from host */
55 
56 	/* Rarely used fields */
57 	struct hyperv_dma	message_dma;	/* busdma glue */
58 	struct hyperv_dma	event_flags_dma;/* busdma glue */
59 	struct taskqueue	*event_tq;	/* event taskq */
60 	struct taskqueue	*message_tq;	/* message taskq */
61 	struct task		message_task;	/* message task */
62 } __aligned(CACHE_LINE_SIZE);
63 
64 struct vmbus_softc {
65 	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
66 	u_long			*vmbus_tx_evtflags;
67 						/* event flags to host */
68 	void			*vmbus_mnf2;	/* monitored by host */
69 
70 	u_long			*vmbus_rx_evtflags;
71 						/* compat evtflgs from host */
72 	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
73 
74 	/* Rarely used fields */
75 	device_t		vmbus_dev;
76 	int			vmbus_idtvec;
77 	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
78 
79 	/* Shared memory for vmbus_{rx,tx}_evtflags */
80 	void			*vmbus_evtflags;
81 	struct hyperv_dma	vmbus_evtflags_dma;
82 
83 	void			*vmbus_mnf1;	/* monitored by VM, unused */
84 	struct hyperv_dma	vmbus_mnf1_dma;
85 	struct hyperv_dma	vmbus_mnf2_dma;
86 };
87 
88 #define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
89 #define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
90 
91 extern struct vmbus_softc	*vmbus_sc;
92 
93 static __inline struct vmbus_softc *
94 vmbus_get_softc(void)
95 {
96 	return vmbus_sc;
97 }
98 
99 static __inline device_t
100 vmbus_get_device(void)
101 {
102 	return vmbus_sc->vmbus_dev;
103 }
104 
105 #define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
106 #define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
107 
108 struct hv_vmbus_channel;
109 struct trapframe;
110 struct vmbus_message;
111 
112 void	vmbus_on_channel_open(const struct hv_vmbus_channel *);
113 void	vmbus_event_proc(struct vmbus_softc *, int);
114 void	vmbus_event_proc_compat(struct vmbus_softc *, int);
115 void	vmbus_handle_intr(struct trapframe *);
116 
117 void	vmbus_et_intr(struct trapframe *);
118 
119 void	vmbus_chan_msgproc(struct vmbus_softc *, const struct vmbus_message *);
120 
121 #endif	/* !_VMBUS_VAR_H_ */
122