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
37 #define NDIS_OBJECT_TYPE_OFFLOAD 0xa7
39 #define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
40 #define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
42 struct ndis_obj_header
{
48 /* ndis_recv_scale_cap/cap_flag */
49 #define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
50 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR 0x02000000
51 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC 0x04000000
52 #define NDIS_RSS_CAPS_USING_MSI_X 0x08000000
53 #define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS 0x10000000
54 #define NDIS_RSS_CAPS_SUPPORTS_MSI_X 0x20000000
55 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4 0x00000100
56 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6 0x00000200
57 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX 0x00000400
59 struct ndis_recv_scale_cap
{ /* NDIS_RECEIVE_SCALE_CAPABILITIES */
60 struct ndis_obj_header hdr
;
64 u16 num_indirect_tabent
;
68 /* ndis_recv_scale_param flags */
69 #define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED 0x0001
70 #define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED 0x0002
71 #define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED 0x0004
72 #define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED 0x0008
73 #define NDIS_RSS_PARAM_FLAG_DISABLE_RSS 0x0010
76 #define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
77 #define NDIS_HASH_IPV4 0x00000100
78 #define NDIS_HASH_TCP_IPV4 0x00000200
79 #define NDIS_HASH_IPV6 0x00000400
80 #define NDIS_HASH_IPV6_EX 0x00000800
81 #define NDIS_HASH_TCP_IPV6 0x00001000
82 #define NDIS_HASH_TCP_IPV6_EX 0x00002000
84 #define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
85 #define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2 40
89 struct ndis_recv_scale_param
{ /* NDIS_RECEIVE_SCALE_PARAMETERS */
90 struct ndis_obj_header hdr
;
92 /* Qualifies the rest of the information */
95 /* The base CPU number to do receive processing. not used */
98 /* This describes the hash function and type being enabled */
101 /* The size of indirection table array */
102 u16 indirect_tabsize
;
104 /* The offset of the indirection table from the beginning of this
107 u32 indirect_taboffset
;
109 /* The size of the hash secret key */
112 /* The offset of the secret key from the beginning of this structure */
115 u32 processor_masks_offset
;
116 u32 num_processor_masks
;
117 u32 processor_masks_entry_size
;
120 /* Fwd declaration */
121 struct ndis_tcp_ip_checksum_info
;
122 struct ndis_pkt_8021q_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 */
144 u32 total_data_buflen
;
147 struct netvsc_device_info
{
148 unsigned char mac_adr
[ETH_ALEN
];
152 u32 send_section_size
;
153 u32 recv_section_size
;
156 enum rndis_device_state
{
157 RNDIS_DEV_UNINITIALIZED
= 0,
158 RNDIS_DEV_INITIALIZING
,
159 RNDIS_DEV_INITIALIZED
,
160 RNDIS_DEV_DATAINITIALIZED
,
163 #define NETVSC_HASH_KEYLEN 40
165 struct rndis_device
{
166 struct net_device
*ndev
;
168 enum rndis_device_state state
;
172 spinlock_t request_lock
;
173 struct list_head req_list
;
175 struct work_struct mcast_work
;
177 bool link_state
; /* 0 - link up, 1 - link down */
179 u8 hw_mac_adr
[ETH_ALEN
];
180 u8 rss_key
[NETVSC_HASH_KEYLEN
];
181 u16 rx_table
[ITAB_NUM
];
186 struct rndis_message
;
187 struct netvsc_device
;
188 struct net_device_context
;
190 extern u32 netvsc_ring_bytes
;
191 extern struct reciprocal_value netvsc_ring_reciprocal
;
193 struct netvsc_device
*netvsc_device_add(struct hv_device
*device
,
194 const struct netvsc_device_info
*info
);
195 int netvsc_alloc_recv_comp_ring(struct netvsc_device
*net_device
, u32 q_idx
);
196 void netvsc_device_remove(struct hv_device
*device
);
197 int netvsc_send(struct net_device_context
*ndc
,
198 struct hv_netvsc_packet
*packet
,
199 struct rndis_message
*rndis_msg
,
200 struct hv_page_buffer
*page_buffer
,
201 struct sk_buff
*skb
);
202 void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
203 struct rndis_message
*resp
);
204 int netvsc_recv_callback(struct net_device
*net
,
205 struct vmbus_channel
*channel
,
207 const struct ndis_tcp_ip_checksum_info
*csum_info
,
208 const struct ndis_pkt_8021q_info
*vlan
);
209 void netvsc_channel_cb(void *context
);
210 int netvsc_poll(struct napi_struct
*napi
, int budget
);
212 void rndis_set_subchannel(struct work_struct
*w
);
213 bool rndis_filter_opened(const struct netvsc_device
*nvdev
);
214 int rndis_filter_open(struct netvsc_device
*nvdev
);
215 int rndis_filter_close(struct netvsc_device
*nvdev
);
216 struct netvsc_device
*rndis_filter_device_add(struct hv_device
*dev
,
217 struct netvsc_device_info
*info
);
218 void rndis_filter_update(struct netvsc_device
*nvdev
);
219 void rndis_filter_device_remove(struct hv_device
*dev
,
220 struct netvsc_device
*nvdev
);
221 int rndis_filter_set_rss_param(struct rndis_device
*rdev
,
223 int rndis_filter_receive(struct net_device
*ndev
,
224 struct netvsc_device
*net_dev
,
225 struct hv_device
*dev
,
226 struct vmbus_channel
*channel
,
227 void *data
, u32 buflen
);
229 int rndis_filter_set_device_mac(struct netvsc_device
*ndev
,
232 void netvsc_switch_datapath(struct net_device
*nv_dev
, bool vf
);
234 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
236 #define NVSP_PROTOCOL_VERSION_1 2
237 #define NVSP_PROTOCOL_VERSION_2 0x30002
238 #define NVSP_PROTOCOL_VERSION_4 0x40000
239 #define NVSP_PROTOCOL_VERSION_5 0x50000
242 NVSP_MSG_TYPE_NONE
= 0,
245 NVSP_MSG_TYPE_INIT
= 1,
246 NVSP_MSG_TYPE_INIT_COMPLETE
= 2,
248 NVSP_VERSION_MSG_START
= 100,
250 /* Version 1 Messages */
251 NVSP_MSG1_TYPE_SEND_NDIS_VER
= NVSP_VERSION_MSG_START
,
253 NVSP_MSG1_TYPE_SEND_RECV_BUF
,
254 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE
,
255 NVSP_MSG1_TYPE_REVOKE_RECV_BUF
,
257 NVSP_MSG1_TYPE_SEND_SEND_BUF
,
258 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE
,
259 NVSP_MSG1_TYPE_REVOKE_SEND_BUF
,
261 NVSP_MSG1_TYPE_SEND_RNDIS_PKT
,
262 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE
,
264 /* Version 2 messages */
265 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF
,
266 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP
,
267 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF
,
269 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION
,
271 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY
,
272 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP
,
274 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT
,
276 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT
,
277 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP
,
279 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ
,
280 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP
,
282 NVSP_MSG2_TYPE_ALLOC_RXBUF
,
283 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP
,
285 NVSP_MSG2_TYPE_FREE_RXBUF
,
287 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT
,
288 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP
,
290 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG
,
292 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE
,
293 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
295 NVSP_MSG2_MAX
= NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
297 /* Version 4 messages */
298 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION
,
299 NVSP_MSG4_TYPE_SWITCH_DATA_PATH
,
300 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
302 NVSP_MSG4_MAX
= NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
304 /* Version 5 messages */
305 NVSP_MSG5_TYPE_OID_QUERY_EX
,
306 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP
,
307 NVSP_MSG5_TYPE_SUBCHANNEL
,
308 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
310 NVSP_MSG5_MAX
= NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
317 NVSP_STAT_PROTOCOL_TOO_NEW
,
318 NVSP_STAT_PROTOCOL_TOO_OLD
,
319 NVSP_STAT_INVALID_RNDIS_PKT
,
321 NVSP_STAT_PROTOCOL_UNSUPPORTED
,
325 struct nvsp_message_header
{
332 * This message is used by the VSC to initialize the channel after the channels
333 * has been opened. This message should never include anything other then
334 * versioning (i.e. this message will be the same for ever).
336 struct nvsp_message_init
{
337 u32 min_protocol_ver
;
338 u32 max_protocol_ver
;
342 * This message is used by the VSP to complete the initialization of the
343 * channel. This message should never include anything other then versioning
344 * (i.e. this message will be the same for ever).
346 struct nvsp_message_init_complete
{
347 u32 negotiated_protocol_ver
;
348 u32 max_mdl_chain_len
;
352 union nvsp_message_init_uber
{
353 struct nvsp_message_init init
;
354 struct nvsp_message_init_complete init_complete
;
357 /* Version 1 Messages */
360 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
361 * can use this information when handling OIDs sent by the VSC.
363 struct nvsp_1_message_send_ndis_version
{
369 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
370 * can then use the receive buffer to send data to the VSC.
372 struct nvsp_1_message_send_receive_buffer
{
377 struct nvsp_1_receive_buffer_section
{
385 * This message is used by the VSP to acknowledge a receive buffer send by the
386 * VSC. This message must be sent by the VSP before the VSP uses the receive
389 struct nvsp_1_message_send_receive_buffer_complete
{
394 * The receive buffer is split into two parts, a large suballocation
395 * section and a small suballocation section. These sections are then
396 * suballocated by a certain size.
400 * For example, the following break up of the receive buffer has 6
401 * large suballocations and 10 small suballocations.
405 * | Large Section | | Small Section |
406 * ------------------------------------------------------------
407 * | | | | | | | | | | | | | | | | | |
409 * LargeOffset SmallOffset
412 struct nvsp_1_receive_buffer_section sections
[1];
416 * This message is sent by the VSC to revoke the receive buffer. After the VSP
417 * completes this transaction, the vsp should never use the receive buffer
420 struct nvsp_1_message_revoke_receive_buffer
{
425 * This message is used by the VSC to send a send buffer to the VSP. The VSC
426 * can then use the send buffer to send data to the VSP.
428 struct nvsp_1_message_send_send_buffer
{
434 * This message is used by the VSP to acknowledge a send buffer sent by the
435 * VSC. This message must be sent by the VSP before the VSP uses the sent
438 struct nvsp_1_message_send_send_buffer_complete
{
442 * The VSC gets to choose the size of the send buffer and the VSP gets
443 * to choose the sections size of the buffer. This was done to enable
444 * dynamic reconfigurations when the cost of GPA-direct buffers
451 * This message is sent by the VSC to revoke the send buffer. After the VSP
452 * completes this transaction, the vsp should never use the send buffer again.
454 struct nvsp_1_message_revoke_send_buffer
{
459 * This message is used by both the VSP and the VSC to send a RNDIS message to
460 * the opposite channel endpoint.
462 struct nvsp_1_message_send_rndis_packet
{
464 * This field is specified by RNDIS. They assume there's two different
465 * channels of communication. However, the Network VSP only has one.
466 * Therefore, the channel travels with the RNDIS packet.
471 * This field is used to send part or all of the data through a send
472 * buffer. This values specifies an index into the send buffer. If the
473 * index is 0xFFFFFFFF, then the send buffer is not being used and all
474 * of the data was sent through other VMBus mechanisms.
476 u32 send_buf_section_index
;
477 u32 send_buf_section_size
;
481 * This message is used by both the VSP and the VSC to complete a RNDIS message
482 * to the opposite channel endpoint. At this point, the initiator of this
483 * message cannot use any resources associated with the original RNDIS packet.
485 struct nvsp_1_message_send_rndis_packet_complete
{
489 union nvsp_1_message_uber
{
490 struct nvsp_1_message_send_ndis_version send_ndis_ver
;
492 struct nvsp_1_message_send_receive_buffer send_recv_buf
;
493 struct nvsp_1_message_send_receive_buffer_complete
494 send_recv_buf_complete
;
495 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf
;
497 struct nvsp_1_message_send_send_buffer send_send_buf
;
498 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete
;
499 struct nvsp_1_message_revoke_send_buffer revoke_send_buf
;
501 struct nvsp_1_message_send_rndis_packet send_rndis_pkt
;
502 struct nvsp_1_message_send_rndis_packet_complete
503 send_rndis_pkt_complete
;
508 * Network VSP protocol version 2 messages:
510 struct nvsp_2_vsc_capability
{
518 u64 correlation_id
:1;
524 struct nvsp_2_send_ndis_config
{
527 struct nvsp_2_vsc_capability capability
;
530 /* Allocate receive buffer */
531 struct nvsp_2_alloc_rxbuf
{
532 /* Allocation ID to match the allocation request and response */
535 /* Length of the VM shared memory receive buffer that needs to
541 /* Allocate receive buffer complete */
542 struct nvsp_2_alloc_rxbuf_comp
{
543 /* The NDIS_STATUS code for buffer allocation */
548 /* GPADL handle for the allocated receive buffer */
551 /* Receive buffer ID */
555 struct nvsp_2_free_rxbuf
{
559 union nvsp_2_message_uber
{
560 struct nvsp_2_send_ndis_config send_ndis_config
;
561 struct nvsp_2_alloc_rxbuf alloc_rxbuf
;
562 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp
;
563 struct nvsp_2_free_rxbuf free_rxbuf
;
566 struct nvsp_4_send_vf_association
{
567 /* 1: allocated, serial number is valid. 0: not allocated */
570 /* Serial number of the VF to team with */
574 enum nvsp_vm_datapath
{
575 NVSP_DATAPATH_SYNTHETIC
= 0,
580 struct nvsp_4_sw_datapath
{
581 u32 active_datapath
; /* active data path in VM */
584 union nvsp_4_message_uber
{
585 struct nvsp_4_send_vf_association vf_assoc
;
586 struct nvsp_4_sw_datapath active_dp
;
589 enum nvsp_subchannel_operation
{
590 NVSP_SUBCHANNEL_NONE
= 0,
591 NVSP_SUBCHANNEL_ALLOCATE
,
595 struct nvsp_5_subchannel_request
{
600 struct nvsp_5_subchannel_complete
{
602 u32 num_subchannels
; /* Actual number of subchannels allocated */
605 struct nvsp_5_send_indirect_table
{
606 /* The number of entries in the send indirection table */
609 /* The offset of the send indirection table from top of this struct.
610 * The send indirection table tells which channel to put the send
611 * traffic on. Each entry is a channel number.
616 union nvsp_5_message_uber
{
617 struct nvsp_5_subchannel_request subchn_req
;
618 struct nvsp_5_subchannel_complete subchn_comp
;
619 struct nvsp_5_send_indirect_table send_table
;
622 union nvsp_all_messages
{
623 union nvsp_message_init_uber init_msg
;
624 union nvsp_1_message_uber v1_msg
;
625 union nvsp_2_message_uber v2_msg
;
626 union nvsp_4_message_uber v4_msg
;
627 union nvsp_5_message_uber v5_msg
;
631 struct nvsp_message
{
632 struct nvsp_message_header hdr
;
633 union nvsp_all_messages msg
;
637 #define NETVSC_MTU 65535
638 #define NETVSC_MTU_MIN ETH_MIN_MTU
640 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
641 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
642 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
643 #define NETVSC_INVALID_INDEX -1
645 #define NETVSC_SEND_SECTION_SIZE 6144
646 #define NETVSC_RECV_SECTION_SIZE 1728
648 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
649 #define NETVSC_SEND_BUFFER_ID 0
651 #define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
652 NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
655 #define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
656 #define VRSS_CHANNEL_MAX 64
657 #define VRSS_CHANNEL_DEFAULT 8
659 #define RNDIS_MAX_PKT_DEFAULT 8
660 #define RNDIS_PKT_ALIGN_DEFAULT 8
662 struct multi_send_data
{
663 struct sk_buff
*skb
; /* skb containing the pkt */
664 struct hv_netvsc_packet
*pkt
; /* netvsc pkt pending */
665 u32 count
; /* counter of batched packets */
668 struct recv_comp_data
{
669 u64 tid
; /* transaction id */
673 struct multi_recv_comp
{
674 struct recv_comp_data
*slots
;
675 u32 first
; /* first data entry */
676 u32 next
; /* next entry for writing */
679 struct netvsc_stats
{
684 struct u64_stats_sync syncp
;
687 struct netvsc_ethtool_stats
{
688 unsigned long tx_scattered
;
689 unsigned long tx_no_memory
;
690 unsigned long tx_no_space
;
691 unsigned long tx_too_big
;
692 unsigned long tx_busy
;
693 unsigned long tx_send_full
;
694 unsigned long rx_comp_busy
;
695 unsigned long stop_queue
;
696 unsigned long wake_queue
;
699 struct netvsc_vf_pcpu_stats
{
704 struct u64_stats_sync syncp
;
708 struct netvsc_reconfig
{
709 struct list_head list
;
713 /* L4 hash bits for different protocols */
714 #define HV_TCP4_L4HASH 1
715 #define HV_TCP6_L4HASH 2
716 #define HV_UDP4_L4HASH 4
717 #define HV_UDP6_L4HASH 8
718 #define HV_DEFAULT_L4HASH (HV_TCP4_L4HASH | HV_TCP6_L4HASH | HV_UDP4_L4HASH | \
721 /* The context of the netvsc device */
722 struct net_device_context
{
723 /* point back to our device context */
724 struct hv_device
*device_ctx
;
726 struct netvsc_device __rcu
*nvdev
;
727 /* reconfigure work */
728 struct delayed_work dwork
;
729 /* last reconfig time */
730 unsigned long last_reconfig
;
731 /* reconfig events */
732 struct list_head reconfig_events
;
733 /* list protection */
736 u32 msg_enable
; /* debug level */
738 u32 tx_checksum_mask
;
740 u32 tx_table
[VRSS_SEND_TAB_SIZE
];
742 /* Ethtool settings */
745 u32 l4_hash
; /* L4 hash settings */
746 struct netvsc_ethtool_stats eth_stats
;
748 /* State to manage the associated VF interface. */
749 struct net_device __rcu
*vf_netdev
;
750 struct netvsc_vf_pcpu_stats __percpu
*vf_stats
;
751 struct delayed_work vf_takeover
;
753 /* 1: allocated, serial number is valid. 0: not allocated */
755 /* Serial number of the VF to team with */
759 /* Per channel data */
760 struct netvsc_channel
{
761 struct vmbus_channel
*channel
;
762 struct netvsc_device
*net_device
;
763 const struct vmpacket_descriptor
*desc
;
764 struct napi_struct napi
;
765 struct multi_send_data msd
;
766 struct multi_recv_comp mrc
;
767 atomic_t queue_sends
;
769 struct netvsc_stats tx_stats
;
770 struct netvsc_stats rx_stats
;
773 /* Per netvsc device */
774 struct netvsc_device
{
777 wait_queue_head_t wait_drain
;
780 /* Receive buffer allocated by us but manages by NetVSP */
782 u32 recv_buf_gpadl_handle
;
783 u32 recv_section_cnt
;
784 u32 recv_section_size
;
785 u32 recv_completion_cnt
;
787 /* Send buffer allocated by us */
789 u32 send_buf_gpadl_handle
;
790 u32 send_section_cnt
;
791 u32 send_section_size
;
792 unsigned long *send_section_map
;
794 /* Used for NetVSP initialization protocol */
795 struct completion channel_init_wait
;
796 struct nvsp_message channel_init_pkt
;
798 struct nvsp_message revoke_packet
;
804 struct work_struct subchan_work
;
805 wait_queue_head_t subchan_open
;
807 struct rndis_device
*extension
;
809 u32 max_pkt
; /* max number of pkt in one send, e.g. 8 */
810 u32 pkt_align
; /* alignment bytes, e.g. 8 */
814 struct netvsc_channel chan_table
[VRSS_CHANNEL_MAX
];
819 /* NdisInitialize message */
820 struct rndis_initialize_request
{
827 /* Response to NdisInitialize */
828 struct rndis_initialize_complete
{
837 u32 pkt_alignment_factor
;
842 /* Call manager devices only: Information about an address family */
843 /* supported by the device is appended to the response to NdisInitialize. */
844 struct rndis_co_address_family
{
850 /* NdisHalt message */
851 struct rndis_halt_request
{
855 /* NdisQueryRequest message */
856 struct rndis_query_request
{
864 /* Response to NdisQueryRequest */
865 struct rndis_query_complete
{
872 /* NdisSetRequest message */
873 struct rndis_set_request
{
881 /* Response to NdisSetRequest */
882 struct rndis_set_complete
{
887 /* NdisReset message */
888 struct rndis_reset_request
{
892 /* Response to NdisReset */
893 struct rndis_reset_complete
{
895 u32 addressing_reset
;
898 /* NdisMIndicateStatus message */
899 struct rndis_indicate_status
{
902 u32 status_buf_offset
;
905 /* Diagnostic information passed as the status buffer in */
906 /* struct rndis_indicate_status messages signifying error conditions. */
907 struct rndis_diagnostic_info
{
912 /* NdisKeepAlive message */
913 struct rndis_keepalive_request
{
917 /* Response to NdisKeepAlive */
918 struct rndis_keepalive_complete
{
924 * Data message. All Offset fields contain byte offsets from the beginning of
925 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
926 * to 0 for connectionless data, otherwise it contains the VC handle.
928 struct rndis_packet
{
933 u32 num_oob_data_elements
;
934 u32 per_pkt_info_offset
;
935 u32 per_pkt_info_len
;
940 /* Optional Out of Band data associated with a Data message. */
944 u32 class_info_offset
;
947 /* Packet extension field contents associated with a Data message. */
948 struct rndis_per_packet_info
{
954 enum ndis_per_pkt_info_type
{
955 TCPIP_CHKSUM_PKTINFO
,
957 TCP_LARGESEND_PKTINFO
,
958 CLASSIFICATION_HANDLE_PKTINFO
,
964 NBL_HASH_VALUE
= PACKET_CANCEL_ID
,
965 ORIGINAL_NET_BUFLIST
,
971 struct ndis_pkt_8021q_info
{
974 u32 pri
:3; /* User Priority */
975 u32 cfi
:1; /* Canonical Format ID */
976 u32 vlanid
:12; /* VLAN ID */
983 struct ndis_object_header
{
989 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
990 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
991 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
992 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
994 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
995 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
996 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
997 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
998 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
999 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1000 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1001 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1002 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1003 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1005 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
1006 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
1007 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
1009 #define VERSION_4_OFFLOAD_SIZE 22
1011 * New offload OIDs for NDIS 6
1013 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1014 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1015 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1016 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1017 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1018 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1021 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1022 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1025 #define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1026 #define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1027 #define NDIS_OFFLOAD_ENCAP_8023 0x0002
1028 #define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1029 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1030 #define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1032 struct ndis_csum_offload
{
1035 #define NDIS_TXCSUM_CAP_IP4OPT 0x001
1036 #define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1037 #define NDIS_TXCSUM_CAP_TCP4 0x010
1038 #define NDIS_TXCSUM_CAP_UDP4 0x040
1039 #define NDIS_TXCSUM_CAP_IP4 0x100
1041 #define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1045 #define NDIS_RXCSUM_CAP_IP4OPT 0x001
1046 #define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1047 #define NDIS_RXCSUM_CAP_TCP4 0x010
1048 #define NDIS_RXCSUM_CAP_UDP4 0x040
1049 #define NDIS_RXCSUM_CAP_IP4 0x100
1052 #define NDIS_TXCSUM_CAP_IP6EXT 0x001
1053 #define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1054 #define NDIS_TXCSUM_CAP_TCP6 0x010
1055 #define NDIS_TXCSUM_CAP_UDP6 0x040
1058 #define NDIS_RXCSUM_CAP_IP6EXT 0x001
1059 #define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1060 #define NDIS_RXCSUM_CAP_TCP6 0x010
1061 #define NDIS_RXCSUM_CAP_UDP6 0x040
1063 #define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1064 NDIS_TXCSUM_CAP_TCP6OPT | \
1065 NDIS_TXCSUM_CAP_IP6EXT)
1068 struct ndis_lsov1_offload
{
1075 struct ndis_ipsecv1_offload
{
1085 struct ndis_lsov2_offload
{
1093 #define NDIS_LSOV2_CAP_IP6EXT 0x001
1094 #define NDIS_LSOV2_CAP_TCP6OPT 0x004
1096 #define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1097 NDIS_LSOV2_CAP_TCP6OPT)
1100 struct ndis_ipsecv2_offload
{
1119 struct ndis_rsc_offload
{
1124 struct ndis_encap_offload
{
1129 struct ndis_offload
{
1130 struct ndis_object_header header
;
1131 struct ndis_csum_offload csum
;
1132 struct ndis_lsov1_offload lsov1
;
1133 struct ndis_ipsecv1_offload ipsecv1
;
1134 struct ndis_lsov2_offload lsov2
;
1137 struct ndis_ipsecv2_offload ipsecv2
;
1139 struct ndis_rsc_offload rsc
;
1140 struct ndis_encap_offload encap_gre
;
1143 #define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1144 #define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1145 #define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1147 struct ndis_offload_params
{
1148 struct ndis_object_header header
;
1158 u8 tcp_connection_ip_v4
;
1159 u8 tcp_connection_ip_v6
;
1168 u8 encapsulated_packet_task_offload
;
1169 u8 encapsulation_types
;
1173 struct ndis_tcp_ip_checksum_info
{
1180 u32 ip_header_checksum
:1;
1182 u32 tcp_header_offset
:10;
1185 u32 tcp_checksum_failed
:1;
1186 u32 udp_checksum_failed
:1;
1187 u32 ip_checksum_failed
:1;
1188 u32 tcp_checksum_succeeded
:1;
1189 u32 udp_checksum_succeeded
:1;
1190 u32 ip_checksum_succeeded
:1;
1192 u32 tcp_checksum_value_invalid
:1;
1193 u32 ip_checksum_value_invalid
:1;
1199 struct ndis_tcp_lso_info
{
1208 u32 tcp_header_offset
:10;
1216 } lso_v1_transmit_complete
;
1219 u32 tcp_header_offset
:10;
1227 } lso_v2_transmit_complete
;
1232 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1233 sizeof(struct ndis_pkt_8021q_info))
1235 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1236 sizeof(struct ndis_tcp_ip_checksum_info))
1238 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1239 sizeof(struct ndis_tcp_lso_info))
1241 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1244 /* Total size of all PPI data */
1245 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1246 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1248 /* Format of Information buffer passed in a SetRequest for the OID */
1249 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1250 struct rndis_config_parameter_info
{
1251 u32 parameter_name_offset
;
1252 u32 parameter_name_length
;
1254 u32 parameter_value_offset
;
1255 u32 parameter_value_length
;
1258 /* Values for ParameterType in struct rndis_config_parameter_info */
1259 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1260 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1262 /* CONDIS Miniport messages for connection oriented devices */
1263 /* that do not implement a call manager. */
1265 /* CoNdisMiniportCreateVc message */
1266 struct rcondis_mp_create_vc
{
1271 /* Response to CoNdisMiniportCreateVc */
1272 struct rcondis_mp_create_vc_complete
{
1278 /* CoNdisMiniportDeleteVc message */
1279 struct rcondis_mp_delete_vc
{
1284 /* Response to CoNdisMiniportDeleteVc */
1285 struct rcondis_mp_delete_vc_complete
{
1290 /* CoNdisMiniportQueryRequest message */
1291 struct rcondis_mp_query_request
{
1297 u32 info_buf_offset
;
1300 /* CoNdisMiniportSetRequest message */
1301 struct rcondis_mp_set_request
{
1307 u32 info_buf_offset
;
1310 /* CoNdisIndicateStatus message */
1311 struct rcondis_indicate_status
{
1315 u32 status_buf_offset
;
1318 /* CONDIS Call/VC parameters */
1319 struct rcondis_specific_parameters
{
1321 u32 parameter_length
;
1322 u32 parameter_lffset
;
1325 struct rcondis_media_parameters
{
1329 struct rcondis_specific_parameters media_specific
;
1332 struct rndis_flowspec
{
1334 u32 token_bucket_size
;
1337 u32 delay_variation
;
1340 u32 minimum_policed_size
;
1343 struct rcondis_call_manager_parameters
{
1344 struct rndis_flowspec transmit
;
1345 struct rndis_flowspec receive
;
1346 struct rcondis_specific_parameters call_mgr_specific
;
1349 /* CoNdisMiniportActivateVc message */
1350 struct rcondis_mp_activate_vc_request
{
1354 u32 media_params_offset
;
1355 u32 media_params_length
;
1356 u32 call_mgr_params_offset
;
1357 u32 call_mgr_params_length
;
1360 /* Response to CoNdisMiniportActivateVc */
1361 struct rcondis_mp_activate_vc_complete
{
1366 /* CoNdisMiniportDeactivateVc message */
1367 struct rcondis_mp_deactivate_vc_request
{
1373 /* Response to CoNdisMiniportDeactivateVc */
1374 struct rcondis_mp_deactivate_vc_complete
{
1380 /* union with all of the RNDIS messages */
1381 union rndis_message_container
{
1382 struct rndis_packet pkt
;
1383 struct rndis_initialize_request init_req
;
1384 struct rndis_halt_request halt_req
;
1385 struct rndis_query_request query_req
;
1386 struct rndis_set_request set_req
;
1387 struct rndis_reset_request reset_req
;
1388 struct rndis_keepalive_request keep_alive_req
;
1389 struct rndis_indicate_status indicate_status
;
1390 struct rndis_initialize_complete init_complete
;
1391 struct rndis_query_complete query_complete
;
1392 struct rndis_set_complete set_complete
;
1393 struct rndis_reset_complete reset_complete
;
1394 struct rndis_keepalive_complete keep_alive_complete
;
1395 struct rcondis_mp_create_vc co_miniport_create_vc
;
1396 struct rcondis_mp_delete_vc co_miniport_delete_vc
;
1397 struct rcondis_indicate_status co_indicate_status
;
1398 struct rcondis_mp_activate_vc_request co_miniport_activate_vc
;
1399 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc
;
1400 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete
;
1401 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete
;
1402 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete
;
1403 struct rcondis_mp_deactivate_vc_complete
1404 co_miniport_deactivate_vc_complete
;
1407 /* Remote NDIS message format */
1408 struct rndis_message
{
1411 /* Total length of this message, from the beginning */
1412 /* of the struct rndis_message, in bytes. */
1415 /* Actual message */
1416 union rndis_message_container msg
;
1422 /* get the size of an RNDIS message. Pass in the message type, */
1423 /* struct rndis_set_request, struct rndis_packet for example */
1424 #define RNDIS_MESSAGE_SIZE(msg) \
1425 (sizeof(msg) + (sizeof(struct rndis_message) - \
1426 sizeof(union rndis_message_container)))
1428 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1429 sizeof(union rndis_message_container))
1431 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1433 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1434 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1435 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1436 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1437 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1438 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1439 #define NDIS_PACKET_TYPE_SMT 0x00000040
1440 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1441 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1442 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1443 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1444 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1446 #define TRANSPORT_INFO_NOT_IP 0
1447 #define TRANSPORT_INFO_IPV4_TCP 0x01
1448 #define TRANSPORT_INFO_IPV4_UDP 0x02
1449 #define TRANSPORT_INFO_IPV6_TCP 0x10
1450 #define TRANSPORT_INFO_IPV6_UDP 0x20
1452 #endif /* _HYPERV_NET_H */