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