2f48f790c9b43e983f44107a97f42f2268262099
[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         u32 status;
131
132         struct hv_device *device;
133         bool is_data_pkt;
134         u16 vlan_tci;
135
136         u16 q_idx;
137         struct vmbus_channel *channel;
138
139         u64 send_completion_tid;
140         void *send_completion_ctx;
141         void (*send_completion)(void *context);
142
143         u32 send_buf_index;
144
145         /* This points to the memory after page_buf */
146         struct rndis_message *rndis_msg;
147
148         u32 total_data_buflen;
149         /* Points to the send/receive buffer where the ethernet frame is */
150         void *data;
151         u32 page_buf_cnt;
152         struct hv_page_buffer page_buf[0];
153 };
154
155 struct netvsc_device_info {
156         unsigned char mac_adr[ETH_ALEN];
157         bool link_state;        /* 0 - link up, 1 - link down */
158         int  ring_size;
159 };
160
161 enum rndis_device_state {
162         RNDIS_DEV_UNINITIALIZED = 0,
163         RNDIS_DEV_INITIALIZING,
164         RNDIS_DEV_INITIALIZED,
165         RNDIS_DEV_DATAINITIALIZED,
166 };
167
168 struct rndis_device {
169         struct netvsc_device *net_dev;
170
171         enum rndis_device_state state;
172         bool link_state;
173         bool link_change;
174         atomic_t new_req_id;
175
176         spinlock_t request_lock;
177         struct list_head req_list;
178
179         unsigned char hw_mac_adr[ETH_ALEN];
180 };
181
182
183 /* Interface */
184 int netvsc_device_add(struct hv_device *device, void *additional_info);
185 int netvsc_device_remove(struct hv_device *device);
186 int netvsc_send(struct hv_device *device,
187                 struct hv_netvsc_packet *packet);
188 void netvsc_linkstatus_callback(struct hv_device *device_obj,
189                                 struct rndis_message *resp);
190 int netvsc_recv_callback(struct hv_device *device_obj,
191                         struct hv_netvsc_packet *packet,
192                         struct ndis_tcp_ip_checksum_info *csum_info);
193 void netvsc_channel_cb(void *context);
194 int rndis_filter_open(struct hv_device *dev);
195 int rndis_filter_close(struct hv_device *dev);
196 int rndis_filter_device_add(struct hv_device *dev,
197                         void *additional_info);
198 void rndis_filter_device_remove(struct hv_device *dev);
199 int rndis_filter_receive(struct hv_device *dev,
200                         struct hv_netvsc_packet *pkt);
201
202 int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
203 int rndis_filter_set_device_mac(struct hv_device *hdev, char *mac);
204
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                 };
492         };
493 } __packed;
494
495 struct nvsp_2_send_ndis_config {
496         u32 mtu;
497         u32 reserved;
498         struct nvsp_2_vsc_capability capability;
499 } __packed;
500
501 /* Allocate receive buffer */
502 struct nvsp_2_alloc_rxbuf {
503         /* Allocation ID to match the allocation request and response */
504         u32 alloc_id;
505
506         /* Length of the VM shared memory receive buffer that needs to
507          * be allocated
508          */
509         u32 len;
510 } __packed;
511
512 /* Allocate receive buffer complete */
513 struct nvsp_2_alloc_rxbuf_comp {
514         /* The NDIS_STATUS code for buffer allocation */
515         u32 status;
516
517         u32 alloc_id;
518
519         /* GPADL handle for the allocated receive buffer */
520         u32 gpadl_handle;
521
522         /* Receive buffer ID */
523         u64 recv_buf_id;
524 } __packed;
525
526 struct nvsp_2_free_rxbuf {
527         u64 recv_buf_id;
528 } __packed;
529
530 union nvsp_2_message_uber {
531         struct nvsp_2_send_ndis_config send_ndis_config;
532         struct nvsp_2_alloc_rxbuf alloc_rxbuf;
533         struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
534         struct nvsp_2_free_rxbuf free_rxbuf;
535 } __packed;
536
537 enum nvsp_subchannel_operation {
538         NVSP_SUBCHANNEL_NONE = 0,
539         NVSP_SUBCHANNEL_ALLOCATE,
540         NVSP_SUBCHANNEL_MAX
541 };
542
543 struct nvsp_5_subchannel_request {
544         u32 op;
545         u32 num_subchannels;
546 } __packed;
547
548 struct nvsp_5_subchannel_complete {
549         u32 status;
550         u32 num_subchannels; /* Actual number of subchannels allocated */
551 } __packed;
552
553 struct nvsp_5_send_indirect_table {
554         /* The number of entries in the send indirection table */
555         u32 count;
556
557         /* The offset of the send indireciton table from top of this struct.
558          * The send indirection table tells which channel to put the send
559          * traffic on. Each entry is a channel number.
560          */
561         u32 offset;
562 } __packed;
563
564 union nvsp_5_message_uber {
565         struct nvsp_5_subchannel_request subchn_req;
566         struct nvsp_5_subchannel_complete subchn_comp;
567         struct nvsp_5_send_indirect_table send_table;
568 } __packed;
569
570 union nvsp_all_messages {
571         union nvsp_message_init_uber init_msg;
572         union nvsp_1_message_uber v1_msg;
573         union nvsp_2_message_uber v2_msg;
574         union nvsp_5_message_uber v5_msg;
575 } __packed;
576
577 /* ALL Messages */
578 struct nvsp_message {
579         struct nvsp_message_header hdr;
580         union nvsp_all_messages msg;
581 } __packed;
582
583
584 #define NETVSC_MTU 65536
585
586 #define NETVSC_RECEIVE_BUFFER_SIZE              (1024*1024*16)  /* 16MB */
587 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY       (1024*1024*15)  /* 15MB */
588 #define NETVSC_SEND_BUFFER_SIZE                 (1024 * 1024 * 15)   /* 15MB */
589 #define NETVSC_INVALID_INDEX                    -1
590
591
592 #define NETVSC_RECEIVE_BUFFER_ID                0xcafe
593
594 #define NETVSC_PACKET_SIZE                      4096
595
596 #define VRSS_SEND_TAB_SIZE 16
597
598 /* Per netvsc channel-specific */
599 struct netvsc_device {
600         struct hv_device *dev;
601
602         u32 nvsp_version;
603
604         atomic_t num_outstanding_sends;
605         wait_queue_head_t wait_drain;
606         bool start_remove;
607         bool destroy;
608
609         /* Receive buffer allocated by us but manages by NetVSP */
610         void *recv_buf;
611         u32 recv_buf_size;
612         u32 recv_buf_gpadl_handle;
613         u32 recv_section_cnt;
614         struct nvsp_1_receive_buffer_section *recv_section;
615
616         /* Send buffer allocated by us */
617         void *send_buf;
618         u32 send_buf_size;
619         u32 send_buf_gpadl_handle;
620         u32 send_section_cnt;
621         u32 send_section_size;
622         unsigned long *send_section_map;
623         int map_words;
624
625         /* Used for NetVSP initialization protocol */
626         struct completion channel_init_wait;
627         struct nvsp_message channel_init_pkt;
628
629         struct nvsp_message revoke_packet;
630         /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
631
632         struct net_device *ndev;
633
634         struct vmbus_channel *chn_table[NR_CPUS];
635         u32 send_table[VRSS_SEND_TAB_SIZE];
636         u32 num_chn;
637         atomic_t queue_sends[NR_CPUS];
638
639         /* Holds rndis device info */
640         void *extension;
641
642         int ring_size;
643
644         /* The primary channel callback buffer */
645         unsigned char *cb_buffer;
646         /* The sub channel callback buffer */
647         unsigned char *sub_cb_buf;
648 };
649
650 /* NdisInitialize message */
651 struct rndis_initialize_request {
652         u32 req_id;
653         u32 major_ver;
654         u32 minor_ver;
655         u32 max_xfer_size;
656 };
657
658 /* Response to NdisInitialize */
659 struct rndis_initialize_complete {
660         u32 req_id;
661         u32 status;
662         u32 major_ver;
663         u32 minor_ver;
664         u32 dev_flags;
665         u32 medium;
666         u32 max_pkt_per_msg;
667         u32 max_xfer_size;
668         u32 pkt_alignment_factor;
669         u32 af_list_offset;
670         u32 af_list_size;
671 };
672
673 /* Call manager devices only: Information about an address family */
674 /* supported by the device is appended to the response to NdisInitialize. */
675 struct rndis_co_address_family {
676         u32 address_family;
677         u32 major_ver;
678         u32 minor_ver;
679 };
680
681 /* NdisHalt message */
682 struct rndis_halt_request {
683         u32 req_id;
684 };
685
686 /* NdisQueryRequest message */
687 struct rndis_query_request {
688         u32 req_id;
689         u32 oid;
690         u32 info_buflen;
691         u32 info_buf_offset;
692         u32 dev_vc_handle;
693 };
694
695 /* Response to NdisQueryRequest */
696 struct rndis_query_complete {
697         u32 req_id;
698         u32 status;
699         u32 info_buflen;
700         u32 info_buf_offset;
701 };
702
703 /* NdisSetRequest message */
704 struct rndis_set_request {
705         u32 req_id;
706         u32 oid;
707         u32 info_buflen;
708         u32 info_buf_offset;
709         u32 dev_vc_handle;
710 };
711
712 /* Response to NdisSetRequest */
713 struct rndis_set_complete {
714         u32 req_id;
715         u32 status;
716 };
717
718 /* NdisReset message */
719 struct rndis_reset_request {
720         u32 reserved;
721 };
722
723 /* Response to NdisReset */
724 struct rndis_reset_complete {
725         u32 status;
726         u32 addressing_reset;
727 };
728
729 /* NdisMIndicateStatus message */
730 struct rndis_indicate_status {
731         u32 status;
732         u32 status_buflen;
733         u32 status_buf_offset;
734 };
735
736 /* Diagnostic information passed as the status buffer in */
737 /* struct rndis_indicate_status messages signifying error conditions. */
738 struct rndis_diagnostic_info {
739         u32 diag_status;
740         u32 error_offset;
741 };
742
743 /* NdisKeepAlive message */
744 struct rndis_keepalive_request {
745         u32 req_id;
746 };
747
748 /* Response to NdisKeepAlive */
749 struct rndis_keepalive_complete {
750         u32 req_id;
751         u32 status;
752 };
753
754 /*
755  * Data message. All Offset fields contain byte offsets from the beginning of
756  * struct rndis_packet. All Length fields are in bytes.  VcHandle is set
757  * to 0 for connectionless data, otherwise it contains the VC handle.
758  */
759 struct rndis_packet {
760         u32 data_offset;
761         u32 data_len;
762         u32 oob_data_offset;
763         u32 oob_data_len;
764         u32 num_oob_data_elements;
765         u32 per_pkt_info_offset;
766         u32 per_pkt_info_len;
767         u32 vc_handle;
768         u32 reserved;
769 };
770
771 /* Optional Out of Band data associated with a Data message. */
772 struct rndis_oobd {
773         u32 size;
774         u32 type;
775         u32 class_info_offset;
776 };
777
778 /* Packet extension field contents associated with a Data message. */
779 struct rndis_per_packet_info {
780         u32 size;
781         u32 type;
782         u32 ppi_offset;
783 };
784
785 enum ndis_per_pkt_info_type {
786         TCPIP_CHKSUM_PKTINFO,
787         IPSEC_PKTINFO,
788         TCP_LARGESEND_PKTINFO,
789         CLASSIFICATION_HANDLE_PKTINFO,
790         NDIS_RESERVED,
791         SG_LIST_PKTINFO,
792         IEEE_8021Q_INFO,
793         ORIGINAL_PKTINFO,
794         PACKET_CANCEL_ID,
795         NBL_HASH_VALUE = PACKET_CANCEL_ID,
796         ORIGINAL_NET_BUFLIST,
797         CACHED_NET_BUFLIST,
798         SHORT_PKT_PADINFO,
799         MAX_PER_PKT_INFO
800 };
801
802 struct ndis_pkt_8021q_info {
803         union {
804                 struct {
805                         u32 pri:3; /* User Priority */
806                         u32 cfi:1; /* Canonical Format ID */
807                         u32 vlanid:12; /* VLAN ID */
808                         u32 reserved:16;
809                 };
810                 u32 value;
811         };
812 };
813
814 struct ndis_oject_header {
815         u8 type;
816         u8 revision;
817         u16 size;
818 };
819
820 #define NDIS_OBJECT_TYPE_DEFAULT        0x80
821 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
822 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
823 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
824 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED  2
825 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED  2
826 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
827 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
828 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
829 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
830 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
831 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
832
833 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE     1
834 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4        0
835 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6        1
836
837 #define VERSION_4_OFFLOAD_SIZE                  22
838 /*
839  * New offload OIDs for NDIS 6
840  */
841 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
842 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C           /* set only */
843 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
844 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
845 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
846 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
847
848 struct ndis_offload_params {
849         struct ndis_oject_header header;
850         u8 ip_v4_csum;
851         u8 tcp_ip_v4_csum;
852         u8 udp_ip_v4_csum;
853         u8 tcp_ip_v6_csum;
854         u8 udp_ip_v6_csum;
855         u8 lso_v1;
856         u8 ip_sec_v1;
857         u8 lso_v2_ipv4;
858         u8 lso_v2_ipv6;
859         u8 tcp_connection_ip_v4;
860         u8 tcp_connection_ip_v6;
861         u32 flags;
862         u8 ip_sec_v2;
863         u8 ip_sec_v2_ip_v4;
864         struct {
865                 u8 rsc_ip_v4;
866                 u8 rsc_ip_v6;
867         };
868         struct {
869                 u8 encapsulated_packet_task_offload;
870                 u8 encapsulation_types;
871         };
872 };
873
874 struct ndis_tcp_ip_checksum_info {
875         union {
876                 struct {
877                         u32 is_ipv4:1;
878                         u32 is_ipv6:1;
879                         u32 tcp_checksum:1;
880                         u32 udp_checksum:1;
881                         u32 ip_header_checksum:1;
882                         u32 reserved:11;
883                         u32 tcp_header_offset:10;
884                 } transmit;
885                 struct {
886                         u32 tcp_checksum_failed:1;
887                         u32 udp_checksum_failed:1;
888                         u32 ip_checksum_failed:1;
889                         u32 tcp_checksum_succeeded:1;
890                         u32 udp_checksum_succeeded:1;
891                         u32 ip_checksum_succeeded:1;
892                         u32 loopback:1;
893                         u32 tcp_checksum_value_invalid:1;
894                         u32 ip_checksum_value_invalid:1;
895                 } receive;
896                 u32  value;
897         };
898 };
899
900 struct ndis_tcp_lso_info {
901         union {
902                 struct {
903                         u32 unused:30;
904                         u32 type:1;
905                         u32 reserved2:1;
906                 } transmit;
907                 struct {
908                         u32 mss:20;
909                         u32 tcp_header_offset:10;
910                         u32 type:1;
911                         u32 reserved2:1;
912                 } lso_v1_transmit;
913                 struct {
914                         u32 tcp_payload:30;
915                         u32 type:1;
916                         u32 reserved2:1;
917                 } lso_v1_transmit_complete;
918                 struct {
919                         u32 mss:20;
920                         u32 tcp_header_offset:10;
921                         u32 type:1;
922                         u32 ip_version:1;
923                 } lso_v2_transmit;
924                 struct {
925                         u32 reserved:30;
926                         u32 type:1;
927                         u32 reserved2:1;
928                 } lso_v2_transmit_complete;
929                 u32  value;
930         };
931 };
932
933 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
934                 sizeof(struct ndis_pkt_8021q_info))
935
936 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
937                 sizeof(struct ndis_tcp_ip_checksum_info))
938
939 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
940                 sizeof(struct ndis_tcp_lso_info))
941
942 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
943                 sizeof(u32))
944
945 /* Format of Information buffer passed in a SetRequest for the OID */
946 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
947 struct rndis_config_parameter_info {
948         u32 parameter_name_offset;
949         u32 parameter_name_length;
950         u32 parameter_type;
951         u32 parameter_value_offset;
952         u32 parameter_value_length;
953 };
954
955 /* Values for ParameterType in struct rndis_config_parameter_info */
956 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER     0
957 #define RNDIS_CONFIG_PARAM_TYPE_STRING      2
958
959 /* CONDIS Miniport messages for connection oriented devices */
960 /* that do not implement a call manager. */
961
962 /* CoNdisMiniportCreateVc message */
963 struct rcondis_mp_create_vc {
964         u32 req_id;
965         u32 ndis_vc_handle;
966 };
967
968 /* Response to CoNdisMiniportCreateVc */
969 struct rcondis_mp_create_vc_complete {
970         u32 req_id;
971         u32 dev_vc_handle;
972         u32 status;
973 };
974
975 /* CoNdisMiniportDeleteVc message */
976 struct rcondis_mp_delete_vc {
977         u32 req_id;
978         u32 dev_vc_handle;
979 };
980
981 /* Response to CoNdisMiniportDeleteVc */
982 struct rcondis_mp_delete_vc_complete {
983         u32 req_id;
984         u32 status;
985 };
986
987 /* CoNdisMiniportQueryRequest message */
988 struct rcondis_mp_query_request {
989         u32 req_id;
990         u32 request_type;
991         u32 oid;
992         u32 dev_vc_handle;
993         u32 info_buflen;
994         u32 info_buf_offset;
995 };
996
997 /* CoNdisMiniportSetRequest message */
998 struct rcondis_mp_set_request {
999         u32 req_id;
1000         u32 request_type;
1001         u32 oid;
1002         u32 dev_vc_handle;
1003         u32 info_buflen;
1004         u32 info_buf_offset;
1005 };
1006
1007 /* CoNdisIndicateStatus message */
1008 struct rcondis_indicate_status {
1009         u32 ndis_vc_handle;
1010         u32 status;
1011         u32 status_buflen;
1012         u32 status_buf_offset;
1013 };
1014
1015 /* CONDIS Call/VC parameters */
1016 struct rcondis_specific_parameters {
1017         u32 parameter_type;
1018         u32 parameter_length;
1019         u32 parameter_lffset;
1020 };
1021
1022 struct rcondis_media_parameters {
1023         u32 flags;
1024         u32 reserved1;
1025         u32 reserved2;
1026         struct rcondis_specific_parameters media_specific;
1027 };
1028
1029 struct rndis_flowspec {
1030         u32 token_rate;
1031         u32 token_bucket_size;
1032         u32 peak_bandwidth;
1033         u32 latency;
1034         u32 delay_variation;
1035         u32 service_type;
1036         u32 max_sdu_size;
1037         u32 minimum_policed_size;
1038 };
1039
1040 struct rcondis_call_manager_parameters {
1041         struct rndis_flowspec transmit;
1042         struct rndis_flowspec receive;
1043         struct rcondis_specific_parameters call_mgr_specific;
1044 };
1045
1046 /* CoNdisMiniportActivateVc message */
1047 struct rcondis_mp_activate_vc_request {
1048         u32 req_id;
1049         u32 flags;
1050         u32 dev_vc_handle;
1051         u32 media_params_offset;
1052         u32 media_params_length;
1053         u32 call_mgr_params_offset;
1054         u32 call_mgr_params_length;
1055 };
1056
1057 /* Response to CoNdisMiniportActivateVc */
1058 struct rcondis_mp_activate_vc_complete {
1059         u32 req_id;
1060         u32 status;
1061 };
1062
1063 /* CoNdisMiniportDeactivateVc message */
1064 struct rcondis_mp_deactivate_vc_request {
1065         u32 req_id;
1066         u32 flags;
1067         u32 dev_vc_handle;
1068 };
1069
1070 /* Response to CoNdisMiniportDeactivateVc */
1071 struct rcondis_mp_deactivate_vc_complete {
1072         u32 req_id;
1073         u32 status;
1074 };
1075
1076
1077 /* union with all of the RNDIS messages */
1078 union rndis_message_container {
1079         struct rndis_packet pkt;
1080         struct rndis_initialize_request init_req;
1081         struct rndis_halt_request halt_req;
1082         struct rndis_query_request query_req;
1083         struct rndis_set_request set_req;
1084         struct rndis_reset_request reset_req;
1085         struct rndis_keepalive_request keep_alive_req;
1086         struct rndis_indicate_status indicate_status;
1087         struct rndis_initialize_complete init_complete;
1088         struct rndis_query_complete query_complete;
1089         struct rndis_set_complete set_complete;
1090         struct rndis_reset_complete reset_complete;
1091         struct rndis_keepalive_complete keep_alive_complete;
1092         struct rcondis_mp_create_vc co_miniport_create_vc;
1093         struct rcondis_mp_delete_vc co_miniport_delete_vc;
1094         struct rcondis_indicate_status co_indicate_status;
1095         struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1096         struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1097         struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1098         struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1099         struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1100         struct rcondis_mp_deactivate_vc_complete
1101                 co_miniport_deactivate_vc_complete;
1102 };
1103
1104 /* Remote NDIS message format */
1105 struct rndis_message {
1106         u32 ndis_msg_type;
1107
1108         /* Total length of this message, from the beginning */
1109         /* of the sruct rndis_message, in bytes. */
1110         u32 msg_len;
1111
1112         /* Actual message */
1113         union rndis_message_container msg;
1114 };
1115
1116
1117 /* Handy macros */
1118
1119 /* get the size of an RNDIS message. Pass in the message type, */
1120 /* struct rndis_set_request, struct rndis_packet for example */
1121 #define RNDIS_MESSAGE_SIZE(msg)                         \
1122         (sizeof(msg) + (sizeof(struct rndis_message) -  \
1123          sizeof(union rndis_message_container)))
1124
1125 /* get pointer to info buffer with message pointer */
1126 #define MESSAGE_TO_INFO_BUFFER(msg)                             \
1127         (((unsigned char *)(msg)) + msg->info_buf_offset)
1128
1129 /* get pointer to status buffer with message pointer */
1130 #define MESSAGE_TO_STATUS_BUFFER(msg)                   \
1131         (((unsigned char *)(msg)) + msg->status_buf_offset)
1132
1133 /* get pointer to OOBD buffer with message pointer */
1134 #define MESSAGE_TO_OOBD_BUFFER(msg)                             \
1135         (((unsigned char *)(msg)) + msg->oob_data_offset)
1136
1137 /* get pointer to data buffer with message pointer */
1138 #define MESSAGE_TO_DATA_BUFFER(msg)                             \
1139         (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1140
1141 /* get pointer to contained message from NDIS_MESSAGE pointer */
1142 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg)             \
1143         ((void *) &rndis_msg->msg)
1144
1145 /* get pointer to contained message from NDIS_MESSAGE pointer */
1146 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1147         ((void *) rndis_msg)
1148
1149
1150 #define __struct_bcount(x)
1151
1152
1153
1154 #define RNDIS_HEADER_SIZE       (sizeof(struct rndis_message) - \
1155                                  sizeof(union rndis_message_container))
1156
1157 #define NDIS_PACKET_TYPE_DIRECTED       0x00000001
1158 #define NDIS_PACKET_TYPE_MULTICAST      0x00000002
1159 #define NDIS_PACKET_TYPE_ALL_MULTICAST  0x00000004
1160 #define NDIS_PACKET_TYPE_BROADCAST      0x00000008
1161 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1162 #define NDIS_PACKET_TYPE_PROMISCUOUS    0x00000020
1163 #define NDIS_PACKET_TYPE_SMT            0x00000040
1164 #define NDIS_PACKET_TYPE_ALL_LOCAL      0x00000080
1165 #define NDIS_PACKET_TYPE_GROUP          0x00000100
1166 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1167 #define NDIS_PACKET_TYPE_FUNCTIONAL     0x00000400
1168 #define NDIS_PACKET_TYPE_MAC_FRAME      0x00000800
1169
1170 #define INFO_IPV4       2
1171 #define INFO_IPV6       4
1172 #define INFO_TCP        2
1173 #define INFO_UDP        4
1174
1175 #define TRANSPORT_INFO_NOT_IP   0
1176 #define TRANSPORT_INFO_IPV4_TCP ((INFO_IPV4 << 16) | INFO_TCP)
1177 #define TRANSPORT_INFO_IPV4_UDP ((INFO_IPV4 << 16) | INFO_UDP)
1178 #define TRANSPORT_INFO_IPV6_TCP ((INFO_IPV6 << 16) | INFO_TCP)
1179 #define TRANSPORT_INFO_IPV6_UDP ((INFO_IPV6 << 16) | INFO_UDP)
1180
1181
1182 #endif /* _HYPERV_NET_H */