15c072c8eSSepherosa Ziehau /*-
293b4e111SSepherosa Ziehau * Copyright (c) 2014,2016-2017 Microsoft Corp.
35c072c8eSSepherosa Ziehau * All rights reserved.
45c072c8eSSepherosa Ziehau *
55c072c8eSSepherosa Ziehau * Redistribution and use in source and binary forms, with or without
65c072c8eSSepherosa Ziehau * modification, are permitted provided that the following conditions
75c072c8eSSepherosa Ziehau * are met:
85c072c8eSSepherosa Ziehau * 1. Redistributions of source code must retain the above copyright
95c072c8eSSepherosa Ziehau * notice unmodified, this list of conditions, and the following
105c072c8eSSepherosa Ziehau * disclaimer.
115c072c8eSSepherosa Ziehau * 2. Redistributions in binary form must reproduce the above copyright
125c072c8eSSepherosa Ziehau * notice, this list of conditions and the following disclaimer in the
135c072c8eSSepherosa Ziehau * documentation and/or other materials provided with the distribution.
145c072c8eSSepherosa Ziehau *
155c072c8eSSepherosa Ziehau * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
165c072c8eSSepherosa Ziehau * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
175c072c8eSSepherosa Ziehau * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
185c072c8eSSepherosa Ziehau * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
195c072c8eSSepherosa Ziehau * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
205c072c8eSSepherosa Ziehau * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
215c072c8eSSepherosa Ziehau * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
225c072c8eSSepherosa Ziehau * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
235c072c8eSSepherosa Ziehau * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
245c072c8eSSepherosa Ziehau * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
255c072c8eSSepherosa Ziehau */
265c072c8eSSepherosa Ziehau
275c072c8eSSepherosa Ziehau #include <sys/param.h>
285c072c8eSSepherosa Ziehau #include <sys/bus.h>
295c072c8eSSepherosa Ziehau #include <sys/kernel.h>
305c072c8eSSepherosa Ziehau #include <sys/module.h>
315c072c8eSSepherosa Ziehau #include <sys/syscallsubr.h>
325c072c8eSSepherosa Ziehau #include <sys/sysctl.h>
335c072c8eSSepherosa Ziehau #include <sys/systm.h>
345c072c8eSSepherosa Ziehau
355c072c8eSSepherosa Ziehau #include <dev/hyperv/include/hyperv.h>
365c072c8eSSepherosa Ziehau #include <dev/hyperv/include/vmbus.h>
375c072c8eSSepherosa Ziehau #include <dev/hyperv/utilities/vmbus_icreg.h>
385c072c8eSSepherosa Ziehau #include <dev/hyperv/utilities/vmbus_icvar.h>
395c072c8eSSepherosa Ziehau
405c072c8eSSepherosa Ziehau #define VMBUS_TIMESYNC_FWVER_MAJOR 3
415c072c8eSSepherosa Ziehau #define VMBUS_TIMESYNC_FWVER \
425c072c8eSSepherosa Ziehau VMBUS_IC_VERSION(VMBUS_TIMESYNC_FWVER_MAJOR, 0)
435c072c8eSSepherosa Ziehau
445c072c8eSSepherosa Ziehau #define VMBUS_TIMESYNC_MSGVER_MAJOR 4
455c072c8eSSepherosa Ziehau #define VMBUS_TIMESYNC_MSGVER \
465c072c8eSSepherosa Ziehau VMBUS_IC_VERSION(VMBUS_TIMESYNC_MSGVER_MAJOR, 0)
475c072c8eSSepherosa Ziehau
4869b12e53SSepherosa Ziehau #define VMBUS_TIMESYNC_MSGVER4(sc) \
4969b12e53SSepherosa Ziehau VMBUS_ICVER_LE(VMBUS_IC_VERSION(4, 0), (sc)->ic_msgver)
5069b12e53SSepherosa Ziehau
515c072c8eSSepherosa Ziehau #define VMBUS_TIMESYNC_DORTT(sc) \
52227bb849SSepherosa Ziehau (VMBUS_TIMESYNC_MSGVER4((sc)) && hyperv_tc64 != NULL)
535c072c8eSSepherosa Ziehau
545c072c8eSSepherosa Ziehau static int vmbus_timesync_probe(device_t);
555c072c8eSSepherosa Ziehau static int vmbus_timesync_attach(device_t);
565c072c8eSSepherosa Ziehau
575c072c8eSSepherosa Ziehau static const struct vmbus_ic_desc vmbus_timesync_descs[] = {
585c072c8eSSepherosa Ziehau {
595c072c8eSSepherosa Ziehau .ic_guid = { .hv_guid = {
605c072c8eSSepherosa Ziehau 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49,
615c072c8eSSepherosa Ziehau 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf } },
625c072c8eSSepherosa Ziehau .ic_desc = "Hyper-V Timesync"
635c072c8eSSepherosa Ziehau },
645c072c8eSSepherosa Ziehau VMBUS_IC_DESC_END
655c072c8eSSepherosa Ziehau };
665c072c8eSSepherosa Ziehau
675c072c8eSSepherosa Ziehau static device_method_t vmbus_timesync_methods[] = {
685c072c8eSSepherosa Ziehau /* Device interface */
695c072c8eSSepherosa Ziehau DEVMETHOD(device_probe, vmbus_timesync_probe),
705c072c8eSSepherosa Ziehau DEVMETHOD(device_attach, vmbus_timesync_attach),
715c072c8eSSepherosa Ziehau DEVMETHOD(device_detach, vmbus_ic_detach),
725c072c8eSSepherosa Ziehau DEVMETHOD_END
735c072c8eSSepherosa Ziehau };
745c072c8eSSepherosa Ziehau
755c072c8eSSepherosa Ziehau static driver_t vmbus_timesync_driver = {
765c072c8eSSepherosa Ziehau "hvtimesync",
775c072c8eSSepherosa Ziehau vmbus_timesync_methods,
785c072c8eSSepherosa Ziehau sizeof(struct vmbus_ic_softc)
795c072c8eSSepherosa Ziehau };
805c072c8eSSepherosa Ziehau
81c1cef544SJohn Baldwin DRIVER_MODULE(hv_timesync, vmbus, vmbus_timesync_driver, NULL, NULL);
825c072c8eSSepherosa Ziehau MODULE_VERSION(hv_timesync, 1);
835c072c8eSSepherosa Ziehau MODULE_DEPEND(hv_timesync, vmbus, 1, 1, 1);
845c072c8eSSepherosa Ziehau
855c072c8eSSepherosa Ziehau SYSCTL_NODE(_hw, OID_AUTO, hvtimesync, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
865c072c8eSSepherosa Ziehau "Hyper-V timesync interface");
875c072c8eSSepherosa Ziehau
885c072c8eSSepherosa Ziehau static int vmbus_ts_ignore_sync = 0;
895c072c8eSSepherosa Ziehau SYSCTL_INT(_hw_hvtimesync, OID_AUTO, ignore_sync, CTLFLAG_RWTUN,
905c072c8eSSepherosa Ziehau &vmbus_ts_ignore_sync, 0, "Ignore the sync request.");
915c072c8eSSepherosa Ziehau
925c072c8eSSepherosa Ziehau /*
935c072c8eSSepherosa Ziehau * Trigger sample sync when drift exceeds threshold (ms).
945c072c8eSSepherosa Ziehau * Ignore the sample request when set to 0.
955c072c8eSSepherosa Ziehau */
965c072c8eSSepherosa Ziehau static int vmbus_ts_sample_thresh = 100;
975c072c8eSSepherosa Ziehau SYSCTL_INT(_hw_hvtimesync, OID_AUTO, sample_thresh, CTLFLAG_RWTUN,
985c072c8eSSepherosa Ziehau &vmbus_ts_sample_thresh, 0,
995c072c8eSSepherosa Ziehau "Threshold that makes sample request trigger the sync (unit: ms).");
1005c072c8eSSepherosa Ziehau
1015c072c8eSSepherosa Ziehau static int vmbus_ts_sample_verbose = 0;
1025c072c8eSSepherosa Ziehau SYSCTL_INT(_hw_hvtimesync, OID_AUTO, sample_verbose, CTLFLAG_RWTUN,
1035c072c8eSSepherosa Ziehau &vmbus_ts_sample_verbose, 0, "Increase sample request verbosity.");
1045c072c8eSSepherosa Ziehau
1055c072c8eSSepherosa Ziehau static void
vmbus_timesync(struct vmbus_ic_softc * sc,uint64_t hvtime,uint64_t sent_tc,uint8_t tsflags)1065c072c8eSSepherosa Ziehau vmbus_timesync(struct vmbus_ic_softc *sc, uint64_t hvtime, uint64_t sent_tc,
1075c072c8eSSepherosa Ziehau uint8_t tsflags)
1085c072c8eSSepherosa Ziehau {
1095c072c8eSSepherosa Ziehau struct timespec vm_ts;
1105c072c8eSSepherosa Ziehau uint64_t hv_ns, vm_ns, rtt = 0;
1115c072c8eSSepherosa Ziehau
1125c072c8eSSepherosa Ziehau if (VMBUS_TIMESYNC_DORTT(sc))
113227bb849SSepherosa Ziehau rtt = hyperv_tc64() - sent_tc;
1145c072c8eSSepherosa Ziehau
1155c072c8eSSepherosa Ziehau hv_ns = (hvtime - VMBUS_ICMSG_TS_BASE + rtt) * HYPERV_TIMER_NS_FACTOR;
1165c072c8eSSepherosa Ziehau nanotime(&vm_ts);
1175c072c8eSSepherosa Ziehau vm_ns = (vm_ts.tv_sec * NANOSEC) + vm_ts.tv_nsec;
1185c072c8eSSepherosa Ziehau
1195c072c8eSSepherosa Ziehau if ((tsflags & VMBUS_ICMSG_TS_FLAG_SYNC) && !vmbus_ts_ignore_sync) {
1205c072c8eSSepherosa Ziehau struct timespec hv_ts;
1215c072c8eSSepherosa Ziehau
1225c072c8eSSepherosa Ziehau if (bootverbose) {
1235c072c8eSSepherosa Ziehau device_printf(sc->ic_dev, "apply sync request, "
1245c072c8eSSepherosa Ziehau "hv: %ju, vm: %ju\n",
1255c072c8eSSepherosa Ziehau (uintmax_t)hv_ns, (uintmax_t)vm_ns);
1265c072c8eSSepherosa Ziehau }
1275c072c8eSSepherosa Ziehau hv_ts.tv_sec = hv_ns / NANOSEC;
1285c072c8eSSepherosa Ziehau hv_ts.tv_nsec = hv_ns % NANOSEC;
1295c072c8eSSepherosa Ziehau kern_clock_settime(curthread, CLOCK_REALTIME, &hv_ts);
1305c072c8eSSepherosa Ziehau /* Done! */
1315c072c8eSSepherosa Ziehau return;
1325c072c8eSSepherosa Ziehau }
1335c072c8eSSepherosa Ziehau
1345c072c8eSSepherosa Ziehau if ((tsflags & VMBUS_ICMSG_TS_FLAG_SAMPLE) &&
13592c1ba28SSepherosa Ziehau vmbus_ts_sample_thresh >= 0) {
1365c072c8eSSepherosa Ziehau int64_t diff;
1375c072c8eSSepherosa Ziehau
1385c072c8eSSepherosa Ziehau if (vmbus_ts_sample_verbose) {
1395c072c8eSSepherosa Ziehau device_printf(sc->ic_dev, "sample request, "
1405c072c8eSSepherosa Ziehau "hv: %ju, vm: %ju\n",
1415c072c8eSSepherosa Ziehau (uintmax_t)hv_ns, (uintmax_t)vm_ns);
1425c072c8eSSepherosa Ziehau }
1435c072c8eSSepherosa Ziehau
1445c072c8eSSepherosa Ziehau if (hv_ns > vm_ns)
1455c072c8eSSepherosa Ziehau diff = hv_ns - vm_ns;
1465c072c8eSSepherosa Ziehau else
1475c072c8eSSepherosa Ziehau diff = vm_ns - hv_ns;
1485c072c8eSSepherosa Ziehau /* nanosec -> millisec */
1495c072c8eSSepherosa Ziehau diff /= 1000000;
1505c072c8eSSepherosa Ziehau
1515c072c8eSSepherosa Ziehau if (diff > vmbus_ts_sample_thresh) {
1525c072c8eSSepherosa Ziehau struct timespec hv_ts;
1535c072c8eSSepherosa Ziehau
1545c072c8eSSepherosa Ziehau if (bootverbose) {
1555c072c8eSSepherosa Ziehau device_printf(sc->ic_dev,
1565c072c8eSSepherosa Ziehau "apply sample request, hv: %ju, vm: %ju\n",
1575c072c8eSSepherosa Ziehau (uintmax_t)hv_ns, (uintmax_t)vm_ns);
1585c072c8eSSepherosa Ziehau }
1595c072c8eSSepherosa Ziehau hv_ts.tv_sec = hv_ns / NANOSEC;
1605c072c8eSSepherosa Ziehau hv_ts.tv_nsec = hv_ns % NANOSEC;
1615c072c8eSSepherosa Ziehau kern_clock_settime(curthread, CLOCK_REALTIME, &hv_ts);
1625c072c8eSSepherosa Ziehau }
1635c072c8eSSepherosa Ziehau /* Done */
1645c072c8eSSepherosa Ziehau return;
1655c072c8eSSepherosa Ziehau }
1665c072c8eSSepherosa Ziehau }
1675c072c8eSSepherosa Ziehau
1685c072c8eSSepherosa Ziehau static void
vmbus_timesync_cb(struct vmbus_channel * chan,void * xsc)1695c072c8eSSepherosa Ziehau vmbus_timesync_cb(struct vmbus_channel *chan, void *xsc)
1705c072c8eSSepherosa Ziehau {
1715c072c8eSSepherosa Ziehau struct vmbus_ic_softc *sc = xsc;
1725c072c8eSSepherosa Ziehau struct vmbus_icmsg_hdr *hdr;
1735c072c8eSSepherosa Ziehau int dlen, error;
1745c072c8eSSepherosa Ziehau uint64_t xactid;
1755c072c8eSSepherosa Ziehau void *data;
1765c072c8eSSepherosa Ziehau
1775c072c8eSSepherosa Ziehau /*
1785c072c8eSSepherosa Ziehau * Receive request.
1795c072c8eSSepherosa Ziehau */
1805c072c8eSSepherosa Ziehau data = sc->ic_buf;
1815c072c8eSSepherosa Ziehau dlen = sc->ic_buflen;
1825c072c8eSSepherosa Ziehau error = vmbus_chan_recv(chan, data, &dlen, &xactid);
1835c072c8eSSepherosa Ziehau KASSERT(error != ENOBUFS, ("icbuf is not large enough"));
1845c072c8eSSepherosa Ziehau if (error)
1855c072c8eSSepherosa Ziehau return;
1865c072c8eSSepherosa Ziehau
1875c072c8eSSepherosa Ziehau if (dlen < sizeof(*hdr)) {
1885c072c8eSSepherosa Ziehau device_printf(sc->ic_dev, "invalid data len %d\n", dlen);
1895c072c8eSSepherosa Ziehau return;
1905c072c8eSSepherosa Ziehau }
1915c072c8eSSepherosa Ziehau hdr = data;
1925c072c8eSSepherosa Ziehau
1935c072c8eSSepherosa Ziehau /*
1945c072c8eSSepherosa Ziehau * Update request, which will be echoed back as response.
1955c072c8eSSepherosa Ziehau */
1965c072c8eSSepherosa Ziehau switch (hdr->ic_type) {
1975c072c8eSSepherosa Ziehau case VMBUS_ICMSG_TYPE_NEGOTIATE:
1985c072c8eSSepherosa Ziehau error = vmbus_ic_negomsg(sc, data, &dlen,
1995c072c8eSSepherosa Ziehau VMBUS_TIMESYNC_FWVER, VMBUS_TIMESYNC_MSGVER);
2005c072c8eSSepherosa Ziehau if (error)
2015c072c8eSSepherosa Ziehau return;
2025c072c8eSSepherosa Ziehau if (VMBUS_TIMESYNC_DORTT(sc))
2035c072c8eSSepherosa Ziehau device_printf(sc->ic_dev, "RTT\n");
2045c072c8eSSepherosa Ziehau break;
2055c072c8eSSepherosa Ziehau
2065c072c8eSSepherosa Ziehau case VMBUS_ICMSG_TYPE_TIMESYNC:
20769b12e53SSepherosa Ziehau if (VMBUS_TIMESYNC_MSGVER4(sc)) {
20869b12e53SSepherosa Ziehau const struct vmbus_icmsg_timesync4 *msg4;
20969b12e53SSepherosa Ziehau
21069b12e53SSepherosa Ziehau if (dlen < sizeof(*msg4)) {
21169b12e53SSepherosa Ziehau device_printf(sc->ic_dev, "invalid timesync4 "
21269b12e53SSepherosa Ziehau "len %d\n", dlen);
21369b12e53SSepherosa Ziehau return;
21469b12e53SSepherosa Ziehau }
21569b12e53SSepherosa Ziehau msg4 = data;
21669b12e53SSepherosa Ziehau vmbus_timesync(sc, msg4->ic_hvtime, msg4->ic_sent_tc,
21769b12e53SSepherosa Ziehau msg4->ic_tsflags);
21869b12e53SSepherosa Ziehau } else {
21969b12e53SSepherosa Ziehau const struct vmbus_icmsg_timesync *msg;
22069b12e53SSepherosa Ziehau
2215c072c8eSSepherosa Ziehau if (dlen < sizeof(*msg)) {
22269b12e53SSepherosa Ziehau device_printf(sc->ic_dev, "invalid timesync "
22369b12e53SSepherosa Ziehau "len %d\n", dlen);
2245c072c8eSSepherosa Ziehau return;
2255c072c8eSSepherosa Ziehau }
2265c072c8eSSepherosa Ziehau msg = data;
22769b12e53SSepherosa Ziehau vmbus_timesync(sc, msg->ic_hvtime, 0, msg->ic_tsflags);
22869b12e53SSepherosa Ziehau }
2295c072c8eSSepherosa Ziehau break;
2305c072c8eSSepherosa Ziehau
2315c072c8eSSepherosa Ziehau default:
2325c072c8eSSepherosa Ziehau device_printf(sc->ic_dev, "got 0x%08x icmsg\n", hdr->ic_type);
2335c072c8eSSepherosa Ziehau break;
2345c072c8eSSepherosa Ziehau }
2355c072c8eSSepherosa Ziehau
2365c072c8eSSepherosa Ziehau /*
2375c072c8eSSepherosa Ziehau * Send response by echoing the request back.
2385c072c8eSSepherosa Ziehau */
2395c072c8eSSepherosa Ziehau vmbus_ic_sendresp(sc, chan, data, dlen, xactid);
2405c072c8eSSepherosa Ziehau }
2415c072c8eSSepherosa Ziehau
2425c072c8eSSepherosa Ziehau static int
vmbus_timesync_probe(device_t dev)2435c072c8eSSepherosa Ziehau vmbus_timesync_probe(device_t dev)
2445c072c8eSSepherosa Ziehau {
2455c072c8eSSepherosa Ziehau
2465c072c8eSSepherosa Ziehau return (vmbus_ic_probe(dev, vmbus_timesync_descs));
2475c072c8eSSepherosa Ziehau }
2485c072c8eSSepherosa Ziehau
2495c072c8eSSepherosa Ziehau static int
vmbus_timesync_attach(device_t dev)2505c072c8eSSepherosa Ziehau vmbus_timesync_attach(device_t dev)
2515c072c8eSSepherosa Ziehau {
2525c072c8eSSepherosa Ziehau
2535c072c8eSSepherosa Ziehau return (vmbus_ic_attach(dev, vmbus_timesync_cb));
2545c072c8eSSepherosa Ziehau }
255