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