[deliverable/linux.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 "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;
static int util_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;
	struct icmsg_negotiate *negop = NULL;

	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) {
			vmbus_prep_negotiate_resp(icmsghdrp, negop,
					shut_txf_buf, util_fw_version,
					sd_srv_version);
		} 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 timespec 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;

		rdmsrl(HV_X64_MSR_TIME_REF_COUNT, current_tick);
		newtime += (current_tick - wrk->ref_time);
	}
	host_tns = (newtime - WLTIMEDELTA) * 100;
	host_ts = ns_to_timespec(host_tns);

	do_settimeofday(&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;
	struct icmsg_negotiate *negop = NULL;

	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) {
			vmbus_prep_negotiate_resp(icmsghdrp, negop,
						time_txf_buf,
						util_fw_version,
						ts_srv_version);
			pr_info("Using TimeSync 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;
	struct icmsg_negotiate *negop = NULL;

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

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

		if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
			vmbus_prep_negotiate_resp(icmsghdrp, negop,
				hbeat_txf_buf, util_fw_version,
				hb_srv_version);
		} 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);

	/*
	 * Based on the host; initialize the framework and
	 * service version numbers we will negotiate.
	 */
	switch (vmbus_proto_version) {
	case (VERSION_WS2008):
		util_fw_version = UTIL_WS2K8_FW_VERSION;
		sd_srv_version = SD_VERSION_1;
		ts_srv_version = TS_VERSION_1;
		hb_srv_version = HB_VERSION_1;
		break;
	case(VERSION_WIN10):
		util_fw_version = UTIL_FW_VERSION;
		sd_srv_version = SD_VERSION;
		ts_srv_version = TS_VERSION;
		hb_srv_version = HB_VERSION;
		break;
	default:
		util_fw_version = UTIL_FW_VERSION;
		sd_srv_version = SD_VERSION;
		ts_srv_version = TS_VERSION_3;
		hb_srv_version = HB_VERSION;
	}

	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>
c88c4e4c	30
01325476	31	#include "hyperv_vmbus.h"
6741335b	32
3a491605 S	33	#define SD_MAJOR 3
	34	#define SD_MINOR 0
	35	#define SD_VERSION (SD_MAJOR << 16 \| SD_MINOR)
6741335b	36
abeda47e AN	37	#define SD_MAJOR_1 1
abeda47e AN	38	#define SD_VERSION_1 (SD_MAJOR_1 << 16 \| SD_MINOR)
3a491605	39
8e1d2607	40	#define TS_MAJOR 4
3a491605 S	41	#define TS_MINOR 0
	42	#define TS_VERSION (TS_MAJOR << 16 \| TS_MINOR)
	43
abeda47e AN	44	#define TS_MAJOR_1 1
abeda47e AN	45	#define TS_VERSION_1 (TS_MAJOR_1 << 16 \| TS_MINOR)
3a491605	46
8e1d2607 AN	47	#define TS_MAJOR_3 3
	48	#define TS_VERSION_3 (TS_MAJOR_3 << 16 \| TS_MINOR)
	49
3a491605	50	#define HB_MAJOR 3
abeda47e	51	#define HB_MINOR 0
3a491605 S	52	#define HB_VERSION (HB_MAJOR << 16 \| HB_MINOR)
3a491605 S	53
abeda47e AN	54	#define HB_MAJOR_1 1
abeda47e AN	55	#define HB_VERSION_1 (HB_MAJOR_1 << 16 \| HB_MINOR)
3a491605 S	56
	57	static int sd_srv_version;
	58	static int ts_srv_version;
	59	static int hb_srv_version;
	60	static int util_fw_version;
6741335b	61
a29b643c S	62	static void shutdown_onchannelcallback(void *context);
	63	static struct hv_util_service util_shutdown = {
	64	.util_cb = shutdown_onchannelcallback,
	65	};
	66
3ba1eb17 V	67	static int hv_timesync_init(struct hv_util_service *srv);
	68	static void hv_timesync_deinit(void);
	69
a29b643c S	70	static void timesync_onchannelcallback(void *context);
	71	static struct hv_util_service util_timesynch = {
	72	.util_cb = timesync_onchannelcallback,
3ba1eb17 V	73	.util_init = hv_timesync_init,
3ba1eb17 V	74	.util_deinit = hv_timesync_deinit,
a29b643c S	75	};
	76
	77	static void heartbeat_onchannelcallback(void *context);
	78	static struct hv_util_service util_heartbeat = {
	79	.util_cb = heartbeat_onchannelcallback,
	80	};
	81
	82	static struct hv_util_service util_kvp = {
	83	.util_cb = hv_kvp_onchannelcallback,
	84	.util_init = hv_kvp_init,
	85	.util_deinit = hv_kvp_deinit,
	86	};
