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