[linux-2.6-block.git] / drivers / hv / hv_util.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2010, Microsoft Corporation.
 *
 * Authors:
 *   Haiyang Zhang <haiyangz@microsoft.com>
 *   Hank Janssen  <hjanssen@microsoft.com>
 */
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/sysctl.h>
#include <linux/reboot.h>
#include <linux/hyperv.h>
#include <linux/clockchips.h>
#include <linux/ptp_clock_kernel.h>
#include <clocksource/hyperv_timer.h>
#include <asm/mshyperv.h>

#include "hyperv_vmbus.h"

#define SD_MAJOR	3
#define SD_MINOR	0
#define SD_VERSION	(SD_MAJOR << 16 | SD_MINOR)

#define SD_MAJOR_1	1
#define SD_VERSION_1	(SD_MAJOR_1 << 16 | SD_MINOR)

#define TS_MAJOR	4
#define TS_MINOR	0
#define TS_VERSION	(TS_MAJOR << 16 | TS_MINOR)

#define TS_MAJOR_1	1
#define TS_VERSION_1	(TS_MAJOR_1 << 16 | TS_MINOR)

#define TS_MAJOR_3	3
#define TS_VERSION_3	(TS_MAJOR_3 << 16 | TS_MINOR)

#define HB_MAJOR	3
#define HB_MINOR	0
#define HB_VERSION	(HB_MAJOR << 16 | HB_MINOR)

#define HB_MAJOR_1	1
#define HB_VERSION_1	(HB_MAJOR_1 << 16 | HB_MINOR)

static int sd_srv_version;
static int ts_srv_version;
static int hb_srv_version;

#define SD_VER_COUNT 2
static const int sd_versions[] = {
	SD_VERSION,
	SD_VERSION_1
};

#define TS_VER_COUNT 3
static const int ts_versions[] = {
	TS_VERSION,
	TS_VERSION_3,
	TS_VERSION_1
};

#define HB_VER_COUNT 2
static const int hb_versions[] = {
	HB_VERSION,
	HB_VERSION_1
};

#define FW_VER_COUNT 2
static const int fw_versions[] = {
	UTIL_FW_VERSION,
	UTIL_WS2K8_FW_VERSION
};

static void shutdown_onchannelcallback(void *context);
static struct hv_util_service util_shutdown = {
	.util_cb = shutdown_onchannelcallback,
};

static int hv_timesync_init(struct hv_util_service *srv);
static void hv_timesync_deinit(void);

static void timesync_onchannelcallback(void *context);
static struct hv_util_service util_timesynch = {
	.util_cb = timesync_onchannelcallback,
	.util_init = hv_timesync_init,
	.util_deinit = hv_timesync_deinit,
};

static void heartbeat_onchannelcallback(void *context);
static struct hv_util_service util_heartbeat = {
	.util_cb = heartbeat_onchannelcallback,
};

static struct hv_util_service util_kvp = {
	.util_cb = hv_kvp_onchannelcallback,
	.util_init = hv_kvp_init,
	.util_deinit = hv_kvp_deinit,
};

static struct hv_util_service util_vss = {
	.util_cb = hv_vss_onchannelcallback,
	.util_init = hv_vss_init,
	.util_deinit = hv_vss_deinit,
};

static struct hv_util_service util_fcopy = {
	.util_cb = hv_fcopy_onchannelcallback,
	.util_init = hv_fcopy_init,
	.util_deinit = hv_fcopy_deinit,
};

static void perform_shutdown(struct work_struct *dummy)
{
	orderly_poweroff(true);
}

/*
 * Perform the shutdown operation in a thread context.
 */
static DECLARE_WORK(shutdown_work, perform_shutdown);

static void shutdown_onchannelcallback(void *context)
{
	struct vmbus_channel *channel = context;
	u32 recvlen;
	u64 requestid;
	bool execute_shutdown = false;
	u8  *shut_txf_buf = util_shutdown.recv_buffer;

	struct shutdown_msg_data *shutdown_msg;

	struct icmsg_hdr *icmsghdrp;

	vmbus_recvpacket(channel, shut_txf_buf,
			 PAGE_SIZE, &recvlen, &requestid);

	if (recvlen > 0) {
		icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[
			sizeof(struct vmbuspipe_hdr)];

		if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
			if (vmbus_prep_negotiate_resp(icmsghdrp, shut_txf_buf,
					fw_versions, FW_VER_COUNT,
					sd_versions, SD_VER_COUNT,
					NULL, &sd_srv_version)) {
				pr_info("Shutdown IC version %d.%d\n",
					sd_srv_version >> 16,
					sd_srv_version & 0xFFFF);
			}
		} else {
			shutdown_msg =
				(struct shutdown_msg_data *)&shut_txf_buf[
					sizeof(struct vmbuspipe_hdr) +
					sizeof(struct icmsg_hdr)];

			switch (shutdown_msg->flags) {
			case 0:
			case 1:
				icmsghdrp->status = HV_S_OK;
				execute_shutdown = true;

				pr_info("Shutdown request received -"
					    " graceful shutdown initiated\n");
				break;
			default:
				icmsghdrp->status = HV_E_FAIL;
				execute_shutdown = false;

				pr_info("Shutdown request received -"
					    " Invalid request\n");
				break;
			}
		}

		icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
			| ICMSGHDRFLAG_RESPONSE;

		vmbus_sendpacket(channel, shut_txf_buf,
				       recvlen, requestid,
				       VM_PKT_DATA_INBAND, 0);
	}

	if (execute_shutdown == true)
		schedule_work(&shutdown_work);
}

