sys/dev/hyperv/utilities/hv_shutdown.c

   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/reboot.h>
  35 #include <sys/systm.h>
  36
  37 #include <dev/hyperv/include/hyperv.h>
  38 #include <dev/hyperv/include/vmbus.h>
  39 #include <dev/hyperv/utilities/hv_util.h>
  40 #include <dev/hyperv/utilities/vmbus_icreg.h>
  41
  42 #include "vmbus_if.h"
  43
  44 #define VMBUS_SHUTDOWN_FWVER_MAJOR      3
  45 #define VMBUS_SHUTDOWN_FWVER            \
  46         VMBUS_IC_VERSION(VMBUS_SHUTDOWN_FWVER_MAJOR, 0)
  47
  48 #define VMBUS_SHUTDOWN_MSGVER_MAJOR     3
  49 #define VMBUS_SHUTDOWN_MSGVER           \
  50         VMBUS_IC_VERSION(VMBUS_SHUTDOWN_MSGVER_MAJOR, 0)
  51
  52 static const struct vmbus_ic_desc vmbus_shutdown_descs[] = {
  53         {
  54                 .ic_guid = { .hv_guid = {
  55                     0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49,
  56                     0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb } },
  57                 .ic_desc = "Hyper-V Shutdown"
  58         },
  59         VMBUS_IC_DESC_END
  60 };
  61
  62 static void
  63 vmbus_shutdown_cb(struct vmbus_channel *chan, void *xsc)
  64 {
  65         struct hv_util_sc *sc = xsc;
  66         struct vmbus_icmsg_hdr *hdr;
  67         struct vmbus_icmsg_shutdown *msg;
  68         int dlen, error, do_shutdown = 0;
  69         uint64_t xactid;
  70         void *data;
  71
  72         /*
  73          * Receive request.
  74          */
  75         data = sc->receive_buffer;
  76         dlen = sc->ic_buflen;
  77         error = vmbus_chan_recv(chan, data, &dlen, &xactid);
  78         KASSERT(error != ENOBUFS, ("icbuf is not large enough"));
  79         if (error)
  80                 return;
  81
  82         if (dlen < sizeof(*hdr)) {
  83                 device_printf(sc->ic_dev, "invalid data len %d\n", dlen);
  84                 return;
  85         }
  86         hdr = data;
  87
  88         /*
  89          * Update request, which will be echoed back as response.
  90          */
  91         switch (hdr->ic_type) {
  92         case VMBUS_ICMSG_TYPE_NEGOTIATE:
  93                 error = vmbus_ic_negomsg(sc, data, &dlen,
  94                     VMBUS_SHUTDOWN_FWVER, VMBUS_SHUTDOWN_MSGVER);
  95                 if (error)
  96                         return;
  97                 break;
  98
  99         case VMBUS_ICMSG_TYPE_SHUTDOWN:
 100                 if (dlen < VMBUS_ICMSG_SHUTDOWN_SIZE_MIN) {
 101                         device_printf(sc->ic_dev, "invalid shutdown len %d\n",
 102                             dlen);
 103                         return;
 104                 }
 105                 msg = data;
 106
 107                 /* XXX ic_flags definition? */
 108                 if (msg->ic_haltflags == 0 || msg->ic_haltflags == 1) {
 109                         device_printf(sc->ic_dev, "shutdown requested\n");
 110                         hdr->ic_status = VMBUS_ICMSG_STATUS_OK;
 111                         do_shutdown = 1;
 112                 } else {
 113                         device_printf(sc->ic_dev, "unknown shutdown flags "
 114                             "0x%08x\n", msg->ic_haltflags);
 115                         hdr->ic_status = VMBUS_ICMSG_STATUS_FAIL;
 116                 }
 117                 break;
 118
 119         default:
 120                 device_printf(sc->ic_dev, "got 0x%08x icmsg\n", hdr->ic_type);
 121                 break;
 122         }
 123
 124         /*
 125          * Send response by echoing the updated request back.
 126          */
 127         hdr->ic_flags = VMBUS_ICMSG_FLAG_XACT | VMBUS_ICMSG_FLAG_RESP;
 128         error = vmbus_chan_send(chan, VMBUS_CHANPKT_TYPE_INBAND, 0,
 129             data, dlen, xactid);
 130         if (error)
 131                 device_printf(sc->ic_dev, "resp send failed: %d\n", error);
 132
 133         if (do_shutdown)
 134                 shutdown_nice(RB_POWEROFF);
 135 }
 136
 137 static int
 138 hv_shutdown_probe(device_t dev)
 139 {
 140
 141         return (vmbus_ic_probe(dev, vmbus_shutdown_descs));
 142 }
 143
 144 static int
 145 hv_shutdown_attach(device_t dev)
 146 {
 147
 148         return (hv_util_attach(dev, vmbus_shutdown_cb));
 149 }
 150
 151 static device_method_t shutdown_methods[] = {
 152         /* Device interface */
 153         DEVMETHOD(device_probe, hv_shutdown_probe),
 154         DEVMETHOD(device_attach, hv_shutdown_attach),
 155         DEVMETHOD(device_detach, hv_util_detach),
 156         { 0, 0 }
 157 };
 158
 159 static driver_t shutdown_driver = { "hvshutdown", shutdown_methods, sizeof(hv_util_sc)};
 160
 161 static devclass_t shutdown_devclass;
 162
 163 DRIVER_MODULE(hv_shutdown, vmbus, shutdown_driver, shutdown_devclass, NULL, NULL);
 164 MODULE_VERSION(hv_shutdown, 1);
 165 MODULE_DEPEND(hv_shutdown, vmbus, 1, 1, 1);