blob: 8bc4e766589b6167cf10f36aa45716227e93a27a [file] [log] [blame]
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -07001/*
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
Jeff Kirsheradf8d3f2013-12-06 06:28:47 -080015 * this program; if not, see <http://www.gnu.org/licenses/>.
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -070016 *
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
K. Y. Srinivasan8a079412011-05-12 19:34:42 -070027#include <linux/list.h>
Greg Kroah-Hartman46a97192011-10-04 12:29:52 -070028#include <linux/hyperv.h>
Linus Walleij75911572012-05-11 22:15:50 +000029#include <linux/rndis.h>
K. Y. Srinivasan41308862011-05-12 19:34:38 -070030
31/* Fwd declaration */
32struct hv_netvsc_packet;
33
34/* Represent the xfer page packet which contains 1 or more netvsc packet */
35struct xferpage_packet {
36 struct list_head list_ent;
Haiyang Zhang63f69212012-10-02 05:30:23 +000037 u32 status;
K. Y. Srinivasan41308862011-05-12 19:34:38 -070038
39 /* # of netvsc packets this xfer packet contains */
40 u32 count;
41};
42
K. Y. Srinivasan41308862011-05-12 19:34:38 -070043/*
44 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
45 * within the RNDIS
46 */
47struct hv_netvsc_packet {
48 /* Bookkeeping stuff */
49 struct list_head list_ent;
Haiyang Zhang63f69212012-10-02 05:30:23 +000050 u32 status;
K. Y. Srinivasan41308862011-05-12 19:34:38 -070051
52 struct hv_device *device;
53 bool is_data_pkt;
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +000054 u16 vlan_tci;
K. Y. Srinivasan41308862011-05-12 19:34:38 -070055
56 /*
57 * Valid only for receives when we break a xfer page packet
58 * into multiple netvsc packets
59 */
60 struct xferpage_packet *xfer_page_pkt;
61
62 union {
63 struct {
64 u64 recv_completion_tid;
65 void *recv_completion_ctx;
66 void (*recv_completion)(void *context);
67 } recv;
68 struct {
69 u64 send_completion_tid;
70 void *send_completion_ctx;
71 void (*send_completion)(void *context);
72 } send;
73 } completion;
74
75 /* This points to the memory after page_buf */
KY Srinivasan8a002512014-03-08 19:23:14 -080076 struct rndis_message *rndis_msg;
K. Y. Srinivasan41308862011-05-12 19:34:38 -070077
78 u32 total_data_buflen;
79 /* Points to the send/receive buffer where the ethernet frame is */
Haiyang Zhang45326342011-12-15 13:45:15 -080080 void *data;
K. Y. Srinivasan41308862011-05-12 19:34:38 -070081 u32 page_buf_cnt;
Haiyang Zhang45326342011-12-15 13:45:15 -080082 struct hv_page_buffer page_buf[0];
K. Y. Srinivasan41308862011-05-12 19:34:38 -070083};
84
K. Y. Srinivasan41308862011-05-12 19:34:38 -070085struct netvsc_device_info {
Jianjun Kong9a4c8312013-01-18 16:52:09 +000086 unsigned char mac_adr[ETH_ALEN];
K. Y. Srinivasan41308862011-05-12 19:34:38 -070087 bool link_state; /* 0 - link up, 1 - link down */
K. Y. Srinivasan78001df2011-05-12 19:35:04 -070088 int ring_size;
K. Y. Srinivasan41308862011-05-12 19:34:38 -070089};
90
Haiyang Zhangd426b2e2011-11-30 07:19:08 -080091enum rndis_device_state {
92 RNDIS_DEV_UNINITIALIZED = 0,
93 RNDIS_DEV_INITIALIZING,
94 RNDIS_DEV_INITIALIZED,
95 RNDIS_DEV_DATAINITIALIZED,
96};
97
98struct rndis_device {
99 struct netvsc_device *net_dev;
100
101 enum rndis_device_state state;
102 bool link_state;
103 atomic_t new_req_id;
104
105 spinlock_t request_lock;
106 struct list_head req_list;
107
108 unsigned char hw_mac_adr[ETH_ALEN];
109};
110
111
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700112/* Interface */
113int netvsc_device_add(struct hv_device *device, void *additional_info);
114int netvsc_device_remove(struct hv_device *device);
K. Y. Srinivasanf9819f02011-05-12 19:34:49 -0700115int netvsc_send(struct hv_device *device,
116 struct hv_netvsc_packet *packet);
K. Y. Srinivasan90ef1172011-05-12 19:34:50 -0700117void netvsc_linkstatus_callback(struct hv_device *device_obj,
118 unsigned int status);
K. Y. Srinivasanf79adf82011-05-12 19:34:51 -0700119int netvsc_recv_callback(struct hv_device *device_obj,
120 struct hv_netvsc_packet *packet);
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700121int rndis_filter_open(struct hv_device *dev);
122int rndis_filter_close(struct hv_device *dev);
Haiyang Zhangbdbad572011-05-23 09:03:49 -0700123int rndis_filter_device_add(struct hv_device *dev,
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700124 void *additional_info);
Haiyang Zhangdf06bcf2011-05-23 09:03:47 -0700125void rndis_filter_device_remove(struct hv_device *dev);
K. Y. Srinivasan5fcc4112011-05-12 19:34:52 -0700126int rndis_filter_receive(struct hv_device *dev,
127 struct hv_netvsc_packet *pkt);
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700128
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800129int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
Haiyang Zhang1ce09e82012-07-10 07:19:22 +0000130int rndis_filter_set_device_mac(struct hv_device *hdev, char *mac);
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800131
132
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700133#define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
134
135#define NVSP_PROTOCOL_VERSION_1 2
Haiyang Zhangf157e782011-12-15 13:45:16 -0800136#define NVSP_PROTOCOL_VERSION_2 0x30002
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800137#define NVSP_PROTOCOL_VERSION_4 0x40000
138#define NVSP_PROTOCOL_VERSION_5 0x50000
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700139
140enum {
141 NVSP_MSG_TYPE_NONE = 0,
142
143 /* Init Messages */
144 NVSP_MSG_TYPE_INIT = 1,
145 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
146
147 NVSP_VERSION_MSG_START = 100,
148
149 /* Version 1 Messages */
150 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
151
152 NVSP_MSG1_TYPE_SEND_RECV_BUF,
153 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
154 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
155
156 NVSP_MSG1_TYPE_SEND_SEND_BUF,
157 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
158 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
159
160 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
161 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
162
Haiyang Zhangf157e782011-12-15 13:45:16 -0800163 /* Version 2 messages */
164 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
165 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
166 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
167
168 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
169
170 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
171 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
172
173 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
174
175 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
176 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
177
178 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
179 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
180
181 NVSP_MSG2_TYPE_ALLOC_RXBUF,
182 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
183
184 NVSP_MSG2_TYPE_FREE_RXBUF,
185
186 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
187 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
188
189 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
190
191 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
192 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800193
194 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
195
196 /* Version 4 messages */
197 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
198 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
199 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
200
201 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
202
203 /* Version 5 messages */
204 NVSP_MSG5_TYPE_OID_QUERY_EX,
205 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
206 NVSP_MSG5_TYPE_SUBCHANNEL,
207 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
208
209 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700210};
211
212enum {
213 NVSP_STAT_NONE = 0,
214 NVSP_STAT_SUCCESS,
215 NVSP_STAT_FAIL,
216 NVSP_STAT_PROTOCOL_TOO_NEW,
217 NVSP_STAT_PROTOCOL_TOO_OLD,
218 NVSP_STAT_INVALID_RNDIS_PKT,
219 NVSP_STAT_BUSY,
Haiyang Zhangf157e782011-12-15 13:45:16 -0800220 NVSP_STAT_PROTOCOL_UNSUPPORTED,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700221 NVSP_STAT_MAX,
222};
223
224struct nvsp_message_header {
225 u32 msg_type;
226};
227
228/* Init Messages */
229
230/*
231 * This message is used by the VSC to initialize the channel after the channels
232 * has been opened. This message should never include anything other then
233 * versioning (i.e. this message will be the same for ever).
234 */
235struct nvsp_message_init {
236 u32 min_protocol_ver;
237 u32 max_protocol_ver;
238} __packed;
239
240/*
241 * This message is used by the VSP to complete the initialization of the
242 * channel. This message should never include anything other then versioning
243 * (i.e. this message will be the same for ever).
244 */
245struct nvsp_message_init_complete {
246 u32 negotiated_protocol_ver;
247 u32 max_mdl_chain_len;
248 u32 status;
249} __packed;
250
251union nvsp_message_init_uber {
252 struct nvsp_message_init init;
253 struct nvsp_message_init_complete init_complete;
254} __packed;
255
256/* Version 1 Messages */
257
258/*
259 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
260 * can use this information when handling OIDs sent by the VSC.
261 */
262struct nvsp_1_message_send_ndis_version {
263 u32 ndis_major_ver;
264 u32 ndis_minor_ver;
265} __packed;
266
267/*
268 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
269 * can then use the receive buffer to send data to the VSC.
270 */
271struct nvsp_1_message_send_receive_buffer {
272 u32 gpadl_handle;
273 u16 id;
274} __packed;
275
276struct nvsp_1_receive_buffer_section {
277 u32 offset;
278 u32 sub_alloc_size;
279 u32 num_sub_allocs;
280 u32 end_offset;
281} __packed;
282
283/*
284 * This message is used by the VSP to acknowledge a receive buffer send by the
285 * VSC. This message must be sent by the VSP before the VSP uses the receive
286 * buffer.
287 */
288struct nvsp_1_message_send_receive_buffer_complete {
289 u32 status;
290 u32 num_sections;
291
292 /*
293 * The receive buffer is split into two parts, a large suballocation
294 * section and a small suballocation section. These sections are then
295 * suballocated by a certain size.
296 */
297
298 /*
299 * For example, the following break up of the receive buffer has 6
300 * large suballocations and 10 small suballocations.
301 */
302
303 /*
304 * | Large Section | | Small Section |
305 * ------------------------------------------------------------
306 * | | | | | | | | | | | | | | | | | |
307 * | |
308 * LargeOffset SmallOffset
309 */
310
311 struct nvsp_1_receive_buffer_section sections[1];
312} __packed;
313
314/*
315 * This message is sent by the VSC to revoke the receive buffer. After the VSP
316 * completes this transaction, the vsp should never use the receive buffer
317 * again.
318 */
319struct nvsp_1_message_revoke_receive_buffer {
320 u16 id;
321};
322
323/*
324 * This message is used by the VSC to send a send buffer to the VSP. The VSC
325 * can then use the send buffer to send data to the VSP.
326 */
327struct nvsp_1_message_send_send_buffer {
328 u32 gpadl_handle;
329 u16 id;
330} __packed;
331
332/*
333 * This message is used by the VSP to acknowledge a send buffer sent by the
334 * VSC. This message must be sent by the VSP before the VSP uses the sent
335 * buffer.
336 */
337struct nvsp_1_message_send_send_buffer_complete {
338 u32 status;
339
340 /*
341 * The VSC gets to choose the size of the send buffer and the VSP gets
342 * to choose the sections size of the buffer. This was done to enable
343 * dynamic reconfigurations when the cost of GPA-direct buffers
344 * decreases.
345 */
346 u32 section_size;
347} __packed;
348
349/*
350 * This message is sent by the VSC to revoke the send buffer. After the VSP
351 * completes this transaction, the vsp should never use the send buffer again.
352 */
353struct nvsp_1_message_revoke_send_buffer {
354 u16 id;
355};
356
357/*
358 * This message is used by both the VSP and the VSC to send a RNDIS message to
359 * the opposite channel endpoint.
360 */
361struct nvsp_1_message_send_rndis_packet {
362 /*
363 * This field is specified by RNIDS. They assume there's two different
364 * channels of communication. However, the Network VSP only has one.
365 * Therefore, the channel travels with the RNDIS packet.
366 */
367 u32 channel_type;
368
369 /*
370 * This field is used to send part or all of the data through a send
371 * buffer. This values specifies an index into the send buffer. If the
372 * index is 0xFFFFFFFF, then the send buffer is not being used and all
373 * of the data was sent through other VMBus mechanisms.
374 */
375 u32 send_buf_section_index;
376 u32 send_buf_section_size;
377} __packed;
378
379/*
380 * This message is used by both the VSP and the VSC to complete a RNDIS message
381 * to the opposite channel endpoint. At this point, the initiator of this
382 * message cannot use any resources associated with the original RNDIS packet.
383 */
384struct nvsp_1_message_send_rndis_packet_complete {
385 u32 status;
386};
387
388union nvsp_1_message_uber {
389 struct nvsp_1_message_send_ndis_version send_ndis_ver;
390
391 struct nvsp_1_message_send_receive_buffer send_recv_buf;
392 struct nvsp_1_message_send_receive_buffer_complete
393 send_recv_buf_complete;
394 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
395
396 struct nvsp_1_message_send_send_buffer send_send_buf;
397 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
398 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
399
400 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
401 struct nvsp_1_message_send_rndis_packet_complete
402 send_rndis_pkt_complete;
403} __packed;
404
Haiyang Zhangf157e782011-12-15 13:45:16 -0800405
406/*
407 * Network VSP protocol version 2 messages:
408 */
409struct nvsp_2_vsc_capability {
410 union {
411 u64 data;
412 struct {
413 u64 vmq:1;
414 u64 chimney:1;
415 u64 sriov:1;
416 u64 ieee8021q:1;
417 u64 correlation_id:1;
418 };
419 };
420} __packed;
421
422struct nvsp_2_send_ndis_config {
423 u32 mtu;
424 u32 reserved;
425 struct nvsp_2_vsc_capability capability;
426} __packed;
427
428/* Allocate receive buffer */
429struct nvsp_2_alloc_rxbuf {
430 /* Allocation ID to match the allocation request and response */
431 u32 alloc_id;
432
433 /* Length of the VM shared memory receive buffer that needs to
434 * be allocated
435 */
436 u32 len;
437} __packed;
438
439/* Allocate receive buffer complete */
440struct nvsp_2_alloc_rxbuf_comp {
441 /* The NDIS_STATUS code for buffer allocation */
442 u32 status;
443
444 u32 alloc_id;
445
446 /* GPADL handle for the allocated receive buffer */
447 u32 gpadl_handle;
448
449 /* Receive buffer ID */
450 u64 recv_buf_id;
451} __packed;
452
453struct nvsp_2_free_rxbuf {
454 u64 recv_buf_id;
455} __packed;
456
457union nvsp_2_message_uber {
458 struct nvsp_2_send_ndis_config send_ndis_config;
459 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
460 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
461 struct nvsp_2_free_rxbuf free_rxbuf;
462} __packed;
463
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800464enum nvsp_subchannel_operation {
465 NVSP_SUBCHANNEL_NONE = 0,
466 NVSP_SUBCHANNEL_ALLOCATE,
467 NVSP_SUBCHANNEL_MAX
468};
469
470struct nvsp_5_subchannel_request {
471 u32 op;
472 u32 num_subchannels;
473} __packed;
474
475struct nvsp_5_subchannel_complete {
476 u32 status;
477 u32 num_subchannels; /* Actual number of subchannels allocated */
478} __packed;
479
480struct nvsp_5_send_indirect_table {
481 /* The number of entries in the send indirection table */
482 u32 count;
483
484 /* The offset of the send indireciton table from top of this struct.
485 * The send indirection table tells which channel to put the send
486 * traffic on. Each entry is a channel number.
487 */
488 u32 offset;
489} __packed;
490
491union nvsp_5_message_uber {
492 struct nvsp_5_subchannel_request subchn_req;
493 struct nvsp_5_subchannel_complete subchn_comp;
494 struct nvsp_5_send_indirect_table send_table;
495} __packed;
496
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700497union nvsp_all_messages {
498 union nvsp_message_init_uber init_msg;
499 union nvsp_1_message_uber v1_msg;
Haiyang Zhangf157e782011-12-15 13:45:16 -0800500 union nvsp_2_message_uber v2_msg;
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800501 union nvsp_5_message_uber v5_msg;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700502} __packed;
503
504/* ALL Messages */
505struct nvsp_message {
506 struct nvsp_message_header hdr;
507 union nvsp_all_messages msg;
508} __packed;
509
510
Haiyang Zhang4d447c92011-12-15 13:45:17 -0800511#define NETVSC_MTU 65536
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700512
Haiyang Zhangb679ef72014-01-27 15:03:42 -0800513#define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700514
515#define NETVSC_RECEIVE_BUFFER_ID 0xcafe
516
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700517/* Preallocated receive packets */
518#define NETVSC_RECEIVE_PACKETLIST_COUNT 256
519
520#define NETVSC_PACKET_SIZE 2048
521
522/* Per netvsc channel-specific */
523struct netvsc_device {
524 struct hv_device *dev;
525
Haiyang Zhangf157e782011-12-15 13:45:16 -0800526 u32 nvsp_version;
527
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700528 atomic_t num_outstanding_sends;
Haiyang Zhangdc5cd892012-06-04 06:42:38 +0000529 wait_queue_head_t wait_drain;
Haiyang Zhang4d447c92011-12-15 13:45:17 -0800530 bool start_remove;
K. Y. Srinivasanc38b9c72011-08-27 11:31:12 -0700531 bool destroy;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700532 /*
533 * List of free preallocated hv_netvsc_packet to represent receive
534 * packet
535 */
536 struct list_head recv_pkt_list;
537 spinlock_t recv_pkt_list_lock;
538
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700539 /* Receive buffer allocated by us but manages by NetVSP */
540 void *recv_buf;
541 u32 recv_buf_size;
542 u32 recv_buf_gpadl_handle;
543 u32 recv_section_cnt;
544 struct nvsp_1_receive_buffer_section *recv_section;
545
546 /* Used for NetVSP initialization protocol */
547 struct completion channel_init_wait;
548 struct nvsp_message channel_init_pkt;
549
550 struct nvsp_message revoke_packet;
551 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
552
K. Y. Srinivasan2ddd5e5f2011-09-13 10:59:49 -0700553 struct net_device *ndev;
554
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700555 /* Holds rndis device info */
556 void *extension;
KY Srinivasanee0c4c32014-02-16 16:38:45 -0800557 /* The recive buffer for this device */
558 unsigned char cb_buffer[NETVSC_PACKET_SIZE];
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700559};
560
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700561/* NdisInitialize message */
562struct rndis_initialize_request {
563 u32 req_id;
564 u32 major_ver;
565 u32 minor_ver;
566 u32 max_xfer_size;
567};
568
569/* Response to NdisInitialize */
570struct rndis_initialize_complete {
571 u32 req_id;
572 u32 status;
573 u32 major_ver;
574 u32 minor_ver;
575 u32 dev_flags;
576 u32 medium;
577 u32 max_pkt_per_msg;
578 u32 max_xfer_size;
579 u32 pkt_alignment_factor;
580 u32 af_list_offset;
581 u32 af_list_size;
582};
583
584/* Call manager devices only: Information about an address family */
585/* supported by the device is appended to the response to NdisInitialize. */
586struct rndis_co_address_family {
587 u32 address_family;
588 u32 major_ver;
589 u32 minor_ver;
590};
591
592/* NdisHalt message */
593struct rndis_halt_request {
594 u32 req_id;
595};
596
597/* NdisQueryRequest message */
598struct rndis_query_request {
599 u32 req_id;
600 u32 oid;
601 u32 info_buflen;
602 u32 info_buf_offset;
603 u32 dev_vc_handle;
604};
605
606/* Response to NdisQueryRequest */
607struct rndis_query_complete {
608 u32 req_id;
609 u32 status;
610 u32 info_buflen;
611 u32 info_buf_offset;
612};
613
614/* NdisSetRequest message */
615struct rndis_set_request {
616 u32 req_id;
617 u32 oid;
618 u32 info_buflen;
619 u32 info_buf_offset;
620 u32 dev_vc_handle;
621};
622
623/* Response to NdisSetRequest */
624struct rndis_set_complete {
625 u32 req_id;
626 u32 status;
627};
628
629/* NdisReset message */
630struct rndis_reset_request {
631 u32 reserved;
632};
633
634/* Response to NdisReset */
635struct rndis_reset_complete {
636 u32 status;
637 u32 addressing_reset;
638};
639
640/* NdisMIndicateStatus message */
641struct rndis_indicate_status {
642 u32 status;
643 u32 status_buflen;
644 u32 status_buf_offset;
645};
646
647/* Diagnostic information passed as the status buffer in */
648/* struct rndis_indicate_status messages signifying error conditions. */
649struct rndis_diagnostic_info {
650 u32 diag_status;
651 u32 error_offset;
652};
653
654/* NdisKeepAlive message */
655struct rndis_keepalive_request {
656 u32 req_id;
657};
658
659/* Response to NdisKeepAlive */
660struct rndis_keepalive_complete {
661 u32 req_id;
662 u32 status;
663};
664
665/*
666 * Data message. All Offset fields contain byte offsets from the beginning of
667 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
668 * to 0 for connectionless data, otherwise it contains the VC handle.
669 */
670struct rndis_packet {
671 u32 data_offset;
672 u32 data_len;
673 u32 oob_data_offset;
674 u32 oob_data_len;
675 u32 num_oob_data_elements;
676 u32 per_pkt_info_offset;
677 u32 per_pkt_info_len;
678 u32 vc_handle;
679 u32 reserved;
680};
681
682/* Optional Out of Band data associated with a Data message. */
683struct rndis_oobd {
684 u32 size;
685 u32 type;
686 u32 class_info_offset;
687};
688
689/* Packet extension field contents associated with a Data message. */
690struct rndis_per_packet_info {
691 u32 size;
692 u32 type;
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000693 u32 ppi_offset;
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700694};
695
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000696enum ndis_per_pkt_info_type {
697 TCPIP_CHKSUM_PKTINFO,
698 IPSEC_PKTINFO,
699 TCP_LARGESEND_PKTINFO,
700 CLASSIFICATION_HANDLE_PKTINFO,
701 NDIS_RESERVED,
702 SG_LIST_PKTINFO,
703 IEEE_8021Q_INFO,
704 ORIGINAL_PKTINFO,
705 PACKET_CANCEL_ID,
706 ORIGINAL_NET_BUFLIST,
707 CACHED_NET_BUFLIST,
708 SHORT_PKT_PADINFO,
709 MAX_PER_PKT_INFO
710};
711
712struct ndis_pkt_8021q_info {
713 union {
714 struct {
715 u32 pri:3; /* User Priority */
716 u32 cfi:1; /* Canonical Format ID */
717 u32 vlanid:12; /* VLAN ID */
718 u32 reserved:16;
719 };
720 u32 value;
721 };
722};
723
KY Srinivasan4a0e70a2014-03-08 19:23:15 -0800724struct ndis_oject_header {
725 u8 type;
726 u8 revision;
727 u16 size;
728};
729
730#define NDIS_OBJECT_TYPE_DEFAULT 0x80
731#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
732#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
733#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
734#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
735#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
736#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
737#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
738#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
739#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
740#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
741#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
742
743/*
744 * New offload OIDs for NDIS 6
745 */
746#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
747#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
748#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
749#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
750#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
751#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
752
753struct ndis_offload_params {
754 struct ndis_oject_header header;
755 u8 ip_v4_csum;
756 u8 tcp_ip_v4_csum;
757 u8 udp_ip_v4_csum;
758 u8 tcp_ip_v6_csum;
759 u8 udp_ip_v6_csum;
760 u8 lso_v1;
761 u8 ip_sec_v1;
762 u8 lso_v2_ipv4;
763 u8 lso_v2_ipv6;
764 u8 tcp_connection_ip_v4;
765 u8 tcp_connection_ip_v6;
766 u32 flags;
767 u8 ip_sec_v2;
768 u8 ip_sec_v2_ip_v4;
769 struct {
770 u8 rsc_ip_v4;
771 u8 rsc_ip_v6;
772 };
773 struct {
774 u8 encapsulated_packet_task_offload;
775 u8 encapsulation_types;
776 };
777};
778
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000779#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
780 sizeof(struct ndis_pkt_8021q_info))
781
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700782/* Format of Information buffer passed in a SetRequest for the OID */
783/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
784struct rndis_config_parameter_info {
785 u32 parameter_name_offset;
786 u32 parameter_name_length;
787 u32 parameter_type;
788 u32 parameter_value_offset;
789 u32 parameter_value_length;
790};
791
792/* Values for ParameterType in struct rndis_config_parameter_info */
793#define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
794#define RNDIS_CONFIG_PARAM_TYPE_STRING 2
795
796/* CONDIS Miniport messages for connection oriented devices */
797/* that do not implement a call manager. */
798
799/* CoNdisMiniportCreateVc message */
800struct rcondis_mp_create_vc {
801 u32 req_id;
802 u32 ndis_vc_handle;
803};
804
805/* Response to CoNdisMiniportCreateVc */
806struct rcondis_mp_create_vc_complete {
807 u32 req_id;
808 u32 dev_vc_handle;
809 u32 status;
810};
811
812/* CoNdisMiniportDeleteVc message */
813struct rcondis_mp_delete_vc {
814 u32 req_id;
815 u32 dev_vc_handle;
816};
817
818/* Response to CoNdisMiniportDeleteVc */
819struct rcondis_mp_delete_vc_complete {
820 u32 req_id;
821 u32 status;
822};
823
824/* CoNdisMiniportQueryRequest message */
825struct rcondis_mp_query_request {
826 u32 req_id;
827 u32 request_type;
828 u32 oid;
829 u32 dev_vc_handle;
830 u32 info_buflen;
831 u32 info_buf_offset;
832};
833
834/* CoNdisMiniportSetRequest message */
835struct rcondis_mp_set_request {
836 u32 req_id;
837 u32 request_type;
838 u32 oid;
839 u32 dev_vc_handle;
840 u32 info_buflen;
841 u32 info_buf_offset;
842};
843
844/* CoNdisIndicateStatus message */
845struct rcondis_indicate_status {
846 u32 ndis_vc_handle;
847 u32 status;
848 u32 status_buflen;
849 u32 status_buf_offset;
850};
851
852/* CONDIS Call/VC parameters */
853struct rcondis_specific_parameters {
854 u32 parameter_type;
855 u32 parameter_length;
856 u32 parameter_lffset;
857};
858
859struct rcondis_media_parameters {
860 u32 flags;
861 u32 reserved1;
862 u32 reserved2;
863 struct rcondis_specific_parameters media_specific;
864};
865
866struct rndis_flowspec {
867 u32 token_rate;
868 u32 token_bucket_size;
869 u32 peak_bandwidth;
870 u32 latency;
871 u32 delay_variation;
872 u32 service_type;
873 u32 max_sdu_size;
874 u32 minimum_policed_size;
875};
876
877struct rcondis_call_manager_parameters {
878 struct rndis_flowspec transmit;
879 struct rndis_flowspec receive;
880 struct rcondis_specific_parameters call_mgr_specific;
881};
882
883/* CoNdisMiniportActivateVc message */
884struct rcondis_mp_activate_vc_request {
885 u32 req_id;
886 u32 flags;
887 u32 dev_vc_handle;
888 u32 media_params_offset;
889 u32 media_params_length;
890 u32 call_mgr_params_offset;
891 u32 call_mgr_params_length;
892};
893
894/* Response to CoNdisMiniportActivateVc */
895struct rcondis_mp_activate_vc_complete {
896 u32 req_id;
897 u32 status;
898};
899
900/* CoNdisMiniportDeactivateVc message */
901struct rcondis_mp_deactivate_vc_request {
902 u32 req_id;
903 u32 flags;
904 u32 dev_vc_handle;
905};
906
907/* Response to CoNdisMiniportDeactivateVc */
908struct rcondis_mp_deactivate_vc_complete {
909 u32 req_id;
910 u32 status;
911};
912
913
914/* union with all of the RNDIS messages */
915union rndis_message_container {
916 struct rndis_packet pkt;
917 struct rndis_initialize_request init_req;
918 struct rndis_halt_request halt_req;
919 struct rndis_query_request query_req;
920 struct rndis_set_request set_req;
921 struct rndis_reset_request reset_req;
922 struct rndis_keepalive_request keep_alive_req;
923 struct rndis_indicate_status indicate_status;
924 struct rndis_initialize_complete init_complete;
925 struct rndis_query_complete query_complete;
926 struct rndis_set_complete set_complete;
927 struct rndis_reset_complete reset_complete;
928 struct rndis_keepalive_complete keep_alive_complete;
929 struct rcondis_mp_create_vc co_miniport_create_vc;
930 struct rcondis_mp_delete_vc co_miniport_delete_vc;
931 struct rcondis_indicate_status co_indicate_status;
932 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
933 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
934 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
935 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
936 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
937 struct rcondis_mp_deactivate_vc_complete
938 co_miniport_deactivate_vc_complete;
939};
940
941/* Remote NDIS message format */
942struct rndis_message {
943 u32 ndis_msg_type;
944
945 /* Total length of this message, from the beginning */
946 /* of the sruct rndis_message, in bytes. */
947 u32 msg_len;
948
949 /* Actual message */
950 union rndis_message_container msg;
951};
952
K. Y. Srinivasan9dbfd152011-05-12 19:35:00 -0700953
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700954/* Handy macros */
955
956/* get the size of an RNDIS message. Pass in the message type, */
957/* struct rndis_set_request, struct rndis_packet for example */
958#define RNDIS_MESSAGE_SIZE(msg) \
959 (sizeof(msg) + (sizeof(struct rndis_message) - \
960 sizeof(union rndis_message_container)))
961
962/* get pointer to info buffer with message pointer */
963#define MESSAGE_TO_INFO_BUFFER(msg) \
964 (((unsigned char *)(msg)) + msg->info_buf_offset)
965
966/* get pointer to status buffer with message pointer */
967#define MESSAGE_TO_STATUS_BUFFER(msg) \
968 (((unsigned char *)(msg)) + msg->status_buf_offset)
969
970/* get pointer to OOBD buffer with message pointer */
971#define MESSAGE_TO_OOBD_BUFFER(msg) \
972 (((unsigned char *)(msg)) + msg->oob_data_offset)
973
974/* get pointer to data buffer with message pointer */
975#define MESSAGE_TO_DATA_BUFFER(msg) \
976 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
977
978/* get pointer to contained message from NDIS_MESSAGE pointer */
979#define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
980 ((void *) &rndis_msg->msg)
981
982/* get pointer to contained message from NDIS_MESSAGE pointer */
983#define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
984 ((void *) rndis_msg)
985
K. Y. Srinivasan299d09252011-05-12 19:34:41 -0700986
987#define __struct_bcount(x)
988
989
990
991#define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
992 sizeof(union rndis_message_container))
993
994#define NDIS_PACKET_TYPE_DIRECTED 0x00000001
995#define NDIS_PACKET_TYPE_MULTICAST 0x00000002
996#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
997#define NDIS_PACKET_TYPE_BROADCAST 0x00000008
998#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
999#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1000#define NDIS_PACKET_TYPE_SMT 0x00000040
1001#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1002#define NDIS_PACKET_TYPE_GROUP 0x00000100
1003#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1004#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1005#define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1006
1007
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001008
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -07001009#endif /* _HYPERV_NET_H */