/*
 * Set the host time in a process context.
 */
static struct work_struct adj_time_work;

/*
 * The last time sample, received from the host. PTP device responds to
 * requests by using this data and the current partition-wide time reference
 * count.
 */
static struct {
	u64				host_time;
	u64				ref_time;
	spinlock_t			lock;
} host_ts;

static struct timespec64 hv_get_adj_host_time(void)
{
	struct timespec64 ts;
	u64 newtime, reftime;
	unsigned long flags;

	spin_lock_irqsave(&host_ts.lock, flags);
	reftime = hyperv_cs->read(hyperv_cs);
	newtime = host_ts.host_time + (reftime - host_ts.ref_time);
	ts = ns_to_timespec64((newtime - WLTIMEDELTA) * 100);
	spin_unlock_irqrestore(&host_ts.lock, flags);

	return ts;
}

static void hv_set_host_time(struct work_struct *work)
{
	struct timespec64 ts = hv_get_adj_host_time();

	do_settimeofday64(&ts);
}

/*
 * Synchronize time with host after reboot, restore, etc.
 *
 * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
 * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
 * message after the timesync channel is opened. Since the hv_utils module is
 * loaded after hv_vmbus, the first message is usually missed. This bit is
 * considered a hard request to discipline the clock.
 *
 * ICTIMESYNCFLAG_SAMPLE bit indicates a time sample from host. This is
 * typically used as a hint to the guest. The guest is under no obligation
 * to discipline the clock.
 */
static inline void adj_guesttime(u64 hosttime, u64 reftime, u8 adj_flags)
{
	unsigned long flags;
	u64 cur_reftime;

	/*
	 * Save the adjusted time sample from the host and the snapshot
	 * of the current system time.
	 */
	spin_lock_irqsave(&host_ts.lock, flags);

	cur_reftime = hyperv_cs->read(hyperv_cs);
	host_ts.host_time = hosttime;
	host_ts.ref_time = cur_reftime;

	/*
	 * TimeSync v4 messages contain reference time (guest's Hyper-V
	 * clocksource read when the time sample was generated), we can
	 * improve the precision by adding the delta between now and the
	 * time of generation. For older protocols we set
	 * reftime == cur_reftime on call.
	 */
	host_ts.host_time += (cur_reftime - reftime);

	spin_unlock_irqrestore(&host_ts.lock, flags);

	/* Schedule work to do do_settimeofday64() */
	if (adj_flags & ICTIMESYNCFLAG_SYNC)
		schedule_work(&adj_time_work);
}

/*
 * Time Sync Channel message handler.
 */
static void timesync_onchannelcallback(void *context)
{
	struct vmbus_channel *channel = context;
	u32 recvlen;
	u64 requestid;
	struct icmsg_hdr *icmsghdrp;
	struct ictimesync_data *timedatap;
	struct ictimesync_ref_data *refdata;
	u8 *time_txf_buf = util_timesynch.recv_buffer;

	vmbus_recvpacket(channel, time_txf_buf,
			 PAGE_SIZE, &recvlen, &requestid);

	if (recvlen > 0) {
		icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[
				sizeof(struct vmbuspipe_hdr)];

		if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
			if (vmbus_prep_negotiate_resp(icmsghdrp, time_txf_buf,
						fw_versions, FW_VER_COUNT,
						ts_versions, TS_VER_COUNT,
						NULL, &ts_srv_version)) {
				pr_info("TimeSync IC version %d.%d\n",
					ts_srv_version >> 16,
					ts_srv_version & 0xFFFF);
			}
		} else {
			if (ts_srv_version > TS_VERSION_3) {
				refdata = (struct ictimesync_ref_data *)
					&time_txf_buf[
					sizeof(struct vmbuspipe_hdr) +
					sizeof(struct icmsg_hdr)];

				adj_guesttime(refdata->parenttime,
						refdata->vmreferencetime,
						refdata->flags);
			} else {
				timedatap = (struct ictimesync_data *)
					&time_txf_buf[
					sizeof(struct vmbuspipe_hdr) +
					sizeof(struct icmsg_hdr)];
				adj_guesttime(timedatap->parenttime,
					      hyperv_cs->read(hyperv_cs),
					      timedatap->flags);
			}
		}

		icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
			| ICMSGHDRFLAG_RESPONSE;

		vmbus_sendpacket(channel, time_txf_buf,
				recvlen, requestid,
				VM_PKT_DATA_INBAND, 0);
	}
}

/*
 * Heartbeat functionality.
 * Every two seconds, Hyper-V send us a heartbeat request message.
 * we respond to this message, and Hyper-V knows we are alive.
 */
