3 * Copyright (c) 2011, Microsoft Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
28 #include <linux/types.h>
32 * Implementation of host controlled snapshot of the guest.
35 #define VSS_OP_REGISTER 128
44 * Following operations are only supported with IC version >= 5.0
46 VSS_OP_FREEZE
, /* Freeze the file systems in the VM */
47 VSS_OP_THAW
, /* Unfreeze the file systems */
49 VSS_OP_COUNT
/* Number of operations, must be last */
54 * Header for all VSS messages.
59 } __attribute__((packed
));
63 * Flag values for the hv_vss_check_feature. Linux supports only
66 #define VSS_HBU_NO_AUTO_RECOVERY 0x00000005
68 struct hv_vss_check_feature
{
70 } __attribute__((packed
));
72 struct hv_vss_check_dm_info
{
74 } __attribute__((packed
));
78 struct hv_vss_hdr vss_hdr
;
82 struct hv_vss_check_feature vss_cf
;
83 struct hv_vss_check_dm_info dm_info
;
85 } __attribute__((packed
));
88 * An implementation of HyperV key value pair (KVP) functionality for Linux.
91 * Copyright (C) 2010, Novell, Inc.
92 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
97 * Maximum value size - used for both key names and value data, and includes
98 * any applicable NULL terminators.
100 * Note: This limit is somewhat arbitrary, but falls easily within what is
101 * supported for all native guests (back to Win 2000) and what is reasonable
102 * for the IC KVP exchange functionality. Note that Windows Me/98/95 are
103 * limited to 255 character key names.
105 * MSDN recommends not storing data values larger than 2048 bytes in the
108 * Note: This value is used in defining the KVP exchange message - this value
109 * cannot be modified without affecting the message size and compatibility.
113 * bytes, including any null terminators
115 #define HV_KVP_EXCHANGE_MAX_VALUE_SIZE (2048)
119 * Maximum key size - the registry limit for the length of an entry name
120 * is 256 characters, including the null terminator
123 #define HV_KVP_EXCHANGE_MAX_KEY_SIZE (512)
126 * In Linux, we implement the KVP functionality in two components:
127 * 1) The kernel component which is packaged as part of the hv_utils driver
128 * is responsible for communicating with the host and responsible for
129 * implementing the host/guest protocol. 2) A user level daemon that is
130 * responsible for data gathering.
132 * Host/Guest Protocol: The host iterates over an index and expects the guest
133 * to assign a key name to the index and also return the value corresponding to
134 * the key. The host will have atmost one KVP transaction outstanding at any
135 * given point in time. The host side iteration stops when the guest returns
136 * an error. Microsoft has specified the following mapping of key names to
137 * host specified index:
140 * 0 FullyQualifiedDomainName
141 * 1 IntegrationServicesVersion
142 * 2 NetworkAddressIPv4
143 * 3 NetworkAddressIPv6
149 * 9 ProcessorArchitecture
151 * The Windows host expects the Key Name and Key Value to be encoded in utf16.
153 * Guest Kernel/KVP Daemon Protocol: As noted earlier, we implement all of the
154 * data gathering functionality in a user mode daemon. The user level daemon
155 * is also responsible for binding the key name to the index as well. The
156 * kernel and user-level daemon communicate using a connector channel.
158 * The user mode component first registers with the
159 * the kernel component. Subsequently, the kernel component requests, data
160 * for the specified keys. In response to this message the user mode component
161 * fills in the value corresponding to the specified key. We overload the
162 * sequence field in the cn_msg header to define our KVP message types.
165 * The kernel component simply acts as a conduit for communication between the
166 * Windows host and the user-level daemon. The kernel component passes up the
167 * index received from the Host to the user-level daemon. If the index is
168 * valid (supported), the corresponding key as well as its
169 * value (both are strings) is returned. If the index is invalid
170 * (not supported), a NULL key string is returned.
175 * Registry value types.
183 * As we look at expanding the KVP functionality to include
184 * IP injection functionality, we need to maintain binary
185 * compatibility with older daemons.
187 * The KVP opcodes are defined by the host and it was unfortunate
188 * that I chose to treat the registration operation as part of the
189 * KVP operations defined by the host.
190 * Here is the level of compatibility
191 * (between the user level daemon and the kernel KVP driver) that we
194 * An older daemon will always be supported on a newer driver.
195 * A given user level daemon will require a minimal version of the
197 * If we cannot handle the version differences, we will fail gracefully
198 * (this can happen when we have a user level daemon that is more
199 * advanced than the KVP driver.
201 * We will use values used in this handshake for determining if we have
202 * workable user level daemon and the kernel driver. We begin by taking the
203 * registration opcode out of the KVP opcode namespace. We will however,
204 * maintain compatibility with the existing user-level daemon code.
208 * Daemon code not supporting IP injection (legacy daemon).
211 #define KVP_OP_REGISTER 4
214 * Daemon code supporting IP injection.
215 * The KVP opcode field is used to communicate the
216 * registration information; so define a namespace that
217 * will be distinct from the host defined KVP opcode.
220 #define KVP_OP_REGISTER1 100
222 enum hv_kvp_exchg_op
{
229 KVP_OP_COUNT
/* Number of operations, must be last. */
232 enum hv_kvp_exchg_pool
{
233 KVP_POOL_EXTERNAL
= 0,
236 KVP_POOL_AUTO_EXTERNAL
,
237 KVP_POOL_AUTO_INTERNAL
,
238 KVP_POOL_COUNT
/* Number of pools, must be last. */
242 * Some Hyper-V status codes.
245 #define HV_S_OK 0x00000000
246 #define HV_E_FAIL 0x80004005
247 #define HV_S_CONT 0x80070103
248 #define HV_ERROR_NOT_SUPPORTED 0x80070032
249 #define HV_ERROR_MACHINE_LOCKED 0x800704F7
250 #define HV_ERROR_DEVICE_NOT_CONNECTED 0x8007048F
251 #define HV_INVALIDARG 0x80070057
252 #define HV_GUID_NOTFOUND 0x80041002
254 #define ADDR_FAMILY_NONE 0x00
255 #define ADDR_FAMILY_IPV4 0x01
256 #define ADDR_FAMILY_IPV6 0x02
258 #define MAX_ADAPTER_ID_SIZE 128
259 #define MAX_IP_ADDR_SIZE 1024
260 #define MAX_GATEWAY_SIZE 512
263 struct hv_kvp_ipaddr_value
{
264 __u16 adapter_id
[MAX_ADAPTER_ID_SIZE
];
267 __u16 ip_addr
[MAX_IP_ADDR_SIZE
];
268 __u16 sub_net
[MAX_IP_ADDR_SIZE
];
269 __u16 gate_way
[MAX_GATEWAY_SIZE
];
270 __u16 dns_addr
[MAX_IP_ADDR_SIZE
];
271 } __attribute__((packed
));
278 } __attribute__((packed
));
280 struct hv_kvp_exchg_msg_value
{
284 __u8 key
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
];
286 __u8 value
[HV_KVP_EXCHANGE_MAX_VALUE_SIZE
];
290 } __attribute__((packed
));
292 struct hv_kvp_msg_enumerate
{
294 struct hv_kvp_exchg_msg_value data
;
295 } __attribute__((packed
));
297 struct hv_kvp_msg_get
{
298 struct hv_kvp_exchg_msg_value data
;
301 struct hv_kvp_msg_set
{
302 struct hv_kvp_exchg_msg_value data
;
305 struct hv_kvp_msg_delete
{
307 __u8 key
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
];
310 struct hv_kvp_register
{
311 __u8 version
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
];
316 struct hv_kvp_hdr kvp_hdr
;
320 struct hv_kvp_msg_get kvp_get
;
321 struct hv_kvp_msg_set kvp_set
;
322 struct hv_kvp_msg_delete kvp_delete
;
323 struct hv_kvp_msg_enumerate kvp_enum_data
;
324 struct hv_kvp_ipaddr_value kvp_ip_val
;
325 struct hv_kvp_register kvp_register
;
327 } __attribute__((packed
));
329 struct hv_kvp_ip_msg
{
332 struct hv_kvp_ipaddr_value kvp_ip_val
;
333 } __attribute__((packed
));
336 #include <linux/scatterlist.h>
337 #include <linux/list.h>
338 #include <linux/uuid.h>
339 #include <linux/timer.h>
340 #include <linux/workqueue.h>
341 #include <linux/completion.h>
342 #include <linux/device.h>
343 #include <linux/mod_devicetable.h>
346 #define MAX_PAGE_BUFFER_COUNT 19
347 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
349 #pragma pack(push, 1)
351 /* Single-page buffer */
352 struct hv_page_buffer
{
358 /* Multiple-page buffer */
359 struct hv_multipage_buffer
{
360 /* Length and Offset determines the # of pfns in the array */
363 u64 pfn_array
[MAX_MULTIPAGE_BUFFER_COUNT
];
366 /* 0x18 includes the proprietary packet header */
367 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
368 (sizeof(struct hv_page_buffer) * \
369 MAX_PAGE_BUFFER_COUNT))
370 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
371 sizeof(struct hv_multipage_buffer))
376 struct hv_ring_buffer
{
377 /* Offset in bytes from the start of ring data below */
380 /* Offset in bytes from the start of ring data below */
386 * Win8 uses some of the reserved bits to implement
387 * interrupt driven flow management. On the send side
388 * we can request that the receiver interrupt the sender
389 * when the ring transitions from being full to being able
390 * to handle a message of size "pending_send_sz".
392 * Add necessary state for this enhancement.
400 u32 feat_pending_send_sz
:1;
405 /* Pad it to PAGE_SIZE so that data starts on page boundary */
409 * Ring data starts here + RingDataStartOffset
410 * !!! DO NOT place any fields below this !!!
415 struct hv_ring_buffer_info
{
416 struct hv_ring_buffer
*ring_buffer
;
417 u32 ring_size
; /* Include the shared header */
418 spinlock_t ring_lock
;
420 u32 ring_datasize
; /* < ring_size */
421 u32 ring_data_startoffset
;
424 struct hv_ring_buffer_debug_info
{
425 u32 current_interrupt_mask
;
426 u32 current_read_index
;
427 u32 current_write_index
;
428 u32 bytes_avail_toread
;
429 u32 bytes_avail_towrite
;
435 * hv_get_ringbuffer_availbytes()
437 * Get number of bytes available to read and to write to
438 * for the specified ring buffer
441 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info
*rbi
,
442 u32
*read
, u32
*write
)
444 u32 read_loc
, write_loc
, dsize
;
446 smp_read_barrier_depends();
448 /* Capture the read/write indices before they changed */
449 read_loc
= rbi
->ring_buffer
->read_index
;
450 write_loc
= rbi
->ring_buffer
->write_index
;
451 dsize
= rbi
->ring_datasize
;
453 *write
= write_loc
>= read_loc
? dsize
- (write_loc
- read_loc
) :
454 read_loc
- write_loc
;
455 *read
= dsize
- *write
;
460 * We use the same version numbering for all Hyper-V modules.
462 * Definition of versioning is as follows;
464 * Major Number Changes for these scenarios;
465 * 1. When a new version of Windows Hyper-V
467 * 2. A Major change has occurred in the
469 * (For example the merge for the first time
470 * into the kernel) Every time the Major Number
471 * changes, the Revision number is reset to 0.
472 * Minor Number Changes when new functionality is added
473 * to the Linux IC's that is not a bug fix.
475 * 3.1 - Added completed hv_utils driver. Shutdown/Heartbeat/Timesync
477 #define HV_DRV_VERSION "3.1"
480 * VMBUS version is 32 bit entity broken up into
481 * two 16 bit quantities: major_number. minor_number.
483 * 0 . 13 (Windows Server 2008)
488 #define VERSION_WS2008 ((0 << 16) | (13))
489 #define VERSION_WIN7 ((1 << 16) | (1))
490 #define VERSION_WIN8 ((2 << 16) | (4))
492 #define VERSION_INVAL -1
494 #define VERSION_CURRENT VERSION_WIN8
496 /* Make maximum size of pipe payload of 16K */
497 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
499 /* Define PipeMode values. */
500 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
501 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
503 /* The size of the user defined data buffer for non-pipe offers. */
504 #define MAX_USER_DEFINED_BYTES 120
506 /* The size of the user defined data buffer for pipe offers. */
507 #define MAX_PIPE_USER_DEFINED_BYTES 116
510 * At the center of the Channel Management library is the Channel Offer. This
511 * struct contains the fundamental information about an offer.
513 struct vmbus_channel_offer
{
518 * These two fields are not currently used.
524 u16 mmio_megabytes
; /* in bytes * 1024 * 1024 */
527 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
529 unsigned char user_def
[MAX_USER_DEFINED_BYTES
];
534 * The following sructure is an integrated pipe protocol, which
535 * is implemented on top of standard user-defined data. Pipe
536 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
541 unsigned char user_def
[MAX_PIPE_USER_DEFINED_BYTES
];
545 * The sub_channel_index is defined in win8.
547 u16 sub_channel_index
;
552 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
553 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
554 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
555 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
556 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
557 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
558 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
560 struct vmpacket_descriptor
{
568 struct vmpacket_header
{
569 u32 prev_pkt_start_offset
;
570 struct vmpacket_descriptor descriptor
;
573 struct vmtransfer_page_range
{
578 struct vmtransfer_page_packet_header
{
579 struct vmpacket_descriptor d
;
584 struct vmtransfer_page_range ranges
[1];
587 struct vmgpadl_packet_header
{
588 struct vmpacket_descriptor d
;
593 struct vmadd_remove_transfer_page_set
{
594 struct vmpacket_descriptor d
;
601 * This structure defines a range in guest physical space that can be made to
602 * look virtually contiguous.
611 * This is the format for an Establish Gpadl packet, which contains a handle by
612 * which this GPADL will be known and a set of GPA ranges associated with it.
613 * This can be converted to a MDL by the guest OS. If there are multiple GPA
614 * ranges, then the resulting MDL will be "chained," representing multiple VA
617 struct vmestablish_gpadl
{
618 struct vmpacket_descriptor d
;
621 struct gpa_range range
[1];
625 * This is the format for a Teardown Gpadl packet, which indicates that the
626 * GPADL handle in the Establish Gpadl packet will never be referenced again.
628 struct vmteardown_gpadl
{
629 struct vmpacket_descriptor d
;
631 u32 reserved
; /* for alignment to a 8-byte boundary */
635 * This is the format for a GPA-Direct packet, which contains a set of GPA
636 * ranges, in addition to commands and/or data.
638 struct vmdata_gpa_direct
{
639 struct vmpacket_descriptor d
;
642 struct gpa_range range
[1];
645 /* This is the format for a Additional Data Packet. */
646 struct vmadditional_data
{
647 struct vmpacket_descriptor d
;
651 unsigned char data
[1];
654 union vmpacket_largest_possible_header
{
655 struct vmpacket_descriptor simple_hdr
;
656 struct vmtransfer_page_packet_header xfer_page_hdr
;
657 struct vmgpadl_packet_header gpadl_hdr
;
658 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr
;
659 struct vmestablish_gpadl establish_gpadl_hdr
;
660 struct vmteardown_gpadl teardown_gpadl_hdr
;
661 struct vmdata_gpa_direct data_gpa_direct_hdr
;
664 #define VMPACKET_DATA_START_ADDRESS(__packet) \
665 (void *)(((unsigned char *)__packet) + \
666 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
668 #define VMPACKET_DATA_LENGTH(__packet) \
669 ((((struct vmpacket_descriptor)__packet)->len8 - \
670 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
672 #define VMPACKET_TRANSFER_MODE(__packet) \
673 (((struct IMPACT)__packet)->type)
675 enum vmbus_packet_type
{
676 VM_PKT_INVALID
= 0x0,
678 VM_PKT_ADD_XFER_PAGESET
= 0x2,
679 VM_PKT_RM_XFER_PAGESET
= 0x3,
680 VM_PKT_ESTABLISH_GPADL
= 0x4,
681 VM_PKT_TEARDOWN_GPADL
= 0x5,
682 VM_PKT_DATA_INBAND
= 0x6,
683 VM_PKT_DATA_USING_XFER_PAGES
= 0x7,
684 VM_PKT_DATA_USING_GPADL
= 0x8,
685 VM_PKT_DATA_USING_GPA_DIRECT
= 0x9,
686 VM_PKT_CANCEL_REQUEST
= 0xa,
688 VM_PKT_DATA_USING_ADDITIONAL_PKT
= 0xc,
689 VM_PKT_ADDITIONAL_DATA
= 0xd
692 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
695 /* Version 1 messages */
696 enum vmbus_channel_message_type
{
697 CHANNELMSG_INVALID
= 0,
698 CHANNELMSG_OFFERCHANNEL
= 1,
699 CHANNELMSG_RESCIND_CHANNELOFFER
= 2,
700 CHANNELMSG_REQUESTOFFERS
= 3,
701 CHANNELMSG_ALLOFFERS_DELIVERED
= 4,
702 CHANNELMSG_OPENCHANNEL
= 5,
703 CHANNELMSG_OPENCHANNEL_RESULT
= 6,
704 CHANNELMSG_CLOSECHANNEL
= 7,
705 CHANNELMSG_GPADL_HEADER
= 8,
706 CHANNELMSG_GPADL_BODY
= 9,
707 CHANNELMSG_GPADL_CREATED
= 10,
708 CHANNELMSG_GPADL_TEARDOWN
= 11,
709 CHANNELMSG_GPADL_TORNDOWN
= 12,
710 CHANNELMSG_RELID_RELEASED
= 13,
711 CHANNELMSG_INITIATE_CONTACT
= 14,
712 CHANNELMSG_VERSION_RESPONSE
= 15,
713 CHANNELMSG_UNLOAD
= 16,
714 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
715 CHANNELMSG_VIEWRANGE_ADD
= 17,
716 CHANNELMSG_VIEWRANGE_REMOVE
= 18,
721 struct vmbus_channel_message_header
{
722 enum vmbus_channel_message_type msgtype
;
726 /* Query VMBus Version parameters */
727 struct vmbus_channel_query_vmbus_version
{
728 struct vmbus_channel_message_header header
;
732 /* VMBus Version Supported parameters */
733 struct vmbus_channel_version_supported
{
734 struct vmbus_channel_message_header header
;
735 u8 version_supported
;
738 /* Offer Channel parameters */
739 struct vmbus_channel_offer_channel
{
740 struct vmbus_channel_message_header header
;
741 struct vmbus_channel_offer offer
;
745 * win7 and beyond splits this field into a bit field.
747 u8 monitor_allocated
:1;
750 * These are new fields added in win7 and later.
751 * Do not access these fields without checking the
752 * negotiated protocol.
754 * If "is_dedicated_interrupt" is set, we must not set the
755 * associated bit in the channel bitmap while sending the
756 * interrupt to the host.
758 * connection_id is to be used in signaling the host.
760 u16 is_dedicated_interrupt
:1;
765 /* Rescind Offer parameters */
766 struct vmbus_channel_rescind_offer
{
767 struct vmbus_channel_message_header header
;
772 * Request Offer -- no parameters, SynIC message contains the partition ID
773 * Set Snoop -- no parameters, SynIC message contains the partition ID
774 * Clear Snoop -- no parameters, SynIC message contains the partition ID
775 * All Offers Delivered -- no parameters, SynIC message contains the partition
777 * Flush Client -- no parameters, SynIC message contains the partition ID
780 /* Open Channel parameters */
781 struct vmbus_channel_open_channel
{
782 struct vmbus_channel_message_header header
;
784 /* Identifies the specific VMBus channel that is being opened. */
787 /* ID making a particular open request at a channel offer unique. */
790 /* GPADL for the channel's ring buffer. */
791 u32 ringbuffer_gpadlhandle
;
794 * Starting with win8, this field will be used to specify
795 * the target virtual processor on which to deliver the interrupt for
796 * the host to guest communication.
797 * Prior to win8, incoming channel interrupts would only
798 * be delivered on cpu 0. Setting this value to 0 would
799 * preserve the earlier behavior.
804 * The upstream ring buffer begins at offset zero in the memory
805 * described by RingBufferGpadlHandle. The downstream ring buffer
806 * follows it at this offset (in pages).
808 u32 downstream_ringbuffer_pageoffset
;
810 /* User-specific data to be passed along to the server endpoint. */
811 unsigned char userdata
[MAX_USER_DEFINED_BYTES
];
814 /* Open Channel Result parameters */
815 struct vmbus_channel_open_result
{
816 struct vmbus_channel_message_header header
;
822 /* Close channel parameters; */
823 struct vmbus_channel_close_channel
{
824 struct vmbus_channel_message_header header
;
828 /* Channel Message GPADL */
829 #define GPADL_TYPE_RING_BUFFER 1
830 #define GPADL_TYPE_SERVER_SAVE_AREA 2
831 #define GPADL_TYPE_TRANSACTION 8
834 * The number of PFNs in a GPADL message is defined by the number of
835 * pages that would be spanned by ByteCount and ByteOffset. If the
836 * implied number of PFNs won't fit in this packet, there will be a
837 * follow-up packet that contains more.
839 struct vmbus_channel_gpadl_header
{
840 struct vmbus_channel_message_header header
;
845 struct gpa_range range
[0];
848 /* This is the followup packet that contains more PFNs. */
849 struct vmbus_channel_gpadl_body
{
850 struct vmbus_channel_message_header header
;
856 struct vmbus_channel_gpadl_created
{
857 struct vmbus_channel_message_header header
;
863 struct vmbus_channel_gpadl_teardown
{
864 struct vmbus_channel_message_header header
;
869 struct vmbus_channel_gpadl_torndown
{
870 struct vmbus_channel_message_header header
;
874 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
875 struct vmbus_channel_view_range_add
{
876 struct vmbus_channel_message_header header
;
877 PHYSICAL_ADDRESS viewrange_base
;
878 u64 viewrange_length
;
882 struct vmbus_channel_view_range_remove
{
883 struct vmbus_channel_message_header header
;
884 PHYSICAL_ADDRESS viewrange_base
;
889 struct vmbus_channel_relid_released
{
890 struct vmbus_channel_message_header header
;
894 struct vmbus_channel_initiate_contact
{
895 struct vmbus_channel_message_header header
;
896 u32 vmbus_version_requested
;
903 struct vmbus_channel_version_response
{
904 struct vmbus_channel_message_header header
;
905 u8 version_supported
;
908 enum vmbus_channel_state
{
910 CHANNEL_OPENING_STATE
,
914 struct vmbus_channel_debug_info
{
916 enum vmbus_channel_state state
;
917 uuid_le interfacetype
;
918 uuid_le interface_instance
;
920 u32 servermonitor_pending
;
921 u32 servermonitor_latency
;
922 u32 servermonitor_connectionid
;
923 u32 clientmonitor_pending
;
924 u32 clientmonitor_latency
;
925 u32 clientmonitor_connectionid
;
927 struct hv_ring_buffer_debug_info inbound
;
928 struct hv_ring_buffer_debug_info outbound
;
932 * Represents each channel msg on the vmbus connection This is a
933 * variable-size data structure depending on the msg type itself
935 struct vmbus_channel_msginfo
{
936 /* Bookkeeping stuff */
937 struct list_head msglistentry
;
939 /* So far, this is only used to handle gpadl body message */
940 struct list_head submsglist
;
942 /* Synchronize the request/response if needed */
943 struct completion waitevent
;
945 struct vmbus_channel_version_supported version_supported
;
946 struct vmbus_channel_open_result open_result
;
947 struct vmbus_channel_gpadl_torndown gpadl_torndown
;
948 struct vmbus_channel_gpadl_created gpadl_created
;
949 struct vmbus_channel_version_response version_response
;
954 * The channel message that goes out on the "wire".
955 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
957 unsigned char msg
[0];
960 struct vmbus_close_msg
{
961 struct vmbus_channel_msginfo info
;
962 struct vmbus_channel_close_channel msg
;
965 /* Define connection identifier type. */
966 union hv_connection_id
{
974 /* Definition of the hv_signal_event hypercall input structure. */
975 struct hv_input_signal_event
{
976 union hv_connection_id connectionid
;
981 struct hv_input_signal_event_buffer
{
983 struct hv_input_signal_event event
;
986 struct vmbus_channel
{
987 struct list_head listentry
;
989 struct hv_device
*device_obj
;
991 struct work_struct work
;
993 enum vmbus_channel_state state
;
995 struct vmbus_channel_offer_channel offermsg
;
997 * These are based on the OfferMsg.MonitorId.
998 * Save it here for easy access.
1003 u32 ringbuffer_gpadlhandle
;
1005 /* Allocated memory for ring buffer */
1006 void *ringbuffer_pages
;
1007 u32 ringbuffer_pagecount
;
1008 struct hv_ring_buffer_info outbound
; /* send to parent */
1009 struct hv_ring_buffer_info inbound
; /* receive from parent */
1010 spinlock_t inbound_lock
;
1011 struct workqueue_struct
*controlwq
;
1013 struct vmbus_close_msg close_msg
;
1015 /* Channel callback are invoked in this workqueue context */
1016 /* HANDLE dataWorkQueue; */
1018 void (*onchannel_callback
)(void *context
);
1019 void *channel_callback_context
;
1022 * A channel can be marked for efficient (batched)
1024 * If batched_reading is set to "true", we read until the
1025 * channel is empty and hold off interrupts from the host
1026 * during the entire read process.
1027 * If batched_reading is set to "false", the client is not
1028 * going to perform batched reading.
1030 * By default we will enable batched reading; specific
1031 * drivers that don't want this behavior can turn it off.
1034 bool batched_reading
;
1036 bool is_dedicated_interrupt
;
1037 struct hv_input_signal_event_buffer sig_buf
;
1038 struct hv_input_signal_event
*sig_event
;
1041 * Starting with win8, this field will be used to specify
1042 * the target virtual processor on which to deliver the interrupt for
1043 * the host to guest communication.
1044 * Prior to win8, incoming channel interrupts would only
1045 * be delivered on cpu 0. Setting this value to 0 would
1046 * preserve the earlier behavior.
1051 static inline void set_channel_read_state(struct vmbus_channel
*c
, bool state
)
1053 c
->batched_reading
= state
;
1056 void vmbus_onmessage(void *context
);
1058 int vmbus_request_offers(void);
1060 /* The format must be the same as struct vmdata_gpa_direct */
1061 struct vmbus_channel_packet_page_buffer
{
1069 struct hv_page_buffer range
[MAX_PAGE_BUFFER_COUNT
];
1072 /* The format must be the same as struct vmdata_gpa_direct */
1073 struct vmbus_channel_packet_multipage_buffer
{
1080 u32 rangecount
; /* Always 1 in this case */
1081 struct hv_multipage_buffer range
;
1085 extern int vmbus_open(struct vmbus_channel
*channel
,
1086 u32 send_ringbuffersize
,
1087 u32 recv_ringbuffersize
,
1090 void(*onchannel_callback
)(void *context
),
1093 extern void vmbus_close(struct vmbus_channel
*channel
);
1095 extern int vmbus_sendpacket(struct vmbus_channel
*channel
,
1099 enum vmbus_packet_type type
,
1102 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel
*channel
,
1103 struct hv_page_buffer pagebuffers
[],
1109 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel
*channel
,
1110 struct hv_multipage_buffer
*mpb
,
1115 extern int vmbus_establish_gpadl(struct vmbus_channel
*channel
,
1120 extern int vmbus_teardown_gpadl(struct vmbus_channel
*channel
,
1123 extern int vmbus_recvpacket(struct vmbus_channel
*channel
,
1126 u32
*buffer_actual_len
,
1129 extern int vmbus_recvpacket_raw(struct vmbus_channel
*channel
,
1132 u32
*buffer_actual_len
,
1136 extern void vmbus_get_debug_info(struct vmbus_channel
*channel
,
1137 struct vmbus_channel_debug_info
*debug
);
1139 extern void vmbus_ontimer(unsigned long data
);
1141 struct hv_dev_port_info
{
1145 u32 bytes_avail_toread
;
1146 u32 bytes_avail_towrite
;
1149 /* Base driver object */
1153 /* the device type supported by this driver */
1155 const struct hv_vmbus_device_id
*id_table
;
1157 struct device_driver driver
;
1159 int (*probe
)(struct hv_device
*, const struct hv_vmbus_device_id
*);
1160 int (*remove
)(struct hv_device
*);
1161 void (*shutdown
)(struct hv_device
*);
1165 /* Base device object */
1167 /* the device type id of this device */
1170 /* the device instance id of this device */
1171 uuid_le dev_instance
;
1173 struct device device
;
1175 struct vmbus_channel
*channel
;
1179 static inline struct hv_device
*device_to_hv_device(struct device
*d
)
1181 return container_of(d
, struct hv_device
, device
);
1184 static inline struct hv_driver
*drv_to_hv_drv(struct device_driver
*d
)
1186 return container_of(d
, struct hv_driver
, driver
);
1189 static inline void hv_set_drvdata(struct hv_device
*dev
, void *data
)
1191 dev_set_drvdata(&dev
->device
, data
);
1194 static inline void *hv_get_drvdata(struct hv_device
*dev
)
1196 return dev_get_drvdata(&dev
->device
);
1199 /* Vmbus interface */
1200 #define vmbus_driver_register(driver) \
1201 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
1202 int __must_check
__vmbus_driver_register(struct hv_driver
*hv_driver
,
1203 struct module
*owner
,
1204 const char *mod_name
);
1205 void vmbus_driver_unregister(struct hv_driver
*hv_driver
);
1208 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
1210 * This macro is used to create a struct hv_vmbus_device_id that matches a
1213 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \
1214 g8, g9, ga, gb, gc, gd, ge, gf) \
1215 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \
1216 g8, g9, ga, gb, gc, gd, ge, gf },
1219 * GUID definitions of various offer types - services offered to the guest.
1224 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
1226 #define HV_NIC_GUID \
1228 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \
1229 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \
1234 * {32412632-86cb-44a2-9b5c-50d1417354f5}
1236 #define HV_IDE_GUID \
1238 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
1239 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \
1244 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
1246 #define HV_SCSI_GUID \
1248 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
1249 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \
1254 * {0e0b6031-5213-4934-818b-38d90ced39db}
1256 #define HV_SHUTDOWN_GUID \
1258 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \
1259 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \
1264 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
1266 #define HV_TS_GUID \
1268 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \
1269 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \
1274 * {57164f39-9115-4e78-ab55-382f3bd5422d}
1276 #define HV_HEART_BEAT_GUID \
1278 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \
1279 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \
1284 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
1286 #define HV_KVP_GUID \
1288 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \
1289 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \
1293 * Dynamic memory GUID
1294 * {525074dc-8985-46e2-8057-a307dc18a502}
1296 #define HV_DM_GUID \
1298 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \
1299 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \
1304 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1306 #define HV_MOUSE_GUID \
1308 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \
1309 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \
1313 * VSS (Backup/Restore) GUID
1315 #define HV_VSS_GUID \
1317 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \
1318 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \
1321 * Synthetic Video GUID
1322 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1324 #define HV_SYNTHVID_GUID \
1326 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \
1327 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \
1332 * Common header for Hyper-V ICs
1335 #define ICMSGTYPE_NEGOTIATE 0
1336 #define ICMSGTYPE_HEARTBEAT 1
1337 #define ICMSGTYPE_KVPEXCHANGE 2
1338 #define ICMSGTYPE_SHUTDOWN 3
1339 #define ICMSGTYPE_TIMESYNC 4
1340 #define ICMSGTYPE_VSS 5
1342 #define ICMSGHDRFLAG_TRANSACTION 1
1343 #define ICMSGHDRFLAG_REQUEST 2
1344 #define ICMSGHDRFLAG_RESPONSE 4
1348 * While we want to handle util services as regular devices,
1349 * there is only one instance of each of these services; so
1350 * we statically allocate the service specific state.
1353 struct hv_util_service
{
1355 void (*util_cb
)(void *);
1356 int (*util_init
)(struct hv_util_service
*);
1357 void (*util_deinit
)(void);
1360 struct vmbuspipe_hdr
{
1371 struct ic_version icverframe
;
1373 struct ic_version icvermsg
;
1376 u8 ictransaction_id
;
1381 struct icmsg_negotiate
{
1385 struct ic_version icversion_data
[1]; /* any size array */
1388 struct shutdown_msg_data
{
1390 u32 timeout_seconds
;
1392 u8 display_message
[2048];
1395 struct heartbeat_msg_data
{
1400 /* Time Sync IC defs */
1401 #define ICTIMESYNCFLAG_PROBE 0
1402 #define ICTIMESYNCFLAG_SYNC 1
1403 #define ICTIMESYNCFLAG_SAMPLE 2
1406 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1408 #define WLTIMEDELTA 116444736000000000LL
1411 struct ictimesync_data
{
1418 struct hyperv_service_callback
{
1422 struct vmbus_channel
*channel
;
1423 void (*callback
) (void *context
);
1426 #define MAX_SRV_VER 0x7ffffff
1427 extern void vmbus_prep_negotiate_resp(struct icmsg_hdr
*,
1428 struct icmsg_negotiate
*, u8
*, int,
1431 int hv_kvp_init(struct hv_util_service
*);
1432 void hv_kvp_deinit(void);
1433 void hv_kvp_onchannelcallback(void *);
1435 int hv_vss_init(struct hv_util_service
*);
1436 void hv_vss_deinit(void);
1437 void hv_vss_onchannelcallback(void *);
1440 * Negotiated version with the Host.
1443 extern __u32 vmbus_proto_version
;
1445 #endif /* __KERNEL__ */
1446 #endif /* _HYPERV_H */