2 * Copyright (c) 2010, Microsoft Corporation.
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.
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
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.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
28 #include <linux/reboot.h>
29 #include <linux/dmi.h>
30 #include <linux/pci.h>
35 #include "vmbus_packet_format.h"
36 #include "vmbus_channel_interface.h"
37 #include "version_info.h"
39 #include "vmbus_private.h"
40 #include "vmbus_api.h"
44 static u8
*shut_txf_buf
;
45 static u8
*time_txf_buf
;
46 static u8
*hbeat_txf_buf
;
48 static void shutdown_onchannelcallback(void *context
)
50 struct vmbus_channel
*channel
= context
;
53 u8 execute_shutdown
= false;
55 struct shutdown_msg_data
*shutdown_msg
;
57 struct icmsg_hdr
*icmsghdrp
;
58 struct icmsg_negotiate
*negop
= NULL
;
60 vmbus_recvpacket(channel
, shut_txf_buf
,
61 PAGE_SIZE
, &recvlen
, &requestid
);
64 icmsghdrp
= (struct icmsg_hdr
*)&shut_txf_buf
[
65 sizeof(struct vmbuspipe_hdr
)];
67 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
68 prep_negotiate_resp(icmsghdrp
, negop
, shut_txf_buf
);
71 (struct shutdown_msg_data
*)&shut_txf_buf
[
72 sizeof(struct vmbuspipe_hdr
) +
73 sizeof(struct icmsg_hdr
)];
75 switch (shutdown_msg
->flags
) {
78 icmsghdrp
->status
= HV_S_OK
;
79 execute_shutdown
= true;
81 pr_info("Shutdown request received -"
82 " graceful shutdown initiated\n");
85 icmsghdrp
->status
= HV_E_FAIL
;
86 execute_shutdown
= false;
88 pr_info("Shutdown request received -"
89 " Invalid request\n");
94 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
95 | ICMSGHDRFLAG_RESPONSE
;
97 vmbus_sendpacket(channel
, shut_txf_buf
,
99 VM_PKT_DATA_INBAND
, 0);
102 if (execute_shutdown
== true)
103 orderly_poweroff(false);
107 * Set guest time to host UTC time.
109 static inline void do_adj_guesttime(u64 hosttime
)
112 struct timespec host_ts
;
114 host_tns
= (hosttime
- WLTIMEDELTA
) * 100;
115 host_ts
= ns_to_timespec(host_tns
);
117 do_settimeofday(&host_ts
);
121 * Synchronize time with host after reboot, restore, etc.
123 * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
124 * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
125 * message after the timesync channel is opened. Since the hv_utils module is
126 * loaded after hv_vmbus, the first message is usually missed. The other
127 * thing is, systime is automatically set to emulated hardware clock which may
128 * not be UTC time or in the same time zone. So, to override these effects, we
129 * use the first 50 time samples for initial system time setting.
131 static inline void adj_guesttime(u64 hosttime
, u8 flags
)
133 static s32 scnt
= 50;
135 if ((flags
& ICTIMESYNCFLAG_SYNC
) != 0) {
136 do_adj_guesttime(hosttime
);
140 if ((flags
& ICTIMESYNCFLAG_SAMPLE
) != 0 && scnt
> 0) {
142 do_adj_guesttime(hosttime
);
147 * Time Sync Channel message handler.
149 static void timesync_onchannelcallback(void *context
)
151 struct vmbus_channel
*channel
= context
;
154 struct icmsg_hdr
*icmsghdrp
;
155 struct ictimesync_data
*timedatap
;
157 vmbus_recvpacket(channel
, time_txf_buf
,
158 PAGE_SIZE
, &recvlen
, &requestid
);
161 icmsghdrp
= (struct icmsg_hdr
*)&time_txf_buf
[
162 sizeof(struct vmbuspipe_hdr
)];
164 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
165 prep_negotiate_resp(icmsghdrp
, NULL
, time_txf_buf
);
167 timedatap
= (struct ictimesync_data
*)&time_txf_buf
[
168 sizeof(struct vmbuspipe_hdr
) +
169 sizeof(struct icmsg_hdr
)];
170 adj_guesttime(timedatap
->parenttime
, timedatap
->flags
);
173 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
174 | ICMSGHDRFLAG_RESPONSE
;
176 vmbus_sendpacket(channel
, time_txf_buf
,
178 VM_PKT_DATA_INBAND
, 0);
183 * Heartbeat functionality.
184 * Every two seconds, Hyper-V send us a heartbeat request message.
185 * we respond to this message, and Hyper-V knows we are alive.
187 static void heartbeat_onchannelcallback(void *context
)
189 struct vmbus_channel
*channel
= context
;
192 struct icmsg_hdr
*icmsghdrp
;
193 struct heartbeat_msg_data
*heartbeat_msg
;
195 vmbus_recvpacket(channel
, hbeat_txf_buf
,
196 PAGE_SIZE
, &recvlen
, &requestid
);
199 icmsghdrp
= (struct icmsg_hdr
*)&hbeat_txf_buf
[
200 sizeof(struct vmbuspipe_hdr
)];
202 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
203 prep_negotiate_resp(icmsghdrp
, NULL
, hbeat_txf_buf
);
206 (struct heartbeat_msg_data
*)&hbeat_txf_buf
[
207 sizeof(struct vmbuspipe_hdr
) +
208 sizeof(struct icmsg_hdr
)];
210 heartbeat_msg
->seq_num
+= 1;
213 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
214 | ICMSGHDRFLAG_RESPONSE
;
216 vmbus_sendpacket(channel
, hbeat_txf_buf
,
218 VM_PKT_DATA_INBAND
, 0);
222 static const struct pci_device_id __initconst
223 hv_utils_pci_table
[] __maybe_unused
= {
224 { PCI_DEVICE(0x1414, 0x5353) }, /* Hyper-V emulated VGA controller */
227 MODULE_DEVICE_TABLE(pci
, hv_utils_pci_table
);
230 static const struct dmi_system_id __initconst
231 hv_utils_dmi_table
[] __maybe_unused
= {
235 DMI_MATCH(DMI_SYS_VENDOR
, "Microsoft Corporation"),
236 DMI_MATCH(DMI_PRODUCT_NAME
, "Virtual Machine"),
237 DMI_MATCH(DMI_BOARD_NAME
, "Virtual Machine"),
242 MODULE_DEVICE_TABLE(dmi
, hv_utils_dmi_table
);
245 static int __init
init_hyperv_utils(void)
247 pr_info("Registering HyperV Utility Driver\n");
253 if (!dmi_check_system(hv_utils_dmi_table
))
256 shut_txf_buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
257 time_txf_buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
258 hbeat_txf_buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
260 if (!shut_txf_buf
|| !time_txf_buf
|| !hbeat_txf_buf
) {
261 pr_info("Unable to allocate memory for receive buffer\n");
264 kfree(hbeat_txf_buf
);
268 hv_cb_utils
[HV_SHUTDOWN_MSG
].channel
->onchannel_callback
=
269 &shutdown_onchannelcallback
;
270 hv_cb_utils
[HV_SHUTDOWN_MSG
].callback
= &shutdown_onchannelcallback
;
272 hv_cb_utils
[HV_TIMESYNC_MSG
].channel
->onchannel_callback
=
273 ×ync_onchannelcallback
;
274 hv_cb_utils
[HV_TIMESYNC_MSG
].callback
= ×ync_onchannelcallback
;
276 hv_cb_utils
[HV_HEARTBEAT_MSG
].channel
->onchannel_callback
=
277 &heartbeat_onchannelcallback
;
278 hv_cb_utils
[HV_HEARTBEAT_MSG
].callback
= &heartbeat_onchannelcallback
;
280 hv_cb_utils
[HV_KVP_MSG
].channel
->onchannel_callback
=
281 &hv_kvp_onchannelcallback
;
288 static void exit_hyperv_utils(void)
290 pr_info("De-Registered HyperV Utility Driver\n");
292 hv_cb_utils
[HV_SHUTDOWN_MSG
].channel
->onchannel_callback
=
294 hv_cb_utils
[HV_SHUTDOWN_MSG
].callback
= &chn_cb_negotiate
;
296 hv_cb_utils
[HV_TIMESYNC_MSG
].channel
->onchannel_callback
=
298 hv_cb_utils
[HV_TIMESYNC_MSG
].callback
= &chn_cb_negotiate
;
300 hv_cb_utils
[HV_HEARTBEAT_MSG
].channel
->onchannel_callback
=
302 hv_cb_utils
[HV_HEARTBEAT_MSG
].callback
= &chn_cb_negotiate
;
304 hv_cb_utils
[HV_KVP_MSG
].channel
->onchannel_callback
=
310 kfree(hbeat_txf_buf
);
313 module_init(init_hyperv_utils
);
314 module_exit(exit_hyperv_utils
);
316 MODULE_DESCRIPTION("Hyper-V Utilities");
317 MODULE_VERSION(HV_DRV_VERSION
);
318 MODULE_LICENSE("GPL");