1 /*- 2 * Copyright (c) 2014,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 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/systm.h> 35 36 #include <dev/hyperv/include/hyperv.h> 37 #include <dev/hyperv/include/vmbus.h> 38 #include <dev/hyperv/utilities/vmbus_icreg.h> 39 #include <dev/hyperv/utilities/vmbus_icvar.h> 40 41 #define VMBUS_HEARTBEAT_FWVER_MAJOR 3 42 #define VMBUS_HEARTBEAT_FWVER \ 43 VMBUS_IC_VERSION(VMBUS_HEARTBEAT_FWVER_MAJOR, 0) 44 45 #define VMBUS_HEARTBEAT_MSGVER_MAJOR 3 46 #define VMBUS_HEARTBEAT_MSGVER \ 47 VMBUS_IC_VERSION(VMBUS_HEARTBEAT_MSGVER_MAJOR, 0) 48 49 static int vmbus_heartbeat_probe(device_t); 50 static int vmbus_heartbeat_attach(device_t); 51 52 static const struct vmbus_ic_desc vmbus_heartbeat_descs[] = { 53 { 54 .ic_guid = { .hv_guid = { 55 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, 56 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d} }, 57 .ic_desc = "Hyper-V Heartbeat" 58 }, 59 VMBUS_IC_DESC_END 60 }; 61 62 static device_method_t vmbus_heartbeat_methods[] = { 63 /* Device interface */ 64 DEVMETHOD(device_probe, vmbus_heartbeat_probe), 65 DEVMETHOD(device_attach, vmbus_heartbeat_attach), 66 DEVMETHOD(device_detach, vmbus_ic_detach), 67 DEVMETHOD_END 68 }; 69 70 static driver_t vmbus_heartbeat_driver = { 71 "hvheartbeat", 72 vmbus_heartbeat_methods, 73 sizeof(struct vmbus_ic_softc) 74 }; 75 76 static devclass_t vmbus_heartbeat_devclass; 77 78 DRIVER_MODULE(hv_heartbeat, vmbus, vmbus_heartbeat_driver, 79 vmbus_heartbeat_devclass, NULL, NULL); 80 MODULE_VERSION(hv_heartbeat, 1); 81 MODULE_DEPEND(hv_heartbeat, vmbus, 1, 1, 1); 82 83 static void 84 vmbus_heartbeat_cb(struct vmbus_channel *chan, void *xsc) 85 { 86 struct vmbus_ic_softc *sc = xsc; 87 struct vmbus_icmsg_hdr *hdr; 88 int dlen, error; 89 uint64_t xactid; 90 void *data; 91 92 /* 93 * Receive request. 94 */ 95 data = sc->ic_buf; 96 dlen = sc->ic_buflen; 97 error = vmbus_chan_recv(chan, data, &dlen, &xactid); 98 KASSERT(error != ENOBUFS, ("icbuf is not large enough")); 99 if (error) 100 return; 101 102 if (dlen < sizeof(*hdr)) { 103 device_printf(sc->ic_dev, "invalid data len %d\n", dlen); 104 return; 105 } 106 hdr = data; 107 108 /* 109 * Update request, which will be echoed back as response. 110 */ 111 switch (hdr->ic_type) { 112 case VMBUS_ICMSG_TYPE_NEGOTIATE: 113 error = vmbus_ic_negomsg(sc, data, &dlen, 114 VMBUS_HEARTBEAT_FWVER, VMBUS_HEARTBEAT_MSGVER); 115 if (error) 116 return; 117 break; 118 119 case VMBUS_ICMSG_TYPE_HEARTBEAT: 120 /* Only ic_seq is a must */ 121 if (dlen < VMBUS_ICMSG_HEARTBEAT_SIZE_MIN) { 122 device_printf(sc->ic_dev, "invalid heartbeat len %d\n", 123 dlen); 124 return; 125 } 126 ((struct vmbus_icmsg_heartbeat *)data)->ic_seq++; 127 break; 128 129 default: 130 device_printf(sc->ic_dev, "got 0x%08x icmsg\n", hdr->ic_type); 131 break; 132 } 133 134 /* 135 * Send response by echoing the request back. 136 */ 137 vmbus_ic_sendresp(sc, chan, data, dlen, xactid); 138 } 139 140 static int 141 vmbus_heartbeat_probe(device_t dev) 142 { 143 144 return (vmbus_ic_probe(dev, vmbus_heartbeat_descs)); 145 } 146 147 static int 148 vmbus_heartbeat_attach(device_t dev) 149 { 150 151 return (vmbus_ic_attach(dev, vmbus_heartbeat_cb)); 152 } 153