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
];
149 bool link_state
; /* 0 - link up, 1 - link down */
151 u32 max_num_vrss_chns
;
155 enum rndis_device_state
{
156 RNDIS_DEV_UNINITIALIZED
= 0,
157 RNDIS_DEV_INITIALIZING
,
158 RNDIS_DEV_INITIALIZED
,
159 RNDIS_DEV_DATAINITIALIZED
,
162 #define NETVSC_HASH_KEYLEN 40
164 struct rndis_device
{
165 struct net_device
*ndev
;
167 enum rndis_device_state state
;
171 spinlock_t request_lock
;
172 struct list_head req_list
;
174 u8 hw_mac_adr
[ETH_ALEN
];
175 u8 rss_key
[NETVSC_HASH_KEYLEN
];
176 u16 ind_table
[ITAB_NUM
];
181 struct rndis_message
;
182 struct netvsc_device
;
183 int netvsc_device_add(struct hv_device
*device
,
184 const struct netvsc_device_info
*info
);
185 void netvsc_device_remove(struct hv_device
*device
);
186 int netvsc_send(struct hv_device
*device
,
187 struct hv_netvsc_packet
*packet
,
188 struct rndis_message
*rndis_msg
,
189 struct hv_page_buffer
**page_buffer
,
190 struct sk_buff
*skb
);
191 void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
192 struct rndis_message
*resp
);
193 int netvsc_recv_callback(struct net_device
*net
,
194 struct vmbus_channel
*channel
,
196 const struct ndis_tcp_ip_checksum_info
*csum_info
,
197 const struct ndis_pkt_8021q_info
*vlan
);
198 void netvsc_channel_cb(void *context
);
199 int rndis_filter_open(struct netvsc_device
*nvdev
);
200 int rndis_filter_close(struct netvsc_device
*nvdev
);
201 int rndis_filter_device_add(struct hv_device
*dev
,
202 struct netvsc_device_info
*info
);
203 void rndis_filter_device_remove(struct hv_device
*dev
,
204 struct netvsc_device
*nvdev
);
205 int rndis_filter_set_rss_param(struct rndis_device
*rdev
,
206 const u8
*key
, int num_queue
);
207 int rndis_filter_receive(struct net_device
*ndev
,
208 struct netvsc_device
*net_dev
,
209 struct hv_device
*dev
,
210 struct vmbus_channel
*channel
,
211 void *data
, u32 buflen
);
213 int rndis_filter_set_packet_filter(struct rndis_device
*dev
, u32 new_filter
);
214 int rndis_filter_set_device_mac(struct net_device
*ndev
, char *mac
);
216 void netvsc_switch_datapath(struct net_device
*nv_dev
, bool vf
);
218 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
220 #define NVSP_PROTOCOL_VERSION_1 2
221 #define NVSP_PROTOCOL_VERSION_2 0x30002
222 #define NVSP_PROTOCOL_VERSION_4 0x40000
223 #define NVSP_PROTOCOL_VERSION_5 0x50000
226 NVSP_MSG_TYPE_NONE
= 0,
229 NVSP_MSG_TYPE_INIT
= 1,
230 NVSP_MSG_TYPE_INIT_COMPLETE
= 2,
232 NVSP_VERSION_MSG_START
= 100,
234 /* Version 1 Messages */
235 NVSP_MSG1_TYPE_SEND_NDIS_VER
= NVSP_VERSION_MSG_START
,
237 NVSP_MSG1_TYPE_SEND_RECV_BUF
,
238 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE
,
239 NVSP_MSG1_TYPE_REVOKE_RECV_BUF
,
241 NVSP_MSG1_TYPE_SEND_SEND_BUF
,
242 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE
,
243 NVSP_MSG1_TYPE_REVOKE_SEND_BUF
,
245 NVSP_MSG1_TYPE_SEND_RNDIS_PKT
,
246 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE
,
248 /* Version 2 messages */
249 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF
,
250 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP
,
251 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF
,
253 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION
,
255 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY
,
256 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP
,
258 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT
,
260 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT
,
261 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP
,
263 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ
,
264 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP
,
266 NVSP_MSG2_TYPE_ALLOC_RXBUF
,
267 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP
,
269 NVSP_MSG2_TYPE_FREE_RXBUF
,
271 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT
,
272 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP
,
274 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG
,
276 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE
,
277 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
279 NVSP_MSG2_MAX
= NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
281 /* Version 4 messages */
282 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION
,
283 NVSP_MSG4_TYPE_SWITCH_DATA_PATH
,
284 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
286 NVSP_MSG4_MAX
= NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
288 /* Version 5 messages */
289 NVSP_MSG5_TYPE_OID_QUERY_EX
,
290 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP
,
291 NVSP_MSG5_TYPE_SUBCHANNEL
,
292 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
294 NVSP_MSG5_MAX
= NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
301 NVSP_STAT_PROTOCOL_TOO_NEW
,
302 NVSP_STAT_PROTOCOL_TOO_OLD
,
303 NVSP_STAT_INVALID_RNDIS_PKT
,
305 NVSP_STAT_PROTOCOL_UNSUPPORTED
,
309 struct nvsp_message_header
{
316 * This message is used by the VSC to initialize the channel after the channels
317 * has been opened. This message should never include anything other then
318 * versioning (i.e. this message will be the same for ever).
320 struct nvsp_message_init
{
321 u32 min_protocol_ver
;
322 u32 max_protocol_ver
;
326 * This message is used by the VSP to complete the initialization of the
327 * channel. This message should never include anything other then versioning
328 * (i.e. this message will be the same for ever).
330 struct nvsp_message_init_complete
{
331 u32 negotiated_protocol_ver
;
332 u32 max_mdl_chain_len
;
336 union nvsp_message_init_uber
{
337 struct nvsp_message_init init
;
338 struct nvsp_message_init_complete init_complete
;
341 /* Version 1 Messages */
344 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
345 * can use this information when handling OIDs sent by the VSC.
347 struct nvsp_1_message_send_ndis_version
{
353 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
354 * can then use the receive buffer to send data to the VSC.
356 struct nvsp_1_message_send_receive_buffer
{
361 struct nvsp_1_receive_buffer_section
{
369 * This message is used by the VSP to acknowledge a receive buffer send by the
370 * VSC. This message must be sent by the VSP before the VSP uses the receive
373 struct nvsp_1_message_send_receive_buffer_complete
{
378 * The receive buffer is split into two parts, a large suballocation
379 * section and a small suballocation section. These sections are then
380 * suballocated by a certain size.
384 * For example, the following break up of the receive buffer has 6
385 * large suballocations and 10 small suballocations.
389 * | Large Section | | Small Section |
390 * ------------------------------------------------------------
391 * | | | | | | | | | | | | | | | | | |
393 * LargeOffset SmallOffset
396 struct nvsp_1_receive_buffer_section sections
[1];
400 * This message is sent by the VSC to revoke the receive buffer. After the VSP
401 * completes this transaction, the vsp should never use the receive buffer
404 struct nvsp_1_message_revoke_receive_buffer
{
409 * This message is used by the VSC to send a send buffer to the VSP. The VSC
410 * can then use the send buffer to send data to the VSP.
412 struct nvsp_1_message_send_send_buffer
{
418 * This message is used by the VSP to acknowledge a send buffer sent by the
419 * VSC. This message must be sent by the VSP before the VSP uses the sent
422 struct nvsp_1_message_send_send_buffer_complete
{
426 * The VSC gets to choose the size of the send buffer and the VSP gets
427 * to choose the sections size of the buffer. This was done to enable
428 * dynamic reconfigurations when the cost of GPA-direct buffers
435 * This message is sent by the VSC to revoke the send buffer. After the VSP
436 * completes this transaction, the vsp should never use the send buffer again.
438 struct nvsp_1_message_revoke_send_buffer
{
443 * This message is used by both the VSP and the VSC to send a RNDIS message to
444 * the opposite channel endpoint.
446 struct nvsp_1_message_send_rndis_packet
{
448 * This field is specified by RNDIS. They assume there's two different
449 * channels of communication. However, the Network VSP only has one.
450 * Therefore, the channel travels with the RNDIS packet.
455 * This field is used to send part or all of the data through a send
456 * buffer. This values specifies an index into the send buffer. If the
457 * index is 0xFFFFFFFF, then the send buffer is not being used and all
458 * of the data was sent through other VMBus mechanisms.
460 u32 send_buf_section_index
;
461 u32 send_buf_section_size
;
465 * This message is used by both the VSP and the VSC to complete a RNDIS message
466 * to the opposite channel endpoint. At this point, the initiator of this
467 * message cannot use any resources associated with the original RNDIS packet.
469 struct nvsp_1_message_send_rndis_packet_complete
{
473 union nvsp_1_message_uber
{
474 struct nvsp_1_message_send_ndis_version send_ndis_ver
;
476 struct nvsp_1_message_send_receive_buffer send_recv_buf
;
477 struct nvsp_1_message_send_receive_buffer_complete
478 send_recv_buf_complete
;
479 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf
;
481 struct nvsp_1_message_send_send_buffer send_send_buf
;
482 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete
;
483 struct nvsp_1_message_revoke_send_buffer revoke_send_buf
;
485 struct nvsp_1_message_send_rndis_packet send_rndis_pkt
;
486 struct nvsp_1_message_send_rndis_packet_complete
487 send_rndis_pkt_complete
;
492 * Network VSP protocol version 2 messages:
494 struct nvsp_2_vsc_capability
{
502 u64 correlation_id
:1;
508 struct nvsp_2_send_ndis_config
{
511 struct nvsp_2_vsc_capability capability
;
514 /* Allocate receive buffer */
515 struct nvsp_2_alloc_rxbuf
{
516 /* Allocation ID to match the allocation request and response */
519 /* Length of the VM shared memory receive buffer that needs to
525 /* Allocate receive buffer complete */
526 struct nvsp_2_alloc_rxbuf_comp
{
527 /* The NDIS_STATUS code for buffer allocation */
532 /* GPADL handle for the allocated receive buffer */
535 /* Receive buffer ID */
539 struct nvsp_2_free_rxbuf
{
543 union nvsp_2_message_uber
{
544 struct nvsp_2_send_ndis_config send_ndis_config
;
545 struct nvsp_2_alloc_rxbuf alloc_rxbuf
;
546 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp
;
547 struct nvsp_2_free_rxbuf free_rxbuf
;
550 struct nvsp_4_send_vf_association
{
551 /* 1: allocated, serial number is valid. 0: not allocated */
554 /* Serial number of the VF to team with */
558 enum nvsp_vm_datapath
{
559 NVSP_DATAPATH_SYNTHETIC
= 0,
564 struct nvsp_4_sw_datapath
{
565 u32 active_datapath
; /* active data path in VM */
568 union nvsp_4_message_uber
{
569 struct nvsp_4_send_vf_association vf_assoc
;
570 struct nvsp_4_sw_datapath active_dp
;
573 enum nvsp_subchannel_operation
{
574 NVSP_SUBCHANNEL_NONE
= 0,
575 NVSP_SUBCHANNEL_ALLOCATE
,
579 struct nvsp_5_subchannel_request
{
584 struct nvsp_5_subchannel_complete
{
586 u32 num_subchannels
; /* Actual number of subchannels allocated */
589 struct nvsp_5_send_indirect_table
{
590 /* The number of entries in the send indirection table */
593 /* The offset of the send indirection table from top of this struct.
594 * The send indirection table tells which channel to put the send
595 * traffic on. Each entry is a channel number.
600 union nvsp_5_message_uber
{
601 struct nvsp_5_subchannel_request subchn_req
;
602 struct nvsp_5_subchannel_complete subchn_comp
;
603 struct nvsp_5_send_indirect_table send_table
;
606 union nvsp_all_messages
{
607 union nvsp_message_init_uber init_msg
;
608 union nvsp_1_message_uber v1_msg
;
609 union nvsp_2_message_uber v2_msg
;
610 union nvsp_4_message_uber v4_msg
;
611 union nvsp_5_message_uber v5_msg
;
615 struct nvsp_message
{
616 struct nvsp_message_header hdr
;
617 union nvsp_all_messages msg
;
621 #define NETVSC_MTU 65535
622 #define NETVSC_MTU_MIN ETH_MIN_MTU
624 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
625 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
626 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
627 #define NETVSC_INVALID_INDEX -1
630 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
631 #define NETVSC_SEND_BUFFER_ID 0
633 #define NETVSC_PACKET_SIZE 4096
635 #define VRSS_SEND_TAB_SIZE 16
636 #define VRSS_CHANNEL_MAX 64
637 #define VRSS_CHANNEL_DEFAULT 8
639 #define RNDIS_MAX_PKT_DEFAULT 8
640 #define RNDIS_PKT_ALIGN_DEFAULT 8
642 struct multi_send_data
{
643 struct sk_buff
*skb
; /* skb containing the pkt */
644 struct hv_netvsc_packet
*pkt
; /* netvsc pkt pending */
645 u32 count
; /* counter of batched packets */
648 struct recv_comp_data
{
649 u64 tid
; /* transaction id */
653 /* Netvsc Receive Slots Max */
654 #define NETVSC_RECVSLOT_MAX (NETVSC_RECEIVE_BUFFER_SIZE / ETH_DATA_LEN + 1)
656 struct multi_recv_comp
{
657 void *buf
; /* queued receive completions */
658 u32 first
; /* first data entry */
659 u32 next
; /* next entry for writing */
662 struct netvsc_stats
{
667 struct u64_stats_sync syncp
;
670 struct netvsc_ethtool_stats
{
671 unsigned long tx_scattered
;
672 unsigned long tx_no_memory
;
673 unsigned long tx_no_space
;
674 unsigned long tx_too_big
;
675 unsigned long tx_busy
;
678 struct netvsc_reconfig
{
679 struct list_head list
;
683 /* The context of the netvsc device */
684 struct net_device_context
{
685 /* point back to our device context */
686 struct hv_device
*device_ctx
;
688 struct netvsc_device
*nvdev
;
689 /* reconfigure work */
690 struct delayed_work dwork
;
691 /* last reconfig time */
692 unsigned long last_reconfig
;
693 /* reconfig events */
694 struct list_head reconfig_events
;
695 /* list protection */
698 struct work_struct work
;
699 u32 msg_enable
; /* debug level */
701 u32 tx_checksum_mask
;
703 /* Ethtool settings */
706 struct netvsc_ethtool_stats eth_stats
;
708 /* the device is going away */
711 /* State to manage the associated VF interface. */
712 struct net_device __rcu
*vf_netdev
;
714 /* 1: allocated, serial number is valid. 0: not allocated */
716 /* Serial number of the VF to team with */
720 /* Per channel data */
721 struct netvsc_channel
{
722 struct vmbus_channel
*channel
;
723 struct multi_send_data msd
;
724 struct multi_recv_comp mrc
;
725 atomic_t queue_sends
;
727 struct netvsc_stats tx_stats
;
728 struct netvsc_stats rx_stats
;
731 /* Per netvsc device */
732 struct netvsc_device
{
735 wait_queue_head_t wait_drain
;
738 /* Receive buffer allocated by us but manages by NetVSP */
741 u32 recv_buf_gpadl_handle
;
742 u32 recv_section_cnt
;
743 struct nvsp_1_receive_buffer_section
*recv_section
;
745 /* Send buffer allocated by us */
748 u32 send_buf_gpadl_handle
;
749 u32 send_section_cnt
;
750 u32 send_section_size
;
751 unsigned long *send_section_map
;
754 /* Used for NetVSP initialization protocol */
755 struct completion channel_init_wait
;
756 struct nvsp_message channel_init_pkt
;
758 struct nvsp_message revoke_packet
;
760 u32 send_table
[VRSS_SEND_TAB_SIZE
];
763 spinlock_t sc_lock
; /* Protects num_sc_offered variable */
766 /* Holds rndis device info */
771 u32 max_pkt
; /* max number of pkt in one send, e.g. 8 */
772 u32 pkt_align
; /* alignment bytes, e.g. 8 */
774 atomic_t num_outstanding_recvs
;
778 struct netvsc_channel chan_table
[VRSS_CHANNEL_MAX
];
781 static inline struct netvsc_device
*
782 net_device_to_netvsc_device(struct net_device
*ndev
)
784 return ((struct net_device_context
*)netdev_priv(ndev
))->nvdev
;
787 static inline struct netvsc_device
*
788 hv_device_to_netvsc_device(struct hv_device
*device
)
790 return net_device_to_netvsc_device(hv_get_drvdata(device
));
793 /* NdisInitialize message */
794 struct rndis_initialize_request
{
801 /* Response to NdisInitialize */
802 struct rndis_initialize_complete
{
811 u32 pkt_alignment_factor
;
816 /* Call manager devices only: Information about an address family */
817 /* supported by the device is appended to the response to NdisInitialize. */
818 struct rndis_co_address_family
{
824 /* NdisHalt message */
825 struct rndis_halt_request
{
829 /* NdisQueryRequest message */
830 struct rndis_query_request
{
838 /* Response to NdisQueryRequest */
839 struct rndis_query_complete
{
846 /* NdisSetRequest message */
847 struct rndis_set_request
{
855 /* Response to NdisSetRequest */
856 struct rndis_set_complete
{
861 /* NdisReset message */
862 struct rndis_reset_request
{
866 /* Response to NdisReset */
867 struct rndis_reset_complete
{
869 u32 addressing_reset
;
872 /* NdisMIndicateStatus message */
873 struct rndis_indicate_status
{
876 u32 status_buf_offset
;
879 /* Diagnostic information passed as the status buffer in */
880 /* struct rndis_indicate_status messages signifying error conditions. */
881 struct rndis_diagnostic_info
{
886 /* NdisKeepAlive message */
887 struct rndis_keepalive_request
{
891 /* Response to NdisKeepAlive */
892 struct rndis_keepalive_complete
{
898 * Data message. All Offset fields contain byte offsets from the beginning of
899 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
900 * to 0 for connectionless data, otherwise it contains the VC handle.
902 struct rndis_packet
{
907 u32 num_oob_data_elements
;
908 u32 per_pkt_info_offset
;
909 u32 per_pkt_info_len
;
914 /* Optional Out of Band data associated with a Data message. */
918 u32 class_info_offset
;
921 /* Packet extension field contents associated with a Data message. */
922 struct rndis_per_packet_info
{
928 enum ndis_per_pkt_info_type
{
929 TCPIP_CHKSUM_PKTINFO
,
931 TCP_LARGESEND_PKTINFO
,
932 CLASSIFICATION_HANDLE_PKTINFO
,
938 NBL_HASH_VALUE
= PACKET_CANCEL_ID
,
939 ORIGINAL_NET_BUFLIST
,
945 struct ndis_pkt_8021q_info
{
948 u32 pri
:3; /* User Priority */
949 u32 cfi
:1; /* Canonical Format ID */
950 u32 vlanid
:12; /* VLAN ID */
957 struct ndis_object_header
{
963 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
964 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
965 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
966 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
968 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
969 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
970 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
971 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
972 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
973 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
974 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
975 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
976 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
977 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
979 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
980 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
981 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
983 #define VERSION_4_OFFLOAD_SIZE 22
985 * New offload OIDs for NDIS 6
987 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
988 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
989 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
990 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
991 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
992 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
995 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
996 * ndis_type: NDIS_OBJTYPE_OFFLOAD
999 #define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1000 #define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1001 #define NDIS_OFFLOAD_ENCAP_8023 0x0002
1002 #define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1003 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1004 #define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1006 struct ndis_csum_offload
{
1009 #define NDIS_TXCSUM_CAP_IP4OPT 0x001
1010 #define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1011 #define NDIS_TXCSUM_CAP_TCP4 0x010
1012 #define NDIS_TXCSUM_CAP_UDP4 0x040
1013 #define NDIS_TXCSUM_CAP_IP4 0x100
1015 #define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1019 #define NDIS_RXCSUM_CAP_IP4OPT 0x001
1020 #define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1021 #define NDIS_RXCSUM_CAP_TCP4 0x010
1022 #define NDIS_RXCSUM_CAP_UDP4 0x040
1023 #define NDIS_RXCSUM_CAP_IP4 0x100
1026 #define NDIS_TXCSUM_CAP_IP6EXT 0x001
1027 #define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1028 #define NDIS_TXCSUM_CAP_TCP6 0x010
1029 #define NDIS_TXCSUM_CAP_UDP6 0x040
1032 #define NDIS_RXCSUM_CAP_IP6EXT 0x001
1033 #define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1034 #define NDIS_RXCSUM_CAP_TCP6 0x010
1035 #define NDIS_RXCSUM_CAP_UDP6 0x040
1037 #define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1038 NDIS_TXCSUM_CAP_TCP6OPT | \
1039 NDIS_TXCSUM_CAP_IP6EXT)
1042 struct ndis_lsov1_offload
{
1049 struct ndis_ipsecv1_offload
{
1059 struct ndis_lsov2_offload
{
1067 #define NDIS_LSOV2_CAP_IP6EXT 0x001
1068 #define NDIS_LSOV2_CAP_TCP6OPT 0x004
1070 #define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1071 NDIS_LSOV2_CAP_TCP6OPT)
1074 struct ndis_ipsecv2_offload
{
1093 struct ndis_rsc_offload
{
1098 struct ndis_encap_offload
{
1103 struct ndis_offload
{
1104 struct ndis_object_header header
;
1105 struct ndis_csum_offload csum
;
1106 struct ndis_lsov1_offload lsov1
;
1107 struct ndis_ipsecv1_offload ipsecv1
;
1108 struct ndis_lsov2_offload lsov2
;
1111 struct ndis_ipsecv2_offload ipsecv2
;
1113 struct ndis_rsc_offload rsc
;
1114 struct ndis_encap_offload encap_gre
;
1117 #define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1118 #define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1119 #define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1121 struct ndis_offload_params
{
1122 struct ndis_object_header header
;
1132 u8 tcp_connection_ip_v4
;
1133 u8 tcp_connection_ip_v6
;
1142 u8 encapsulated_packet_task_offload
;
1143 u8 encapsulation_types
;
1147 struct ndis_tcp_ip_checksum_info
{
1154 u32 ip_header_checksum
:1;
1156 u32 tcp_header_offset
:10;
1159 u32 tcp_checksum_failed
:1;
1160 u32 udp_checksum_failed
:1;
1161 u32 ip_checksum_failed
:1;
1162 u32 tcp_checksum_succeeded
:1;
1163 u32 udp_checksum_succeeded
:1;
1164 u32 ip_checksum_succeeded
:1;
1166 u32 tcp_checksum_value_invalid
:1;
1167 u32 ip_checksum_value_invalid
:1;
1173 struct ndis_tcp_lso_info
{
1182 u32 tcp_header_offset
:10;
1190 } lso_v1_transmit_complete
;
1193 u32 tcp_header_offset
:10;
1201 } lso_v2_transmit_complete
;
1206 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1207 sizeof(struct ndis_pkt_8021q_info))
1209 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1210 sizeof(struct ndis_tcp_ip_checksum_info))
1212 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1213 sizeof(struct ndis_tcp_lso_info))
1215 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1218 /* Total size of all PPI data */
1219 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1220 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1222 /* Format of Information buffer passed in a SetRequest for the OID */
1223 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1224 struct rndis_config_parameter_info
{
1225 u32 parameter_name_offset
;
1226 u32 parameter_name_length
;
1228 u32 parameter_value_offset
;
1229 u32 parameter_value_length
;
1232 /* Values for ParameterType in struct rndis_config_parameter_info */
1233 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1234 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1236 /* CONDIS Miniport messages for connection oriented devices */
1237 /* that do not implement a call manager. */
1239 /* CoNdisMiniportCreateVc message */
1240 struct rcondis_mp_create_vc
{
1245 /* Response to CoNdisMiniportCreateVc */
1246 struct rcondis_mp_create_vc_complete
{
1252 /* CoNdisMiniportDeleteVc message */
1253 struct rcondis_mp_delete_vc
{
1258 /* Response to CoNdisMiniportDeleteVc */
1259 struct rcondis_mp_delete_vc_complete
{
1264 /* CoNdisMiniportQueryRequest message */
1265 struct rcondis_mp_query_request
{
1271 u32 info_buf_offset
;
1274 /* CoNdisMiniportSetRequest message */
1275 struct rcondis_mp_set_request
{
1281 u32 info_buf_offset
;
1284 /* CoNdisIndicateStatus message */
1285 struct rcondis_indicate_status
{
1289 u32 status_buf_offset
;
1292 /* CONDIS Call/VC parameters */
1293 struct rcondis_specific_parameters
{
1295 u32 parameter_length
;
1296 u32 parameter_lffset
;
1299 struct rcondis_media_parameters
{
1303 struct rcondis_specific_parameters media_specific
;
1306 struct rndis_flowspec
{
1308 u32 token_bucket_size
;
1311 u32 delay_variation
;
1314 u32 minimum_policed_size
;
1317 struct rcondis_call_manager_parameters
{
1318 struct rndis_flowspec transmit
;
1319 struct rndis_flowspec receive
;
1320 struct rcondis_specific_parameters call_mgr_specific
;
1323 /* CoNdisMiniportActivateVc message */
1324 struct rcondis_mp_activate_vc_request
{
1328 u32 media_params_offset
;
1329 u32 media_params_length
;
1330 u32 call_mgr_params_offset
;
1331 u32 call_mgr_params_length
;
1334 /* Response to CoNdisMiniportActivateVc */
1335 struct rcondis_mp_activate_vc_complete
{
1340 /* CoNdisMiniportDeactivateVc message */
1341 struct rcondis_mp_deactivate_vc_request
{
1347 /* Response to CoNdisMiniportDeactivateVc */
1348 struct rcondis_mp_deactivate_vc_complete
{
1354 /* union with all of the RNDIS messages */
1355 union rndis_message_container
{
1356 struct rndis_packet pkt
;
1357 struct rndis_initialize_request init_req
;
1358 struct rndis_halt_request halt_req
;
1359 struct rndis_query_request query_req
;
1360 struct rndis_set_request set_req
;
1361 struct rndis_reset_request reset_req
;
1362 struct rndis_keepalive_request keep_alive_req
;
1363 struct rndis_indicate_status indicate_status
;
1364 struct rndis_initialize_complete init_complete
;
1365 struct rndis_query_complete query_complete
;
1366 struct rndis_set_complete set_complete
;
1367 struct rndis_reset_complete reset_complete
;
1368 struct rndis_keepalive_complete keep_alive_complete
;
1369 struct rcondis_mp_create_vc co_miniport_create_vc
;
1370 struct rcondis_mp_delete_vc co_miniport_delete_vc
;
1371 struct rcondis_indicate_status co_indicate_status
;
1372 struct rcondis_mp_activate_vc_request co_miniport_activate_vc
;
1373 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc
;
1374 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete
;
1375 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete
;
1376 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete
;
1377 struct rcondis_mp_deactivate_vc_complete
1378 co_miniport_deactivate_vc_complete
;
1381 /* Remote NDIS message format */
1382 struct rndis_message
{
1385 /* Total length of this message, from the beginning */
1386 /* of the struct rndis_message, in bytes. */
1389 /* Actual message */
1390 union rndis_message_container msg
;
1396 /* get the size of an RNDIS message. Pass in the message type, */
1397 /* struct rndis_set_request, struct rndis_packet for example */
1398 #define RNDIS_MESSAGE_SIZE(msg) \
1399 (sizeof(msg) + (sizeof(struct rndis_message) - \
1400 sizeof(union rndis_message_container)))
1402 /* get pointer to info buffer with message pointer */
1403 #define MESSAGE_TO_INFO_BUFFER(msg) \
1404 (((unsigned char *)(msg)) + msg->info_buf_offset)
1406 /* get pointer to status buffer with message pointer */
1407 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1408 (((unsigned char *)(msg)) + msg->status_buf_offset)
1410 /* get pointer to OOBD buffer with message pointer */
1411 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1412 (((unsigned char *)(msg)) + msg->oob_data_offset)
1414 /* get pointer to data buffer with message pointer */
1415 #define MESSAGE_TO_DATA_BUFFER(msg) \
1416 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1418 /* get pointer to contained message from NDIS_MESSAGE pointer */
1419 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1420 ((void *) &rndis_msg->msg)
1422 /* get pointer to contained message from NDIS_MESSAGE pointer */
1423 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1424 ((void *) rndis_msg)
1427 #define __struct_bcount(x)
1431 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1432 sizeof(union rndis_message_container))
1434 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1436 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1437 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1438 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1439 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1440 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1441 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1442 #define NDIS_PACKET_TYPE_SMT 0x00000040
1443 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1444 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1445 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1446 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1447 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1449 #define TRANSPORT_INFO_NOT_IP 0
1450 #define TRANSPORT_INFO_IPV4_TCP 0x01
1451 #define TRANSPORT_INFO_IPV4_UDP 0x02
1452 #define TRANSPORT_INFO_IPV6_TCP 0x10
1453 #define TRANSPORT_INFO_IPV6_UDP 0x20
1455 #endif /* _HYPERV_NET_H */