xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_reg.h (revision 86c9d9918f1db7cdd968b60f8902466887bcd9e9)
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 _VMBUS_REG_H_
30 #define _VMBUS_REG_H_
31 
32 #include <sys/param.h>
33 
34 /*
35  * Hyper-V SynIC message format.
36  */
37 
38 #define VMBUS_MSG_DSIZE_MAX		240
39 #define VMBUS_MSG_SIZE			256
40 
41 struct vmbus_message {
42 	uint32_t	msg_type;	/* VMBUS_MSGTYPE_ */
43 	uint8_t		msg_dsize;	/* data size */
44 	uint8_t		msg_flags;	/* VMBUS_MSGFLAG_ */
45 	uint16_t	msg_rsvd;
46 	uint64_t	msg_id;
47 	uint8_t		msg_data[VMBUS_MSG_DSIZE_MAX];
48 } __packed;
49 CTASSERT(sizeof(struct vmbus_message) == VMBUS_MSG_SIZE);
50 
51 #define VMBUS_MSGTYPE_NONE		0
52 #define VMBUS_MSGTYPE_CHANNEL		1
53 #define VMBUS_MSGTYPE_TIMER_EXPIRED	0x80000010
54 
55 #define VMBUS_MSGFLAG_PENDING		0x01
56 
57 /*
58  * Hyper-V SynIC event flags
59  */
60 
61 #ifdef __LP64__
62 #define VMBUS_EVTFLAGS_MAX	32
63 #define VMBUS_EVTFLAG_SHIFT	6
64 #else
65 #define VMBUS_EVTFLAGS_MAX	64
66 #define VMBUS_EVTFLAG_SHIFT	5
67 #endif
68 #define VMBUS_EVTFLAG_LEN	(1 << VMBUS_EVTFLAG_SHIFT)
69 #define VMBUS_EVTFLAG_MASK	(VMBUS_EVTFLAG_LEN - 1)
70 #define VMBUS_EVTFLAGS_SIZE	256
71 
72 struct vmbus_evtflags {
73 	u_long		evt_flags[VMBUS_EVTFLAGS_MAX];
74 } __packed;
75 CTASSERT(sizeof(struct vmbus_evtflags) == VMBUS_EVTFLAGS_SIZE);
76 
77 /*
78  * Channel
79  */
80 
81 #define VMBUS_CHAN_MAX_COMPAT	256
82 #define VMBUS_CHAN_MAX		(VMBUS_EVTFLAG_LEN * VMBUS_EVTFLAGS_MAX)
83 
84 #endif	/* !_VMBUS_REG_H_ */
85