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];
153 u32 send_section_size;
154 u32 recv_section_size;
157 enum rndis_device_state {
158 RNDIS_DEV_UNINITIALIZED = 0,
159 RNDIS_DEV_INITIALIZING,
160 RNDIS_DEV_INITIALIZED,
161 RNDIS_DEV_DATAINITIALIZED,
164 #define NETVSC_HASH_KEYLEN 40
166 struct rndis_device {
167 struct net_device *ndev;
169 enum rndis_device_state state;
173 spinlock_t request_lock;
174 struct list_head req_list;
176 struct work_struct mcast_work;
178 bool link_state; /* 0 - link up, 1 - link down */
180 u8 hw_mac_adr[ETH_ALEN];
181 u8 rss_key[NETVSC_HASH_KEYLEN];
186 struct rndis_message;
187 struct netvsc_device;
188 struct net_device_context;
190 struct netvsc_device *netvsc_device_add(struct hv_device *device,
191 const struct netvsc_device_info *info);
192 int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
193 void netvsc_device_remove(struct hv_device *device);
194 int netvsc_send(struct net_device *net,
195 struct hv_netvsc_packet *packet,
196 struct rndis_message *rndis_msg,
197 struct hv_page_buffer *page_buffer,
198 struct sk_buff *skb);
199 void netvsc_linkstatus_callback(struct hv_device *device_obj,
200 struct rndis_message *resp);
201 int netvsc_recv_callback(struct net_device *net,
202 struct vmbus_channel *channel,
204 const struct ndis_tcp_ip_checksum_info *csum_info,
205 const struct ndis_pkt_8021q_info *vlan);
206 void netvsc_channel_cb(void *context);
207 int netvsc_poll(struct napi_struct *napi, int budget);
209 int rndis_set_subchannel(struct net_device *ndev, struct netvsc_device *nvdev);
210 int rndis_filter_open(struct netvsc_device *nvdev);
211 int rndis_filter_close(struct netvsc_device *nvdev);
212 struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
213 struct netvsc_device_info *info);
214 void rndis_filter_update(struct netvsc_device *nvdev);
215 void rndis_filter_device_remove(struct hv_device *dev,
216 struct netvsc_device *nvdev);
217 int rndis_filter_set_rss_param(struct rndis_device *rdev,
219 int rndis_filter_receive(struct net_device *ndev,
220 struct netvsc_device *net_dev,
221 struct hv_device *dev,
222 struct vmbus_channel *channel,
223 void *data, u32 buflen);
225 int rndis_filter_set_device_mac(struct netvsc_device *ndev,
228 void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
230 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
232 #define NVSP_PROTOCOL_VERSION_1 2
233 #define NVSP_PROTOCOL_VERSION_2 0x30002
234 #define NVSP_PROTOCOL_VERSION_4 0x40000
235 #define NVSP_PROTOCOL_VERSION_5 0x50000
238 NVSP_MSG_TYPE_NONE = 0,
241 NVSP_MSG_TYPE_INIT = 1,
242 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
244 NVSP_VERSION_MSG_START = 100,
246 /* Version 1 Messages */
247 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
249 NVSP_MSG1_TYPE_SEND_RECV_BUF,
250 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
251 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
253 NVSP_MSG1_TYPE_SEND_SEND_BUF,
254 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
255 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
257 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
258 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
260 /* Version 2 messages */
261 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
262 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
263 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
265 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
267 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
268 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
270 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
272 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
273 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
275 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
276 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
278 NVSP_MSG2_TYPE_ALLOC_RXBUF,
279 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
281 NVSP_MSG2_TYPE_FREE_RXBUF,
283 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
284 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
286 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
288 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
289 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
291 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
293 /* Version 4 messages */
294 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
295 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
296 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
298 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
300 /* Version 5 messages */
301 NVSP_MSG5_TYPE_OID_QUERY_EX,
302 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
303 NVSP_MSG5_TYPE_SUBCHANNEL,
304 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
306 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
313 NVSP_STAT_PROTOCOL_TOO_NEW,
314 NVSP_STAT_PROTOCOL_TOO_OLD,
315 NVSP_STAT_INVALID_RNDIS_PKT,
317 NVSP_STAT_PROTOCOL_UNSUPPORTED,
321 struct nvsp_message_header {
328 * This message is used by the VSC to initialize the channel after the channels
329 * has been opened. This message should never include anything other then
330 * versioning (i.e. this message will be the same for ever).
332 struct nvsp_message_init {
333 u32 min_protocol_ver;
334 u32 max_protocol_ver;
338 * This message is used by the VSP to complete the initialization of the
339 * channel. This message should never include anything other then versioning
340 * (i.e. this message will be the same for ever).
342 struct nvsp_message_init_complete {
343 u32 negotiated_protocol_ver;
344 u32 max_mdl_chain_len;
348 union nvsp_message_init_uber {
349 struct nvsp_message_init init;
350 struct nvsp_message_init_complete init_complete;
353 /* Version 1 Messages */
356 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
357 * can use this information when handling OIDs sent by the VSC.
359 struct nvsp_1_message_send_ndis_version {
365 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
366 * can then use the receive buffer to send data to the VSC.
368 struct nvsp_1_message_send_receive_buffer {
373 struct nvsp_1_receive_buffer_section {
381 * This message is used by the VSP to acknowledge a receive buffer send by the
382 * VSC. This message must be sent by the VSP before the VSP uses the receive
385 struct nvsp_1_message_send_receive_buffer_complete {
390 * The receive buffer is split into two parts, a large suballocation
391 * section and a small suballocation section. These sections are then
392 * suballocated by a certain size.
396 * For example, the following break up of the receive buffer has 6
397 * large suballocations and 10 small suballocations.
401 * | Large Section | | Small Section |
402 * ------------------------------------------------------------
403 * | | | | | | | | | | | | | | | | | |
405 * LargeOffset SmallOffset
408 struct nvsp_1_receive_buffer_section sections[1];
412 * This message is sent by the VSC to revoke the receive buffer. After the VSP
413 * completes this transaction, the vsp should never use the receive buffer
416 struct nvsp_1_message_revoke_receive_buffer {
421 * This message is used by the VSC to send a send buffer to the VSP. The VSC
422 * can then use the send buffer to send data to the VSP.
424 struct nvsp_1_message_send_send_buffer {
430 * This message is used by the VSP to acknowledge a send buffer sent by the
431 * VSC. This message must be sent by the VSP before the VSP uses the sent
434 struct nvsp_1_message_send_send_buffer_complete {
438 * The VSC gets to choose the size of the send buffer and the VSP gets
439 * to choose the sections size of the buffer. This was done to enable
440 * dynamic reconfigurations when the cost of GPA-direct buffers
447 * This message is sent by the VSC to revoke the send buffer. After the VSP
448 * completes this transaction, the vsp should never use the send buffer again.
450 struct nvsp_1_message_revoke_send_buffer {
455 * This message is used by both the VSP and the VSC to send a RNDIS message to
456 * the opposite channel endpoint.
458 struct nvsp_1_message_send_rndis_packet {
460 * This field is specified by RNDIS. They assume there's two different
461 * channels of communication. However, the Network VSP only has one.
462 * Therefore, the channel travels with the RNDIS packet.
467 * This field is used to send part or all of the data through a send
468 * buffer. This values specifies an index into the send buffer. If the
469 * index is 0xFFFFFFFF, then the send buffer is not being used and all
470 * of the data was sent through other VMBus mechanisms.
472 u32 send_buf_section_index;
473 u32 send_buf_section_size;
477 * This message is used by both the VSP and the VSC to complete a RNDIS message
478 * to the opposite channel endpoint. At this point, the initiator of this
479 * message cannot use any resources associated with the original RNDIS packet.
481 struct nvsp_1_message_send_rndis_packet_complete {
485 union nvsp_1_message_uber {
486 struct nvsp_1_message_send_ndis_version send_ndis_ver;
488 struct nvsp_1_message_send_receive_buffer send_recv_buf;
489 struct nvsp_1_message_send_receive_buffer_complete
490 send_recv_buf_complete;
491 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
493 struct nvsp_1_message_send_send_buffer send_send_buf;
494 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
495 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
497 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
498 struct nvsp_1_message_send_rndis_packet_complete
499 send_rndis_pkt_complete;
504 * Network VSP protocol version 2 messages:
506 struct nvsp_2_vsc_capability {
514 u64 correlation_id:1;
520 struct nvsp_2_send_ndis_config {
523 struct nvsp_2_vsc_capability capability;
526 /* Allocate receive buffer */
527 struct nvsp_2_alloc_rxbuf {
528 /* Allocation ID to match the allocation request and response */
531 /* Length of the VM shared memory receive buffer that needs to
537 /* Allocate receive buffer complete */
538 struct nvsp_2_alloc_rxbuf_comp {
539 /* The NDIS_STATUS code for buffer allocation */
544 /* GPADL handle for the allocated receive buffer */
547 /* Receive buffer ID */
551 struct nvsp_2_free_rxbuf {
555 union nvsp_2_message_uber {
556 struct nvsp_2_send_ndis_config send_ndis_config;
557 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
558 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
559 struct nvsp_2_free_rxbuf free_rxbuf;
562 struct nvsp_4_send_vf_association {
563 /* 1: allocated, serial number is valid. 0: not allocated */
566 /* Serial number of the VF to team with */
570 enum nvsp_vm_datapath {
571 NVSP_DATAPATH_SYNTHETIC = 0,
576 struct nvsp_4_sw_datapath {
577 u32 active_datapath; /* active data path in VM */
580 union nvsp_4_message_uber {
581 struct nvsp_4_send_vf_association vf_assoc;
582 struct nvsp_4_sw_datapath active_dp;
585 enum nvsp_subchannel_operation {
586 NVSP_SUBCHANNEL_NONE = 0,
587 NVSP_SUBCHANNEL_ALLOCATE,
591 struct nvsp_5_subchannel_request {
596 struct nvsp_5_subchannel_complete {
598 u32 num_subchannels; /* Actual number of subchannels allocated */
601 struct nvsp_5_send_indirect_table {
602 /* The number of entries in the send indirection table */
605 /* The offset of the send indirection table from top of this struct.
606 * The send indirection table tells which channel to put the send
607 * traffic on. Each entry is a channel number.
612 union nvsp_5_message_uber {
613 struct nvsp_5_subchannel_request subchn_req;
614 struct nvsp_5_subchannel_complete subchn_comp;
615 struct nvsp_5_send_indirect_table send_table;
618 union nvsp_all_messages {
619 union nvsp_message_init_uber init_msg;
620 union nvsp_1_message_uber v1_msg;
621 union nvsp_2_message_uber v2_msg;
622 union nvsp_4_message_uber v4_msg;
623 union nvsp_5_message_uber v5_msg;
627 struct nvsp_message {
628 struct nvsp_message_header hdr;
629 union nvsp_all_messages msg;
633 #define NETVSC_MTU 65535
634 #define NETVSC_MTU_MIN ETH_MIN_MTU
636 /* Max buffer sizes allowed by a host */
637 #define NETVSC_RECEIVE_BUFFER_SIZE (1024 * 1024 * 31) /* 31MB */
638 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024 * 1024 * 15) /* 15MB */
639 #define NETVSC_RECEIVE_BUFFER_DEFAULT (1024 * 1024 * 16)
641 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
642 #define NETVSC_SEND_BUFFER_DEFAULT (1024 * 1024)
644 #define NETVSC_INVALID_INDEX -1
646 #define NETVSC_SEND_SECTION_SIZE 6144
647 #define NETVSC_RECV_SECTION_SIZE 1728
649 /* Default size of TX buf: 1MB, RX buf: 16MB */
650 #define NETVSC_MIN_TX_SECTIONS 10
651 #define NETVSC_DEFAULT_TX (NETVSC_SEND_BUFFER_DEFAULT \
652 / NETVSC_SEND_SECTION_SIZE)
653 #define NETVSC_MIN_RX_SECTIONS 10
654 #define NETVSC_DEFAULT_RX (NETVSC_RECEIVE_BUFFER_DEFAULT \
655 / NETVSC_RECV_SECTION_SIZE)
657 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
658 #define NETVSC_SEND_BUFFER_ID 0
660 #define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
661 NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
664 #define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
665 #define VRSS_CHANNEL_MAX 64
666 #define VRSS_CHANNEL_DEFAULT 8
668 #define RNDIS_MAX_PKT_DEFAULT 8
669 #define RNDIS_PKT_ALIGN_DEFAULT 8
671 struct multi_send_data {
672 struct sk_buff *skb; /* skb containing the pkt */
673 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
674 u32 count; /* counter of batched packets */
677 struct recv_comp_data {
678 u64 tid; /* transaction id */
682 struct multi_recv_comp {
683 struct recv_comp_data *slots;
684 u32 first; /* first data entry */
685 u32 next; /* next entry for writing */
688 struct netvsc_stats {
693 struct u64_stats_sync syncp;
696 struct netvsc_ethtool_stats {
697 unsigned long tx_scattered;
698 unsigned long tx_no_memory;
699 unsigned long tx_no_space;
700 unsigned long tx_too_big;
701 unsigned long tx_busy;
702 unsigned long tx_send_full;
703 unsigned long rx_comp_busy;
706 struct netvsc_vf_pcpu_stats {
711 struct u64_stats_sync syncp;
715 struct netvsc_reconfig {
716 struct list_head list;
720 /* The context of the netvsc device */
721 struct net_device_context {
722 /* point back to our device context */
723 struct hv_device *device_ctx;
725 struct netvsc_device __rcu *nvdev;
726 /* list of netvsc net_devices */
727 struct list_head list;
728 /* reconfigure work */
729 struct delayed_work dwork;
730 /* last reconfig time */
731 unsigned long last_reconfig;
732 /* reconfig events */
733 struct list_head reconfig_events;
734 /* list protection */
737 u32 msg_enable; /* debug level */
739 u32 tx_checksum_mask;
741 u32 tx_table[VRSS_SEND_TAB_SIZE];
743 u16 rx_table[ITAB_NUM];
745 /* Ethtool settings */
750 struct netvsc_ethtool_stats eth_stats;
752 /* State to manage the associated VF interface. */
753 struct net_device __rcu *vf_netdev;
754 struct netvsc_vf_pcpu_stats __percpu *vf_stats;
755 struct delayed_work vf_takeover;
757 /* 1: allocated, serial number is valid. 0: not allocated */
759 /* Serial number of the VF to team with */
763 /* Per channel data */
764 struct netvsc_channel {
765 struct vmbus_channel *channel;
766 struct netvsc_device *net_device;
767 const struct vmpacket_descriptor *desc;
768 struct napi_struct napi;
769 struct multi_send_data msd;
770 struct multi_recv_comp mrc;
771 atomic_t queue_sends;
773 struct netvsc_stats tx_stats;
774 struct netvsc_stats rx_stats;
777 /* Per netvsc device */
778 struct netvsc_device {
781 wait_queue_head_t wait_drain;
783 bool tx_disable; /* if true, do not wake up queue again */
785 /* Receive buffer allocated by us but manages by NetVSP */
787 u32 recv_buf_gpadl_handle;
788 u32 recv_section_cnt;
789 u32 recv_section_size;
790 u32 recv_completion_cnt;
792 /* Send buffer allocated by us */
794 u32 send_buf_gpadl_handle;
795 u32 send_section_cnt;
796 u32 send_section_size;
797 unsigned long *send_section_map;
799 /* Used for NetVSP initialization protocol */
800 struct completion channel_init_wait;
801 struct nvsp_message channel_init_pkt;
803 struct nvsp_message revoke_packet;
809 struct work_struct subchan_work;
810 wait_queue_head_t subchan_open;
812 struct rndis_device *extension;
816 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
817 u32 pkt_align; /* alignment bytes, e.g. 8 */
821 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
826 /* NdisInitialize message */
827 struct rndis_initialize_request {
834 /* Response to NdisInitialize */
835 struct rndis_initialize_complete {
844 u32 pkt_alignment_factor;
849 /* Call manager devices only: Information about an address family */
850 /* supported by the device is appended to the response to NdisInitialize. */
851 struct rndis_co_address_family {
857 /* NdisHalt message */
858 struct rndis_halt_request {
862 /* NdisQueryRequest message */
863 struct rndis_query_request {
871 /* Response to NdisQueryRequest */
872 struct rndis_query_complete {
879 /* NdisSetRequest message */
880 struct rndis_set_request {
888 /* Response to NdisSetRequest */
889 struct rndis_set_complete {
894 /* NdisReset message */
895 struct rndis_reset_request {
899 /* Response to NdisReset */
900 struct rndis_reset_complete {
902 u32 addressing_reset;
905 /* NdisMIndicateStatus message */
906 struct rndis_indicate_status {
909 u32 status_buf_offset;
912 /* Diagnostic information passed as the status buffer in */
913 /* struct rndis_indicate_status messages signifying error conditions. */
914 struct rndis_diagnostic_info {
919 /* NdisKeepAlive message */
920 struct rndis_keepalive_request {
924 /* Response to NdisKeepAlive */
925 struct rndis_keepalive_complete {
931 * Data message. All Offset fields contain byte offsets from the beginning of
932 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
933 * to 0 for connectionless data, otherwise it contains the VC handle.
935 struct rndis_packet {
940 u32 num_oob_data_elements;
941 u32 per_pkt_info_offset;
942 u32 per_pkt_info_len;
947 /* Optional Out of Band data associated with a Data message. */
951 u32 class_info_offset;
954 /* Packet extension field contents associated with a Data message. */
955 struct rndis_per_packet_info {
961 enum ndis_per_pkt_info_type {
962 TCPIP_CHKSUM_PKTINFO,
964 TCP_LARGESEND_PKTINFO,
965 CLASSIFICATION_HANDLE_PKTINFO,
971 NBL_HASH_VALUE = PACKET_CANCEL_ID,
972 ORIGINAL_NET_BUFLIST,
978 struct ndis_pkt_8021q_info {
981 u32 pri:3; /* User Priority */
982 u32 cfi:1; /* Canonical Format ID */
983 u32 vlanid:12; /* VLAN ID */
990 struct ndis_object_header {
996 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
997 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
998 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
999 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
1001 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
1002 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
1003 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
1004 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
1005 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
1006 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1007 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1008 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1009 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1010 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1012 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
1013 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
1014 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
1016 #define VERSION_4_OFFLOAD_SIZE 22
1018 * New offload OIDs for NDIS 6
1020 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1021 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1022 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1023 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1024 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1025 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1028 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1029 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1032 #define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1033 #define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1034 #define NDIS_OFFLOAD_ENCAP_8023 0x0002
1035 #define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1036 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1037 #define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1039 struct ndis_csum_offload {
1042 #define NDIS_TXCSUM_CAP_IP4OPT 0x001
1043 #define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1044 #define NDIS_TXCSUM_CAP_TCP4 0x010
1045 #define NDIS_TXCSUM_CAP_UDP4 0x040
1046 #define NDIS_TXCSUM_CAP_IP4 0x100
1048 #define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1052 #define NDIS_RXCSUM_CAP_IP4OPT 0x001
1053 #define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1054 #define NDIS_RXCSUM_CAP_TCP4 0x010
1055 #define NDIS_RXCSUM_CAP_UDP4 0x040
1056 #define NDIS_RXCSUM_CAP_IP4 0x100
1059 #define NDIS_TXCSUM_CAP_IP6EXT 0x001
1060 #define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1061 #define NDIS_TXCSUM_CAP_TCP6 0x010
1062 #define NDIS_TXCSUM_CAP_UDP6 0x040
1065 #define NDIS_RXCSUM_CAP_IP6EXT 0x001
1066 #define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1067 #define NDIS_RXCSUM_CAP_TCP6 0x010
1068 #define NDIS_RXCSUM_CAP_UDP6 0x040
1070 #define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1071 NDIS_TXCSUM_CAP_TCP6OPT | \
1072 NDIS_TXCSUM_CAP_IP6EXT)
1075 struct ndis_lsov1_offload {
1082 struct ndis_ipsecv1_offload {
1092 struct ndis_lsov2_offload {
1100 #define NDIS_LSOV2_CAP_IP6EXT 0x001
1101 #define NDIS_LSOV2_CAP_TCP6OPT 0x004
1103 #define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1104 NDIS_LSOV2_CAP_TCP6OPT)
1107 struct ndis_ipsecv2_offload {
1126 struct ndis_rsc_offload {
1131 struct ndis_encap_offload {
1136 struct ndis_offload {
1137 struct ndis_object_header header;
1138 struct ndis_csum_offload csum;
1139 struct ndis_lsov1_offload lsov1;
1140 struct ndis_ipsecv1_offload ipsecv1;
1141 struct ndis_lsov2_offload lsov2;
1144 struct ndis_ipsecv2_offload ipsecv2;
1146 struct ndis_rsc_offload rsc;
1147 struct ndis_encap_offload encap_gre;
1150 #define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1151 #define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1152 #define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1154 struct ndis_offload_params {
1155 struct ndis_object_header header;
1165 u8 tcp_connection_ip_v4;
1166 u8 tcp_connection_ip_v6;
1175 u8 encapsulated_packet_task_offload;
1176 u8 encapsulation_types;
1180 struct ndis_tcp_ip_checksum_info {
1187 u32 ip_header_checksum:1;
1189 u32 tcp_header_offset:10;
1192 u32 tcp_checksum_failed:1;
1193 u32 udp_checksum_failed:1;
1194 u32 ip_checksum_failed:1;
1195 u32 tcp_checksum_succeeded:1;
1196 u32 udp_checksum_succeeded:1;
1197 u32 ip_checksum_succeeded:1;
1199 u32 tcp_checksum_value_invalid:1;
1200 u32 ip_checksum_value_invalid:1;
1206 struct ndis_tcp_lso_info {
1215 u32 tcp_header_offset:10;
1223 } lso_v1_transmit_complete;
1226 u32 tcp_header_offset:10;
1234 } lso_v2_transmit_complete;
1239 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1240 sizeof(struct ndis_pkt_8021q_info))
1242 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1243 sizeof(struct ndis_tcp_ip_checksum_info))
1245 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1246 sizeof(struct ndis_tcp_lso_info))
1248 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1251 /* Total size of all PPI data */
1252 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1253 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1255 /* Format of Information buffer passed in a SetRequest for the OID */
1256 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1257 struct rndis_config_parameter_info {
1258 u32 parameter_name_offset;
1259 u32 parameter_name_length;
1261 u32 parameter_value_offset;
1262 u32 parameter_value_length;
1265 /* Values for ParameterType in struct rndis_config_parameter_info */
1266 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1267 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1269 /* CONDIS Miniport messages for connection oriented devices */
1270 /* that do not implement a call manager. */
1272 /* CoNdisMiniportCreateVc message */
1273 struct rcondis_mp_create_vc {
1278 /* Response to CoNdisMiniportCreateVc */
1279 struct rcondis_mp_create_vc_complete {
1285 /* CoNdisMiniportDeleteVc message */
1286 struct rcondis_mp_delete_vc {
1291 /* Response to CoNdisMiniportDeleteVc */
1292 struct rcondis_mp_delete_vc_complete {
1297 /* CoNdisMiniportQueryRequest message */
1298 struct rcondis_mp_query_request {
1304 u32 info_buf_offset;
1307 /* CoNdisMiniportSetRequest message */
1308 struct rcondis_mp_set_request {
1314 u32 info_buf_offset;
1317 /* CoNdisIndicateStatus message */
1318 struct rcondis_indicate_status {
1322 u32 status_buf_offset;
1325 /* CONDIS Call/VC parameters */
1326 struct rcondis_specific_parameters {
1328 u32 parameter_length;
1329 u32 parameter_lffset;
1332 struct rcondis_media_parameters {
1336 struct rcondis_specific_parameters media_specific;
1339 struct rndis_flowspec {
1341 u32 token_bucket_size;
1344 u32 delay_variation;
1347 u32 minimum_policed_size;
1350 struct rcondis_call_manager_parameters {
1351 struct rndis_flowspec transmit;
1352 struct rndis_flowspec receive;
1353 struct rcondis_specific_parameters call_mgr_specific;
1356 /* CoNdisMiniportActivateVc message */
1357 struct rcondis_mp_activate_vc_request {
1361 u32 media_params_offset;
1362 u32 media_params_length;
1363 u32 call_mgr_params_offset;
1364 u32 call_mgr_params_length;
1367 /* Response to CoNdisMiniportActivateVc */
1368 struct rcondis_mp_activate_vc_complete {
1373 /* CoNdisMiniportDeactivateVc message */
1374 struct rcondis_mp_deactivate_vc_request {
1380 /* Response to CoNdisMiniportDeactivateVc */
1381 struct rcondis_mp_deactivate_vc_complete {
1387 /* union with all of the RNDIS messages */
1388 union rndis_message_container {
1389 struct rndis_packet pkt;
1390 struct rndis_initialize_request init_req;
1391 struct rndis_halt_request halt_req;
1392 struct rndis_query_request query_req;
1393 struct rndis_set_request set_req;
1394 struct rndis_reset_request reset_req;
1395 struct rndis_keepalive_request keep_alive_req;
1396 struct rndis_indicate_status indicate_status;
1397 struct rndis_initialize_complete init_complete;
1398 struct rndis_query_complete query_complete;
1399 struct rndis_set_complete set_complete;
1400 struct rndis_reset_complete reset_complete;
1401 struct rndis_keepalive_complete keep_alive_complete;
1402 struct rcondis_mp_create_vc co_miniport_create_vc;
1403 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1404 struct rcondis_indicate_status co_indicate_status;
1405 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1406 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1407 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1408 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1409 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1410 struct rcondis_mp_deactivate_vc_complete
1411 co_miniport_deactivate_vc_complete;
1414 /* Remote NDIS message format */
1415 struct rndis_message {
1418 /* Total length of this message, from the beginning */
1419 /* of the struct rndis_message, in bytes. */
1422 /* Actual message */
1423 union rndis_message_container msg;
1429 /* get the size of an RNDIS message. Pass in the message type, */
1430 /* struct rndis_set_request, struct rndis_packet for example */
1431 #define RNDIS_MESSAGE_SIZE(msg) \
1432 (sizeof(msg) + (sizeof(struct rndis_message) - \
1433 sizeof(union rndis_message_container)))
1435 /* get pointer to info buffer with message pointer */
1436 #define MESSAGE_TO_INFO_BUFFER(msg) \
1437 (((unsigned char *)(msg)) + msg->info_buf_offset)
1439 /* get pointer to status buffer with message pointer */
1440 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1441 (((unsigned char *)(msg)) + msg->status_buf_offset)
1443 /* get pointer to OOBD buffer with message pointer */
1444 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1445 (((unsigned char *)(msg)) + msg->oob_data_offset)
1447 /* get pointer to data buffer with message pointer */
1448 #define MESSAGE_TO_DATA_BUFFER(msg) \
1449 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1451 /* get pointer to contained message from NDIS_MESSAGE pointer */
1452 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1453 ((void *) &rndis_msg->msg)
1455 /* get pointer to contained message from NDIS_MESSAGE pointer */
1456 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1457 ((void *) rndis_msg)
1461 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1462 sizeof(union rndis_message_container))
1464 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1466 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1467 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1468 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1469 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1470 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1471 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1472 #define NDIS_PACKET_TYPE_SMT 0x00000040
1473 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1474 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1475 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1476 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1477 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1479 #define TRANSPORT_INFO_NOT_IP 0
1480 #define TRANSPORT_INFO_IPV4_TCP 0x01
1481 #define TRANSPORT_INFO_IPV4_UDP 0x02
1482 #define TRANSPORT_INFO_IPV6_TCP 0x10
1483 #define TRANSPORT_INFO_IPV6_UDP 0x20
1485 #endif /* _HYPERV_NET_H */