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 #define NETVSC_HASH_KEYLEN 40
149 struct netvsc_device_info {
150 unsigned char mac_adr[ETH_ALEN];
154 u32 send_section_size;
155 u32 recv_section_size;
157 u8 rss_key[NETVSC_HASH_KEYLEN];
160 enum rndis_device_state {
161 RNDIS_DEV_UNINITIALIZED = 0,
162 RNDIS_DEV_INITIALIZING,
163 RNDIS_DEV_INITIALIZED,
164 RNDIS_DEV_DATAINITIALIZED,
167 struct rndis_device {
168 struct net_device *ndev;
170 enum rndis_device_state state;
174 spinlock_t request_lock;
175 struct list_head req_list;
177 struct work_struct mcast_work;
180 bool link_state; /* 0 - link up, 1 - link down */
182 u8 hw_mac_adr[ETH_ALEN];
183 u8 rss_key[NETVSC_HASH_KEYLEN];
184 u16 rx_table[ITAB_NUM];
189 struct rndis_message;
190 struct ndis_offload_params;
191 struct netvsc_device;
192 struct netvsc_channel;
193 struct net_device_context;
195 extern u32 netvsc_ring_bytes;
197 struct netvsc_device *netvsc_device_add(struct hv_device *device,
198 const struct netvsc_device_info *info);
199 int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
200 void netvsc_device_remove(struct hv_device *device);
201 int netvsc_send(struct net_device *net,
202 struct hv_netvsc_packet *packet,
203 struct rndis_message *rndis_msg,
204 struct hv_page_buffer *page_buffer,
205 struct sk_buff *skb);
206 void netvsc_linkstatus_callback(struct net_device *net,
207 struct rndis_message *resp);
208 int netvsc_recv_callback(struct net_device *net,
209 struct netvsc_device *nvdev,
210 struct netvsc_channel *nvchan);
211 void netvsc_channel_cb(void *context);
212 int netvsc_poll(struct napi_struct *napi, int budget);
214 int rndis_set_subchannel(struct net_device *ndev,
215 struct netvsc_device *nvdev,
216 struct netvsc_device_info *dev_info);
217 int rndis_filter_open(struct netvsc_device *nvdev);
218 int rndis_filter_close(struct netvsc_device *nvdev);
219 struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
220 struct netvsc_device_info *info);
221 void rndis_filter_update(struct netvsc_device *nvdev);
222 void rndis_filter_device_remove(struct hv_device *dev,
223 struct netvsc_device *nvdev);
224 int rndis_filter_set_rss_param(struct rndis_device *rdev,
226 int rndis_filter_set_offload_params(struct net_device *ndev,
227 struct netvsc_device *nvdev,
228 struct ndis_offload_params *req_offloads);
229 int rndis_filter_receive(struct net_device *ndev,
230 struct netvsc_device *net_dev,
231 struct netvsc_channel *nvchan,
232 void *data, u32 buflen);
234 int rndis_filter_set_device_mac(struct netvsc_device *ndev,
237 void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
239 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
241 #define NVSP_PROTOCOL_VERSION_1 2
242 #define NVSP_PROTOCOL_VERSION_2 0x30002
243 #define NVSP_PROTOCOL_VERSION_4 0x40000
244 #define NVSP_PROTOCOL_VERSION_5 0x50000
245 #define NVSP_PROTOCOL_VERSION_6 0x60000
246 #define NVSP_PROTOCOL_VERSION_61 0x60001
249 NVSP_MSG_TYPE_NONE = 0,
252 NVSP_MSG_TYPE_INIT = 1,
253 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
255 NVSP_VERSION_MSG_START = 100,
257 /* Version 1 Messages */
258 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
260 NVSP_MSG1_TYPE_SEND_RECV_BUF,
261 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
262 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
264 NVSP_MSG1_TYPE_SEND_SEND_BUF,
265 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
266 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
268 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
269 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
271 /* Version 2 messages */
272 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
273 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
274 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
276 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
278 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
279 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
281 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
283 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
284 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
286 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
287 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
289 NVSP_MSG2_TYPE_ALLOC_RXBUF,
290 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
292 NVSP_MSG2_TYPE_FREE_RXBUF,
294 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
295 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
297 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
299 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
300 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
302 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
304 /* Version 4 messages */
305 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
306 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
307 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
309 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
311 /* Version 5 messages */
312 NVSP_MSG5_TYPE_OID_QUERY_EX,
313 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
314 NVSP_MSG5_TYPE_SUBCHANNEL,
315 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
317 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
319 /* Version 6 messages */
320 NVSP_MSG6_TYPE_PD_API,
321 NVSP_MSG6_TYPE_PD_POST_BATCH,
323 NVSP_MSG6_MAX = NVSP_MSG6_TYPE_PD_POST_BATCH
330 NVSP_STAT_PROTOCOL_TOO_NEW,
331 NVSP_STAT_PROTOCOL_TOO_OLD,
332 NVSP_STAT_INVALID_RNDIS_PKT,
334 NVSP_STAT_PROTOCOL_UNSUPPORTED,
338 struct nvsp_message_header {
345 * This message is used by the VSC to initialize the channel after the channels
346 * has been opened. This message should never include anything other then
347 * versioning (i.e. this message will be the same for ever).
349 struct nvsp_message_init {
350 u32 min_protocol_ver;
351 u32 max_protocol_ver;
355 * This message is used by the VSP to complete the initialization of the
356 * channel. This message should never include anything other then versioning
357 * (i.e. this message will be the same for ever).
359 struct nvsp_message_init_complete {
360 u32 negotiated_protocol_ver;
361 u32 max_mdl_chain_len;
365 union nvsp_message_init_uber {
366 struct nvsp_message_init init;
367 struct nvsp_message_init_complete init_complete;
370 /* Version 1 Messages */
373 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
374 * can use this information when handling OIDs sent by the VSC.
376 struct nvsp_1_message_send_ndis_version {
382 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
383 * can then use the receive buffer to send data to the VSC.
385 struct nvsp_1_message_send_receive_buffer {
390 struct nvsp_1_receive_buffer_section {
398 * This message is used by the VSP to acknowledge a receive buffer send by the
399 * VSC. This message must be sent by the VSP before the VSP uses the receive
402 struct nvsp_1_message_send_receive_buffer_complete {
407 * The receive buffer is split into two parts, a large suballocation
408 * section and a small suballocation section. These sections are then
409 * suballocated by a certain size.
413 * For example, the following break up of the receive buffer has 6
414 * large suballocations and 10 small suballocations.
418 * | Large Section | | Small Section |
419 * ------------------------------------------------------------
420 * | | | | | | | | | | | | | | | | | |
422 * LargeOffset SmallOffset
425 struct nvsp_1_receive_buffer_section sections[1];
429 * This message is sent by the VSC to revoke the receive buffer. After the VSP
430 * completes this transaction, the vsp should never use the receive buffer
433 struct nvsp_1_message_revoke_receive_buffer {
438 * This message is used by the VSC to send a send buffer to the VSP. The VSC
439 * can then use the send buffer to send data to the VSP.
441 struct nvsp_1_message_send_send_buffer {
447 * This message is used by the VSP to acknowledge a send buffer sent by the
448 * VSC. This message must be sent by the VSP before the VSP uses the sent
451 struct nvsp_1_message_send_send_buffer_complete {
455 * The VSC gets to choose the size of the send buffer and the VSP gets
456 * to choose the sections size of the buffer. This was done to enable
457 * dynamic reconfigurations when the cost of GPA-direct buffers
464 * This message is sent by the VSC to revoke the send buffer. After the VSP
465 * completes this transaction, the vsp should never use the send buffer again.
467 struct nvsp_1_message_revoke_send_buffer {
472 * This message is used by both the VSP and the VSC to send a RNDIS message to
473 * the opposite channel endpoint.
475 struct nvsp_1_message_send_rndis_packet {
477 * This field is specified by RNDIS. They assume there's two different
478 * channels of communication. However, the Network VSP only has one.
479 * Therefore, the channel travels with the RNDIS packet.
484 * This field is used to send part or all of the data through a send
485 * buffer. This values specifies an index into the send buffer. If the
486 * index is 0xFFFFFFFF, then the send buffer is not being used and all
487 * of the data was sent through other VMBus mechanisms.
489 u32 send_buf_section_index;
490 u32 send_buf_section_size;
494 * This message is used by both the VSP and the VSC to complete a RNDIS message
495 * to the opposite channel endpoint. At this point, the initiator of this
496 * message cannot use any resources associated with the original RNDIS packet.
498 struct nvsp_1_message_send_rndis_packet_complete {
502 union nvsp_1_message_uber {
503 struct nvsp_1_message_send_ndis_version send_ndis_ver;
505 struct nvsp_1_message_send_receive_buffer send_recv_buf;
506 struct nvsp_1_message_send_receive_buffer_complete
507 send_recv_buf_complete;
508 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
510 struct nvsp_1_message_send_send_buffer send_send_buf;
511 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
512 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
514 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
515 struct nvsp_1_message_send_rndis_packet_complete
516 send_rndis_pkt_complete;
521 * Network VSP protocol version 2 messages:
523 struct nvsp_2_vsc_capability {
531 u64 correlation_id:1;
539 struct nvsp_2_send_ndis_config {
542 struct nvsp_2_vsc_capability capability;
545 /* Allocate receive buffer */
546 struct nvsp_2_alloc_rxbuf {
547 /* Allocation ID to match the allocation request and response */
550 /* Length of the VM shared memory receive buffer that needs to
556 /* Allocate receive buffer complete */
557 struct nvsp_2_alloc_rxbuf_comp {
558 /* The NDIS_STATUS code for buffer allocation */
563 /* GPADL handle for the allocated receive buffer */
566 /* Receive buffer ID */
570 struct nvsp_2_free_rxbuf {
574 union nvsp_2_message_uber {
575 struct nvsp_2_send_ndis_config send_ndis_config;
576 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
577 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
578 struct nvsp_2_free_rxbuf free_rxbuf;
581 struct nvsp_4_send_vf_association {
582 /* 1: allocated, serial number is valid. 0: not allocated */
585 /* Serial number of the VF to team with */
589 enum nvsp_vm_datapath {
590 NVSP_DATAPATH_SYNTHETIC = 0,
595 struct nvsp_4_sw_datapath {
596 u32 active_datapath; /* active data path in VM */
599 union nvsp_4_message_uber {
600 struct nvsp_4_send_vf_association vf_assoc;
601 struct nvsp_4_sw_datapath active_dp;
604 enum nvsp_subchannel_operation {
605 NVSP_SUBCHANNEL_NONE = 0,
606 NVSP_SUBCHANNEL_ALLOCATE,
610 struct nvsp_5_subchannel_request {
615 struct nvsp_5_subchannel_complete {
617 u32 num_subchannels; /* Actual number of subchannels allocated */
620 struct nvsp_5_send_indirect_table {
621 /* The number of entries in the send indirection table */
624 /* The offset of the send indirection table from top of this struct.
625 * The send indirection table tells which channel to put the send
626 * traffic on. Each entry is a channel number.
631 union nvsp_5_message_uber {
632 struct nvsp_5_subchannel_request subchn_req;
633 struct nvsp_5_subchannel_complete subchn_comp;
634 struct nvsp_5_send_indirect_table send_table;
637 enum nvsp_6_pd_api_op {
638 PD_API_OP_CONFIG = 1,
639 PD_API_OP_SW_DATAPATH, /* Switch Datapath */
640 PD_API_OP_OPEN_PROVIDER,
641 PD_API_OP_CLOSE_PROVIDER,
642 PD_API_OP_CREATE_QUEUE,
643 PD_API_OP_FLUSH_QUEUE,
644 PD_API_OP_FREE_QUEUE,
645 PD_API_OP_ALLOC_COM_BUF, /* Allocate Common Buffer */
646 PD_API_OP_FREE_COM_BUF, /* Free Common Buffer */
650 struct grp_affinity {
656 struct nvsp_6_pd_api_req {
660 /* MMIO information is sent from the VM to VSP */
662 u64 mmio_pa; /* MMIO Physical Address */
665 /* Number of PD queues a VM can support */
669 /* Switch Datapath */
671 /* Host Datapath Is PacketDirect */
674 /* Guest PacketDirect Is Enabled */
680 u32 prov_id; /* Provider id */
697 struct grp_affinity affy;
712 /* Allocate Common Buffer */
715 u32 pf_node; /* Preferred Node */
719 /* Free Common Buffer */
722 u64 pa; /* Physical Address */
723 u32 pf_node; /* Preferred Node */
730 struct nvsp_6_pd_api_comp {
736 /* actual number of PD queues allocated to the VM */
739 /* Num Receive Rss PD Queues */
742 u8 is_supported; /* Is supported by VSP */
743 u8 is_enabled; /* Is enabled by VSP */
757 struct grp_affinity affy;
760 /* Allocate Common Buffer */
762 u64 pa; /* Physical Address */
764 u32 pf_node; /* Preferred Node */
771 struct nvsp_6_pd_buf {
778 struct nvsp_6_pd_batch_msg {
779 struct nvsp_message_header hdr;
784 struct nvsp_6_pd_buf pd_buf[0];
787 union nvsp_6_message_uber {
788 struct nvsp_6_pd_api_req pd_req;
789 struct nvsp_6_pd_api_comp pd_comp;
792 union nvsp_all_messages {
793 union nvsp_message_init_uber init_msg;
794 union nvsp_1_message_uber v1_msg;
795 union nvsp_2_message_uber v2_msg;
796 union nvsp_4_message_uber v4_msg;
797 union nvsp_5_message_uber v5_msg;
798 union nvsp_6_message_uber v6_msg;
802 struct nvsp_message {
803 struct nvsp_message_header hdr;
804 union nvsp_all_messages msg;
808 #define NETVSC_MTU 65535
809 #define NETVSC_MTU_MIN ETH_MIN_MTU
811 /* Max buffer sizes allowed by a host */
812 #define NETVSC_RECEIVE_BUFFER_SIZE (1024 * 1024 * 31) /* 31MB */
813 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024 * 1024 * 15) /* 15MB */
814 #define NETVSC_RECEIVE_BUFFER_DEFAULT (1024 * 1024 * 16)
816 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
817 #define NETVSC_SEND_BUFFER_DEFAULT (1024 * 1024)
819 #define NETVSC_INVALID_INDEX -1
821 #define NETVSC_SEND_SECTION_SIZE 6144
822 #define NETVSC_RECV_SECTION_SIZE 1728
824 /* Default size of TX buf: 1MB, RX buf: 16MB */
825 #define NETVSC_MIN_TX_SECTIONS 10
826 #define NETVSC_DEFAULT_TX (NETVSC_SEND_BUFFER_DEFAULT \
827 / NETVSC_SEND_SECTION_SIZE)
828 #define NETVSC_MIN_RX_SECTIONS 10
829 #define NETVSC_DEFAULT_RX (NETVSC_RECEIVE_BUFFER_DEFAULT \
830 / NETVSC_RECV_SECTION_SIZE)
832 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
833 #define NETVSC_SEND_BUFFER_ID 0
835 #define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
836 NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
837 NETIF_F_TSO6 | NETIF_F_LRO)
839 #define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
840 #define VRSS_CHANNEL_MAX 64
841 #define VRSS_CHANNEL_DEFAULT 8
843 #define RNDIS_MAX_PKT_DEFAULT 8
844 #define RNDIS_PKT_ALIGN_DEFAULT 8
846 struct multi_send_data {
847 struct sk_buff *skb; /* skb containing the pkt */
848 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
849 u32 count; /* counter of batched packets */
852 struct recv_comp_data {
853 u64 tid; /* transaction id */
857 struct multi_recv_comp {
858 struct recv_comp_data *slots;
859 u32 first; /* first data entry */
860 u32 next; /* next entry for writing */
863 #define NVSP_RSC_MAX 562 /* Max #RSC frags in a vmbus xfer page pkt */
866 const struct ndis_pkt_8021q_info *vlan;
867 const struct ndis_tcp_ip_checksum_info *csum_info;
868 u8 is_last; /* last RNDIS msg in a vmtransfer_page */
869 u32 cnt; /* #fragments in an RSC packet */
870 u32 pktlen; /* Full packet length */
871 void *data[NVSP_RSC_MAX];
872 u32 len[NVSP_RSC_MAX];
875 struct netvsc_stats {
880 struct u64_stats_sync syncp;
883 struct netvsc_ethtool_stats {
884 unsigned long tx_scattered;
885 unsigned long tx_no_memory;
886 unsigned long tx_no_space;
887 unsigned long tx_too_big;
888 unsigned long tx_busy;
889 unsigned long tx_send_full;
890 unsigned long rx_comp_busy;
891 unsigned long rx_no_memory;
892 unsigned long stop_queue;
893 unsigned long wake_queue;
896 struct netvsc_ethtool_pcpu_stats {
907 struct netvsc_vf_pcpu_stats {
912 struct u64_stats_sync syncp;
916 struct netvsc_reconfig {
917 struct list_head list;
921 /* L4 hash bits for different protocols */
922 #define HV_TCP4_L4HASH 1
923 #define HV_TCP6_L4HASH 2
924 #define HV_UDP4_L4HASH 4
925 #define HV_UDP6_L4HASH 8
926 #define HV_DEFAULT_L4HASH (HV_TCP4_L4HASH | HV_TCP6_L4HASH | HV_UDP4_L4HASH | \
929 /* The context of the netvsc device */
930 struct net_device_context {
931 /* point back to our device context */
932 struct hv_device *device_ctx;
934 struct netvsc_device __rcu *nvdev;
935 /* list of netvsc net_devices */
936 struct list_head list;
937 /* reconfigure work */
938 struct delayed_work dwork;
939 /* last reconfig time */
940 unsigned long last_reconfig;
941 /* reconfig events */
942 struct list_head reconfig_events;
943 /* list protection */
946 u32 msg_enable; /* debug level */
948 u32 tx_checksum_mask;
950 u32 tx_table[VRSS_SEND_TAB_SIZE];
952 /* Ethtool settings */
955 u32 l4_hash; /* L4 hash settings */
956 struct netvsc_ethtool_stats eth_stats;
958 /* State to manage the associated VF interface. */
959 struct net_device __rcu *vf_netdev;
960 struct netvsc_vf_pcpu_stats __percpu *vf_stats;
961 struct delayed_work vf_takeover;
963 /* 1: allocated, serial number is valid. 0: not allocated */
965 /* Serial number of the VF to team with */
969 /* Per channel data */
970 struct netvsc_channel {
971 struct vmbus_channel *channel;
972 struct netvsc_device *net_device;
973 const struct vmpacket_descriptor *desc;
974 struct napi_struct napi;
975 struct multi_send_data msd;
976 struct multi_recv_comp mrc;
977 atomic_t queue_sends;
980 struct netvsc_stats tx_stats;
981 struct netvsc_stats rx_stats;
984 /* Per netvsc device */
985 struct netvsc_device {
988 wait_queue_head_t wait_drain;
990 bool tx_disable; /* if true, do not wake up queue again */
992 /* Receive buffer allocated by us but manages by NetVSP */
994 u32 recv_buf_size; /* allocated bytes */
995 u32 recv_buf_gpadl_handle;
996 u32 recv_section_cnt;
997 u32 recv_section_size;
998 u32 recv_completion_cnt;
1000 /* Send buffer allocated by us */
1002 u32 send_buf_gpadl_handle;
1003 u32 send_section_cnt;
1004 u32 send_section_size;
1005 unsigned long *send_section_map;
1007 /* Used for NetVSP initialization protocol */
1008 struct completion channel_init_wait;
1009 struct nvsp_message channel_init_pkt;
1011 struct nvsp_message revoke_packet;
1017 struct work_struct subchan_work;
1018 wait_queue_head_t subchan_open;
1020 struct rndis_device *extension;
1022 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
1023 u32 pkt_align; /* alignment bytes, e.g. 8 */
1025 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
1027 struct rcu_head rcu;
1030 /* NdisInitialize message */
1031 struct rndis_initialize_request {
1038 /* Response to NdisInitialize */
1039 struct rndis_initialize_complete {
1046 u32 max_pkt_per_msg;
1048 u32 pkt_alignment_factor;
1053 /* Call manager devices only: Information about an address family */
1054 /* supported by the device is appended to the response to NdisInitialize. */
1055 struct rndis_co_address_family {
1061 /* NdisHalt message */
1062 struct rndis_halt_request {
1066 /* NdisQueryRequest message */
1067 struct rndis_query_request {
1071 u32 info_buf_offset;
1075 /* Response to NdisQueryRequest */
1076 struct rndis_query_complete {
1080 u32 info_buf_offset;
1083 /* NdisSetRequest message */
1084 struct rndis_set_request {
1088 u32 info_buf_offset;
1092 /* Response to NdisSetRequest */
1093 struct rndis_set_complete {
1098 /* NdisReset message */
1099 struct rndis_reset_request {
1103 /* Response to NdisReset */
1104 struct rndis_reset_complete {
1106 u32 addressing_reset;
1109 /* NdisMIndicateStatus message */
1110 struct rndis_indicate_status {
1113 u32 status_buf_offset;
1116 /* Diagnostic information passed as the status buffer in */
1117 /* struct rndis_indicate_status messages signifying error conditions. */
1118 struct rndis_diagnostic_info {
1123 /* NdisKeepAlive message */
1124 struct rndis_keepalive_request {
1128 /* Response to NdisKeepAlive */
1129 struct rndis_keepalive_complete {
1135 * Data message. All Offset fields contain byte offsets from the beginning of
1136 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
1137 * to 0 for connectionless data, otherwise it contains the VC handle.
1139 struct rndis_packet {
1142 u32 oob_data_offset;
1144 u32 num_oob_data_elements;
1145 u32 per_pkt_info_offset;
1146 u32 per_pkt_info_len;
1151 /* Optional Out of Band data associated with a Data message. */
1155 u32 class_info_offset;
1158 /* Packet extension field contents associated with a Data message. */
1159 struct rndis_per_packet_info {
1166 enum ndis_per_pkt_info_type {
1167 TCPIP_CHKSUM_PKTINFO,
1169 TCP_LARGESEND_PKTINFO,
1170 CLASSIFICATION_HANDLE_PKTINFO,
1176 NBL_HASH_VALUE = PACKET_CANCEL_ID,
1177 ORIGINAL_NET_BUFLIST,
1183 enum rndis_per_pkt_info_interal_type {
1184 RNDIS_PKTINFO_ID = 1,
1185 /* Add more members here */
1190 #define RNDIS_PKTINFO_SUBALLOC BIT(0)
1191 #define RNDIS_PKTINFO_1ST_FRAG BIT(1)
1192 #define RNDIS_PKTINFO_LAST_FRAG BIT(2)
1194 #define RNDIS_PKTINFO_ID_V1 1
1196 struct rndis_pktinfo_id {
1202 struct ndis_pkt_8021q_info {
1205 u32 pri:3; /* User Priority */
1206 u32 cfi:1; /* Canonical Format ID */
1207 u32 vlanid:12; /* VLAN ID */
1214 struct ndis_object_header {
1220 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
1221 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
1222 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
1223 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
1225 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
1226 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
1227 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
1228 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
1229 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
1230 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1231 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1232 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1233 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1234 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1236 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
1237 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
1238 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
1240 #define VERSION_4_OFFLOAD_SIZE 22
1242 * New offload OIDs for NDIS 6
1244 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1245 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1246 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1247 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1248 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1249 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1252 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1253 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1256 #define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1257 #define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1258 #define NDIS_OFFLOAD_ENCAP_8023 0x0002
1259 #define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1260 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1261 #define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1263 struct ndis_csum_offload {
1266 #define NDIS_TXCSUM_CAP_IP4OPT 0x001
1267 #define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1268 #define NDIS_TXCSUM_CAP_TCP4 0x010
1269 #define NDIS_TXCSUM_CAP_UDP4 0x040
1270 #define NDIS_TXCSUM_CAP_IP4 0x100
1272 #define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1276 #define NDIS_RXCSUM_CAP_IP4OPT 0x001
1277 #define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1278 #define NDIS_RXCSUM_CAP_TCP4 0x010
1279 #define NDIS_RXCSUM_CAP_UDP4 0x040
1280 #define NDIS_RXCSUM_CAP_IP4 0x100
1283 #define NDIS_TXCSUM_CAP_IP6EXT 0x001
1284 #define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1285 #define NDIS_TXCSUM_CAP_TCP6 0x010
1286 #define NDIS_TXCSUM_CAP_UDP6 0x040
1289 #define NDIS_RXCSUM_CAP_IP6EXT 0x001
1290 #define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1291 #define NDIS_RXCSUM_CAP_TCP6 0x010
1292 #define NDIS_RXCSUM_CAP_UDP6 0x040
1294 #define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1295 NDIS_TXCSUM_CAP_TCP6OPT | \
1296 NDIS_TXCSUM_CAP_IP6EXT)
1299 struct ndis_lsov1_offload {
1306 struct ndis_ipsecv1_offload {
1316 struct ndis_lsov2_offload {
1324 #define NDIS_LSOV2_CAP_IP6EXT 0x001
1325 #define NDIS_LSOV2_CAP_TCP6OPT 0x004
1327 #define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1328 NDIS_LSOV2_CAP_TCP6OPT)
1331 struct ndis_ipsecv2_offload {
1350 struct ndis_rsc_offload {
1355 struct ndis_encap_offload {
1360 struct ndis_offload {
1361 struct ndis_object_header header;
1362 struct ndis_csum_offload csum;
1363 struct ndis_lsov1_offload lsov1;
1364 struct ndis_ipsecv1_offload ipsecv1;
1365 struct ndis_lsov2_offload lsov2;
1368 struct ndis_ipsecv2_offload ipsecv2;
1370 struct ndis_rsc_offload rsc;
1371 struct ndis_encap_offload encap_gre;
1374 #define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1375 #define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1376 #define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1378 struct ndis_offload_params {
1379 struct ndis_object_header header;
1389 u8 tcp_connection_ip_v4;
1390 u8 tcp_connection_ip_v6;
1399 u8 encapsulated_packet_task_offload;
1400 u8 encapsulation_types;
1404 struct ndis_tcp_ip_checksum_info {
1411 u32 ip_header_checksum:1;
1413 u32 tcp_header_offset:10;
1416 u32 tcp_checksum_failed:1;
1417 u32 udp_checksum_failed:1;
1418 u32 ip_checksum_failed:1;
1419 u32 tcp_checksum_succeeded:1;
1420 u32 udp_checksum_succeeded:1;
1421 u32 ip_checksum_succeeded:1;
1423 u32 tcp_checksum_value_invalid:1;
1424 u32 ip_checksum_value_invalid:1;
1430 struct ndis_tcp_lso_info {
1439 u32 tcp_header_offset:10;
1447 } lso_v1_transmit_complete;
1450 u32 tcp_header_offset:10;
1458 } lso_v2_transmit_complete;
1463 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1464 sizeof(struct ndis_pkt_8021q_info))
1466 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1467 sizeof(struct ndis_tcp_ip_checksum_info))
1469 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1470 sizeof(struct ndis_tcp_lso_info))
1472 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1475 /* Total size of all PPI data */
1476 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1477 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1479 /* Format of Information buffer passed in a SetRequest for the OID */
1480 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1481 struct rndis_config_parameter_info {
1482 u32 parameter_name_offset;
1483 u32 parameter_name_length;
1485 u32 parameter_value_offset;
1486 u32 parameter_value_length;
1489 /* Values for ParameterType in struct rndis_config_parameter_info */
1490 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1491 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1493 /* CONDIS Miniport messages for connection oriented devices */
1494 /* that do not implement a call manager. */
1496 /* CoNdisMiniportCreateVc message */
1497 struct rcondis_mp_create_vc {
1502 /* Response to CoNdisMiniportCreateVc */
1503 struct rcondis_mp_create_vc_complete {
1509 /* CoNdisMiniportDeleteVc message */
1510 struct rcondis_mp_delete_vc {
1515 /* Response to CoNdisMiniportDeleteVc */
1516 struct rcondis_mp_delete_vc_complete {
1521 /* CoNdisMiniportQueryRequest message */
1522 struct rcondis_mp_query_request {
1528 u32 info_buf_offset;
1531 /* CoNdisMiniportSetRequest message */
1532 struct rcondis_mp_set_request {
1538 u32 info_buf_offset;
1541 /* CoNdisIndicateStatus message */
1542 struct rcondis_indicate_status {
1546 u32 status_buf_offset;
1549 /* CONDIS Call/VC parameters */
1550 struct rcondis_specific_parameters {
1552 u32 parameter_length;
1553 u32 parameter_lffset;
1556 struct rcondis_media_parameters {
1560 struct rcondis_specific_parameters media_specific;
1563 struct rndis_flowspec {
1565 u32 token_bucket_size;
1568 u32 delay_variation;
1571 u32 minimum_policed_size;
1574 struct rcondis_call_manager_parameters {
1575 struct rndis_flowspec transmit;
1576 struct rndis_flowspec receive;
1577 struct rcondis_specific_parameters call_mgr_specific;
1580 /* CoNdisMiniportActivateVc message */
1581 struct rcondis_mp_activate_vc_request {
1585 u32 media_params_offset;
1586 u32 media_params_length;
1587 u32 call_mgr_params_offset;
1588 u32 call_mgr_params_length;
1591 /* Response to CoNdisMiniportActivateVc */
1592 struct rcondis_mp_activate_vc_complete {
1597 /* CoNdisMiniportDeactivateVc message */
1598 struct rcondis_mp_deactivate_vc_request {
1604 /* Response to CoNdisMiniportDeactivateVc */
1605 struct rcondis_mp_deactivate_vc_complete {
1611 /* union with all of the RNDIS messages */
1612 union rndis_message_container {
1613 struct rndis_packet pkt;
1614 struct rndis_initialize_request init_req;
1615 struct rndis_halt_request halt_req;
1616 struct rndis_query_request query_req;
1617 struct rndis_set_request set_req;
1618 struct rndis_reset_request reset_req;
1619 struct rndis_keepalive_request keep_alive_req;
1620 struct rndis_indicate_status indicate_status;
1621 struct rndis_initialize_complete init_complete;
1622 struct rndis_query_complete query_complete;
1623 struct rndis_set_complete set_complete;
1624 struct rndis_reset_complete reset_complete;
1625 struct rndis_keepalive_complete keep_alive_complete;
1626 struct rcondis_mp_create_vc co_miniport_create_vc;
1627 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1628 struct rcondis_indicate_status co_indicate_status;
1629 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1630 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1631 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1632 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1633 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1634 struct rcondis_mp_deactivate_vc_complete
1635 co_miniport_deactivate_vc_complete;
1638 /* Remote NDIS message format */
1639 struct rndis_message {
1642 /* Total length of this message, from the beginning */
1643 /* of the struct rndis_message, in bytes. */
1646 /* Actual message */
1647 union rndis_message_container msg;
1653 /* get the size of an RNDIS message. Pass in the message type, */
1654 /* struct rndis_set_request, struct rndis_packet for example */
1655 #define RNDIS_MESSAGE_SIZE(msg) \
1656 (sizeof(msg) + (sizeof(struct rndis_message) - \
1657 sizeof(union rndis_message_container)))
1659 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1660 sizeof(union rndis_message_container))
1662 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1664 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1665 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1666 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1667 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1668 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1669 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1670 #define NDIS_PACKET_TYPE_SMT 0x00000040
1671 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1672 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1673 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1674 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1675 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1677 #define TRANSPORT_INFO_NOT_IP 0
1678 #define TRANSPORT_INFO_IPV4_TCP 0x01
1679 #define TRANSPORT_INFO_IPV4_UDP 0x02
1680 #define TRANSPORT_INFO_IPV6_TCP 0x10
1681 #define TRANSPORT_INFO_IPV6_UDP 0x20
1683 #endif /* _HYPERV_NET_H */