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];
61 * Multiple-page buffer array; the pfn array is variable size:
62 * The number of entries in the PFN array is determined by
66 /* Length and Offset determines the # of pfns in the array */
72 /* 0x18 includes the proprietary packet header */
73 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
74 (sizeof(struct hv_page_buffer) * \
75 MAX_PAGE_BUFFER_COUNT))
76 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
77 sizeof(struct hv_multipage_buffer))
82 struct hv_ring_buffer {
83 /* Offset in bytes from the start of ring data below */
86 /* Offset in bytes from the start of ring data below */
92 * Win8 uses some of the reserved bits to implement
93 * interrupt driven flow management. On the send side
94 * we can request that the receiver interrupt the sender
95 * when the ring transitions from being full to being able
96 * to handle a message of size "pending_send_sz".
98 * Add necessary state for this enhancement.
106 u32 feat_pending_send_sz:1;
111 /* Pad it to PAGE_SIZE so that data starts on page boundary */
115 * Ring data starts here + RingDataStartOffset
116 * !!! DO NOT place any fields below this !!!
121 struct hv_ring_buffer_info {
122 struct hv_ring_buffer *ring_buffer;
123 u32 ring_size; /* Include the shared header */
124 spinlock_t ring_lock;
126 u32 ring_datasize; /* < ring_size */
127 u32 ring_data_startoffset;
132 * hv_get_ringbuffer_availbytes()
134 * Get number of bytes available to read and to write to
135 * for the specified ring buffer
138 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info *rbi,
139 u32 *read, u32 *write)
141 u32 read_loc, write_loc, dsize;
143 smp_read_barrier_depends();
145 /* Capture the read/write indices before they changed */
146 read_loc = rbi->ring_buffer->read_index;
147 write_loc = rbi->ring_buffer->write_index;
148 dsize = rbi->ring_datasize;
150 *write = write_loc >= read_loc ? dsize - (write_loc - read_loc) :
151 read_loc - write_loc;
152 *read = dsize - *write;
156 * VMBUS version is 32 bit entity broken up into
157 * two 16 bit quantities: major_number. minor_number.
159 * 0 . 13 (Windows Server 2008)
162 * 3 . 0 (Windows 8 R2)
165 #define VERSION_WS2008 ((0 << 16) | (13))
166 #define VERSION_WIN7 ((1 << 16) | (1))
167 #define VERSION_WIN8 ((2 << 16) | (4))
168 #define VERSION_WIN8_1 ((3 << 16) | (0))
170 #define VERSION_INVAL -1
172 #define VERSION_CURRENT VERSION_WIN8_1
174 /* Make maximum size of pipe payload of 16K */
175 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
177 /* Define PipeMode values. */
178 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
179 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
181 /* The size of the user defined data buffer for non-pipe offers. */
182 #define MAX_USER_DEFINED_BYTES 120
184 /* The size of the user defined data buffer for pipe offers. */
185 #define MAX_PIPE_USER_DEFINED_BYTES 116
188 * At the center of the Channel Management library is the Channel Offer. This
189 * struct contains the fundamental information about an offer.
191 struct vmbus_channel_offer {
196 * These two fields are not currently used.
202 u16 mmio_megabytes; /* in bytes * 1024 * 1024 */
205 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
207 unsigned char user_def[MAX_USER_DEFINED_BYTES];
212 * The following sructure is an integrated pipe protocol, which
213 * is implemented on top of standard user-defined data. Pipe
214 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
219 unsigned char user_def[MAX_PIPE_USER_DEFINED_BYTES];
223 * The sub_channel_index is defined in win8.
225 u16 sub_channel_index;
230 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
231 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
232 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
233 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
234 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
235 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
236 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
238 struct vmpacket_descriptor {
246 struct vmpacket_header {
247 u32 prev_pkt_start_offset;
248 struct vmpacket_descriptor descriptor;
251 struct vmtransfer_page_range {
256 struct vmtransfer_page_packet_header {
257 struct vmpacket_descriptor d;
262 struct vmtransfer_page_range ranges[1];
265 struct vmgpadl_packet_header {
266 struct vmpacket_descriptor d;
271 struct vmadd_remove_transfer_page_set {
272 struct vmpacket_descriptor d;
279 * This structure defines a range in guest physical space that can be made to
280 * look virtually contiguous.
289 * This is the format for an Establish Gpadl packet, which contains a handle by
290 * which this GPADL will be known and a set of GPA ranges associated with it.
291 * This can be converted to a MDL by the guest OS. If there are multiple GPA
292 * ranges, then the resulting MDL will be "chained," representing multiple VA
295 struct vmestablish_gpadl {
296 struct vmpacket_descriptor d;
299 struct gpa_range range[1];
303 * This is the format for a Teardown Gpadl packet, which indicates that the
304 * GPADL handle in the Establish Gpadl packet will never be referenced again.
306 struct vmteardown_gpadl {
307 struct vmpacket_descriptor d;
309 u32 reserved; /* for alignment to a 8-byte boundary */
313 * This is the format for a GPA-Direct packet, which contains a set of GPA
314 * ranges, in addition to commands and/or data.
316 struct vmdata_gpa_direct {
317 struct vmpacket_descriptor d;
320 struct gpa_range range[1];
323 /* This is the format for a Additional Data Packet. */
324 struct vmadditional_data {
325 struct vmpacket_descriptor d;
329 unsigned char data[1];
332 union vmpacket_largest_possible_header {
333 struct vmpacket_descriptor simple_hdr;
334 struct vmtransfer_page_packet_header xfer_page_hdr;
335 struct vmgpadl_packet_header gpadl_hdr;
336 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr;
337 struct vmestablish_gpadl establish_gpadl_hdr;
338 struct vmteardown_gpadl teardown_gpadl_hdr;
339 struct vmdata_gpa_direct data_gpa_direct_hdr;
342 #define VMPACKET_DATA_START_ADDRESS(__packet) \
343 (void *)(((unsigned char *)__packet) + \
344 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
346 #define VMPACKET_DATA_LENGTH(__packet) \
347 ((((struct vmpacket_descriptor)__packet)->len8 - \
348 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
350 #define VMPACKET_TRANSFER_MODE(__packet) \
351 (((struct IMPACT)__packet)->type)
353 enum vmbus_packet_type {
354 VM_PKT_INVALID = 0x0,
356 VM_PKT_ADD_XFER_PAGESET = 0x2,
357 VM_PKT_RM_XFER_PAGESET = 0x3,
358 VM_PKT_ESTABLISH_GPADL = 0x4,
359 VM_PKT_TEARDOWN_GPADL = 0x5,
360 VM_PKT_DATA_INBAND = 0x6,
361 VM_PKT_DATA_USING_XFER_PAGES = 0x7,
362 VM_PKT_DATA_USING_GPADL = 0x8,
363 VM_PKT_DATA_USING_GPA_DIRECT = 0x9,
364 VM_PKT_CANCEL_REQUEST = 0xa,
366 VM_PKT_DATA_USING_ADDITIONAL_PKT = 0xc,
367 VM_PKT_ADDITIONAL_DATA = 0xd
370 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
373 /* Version 1 messages */
374 enum vmbus_channel_message_type {
375 CHANNELMSG_INVALID = 0,
376 CHANNELMSG_OFFERCHANNEL = 1,
377 CHANNELMSG_RESCIND_CHANNELOFFER = 2,
378 CHANNELMSG_REQUESTOFFERS = 3,
379 CHANNELMSG_ALLOFFERS_DELIVERED = 4,
380 CHANNELMSG_OPENCHANNEL = 5,
381 CHANNELMSG_OPENCHANNEL_RESULT = 6,
382 CHANNELMSG_CLOSECHANNEL = 7,
383 CHANNELMSG_GPADL_HEADER = 8,
384 CHANNELMSG_GPADL_BODY = 9,
385 CHANNELMSG_GPADL_CREATED = 10,
386 CHANNELMSG_GPADL_TEARDOWN = 11,
387 CHANNELMSG_GPADL_TORNDOWN = 12,
388 CHANNELMSG_RELID_RELEASED = 13,
389 CHANNELMSG_INITIATE_CONTACT = 14,
390 CHANNELMSG_VERSION_RESPONSE = 15,
391 CHANNELMSG_UNLOAD = 16,
392 CHANNELMSG_UNLOAD_RESPONSE = 17,
396 struct vmbus_channel_message_header {
397 enum vmbus_channel_message_type msgtype;
401 /* Query VMBus Version parameters */
402 struct vmbus_channel_query_vmbus_version {
403 struct vmbus_channel_message_header header;
407 /* VMBus Version Supported parameters */
408 struct vmbus_channel_version_supported {
409 struct vmbus_channel_message_header header;
410 u8 version_supported;
413 /* Offer Channel parameters */
414 struct vmbus_channel_offer_channel {
415 struct vmbus_channel_message_header header;
416 struct vmbus_channel_offer offer;
420 * win7 and beyond splits this field into a bit field.
422 u8 monitor_allocated:1;
425 * These are new fields added in win7 and later.
426 * Do not access these fields without checking the
427 * negotiated protocol.
429 * If "is_dedicated_interrupt" is set, we must not set the
430 * associated bit in the channel bitmap while sending the
431 * interrupt to the host.
433 * connection_id is to be used in signaling the host.
435 u16 is_dedicated_interrupt:1;
440 /* Rescind Offer parameters */
441 struct vmbus_channel_rescind_offer {
442 struct vmbus_channel_message_header header;
447 * Request Offer -- no parameters, SynIC message contains the partition ID
448 * Set Snoop -- no parameters, SynIC message contains the partition ID
449 * Clear Snoop -- no parameters, SynIC message contains the partition ID
450 * All Offers Delivered -- no parameters, SynIC message contains the partition
452 * Flush Client -- no parameters, SynIC message contains the partition ID
455 /* Open Channel parameters */
456 struct vmbus_channel_open_channel {
457 struct vmbus_channel_message_header header;
459 /* Identifies the specific VMBus channel that is being opened. */
462 /* ID making a particular open request at a channel offer unique. */
465 /* GPADL for the channel's ring buffer. */
466 u32 ringbuffer_gpadlhandle;
469 * Starting with win8, this field will be used to specify
470 * the target virtual processor on which to deliver the interrupt for
471 * the host to guest communication.
472 * Prior to win8, incoming channel interrupts would only
473 * be delivered on cpu 0. Setting this value to 0 would
474 * preserve the earlier behavior.
479 * The upstream ring buffer begins at offset zero in the memory
480 * described by RingBufferGpadlHandle. The downstream ring buffer
481 * follows it at this offset (in pages).
483 u32 downstream_ringbuffer_pageoffset;
485 /* User-specific data to be passed along to the server endpoint. */
486 unsigned char userdata[MAX_USER_DEFINED_BYTES];
489 /* Open Channel Result parameters */
490 struct vmbus_channel_open_result {
491 struct vmbus_channel_message_header header;
497 /* Close channel parameters; */
498 struct vmbus_channel_close_channel {
499 struct vmbus_channel_message_header header;
503 /* Channel Message GPADL */
504 #define GPADL_TYPE_RING_BUFFER 1
505 #define GPADL_TYPE_SERVER_SAVE_AREA 2
506 #define GPADL_TYPE_TRANSACTION 8
509 * The number of PFNs in a GPADL message is defined by the number of
510 * pages that would be spanned by ByteCount and ByteOffset. If the
511 * implied number of PFNs won't fit in this packet, there will be a
512 * follow-up packet that contains more.
514 struct vmbus_channel_gpadl_header {
515 struct vmbus_channel_message_header header;
520 struct gpa_range range[0];
523 /* This is the followup packet that contains more PFNs. */
524 struct vmbus_channel_gpadl_body {
525 struct vmbus_channel_message_header header;
531 struct vmbus_channel_gpadl_created {
532 struct vmbus_channel_message_header header;
538 struct vmbus_channel_gpadl_teardown {
539 struct vmbus_channel_message_header header;
544 struct vmbus_channel_gpadl_torndown {
545 struct vmbus_channel_message_header header;
549 struct vmbus_channel_relid_released {
550 struct vmbus_channel_message_header header;
554 struct vmbus_channel_initiate_contact {
555 struct vmbus_channel_message_header header;
556 u32 vmbus_version_requested;
557 u32 target_vcpu; /* The VCPU the host should respond to */
563 struct vmbus_channel_version_response {
564 struct vmbus_channel_message_header header;
565 u8 version_supported;
568 enum vmbus_channel_state {
570 CHANNEL_OPENING_STATE,
572 CHANNEL_OPENED_STATE,
576 * Represents each channel msg on the vmbus connection This is a
577 * variable-size data structure depending on the msg type itself
579 struct vmbus_channel_msginfo {
580 /* Bookkeeping stuff */
581 struct list_head msglistentry;
583 /* So far, this is only used to handle gpadl body message */
584 struct list_head submsglist;
586 /* Synchronize the request/response if needed */
587 struct completion waitevent;
589 struct vmbus_channel_version_supported version_supported;
590 struct vmbus_channel_open_result open_result;
591 struct vmbus_channel_gpadl_torndown gpadl_torndown;
592 struct vmbus_channel_gpadl_created gpadl_created;
593 struct vmbus_channel_version_response version_response;
598 * The channel message that goes out on the "wire".
599 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
601 unsigned char msg[0];
604 struct vmbus_close_msg {
605 struct vmbus_channel_msginfo info;
606 struct vmbus_channel_close_channel msg;
609 /* Define connection identifier type. */
610 union hv_connection_id {
618 /* Definition of the hv_signal_event hypercall input structure. */
619 struct hv_input_signal_event {
620 union hv_connection_id connectionid;
625 struct hv_input_signal_event_buffer {
627 struct hv_input_signal_event event;
630 struct vmbus_channel {
631 /* Unique channel id */
634 struct list_head listentry;
636 struct hv_device *device_obj;
638 enum vmbus_channel_state state;
640 struct vmbus_channel_offer_channel offermsg;
642 * These are based on the OfferMsg.MonitorId.
643 * Save it here for easy access.
648 bool rescind; /* got rescind msg */
650 u32 ringbuffer_gpadlhandle;
652 /* Allocated memory for ring buffer */
653 void *ringbuffer_pages;
654 u32 ringbuffer_pagecount;
655 struct hv_ring_buffer_info outbound; /* send to parent */
656 struct hv_ring_buffer_info inbound; /* receive from parent */
657 spinlock_t inbound_lock;
659 struct vmbus_close_msg close_msg;
661 /* Channel callback are invoked in this workqueue context */
662 /* HANDLE dataWorkQueue; */
664 void (*onchannel_callback)(void *context);
665 void *channel_callback_context;
668 * A channel can be marked for efficient (batched)
670 * If batched_reading is set to "true", we read until the
671 * channel is empty and hold off interrupts from the host
672 * during the entire read process.
673 * If batched_reading is set to "false", the client is not
674 * going to perform batched reading.
676 * By default we will enable batched reading; specific
677 * drivers that don't want this behavior can turn it off.
680 bool batched_reading;
682 bool is_dedicated_interrupt;
683 struct hv_input_signal_event_buffer sig_buf;
684 struct hv_input_signal_event *sig_event;
687 * Starting with win8, this field will be used to specify
688 * the target virtual processor on which to deliver the interrupt for
689 * the host to guest communication.
690 * Prior to win8, incoming channel interrupts would only
691 * be delivered on cpu 0. Setting this value to 0 would
692 * preserve the earlier behavior.
695 /* The corresponding CPUID in the guest */
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);
720 * The spinlock to protect the structure. It is being used to protect
721 * test-and-set access to various attributes of the structure as well
722 * as all sc_list operations.
726 * All Sub-channels of a primary channel are linked here.
728 struct list_head sc_list;
730 * Current number of sub-channels.
734 * Number of a sub-channel (position within sc_list) which is supposed
735 * to be used as the next outgoing channel.
739 * The primary channel this sub-channel belongs to.
740 * This will be NULL for the primary channel.
742 struct vmbus_channel *primary_channel;
744 * Support per-channel state for use by vmbus drivers.
746 void *per_channel_state;
748 * To support per-cpu lookup mapping of relid to channel,
749 * link up channels based on their CPU affinity.
751 struct list_head percpu_list;
754 static inline void set_channel_read_state(struct vmbus_channel *c, bool state)
756 c->batched_reading = state;
759 static inline void set_per_channel_state(struct vmbus_channel *c, void *s)
761 c->per_channel_state = s;
764 static inline void *get_per_channel_state(struct vmbus_channel *c)
766 return c->per_channel_state;
769 void vmbus_onmessage(void *context);
771 int vmbus_request_offers(void);
774 * APIs for managing sub-channels.
777 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel,
778 void (*sc_cr_cb)(struct vmbus_channel *new_sc));
781 * Retrieve the (sub) channel on which to send an outgoing request.
782 * When a primary channel has multiple sub-channels, we choose a
783 * channel whose VCPU binding is closest to the VCPU on which
784 * this call is being made.
786 struct vmbus_channel *vmbus_get_outgoing_channel(struct vmbus_channel *primary);
789 * Check if sub-channels have already been offerred. This API will be useful
790 * when the driver is unloaded after establishing sub-channels. In this case,
791 * when the driver is re-loaded, the driver would have to check if the
792 * subchannels have already been established before attempting to request
793 * the creation of sub-channels.
794 * This function returns TRUE to indicate that subchannels have already been
796 * This function should be invoked after setting the callback function for
797 * sub-channel creation.
799 bool vmbus_are_subchannels_present(struct vmbus_channel *primary);
801 /* The format must be the same as struct vmdata_gpa_direct */
802 struct vmbus_channel_packet_page_buffer {
810 struct hv_page_buffer range[MAX_PAGE_BUFFER_COUNT];
813 /* The format must be the same as struct vmdata_gpa_direct */
814 struct vmbus_channel_packet_multipage_buffer {
821 u32 rangecount; /* Always 1 in this case */
822 struct hv_multipage_buffer range;
825 /* The format must be the same as struct vmdata_gpa_direct */
826 struct vmbus_packet_mpb_array {
833 u32 rangecount; /* Always 1 in this case */
834 struct hv_mpb_array range;
838 extern int vmbus_open(struct vmbus_channel *channel,
839 u32 send_ringbuffersize,
840 u32 recv_ringbuffersize,
843 void(*onchannel_callback)(void *context),
846 extern void vmbus_close(struct vmbus_channel *channel);
848 extern int vmbus_sendpacket(struct vmbus_channel *channel,
852 enum vmbus_packet_type type,
855 extern int vmbus_sendpacket_ctl(struct vmbus_channel *channel,
859 enum vmbus_packet_type type,
863 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel *channel,
864 struct hv_page_buffer pagebuffers[],
870 extern int vmbus_sendpacket_pagebuffer_ctl(struct vmbus_channel *channel,
871 struct hv_page_buffer pagebuffers[],
879 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel *channel,
880 struct hv_multipage_buffer *mpb,
885 extern int vmbus_sendpacket_mpb_desc(struct vmbus_channel *channel,
886 struct vmbus_packet_mpb_array *mpb,
892 extern int vmbus_establish_gpadl(struct vmbus_channel *channel,
897 extern int vmbus_teardown_gpadl(struct vmbus_channel *channel,
900 extern int vmbus_recvpacket(struct vmbus_channel *channel,
903 u32 *buffer_actual_len,
906 extern int vmbus_recvpacket_raw(struct vmbus_channel *channel,
909 u32 *buffer_actual_len,
913 extern void vmbus_ontimer(unsigned long data);
915 /* Base driver object */
919 /* the device type supported by this driver */
921 const struct hv_vmbus_device_id *id_table;
923 struct device_driver driver;
925 int (*probe)(struct hv_device *, const struct hv_vmbus_device_id *);
926 int (*remove)(struct hv_device *);
927 void (*shutdown)(struct hv_device *);
931 /* Base device object */
933 /* the device type id of this device */
936 /* the device instance id of this device */
937 uuid_le dev_instance;
939 struct device device;
941 struct vmbus_channel *channel;
945 static inline struct hv_device *device_to_hv_device(struct device *d)
947 return container_of(d, struct hv_device, device);
950 static inline struct hv_driver *drv_to_hv_drv(struct device_driver *d)
952 return container_of(d, struct hv_driver, driver);
955 static inline void hv_set_drvdata(struct hv_device *dev, void *data)
957 dev_set_drvdata(&dev->device, data);
960 static inline void *hv_get_drvdata(struct hv_device *dev)
962 return dev_get_drvdata(&dev->device);
965 /* Vmbus interface */
966 #define vmbus_driver_register(driver) \
967 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
968 int __must_check __vmbus_driver_register(struct hv_driver *hv_driver,
969 struct module *owner,
970 const char *mod_name);
971 void vmbus_driver_unregister(struct hv_driver *hv_driver);
974 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
976 * This macro is used to create a struct hv_vmbus_device_id that matches a
979 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \
980 g8, g9, ga, gb, gc, gd, ge, gf) \
981 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \
982 g8, g9, ga, gb, gc, gd, ge, gf },
985 * GUID definitions of various offer types - services offered to the guest.
990 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
992 #define HV_NIC_GUID \
994 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \
995 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \
1000 * {32412632-86cb-44a2-9b5c-50d1417354f5}
1002 #define HV_IDE_GUID \
1004 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
1005 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \
1010 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
1012 #define HV_SCSI_GUID \
1014 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
1015 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \
1020 * {0e0b6031-5213-4934-818b-38d90ced39db}
1022 #define HV_SHUTDOWN_GUID \
1024 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \
1025 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \
1030 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
1032 #define HV_TS_GUID \
1034 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \
1035 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \
1040 * {57164f39-9115-4e78-ab55-382f3bd5422d}
1042 #define HV_HEART_BEAT_GUID \
1044 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \
1045 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \
1050 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
1052 #define HV_KVP_GUID \
1054 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \
1055 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \
1059 * Dynamic memory GUID
1060 * {525074dc-8985-46e2-8057-a307dc18a502}
1062 #define HV_DM_GUID \
1064 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \
1065 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \
1070 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1072 #define HV_MOUSE_GUID \
1074 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \
1075 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \
1079 * VSS (Backup/Restore) GUID
1081 #define HV_VSS_GUID \
1083 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \
1084 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \
1087 * Synthetic Video GUID
1088 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1090 #define HV_SYNTHVID_GUID \
1092 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \
1093 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \
1098 * {2f9bcc4a-0069-4af3-b76b-6fd0be528cda}
1100 #define HV_SYNTHFC_GUID \
1102 0x4A, 0xCC, 0x9B, 0x2F, 0x69, 0x00, 0xF3, 0x4A, \
1103 0xB7, 0x6B, 0x6F, 0xD0, 0xBE, 0x52, 0x8C, 0xDA \
1107 * Guest File Copy Service
1108 * {34D14BE3-DEE4-41c8-9AE7-6B174977C192}
1111 #define HV_FCOPY_GUID \
1113 0xE3, 0x4B, 0xD1, 0x34, 0xE4, 0xDE, 0xC8, 0x41, \
1114 0x9A, 0xE7, 0x6B, 0x17, 0x49, 0x77, 0xC1, 0x92 \
1118 * NetworkDirect. This is the guest RDMA service.
1119 * {8c2eaf3d-32a7-4b09-ab99-bd1f1c86b501}
1121 #define HV_ND_GUID \
1123 0x3d, 0xaf, 0x2e, 0x8c, 0xa7, 0x32, 0x09, 0x4b, \
1124 0xab, 0x99, 0xbd, 0x1f, 0x1c, 0x86, 0xb5, 0x01 \
1128 * Common header for Hyper-V ICs
1131 #define ICMSGTYPE_NEGOTIATE 0
1132 #define ICMSGTYPE_HEARTBEAT 1
1133 #define ICMSGTYPE_KVPEXCHANGE 2
1134 #define ICMSGTYPE_SHUTDOWN 3
1135 #define ICMSGTYPE_TIMESYNC 4
1136 #define ICMSGTYPE_VSS 5
1138 #define ICMSGHDRFLAG_TRANSACTION 1
1139 #define ICMSGHDRFLAG_REQUEST 2
1140 #define ICMSGHDRFLAG_RESPONSE 4
1144 * While we want to handle util services as regular devices,
1145 * there is only one instance of each of these services; so
1146 * we statically allocate the service specific state.
1149 struct hv_util_service {
1151 void (*util_cb)(void *);
1152 int (*util_init)(struct hv_util_service *);
1153 void (*util_deinit)(void);
1156 struct vmbuspipe_hdr {
1167 struct ic_version icverframe;
1169 struct ic_version icvermsg;
1172 u8 ictransaction_id;
1177 struct icmsg_negotiate {
1181 struct ic_version icversion_data[1]; /* any size array */
1184 struct shutdown_msg_data {
1186 u32 timeout_seconds;
1188 u8 display_message[2048];
1191 struct heartbeat_msg_data {
1196 /* Time Sync IC defs */
1197 #define ICTIMESYNCFLAG_PROBE 0
1198 #define ICTIMESYNCFLAG_SYNC 1
1199 #define ICTIMESYNCFLAG_SAMPLE 2
1202 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1204 #define WLTIMEDELTA 116444736000000000LL
1207 struct ictimesync_data {
1214 struct hyperv_service_callback {
1218 struct vmbus_channel *channel;
1219 void (*callback) (void *context);
1222 #define MAX_SRV_VER 0x7ffffff
1223 extern bool vmbus_prep_negotiate_resp(struct icmsg_hdr *,
1224 struct icmsg_negotiate *, u8 *, int,
1227 void hv_process_channel_removal(struct vmbus_channel *channel, u32 relid);
1229 extern struct resource hyperv_mmio;
1232 * Negotiated version with the Host.
1235 extern __u32 vmbus_proto_version;
1237 #endif /* _HYPERV_H */