xref: /kernel/linux/linux-6.6/drivers/hv/hv_util.c (revision 62306a36)
162306a36Sopenharmony_ci// SPDX-License-Identifier: GPL-2.0-only
262306a36Sopenharmony_ci/*
362306a36Sopenharmony_ci * Copyright (c) 2010, Microsoft Corporation.
462306a36Sopenharmony_ci *
562306a36Sopenharmony_ci * Authors:
662306a36Sopenharmony_ci *   Haiyang Zhang <haiyangz@microsoft.com>
762306a36Sopenharmony_ci *   Hank Janssen  <hjanssen@microsoft.com>
862306a36Sopenharmony_ci */
962306a36Sopenharmony_ci#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
1062306a36Sopenharmony_ci
1162306a36Sopenharmony_ci#include <linux/kernel.h>
1262306a36Sopenharmony_ci#include <linux/init.h>
1362306a36Sopenharmony_ci#include <linux/module.h>
1462306a36Sopenharmony_ci#include <linux/slab.h>
1562306a36Sopenharmony_ci#include <linux/sysctl.h>
1662306a36Sopenharmony_ci#include <linux/reboot.h>
1762306a36Sopenharmony_ci#include <linux/hyperv.h>
1862306a36Sopenharmony_ci#include <linux/clockchips.h>
1962306a36Sopenharmony_ci#include <linux/ptp_clock_kernel.h>
2062306a36Sopenharmony_ci#include <asm/mshyperv.h>
2162306a36Sopenharmony_ci
2262306a36Sopenharmony_ci#include "hyperv_vmbus.h"
2362306a36Sopenharmony_ci
2462306a36Sopenharmony_ci#define SD_MAJOR	3
2562306a36Sopenharmony_ci#define SD_MINOR	0
2662306a36Sopenharmony_ci#define SD_MINOR_1	1
2762306a36Sopenharmony_ci#define SD_MINOR_2	2
2862306a36Sopenharmony_ci#define SD_VERSION_3_1	(SD_MAJOR << 16 | SD_MINOR_1)
2962306a36Sopenharmony_ci#define SD_VERSION_3_2	(SD_MAJOR << 16 | SD_MINOR_2)
3062306a36Sopenharmony_ci#define SD_VERSION	(SD_MAJOR << 16 | SD_MINOR)
3162306a36Sopenharmony_ci
3262306a36Sopenharmony_ci#define SD_MAJOR_1	1
3362306a36Sopenharmony_ci#define SD_VERSION_1	(SD_MAJOR_1 << 16 | SD_MINOR)
3462306a36Sopenharmony_ci
3562306a36Sopenharmony_ci#define TS_MAJOR	4
3662306a36Sopenharmony_ci#define TS_MINOR	0
3762306a36Sopenharmony_ci#define TS_VERSION	(TS_MAJOR << 16 | TS_MINOR)
3862306a36Sopenharmony_ci
3962306a36Sopenharmony_ci#define TS_MAJOR_1	1
4062306a36Sopenharmony_ci#define TS_VERSION_1	(TS_MAJOR_1 << 16 | TS_MINOR)
4162306a36Sopenharmony_ci
4262306a36Sopenharmony_ci#define TS_MAJOR_3	3
4362306a36Sopenharmony_ci#define TS_VERSION_3	(TS_MAJOR_3 << 16 | TS_MINOR)
4462306a36Sopenharmony_ci
4562306a36Sopenharmony_ci#define HB_MAJOR	3
4662306a36Sopenharmony_ci#define HB_MINOR	0
4762306a36Sopenharmony_ci#define HB_VERSION	(HB_MAJOR << 16 | HB_MINOR)
4862306a36Sopenharmony_ci
4962306a36Sopenharmony_ci#define HB_MAJOR_1	1
5062306a36Sopenharmony_ci#define HB_VERSION_1	(HB_MAJOR_1 << 16 | HB_MINOR)
5162306a36Sopenharmony_ci
5262306a36Sopenharmony_cistatic int sd_srv_version;
5362306a36Sopenharmony_cistatic int ts_srv_version;
5462306a36Sopenharmony_cistatic int hb_srv_version;
5562306a36Sopenharmony_ci
5662306a36Sopenharmony_ci#define SD_VER_COUNT 4
5762306a36Sopenharmony_cistatic const int sd_versions[] = {
5862306a36Sopenharmony_ci	SD_VERSION_3_2,
5962306a36Sopenharmony_ci	SD_VERSION_3_1,
6062306a36Sopenharmony_ci	SD_VERSION,
6162306a36Sopenharmony_ci	SD_VERSION_1
6262306a36Sopenharmony_ci};
6362306a36Sopenharmony_ci
6462306a36Sopenharmony_ci#define TS_VER_COUNT 3
6562306a36Sopenharmony_cistatic const int ts_versions[] = {
6662306a36Sopenharmony_ci	TS_VERSION,
6762306a36Sopenharmony_ci	TS_VERSION_3,
6862306a36Sopenharmony_ci	TS_VERSION_1
6962306a36Sopenharmony_ci};
7062306a36Sopenharmony_ci
7162306a36Sopenharmony_ci#define HB_VER_COUNT 2
7262306a36Sopenharmony_cistatic const int hb_versions[] = {
7362306a36Sopenharmony_ci	HB_VERSION,
7462306a36Sopenharmony_ci	HB_VERSION_1
7562306a36Sopenharmony_ci};
7662306a36Sopenharmony_ci
7762306a36Sopenharmony_ci#define FW_VER_COUNT 2
7862306a36Sopenharmony_cistatic const int fw_versions[] = {
7962306a36Sopenharmony_ci	UTIL_FW_VERSION,
8062306a36Sopenharmony_ci	UTIL_WS2K8_FW_VERSION
8162306a36Sopenharmony_ci};
8262306a36Sopenharmony_ci
8362306a36Sopenharmony_ci/*
8462306a36Sopenharmony_ci * Send the "hibernate" udev event in a thread context.
8562306a36Sopenharmony_ci */
8662306a36Sopenharmony_cistruct hibernate_work_context {
8762306a36Sopenharmony_ci	struct work_struct work;
8862306a36Sopenharmony_ci	struct hv_device *dev;
8962306a36Sopenharmony_ci};
9062306a36Sopenharmony_ci
9162306a36Sopenharmony_cistatic struct hibernate_work_context hibernate_context;
9262306a36Sopenharmony_cistatic bool hibernation_supported;
9362306a36Sopenharmony_ci
9462306a36Sopenharmony_cistatic void send_hibernate_uevent(struct work_struct *work)
9562306a36Sopenharmony_ci{
9662306a36Sopenharmony_ci	char *uevent_env[2] = { "EVENT=hibernate", NULL };
9762306a36Sopenharmony_ci	struct hibernate_work_context *ctx;
9862306a36Sopenharmony_ci
9962306a36Sopenharmony_ci	ctx = container_of(work, struct hibernate_work_context, work);
10062306a36Sopenharmony_ci
10162306a36Sopenharmony_ci	kobject_uevent_env(&ctx->dev->device.kobj, KOBJ_CHANGE, uevent_env);
10262306a36Sopenharmony_ci
10362306a36Sopenharmony_ci	pr_info("Sent hibernation uevent\n");
10462306a36Sopenharmony_ci}
10562306a36Sopenharmony_ci
10662306a36Sopenharmony_cistatic int hv_shutdown_init(struct hv_util_service *srv)
10762306a36Sopenharmony_ci{
10862306a36Sopenharmony_ci	struct vmbus_channel *channel = srv->channel;
10962306a36Sopenharmony_ci
11062306a36Sopenharmony_ci	INIT_WORK(&hibernate_context.work, send_hibernate_uevent);
11162306a36Sopenharmony_ci	hibernate_context.dev = channel->device_obj;
11262306a36Sopenharmony_ci
11362306a36Sopenharmony_ci	hibernation_supported = hv_is_hibernation_supported();
11462306a36Sopenharmony_ci
11562306a36Sopenharmony_ci	return 0;
11662306a36Sopenharmony_ci}
11762306a36Sopenharmony_ci
11862306a36Sopenharmony_cistatic void shutdown_onchannelcallback(void *context);
11962306a36Sopenharmony_cistatic struct hv_util_service util_shutdown = {
12062306a36Sopenharmony_ci	.util_cb = shutdown_onchannelcallback,
12162306a36Sopenharmony_ci	.util_init = hv_shutdown_init,
12262306a36Sopenharmony_ci};
12362306a36Sopenharmony_ci
12462306a36Sopenharmony_cistatic int hv_timesync_init(struct hv_util_service *srv);
12562306a36Sopenharmony_cistatic int hv_timesync_pre_suspend(void);
12662306a36Sopenharmony_cistatic void hv_timesync_deinit(void);
12762306a36Sopenharmony_ci
12862306a36Sopenharmony_cistatic void timesync_onchannelcallback(void *context);
12962306a36Sopenharmony_cistatic struct hv_util_service util_timesynch = {
13062306a36Sopenharmony_ci	.util_cb = timesync_onchannelcallback,
13162306a36Sopenharmony_ci	.util_init = hv_timesync_init,
13262306a36Sopenharmony_ci	.util_pre_suspend = hv_timesync_pre_suspend,
13362306a36Sopenharmony_ci	.util_deinit = hv_timesync_deinit,
13462306a36Sopenharmony_ci};
13562306a36Sopenharmony_ci
13662306a36Sopenharmony_cistatic void heartbeat_onchannelcallback(void *context);
13762306a36Sopenharmony_cistatic struct hv_util_service util_heartbeat = {
13862306a36Sopenharmony_ci	.util_cb = heartbeat_onchannelcallback,
13962306a36Sopenharmony_ci};
14062306a36Sopenharmony_ci
14162306a36Sopenharmony_cistatic struct hv_util_service util_kvp = {
14262306a36Sopenharmony_ci	.util_cb = hv_kvp_onchannelcallback,
14362306a36Sopenharmony_ci	.util_init = hv_kvp_init,
14462306a36Sopenharmony_ci	.util_pre_suspend = hv_kvp_pre_suspend,
14562306a36Sopenharmony_ci	.util_pre_resume = hv_kvp_pre_resume,
14662306a36Sopenharmony_ci	.util_deinit = hv_kvp_deinit,
14762306a36Sopenharmony_ci};
14862306a36Sopenharmony_ci
14962306a36Sopenharmony_cistatic struct hv_util_service util_vss = {
15062306a36Sopenharmony_ci	.util_cb = hv_vss_onchannelcallback,
15162306a36Sopenharmony_ci	.util_init = hv_vss_init,
15262306a36Sopenharmony_ci	.util_pre_suspend = hv_vss_pre_suspend,
15362306a36Sopenharmony_ci	.util_pre_resume = hv_vss_pre_resume,
15462306a36Sopenharmony_ci	.util_deinit = hv_vss_deinit,
15562306a36Sopenharmony_ci};
15662306a36Sopenharmony_ci
15762306a36Sopenharmony_cistatic struct hv_util_service util_fcopy = {
15862306a36Sopenharmony_ci	.util_cb = hv_fcopy_onchannelcallback,
15962306a36Sopenharmony_ci	.util_init = hv_fcopy_init,
16062306a36Sopenharmony_ci	.util_pre_suspend = hv_fcopy_pre_suspend,
16162306a36Sopenharmony_ci	.util_pre_resume = hv_fcopy_pre_resume,
16262306a36Sopenharmony_ci	.util_deinit = hv_fcopy_deinit,
16362306a36Sopenharmony_ci};
16462306a36Sopenharmony_ci
16562306a36Sopenharmony_cistatic void perform_shutdown(struct work_struct *dummy)
16662306a36Sopenharmony_ci{
16762306a36Sopenharmony_ci	orderly_poweroff(true);
16862306a36Sopenharmony_ci}
16962306a36Sopenharmony_ci
17062306a36Sopenharmony_cistatic void perform_restart(struct work_struct *dummy)
17162306a36Sopenharmony_ci{
17262306a36Sopenharmony_ci	orderly_reboot();
17362306a36Sopenharmony_ci}
17462306a36Sopenharmony_ci
17562306a36Sopenharmony_ci/*
17662306a36Sopenharmony_ci * Perform the shutdown operation in a thread context.
17762306a36Sopenharmony_ci */
17862306a36Sopenharmony_cistatic DECLARE_WORK(shutdown_work, perform_shutdown);
17962306a36Sopenharmony_ci
18062306a36Sopenharmony_ci/*
18162306a36Sopenharmony_ci * Perform the restart operation in a thread context.
18262306a36Sopenharmony_ci */
18362306a36Sopenharmony_cistatic DECLARE_WORK(restart_work, perform_restart);
18462306a36Sopenharmony_ci
18562306a36Sopenharmony_cistatic void shutdown_onchannelcallback(void *context)
18662306a36Sopenharmony_ci{
18762306a36Sopenharmony_ci	struct vmbus_channel *channel = context;
18862306a36Sopenharmony_ci	struct work_struct *work = NULL;
18962306a36Sopenharmony_ci	u32 recvlen;
19062306a36Sopenharmony_ci	u64 requestid;
19162306a36Sopenharmony_ci	u8  *shut_txf_buf = util_shutdown.recv_buffer;
19262306a36Sopenharmony_ci
19362306a36Sopenharmony_ci	struct shutdown_msg_data *shutdown_msg;
19462306a36Sopenharmony_ci
19562306a36Sopenharmony_ci	struct icmsg_hdr *icmsghdrp;
19662306a36Sopenharmony_ci
19762306a36Sopenharmony_ci	if (vmbus_recvpacket(channel, shut_txf_buf, HV_HYP_PAGE_SIZE, &recvlen, &requestid)) {
19862306a36Sopenharmony_ci		pr_err_ratelimited("Shutdown request received. Could not read into shut txf buf\n");
19962306a36Sopenharmony_ci		return;
20062306a36Sopenharmony_ci	}
20162306a36Sopenharmony_ci
20262306a36Sopenharmony_ci	if (!recvlen)
20362306a36Sopenharmony_ci		return;
20462306a36Sopenharmony_ci
20562306a36Sopenharmony_ci	/* Ensure recvlen is big enough to read header data */
20662306a36Sopenharmony_ci	if (recvlen < ICMSG_HDR) {
20762306a36Sopenharmony_ci		pr_err_ratelimited("Shutdown request received. Packet length too small: %d\n",
20862306a36Sopenharmony_ci				   recvlen);
20962306a36Sopenharmony_ci		return;
21062306a36Sopenharmony_ci	}
21162306a36Sopenharmony_ci
21262306a36Sopenharmony_ci	icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[sizeof(struct vmbuspipe_hdr)];
21362306a36Sopenharmony_ci
21462306a36Sopenharmony_ci	if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
21562306a36Sopenharmony_ci		if (vmbus_prep_negotiate_resp(icmsghdrp,
21662306a36Sopenharmony_ci				shut_txf_buf, recvlen,
21762306a36Sopenharmony_ci				fw_versions, FW_VER_COUNT,
21862306a36Sopenharmony_ci				sd_versions, SD_VER_COUNT,
21962306a36Sopenharmony_ci				NULL, &sd_srv_version)) {
22062306a36Sopenharmony_ci			pr_info("Shutdown IC version %d.%d\n",
22162306a36Sopenharmony_ci				sd_srv_version >> 16,
22262306a36Sopenharmony_ci				sd_srv_version & 0xFFFF);
22362306a36Sopenharmony_ci		}
22462306a36Sopenharmony_ci	} else if (icmsghdrp->icmsgtype == ICMSGTYPE_SHUTDOWN) {
22562306a36Sopenharmony_ci		/* Ensure recvlen is big enough to contain shutdown_msg_data struct */
22662306a36Sopenharmony_ci		if (recvlen < ICMSG_HDR + sizeof(struct shutdown_msg_data)) {
22762306a36Sopenharmony_ci			pr_err_ratelimited("Invalid shutdown msg data. Packet length too small: %u\n",
22862306a36Sopenharmony_ci					   recvlen);
22962306a36Sopenharmony_ci			return;
23062306a36Sopenharmony_ci		}
23162306a36Sopenharmony_ci
23262306a36Sopenharmony_ci		shutdown_msg = (struct shutdown_msg_data *)&shut_txf_buf[ICMSG_HDR];
23362306a36Sopenharmony_ci
23462306a36Sopenharmony_ci		/*
23562306a36Sopenharmony_ci		 * shutdown_msg->flags can be 0(shut down), 2(reboot),
23662306a36Sopenharmony_ci		 * or 4(hibernate). It may bitwise-OR 1, which means
23762306a36Sopenharmony_ci		 * performing the request by force. Linux always tries
23862306a36Sopenharmony_ci		 * to perform the request by force.
23962306a36Sopenharmony_ci		 */
24062306a36Sopenharmony_ci		switch (shutdown_msg->flags) {
24162306a36Sopenharmony_ci		case 0:
24262306a36Sopenharmony_ci		case 1:
24362306a36Sopenharmony_ci			icmsghdrp->status = HV_S_OK;
24462306a36Sopenharmony_ci			work = &shutdown_work;
24562306a36Sopenharmony_ci			pr_info("Shutdown request received - graceful shutdown initiated\n");
24662306a36Sopenharmony_ci			break;
24762306a36Sopenharmony_ci		case 2:
24862306a36Sopenharmony_ci		case 3:
24962306a36Sopenharmony_ci			icmsghdrp->status = HV_S_OK;
25062306a36Sopenharmony_ci			work = &restart_work;
25162306a36Sopenharmony_ci			pr_info("Restart request received - graceful restart initiated\n");
25262306a36Sopenharmony_ci			break;
25362306a36Sopenharmony_ci		case 4:
25462306a36Sopenharmony_ci		case 5:
25562306a36Sopenharmony_ci			pr_info("Hibernation request received\n");
25662306a36Sopenharmony_ci			icmsghdrp->status = hibernation_supported ?
25762306a36Sopenharmony_ci				HV_S_OK : HV_E_FAIL;
25862306a36Sopenharmony_ci			if (hibernation_supported)
25962306a36Sopenharmony_ci				work = &hibernate_context.work;
26062306a36Sopenharmony_ci			break;
26162306a36Sopenharmony_ci		default:
26262306a36Sopenharmony_ci			icmsghdrp->status = HV_E_FAIL;
26362306a36Sopenharmony_ci			pr_info("Shutdown request received - Invalid request\n");
26462306a36Sopenharmony_ci			break;
26562306a36Sopenharmony_ci		}
26662306a36Sopenharmony_ci	} else {
26762306a36Sopenharmony_ci		icmsghdrp->status = HV_E_FAIL;
26862306a36Sopenharmony_ci		pr_err_ratelimited("Shutdown request received. Invalid msg type: %d\n",
26962306a36Sopenharmony_ci				   icmsghdrp->icmsgtype);
27062306a36Sopenharmony_ci	}
27162306a36Sopenharmony_ci
27262306a36Sopenharmony_ci	icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
27362306a36Sopenharmony_ci		| ICMSGHDRFLAG_RESPONSE;
27462306a36Sopenharmony_ci
27562306a36Sopenharmony_ci	vmbus_sendpacket(channel, shut_txf_buf,
27662306a36Sopenharmony_ci			 recvlen, requestid,
27762306a36Sopenharmony_ci			 VM_PKT_DATA_INBAND, 0);
27862306a36Sopenharmony_ci
27962306a36Sopenharmony_ci	if (work)
28062306a36Sopenharmony_ci		schedule_work(work);
28162306a36Sopenharmony_ci}
28262306a36Sopenharmony_ci
28362306a36Sopenharmony_ci/*
28462306a36Sopenharmony_ci * Set the host time in a process context.
28562306a36Sopenharmony_ci */
28662306a36Sopenharmony_cistatic struct work_struct adj_time_work;
28762306a36Sopenharmony_ci
28862306a36Sopenharmony_ci/*
28962306a36Sopenharmony_ci * The last time sample, received from the host. PTP device responds to
29062306a36Sopenharmony_ci * requests by using this data and the current partition-wide time reference
29162306a36Sopenharmony_ci * count.
29262306a36Sopenharmony_ci */
29362306a36Sopenharmony_cistatic struct {
29462306a36Sopenharmony_ci	u64				host_time;
29562306a36Sopenharmony_ci	u64				ref_time;
29662306a36Sopenharmony_ci	spinlock_t			lock;
29762306a36Sopenharmony_ci} host_ts;
29862306a36Sopenharmony_ci
29962306a36Sopenharmony_cistatic inline u64 reftime_to_ns(u64 reftime)
30062306a36Sopenharmony_ci{
30162306a36Sopenharmony_ci	return (reftime - WLTIMEDELTA) * 100;
30262306a36Sopenharmony_ci}
30362306a36Sopenharmony_ci
30462306a36Sopenharmony_ci/*
30562306a36Sopenharmony_ci * Hard coded threshold for host timesync delay: 600 seconds
30662306a36Sopenharmony_ci */
30762306a36Sopenharmony_cistatic const u64 HOST_TIMESYNC_DELAY_THRESH = 600 * (u64)NSEC_PER_SEC;
30862306a36Sopenharmony_ci
30962306a36Sopenharmony_cistatic int hv_get_adj_host_time(struct timespec64 *ts)
31062306a36Sopenharmony_ci{
31162306a36Sopenharmony_ci	u64 newtime, reftime, timediff_adj;
31262306a36Sopenharmony_ci	unsigned long flags;
31362306a36Sopenharmony_ci	int ret = 0;
31462306a36Sopenharmony_ci
31562306a36Sopenharmony_ci	spin_lock_irqsave(&host_ts.lock, flags);
31662306a36Sopenharmony_ci	reftime = hv_read_reference_counter();
31762306a36Sopenharmony_ci
31862306a36Sopenharmony_ci	/*
31962306a36Sopenharmony_ci	 * We need to let the caller know that last update from host
32062306a36Sopenharmony_ci	 * is older than the max allowable threshold. clock_gettime()
32162306a36Sopenharmony_ci	 * and PTP ioctl do not have a documented error that we could
32262306a36Sopenharmony_ci	 * return for this specific case. Use ESTALE to report this.
32362306a36Sopenharmony_ci	 */
32462306a36Sopenharmony_ci	timediff_adj = reftime - host_ts.ref_time;
32562306a36Sopenharmony_ci	if (timediff_adj * 100 > HOST_TIMESYNC_DELAY_THRESH) {
32662306a36Sopenharmony_ci		pr_warn_once("TIMESYNC IC: Stale time stamp, %llu nsecs old\n",
32762306a36Sopenharmony_ci			     (timediff_adj * 100));
32862306a36Sopenharmony_ci		ret = -ESTALE;
32962306a36Sopenharmony_ci	}
33062306a36Sopenharmony_ci
33162306a36Sopenharmony_ci	newtime = host_ts.host_time + timediff_adj;
33262306a36Sopenharmony_ci	*ts = ns_to_timespec64(reftime_to_ns(newtime));
33362306a36Sopenharmony_ci	spin_unlock_irqrestore(&host_ts.lock, flags);
33462306a36Sopenharmony_ci
33562306a36Sopenharmony_ci	return ret;
33662306a36Sopenharmony_ci}
33762306a36Sopenharmony_ci
33862306a36Sopenharmony_cistatic void hv_set_host_time(struct work_struct *work)
33962306a36Sopenharmony_ci{
34062306a36Sopenharmony_ci
34162306a36Sopenharmony_ci	struct timespec64 ts;
34262306a36Sopenharmony_ci
34362306a36Sopenharmony_ci	if (!hv_get_adj_host_time(&ts))
34462306a36Sopenharmony_ci		do_settimeofday64(&ts);
34562306a36Sopenharmony_ci}
34662306a36Sopenharmony_ci
34762306a36Sopenharmony_ci/*
34862306a36Sopenharmony_ci * Synchronize time with host after reboot, restore, etc.
34962306a36Sopenharmony_ci *
35062306a36Sopenharmony_ci * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
35162306a36Sopenharmony_ci * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
35262306a36Sopenharmony_ci * message after the timesync channel is opened. Since the hv_utils module is
35362306a36Sopenharmony_ci * loaded after hv_vmbus, the first message is usually missed. This bit is
35462306a36Sopenharmony_ci * considered a hard request to discipline the clock.
35562306a36Sopenharmony_ci *
35662306a36Sopenharmony_ci * ICTIMESYNCFLAG_SAMPLE bit indicates a time sample from host. This is
35762306a36Sopenharmony_ci * typically used as a hint to the guest. The guest is under no obligation
35862306a36Sopenharmony_ci * to discipline the clock.
35962306a36Sopenharmony_ci */
36062306a36Sopenharmony_cistatic inline void adj_guesttime(u64 hosttime, u64 reftime, u8 adj_flags)
36162306a36Sopenharmony_ci{
36262306a36Sopenharmony_ci	unsigned long flags;
36362306a36Sopenharmony_ci	u64 cur_reftime;
36462306a36Sopenharmony_ci
36562306a36Sopenharmony_ci	/*
36662306a36Sopenharmony_ci	 * Save the adjusted time sample from the host and the snapshot
36762306a36Sopenharmony_ci	 * of the current system time.
36862306a36Sopenharmony_ci	 */
36962306a36Sopenharmony_ci	spin_lock_irqsave(&host_ts.lock, flags);
37062306a36Sopenharmony_ci
37162306a36Sopenharmony_ci	cur_reftime = hv_read_reference_counter();
37262306a36Sopenharmony_ci	host_ts.host_time = hosttime;
37362306a36Sopenharmony_ci	host_ts.ref_time = cur_reftime;
37462306a36Sopenharmony_ci
37562306a36Sopenharmony_ci	/*
37662306a36Sopenharmony_ci	 * TimeSync v4 messages contain reference time (guest's Hyper-V
37762306a36Sopenharmony_ci	 * clocksource read when the time sample was generated), we can
37862306a36Sopenharmony_ci	 * improve the precision by adding the delta between now and the
37962306a36Sopenharmony_ci	 * time of generation. For older protocols we set
38062306a36Sopenharmony_ci	 * reftime == cur_reftime on call.
38162306a36Sopenharmony_ci	 */
38262306a36Sopenharmony_ci	host_ts.host_time += (cur_reftime - reftime);
38362306a36Sopenharmony_ci
38462306a36Sopenharmony_ci	spin_unlock_irqrestore(&host_ts.lock, flags);
38562306a36Sopenharmony_ci
38662306a36Sopenharmony_ci	/* Schedule work to do do_settimeofday64() */
38762306a36Sopenharmony_ci	if (adj_flags & ICTIMESYNCFLAG_SYNC)
38862306a36Sopenharmony_ci		schedule_work(&adj_time_work);
38962306a36Sopenharmony_ci}
39062306a36Sopenharmony_ci
39162306a36Sopenharmony_ci/*
39262306a36Sopenharmony_ci * Time Sync Channel message handler.
39362306a36Sopenharmony_ci */
39462306a36Sopenharmony_cistatic void timesync_onchannelcallback(void *context)
39562306a36Sopenharmony_ci{
39662306a36Sopenharmony_ci	struct vmbus_channel *channel = context;
39762306a36Sopenharmony_ci	u32 recvlen;
39862306a36Sopenharmony_ci	u64 requestid;
39962306a36Sopenharmony_ci	struct icmsg_hdr *icmsghdrp;
40062306a36Sopenharmony_ci	struct ictimesync_data *timedatap;
40162306a36Sopenharmony_ci	struct ictimesync_ref_data *refdata;
40262306a36Sopenharmony_ci	u8 *time_txf_buf = util_timesynch.recv_buffer;
40362306a36Sopenharmony_ci
40462306a36Sopenharmony_ci	/*
40562306a36Sopenharmony_ci	 * Drain the ring buffer and use the last packet to update
40662306a36Sopenharmony_ci	 * host_ts
40762306a36Sopenharmony_ci	 */
40862306a36Sopenharmony_ci	while (1) {
40962306a36Sopenharmony_ci		int ret = vmbus_recvpacket(channel, time_txf_buf,
41062306a36Sopenharmony_ci					   HV_HYP_PAGE_SIZE, &recvlen,
41162306a36Sopenharmony_ci					   &requestid);
41262306a36Sopenharmony_ci		if (ret) {
41362306a36Sopenharmony_ci			pr_err_ratelimited("TimeSync IC pkt recv failed (Err: %d)\n",
41462306a36Sopenharmony_ci					   ret);
41562306a36Sopenharmony_ci			break;
41662306a36Sopenharmony_ci		}
41762306a36Sopenharmony_ci
41862306a36Sopenharmony_ci		if (!recvlen)
41962306a36Sopenharmony_ci			break;
42062306a36Sopenharmony_ci
42162306a36Sopenharmony_ci		/* Ensure recvlen is big enough to read header data */
42262306a36Sopenharmony_ci		if (recvlen < ICMSG_HDR) {
42362306a36Sopenharmony_ci			pr_err_ratelimited("Timesync request received. Packet length too small: %d\n",
42462306a36Sopenharmony_ci					   recvlen);
42562306a36Sopenharmony_ci			break;
42662306a36Sopenharmony_ci		}
42762306a36Sopenharmony_ci
42862306a36Sopenharmony_ci		icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[
42962306a36Sopenharmony_ci				sizeof(struct vmbuspipe_hdr)];
43062306a36Sopenharmony_ci
43162306a36Sopenharmony_ci		if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
43262306a36Sopenharmony_ci			if (vmbus_prep_negotiate_resp(icmsghdrp,
43362306a36Sopenharmony_ci						time_txf_buf, recvlen,
43462306a36Sopenharmony_ci						fw_versions, FW_VER_COUNT,
43562306a36Sopenharmony_ci						ts_versions, TS_VER_COUNT,
43662306a36Sopenharmony_ci						NULL, &ts_srv_version)) {
43762306a36Sopenharmony_ci				pr_info("TimeSync IC version %d.%d\n",
43862306a36Sopenharmony_ci					ts_srv_version >> 16,
43962306a36Sopenharmony_ci					ts_srv_version & 0xFFFF);
44062306a36Sopenharmony_ci			}
44162306a36Sopenharmony_ci		} else if (icmsghdrp->icmsgtype == ICMSGTYPE_TIMESYNC) {
44262306a36Sopenharmony_ci			if (ts_srv_version > TS_VERSION_3) {
44362306a36Sopenharmony_ci				/* Ensure recvlen is big enough to read ictimesync_ref_data */
44462306a36Sopenharmony_ci				if (recvlen < ICMSG_HDR + sizeof(struct ictimesync_ref_data)) {
44562306a36Sopenharmony_ci					pr_err_ratelimited("Invalid ictimesync ref data. Length too small: %u\n",
44662306a36Sopenharmony_ci							   recvlen);
44762306a36Sopenharmony_ci					break;
44862306a36Sopenharmony_ci				}
44962306a36Sopenharmony_ci				refdata = (struct ictimesync_ref_data *)&time_txf_buf[ICMSG_HDR];
45062306a36Sopenharmony_ci
45162306a36Sopenharmony_ci				adj_guesttime(refdata->parenttime,
45262306a36Sopenharmony_ci						refdata->vmreferencetime,
45362306a36Sopenharmony_ci						refdata->flags);
45462306a36Sopenharmony_ci			} else {
45562306a36Sopenharmony_ci				/* Ensure recvlen is big enough to read ictimesync_data */
45662306a36Sopenharmony_ci				if (recvlen < ICMSG_HDR + sizeof(struct ictimesync_data)) {
45762306a36Sopenharmony_ci					pr_err_ratelimited("Invalid ictimesync data. Length too small: %u\n",
45862306a36Sopenharmony_ci							   recvlen);
45962306a36Sopenharmony_ci					break;
46062306a36Sopenharmony_ci				}
46162306a36Sopenharmony_ci				timedatap = (struct ictimesync_data *)&time_txf_buf[ICMSG_HDR];
46262306a36Sopenharmony_ci
46362306a36Sopenharmony_ci				adj_guesttime(timedatap->parenttime,
46462306a36Sopenharmony_ci					      hv_read_reference_counter(),
46562306a36Sopenharmony_ci					      timedatap->flags);
46662306a36Sopenharmony_ci			}
46762306a36Sopenharmony_ci		} else {
46862306a36Sopenharmony_ci			icmsghdrp->status = HV_E_FAIL;
46962306a36Sopenharmony_ci			pr_err_ratelimited("Timesync request received. Invalid msg type: %d\n",
47062306a36Sopenharmony_ci					   icmsghdrp->icmsgtype);
47162306a36Sopenharmony_ci		}
47262306a36Sopenharmony_ci
47362306a36Sopenharmony_ci		icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
47462306a36Sopenharmony_ci			| ICMSGHDRFLAG_RESPONSE;
47562306a36Sopenharmony_ci
47662306a36Sopenharmony_ci		vmbus_sendpacket(channel, time_txf_buf,
47762306a36Sopenharmony_ci				 recvlen, requestid,
47862306a36Sopenharmony_ci				 VM_PKT_DATA_INBAND, 0);
47962306a36Sopenharmony_ci	}
48062306a36Sopenharmony_ci}
48162306a36Sopenharmony_ci
48262306a36Sopenharmony_ci/*
48362306a36Sopenharmony_ci * Heartbeat functionality.
48462306a36Sopenharmony_ci * Every two seconds, Hyper-V send us a heartbeat request message.
48562306a36Sopenharmony_ci * we respond to this message, and Hyper-V knows we are alive.
48662306a36Sopenharmony_ci */
48762306a36Sopenharmony_cistatic void heartbeat_onchannelcallback(void *context)
48862306a36Sopenharmony_ci{
48962306a36Sopenharmony_ci	struct vmbus_channel *channel = context;
49062306a36Sopenharmony_ci	u32 recvlen;
49162306a36Sopenharmony_ci	u64 requestid;
49262306a36Sopenharmony_ci	struct icmsg_hdr *icmsghdrp;
49362306a36Sopenharmony_ci	struct heartbeat_msg_data *heartbeat_msg;
49462306a36Sopenharmony_ci	u8 *hbeat_txf_buf = util_heartbeat.recv_buffer;
49562306a36Sopenharmony_ci
49662306a36Sopenharmony_ci	while (1) {
49762306a36Sopenharmony_ci
49862306a36Sopenharmony_ci		if (vmbus_recvpacket(channel, hbeat_txf_buf, HV_HYP_PAGE_SIZE,
49962306a36Sopenharmony_ci				     &recvlen, &requestid)) {
50062306a36Sopenharmony_ci			pr_err_ratelimited("Heartbeat request received. Could not read into hbeat txf buf\n");
50162306a36Sopenharmony_ci			return;
50262306a36Sopenharmony_ci		}
50362306a36Sopenharmony_ci
50462306a36Sopenharmony_ci		if (!recvlen)
50562306a36Sopenharmony_ci			break;
50662306a36Sopenharmony_ci
50762306a36Sopenharmony_ci		/* Ensure recvlen is big enough to read header data */
50862306a36Sopenharmony_ci		if (recvlen < ICMSG_HDR) {
50962306a36Sopenharmony_ci			pr_err_ratelimited("Heartbeat request received. Packet length too small: %d\n",
51062306a36Sopenharmony_ci					   recvlen);
51162306a36Sopenharmony_ci			break;
51262306a36Sopenharmony_ci		}
51362306a36Sopenharmony_ci
51462306a36Sopenharmony_ci		icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[
51562306a36Sopenharmony_ci				sizeof(struct vmbuspipe_hdr)];
51662306a36Sopenharmony_ci
51762306a36Sopenharmony_ci		if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
51862306a36Sopenharmony_ci			if (vmbus_prep_negotiate_resp(icmsghdrp,
51962306a36Sopenharmony_ci					hbeat_txf_buf, recvlen,
52062306a36Sopenharmony_ci					fw_versions, FW_VER_COUNT,
52162306a36Sopenharmony_ci					hb_versions, HB_VER_COUNT,
52262306a36Sopenharmony_ci					NULL, &hb_srv_version)) {
52362306a36Sopenharmony_ci
52462306a36Sopenharmony_ci				pr_info("Heartbeat IC version %d.%d\n",
52562306a36Sopenharmony_ci					hb_srv_version >> 16,
52662306a36Sopenharmony_ci					hb_srv_version & 0xFFFF);
52762306a36Sopenharmony_ci			}
52862306a36Sopenharmony_ci		} else if (icmsghdrp->icmsgtype == ICMSGTYPE_HEARTBEAT) {
52962306a36Sopenharmony_ci			/*
53062306a36Sopenharmony_ci			 * Ensure recvlen is big enough to read seq_num. Reserved area is not
53162306a36Sopenharmony_ci			 * included in the check as the host may not fill it up entirely
53262306a36Sopenharmony_ci			 */
53362306a36Sopenharmony_ci			if (recvlen < ICMSG_HDR + sizeof(u64)) {
53462306a36Sopenharmony_ci				pr_err_ratelimited("Invalid heartbeat msg data. Length too small: %u\n",
53562306a36Sopenharmony_ci						   recvlen);
53662306a36Sopenharmony_ci				break;
53762306a36Sopenharmony_ci			}
53862306a36Sopenharmony_ci			heartbeat_msg = (struct heartbeat_msg_data *)&hbeat_txf_buf[ICMSG_HDR];
53962306a36Sopenharmony_ci
54062306a36Sopenharmony_ci			heartbeat_msg->seq_num += 1;
54162306a36Sopenharmony_ci		} else {
54262306a36Sopenharmony_ci			icmsghdrp->status = HV_E_FAIL;
54362306a36Sopenharmony_ci			pr_err_ratelimited("Heartbeat request received. Invalid msg type: %d\n",
54462306a36Sopenharmony_ci					   icmsghdrp->icmsgtype);
54562306a36Sopenharmony_ci		}
54662306a36Sopenharmony_ci
54762306a36Sopenharmony_ci		icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
54862306a36Sopenharmony_ci			| ICMSGHDRFLAG_RESPONSE;
54962306a36Sopenharmony_ci
55062306a36Sopenharmony_ci		vmbus_sendpacket(channel, hbeat_txf_buf,
55162306a36Sopenharmony_ci				 recvlen, requestid,
55262306a36Sopenharmony_ci				 VM_PKT_DATA_INBAND, 0);
55362306a36Sopenharmony_ci	}
55462306a36Sopenharmony_ci}
55562306a36Sopenharmony_ci
55662306a36Sopenharmony_ci#define HV_UTIL_RING_SEND_SIZE VMBUS_RING_SIZE(3 * HV_HYP_PAGE_SIZE)
55762306a36Sopenharmony_ci#define HV_UTIL_RING_RECV_SIZE VMBUS_RING_SIZE(3 * HV_HYP_PAGE_SIZE)
55862306a36Sopenharmony_ci
55962306a36Sopenharmony_cistatic int util_probe(struct hv_device *dev,
56062306a36Sopenharmony_ci			const struct hv_vmbus_device_id *dev_id)
56162306a36Sopenharmony_ci{
56262306a36Sopenharmony_ci	struct hv_util_service *srv =
56362306a36Sopenharmony_ci		(struct hv_util_service *)dev_id->driver_data;
56462306a36Sopenharmony_ci	int ret;
56562306a36Sopenharmony_ci
56662306a36Sopenharmony_ci	srv->recv_buffer = kmalloc(HV_HYP_PAGE_SIZE * 4, GFP_KERNEL);
56762306a36Sopenharmony_ci	if (!srv->recv_buffer)
56862306a36Sopenharmony_ci		return -ENOMEM;
56962306a36Sopenharmony_ci	srv->channel = dev->channel;
57062306a36Sopenharmony_ci	if (srv->util_init) {
57162306a36Sopenharmony_ci		ret = srv->util_init(srv);
57262306a36Sopenharmony_ci		if (ret) {
57362306a36Sopenharmony_ci			ret = -ENODEV;
57462306a36Sopenharmony_ci			goto error1;
57562306a36Sopenharmony_ci		}
57662306a36Sopenharmony_ci	}
57762306a36Sopenharmony_ci
57862306a36Sopenharmony_ci	/*
57962306a36Sopenharmony_ci	 * The set of services managed by the util driver are not performance
58062306a36Sopenharmony_ci	 * critical and do not need batched reading. Furthermore, some services
58162306a36Sopenharmony_ci	 * such as KVP can only handle one message from the host at a time.
58262306a36Sopenharmony_ci	 * Turn off batched reading for all util drivers before we open the
58362306a36Sopenharmony_ci	 * channel.
58462306a36Sopenharmony_ci	 */
58562306a36Sopenharmony_ci	set_channel_read_mode(dev->channel, HV_CALL_DIRECT);
58662306a36Sopenharmony_ci
58762306a36Sopenharmony_ci	hv_set_drvdata(dev, srv);
58862306a36Sopenharmony_ci
58962306a36Sopenharmony_ci	ret = vmbus_open(dev->channel, HV_UTIL_RING_SEND_SIZE,
59062306a36Sopenharmony_ci			 HV_UTIL_RING_RECV_SIZE, NULL, 0, srv->util_cb,
59162306a36Sopenharmony_ci			 dev->channel);
59262306a36Sopenharmony_ci	if (ret)
59362306a36Sopenharmony_ci		goto error;
59462306a36Sopenharmony_ci
59562306a36Sopenharmony_ci	return 0;
59662306a36Sopenharmony_ci
59762306a36Sopenharmony_cierror:
59862306a36Sopenharmony_ci	if (srv->util_deinit)
59962306a36Sopenharmony_ci		srv->util_deinit();
60062306a36Sopenharmony_cierror1:
60162306a36Sopenharmony_ci	kfree(srv->recv_buffer);
60262306a36Sopenharmony_ci	return ret;
60362306a36Sopenharmony_ci}
60462306a36Sopenharmony_ci
60562306a36Sopenharmony_cistatic void util_remove(struct hv_device *dev)
60662306a36Sopenharmony_ci{
60762306a36Sopenharmony_ci	struct hv_util_service *srv = hv_get_drvdata(dev);
60862306a36Sopenharmony_ci
60962306a36Sopenharmony_ci	if (srv->util_deinit)
61062306a36Sopenharmony_ci		srv->util_deinit();
61162306a36Sopenharmony_ci	vmbus_close(dev->channel);
61262306a36Sopenharmony_ci	kfree(srv->recv_buffer);
61362306a36Sopenharmony_ci}
61462306a36Sopenharmony_ci
61562306a36Sopenharmony_ci/*
61662306a36Sopenharmony_ci * When we're in util_suspend(), all the userspace processes have been frozen
61762306a36Sopenharmony_ci * (refer to hibernate() -> freeze_processes()). The userspace is thawed only
61862306a36Sopenharmony_ci * after the whole resume procedure, including util_resume(), finishes.
61962306a36Sopenharmony_ci */
62062306a36Sopenharmony_cistatic int util_suspend(struct hv_device *dev)
62162306a36Sopenharmony_ci{
62262306a36Sopenharmony_ci	struct hv_util_service *srv = hv_get_drvdata(dev);
62362306a36Sopenharmony_ci	int ret = 0;
62462306a36Sopenharmony_ci
62562306a36Sopenharmony_ci	if (srv->util_pre_suspend) {
62662306a36Sopenharmony_ci		ret = srv->util_pre_suspend();
62762306a36Sopenharmony_ci		if (ret)
62862306a36Sopenharmony_ci			return ret;
62962306a36Sopenharmony_ci	}
63062306a36Sopenharmony_ci
63162306a36Sopenharmony_ci	vmbus_close(dev->channel);
63262306a36Sopenharmony_ci
63362306a36Sopenharmony_ci	return 0;
63462306a36Sopenharmony_ci}
63562306a36Sopenharmony_ci
63662306a36Sopenharmony_cistatic int util_resume(struct hv_device *dev)
63762306a36Sopenharmony_ci{
63862306a36Sopenharmony_ci	struct hv_util_service *srv = hv_get_drvdata(dev);
63962306a36Sopenharmony_ci	int ret = 0;
64062306a36Sopenharmony_ci
64162306a36Sopenharmony_ci	if (srv->util_pre_resume) {
64262306a36Sopenharmony_ci		ret = srv->util_pre_resume();
64362306a36Sopenharmony_ci		if (ret)
64462306a36Sopenharmony_ci			return ret;
64562306a36Sopenharmony_ci	}
64662306a36Sopenharmony_ci
64762306a36Sopenharmony_ci	ret = vmbus_open(dev->channel, HV_UTIL_RING_SEND_SIZE,
64862306a36Sopenharmony_ci			 HV_UTIL_RING_RECV_SIZE, NULL, 0, srv->util_cb,
64962306a36Sopenharmony_ci			 dev->channel);
65062306a36Sopenharmony_ci	return ret;
65162306a36Sopenharmony_ci}
65262306a36Sopenharmony_ci
65362306a36Sopenharmony_cistatic const struct hv_vmbus_device_id id_table[] = {
65462306a36Sopenharmony_ci	/* Shutdown guid */
65562306a36Sopenharmony_ci	{ HV_SHUTDOWN_GUID,
65662306a36Sopenharmony_ci	  .driver_data = (unsigned long)&util_shutdown
65762306a36Sopenharmony_ci	},
65862306a36Sopenharmony_ci	/* Time synch guid */
65962306a36Sopenharmony_ci	{ HV_TS_GUID,
66062306a36Sopenharmony_ci	  .driver_data = (unsigned long)&util_timesynch
66162306a36Sopenharmony_ci	},
66262306a36Sopenharmony_ci	/* Heartbeat guid */
66362306a36Sopenharmony_ci	{ HV_HEART_BEAT_GUID,
66462306a36Sopenharmony_ci	  .driver_data = (unsigned long)&util_heartbeat
66562306a36Sopenharmony_ci	},
66662306a36Sopenharmony_ci	/* KVP guid */
66762306a36Sopenharmony_ci	{ HV_KVP_GUID,
66862306a36Sopenharmony_ci	  .driver_data = (unsigned long)&util_kvp
66962306a36Sopenharmony_ci	},
67062306a36Sopenharmony_ci	/* VSS GUID */
67162306a36Sopenharmony_ci	{ HV_VSS_GUID,
67262306a36Sopenharmony_ci	  .driver_data = (unsigned long)&util_vss
67362306a36Sopenharmony_ci	},
67462306a36Sopenharmony_ci	/* File copy GUID */
67562306a36Sopenharmony_ci	{ HV_FCOPY_GUID,
67662306a36Sopenharmony_ci	  .driver_data = (unsigned long)&util_fcopy
67762306a36Sopenharmony_ci	},
67862306a36Sopenharmony_ci	{ },
67962306a36Sopenharmony_ci};
68062306a36Sopenharmony_ci
68162306a36Sopenharmony_ciMODULE_DEVICE_TABLE(vmbus, id_table);
68262306a36Sopenharmony_ci
68362306a36Sopenharmony_ci/* The one and only one */
68462306a36Sopenharmony_cistatic  struct hv_driver util_drv = {
68562306a36Sopenharmony_ci	.name = "hv_utils",
68662306a36Sopenharmony_ci	.id_table = id_table,
68762306a36Sopenharmony_ci	.probe =  util_probe,
68862306a36Sopenharmony_ci	.remove =  util_remove,
68962306a36Sopenharmony_ci	.suspend = util_suspend,
69062306a36Sopenharmony_ci	.resume =  util_resume,
69162306a36Sopenharmony_ci	.driver = {
69262306a36Sopenharmony_ci		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
69362306a36Sopenharmony_ci	},
69462306a36Sopenharmony_ci};
69562306a36Sopenharmony_ci
69662306a36Sopenharmony_cistatic int hv_ptp_enable(struct ptp_clock_info *info,
69762306a36Sopenharmony_ci			 struct ptp_clock_request *request, int on)
69862306a36Sopenharmony_ci{
69962306a36Sopenharmony_ci	return -EOPNOTSUPP;
70062306a36Sopenharmony_ci}
70162306a36Sopenharmony_ci
70262306a36Sopenharmony_cistatic int hv_ptp_settime(struct ptp_clock_info *p, const struct timespec64 *ts)
70362306a36Sopenharmony_ci{
70462306a36Sopenharmony_ci	return -EOPNOTSUPP;
70562306a36Sopenharmony_ci}
70662306a36Sopenharmony_ci
70762306a36Sopenharmony_cistatic int hv_ptp_adjfine(struct ptp_clock_info *ptp, long delta)
70862306a36Sopenharmony_ci{
70962306a36Sopenharmony_ci	return -EOPNOTSUPP;
71062306a36Sopenharmony_ci}
71162306a36Sopenharmony_cistatic int hv_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
71262306a36Sopenharmony_ci{
71362306a36Sopenharmony_ci	return -EOPNOTSUPP;
71462306a36Sopenharmony_ci}
71562306a36Sopenharmony_ci
71662306a36Sopenharmony_cistatic int hv_ptp_gettime(struct ptp_clock_info *info, struct timespec64 *ts)
71762306a36Sopenharmony_ci{
71862306a36Sopenharmony_ci	return hv_get_adj_host_time(ts);
71962306a36Sopenharmony_ci}
72062306a36Sopenharmony_ci
72162306a36Sopenharmony_cistatic struct ptp_clock_info ptp_hyperv_info = {
72262306a36Sopenharmony_ci	.name		= "hyperv",
72362306a36Sopenharmony_ci	.enable         = hv_ptp_enable,
72462306a36Sopenharmony_ci	.adjtime        = hv_ptp_adjtime,
72562306a36Sopenharmony_ci	.adjfine        = hv_ptp_adjfine,
72662306a36Sopenharmony_ci	.gettime64      = hv_ptp_gettime,
72762306a36Sopenharmony_ci	.settime64      = hv_ptp_settime,
72862306a36Sopenharmony_ci	.owner		= THIS_MODULE,
72962306a36Sopenharmony_ci};
73062306a36Sopenharmony_ci
73162306a36Sopenharmony_cistatic struct ptp_clock *hv_ptp_clock;
73262306a36Sopenharmony_ci
73362306a36Sopenharmony_cistatic int hv_timesync_init(struct hv_util_service *srv)
73462306a36Sopenharmony_ci{
73562306a36Sopenharmony_ci	spin_lock_init(&host_ts.lock);
73662306a36Sopenharmony_ci
73762306a36Sopenharmony_ci	INIT_WORK(&adj_time_work, hv_set_host_time);
73862306a36Sopenharmony_ci
73962306a36Sopenharmony_ci	/*
74062306a36Sopenharmony_ci	 * ptp_clock_register() returns NULL when CONFIG_PTP_1588_CLOCK is
74162306a36Sopenharmony_ci	 * disabled but the driver is still useful without the PTP device
74262306a36Sopenharmony_ci	 * as it still handles the ICTIMESYNCFLAG_SYNC case.
74362306a36Sopenharmony_ci	 */
74462306a36Sopenharmony_ci	hv_ptp_clock = ptp_clock_register(&ptp_hyperv_info, NULL);
74562306a36Sopenharmony_ci	if (IS_ERR_OR_NULL(hv_ptp_clock)) {
74662306a36Sopenharmony_ci		pr_err("cannot register PTP clock: %d\n",
74762306a36Sopenharmony_ci		       PTR_ERR_OR_ZERO(hv_ptp_clock));
74862306a36Sopenharmony_ci		hv_ptp_clock = NULL;
74962306a36Sopenharmony_ci	}
75062306a36Sopenharmony_ci
75162306a36Sopenharmony_ci	return 0;
75262306a36Sopenharmony_ci}
75362306a36Sopenharmony_ci
75462306a36Sopenharmony_cistatic void hv_timesync_cancel_work(void)
75562306a36Sopenharmony_ci{
75662306a36Sopenharmony_ci	cancel_work_sync(&adj_time_work);
75762306a36Sopenharmony_ci}
75862306a36Sopenharmony_ci
75962306a36Sopenharmony_cistatic int hv_timesync_pre_suspend(void)
76062306a36Sopenharmony_ci{
76162306a36Sopenharmony_ci	hv_timesync_cancel_work();
76262306a36Sopenharmony_ci	return 0;
76362306a36Sopenharmony_ci}
76462306a36Sopenharmony_ci
76562306a36Sopenharmony_cistatic void hv_timesync_deinit(void)
76662306a36Sopenharmony_ci{
76762306a36Sopenharmony_ci	if (hv_ptp_clock)
76862306a36Sopenharmony_ci		ptp_clock_unregister(hv_ptp_clock);
76962306a36Sopenharmony_ci
77062306a36Sopenharmony_ci	hv_timesync_cancel_work();
77162306a36Sopenharmony_ci}
77262306a36Sopenharmony_ci
77362306a36Sopenharmony_cistatic int __init init_hyperv_utils(void)
77462306a36Sopenharmony_ci{
77562306a36Sopenharmony_ci	pr_info("Registering HyperV Utility Driver\n");
77662306a36Sopenharmony_ci
77762306a36Sopenharmony_ci	return vmbus_driver_register(&util_drv);
77862306a36Sopenharmony_ci}
77962306a36Sopenharmony_ci
78062306a36Sopenharmony_cistatic void exit_hyperv_utils(void)
78162306a36Sopenharmony_ci{
78262306a36Sopenharmony_ci	pr_info("De-Registered HyperV Utility Driver\n");
78362306a36Sopenharmony_ci
78462306a36Sopenharmony_ci	vmbus_driver_unregister(&util_drv);
78562306a36Sopenharmony_ci}
78662306a36Sopenharmony_ci
78762306a36Sopenharmony_cimodule_init(init_hyperv_utils);
78862306a36Sopenharmony_cimodule_exit(exit_hyperv_utils);
78962306a36Sopenharmony_ci
79062306a36Sopenharmony_ciMODULE_DESCRIPTION("Hyper-V Utilities");
79162306a36Sopenharmony_ciMODULE_LICENSE("GPL");
792