xref: /freebsd/sys/dev/hyperv/utilities/hv_utilreg.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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 
27 #ifndef _HV_UTILREG_H_
28 #define _HV_UTILREG_H_
29 
30 /*
31  * Some Hyper-V status codes.
32  */
33 #define HV_S_OK				0x00000000
34 #define HV_E_FAIL			0x80004005
35 #define HV_S_CONT			0x80070103
36 #define HV_ERROR_NOT_SUPPORTED		0x80070032
37 #define HV_ERROR_MACHINE_LOCKED		0x800704F7
38 #define HV_ERROR_DEVICE_NOT_CONNECTED	0x8007048F
39 #define HV_INVALIDARG			0x80070057
40 #define HV_GUID_NOTFOUND		0x80041002
41 
42 /*
43  * Common defines for Hyper-V ICs
44  */
45 #define HV_ICMSGTYPE_NEGOTIATE		0
46 #define HV_ICMSGTYPE_HEARTBEAT		1
47 #define HV_ICMSGTYPE_KVPEXCHANGE	2
48 #define HV_ICMSGTYPE_SHUTDOWN		3
49 #define HV_ICMSGTYPE_TIMESYNC		4
50 #define HV_ICMSGTYPE_VSS		5
51 
52 #define HV_ICMSGHDRFLAG_TRANSACTION	1
53 #define HV_ICMSGHDRFLAG_REQUEST		2
54 #define HV_ICMSGHDRFLAG_RESPONSE	4
55 
56 typedef struct hv_vmbus_pipe_hdr {
57 	uint32_t flags;
58 	uint32_t msgsize;
59 } __packed hv_vmbus_pipe_hdr;
60 
61 typedef struct hv_vmbus_ic_version {
62 	uint16_t major;
63 	uint16_t minor;
64 } __packed hv_vmbus_ic_version;
65 
66 typedef struct hv_vmbus_icmsg_hdr {
67 	hv_vmbus_ic_version	icverframe;
68 	uint16_t		icmsgtype;
69 	hv_vmbus_ic_version	icvermsg;
70 	uint16_t		icmsgsize;
71 	uint32_t		status;
72 	uint8_t			ictransaction_id;
73 	uint8_t			icflags;
74 	uint8_t			reserved[2];
75 } __packed hv_vmbus_icmsg_hdr;
76 
77 typedef struct hv_vmbus_icmsg_negotiate {
78 	uint16_t		icframe_vercnt;
79 	uint16_t		icmsg_vercnt;
80 	uint32_t		reserved;
81 	hv_vmbus_ic_version	icversion_data[1]; /* any size array */
82 } __packed hv_vmbus_icmsg_negotiate;
83 
84 #endif	/* !_HV_UTILREG_H_ */
85