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 DRIVER_MODULE(hv_heartbeat, vmbus, vmbus_heartbeat_driver, NULL, NULL); 77 MODULE_VERSION(hv_heartbeat, 1); 78 MODULE_DEPEND(hv_heartbeat, vmbus, 1, 1, 1); 79 80 static void 81 vmbus_heartbeat_cb(struct vmbus_channel *chan, void *xsc) 82 { 83 struct vmbus_ic_softc *sc = xsc; 84 struct vmbus_icmsg_hdr *hdr; 85 int dlen, error; 86 uint64_t xactid; 87 void *data; 88 89 /* 90 * Receive request. 91 */ 92 data = sc->ic_buf; 93 dlen = sc->ic_buflen; 94 error = vmbus_chan_recv(chan, data, &dlen, &xactid); 95 KASSERT(error != ENOBUFS, ("icbuf is not large enough")); 96 if (error) 97 return; 98 99 if (dlen < sizeof(*hdr)) { 100 device_printf(sc->ic_dev, "invalid data len %d\n", dlen); 101 return; 102 } 103 hdr = data; 104 105 /* 106 * Update request, which will be echoed back as response. 107 */ 108 switch (hdr->ic_type) { 109 case VMBUS_ICMSG_TYPE_NEGOTIATE: 110 error = vmbus_ic_negomsg(sc, data, &dlen, 111 VMBUS_HEARTBEAT_FWVER, VMBUS_HEARTBEAT_MSGVER); 112 if (error) 113 return; 114 break; 115 116 case VMBUS_ICMSG_TYPE_HEARTBEAT: 117 /* Only ic_seq is a must */ 118 if (dlen < VMBUS_ICMSG_HEARTBEAT_SIZE_MIN) { 119 device_printf(sc->ic_dev, "invalid heartbeat len %d\n", 120 dlen); 121 return; 122 } 123 ((struct vmbus_icmsg_heartbeat *)data)->ic_seq++; 124 break; 125 126 default: 127 device_printf(sc->ic_dev, "got 0x%08x icmsg\n", hdr->ic_type); 128 break; 129 } 130 131 /* 132 * Send response by echoing the request back. 133 */ 134 vmbus_ic_sendresp(sc, chan, data, dlen, xactid); 135 } 136 137 static int 138 vmbus_heartbeat_probe(device_t dev) 139 { 140 141 return (vmbus_ic_probe(dev, vmbus_heartbeat_descs)); 142 } 143 144 static int 145 vmbus_heartbeat_attach(device_t dev) 146 { 147 148 return (vmbus_ic_attach(dev, vmbus_heartbeat_cb)); 149 } 150