static void heartbeat_onchannelcallback(void *context)
{
	struct vmbus_channel *channel = context;
	u32 recvlen;
	u64 requestid;
	struct icmsg_hdr *icmsghdrp;
	struct heartbeat_msg_data *heartbeat_msg;
	u8 *hbeat_txf_buf = util_heartbeat.recv_buffer;

	while (1) {

		vmbus_recvpacket(channel, hbeat_txf_buf,
				 PAGE_SIZE, &recvlen, &requestid);

		if (!recvlen)
			break;

		icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[
				sizeof(struct vmbuspipe_hdr)];

		if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
			if (vmbus_prep_negotiate_resp(icmsghdrp,
					hbeat_txf_buf,
					fw_versions, FW_VER_COUNT,
					hb_versions, HB_VER_COUNT,
					NULL, &hb_srv_version)) {

				pr_info("Heartbeat IC version %d.%d\n",
					hb_srv_version >> 16,
					hb_srv_version & 0xFFFF);
			}
		} else {
			heartbeat_msg =
				(struct heartbeat_msg_data *)&hbeat_txf_buf[
					sizeof(struct vmbuspipe_hdr) +
					sizeof(struct icmsg_hdr)];

			heartbeat_msg->seq_num += 1;
		}

		icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
			| ICMSGHDRFLAG_RESPONSE;

		vmbus_sendpacket(channel, hbeat_txf_buf,
				       recvlen, requestid,
				       VM_PKT_DATA_INBAND, 0);
	}
}

static int util_probe(struct hv_device *dev,
			const struct hv_vmbus_device_id *dev_id)
{
	struct hv_util_service *srv =
		(struct hv_util_service *)dev_id->driver_data;
	int ret;

	srv->recv_buffer = kmalloc(PAGE_SIZE * 4, GFP_KERNEL);
	if (!srv->recv_buffer)
		return -ENOMEM;
	srv->channel = dev->channel;
	if (srv->util_init) {
		ret = srv->util_init(srv);
		if (ret) {
			ret = -ENODEV;
			goto error1;
		}
	}

	/*
	 * The set of services managed by the util driver are not performance
	 * critical and do not need batched reading. Furthermore, some services
	 * such as KVP can only handle one message from the host at a time.
	 * Turn off batched reading for all util drivers before we open the
	 * channel.
	 */
	set_channel_read_mode(dev->channel, HV_CALL_DIRECT);

	hv_set_drvdata(dev, srv);

	ret = vmbus_open(dev->channel, 4 * PAGE_SIZE, 4 * PAGE_SIZE, NULL, 0,
			srv->util_cb, dev->channel);
	if (ret)
		goto error;

	return 0;

error:
	if (srv->util_deinit)
		srv->util_deinit();
error1:
	kfree(srv->recv_buffer);
	return ret;
}

static int util_remove(struct hv_device *dev)
{
	struct hv_util_service *srv = hv_get_drvdata(dev);

	if (srv->util_deinit)
		srv->util_deinit();
	vmbus_close(dev->channel);
	kfree(srv->recv_buffer);

	return 0;
}

static const struct hv_vmbus_device_id id_table[] = {
	/* Shutdown guid */
	{ HV_SHUTDOWN_GUID,
	  .driver_data = (unsigned long)&util_shutdown
	},
	/* Time synch guid */
	{ HV_TS_GUID,
	  .driver_data = (unsigned long)&util_timesynch
	},
	/* Heartbeat guid */
	{ HV_HEART_BEAT_GUID,
	  .driver_data = (unsigned long)&util_heartbeat
	},
	/* KVP guid */
	{ HV_KVP_GUID,
	  .driver_data = (unsigned long)&util_kvp
	},
	/* VSS GUID */
	{ HV_VSS_GUID,
	  .driver_data = (unsigned long)&util_vss
	},
	/* File copy GUID */
	{ HV_FCOPY_GUID,
	  .driver_data = (unsigned long)&util_fcopy
	},
	{ },
};

MODULE_DEVICE_TABLE(vmbus, id_table);

/* The one and only one */
static  struct hv_driver util_drv = {
	.name = "hv_utils",
	.id_table = id_table,
	.probe =  util_probe,
	.remove =  util_remove,
	.driver = {
		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
	},
};

static int hv_ptp_enable(struct ptp_clock_info *info,
			 struct ptp_clock_request *request, int on)
{
	return -EOPNOTSUPP;
}

static int hv_ptp_settime(struct ptp_clock_info *p, const struct timespec64 *ts)
{
	return -EOPNOTSUPP;
}

static int hv_ptp_adjfreq(struct ptp_clock_info *ptp, s32 delta)
{
	return -EOPNOTSUPP;
}
static int hv_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
{
	return -EOPNOTSUPP;
}

static int hv_ptp_gettime(struct ptp_clock_info *info, struct timespec64 *ts)
{
	*ts = hv_get_adj_host_time();

	return 0;
}

static struct ptp_clock_info ptp_hyperv_info = {
	.name		= "hyperv",
	.enable         = hv_ptp_enable,
	.adjtime        = hv_ptp_adjtime,
	.adjfreq        = hv_ptp_adjfreq,
	.gettime64      = hv_ptp_gettime,
	.settime64      = hv_ptp_settime,
	.owner		= THIS_MODULE,
};

static struct ptp_clock *hv_ptp_clock;

