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 #include <linux/kernel.h>
22 #include <linux/init.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/sysctl.h>
26 #include <linux/reboot.h>
27 #include <linux/dmi.h>
28 #include <linux/pci.h>
33 #include "vmbus_packet_format.h"
34 #include "vmbus_channel_interface.h"
35 #include "version_info.h"
37 #include "vmbus_private.h"
38 #include "vmbus_api.h"
42 static u8
*shut_txf_buf
;
43 static u8
*time_txf_buf
;
44 static u8
*hbeat_txf_buf
;
46 static void shutdown_onchannelcallback(void *context
)
48 struct vmbus_channel
*channel
= context
;
51 u8 execute_shutdown
= false;
53 struct shutdown_msg_data
*shutdown_msg
;
55 struct icmsg_hdr
*icmsghdrp
;
56 struct icmsg_negotiate
*negop
= NULL
;
58 vmbus_recvpacket(channel
, shut_txf_buf
,
59 PAGE_SIZE
, &recvlen
, &requestid
);
62 DPRINT_DBG(VMBUS
, "shutdown packet: len=%d, requestid=%lld",
65 icmsghdrp
= (struct icmsg_hdr
*)&shut_txf_buf
[
66 sizeof(struct vmbuspipe_hdr
)];
68 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
69 prep_negotiate_resp(icmsghdrp
, negop
, shut_txf_buf
);
72 (struct shutdown_msg_data
*)&shut_txf_buf
[
73 sizeof(struct vmbuspipe_hdr
) +
74 sizeof(struct icmsg_hdr
)];
76 switch (shutdown_msg
->flags
) {
79 icmsghdrp
->status
= HV_S_OK
;
80 execute_shutdown
= true;
82 DPRINT_INFO(VMBUS
, "Shutdown request received -"
83 " graceful shutdown initiated");
86 icmsghdrp
->status
= HV_E_FAIL
;
87 execute_shutdown
= false;
89 DPRINT_INFO(VMBUS
, "Shutdown request received -"
95 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
96 | ICMSGHDRFLAG_RESPONSE
;
98 vmbus_sendpacket(channel
, shut_txf_buf
,
100 VM_PKT_DATA_INBAND
, 0);
103 if (execute_shutdown
== true)
104 orderly_poweroff(false);
108 * Set guest time to host UTC time.
110 static inline void do_adj_guesttime(u64 hosttime
)
113 struct timespec host_ts
;
115 host_tns
= (hosttime
- WLTIMEDELTA
) * 100;
116 host_ts
= ns_to_timespec(host_tns
);
118 do_settimeofday(&host_ts
);
122 * Synchronize time with host after reboot, restore, etc.
124 * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
125 * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
126 * message after the timesync channel is opened. Since the hv_utils module is
127 * loaded after hv_vmbus, the first message is usually missed. The other
128 * thing is, systime is automatically set to emulated hardware clock which may
129 * not be UTC time or in the same time zone. So, to override these effects, we
130 * use the first 50 time samples for initial system time setting.
132 static inline void adj_guesttime(u64 hosttime
, u8 flags
)
134 static s32 scnt
= 50;
136 if ((flags
& ICTIMESYNCFLAG_SYNC
) != 0) {
137 do_adj_guesttime(hosttime
);
141 if ((flags
& ICTIMESYNCFLAG_SAMPLE
) != 0 && scnt
> 0) {
143 do_adj_guesttime(hosttime
);
148 * Time Sync Channel message handler.
150 static void timesync_onchannelcallback(void *context
)
152 struct vmbus_channel
*channel
= context
;
155 struct icmsg_hdr
*icmsghdrp
;
156 struct ictimesync_data
*timedatap
;
158 vmbus_recvpacket(channel
, time_txf_buf
,
159 PAGE_SIZE
, &recvlen
, &requestid
);
162 DPRINT_DBG(VMBUS
, "timesync packet: recvlen=%d, requestid=%lld",
165 icmsghdrp
= (struct icmsg_hdr
*)&time_txf_buf
[
166 sizeof(struct vmbuspipe_hdr
)];
168 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
169 prep_negotiate_resp(icmsghdrp
, NULL
, time_txf_buf
);
171 timedatap
= (struct ictimesync_data
*)&time_txf_buf
[
172 sizeof(struct vmbuspipe_hdr
) +
173 sizeof(struct icmsg_hdr
)];
174 adj_guesttime(timedatap
->parenttime
, timedatap
->flags
);
177 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
178 | ICMSGHDRFLAG_RESPONSE
;
180 vmbus_sendpacket(channel
, time_txf_buf
,
182 VM_PKT_DATA_INBAND
, 0);
187 * Heartbeat functionality.
188 * Every two seconds, Hyper-V send us a heartbeat request message.
189 * we respond to this message, and Hyper-V knows we are alive.
191 static void heartbeat_onchannelcallback(void *context
)
193 struct vmbus_channel
*channel
= context
;
196 struct icmsg_hdr
*icmsghdrp
;
197 struct heartbeat_msg_data
*heartbeat_msg
;
199 vmbus_recvpacket(channel
, hbeat_txf_buf
,
200 PAGE_SIZE
, &recvlen
, &requestid
);
203 DPRINT_DBG(VMBUS
, "heartbeat packet: len=%d, requestid=%lld",
206 icmsghdrp
= (struct icmsg_hdr
*)&hbeat_txf_buf
[
207 sizeof(struct vmbuspipe_hdr
)];
209 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
210 prep_negotiate_resp(icmsghdrp
, NULL
, hbeat_txf_buf
);
213 (struct heartbeat_msg_data
*)&hbeat_txf_buf
[
214 sizeof(struct vmbuspipe_hdr
) +
215 sizeof(struct icmsg_hdr
)];
217 DPRINT_DBG(VMBUS
, "heartbeat seq = %lld",
218 heartbeat_msg
->seq_num
);
220 heartbeat_msg
->seq_num
+= 1;
223 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
224 | ICMSGHDRFLAG_RESPONSE
;
226 vmbus_sendpacket(channel
, hbeat_txf_buf
,
228 VM_PKT_DATA_INBAND
, 0);
232 static const struct pci_device_id __initconst
233 hv_utils_pci_table
[] __maybe_unused
= {
234 { PCI_DEVICE(0x1414, 0x5353) }, /* Hyper-V emulated VGA controller */
237 MODULE_DEVICE_TABLE(pci
, hv_utils_pci_table
);
240 static const struct dmi_system_id __initconst
241 hv_utils_dmi_table
[] __maybe_unused
= {
245 DMI_MATCH(DMI_SYS_VENDOR
, "Microsoft Corporation"),
246 DMI_MATCH(DMI_PRODUCT_NAME
, "Virtual Machine"),
247 DMI_MATCH(DMI_BOARD_NAME
, "Virtual Machine"),
252 MODULE_DEVICE_TABLE(dmi
, hv_utils_dmi_table
);
255 static int __init
init_hyperv_utils(void)
257 printk(KERN_INFO
"Registering HyperV Utility Driver\n");
263 if (!dmi_check_system(hv_utils_dmi_table
))
266 shut_txf_buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
267 time_txf_buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
268 hbeat_txf_buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
270 if (!shut_txf_buf
|| !time_txf_buf
|| !hbeat_txf_buf
) {
272 "Unable to allocate memory for receive buffer\n");
275 kfree(hbeat_txf_buf
);
279 hv_cb_utils
[HV_SHUTDOWN_MSG
].channel
->onchannel_callback
=
280 &shutdown_onchannelcallback
;
281 hv_cb_utils
[HV_SHUTDOWN_MSG
].callback
= &shutdown_onchannelcallback
;
283 hv_cb_utils
[HV_TIMESYNC_MSG
].channel
->onchannel_callback
=
284 ×ync_onchannelcallback
;
285 hv_cb_utils
[HV_TIMESYNC_MSG
].callback
= ×ync_onchannelcallback
;
287 hv_cb_utils
[HV_HEARTBEAT_MSG
].channel
->onchannel_callback
=
288 &heartbeat_onchannelcallback
;
289 hv_cb_utils
[HV_HEARTBEAT_MSG
].callback
= &heartbeat_onchannelcallback
;
291 hv_cb_utils
[HV_KVP_MSG
].channel
->onchannel_callback
=
292 &hv_kvp_onchannelcallback
;
299 static void exit_hyperv_utils(void)
301 printk(KERN_INFO
"De-Registered HyperV Utility Driver\n");
303 hv_cb_utils
[HV_SHUTDOWN_MSG
].channel
->onchannel_callback
=
305 hv_cb_utils
[HV_SHUTDOWN_MSG
].callback
= &chn_cb_negotiate
;
307 hv_cb_utils
[HV_TIMESYNC_MSG
].channel
->onchannel_callback
=
309 hv_cb_utils
[HV_TIMESYNC_MSG
].callback
= &chn_cb_negotiate
;
311 hv_cb_utils
[HV_HEARTBEAT_MSG
].channel
->onchannel_callback
=
313 hv_cb_utils
[HV_HEARTBEAT_MSG
].callback
= &chn_cb_negotiate
;
315 hv_cb_utils
[HV_KVP_MSG
].channel
->onchannel_callback
=
321 kfree(hbeat_txf_buf
);
324 module_init(init_hyperv_utils
);
325 module_exit(exit_hyperv_utils
);
327 MODULE_DESCRIPTION("Hyper-V Utilities");
328 MODULE_VERSION(HV_DRV_VERSION
);
329 MODULE_LICENSE("GPL");