Loading...
1/*
2 *
3 * Copyright (c) 2011, Microsoft Corporation.
4 *
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.
8 *
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
12 * more details.
13 *
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/>.
16 *
17 * Authors:
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 * K. Y. Srinivasan <kys@microsoft.com>
21 *
22 */
23
24#ifndef _HYPERV_NET_H
25#define _HYPERV_NET_H
26
27#include <linux/list.h>
28#include <linux/hyperv.h>
29#include <linux/rndis.h>
30
31/* Fwd declaration */
32struct hv_netvsc_packet;
33struct ndis_tcp_ip_checksum_info;
34
35/* Represent the xfer page packet which contains 1 or more netvsc packet */
36struct xferpage_packet {
37 struct list_head list_ent;
38 u32 status;
39
40 /* # of netvsc packets this xfer packet contains */
41 u32 count;
42};
43
44/*
45 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
46 * within the RNDIS
47 */
48struct hv_netvsc_packet {
49 /* Bookkeeping stuff */
50 struct list_head list_ent;
51 u32 status;
52
53 struct hv_device *device;
54 bool is_data_pkt;
55 u16 vlan_tci;
56
57 /*
58 * Valid only for receives when we break a xfer page packet
59 * into multiple netvsc packets
60 */
61 struct xferpage_packet *xfer_page_pkt;
62
63 union {
64 struct {
65 u64 recv_completion_tid;
66 void *recv_completion_ctx;
67 void (*recv_completion)(void *context);
68 } recv;
69 struct {
70 u64 send_completion_tid;
71 void *send_completion_ctx;
72 void (*send_completion)(void *context);
73 } send;
74 } completion;
75
76 /* This points to the memory after page_buf */
77 struct rndis_message *rndis_msg;
78
79 u32 total_data_buflen;
80 /* Points to the send/receive buffer where the ethernet frame is */
81 void *data;
82 u32 page_buf_cnt;
83 struct hv_page_buffer page_buf[0];
84};
85
86struct netvsc_device_info {
87 unsigned char mac_adr[ETH_ALEN];
88 bool link_state; /* 0 - link up, 1 - link down */
89 int ring_size;
90};
91
92enum rndis_device_state {
93 RNDIS_DEV_UNINITIALIZED = 0,
94 RNDIS_DEV_INITIALIZING,
95 RNDIS_DEV_INITIALIZED,
96 RNDIS_DEV_DATAINITIALIZED,
97};
98
99struct rndis_device {
100 struct netvsc_device *net_dev;
101
102 enum rndis_device_state state;
103 bool link_state;
104 atomic_t new_req_id;
105
106 spinlock_t request_lock;
107 struct list_head req_list;
108
109 unsigned char hw_mac_adr[ETH_ALEN];
110};
111
112
113/* Interface */
114int netvsc_device_add(struct hv_device *device, void *additional_info);
115int netvsc_device_remove(struct hv_device *device);
116int netvsc_send(struct hv_device *device,
117 struct hv_netvsc_packet *packet);
118void netvsc_linkstatus_callback(struct hv_device *device_obj,
119 unsigned int status);
120int netvsc_recv_callback(struct hv_device *device_obj,
121 struct hv_netvsc_packet *packet,
122 struct ndis_tcp_ip_checksum_info *csum_info);
123int rndis_filter_open(struct hv_device *dev);
124int rndis_filter_close(struct hv_device *dev);
125int rndis_filter_device_add(struct hv_device *dev,
126 void *additional_info);
127void rndis_filter_device_remove(struct hv_device *dev);
128int rndis_filter_receive(struct hv_device *dev,
129 struct hv_netvsc_packet *pkt);
130
131int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
132int rndis_filter_set_device_mac(struct hv_device *hdev, char *mac);
133
134
135#define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
136
137#define NVSP_PROTOCOL_VERSION_1 2
138#define NVSP_PROTOCOL_VERSION_2 0x30002
139#define NVSP_PROTOCOL_VERSION_4 0x40000
140#define NVSP_PROTOCOL_VERSION_5 0x50000
141
142enum {
143 NVSP_MSG_TYPE_NONE = 0,
144
145 /* Init Messages */
146 NVSP_MSG_TYPE_INIT = 1,
147 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
148
149 NVSP_VERSION_MSG_START = 100,
150
151 /* Version 1 Messages */
152 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
153
154 NVSP_MSG1_TYPE_SEND_RECV_BUF,
155 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
156 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
157
158 NVSP_MSG1_TYPE_SEND_SEND_BUF,
159 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
160 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
161
162 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
163 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
164
165 /* Version 2 messages */
166 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
167 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
168 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
169
170 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
171
172 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
173 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
174
175 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
176
177 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
178 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
179
180 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
181 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
182
183 NVSP_MSG2_TYPE_ALLOC_RXBUF,
184 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
185
186 NVSP_MSG2_TYPE_FREE_RXBUF,
187
188 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
189 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
190
191 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
192
193 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
194 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
195
196 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
197
198 /* Version 4 messages */
199 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
200 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
201 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
202
203 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
204
205 /* Version 5 messages */
206 NVSP_MSG5_TYPE_OID_QUERY_EX,
207 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
208 NVSP_MSG5_TYPE_SUBCHANNEL,
209 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
210
211 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
212};
213
214enum {
215 NVSP_STAT_NONE = 0,
216 NVSP_STAT_SUCCESS,
217 NVSP_STAT_FAIL,
218 NVSP_STAT_PROTOCOL_TOO_NEW,
219 NVSP_STAT_PROTOCOL_TOO_OLD,
220 NVSP_STAT_INVALID_RNDIS_PKT,
221 NVSP_STAT_BUSY,
222 NVSP_STAT_PROTOCOL_UNSUPPORTED,
223 NVSP_STAT_MAX,
224};
225
226struct nvsp_message_header {
227 u32 msg_type;
228};
229
230/* Init Messages */
231
232/*
233 * This message is used by the VSC to initialize the channel after the channels
234 * has been opened. This message should never include anything other then
235 * versioning (i.e. this message will be the same for ever).
236 */
237struct nvsp_message_init {
238 u32 min_protocol_ver;
239 u32 max_protocol_ver;
240} __packed;
241
242/*
243 * This message is used by the VSP to complete the initialization of the
244 * channel. This message should never include anything other then versioning
245 * (i.e. this message will be the same for ever).
246 */
247struct nvsp_message_init_complete {
248 u32 negotiated_protocol_ver;
249 u32 max_mdl_chain_len;
250 u32 status;
251} __packed;
252
253union nvsp_message_init_uber {
254 struct nvsp_message_init init;
255 struct nvsp_message_init_complete init_complete;
256} __packed;
257
258/* Version 1 Messages */
259
260/*
261 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
262 * can use this information when handling OIDs sent by the VSC.
263 */
264struct nvsp_1_message_send_ndis_version {
265 u32 ndis_major_ver;
266 u32 ndis_minor_ver;
267} __packed;
268
269/*
270 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
271 * can then use the receive buffer to send data to the VSC.
272 */
273struct nvsp_1_message_send_receive_buffer {
274 u32 gpadl_handle;
275 u16 id;
276} __packed;
277
278struct nvsp_1_receive_buffer_section {
279 u32 offset;
280 u32 sub_alloc_size;
281 u32 num_sub_allocs;
282 u32 end_offset;
283} __packed;
284
285/*
286 * This message is used by the VSP to acknowledge a receive buffer send by the
287 * VSC. This message must be sent by the VSP before the VSP uses the receive
288 * buffer.
289 */
290struct nvsp_1_message_send_receive_buffer_complete {
291 u32 status;
292 u32 num_sections;
293
294 /*
295 * The receive buffer is split into two parts, a large suballocation
296 * section and a small suballocation section. These sections are then
297 * suballocated by a certain size.
298 */
299
300 /*
301 * For example, the following break up of the receive buffer has 6
302 * large suballocations and 10 small suballocations.
303 */
304
305 /*
306 * | Large Section | | Small Section |
307 * ------------------------------------------------------------
308 * | | | | | | | | | | | | | | | | | |
309 * | |
310 * LargeOffset SmallOffset
311 */
312
313 struct nvsp_1_receive_buffer_section sections[1];
314} __packed;
315
316/*
317 * This message is sent by the VSC to revoke the receive buffer. After the VSP
318 * completes this transaction, the vsp should never use the receive buffer
319 * again.
320 */
321struct nvsp_1_message_revoke_receive_buffer {
322 u16 id;
323};
324
325/*
326 * This message is used by the VSC to send a send buffer to the VSP. The VSC
327 * can then use the send buffer to send data to the VSP.
328 */
329struct nvsp_1_message_send_send_buffer {
330 u32 gpadl_handle;
331 u16 id;
332} __packed;
333
334/*
335 * This message is used by the VSP to acknowledge a send buffer sent by the
336 * VSC. This message must be sent by the VSP before the VSP uses the sent
337 * buffer.
338 */
339struct nvsp_1_message_send_send_buffer_complete {
340 u32 status;
341
342 /*
343 * The VSC gets to choose the size of the send buffer and the VSP gets
344 * to choose the sections size of the buffer. This was done to enable
345 * dynamic reconfigurations when the cost of GPA-direct buffers
346 * decreases.
347 */
348 u32 section_size;
349} __packed;
350
351/*
352 * This message is sent by the VSC to revoke the send buffer. After the VSP
353 * completes this transaction, the vsp should never use the send buffer again.
354 */
355struct nvsp_1_message_revoke_send_buffer {
356 u16 id;
357};
358
359/*
360 * This message is used by both the VSP and the VSC to send a RNDIS message to
361 * the opposite channel endpoint.
362 */
363struct nvsp_1_message_send_rndis_packet {
364 /*
365 * This field is specified by RNIDS. They assume there's two different
366 * channels of communication. However, the Network VSP only has one.
367 * Therefore, the channel travels with the RNDIS packet.
368 */
369 u32 channel_type;
370
371 /*
372 * This field is used to send part or all of the data through a send
373 * buffer. This values specifies an index into the send buffer. If the
374 * index is 0xFFFFFFFF, then the send buffer is not being used and all
375 * of the data was sent through other VMBus mechanisms.
376 */
377 u32 send_buf_section_index;
378 u32 send_buf_section_size;
379} __packed;
380
381/*
382 * This message is used by both the VSP and the VSC to complete a RNDIS message
383 * to the opposite channel endpoint. At this point, the initiator of this
384 * message cannot use any resources associated with the original RNDIS packet.
385 */
386struct nvsp_1_message_send_rndis_packet_complete {
387 u32 status;
388};
389
390union nvsp_1_message_uber {
391 struct nvsp_1_message_send_ndis_version send_ndis_ver;
392
393 struct nvsp_1_message_send_receive_buffer send_recv_buf;
394 struct nvsp_1_message_send_receive_buffer_complete
395 send_recv_buf_complete;
396 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
397
398 struct nvsp_1_message_send_send_buffer send_send_buf;
399 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
400 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
401
402 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
403 struct nvsp_1_message_send_rndis_packet_complete
404 send_rndis_pkt_complete;
405} __packed;
406
407
408/*
409 * Network VSP protocol version 2 messages:
410 */
411struct nvsp_2_vsc_capability {
412 union {
413 u64 data;
414 struct {
415 u64 vmq:1;
416 u64 chimney:1;
417 u64 sriov:1;
418 u64 ieee8021q:1;
419 u64 correlation_id:1;
420 };
421 };
422} __packed;
423
424struct nvsp_2_send_ndis_config {
425 u32 mtu;
426 u32 reserved;
427 struct nvsp_2_vsc_capability capability;
428} __packed;
429
430/* Allocate receive buffer */
431struct nvsp_2_alloc_rxbuf {
432 /* Allocation ID to match the allocation request and response */
433 u32 alloc_id;
434
435 /* Length of the VM shared memory receive buffer that needs to
436 * be allocated
437 */
438 u32 len;
439} __packed;
440
441/* Allocate receive buffer complete */
442struct nvsp_2_alloc_rxbuf_comp {
443 /* The NDIS_STATUS code for buffer allocation */
444 u32 status;
445
446 u32 alloc_id;
447
448 /* GPADL handle for the allocated receive buffer */
449 u32 gpadl_handle;
450
451 /* Receive buffer ID */
452 u64 recv_buf_id;
453} __packed;
454
455struct nvsp_2_free_rxbuf {
456 u64 recv_buf_id;
457} __packed;
458
459union nvsp_2_message_uber {
460 struct nvsp_2_send_ndis_config send_ndis_config;
461 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
462 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
463 struct nvsp_2_free_rxbuf free_rxbuf;
464} __packed;
465
466enum nvsp_subchannel_operation {
467 NVSP_SUBCHANNEL_NONE = 0,
468 NVSP_SUBCHANNEL_ALLOCATE,
469 NVSP_SUBCHANNEL_MAX
470};
471
472struct nvsp_5_subchannel_request {
473 u32 op;
474 u32 num_subchannels;
475} __packed;
476
477struct nvsp_5_subchannel_complete {
478 u32 status;
479 u32 num_subchannels; /* Actual number of subchannels allocated */
480} __packed;
481
482struct nvsp_5_send_indirect_table {
483 /* The number of entries in the send indirection table */
484 u32 count;
485
486 /* The offset of the send indireciton table from top of this struct.
487 * The send indirection table tells which channel to put the send
488 * traffic on. Each entry is a channel number.
489 */
490 u32 offset;
491} __packed;
492
493union nvsp_5_message_uber {
494 struct nvsp_5_subchannel_request subchn_req;
495 struct nvsp_5_subchannel_complete subchn_comp;
496 struct nvsp_5_send_indirect_table send_table;
497} __packed;
498
499union nvsp_all_messages {
500 union nvsp_message_init_uber init_msg;
501 union nvsp_1_message_uber v1_msg;
502 union nvsp_2_message_uber v2_msg;
503 union nvsp_5_message_uber v5_msg;
504} __packed;
505
506/* ALL Messages */
507struct nvsp_message {
508 struct nvsp_message_header hdr;
509 union nvsp_all_messages msg;
510} __packed;
511
512
513#define NETVSC_MTU 65536
514
515#define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
516#define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
517
518#define NETVSC_RECEIVE_BUFFER_ID 0xcafe
519
520/* Preallocated receive packets */
521#define NETVSC_RECEIVE_PACKETLIST_COUNT 256
522
523#define NETVSC_PACKET_SIZE 2048
524
525/* Per netvsc channel-specific */
526struct netvsc_device {
527 struct hv_device *dev;
528
529 u32 nvsp_version;
530
531 atomic_t num_outstanding_sends;
532 wait_queue_head_t wait_drain;
533 bool start_remove;
534 bool destroy;
535 /*
536 * List of free preallocated hv_netvsc_packet to represent receive
537 * packet
538 */
539 struct list_head recv_pkt_list;
540 spinlock_t recv_pkt_list_lock;
541
542 /* Receive buffer allocated by us but manages by NetVSP */
543 void *recv_buf;
544 u32 recv_buf_size;
545 u32 recv_buf_gpadl_handle;
546 u32 recv_section_cnt;
547 struct nvsp_1_receive_buffer_section *recv_section;
548
549 /* Used for NetVSP initialization protocol */
550 struct completion channel_init_wait;
551 struct nvsp_message channel_init_pkt;
552
553 struct nvsp_message revoke_packet;
554 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
555
556 struct net_device *ndev;
557
558 /* Holds rndis device info */
559 void *extension;
560 /* The recive buffer for this device */
561 unsigned char cb_buffer[NETVSC_PACKET_SIZE];
562};
563
564/* NdisInitialize message */
565struct rndis_initialize_request {
566 u32 req_id;
567 u32 major_ver;
568 u32 minor_ver;
569 u32 max_xfer_size;
570};
571
572/* Response to NdisInitialize */
573struct rndis_initialize_complete {
574 u32 req_id;
575 u32 status;
576 u32 major_ver;
577 u32 minor_ver;
578 u32 dev_flags;
579 u32 medium;
580 u32 max_pkt_per_msg;
581 u32 max_xfer_size;
582 u32 pkt_alignment_factor;
583 u32 af_list_offset;
584 u32 af_list_size;
585};
586
587/* Call manager devices only: Information about an address family */
588/* supported by the device is appended to the response to NdisInitialize. */
589struct rndis_co_address_family {
590 u32 address_family;
591 u32 major_ver;
592 u32 minor_ver;
593};
594
595/* NdisHalt message */
596struct rndis_halt_request {
597 u32 req_id;
598};
599
600/* NdisQueryRequest message */
601struct rndis_query_request {
602 u32 req_id;
603 u32 oid;
604 u32 info_buflen;
605 u32 info_buf_offset;
606 u32 dev_vc_handle;
607};
608
609/* Response to NdisQueryRequest */
610struct rndis_query_complete {
611 u32 req_id;
612 u32 status;
613 u32 info_buflen;
614 u32 info_buf_offset;
615};
616
617/* NdisSetRequest message */
618struct rndis_set_request {
619 u32 req_id;
620 u32 oid;
621 u32 info_buflen;
622 u32 info_buf_offset;
623 u32 dev_vc_handle;
624};
625
626/* Response to NdisSetRequest */
627struct rndis_set_complete {
628 u32 req_id;
629 u32 status;
630};
631
632/* NdisReset message */
633struct rndis_reset_request {
634 u32 reserved;
635};
636
637/* Response to NdisReset */
638struct rndis_reset_complete {
639 u32 status;
640 u32 addressing_reset;
641};
642
643/* NdisMIndicateStatus message */
644struct rndis_indicate_status {
645 u32 status;
646 u32 status_buflen;
647 u32 status_buf_offset;
648};
649
650/* Diagnostic information passed as the status buffer in */
651/* struct rndis_indicate_status messages signifying error conditions. */
652struct rndis_diagnostic_info {
653 u32 diag_status;
654 u32 error_offset;
655};
656
657/* NdisKeepAlive message */
658struct rndis_keepalive_request {
659 u32 req_id;
660};
661
662/* Response to NdisKeepAlive */
663struct rndis_keepalive_complete {
664 u32 req_id;
665 u32 status;
666};
667
668/*
669 * Data message. All Offset fields contain byte offsets from the beginning of
670 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
671 * to 0 for connectionless data, otherwise it contains the VC handle.
672 */
673struct rndis_packet {
674 u32 data_offset;
675 u32 data_len;
676 u32 oob_data_offset;
677 u32 oob_data_len;
678 u32 num_oob_data_elements;
679 u32 per_pkt_info_offset;
680 u32 per_pkt_info_len;
681 u32 vc_handle;
682 u32 reserved;
683};
684
685/* Optional Out of Band data associated with a Data message. */
686struct rndis_oobd {
687 u32 size;
688 u32 type;
689 u32 class_info_offset;
690};
691
692/* Packet extension field contents associated with a Data message. */
693struct rndis_per_packet_info {
694 u32 size;
695 u32 type;
696 u32 ppi_offset;
697};
698
699enum ndis_per_pkt_info_type {
700 TCPIP_CHKSUM_PKTINFO,
701 IPSEC_PKTINFO,
702 TCP_LARGESEND_PKTINFO,
703 CLASSIFICATION_HANDLE_PKTINFO,
704 NDIS_RESERVED,
705 SG_LIST_PKTINFO,
706 IEEE_8021Q_INFO,
707 ORIGINAL_PKTINFO,
708 PACKET_CANCEL_ID,
709 ORIGINAL_NET_BUFLIST,
710 CACHED_NET_BUFLIST,
711 SHORT_PKT_PADINFO,
712 MAX_PER_PKT_INFO
713};
714
715struct ndis_pkt_8021q_info {
716 union {
717 struct {
718 u32 pri:3; /* User Priority */
719 u32 cfi:1; /* Canonical Format ID */
720 u32 vlanid:12; /* VLAN ID */
721 u32 reserved:16;
722 };
723 u32 value;
724 };
725};
726
727struct ndis_oject_header {
728 u8 type;
729 u8 revision;
730 u16 size;
731};
732
733#define NDIS_OBJECT_TYPE_DEFAULT 0x80
734#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
735#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
736#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
737#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
738#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
739#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
740#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
741#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
742#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
743#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
744#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
745
746#define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
747#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
748#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
749
750#define VERSION_4_OFFLOAD_SIZE 22
751/*
752 * New offload OIDs for NDIS 6
753 */
754#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
755#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
756#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
757#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
758#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
759#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
760
761struct ndis_offload_params {
762 struct ndis_oject_header header;
763 u8 ip_v4_csum;
764 u8 tcp_ip_v4_csum;
765 u8 udp_ip_v4_csum;
766 u8 tcp_ip_v6_csum;
767 u8 udp_ip_v6_csum;
768 u8 lso_v1;
769 u8 ip_sec_v1;
770 u8 lso_v2_ipv4;
771 u8 lso_v2_ipv6;
772 u8 tcp_connection_ip_v4;
773 u8 tcp_connection_ip_v6;
774 u32 flags;
775 u8 ip_sec_v2;
776 u8 ip_sec_v2_ip_v4;
777 struct {
778 u8 rsc_ip_v4;
779 u8 rsc_ip_v6;
780 };
781 struct {
782 u8 encapsulated_packet_task_offload;
783 u8 encapsulation_types;
784 };
785};
786
787struct ndis_tcp_ip_checksum_info {
788 union {
789 struct {
790 u32 is_ipv4:1;
791 u32 is_ipv6:1;
792 u32 tcp_checksum:1;
793 u32 udp_checksum:1;
794 u32 ip_header_checksum:1;
795 u32 reserved:11;
796 u32 tcp_header_offset:10;
797 } transmit;
798 struct {
799 u32 tcp_checksum_failed:1;
800 u32 udp_checksum_failed:1;
801 u32 ip_checksum_failed:1;
802 u32 tcp_checksum_succeeded:1;
803 u32 udp_checksum_succeeded:1;
804 u32 ip_checksum_succeeded:1;
805 u32 loopback:1;
806 u32 tcp_checksum_value_invalid:1;
807 u32 ip_checksum_value_invalid:1;
808 } receive;
809 u32 value;
810 };
811};
812
813struct ndis_tcp_lso_info {
814 union {
815 struct {
816 u32 unused:30;
817 u32 type:1;
818 u32 reserved2:1;
819 } transmit;
820 struct {
821 u32 mss:20;
822 u32 tcp_header_offset:10;
823 u32 type:1;
824 u32 reserved2:1;
825 } lso_v1_transmit;
826 struct {
827 u32 tcp_payload:30;
828 u32 type:1;
829 u32 reserved2:1;
830 } lso_v1_transmit_complete;
831 struct {
832 u32 mss:20;
833 u32 tcp_header_offset:10;
834 u32 type:1;
835 u32 ip_version:1;
836 } lso_v2_transmit;
837 struct {
838 u32 reserved:30;
839 u32 type:1;
840 u32 reserved2:1;
841 } lso_v2_transmit_complete;
842 u32 value;
843 };
844};
845
846#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
847 sizeof(struct ndis_pkt_8021q_info))
848
849#define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
850 sizeof(struct ndis_tcp_ip_checksum_info))
851
852#define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
853 sizeof(struct ndis_tcp_lso_info))
854
855/* Format of Information buffer passed in a SetRequest for the OID */
856/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
857struct rndis_config_parameter_info {
858 u32 parameter_name_offset;
859 u32 parameter_name_length;
860 u32 parameter_type;
861 u32 parameter_value_offset;
862 u32 parameter_value_length;
863};
864
865/* Values for ParameterType in struct rndis_config_parameter_info */
866#define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
867#define RNDIS_CONFIG_PARAM_TYPE_STRING 2
868
869/* CONDIS Miniport messages for connection oriented devices */
870/* that do not implement a call manager. */
871
872/* CoNdisMiniportCreateVc message */
873struct rcondis_mp_create_vc {
874 u32 req_id;
875 u32 ndis_vc_handle;
876};
877
878/* Response to CoNdisMiniportCreateVc */
879struct rcondis_mp_create_vc_complete {
880 u32 req_id;
881 u32 dev_vc_handle;
882 u32 status;
883};
884
885/* CoNdisMiniportDeleteVc message */
886struct rcondis_mp_delete_vc {
887 u32 req_id;
888 u32 dev_vc_handle;
889};
890
891/* Response to CoNdisMiniportDeleteVc */
892struct rcondis_mp_delete_vc_complete {
893 u32 req_id;
894 u32 status;
895};
896
897/* CoNdisMiniportQueryRequest message */
898struct rcondis_mp_query_request {
899 u32 req_id;
900 u32 request_type;
901 u32 oid;
902 u32 dev_vc_handle;
903 u32 info_buflen;
904 u32 info_buf_offset;
905};
906
907/* CoNdisMiniportSetRequest message */
908struct rcondis_mp_set_request {
909 u32 req_id;
910 u32 request_type;
911 u32 oid;
912 u32 dev_vc_handle;
913 u32 info_buflen;
914 u32 info_buf_offset;
915};
916
917/* CoNdisIndicateStatus message */
918struct rcondis_indicate_status {
919 u32 ndis_vc_handle;
920 u32 status;
921 u32 status_buflen;
922 u32 status_buf_offset;
923};
924
925/* CONDIS Call/VC parameters */
926struct rcondis_specific_parameters {
927 u32 parameter_type;
928 u32 parameter_length;
929 u32 parameter_lffset;
930};
931
932struct rcondis_media_parameters {
933 u32 flags;
934 u32 reserved1;
935 u32 reserved2;
936 struct rcondis_specific_parameters media_specific;
937};
938
939struct rndis_flowspec {
940 u32 token_rate;
941 u32 token_bucket_size;
942 u32 peak_bandwidth;
943 u32 latency;
944 u32 delay_variation;
945 u32 service_type;
946 u32 max_sdu_size;
947 u32 minimum_policed_size;
948};
949
950struct rcondis_call_manager_parameters {
951 struct rndis_flowspec transmit;
952 struct rndis_flowspec receive;
953 struct rcondis_specific_parameters call_mgr_specific;
954};
955
956/* CoNdisMiniportActivateVc message */
957struct rcondis_mp_activate_vc_request {
958 u32 req_id;
959 u32 flags;
960 u32 dev_vc_handle;
961 u32 media_params_offset;
962 u32 media_params_length;
963 u32 call_mgr_params_offset;
964 u32 call_mgr_params_length;
965};
966
967/* Response to CoNdisMiniportActivateVc */
968struct rcondis_mp_activate_vc_complete {
969 u32 req_id;
970 u32 status;
971};
972
973/* CoNdisMiniportDeactivateVc message */
974struct rcondis_mp_deactivate_vc_request {
975 u32 req_id;
976 u32 flags;
977 u32 dev_vc_handle;
978};
979
980/* Response to CoNdisMiniportDeactivateVc */
981struct rcondis_mp_deactivate_vc_complete {
982 u32 req_id;
983 u32 status;
984};
985
986
987/* union with all of the RNDIS messages */
988union rndis_message_container {
989 struct rndis_packet pkt;
990 struct rndis_initialize_request init_req;
991 struct rndis_halt_request halt_req;
992 struct rndis_query_request query_req;
993 struct rndis_set_request set_req;
994 struct rndis_reset_request reset_req;
995 struct rndis_keepalive_request keep_alive_req;
996 struct rndis_indicate_status indicate_status;
997 struct rndis_initialize_complete init_complete;
998 struct rndis_query_complete query_complete;
999 struct rndis_set_complete set_complete;
1000 struct rndis_reset_complete reset_complete;
1001 struct rndis_keepalive_complete keep_alive_complete;
1002 struct rcondis_mp_create_vc co_miniport_create_vc;
1003 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1004 struct rcondis_indicate_status co_indicate_status;
1005 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1006 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1007 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1008 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1009 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1010 struct rcondis_mp_deactivate_vc_complete
1011 co_miniport_deactivate_vc_complete;
1012};
1013
1014/* Remote NDIS message format */
1015struct rndis_message {
1016 u32 ndis_msg_type;
1017
1018 /* Total length of this message, from the beginning */
1019 /* of the sruct rndis_message, in bytes. */
1020 u32 msg_len;
1021
1022 /* Actual message */
1023 union rndis_message_container msg;
1024};
1025
1026
1027/* Handy macros */
1028
1029/* get the size of an RNDIS message. Pass in the message type, */
1030/* struct rndis_set_request, struct rndis_packet for example */
1031#define RNDIS_MESSAGE_SIZE(msg) \
1032 (sizeof(msg) + (sizeof(struct rndis_message) - \
1033 sizeof(union rndis_message_container)))
1034
1035/* get pointer to info buffer with message pointer */
1036#define MESSAGE_TO_INFO_BUFFER(msg) \
1037 (((unsigned char *)(msg)) + msg->info_buf_offset)
1038
1039/* get pointer to status buffer with message pointer */
1040#define MESSAGE_TO_STATUS_BUFFER(msg) \
1041 (((unsigned char *)(msg)) + msg->status_buf_offset)
1042
1043/* get pointer to OOBD buffer with message pointer */
1044#define MESSAGE_TO_OOBD_BUFFER(msg) \
1045 (((unsigned char *)(msg)) + msg->oob_data_offset)
1046
1047/* get pointer to data buffer with message pointer */
1048#define MESSAGE_TO_DATA_BUFFER(msg) \
1049 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1050
1051/* get pointer to contained message from NDIS_MESSAGE pointer */
1052#define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1053 ((void *) &rndis_msg->msg)
1054
1055/* get pointer to contained message from NDIS_MESSAGE pointer */
1056#define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1057 ((void *) rndis_msg)
1058
1059
1060#define __struct_bcount(x)
1061
1062
1063
1064#define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1065 sizeof(union rndis_message_container))
1066
1067#define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1068#define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1069#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1070#define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1071#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1072#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1073#define NDIS_PACKET_TYPE_SMT 0x00000040
1074#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1075#define NDIS_PACKET_TYPE_GROUP 0x00000100
1076#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1077#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1078#define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1079
1080#define INFO_IPV4 2
1081#define INFO_IPV6 4
1082#define INFO_TCP 2
1083#define INFO_UDP 4
1084
1085#define TRANSPORT_INFO_NOT_IP 0
1086#define TRANSPORT_INFO_IPV4_TCP ((INFO_IPV4 << 16) | INFO_TCP)
1087#define TRANSPORT_INFO_IPV4_UDP ((INFO_IPV4 << 16) | INFO_UDP)
1088#define TRANSPORT_INFO_IPV6_TCP ((INFO_IPV6 << 16) | INFO_TCP)
1089#define TRANSPORT_INFO_IPV6_UDP ((INFO_IPV6 << 16) | INFO_UDP)
1090
1091
1092#endif /* _HYPERV_NET_H */
1/*
2 *
3 * Copyright (c) 2011, Microsoft Corporation.
4 *
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.
8 *
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
12 * more details.
13 *
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/>.
16 *
17 * Authors:
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 * K. Y. Srinivasan <kys@microsoft.com>
21 *
22 */
23
24#ifndef _HYPERV_NET_H
25#define _HYPERV_NET_H
26
27#include <linux/list.h>
28#include <linux/hyperv.h>
29#include <linux/rndis.h>
30
31/* RSS related */
32#define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203 /* query only */
33#define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204 /* query and set */
34
35#define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88
36#define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89
37#define NDIS_OBJECT_TYPE_OFFLOAD 0xa7
38
39#define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
40#define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
41
42struct ndis_obj_header {
43 u8 type;
44 u8 rev;
45 u16 size;
46} __packed;
47
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
58
59struct ndis_recv_scale_cap { /* NDIS_RECEIVE_SCALE_CAPABILITIES */
60 struct ndis_obj_header hdr;
61 u32 cap_flag;
62 u32 num_int_msg;
63 u32 num_recv_que;
64 u16 num_indirect_tabent;
65} __packed;
66
67
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
74
75/* Hash info bits */
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
83
84#define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
85#define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2 40
86
87#define ITAB_NUM 128
88
89struct ndis_recv_scale_param { /* NDIS_RECEIVE_SCALE_PARAMETERS */
90 struct ndis_obj_header hdr;
91
92 /* Qualifies the rest of the information */
93 u16 flag;
94
95 /* The base CPU number to do receive processing. not used */
96 u16 base_cpu_number;
97
98 /* This describes the hash function and type being enabled */
99 u32 hashinfo;
100
101 /* The size of indirection table array */
102 u16 indirect_tabsize;
103
104 /* The offset of the indirection table from the beginning of this
105 * structure
106 */
107 u32 indirect_taboffset;
108
109 /* The size of the hash secret key */
110 u16 hashkey_size;
111
112 /* The offset of the secret key from the beginning of this structure */
113 u32 kashkey_offset;
114
115 u32 processor_masks_offset;
116 u32 num_processor_masks;
117 u32 processor_masks_entry_size;
118};
119
120/* Fwd declaration */
121struct ndis_tcp_ip_checksum_info;
122struct ndis_pkt_8021q_info;
123
124/*
125 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
126 * within the RNDIS
127 *
128 * The size of this structure is less than 48 bytes and we can now
129 * place this structure in the skb->cb field.
130 */
131struct hv_netvsc_packet {
132 /* Bookkeeping stuff */
133 u8 cp_partial; /* partial copy into send buffer */
134
135 u8 rmsg_size; /* RNDIS header and PPI size */
136 u8 rmsg_pgcnt; /* page count of RNDIS header and PPI */
137 u8 page_buf_cnt;
138
139 u16 q_idx;
140 u16 total_packets;
141
142 u32 total_bytes;
143 u32 send_buf_index;
144 u32 total_data_buflen;
145};
146
147struct netvsc_device_info {
148 unsigned char mac_adr[ETH_ALEN];
149 u32 num_chn;
150 u32 send_sections;
151 u32 recv_sections;
152 u32 send_section_size;
153 u32 recv_section_size;
154};
155
156enum rndis_device_state {
157 RNDIS_DEV_UNINITIALIZED = 0,
158 RNDIS_DEV_INITIALIZING,
159 RNDIS_DEV_INITIALIZED,
160 RNDIS_DEV_DATAINITIALIZED,
161};
162
163#define NETVSC_HASH_KEYLEN 40
164
165struct rndis_device {
166 struct net_device *ndev;
167
168 enum rndis_device_state state;
169
170 atomic_t new_req_id;
171
172 spinlock_t request_lock;
173 struct list_head req_list;
174
175 struct work_struct mcast_work;
176 u32 filter;
177
178 bool link_state; /* 0 - link up, 1 - link down */
179
180 u8 hw_mac_adr[ETH_ALEN];
181 u8 rss_key[NETVSC_HASH_KEYLEN];
182 u16 rx_table[ITAB_NUM];
183};
184
185
186/* Interface */
187struct rndis_message;
188struct netvsc_device;
189struct net_device_context;
190
191extern u32 netvsc_ring_bytes;
192extern struct reciprocal_value netvsc_ring_reciprocal;
193
194struct netvsc_device *netvsc_device_add(struct hv_device *device,
195 const struct netvsc_device_info *info);
196int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
197void netvsc_device_remove(struct hv_device *device);
198int netvsc_send(struct net_device *net,
199 struct hv_netvsc_packet *packet,
200 struct rndis_message *rndis_msg,
201 struct hv_page_buffer *page_buffer,
202 struct sk_buff *skb);
203void netvsc_linkstatus_callback(struct net_device *net,
204 struct rndis_message *resp);
205int netvsc_recv_callback(struct net_device *net,
206 struct netvsc_device *nvdev,
207 struct vmbus_channel *channel,
208 void *data, u32 len,
209 const struct ndis_tcp_ip_checksum_info *csum_info,
210 const struct ndis_pkt_8021q_info *vlan);
211void netvsc_channel_cb(void *context);
212int netvsc_poll(struct napi_struct *napi, int budget);
213
214void rndis_set_subchannel(struct work_struct *w);
215int rndis_filter_open(struct netvsc_device *nvdev);
216int rndis_filter_close(struct netvsc_device *nvdev);
217struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
218 struct netvsc_device_info *info);
219void rndis_filter_update(struct netvsc_device *nvdev);
220void rndis_filter_device_remove(struct hv_device *dev,
221 struct netvsc_device *nvdev);
222int rndis_filter_set_rss_param(struct rndis_device *rdev,
223 const u8 *key);
224int rndis_filter_receive(struct net_device *ndev,
225 struct netvsc_device *net_dev,
226 struct vmbus_channel *channel,
227 void *data, u32 buflen);
228
229int rndis_filter_set_device_mac(struct netvsc_device *ndev,
230 const char *mac);
231
232void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
233
234#define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
235
236#define NVSP_PROTOCOL_VERSION_1 2
237#define NVSP_PROTOCOL_VERSION_2 0x30002
238#define NVSP_PROTOCOL_VERSION_4 0x40000
239#define NVSP_PROTOCOL_VERSION_5 0x50000
240
241enum {
242 NVSP_MSG_TYPE_NONE = 0,
243
244 /* Init Messages */
245 NVSP_MSG_TYPE_INIT = 1,
246 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
247
248 NVSP_VERSION_MSG_START = 100,
249
250 /* Version 1 Messages */
251 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
252
253 NVSP_MSG1_TYPE_SEND_RECV_BUF,
254 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
255 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
256
257 NVSP_MSG1_TYPE_SEND_SEND_BUF,
258 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
259 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
260
261 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
262 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
263
264 /* Version 2 messages */
265 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
266 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
267 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
268
269 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
270
271 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
272 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
273
274 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
275
276 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
277 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
278
279 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
280 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
281
282 NVSP_MSG2_TYPE_ALLOC_RXBUF,
283 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
284
285 NVSP_MSG2_TYPE_FREE_RXBUF,
286
287 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
288 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
289
290 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
291
292 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
293 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
294
295 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
296
297 /* Version 4 messages */
298 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
299 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
300 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
301
302 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
303
304 /* Version 5 messages */
305 NVSP_MSG5_TYPE_OID_QUERY_EX,
306 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
307 NVSP_MSG5_TYPE_SUBCHANNEL,
308 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
309
310 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
311};
312
313enum {
314 NVSP_STAT_NONE = 0,
315 NVSP_STAT_SUCCESS,
316 NVSP_STAT_FAIL,
317 NVSP_STAT_PROTOCOL_TOO_NEW,
318 NVSP_STAT_PROTOCOL_TOO_OLD,
319 NVSP_STAT_INVALID_RNDIS_PKT,
320 NVSP_STAT_BUSY,
321 NVSP_STAT_PROTOCOL_UNSUPPORTED,
322 NVSP_STAT_MAX,
323};
324
325struct nvsp_message_header {
326 u32 msg_type;
327};
328
329/* Init Messages */
330
331/*
332 * This message is used by the VSC to initialize the channel after the channels
333 * has been opened. This message should never include anything other then
334 * versioning (i.e. this message will be the same for ever).
335 */
336struct nvsp_message_init {
337 u32 min_protocol_ver;
338 u32 max_protocol_ver;
339} __packed;
340
341/*
342 * This message is used by the VSP to complete the initialization of the
343 * channel. This message should never include anything other then versioning
344 * (i.e. this message will be the same for ever).
345 */
346struct nvsp_message_init_complete {
347 u32 negotiated_protocol_ver;
348 u32 max_mdl_chain_len;
349 u32 status;
350} __packed;
351
352union nvsp_message_init_uber {
353 struct nvsp_message_init init;
354 struct nvsp_message_init_complete init_complete;
355} __packed;
356
357/* Version 1 Messages */
358
359/*
360 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
361 * can use this information when handling OIDs sent by the VSC.
362 */
363struct nvsp_1_message_send_ndis_version {
364 u32 ndis_major_ver;
365 u32 ndis_minor_ver;
366} __packed;
367
368/*
369 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
370 * can then use the receive buffer to send data to the VSC.
371 */
372struct nvsp_1_message_send_receive_buffer {
373 u32 gpadl_handle;
374 u16 id;
375} __packed;
376
377struct nvsp_1_receive_buffer_section {
378 u32 offset;
379 u32 sub_alloc_size;
380 u32 num_sub_allocs;
381 u32 end_offset;
382} __packed;
383
384/*
385 * This message is used by the VSP to acknowledge a receive buffer send by the
386 * VSC. This message must be sent by the VSP before the VSP uses the receive
387 * buffer.
388 */
389struct nvsp_1_message_send_receive_buffer_complete {
390 u32 status;
391 u32 num_sections;
392
393 /*
394 * The receive buffer is split into two parts, a large suballocation
395 * section and a small suballocation section. These sections are then
396 * suballocated by a certain size.
397 */
398
399 /*
400 * For example, the following break up of the receive buffer has 6
401 * large suballocations and 10 small suballocations.
402 */
403
404 /*
405 * | Large Section | | Small Section |
406 * ------------------------------------------------------------
407 * | | | | | | | | | | | | | | | | | |
408 * | |
409 * LargeOffset SmallOffset
410 */
411
412 struct nvsp_1_receive_buffer_section sections[1];
413} __packed;
414
415/*
416 * This message is sent by the VSC to revoke the receive buffer. After the VSP
417 * completes this transaction, the vsp should never use the receive buffer
418 * again.
419 */
420struct nvsp_1_message_revoke_receive_buffer {
421 u16 id;
422};
423
424/*
425 * This message is used by the VSC to send a send buffer to the VSP. The VSC
426 * can then use the send buffer to send data to the VSP.
427 */
428struct nvsp_1_message_send_send_buffer {
429 u32 gpadl_handle;
430 u16 id;
431} __packed;
432
433/*
434 * This message is used by the VSP to acknowledge a send buffer sent by the
435 * VSC. This message must be sent by the VSP before the VSP uses the sent
436 * buffer.
437 */
438struct nvsp_1_message_send_send_buffer_complete {
439 u32 status;
440
441 /*
442 * The VSC gets to choose the size of the send buffer and the VSP gets
443 * to choose the sections size of the buffer. This was done to enable
444 * dynamic reconfigurations when the cost of GPA-direct buffers
445 * decreases.
446 */
447 u32 section_size;
448} __packed;
449
450/*
451 * This message is sent by the VSC to revoke the send buffer. After the VSP
452 * completes this transaction, the vsp should never use the send buffer again.
453 */
454struct nvsp_1_message_revoke_send_buffer {
455 u16 id;
456};
457
458/*
459 * This message is used by both the VSP and the VSC to send a RNDIS message to
460 * the opposite channel endpoint.
461 */
462struct nvsp_1_message_send_rndis_packet {
463 /*
464 * This field is specified by RNDIS. They assume there's two different
465 * channels of communication. However, the Network VSP only has one.
466 * Therefore, the channel travels with the RNDIS packet.
467 */
468 u32 channel_type;
469
470 /*
471 * This field is used to send part or all of the data through a send
472 * buffer. This values specifies an index into the send buffer. If the
473 * index is 0xFFFFFFFF, then the send buffer is not being used and all
474 * of the data was sent through other VMBus mechanisms.
475 */
476 u32 send_buf_section_index;
477 u32 send_buf_section_size;
478} __packed;
479
480/*
481 * This message is used by both the VSP and the VSC to complete a RNDIS message
482 * to the opposite channel endpoint. At this point, the initiator of this
483 * message cannot use any resources associated with the original RNDIS packet.
484 */
485struct nvsp_1_message_send_rndis_packet_complete {
486 u32 status;
487};
488
489union nvsp_1_message_uber {
490 struct nvsp_1_message_send_ndis_version send_ndis_ver;
491
492 struct nvsp_1_message_send_receive_buffer send_recv_buf;
493 struct nvsp_1_message_send_receive_buffer_complete
494 send_recv_buf_complete;
495 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
496
497 struct nvsp_1_message_send_send_buffer send_send_buf;
498 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
499 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
500
501 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
502 struct nvsp_1_message_send_rndis_packet_complete
503 send_rndis_pkt_complete;
504} __packed;
505
506
507/*
508 * Network VSP protocol version 2 messages:
509 */
510struct nvsp_2_vsc_capability {
511 union {
512 u64 data;
513 struct {
514 u64 vmq:1;
515 u64 chimney:1;
516 u64 sriov:1;
517 u64 ieee8021q:1;
518 u64 correlation_id:1;
519 u64 teaming:1;
520 };
521 };
522} __packed;
523
524struct nvsp_2_send_ndis_config {
525 u32 mtu;
526 u32 reserved;
527 struct nvsp_2_vsc_capability capability;
528} __packed;
529
530/* Allocate receive buffer */
531struct nvsp_2_alloc_rxbuf {
532 /* Allocation ID to match the allocation request and response */
533 u32 alloc_id;
534
535 /* Length of the VM shared memory receive buffer that needs to
536 * be allocated
537 */
538 u32 len;
539} __packed;
540
541/* Allocate receive buffer complete */
542struct nvsp_2_alloc_rxbuf_comp {
543 /* The NDIS_STATUS code for buffer allocation */
544 u32 status;
545
546 u32 alloc_id;
547
548 /* GPADL handle for the allocated receive buffer */
549 u32 gpadl_handle;
550
551 /* Receive buffer ID */
552 u64 recv_buf_id;
553} __packed;
554
555struct nvsp_2_free_rxbuf {
556 u64 recv_buf_id;
557} __packed;
558
559union nvsp_2_message_uber {
560 struct nvsp_2_send_ndis_config send_ndis_config;
561 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
562 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
563 struct nvsp_2_free_rxbuf free_rxbuf;
564} __packed;
565
566struct nvsp_4_send_vf_association {
567 /* 1: allocated, serial number is valid. 0: not allocated */
568 u32 allocated;
569
570 /* Serial number of the VF to team with */
571 u32 serial;
572} __packed;
573
574enum nvsp_vm_datapath {
575 NVSP_DATAPATH_SYNTHETIC = 0,
576 NVSP_DATAPATH_VF,
577 NVSP_DATAPATH_MAX
578};
579
580struct nvsp_4_sw_datapath {
581 u32 active_datapath; /* active data path in VM */
582} __packed;
583
584union nvsp_4_message_uber {
585 struct nvsp_4_send_vf_association vf_assoc;
586 struct nvsp_4_sw_datapath active_dp;
587} __packed;
588
589enum nvsp_subchannel_operation {
590 NVSP_SUBCHANNEL_NONE = 0,
591 NVSP_SUBCHANNEL_ALLOCATE,
592 NVSP_SUBCHANNEL_MAX
593};
594
595struct nvsp_5_subchannel_request {
596 u32 op;
597 u32 num_subchannels;
598} __packed;
599
600struct nvsp_5_subchannel_complete {
601 u32 status;
602 u32 num_subchannels; /* Actual number of subchannels allocated */
603} __packed;
604
605struct nvsp_5_send_indirect_table {
606 /* The number of entries in the send indirection table */
607 u32 count;
608
609 /* The offset of the send indirection table from top of this struct.
610 * The send indirection table tells which channel to put the send
611 * traffic on. Each entry is a channel number.
612 */
613 u32 offset;
614} __packed;
615
616union nvsp_5_message_uber {
617 struct nvsp_5_subchannel_request subchn_req;
618 struct nvsp_5_subchannel_complete subchn_comp;
619 struct nvsp_5_send_indirect_table send_table;
620} __packed;
621
622union nvsp_all_messages {
623 union nvsp_message_init_uber init_msg;
624 union nvsp_1_message_uber v1_msg;
625 union nvsp_2_message_uber v2_msg;
626 union nvsp_4_message_uber v4_msg;
627 union nvsp_5_message_uber v5_msg;
628} __packed;
629
630/* ALL Messages */
631struct nvsp_message {
632 struct nvsp_message_header hdr;
633 union nvsp_all_messages msg;
634} __packed;
635
636
637#define NETVSC_MTU 65535
638#define NETVSC_MTU_MIN ETH_MIN_MTU
639
640/* Max buffer sizes allowed by a host */
641#define NETVSC_RECEIVE_BUFFER_SIZE (1024 * 1024 * 31) /* 31MB */
642#define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024 * 1024 * 15) /* 15MB */
643#define NETVSC_RECEIVE_BUFFER_DEFAULT (1024 * 1024 * 16)
644
645#define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
646#define NETVSC_SEND_BUFFER_DEFAULT (1024 * 1024)
647
648#define NETVSC_INVALID_INDEX -1
649
650#define NETVSC_SEND_SECTION_SIZE 6144
651#define NETVSC_RECV_SECTION_SIZE 1728
652
653/* Default size of TX buf: 1MB, RX buf: 16MB */
654#define NETVSC_MIN_TX_SECTIONS 10
655#define NETVSC_DEFAULT_TX (NETVSC_SEND_BUFFER_DEFAULT \
656 / NETVSC_SEND_SECTION_SIZE)
657#define NETVSC_MIN_RX_SECTIONS 10
658#define NETVSC_DEFAULT_RX (NETVSC_RECEIVE_BUFFER_DEFAULT \
659 / NETVSC_RECV_SECTION_SIZE)
660
661#define NETVSC_RECEIVE_BUFFER_ID 0xcafe
662#define NETVSC_SEND_BUFFER_ID 0
663
664#define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
665 NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
666 NETIF_F_TSO6)
667
668#define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
669#define VRSS_CHANNEL_MAX 64
670#define VRSS_CHANNEL_DEFAULT 8
671
672#define RNDIS_MAX_PKT_DEFAULT 8
673#define RNDIS_PKT_ALIGN_DEFAULT 8
674
675struct multi_send_data {
676 struct sk_buff *skb; /* skb containing the pkt */
677 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
678 u32 count; /* counter of batched packets */
679};
680
681struct recv_comp_data {
682 u64 tid; /* transaction id */
683 u32 status;
684};
685
686struct multi_recv_comp {
687 struct recv_comp_data *slots;
688 u32 first; /* first data entry */
689 u32 next; /* next entry for writing */
690};
691
692struct netvsc_stats {
693 u64 packets;
694 u64 bytes;
695 u64 broadcast;
696 u64 multicast;
697 struct u64_stats_sync syncp;
698};
699
700struct netvsc_ethtool_stats {
701 unsigned long tx_scattered;
702 unsigned long tx_no_memory;
703 unsigned long tx_no_space;
704 unsigned long tx_too_big;
705 unsigned long tx_busy;
706 unsigned long tx_send_full;
707 unsigned long rx_comp_busy;
708 unsigned long rx_no_memory;
709 unsigned long stop_queue;
710 unsigned long wake_queue;
711};
712
713struct netvsc_vf_pcpu_stats {
714 u64 rx_packets;
715 u64 rx_bytes;
716 u64 tx_packets;
717 u64 tx_bytes;
718 struct u64_stats_sync syncp;
719 u32 tx_dropped;
720};
721
722struct netvsc_reconfig {
723 struct list_head list;
724 u32 event;
725};
726
727/* L4 hash bits for different protocols */
728#define HV_TCP4_L4HASH 1
729#define HV_TCP6_L4HASH 2
730#define HV_UDP4_L4HASH 4
731#define HV_UDP6_L4HASH 8
732#define HV_DEFAULT_L4HASH (HV_TCP4_L4HASH | HV_TCP6_L4HASH | HV_UDP4_L4HASH | \
733 HV_UDP6_L4HASH)
734
735/* The context of the netvsc device */
736struct net_device_context {
737 /* point back to our device context */
738 struct hv_device *device_ctx;
739 /* netvsc_device */
740 struct netvsc_device __rcu *nvdev;
741 /* reconfigure work */
742 struct delayed_work dwork;
743 /* last reconfig time */
744 unsigned long last_reconfig;
745 /* reconfig events */
746 struct list_head reconfig_events;
747 /* list protection */
748 spinlock_t lock;
749
750 u32 msg_enable; /* debug level */
751
752 u32 tx_checksum_mask;
753
754 u32 tx_table[VRSS_SEND_TAB_SIZE];
755
756 /* Ethtool settings */
757 u8 duplex;
758 u32 speed;
759 u32 l4_hash; /* L4 hash settings */
760 struct netvsc_ethtool_stats eth_stats;
761
762 /* State to manage the associated VF interface. */
763 struct net_device __rcu *vf_netdev;
764 struct netvsc_vf_pcpu_stats __percpu *vf_stats;
765 struct delayed_work vf_takeover;
766
767 /* 1: allocated, serial number is valid. 0: not allocated */
768 u32 vf_alloc;
769 /* Serial number of the VF to team with */
770 u32 vf_serial;
771};
772
773/* Per channel data */
774struct netvsc_channel {
775 struct vmbus_channel *channel;
776 struct netvsc_device *net_device;
777 const struct vmpacket_descriptor *desc;
778 struct napi_struct napi;
779 struct multi_send_data msd;
780 struct multi_recv_comp mrc;
781 atomic_t queue_sends;
782
783 struct netvsc_stats tx_stats;
784 struct netvsc_stats rx_stats;
785};
786
787/* Per netvsc device */
788struct netvsc_device {
789 u32 nvsp_version;
790
791 wait_queue_head_t wait_drain;
792 bool destroy;
793
794 /* Receive buffer allocated by us but manages by NetVSP */
795 void *recv_buf;
796 u32 recv_buf_size; /* allocated bytes */
797 u32 recv_buf_gpadl_handle;
798 u32 recv_section_cnt;
799 u32 recv_section_size;
800 u32 recv_completion_cnt;
801
802 /* Send buffer allocated by us */
803 void *send_buf;
804 u32 send_buf_gpadl_handle;
805 u32 send_section_cnt;
806 u32 send_section_size;
807 unsigned long *send_section_map;
808
809 /* Used for NetVSP initialization protocol */
810 struct completion channel_init_wait;
811 struct nvsp_message channel_init_pkt;
812
813 struct nvsp_message revoke_packet;
814
815 u32 max_chn;
816 u32 num_chn;
817
818 atomic_t open_chn;
819 struct work_struct subchan_work;
820 wait_queue_head_t subchan_open;
821
822 struct rndis_device *extension;
823
824 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
825 u32 pkt_align; /* alignment bytes, e.g. 8 */
826
827 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
828
829 struct rcu_head rcu;
830};
831
832/* NdisInitialize message */
833struct rndis_initialize_request {
834 u32 req_id;
835 u32 major_ver;
836 u32 minor_ver;
837 u32 max_xfer_size;
838};
839
840/* Response to NdisInitialize */
841struct rndis_initialize_complete {
842 u32 req_id;
843 u32 status;
844 u32 major_ver;
845 u32 minor_ver;
846 u32 dev_flags;
847 u32 medium;
848 u32 max_pkt_per_msg;
849 u32 max_xfer_size;
850 u32 pkt_alignment_factor;
851 u32 af_list_offset;
852 u32 af_list_size;
853};
854
855/* Call manager devices only: Information about an address family */
856/* supported by the device is appended to the response to NdisInitialize. */
857struct rndis_co_address_family {
858 u32 address_family;
859 u32 major_ver;
860 u32 minor_ver;
861};
862
863/* NdisHalt message */
864struct rndis_halt_request {
865 u32 req_id;
866};
867
868/* NdisQueryRequest message */
869struct rndis_query_request {
870 u32 req_id;
871 u32 oid;
872 u32 info_buflen;
873 u32 info_buf_offset;
874 u32 dev_vc_handle;
875};
876
877/* Response to NdisQueryRequest */
878struct rndis_query_complete {
879 u32 req_id;
880 u32 status;
881 u32 info_buflen;
882 u32 info_buf_offset;
883};
884
885/* NdisSetRequest message */
886struct rndis_set_request {
887 u32 req_id;
888 u32 oid;
889 u32 info_buflen;
890 u32 info_buf_offset;
891 u32 dev_vc_handle;
892};
893
894/* Response to NdisSetRequest */
895struct rndis_set_complete {
896 u32 req_id;
897 u32 status;
898};
899
900/* NdisReset message */
901struct rndis_reset_request {
902 u32 reserved;
903};
904
905/* Response to NdisReset */
906struct rndis_reset_complete {
907 u32 status;
908 u32 addressing_reset;
909};
910
911/* NdisMIndicateStatus message */
912struct rndis_indicate_status {
913 u32 status;
914 u32 status_buflen;
915 u32 status_buf_offset;
916};
917
918/* Diagnostic information passed as the status buffer in */
919/* struct rndis_indicate_status messages signifying error conditions. */
920struct rndis_diagnostic_info {
921 u32 diag_status;
922 u32 error_offset;
923};
924
925/* NdisKeepAlive message */
926struct rndis_keepalive_request {
927 u32 req_id;
928};
929
930/* Response to NdisKeepAlive */
931struct rndis_keepalive_complete {
932 u32 req_id;
933 u32 status;
934};
935
936/*
937 * Data message. All Offset fields contain byte offsets from the beginning of
938 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
939 * to 0 for connectionless data, otherwise it contains the VC handle.
940 */
941struct rndis_packet {
942 u32 data_offset;
943 u32 data_len;
944 u32 oob_data_offset;
945 u32 oob_data_len;
946 u32 num_oob_data_elements;
947 u32 per_pkt_info_offset;
948 u32 per_pkt_info_len;
949 u32 vc_handle;
950 u32 reserved;
951};
952
953/* Optional Out of Band data associated with a Data message. */
954struct rndis_oobd {
955 u32 size;
956 u32 type;
957 u32 class_info_offset;
958};
959
960/* Packet extension field contents associated with a Data message. */
961struct rndis_per_packet_info {
962 u32 size;
963 u32 type;
964 u32 ppi_offset;
965};
966
967enum ndis_per_pkt_info_type {
968 TCPIP_CHKSUM_PKTINFO,
969 IPSEC_PKTINFO,
970 TCP_LARGESEND_PKTINFO,
971 CLASSIFICATION_HANDLE_PKTINFO,
972 NDIS_RESERVED,
973 SG_LIST_PKTINFO,
974 IEEE_8021Q_INFO,
975 ORIGINAL_PKTINFO,
976 PACKET_CANCEL_ID,
977 NBL_HASH_VALUE = PACKET_CANCEL_ID,
978 ORIGINAL_NET_BUFLIST,
979 CACHED_NET_BUFLIST,
980 SHORT_PKT_PADINFO,
981 MAX_PER_PKT_INFO
982};
983
984struct ndis_pkt_8021q_info {
985 union {
986 struct {
987 u32 pri:3; /* User Priority */
988 u32 cfi:1; /* Canonical Format ID */
989 u32 vlanid:12; /* VLAN ID */
990 u32 reserved:16;
991 };
992 u32 value;
993 };
994};
995
996struct ndis_object_header {
997 u8 type;
998 u8 revision;
999 u16 size;
1000};
1001
1002#define NDIS_OBJECT_TYPE_DEFAULT 0x80
1003#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
1004#define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
1005#define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
1006
1007#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
1008#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
1009#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
1010#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
1011#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
1012#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1013#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1014#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1015#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1016#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1017
1018#define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
1019#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
1020#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
1021
1022#define VERSION_4_OFFLOAD_SIZE 22
1023/*
1024 * New offload OIDs for NDIS 6
1025 */
1026#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1027#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1028#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1029#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1030#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1031#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1032
1033/*
1034 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1035 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1036 */
1037
1038#define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1039#define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1040#define NDIS_OFFLOAD_ENCAP_8023 0x0002
1041#define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1042#define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1043#define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1044
1045struct ndis_csum_offload {
1046 u32 ip4_txenc;
1047 u32 ip4_txcsum;
1048#define NDIS_TXCSUM_CAP_IP4OPT 0x001
1049#define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1050#define NDIS_TXCSUM_CAP_TCP4 0x010
1051#define NDIS_TXCSUM_CAP_UDP4 0x040
1052#define NDIS_TXCSUM_CAP_IP4 0x100
1053
1054#define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1055
1056 u32 ip4_rxenc;
1057 u32 ip4_rxcsum;
1058#define NDIS_RXCSUM_CAP_IP4OPT 0x001
1059#define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1060#define NDIS_RXCSUM_CAP_TCP4 0x010
1061#define NDIS_RXCSUM_CAP_UDP4 0x040
1062#define NDIS_RXCSUM_CAP_IP4 0x100
1063 u32 ip6_txenc;
1064 u32 ip6_txcsum;
1065#define NDIS_TXCSUM_CAP_IP6EXT 0x001
1066#define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1067#define NDIS_TXCSUM_CAP_TCP6 0x010
1068#define NDIS_TXCSUM_CAP_UDP6 0x040
1069 u32 ip6_rxenc;
1070 u32 ip6_rxcsum;
1071#define NDIS_RXCSUM_CAP_IP6EXT 0x001
1072#define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1073#define NDIS_RXCSUM_CAP_TCP6 0x010
1074#define NDIS_RXCSUM_CAP_UDP6 0x040
1075
1076#define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1077 NDIS_TXCSUM_CAP_TCP6OPT | \
1078 NDIS_TXCSUM_CAP_IP6EXT)
1079};
1080
1081struct ndis_lsov1_offload {
1082 u32 encap;
1083 u32 maxsize;
1084 u32 minsegs;
1085 u32 opts;
1086};
1087
1088struct ndis_ipsecv1_offload {
1089 u32 encap;
1090 u32 ah_esp;
1091 u32 xport_tun;
1092 u32 ip4_opts;
1093 u32 flags;
1094 u32 ip4_ah;
1095 u32 ip4_esp;
1096};
1097
1098struct ndis_lsov2_offload {
1099 u32 ip4_encap;
1100 u32 ip4_maxsz;
1101 u32 ip4_minsg;
1102 u32 ip6_encap;
1103 u32 ip6_maxsz;
1104 u32 ip6_minsg;
1105 u32 ip6_opts;
1106#define NDIS_LSOV2_CAP_IP6EXT 0x001
1107#define NDIS_LSOV2_CAP_TCP6OPT 0x004
1108
1109#define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1110 NDIS_LSOV2_CAP_TCP6OPT)
1111};
1112
1113struct ndis_ipsecv2_offload {
1114 u32 encap;
1115 u16 ip6;
1116 u16 ip4opt;
1117 u16 ip6ext;
1118 u16 ah;
1119 u16 esp;
1120 u16 ah_esp;
1121 u16 xport;
1122 u16 tun;
1123 u16 xport_tun;
1124 u16 lso;
1125 u16 extseq;
1126 u32 udp_esp;
1127 u32 auth;
1128 u32 crypto;
1129 u32 sa_caps;
1130};
1131
1132struct ndis_rsc_offload {
1133 u16 ip4;
1134 u16 ip6;
1135};
1136
1137struct ndis_encap_offload {
1138 u32 flags;
1139 u32 maxhdr;
1140};
1141
1142struct ndis_offload {
1143 struct ndis_object_header header;
1144 struct ndis_csum_offload csum;
1145 struct ndis_lsov1_offload lsov1;
1146 struct ndis_ipsecv1_offload ipsecv1;
1147 struct ndis_lsov2_offload lsov2;
1148 u32 flags;
1149 /* NDIS >= 6.1 */
1150 struct ndis_ipsecv2_offload ipsecv2;
1151 /* NDIS >= 6.30 */
1152 struct ndis_rsc_offload rsc;
1153 struct ndis_encap_offload encap_gre;
1154};
1155
1156#define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1157#define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1158#define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1159
1160struct ndis_offload_params {
1161 struct ndis_object_header header;
1162 u8 ip_v4_csum;
1163 u8 tcp_ip_v4_csum;
1164 u8 udp_ip_v4_csum;
1165 u8 tcp_ip_v6_csum;
1166 u8 udp_ip_v6_csum;
1167 u8 lso_v1;
1168 u8 ip_sec_v1;
1169 u8 lso_v2_ipv4;
1170 u8 lso_v2_ipv6;
1171 u8 tcp_connection_ip_v4;
1172 u8 tcp_connection_ip_v6;
1173 u32 flags;
1174 u8 ip_sec_v2;
1175 u8 ip_sec_v2_ip_v4;
1176 struct {
1177 u8 rsc_ip_v4;
1178 u8 rsc_ip_v6;
1179 };
1180 struct {
1181 u8 encapsulated_packet_task_offload;
1182 u8 encapsulation_types;
1183 };
1184};
1185
1186struct ndis_tcp_ip_checksum_info {
1187 union {
1188 struct {
1189 u32 is_ipv4:1;
1190 u32 is_ipv6:1;
1191 u32 tcp_checksum:1;
1192 u32 udp_checksum:1;
1193 u32 ip_header_checksum:1;
1194 u32 reserved:11;
1195 u32 tcp_header_offset:10;
1196 } transmit;
1197 struct {
1198 u32 tcp_checksum_failed:1;
1199 u32 udp_checksum_failed:1;
1200 u32 ip_checksum_failed:1;
1201 u32 tcp_checksum_succeeded:1;
1202 u32 udp_checksum_succeeded:1;
1203 u32 ip_checksum_succeeded:1;
1204 u32 loopback:1;
1205 u32 tcp_checksum_value_invalid:1;
1206 u32 ip_checksum_value_invalid:1;
1207 } receive;
1208 u32 value;
1209 };
1210};
1211
1212struct ndis_tcp_lso_info {
1213 union {
1214 struct {
1215 u32 unused:30;
1216 u32 type:1;
1217 u32 reserved2:1;
1218 } transmit;
1219 struct {
1220 u32 mss:20;
1221 u32 tcp_header_offset:10;
1222 u32 type:1;
1223 u32 reserved2:1;
1224 } lso_v1_transmit;
1225 struct {
1226 u32 tcp_payload:30;
1227 u32 type:1;
1228 u32 reserved2:1;
1229 } lso_v1_transmit_complete;
1230 struct {
1231 u32 mss:20;
1232 u32 tcp_header_offset:10;
1233 u32 type:1;
1234 u32 ip_version:1;
1235 } lso_v2_transmit;
1236 struct {
1237 u32 reserved:30;
1238 u32 type:1;
1239 u32 reserved2:1;
1240 } lso_v2_transmit_complete;
1241 u32 value;
1242 };
1243};
1244
1245#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1246 sizeof(struct ndis_pkt_8021q_info))
1247
1248#define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1249 sizeof(struct ndis_tcp_ip_checksum_info))
1250
1251#define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1252 sizeof(struct ndis_tcp_lso_info))
1253
1254#define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1255 sizeof(u32))
1256
1257/* Total size of all PPI data */
1258#define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1259 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1260
1261/* Format of Information buffer passed in a SetRequest for the OID */
1262/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1263struct rndis_config_parameter_info {
1264 u32 parameter_name_offset;
1265 u32 parameter_name_length;
1266 u32 parameter_type;
1267 u32 parameter_value_offset;
1268 u32 parameter_value_length;
1269};
1270
1271/* Values for ParameterType in struct rndis_config_parameter_info */
1272#define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1273#define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1274
1275/* CONDIS Miniport messages for connection oriented devices */
1276/* that do not implement a call manager. */
1277
1278/* CoNdisMiniportCreateVc message */
1279struct rcondis_mp_create_vc {
1280 u32 req_id;
1281 u32 ndis_vc_handle;
1282};
1283
1284/* Response to CoNdisMiniportCreateVc */
1285struct rcondis_mp_create_vc_complete {
1286 u32 req_id;
1287 u32 dev_vc_handle;
1288 u32 status;
1289};
1290
1291/* CoNdisMiniportDeleteVc message */
1292struct rcondis_mp_delete_vc {
1293 u32 req_id;
1294 u32 dev_vc_handle;
1295};
1296
1297/* Response to CoNdisMiniportDeleteVc */
1298struct rcondis_mp_delete_vc_complete {
1299 u32 req_id;
1300 u32 status;
1301};
1302
1303/* CoNdisMiniportQueryRequest message */
1304struct rcondis_mp_query_request {
1305 u32 req_id;
1306 u32 request_type;
1307 u32 oid;
1308 u32 dev_vc_handle;
1309 u32 info_buflen;
1310 u32 info_buf_offset;
1311};
1312
1313/* CoNdisMiniportSetRequest message */
1314struct rcondis_mp_set_request {
1315 u32 req_id;
1316 u32 request_type;
1317 u32 oid;
1318 u32 dev_vc_handle;
1319 u32 info_buflen;
1320 u32 info_buf_offset;
1321};
1322
1323/* CoNdisIndicateStatus message */
1324struct rcondis_indicate_status {
1325 u32 ndis_vc_handle;
1326 u32 status;
1327 u32 status_buflen;
1328 u32 status_buf_offset;
1329};
1330
1331/* CONDIS Call/VC parameters */
1332struct rcondis_specific_parameters {
1333 u32 parameter_type;
1334 u32 parameter_length;
1335 u32 parameter_lffset;
1336};
1337
1338struct rcondis_media_parameters {
1339 u32 flags;
1340 u32 reserved1;
1341 u32 reserved2;
1342 struct rcondis_specific_parameters media_specific;
1343};
1344
1345struct rndis_flowspec {
1346 u32 token_rate;
1347 u32 token_bucket_size;
1348 u32 peak_bandwidth;
1349 u32 latency;
1350 u32 delay_variation;
1351 u32 service_type;
1352 u32 max_sdu_size;
1353 u32 minimum_policed_size;
1354};
1355
1356struct rcondis_call_manager_parameters {
1357 struct rndis_flowspec transmit;
1358 struct rndis_flowspec receive;
1359 struct rcondis_specific_parameters call_mgr_specific;
1360};
1361
1362/* CoNdisMiniportActivateVc message */
1363struct rcondis_mp_activate_vc_request {
1364 u32 req_id;
1365 u32 flags;
1366 u32 dev_vc_handle;
1367 u32 media_params_offset;
1368 u32 media_params_length;
1369 u32 call_mgr_params_offset;
1370 u32 call_mgr_params_length;
1371};
1372
1373/* Response to CoNdisMiniportActivateVc */
1374struct rcondis_mp_activate_vc_complete {
1375 u32 req_id;
1376 u32 status;
1377};
1378
1379/* CoNdisMiniportDeactivateVc message */
1380struct rcondis_mp_deactivate_vc_request {
1381 u32 req_id;
1382 u32 flags;
1383 u32 dev_vc_handle;
1384};
1385
1386/* Response to CoNdisMiniportDeactivateVc */
1387struct rcondis_mp_deactivate_vc_complete {
1388 u32 req_id;
1389 u32 status;
1390};
1391
1392
1393/* union with all of the RNDIS messages */
1394union rndis_message_container {
1395 struct rndis_packet pkt;
1396 struct rndis_initialize_request init_req;
1397 struct rndis_halt_request halt_req;
1398 struct rndis_query_request query_req;
1399 struct rndis_set_request set_req;
1400 struct rndis_reset_request reset_req;
1401 struct rndis_keepalive_request keep_alive_req;
1402 struct rndis_indicate_status indicate_status;
1403 struct rndis_initialize_complete init_complete;
1404 struct rndis_query_complete query_complete;
1405 struct rndis_set_complete set_complete;
1406 struct rndis_reset_complete reset_complete;
1407 struct rndis_keepalive_complete keep_alive_complete;
1408 struct rcondis_mp_create_vc co_miniport_create_vc;
1409 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1410 struct rcondis_indicate_status co_indicate_status;
1411 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1412 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1413 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1414 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1415 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1416 struct rcondis_mp_deactivate_vc_complete
1417 co_miniport_deactivate_vc_complete;
1418};
1419
1420/* Remote NDIS message format */
1421struct rndis_message {
1422 u32 ndis_msg_type;
1423
1424 /* Total length of this message, from the beginning */
1425 /* of the struct rndis_message, in bytes. */
1426 u32 msg_len;
1427
1428 /* Actual message */
1429 union rndis_message_container msg;
1430};
1431
1432
1433/* Handy macros */
1434
1435/* get the size of an RNDIS message. Pass in the message type, */
1436/* struct rndis_set_request, struct rndis_packet for example */
1437#define RNDIS_MESSAGE_SIZE(msg) \
1438 (sizeof(msg) + (sizeof(struct rndis_message) - \
1439 sizeof(union rndis_message_container)))
1440
1441#define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1442 sizeof(union rndis_message_container))
1443
1444#define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1445
1446#define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1447#define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1448#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1449#define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1450#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1451#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1452#define NDIS_PACKET_TYPE_SMT 0x00000040
1453#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1454#define NDIS_PACKET_TYPE_GROUP 0x00000100
1455#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1456#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1457#define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1458
1459#define TRANSPORT_INFO_NOT_IP 0
1460#define TRANSPORT_INFO_IPV4_TCP 0x01
1461#define TRANSPORT_INFO_IPV4_UDP 0x02
1462#define TRANSPORT_INFO_IPV6_TCP 0x10
1463#define TRANSPORT_INFO_IPV6_UDP 0x20
1464
1465#endif /* _HYPERV_NET_H */