xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_et.c (revision 716fd348e01c5f2ba125f878a634a753436c2994)
1 /*-
2  * Copyright (c) 2015,2016-2017 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, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *      notice, this list of conditions and the following disclaimer in the
12  *      documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/bus.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/proc.h>
35 #include <sys/smp.h>
36 #include <sys/systm.h>
37 #include <sys/timeet.h>
38 
39 #include <dev/hyperv/include/hyperv.h>
40 #include <dev/hyperv/vmbus/hyperv_reg.h>
41 #include <dev/hyperv/vmbus/hyperv_var.h>
42 #include <dev/hyperv/vmbus/vmbus_var.h>
43 
44 #define VMBUS_ET_NAME			"hvet"
45 
46 #define MSR_HV_STIMER0_CFG_SINT		\
47 	((((uint64_t)VMBUS_SINT_TIMER) << MSR_HV_STIMER_CFG_SINT_SHIFT) & \
48 	 MSR_HV_STIMER_CFG_SINT_MASK)
49 
50 /*
51  * Additionally required feature:
52  * - SynIC is needed for interrupt generation.
53  */
54 #define CPUID_HV_ET_MASK		(CPUID_HV_MSR_SYNIC |		\
55 					 CPUID_HV_MSR_SYNTIMER)
56 
57 static void			vmbus_et_identify(driver_t *, device_t);
58 static int			vmbus_et_probe(device_t);
59 static int			vmbus_et_attach(device_t);
60 static int			vmbus_et_detach(device_t);
61 static int			vmbus_et_start(struct eventtimer *, sbintime_t,
62 				    sbintime_t);
63 
64 static struct eventtimer	vmbus_et;
65 
66 static device_method_t vmbus_et_methods[] = {
67 	DEVMETHOD(device_identify,	vmbus_et_identify),
68 	DEVMETHOD(device_probe,		vmbus_et_probe),
69 	DEVMETHOD(device_attach,	vmbus_et_attach),
70 	DEVMETHOD(device_detach,	vmbus_et_detach),
71 
72 	DEVMETHOD_END
73 };
74 
75 static driver_t vmbus_et_driver = {
76 	VMBUS_ET_NAME,
77 	vmbus_et_methods,
78 	0
79 };
80 
81 DRIVER_MODULE(hv_et, vmbus, vmbus_et_driver, NULL, NULL);
82 MODULE_VERSION(hv_et, 1);
83 
84 static __inline uint64_t
85 hyperv_sbintime2count(sbintime_t time)
86 {
87 	struct timespec val;
88 
89 	val = sbttots(time);
90 	return (val.tv_sec * HYPERV_TIMER_FREQ) +
91 	    (val.tv_nsec / HYPERV_TIMER_NS_FACTOR);
92 }
93 
94 static int
95 vmbus_et_start(struct eventtimer *et __unused, sbintime_t first,
96     sbintime_t period __unused)
97 {
98 	uint64_t current;
99 
100 	current = hyperv_tc64();
101 	current += hyperv_sbintime2count(first);
102 	wrmsr(MSR_HV_STIMER0_COUNT, current);
103 
104 	return (0);
105 }
106 
107 void
108 vmbus_et_intr(struct trapframe *frame)
109 {
110 	struct trapframe *oldframe;
111 	struct thread *td;
112 
113 	if (vmbus_et.et_active) {
114 		td = curthread;
115 		td->td_intr_nesting_level++;
116 		oldframe = td->td_intr_frame;
117 		td->td_intr_frame = frame;
118 		vmbus_et.et_event_cb(&vmbus_et, vmbus_et.et_arg);
119 		td->td_intr_frame = oldframe;
120 		td->td_intr_nesting_level--;
121 	}
122 }
123 
124 static void
125 vmbus_et_identify(driver_t *driver, device_t parent)
126 {
127 	if (device_get_unit(parent) != 0 ||
128 	    device_find_child(parent, VMBUS_ET_NAME, -1) != NULL ||
129 	    (hyperv_features & CPUID_HV_ET_MASK) != CPUID_HV_ET_MASK ||
130 	    hyperv_tc64 == NULL)
131 		return;
132 
133 	device_add_child(parent, VMBUS_ET_NAME, -1);
134 }
135 
136 static int
137 vmbus_et_probe(device_t dev)
138 {
139 	if (resource_disabled(VMBUS_ET_NAME, 0))
140 		return (ENXIO);
141 
142 	device_set_desc(dev, "Hyper-V event timer");
143 
144 	return (BUS_PROBE_NOWILDCARD);
145 }
146 
147 static void
148 vmbus_et_config(void *arg __unused)
149 {
150 	/*
151 	 * Make sure that STIMER0 is really disabled before writing
152 	 * to STIMER0_CONFIG.
153 	 *
154 	 * "Writing to the configuration register of a timer that
155 	 *  is already enabled may result in undefined behaviour."
156 	 */
157 	for (;;) {
158 		uint64_t val;
159 
160 		/* Stop counting, and this also implies disabling STIMER0 */
161 		wrmsr(MSR_HV_STIMER0_COUNT, 0);
162 
163 		val = rdmsr(MSR_HV_STIMER0_CONFIG);
164 		if ((val & MSR_HV_STIMER_CFG_ENABLE) == 0)
165 			break;
166 		cpu_spinwait();
167 	}
168 	wrmsr(MSR_HV_STIMER0_CONFIG,
169 	    MSR_HV_STIMER_CFG_AUTOEN | MSR_HV_STIMER0_CFG_SINT);
170 }
171 
172 static int
173 vmbus_et_attach(device_t dev)
174 {
175 	/* TODO: use independent IDT vector */
176 
177 	vmbus_et.et_name = "Hyper-V";
178 	vmbus_et.et_flags = ET_FLAGS_ONESHOT | ET_FLAGS_PERCPU;
179 	vmbus_et.et_quality = 1000;
180 	vmbus_et.et_frequency = HYPERV_TIMER_FREQ;
181 	vmbus_et.et_min_period = (0x00000001ULL << 32) / HYPERV_TIMER_FREQ;
182 	vmbus_et.et_max_period = (0xfffffffeULL << 32) / HYPERV_TIMER_FREQ;
183 	vmbus_et.et_start = vmbus_et_start;
184 
185 	/*
186 	 * Delay a bit to make sure that hyperv_tc64 will not return 0,
187 	 * since writing 0 to STIMER0_COUNT will disable STIMER0.
188 	 */
189 	DELAY(100);
190 	smp_rendezvous(NULL, vmbus_et_config, NULL, NULL);
191 
192 	return (et_register(&vmbus_et));
193 }
194 
195 static int
196 vmbus_et_detach(device_t dev)
197 {
198 	return (et_deregister(&vmbus_et));
199 }
200