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, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
28 #include <linux/list.h>
29 #include <linux/hyperv.h>
30 #include <linux/rndis.h>
33 struct hv_netvsc_packet;
35 /* Represent the xfer page packet which contains 1 or more netvsc packet */
36 struct xferpage_packet {
37 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;
51 struct hv_device *device;
56 * Valid only for receives when we break a xfer page packet
57 * into multiple netvsc packets
59 struct xferpage_packet *xfer_page_pkt;
63 u64 recv_completion_tid;
64 void *recv_completion_ctx;
65 void (*recv_completion)(void *context);
68 u64 send_completion_tid;
69 void *send_completion_ctx;
70 void (*send_completion)(void *context);
74 /* This points to the memory after page_buf */
77 u32 total_data_buflen;
78 /* Points to the send/receive buffer where the ethernet frame is */
81 struct hv_page_buffer page_buf[0];
84 struct netvsc_device_info {
85 unsigned char mac_adr[6];
86 bool link_state; /* 0 - link up, 1 - link down */
90 enum rndis_device_state {
91 RNDIS_DEV_UNINITIALIZED = 0,
92 RNDIS_DEV_INITIALIZING,
93 RNDIS_DEV_INITIALIZED,
94 RNDIS_DEV_DATAINITIALIZED,
98 struct netvsc_device *net_dev;
100 enum rndis_device_state state;
104 spinlock_t request_lock;
105 struct list_head req_list;
107 unsigned char hw_mac_adr[ETH_ALEN];
112 int netvsc_device_add(struct hv_device *device, void *additional_info);
113 int netvsc_device_remove(struct hv_device *device);
114 int netvsc_send(struct hv_device *device,
115 struct hv_netvsc_packet *packet);
116 void netvsc_linkstatus_callback(struct hv_device *device_obj,
117 unsigned int status);
118 int netvsc_recv_callback(struct hv_device *device_obj,
119 struct hv_netvsc_packet *packet);
120 int rndis_filter_open(struct hv_device *dev);
121 int rndis_filter_close(struct hv_device *dev);
122 int rndis_filter_device_add(struct hv_device *dev,
123 void *additional_info);
124 void rndis_filter_device_remove(struct hv_device *dev);
125 int rndis_filter_receive(struct hv_device *dev,
126 struct hv_netvsc_packet *pkt);
130 int rndis_filter_send(struct hv_device *dev,
131 struct hv_netvsc_packet *pkt);
133 int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
136 #define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
138 #define NVSP_PROTOCOL_VERSION_1 2
139 #define NVSP_PROTOCOL_VERSION_2 0x30002
142 NVSP_MSG_TYPE_NONE = 0,
145 NVSP_MSG_TYPE_INIT = 1,
146 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
148 NVSP_VERSION_MSG_START = 100,
150 /* Version 1 Messages */
151 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
153 NVSP_MSG1_TYPE_SEND_RECV_BUF,
154 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
155 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
157 NVSP_MSG1_TYPE_SEND_SEND_BUF,
158 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
159 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
161 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
162 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
164 /* Version 2 messages */
165 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
166 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
167 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
169 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
171 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
172 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
174 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
176 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
177 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
179 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
180 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
182 NVSP_MSG2_TYPE_ALLOC_RXBUF,
183 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
185 NVSP_MSG2_TYPE_FREE_RXBUF,
187 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
188 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
190 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
192 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
193 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
200 NVSP_STAT_PROTOCOL_TOO_NEW,
201 NVSP_STAT_PROTOCOL_TOO_OLD,
202 NVSP_STAT_INVALID_RNDIS_PKT,
204 NVSP_STAT_PROTOCOL_UNSUPPORTED,
208 struct nvsp_message_header {
215 * This message is used by the VSC to initialize the channel after the channels
216 * has been opened. This message should never include anything other then
217 * versioning (i.e. this message will be the same for ever).
219 struct nvsp_message_init {
220 u32 min_protocol_ver;
221 u32 max_protocol_ver;
225 * This message is used by the VSP to complete the initialization of the
226 * channel. This message should never include anything other then versioning
227 * (i.e. this message will be the same for ever).
229 struct nvsp_message_init_complete {
230 u32 negotiated_protocol_ver;
231 u32 max_mdl_chain_len;
235 union nvsp_message_init_uber {
236 struct nvsp_message_init init;
237 struct nvsp_message_init_complete init_complete;
240 /* Version 1 Messages */
243 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
244 * can use this information when handling OIDs sent by the VSC.
246 struct nvsp_1_message_send_ndis_version {
252 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
253 * can then use the receive buffer to send data to the VSC.
255 struct nvsp_1_message_send_receive_buffer {
260 struct nvsp_1_receive_buffer_section {
268 * This message is used by the VSP to acknowledge a receive buffer send by the
269 * VSC. This message must be sent by the VSP before the VSP uses the receive
272 struct nvsp_1_message_send_receive_buffer_complete {
277 * The receive buffer is split into two parts, a large suballocation
278 * section and a small suballocation section. These sections are then
279 * suballocated by a certain size.
283 * For example, the following break up of the receive buffer has 6
284 * large suballocations and 10 small suballocations.
288 * | Large Section | | Small Section |
289 * ------------------------------------------------------------
290 * | | | | | | | | | | | | | | | | | |
292 * LargeOffset SmallOffset
295 struct nvsp_1_receive_buffer_section sections[1];
299 * This message is sent by the VSC to revoke the receive buffer. After the VSP
300 * completes this transaction, the vsp should never use the receive buffer
303 struct nvsp_1_message_revoke_receive_buffer {
308 * This message is used by the VSC to send a send buffer to the VSP. The VSC
309 * can then use the send buffer to send data to the VSP.
311 struct nvsp_1_message_send_send_buffer {
317 * This message is used by the VSP to acknowledge a send buffer sent by the
318 * VSC. This message must be sent by the VSP before the VSP uses the sent
321 struct nvsp_1_message_send_send_buffer_complete {
325 * The VSC gets to choose the size of the send buffer and the VSP gets
326 * to choose the sections size of the buffer. This was done to enable
327 * dynamic reconfigurations when the cost of GPA-direct buffers
334 * This message is sent by the VSC to revoke the send buffer. After the VSP
335 * completes this transaction, the vsp should never use the send buffer again.
337 struct nvsp_1_message_revoke_send_buffer {
342 * This message is used by both the VSP and the VSC to send a RNDIS message to
343 * the opposite channel endpoint.
345 struct nvsp_1_message_send_rndis_packet {
347 * This field is specified by RNIDS. They assume there's two different
348 * channels of communication. However, the Network VSP only has one.
349 * Therefore, the channel travels with the RNDIS packet.
354 * This field is used to send part or all of the data through a send
355 * buffer. This values specifies an index into the send buffer. If the
356 * index is 0xFFFFFFFF, then the send buffer is not being used and all
357 * of the data was sent through other VMBus mechanisms.
359 u32 send_buf_section_index;
360 u32 send_buf_section_size;
364 * This message is used by both the VSP and the VSC to complete a RNDIS message
365 * to the opposite channel endpoint. At this point, the initiator of this
366 * message cannot use any resources associated with the original RNDIS packet.
368 struct nvsp_1_message_send_rndis_packet_complete {
372 union nvsp_1_message_uber {
373 struct nvsp_1_message_send_ndis_version send_ndis_ver;
375 struct nvsp_1_message_send_receive_buffer send_recv_buf;
376 struct nvsp_1_message_send_receive_buffer_complete
377 send_recv_buf_complete;
378 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
380 struct nvsp_1_message_send_send_buffer send_send_buf;
381 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
382 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
384 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
385 struct nvsp_1_message_send_rndis_packet_complete
386 send_rndis_pkt_complete;
391 * Network VSP protocol version 2 messages:
393 struct nvsp_2_vsc_capability {
401 u64 correlation_id:1;
406 struct nvsp_2_send_ndis_config {
409 struct nvsp_2_vsc_capability capability;
412 /* Allocate receive buffer */
413 struct nvsp_2_alloc_rxbuf {
414 /* Allocation ID to match the allocation request and response */
417 /* Length of the VM shared memory receive buffer that needs to
423 /* Allocate receive buffer complete */
424 struct nvsp_2_alloc_rxbuf_comp {
425 /* The NDIS_STATUS code for buffer allocation */
430 /* GPADL handle for the allocated receive buffer */
433 /* Receive buffer ID */
437 struct nvsp_2_free_rxbuf {
441 union nvsp_2_message_uber {
442 struct nvsp_2_send_ndis_config send_ndis_config;
443 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
444 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
445 struct nvsp_2_free_rxbuf free_rxbuf;
448 union nvsp_all_messages {
449 union nvsp_message_init_uber init_msg;
450 union nvsp_1_message_uber v1_msg;
451 union nvsp_2_message_uber v2_msg;
455 struct nvsp_message {
456 struct nvsp_message_header hdr;
457 union nvsp_all_messages msg;
461 #define NETVSC_MTU 65536
463 #define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*2) /* 2MB */
465 #define NETVSC_RECEIVE_BUFFER_ID 0xcafe
467 #define NETVSC_RECEIVE_SG_COUNT 1
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 */