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
38 #define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
39 #define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
41 struct ndis_obj_header
{
47 /* ndis_recv_scale_cap/cap_flag */
48 #define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
49 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR 0x02000000
50 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC 0x04000000
51 #define NDIS_RSS_CAPS_USING_MSI_X 0x08000000
52 #define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS 0x10000000
53 #define NDIS_RSS_CAPS_SUPPORTS_MSI_X 0x20000000
54 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4 0x00000100
55 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6 0x00000200
56 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX 0x00000400
58 struct ndis_recv_scale_cap
{ /* NDIS_RECEIVE_SCALE_CAPABILITIES */
59 struct ndis_obj_header hdr
;
63 u16 num_indirect_tabent
;
67 /* ndis_recv_scale_param flags */
68 #define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED 0x0001
69 #define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED 0x0002
70 #define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED 0x0004
71 #define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED 0x0008
72 #define NDIS_RSS_PARAM_FLAG_DISABLE_RSS 0x0010
75 #define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
76 #define NDIS_HASH_IPV4 0x00000100
77 #define NDIS_HASH_TCP_IPV4 0x00000200
78 #define NDIS_HASH_IPV6 0x00000400
79 #define NDIS_HASH_IPV6_EX 0x00000800
80 #define NDIS_HASH_TCP_IPV6 0x00001000
81 #define NDIS_HASH_TCP_IPV6_EX 0x00002000
83 #define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
84 #define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2 40
87 #define HASH_KEYLEN NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2
88 extern u8 netvsc_hash_key
[];
90 struct ndis_recv_scale_param
{ /* NDIS_RECEIVE_SCALE_PARAMETERS */
91 struct ndis_obj_header hdr
;
93 /* Qualifies the rest of the information */
96 /* The base CPU number to do receive processing. not used */
99 /* This describes the hash function and type being enabled */
102 /* The size of indirection table array */
103 u16 indirect_tabsize
;
105 /* The offset of the indirection table from the beginning of this
108 u32 indirect_taboffset
;
110 /* The size of the hash secret key */
113 /* The offset of the secret key from the beginning of this structure */
116 u32 processor_masks_offset
;
117 u32 num_processor_masks
;
118 u32 processor_masks_entry_size
;
121 /* Fwd declaration */
122 struct ndis_tcp_ip_checksum_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 */
142 u32 total_data_buflen
;
145 struct netvsc_device_info
{
146 unsigned char mac_adr
[ETH_ALEN
];
147 bool link_state
; /* 0 - link up, 1 - link down */
149 u32 max_num_vrss_chns
;
153 enum rndis_device_state
{
154 RNDIS_DEV_UNINITIALIZED
= 0,
155 RNDIS_DEV_INITIALIZING
,
156 RNDIS_DEV_INITIALIZED
,
157 RNDIS_DEV_DATAINITIALIZED
,
160 struct rndis_device
{
161 struct net_device
*ndev
;
163 enum rndis_device_state state
;
167 spinlock_t request_lock
;
168 struct list_head req_list
;
170 unsigned char hw_mac_adr
[ETH_ALEN
];
175 struct rndis_message
;
176 int netvsc_device_add(struct hv_device
*device
, void *additional_info
);
177 int netvsc_device_remove(struct hv_device
*device
);
178 int netvsc_send(struct hv_device
*device
,
179 struct hv_netvsc_packet
*packet
,
180 struct rndis_message
*rndis_msg
,
181 struct hv_page_buffer
**page_buffer
,
182 struct sk_buff
*skb
);
183 void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
184 struct rndis_message
*resp
);
185 int netvsc_recv_callback(struct hv_device
*device_obj
,
186 struct hv_netvsc_packet
*packet
,
188 struct ndis_tcp_ip_checksum_info
*csum_info
,
189 struct vmbus_channel
*channel
,
191 void netvsc_channel_cb(void *context
);
192 int rndis_filter_open(struct hv_device
*dev
);
193 int rndis_filter_close(struct hv_device
*dev
);
194 int rndis_filter_device_add(struct hv_device
*dev
,
195 void *additional_info
);
196 void rndis_filter_device_remove(struct hv_device
*dev
);
197 int rndis_filter_receive(struct hv_device
*dev
,
198 struct hv_netvsc_packet
*pkt
,
200 struct vmbus_channel
*channel
);
202 int rndis_filter_set_packet_filter(struct rndis_device
*dev
, u32 new_filter
);
203 int rndis_filter_set_device_mac(struct hv_device
*hdev
, char *mac
);
205 void netvsc_switch_datapath(struct net_device
*nv_dev
, bool vf
);
207 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
209 #define NVSP_PROTOCOL_VERSION_1 2
210 #define NVSP_PROTOCOL_VERSION_2 0x30002
211 #define NVSP_PROTOCOL_VERSION_4 0x40000
212 #define NVSP_PROTOCOL_VERSION_5 0x50000
215 NVSP_MSG_TYPE_NONE
= 0,
218 NVSP_MSG_TYPE_INIT
= 1,
219 NVSP_MSG_TYPE_INIT_COMPLETE
= 2,
221 NVSP_VERSION_MSG_START
= 100,
223 /* Version 1 Messages */
224 NVSP_MSG1_TYPE_SEND_NDIS_VER
= NVSP_VERSION_MSG_START
,
226 NVSP_MSG1_TYPE_SEND_RECV_BUF
,
227 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE
,
228 NVSP_MSG1_TYPE_REVOKE_RECV_BUF
,
230 NVSP_MSG1_TYPE_SEND_SEND_BUF
,
231 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE
,
232 NVSP_MSG1_TYPE_REVOKE_SEND_BUF
,
234 NVSP_MSG1_TYPE_SEND_RNDIS_PKT
,
235 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE
,
237 /* Version 2 messages */
238 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF
,
239 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP
,
240 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF
,
242 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION
,
244 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY
,
245 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP
,
247 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT
,
249 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT
,
250 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP
,
252 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ
,
253 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP
,
255 NVSP_MSG2_TYPE_ALLOC_RXBUF
,
256 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP
,
258 NVSP_MSG2_TYPE_FREE_RXBUF
,
260 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT
,
261 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP
,
263 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG
,
265 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE
,
266 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
268 NVSP_MSG2_MAX
= NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
270 /* Version 4 messages */
271 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION
,
272 NVSP_MSG4_TYPE_SWITCH_DATA_PATH
,
273 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
275 NVSP_MSG4_MAX
= NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED
,
277 /* Version 5 messages */
278 NVSP_MSG5_TYPE_OID_QUERY_EX
,
279 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP
,
280 NVSP_MSG5_TYPE_SUBCHANNEL
,
281 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
283 NVSP_MSG5_MAX
= NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE
,
290 NVSP_STAT_PROTOCOL_TOO_NEW
,
291 NVSP_STAT_PROTOCOL_TOO_OLD
,
292 NVSP_STAT_INVALID_RNDIS_PKT
,
294 NVSP_STAT_PROTOCOL_UNSUPPORTED
,
298 struct nvsp_message_header
{
305 * This message is used by the VSC to initialize the channel after the channels
306 * has been opened. This message should never include anything other then
307 * versioning (i.e. this message will be the same for ever).
309 struct nvsp_message_init
{
310 u32 min_protocol_ver
;
311 u32 max_protocol_ver
;
315 * This message is used by the VSP to complete the initialization of the
316 * channel. This message should never include anything other then versioning
317 * (i.e. this message will be the same for ever).
319 struct nvsp_message_init_complete
{
320 u32 negotiated_protocol_ver
;
321 u32 max_mdl_chain_len
;
325 union nvsp_message_init_uber
{
326 struct nvsp_message_init init
;
327 struct nvsp_message_init_complete init_complete
;
330 /* Version 1 Messages */
333 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
334 * can use this information when handling OIDs sent by the VSC.
336 struct nvsp_1_message_send_ndis_version
{
342 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
343 * can then use the receive buffer to send data to the VSC.
345 struct nvsp_1_message_send_receive_buffer
{
350 struct nvsp_1_receive_buffer_section
{
358 * This message is used by the VSP to acknowledge a receive buffer send by the
359 * VSC. This message must be sent by the VSP before the VSP uses the receive
362 struct nvsp_1_message_send_receive_buffer_complete
{
367 * The receive buffer is split into two parts, a large suballocation
368 * section and a small suballocation section. These sections are then
369 * suballocated by a certain size.
373 * For example, the following break up of the receive buffer has 6
374 * large suballocations and 10 small suballocations.
378 * | Large Section | | Small Section |
379 * ------------------------------------------------------------
380 * | | | | | | | | | | | | | | | | | |
382 * LargeOffset SmallOffset
385 struct nvsp_1_receive_buffer_section sections
[1];
389 * This message is sent by the VSC to revoke the receive buffer. After the VSP
390 * completes this transaction, the vsp should never use the receive buffer
393 struct nvsp_1_message_revoke_receive_buffer
{
398 * This message is used by the VSC to send a send buffer to the VSP. The VSC
399 * can then use the send buffer to send data to the VSP.
401 struct nvsp_1_message_send_send_buffer
{
407 * This message is used by the VSP to acknowledge a send buffer sent by the
408 * VSC. This message must be sent by the VSP before the VSP uses the sent
411 struct nvsp_1_message_send_send_buffer_complete
{
415 * The VSC gets to choose the size of the send buffer and the VSP gets
416 * to choose the sections size of the buffer. This was done to enable
417 * dynamic reconfigurations when the cost of GPA-direct buffers
424 * This message is sent by the VSC to revoke the send buffer. After the VSP
425 * completes this transaction, the vsp should never use the send buffer again.
427 struct nvsp_1_message_revoke_send_buffer
{
432 * This message is used by both the VSP and the VSC to send a RNDIS message to
433 * the opposite channel endpoint.
435 struct nvsp_1_message_send_rndis_packet
{
437 * This field is specified by RNIDS. They assume there's two different
438 * channels of communication. However, the Network VSP only has one.
439 * Therefore, the channel travels with the RNDIS packet.
444 * This field is used to send part or all of the data through a send
445 * buffer. This values specifies an index into the send buffer. If the
446 * index is 0xFFFFFFFF, then the send buffer is not being used and all
447 * of the data was sent through other VMBus mechanisms.
449 u32 send_buf_section_index
;
450 u32 send_buf_section_size
;
454 * This message is used by both the VSP and the VSC to complete a RNDIS message
455 * to the opposite channel endpoint. At this point, the initiator of this
456 * message cannot use any resources associated with the original RNDIS packet.
458 struct nvsp_1_message_send_rndis_packet_complete
{
462 union nvsp_1_message_uber
{
463 struct nvsp_1_message_send_ndis_version send_ndis_ver
;
465 struct nvsp_1_message_send_receive_buffer send_recv_buf
;
466 struct nvsp_1_message_send_receive_buffer_complete
467 send_recv_buf_complete
;
468 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf
;
470 struct nvsp_1_message_send_send_buffer send_send_buf
;
471 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete
;
472 struct nvsp_1_message_revoke_send_buffer revoke_send_buf
;
474 struct nvsp_1_message_send_rndis_packet send_rndis_pkt
;
475 struct nvsp_1_message_send_rndis_packet_complete
476 send_rndis_pkt_complete
;
481 * Network VSP protocol version 2 messages:
483 struct nvsp_2_vsc_capability
{
491 u64 correlation_id
:1;
496 struct nvsp_2_send_ndis_config
{
499 struct nvsp_2_vsc_capability capability
;
502 /* Allocate receive buffer */
503 struct nvsp_2_alloc_rxbuf
{
504 /* Allocation ID to match the allocation request and response */
507 /* Length of the VM shared memory receive buffer that needs to
513 /* Allocate receive buffer complete */
514 struct nvsp_2_alloc_rxbuf_comp
{
515 /* The NDIS_STATUS code for buffer allocation */
520 /* GPADL handle for the allocated receive buffer */
523 /* Receive buffer ID */
527 struct nvsp_2_free_rxbuf
{
531 union nvsp_2_message_uber
{
532 struct nvsp_2_send_ndis_config send_ndis_config
;
533 struct nvsp_2_alloc_rxbuf alloc_rxbuf
;
534 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp
;
535 struct nvsp_2_free_rxbuf free_rxbuf
;
538 struct nvsp_4_send_vf_association
{
539 /* 1: allocated, serial number is valid. 0: not allocated */
542 /* Serial number of the VF to team with */
546 enum nvsp_vm_datapath
{
547 NVSP_DATAPATH_SYNTHETIC
= 0,
552 struct nvsp_4_sw_datapath
{
553 u32 active_datapath
; /* active data path in VM */
556 union nvsp_4_message_uber
{
557 struct nvsp_4_send_vf_association vf_assoc
;
558 struct nvsp_4_sw_datapath active_dp
;
561 enum nvsp_subchannel_operation
{
562 NVSP_SUBCHANNEL_NONE
= 0,
563 NVSP_SUBCHANNEL_ALLOCATE
,
567 struct nvsp_5_subchannel_request
{
572 struct nvsp_5_subchannel_complete
{
574 u32 num_subchannels
; /* Actual number of subchannels allocated */
577 struct nvsp_5_send_indirect_table
{
578 /* The number of entries in the send indirection table */
581 /* The offset of the send indireciton table from top of this struct.
582 * The send indirection table tells which channel to put the send
583 * traffic on. Each entry is a channel number.
588 union nvsp_5_message_uber
{
589 struct nvsp_5_subchannel_request subchn_req
;
590 struct nvsp_5_subchannel_complete subchn_comp
;
591 struct nvsp_5_send_indirect_table send_table
;
594 union nvsp_all_messages
{
595 union nvsp_message_init_uber init_msg
;
596 union nvsp_1_message_uber v1_msg
;
597 union nvsp_2_message_uber v2_msg
;
598 union nvsp_4_message_uber v4_msg
;
599 union nvsp_5_message_uber v5_msg
;
603 struct nvsp_message
{
604 struct nvsp_message_header hdr
;
605 union nvsp_all_messages msg
;
609 #define NETVSC_MTU 65536
610 #define NETVSC_MTU_MIN 68
612 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
613 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
614 #define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
615 #define NETVSC_INVALID_INDEX -1
618 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
619 #define NETVSC_SEND_BUFFER_ID 0
621 #define NETVSC_PACKET_SIZE 4096
623 #define VRSS_SEND_TAB_SIZE 16
624 #define VRSS_CHANNEL_MAX 64
626 #define RNDIS_MAX_PKT_DEFAULT 8
627 #define RNDIS_PKT_ALIGN_DEFAULT 8
629 struct multi_send_data
{
630 struct sk_buff
*skb
; /* skb containing the pkt */
631 struct hv_netvsc_packet
*pkt
; /* netvsc pkt pending */
632 u32 count
; /* counter of batched packets */
635 struct netvsc_stats
{
638 struct u64_stats_sync syncp
;
641 struct netvsc_reconfig
{
642 struct list_head list
;
647 struct work_struct dwrk
;
648 struct net_device
*netdev
;
649 struct netvsc_device
*netvsc_dev
;
652 /* The context of the netvsc device */
653 struct net_device_context
{
654 /* point back to our device context */
655 struct hv_device
*device_ctx
;
657 struct netvsc_device
*nvdev
;
658 /* reconfigure work */
659 struct delayed_work dwork
;
660 /* last reconfig time */
661 unsigned long last_reconfig
;
662 /* reconfig events */
663 struct list_head reconfig_events
;
664 /* list protection */
667 struct work_struct work
;
668 u32 msg_enable
; /* debug level */
669 struct garp_wrk gwrk
;
671 struct netvsc_stats __percpu
*tx_stats
;
672 struct netvsc_stats __percpu
*rx_stats
;
674 /* Ethtool settings */
678 /* the device is going away */
682 /* Per netvsc device */
683 struct netvsc_device
{
686 atomic_t num_outstanding_sends
;
687 wait_queue_head_t wait_drain
;
690 /* Receive buffer allocated by us but manages by NetVSP */
693 u32 recv_buf_gpadl_handle
;
694 u32 recv_section_cnt
;
695 struct nvsp_1_receive_buffer_section
*recv_section
;
697 /* Send buffer allocated by us */
700 u32 send_buf_gpadl_handle
;
701 u32 send_section_cnt
;
702 u32 send_section_size
;
703 unsigned long *send_section_map
;
706 /* Used for NetVSP initialization protocol */
707 struct completion channel_init_wait
;
708 struct nvsp_message channel_init_pkt
;
710 struct nvsp_message revoke_packet
;
711 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
713 struct vmbus_channel
*chn_table
[VRSS_CHANNEL_MAX
];
714 u32 send_table
[VRSS_SEND_TAB_SIZE
];
717 spinlock_t sc_lock
; /* Protects num_sc_offered variable */
719 atomic_t queue_sends
[VRSS_CHANNEL_MAX
];
721 /* Holds rndis device info */
726 /* The primary channel callback buffer */
727 unsigned char *cb_buffer
;
728 /* The sub channel callback buffer */
729 unsigned char *sub_cb_buf
;
731 struct multi_send_data msd
[VRSS_CHANNEL_MAX
];
732 u32 max_pkt
; /* max number of pkt in one send, e.g. 8 */
733 u32 pkt_align
; /* alignment bytes, e.g. 8 */
735 /* 1: allocated, serial number is valid. 0: not allocated */
737 /* Serial number of the VF to team with */
740 /* State to manage the associated VF interface. */
742 struct net_device
*vf_netdev
;
746 /* NdisInitialize message */
747 struct rndis_initialize_request
{
754 /* Response to NdisInitialize */
755 struct rndis_initialize_complete
{
764 u32 pkt_alignment_factor
;
769 /* Call manager devices only: Information about an address family */
770 /* supported by the device is appended to the response to NdisInitialize. */
771 struct rndis_co_address_family
{
777 /* NdisHalt message */
778 struct rndis_halt_request
{
782 /* NdisQueryRequest message */
783 struct rndis_query_request
{
791 /* Response to NdisQueryRequest */
792 struct rndis_query_complete
{
799 /* NdisSetRequest message */
800 struct rndis_set_request
{
808 /* Response to NdisSetRequest */
809 struct rndis_set_complete
{
814 /* NdisReset message */
815 struct rndis_reset_request
{
819 /* Response to NdisReset */
820 struct rndis_reset_complete
{
822 u32 addressing_reset
;
825 /* NdisMIndicateStatus message */
826 struct rndis_indicate_status
{
829 u32 status_buf_offset
;
832 /* Diagnostic information passed as the status buffer in */
833 /* struct rndis_indicate_status messages signifying error conditions. */
834 struct rndis_diagnostic_info
{
839 /* NdisKeepAlive message */
840 struct rndis_keepalive_request
{
844 /* Response to NdisKeepAlive */
845 struct rndis_keepalive_complete
{
851 * Data message. All Offset fields contain byte offsets from the beginning of
852 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
853 * to 0 for connectionless data, otherwise it contains the VC handle.
855 struct rndis_packet
{
860 u32 num_oob_data_elements
;
861 u32 per_pkt_info_offset
;
862 u32 per_pkt_info_len
;
867 /* Optional Out of Band data associated with a Data message. */
871 u32 class_info_offset
;
874 /* Packet extension field contents associated with a Data message. */
875 struct rndis_per_packet_info
{
881 enum ndis_per_pkt_info_type
{
882 TCPIP_CHKSUM_PKTINFO
,
884 TCP_LARGESEND_PKTINFO
,
885 CLASSIFICATION_HANDLE_PKTINFO
,
891 NBL_HASH_VALUE
= PACKET_CANCEL_ID
,
892 ORIGINAL_NET_BUFLIST
,
898 struct ndis_pkt_8021q_info
{
901 u32 pri
:3; /* User Priority */
902 u32 cfi
:1; /* Canonical Format ID */
903 u32 vlanid
:12; /* VLAN ID */
910 struct ndis_oject_header
{
916 #define NDIS_OBJECT_TYPE_DEFAULT 0x80
917 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
918 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
919 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
920 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
921 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
922 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
923 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
924 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
925 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
926 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
927 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
929 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
930 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
931 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
933 #define VERSION_4_OFFLOAD_SIZE 22
935 * New offload OIDs for NDIS 6
937 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
938 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
939 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
940 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
941 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
942 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
944 struct ndis_offload_params
{
945 struct ndis_oject_header header
;
955 u8 tcp_connection_ip_v4
;
956 u8 tcp_connection_ip_v6
;
965 u8 encapsulated_packet_task_offload
;
966 u8 encapsulation_types
;
970 struct ndis_tcp_ip_checksum_info
{
977 u32 ip_header_checksum
:1;
979 u32 tcp_header_offset
:10;
982 u32 tcp_checksum_failed
:1;
983 u32 udp_checksum_failed
:1;
984 u32 ip_checksum_failed
:1;
985 u32 tcp_checksum_succeeded
:1;
986 u32 udp_checksum_succeeded
:1;
987 u32 ip_checksum_succeeded
:1;
989 u32 tcp_checksum_value_invalid
:1;
990 u32 ip_checksum_value_invalid
:1;
996 struct ndis_tcp_lso_info
{
1005 u32 tcp_header_offset
:10;
1013 } lso_v1_transmit_complete
;
1016 u32 tcp_header_offset
:10;
1024 } lso_v2_transmit_complete
;
1029 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1030 sizeof(struct ndis_pkt_8021q_info))
1032 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1033 sizeof(struct ndis_tcp_ip_checksum_info))
1035 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1036 sizeof(struct ndis_tcp_lso_info))
1038 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1041 /* Total size of all PPI data */
1042 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1043 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1045 /* Format of Information buffer passed in a SetRequest for the OID */
1046 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1047 struct rndis_config_parameter_info
{
1048 u32 parameter_name_offset
;
1049 u32 parameter_name_length
;
1051 u32 parameter_value_offset
;
1052 u32 parameter_value_length
;
1055 /* Values for ParameterType in struct rndis_config_parameter_info */
1056 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1057 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1059 /* CONDIS Miniport messages for connection oriented devices */
1060 /* that do not implement a call manager. */
1062 /* CoNdisMiniportCreateVc message */
1063 struct rcondis_mp_create_vc
{
1068 /* Response to CoNdisMiniportCreateVc */
1069 struct rcondis_mp_create_vc_complete
{
1075 /* CoNdisMiniportDeleteVc message */
1076 struct rcondis_mp_delete_vc
{
1081 /* Response to CoNdisMiniportDeleteVc */
1082 struct rcondis_mp_delete_vc_complete
{
1087 /* CoNdisMiniportQueryRequest message */
1088 struct rcondis_mp_query_request
{
1094 u32 info_buf_offset
;
1097 /* CoNdisMiniportSetRequest message */
1098 struct rcondis_mp_set_request
{
1104 u32 info_buf_offset
;
1107 /* CoNdisIndicateStatus message */
1108 struct rcondis_indicate_status
{
1112 u32 status_buf_offset
;
1115 /* CONDIS Call/VC parameters */
1116 struct rcondis_specific_parameters
{
1118 u32 parameter_length
;
1119 u32 parameter_lffset
;
1122 struct rcondis_media_parameters
{
1126 struct rcondis_specific_parameters media_specific
;
1129 struct rndis_flowspec
{
1131 u32 token_bucket_size
;
1134 u32 delay_variation
;
1137 u32 minimum_policed_size
;
1140 struct rcondis_call_manager_parameters
{
1141 struct rndis_flowspec transmit
;
1142 struct rndis_flowspec receive
;
1143 struct rcondis_specific_parameters call_mgr_specific
;
1146 /* CoNdisMiniportActivateVc message */
1147 struct rcondis_mp_activate_vc_request
{
1151 u32 media_params_offset
;
1152 u32 media_params_length
;
1153 u32 call_mgr_params_offset
;
1154 u32 call_mgr_params_length
;
1157 /* Response to CoNdisMiniportActivateVc */
1158 struct rcondis_mp_activate_vc_complete
{
1163 /* CoNdisMiniportDeactivateVc message */
1164 struct rcondis_mp_deactivate_vc_request
{
1170 /* Response to CoNdisMiniportDeactivateVc */
1171 struct rcondis_mp_deactivate_vc_complete
{
1177 /* union with all of the RNDIS messages */
1178 union rndis_message_container
{
1179 struct rndis_packet pkt
;
1180 struct rndis_initialize_request init_req
;
1181 struct rndis_halt_request halt_req
;
1182 struct rndis_query_request query_req
;
1183 struct rndis_set_request set_req
;
1184 struct rndis_reset_request reset_req
;
1185 struct rndis_keepalive_request keep_alive_req
;
1186 struct rndis_indicate_status indicate_status
;
1187 struct rndis_initialize_complete init_complete
;
1188 struct rndis_query_complete query_complete
;
1189 struct rndis_set_complete set_complete
;
1190 struct rndis_reset_complete reset_complete
;
1191 struct rndis_keepalive_complete keep_alive_complete
;
1192 struct rcondis_mp_create_vc co_miniport_create_vc
;
1193 struct rcondis_mp_delete_vc co_miniport_delete_vc
;
1194 struct rcondis_indicate_status co_indicate_status
;
1195 struct rcondis_mp_activate_vc_request co_miniport_activate_vc
;
1196 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc
;
1197 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete
;
1198 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete
;
1199 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete
;
1200 struct rcondis_mp_deactivate_vc_complete
1201 co_miniport_deactivate_vc_complete
;
1204 /* Remote NDIS message format */
1205 struct rndis_message
{
1208 /* Total length of this message, from the beginning */
1209 /* of the sruct rndis_message, in bytes. */
1212 /* Actual message */
1213 union rndis_message_container msg
;
1219 /* get the size of an RNDIS message. Pass in the message type, */
1220 /* struct rndis_set_request, struct rndis_packet for example */
1221 #define RNDIS_MESSAGE_SIZE(msg) \
1222 (sizeof(msg) + (sizeof(struct rndis_message) - \
1223 sizeof(union rndis_message_container)))
1225 /* get pointer to info buffer with message pointer */
1226 #define MESSAGE_TO_INFO_BUFFER(msg) \
1227 (((unsigned char *)(msg)) + msg->info_buf_offset)
1229 /* get pointer to status buffer with message pointer */
1230 #define MESSAGE_TO_STATUS_BUFFER(msg) \
1231 (((unsigned char *)(msg)) + msg->status_buf_offset)
1233 /* get pointer to OOBD buffer with message pointer */
1234 #define MESSAGE_TO_OOBD_BUFFER(msg) \
1235 (((unsigned char *)(msg)) + msg->oob_data_offset)
1237 /* get pointer to data buffer with message pointer */
1238 #define MESSAGE_TO_DATA_BUFFER(msg) \
1239 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1241 /* get pointer to contained message from NDIS_MESSAGE pointer */
1242 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1243 ((void *) &rndis_msg->msg)
1245 /* get pointer to contained message from NDIS_MESSAGE pointer */
1246 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1247 ((void *) rndis_msg)
1250 #define __struct_bcount(x)
1254 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1255 sizeof(union rndis_message_container))
1257 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1259 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1260 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1261 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1262 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1263 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1264 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1265 #define NDIS_PACKET_TYPE_SMT 0x00000040
1266 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1267 #define NDIS_PACKET_TYPE_GROUP 0x00000100
1268 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1269 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1270 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1277 #define TRANSPORT_INFO_NOT_IP 0
1278 #define TRANSPORT_INFO_IPV4_TCP ((INFO_IPV4 << 16) | INFO_TCP)
1279 #define TRANSPORT_INFO_IPV4_UDP ((INFO_IPV4 << 16) | INFO_UDP)
1280 #define TRANSPORT_INFO_IPV6_TCP ((INFO_IPV6 << 16) | INFO_TCP)
1281 #define TRANSPORT_INFO_IPV6_UDP ((INFO_IPV6 << 16) | INFO_UDP)
1283 #endif /* _HYPERV_NET_H */