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