static int hv_timesync_init(struct hv_util_service *srv)
{
	/* TimeSync requires Hyper-V clocksource. */
	if (!hyperv_cs)
		return -ENODEV;

	spin_lock_init(&host_ts.lock);

	INIT_WORK(&adj_time_work, hv_set_host_time);

	/*
	 * ptp_clock_register() returns NULL when CONFIG_PTP_1588_CLOCK is
	 * disabled but the driver is still useful without the PTP device
	 * as it still handles the ICTIMESYNCFLAG_SYNC case.
	 */
	hv_ptp_clock = ptp_clock_register(&ptp_hyperv_info, NULL);
	if (IS_ERR_OR_NULL(hv_ptp_clock)) {
		pr_err("cannot register PTP clock: %ld\n",
		       PTR_ERR(hv_ptp_clock));
		hv_ptp_clock = NULL;
	}

	return 0;
}

static void hv_timesync_deinit(void)
{
	if (hv_ptp_clock)
		ptp_clock_unregister(hv_ptp_clock);
	cancel_work_sync(&adj_time_work);
}

static int __init init_hyperv_utils(void)
{
	pr_info("Registering HyperV Utility Driver\n");

	return vmbus_driver_register(&util_drv);
}

static void exit_hyperv_utils(void)
{
	pr_info("De-Registered HyperV Utility Driver\n");

	vmbus_driver_unregister(&util_drv);
}

module_init(init_hyperv_utils);
module_exit(exit_hyperv_utils);

MODULE_DESCRIPTION("Hyper-V Utilities");
MODULE_LICENSE("GPL");
Commit	Line	Data
3b20eb23	1	// SPDX-License-Identifier: GPL-2.0-only
c88c4e4c HJ	2	/*
	3	* Copyright (c) 2010, Microsoft Corporation.
	4	*
c88c4e4c HJ	5	* Authors:
	6	* Haiyang Zhang <haiyangz@microsoft.com>
	7	* Hank Janssen <hjanssen@microsoft.com>
	8	*/
af7a5b6e HJ	9	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
af7a5b6e HJ	10
c88c4e4c HJ	11	#include <linux/kernel.h>
	12	#include <linux/init.h>
	13	#include <linux/module.h>
	14	#include <linux/slab.h>
	15	#include <linux/sysctl.h>
9e629075	16	#include <linux/reboot.h>
46a97191	17	#include <linux/hyperv.h>
3716a49a VK	18	#include <linux/clockchips.h>
3716a49a VK	19	#include <linux/ptp_clock_kernel.h>
dd2cb348	20	#include <clocksource/hyperv_timer.h>
305f7549	21	#include <asm/mshyperv.h>
c88c4e4c	22
01325476	23	#include "hyperv_vmbus.h"
6741335b	24
3a491605 S	25	#define SD_MAJOR 3
	26	#define SD_MINOR 0
	27	#define SD_VERSION (SD_MAJOR << 16 \| SD_MINOR)
6741335b	28
abeda47e AN	29	#define SD_MAJOR_1 1
abeda47e AN	30	#define SD_VERSION_1 (SD_MAJOR_1 << 16 \| SD_MINOR)
3a491605	31
8e1d2607	32	#define TS_MAJOR 4
3a491605 S	33	#define TS_MINOR 0
	34	#define TS_VERSION (TS_MAJOR << 16 \| TS_MINOR)
	35
abeda47e AN	36	#define TS_MAJOR_1 1
abeda47e AN	37	#define TS_VERSION_1 (TS_MAJOR_1 << 16 \| TS_MINOR)
3a491605	38
8e1d2607 AN	39	#define TS_MAJOR_3 3
	40	#define TS_VERSION_3 (TS_MAJOR_3 << 16 \| TS_MINOR)
	41
3a491605	42	#define HB_MAJOR 3
abeda47e	43	#define HB_MINOR 0
3a491605 S	44	#define HB_VERSION (HB_MAJOR << 16 \| HB_MINOR)
3a491605 S	45
abeda47e AN	46	#define HB_MAJOR_1 1
abeda47e AN	47	#define HB_VERSION_1 (HB_MAJOR_1 << 16 \| HB_MINOR)
3a491605 S	48
	49	static int sd_srv_version;
	50	static int ts_srv_version;
	51	static int hb_srv_version;
a1656454 AN	52
	53	#define SD_VER_COUNT 2
	54	static const int sd_versions[] = {
	55	SD_VERSION,
	56	SD_VERSION_1
	57	};
	58
	59	#define TS_VER_COUNT 3
	60	static const int ts_versions[] = {
	61	TS_VERSION,
	62	TS_VERSION_3,
	63	TS_VERSION_1
	64	};
	65
	66	#define HB_VER_COUNT 2
	67	static const int hb_versions[] = {
	68	HB_VERSION,
	69	HB_VERSION_1
	70	};
	71
	72	#define FW_VER_COUNT 2
	73	static const int fw_versions[] = {
	74	UTIL_FW_VERSION,
	75	UTIL_WS2K8_FW_VERSION
	76	};
6741335b	77
a29b643c S	78	static void shutdown_onchannelcallback(void *context);
	79	static struct hv_util_service util_shutdown = {
	80	.util_cb = shutdown_onchannelcallback,
	81	};
	82
3ba1eb17 V	83	static int hv_timesync_init(struct hv_util_service *srv);
	84	static void hv_timesync_deinit(void);
	85
