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 struct hv_netvsc_packet
;
34 /* Represent the xfer page packet which contains 1 or more netvsc packet */
35 struct xferpage_packet
{
36 struct list_head list_ent
;
39 /* # of netvsc packets this xfer packet contains */
44 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
47 struct hv_netvsc_packet
{
48 /* Bookkeeping stuff */
49 struct list_head list_ent
;
52 struct hv_device
*device
;
57 * Valid only for receives when we break a xfer page packet
58 * into multiple netvsc packets
60 struct xferpage_packet
*xfer_page_pkt
;
64 u64 recv_completion_tid
;
65 void *recv_completion_ctx
;
66 void (*recv_completion
)(void *context
);
69 u64 send_completion_tid
;
70 void *send_completion_ctx
;
71 void (*send_completion
)(void *context
);
75 /* This points to the memory after page_buf */
78 u32 total_data_buflen
;
79 /* Points to the send/receive buffer where the ethernet frame is */
82 struct hv_page_buffer page_buf
[0];
85 struct netvsc_device_info
{
86 unsigned char mac_adr
[ETH_ALEN
];
87 bool link_state
; /* 0 - link up, 1 - link down */
91 enum rndis_device_state
{
92 RNDIS_DEV_UNINITIALIZED
= 0,
93 RNDIS_DEV_INITIALIZING
,
94 RNDIS_DEV_INITIALIZED
,
95 RNDIS_DEV_DATAINITIALIZED
,
99 struct netvsc_device
*net_dev
;
101 enum rndis_device_state state
;
105 spinlock_t request_lock
;
106 struct list_head req_list
;
108 unsigned char hw_mac_adr
[ETH_ALEN
];
113 int netvsc_device_add(struct hv_device
*device
, void *additional_info
);
114 int netvsc_device_remove(struct hv_device
*device
);
115 int netvsc_send(struct hv_device
*device
,
116 struct hv_netvsc_packet
*packet
);
117 void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
118 unsigned int status
);
119 int netvsc_recv_callback(struct hv_device
*device_obj
,
120 struct hv_netvsc_packet
*packet
);
121 int rndis_filter_open(struct hv_device
*dev
);
122 int rndis_filter_close(struct hv_device
*dev
);
123 int rndis_filter_device_add(struct hv_device
*dev
,
124 void *additional_info
);
125 void rndis_filter_device_remove(struct hv_device
*dev
);
126 int rndis_filter_receive(struct hv_device
*dev
,
127 struct hv_netvsc_packet
*pkt
);
131 int rndis_filter_send(struct hv_device
*dev
,
132 struct hv_netvsc_packet
*pkt
);
134 int rndis_filter_set_packet_filter(struct rndis_device
*dev
, u32 new_filter
);
135 int rndis_filter_set_device_mac(struct hv_device
*hdev
, char *mac
);
138 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
140 #define NVSP_PROTOCOL_VERSION_1 2
141 #define NVSP_PROTOCOL_VERSION_2 0x30002
144 NVSP_MSG_TYPE_NONE
= 0,
147 NVSP_MSG_TYPE_INIT
= 1,
148 NVSP_MSG_TYPE_INIT_COMPLETE
= 2,
150 NVSP_VERSION_MSG_START
= 100,
152 /* Version 1 Messages */
153 NVSP_MSG1_TYPE_SEND_NDIS_VER
= NVSP_VERSION_MSG_START
,
155 NVSP_MSG1_TYPE_SEND_RECV_BUF
,
156 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE
,
157 NVSP_MSG1_TYPE_REVOKE_RECV_BUF
,
159 NVSP_MSG1_TYPE_SEND_SEND_BUF
,
160 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE
,
161 NVSP_MSG1_TYPE_REVOKE_SEND_BUF
,
163 NVSP_MSG1_TYPE_SEND_RNDIS_PKT
,
164 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE
,
166 /* Version 2 messages */
167 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF
,
168 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP
,
169 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF
,
171 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION
,
173 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY
,
174 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP
,
176 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT
,
178 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT
,
179 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP
,
181 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ
,
182 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP
,
184 NVSP_MSG2_TYPE_ALLOC_RXBUF
,
185 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP
,
187 NVSP_MSG2_TYPE_FREE_RXBUF
,
189 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT
,
190 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP
,
192 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG
,
194 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE
,
195 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP
,
202 NVSP_STAT_PROTOCOL_TOO_NEW
,
203 NVSP_STAT_PROTOCOL_TOO_OLD
,
204 NVSP_STAT_INVALID_RNDIS_PKT
,
206 NVSP_STAT_PROTOCOL_UNSUPPORTED
,
210 struct nvsp_message_header
{
217 * This message is used by the VSC to initialize the channel after the channels
218 * has been opened. This message should never include anything other then
219 * versioning (i.e. this message will be the same for ever).
221 struct nvsp_message_init
{
222 u32 min_protocol_ver
;
223 u32 max_protocol_ver
;
227 * This message is used by the VSP to complete the initialization of the
228 * channel. This message should never include anything other then versioning
229 * (i.e. this message will be the same for ever).
231 struct nvsp_message_init_complete
{
232 u32 negotiated_protocol_ver
;
233 u32 max_mdl_chain_len
;
237 union nvsp_message_init_uber
{
238 struct nvsp_message_init init
;
239 struct nvsp_message_init_complete init_complete
;
242 /* Version 1 Messages */
245 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
246 * can use this information when handling OIDs sent by the VSC.
248 struct nvsp_1_message_send_ndis_version
{
254 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
255 * can then use the receive buffer to send data to the VSC.
257 struct nvsp_1_message_send_receive_buffer
{
262 struct nvsp_1_receive_buffer_section
{
270 * This message is used by the VSP to acknowledge a receive buffer send by the
271 * VSC. This message must be sent by the VSP before the VSP uses the receive
274 struct nvsp_1_message_send_receive_buffer_complete
{
279 * The receive buffer is split into two parts, a large suballocation
280 * section and a small suballocation section. These sections are then
281 * suballocated by a certain size.
285 * For example, the following break up of the receive buffer has 6
286 * large suballocations and 10 small suballocations.
290 * | Large Section | | Small Section |
291 * ------------------------------------------------------------
292 * | | | | | | | | | | | | | | | | | |
294 * LargeOffset SmallOffset
297 struct nvsp_1_receive_buffer_section sections
[1];
301 * This message is sent by the VSC to revoke the receive buffer. After the VSP
302 * completes this transaction, the vsp should never use the receive buffer
305 struct nvsp_1_message_revoke_receive_buffer
{
310 * This message is used by the VSC to send a send buffer to the VSP. The VSC
311 * can then use the send buffer to send data to the VSP.
313 struct nvsp_1_message_send_send_buffer
{
319 * This message is used by the VSP to acknowledge a send buffer sent by the
320 * VSC. This message must be sent by the VSP before the VSP uses the sent
323 struct nvsp_1_message_send_send_buffer_complete
{
327 * The VSC gets to choose the size of the send buffer and the VSP gets
328 * to choose the sections size of the buffer. This was done to enable
329 * dynamic reconfigurations when the cost of GPA-direct buffers
336 * This message is sent by the VSC to revoke the send buffer. After the VSP
337 * completes this transaction, the vsp should never use the send buffer again.
339 struct nvsp_1_message_revoke_send_buffer
{
344 * This message is used by both the VSP and the VSC to send a RNDIS message to
345 * the opposite channel endpoint.
347 struct nvsp_1_message_send_rndis_packet
{
349 * This field is specified by RNIDS. They assume there's two different
350 * channels of communication. However, the Network VSP only has one.
351 * Therefore, the channel travels with the RNDIS packet.
356 * This field is used to send part or all of the data through a send
357 * buffer. This values specifies an index into the send buffer. If the
358 * index is 0xFFFFFFFF, then the send buffer is not being used and all
359 * of the data was sent through other VMBus mechanisms.
361 u32 send_buf_section_index
;
362 u32 send_buf_section_size
;
366 * This message is used by both the VSP and the VSC to complete a RNDIS message
367 * to the opposite channel endpoint. At this point, the initiator of this
368 * message cannot use any resources associated with the original RNDIS packet.
370 struct nvsp_1_message_send_rndis_packet_complete
{
374 union nvsp_1_message_uber
{
375 struct nvsp_1_message_send_ndis_version send_ndis_ver
;
377 struct nvsp_1_message_send_receive_buffer send_recv_buf
;
378 struct nvsp_1_message_send_receive_buffer_complete
379 send_recv_buf_complete
;
380 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf
;
382 struct nvsp_1_message_send_send_buffer send_send_buf
;
383 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete
;
384 struct nvsp_1_message_revoke_send_buffer revoke_send_buf
;
386 struct nvsp_1_message_send_rndis_packet send_rndis_pkt
;
387 struct nvsp_1_message_send_rndis_packet_complete
388 send_rndis_pkt_complete
;
393 * Network VSP protocol version 2 messages:
395 struct nvsp_2_vsc_capability
{
403 u64 correlation_id
:1;
408 struct nvsp_2_send_ndis_config
{
411 struct nvsp_2_vsc_capability capability
;
414 /* Allocate receive buffer */
415 struct nvsp_2_alloc_rxbuf
{
416 /* Allocation ID to match the allocation request and response */
419 /* Length of the VM shared memory receive buffer that needs to
425 /* Allocate receive buffer complete */
426 struct nvsp_2_alloc_rxbuf_comp
{
427 /* The NDIS_STATUS code for buffer allocation */
432 /* GPADL handle for the allocated receive buffer */
435 /* Receive buffer ID */
439 struct nvsp_2_free_rxbuf
{
443 union nvsp_2_message_uber
{
444 struct nvsp_2_send_ndis_config send_ndis_config
;
445 struct nvsp_2_alloc_rxbuf alloc_rxbuf
;
446 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp
;
447 struct nvsp_2_free_rxbuf free_rxbuf
;
450 union nvsp_all_messages
{
451 union nvsp_message_init_uber init_msg
;
452 union nvsp_1_message_uber v1_msg
;
453 union nvsp_2_message_uber v2_msg
;
457 struct nvsp_message
{
458 struct nvsp_message_header hdr
;
459 union nvsp_all_messages msg
;
463 #define NETVSC_MTU 65536
465 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
467 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
469 /* Preallocated receive packets */
470 #define NETVSC_RECEIVE_PACKETLIST_COUNT 256
472 #define NETVSC_PACKET_SIZE 2048
474 /* Per netvsc channel-specific */
475 struct netvsc_device
{
476 struct hv_device
*dev
;
480 atomic_t num_outstanding_sends
;
481 wait_queue_head_t wait_drain
;
485 * List of free preallocated hv_netvsc_packet to represent receive
488 struct list_head recv_pkt_list
;
489 spinlock_t recv_pkt_list_lock
;
491 /* Receive buffer allocated by us but manages by NetVSP */
494 u32 recv_buf_gpadl_handle
;
495 u32 recv_section_cnt
;
496 struct nvsp_1_receive_buffer_section
*recv_section
;
498 /* Used for NetVSP initialization protocol */
499 struct completion channel_init_wait
;
500 struct nvsp_message channel_init_pkt
;
502 struct nvsp_message revoke_packet
;
503 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
505 struct net_device
*ndev
;
507 /* Holds rndis device info */
511 /* NdisInitialize message */
512 struct rndis_initialize_request
{
519 /* Response to NdisInitialize */
520 struct rndis_initialize_complete
{
529 u32 pkt_alignment_factor
;
534 /* Call manager devices only: Information about an address family */
535 /* supported by the device is appended to the response to NdisInitialize. */
536 struct rndis_co_address_family
{
542 /* NdisHalt message */
543 struct rndis_halt_request
{
547 /* NdisQueryRequest message */
548 struct rndis_query_request
{
556 /* Response to NdisQueryRequest */
557 struct rndis_query_complete
{
564 /* NdisSetRequest message */
565 struct rndis_set_request
{
573 /* Response to NdisSetRequest */
574 struct rndis_set_complete
{
579 /* NdisReset message */
580 struct rndis_reset_request
{
584 /* Response to NdisReset */
585 struct rndis_reset_complete
{
587 u32 addressing_reset
;
590 /* NdisMIndicateStatus message */
591 struct rndis_indicate_status
{
594 u32 status_buf_offset
;
597 /* Diagnostic information passed as the status buffer in */
598 /* struct rndis_indicate_status messages signifying error conditions. */
599 struct rndis_diagnostic_info
{
604 /* NdisKeepAlive message */
605 struct rndis_keepalive_request
{
609 /* Response to NdisKeepAlive */
610 struct rndis_keepalive_complete
{
616 * Data message. All Offset fields contain byte offsets from the beginning of
617 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
618 * to 0 for connectionless data, otherwise it contains the VC handle.
620 struct rndis_packet
{
625 u32 num_oob_data_elements
;
626 u32 per_pkt_info_offset
;
627 u32 per_pkt_info_len
;
632 /* Optional Out of Band data associated with a Data message. */
636 u32 class_info_offset
;
639 /* Packet extension field contents associated with a Data message. */
640 struct rndis_per_packet_info
{
646 enum ndis_per_pkt_info_type
{
647 TCPIP_CHKSUM_PKTINFO
,
649 TCP_LARGESEND_PKTINFO
,
650 CLASSIFICATION_HANDLE_PKTINFO
,
656 ORIGINAL_NET_BUFLIST
,
662 struct ndis_pkt_8021q_info
{
665 u32 pri
:3; /* User Priority */
666 u32 cfi
:1; /* Canonical Format ID */
667 u32 vlanid
:12; /* VLAN ID */
674 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
675 sizeof(struct ndis_pkt_8021q_info))
677 /* Format of Information buffer passed in a SetRequest for the OID */
678 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
679 struct rndis_config_parameter_info
{
680 u32 parameter_name_offset
;
681 u32 parameter_name_length
;
683 u32 parameter_value_offset
;
684 u32 parameter_value_length
;
687 /* Values for ParameterType in struct rndis_config_parameter_info */
688 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
689 #define RNDIS_CONFIG_PARAM_TYPE_STRING 2
691 /* CONDIS Miniport messages for connection oriented devices */
692 /* that do not implement a call manager. */
694 /* CoNdisMiniportCreateVc message */
695 struct rcondis_mp_create_vc
{
700 /* Response to CoNdisMiniportCreateVc */
701 struct rcondis_mp_create_vc_complete
{
707 /* CoNdisMiniportDeleteVc message */
708 struct rcondis_mp_delete_vc
{
713 /* Response to CoNdisMiniportDeleteVc */
714 struct rcondis_mp_delete_vc_complete
{
719 /* CoNdisMiniportQueryRequest message */
720 struct rcondis_mp_query_request
{
729 /* CoNdisMiniportSetRequest message */
730 struct rcondis_mp_set_request
{
739 /* CoNdisIndicateStatus message */
740 struct rcondis_indicate_status
{
744 u32 status_buf_offset
;
747 /* CONDIS Call/VC parameters */
748 struct rcondis_specific_parameters
{
750 u32 parameter_length
;
751 u32 parameter_lffset
;
754 struct rcondis_media_parameters
{
758 struct rcondis_specific_parameters media_specific
;
761 struct rndis_flowspec
{
763 u32 token_bucket_size
;
769 u32 minimum_policed_size
;
772 struct rcondis_call_manager_parameters
{
773 struct rndis_flowspec transmit
;
774 struct rndis_flowspec receive
;
775 struct rcondis_specific_parameters call_mgr_specific
;
778 /* CoNdisMiniportActivateVc message */
779 struct rcondis_mp_activate_vc_request
{
783 u32 media_params_offset
;
784 u32 media_params_length
;
785 u32 call_mgr_params_offset
;
786 u32 call_mgr_params_length
;
789 /* Response to CoNdisMiniportActivateVc */
790 struct rcondis_mp_activate_vc_complete
{
795 /* CoNdisMiniportDeactivateVc message */
796 struct rcondis_mp_deactivate_vc_request
{
802 /* Response to CoNdisMiniportDeactivateVc */
803 struct rcondis_mp_deactivate_vc_complete
{
809 /* union with all of the RNDIS messages */
810 union rndis_message_container
{
811 struct rndis_packet pkt
;
812 struct rndis_initialize_request init_req
;
813 struct rndis_halt_request halt_req
;
814 struct rndis_query_request query_req
;
815 struct rndis_set_request set_req
;
816 struct rndis_reset_request reset_req
;
817 struct rndis_keepalive_request keep_alive_req
;
818 struct rndis_indicate_status indicate_status
;
819 struct rndis_initialize_complete init_complete
;
820 struct rndis_query_complete query_complete
;
821 struct rndis_set_complete set_complete
;
822 struct rndis_reset_complete reset_complete
;
823 struct rndis_keepalive_complete keep_alive_complete
;
824 struct rcondis_mp_create_vc co_miniport_create_vc
;
825 struct rcondis_mp_delete_vc co_miniport_delete_vc
;
826 struct rcondis_indicate_status co_indicate_status
;
827 struct rcondis_mp_activate_vc_request co_miniport_activate_vc
;
828 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc
;
829 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete
;
830 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete
;
831 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete
;
832 struct rcondis_mp_deactivate_vc_complete
833 co_miniport_deactivate_vc_complete
;
836 /* Remote NDIS message format */
837 struct rndis_message
{
840 /* Total length of this message, from the beginning */
841 /* of the sruct rndis_message, in bytes. */
845 union rndis_message_container msg
;
849 struct rndis_filter_packet
{
850 void *completion_ctx
;
851 void (*completion
)(void *context
);
852 struct rndis_message msg
;
857 /* get the size of an RNDIS message. Pass in the message type, */
858 /* struct rndis_set_request, struct rndis_packet for example */
859 #define RNDIS_MESSAGE_SIZE(msg) \
860 (sizeof(msg) + (sizeof(struct rndis_message) - \
861 sizeof(union rndis_message_container)))
863 /* get pointer to info buffer with message pointer */
864 #define MESSAGE_TO_INFO_BUFFER(msg) \
865 (((unsigned char *)(msg)) + msg->info_buf_offset)
867 /* get pointer to status buffer with message pointer */
868 #define MESSAGE_TO_STATUS_BUFFER(msg) \
869 (((unsigned char *)(msg)) + msg->status_buf_offset)
871 /* get pointer to OOBD buffer with message pointer */
872 #define MESSAGE_TO_OOBD_BUFFER(msg) \
873 (((unsigned char *)(msg)) + msg->oob_data_offset)
875 /* get pointer to data buffer with message pointer */
876 #define MESSAGE_TO_DATA_BUFFER(msg) \
877 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
879 /* get pointer to contained message from NDIS_MESSAGE pointer */
880 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
881 ((void *) &rndis_msg->msg)
883 /* get pointer to contained message from NDIS_MESSAGE pointer */
884 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
888 #define __struct_bcount(x)
892 #define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
893 sizeof(union rndis_message_container))
895 #define NDIS_PACKET_TYPE_DIRECTED 0x00000001
896 #define NDIS_PACKET_TYPE_MULTICAST 0x00000002
897 #define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
898 #define NDIS_PACKET_TYPE_BROADCAST 0x00000008
899 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
900 #define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
901 #define NDIS_PACKET_TYPE_SMT 0x00000040
902 #define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
903 #define NDIS_PACKET_TYPE_GROUP 0x00000100
904 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
905 #define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
906 #define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
910 #endif /* _HYPERV_NET_H */