xref: /freebsd/sys/dev/hyperv/utilities/hv_utilreg.h (revision 907b59d76938e654f0d040a888e8dfca3de1e222)
1 /*-
2  * Copyright (c) 2016 Microsoft Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _HV_UTILREG_H_
30 #define _HV_UTILREG_H_
31 
32 #define HV_S_OK			0x00000000
33 #define HV_E_FAIL		0x80004005
34 #define HV_ERROR_NOT_SUPPORTED	0x80070032
35 #define HV_ERROR_MACHINE_LOCKED	0x800704F7
36 
37 /*
38  * Common defines for Hyper-V ICs
39  */
40 #define HV_ICMSGTYPE_NEGOTIATE		0
41 #define HV_ICMSGTYPE_HEARTBEAT		1
42 #define HV_ICMSGTYPE_KVPEXCHANGE	2
43 #define HV_ICMSGTYPE_SHUTDOWN		3
44 #define HV_ICMSGTYPE_TIMESYNC		4
45 #define HV_ICMSGTYPE_VSS		5
46 
47 #define HV_ICMSGHDRFLAG_TRANSACTION	1
48 #define HV_ICMSGHDRFLAG_REQUEST		2
49 #define HV_ICMSGHDRFLAG_RESPONSE	4
50 
51 typedef struct hv_vmbus_pipe_hdr {
52 	uint32_t flags;
53 	uint32_t msgsize;
54 } __packed hv_vmbus_pipe_hdr;
55 
56 typedef struct hv_vmbus_ic_version {
57 	uint16_t major;
58 	uint16_t minor;
59 } __packed hv_vmbus_ic_version;
60 
61 typedef struct hv_vmbus_icmsg_hdr {
62 	hv_vmbus_ic_version	icverframe;
63 	uint16_t		icmsgtype;
64 	hv_vmbus_ic_version	icvermsg;
65 	uint16_t		icmsgsize;
66 	uint32_t		status;
67 	uint8_t			ictransaction_id;
68 	uint8_t			icflags;
69 	uint8_t			reserved[2];
70 } __packed hv_vmbus_icmsg_hdr;
71 
72 typedef struct hv_vmbus_icmsg_negotiate {
73 	uint16_t		icframe_vercnt;
74 	uint16_t		icmsg_vercnt;
75 	uint32_t		reserved;
76 	hv_vmbus_ic_version	icversion_data[1]; /* any size array */
77 } __packed hv_vmbus_icmsg_negotiate;
78 
79 typedef struct hv_vmbus_shutdown_msg_data {
80 	uint32_t		reason_code;
81 	uint32_t		timeout_seconds;
82 	uint32_t 		flags;
83 	uint8_t			display_message[2048];
84 } __packed hv_vmbus_shutdown_msg_data;
85 
86 typedef struct hv_vmbus_heartbeat_msg_data {
87 	uint64_t 		seq_num;
88 	uint32_t 		reserved[8];
89 } __packed hv_vmbus_heartbeat_msg_data;
90 
91 #endif	/* !_HV_UTILREG_H_ */
92