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/reboot.h> 33 #include <sys/systm.h> 34 35 #include <dev/hyperv/include/hyperv.h> 36 #include <dev/hyperv/include/vmbus.h> 37 #include <dev/hyperv/utilities/vmbus_icreg.h> 38 #include <dev/hyperv/utilities/vmbus_icvar.h> 39 40 #define VMBUS_SHUTDOWN_FWVER_MAJOR 3 41 #define VMBUS_SHUTDOWN_FWVER \ 42 VMBUS_IC_VERSION(VMBUS_SHUTDOWN_FWVER_MAJOR, 0) 43 44 #define VMBUS_SHUTDOWN_MSGVER_MAJOR 3 45 #define VMBUS_SHUTDOWN_MSGVER \ 46 VMBUS_IC_VERSION(VMBUS_SHUTDOWN_MSGVER_MAJOR, 0) 47 48 static int vmbus_shutdown_probe(device_t); 49 static int vmbus_shutdown_attach(device_t); 50 51 static const struct vmbus_ic_desc vmbus_shutdown_descs[] = { 52 { 53 .ic_guid = { .hv_guid = { 54 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, 55 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb } }, 56 .ic_desc = "Hyper-V Shutdown" 57 }, 58 VMBUS_IC_DESC_END 59 }; 60 61 static device_method_t vmbus_shutdown_methods[] = { 62 /* Device interface */ 63 DEVMETHOD(device_probe, vmbus_shutdown_probe), 64 DEVMETHOD(device_attach, vmbus_shutdown_attach), 65 DEVMETHOD(device_detach, vmbus_ic_detach), 66 DEVMETHOD_END 67 }; 68 69 static driver_t vmbus_shutdown_driver = { 70 "hvshutdown", 71 vmbus_shutdown_methods, 72 sizeof(struct vmbus_ic_softc) 73 }; 74 75 DRIVER_MODULE(hv_shutdown, vmbus, vmbus_shutdown_driver, NULL, NULL); 76 MODULE_VERSION(hv_shutdown, 1); 77 MODULE_DEPEND(hv_shutdown, vmbus, 1, 1, 1); 78 79 static void 80 vmbus_shutdown_cb(struct vmbus_channel *chan, void *xsc) 81 { 82 struct vmbus_ic_softc *sc = xsc; 83 struct vmbus_icmsg_hdr *hdr; 84 struct vmbus_icmsg_shutdown *msg; 85 int dlen, error, do_shutdown = 0; 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_SHUTDOWN_FWVER, VMBUS_SHUTDOWN_MSGVER); 112 if (error) 113 return; 114 break; 115 116 case VMBUS_ICMSG_TYPE_SHUTDOWN: 117 if (dlen < VMBUS_ICMSG_SHUTDOWN_SIZE_MIN) { 118 device_printf(sc->ic_dev, "invalid shutdown len %d\n", 119 dlen); 120 return; 121 } 122 msg = data; 123 124 /* XXX ic_flags definition? */ 125 if (msg->ic_haltflags == 0 || msg->ic_haltflags == 1) { 126 device_printf(sc->ic_dev, "shutdown requested\n"); 127 hdr->ic_status = VMBUS_ICMSG_STATUS_OK; 128 do_shutdown = 1; 129 } else { 130 device_printf(sc->ic_dev, "unknown shutdown flags " 131 "0x%08x\n", msg->ic_haltflags); 132 hdr->ic_status = VMBUS_ICMSG_STATUS_FAIL; 133 } 134 break; 135 136 default: 137 device_printf(sc->ic_dev, "got 0x%08x icmsg\n", hdr->ic_type); 138 break; 139 } 140 141 /* 142 * Send response by echoing the request back. 143 */ 144 vmbus_ic_sendresp(sc, chan, data, dlen, xactid); 145 146 if (do_shutdown) 147 shutdown_nice(RB_POWEROFF); 148 } 149 150 static int 151 vmbus_shutdown_probe(device_t dev) 152 { 153 154 return (vmbus_ic_probe(dev, vmbus_shutdown_descs)); 155 } 156 157 static int 158 vmbus_shutdown_attach(device_t dev) 159 { 160 161 return (vmbus_ic_attach(dev, vmbus_shutdown_cb)); 162 } 163