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 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
393 CHANNELMSG_VIEWRANGE_ADD
= 17,
394 CHANNELMSG_VIEWRANGE_REMOVE
= 18,
399 struct vmbus_channel_message_header
{
400 enum vmbus_channel_message_type msgtype
;
404 /* Query VMBus Version parameters */
405 struct vmbus_channel_query_vmbus_version
{
406 struct vmbus_channel_message_header header
;
410 /* VMBus Version Supported parameters */
411 struct vmbus_channel_version_supported
{
412 struct vmbus_channel_message_header header
;
413 u8 version_supported
;
416 /* Offer Channel parameters */
417 struct vmbus_channel_offer_channel
{
418 struct vmbus_channel_message_header header
;
419 struct vmbus_channel_offer offer
;
423 * win7 and beyond splits this field into a bit field.
425 u8 monitor_allocated
:1;
428 * These are new fields added in win7 and later.
429 * Do not access these fields without checking the
430 * negotiated protocol.
432 * If "is_dedicated_interrupt" is set, we must not set the
433 * associated bit in the channel bitmap while sending the
434 * interrupt to the host.
436 * connection_id is to be used in signaling the host.
438 u16 is_dedicated_interrupt
:1;
443 /* Rescind Offer parameters */
444 struct vmbus_channel_rescind_offer
{
445 struct vmbus_channel_message_header header
;
450 * Request Offer -- no parameters, SynIC message contains the partition ID
451 * Set Snoop -- no parameters, SynIC message contains the partition ID
452 * Clear Snoop -- no parameters, SynIC message contains the partition ID
453 * All Offers Delivered -- no parameters, SynIC message contains the partition
455 * Flush Client -- no parameters, SynIC message contains the partition ID
458 /* Open Channel parameters */
459 struct vmbus_channel_open_channel
{
460 struct vmbus_channel_message_header header
;
462 /* Identifies the specific VMBus channel that is being opened. */
465 /* ID making a particular open request at a channel offer unique. */
468 /* GPADL for the channel's ring buffer. */
469 u32 ringbuffer_gpadlhandle
;
472 * Starting with win8, this field will be used to specify
473 * the target virtual processor on which to deliver the interrupt for
474 * the host to guest communication.
475 * Prior to win8, incoming channel interrupts would only
476 * be delivered on cpu 0. Setting this value to 0 would
477 * preserve the earlier behavior.
482 * The upstream ring buffer begins at offset zero in the memory
483 * described by RingBufferGpadlHandle. The downstream ring buffer
484 * follows it at this offset (in pages).
486 u32 downstream_ringbuffer_pageoffset
;
488 /* User-specific data to be passed along to the server endpoint. */
489 unsigned char userdata
[MAX_USER_DEFINED_BYTES
];
492 /* Open Channel Result parameters */
493 struct vmbus_channel_open_result
{
494 struct vmbus_channel_message_header header
;
500 /* Close channel parameters; */
501 struct vmbus_channel_close_channel
{
502 struct vmbus_channel_message_header header
;
506 /* Channel Message GPADL */
507 #define GPADL_TYPE_RING_BUFFER 1
508 #define GPADL_TYPE_SERVER_SAVE_AREA 2
509 #define GPADL_TYPE_TRANSACTION 8
512 * The number of PFNs in a GPADL message is defined by the number of
513 * pages that would be spanned by ByteCount and ByteOffset. If the
514 * implied number of PFNs won't fit in this packet, there will be a
515 * follow-up packet that contains more.
517 struct vmbus_channel_gpadl_header
{
518 struct vmbus_channel_message_header header
;
523 struct gpa_range range
[0];
526 /* This is the followup packet that contains more PFNs. */
527 struct vmbus_channel_gpadl_body
{
528 struct vmbus_channel_message_header header
;
534 struct vmbus_channel_gpadl_created
{
535 struct vmbus_channel_message_header header
;
541 struct vmbus_channel_gpadl_teardown
{
542 struct vmbus_channel_message_header header
;
547 struct vmbus_channel_gpadl_torndown
{
548 struct vmbus_channel_message_header header
;
552 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
553 struct vmbus_channel_view_range_add
{
554 struct vmbus_channel_message_header header
;
555 PHYSICAL_ADDRESS viewrange_base
;
556 u64 viewrange_length
;
560 struct vmbus_channel_view_range_remove
{
561 struct vmbus_channel_message_header header
;
562 PHYSICAL_ADDRESS viewrange_base
;
567 struct vmbus_channel_relid_released
{
568 struct vmbus_channel_message_header header
;
572 struct vmbus_channel_initiate_contact
{
573 struct vmbus_channel_message_header header
;
574 u32 vmbus_version_requested
;
575 u32 target_vcpu
; /* The VCPU the host should respond to */
581 struct vmbus_channel_version_response
{
582 struct vmbus_channel_message_header header
;
583 u8 version_supported
;
586 enum vmbus_channel_state
{
588 CHANNEL_OPENING_STATE
,
590 CHANNEL_OPENED_STATE
,
594 * Represents each channel msg on the vmbus connection This is a
595 * variable-size data structure depending on the msg type itself
597 struct vmbus_channel_msginfo
{
598 /* Bookkeeping stuff */
599 struct list_head msglistentry
;
601 /* So far, this is only used to handle gpadl body message */
602 struct list_head submsglist
;
604 /* Synchronize the request/response if needed */
605 struct completion waitevent
;
607 struct vmbus_channel_version_supported version_supported
;
608 struct vmbus_channel_open_result open_result
;
609 struct vmbus_channel_gpadl_torndown gpadl_torndown
;
610 struct vmbus_channel_gpadl_created gpadl_created
;
611 struct vmbus_channel_version_response version_response
;
616 * The channel message that goes out on the "wire".
617 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
619 unsigned char msg
[0];
622 struct vmbus_close_msg
{
623 struct vmbus_channel_msginfo info
;
624 struct vmbus_channel_close_channel msg
;
627 /* Define connection identifier type. */
628 union hv_connection_id
{
636 /* Definition of the hv_signal_event hypercall input structure. */
637 struct hv_input_signal_event
{
638 union hv_connection_id connectionid
;
643 struct hv_input_signal_event_buffer
{
645 struct hv_input_signal_event event
;
648 struct vmbus_channel
{
649 struct list_head listentry
;
651 struct hv_device
*device_obj
;
653 struct work_struct work
;
655 enum vmbus_channel_state state
;
657 struct vmbus_channel_offer_channel offermsg
;
659 * These are based on the OfferMsg.MonitorId.
660 * Save it here for easy access.
665 bool rescind
; /* got rescind msg */
667 u32 ringbuffer_gpadlhandle
;
669 /* Allocated memory for ring buffer */
670 void *ringbuffer_pages
;
671 u32 ringbuffer_pagecount
;
672 struct hv_ring_buffer_info outbound
; /* send to parent */
673 struct hv_ring_buffer_info inbound
; /* receive from parent */
674 spinlock_t inbound_lock
;
675 struct workqueue_struct
*controlwq
;
677 struct vmbus_close_msg close_msg
;
679 /* Channel callback are invoked in this workqueue context */
680 /* HANDLE dataWorkQueue; */
682 void (*onchannel_callback
)(void *context
);
683 void *channel_callback_context
;
686 * A channel can be marked for efficient (batched)
688 * If batched_reading is set to "true", we read until the
689 * channel is empty and hold off interrupts from the host
690 * during the entire read process.
691 * If batched_reading is set to "false", the client is not
692 * going to perform batched reading.
694 * By default we will enable batched reading; specific
695 * drivers that don't want this behavior can turn it off.
698 bool batched_reading
;
700 bool is_dedicated_interrupt
;
701 struct hv_input_signal_event_buffer sig_buf
;
702 struct hv_input_signal_event
*sig_event
;
705 * Starting with win8, this field will be used to specify
706 * the target virtual processor on which to deliver the interrupt for
707 * the host to guest communication.
708 * Prior to win8, incoming channel interrupts would only
709 * be delivered on cpu 0. Setting this value to 0 would
710 * preserve the earlier behavior.
713 /* The corresponding CPUID in the guest */
716 * Support for sub-channels. For high performance devices,
717 * it will be useful to have multiple sub-channels to support
718 * a scalable communication infrastructure with the host.
719 * The support for sub-channels is implemented as an extention
720 * to the current infrastructure.
721 * The initial offer is considered the primary channel and this
722 * offer message will indicate if the host supports sub-channels.
723 * The guest is free to ask for sub-channels to be offerred and can
724 * open these sub-channels as a normal "primary" channel. However,
725 * all sub-channels will have the same type and instance guids as the
726 * primary channel. Requests sent on a given channel will result in a
727 * response on the same channel.
731 * Sub-channel creation callback. This callback will be called in
732 * process context when a sub-channel offer is received from the host.
733 * The guest can open the sub-channel in the context of this callback.
735 void (*sc_creation_callback
)(struct vmbus_channel
*new_sc
);
738 * The spinlock to protect the structure. It is being used to protect
739 * test-and-set access to various attributes of the structure as well
740 * as all sc_list operations.
744 * All Sub-channels of a primary channel are linked here.
746 struct list_head sc_list
;
748 * The primary channel this sub-channel belongs to.
749 * This will be NULL for the primary channel.
751 struct vmbus_channel
*primary_channel
;
753 * Support per-channel state for use by vmbus drivers.
755 void *per_channel_state
;
757 * To support per-cpu lookup mapping of relid to channel,
758 * link up channels based on their CPU affinity.
760 struct list_head percpu_list
;
763 static inline void set_channel_read_state(struct vmbus_channel
*c
, bool state
)
765 c
->batched_reading
= state
;
768 static inline void set_per_channel_state(struct vmbus_channel
*c
, void *s
)
770 c
->per_channel_state
= s
;
773 static inline void *get_per_channel_state(struct vmbus_channel
*c
)
775 return c
->per_channel_state
;
778 void vmbus_onmessage(void *context
);
780 int vmbus_request_offers(void);
783 * APIs for managing sub-channels.
786 void vmbus_set_sc_create_callback(struct vmbus_channel
*primary_channel
,
787 void (*sc_cr_cb
)(struct vmbus_channel
*new_sc
));
790 * Retrieve the (sub) channel on which to send an outgoing request.
791 * When a primary channel has multiple sub-channels, we choose a
792 * channel whose VCPU binding is closest to the VCPU on which
793 * this call is being made.
795 struct vmbus_channel
*vmbus_get_outgoing_channel(struct vmbus_channel
*primary
);
798 * Check if sub-channels have already been offerred. This API will be useful
799 * when the driver is unloaded after establishing sub-channels. In this case,
800 * when the driver is re-loaded, the driver would have to check if the
801 * subchannels have already been established before attempting to request
802 * the creation of sub-channels.
803 * This function returns TRUE to indicate that subchannels have already been
805 * This function should be invoked after setting the callback function for
806 * sub-channel creation.
808 bool vmbus_are_subchannels_present(struct vmbus_channel
*primary
);
810 /* The format must be the same as struct vmdata_gpa_direct */
811 struct vmbus_channel_packet_page_buffer
{
819 struct hv_page_buffer range
[MAX_PAGE_BUFFER_COUNT
];
822 /* The format must be the same as struct vmdata_gpa_direct */
823 struct vmbus_channel_packet_multipage_buffer
{
830 u32 rangecount
; /* Always 1 in this case */
831 struct hv_multipage_buffer range
;
834 /* The format must be the same as struct vmdata_gpa_direct */
835 struct vmbus_packet_mpb_array
{
842 u32 rangecount
; /* Always 1 in this case */
843 struct hv_mpb_array range
;
847 extern int vmbus_open(struct vmbus_channel
*channel
,
848 u32 send_ringbuffersize
,
849 u32 recv_ringbuffersize
,
852 void(*onchannel_callback
)(void *context
),
855 extern void vmbus_close(struct vmbus_channel
*channel
);
857 extern int vmbus_sendpacket(struct vmbus_channel
*channel
,
861 enum vmbus_packet_type type
,
864 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel
*channel
,
865 struct hv_page_buffer pagebuffers
[],
871 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel
*channel
,
872 struct hv_multipage_buffer
*mpb
,
877 extern int vmbus_sendpacket_mpb_desc(struct vmbus_channel
*channel
,
878 struct vmbus_packet_mpb_array
*mpb
,
884 extern int vmbus_establish_gpadl(struct vmbus_channel
*channel
,
889 extern int vmbus_teardown_gpadl(struct vmbus_channel
*channel
,
892 extern int vmbus_recvpacket(struct vmbus_channel
*channel
,
895 u32
*buffer_actual_len
,
898 extern int vmbus_recvpacket_raw(struct vmbus_channel
*channel
,
901 u32
*buffer_actual_len
,
905 extern void vmbus_ontimer(unsigned long data
);
907 /* Base driver object */
911 /* the device type supported by this driver */
913 const struct hv_vmbus_device_id
*id_table
;
915 struct device_driver driver
;
917 int (*probe
)(struct hv_device
*, const struct hv_vmbus_device_id
*);
918 int (*remove
)(struct hv_device
*);
919 void (*shutdown
)(struct hv_device
*);
923 /* Base device object */
925 /* the device type id of this device */
928 /* the device instance id of this device */
929 uuid_le dev_instance
;
931 struct device device
;
933 struct vmbus_channel
*channel
;
937 static inline struct hv_device
*device_to_hv_device(struct device
*d
)
939 return container_of(d
, struct hv_device
, device
);
942 static inline struct hv_driver
*drv_to_hv_drv(struct device_driver
*d
)
944 return container_of(d
, struct hv_driver
, driver
);
947 static inline void hv_set_drvdata(struct hv_device
*dev
, void *data
)
949 dev_set_drvdata(&dev
->device
, data
);
952 static inline void *hv_get_drvdata(struct hv_device
*dev
)
954 return dev_get_drvdata(&dev
->device
);
957 /* Vmbus interface */
958 #define vmbus_driver_register(driver) \
959 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
960 int __must_check
__vmbus_driver_register(struct hv_driver
*hv_driver
,
961 struct module
*owner
,
962 const char *mod_name
);
963 void vmbus_driver_unregister(struct hv_driver
*hv_driver
);
966 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
968 * This macro is used to create a struct hv_vmbus_device_id that matches a
971 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \
972 g8, g9, ga, gb, gc, gd, ge, gf) \
973 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \
974 g8, g9, ga, gb, gc, gd, ge, gf },
977 * GUID definitions of various offer types - services offered to the guest.
982 * {f8615163-df3e-46c5-913f-f2d2f965ed0e}
984 #define HV_NIC_GUID \
986 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \
987 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \
992 * {32412632-86cb-44a2-9b5c-50d1417354f5}
994 #define HV_IDE_GUID \
996 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
997 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \
1002 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f}
1004 #define HV_SCSI_GUID \
1006 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
1007 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \
1012 * {0e0b6031-5213-4934-818b-38d90ced39db}
1014 #define HV_SHUTDOWN_GUID \
1016 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \
1017 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \
1022 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF}
1024 #define HV_TS_GUID \
1026 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \
1027 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \
1032 * {57164f39-9115-4e78-ab55-382f3bd5422d}
1034 #define HV_HEART_BEAT_GUID \
1036 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \
1037 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \
1042 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6}
1044 #define HV_KVP_GUID \
1046 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \
1047 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \
1051 * Dynamic memory GUID
1052 * {525074dc-8985-46e2-8057-a307dc18a502}
1054 #define HV_DM_GUID \
1056 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \
1057 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \
1062 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a}
1064 #define HV_MOUSE_GUID \
1066 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \
1067 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \
1071 * VSS (Backup/Restore) GUID
1073 #define HV_VSS_GUID \
1075 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \
1076 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \
1079 * Synthetic Video GUID
1080 * {DA0A7802-E377-4aac-8E77-0558EB1073F8}
1082 #define HV_SYNTHVID_GUID \
1084 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \
1085 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \
1090 * {2f9bcc4a-0069-4af3-b76b-6fd0be528cda}
1092 #define HV_SYNTHFC_GUID \
1094 0x4A, 0xCC, 0x9B, 0x2F, 0x69, 0x00, 0xF3, 0x4A, \
1095 0xB7, 0x6B, 0x6F, 0xD0, 0xBE, 0x52, 0x8C, 0xDA \
1099 * Guest File Copy Service
1100 * {34D14BE3-DEE4-41c8-9AE7-6B174977C192}
1103 #define HV_FCOPY_GUID \
1105 0xE3, 0x4B, 0xD1, 0x34, 0xE4, 0xDE, 0xC8, 0x41, \
1106 0x9A, 0xE7, 0x6B, 0x17, 0x49, 0x77, 0xC1, 0x92 \
1110 * Common header for Hyper-V ICs
1113 #define ICMSGTYPE_NEGOTIATE 0
1114 #define ICMSGTYPE_HEARTBEAT 1
1115 #define ICMSGTYPE_KVPEXCHANGE 2
1116 #define ICMSGTYPE_SHUTDOWN 3
1117 #define ICMSGTYPE_TIMESYNC 4
1118 #define ICMSGTYPE_VSS 5
1120 #define ICMSGHDRFLAG_TRANSACTION 1
1121 #define ICMSGHDRFLAG_REQUEST 2
1122 #define ICMSGHDRFLAG_RESPONSE 4
1126 * While we want to handle util services as regular devices,
1127 * there is only one instance of each of these services; so
1128 * we statically allocate the service specific state.
1131 struct hv_util_service
{
1133 void (*util_cb
)(void *);
1134 int (*util_init
)(struct hv_util_service
*);
1135 void (*util_deinit
)(void);
1138 struct vmbuspipe_hdr
{
1149 struct ic_version icverframe
;
1151 struct ic_version icvermsg
;
1154 u8 ictransaction_id
;
1159 struct icmsg_negotiate
{
1163 struct ic_version icversion_data
[1]; /* any size array */
1166 struct shutdown_msg_data
{
1168 u32 timeout_seconds
;
1170 u8 display_message
[2048];
1173 struct heartbeat_msg_data
{
1178 /* Time Sync IC defs */
1179 #define ICTIMESYNCFLAG_PROBE 0
1180 #define ICTIMESYNCFLAG_SYNC 1
1181 #define ICTIMESYNCFLAG_SAMPLE 2
1184 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1186 #define WLTIMEDELTA 116444736000000000LL
1189 struct ictimesync_data
{
1196 struct hyperv_service_callback
{
1200 struct vmbus_channel
*channel
;
1201 void (*callback
) (void *context
);
1204 #define MAX_SRV_VER 0x7ffffff
1205 extern bool vmbus_prep_negotiate_resp(struct icmsg_hdr
*,
1206 struct icmsg_negotiate
*, u8
*, int,
1209 int hv_kvp_init(struct hv_util_service
*);
1210 void hv_kvp_deinit(void);
1211 void hv_kvp_onchannelcallback(void *);
1213 int hv_vss_init(struct hv_util_service
*);
1214 void hv_vss_deinit(void);
1215 void hv_vss_onchannelcallback(void *);
1217 extern struct resource hyperv_mmio
;
1220 * Negotiated version with the Host.
1223 extern __u32 vmbus_proto_version
;
1225 #endif /* _HYPERV_H */