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, see <http://www.gnu.org/licenses/>.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 * K. Y. Srinivasan <kys@microsoft.com>
27 #include <linux/list.h>
28 #include <linux/hyperv.h>
29 #include <linux/rndis.h>
32 #define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203 /* query only */
33 #define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204 /* query and set */
35 #define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88
36 #define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89
38 #define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
39 #define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
41 struct ndis_obj_header
{
47 /* ndis_recv_scale_cap/cap_flag */
48 #define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
49 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR 0x02000000
50 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC 0x04000000
51 #define NDIS_RSS_CAPS_USING_MSI_X 0x08000000
52 #define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS 0x10000000
53 #define NDIS_RSS_CAPS_SUPPORTS_MSI_X 0x20000000
54 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4 0x00000100
55 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6 0x00000200
56 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX 0x00000400
58 struct ndis_recv_scale_cap
{ /* NDIS_RECEIVE_SCALE_CAPABILITIES */
59 struct ndis_obj_header hdr
;
63 u16 num_indirect_tabent
;
67 /* ndis_recv_scale_param flags */
68 #define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED 0x0001
69 #define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED 0x0002
70 #define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED 0x0004
71 #define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED 0x0008
72 #define NDIS_RSS_PARAM_FLAG_DISABLE_RSS 0x0010
75 #define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
76 #define NDIS_HASH_IPV4 0x00000100
77 #define NDIS_HASH_TCP_IPV4 0x00000200
78 #define NDIS_HASH_IPV6 0x00000400
79 #define NDIS_HASH_IPV6_EX 0x00000800
80 #define NDIS_HASH_TCP_IPV6 0x00001000
81 #define NDIS_HASH_TCP_IPV6_EX 0x00002000
83 #define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
84 #define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2 40
87 #define HASH_KEYLEN NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2
88 extern u8 netvsc_hash_key
[];
90 struct ndis_recv_scale_param
{ /* NDIS_RECEIVE_SCALE_PARAMETERS */
91 struct ndis_obj_header hdr
;
93 /* Qualifies the rest of the information */
96 /* The base CPU number to do receive processing. not used */
99 /* This describes the hash function and type being enabled */
102 /* The size of indirection table array */
103 u16 indirect_tabsize
;
105 /* The offset of the indirection table from the beginning of this
108 u32 indirect_taboffset
;
110 /* The size of the hash secret key */
113 /* The offset of the secret key from the beginning of this structure */
116 u32 processor_masks_offset
;
117 u32 num_processor_masks
;
118 u32 processor_masks_entry_size
;
121 /* Fwd declaration */
122 struct ndis_tcp_ip_checksum_info
;
125 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
128 * The size of this structure is less than 48 bytes and we can now
129 * place this structure in the skb->cb field.
131 struct hv_netvsc_packet
{
132 /* Bookkeeping stuff */
133 u8 cp_partial
; /* partial copy into send buffer */
135 u8 rmsg_size
; /* RNDIS header and PPI size */
136 u8 rmsg_pgcnt
; /* page count of RNDIS header and PPI */
142 u32 total_data_buflen
;
145 struct netvsc_device_info
{
146 unsigned char mac_adr
[ETH_ALEN
];
147 bool link_state
; /* 0 - link up, 1 - link down */
149 u32 max_num_vrss_chns
;
153 enum rndis_device_state
{
154 RNDIS_DEV_UNINITIALIZED
= 0,
155 RNDIS_DEV_INITIALIZING
,
156 RNDIS_DEV_INITIALIZED
,
157 RNDIS_DEV_DATAINITIALIZED
,
160 struct rndis_device
{
161 struct net_device
*ndev
;
163 enum rndis_device_state state
;
167 spinlock_t request_lock
;
168 struct list_head req_list
;
170 unsigned char hw_mac_adr
[ETH_ALEN
];
175 struct rndis_message
;
176 struct netvsc_device
;
177 int netvsc_device_add(struct hv_device
*device
, void *additional_info
);
178 int netvsc_device_remove(struct hv_device
*device
);
179 int netvsc_send(struct hv_device
*device
,
180 struct hv_netvsc_packet
*packet
,
181 struct rndis_message
*rndis_msg
,
182 struct hv_page_buffer
**page_buffer
,
183 struct sk_buff
*skb
);
184 void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
185 struct rndis_message
*resp
);
186 int netvsc_recv_callback(struct hv_device
*device_obj
,
187 struct hv_netvsc_packet
*packet
,
189 struct ndis_tcp_ip_checksum_info
*csum_info
,
190 struct vmbus_channel
*channel
,
192 void netvsc_channel_cb(void *context
);
193 int rndis_filter_open(struct netvsc_device
*nvdev
);
194 int rndis_filter_close(struct netvsc_device
*nvdev
);
195 int rndis_filter_device_add(struct hv_device
*dev
,
196 void *additional_info
);
197 void rndis_filter_device_remove(struct hv_device
*dev
);
198 int rndis_filter_receive(struct hv_device
*dev
,
199 struct hv_netvsc_packet
*pkt
,
201 struct vmbus_channel
*channel
);
203 int rndis_filter_set_packet_filter(struct rndis_device
*dev
, u32 new_filter
);
204 int rndis_filter_set_device_mac(struct net_device
*ndev
, char *mac
);
206 void netvsc_switch_datapath(struct net_device
*nv_dev
, bool vf
);
208 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
210 #define NVSP_PROTOCOL_VERSION_1 2
211 #define NVSP_PROTOCOL_VERSION_2 0x30002
212 #define NVSP_PROTOCOL_VERSION_4 0x40000
213 #define NVSP_PROTOCOL_VERSION_5 0x50000
216 NVSP_MSG_TYPE_NONE
= 0,
219 NVSP_MSG_TYPE_INIT
= 1,
220 NVSP_MSG_TYPE_INIT_COMPLETE
= 2,
222 NVSP_VERSION_MSG_START
= 100,
224 /* Version 1 Messages */
225 NVSP_MSG1_TYPE_SEND_NDIS_VER
= NVSP_VERSION_MSG_START
,
227 NVSP_MSG1_TYPE_SEND_RECV_BUF
,
228 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE
,
229 NVSP_MSG1_TYPE_REVOKE_RECV_BUF
,
231 NVSP_MSG1_TYPE_SEND_SEND_BUF
,
232 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE
,
233 NVSP_MSG1_TYPE_REVOKE_SEND_BUF
,
235 NVSP_MSG1_TYPE_SEND_RNDIS_PKT
,
236 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE
,
238 /* Version 2 messages */
239 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF
,
240 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP
,
241 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF
,
243 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION
,
245 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY
,
246 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP
,
248 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT
,
250 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT
,
251 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP
,
253 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ
,
254 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP
,
256 NVSP_MSG2_TYPE_ALLOC_RXBUF
,
257 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP
,
259 NVSP_MSG2_TYPE_FREE_RXBUF
,
261 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT
,
262 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP
,
264 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG
,
266 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE
,
267 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
269 NVSP_MSG2_MAX
= NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
271 /* Version 4 messages */
272 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION
,
273 NVSP_MSG4_TYPE_SWITCH_DATA_PATH
,
274 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
276 NVSP_MSG4_MAX
= NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
278 /* Version 5 messages */
279 NVSP_MSG5_TYPE_OID_QUERY_EX
,
280 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP
,
281 NVSP_MSG5_TYPE_SUBCHANNEL
,
282 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
284 NVSP_MSG5_MAX
= NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
291 NVSP_STAT_PROTOCOL_TOO_NEW
,
292 NVSP_STAT_PROTOCOL_TOO_OLD
,
293 NVSP_STAT_INVALID_RNDIS_PKT
,
295 NVSP_STAT_PROTOCOL_UNSUPPORTED
,
299 struct nvsp_message_header
{
306 * This message is used by the VSC to initialize the channel after the channels
307 * has been opened. This message should never include anything other then
308 * versioning (i.e. this message will be the same for ever).
310 struct nvsp_message_init
{
311 u32 min_protocol_ver
;
312 u32 max_protocol_ver
;
316 * This message is used by the VSP to complete the initialization of the
317 * channel. This message should never include anything other then versioning
318 * (i.e. this message will be the same for ever).
320 struct nvsp_message_init_complete
{
321 u32 negotiated_protocol_ver
;
322 u32 max_mdl_chain_len
;
326 union nvsp_message_init_uber
{
327 struct nvsp_message_init init
;
328 struct nvsp_message_init_complete init_complete
;
331 /* Version 1 Messages */
334 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
335 * can use this information when handling OIDs sent by the VSC.
337 struct nvsp_1_message_send_ndis_version
{
343 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
344 * can then use the receive buffer to send data to the VSC.
346 struct nvsp_1_message_send_receive_buffer
{
351 struct nvsp_1_receive_buffer_section
{
359 * This message is used by the VSP to acknowledge a receive buffer send by the
360 * VSC. This message must be sent by the VSP before the VSP uses the receive
363 struct nvsp_1_message_send_receive_buffer_complete
{
368 * The receive buffer is split into two parts, a large suballocation
369 * section and a small suballocation section. These sections are then
370 * suballocated by a certain size.
374 * For example, the following break up of the receive buffer has 6
375 * large suballocations and 10 small suballocations.
379 * | Large Section | | Small Section |
380 * ------------------------------------------------------------
381 * | | | | | | | | | | | | | | | | | |
383 * LargeOffset SmallOffset
386 struct nvsp_1_receive_buffer_section sections
[1];
390 * This message is sent by the VSC to revoke the receive buffer. After the VSP
391 * completes this transaction, the vsp should never use the receive buffer
394 struct nvsp_1_message_revoke_receive_buffer
{
399 * This message is used by the VSC to send a send buffer to the VSP. The VSC
400 * can then use the send buffer to send data to the VSP.
402 struct nvsp_1_message_send_send_buffer
{
408 * This message is used by the VSP to acknowledge a send buffer sent by the
409 * VSC. This message must be sent by the VSP before the VSP uses the sent
412 struct nvsp_1_message_send_send_buffer_complete
{
416 * The VSC gets to choose the size of the send buffer and the VSP gets
417 * to choose the sections size of the buffer. This was done to enable
418 * dynamic reconfigurations when the cost of GPA-direct buffers
425 * This message is sent by the VSC to revoke the send buffer. After the VSP
426 * completes this transaction, the vsp should never use the send buffer again.
428 struct nvsp_1_message_revoke_send_buffer
{
433 * This message is used by both the VSP and the VSC to send a RNDIS message to
434 * the opposite channel endpoint.
436 struct nvsp_1_message_send_rndis_packet
{
438 * This field is specified by RNIDS. They assume there's two different
439 * channels of communication. However, the Network VSP only has one.
440 * Therefore, the channel travels with the RNDIS packet.
445 * This field is used to send part or all of the data through a send
446 * buffer. This values specifies an index into the send buffer. If the
447 * index is 0xFFFFFFFF, then the send buffer is not being used and all
448 * of the data was sent through other VMBus mechanisms.
450 u32 send_buf_section_index
;
451 u32 send_buf_section_size
;
455 * This message is used by both the VSP and the VSC to complete a RNDIS message
456 * to the opposite channel endpoint. At this point, the initiator of this
457 * message cannot use any resources associated with the original RNDIS packet.
459 struct nvsp_1_message_send_rndis_packet_complete
{
463 union nvsp_1_message_uber
{
464 struct nvsp_1_message_send_ndis_version send_ndis_ver
;
466 struct nvsp_1_message_send_receive_buffer send_recv_buf
;
467 struct nvsp_1_message_send_receive_buffer_complete
468 send_recv_buf_complete
;
469 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf
;
471 struct nvsp_1_message_send_send_buffer send_send_buf
;
472 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete
;
473 struct nvsp_1_message_revoke_send_buffer revoke_send_buf
;
475 struct nvsp_1_message_send_rndis_packet send_rndis_pkt
;
476 struct nvsp_1_message_send_rndis_packet_complete
477 send_rndis_pkt_complete
;
482 * Network VSP protocol version 2 messages:
484 struct nvsp_2_vsc_capability
{
492 u64 correlation_id
:1;
497 struct nvsp_2_send_ndis_config
{
500 struct nvsp_2_vsc_capability capability
;
503 /* Allocate receive buffer */
504 struct nvsp_2_alloc_rxbuf
{
505 /* Allocation ID to match the allocation request and response */
508 /* Length of the VM shared memory receive buffer that needs to
514 /* Allocate receive buffer complete */
515 struct nvsp_2_alloc_rxbuf_comp
{
516 /* The NDIS_STATUS code for buffer allocation */
521 /* GPADL handle for the allocated receive buffer */
524 /* Receive buffer ID */
528 struct nvsp_2_free_rxbuf
{
532 union nvsp_2_message_uber
{
533 struct nvsp_2_send_ndis_config send_ndis_config
;
534 struct nvsp_2_alloc_rxbuf alloc_rxbuf
;
535 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp
;
536 struct nvsp_2_free_rxbuf free_rxbuf
;
539 struct nvsp_4_send_vf_association
{
540 /* 1: allocated, serial number is valid. 0: not allocated */
543 /* Serial number of the VF to team with */
547 enum nvsp_vm_datapath
{
548 NVSP_DATAPATH_SYNTHETIC
= 0,
553 struct nvsp_4_sw_datapath
{
554 u32 active_datapath
; /* active data path in VM */
557 union nvsp_4_message_uber
{
558 struct nvsp_4_send_vf_association vf_assoc
;
559 struct nvsp_4_sw_datapath active_dp
;
562 enum nvsp_subchannel_operation
{
563 NVSP_SUBCHANNEL_NONE
= 0,
564 NVSP_SUBCHANNEL_ALLOCATE
,
568 struct nvsp_5_subchannel_request
{
573 struct nvsp_5_subchannel_complete
{
575 u32 num_subchannels
; /* Actual number of subchannels allocated */
578 struct nvsp_5_send_indirect_table
{
579 /* The number of entries in the send indirection table */
582 /* The offset of the send indireciton table from top of this struct.
583 * The send indirection table tells which channel to put the send
584 * traffic on. Each entry is a channel number.
589 union nvsp_5_message_uber
{
590 struct nvsp_5_subchannel_request subchn_req
;
591 struct nvsp_5_subchannel_complete subchn_comp
;
592 struct nvsp_5_send_indirect_table send_table
;
595 union nvsp_all_messages
{
596 union nvsp_message_init_uber init_msg
;
597 union nvsp_1_message_uber v1_msg
;
598 union nvsp_2_message_uber v2_msg
;
599 union nvsp_4_message_uber v4_msg
;
600 union nvsp_5_message_uber v5_msg
;
604 struct nvsp_message
{
605 struct nvsp_message_header hdr
;
606 union nvsp_all_messages msg
;
610 #define NETVSC_MTU 65536
611 #define NETVSC_MTU_MIN 68
613 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
614 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
615 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
616 #define NETVSC_INVALID_INDEX -1
619 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
620 #define NETVSC_SEND_BUFFER_ID 0
622 #define NETVSC_PACKET_SIZE 4096
624 #define VRSS_SEND_TAB_SIZE 16
625 #define VRSS_CHANNEL_MAX 64
627 #define RNDIS_MAX_PKT_DEFAULT 8
628 #define RNDIS_PKT_ALIGN_DEFAULT 8
630 struct multi_send_data
{
631 struct sk_buff
*skb
; /* skb containing the pkt */
632 struct hv_netvsc_packet
*pkt
; /* netvsc pkt pending */
633 u32 count
; /* counter of batched packets */
636 struct netvsc_stats
{
639 struct u64_stats_sync syncp
;
642 struct netvsc_reconfig
{
643 struct list_head list
;
647 /* The context of the netvsc device */
648 struct net_device_context
{
649 /* point back to our device context */
650 struct hv_device
*device_ctx
;
652 struct netvsc_device
*nvdev
;
653 /* reconfigure work */
654 struct delayed_work dwork
;
655 /* last reconfig time */
656 unsigned long last_reconfig
;
657 /* reconfig events */
658 struct list_head reconfig_events
;
659 /* list protection */
662 struct work_struct work
;
663 u32 msg_enable
; /* debug level */
665 struct netvsc_stats __percpu
*tx_stats
;
666 struct netvsc_stats __percpu
*rx_stats
;
668 /* Ethtool settings */
672 /* the device is going away */
675 /* State to manage the associated VF interface. */
676 struct net_device
*vf_netdev
;
679 /* 1: allocated, serial number is valid. 0: not allocated */
681 /* Serial number of the VF to team with */
685 /* Per netvsc device */
686 struct netvsc_device
{
689 atomic_t num_outstanding_sends
;
690 wait_queue_head_t wait_drain
;
693 /* Receive buffer allocated by us but manages by NetVSP */
696 u32 recv_buf_gpadl_handle
;
697 u32 recv_section_cnt
;
698 struct nvsp_1_receive_buffer_section
*recv_section
;
700 /* Send buffer allocated by us */
703 u32 send_buf_gpadl_handle
;
704 u32 send_section_cnt
;
705 u32 send_section_size
;
706 unsigned long *send_section_map
;
709 /* Used for NetVSP initialization protocol */
710 struct completion channel_init_wait
;
711 struct nvsp_message channel_init_pkt
;
713 struct nvsp_message revoke_packet
;
714 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
716 struct vmbus_channel
*chn_table
[VRSS_CHANNEL_MAX
];
717 u32 send_table
[VRSS_SEND_TAB_SIZE
];
720 spinlock_t sc_lock
; /* Protects num_sc_offered variable */
722 atomic_t queue_sends
[VRSS_CHANNEL_MAX
];
724 /* Holds rndis device info */
729 /* The primary channel callback buffer */
730 unsigned char *cb_buffer
;
731 /* The sub channel callback buffer */
732 unsigned char *sub_cb_buf
;
734 struct multi_send_data msd
[VRSS_CHANNEL_MAX
];
735 u32 max_pkt
; /* max number of pkt in one send, e.g. 8 */
736 u32 pkt_align
; /* alignment bytes, e.g. 8 */
741 static inline struct netvsc_device
*
742 net_device_to_netvsc_device(struct net_device
*ndev
)
744 return ((struct net_device_context
*)netdev_priv(ndev
))->nvdev
;
747 static inline struct netvsc_device
*
748 hv_device_to_netvsc_device(struct hv_device
*device
)
750 return net_device_to_netvsc_device(hv_get_drvdata(device
));
753 /* NdisInitialize message */
754 struct rndis_initialize_request
{
761 /* Response to NdisInitialize */
762 struct rndis_initialize_complete
{
771 u32 pkt_alignment_factor
;
776 /* Call manager devices only: Information about an address family */
777 /* supported by the device is appended to the response to NdisInitialize. */
778 struct rndis_co_address_family
{
784 /* NdisHalt message */
785 struct rndis_halt_request
{
789 /* NdisQueryRequest message */
790 struct rndis_query_request
{
798 /* Response to NdisQueryRequest */
799 struct rndis_query_complete
{
806 /* NdisSetRequest message */
807 struct rndis_set_request
{
815 /* Response to NdisSetRequest */
816 struct rndis_set_complete
{
821 /* NdisReset message */
822 struct rndis_reset_request
{
826 /* Response to NdisReset */
827 struct rndis_reset_complete
{
829 u32 addressing_reset
;
832 /* NdisMIndicateStatus message */
833 struct rndis_indicate_status
{
836 u32 status_buf_offset
;
839 /* Diagnostic information passed as the status buffer in */
840 /* struct rndis_indicate_status messages signifying error conditions. */
841 struct rndis_diagnostic_info
{
846 /* NdisKeepAlive message */
847 struct rndis_keepalive_request
{
851 /* Response to NdisKeepAlive */
852 struct rndis_keepalive_complete
{
858 * Data message. All Offset fields contain byte offsets from the beginning of
859 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
860 * to 0 for connectionless data, otherwise it contains the VC handle.
862 struct rndis_packet
{
867 u32 num_oob_data_elements
;
868 u32 per_pkt_info_offset
;
869 u32 per_pkt_info_len
;
874 /* Optional Out of Band data associated with a Data message. */
878 u32 class_info_offset
;
881 /* Packet extension field contents associated with a Data message. */
882 struct rndis_per_packet_info
{
888 enum ndis_per_pkt_info_type
{
889 TCPIP_CHKSUM_PKTINFO
,
891 TCP_LARGESEND_PKTINFO
,
892 CLASSIFICATION_HANDLE_PKTINFO
,
898 NBL_HASH_VALUE
= PACKET_CANCEL_ID
,
899 ORIGINAL_NET_BUFLIST
,
905 struct ndis_pkt_8021q_info
{
908 u32 pri
:3; /* User Priority */
909 u32 cfi
:1; /* Canonical Format ID */
910 u32 vlanid
:12; /* VLAN ID */
917 struct ndis_oject_header
{
923 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
924 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
925 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
926 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
927 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
928 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
929 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
930 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
931 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
932 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
933 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
934 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
936 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
937 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
938 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
940 #define VERSION_4_OFFLOAD_SIZE 22
942 * New offload OIDs for NDIS 6
944 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
945 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
946 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
947 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
948 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
949 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
951 struct ndis_offload_params
{
952 struct ndis_oject_header header
;
962 u8 tcp_connection_ip_v4
;
963 u8 tcp_connection_ip_v6
;
972 u8 encapsulated_packet_task_offload
;
973 u8 encapsulation_types
;
977 struct ndis_tcp_ip_checksum_info
{
984 u32 ip_header_checksum
:1;
986 u32 tcp_header_offset
:10;
989 u32 tcp_checksum_failed
:1;
990 u32 udp_checksum_failed
:1;
991 u32 ip_checksum_failed
:1;
992 u32 tcp_checksum_succeeded
:1;
993 u32 udp_checksum_succeeded
:1;
994 u32 ip_checksum_succeeded
:1;
996 u32 tcp_checksum_value_invalid
:1;
997 u32 ip_checksum_value_invalid
:1;
1003 struct ndis_tcp_lso_info
{
1012 u32 tcp_header_offset
:10;
1020 } lso_v1_transmit_complete
;
1023 u32 tcp_header_offset
:10;
1031 } lso_v2_transmit_complete
;
1036 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1037 sizeof(struct ndis_pkt_8021q_info))
1039 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1040 sizeof(struct ndis_tcp_ip_checksum_info))
1042 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1043 sizeof(struct ndis_tcp_lso_info))
1045 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1048 /* Total size of all PPI data */
1049 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1050 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1052 /* Format of Information buffer passed in a SetRequest for the OID */
1053 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1054 struct rndis_config_parameter_info
{
1055 u32 parameter_name_offset
;
1056 u32 parameter_name_length
;
1058 u32 parameter_value_offset
;
1059 u32 parameter_value_length
;
1062 /* Values for ParameterType in struct rndis_config_parameter_info */
1063 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1064 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1066 /* CONDIS Miniport messages for connection oriented devices */
1067 /* that do not implement a call manager. */
1069 /* CoNdisMiniportCreateVc message */
1070 struct rcondis_mp_create_vc
{
1075 /* Response to CoNdisMiniportCreateVc */
1076 struct rcondis_mp_create_vc_complete
{
1082 /* CoNdisMiniportDeleteVc message */
1083 struct rcondis_mp_delete_vc
{
1088 /* Response to CoNdisMiniportDeleteVc */
1089 struct rcondis_mp_delete_vc_complete
{
1094 /* CoNdisMiniportQueryRequest message */
1095 struct rcondis_mp_query_request
{
1101 u32 info_buf_offset
;
1104 /* CoNdisMiniportSetRequest message */
1105 struct rcondis_mp_set_request
{
1111 u32 info_buf_offset
;
1114 /* CoNdisIndicateStatus message */
1115 struct rcondis_indicate_status
{
1119 u32 status_buf_offset
;
1122 /* CONDIS Call/VC parameters */
1123 struct rcondis_specific_parameters
{
1125 u32 parameter_length
;
1126 u32 parameter_lffset
;
1129 struct rcondis_media_parameters
{
1133 struct rcondis_specific_parameters media_specific
;
1136 struct rndis_flowspec
{
1138 u32 token_bucket_size
;
1141 u32 delay_variation
;
1144 u32 minimum_policed_size
;
1147 struct rcondis_call_manager_parameters
{
1148 struct rndis_flowspec transmit
;
1149 struct rndis_flowspec receive
;
1150 struct rcondis_specific_parameters call_mgr_specific
;
1153 /* CoNdisMiniportActivateVc message */
1154 struct rcondis_mp_activate_vc_request
{
1158 u32 media_params_offset
;
1159 u32 media_params_length
;
1160 u32 call_mgr_params_offset
;
1161 u32 call_mgr_params_length
;
1164 /* Response to CoNdisMiniportActivateVc */
1165 struct rcondis_mp_activate_vc_complete
{
1170 /* CoNdisMiniportDeactivateVc message */
1171 struct rcondis_mp_deactivate_vc_request
{
1177 /* Response to CoNdisMiniportDeactivateVc */
1178 struct rcondis_mp_deactivate_vc_complete
{
1184 /* union with all of the RNDIS messages */
1185 union rndis_message_container
{
1186 struct rndis_packet pkt
;
1187 struct rndis_initialize_request init_req
;
1188 struct rndis_halt_request halt_req
;
1189 struct rndis_query_request query_req
;
1190 struct rndis_set_request set_req
;
1191 struct rndis_reset_request reset_req
;
1192 struct rndis_keepalive_request keep_alive_req
;
1193 struct rndis_indicate_status indicate_status
;
1194 struct rndis_initialize_complete init_complete
;
1195 struct rndis_query_complete query_complete
;
1196 struct rndis_set_complete set_complete
;
1197 struct rndis_reset_complete reset_complete
;
1198 struct rndis_keepalive_complete keep_alive_complete
;
1199 struct rcondis_mp_create_vc co_miniport_create_vc
;
1200 struct rcondis_mp_delete_vc co_miniport_delete_vc
;
1201 struct rcondis_indicate_status co_indicate_status
;
1202 struct rcondis_mp_activate_vc_request co_miniport_activate_vc
;
1203 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc
;
1204 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete
;
1205 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete
;
1206 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete
;
1207 struct rcondis_mp_deactivate_vc_complete
1208 co_miniport_deactivate_vc_complete
;
1211 /* Remote NDIS message format */
1212 struct rndis_message
{
1215 /* Total length of this message, from the beginning */
1216 /* of the sruct rndis_message, in bytes. */
1219 /* Actual message */
1220 union rndis_message_container msg
;
1226 /* get the size of an RNDIS message. Pass in the message type, */
1227 /* struct rndis_set_request, struct rndis_packet for example */
1228 #define RNDIS_MESSAGE_SIZE(msg) \
1229 (sizeof(msg) + (sizeof(struct rndis_message) - \
1230 sizeof(union rndis_message_container)))
1232 /* get pointer to info buffer with message pointer */
1233 #define MESSAGE_TO_INFO_BUFFER(msg) \
1234 (((unsigned char *)(msg)) + msg->info_buf_offset)
1236 /* get pointer to status buffer with message pointer */
1237 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1238 (((unsigned char *)(msg)) + msg->status_buf_offset)
1240 /* get pointer to OOBD buffer with message pointer */
1241 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1242 (((unsigned char *)(msg)) + msg->oob_data_offset)
1244 /* get pointer to data buffer with message pointer */
1245 #define MESSAGE_TO_DATA_BUFFER(msg) \
1246 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1248 /* get pointer to contained message from NDIS_MESSAGE pointer */
1249 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1250 ((void *) &rndis_msg->msg)
1252 /* get pointer to contained message from NDIS_MESSAGE pointer */
1253 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1254 ((void *) rndis_msg)
1257 #define __struct_bcount(x)
1261 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1262 sizeof(union rndis_message_container))
1264 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1266 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1267 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1268 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1269 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1270 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1271 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1272 #define NDIS_PACKET_TYPE_SMT 0x00000040
1273 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1274 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1275 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1276 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1277 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1284 #define TRANSPORT_INFO_NOT_IP 0
1285 #define TRANSPORT_INFO_IPV4_TCP ((INFO_IPV4 << 16) | INFO_TCP)
1286 #define TRANSPORT_INFO_IPV4_UDP ((INFO_IPV4 << 16) | INFO_UDP)
1287 #define TRANSPORT_INFO_IPV6_TCP ((INFO_IPV6 << 16) | INFO_TCP)
1288 #define TRANSPORT_INFO_IPV6_UDP ((INFO_IPV6 << 16) | INFO_UDP)
1290 #endif /* _HYPERV_NET_H */