c88c4e4c	87
96dd86fa S	88	static struct hv_util_service util_vss = {
	89	.util_cb = hv_vss_onchannelcallback,
	90	.util_init = hv_vss_init,
	91	.util_deinit = hv_vss_deinit,
	92	};
	93
01325476 S	94	static struct hv_util_service util_fcopy = {
	95	.util_cb = hv_fcopy_onchannelcallback,
	96	.util_init = hv_fcopy_init,
	97	.util_deinit = hv_fcopy_deinit,
	98	};
	99
3dd6cb49 S	100	static void perform_shutdown(struct work_struct *dummy)
	101	{
	102	orderly_poweroff(true);
	103	}
	104
	105	/*
	106	* Perform the shutdown operation in a thread context.
	107	*/
	108	static DECLARE_WORK(shutdown_work, perform_shutdown);
	109
6610944a	110	static void shutdown_onchannelcallback(void *context)
c88c4e4c HJ	111	{
c88c4e4c HJ	112	struct vmbus_channel *channel = context;
45241e50	113	u32 recvlen;
c88c4e4c	114	u64 requestid;
31734634	115	bool execute_shutdown = false;
a29b643c	116	u8 *shut_txf_buf = util_shutdown.recv_buffer;
c88c4e4c HJ	117
	118	struct shutdown_msg_data *shutdown_msg;
	119
	120	struct icmsg_hdr *icmsghdrp;
	121	struct icmsg_negotiate *negop = NULL;
	122
45241e50 HJ	123	vmbus_recvpacket(channel, shut_txf_buf,
45241e50 HJ	124	PAGE_SIZE, &recvlen, &requestid);
c88c4e4c HJ	125
c88c4e4c HJ	126	if (recvlen > 0) {
45241e50	127	icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[
c88c4e4c HJ	128	sizeof(struct vmbuspipe_hdr)];
	129
	130	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
c836d0ab	131	vmbus_prep_negotiate_resp(icmsghdrp, negop,
3a491605 S	132	shut_txf_buf, util_fw_version,
3a491605 S	133	sd_srv_version);
c88c4e4c	134	} else {
45241e50 HJ	135	shutdown_msg =
	136	(struct shutdown_msg_data *)&shut_txf_buf[
	137	sizeof(struct vmbuspipe_hdr) +
	138	sizeof(struct icmsg_hdr)];
c88c4e4c HJ	139
	140	switch (shutdown_msg->flags) {
	141	case 0:
	142	case 1:
	143	icmsghdrp->status = HV_S_OK;
	144	execute_shutdown = true;
	145
af7a5b6e	146	pr_info("Shutdown request received -"
32235b07	147	" graceful shutdown initiated\n");
c88c4e4c HJ	148	break;
	149	default:
	150	icmsghdrp->status = HV_E_FAIL;
	151	execute_shutdown = false;
	152
af7a5b6e HJ	153	pr_info("Shutdown request received -"
af7a5b6e HJ	154	" Invalid request\n");
c88c4e4c	155	break;
95cd17c9	156	}
c88c4e4c HJ	157	}
	158
	159	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	160	\| ICMSGHDRFLAG_RESPONSE;
	161
45241e50	162	vmbus_sendpacket(channel, shut_txf_buf,
c88c4e4c	163	recvlen, requestid,
415f2287	164	VM_PKT_DATA_INBAND, 0);
c88c4e4c HJ	165	}
c88c4e4c HJ	166
c88c4e4c	167	if (execute_shutdown == true)
3dd6cb49	168	schedule_work(&shutdown_work);
c88c4e4c HJ	169	}
c88c4e4c HJ	170
95ff7cde S	171	/*
	172	* Set the host time in a process context.
	173	*/
	174
	175	struct adj_time_work {
	176	struct work_struct work;
	177	u64 host_time;
8e1d2607 AN	178	u64 ref_time;
8e1d2607 AN	179	u8 flags;
95ff7cde S	180	};
	181
	182	static void hv_set_host_time(struct work_struct *work)
	183	{
	184	struct adj_time_work *wrk;
8e1d2607 AN	185	s64 host_tns;
	186	u64 newtime;
	187	struct timespec host_ts;
95ff7cde S	188
95ff7cde S	189	wrk = container_of(work, struct adj_time_work, work);
8e1d2607 AN	190
	191	newtime = wrk->host_time;
	192	if (ts_srv_version > TS_VERSION_3) {
	193	/*
	194	* Some latency has been introduced since Hyper-V generated
	195	* its time sample. Take that latency into account before
	196	* using TSC reference time sample from Hyper-V.
	197	*
	198	* This sample is given by TimeSync v4 and above hosts.
	199	*/
	200	u64 current_tick;
	201
	202	rdmsrl(HV_X64_MSR_TIME_REF_COUNT, current_tick);
	203	newtime += (current_tick - wrk->ref_time);
	204	}
	205	host_tns = (newtime - WLTIMEDELTA) * 100;
	206	host_ts = ns_to_timespec(host_tns);
	207
	208	do_settimeofday(&host_ts);
95ff7cde S	209	}
95ff7cde S	210
e9ec3603 HZ	211	/*
	212	* Synchronize time with host after reboot, restore, etc.
	213	*
	214	* ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
	215	* After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
	216	* message after the timesync channel is opened. Since the hv_utils module is
2e338f7e AN	217	* loaded after hv_vmbus, the first message is usually missed. This bit is
	218	* considered a hard request to discipline the clock.
	219	*
	220	* ICTIMESYNCFLAG_SAMPLE bit indicates a time sample from host. This is
	221	* typically used as a hint to the guest. The guest is under no obligation
	222	* to discipline the clock.
e9ec3603	223	*/
3ba1eb17	224	static struct adj_time_work wrk;
8e1d2607	225	static inline void adj_guesttime(u64 hosttime, u64 reftime, u8 flags)
e9ec3603	226	{
e9ec3603	227
3ba1eb17 V	228	/*
	229	* This check is safe since we are executing in the
	230	* interrupt context and time synch messages arre always
	231	* delivered on the same CPU.
	232	*/
	233	if (work_pending(&wrk.work))
95ff7cde S	234	return;
95ff7cde S	235
3ba1eb17 V	236	wrk.host_time = hosttime;
	237	wrk.ref_time = reftime;
	238	wrk.flags = flags;
2e338f7e	239	if ((flags & (ICTIMESYNCFLAG_SYNC \| ICTIMESYNCFLAG_SAMPLE)) != 0) {
3ba1eb17 V	240	schedule_work(&wrk.work);
3ba1eb17 V	241	}
39c4e9c3 HZ	242	}
	243
	244	/*
	245	* Time Sync Channel message handler.
	246	*/
	247	static void timesync_onchannelcallback(void *context)
	248	{
	249	struct vmbus_channel *channel = context;
45241e50	250	u32 recvlen;
39c4e9c3 HZ	251	u64 requestid;
	252	struct icmsg_hdr *icmsghdrp;
	253	struct ictimesync_data *timedatap;
8e1d2607	254	struct ictimesync_ref_data *refdata;
a29b643c	255	u8 *time_txf_buf = util_timesynch.recv_buffer;
3a491605	256	struct icmsg_negotiate *negop = NULL;
39c4e9c3	257
45241e50 HJ	258	vmbus_recvpacket(channel, time_txf_buf,
45241e50 HJ	259	PAGE_SIZE, &recvlen, &requestid);
39c4e9c3 HZ	260
39c4e9c3 HZ	261	if (recvlen > 0) {
45241e50	262	icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[
39c4e9c3 HZ	263	sizeof(struct vmbuspipe_hdr)];
	264
	265	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
3a491605 S	266	vmbus_prep_negotiate_resp(icmsghdrp, negop,
	267	time_txf_buf,
	268	util_fw_version,
	269	ts_srv_version);
8e1d2607 AN	270	pr_info("Using TimeSync version %d.%d\n",
8e1d2607 AN	271	ts_srv_version >> 16, ts_srv_version & 0xFFFF);
39c4e9c3	272	} else {
8e1d2607 AN	273	if (ts_srv_version > TS_VERSION_3) {
	274	refdata = (struct ictimesync_ref_data *)
	275	&time_txf_buf[
	276	sizeof(struct vmbuspipe_hdr) +
	277	sizeof(struct icmsg_hdr)];
	278
	279	adj_guesttime(refdata->parenttime,
	280	refdata->vmreferencetime,
	281	refdata->flags);
	282	} else {
	283	timedatap = (struct ictimesync_data *)
	284	&time_txf_buf[
	285	sizeof(struct vmbuspipe_hdr) +
	286	sizeof(struct icmsg_hdr)];
	287	adj_guesttime(timedatap->parenttime,
	288	0,
	289	timedatap->flags);
	290	}
39c4e9c3 HZ	291	}
	292
	293	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	294	\| ICMSGHDRFLAG_RESPONSE;
	295
45241e50	296	vmbus_sendpacket(channel, time_txf_buf,
39c4e9c3	297	recvlen, requestid,
415f2287	298	VM_PKT_DATA_INBAND, 0);
39c4e9c3	299	}
39c4e9c3 HZ	300	}
39c4e9c3 HZ	301
9153f7b9 HJ	302	/*
	303	* Heartbeat functionality.
	304	* Every two seconds, Hyper-V send us a heartbeat request message.
	305	* we respond to this message, and Hyper-V knows we are alive.
	306	*/
	307	static void heartbeat_onchannelcallback(void *context)
	308	{
	309	struct vmbus_channel *channel = context;
45241e50	310	u32 recvlen;
9153f7b9 HJ	311	u64 requestid;
	312	struct icmsg_hdr *icmsghdrp;
	313	struct heartbeat_msg_data *heartbeat_msg;
a29b643c	314	u8 *hbeat_txf_buf = util_heartbeat.recv_buffer;
3a491605	315	struct icmsg_negotiate *negop = NULL;
9153f7b9	316
45241e50 HJ	317	vmbus_recvpacket(channel, hbeat_txf_buf,
45241e50 HJ	318	PAGE_SIZE, &recvlen, &requestid);
9153f7b9 HJ	319
9153f7b9 HJ	320	if (recvlen > 0) {
45241e50	321	icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[
9153f7b9 HJ	322	sizeof(struct vmbuspipe_hdr)];
	323
	324	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
3a491605 S	325	vmbus_prep_negotiate_resp(icmsghdrp, negop,
	326	hbeat_txf_buf, util_fw_version,
	327	hb_srv_version);
9153f7b9	328	} else {
45241e50 HJ	329	heartbeat_msg =
	330	(struct heartbeat_msg_data *)&hbeat_txf_buf[
	331	sizeof(struct vmbuspipe_hdr) +
	332	sizeof(struct icmsg_hdr)];
9153f7b9	333
9153f7b9 HJ	334	heartbeat_msg->seq_num += 1;
	335	}
	336
	337	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
	338	\| ICMSGHDRFLAG_RESPONSE;
	339
45241e50	340	vmbus_sendpacket(channel, hbeat_txf_buf,
9153f7b9	341	recvlen, requestid,
415f2287	342	VM_PKT_DATA_INBAND, 0);
9153f7b9	343	}
9153f7b9	344	}
39c4e9c3	345
84946899 S	346	static int util_probe(struct hv_device *dev,
84946899 S	347	const struct hv_vmbus_device_id *dev_id)
283f2129	348	{
a29b643c S	349	struct hv_util_service *srv =
	350	(struct hv_util_service *)dev_id->driver_data;
	351	int ret;
	352
9bd2d0df	353	srv->recv_buffer = kmalloc(PAGE_SIZE * 4, GFP_KERNEL);
a29b643c S	354	if (!srv->recv_buffer)
a29b643c S	355	return -ENOMEM;
b9830d12	356	srv->channel = dev->channel;
a29b643c S	357	if (srv->util_init) {
	358	ret = srv->util_init(srv);
	359	if (ret) {
4e65f6e8 S	360	ret = -ENODEV;
4e65f6e8 S	361	goto error1;
a29b643c S	362	}
	363	}
	364
7ae3e035 S	365	/*
	366	* The set of services managed by the util driver are not performance
	367	* critical and do not need batched reading. Furthermore, some services
	368	* such as KVP can only handle one message from the host at a time.
	369	* Turn off batched reading for all util drivers before we open the
	370	* channel.
	371	*/
	372
	373	set_channel_read_state(dev->channel, false);
	374
a29b643c	375	hv_set_drvdata(dev, srv);
18965663	376
3a491605 S	377	/*
	378	* Based on the host; initialize the framework and
	379	* service version numbers we will negotiate.
	380	*/
	381	switch (vmbus_proto_version) {
	382	case (VERSION_WS2008):
	383	util_fw_version = UTIL_WS2K8_FW_VERSION;
abeda47e AN	384	sd_srv_version = SD_VERSION_1;
	385	ts_srv_version = TS_VERSION_1;
	386	hb_srv_version = HB_VERSION_1;
3a491605	387	break;
8e1d2607	388	case(VERSION_WIN10):
3a491605 S	389	util_fw_version = UTIL_FW_VERSION;
	390	sd_srv_version = SD_VERSION;
	391	ts_srv_version = TS_VERSION;
	392	hb_srv_version = HB_VERSION;
8e1d2607 AN	393	break;
	394	default:
	395	util_fw_version = UTIL_FW_VERSION;
	396	sd_srv_version = SD_VERSION;
	397	ts_srv_version = TS_VERSION_3;
	398	hb_srv_version = HB_VERSION;
3a491605 S	399	}
3a491605 S	400
18965663 DC	401	ret = vmbus_open(dev->channel, 4 * PAGE_SIZE, 4 * PAGE_SIZE, NULL, 0,
	402	srv->util_cb, dev->channel);
	403	if (ret)
	404	goto error;
	405
283f2129	406	return 0;
4e65f6e8 S	407
	408	error:
	409	if (srv->util_deinit)
	410	srv->util_deinit();
	411	error1:
	412	kfree(srv->recv_buffer);
	413	return ret;
283f2129 S	414	}
	415
	416	static int util_remove(struct hv_device *dev)
	417	{
a29b643c S	418	struct hv_util_service *srv = hv_get_drvdata(dev);
	419
	420	if (srv->util_deinit)
	421	srv->util_deinit();
5380b383	422	vmbus_close(dev->channel);
a29b643c S	423	kfree(srv->recv_buffer);
a29b643c S	424
283f2129 S	425	return 0;
	426	}
	427
	428	static const struct hv_vmbus_device_id id_table[] = {
c45cf2d4	429	/* Shutdown guid */
d13984e5 S	430	{ HV_SHUTDOWN_GUID,
	431	.driver_data = (unsigned long)&util_shutdown
	432	},
c45cf2d4	433	/* Time synch guid */
d13984e5 S	434	{ HV_TS_GUID,
	435	.driver_data = (unsigned long)&util_timesynch
	436	},
c45cf2d4	437	/* Heartbeat guid */
d13984e5 S	438	{ HV_HEART_BEAT_GUID,
	439	.driver_data = (unsigned long)&util_heartbeat
	440	},
c45cf2d4	441	/* KVP guid */
d13984e5 S	442	{ HV_KVP_GUID,
	443	.driver_data = (unsigned long)&util_kvp
	444	},
96dd86fa S	445	/* VSS GUID */
	446	{ HV_VSS_GUID,
	447	.driver_data = (unsigned long)&util_vss
	448	},
01325476 S	449	/* File copy GUID */
	450	{ HV_FCOPY_GUID,
	451	.driver_data = (unsigned long)&util_fcopy
	452	},
c45cf2d4	453	{ },
283f2129 S	454	};
	455
	456	MODULE_DEVICE_TABLE(vmbus, id_table);
	457
	458	/* The one and only one */
	459	static struct hv_driver util_drv = {
768fa219	460	.name = "hv_util",
283f2129 S	461	.id_table = id_table,
	462	.probe = util_probe,
	463	.remove = util_remove,
	464	};
	465
3ba1eb17 V	466	static int hv_timesync_init(struct hv_util_service *srv)
	467	{
	468	INIT_WORK(&wrk.work, hv_set_host_time);
	469	return 0;
	470	}
	471
	472	static void hv_timesync_deinit(void)
	473	{
	474	cancel_work_sync(&wrk.work);
	475	}
	476
c88c4e4c HJ	477	static int __init init_hyperv_utils(void)
c88c4e4c HJ	478	{
af7a5b6e	479	pr_info("Registering HyperV Utility Driver\n");
c88c4e4c	480
4e65f6e8	481	return vmbus_driver_register(&util_drv);
c88c4e4c HJ	482	}
	483
	484	static void exit_hyperv_utils(void)
	485	{
af7a5b6e	486	pr_info("De-Registered HyperV Utility Driver\n");
c88c4e4c	487
768fa219	488	vmbus_driver_unregister(&util_drv);
c88c4e4c HJ	489	}
	490
	491	module_init(init_hyperv_utils);
	492	module_exit(exit_hyperv_utils);
	493
	494	MODULE_DESCRIPTION("Hyper-V Utilities");
c88c4e4c	495	MODULE_LICENSE("GPL");