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 <linux/types.h>
31 * An implementation of HyperV key value pair (KVP) functionality for Linux.
34 * Copyright (C) 2010, Novell, Inc.
35 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
40 * Maximum value size - used for both key names and value data, and includes
41 * any applicable NULL terminators.
43 * Note: This limit is somewhat arbitrary, but falls easily within what is
44 * supported for all native guests (back to Win 2000) and what is reasonable
45 * for the IC KVP exchange functionality. Note that Windows Me/98/95 are
46 * limited to 255 character key names.
48 * MSDN recommends not storing data values larger than 2048 bytes in the
51 * Note: This value is used in defining the KVP exchange message - this value
52 * cannot be modified without affecting the message size and compatibility.
56 * bytes, including any null terminators
58 #define HV_KVP_EXCHANGE_MAX_VALUE_SIZE (2048)
62 * Maximum key size - the registry limit for the length of an entry name
63 * is 256 characters, including the null terminator
66 #define HV_KVP_EXCHANGE_MAX_KEY_SIZE (512)
69 * In Linux, we implement the KVP functionality in two components:
70 * 1) The kernel component which is packaged as part of the hv_utils driver
71 * is responsible for communicating with the host and responsible for
72 * implementing the host/guest protocol. 2) A user level daemon that is
73 * responsible for data gathering.
75 * Host/Guest Protocol: The host iterates over an index and expects the guest
76 * to assign a key name to the index and also return the value corresponding to
77 * the key. The host will have atmost one KVP transaction outstanding at any
78 * given point in time. The host side iteration stops when the guest returns
79 * an error. Microsoft has specified the following mapping of key names to
80 * host specified index:
83 * 0 FullyQualifiedDomainName
84 * 1 IntegrationServicesVersion
85 * 2 NetworkAddressIPv4
86 * 3 NetworkAddressIPv6
92 * 9 ProcessorArchitecture
94 * The Windows host expects the Key Name and Key Value to be encoded in utf16.
96 * Guest Kernel/KVP Daemon Protocol: As noted earlier, we implement all of the
97 * data gathering functionality in a user mode daemon. The user level daemon
98 * is also responsible for binding the key name to the index as well. The
99 * kernel and user-level daemon communicate using a connector channel.
101 * The user mode component first registers with the
102 * the kernel component. Subsequently, the kernel component requests, data
103 * for the specified keys. In response to this message the user mode component
104 * fills in the value corresponding to the specified key. We overload the
105 * sequence field in the cn_msg header to define our KVP message types.
108 * The kernel component simply acts as a conduit for communication between the
109 * Windows host and the user-level daemon. The kernel component passes up the
110 * index received from the Host to the user-level daemon. If the index is
111 * valid (supported), the corresponding key as well as its
112 * value (both are strings) is returned. If the index is invalid
113 * (not supported), a NULL key string is returned.
118 * Registry value types.
125 enum hv_kvp_exchg_op
{
131 KVP_OP_COUNT
/* Number of operations, must be last. */
134 enum hv_kvp_exchg_pool
{
135 KVP_POOL_EXTERNAL
= 0,
138 KVP_POOL_AUTO_EXTERNAL
,
139 KVP_POOL_AUTO_INTERNAL
,
140 KVP_POOL_COUNT
/* Number of pools, must be last. */
147 } __attribute__((packed
));
149 struct hv_kvp_exchg_msg_value
{
153 __u8 key
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
];
155 __u8 value
[HV_KVP_EXCHANGE_MAX_VALUE_SIZE
];
159 } __attribute__((packed
));
161 struct hv_kvp_msg_enumerate
{
163 struct hv_kvp_exchg_msg_value data
;
164 } __attribute__((packed
));
166 struct hv_kvp_msg_get
{
167 struct hv_kvp_exchg_msg_value data
;
170 struct hv_kvp_msg_set
{
171 struct hv_kvp_exchg_msg_value data
;
174 struct hv_kvp_msg_delete
{
176 __u8 key
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
];
179 struct hv_kvp_register
{
180 __u8 version
[HV_KVP_EXCHANGE_MAX_KEY_SIZE
];
184 struct hv_kvp_hdr kvp_hdr
;
186 struct hv_kvp_msg_get kvp_get
;
187 struct hv_kvp_msg_set kvp_set
;
188 struct hv_kvp_msg_delete kvp_delete
;
189 struct hv_kvp_msg_enumerate kvp_enum_data
;
190 struct hv_kvp_register kvp_register
;
192 } __attribute__((packed
));
195 #include <linux/scatterlist.h>
196 #include <linux/list.h>
197 #include <linux/uuid.h>
198 #include <linux/timer.h>
199 #include <linux/workqueue.h>
200 #include <linux/completion.h>
201 #include <linux/device.h>
202 #include <linux/mod_devicetable.h>
205 #define MAX_PAGE_BUFFER_COUNT 19
206 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
208 #pragma pack(push, 1)
210 /* Single-page buffer */
211 struct hv_page_buffer
{
217 /* Multiple-page buffer */
218 struct hv_multipage_buffer
{
219 /* Length and Offset determines the # of pfns in the array */
222 u64 pfn_array
[MAX_MULTIPAGE_BUFFER_COUNT
];
225 /* 0x18 includes the proprietary packet header */
226 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
227 (sizeof(struct hv_page_buffer) * \
228 MAX_PAGE_BUFFER_COUNT))
229 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
230 sizeof(struct hv_multipage_buffer))
235 struct hv_ring_buffer
{
236 /* Offset in bytes from the start of ring data below */
239 /* Offset in bytes from the start of ring data below */
244 /* Pad it to PAGE_SIZE so that data starts on page boundary */
248 * The interrupt_mask field is used only for channels but since our
249 * vmbus connection also uses this data structure and its data starts
250 * here, we commented out this field.
254 * Ring data starts here + RingDataStartOffset
255 * !!! DO NOT place any fields below this !!!
260 struct hv_ring_buffer_info
{
261 struct hv_ring_buffer
*ring_buffer
;
262 u32 ring_size
; /* Include the shared header */
263 spinlock_t ring_lock
;
265 u32 ring_datasize
; /* < ring_size */
266 u32 ring_data_startoffset
;
269 struct hv_ring_buffer_debug_info
{
270 u32 current_interrupt_mask
;
271 u32 current_read_index
;
272 u32 current_write_index
;
273 u32 bytes_avail_toread
;
274 u32 bytes_avail_towrite
;
278 * We use the same version numbering for all Hyper-V modules.
280 * Definition of versioning is as follows;
282 * Major Number Changes for these scenarios;
283 * 1. When a new version of Windows Hyper-V
285 * 2. A Major change has occurred in the
287 * (For example the merge for the first time
288 * into the kernel) Every time the Major Number
289 * changes, the Revision number is reset to 0.
290 * Minor Number Changes when new functionality is added
291 * to the Linux IC's that is not a bug fix.
293 * 3.1 - Added completed hv_utils driver. Shutdown/Heartbeat/Timesync
295 #define HV_DRV_VERSION "3.1"
299 * A revision number of vmbus that is used for ensuring both ends on a
300 * partition are using compatible versions.
302 #define VMBUS_REVISION_NUMBER 13
304 /* Make maximum size of pipe payload of 16K */
305 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384)
307 /* Define PipeMode values. */
308 #define VMBUS_PIPE_TYPE_BYTE 0x00000000
309 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004
311 /* The size of the user defined data buffer for non-pipe offers. */
312 #define MAX_USER_DEFINED_BYTES 120
314 /* The size of the user defined data buffer for pipe offers. */
315 #define MAX_PIPE_USER_DEFINED_BYTES 116
318 * At the center of the Channel Management library is the Channel Offer. This
319 * struct contains the fundamental information about an offer.
321 struct vmbus_channel_offer
{
324 u64 int_latency
; /* in 100ns units */
326 u32 server_ctx_size
; /* in bytes */
328 u16 mmio_megabytes
; /* in bytes * 1024 * 1024 */
331 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
333 unsigned char user_def
[MAX_USER_DEFINED_BYTES
];
338 * The following sructure is an integrated pipe protocol, which
339 * is implemented on top of standard user-defined data. Pipe
340 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
345 unsigned char user_def
[MAX_PIPE_USER_DEFINED_BYTES
];
352 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1
353 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2
354 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4
355 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10
356 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100
357 #define VMBUS_CHANNEL_PARENT_OFFER 0x200
358 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400
360 struct vmpacket_descriptor
{
368 struct vmpacket_header
{
369 u32 prev_pkt_start_offset
;
370 struct vmpacket_descriptor descriptor
;
373 struct vmtransfer_page_range
{
378 struct vmtransfer_page_packet_header
{
379 struct vmpacket_descriptor d
;
381 bool sender_owns_set
;
384 struct vmtransfer_page_range ranges
[1];
387 struct vmgpadl_packet_header
{
388 struct vmpacket_descriptor d
;
393 struct vmadd_remove_transfer_page_set
{
394 struct vmpacket_descriptor d
;
401 * This structure defines a range in guest physical space that can be made to
402 * look virtually contiguous.
411 * This is the format for an Establish Gpadl packet, which contains a handle by
412 * which this GPADL will be known and a set of GPA ranges associated with it.
413 * This can be converted to a MDL by the guest OS. If there are multiple GPA
414 * ranges, then the resulting MDL will be "chained," representing multiple VA
417 struct vmestablish_gpadl
{
418 struct vmpacket_descriptor d
;
421 struct gpa_range range
[1];
425 * This is the format for a Teardown Gpadl packet, which indicates that the
426 * GPADL handle in the Establish Gpadl packet will never be referenced again.
428 struct vmteardown_gpadl
{
429 struct vmpacket_descriptor d
;
431 u32 reserved
; /* for alignment to a 8-byte boundary */
435 * This is the format for a GPA-Direct packet, which contains a set of GPA
436 * ranges, in addition to commands and/or data.
438 struct vmdata_gpa_direct
{
439 struct vmpacket_descriptor d
;
442 struct gpa_range range
[1];
445 /* This is the format for a Additional Data Packet. */
446 struct vmadditional_data
{
447 struct vmpacket_descriptor d
;
451 unsigned char data
[1];
454 union vmpacket_largest_possible_header
{
455 struct vmpacket_descriptor simple_hdr
;
456 struct vmtransfer_page_packet_header xfer_page_hdr
;
457 struct vmgpadl_packet_header gpadl_hdr
;
458 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr
;
459 struct vmestablish_gpadl establish_gpadl_hdr
;
460 struct vmteardown_gpadl teardown_gpadl_hdr
;
461 struct vmdata_gpa_direct data_gpa_direct_hdr
;
464 #define VMPACKET_DATA_START_ADDRESS(__packet) \
465 (void *)(((unsigned char *)__packet) + \
466 ((struct vmpacket_descriptor)__packet)->offset8 * 8)
468 #define VMPACKET_DATA_LENGTH(__packet) \
469 ((((struct vmpacket_descriptor)__packet)->len8 - \
470 ((struct vmpacket_descriptor)__packet)->offset8) * 8)
472 #define VMPACKET_TRANSFER_MODE(__packet) \
473 (((struct IMPACT)__packet)->type)
475 enum vmbus_packet_type
{
476 VM_PKT_INVALID
= 0x0,
478 VM_PKT_ADD_XFER_PAGESET
= 0x2,
479 VM_PKT_RM_XFER_PAGESET
= 0x3,
480 VM_PKT_ESTABLISH_GPADL
= 0x4,
481 VM_PKT_TEARDOWN_GPADL
= 0x5,
482 VM_PKT_DATA_INBAND
= 0x6,
483 VM_PKT_DATA_USING_XFER_PAGES
= 0x7,
484 VM_PKT_DATA_USING_GPADL
= 0x8,
485 VM_PKT_DATA_USING_GPA_DIRECT
= 0x9,
486 VM_PKT_CANCEL_REQUEST
= 0xa,
488 VM_PKT_DATA_USING_ADDITIONAL_PKT
= 0xc,
489 VM_PKT_ADDITIONAL_DATA
= 0xd
492 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
495 /* Version 1 messages */
496 enum vmbus_channel_message_type
{
497 CHANNELMSG_INVALID
= 0,
498 CHANNELMSG_OFFERCHANNEL
= 1,
499 CHANNELMSG_RESCIND_CHANNELOFFER
= 2,
500 CHANNELMSG_REQUESTOFFERS
= 3,
501 CHANNELMSG_ALLOFFERS_DELIVERED
= 4,
502 CHANNELMSG_OPENCHANNEL
= 5,
503 CHANNELMSG_OPENCHANNEL_RESULT
= 6,
504 CHANNELMSG_CLOSECHANNEL
= 7,
505 CHANNELMSG_GPADL_HEADER
= 8,
506 CHANNELMSG_GPADL_BODY
= 9,
507 CHANNELMSG_GPADL_CREATED
= 10,
508 CHANNELMSG_GPADL_TEARDOWN
= 11,
509 CHANNELMSG_GPADL_TORNDOWN
= 12,
510 CHANNELMSG_RELID_RELEASED
= 13,
511 CHANNELMSG_INITIATE_CONTACT
= 14,
512 CHANNELMSG_VERSION_RESPONSE
= 15,
513 CHANNELMSG_UNLOAD
= 16,
514 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
515 CHANNELMSG_VIEWRANGE_ADD
= 17,
516 CHANNELMSG_VIEWRANGE_REMOVE
= 18,
521 struct vmbus_channel_message_header
{
522 enum vmbus_channel_message_type msgtype
;
526 /* Query VMBus Version parameters */
527 struct vmbus_channel_query_vmbus_version
{
528 struct vmbus_channel_message_header header
;
532 /* VMBus Version Supported parameters */
533 struct vmbus_channel_version_supported
{
534 struct vmbus_channel_message_header header
;
535 bool version_supported
;
538 /* Offer Channel parameters */
539 struct vmbus_channel_offer_channel
{
540 struct vmbus_channel_message_header header
;
541 struct vmbus_channel_offer offer
;
544 bool monitor_allocated
;
547 /* Rescind Offer parameters */
548 struct vmbus_channel_rescind_offer
{
549 struct vmbus_channel_message_header header
;
554 * Request Offer -- no parameters, SynIC message contains the partition ID
555 * Set Snoop -- no parameters, SynIC message contains the partition ID
556 * Clear Snoop -- no parameters, SynIC message contains the partition ID
557 * All Offers Delivered -- no parameters, SynIC message contains the partition
559 * Flush Client -- no parameters, SynIC message contains the partition ID
562 /* Open Channel parameters */
563 struct vmbus_channel_open_channel
{
564 struct vmbus_channel_message_header header
;
566 /* Identifies the specific VMBus channel that is being opened. */
569 /* ID making a particular open request at a channel offer unique. */
572 /* GPADL for the channel's ring buffer. */
573 u32 ringbuffer_gpadlhandle
;
575 /* GPADL for the channel's server context save area. */
576 u32 server_contextarea_gpadlhandle
;
579 * The upstream ring buffer begins at offset zero in the memory
580 * described by RingBufferGpadlHandle. The downstream ring buffer
581 * follows it at this offset (in pages).
583 u32 downstream_ringbuffer_pageoffset
;
585 /* User-specific data to be passed along to the server endpoint. */
586 unsigned char userdata
[MAX_USER_DEFINED_BYTES
];
589 /* Open Channel Result parameters */
590 struct vmbus_channel_open_result
{
591 struct vmbus_channel_message_header header
;
597 /* Close channel parameters; */
598 struct vmbus_channel_close_channel
{
599 struct vmbus_channel_message_header header
;
603 /* Channel Message GPADL */
604 #define GPADL_TYPE_RING_BUFFER 1
605 #define GPADL_TYPE_SERVER_SAVE_AREA 2
606 #define GPADL_TYPE_TRANSACTION 8
609 * The number of PFNs in a GPADL message is defined by the number of
610 * pages that would be spanned by ByteCount and ByteOffset. If the
611 * implied number of PFNs won't fit in this packet, there will be a
612 * follow-up packet that contains more.
614 struct vmbus_channel_gpadl_header
{
615 struct vmbus_channel_message_header header
;
620 struct gpa_range range
[0];
623 /* This is the followup packet that contains more PFNs. */
624 struct vmbus_channel_gpadl_body
{
625 struct vmbus_channel_message_header header
;
631 struct vmbus_channel_gpadl_created
{
632 struct vmbus_channel_message_header header
;
638 struct vmbus_channel_gpadl_teardown
{
639 struct vmbus_channel_message_header header
;
644 struct vmbus_channel_gpadl_torndown
{
645 struct vmbus_channel_message_header header
;
649 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
650 struct vmbus_channel_view_range_add
{
651 struct vmbus_channel_message_header header
;
652 PHYSICAL_ADDRESS viewrange_base
;
653 u64 viewrange_length
;
657 struct vmbus_channel_view_range_remove
{
658 struct vmbus_channel_message_header header
;
659 PHYSICAL_ADDRESS viewrange_base
;
664 struct vmbus_channel_relid_released
{
665 struct vmbus_channel_message_header header
;
669 struct vmbus_channel_initiate_contact
{
670 struct vmbus_channel_message_header header
;
671 u32 vmbus_version_requested
;
678 struct vmbus_channel_version_response
{
679 struct vmbus_channel_message_header header
;
680 bool version_supported
;
683 enum vmbus_channel_state
{
685 CHANNEL_OPENING_STATE
,
689 struct vmbus_channel_debug_info
{
691 enum vmbus_channel_state state
;
692 uuid_le interfacetype
;
693 uuid_le interface_instance
;
695 u32 servermonitor_pending
;
696 u32 servermonitor_latency
;
697 u32 servermonitor_connectionid
;
698 u32 clientmonitor_pending
;
699 u32 clientmonitor_latency
;
700 u32 clientmonitor_connectionid
;
702 struct hv_ring_buffer_debug_info inbound
;
703 struct hv_ring_buffer_debug_info outbound
;
707 * Represents each channel msg on the vmbus connection This is a
708 * variable-size data structure depending on the msg type itself
710 struct vmbus_channel_msginfo
{
711 /* Bookkeeping stuff */
712 struct list_head msglistentry
;
714 /* So far, this is only used to handle gpadl body message */
715 struct list_head submsglist
;
717 /* Synchronize the request/response if needed */
718 struct completion waitevent
;
720 struct vmbus_channel_version_supported version_supported
;
721 struct vmbus_channel_open_result open_result
;
722 struct vmbus_channel_gpadl_torndown gpadl_torndown
;
723 struct vmbus_channel_gpadl_created gpadl_created
;
724 struct vmbus_channel_version_response version_response
;
729 * The channel message that goes out on the "wire".
730 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
732 unsigned char msg
[0];
735 struct vmbus_close_msg
{
736 struct vmbus_channel_msginfo info
;
737 struct vmbus_channel_close_channel msg
;
740 struct vmbus_channel
{
741 struct list_head listentry
;
743 struct hv_device
*device_obj
;
745 struct work_struct work
;
747 enum vmbus_channel_state state
;
749 struct vmbus_channel_offer_channel offermsg
;
751 * These are based on the OfferMsg.MonitorId.
752 * Save it here for easy access.
757 u32 ringbuffer_gpadlhandle
;
759 /* Allocated memory for ring buffer */
760 void *ringbuffer_pages
;
761 u32 ringbuffer_pagecount
;
762 struct hv_ring_buffer_info outbound
; /* send to parent */
763 struct hv_ring_buffer_info inbound
; /* receive from parent */
764 spinlock_t inbound_lock
;
765 struct workqueue_struct
*controlwq
;
767 struct vmbus_close_msg close_msg
;
769 /* Channel callback are invoked in this workqueue context */
770 /* HANDLE dataWorkQueue; */
772 void (*onchannel_callback
)(void *context
);
773 void *channel_callback_context
;
776 void vmbus_onmessage(void *context
);
778 int vmbus_request_offers(void);
780 /* The format must be the same as struct vmdata_gpa_direct */
781 struct vmbus_channel_packet_page_buffer
{
789 struct hv_page_buffer range
[MAX_PAGE_BUFFER_COUNT
];
792 /* The format must be the same as struct vmdata_gpa_direct */
793 struct vmbus_channel_packet_multipage_buffer
{
800 u32 rangecount
; /* Always 1 in this case */
801 struct hv_multipage_buffer range
;
805 extern int vmbus_open(struct vmbus_channel
*channel
,
806 u32 send_ringbuffersize
,
807 u32 recv_ringbuffersize
,
810 void(*onchannel_callback
)(void *context
),
813 extern void vmbus_close(struct vmbus_channel
*channel
);
815 extern int vmbus_sendpacket(struct vmbus_channel
*channel
,
819 enum vmbus_packet_type type
,
822 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel
*channel
,
823 struct hv_page_buffer pagebuffers
[],
829 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel
*channel
,
830 struct hv_multipage_buffer
*mpb
,
835 extern int vmbus_establish_gpadl(struct vmbus_channel
*channel
,
840 extern int vmbus_teardown_gpadl(struct vmbus_channel
*channel
,
843 extern int vmbus_recvpacket(struct vmbus_channel
*channel
,
846 u32
*buffer_actual_len
,
849 extern int vmbus_recvpacket_raw(struct vmbus_channel
*channel
,
852 u32
*buffer_actual_len
,
856 extern void vmbus_get_debug_info(struct vmbus_channel
*channel
,
857 struct vmbus_channel_debug_info
*debug
);
859 extern void vmbus_ontimer(unsigned long data
);
861 struct hv_dev_port_info
{
865 u32 bytes_avail_toread
;
866 u32 bytes_avail_towrite
;
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 * Common header for Hyper-V ICs
942 #define ICMSGTYPE_NEGOTIATE 0
943 #define ICMSGTYPE_HEARTBEAT 1
944 #define ICMSGTYPE_KVPEXCHANGE 2
945 #define ICMSGTYPE_SHUTDOWN 3
946 #define ICMSGTYPE_TIMESYNC 4
947 #define ICMSGTYPE_VSS 5
949 #define ICMSGHDRFLAG_TRANSACTION 1
950 #define ICMSGHDRFLAG_REQUEST 2
951 #define ICMSGHDRFLAG_RESPONSE 4
953 #define HV_S_OK 0x00000000
954 #define HV_E_FAIL 0x80004005
955 #define HV_S_CONT 0x80070103
956 #define HV_ERROR_NOT_SUPPORTED 0x80070032
957 #define HV_ERROR_MACHINE_LOCKED 0x800704F7
960 * While we want to handle util services as regular devices,
961 * there is only one instance of each of these services; so
962 * we statically allocate the service specific state.
965 struct hv_util_service
{
967 void (*util_cb
)(void *);
968 int (*util_init
)(struct hv_util_service
*);
969 void (*util_deinit
)(void);
972 struct vmbuspipe_hdr
{
983 struct ic_version icverframe
;
985 struct ic_version icvermsg
;
993 struct icmsg_negotiate
{
997 struct ic_version icversion_data
[1]; /* any size array */
1000 struct shutdown_msg_data
{
1002 u32 timeout_seconds
;
1004 u8 display_message
[2048];
1007 struct heartbeat_msg_data
{
1012 /* Time Sync IC defs */
1013 #define ICTIMESYNCFLAG_PROBE 0
1014 #define ICTIMESYNCFLAG_SYNC 1
1015 #define ICTIMESYNCFLAG_SAMPLE 2
1018 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */
1020 #define WLTIMEDELTA 116444736000000000LL
1023 struct ictimesync_data
{
1030 struct hyperv_service_callback
{
1034 struct vmbus_channel
*channel
;
1035 void (*callback
) (void *context
);
1038 extern void vmbus_prep_negotiate_resp(struct icmsg_hdr
*,
1039 struct icmsg_negotiate
*, u8
*);
1041 int hv_kvp_init(struct hv_util_service
*);
1042 void hv_kvp_deinit(void);
1043 void hv_kvp_onchannelcallback(void *);
1045 #endif /* __KERNEL__ */
1046 #endif /* _HYPERV_H */