[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>


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

#define SD_WS2008_MAJOR		1
#define SD_WS2008_VERSION	(SD_WS2008_MAJOR << 16 | SD_MINOR)

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

#define TS_WS2008_MAJOR		1
#define TS_WS2008_VERSION	(TS_WS2008_MAJOR << 16 | TS_MINOR)

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

#define HB_WS2008_MAJOR	1
#define HB_WS2008_VERSION	(HB_WS2008_MAJOR << 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 void timesync_onchannelcallback(void *context);
static struct hv_util_service util_timesynch = {
	.util_cb = timesync_onchannelcallback,
};

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 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 guest time to host UTC time.
 */
static inline void do_adj_guesttime(u64 hosttime)
{
	s64 host_tns;
	struct timespec host_ts;

	host_tns = (hosttime - WLTIMEDELTA) * 100;
	host_ts = ns_to_timespec(host_tns);

	do_settimeofday(&host_ts);
}

/*
 * Set the host time in a process context.
 */

struct adj_time_work {
	struct work_struct work;
	u64	host_time;
};

static void hv_set_host_time(struct work_struct *work)
{
	struct adj_time_work	*wrk;

	wrk = container_of(work, struct adj_time_work, work);
	do_adj_guesttime(wrk->host_time);
	kfree(wrk);
}

/*
 * 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. The other
 * thing is, systime is automatically set to emulated hardware clock which may
 * not be UTC time or in the same time zone. So, to override these effects, we
 * use the first 50 time samples for initial system time setting.
 */
static inline void adj_guesttime(u64 hosttime, u8 flags)
{
	struct adj_time_work    *wrk;
	static s32 scnt = 50;

	wrk = kmalloc(sizeof(struct adj_time_work), GFP_ATOMIC);
	if (wrk == NULL)
		return;

	wrk->host_time = hosttime;
	if ((flags & ICTIMESYNCFLAG_SYNC) != 0) {
		INIT_WORK(&wrk->work, hv_set_host_time);
		schedule_work(&wrk->work);
		return;
	}

	if ((flags & ICTIMESYNCFLAG_SAMPLE) != 0 && scnt > 0) {
		scnt--;
		INIT_WORK(&wrk->work, hv_set_host_time);
		schedule_work(&wrk->work);
	} else
		kfree(wrk);
}

/*
 * 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;
	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);
		} else {
			timedatap = (struct ictimesync_data *)&time_txf_buf[
				sizeof(struct vmbuspipe_hdr) +
				sizeof(struct icmsg_hdr)];
			adj_guesttime(timedatap->parenttime, 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 * 2, GFP_KERNEL);
	if (!srv->recv_buffer)
		return -ENOMEM;
	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);

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

	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_WS2008_VERSION;
		ts_srv_version = TS_WS2008_VERSION;
		hb_srv_version = HB_WS2008_VERSION;
		break;

	default:
		util_fw_version = UTIL_FW_VERSION;
		sd_srv_version = SD_VERSION;
		ts_srv_version = TS_VERSION;
		hb_srv_version = HB_VERSION;
	}

	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);

	vmbus_close(dev->channel);
	if (srv->util_deinit)
		srv->util_deinit();
	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
	},
	{ },
};

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