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];
182 u16 ind_table[ITAB_NUM];
187 struct rndis_message;
188 struct netvsc_device;
189 struct net_device_context;
191 struct netvsc_device *netvsc_device_add(struct hv_device *device,
192 const struct netvsc_device_info *info);
193 int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
194 void netvsc_device_remove(struct hv_device *device);
195 int netvsc_send(struct net_device_context *ndc,
196 struct hv_netvsc_packet *packet,
197 struct rndis_message *rndis_msg,
198 struct hv_page_buffer *page_buffer,
199 struct sk_buff *skb);
200 void netvsc_linkstatus_callback(struct hv_device *device_obj,
201 struct rndis_message *resp);
202 int netvsc_recv_callback(struct net_device *net,
203 struct vmbus_channel *channel,
205 const struct ndis_tcp_ip_checksum_info *csum_info,
206 const struct ndis_pkt_8021q_info *vlan);
207 void netvsc_channel_cb(void *context);
208 int netvsc_poll(struct napi_struct *napi, int budget);
210 void rndis_set_subchannel(struct work_struct *w);
211 bool rndis_filter_opened(const struct netvsc_device *nvdev);
212 int rndis_filter_open(struct netvsc_device *nvdev);
213 int rndis_filter_close(struct netvsc_device *nvdev);
214 struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
215 struct netvsc_device_info *info);
216 void rndis_filter_update(struct netvsc_device *nvdev);
217 void rndis_filter_device_remove(struct hv_device *dev,
218 struct netvsc_device *nvdev);
219 int rndis_filter_set_rss_param(struct rndis_device *rdev,
221 int rndis_filter_receive(struct net_device *ndev,
222 struct netvsc_device *net_dev,
223 struct hv_device *dev,
224 struct vmbus_channel *channel,
225 void *data, u32 buflen);
227 int rndis_filter_set_device_mac(struct netvsc_device *ndev,
230 void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
232 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
234 #define NVSP_PROTOCOL_VERSION_1 2
235 #define NVSP_PROTOCOL_VERSION_2 0x30002
236 #define NVSP_PROTOCOL_VERSION_4 0x40000
237 #define NVSP_PROTOCOL_VERSION_5 0x50000
240 NVSP_MSG_TYPE_NONE = 0,
243 NVSP_MSG_TYPE_INIT = 1,
244 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
246 NVSP_VERSION_MSG_START = 100,
248 /* Version 1 Messages */
249 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
251 NVSP_MSG1_TYPE_SEND_RECV_BUF,
252 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
253 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
255 NVSP_MSG1_TYPE_SEND_SEND_BUF,
256 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
257 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
259 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
260 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
262 /* Version 2 messages */
263 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
264 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
265 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
267 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
269 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
270 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
272 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
274 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
275 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
277 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
278 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
280 NVSP_MSG2_TYPE_ALLOC_RXBUF,
281 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
283 NVSP_MSG2_TYPE_FREE_RXBUF,
285 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
286 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
288 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
290 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
291 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
293 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
295 /* Version 4 messages */
296 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
297 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
298 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
300 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
302 /* Version 5 messages */
303 NVSP_MSG5_TYPE_OID_QUERY_EX,
304 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
305 NVSP_MSG5_TYPE_SUBCHANNEL,
306 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
308 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
315 NVSP_STAT_PROTOCOL_TOO_NEW,
316 NVSP_STAT_PROTOCOL_TOO_OLD,
317 NVSP_STAT_INVALID_RNDIS_PKT,
319 NVSP_STAT_PROTOCOL_UNSUPPORTED,
323 struct nvsp_message_header {
330 * This message is used by the VSC to initialize the channel after the channels
331 * has been opened. This message should never include anything other then
332 * versioning (i.e. this message will be the same for ever).
334 struct nvsp_message_init {
335 u32 min_protocol_ver;
336 u32 max_protocol_ver;
340 * This message is used by the VSP to complete the initialization of the
341 * channel. This message should never include anything other then versioning
342 * (i.e. this message will be the same for ever).
344 struct nvsp_message_init_complete {
345 u32 negotiated_protocol_ver;
346 u32 max_mdl_chain_len;
350 union nvsp_message_init_uber {
351 struct nvsp_message_init init;
352 struct nvsp_message_init_complete init_complete;
355 /* Version 1 Messages */
358 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
359 * can use this information when handling OIDs sent by the VSC.
361 struct nvsp_1_message_send_ndis_version {
367 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
368 * can then use the receive buffer to send data to the VSC.
370 struct nvsp_1_message_send_receive_buffer {
375 struct nvsp_1_receive_buffer_section {
383 * This message is used by the VSP to acknowledge a receive buffer send by the
384 * VSC. This message must be sent by the VSP before the VSP uses the receive
387 struct nvsp_1_message_send_receive_buffer_complete {
392 * The receive buffer is split into two parts, a large suballocation
393 * section and a small suballocation section. These sections are then
394 * suballocated by a certain size.
398 * For example, the following break up of the receive buffer has 6
399 * large suballocations and 10 small suballocations.
403 * | Large Section | | Small Section |
404 * ------------------------------------------------------------
405 * | | | | | | | | | | | | | | | | | |
407 * LargeOffset SmallOffset
410 struct nvsp_1_receive_buffer_section sections[1];
414 * This message is sent by the VSC to revoke the receive buffer. After the VSP
415 * completes this transaction, the vsp should never use the receive buffer
418 struct nvsp_1_message_revoke_receive_buffer {
423 * This message is used by the VSC to send a send buffer to the VSP. The VSC
424 * can then use the send buffer to send data to the VSP.
426 struct nvsp_1_message_send_send_buffer {
432 * This message is used by the VSP to acknowledge a send buffer sent by the
433 * VSC. This message must be sent by the VSP before the VSP uses the sent
436 struct nvsp_1_message_send_send_buffer_complete {
440 * The VSC gets to choose the size of the send buffer and the VSP gets
441 * to choose the sections size of the buffer. This was done to enable
442 * dynamic reconfigurations when the cost of GPA-direct buffers
449 * This message is sent by the VSC to revoke the send buffer. After the VSP
450 * completes this transaction, the vsp should never use the send buffer again.
452 struct nvsp_1_message_revoke_send_buffer {
457 * This message is used by both the VSP and the VSC to send a RNDIS message to
458 * the opposite channel endpoint.
460 struct nvsp_1_message_send_rndis_packet {
462 * This field is specified by RNDIS. They assume there's two different
463 * channels of communication. However, the Network VSP only has one.
464 * Therefore, the channel travels with the RNDIS packet.
469 * This field is used to send part or all of the data through a send
470 * buffer. This values specifies an index into the send buffer. If the
471 * index is 0xFFFFFFFF, then the send buffer is not being used and all
472 * of the data was sent through other VMBus mechanisms.
474 u32 send_buf_section_index;
475 u32 send_buf_section_size;
479 * This message is used by both the VSP and the VSC to complete a RNDIS message
480 * to the opposite channel endpoint. At this point, the initiator of this
481 * message cannot use any resources associated with the original RNDIS packet.
483 struct nvsp_1_message_send_rndis_packet_complete {
487 union nvsp_1_message_uber {
488 struct nvsp_1_message_send_ndis_version send_ndis_ver;
490 struct nvsp_1_message_send_receive_buffer send_recv_buf;
491 struct nvsp_1_message_send_receive_buffer_complete
492 send_recv_buf_complete;
493 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
495 struct nvsp_1_message_send_send_buffer send_send_buf;
496 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
497 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
499 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
500 struct nvsp_1_message_send_rndis_packet_complete
501 send_rndis_pkt_complete;
506 * Network VSP protocol version 2 messages:
508 struct nvsp_2_vsc_capability {
516 u64 correlation_id:1;
522 struct nvsp_2_send_ndis_config {
525 struct nvsp_2_vsc_capability capability;
528 /* Allocate receive buffer */
529 struct nvsp_2_alloc_rxbuf {
530 /* Allocation ID to match the allocation request and response */
533 /* Length of the VM shared memory receive buffer that needs to
539 /* Allocate receive buffer complete */
540 struct nvsp_2_alloc_rxbuf_comp {
541 /* The NDIS_STATUS code for buffer allocation */
546 /* GPADL handle for the allocated receive buffer */
549 /* Receive buffer ID */
553 struct nvsp_2_free_rxbuf {
557 union nvsp_2_message_uber {
558 struct nvsp_2_send_ndis_config send_ndis_config;
559 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
560 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
561 struct nvsp_2_free_rxbuf free_rxbuf;
564 struct nvsp_4_send_vf_association {
565 /* 1: allocated, serial number is valid. 0: not allocated */
568 /* Serial number of the VF to team with */
572 enum nvsp_vm_datapath {
573 NVSP_DATAPATH_SYNTHETIC = 0,
578 struct nvsp_4_sw_datapath {
579 u32 active_datapath; /* active data path in VM */
582 union nvsp_4_message_uber {
583 struct nvsp_4_send_vf_association vf_assoc;
584 struct nvsp_4_sw_datapath active_dp;
587 enum nvsp_subchannel_operation {
588 NVSP_SUBCHANNEL_NONE = 0,
589 NVSP_SUBCHANNEL_ALLOCATE,
593 struct nvsp_5_subchannel_request {
598 struct nvsp_5_subchannel_complete {
600 u32 num_subchannels; /* Actual number of subchannels allocated */
603 struct nvsp_5_send_indirect_table {
604 /* The number of entries in the send indirection table */
607 /* The offset of the send indirection table from top of this struct.
608 * The send indirection table tells which channel to put the send
609 * traffic on. Each entry is a channel number.
614 union nvsp_5_message_uber {
615 struct nvsp_5_subchannel_request subchn_req;
616 struct nvsp_5_subchannel_complete subchn_comp;
617 struct nvsp_5_send_indirect_table send_table;
620 union nvsp_all_messages {
621 union nvsp_message_init_uber init_msg;
622 union nvsp_1_message_uber v1_msg;
623 union nvsp_2_message_uber v2_msg;
624 union nvsp_4_message_uber v4_msg;
625 union nvsp_5_message_uber v5_msg;
629 struct nvsp_message {
630 struct nvsp_message_header hdr;
631 union nvsp_all_messages msg;
635 #define NETVSC_MTU 65535
636 #define NETVSC_MTU_MIN ETH_MIN_MTU
638 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
639 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
640 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
641 #define NETVSC_INVALID_INDEX -1
643 #define NETVSC_SEND_SECTION_SIZE 6144
644 #define NETVSC_RECV_SECTION_SIZE 1728
646 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
647 #define NETVSC_SEND_BUFFER_ID 0
649 #define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
650 #define VRSS_CHANNEL_MAX 64
651 #define VRSS_CHANNEL_DEFAULT 8
653 #define RNDIS_MAX_PKT_DEFAULT 8
654 #define RNDIS_PKT_ALIGN_DEFAULT 8
656 struct multi_send_data {
657 struct sk_buff *skb; /* skb containing the pkt */
658 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
659 u32 count; /* counter of batched packets */
662 struct recv_comp_data {
663 u64 tid; /* transaction id */
667 struct multi_recv_comp {
668 struct recv_comp_data *slots;
669 u32 first; /* first data entry */
670 u32 next; /* next entry for writing */
673 struct netvsc_stats {
678 struct u64_stats_sync syncp;
681 struct netvsc_ethtool_stats {
682 unsigned long tx_scattered;
683 unsigned long tx_no_memory;
684 unsigned long tx_no_space;
685 unsigned long tx_too_big;
686 unsigned long tx_busy;
687 unsigned long tx_send_full;
688 unsigned long rx_comp_busy;
691 struct netvsc_vf_pcpu_stats {
696 struct u64_stats_sync syncp;
700 struct netvsc_reconfig {
701 struct list_head list;
705 /* The context of the netvsc device */
706 struct net_device_context {
707 /* point back to our device context */
708 struct hv_device *device_ctx;
710 struct netvsc_device __rcu *nvdev;
711 /* reconfigure work */
712 struct delayed_work dwork;
713 /* last reconfig time */
714 unsigned long last_reconfig;
715 /* reconfig events */
716 struct list_head reconfig_events;
717 /* list protection */
720 u32 msg_enable; /* debug level */
722 u32 tx_checksum_mask;
724 u32 tx_send_table[VRSS_SEND_TAB_SIZE];
726 /* Ethtool settings */
731 struct netvsc_ethtool_stats eth_stats;
733 /* State to manage the associated VF interface. */
734 struct net_device __rcu *vf_netdev;
735 struct netvsc_vf_pcpu_stats __percpu *vf_stats;
736 struct delayed_work vf_takeover;
738 /* 1: allocated, serial number is valid. 0: not allocated */
740 /* Serial number of the VF to team with */
744 /* Per channel data */
745 struct netvsc_channel {
746 struct vmbus_channel *channel;
747 struct netvsc_device *net_device;
748 const struct vmpacket_descriptor *desc;
749 struct napi_struct napi;
750 struct multi_send_data msd;
751 struct multi_recv_comp mrc;
752 atomic_t queue_sends;
754 struct netvsc_stats tx_stats;
755 struct netvsc_stats rx_stats;
758 /* Per netvsc device */
759 struct netvsc_device {
762 wait_queue_head_t wait_drain;
765 /* Receive buffer allocated by us but manages by NetVSP */
767 u32 recv_buf_gpadl_handle;
768 u32 recv_section_cnt;
769 u32 recv_section_size;
770 u32 recv_completion_cnt;
772 /* Send buffer allocated by us */
774 u32 send_buf_gpadl_handle;
775 u32 send_section_cnt;
776 u32 send_section_size;
777 unsigned long *send_section_map;
779 /* Used for NetVSP initialization protocol */
780 struct completion channel_init_wait;
781 struct nvsp_message channel_init_pkt;
783 struct nvsp_message revoke_packet;
789 struct work_struct subchan_work;
790 wait_queue_head_t subchan_open;
792 struct rndis_device *extension;
796 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
797 u32 pkt_align; /* alignment bytes, e.g. 8 */
801 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
806 /* NdisInitialize message */
807 struct rndis_initialize_request {
814 /* Response to NdisInitialize */
815 struct rndis_initialize_complete {
824 u32 pkt_alignment_factor;
829 /* Call manager devices only: Information about an address family */
830 /* supported by the device is appended to the response to NdisInitialize. */
831 struct rndis_co_address_family {
837 /* NdisHalt message */
838 struct rndis_halt_request {
842 /* NdisQueryRequest message */
843 struct rndis_query_request {
851 /* Response to NdisQueryRequest */
852 struct rndis_query_complete {
859 /* NdisSetRequest message */
860 struct rndis_set_request {
868 /* Response to NdisSetRequest */
869 struct rndis_set_complete {
874 /* NdisReset message */
875 struct rndis_reset_request {
879 /* Response to NdisReset */
880 struct rndis_reset_complete {
882 u32 addressing_reset;
885 /* NdisMIndicateStatus message */
886 struct rndis_indicate_status {
889 u32 status_buf_offset;
892 /* Diagnostic information passed as the status buffer in */
893 /* struct rndis_indicate_status messages signifying error conditions. */
894 struct rndis_diagnostic_info {
899 /* NdisKeepAlive message */
900 struct rndis_keepalive_request {
904 /* Response to NdisKeepAlive */
905 struct rndis_keepalive_complete {
911 * Data message. All Offset fields contain byte offsets from the beginning of
912 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
913 * to 0 for connectionless data, otherwise it contains the VC handle.
915 struct rndis_packet {
920 u32 num_oob_data_elements;
921 u32 per_pkt_info_offset;
922 u32 per_pkt_info_len;
927 /* Optional Out of Band data associated with a Data message. */
931 u32 class_info_offset;
934 /* Packet extension field contents associated with a Data message. */
935 struct rndis_per_packet_info {
941 enum ndis_per_pkt_info_type {
942 TCPIP_CHKSUM_PKTINFO,
944 TCP_LARGESEND_PKTINFO,
945 CLASSIFICATION_HANDLE_PKTINFO,
951 NBL_HASH_VALUE = PACKET_CANCEL_ID,
952 ORIGINAL_NET_BUFLIST,
958 struct ndis_pkt_8021q_info {
961 u32 pri:3; /* User Priority */
962 u32 cfi:1; /* Canonical Format ID */
963 u32 vlanid:12; /* VLAN ID */
970 struct ndis_object_header {
976 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
977 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
978 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
979 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
981 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
982 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
983 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
984 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
985 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
986 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
987 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
988 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
989 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
990 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
992 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
993 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
994 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
996 #define VERSION_4_OFFLOAD_SIZE 22
998 * New offload OIDs for NDIS 6
1000 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1001 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1002 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1003 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1004 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1005 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1008 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1009 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1012 #define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1013 #define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1014 #define NDIS_OFFLOAD_ENCAP_8023 0x0002
1015 #define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1016 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1017 #define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1019 struct ndis_csum_offload {
1022 #define NDIS_TXCSUM_CAP_IP4OPT 0x001
1023 #define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1024 #define NDIS_TXCSUM_CAP_TCP4 0x010
1025 #define NDIS_TXCSUM_CAP_UDP4 0x040
1026 #define NDIS_TXCSUM_CAP_IP4 0x100
1028 #define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1032 #define NDIS_RXCSUM_CAP_IP4OPT 0x001
1033 #define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1034 #define NDIS_RXCSUM_CAP_TCP4 0x010
1035 #define NDIS_RXCSUM_CAP_UDP4 0x040
1036 #define NDIS_RXCSUM_CAP_IP4 0x100
1039 #define NDIS_TXCSUM_CAP_IP6EXT 0x001
1040 #define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1041 #define NDIS_TXCSUM_CAP_TCP6 0x010
1042 #define NDIS_TXCSUM_CAP_UDP6 0x040
1045 #define NDIS_RXCSUM_CAP_IP6EXT 0x001
1046 #define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1047 #define NDIS_RXCSUM_CAP_TCP6 0x010
1048 #define NDIS_RXCSUM_CAP_UDP6 0x040
1050 #define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1051 NDIS_TXCSUM_CAP_TCP6OPT | \
1052 NDIS_TXCSUM_CAP_IP6EXT)
1055 struct ndis_lsov1_offload {
1062 struct ndis_ipsecv1_offload {
1072 struct ndis_lsov2_offload {
1080 #define NDIS_LSOV2_CAP_IP6EXT 0x001
1081 #define NDIS_LSOV2_CAP_TCP6OPT 0x004
1083 #define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1084 NDIS_LSOV2_CAP_TCP6OPT)
1087 struct ndis_ipsecv2_offload {
1106 struct ndis_rsc_offload {
1111 struct ndis_encap_offload {
1116 struct ndis_offload {
1117 struct ndis_object_header header;
1118 struct ndis_csum_offload csum;
1119 struct ndis_lsov1_offload lsov1;
1120 struct ndis_ipsecv1_offload ipsecv1;
1121 struct ndis_lsov2_offload lsov2;
1124 struct ndis_ipsecv2_offload ipsecv2;
1126 struct ndis_rsc_offload rsc;
1127 struct ndis_encap_offload encap_gre;
1130 #define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1131 #define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1132 #define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1134 struct ndis_offload_params {
1135 struct ndis_object_header header;
1145 u8 tcp_connection_ip_v4;
1146 u8 tcp_connection_ip_v6;
1155 u8 encapsulated_packet_task_offload;
1156 u8 encapsulation_types;
1160 struct ndis_tcp_ip_checksum_info {
1167 u32 ip_header_checksum:1;
1169 u32 tcp_header_offset:10;
1172 u32 tcp_checksum_failed:1;
1173 u32 udp_checksum_failed:1;
1174 u32 ip_checksum_failed:1;
1175 u32 tcp_checksum_succeeded:1;
1176 u32 udp_checksum_succeeded:1;
1177 u32 ip_checksum_succeeded:1;
1179 u32 tcp_checksum_value_invalid:1;
1180 u32 ip_checksum_value_invalid:1;
1186 struct ndis_tcp_lso_info {
1195 u32 tcp_header_offset:10;
1203 } lso_v1_transmit_complete;
1206 u32 tcp_header_offset:10;
1214 } lso_v2_transmit_complete;
1219 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1220 sizeof(struct ndis_pkt_8021q_info))
1222 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1223 sizeof(struct ndis_tcp_ip_checksum_info))
1225 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1226 sizeof(struct ndis_tcp_lso_info))
1228 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1231 /* Total size of all PPI data */
1232 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1233 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1235 /* Format of Information buffer passed in a SetRequest for the OID */
1236 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1237 struct rndis_config_parameter_info {
1238 u32 parameter_name_offset;
1239 u32 parameter_name_length;
1241 u32 parameter_value_offset;
1242 u32 parameter_value_length;
1245 /* Values for ParameterType in struct rndis_config_parameter_info */
1246 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1247 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1249 /* CONDIS Miniport messages for connection oriented devices */
1250 /* that do not implement a call manager. */
1252 /* CoNdisMiniportCreateVc message */
1253 struct rcondis_mp_create_vc {
1258 /* Response to CoNdisMiniportCreateVc */
1259 struct rcondis_mp_create_vc_complete {
1265 /* CoNdisMiniportDeleteVc message */
1266 struct rcondis_mp_delete_vc {
1271 /* Response to CoNdisMiniportDeleteVc */
1272 struct rcondis_mp_delete_vc_complete {
1277 /* CoNdisMiniportQueryRequest message */
1278 struct rcondis_mp_query_request {
1284 u32 info_buf_offset;
1287 /* CoNdisMiniportSetRequest message */
1288 struct rcondis_mp_set_request {
1294 u32 info_buf_offset;
1297 /* CoNdisIndicateStatus message */
1298 struct rcondis_indicate_status {
1302 u32 status_buf_offset;
1305 /* CONDIS Call/VC parameters */
1306 struct rcondis_specific_parameters {
1308 u32 parameter_length;
1309 u32 parameter_lffset;
1312 struct rcondis_media_parameters {
1316 struct rcondis_specific_parameters media_specific;
1319 struct rndis_flowspec {
1321 u32 token_bucket_size;
1324 u32 delay_variation;
1327 u32 minimum_policed_size;
1330 struct rcondis_call_manager_parameters {
1331 struct rndis_flowspec transmit;
1332 struct rndis_flowspec receive;
1333 struct rcondis_specific_parameters call_mgr_specific;
1336 /* CoNdisMiniportActivateVc message */
1337 struct rcondis_mp_activate_vc_request {
1341 u32 media_params_offset;
1342 u32 media_params_length;
1343 u32 call_mgr_params_offset;
1344 u32 call_mgr_params_length;
1347 /* Response to CoNdisMiniportActivateVc */
1348 struct rcondis_mp_activate_vc_complete {
1353 /* CoNdisMiniportDeactivateVc message */
1354 struct rcondis_mp_deactivate_vc_request {
1360 /* Response to CoNdisMiniportDeactivateVc */
1361 struct rcondis_mp_deactivate_vc_complete {
1367 /* union with all of the RNDIS messages */
1368 union rndis_message_container {
1369 struct rndis_packet pkt;
1370 struct rndis_initialize_request init_req;
1371 struct rndis_halt_request halt_req;
1372 struct rndis_query_request query_req;
1373 struct rndis_set_request set_req;
1374 struct rndis_reset_request reset_req;
1375 struct rndis_keepalive_request keep_alive_req;
1376 struct rndis_indicate_status indicate_status;
1377 struct rndis_initialize_complete init_complete;
1378 struct rndis_query_complete query_complete;
1379 struct rndis_set_complete set_complete;
1380 struct rndis_reset_complete reset_complete;
1381 struct rndis_keepalive_complete keep_alive_complete;
1382 struct rcondis_mp_create_vc co_miniport_create_vc;
1383 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1384 struct rcondis_indicate_status co_indicate_status;
1385 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1386 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1387 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1388 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1389 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1390 struct rcondis_mp_deactivate_vc_complete
1391 co_miniport_deactivate_vc_complete;
1394 /* Remote NDIS message format */
1395 struct rndis_message {
1398 /* Total length of this message, from the beginning */
1399 /* of the struct rndis_message, in bytes. */
1402 /* Actual message */
1403 union rndis_message_container msg;
1409 /* get the size of an RNDIS message. Pass in the message type, */
1410 /* struct rndis_set_request, struct rndis_packet for example */
1411 #define RNDIS_MESSAGE_SIZE(msg) \
1412 (sizeof(msg) + (sizeof(struct rndis_message) - \
1413 sizeof(union rndis_message_container)))
1415 /* get pointer to info buffer with message pointer */
1416 #define MESSAGE_TO_INFO_BUFFER(msg) \
1417 (((unsigned char *)(msg)) + msg->info_buf_offset)
1419 /* get pointer to status buffer with message pointer */
1420 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1421 (((unsigned char *)(msg)) + msg->status_buf_offset)
1423 /* get pointer to OOBD buffer with message pointer */
1424 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1425 (((unsigned char *)(msg)) + msg->oob_data_offset)
1427 /* get pointer to data buffer with message pointer */
1428 #define MESSAGE_TO_DATA_BUFFER(msg) \
1429 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1431 /* get pointer to contained message from NDIS_MESSAGE pointer */
1432 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1433 ((void *) &rndis_msg->msg)
1435 /* get pointer to contained message from NDIS_MESSAGE pointer */
1436 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1437 ((void *) rndis_msg)
1441 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1442 sizeof(union rndis_message_container))
1444 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1446 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1447 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1448 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1449 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1450 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1451 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1452 #define NDIS_PACKET_TYPE_SMT 0x00000040
1453 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1454 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1455 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1456 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1457 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1459 #define TRANSPORT_INFO_NOT_IP 0
1460 #define TRANSPORT_INFO_IPV4_TCP 0x01
1461 #define TRANSPORT_INFO_IPV4_UDP 0x02
1462 #define TRANSPORT_INFO_IPV6_TCP 0x10
1463 #define TRANSPORT_INFO_IPV6_UDP 0x20
1465 #endif /* _HYPERV_NET_H */