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 <uapi/linux/hyperv.h>
30 #include <linux/types.h>
31 #include <linux/scatterlist.h>
32 #include <linux/list.h>
33 #include <linux/timer.h>
34 #include <linux/workqueue.h>
35 #include <linux/completion.h>
36 #include <linux/device.h>
37 #include <linux/mod_devicetable.h>
40 #define MAX_PAGE_BUFFER_COUNT 32
41 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
45 /* Single-page buffer */
46 struct hv_page_buffer {
52 /* Multiple-page buffer */
53 struct hv_multipage_buffer {
54 /* Length and Offset determines the # of pfns in the array */
57 u64 pfn_array[MAX_MULTIPAGE_BUFFER_COUNT];
60 /* 0x18 includes the proprietary packet header */
61 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
62 (sizeof(struct hv_page_buffer) * \
63 MAX_PAGE_BUFFER_COUNT))
64 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
65 sizeof(struct hv_multipage_buffer))
70 struct hv_ring_buffer {
71 /* Offset in bytes from the start of ring data below */
74 /* Offset in bytes from the start of ring data below */
80 * Win8 uses some of the reserved bits to implement
81 * interrupt driven flow management. On the send side
82 * we can request that the receiver interrupt the sender
83 * when the ring transitions from being full to being able
84 * to handle a message of size "pending_send_sz".
86 * Add necessary state for this enhancement.
94 u32 feat_pending_send_sz:1;
99 /* Pad it to PAGE_SIZE so that data starts on page boundary */
103 * Ring data starts here + RingDataStartOffset
104 * !!! DO NOT place any fields below this !!!
109 struct hv_ring_buffer_info {
110 struct hv_ring_buffer *ring_buffer;
111 u32 ring_size; /* Include the shared header */
112 spinlock_t ring_lock;
114 u32 ring_datasize; /* < ring_size */
115 u32 ring_data_startoffset;
120 * hv_get_ringbuffer_availbytes()
122 * Get number of bytes available to read and to write to
123 * for the specified ring buffer
126 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info *rbi,
127 u32 *read, u32 *write)
129 u32 read_loc, write_loc, dsize;
131 smp_read_barrier_depends();
133 /* Capture the read/write indices before they changed */
134 read_loc = rbi->ring_buffer->read_index;
135 write_loc = rbi->ring_buffer->write_index;
136 dsize = rbi->ring_datasize;
138 *write = write_loc >= read_loc ? dsize - (write_loc - read_loc) :
139 read_loc - write_loc;
140 *read = dsize - *write;
144 * VMBUS version is 32 bit entity broken up into
145 * two 16 bit quantities: major_number. minor_number.
147 * 0 . 13 (Windows Server 2008)
152 #define VERSION_WS2008 ((0 << 16) | (13))
153 #define VERSION_WIN7 ((1 << 16) | (1))
154 #define VERSION_WIN8 ((2 << 16) | (4))
156 #define VERSION_INVAL -1
158 #define VERSION_CURRENT VERSION_WIN8
160 /* Make maximum size of pipe payload of 16K */
161 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
163 /* Define PipeMode values. */
164 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
165 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
167 /* The size of the user defined data buffer for non-pipe offers. */
168 #define MAX_USER_DEFINED_BYTES 120
170 /* The size of the user defined data buffer for pipe offers. */
171 #define MAX_PIPE_USER_DEFINED_BYTES 116
174 * At the center of the Channel Management library is the Channel Offer. This
175 * struct contains the fundamental information about an offer.
177 struct vmbus_channel_offer {
182 * These two fields are not currently used.
188 u16 mmio_megabytes; /* in bytes * 1024 * 1024 */
191 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
193 unsigned char user_def[MAX_USER_DEFINED_BYTES];
198 * The following sructure is an integrated pipe protocol, which
199 * is implemented on top of standard user-defined data. Pipe
200 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
205 unsigned char user_def[MAX_PIPE_USER_DEFINED_BYTES];
209 * The sub_channel_index is defined in win8.
211 u16 sub_channel_index;
216 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
217 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
218 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
219 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
220 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
221 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
222 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
224 struct vmpacket_descriptor {
232 struct vmpacket_header {
233 u32 prev_pkt_start_offset;
234 struct vmpacket_descriptor descriptor;
237 struct vmtransfer_page_range {
242 struct vmtransfer_page_packet_header {
243 struct vmpacket_descriptor d;
248 struct vmtransfer_page_range ranges[1];
251 struct vmgpadl_packet_header {
252 struct vmpacket_descriptor d;
257 struct vmadd_remove_transfer_page_set {
258 struct vmpacket_descriptor d;
265 * This structure defines a range in guest physical space that can be made to
266 * look virtually contiguous.
275 * This is the format for an Establish Gpadl packet, which contains a handle by
276 * which this GPADL will be known and a set of GPA ranges associated with it.
277 * This can be converted to a MDL by the guest OS. If there are multiple GPA
278 * ranges, then the resulting MDL will be "chained," representing multiple VA
281 struct vmestablish_gpadl {
282 struct vmpacket_descriptor d;
285 struct gpa_range range[1];
289 * This is the format for a Teardown Gpadl packet, which indicates that the
290 * GPADL handle in the Establish Gpadl packet will never be referenced again.
292 struct vmteardown_gpadl {
293 struct vmpacket_descriptor d;
295 u32 reserved; /* for alignment to a 8-byte boundary */
299 * This is the format for a GPA-Direct packet, which contains a set of GPA
300 * ranges, in addition to commands and/or data.
302 struct vmdata_gpa_direct {
303 struct vmpacket_descriptor d;
306 struct gpa_range range[1];
309 /* This is the format for a Additional Data Packet. */
310 struct vmadditional_data {
311 struct vmpacket_descriptor d;
315 unsigned char data[1];
318 union vmpacket_largest_possible_header {
319 struct vmpacket_descriptor simple_hdr;
320 struct vmtransfer_page_packet_header xfer_page_hdr;
321 struct vmgpadl_packet_header gpadl_hdr;
322 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr;
323 struct vmestablish_gpadl establish_gpadl_hdr;
324 struct vmteardown_gpadl teardown_gpadl_hdr;
325 struct vmdata_gpa_direct data_gpa_direct_hdr;
328 #define VMPACKET_DATA_START_ADDRESS(__packet) \
329 (void *)(((unsigned char *)__packet) + \
330 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
332 #define VMPACKET_DATA_LENGTH(__packet) \
333 ((((struct vmpacket_descriptor)__packet)->len8 - \
334 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
336 #define VMPACKET_TRANSFER_MODE(__packet) \
337 (((struct IMPACT)__packet)->type)
339 enum vmbus_packet_type {
340 VM_PKT_INVALID = 0x0,
342 VM_PKT_ADD_XFER_PAGESET = 0x2,
343 VM_PKT_RM_XFER_PAGESET = 0x3,
344 VM_PKT_ESTABLISH_GPADL = 0x4,
345 VM_PKT_TEARDOWN_GPADL = 0x5,
346 VM_PKT_DATA_INBAND = 0x6,
347 VM_PKT_DATA_USING_XFER_PAGES = 0x7,
348 VM_PKT_DATA_USING_GPADL = 0x8,
349 VM_PKT_DATA_USING_GPA_DIRECT = 0x9,
350 VM_PKT_CANCEL_REQUEST = 0xa,
352 VM_PKT_DATA_USING_ADDITIONAL_PKT = 0xc,
353 VM_PKT_ADDITIONAL_DATA = 0xd
356 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
359 /* Version 1 messages */
360 enum vmbus_channel_message_type {
361 CHANNELMSG_INVALID = 0,
362 CHANNELMSG_OFFERCHANNEL = 1,
363 CHANNELMSG_RESCIND_CHANNELOFFER = 2,
364 CHANNELMSG_REQUESTOFFERS = 3,
365 CHANNELMSG_ALLOFFERS_DELIVERED = 4,
366 CHANNELMSG_OPENCHANNEL = 5,
367 CHANNELMSG_OPENCHANNEL_RESULT = 6,
368 CHANNELMSG_CLOSECHANNEL = 7,
369 CHANNELMSG_GPADL_HEADER = 8,
370 CHANNELMSG_GPADL_BODY = 9,
371 CHANNELMSG_GPADL_CREATED = 10,
372 CHANNELMSG_GPADL_TEARDOWN = 11,
373 CHANNELMSG_GPADL_TORNDOWN = 12,
374 CHANNELMSG_RELID_RELEASED = 13,
375 CHANNELMSG_INITIATE_CONTACT = 14,
376 CHANNELMSG_VERSION_RESPONSE = 15,
377 CHANNELMSG_UNLOAD = 16,
378 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
379 CHANNELMSG_VIEWRANGE_ADD = 17,
380 CHANNELMSG_VIEWRANGE_REMOVE = 18,
385 struct vmbus_channel_message_header {
386 enum vmbus_channel_message_type msgtype;
390 /* Query VMBus Version parameters */
391 struct vmbus_channel_query_vmbus_version {
392 struct vmbus_channel_message_header header;
396 /* VMBus Version Supported parameters */
397 struct vmbus_channel_version_supported {
398 struct vmbus_channel_message_header header;
399 u8 version_supported;
402 /* Offer Channel parameters */
403 struct vmbus_channel_offer_channel {
404 struct vmbus_channel_message_header header;
405 struct vmbus_channel_offer offer;
409 * win7 and beyond splits this field into a bit field.
411 u8 monitor_allocated:1;
414 * These are new fields added in win7 and later.
415 * Do not access these fields without checking the
416 * negotiated protocol.
418 * If "is_dedicated_interrupt" is set, we must not set the
419 * associated bit in the channel bitmap while sending the
420 * interrupt to the host.
422 * connection_id is to be used in signaling the host.
424 u16 is_dedicated_interrupt:1;
429 /* Rescind Offer parameters */
430 struct vmbus_channel_rescind_offer {
431 struct vmbus_channel_message_header header;
436 * Request Offer -- no parameters, SynIC message contains the partition ID
437 * Set Snoop -- no parameters, SynIC message contains the partition ID
438 * Clear Snoop -- no parameters, SynIC message contains the partition ID
439 * All Offers Delivered -- no parameters, SynIC message contains the partition
441 * Flush Client -- no parameters, SynIC message contains the partition ID
444 /* Open Channel parameters */
445 struct vmbus_channel_open_channel {
446 struct vmbus_channel_message_header header;
448 /* Identifies the specific VMBus channel that is being opened. */
451 /* ID making a particular open request at a channel offer unique. */
454 /* GPADL for the channel's ring buffer. */
455 u32 ringbuffer_gpadlhandle;
458 * Starting with win8, this field will be used to specify
459 * the target virtual processor on which to deliver the interrupt for
460 * the host to guest communication.
461 * Prior to win8, incoming channel interrupts would only
462 * be delivered on cpu 0. Setting this value to 0 would
463 * preserve the earlier behavior.
468 * The upstream ring buffer begins at offset zero in the memory
469 * described by RingBufferGpadlHandle. The downstream ring buffer
470 * follows it at this offset (in pages).
472 u32 downstream_ringbuffer_pageoffset;
474 /* User-specific data to be passed along to the server endpoint. */
475 unsigned char userdata[MAX_USER_DEFINED_BYTES];
478 /* Open Channel Result parameters */
479 struct vmbus_channel_open_result {
480 struct vmbus_channel_message_header header;
486 /* Close channel parameters; */
487 struct vmbus_channel_close_channel {
488 struct vmbus_channel_message_header header;
492 /* Channel Message GPADL */
493 #define GPADL_TYPE_RING_BUFFER 1
494 #define GPADL_TYPE_SERVER_SAVE_AREA 2
495 #define GPADL_TYPE_TRANSACTION 8
498 * The number of PFNs in a GPADL message is defined by the number of
499 * pages that would be spanned by ByteCount and ByteOffset. If the
500 * implied number of PFNs won't fit in this packet, there will be a
501 * follow-up packet that contains more.
503 struct vmbus_channel_gpadl_header {
504 struct vmbus_channel_message_header header;
509 struct gpa_range range[0];
512 /* This is the followup packet that contains more PFNs. */
513 struct vmbus_channel_gpadl_body {
514 struct vmbus_channel_message_header header;
520 struct vmbus_channel_gpadl_created {
521 struct vmbus_channel_message_header header;
527 struct vmbus_channel_gpadl_teardown {
528 struct vmbus_channel_message_header header;
533 struct vmbus_channel_gpadl_torndown {
534 struct vmbus_channel_message_header header;
538 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
539 struct vmbus_channel_view_range_add {
540 struct vmbus_channel_message_header header;
541 PHYSICAL_ADDRESS viewrange_base;
542 u64 viewrange_length;
546 struct vmbus_channel_view_range_remove {
547 struct vmbus_channel_message_header header;
548 PHYSICAL_ADDRESS viewrange_base;
553 struct vmbus_channel_relid_released {
554 struct vmbus_channel_message_header header;
558 struct vmbus_channel_initiate_contact {
559 struct vmbus_channel_message_header header;
560 u32 vmbus_version_requested;
561 u32 target_vcpu; /* The VCPU the host should respond to */
567 struct vmbus_channel_version_response {
568 struct vmbus_channel_message_header header;
569 u8 version_supported;
572 enum vmbus_channel_state {
574 CHANNEL_OPENING_STATE,
576 CHANNEL_OPENED_STATE,
580 * Represents each channel msg on the vmbus connection This is a
581 * variable-size data structure depending on the msg type itself
583 struct vmbus_channel_msginfo {
584 /* Bookkeeping stuff */
585 struct list_head msglistentry;
587 /* So far, this is only used to handle gpadl body message */
588 struct list_head submsglist;
590 /* Synchronize the request/response if needed */
591 struct completion waitevent;
593 struct vmbus_channel_version_supported version_supported;
594 struct vmbus_channel_open_result open_result;
595 struct vmbus_channel_gpadl_torndown gpadl_torndown;
596 struct vmbus_channel_gpadl_created gpadl_created;
597 struct vmbus_channel_version_response version_response;
602 * The channel message that goes out on the "wire".
603 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
605 unsigned char msg[0];
608 struct vmbus_close_msg {
609 struct vmbus_channel_msginfo info;
610 struct vmbus_channel_close_channel msg;
613 /* Define connection identifier type. */
614 union hv_connection_id {
622 /* Definition of the hv_signal_event hypercall input structure. */
623 struct hv_input_signal_event {
624 union hv_connection_id connectionid;
629 struct hv_input_signal_event_buffer {
631 struct hv_input_signal_event event;
634 struct vmbus_channel {
635 struct list_head listentry;
637 struct hv_device *device_obj;
639 struct work_struct work;
641 enum vmbus_channel_state state;
643 struct vmbus_channel_offer_channel offermsg;
645 * These are based on the OfferMsg.MonitorId.
646 * Save it here for easy access.
651 u32 ringbuffer_gpadlhandle;
653 /* Allocated memory for ring buffer */
654 void *ringbuffer_pages;
655 u32 ringbuffer_pagecount;
656 struct hv_ring_buffer_info outbound; /* send to parent */
657 struct hv_ring_buffer_info inbound; /* receive from parent */
658 spinlock_t inbound_lock;
659 struct workqueue_struct *controlwq;
661 struct vmbus_close_msg close_msg;
663 /* Channel callback are invoked in this workqueue context */
664 /* HANDLE dataWorkQueue; */
666 void (*onchannel_callback)(void *context);
667 void *channel_callback_context;
670 * A channel can be marked for efficient (batched)
672 * If batched_reading is set to "true", we read until the
673 * channel is empty and hold off interrupts from the host
674 * during the entire read process.
675 * If batched_reading is set to "false", the client is not
676 * going to perform batched reading.
678 * By default we will enable batched reading; specific
679 * drivers that don't want this behavior can turn it off.
682 bool batched_reading;
684 bool is_dedicated_interrupt;
685 struct hv_input_signal_event_buffer sig_buf;
686 struct hv_input_signal_event *sig_event;
689 * Starting with win8, this field will be used to specify
690 * the target virtual processor on which to deliver the interrupt for
691 * the host to guest communication.
692 * Prior to win8, incoming channel interrupts would only
693 * be delivered on cpu 0. Setting this value to 0 would
694 * preserve the earlier behavior.
698 * Support for sub-channels. For high performance devices,
699 * it will be useful to have multiple sub-channels to support
700 * a scalable communication infrastructure with the host.
701 * The support for sub-channels is implemented as an extention
702 * to the current infrastructure.
703 * The initial offer is considered the primary channel and this
704 * offer message will indicate if the host supports sub-channels.
705 * The guest is free to ask for sub-channels to be offerred and can
706 * open these sub-channels as a normal "primary" channel. However,
707 * all sub-channels will have the same type and instance guids as the
708 * primary channel. Requests sent on a given channel will result in a
709 * response on the same channel.
713 * Sub-channel creation callback. This callback will be called in
714 * process context when a sub-channel offer is received from the host.
715 * The guest can open the sub-channel in the context of this callback.
717 void (*sc_creation_callback)(struct vmbus_channel *new_sc);
721 * All Sub-channels of a primary channel are linked here.
723 struct list_head sc_list;
725 * The primary channel this sub-channel belongs to.
726 * This will be NULL for the primary channel.
728 struct vmbus_channel *primary_channel;
730 * Support per-channel state for use by vmbus drivers.
732 void *per_channel_state;
735 static inline void set_channel_read_state(struct vmbus_channel *c, bool state)
737 c->batched_reading = state;
740 static inline void set_per_channel_state(struct vmbus_channel *c, void *s)
742 c->per_channel_state = s;
745 static inline void *get_per_channel_state(struct vmbus_channel *c)
747 return c->per_channel_state;
750 void vmbus_onmessage(void *context);
752 int vmbus_request_offers(void);
755 * APIs for managing sub-channels.
758 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel,
759 void (*sc_cr_cb)(struct vmbus_channel *new_sc));
762 * Retrieve the (sub) channel on which to send an outgoing request.
763 * When a primary channel has multiple sub-channels, we choose a
764 * channel whose VCPU binding is closest to the VCPU on which
765 * this call is being made.
767 struct vmbus_channel *vmbus_get_outgoing_channel(struct vmbus_channel *primary);
770 * Check if sub-channels have already been offerred. This API will be useful
771 * when the driver is unloaded after establishing sub-channels. In this case,
772 * when the driver is re-loaded, the driver would have to check if the
773 * subchannels have already been established before attempting to request
774 * the creation of sub-channels.
775 * This function returns TRUE to indicate that subchannels have already been
777 * This function should be invoked after setting the callback function for
778 * sub-channel creation.
780 bool vmbus_are_subchannels_present(struct vmbus_channel *primary);
782 /* The format must be the same as struct vmdata_gpa_direct */
783 struct vmbus_channel_packet_page_buffer {
791 struct hv_page_buffer range[MAX_PAGE_BUFFER_COUNT];
794 /* The format must be the same as struct vmdata_gpa_direct */
795 struct vmbus_channel_packet_multipage_buffer {
802 u32 rangecount; /* Always 1 in this case */
803 struct hv_multipage_buffer range;
807 extern int vmbus_open(struct vmbus_channel *channel,
808 u32 send_ringbuffersize,
809 u32 recv_ringbuffersize,
812 void(*onchannel_callback)(void *context),
815 extern void vmbus_close(struct vmbus_channel *channel);
817 extern int vmbus_sendpacket(struct vmbus_channel *channel,
821 enum vmbus_packet_type type,
824 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel *channel,
825 struct hv_page_buffer pagebuffers[],
831 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel *channel,
832 struct hv_multipage_buffer *mpb,
837 extern int vmbus_establish_gpadl(struct vmbus_channel *channel,
842 extern int vmbus_teardown_gpadl(struct vmbus_channel *channel,
845 extern int vmbus_recvpacket(struct vmbus_channel *channel,
848 u32 *buffer_actual_len,
851 extern int vmbus_recvpacket_raw(struct vmbus_channel *channel,
854 u32 *buffer_actual_len,
858 extern void vmbus_ontimer(unsigned long data);
860 /* Base driver object */
864 /* the device type supported by this driver */
866 const struct hv_vmbus_device_id *id_table;
868 struct device_driver driver;
870 int (*probe)(struct hv_device *, const struct hv_vmbus_device_id *);
871 int (*remove)(struct hv_device *);
872 void (*shutdown)(struct hv_device *);
876 /* Base device object */
878 /* the device type id of this device */
881 /* the device instance id of this device */
882 uuid_le dev_instance;
884 struct device device;
886 struct vmbus_channel *channel;
890 static inline struct hv_device *device_to_hv_device(struct device *d)
892 return container_of(d, struct hv_device, device);
895 static inline struct hv_driver *drv_to_hv_drv(struct device_driver *d)
897 return container_of(d, struct hv_driver, driver);
900 static inline void hv_set_drvdata(struct hv_device *dev, void *data)
902 dev_set_drvdata(&dev->device, data);
905 static inline void *hv_get_drvdata(struct hv_device *dev)
907 return dev_get_drvdata(&dev->device);
910 /* Vmbus interface */
911 #define vmbus_driver_register(driver) \
912 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
913 int __must_check __vmbus_driver_register(struct hv_driver *hv_driver,
914 struct module *owner,
915 const char *mod_name);
916 void vmbus_driver_unregister(struct hv_driver *hv_driver);
919 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
921 * This macro is used to create a struct hv_vmbus_device_id that matches a
924 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \
925 g8, g9, ga, gb, gc, gd, ge, gf) \
926 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \
927 g8, g9, ga, gb, gc, gd, ge, gf },
930 * GUID definitions of various offer types - services offered to the guest.
935 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
937 #define HV_NIC_GUID \
939 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \
940 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \
945 * {32412632-86cb-44a2-9b5c-50d1417354f5}
947 #define HV_IDE_GUID \
949 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
950 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \
955 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
957 #define HV_SCSI_GUID \
959 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
960 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \
965 * {0e0b6031-5213-4934-818b-38d90ced39db}
967 #define HV_SHUTDOWN_GUID \
969 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \
970 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \
975 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
979 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \
980 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \
985 * {57164f39-9115-4e78-ab55-382f3bd5422d}
987 #define HV_HEART_BEAT_GUID \
989 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \
990 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \
995 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
997 #define HV_KVP_GUID \
999 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \
1000 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \
1004 * Dynamic memory GUID
1005 * {525074dc-8985-46e2-8057-a307dc18a502}
1007 #define HV_DM_GUID \
1009 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \
1010 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \
1015 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1017 #define HV_MOUSE_GUID \
1019 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \
1020 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \
1024 * VSS (Backup/Restore) GUID
1026 #define HV_VSS_GUID \
1028 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \
1029 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \
1032 * Synthetic Video GUID
1033 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1035 #define HV_SYNTHVID_GUID \
1037 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \
1038 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \
1043 * {2f9bcc4a-0069-4af3-b76b-6fd0be528cda}
1045 #define HV_SYNTHFC_GUID \
1047 0x4A, 0xCC, 0x9B, 0x2F, 0x69, 0x00, 0xF3, 0x4A, \
1048 0xB7, 0x6B, 0x6F, 0xD0, 0xBE, 0x52, 0x8C, 0xDA \
1052 * Guest File Copy Service
1053 * {34D14BE3-DEE4-41c8-9AE7-6B174977C192}
1056 #define HV_FCOPY_GUID \
1058 0xE3, 0x4B, 0xD1, 0x34, 0xE4, 0xDE, 0xC8, 0x41, \
1059 0x9A, 0xE7, 0x6B, 0x17, 0x49, 0x77, 0xC1, 0x92 \
1063 * Common header for Hyper-V ICs
1066 #define ICMSGTYPE_NEGOTIATE 0
1067 #define ICMSGTYPE_HEARTBEAT 1
1068 #define ICMSGTYPE_KVPEXCHANGE 2
1069 #define ICMSGTYPE_SHUTDOWN 3
1070 #define ICMSGTYPE_TIMESYNC 4
1071 #define ICMSGTYPE_VSS 5
1073 #define ICMSGHDRFLAG_TRANSACTION 1
1074 #define ICMSGHDRFLAG_REQUEST 2
1075 #define ICMSGHDRFLAG_RESPONSE 4
1079 * While we want to handle util services as regular devices,
1080 * there is only one instance of each of these services; so
1081 * we statically allocate the service specific state.
1084 struct hv_util_service {
1086 void (*util_cb)(void *);
1087 int (*util_init)(struct hv_util_service *);
1088 void (*util_deinit)(void);
1091 struct vmbuspipe_hdr {
1102 struct ic_version icverframe;
1104 struct ic_version icvermsg;
1107 u8 ictransaction_id;
1112 struct icmsg_negotiate {
1116 struct ic_version icversion_data[1]; /* any size array */
1119 struct shutdown_msg_data {
1121 u32 timeout_seconds;
1123 u8 display_message[2048];
1126 struct heartbeat_msg_data {
1131 /* Time Sync IC defs */
1132 #define ICTIMESYNCFLAG_PROBE 0
1133 #define ICTIMESYNCFLAG_SYNC 1
1134 #define ICTIMESYNCFLAG_SAMPLE 2
1137 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1139 #define WLTIMEDELTA 116444736000000000LL
1142 struct ictimesync_data {
1149 struct hyperv_service_callback {
1153 struct vmbus_channel *channel;
1154 void (*callback) (void *context);
1157 #define MAX_SRV_VER 0x7ffffff
1158 extern bool vmbus_prep_negotiate_resp(struct icmsg_hdr *,
1159 struct icmsg_negotiate *, u8 *, int,
1162 int hv_kvp_init(struct hv_util_service *);
1163 void hv_kvp_deinit(void);
1164 void hv_kvp_onchannelcallback(void *);
1166 int hv_vss_init(struct hv_util_service *);
1167 void hv_vss_deinit(void);
1168 void hv_vss_onchannelcallback(void *);
1170 extern struct resource hyperv_mmio;
1173 * Negotiated version with the Host.
1176 extern __u32 vmbus_proto_version;
1178 #endif /* _HYPERV_H */