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