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>
29 #include <uapi/asm/hyperv.h>
31 #include <linux/types.h>
32 #include <linux/scatterlist.h>
33 #include <linux/list.h>
34 #include <linux/timer.h>
35 #include <linux/workqueue.h>
36 #include <linux/completion.h>
37 #include <linux/device.h>
38 #include <linux/mod_devicetable.h>
41 #define MAX_PAGE_BUFFER_COUNT 32
42 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
46 /* Single-page buffer */
47 struct hv_page_buffer {
53 /* Multiple-page buffer */
54 struct hv_multipage_buffer {
55 /* Length and Offset determines the # of pfns in the array */
58 u64 pfn_array[MAX_MULTIPAGE_BUFFER_COUNT];
62 * Multiple-page buffer array; the pfn array is variable size:
63 * The number of entries in the PFN array is determined by
67 /* Length and Offset determines the # of pfns in the array */
73 /* 0x18 includes the proprietary packet header */
74 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
75 (sizeof(struct hv_page_buffer) * \
76 MAX_PAGE_BUFFER_COUNT))
77 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
78 sizeof(struct hv_multipage_buffer))
83 struct hv_ring_buffer {
84 /* Offset in bytes from the start of ring data below */
87 /* Offset in bytes from the start of ring data below */
93 * Win8 uses some of the reserved bits to implement
94 * interrupt driven flow management. On the send side
95 * we can request that the receiver interrupt the sender
96 * when the ring transitions from being full to being able
97 * to handle a message of size "pending_send_sz".
99 * Add necessary state for this enhancement.
107 u32 feat_pending_send_sz:1;
112 /* Pad it to PAGE_SIZE so that data starts on page boundary */
116 * Ring data starts here + RingDataStartOffset
117 * !!! DO NOT place any fields below this !!!
122 struct hv_ring_buffer_info {
123 struct hv_ring_buffer *ring_buffer;
124 u32 ring_size; /* Include the shared header */
125 spinlock_t ring_lock;
127 u32 ring_datasize; /* < ring_size */
128 u32 ring_data_startoffset;
133 * hv_get_ringbuffer_availbytes()
135 * Get number of bytes available to read and to write to
136 * for the specified ring buffer
139 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info *rbi,
140 u32 *read, u32 *write)
142 u32 read_loc, write_loc, dsize;
144 /* Capture the read/write indices before they changed */
145 read_loc = rbi->ring_buffer->read_index;
146 write_loc = rbi->ring_buffer->write_index;
147 dsize = rbi->ring_datasize;
149 *write = write_loc >= read_loc ? dsize - (write_loc - read_loc) :
150 read_loc - write_loc;
151 *read = dsize - *write;
155 * VMBUS version is 32 bit entity broken up into
156 * two 16 bit quantities: major_number. minor_number.
158 * 0 . 13 (Windows Server 2008)
161 * 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))
169 #define VERSION_WIN10 ((4 << 16) | (0))
171 #define VERSION_INVAL -1
173 #define VERSION_CURRENT VERSION_WIN10
175 /* Make maximum size of pipe payload of 16K */
176 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
178 /* Define PipeMode values. */
179 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
180 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
182 /* The size of the user defined data buffer for non-pipe offers. */
183 #define MAX_USER_DEFINED_BYTES 120
185 /* The size of the user defined data buffer for pipe offers. */
186 #define MAX_PIPE_USER_DEFINED_BYTES 116
189 * At the center of the Channel Management library is the Channel Offer. This
190 * struct contains the fundamental information about an offer.
192 struct vmbus_channel_offer {
197 * These two fields are not currently used.
203 u16 mmio_megabytes; /* in bytes * 1024 * 1024 */
206 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
208 unsigned char user_def[MAX_USER_DEFINED_BYTES];
213 * The following sructure is an integrated pipe protocol, which
214 * is implemented on top of standard user-defined data. Pipe
215 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
220 unsigned char user_def[MAX_PIPE_USER_DEFINED_BYTES];
224 * The sub_channel_index is defined in win8.
226 u16 sub_channel_index;
231 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
232 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
233 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
234 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
235 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
236 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
237 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
238 #define VMBUS_CHANNEL_TLNPI_PROVIDER_OFFER 0x2000
240 struct vmpacket_descriptor {
248 struct vmpacket_header {
249 u32 prev_pkt_start_offset;
250 struct vmpacket_descriptor descriptor;
253 struct vmtransfer_page_range {
258 struct vmtransfer_page_packet_header {
259 struct vmpacket_descriptor d;
264 struct vmtransfer_page_range ranges[1];
267 struct vmgpadl_packet_header {
268 struct vmpacket_descriptor d;
273 struct vmadd_remove_transfer_page_set {
274 struct vmpacket_descriptor d;
281 * This structure defines a range in guest physical space that can be made to
282 * look virtually contiguous.
291 * This is the format for an Establish Gpadl packet, which contains a handle by
292 * which this GPADL will be known and a set of GPA ranges associated with it.
293 * This can be converted to a MDL by the guest OS. If there are multiple GPA
294 * ranges, then the resulting MDL will be "chained," representing multiple VA
297 struct vmestablish_gpadl {
298 struct vmpacket_descriptor d;
301 struct gpa_range range[1];
305 * This is the format for a Teardown Gpadl packet, which indicates that the
306 * GPADL handle in the Establish Gpadl packet will never be referenced again.
308 struct vmteardown_gpadl {
309 struct vmpacket_descriptor d;
311 u32 reserved; /* for alignment to a 8-byte boundary */
315 * This is the format for a GPA-Direct packet, which contains a set of GPA
316 * ranges, in addition to commands and/or data.
318 struct vmdata_gpa_direct {
319 struct vmpacket_descriptor d;
322 struct gpa_range range[1];
325 /* This is the format for a Additional Data Packet. */
326 struct vmadditional_data {
327 struct vmpacket_descriptor d;
331 unsigned char data[1];
334 union vmpacket_largest_possible_header {
335 struct vmpacket_descriptor simple_hdr;
336 struct vmtransfer_page_packet_header xfer_page_hdr;
337 struct vmgpadl_packet_header gpadl_hdr;
338 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr;
339 struct vmestablish_gpadl establish_gpadl_hdr;
340 struct vmteardown_gpadl teardown_gpadl_hdr;
341 struct vmdata_gpa_direct data_gpa_direct_hdr;
344 #define VMPACKET_DATA_START_ADDRESS(__packet) \
345 (void *)(((unsigned char *)__packet) + \
346 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
348 #define VMPACKET_DATA_LENGTH(__packet) \
349 ((((struct vmpacket_descriptor)__packet)->len8 - \
350 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
352 #define VMPACKET_TRANSFER_MODE(__packet) \
353 (((struct IMPACT)__packet)->type)
355 enum vmbus_packet_type {
356 VM_PKT_INVALID = 0x0,
358 VM_PKT_ADD_XFER_PAGESET = 0x2,
359 VM_PKT_RM_XFER_PAGESET = 0x3,
360 VM_PKT_ESTABLISH_GPADL = 0x4,
361 VM_PKT_TEARDOWN_GPADL = 0x5,
362 VM_PKT_DATA_INBAND = 0x6,
363 VM_PKT_DATA_USING_XFER_PAGES = 0x7,
364 VM_PKT_DATA_USING_GPADL = 0x8,
365 VM_PKT_DATA_USING_GPA_DIRECT = 0x9,
366 VM_PKT_CANCEL_REQUEST = 0xa,
368 VM_PKT_DATA_USING_ADDITIONAL_PKT = 0xc,
369 VM_PKT_ADDITIONAL_DATA = 0xd
372 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
375 /* Version 1 messages */
376 enum vmbus_channel_message_type {
377 CHANNELMSG_INVALID = 0,
378 CHANNELMSG_OFFERCHANNEL = 1,
379 CHANNELMSG_RESCIND_CHANNELOFFER = 2,
380 CHANNELMSG_REQUESTOFFERS = 3,
381 CHANNELMSG_ALLOFFERS_DELIVERED = 4,
382 CHANNELMSG_OPENCHANNEL = 5,
383 CHANNELMSG_OPENCHANNEL_RESULT = 6,
384 CHANNELMSG_CLOSECHANNEL = 7,
385 CHANNELMSG_GPADL_HEADER = 8,
386 CHANNELMSG_GPADL_BODY = 9,
387 CHANNELMSG_GPADL_CREATED = 10,
388 CHANNELMSG_GPADL_TEARDOWN = 11,
389 CHANNELMSG_GPADL_TORNDOWN = 12,
390 CHANNELMSG_RELID_RELEASED = 13,
391 CHANNELMSG_INITIATE_CONTACT = 14,
392 CHANNELMSG_VERSION_RESPONSE = 15,
393 CHANNELMSG_UNLOAD = 16,
394 CHANNELMSG_UNLOAD_RESPONSE = 17,
398 struct vmbus_channel_message_header {
399 enum vmbus_channel_message_type msgtype;
403 /* Query VMBus Version parameters */
404 struct vmbus_channel_query_vmbus_version {
405 struct vmbus_channel_message_header header;
409 /* VMBus Version Supported parameters */
410 struct vmbus_channel_version_supported {
411 struct vmbus_channel_message_header header;
412 u8 version_supported;
415 /* Offer Channel parameters */
416 struct vmbus_channel_offer_channel {
417 struct vmbus_channel_message_header header;
418 struct vmbus_channel_offer offer;
422 * win7 and beyond splits this field into a bit field.
424 u8 monitor_allocated:1;
427 * These are new fields added in win7 and later.
428 * Do not access these fields without checking the
429 * negotiated protocol.
431 * If "is_dedicated_interrupt" is set, we must not set the
432 * associated bit in the channel bitmap while sending the
433 * interrupt to the host.
435 * connection_id is to be used in signaling the host.
437 u16 is_dedicated_interrupt:1;
442 /* Rescind Offer parameters */
443 struct vmbus_channel_rescind_offer {
444 struct vmbus_channel_message_header header;
449 * Request Offer -- no parameters, SynIC message contains the partition ID
450 * Set Snoop -- no parameters, SynIC message contains the partition ID
451 * Clear Snoop -- no parameters, SynIC message contains the partition ID
452 * All Offers Delivered -- no parameters, SynIC message contains the partition
454 * Flush Client -- no parameters, SynIC message contains the partition ID
457 /* Open Channel parameters */
458 struct vmbus_channel_open_channel {
459 struct vmbus_channel_message_header header;
461 /* Identifies the specific VMBus channel that is being opened. */
464 /* ID making a particular open request at a channel offer unique. */
467 /* GPADL for the channel's ring buffer. */
468 u32 ringbuffer_gpadlhandle;
471 * Starting with win8, this field will be used to specify
472 * the target virtual processor on which to deliver the interrupt for
473 * the host to guest communication.
474 * Prior to win8, incoming channel interrupts would only
475 * be delivered on cpu 0. Setting this value to 0 would
476 * preserve the earlier behavior.
481 * The upstream ring buffer begins at offset zero in the memory
482 * described by RingBufferGpadlHandle. The downstream ring buffer
483 * follows it at this offset (in pages).
485 u32 downstream_ringbuffer_pageoffset;
487 /* User-specific data to be passed along to the server endpoint. */
488 unsigned char userdata[MAX_USER_DEFINED_BYTES];
491 /* Open Channel Result parameters */
492 struct vmbus_channel_open_result {
493 struct vmbus_channel_message_header header;
499 /* Close channel parameters; */
500 struct vmbus_channel_close_channel {
501 struct vmbus_channel_message_header header;
505 /* Channel Message GPADL */
506 #define GPADL_TYPE_RING_BUFFER 1
507 #define GPADL_TYPE_SERVER_SAVE_AREA 2
508 #define GPADL_TYPE_TRANSACTION 8
511 * The number of PFNs in a GPADL message is defined by the number of
512 * pages that would be spanned by ByteCount and ByteOffset. If the
513 * implied number of PFNs won't fit in this packet, there will be a
514 * follow-up packet that contains more.
516 struct vmbus_channel_gpadl_header {
517 struct vmbus_channel_message_header header;
522 struct gpa_range range[0];
525 /* This is the followup packet that contains more PFNs. */
526 struct vmbus_channel_gpadl_body {
527 struct vmbus_channel_message_header header;
533 struct vmbus_channel_gpadl_created {
534 struct vmbus_channel_message_header header;
540 struct vmbus_channel_gpadl_teardown {
541 struct vmbus_channel_message_header header;
546 struct vmbus_channel_gpadl_torndown {
547 struct vmbus_channel_message_header header;
551 struct vmbus_channel_relid_released {
552 struct vmbus_channel_message_header header;
556 struct vmbus_channel_initiate_contact {
557 struct vmbus_channel_message_header header;
558 u32 vmbus_version_requested;
559 u32 target_vcpu; /* The VCPU the host should respond to */
565 struct vmbus_channel_version_response {
566 struct vmbus_channel_message_header header;
567 u8 version_supported;
570 enum vmbus_channel_state {
572 CHANNEL_OPENING_STATE,
574 CHANNEL_OPENED_STATE,
578 * Represents each channel msg on the vmbus connection This is a
579 * variable-size data structure depending on the msg type itself
581 struct vmbus_channel_msginfo {
582 /* Bookkeeping stuff */
583 struct list_head msglistentry;
585 /* So far, this is only used to handle gpadl body message */
586 struct list_head submsglist;
588 /* Synchronize the request/response if needed */
589 struct completion waitevent;
591 struct vmbus_channel_version_supported version_supported;
592 struct vmbus_channel_open_result open_result;
593 struct vmbus_channel_gpadl_torndown gpadl_torndown;
594 struct vmbus_channel_gpadl_created gpadl_created;
595 struct vmbus_channel_version_response version_response;
600 * The channel message that goes out on the "wire".
601 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
603 unsigned char msg[0];
606 struct vmbus_close_msg {
607 struct vmbus_channel_msginfo info;
608 struct vmbus_channel_close_channel msg;
611 /* Define connection identifier type. */
612 union hv_connection_id {
620 /* Definition of the hv_signal_event hypercall input structure. */
621 struct hv_input_signal_event {
622 union hv_connection_id connectionid;
627 struct hv_input_signal_event_buffer {
629 struct hv_input_signal_event event;
632 enum hv_signal_policy {
633 HV_SIGNAL_POLICY_DEFAULT = 0,
634 HV_SIGNAL_POLICY_EXPLICIT,
637 enum vmbus_device_type {
657 struct vmbus_device {
663 struct vmbus_channel {
664 /* Unique channel id */
667 struct list_head listentry;
669 struct hv_device *device_obj;
671 enum vmbus_channel_state state;
673 struct vmbus_channel_offer_channel offermsg;
675 * These are based on the OfferMsg.MonitorId.
676 * Save it here for easy access.
681 bool rescind; /* got rescind msg */
683 u32 ringbuffer_gpadlhandle;
685 /* Allocated memory for ring buffer */
686 void *ringbuffer_pages;
687 u32 ringbuffer_pagecount;
688 struct hv_ring_buffer_info outbound; /* send to parent */
689 struct hv_ring_buffer_info inbound; /* receive from parent */
690 spinlock_t inbound_lock;
692 struct vmbus_close_msg close_msg;
694 /* Channel callback are invoked in this workqueue context */
695 /* HANDLE dataWorkQueue; */
697 void (*onchannel_callback)(void *context);
698 void *channel_callback_context;
701 * A channel can be marked for efficient (batched)
703 * If batched_reading is set to "true", we read until the
704 * channel is empty and hold off interrupts from the host
705 * during the entire read process.
706 * If batched_reading is set to "false", the client is not
707 * going to perform batched reading.
709 * By default we will enable batched reading; specific
710 * drivers that don't want this behavior can turn it off.
713 bool batched_reading;
715 bool is_dedicated_interrupt;
716 struct hv_input_signal_event_buffer sig_buf;
717 struct hv_input_signal_event *sig_event;
720 * Starting with win8, this field will be used to specify
721 * the target virtual processor on which to deliver the interrupt for
722 * the host to guest communication.
723 * Prior to win8, incoming channel interrupts would only
724 * be delivered on cpu 0. Setting this value to 0 would
725 * preserve the earlier behavior.
728 /* The corresponding CPUID in the guest */
731 * State to manage the CPU affiliation of channels.
733 struct cpumask alloced_cpus_in_node;
736 * Support for sub-channels. For high performance devices,
737 * it will be useful to have multiple sub-channels to support
738 * a scalable communication infrastructure with the host.
739 * The support for sub-channels is implemented as an extention
740 * to the current infrastructure.
741 * The initial offer is considered the primary channel and this
742 * offer message will indicate if the host supports sub-channels.
743 * The guest is free to ask for sub-channels to be offerred and can
744 * open these sub-channels as a normal "primary" channel. However,
745 * all sub-channels will have the same type and instance guids as the
746 * primary channel. Requests sent on a given channel will result in a
747 * response on the same channel.
751 * Sub-channel creation callback. This callback will be called in
752 * process context when a sub-channel offer is received from the host.
753 * The guest can open the sub-channel in the context of this callback.
755 void (*sc_creation_callback)(struct vmbus_channel *new_sc);
758 * The spinlock to protect the structure. It is being used to protect
759 * test-and-set access to various attributes of the structure as well
760 * as all sc_list operations.
764 * All Sub-channels of a primary channel are linked here.
766 struct list_head sc_list;
768 * Current number of sub-channels.
772 * Number of a sub-channel (position within sc_list) which is supposed
773 * to be used as the next outgoing channel.
777 * The primary channel this sub-channel belongs to.
778 * This will be NULL for the primary channel.
780 struct vmbus_channel *primary_channel;
782 * Support per-channel state for use by vmbus drivers.
784 void *per_channel_state;
786 * To support per-cpu lookup mapping of relid to channel,
787 * link up channels based on their CPU affinity.
789 struct list_head percpu_list;
791 * Host signaling policy: The default policy will be
792 * based on the ring buffer state. We will also support
793 * a policy where the client driver can have explicit
796 enum hv_signal_policy signal_policy;
799 static inline bool is_hvsock_channel(const struct vmbus_channel *c)
801 return !!(c->offermsg.offer.chn_flags &
802 VMBUS_CHANNEL_TLNPI_PROVIDER_OFFER);
805 static inline void set_channel_signal_state(struct vmbus_channel *c,
806 enum hv_signal_policy policy)
808 c->signal_policy = policy;
811 static inline void set_channel_read_state(struct vmbus_channel *c, bool state)
813 c->batched_reading = state;
816 static inline void set_per_channel_state(struct vmbus_channel *c, void *s)
818 c->per_channel_state = s;
821 static inline void *get_per_channel_state(struct vmbus_channel *c)
823 return c->per_channel_state;
826 static inline void set_channel_pending_send_size(struct vmbus_channel *c,
829 c->outbound.ring_buffer->pending_send_sz = size;
832 void vmbus_onmessage(void *context);
834 int vmbus_request_offers(void);
837 * APIs for managing sub-channels.
840 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel,
841 void (*sc_cr_cb)(struct vmbus_channel *new_sc));
844 * Retrieve the (sub) channel on which to send an outgoing request.
845 * When a primary channel has multiple sub-channels, we choose a
846 * channel whose VCPU binding is closest to the VCPU on which
847 * this call is being made.
849 struct vmbus_channel *vmbus_get_outgoing_channel(struct vmbus_channel *primary);
852 * Check if sub-channels have already been offerred. This API will be useful
853 * when the driver is unloaded after establishing sub-channels. In this case,
854 * when the driver is re-loaded, the driver would have to check if the
855 * subchannels have already been established before attempting to request
856 * the creation of sub-channels.
857 * This function returns TRUE to indicate that subchannels have already been
859 * This function should be invoked after setting the callback function for
860 * sub-channel creation.
862 bool vmbus_are_subchannels_present(struct vmbus_channel *primary);
864 /* The format must be the same as struct vmdata_gpa_direct */
865 struct vmbus_channel_packet_page_buffer {
873 struct hv_page_buffer range[MAX_PAGE_BUFFER_COUNT];
876 /* The format must be the same as struct vmdata_gpa_direct */
877 struct vmbus_channel_packet_multipage_buffer {
884 u32 rangecount; /* Always 1 in this case */
885 struct hv_multipage_buffer range;
888 /* The format must be the same as struct vmdata_gpa_direct */
889 struct vmbus_packet_mpb_array {
896 u32 rangecount; /* Always 1 in this case */
897 struct hv_mpb_array range;
901 extern int vmbus_open(struct vmbus_channel *channel,
902 u32 send_ringbuffersize,
903 u32 recv_ringbuffersize,
906 void(*onchannel_callback)(void *context),
909 extern void vmbus_close(struct vmbus_channel *channel);
911 extern int vmbus_sendpacket(struct vmbus_channel *channel,
915 enum vmbus_packet_type type,
918 extern int vmbus_sendpacket_ctl(struct vmbus_channel *channel,
922 enum vmbus_packet_type type,
926 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel *channel,
927 struct hv_page_buffer pagebuffers[],
933 extern int vmbus_sendpacket_pagebuffer_ctl(struct vmbus_channel *channel,
934 struct hv_page_buffer pagebuffers[],
942 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel *channel,
943 struct hv_multipage_buffer *mpb,
948 extern int vmbus_sendpacket_mpb_desc(struct vmbus_channel *channel,
949 struct vmbus_packet_mpb_array *mpb,
955 extern int vmbus_establish_gpadl(struct vmbus_channel *channel,
960 extern int vmbus_teardown_gpadl(struct vmbus_channel *channel,
963 extern int vmbus_recvpacket(struct vmbus_channel *channel,
966 u32 *buffer_actual_len,
969 extern int vmbus_recvpacket_raw(struct vmbus_channel *channel,
972 u32 *buffer_actual_len,
976 extern void vmbus_ontimer(unsigned long data);
978 /* Base driver object */
982 /* the device type supported by this driver */
984 const struct hv_vmbus_device_id *id_table;
986 struct device_driver driver;
988 int (*probe)(struct hv_device *, const struct hv_vmbus_device_id *);
989 int (*remove)(struct hv_device *);
990 void (*shutdown)(struct hv_device *);
994 /* Base device object */
996 /* the device type id of this device */
999 /* the device instance id of this device */
1000 uuid_le dev_instance;
1004 struct device device;
1006 struct vmbus_channel *channel;
1010 static inline struct hv_device *device_to_hv_device(struct device *d)
1012 return container_of(d, struct hv_device, device);
1015 static inline struct hv_driver *drv_to_hv_drv(struct device_driver *d)
1017 return container_of(d, struct hv_driver, driver);
1020 static inline void hv_set_drvdata(struct hv_device *dev, void *data)
1022 dev_set_drvdata(&dev->device, data);
1025 static inline void *hv_get_drvdata(struct hv_device *dev)
1027 return dev_get_drvdata(&dev->device);
1030 /* Vmbus interface */
1031 #define vmbus_driver_register(driver) \
1032 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
1033 int __must_check __vmbus_driver_register(struct hv_driver *hv_driver,
1034 struct module *owner,
1035 const char *mod_name);
1036 void vmbus_driver_unregister(struct hv_driver *hv_driver);
1038 int vmbus_allocate_mmio(struct resource **new, struct hv_device *device_obj,
1039 resource_size_t min, resource_size_t max,
1040 resource_size_t size, resource_size_t align,
1041 bool fb_overlap_ok);
1043 int vmbus_cpu_number_to_vp_number(int cpu_number);
1044 u64 hv_do_hypercall(u64 control, void *input, void *output);
1047 * GUID definitions of various offer types - services offered to the guest.
1052 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
1054 #define HV_NIC_GUID \
1055 .guid = UUID_LE(0xf8615163, 0xdf3e, 0x46c5, 0x91, 0x3f, \
1056 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e)
1060 * {32412632-86cb-44a2-9b5c-50d1417354f5}
1062 #define HV_IDE_GUID \
1063 .guid = UUID_LE(0x32412632, 0x86cb, 0x44a2, 0x9b, 0x5c, \
1064 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5)
1068 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
1070 #define HV_SCSI_GUID \
1071 .guid = UUID_LE(0xba6163d9, 0x04a1, 0x4d29, 0xb6, 0x05, \
1072 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f)
1076 * {0e0b6031-5213-4934-818b-38d90ced39db}
1078 #define HV_SHUTDOWN_GUID \
1079 .guid = UUID_LE(0x0e0b6031, 0x5213, 0x4934, 0x81, 0x8b, \
1080 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb)
1084 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
1086 #define HV_TS_GUID \
1087 .guid = UUID_LE(0x9527e630, 0xd0ae, 0x497b, 0xad, 0xce, \
1088 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf)
1092 * {57164f39-9115-4e78-ab55-382f3bd5422d}
1094 #define HV_HEART_BEAT_GUID \
1095 .guid = UUID_LE(0x57164f39, 0x9115, 0x4e78, 0xab, 0x55, \
1096 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d)
1100 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
1102 #define HV_KVP_GUID \
1103 .guid = UUID_LE(0xa9a0f4e7, 0x5a45, 0x4d96, 0xb8, 0x27, \
1104 0x8a, 0x84, 0x1e, 0x8c, 0x03, 0xe6)
1107 * Dynamic memory GUID
1108 * {525074dc-8985-46e2-8057-a307dc18a502}
1110 #define HV_DM_GUID \
1111 .guid = UUID_LE(0x525074dc, 0x8985, 0x46e2, 0x80, 0x57, \
1112 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02)
1116 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1118 #define HV_MOUSE_GUID \
1119 .guid = UUID_LE(0xcfa8b69e, 0x5b4a, 0x4cc0, 0xb9, 0x8b, \
1120 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a)
1124 * {f912ad6d-2b17-48ea-bd65-f927a61c7684}
1126 #define HV_KBD_GUID \
1127 .guid = UUID_LE(0xf912ad6d, 0x2b17, 0x48ea, 0xbd, 0x65, \
1128 0xf9, 0x27, 0xa6, 0x1c, 0x76, 0x84)
1131 * VSS (Backup/Restore) GUID
1133 #define HV_VSS_GUID \
1134 .guid = UUID_LE(0x35fa2e29, 0xea23, 0x4236, 0x96, 0xae, \
1135 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40)
1137 * Synthetic Video GUID
1138 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1140 #define HV_SYNTHVID_GUID \
1141 .guid = UUID_LE(0xda0a7802, 0xe377, 0x4aac, 0x8e, 0x77, \
1142 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8)
1146 * {2f9bcc4a-0069-4af3-b76b-6fd0be528cda}
1148 #define HV_SYNTHFC_GUID \
1149 .guid = UUID_LE(0x2f9bcc4a, 0x0069, 0x4af3, 0xb7, 0x6b, \
1150 0x6f, 0xd0, 0xbe, 0x52, 0x8c, 0xda)
1153 * Guest File Copy Service
1154 * {34D14BE3-DEE4-41c8-9AE7-6B174977C192}
1157 #define HV_FCOPY_GUID \
1158 .guid = UUID_LE(0x34d14be3, 0xdee4, 0x41c8, 0x9a, 0xe7, \
1159 0x6b, 0x17, 0x49, 0x77, 0xc1, 0x92)
1162 * NetworkDirect. This is the guest RDMA service.
1163 * {8c2eaf3d-32a7-4b09-ab99-bd1f1c86b501}
1165 #define HV_ND_GUID \
1166 .guid = UUID_LE(0x8c2eaf3d, 0x32a7, 0x4b09, 0xab, 0x99, \
1167 0xbd, 0x1f, 0x1c, 0x86, 0xb5, 0x01)
1170 * PCI Express Pass Through
1171 * {44C4F61D-4444-4400-9D52-802E27EDE19F}
1174 #define HV_PCIE_GUID \
1175 .guid = UUID_LE(0x44c4f61d, 0x4444, 0x4400, 0x9d, 0x52, \
1176 0x80, 0x2e, 0x27, 0xed, 0xe1, 0x9f)
1179 * Common header for Hyper-V ICs
1182 #define ICMSGTYPE_NEGOTIATE 0
1183 #define ICMSGTYPE_HEARTBEAT 1
1184 #define ICMSGTYPE_KVPEXCHANGE 2
1185 #define ICMSGTYPE_SHUTDOWN 3
1186 #define ICMSGTYPE_TIMESYNC 4
1187 #define ICMSGTYPE_VSS 5
1189 #define ICMSGHDRFLAG_TRANSACTION 1
1190 #define ICMSGHDRFLAG_REQUEST 2
1191 #define ICMSGHDRFLAG_RESPONSE 4
1195 * While we want to handle util services as regular devices,
1196 * there is only one instance of each of these services; so
1197 * we statically allocate the service specific state.
1200 struct hv_util_service {
1202 void (*util_cb)(void *);
1203 int (*util_init)(struct hv_util_service *);
1204 void (*util_deinit)(void);
1207 struct vmbuspipe_hdr {
1218 struct ic_version icverframe;
1220 struct ic_version icvermsg;
1223 u8 ictransaction_id;
1228 struct icmsg_negotiate {
1232 struct ic_version icversion_data[1]; /* any size array */
1235 struct shutdown_msg_data {
1237 u32 timeout_seconds;
1239 u8 display_message[2048];
1242 struct heartbeat_msg_data {
1247 /* Time Sync IC defs */
1248 #define ICTIMESYNCFLAG_PROBE 0
1249 #define ICTIMESYNCFLAG_SYNC 1
1250 #define ICTIMESYNCFLAG_SAMPLE 2
1253 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1255 #define WLTIMEDELTA 116444736000000000LL
1258 struct ictimesync_data {
1265 struct hyperv_service_callback {
1269 struct vmbus_channel *channel;
1270 void (*callback) (void *context);
1273 #define MAX_SRV_VER 0x7ffffff
1274 extern bool vmbus_prep_negotiate_resp(struct icmsg_hdr *,
1275 struct icmsg_negotiate *, u8 *, int,
1278 void hv_process_channel_removal(struct vmbus_channel *channel, u32 relid);
1281 * Negotiated version with the Host.
1284 extern __u32 vmbus_proto_version;
1286 #endif /* _HYPERV_H */