2 * Copyright (c) 2009-2012 Microsoft Corp.
3 * Copyright (c) 2012 NetApp Inc.
4 * Copyright (c) 2012 Citrix Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * HyperV definitions for messages that are sent between instances of the
33 * Channel Management Library in separate partitions, or in some cases,
40 #include <sys/param.h>
42 #include <sys/queue.h>
43 #include <sys/malloc.h>
44 #include <sys/kthread.h>
45 #include <sys/taskqueue.h>
46 #include <sys/systm.h>
50 #include <sys/mutex.h>
53 #include <vm/vm_param.h>
56 #include <amd64/include/xen/synch_bitops.h>
57 #include <amd64/include/atomic.h>
59 typedef uint8_t hv_bool_uint8_t;
61 #define HV_S_OK 0x00000000
62 #define HV_E_FAIL 0x80004005
63 #define HV_ERROR_NOT_SUPPORTED 0x80070032
64 #define HV_ERROR_MACHINE_LOCKED 0x800704F7
67 * VMBUS version is 32 bit, upper 16 bit for major_number and lower
68 * 16 bit for minor_number.
70 * 0.13 -- Windows Server 2008
75 #define HV_VMBUS_VERSION_WS2008 ((0 << 16) | (13))
76 #define HV_VMBUS_VERSION_WIN7 ((1 << 16) | (1))
77 #define HV_VMBUS_VERSION_WIN8 ((2 << 16) | (4))
78 #define HV_VMBUS_VERSION_WIN8_1 ((3 << 16) | (0))
80 #define HV_VMBUS_VERSION_INVALID -1
82 #define HV_VMBUS_VERSION_CURRENT HV_VMBUS_VERSION_WIN8_1
85 * Make maximum size of pipe payload of 16K
88 #define HV_MAX_PIPE_DATA_PAYLOAD (sizeof(BYTE) * 16384)
91 * Define pipe_mode values
94 #define HV_VMBUS_PIPE_TYPE_BYTE 0x00000000
95 #define HV_VMBUS_PIPE_TYPE_MESSAGE 0x00000004
98 * The size of the user defined data buffer for non-pipe offers
101 #define HV_MAX_USER_DEFINED_BYTES 120
104 * The size of the user defined data buffer for pipe offers
107 #define HV_MAX_PIPE_USER_DEFINED_BYTES 116
110 #define HV_MAX_PAGE_BUFFER_COUNT 32
111 #define HV_MAX_MULTIPAGE_BUFFER_COUNT 32
113 #define HV_ALIGN_UP(value, align) \
114 (((value) & (align-1)) ? \
115 (((value) + (align-1)) & ~(align-1) ) : (value))
117 #define HV_ALIGN_DOWN(value, align) ( (value) & ~(align-1) )
119 #define HV_NUM_PAGES_SPANNED(addr, len) \
120 ((HV_ALIGN_UP(addr+len, PAGE_SIZE) - \
121 HV_ALIGN_DOWN(addr, PAGE_SIZE)) >> PAGE_SHIFT )
123 typedef struct hv_guid {
124 unsigned char data[16];
127 #define HV_NIC_GUID \
128 .data = {0x63, 0x51, 0x61, 0xF8, 0x3E, 0xDF, 0xc5, 0x46, \
129 0x91, 0x3F, 0xF2, 0xD2, 0xF9, 0x65, 0xED, 0x0E}
131 #define HV_IDE_GUID \
132 .data = {0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \
133 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5}
135 #define HV_SCSI_GUID \
136 .data = {0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \
137 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f}
140 * At the center of the Channel Management library is
141 * the Channel Offer. This struct contains the
142 * fundamental information about an offer.
145 typedef struct hv_vmbus_channel_offer {
146 hv_guid interface_type;
147 hv_guid interface_instance;
148 uint64_t interrupt_latency_in_100ns_units;
149 uint32_t interface_revision;
150 uint32_t server_context_area_size; /* in bytes */
151 uint16_t channel_flags;
152 uint16_t mmio_megabytes; /* in bytes * 1024 * 1024 */
156 * Non-pipes: The user has HV_MAX_USER_DEFINED_BYTES bytes.
159 uint8_t user_defined[HV_MAX_USER_DEFINED_BYTES];
163 * Pipes: The following structure is an integrated pipe protocol, which
164 * is implemented on top of standard user-defined data. pipe
165 * clients have HV_MAX_PIPE_USER_DEFINED_BYTES left for their
170 uint8_t user_defined[HV_MAX_PIPE_USER_DEFINED_BYTES];
175 * Sub_channel_index, newly added in Win8.
177 uint16_t sub_channel_index;
180 } __packed hv_vmbus_channel_offer;
182 typedef uint32_t hv_gpadl_handle;
186 uint16_t data_offset8;
189 uint64_t transaction_id;
190 } __packed hv_vm_packet_descriptor;
192 typedef uint32_t hv_previous_packet_offset;
195 hv_previous_packet_offset previous_packet_start_offset;
196 hv_vm_packet_descriptor descriptor;
197 } __packed hv_vm_packet_header;
201 uint32_t byte_offset;
202 } __packed hv_vm_transfer_page;
205 hv_vm_packet_descriptor d;
206 uint16_t transfer_page_set_id;
207 hv_bool_uint8_t sender_owns_set;
209 uint32_t range_count;
210 hv_vm_transfer_page ranges[1];
211 } __packed hv_vm_transfer_page_packet_header;
214 hv_vm_packet_descriptor d;
217 } __packed hv_vm_gpadl_packet_header;
220 hv_vm_packet_descriptor d;
222 uint16_t transfer_page_set_id;
224 } __packed hv_vm_add_remove_transfer_page_set;
227 * This structure defines a range in guest
228 * physical space that can be made
229 * to look virtually contiguous.
234 uint32_t byte_offset;
235 uint64_t pfn_array[0];
236 } __packed hv_gpa_range;
239 * This is the format for an Establish Gpadl packet, which contains a handle
240 * by which this GPADL will be known and a set of GPA ranges associated with
241 * it. This can be converted to a MDL by the guest OS. If there are multiple
242 * GPA ranges, then the resulting MDL will be "chained," representing multiple
247 hv_vm_packet_descriptor d;
249 uint32_t range_count;
250 hv_gpa_range range[1];
251 } __packed hv_vm_establish_gpadl;
254 * This is the format for a Teardown Gpadl packet, which indicates that the
255 * GPADL handle in the Establish Gpadl packet will never be referenced again.
259 hv_vm_packet_descriptor d;
261 /* for alignment to a 8-byte boundary */
263 } __packed hv_vm_teardown_gpadl;
266 * This is the format for a GPA-Direct packet, which contains a set of GPA
267 * ranges, in addition to commands and/or data.
271 hv_vm_packet_descriptor d;
273 uint32_t range_count;
274 hv_gpa_range range[1];
275 } __packed hv_vm_data_gpa_direct;
278 * This is the format for a Additional data Packet.
281 hv_vm_packet_descriptor d;
282 uint64_t total_bytes;
283 uint32_t byte_offset;
286 } __packed hv_vm_additional_data;
289 hv_vm_packet_descriptor simple_header;
290 hv_vm_transfer_page_packet_header transfer_page_header;
291 hv_vm_gpadl_packet_header gpadl_header;
292 hv_vm_add_remove_transfer_page_set add_remove_transfer_page_header;
293 hv_vm_establish_gpadl establish_gpadl_header;
294 hv_vm_teardown_gpadl teardown_gpadl_header;
295 hv_vm_data_gpa_direct data_gpa_direct_header;
296 } __packed hv_vm_packet_largest_possible_header;
299 HV_VMBUS_PACKET_TYPE_INVALID = 0x0,
300 HV_VMBUS_PACKET_TYPES_SYNCH = 0x1,
301 HV_VMBUS_PACKET_TYPE_ADD_TRANSFER_PAGE_SET = 0x2,
302 HV_VMBUS_PACKET_TYPE_REMOVE_TRANSFER_PAGE_SET = 0x3,
303 HV_VMBUS_PACKET_TYPE_ESTABLISH_GPADL = 0x4,
304 HV_VMBUS_PACKET_TYPE_TEAR_DOWN_GPADL = 0x5,
305 HV_VMBUS_PACKET_TYPE_DATA_IN_BAND = 0x6,
306 HV_VMBUS_PACKET_TYPE_DATA_USING_TRANSFER_PAGES = 0x7,
307 HV_VMBUS_PACKET_TYPE_DATA_USING_GPADL = 0x8,
308 HV_VMBUS_PACKET_TYPE_DATA_USING_GPA_DIRECT = 0x9,
309 HV_VMBUS_PACKET_TYPE_CANCEL_REQUEST = 0xa,
310 HV_VMBUS_PACKET_TYPE_COMPLETION = 0xb,
311 HV_VMBUS_PACKET_TYPE_DATA_USING_ADDITIONAL_PACKETS = 0xc,
312 HV_VMBUS_PACKET_TYPE_ADDITIONAL_DATA = 0xd
313 } hv_vmbus_packet_type;
315 #define HV_VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
321 HV_CHANNEL_MESSAGE_INVALID = 0,
322 HV_CHANNEL_MESSAGE_OFFER_CHANNEL = 1,
323 HV_CHANNEL_MESSAGE_RESCIND_CHANNEL_OFFER = 2,
324 HV_CHANNEL_MESSAGE_REQUEST_OFFERS = 3,
325 HV_CHANNEL_MESSAGE_ALL_OFFERS_DELIVERED = 4,
326 HV_CHANNEL_MESSAGE_OPEN_CHANNEL = 5,
327 HV_CHANNEL_MESSAGE_OPEN_CHANNEL_RESULT = 6,
328 HV_CHANNEL_MESSAGE_CLOSE_CHANNEL = 7,
329 HV_CHANNEL_MESSAGEL_GPADL_HEADER = 8,
330 HV_CHANNEL_MESSAGE_GPADL_BODY = 9,
331 HV_CHANNEL_MESSAGE_GPADL_CREATED = 10,
332 HV_CHANNEL_MESSAGE_GPADL_TEARDOWN = 11,
333 HV_CHANNEL_MESSAGE_GPADL_TORNDOWN = 12,
334 HV_CHANNEL_MESSAGE_REL_ID_RELEASED = 13,
335 HV_CHANNEL_MESSAGE_INITIATED_CONTACT = 14,
336 HV_CHANNEL_MESSAGE_VERSION_RESPONSE = 15,
337 HV_CHANNEL_MESSAGE_UNLOAD = 16,
338 HV_CHANNEL_MESSAGE_COUNT
339 } hv_vmbus_channel_msg_type;
342 hv_vmbus_channel_msg_type message_type;
344 } __packed hv_vmbus_channel_msg_header;
347 * Query VMBus Version parameters
350 hv_vmbus_channel_msg_header header;
352 } __packed hv_vmbus_channel_query_vmbus_version;
355 * VMBus Version Supported parameters
358 hv_vmbus_channel_msg_header header;
359 hv_bool_uint8_t version_supported;
360 } __packed hv_vmbus_channel_version_supported;
363 * Channel Offer parameters
366 hv_vmbus_channel_msg_header header;
367 hv_vmbus_channel_offer offer;
368 uint32_t child_rel_id;
371 * This field has been split into a bit field on Win7
374 uint8_t monitor_allocated:1;
377 * Following fields were added in win7 and higher.
378 * Make sure to check the version before accessing these fields.
380 * If "is_dedicated_interrupt" is set, we must not set the
381 * associated bit in the channel bitmap while sending the
382 * interrupt to the host.
384 * connection_id is used in signaling the host.
386 uint16_t is_dedicated_interrupt:1;
387 uint16_t reserved1:15;
388 uint32_t connection_id;
389 } __packed hv_vmbus_channel_offer_channel;
392 * Rescind Offer parameters
396 hv_vmbus_channel_msg_header header;
397 uint32_t child_rel_id;
398 } __packed hv_vmbus_channel_rescind_offer;
402 * Request Offer -- no parameters, SynIC message contains the partition ID
404 * Set Snoop -- no parameters, SynIC message contains the partition ID
406 * Clear Snoop -- no parameters, SynIC message contains the partition ID
408 * All Offers Delivered -- no parameters, SynIC message contains the
411 * Flush Client -- no parameters, SynIC message contains the partition ID
416 * Open Channel parameters
420 hv_vmbus_channel_msg_header header;
423 * Identifies the specific VMBus channel that is being opened.
425 uint32_t child_rel_id;
428 * ID making a particular open request at a channel offer unique.
433 * GPADL for the channel's ring buffer.
435 hv_gpadl_handle ring_buffer_gpadl_handle;
438 * Before win8, all incoming channel interrupts are only
439 * delivered on cpu 0. Setting this value to 0 would
440 * preserve the earlier behavior.
442 uint32_t target_vcpu;
445 * The upstream ring buffer begins at offset zero in the memory described
446 * by ring_buffer_gpadl_handle. The downstream ring buffer follows it at
447 * this offset (in pages).
449 uint32_t downstream_ring_buffer_page_offset;
452 * User-specific data to be passed along to the server endpoint.
454 uint8_t user_data[HV_MAX_USER_DEFINED_BYTES];
456 } __packed hv_vmbus_channel_open_channel;
458 typedef uint32_t hv_nt_status;
461 * Open Channel Result parameters
465 hv_vmbus_channel_msg_header header;
466 uint32_t child_rel_id;
469 } __packed hv_vmbus_channel_open_result;
472 * Close channel parameters
476 hv_vmbus_channel_msg_header header;
477 uint32_t child_rel_id;
478 } __packed hv_vmbus_channel_close_channel;
481 * Channel Message GPADL
483 #define HV_GPADL_TYPE_RING_BUFFER 1
484 #define HV_GPADL_TYPE_SERVER_SAVE_AREA 2
485 #define HV_GPADL_TYPE_TRANSACTION 8
488 * The number of PFNs in a GPADL message is defined by the number of pages
489 * that would be spanned by byte_count and byte_offset. If the implied number
490 * of PFNs won't fit in this packet, there will be a follow-up packet that
495 hv_vmbus_channel_msg_header header;
496 uint32_t child_rel_id;
498 uint16_t range_buf_len;
499 uint16_t range_count;
500 hv_gpa_range range[0];
501 } __packed hv_vmbus_channel_gpadl_header;
504 * This is the follow-up packet that contains more PFNs
507 hv_vmbus_channel_msg_header header;
508 uint32_t message_number;
511 } __packed hv_vmbus_channel_gpadl_body;
514 hv_vmbus_channel_msg_header header;
515 uint32_t child_rel_id;
517 uint32_t creation_status;
518 } __packed hv_vmbus_channel_gpadl_created;
521 hv_vmbus_channel_msg_header header;
522 uint32_t child_rel_id;
524 } __packed hv_vmbus_channel_gpadl_teardown;
527 hv_vmbus_channel_msg_header header;
529 } __packed hv_vmbus_channel_gpadl_torndown;
532 hv_vmbus_channel_msg_header header;
533 uint32_t child_rel_id;
534 } __packed hv_vmbus_channel_relid_released;
537 hv_vmbus_channel_msg_header header;
538 uint32_t vmbus_version_requested;
540 uint64_t interrupt_page;
541 uint64_t monitor_page_1;
542 uint64_t monitor_page_2;
543 } __packed hv_vmbus_channel_initiate_contact;
546 hv_vmbus_channel_msg_header header;
547 hv_bool_uint8_t version_supported;
548 } __packed hv_vmbus_channel_version_response;
550 typedef hv_vmbus_channel_msg_header hv_vmbus_channel_unload;
552 #define HW_MACADDR_LEN 6
555 * Fixme: Added to quiet "typeof" errors involving hv_vmbus.h when
556 * the including C file was compiled with "-std=c99".
559 #define typeof __typeof
563 #define NULL (void *)0
566 typedef void *hv_vmbus_handle;
568 #ifndef CONTAINING_RECORD
569 #define CONTAINING_RECORD(address, type, field) ((type *)( \
570 (uint8_t *)(address) - \
571 (uint8_t *)(&((type *)0)->field)))
572 #endif /* CONTAINING_RECORD */
575 #define container_of(ptr, type, member) ({ \
576 __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
577 (type *)( (char *)__mptr - offsetof(type,member) );})
581 HV_VMBUS_IVAR_INSTANCE,
586 #define HV_VMBUS_ACCESSOR(var, ivar, type) \
587 __BUS_ACCESSOR(vmbus, var, HV_VMBUS, ivar, type)
589 HV_VMBUS_ACCESSOR(type, TYPE, const char *)
590 HV_VMBUS_ACCESSOR(devctx, DEVCTX, struct hv_device *)
594 * Common defines for Hyper-V ICs
596 #define HV_ICMSGTYPE_NEGOTIATE 0
597 #define HV_ICMSGTYPE_HEARTBEAT 1
598 #define HV_ICMSGTYPE_KVPEXCHANGE 2
599 #define HV_ICMSGTYPE_SHUTDOWN 3
600 #define HV_ICMSGTYPE_TIMESYNC 4
601 #define HV_ICMSGTYPE_VSS 5
603 #define HV_ICMSGHDRFLAG_TRANSACTION 1
604 #define HV_ICMSGHDRFLAG_REQUEST 2
605 #define HV_ICMSGHDRFLAG_RESPONSE 4
607 typedef struct hv_vmbus_pipe_hdr {
610 } __packed hv_vmbus_pipe_hdr;
612 typedef struct hv_vmbus_ic_version {
615 } __packed hv_vmbus_ic_version;
617 typedef struct hv_vmbus_icmsg_hdr {
618 hv_vmbus_ic_version icverframe;
620 hv_vmbus_ic_version icvermsg;
623 uint8_t ictransaction_id;
626 } __packed hv_vmbus_icmsg_hdr;
628 typedef struct hv_vmbus_icmsg_negotiate {
629 uint16_t icframe_vercnt;
630 uint16_t icmsg_vercnt;
632 hv_vmbus_ic_version icversion_data[1]; /* any size array */
633 } __packed hv_vmbus_icmsg_negotiate;
635 typedef struct hv_vmbus_shutdown_msg_data {
636 uint32_t reason_code;
637 uint32_t timeout_seconds;
639 uint8_t display_message[2048];
640 } __packed hv_vmbus_shutdown_msg_data;
642 typedef struct hv_vmbus_heartbeat_msg_data {
644 uint32_t reserved[8];
645 } __packed hv_vmbus_heartbeat_msg_data;
649 * offset in bytes from the start of ring data below
651 volatile uint32_t write_index;
653 * offset in bytes from the start of ring data below
655 volatile uint32_t read_index;
657 * NOTE: The interrupt_mask field is used only for channels, but
658 * vmbus connection also uses this data structure
660 volatile uint32_t interrupt_mask;
661 /* pad it to PAGE_SIZE so that data starts on a page */
662 uint8_t reserved[4084];
665 * WARNING: Ring data starts here + ring_data_start_offset
666 * !!! DO NOT place any fields below this !!!
668 uint8_t buffer[0]; /* doubles as interrupt mask */
669 } __packed hv_vmbus_ring_buffer;
675 } __packed hv_vmbus_page_buffer;
680 uint64_t pfn_array[HV_MAX_MULTIPAGE_BUFFER_COUNT];
681 } __packed hv_vmbus_multipage_buffer;
684 hv_vmbus_ring_buffer* ring_buffer;
685 uint32_t ring_size; /* Include the shared header */
686 struct mtx ring_lock;
687 uint32_t ring_data_size; /* ring_size */
688 uint32_t ring_data_start_offset;
689 } hv_vmbus_ring_buffer_info;
691 typedef void (*hv_vmbus_pfn_channel_callback)(void *context);
692 typedef void (*hv_vmbus_sc_creation_callback)(void *context);
695 HV_CHANNEL_OFFER_STATE,
696 HV_CHANNEL_OPENING_STATE,
697 HV_CHANNEL_OPEN_STATE,
698 HV_CHANNEL_OPENED_STATE,
699 HV_CHANNEL_CLOSING_NONDESTRUCTIVE_STATE,
700 } hv_vmbus_channel_state;
703 * Connection identifier type
706 uint32_t as_uint32_t;
712 } __packed hv_vmbus_connection_id;
715 * Definition of the hv_vmbus_signal_event hypercall input structure
718 hv_vmbus_connection_id connection_id;
719 uint16_t flag_number;
721 } __packed hv_vmbus_input_signal_event;
725 hv_vmbus_input_signal_event event;
726 } __packed hv_vmbus_input_signal_event_buffer;
728 typedef struct hv_vmbus_channel {
729 TAILQ_ENTRY(hv_vmbus_channel) list_entry;
730 struct hv_device* device;
731 hv_vmbus_channel_state state;
732 hv_vmbus_channel_offer_channel offer_msg;
734 * These are based on the offer_msg.monitor_id.
735 * Save it here for easy access.
737 uint8_t monitor_group;
740 uint32_t ring_buffer_gpadl_handle;
742 * Allocated memory for ring buffer
744 void* ring_buffer_pages;
745 unsigned long ring_buffer_size;
746 uint32_t ring_buffer_page_count;
750 hv_vmbus_ring_buffer_info outbound;
752 * receive from parent
754 hv_vmbus_ring_buffer_info inbound;
756 struct mtx inbound_lock;
758 struct taskqueue * rxq;
759 struct task channel_task;
760 hv_vmbus_pfn_channel_callback on_channel_callback;
761 void* channel_callback_context;
764 * If batched_reading is set to "true", mask the interrupt
765 * and read until the channel is empty.
766 * If batched_reading is set to "false", the channel is not
767 * going to perform batched reading.
769 * Batched reading is enabled by default; specific
770 * drivers that don't want this behavior can turn it off.
772 boolean_t batched_reading;
774 boolean_t is_dedicated_interrupt;
777 * Used as an input param for HV_CALL_SIGNAL_EVENT hypercall.
779 hv_vmbus_input_signal_event_buffer signal_event_buffer;
781 * 8-bytes aligned of the buffer above
783 hv_vmbus_input_signal_event *signal_event_param;
786 * From Win8, this field specifies the target virtual process
787 * on which to deliver the interupt from the host to guest.
788 * Before Win8, all channel interrupts would only be
789 * delivered on cpu 0. Setting this value to 0 would preserve
790 * the earlier behavior.
792 uint32_t target_vcpu;
793 /* The corresponding CPUID in the guest */
797 * Support for multi-channels.
798 * The initial offer is considered the primary channel and this
799 * offer message will indicate if the host supports multi-channels.
800 * The guest is free to ask for multi-channels to be offerred and can
801 * open these multi-channels as a normal "primary" channel. However,
802 * all multi-channels will have the same type and instance guids as the
803 * primary channel. Requests sent on a given channel will result in a
804 * response on the same channel.
808 * Multi-channel creation callback. This callback will be called in
809 * process context when a Multi-channel offer is received from the host.
810 * The guest can open the Multi-channel in the context of this callback.
812 hv_vmbus_sc_creation_callback sc_creation_callback;
817 * Link list of all the multi-channels if this is a primary channel
819 TAILQ_HEAD(, hv_vmbus_channel) sc_list_anchor;
820 TAILQ_ENTRY(hv_vmbus_channel) sc_list_entry;
823 * The primary channel this sub-channle belongs to.
824 * This will be NULL for the primary channel.
826 struct hv_vmbus_channel *primary_channel;
828 * Support per channel state for use by vmbus drivers.
830 void *per_channel_state;
834 hv_set_channel_read_state(hv_vmbus_channel* channel, boolean_t state)
836 channel->batched_reading = state;
839 typedef struct hv_device {
843 hv_vmbus_channel* channel;
848 int hv_vmbus_channel_recv_packet(
849 hv_vmbus_channel* channel,
852 uint32_t* buffer_actual_len,
853 uint64_t* request_id);
855 int hv_vmbus_channel_recv_packet_raw(
856 hv_vmbus_channel* channel,
859 uint32_t* buffer_actual_len,
860 uint64_t* request_id);
862 int hv_vmbus_channel_open(
863 hv_vmbus_channel* channel,
864 uint32_t send_ring_buffer_size,
865 uint32_t recv_ring_buffer_size,
867 uint32_t user_data_len,
868 hv_vmbus_pfn_channel_callback
869 pfn_on_channel_callback,
872 void hv_vmbus_channel_close(hv_vmbus_channel *channel);
874 int hv_vmbus_channel_send_packet(
875 hv_vmbus_channel* channel,
879 hv_vmbus_packet_type type,
882 int hv_vmbus_channel_send_packet_pagebuffer(
883 hv_vmbus_channel* channel,
884 hv_vmbus_page_buffer page_buffers[],
888 uint64_t request_id);
890 int hv_vmbus_channel_send_packet_multipagebuffer(
891 hv_vmbus_channel* channel,
892 hv_vmbus_multipage_buffer* multi_page_buffer,
895 uint64_t request_id);
897 int hv_vmbus_channel_establish_gpadl(
898 hv_vmbus_channel* channel,
899 /* must be phys and virt contiguous */
901 /* page-size multiple */
903 uint32_t* gpadl_handle);
905 int hv_vmbus_channel_teardown_gpdal(
906 hv_vmbus_channel* channel,
907 uint32_t gpadl_handle);
909 struct hv_vmbus_channel* vmbus_select_outgoing_channel(struct hv_vmbus_channel *promary);
912 * @brief Get physical address from virtual
914 static inline unsigned long
915 hv_get_phys_addr(void *virt)
918 ret = (vtophys(virt) | ((vm_offset_t) virt & PAGE_MASK));
922 extern uint32_t hv_vmbus_protocal_version;
923 #endif /* __HYPERV_H__ */