a29b643c S	86	static void timesync_onchannelcallback(void *context);
	87	static struct hv_util_service util_timesynch = {
	88	.util_cb = timesync_onchannelcallback,
3ba1eb17 V	89	.util_init = hv_timesync_init,
3ba1eb17 V	90	.util_deinit = hv_timesync_deinit,
a29b643c S	91	};
	92
	93	static void heartbeat_onchannelcallback(void *context);
	94	static struct hv_util_service util_heartbeat = {
	95	.util_cb = heartbeat_onchannelcallback,
	96	};
	97
	98	static struct hv_util_service util_kvp = {
	99	.util_cb = hv_kvp_onchannelcallback,
	100	.util_init = hv_kvp_init,
	101	.util_deinit = hv_kvp_deinit,
	102	};
c88c4e4c	103
96dd86fa S	104	static struct hv_util_service util_vss = {
	105	.util_cb = hv_vss_onchannelcallback,
	106	.util_init = hv_vss_init,
	107	.util_deinit = hv_vss_deinit,
	108	};
	109
01325476 S	110	static struct hv_util_service util_fcopy = {
	111	.util_cb = hv_fcopy_onchannelcallback,
	112	.util_init = hv_fcopy_init,
	113	.util_deinit = hv_fcopy_deinit,
	114	};
	115
3dd6cb49 S	116	static void perform_shutdown(struct work_struct *dummy)
	117	{
	118	orderly_poweroff(true);
	119	}
	120
	121	/*
	122	* Perform the shutdown operation in a thread context.
	123	*/
	124	static DECLARE_WORK(shutdown_work, perform_shutdown);
	125
6610944a	126	static void shutdown_onchannelcallback(void *context)
c88c4e4c HJ	127	{
c88c4e4c HJ	128	struct vmbus_channel *channel = context;
45241e50	129	u32 recvlen;
c88c4e4c	130	u64 requestid;
31734634	131	bool execute_shutdown = false;
a29b643c	132	u8 *shut_txf_buf = util_shutdown.recv_buffer;
c88c4e4c HJ	133
	134	struct shutdown_msg_data *shutdown_msg;
	135
	136	struct icmsg_hdr *icmsghdrp;
c88c4e4c	137
45241e50 HJ	138	vmbus_recvpacket(channel, shut_txf_buf,
45241e50 HJ	139	PAGE_SIZE, &recvlen, &requestid);
c88c4e4c HJ	140
c88c4e4c HJ	141	if (recvlen > 0) {
45241e50	142	icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[
c88c4e4c HJ	143	sizeof(struct vmbuspipe_hdr)];
	144
	145	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
a1656454 AN	146	if (vmbus_prep_negotiate_resp(icmsghdrp, shut_txf_buf,
	147	fw_versions, FW_VER_COUNT,
	148	sd_versions, SD_VER_COUNT,
	149	NULL, &sd_srv_version)) {
	150	pr_info("Shutdown IC version %d.%d\n",
	151	sd_srv_version >> 16,
	152	sd_srv_version & 0xFFFF);
	153	}
c88c4e4c	154	} else {
45241e50 HJ	155	shutdown_msg =
	156	(struct shutdown_msg_data *)&shut_txf_buf[
	157	sizeof(struct vmbuspipe_hdr) +
	158	sizeof(struct icmsg_hdr)];
c88c4e4c HJ	159
	160	switch (shutdown_msg->flags) {
	161	case 0:
	162	case 1:
	163	icmsghdrp->status = HV_S_OK;
	164	execute_shutdown = true;
	165
af7a5b6e	166	pr_info("Shutdown request received -"
32235b07	167	" graceful shutdown initiated\n");
c88c4e4c HJ	168	break;
	169	default:
	170	icmsghdrp->status = HV_E_FAIL;
	171	execute_shutdown = false;
	172
af7a5b6e HJ	173	pr_info("Shutdown request received -"
af7a5b6e HJ	174	" Invalid request\n");
c88c4e4c	175	break;
95cd17c9	176	}
c88c4e4c HJ	177	}
	178
	179	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	180	\| ICMSGHDRFLAG_RESPONSE;
	181
45241e50	182	vmbus_sendpacket(channel, shut_txf_buf,
c88c4e4c	183	recvlen, requestid,
415f2287	184	VM_PKT_DATA_INBAND, 0);
c88c4e4c HJ	185	}
c88c4e4c HJ	186
c88c4e4c	187	if (execute_shutdown == true)
3dd6cb49	188	schedule_work(&shutdown_work);
c88c4e4c HJ	189	}
c88c4e4c HJ	190
95ff7cde S	191	/*
	192	* Set the host time in a process context.
	193	*/
1d10602d	194	static struct work_struct adj_time_work;
95ff7cde	195
1d10602d VK	196	/*
	197	* The last time sample, received from the host. PTP device responds to
	198	* requests by using this data and the current partition-wide time reference
	199	* count.
	200	*/
	201	static struct {
	202	u64 host_time;
	203	u64 ref_time;
	204	spinlock_t lock;
	205	} host_ts;
