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