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/>.
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];
150 u32 max_num_vrss_chns;
154 enum rndis_device_state {
155 RNDIS_DEV_UNINITIALIZED = 0,
156 RNDIS_DEV_INITIALIZING,
157 RNDIS_DEV_INITIALIZED,
158 RNDIS_DEV_DATAINITIALIZED,
161 #define NETVSC_HASH_KEYLEN 40
163 struct rndis_device {
164 struct net_device *ndev;
166 enum rndis_device_state state;
170 spinlock_t request_lock;
171 struct list_head req_list;
173 struct work_struct mcast_work;
175 bool link_state; /* 0 - link up, 1 - link down */
177 u8 hw_mac_adr[ETH_ALEN];
178 u8 rss_key[NETVSC_HASH_KEYLEN];
179 u16 ind_table[ITAB_NUM];
184 struct rndis_message;
185 struct netvsc_device;
186 int netvsc_device_add(struct hv_device *device,
187 const struct netvsc_device_info *info);
188 void netvsc_device_remove(struct hv_device *device);
189 int netvsc_send(struct hv_device *device,
190 struct hv_netvsc_packet *packet,
191 struct rndis_message *rndis_msg,
192 struct hv_page_buffer **page_buffer,
193 struct sk_buff *skb);
194 void netvsc_linkstatus_callback(struct hv_device *device_obj,
195 struct rndis_message *resp);
196 int netvsc_recv_callback(struct net_device *net,
197 struct vmbus_channel *channel,
199 const struct ndis_tcp_ip_checksum_info *csum_info,
200 const struct ndis_pkt_8021q_info *vlan);
201 void netvsc_channel_cb(void *context);
202 int netvsc_poll(struct napi_struct *napi, int budget);
203 int rndis_filter_open(struct netvsc_device *nvdev);
204 int rndis_filter_close(struct netvsc_device *nvdev);
205 int rndis_filter_device_add(struct hv_device *dev,
206 struct netvsc_device_info *info);
207 void rndis_filter_update(struct netvsc_device *nvdev);
208 void rndis_filter_device_remove(struct hv_device *dev,
209 struct netvsc_device *nvdev);
210 int rndis_filter_set_rss_param(struct rndis_device *rdev,
211 const u8 *key, int num_queue);
212 int rndis_filter_receive(struct net_device *ndev,
213 struct netvsc_device *net_dev,
214 struct hv_device *dev,
215 struct vmbus_channel *channel,
216 void *data, u32 buflen);
218 int rndis_filter_set_device_mac(struct net_device *ndev, char *mac);
220 void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
222 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
224 #define NVSP_PROTOCOL_VERSION_1 2
225 #define NVSP_PROTOCOL_VERSION_2 0x30002
226 #define NVSP_PROTOCOL_VERSION_4 0x40000
227 #define NVSP_PROTOCOL_VERSION_5 0x50000
230 NVSP_MSG_TYPE_NONE = 0,
233 NVSP_MSG_TYPE_INIT = 1,
234 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
236 NVSP_VERSION_MSG_START = 100,
238 /* Version 1 Messages */
239 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
241 NVSP_MSG1_TYPE_SEND_RECV_BUF,
242 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
243 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
245 NVSP_MSG1_TYPE_SEND_SEND_BUF,
246 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
247 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
249 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
250 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
252 /* Version 2 messages */
253 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
254 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
255 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
257 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
259 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
260 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
262 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
264 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
265 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
267 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
268 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
270 NVSP_MSG2_TYPE_ALLOC_RXBUF,
271 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
273 NVSP_MSG2_TYPE_FREE_RXBUF,
275 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
276 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
278 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
280 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
281 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
283 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
285 /* Version 4 messages */
286 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
287 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
288 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
290 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
292 /* Version 5 messages */
293 NVSP_MSG5_TYPE_OID_QUERY_EX,
294 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
295 NVSP_MSG5_TYPE_SUBCHANNEL,
296 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
298 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
305 NVSP_STAT_PROTOCOL_TOO_NEW,
306 NVSP_STAT_PROTOCOL_TOO_OLD,
307 NVSP_STAT_INVALID_RNDIS_PKT,
309 NVSP_STAT_PROTOCOL_UNSUPPORTED,
313 struct nvsp_message_header {
320 * This message is used by the VSC to initialize the channel after the channels
321 * has been opened. This message should never include anything other then
322 * versioning (i.e. this message will be the same for ever).
324 struct nvsp_message_init {
325 u32 min_protocol_ver;
326 u32 max_protocol_ver;
330 * This message is used by the VSP to complete the initialization of the
331 * channel. This message should never include anything other then versioning
332 * (i.e. this message will be the same for ever).
334 struct nvsp_message_init_complete {
335 u32 negotiated_protocol_ver;
336 u32 max_mdl_chain_len;
340 union nvsp_message_init_uber {
341 struct nvsp_message_init init;
342 struct nvsp_message_init_complete init_complete;
345 /* Version 1 Messages */
348 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
349 * can use this information when handling OIDs sent by the VSC.
351 struct nvsp_1_message_send_ndis_version {
357 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
358 * can then use the receive buffer to send data to the VSC.
360 struct nvsp_1_message_send_receive_buffer {
365 struct nvsp_1_receive_buffer_section {
373 * This message is used by the VSP to acknowledge a receive buffer send by the
374 * VSC. This message must be sent by the VSP before the VSP uses the receive
377 struct nvsp_1_message_send_receive_buffer_complete {
382 * The receive buffer is split into two parts, a large suballocation
383 * section and a small suballocation section. These sections are then
384 * suballocated by a certain size.
388 * For example, the following break up of the receive buffer has 6
389 * large suballocations and 10 small suballocations.
393 * | Large Section | | Small Section |
394 * ------------------------------------------------------------
395 * | | | | | | | | | | | | | | | | | |
397 * LargeOffset SmallOffset
400 struct nvsp_1_receive_buffer_section sections[1];
404 * This message is sent by the VSC to revoke the receive buffer. After the VSP
405 * completes this transaction, the vsp should never use the receive buffer
408 struct nvsp_1_message_revoke_receive_buffer {
413 * This message is used by the VSC to send a send buffer to the VSP. The VSC
414 * can then use the send buffer to send data to the VSP.
416 struct nvsp_1_message_send_send_buffer {
422 * This message is used by the VSP to acknowledge a send buffer sent by the
423 * VSC. This message must be sent by the VSP before the VSP uses the sent
426 struct nvsp_1_message_send_send_buffer_complete {
430 * The VSC gets to choose the size of the send buffer and the VSP gets
431 * to choose the sections size of the buffer. This was done to enable
432 * dynamic reconfigurations when the cost of GPA-direct buffers
439 * This message is sent by the VSC to revoke the send buffer. After the VSP
440 * completes this transaction, the vsp should never use the send buffer again.
442 struct nvsp_1_message_revoke_send_buffer {
447 * This message is used by both the VSP and the VSC to send a RNDIS message to
448 * the opposite channel endpoint.
450 struct nvsp_1_message_send_rndis_packet {
452 * This field is specified by RNDIS. They assume there's two different
453 * channels of communication. However, the Network VSP only has one.
454 * Therefore, the channel travels with the RNDIS packet.
459 * This field is used to send part or all of the data through a send
460 * buffer. This values specifies an index into the send buffer. If the
461 * index is 0xFFFFFFFF, then the send buffer is not being used and all
462 * of the data was sent through other VMBus mechanisms.
464 u32 send_buf_section_index;
465 u32 send_buf_section_size;
469 * This message is used by both the VSP and the VSC to complete a RNDIS message
470 * to the opposite channel endpoint. At this point, the initiator of this
471 * message cannot use any resources associated with the original RNDIS packet.
473 struct nvsp_1_message_send_rndis_packet_complete {
477 union nvsp_1_message_uber {
478 struct nvsp_1_message_send_ndis_version send_ndis_ver;
480 struct nvsp_1_message_send_receive_buffer send_recv_buf;
481 struct nvsp_1_message_send_receive_buffer_complete
482 send_recv_buf_complete;
483 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
485 struct nvsp_1_message_send_send_buffer send_send_buf;
486 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
487 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
489 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
490 struct nvsp_1_message_send_rndis_packet_complete
491 send_rndis_pkt_complete;
496 * Network VSP protocol version 2 messages:
498 struct nvsp_2_vsc_capability {
506 u64 correlation_id:1;
512 struct nvsp_2_send_ndis_config {
515 struct nvsp_2_vsc_capability capability;
518 /* Allocate receive buffer */
519 struct nvsp_2_alloc_rxbuf {
520 /* Allocation ID to match the allocation request and response */
523 /* Length of the VM shared memory receive buffer that needs to
529 /* Allocate receive buffer complete */
530 struct nvsp_2_alloc_rxbuf_comp {
531 /* The NDIS_STATUS code for buffer allocation */
536 /* GPADL handle for the allocated receive buffer */
539 /* Receive buffer ID */
543 struct nvsp_2_free_rxbuf {
547 union nvsp_2_message_uber {
548 struct nvsp_2_send_ndis_config send_ndis_config;
549 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
550 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
551 struct nvsp_2_free_rxbuf free_rxbuf;
554 struct nvsp_4_send_vf_association {
555 /* 1: allocated, serial number is valid. 0: not allocated */
558 /* Serial number of the VF to team with */
562 enum nvsp_vm_datapath {
563 NVSP_DATAPATH_SYNTHETIC = 0,
568 struct nvsp_4_sw_datapath {
569 u32 active_datapath; /* active data path in VM */
572 union nvsp_4_message_uber {
573 struct nvsp_4_send_vf_association vf_assoc;
574 struct nvsp_4_sw_datapath active_dp;
577 enum nvsp_subchannel_operation {
578 NVSP_SUBCHANNEL_NONE = 0,
579 NVSP_SUBCHANNEL_ALLOCATE,
583 struct nvsp_5_subchannel_request {
588 struct nvsp_5_subchannel_complete {
590 u32 num_subchannels; /* Actual number of subchannels allocated */
593 struct nvsp_5_send_indirect_table {
594 /* The number of entries in the send indirection table */
597 /* The offset of the send indirection table from top of this struct.
598 * The send indirection table tells which channel to put the send
599 * traffic on. Each entry is a channel number.
604 union nvsp_5_message_uber {
605 struct nvsp_5_subchannel_request subchn_req;
606 struct nvsp_5_subchannel_complete subchn_comp;
607 struct nvsp_5_send_indirect_table send_table;
610 union nvsp_all_messages {
611 union nvsp_message_init_uber init_msg;
612 union nvsp_1_message_uber v1_msg;
613 union nvsp_2_message_uber v2_msg;
614 union nvsp_4_message_uber v4_msg;
615 union nvsp_5_message_uber v5_msg;
619 struct nvsp_message {
620 struct nvsp_message_header hdr;
621 union nvsp_all_messages msg;
625 #define NETVSC_MTU 65535
626 #define NETVSC_MTU_MIN ETH_MIN_MTU
628 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
629 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
630 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
631 #define NETVSC_INVALID_INDEX -1
634 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
635 #define NETVSC_SEND_BUFFER_ID 0
637 #define NETVSC_PACKET_SIZE 4096
639 #define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
640 #define VRSS_CHANNEL_MAX 64
641 #define VRSS_CHANNEL_DEFAULT 8
643 #define RNDIS_MAX_PKT_DEFAULT 8
644 #define RNDIS_PKT_ALIGN_DEFAULT 8
646 struct multi_send_data {
647 struct sk_buff *skb; /* skb containing the pkt */
648 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
649 u32 count; /* counter of batched packets */
652 struct recv_comp_data {
653 u64 tid; /* transaction id */
657 /* Netvsc Receive Slots Max */
658 #define NETVSC_RECVSLOT_MAX (NETVSC_RECEIVE_BUFFER_SIZE / ETH_DATA_LEN + 1)
660 struct multi_recv_comp {
661 void *buf; /* queued receive completions */
662 u32 first; /* first data entry */
663 u32 next; /* next entry for writing */
666 struct netvsc_stats {
671 struct u64_stats_sync syncp;
674 struct netvsc_ethtool_stats {
675 unsigned long tx_scattered;
676 unsigned long tx_no_memory;
677 unsigned long tx_no_space;
678 unsigned long tx_too_big;
679 unsigned long tx_busy;
682 struct netvsc_reconfig {
683 struct list_head list;
687 /* The context of the netvsc device */
688 struct net_device_context {
689 /* point back to our device context */
690 struct hv_device *device_ctx;
692 struct netvsc_device __rcu *nvdev;
693 /* reconfigure work */
694 struct delayed_work dwork;
695 /* last reconfig time */
696 unsigned long last_reconfig;
697 /* reconfig events */
698 struct list_head reconfig_events;
699 /* list protection */
702 u32 msg_enable; /* debug level */
704 u32 tx_checksum_mask;
706 u32 tx_send_table[VRSS_SEND_TAB_SIZE];
708 /* Ethtool settings */
711 struct netvsc_ethtool_stats eth_stats;
713 /* State to manage the associated VF interface. */
714 struct net_device __rcu *vf_netdev;
716 /* 1: allocated, serial number is valid. 0: not allocated */
718 /* Serial number of the VF to team with */
721 bool datapath; /* 0 - synthetic, 1 - VF nic */
724 /* Per channel data */
725 struct netvsc_channel {
726 struct vmbus_channel *channel;
727 const struct vmpacket_descriptor *desc;
728 struct napi_struct napi;
729 struct multi_send_data msd;
730 struct multi_recv_comp mrc;
731 atomic_t queue_sends;
733 struct netvsc_stats tx_stats;
734 struct netvsc_stats rx_stats;
737 /* Per netvsc device */
738 struct netvsc_device {
741 wait_queue_head_t wait_drain;
744 /* Receive buffer allocated by us but manages by NetVSP */
747 u32 recv_buf_gpadl_handle;
748 u32 recv_section_cnt;
749 struct nvsp_1_receive_buffer_section *recv_section;
751 /* Send buffer allocated by us */
754 u32 send_buf_gpadl_handle;
755 u32 send_section_cnt;
756 u32 send_section_size;
757 unsigned long *send_section_map;
759 /* Used for NetVSP initialization protocol */
760 struct completion channel_init_wait;
761 struct nvsp_message channel_init_pkt;
763 struct nvsp_message revoke_packet;
768 refcount_t sc_offered;
770 struct rndis_device *extension;
774 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
775 u32 pkt_align; /* alignment bytes, e.g. 8 */
777 atomic_t num_outstanding_recvs;
781 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
786 static inline struct netvsc_device *
787 net_device_to_netvsc_device(struct net_device *ndev)
789 return ((struct net_device_context *)netdev_priv(ndev))->nvdev;
792 static inline struct netvsc_device *
793 hv_device_to_netvsc_device(struct hv_device *device)
795 return net_device_to_netvsc_device(hv_get_drvdata(device));
798 /* NdisInitialize message */
799 struct rndis_initialize_request {
806 /* Response to NdisInitialize */
807 struct rndis_initialize_complete {
816 u32 pkt_alignment_factor;
821 /* Call manager devices only: Information about an address family */
822 /* supported by the device is appended to the response to NdisInitialize. */
823 struct rndis_co_address_family {
829 /* NdisHalt message */
830 struct rndis_halt_request {
834 /* NdisQueryRequest message */
835 struct rndis_query_request {
843 /* Response to NdisQueryRequest */
844 struct rndis_query_complete {
851 /* NdisSetRequest message */
852 struct rndis_set_request {
860 /* Response to NdisSetRequest */
861 struct rndis_set_complete {
866 /* NdisReset message */
867 struct rndis_reset_request {
871 /* Response to NdisReset */
872 struct rndis_reset_complete {
874 u32 addressing_reset;
877 /* NdisMIndicateStatus message */
878 struct rndis_indicate_status {
881 u32 status_buf_offset;
884 /* Diagnostic information passed as the status buffer in */
885 /* struct rndis_indicate_status messages signifying error conditions. */
886 struct rndis_diagnostic_info {
891 /* NdisKeepAlive message */
892 struct rndis_keepalive_request {
896 /* Response to NdisKeepAlive */
897 struct rndis_keepalive_complete {
903 * Data message. All Offset fields contain byte offsets from the beginning of
904 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
905 * to 0 for connectionless data, otherwise it contains the VC handle.
907 struct rndis_packet {
912 u32 num_oob_data_elements;
913 u32 per_pkt_info_offset;
914 u32 per_pkt_info_len;
919 /* Optional Out of Band data associated with a Data message. */
923 u32 class_info_offset;
926 /* Packet extension field contents associated with a Data message. */
927 struct rndis_per_packet_info {
933 enum ndis_per_pkt_info_type {
934 TCPIP_CHKSUM_PKTINFO,
936 TCP_LARGESEND_PKTINFO,
937 CLASSIFICATION_HANDLE_PKTINFO,
943 NBL_HASH_VALUE = PACKET_CANCEL_ID,
944 ORIGINAL_NET_BUFLIST,
950 struct ndis_pkt_8021q_info {
953 u32 pri:3; /* User Priority */
954 u32 cfi:1; /* Canonical Format ID */
955 u32 vlanid:12; /* VLAN ID */
962 struct ndis_object_header {
968 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
969 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
970 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
971 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
973 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
974 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
975 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
976 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
977 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
978 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
979 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
980 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
981 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
982 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
984 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
985 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
986 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
988 #define VERSION_4_OFFLOAD_SIZE 22
990 * New offload OIDs for NDIS 6
992 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
993 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
994 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
995 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
996 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
997 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1000 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1001 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1004 #define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1005 #define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1006 #define NDIS_OFFLOAD_ENCAP_8023 0x0002
1007 #define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1008 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1009 #define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1011 struct ndis_csum_offload {
1014 #define NDIS_TXCSUM_CAP_IP4OPT 0x001
1015 #define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1016 #define NDIS_TXCSUM_CAP_TCP4 0x010
1017 #define NDIS_TXCSUM_CAP_UDP4 0x040
1018 #define NDIS_TXCSUM_CAP_IP4 0x100
1020 #define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1024 #define NDIS_RXCSUM_CAP_IP4OPT 0x001
1025 #define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1026 #define NDIS_RXCSUM_CAP_TCP4 0x010
1027 #define NDIS_RXCSUM_CAP_UDP4 0x040
1028 #define NDIS_RXCSUM_CAP_IP4 0x100
1031 #define NDIS_TXCSUM_CAP_IP6EXT 0x001
1032 #define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1033 #define NDIS_TXCSUM_CAP_TCP6 0x010
1034 #define NDIS_TXCSUM_CAP_UDP6 0x040
1037 #define NDIS_RXCSUM_CAP_IP6EXT 0x001
1038 #define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1039 #define NDIS_RXCSUM_CAP_TCP6 0x010
1040 #define NDIS_RXCSUM_CAP_UDP6 0x040
1042 #define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1043 NDIS_TXCSUM_CAP_TCP6OPT | \
1044 NDIS_TXCSUM_CAP_IP6EXT)
1047 struct ndis_lsov1_offload {
1054 struct ndis_ipsecv1_offload {
1064 struct ndis_lsov2_offload {
1072 #define NDIS_LSOV2_CAP_IP6EXT 0x001
1073 #define NDIS_LSOV2_CAP_TCP6OPT 0x004
1075 #define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1076 NDIS_LSOV2_CAP_TCP6OPT)
1079 struct ndis_ipsecv2_offload {
1098 struct ndis_rsc_offload {
1103 struct ndis_encap_offload {
1108 struct ndis_offload {
1109 struct ndis_object_header header;
1110 struct ndis_csum_offload csum;
1111 struct ndis_lsov1_offload lsov1;
1112 struct ndis_ipsecv1_offload ipsecv1;
1113 struct ndis_lsov2_offload lsov2;
1116 struct ndis_ipsecv2_offload ipsecv2;
1118 struct ndis_rsc_offload rsc;
1119 struct ndis_encap_offload encap_gre;
1122 #define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1123 #define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1124 #define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1126 struct ndis_offload_params {
1127 struct ndis_object_header header;
1137 u8 tcp_connection_ip_v4;
1138 u8 tcp_connection_ip_v6;
1147 u8 encapsulated_packet_task_offload;
1148 u8 encapsulation_types;
1152 struct ndis_tcp_ip_checksum_info {
1159 u32 ip_header_checksum:1;
1161 u32 tcp_header_offset:10;
1164 u32 tcp_checksum_failed:1;
1165 u32 udp_checksum_failed:1;
1166 u32 ip_checksum_failed:1;
1167 u32 tcp_checksum_succeeded:1;
1168 u32 udp_checksum_succeeded:1;
1169 u32 ip_checksum_succeeded:1;
1171 u32 tcp_checksum_value_invalid:1;
1172 u32 ip_checksum_value_invalid:1;
1178 struct ndis_tcp_lso_info {
1187 u32 tcp_header_offset:10;
1195 } lso_v1_transmit_complete;
1198 u32 tcp_header_offset:10;
1206 } lso_v2_transmit_complete;
1211 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1212 sizeof(struct ndis_pkt_8021q_info))
1214 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1215 sizeof(struct ndis_tcp_ip_checksum_info))
1217 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1218 sizeof(struct ndis_tcp_lso_info))
1220 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1223 /* Total size of all PPI data */
1224 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1225 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1227 /* Format of Information buffer passed in a SetRequest for the OID */
1228 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1229 struct rndis_config_parameter_info {
1230 u32 parameter_name_offset;
1231 u32 parameter_name_length;
1233 u32 parameter_value_offset;
1234 u32 parameter_value_length;
1237 /* Values for ParameterType in struct rndis_config_parameter_info */
1238 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1239 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1241 /* CONDIS Miniport messages for connection oriented devices */
1242 /* that do not implement a call manager. */
1244 /* CoNdisMiniportCreateVc message */
1245 struct rcondis_mp_create_vc {
1250 /* Response to CoNdisMiniportCreateVc */
1251 struct rcondis_mp_create_vc_complete {
1257 /* CoNdisMiniportDeleteVc message */
1258 struct rcondis_mp_delete_vc {
1263 /* Response to CoNdisMiniportDeleteVc */
1264 struct rcondis_mp_delete_vc_complete {
1269 /* CoNdisMiniportQueryRequest message */
1270 struct rcondis_mp_query_request {
1276 u32 info_buf_offset;
1279 /* CoNdisMiniportSetRequest message */
1280 struct rcondis_mp_set_request {
1286 u32 info_buf_offset;
1289 /* CoNdisIndicateStatus message */
1290 struct rcondis_indicate_status {
1294 u32 status_buf_offset;
1297 /* CONDIS Call/VC parameters */
1298 struct rcondis_specific_parameters {
1300 u32 parameter_length;
1301 u32 parameter_lffset;
1304 struct rcondis_media_parameters {
1308 struct rcondis_specific_parameters media_specific;
1311 struct rndis_flowspec {
1313 u32 token_bucket_size;
1316 u32 delay_variation;
1319 u32 minimum_policed_size;
1322 struct rcondis_call_manager_parameters {
1323 struct rndis_flowspec transmit;
1324 struct rndis_flowspec receive;
1325 struct rcondis_specific_parameters call_mgr_specific;
1328 /* CoNdisMiniportActivateVc message */
1329 struct rcondis_mp_activate_vc_request {
1333 u32 media_params_offset;
1334 u32 media_params_length;
1335 u32 call_mgr_params_offset;
1336 u32 call_mgr_params_length;
1339 /* Response to CoNdisMiniportActivateVc */
1340 struct rcondis_mp_activate_vc_complete {
1345 /* CoNdisMiniportDeactivateVc message */
1346 struct rcondis_mp_deactivate_vc_request {
1352 /* Response to CoNdisMiniportDeactivateVc */
1353 struct rcondis_mp_deactivate_vc_complete {
1359 /* union with all of the RNDIS messages */
1360 union rndis_message_container {
1361 struct rndis_packet pkt;
1362 struct rndis_initialize_request init_req;
1363 struct rndis_halt_request halt_req;
1364 struct rndis_query_request query_req;
1365 struct rndis_set_request set_req;
1366 struct rndis_reset_request reset_req;
1367 struct rndis_keepalive_request keep_alive_req;
1368 struct rndis_indicate_status indicate_status;
1369 struct rndis_initialize_complete init_complete;
1370 struct rndis_query_complete query_complete;
1371 struct rndis_set_complete set_complete;
1372 struct rndis_reset_complete reset_complete;
1373 struct rndis_keepalive_complete keep_alive_complete;
1374 struct rcondis_mp_create_vc co_miniport_create_vc;
1375 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1376 struct rcondis_indicate_status co_indicate_status;
1377 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1378 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1379 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1380 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1381 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1382 struct rcondis_mp_deactivate_vc_complete
1383 co_miniport_deactivate_vc_complete;
1386 /* Remote NDIS message format */
1387 struct rndis_message {
1390 /* Total length of this message, from the beginning */
1391 /* of the struct rndis_message, in bytes. */
1394 /* Actual message */
1395 union rndis_message_container msg;
1401 /* get the size of an RNDIS message. Pass in the message type, */
1402 /* struct rndis_set_request, struct rndis_packet for example */
1403 #define RNDIS_MESSAGE_SIZE(msg) \
1404 (sizeof(msg) + (sizeof(struct rndis_message) - \
1405 sizeof(union rndis_message_container)))
1407 /* get pointer to info buffer with message pointer */
1408 #define MESSAGE_TO_INFO_BUFFER(msg) \
1409 (((unsigned char *)(msg)) + msg->info_buf_offset)
1411 /* get pointer to status buffer with message pointer */
1412 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1413 (((unsigned char *)(msg)) + msg->status_buf_offset)
1415 /* get pointer to OOBD buffer with message pointer */
1416 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1417 (((unsigned char *)(msg)) + msg->oob_data_offset)
1419 /* get pointer to data buffer with message pointer */
1420 #define MESSAGE_TO_DATA_BUFFER(msg) \
1421 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1423 /* get pointer to contained message from NDIS_MESSAGE pointer */
1424 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1425 ((void *) &rndis_msg->msg)
1427 /* get pointer to contained message from NDIS_MESSAGE pointer */
1428 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1429 ((void *) rndis_msg)
1433 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1434 sizeof(union rndis_message_container))
1436 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1438 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1439 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1440 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1441 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1442 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1443 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1444 #define NDIS_PACKET_TYPE_SMT 0x00000040
1445 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1446 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1447 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1448 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1449 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1451 #define TRANSPORT_INFO_NOT_IP 0
1452 #define TRANSPORT_INFO_IPV4_TCP 0x01
1453 #define TRANSPORT_INFO_IPV4_UDP 0x02
1454 #define TRANSPORT_INFO_IPV6_TCP 0x10
1455 #define TRANSPORT_INFO_IPV6_UDP 0x20
1457 #endif /* _HYPERV_NET_H */