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