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)
150 * 3 . 0 (Windows 8 R2)
153 #define VERSION_WS2008 ((0 << 16) | (13))
154 #define VERSION_WIN7 ((1 << 16) | (1))
155 #define VERSION_WIN8 ((2 << 16) | (4))
156 #define VERSION_WIN8_1 ((3 << 16) | (0))
158 #define VERSION_INVAL -1
160 #define VERSION_CURRENT VERSION_WIN8_1
162 /* Make maximum size of pipe payload of 16K */
163 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
165 /* Define PipeMode values. */
166 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
167 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
169 /* The size of the user defined data buffer for non-pipe offers. */
170 #define MAX_USER_DEFINED_BYTES 120
172 /* The size of the user defined data buffer for pipe offers. */
173 #define MAX_PIPE_USER_DEFINED_BYTES 116
176 * At the center of the Channel Management library is the Channel Offer. This
177 * struct contains the fundamental information about an offer.
179 struct vmbus_channel_offer
{
184 * These two fields are not currently used.
190 u16 mmio_megabytes
; /* in bytes * 1024 * 1024 */
193 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
195 unsigned char user_def
[MAX_USER_DEFINED_BYTES
];
200 * The following sructure is an integrated pipe protocol, which
201 * is implemented on top of standard user-defined data. Pipe
202 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
207 unsigned char user_def
[MAX_PIPE_USER_DEFINED_BYTES
];
211 * The sub_channel_index is defined in win8.
213 u16 sub_channel_index
;
218 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
219 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
220 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
221 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
222 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
223 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
224 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
226 struct vmpacket_descriptor
{
234 struct vmpacket_header
{
235 u32 prev_pkt_start_offset
;
236 struct vmpacket_descriptor descriptor
;
239 struct vmtransfer_page_range
{
244 struct vmtransfer_page_packet_header
{
245 struct vmpacket_descriptor d
;
250 struct vmtransfer_page_range ranges
[1];
253 struct vmgpadl_packet_header
{
254 struct vmpacket_descriptor d
;
259 struct vmadd_remove_transfer_page_set
{
260 struct vmpacket_descriptor d
;
267 * This structure defines a range in guest physical space that can be made to
268 * look virtually contiguous.
277 * This is the format for an Establish Gpadl packet, which contains a handle by
278 * which this GPADL will be known and a set of GPA ranges associated with it.
279 * This can be converted to a MDL by the guest OS. If there are multiple GPA
280 * ranges, then the resulting MDL will be "chained," representing multiple VA
283 struct vmestablish_gpadl
{
284 struct vmpacket_descriptor d
;
287 struct gpa_range range
[1];
291 * This is the format for a Teardown Gpadl packet, which indicates that the
292 * GPADL handle in the Establish Gpadl packet will never be referenced again.
294 struct vmteardown_gpadl
{
295 struct vmpacket_descriptor d
;
297 u32 reserved
; /* for alignment to a 8-byte boundary */
301 * This is the format for a GPA-Direct packet, which contains a set of GPA
302 * ranges, in addition to commands and/or data.
304 struct vmdata_gpa_direct
{
305 struct vmpacket_descriptor d
;
308 struct gpa_range range
[1];
311 /* This is the format for a Additional Data Packet. */
312 struct vmadditional_data
{
313 struct vmpacket_descriptor d
;
317 unsigned char data
[1];
320 union vmpacket_largest_possible_header
{
321 struct vmpacket_descriptor simple_hdr
;
322 struct vmtransfer_page_packet_header xfer_page_hdr
;
323 struct vmgpadl_packet_header gpadl_hdr
;
324 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr
;
325 struct vmestablish_gpadl establish_gpadl_hdr
;
326 struct vmteardown_gpadl teardown_gpadl_hdr
;
327 struct vmdata_gpa_direct data_gpa_direct_hdr
;
330 #define VMPACKET_DATA_START_ADDRESS(__packet) \
331 (void *)(((unsigned char *)__packet) + \
332 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
334 #define VMPACKET_DATA_LENGTH(__packet) \
335 ((((struct vmpacket_descriptor)__packet)->len8 - \
336 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
338 #define VMPACKET_TRANSFER_MODE(__packet) \
339 (((struct IMPACT)__packet)->type)
341 enum vmbus_packet_type
{
342 VM_PKT_INVALID
= 0x0,
344 VM_PKT_ADD_XFER_PAGESET
= 0x2,
345 VM_PKT_RM_XFER_PAGESET
= 0x3,
346 VM_PKT_ESTABLISH_GPADL
= 0x4,
347 VM_PKT_TEARDOWN_GPADL
= 0x5,
348 VM_PKT_DATA_INBAND
= 0x6,
349 VM_PKT_DATA_USING_XFER_PAGES
= 0x7,
350 VM_PKT_DATA_USING_GPADL
= 0x8,
351 VM_PKT_DATA_USING_GPA_DIRECT
= 0x9,
352 VM_PKT_CANCEL_REQUEST
= 0xa,
354 VM_PKT_DATA_USING_ADDITIONAL_PKT
= 0xc,
355 VM_PKT_ADDITIONAL_DATA
= 0xd
358 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
361 /* Version 1 messages */
362 enum vmbus_channel_message_type
{
363 CHANNELMSG_INVALID
= 0,
364 CHANNELMSG_OFFERCHANNEL
= 1,
365 CHANNELMSG_RESCIND_CHANNELOFFER
= 2,
366 CHANNELMSG_REQUESTOFFERS
= 3,
367 CHANNELMSG_ALLOFFERS_DELIVERED
= 4,
368 CHANNELMSG_OPENCHANNEL
= 5,
369 CHANNELMSG_OPENCHANNEL_RESULT
= 6,
370 CHANNELMSG_CLOSECHANNEL
= 7,
371 CHANNELMSG_GPADL_HEADER
= 8,
372 CHANNELMSG_GPADL_BODY
= 9,
373 CHANNELMSG_GPADL_CREATED
= 10,
374 CHANNELMSG_GPADL_TEARDOWN
= 11,
375 CHANNELMSG_GPADL_TORNDOWN
= 12,
376 CHANNELMSG_RELID_RELEASED
= 13,
377 CHANNELMSG_INITIATE_CONTACT
= 14,
378 CHANNELMSG_VERSION_RESPONSE
= 15,
379 CHANNELMSG_UNLOAD
= 16,
380 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
381 CHANNELMSG_VIEWRANGE_ADD
= 17,
382 CHANNELMSG_VIEWRANGE_REMOVE
= 18,
387 struct vmbus_channel_message_header
{
388 enum vmbus_channel_message_type msgtype
;
392 /* Query VMBus Version parameters */
393 struct vmbus_channel_query_vmbus_version
{
394 struct vmbus_channel_message_header header
;
398 /* VMBus Version Supported parameters */
399 struct vmbus_channel_version_supported
{
400 struct vmbus_channel_message_header header
;
401 u8 version_supported
;
404 /* Offer Channel parameters */
405 struct vmbus_channel_offer_channel
{
406 struct vmbus_channel_message_header header
;
407 struct vmbus_channel_offer offer
;
411 * win7 and beyond splits this field into a bit field.
413 u8 monitor_allocated
:1;
416 * These are new fields added in win7 and later.
417 * Do not access these fields without checking the
418 * negotiated protocol.
420 * If "is_dedicated_interrupt" is set, we must not set the
421 * associated bit in the channel bitmap while sending the
422 * interrupt to the host.
424 * connection_id is to be used in signaling the host.
426 u16 is_dedicated_interrupt
:1;
431 /* Rescind Offer parameters */
432 struct vmbus_channel_rescind_offer
{
433 struct vmbus_channel_message_header header
;
438 * Request Offer -- no parameters, SynIC message contains the partition ID
439 * Set Snoop -- no parameters, SynIC message contains the partition ID
440 * Clear Snoop -- no parameters, SynIC message contains the partition ID
441 * All Offers Delivered -- no parameters, SynIC message contains the partition
443 * Flush Client -- no parameters, SynIC message contains the partition ID
446 /* Open Channel parameters */
447 struct vmbus_channel_open_channel
{
448 struct vmbus_channel_message_header header
;
450 /* Identifies the specific VMBus channel that is being opened. */
453 /* ID making a particular open request at a channel offer unique. */
456 /* GPADL for the channel's ring buffer. */
457 u32 ringbuffer_gpadlhandle
;
460 * Starting with win8, this field will be used to specify
461 * the target virtual processor on which to deliver the interrupt for
462 * the host to guest communication.
463 * Prior to win8, incoming channel interrupts would only
464 * be delivered on cpu 0. Setting this value to 0 would
465 * preserve the earlier behavior.
470 * The upstream ring buffer begins at offset zero in the memory
471 * described by RingBufferGpadlHandle. The downstream ring buffer
472 * follows it at this offset (in pages).
474 u32 downstream_ringbuffer_pageoffset
;
476 /* User-specific data to be passed along to the server endpoint. */
477 unsigned char userdata
[MAX_USER_DEFINED_BYTES
];
480 /* Open Channel Result parameters */
481 struct vmbus_channel_open_result
{
482 struct vmbus_channel_message_header header
;
488 /* Close channel parameters; */
489 struct vmbus_channel_close_channel
{
490 struct vmbus_channel_message_header header
;
494 /* Channel Message GPADL */
495 #define GPADL_TYPE_RING_BUFFER 1
496 #define GPADL_TYPE_SERVER_SAVE_AREA 2
497 #define GPADL_TYPE_TRANSACTION 8
500 * The number of PFNs in a GPADL message is defined by the number of
501 * pages that would be spanned by ByteCount and ByteOffset. If the
502 * implied number of PFNs won't fit in this packet, there will be a
503 * follow-up packet that contains more.
505 struct vmbus_channel_gpadl_header
{
506 struct vmbus_channel_message_header header
;
511 struct gpa_range range
[0];
514 /* This is the followup packet that contains more PFNs. */
515 struct vmbus_channel_gpadl_body
{
516 struct vmbus_channel_message_header header
;
522 struct vmbus_channel_gpadl_created
{
523 struct vmbus_channel_message_header header
;
529 struct vmbus_channel_gpadl_teardown
{
530 struct vmbus_channel_message_header header
;
535 struct vmbus_channel_gpadl_torndown
{
536 struct vmbus_channel_message_header header
;
540 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
541 struct vmbus_channel_view_range_add
{
542 struct vmbus_channel_message_header header
;
543 PHYSICAL_ADDRESS viewrange_base
;
544 u64 viewrange_length
;
548 struct vmbus_channel_view_range_remove
{
549 struct vmbus_channel_message_header header
;
550 PHYSICAL_ADDRESS viewrange_base
;
555 struct vmbus_channel_relid_released
{
556 struct vmbus_channel_message_header header
;
560 struct vmbus_channel_initiate_contact
{
561 struct vmbus_channel_message_header header
;
562 u32 vmbus_version_requested
;
563 u32 target_vcpu
; /* The VCPU the host should respond to */
569 struct vmbus_channel_version_response
{
570 struct vmbus_channel_message_header header
;
571 u8 version_supported
;
574 enum vmbus_channel_state
{
576 CHANNEL_OPENING_STATE
,
578 CHANNEL_OPENED_STATE
,
582 * Represents each channel msg on the vmbus connection This is a
583 * variable-size data structure depending on the msg type itself
585 struct vmbus_channel_msginfo
{
586 /* Bookkeeping stuff */
587 struct list_head msglistentry
;
589 /* So far, this is only used to handle gpadl body message */
590 struct list_head submsglist
;
592 /* Synchronize the request/response if needed */
593 struct completion waitevent
;
595 struct vmbus_channel_version_supported version_supported
;
596 struct vmbus_channel_open_result open_result
;
597 struct vmbus_channel_gpadl_torndown gpadl_torndown
;
598 struct vmbus_channel_gpadl_created gpadl_created
;
599 struct vmbus_channel_version_response version_response
;
604 * The channel message that goes out on the "wire".
605 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
607 unsigned char msg
[0];
610 struct vmbus_close_msg
{
611 struct vmbus_channel_msginfo info
;
612 struct vmbus_channel_close_channel msg
;
615 /* Define connection identifier type. */
616 union hv_connection_id
{
624 /* Definition of the hv_signal_event hypercall input structure. */
625 struct hv_input_signal_event
{
626 union hv_connection_id connectionid
;
631 struct hv_input_signal_event_buffer
{
633 struct hv_input_signal_event event
;
636 struct vmbus_channel
{
637 struct list_head listentry
;
639 struct hv_device
*device_obj
;
641 struct work_struct work
;
643 enum vmbus_channel_state state
;
645 struct vmbus_channel_offer_channel offermsg
;
647 * These are based on the OfferMsg.MonitorId.
648 * Save it here for easy access.
653 u32 ringbuffer_gpadlhandle
;
655 /* Allocated memory for ring buffer */
656 void *ringbuffer_pages
;
657 u32 ringbuffer_pagecount
;
658 struct hv_ring_buffer_info outbound
; /* send to parent */
659 struct hv_ring_buffer_info inbound
; /* receive from parent */
660 spinlock_t inbound_lock
;
661 struct workqueue_struct
*controlwq
;
663 struct vmbus_close_msg close_msg
;
665 /* Channel callback are invoked in this workqueue context */
666 /* HANDLE dataWorkQueue; */
668 void (*onchannel_callback
)(void *context
);
669 void *channel_callback_context
;
672 * A channel can be marked for efficient (batched)
674 * If batched_reading is set to "true", we read until the
675 * channel is empty and hold off interrupts from the host
676 * during the entire read process.
677 * If batched_reading is set to "false", the client is not
678 * going to perform batched reading.
680 * By default we will enable batched reading; specific
681 * drivers that don't want this behavior can turn it off.
684 bool batched_reading
;
686 bool is_dedicated_interrupt
;
687 struct hv_input_signal_event_buffer sig_buf
;
688 struct hv_input_signal_event
*sig_event
;
691 * Starting with win8, this field will be used to specify
692 * the target virtual processor on which to deliver the interrupt for
693 * the host to guest communication.
694 * Prior to win8, incoming channel interrupts would only
695 * be delivered on cpu 0. Setting this value to 0 would
696 * preserve the earlier behavior.
699 /* The corresponding CPUID in the guest */
702 * Support for sub-channels. For high performance devices,
703 * it will be useful to have multiple sub-channels to support
704 * a scalable communication infrastructure with the host.
705 * The support for sub-channels is implemented as an extention
706 * to the current infrastructure.
707 * The initial offer is considered the primary channel and this
708 * offer message will indicate if the host supports sub-channels.
709 * The guest is free to ask for sub-channels to be offerred and can
710 * open these sub-channels as a normal "primary" channel. However,
711 * all sub-channels will have the same type and instance guids as the
712 * primary channel. Requests sent on a given channel will result in a
713 * response on the same channel.
717 * Sub-channel creation callback. This callback will be called in
718 * process context when a sub-channel offer is received from the host.
719 * The guest can open the sub-channel in the context of this callback.
721 void (*sc_creation_callback
)(struct vmbus_channel
*new_sc
);
725 * All Sub-channels of a primary channel are linked here.
727 struct list_head sc_list
;
729 * The primary channel this sub-channel belongs to.
730 * This will be NULL for the primary channel.
732 struct vmbus_channel
*primary_channel
;
734 * Support per-channel state for use by vmbus drivers.
736 void *per_channel_state
;
738 * To support per-cpu lookup mapping of relid to channel,
739 * link up channels based on their CPU affinity.
741 struct list_head percpu_list
;
744 static inline void set_channel_read_state(struct vmbus_channel
*c
, bool state
)
746 c
->batched_reading
= state
;
749 static inline void set_per_channel_state(struct vmbus_channel
*c
, void *s
)
751 c
->per_channel_state
= s
;
754 static inline void *get_per_channel_state(struct vmbus_channel
*c
)
756 return c
->per_channel_state
;
759 void vmbus_onmessage(void *context
);
761 int vmbus_request_offers(void);
764 * APIs for managing sub-channels.
767 void vmbus_set_sc_create_callback(struct vmbus_channel
*primary_channel
,
768 void (*sc_cr_cb
)(struct vmbus_channel
*new_sc
));
771 * Retrieve the (sub) channel on which to send an outgoing request.
772 * When a primary channel has multiple sub-channels, we choose a
773 * channel whose VCPU binding is closest to the VCPU on which
774 * this call is being made.
776 struct vmbus_channel
*vmbus_get_outgoing_channel(struct vmbus_channel
*primary
);
779 * Check if sub-channels have already been offerred. This API will be useful
780 * when the driver is unloaded after establishing sub-channels. In this case,
781 * when the driver is re-loaded, the driver would have to check if the
782 * subchannels have already been established before attempting to request
783 * the creation of sub-channels.
784 * This function returns TRUE to indicate that subchannels have already been
786 * This function should be invoked after setting the callback function for
787 * sub-channel creation.
789 bool vmbus_are_subchannels_present(struct vmbus_channel
*primary
);
791 /* The format must be the same as struct vmdata_gpa_direct */
792 struct vmbus_channel_packet_page_buffer
{
800 struct hv_page_buffer range
[MAX_PAGE_BUFFER_COUNT
];
803 /* The format must be the same as struct vmdata_gpa_direct */
804 struct vmbus_channel_packet_multipage_buffer
{
811 u32 rangecount
; /* Always 1 in this case */
812 struct hv_multipage_buffer range
;
816 extern int vmbus_open(struct vmbus_channel
*channel
,
817 u32 send_ringbuffersize
,
818 u32 recv_ringbuffersize
,
821 void(*onchannel_callback
)(void *context
),
824 extern void vmbus_close(struct vmbus_channel
*channel
);
826 extern int vmbus_sendpacket(struct vmbus_channel
*channel
,
830 enum vmbus_packet_type type
,
833 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel
*channel
,
834 struct hv_page_buffer pagebuffers
[],
840 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel
*channel
,
841 struct hv_multipage_buffer
*mpb
,
846 extern int vmbus_establish_gpadl(struct vmbus_channel
*channel
,
851 extern int vmbus_teardown_gpadl(struct vmbus_channel
*channel
,
854 extern int vmbus_recvpacket(struct vmbus_channel
*channel
,
857 u32
*buffer_actual_len
,
860 extern int vmbus_recvpacket_raw(struct vmbus_channel
*channel
,
863 u32
*buffer_actual_len
,
867 extern void vmbus_ontimer(unsigned long data
);
869 /* Base driver object */
873 /* the device type supported by this driver */
875 const struct hv_vmbus_device_id
*id_table
;
877 struct device_driver driver
;
879 int (*probe
)(struct hv_device
*, const struct hv_vmbus_device_id
*);
880 int (*remove
)(struct hv_device
*);
881 void (*shutdown
)(struct hv_device
*);
885 /* Base device object */
887 /* the device type id of this device */
890 /* the device instance id of this device */
891 uuid_le dev_instance
;
893 struct device device
;
895 struct vmbus_channel
*channel
;
899 static inline struct hv_device
*device_to_hv_device(struct device
*d
)
901 return container_of(d
, struct hv_device
, device
);
904 static inline struct hv_driver
*drv_to_hv_drv(struct device_driver
*d
)
906 return container_of(d
, struct hv_driver
, driver
);
909 static inline void hv_set_drvdata(struct hv_device
*dev
, void *data
)
911 dev_set_drvdata(&dev
->device
, data
);
914 static inline void *hv_get_drvdata(struct hv_device
*dev
)
916 return dev_get_drvdata(&dev
->device
);
919 /* Vmbus interface */
920 #define vmbus_driver_register(driver) \
921 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
922 int __must_check
__vmbus_driver_register(struct hv_driver
*hv_driver
,
923 struct module
*owner
,
924 const char *mod_name
);
925 void vmbus_driver_unregister(struct hv_driver
*hv_driver
);
928 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
930 * This macro is used to create a struct hv_vmbus_device_id that matches a
933 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \
934 g8, g9, ga, gb, gc, gd, ge, gf) \
935 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \
936 g8, g9, ga, gb, gc, gd, ge, gf },
939 * GUID definitions of various offer types - services offered to the guest.
944 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
946 #define HV_NIC_GUID \
948 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \
949 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \
954 * {32412632-86cb-44a2-9b5c-50d1417354f5}
956 #define HV_IDE_GUID \
958 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
959 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \
964 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
966 #define HV_SCSI_GUID \
968 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
969 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \
974 * {0e0b6031-5213-4934-818b-38d90ced39db}
976 #define HV_SHUTDOWN_GUID \
978 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \
979 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \
984 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
988 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \
989 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \
994 * {57164f39-9115-4e78-ab55-382f3bd5422d}
996 #define HV_HEART_BEAT_GUID \
998 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \
999 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \
1004 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
1006 #define HV_KVP_GUID \
1008 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \
1009 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \
1013 * Dynamic memory GUID
1014 * {525074dc-8985-46e2-8057-a307dc18a502}
1016 #define HV_DM_GUID \
1018 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \
1019 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \
1024 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1026 #define HV_MOUSE_GUID \
1028 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \
1029 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \
1033 * VSS (Backup/Restore) GUID
1035 #define HV_VSS_GUID \
1037 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \
1038 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \
1041 * Synthetic Video GUID
1042 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1044 #define HV_SYNTHVID_GUID \
1046 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \
1047 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \
1052 * {2f9bcc4a-0069-4af3-b76b-6fd0be528cda}
1054 #define HV_SYNTHFC_GUID \
1056 0x4A, 0xCC, 0x9B, 0x2F, 0x69, 0x00, 0xF3, 0x4A, \
1057 0xB7, 0x6B, 0x6F, 0xD0, 0xBE, 0x52, 0x8C, 0xDA \
1061 * Guest File Copy Service
1062 * {34D14BE3-DEE4-41c8-9AE7-6B174977C192}
1065 #define HV_FCOPY_GUID \
1067 0xE3, 0x4B, 0xD1, 0x34, 0xE4, 0xDE, 0xC8, 0x41, \
1068 0x9A, 0xE7, 0x6B, 0x17, 0x49, 0x77, 0xC1, 0x92 \
1072 * Common header for Hyper-V ICs
1075 #define ICMSGTYPE_NEGOTIATE 0
1076 #define ICMSGTYPE_HEARTBEAT 1
1077 #define ICMSGTYPE_KVPEXCHANGE 2
1078 #define ICMSGTYPE_SHUTDOWN 3
1079 #define ICMSGTYPE_TIMESYNC 4
1080 #define ICMSGTYPE_VSS 5
1082 #define ICMSGHDRFLAG_TRANSACTION 1
1083 #define ICMSGHDRFLAG_REQUEST 2
1084 #define ICMSGHDRFLAG_RESPONSE 4
1088 * While we want to handle util services as regular devices,
1089 * there is only one instance of each of these services; so
1090 * we statically allocate the service specific state.
1093 struct hv_util_service
{
1095 void (*util_cb
)(void *);
1096 int (*util_init
)(struct hv_util_service
*);
1097 void (*util_deinit
)(void);
1100 struct vmbuspipe_hdr
{
1111 struct ic_version icverframe
;
1113 struct ic_version icvermsg
;
1116 u8 ictransaction_id
;
1121 struct icmsg_negotiate
{
1125 struct ic_version icversion_data
[1]; /* any size array */
1128 struct shutdown_msg_data
{
1130 u32 timeout_seconds
;
1132 u8 display_message
[2048];
1135 struct heartbeat_msg_data
{
1140 /* Time Sync IC defs */
1141 #define ICTIMESYNCFLAG_PROBE 0
1142 #define ICTIMESYNCFLAG_SYNC 1
1143 #define ICTIMESYNCFLAG_SAMPLE 2
1146 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1148 #define WLTIMEDELTA 116444736000000000LL
1151 struct ictimesync_data
{
1158 struct hyperv_service_callback
{
1162 struct vmbus_channel
*channel
;
1163 void (*callback
) (void *context
);
1166 #define MAX_SRV_VER 0x7ffffff
1167 extern bool vmbus_prep_negotiate_resp(struct icmsg_hdr
*,
1168 struct icmsg_negotiate
*, u8
*, int,
1171 int hv_kvp_init(struct hv_util_service
*);
1172 void hv_kvp_deinit(void);
1173 void hv_kvp_onchannelcallback(void *);
1175 int hv_vss_init(struct hv_util_service
*);
1176 void hv_vss_deinit(void);
1177 void hv_vss_onchannelcallback(void *);
1179 extern struct resource hyperv_mmio
;
1182 * Negotiated version with the Host.
1185 extern __u32 vmbus_proto_version
;
1187 #endif /* _HYPERV_H */