95ff7cde	206
1d10602d	207	static struct timespec64 hv_get_adj_host_time(void)
95ff7cde	208	{
1d10602d VK	209	struct timespec64 ts;
	210	u64 newtime, reftime;
	211	unsigned long flags;
8e1d2607	212
1d10602d	213	spin_lock_irqsave(&host_ts.lock, flags);
3716a49a	214	reftime = hyperv_cs->read(hyperv_cs);
1d10602d VK	215	newtime = host_ts.host_time + (reftime - host_ts.ref_time);
	216	ts = ns_to_timespec64((newtime - WLTIMEDELTA) * 100);
	217	spin_unlock_irqrestore(&host_ts.lock, flags);
8e1d2607	218
1d10602d VK	219	return ts;
	220	}
	221
	222	static void hv_set_host_time(struct work_struct *work)
	223	{
	224	struct timespec64 ts = hv_get_adj_host_time();
	225
	226	do_settimeofday64(&ts);
95ff7cde S	227	}
95ff7cde S	228
e9ec3603 HZ	229	/*
	230	* Synchronize time with host after reboot, restore, etc.
	231	*
	232	* ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
	233	* After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
	234	* message after the timesync channel is opened. Since the hv_utils module is
2e338f7e AN	235	* loaded after hv_vmbus, the first message is usually missed. This bit is
	236	* considered a hard request to discipline the clock.
	237	*
	238	* ICTIMESYNCFLAG_SAMPLE bit indicates a time sample from host. This is
	239	* typically used as a hint to the guest. The guest is under no obligation
	240	* to discipline the clock.
e9ec3603	241	*/
3716a49a	242	static inline void adj_guesttime(u64 hosttime, u64 reftime, u8 adj_flags)
e9ec3603	243	{
3716a49a VK	244	unsigned long flags;
3716a49a VK	245	u64 cur_reftime;
e9ec3603	246
3ba1eb17	247	/*
1d10602d VK	248	* Save the adjusted time sample from the host and the snapshot
1d10602d VK	249	* of the current system time.
3ba1eb17	250	*/
1d10602d VK	251	spin_lock_irqsave(&host_ts.lock, flags);
	252
	253	cur_reftime = hyperv_cs->read(hyperv_cs);
	254	host_ts.host_time = hosttime;
	255	host_ts.ref_time = cur_reftime;
	256
	257	/*
	258	* TimeSync v4 messages contain reference time (guest's Hyper-V
	259	* clocksource read when the time sample was generated), we can
	260	* improve the precision by adding the delta between now and the
	261	* time of generation. For older protocols we set
	262	* reftime == cur_reftime on call.
	263	*/
	264	host_ts.host_time += (cur_reftime - reftime);
	265
	266	spin_unlock_irqrestore(&host_ts.lock, flags);
	267
	268	/* Schedule work to do do_settimeofday64() */
	269	if (adj_flags & ICTIMESYNCFLAG_SYNC)
	270	schedule_work(&adj_time_work);
39c4e9c3 HZ	271	}
	272
	273	/*
	274	* Time Sync Channel message handler.
	275	*/
	276	static void timesync_onchannelcallback(void *context)
	277	{
	278	struct vmbus_channel *channel = context;
45241e50	279	u32 recvlen;
39c4e9c3 HZ	280	u64 requestid;
	281	struct icmsg_hdr *icmsghdrp;
	282	struct ictimesync_data *timedatap;
8e1d2607	283	struct ictimesync_ref_data *refdata;
a29b643c	284	u8 *time_txf_buf = util_timesynch.recv_buffer;
39c4e9c3	285
45241e50 HJ	286	vmbus_recvpacket(channel, time_txf_buf,
45241e50 HJ	287	PAGE_SIZE, &recvlen, &requestid);
39c4e9c3 HZ	288
39c4e9c3 HZ	289	if (recvlen > 0) {
45241e50	290	icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[
39c4e9c3 HZ	291	sizeof(struct vmbuspipe_hdr)];
	292
	293	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
a1656454 AN	294	if (vmbus_prep_negotiate_resp(icmsghdrp, time_txf_buf,
	295	fw_versions, FW_VER_COUNT,
	296	ts_versions, TS_VER_COUNT,
	297	NULL, &ts_srv_version)) {
1274a690	298	pr_info("TimeSync IC version %d.%d\n",
a1656454 AN	299	ts_srv_version >> 16,
	300	ts_srv_version & 0xFFFF);
	301	}
39c4e9c3	302	} else {
8e1d2607 AN	303	if (ts_srv_version > TS_VERSION_3) {
	304	refdata = (struct ictimesync_ref_data *)
	305	&time_txf_buf[
	306	sizeof(struct vmbuspipe_hdr) +
	307	sizeof(struct icmsg_hdr)];
	308
	309	adj_guesttime(refdata->parenttime,
	310	refdata->vmreferencetime,
	311	refdata->flags);
	312	} else {
	313	timedatap = (struct ictimesync_data *)
	314	&time_txf_buf[
	315	sizeof(struct vmbuspipe_hdr) +
	316	sizeof(struct icmsg_hdr)];
	317	adj_guesttime(timedatap->parenttime,
1d10602d VK	318	hyperv_cs->read(hyperv_cs),
1d10602d VK	319	timedatap->flags);
8e1d2607	320	}
39c4e9c3 HZ	321	}
	322
	323	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	324	\| ICMSGHDRFLAG_RESPONSE;
	325
45241e50	326	vmbus_sendpacket(channel, time_txf_buf,
39c4e9c3	327	recvlen, requestid,
415f2287	328	VM_PKT_DATA_INBAND, 0);
39c4e9c3	329	}
39c4e9c3 HZ	330	}
39c4e9c3 HZ	331
9153f7b9 HJ	332	/*
	333	* Heartbeat functionality.
	334	* Every two seconds, Hyper-V send us a heartbeat request message.
	335	* we respond to this message, and Hyper-V knows we are alive.
	336	*/
	337	static void heartbeat_onchannelcallback(void *context)
	338	{
	339	struct vmbus_channel *channel = context;
45241e50	340	u32 recvlen;
9153f7b9 HJ	341	u64 requestid;
	342	struct icmsg_hdr *icmsghdrp;
	343	struct heartbeat_msg_data *heartbeat_msg;
a29b643c	344	u8 *hbeat_txf_buf = util_heartbeat.recv_buffer;
9153f7b9	345
407a3aee LL	346	while (1) {
	347
	348	vmbus_recvpacket(channel, hbeat_txf_buf,
	349	PAGE_SIZE, &recvlen, &requestid);
	350
	351	if (!recvlen)
	352	break;
9153f7b9	353
45241e50	354	icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[
9153f7b9 HJ	355	sizeof(struct vmbuspipe_hdr)];
	356
	357	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
a1656454 AN	358	if (vmbus_prep_negotiate_resp(icmsghdrp,
	359	hbeat_txf_buf,
	360	fw_versions, FW_VER_COUNT,
	361	hb_versions, HB_VER_COUNT,
	362	NULL, &hb_srv_version)) {
	363
1274a690	364	pr_info("Heartbeat IC version %d.%d\n",
a1656454 AN	365	hb_srv_version >> 16,
	366	hb_srv_version & 0xFFFF);
	367	}
9153f7b9	368	} else {
45241e50 HJ	369	heartbeat_msg =
	370	(struct heartbeat_msg_data *)&hbeat_txf_buf[
	371	sizeof(struct vmbuspipe_hdr) +
	372	sizeof(struct icmsg_hdr)];
9153f7b9	373
9153f7b9 HJ	374	heartbeat_msg->seq_num += 1;
	375	}
	376
	377	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	378	\| ICMSGHDRFLAG_RESPONSE;
	379
45241e50	380	vmbus_sendpacket(channel, hbeat_txf_buf,
9153f7b9	381	recvlen, requestid,
415f2287	382	VM_PKT_DATA_INBAND, 0);
9153f7b9	383	}
9153f7b9	384	}
39c4e9c3	385
84946899 S	386	static int util_probe(struct hv_device *dev,
84946899 S	387	const struct hv_vmbus_device_id *dev_id)
283f2129	388	{
a29b643c S	389	struct hv_util_service *srv =
	390	(struct hv_util_service *)dev_id->driver_data;
	391	int ret;
	392
9bd2d0df	393	srv->recv_buffer = kmalloc(PAGE_SIZE * 4, GFP_KERNEL);
a29b643c S	394	if (!srv->recv_buffer)
a29b643c S	395	return -ENOMEM;
b9830d12	396	srv->channel = dev->channel;
a29b643c S	397	if (srv->util_init) {
	398	ret = srv->util_init(srv);
	399	if (ret) {
4e65f6e8 S	400	ret = -ENODEV;
4e65f6e8 S	401	goto error1;
a29b643c S	402	}
	403	}
	404
7ae3e035 S	405	/*
	406	* The set of services managed by the util driver are not performance
	407	* critical and do not need batched reading. Furthermore, some services
	408	* such as KVP can only handle one message from the host at a time.
	409	* Turn off batched reading for all util drivers before we open the
	410	* channel.
	411	*/
b71e3282	412	set_channel_read_mode(dev->channel, HV_CALL_DIRECT);
7ae3e035	413
a29b643c	414	hv_set_drvdata(dev, srv);
18965663	415
18965663 DC	416	ret = vmbus_open(dev->channel, 4 * PAGE_SIZE, 4 * PAGE_SIZE, NULL, 0,
	417	srv->util_cb, dev->channel);
	418	if (ret)
	419	goto error;
	420
283f2129	421	return 0;
4e65f6e8 S	422
	423	error:
	424	if (srv->util_deinit)
	425	srv->util_deinit();
	426	error1:
	427	kfree(srv->recv_buffer);
	428	return ret;
283f2129 S	429	}
	430
	431	static int util_remove(struct hv_device *dev)
	432	{
a29b643c S	433	struct hv_util_service *srv = hv_get_drvdata(dev);
	434
	435	if (srv->util_deinit)
	436	srv->util_deinit();
5380b383	437	vmbus_close(dev->channel);
a29b643c S	438	kfree(srv->recv_buffer);
a29b643c S	439
283f2129 S	440	return 0;
	441	}
	442
	443	static const struct hv_vmbus_device_id id_table[] = {
c45cf2d4	444	/* Shutdown guid */
d13984e5 S	445	{ HV_SHUTDOWN_GUID,
	446	.driver_data = (unsigned long)&util_shutdown
	447	},
c45cf2d4	448	/* Time synch guid */
d13984e5 S	449	{ HV_TS_GUID,
	450	.driver_data = (unsigned long)&util_timesynch
	451	},
c45cf2d4	452	/* Heartbeat guid */
d13984e5 S	453	{ HV_HEART_BEAT_GUID,
	454	.driver_data = (unsigned long)&util_heartbeat
	455	},
c45cf2d4	456	/* KVP guid */
d13984e5 S	457	{ HV_KVP_GUID,
	458	.driver_data = (unsigned long)&util_kvp
	459	},
96dd86fa S	460	/* VSS GUID */
	461	{ HV_VSS_GUID,
	462	.driver_data = (unsigned long)&util_vss
	463	},
01325476 S	464	/* File copy GUID */
	465	{ HV_FCOPY_GUID,
	466	.driver_data = (unsigned long)&util_fcopy
	467	},
c45cf2d4	468	{ },
283f2129 S	469	};
	470
	471	MODULE_DEVICE_TABLE(vmbus, id_table);
	472
	473	/* The one and only one */
	474	static struct hv_driver util_drv = {
5c24ee89	475	.name = "hv_utils",
283f2129 S	476	.id_table = id_table,
	477	.probe = util_probe,
	478	.remove = util_remove,
af0a5646 AV	479	.driver = {
	480	.probe_type = PROBE_PREFER_ASYNCHRONOUS,
	481	},
283f2129 S	482	};
283f2129 S	483
3716a49a VK	484	static int hv_ptp_enable(struct ptp_clock_info *info,
	485	struct ptp_clock_request *request, int on)
	486	{
	487	return -EOPNOTSUPP;
	488	}
	489
	490	static int hv_ptp_settime(struct ptp_clock_info p, const struct timespec64 ts)
	491	{
	492	return -EOPNOTSUPP;
	493	}
	494
	495	static int hv_ptp_adjfreq(struct ptp_clock_info *ptp, s32 delta)
	496	{
	497	return -EOPNOTSUPP;
	498	}
	499	static int hv_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
	500	{
	501	return -EOPNOTSUPP;
	502	}
	503
	504	static int hv_ptp_gettime(struct ptp_clock_info info, struct timespec64 ts)
	505	{
1d10602d	506	*ts = hv_get_adj_host_time();
3716a49a VK	507
	508	return 0;
	509	}
	510
