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

/*
 * Copyright (c) 2010, Microsoft Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307 USA.
 *
 * 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 <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.
 */

struct adj_time_work {
	struct work_struct work;
	u64	host_time;
	u64	ref_time;
	u8	flags;
};

static void hv_set_host_time(struct work_struct *work)
{
	struct adj_time_work	*wrk;
	s64 host_tns;
	u64 newtime;
	struct timespec64 host_ts;

	wrk = container_of(work, struct adj_time_work, work);

	newtime = wrk->host_time;
	if (ts_srv_version > TS_VERSION_3) {
		/*
		 * Some latency has been introduced since Hyper-V generated
		 * its time sample. Take that latency into account before
		 * using TSC reference time sample from Hyper-V.
		 *
		 * This sample is given by TimeSync v4 and above hosts.
		 */
		u64 current_tick;

		hv_get_current_tick(current_tick);
		newtime += (current_tick - wrk->ref_time);
	}
	host_tns = (newtime - WLTIMEDELTA) * 100;
	host_ts = ns_to_timespec64(host_tns);

	do_settimeofday64(&host_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 struct adj_time_work  wrk;
static inline void adj_guesttime(u64 hosttime, u64 reftime, u8 flags)
{

	/*
	 * This check is safe since we are executing in the
	 * interrupt context and time synch messages arre always
	 * delivered on the same CPU.
	 */
	if (work_pending(&wrk.work))
		return;

	wrk.host_time = hosttime;
	wrk.ref_time = reftime;
	wrk.flags = flags;
	if ((flags & (ICTIMESYNCFLAG_SYNC | ICTIMESYNCFLAG_SAMPLE)) != 0) {
		schedule_work(&wrk.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,
						0,
						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_state(dev->channel, false);

	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_util",
	.id_table = id_table,
	.probe =  util_probe,
	.remove =  util_remove,
};

static int hv_timesync_init(struct hv_util_service *srv)
{
	INIT_WORK(&wrk.work, hv_set_host_time);
	return 0;
}

static void hv_timesync_deinit(void)
{
	cancel_work_sync(&wrk.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
c88c4e4c HJ	1	/*
	2	* Copyright (c) 2010, Microsoft Corporation.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms and conditions of the GNU General Public License,
	6	* version 2, as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
	15	* Place - Suite 330, Boston, MA 02111-1307 USA.
	16	*
	17	* Authors:
	18	* Haiyang Zhang <haiyangz@microsoft.com>
	19	* Hank Janssen <hjanssen@microsoft.com>
	20	*/
af7a5b6e HJ	21	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
af7a5b6e HJ	22
c88c4e4c HJ	23	#include <linux/kernel.h>
	24	#include <linux/init.h>
	25	#include <linux/module.h>
	26	#include <linux/slab.h>
	27	#include <linux/sysctl.h>
9e629075	28	#include <linux/reboot.h>
46a97191	29	#include <linux/hyperv.h>
305f7549	30	#include <asm/mshyperv.h>
c88c4e4c	31
01325476	32	#include "hyperv_vmbus.h"
6741335b	33
3a491605 S	34	#define SD_MAJOR 3
	35	#define SD_MINOR 0
	36	#define SD_VERSION (SD_MAJOR << 16 \| SD_MINOR)
6741335b	37
abeda47e AN	38	#define SD_MAJOR_1 1
abeda47e AN	39	#define SD_VERSION_1 (SD_MAJOR_1 << 16 \| SD_MINOR)
3a491605	40
8e1d2607	41	#define TS_MAJOR 4
3a491605 S	42	#define TS_MINOR 0
	43	#define TS_VERSION (TS_MAJOR << 16 \| TS_MINOR)
	44
abeda47e AN	45	#define TS_MAJOR_1 1
abeda47e AN	46	#define TS_VERSION_1 (TS_MAJOR_1 << 16 \| TS_MINOR)
3a491605	47
8e1d2607 AN	48	#define TS_MAJOR_3 3
	49	#define TS_VERSION_3 (TS_MAJOR_3 << 16 \| TS_MINOR)
	50
3a491605	51	#define HB_MAJOR 3
abeda47e	52	#define HB_MINOR 0
3a491605 S	53	#define HB_VERSION (HB_MAJOR << 16 \| HB_MINOR)
3a491605 S	54
abeda47e AN	55	#define HB_MAJOR_1 1
abeda47e AN	56	#define HB_VERSION_1 (HB_MAJOR_1 << 16 \| HB_MINOR)
3a491605 S	57
	58	static int sd_srv_version;
	59	static int ts_srv_version;
	60	static int hb_srv_version;
a1656454 AN	61
	62	#define SD_VER_COUNT 2
	63	static const int sd_versions[] = {
	64	SD_VERSION,
	65	SD_VERSION_1
	66	};
	67
	68	#define TS_VER_COUNT 3
	69	static const int ts_versions[] = {
	70	TS_VERSION,
	71	TS_VERSION_3,
	72	TS_VERSION_1
	73	};
	74
	75	#define HB_VER_COUNT 2
	76	static const int hb_versions[] = {
	77	HB_VERSION,
	78	HB_VERSION_1
	79	};
	80
	81	#define FW_VER_COUNT 2
	82	static const int fw_versions[] = {
	83	UTIL_FW_VERSION,
	84	UTIL_WS2K8_FW_VERSION
	85	};
6741335b	86
a29b643c S	87	static void shutdown_onchannelcallback(void *context);
	88	static struct hv_util_service util_shutdown = {
	89	.util_cb = shutdown_onchannelcallback,
	90	};
	91
3ba1eb17 V	92	static int hv_timesync_init(struct hv_util_service *srv);
	93	static void hv_timesync_deinit(void);
	94
a29b643c S	95	static void timesync_onchannelcallback(void *context);
	96	static struct hv_util_service util_timesynch = {
	97	.util_cb = timesync_onchannelcallback,
3ba1eb17 V	98	.util_init = hv_timesync_init,
3ba1eb17 V	99	.util_deinit = hv_timesync_deinit,
a29b643c S	100	};
	101
	102	static void heartbeat_onchannelcallback(void *context);
	103	static struct hv_util_service util_heartbeat = {
	104	.util_cb = heartbeat_onchannelcallback,
	105	};
	106
	107	static struct hv_util_service util_kvp = {
	108	.util_cb = hv_kvp_onchannelcallback,
	109	.util_init = hv_kvp_init,
	110	.util_deinit = hv_kvp_deinit,
	111	};
c88c4e4c	112
96dd86fa S	113	static struct hv_util_service util_vss = {
	114	.util_cb = hv_vss_onchannelcallback,
	115	.util_init = hv_vss_init,
	116	.util_deinit = hv_vss_deinit,
	117	};
	118
01325476 S	119	static struct hv_util_service util_fcopy = {
	120	.util_cb = hv_fcopy_onchannelcallback,
	121	.util_init = hv_fcopy_init,
	122	.util_deinit = hv_fcopy_deinit,
	123	};
	124
3dd6cb49 S	125	static void perform_shutdown(struct work_struct *dummy)
	126	{
	127	orderly_poweroff(true);
	128	}
	129
	130	/*
	131	* Perform the shutdown operation in a thread context.
	132	*/
	133	static DECLARE_WORK(shutdown_work, perform_shutdown);
	134
6610944a	135	static void shutdown_onchannelcallback(void *context)
c88c4e4c HJ	136	{
c88c4e4c HJ	137	struct vmbus_channel *channel = context;
45241e50	138	u32 recvlen;
c88c4e4c	139	u64 requestid;
31734634	140	bool execute_shutdown = false;
a29b643c	141	u8 *shut_txf_buf = util_shutdown.recv_buffer;
c88c4e4c HJ	142
	143	struct shutdown_msg_data *shutdown_msg;
	144
	145	struct icmsg_hdr *icmsghdrp;
c88c4e4c	146
45241e50 HJ	147	vmbus_recvpacket(channel, shut_txf_buf,
45241e50 HJ	148	PAGE_SIZE, &recvlen, &requestid);
c88c4e4c HJ	149
c88c4e4c HJ	150	if (recvlen > 0) {
45241e50	151	icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[
c88c4e4c HJ	152	sizeof(struct vmbuspipe_hdr)];
	153
	154	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
a1656454 AN	155	if (vmbus_prep_negotiate_resp(icmsghdrp, shut_txf_buf,
	156	fw_versions, FW_VER_COUNT,
	157	sd_versions, SD_VER_COUNT,
	158	NULL, &sd_srv_version)) {
	159	pr_info("Shutdown IC version %d.%d\n",
	160	sd_srv_version >> 16,
	161	sd_srv_version & 0xFFFF);
	162	}
c88c4e4c	163	} else {
45241e50 HJ	164	shutdown_msg =
	165	(struct shutdown_msg_data *)&shut_txf_buf[
	166	sizeof(struct vmbuspipe_hdr) +
	167	sizeof(struct icmsg_hdr)];
c88c4e4c HJ	168
	169	switch (shutdown_msg->flags) {
	170	case 0:
	171	case 1:
	172	icmsghdrp->status = HV_S_OK;
	173	execute_shutdown = true;
	174
af7a5b6e	175	pr_info("Shutdown request received -"
32235b07	176	" graceful shutdown initiated\n");
c88c4e4c HJ	177	break;
	178	default:
	179	icmsghdrp->status = HV_E_FAIL;
	180	execute_shutdown = false;
	181
af7a5b6e HJ	182	pr_info("Shutdown request received -"
af7a5b6e HJ	183	" Invalid request\n");
c88c4e4c	184	break;
95cd17c9	185	}
c88c4e4c HJ	186	}
	187
	188	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	189	\| ICMSGHDRFLAG_RESPONSE;
	190
45241e50	191	vmbus_sendpacket(channel, shut_txf_buf,
c88c4e4c	192	recvlen, requestid,
415f2287	193	VM_PKT_DATA_INBAND, 0);
c88c4e4c HJ	194	}
c88c4e4c HJ	195
c88c4e4c	196	if (execute_shutdown == true)
3dd6cb49	197	schedule_work(&shutdown_work);
c88c4e4c HJ	198	}
c88c4e4c HJ	199
95ff7cde S	200	/*
	201	* Set the host time in a process context.
	202	*/
	203
	204	struct adj_time_work {
	205	struct work_struct work;
	206	u64 host_time;
8e1d2607 AN	207	u64 ref_time;
8e1d2607 AN	208	u8 flags;
95ff7cde S	209	};
	210
	211	static void hv_set_host_time(struct work_struct *work)
	212	{
	213	struct adj_time_work *wrk;
8e1d2607 AN	214	s64 host_tns;
8e1d2607 AN	215	u64 newtime;
17244623	216	struct timespec64 host_ts;
95ff7cde S	217
95ff7cde S	218	wrk = container_of(work, struct adj_time_work, work);
8e1d2607 AN	219
	220	newtime = wrk->host_time;
	221	if (ts_srv_version > TS_VERSION_3) {
	222	/*
	223	* Some latency has been introduced since Hyper-V generated
	224	* its time sample. Take that latency into account before
	225	* using TSC reference time sample from Hyper-V.
	226	*
	227	* This sample is given by TimeSync v4 and above hosts.
	228	*/
	229	u64 current_tick;
	230
305f7549	231	hv_get_current_tick(current_tick);
8e1d2607 AN	232	newtime += (current_tick - wrk->ref_time);
	233	}
	234	host_tns = (newtime - WLTIMEDELTA) * 100;
17244623	235	host_ts = ns_to_timespec64(host_tns);
8e1d2607	236
17244623	237	do_settimeofday64(&host_ts);
95ff7cde S	238	}
95ff7cde S	239
e9ec3603 HZ	240	/*
	241	* Synchronize time with host after reboot, restore, etc.
	242	*
	243	* ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
	244	* After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
	245	* message after the timesync channel is opened. Since the hv_utils module is
2e338f7e AN	246	* loaded after hv_vmbus, the first message is usually missed. This bit is
	247	* considered a hard request to discipline the clock.
	248	*
	249	* ICTIMESYNCFLAG_SAMPLE bit indicates a time sample from host. This is
	250	* typically used as a hint to the guest. The guest is under no obligation
	251	* to discipline the clock.
e9ec3603	252	*/
3ba1eb17	253	static struct adj_time_work wrk;
8e1d2607	254	static inline void adj_guesttime(u64 hosttime, u64 reftime, u8 flags)
e9ec3603	255	{
e9ec3603	256
3ba1eb17 V	257	/*
	258	* This check is safe since we are executing in the
	259	* interrupt context and time synch messages arre always
	260	* delivered on the same CPU.
	261	*/
	262	if (work_pending(&wrk.work))
95ff7cde S	263	return;
95ff7cde S	264
3ba1eb17 V	265	wrk.host_time = hosttime;
	266	wrk.ref_time = reftime;
	267	wrk.flags = flags;
2e338f7e	268	if ((flags & (ICTIMESYNCFLAG_SYNC \| ICTIMESYNCFLAG_SAMPLE)) != 0) {
3ba1eb17 V	269	schedule_work(&wrk.work);
3ba1eb17 V	270	}
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,
	318	0,
	319	timedatap->flags);
	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	*/
	412
	413	set_channel_read_state(dev->channel, false);
	414
a29b643c	415	hv_set_drvdata(dev, srv);
18965663	416
18965663 DC	417	ret = vmbus_open(dev->channel, 4 * PAGE_SIZE, 4 * PAGE_SIZE, NULL, 0,
	418	srv->util_cb, dev->channel);
	419	if (ret)
	420	goto error;
	421
283f2129	422	return 0;
4e65f6e8 S	423
	424	error:
	425	if (srv->util_deinit)
	426	srv->util_deinit();
	427	error1:
	428	kfree(srv->recv_buffer);
	429	return ret;
283f2129 S	430	}
	431
	432	static int util_remove(struct hv_device *dev)
	433	{
a29b643c S	434	struct hv_util_service *srv = hv_get_drvdata(dev);
	435
	436	if (srv->util_deinit)
	437	srv->util_deinit();
5380b383	438	vmbus_close(dev->channel);
a29b643c S	439	kfree(srv->recv_buffer);
a29b643c S	440
283f2129 S	441	return 0;
	442	}
	443
	444	static const struct hv_vmbus_device_id id_table[] = {
c45cf2d4	445	/* Shutdown guid */
d13984e5 S	446	{ HV_SHUTDOWN_GUID,
	447	.driver_data = (unsigned long)&util_shutdown
	448	},
c45cf2d4	449	/* Time synch guid */
d13984e5 S	450	{ HV_TS_GUID,
	451	.driver_data = (unsigned long)&util_timesynch
	452	},
c45cf2d4	453	/* Heartbeat guid */
d13984e5 S	454	{ HV_HEART_BEAT_GUID,
	455	.driver_data = (unsigned long)&util_heartbeat
	456	},
c45cf2d4	457	/* KVP guid */
d13984e5 S	458	{ HV_KVP_GUID,
	459	.driver_data = (unsigned long)&util_kvp
	460	},
96dd86fa S	461	/* VSS GUID */
	462	{ HV_VSS_GUID,
	463	.driver_data = (unsigned long)&util_vss
	464	},
01325476 S	465	/* File copy GUID */
	466	{ HV_FCOPY_GUID,
	467	.driver_data = (unsigned long)&util_fcopy
	468	},
c45cf2d4	469	{ },
283f2129 S	470	};
	471
	472	MODULE_DEVICE_TABLE(vmbus, id_table);
	473
	474	/* The one and only one */
	475	static struct hv_driver util_drv = {
768fa219	476	.name = "hv_util",
283f2129 S	477	.id_table = id_table,
	478	.probe = util_probe,
	479	.remove = util_remove,
	480	};
	481
3ba1eb17 V	482	static int hv_timesync_init(struct hv_util_service *srv)
	483	{
	484	INIT_WORK(&wrk.work, hv_set_host_time);
	485	return 0;
	486	}
	487
	488	static void hv_timesync_deinit(void)
	489	{
	490	cancel_work_sync(&wrk.work);
	491	}
	492
c88c4e4c HJ	493	static int __init init_hyperv_utils(void)
c88c4e4c HJ	494	{
af7a5b6e	495	pr_info("Registering HyperV Utility Driver\n");
c88c4e4c	496
4e65f6e8	497	return vmbus_driver_register(&util_drv);
c88c4e4c HJ	498	}
	499
	500	static void exit_hyperv_utils(void)
	501	{
af7a5b6e	502	pr_info("De-Registered HyperV Utility Driver\n");
c88c4e4c	503
768fa219	504	vmbus_driver_unregister(&util_drv);
c88c4e4c HJ	505	}
	506
	507	module_init(init_hyperv_utils);
	508	module_exit(exit_hyperv_utils);
	509
	510	MODULE_DESCRIPTION("Hyper-V Utilities");
c88c4e4c	511	MODULE_LICENSE("GPL");