3716a49a VK	511	static struct ptp_clock_info ptp_hyperv_info = {
	512	.name = "hyperv",
	513	.enable = hv_ptp_enable,
	514	.adjtime = hv_ptp_adjtime,
	515	.adjfreq = hv_ptp_adjfreq,
	516	.gettime64 = hv_ptp_gettime,
3716a49a VK	517	.settime64 = hv_ptp_settime,
	518	.owner = THIS_MODULE,
	519	};
	520
	521	static struct ptp_clock *hv_ptp_clock;
	522
3ba1eb17 V	523	static int hv_timesync_init(struct hv_util_service *srv)
3ba1eb17 V	524	{
3716a49a VK	525	/* TimeSync requires Hyper-V clocksource. */
	526	if (!hyperv_cs)
	527	return -ENODEV;
	528
5a16dfc8 DC	529	spin_lock_init(&host_ts.lock);
5a16dfc8 DC	530
1d10602d	531	INIT_WORK(&adj_time_work, hv_set_host_time);
3716a49a VK	532
	533	/*
	534	* ptp_clock_register() returns NULL when CONFIG_PTP_1588_CLOCK is
	535	* disabled but the driver is still useful without the PTP device
	536	* as it still handles the ICTIMESYNCFLAG_SYNC case.
	537	*/
	538	hv_ptp_clock = ptp_clock_register(&ptp_hyperv_info, NULL);
	539	if (IS_ERR_OR_NULL(hv_ptp_clock)) {
	540	pr_err("cannot register PTP clock: %ld\n",
	541	PTR_ERR(hv_ptp_clock));
	542	hv_ptp_clock = NULL;
	543	}
	544
3ba1eb17 V	545	return 0;
	546	}
	547
	548	static void hv_timesync_deinit(void)
	549	{
3716a49a VK	550	if (hv_ptp_clock)
3716a49a VK	551	ptp_clock_unregister(hv_ptp_clock);
1d10602d	552	cancel_work_sync(&adj_time_work);
3ba1eb17 V	553	}
3ba1eb17 V	554
c88c4e4c HJ	555	static int __init init_hyperv_utils(void)
c88c4e4c HJ	556	{
af7a5b6e	557	pr_info("Registering HyperV Utility Driver\n");
c88c4e4c	558
4e65f6e8	559	return vmbus_driver_register(&util_drv);
c88c4e4c HJ	560	}
	561
	562	static void exit_hyperv_utils(void)
	563	{
af7a5b6e	564	pr_info("De-Registered HyperV Utility Driver\n");
c88c4e4c	565
768fa219	566	vmbus_driver_unregister(&util_drv);
c88c4e4c HJ	567	}
	568
	569	module_init(init_hyperv_utils);
	570	module_exit(exit_hyperv_utils);
	571
	572	MODULE_DESCRIPTION("Hyper-V Utilities");
c88c4e4c	573	MODULE_LICENSE("GPL");