blob: 01a16ea77a5a7dc60d9ed32ff48141a0e946ab04 [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 */
76 void *extension;
77
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
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700129
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700130
K. Y. Srinivasan0652aeb2011-05-12 19:34:53 -0700131int rndis_filter_send(struct hv_device *dev,
132 struct hv_netvsc_packet *pkt);
133
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800134int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
Haiyang Zhang1ce09e82012-07-10 07:19:22 +0000135int rndis_filter_set_device_mac(struct hv_device *hdev, char *mac);
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800136
137
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700138#define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
139
140#define NVSP_PROTOCOL_VERSION_1 2
Haiyang Zhangf157e782011-12-15 13:45:16 -0800141#define NVSP_PROTOCOL_VERSION_2 0x30002
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700142
143enum {
144 NVSP_MSG_TYPE_NONE = 0,
145
146 /* Init Messages */
147 NVSP_MSG_TYPE_INIT = 1,
148 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
149
150 NVSP_VERSION_MSG_START = 100,
151
152 /* Version 1 Messages */
153 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
154
155 NVSP_MSG1_TYPE_SEND_RECV_BUF,
156 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
157 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
158
159 NVSP_MSG1_TYPE_SEND_SEND_BUF,
160 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
161 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
162
163 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
164 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
165
Haiyang Zhangf157e782011-12-15 13:45:16 -0800166 /* Version 2 messages */
167 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
168 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
169 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
170
171 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
172
173 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
174 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
175
176 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
177
178 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
179 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
180
181 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
182 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
183
184 NVSP_MSG2_TYPE_ALLOC_RXBUF,
185 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
186
187 NVSP_MSG2_TYPE_FREE_RXBUF,
188
189 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
190 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
191
192 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
193
194 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
195 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700196};
197
198enum {
199 NVSP_STAT_NONE = 0,
200 NVSP_STAT_SUCCESS,
201 NVSP_STAT_FAIL,
202 NVSP_STAT_PROTOCOL_TOO_NEW,
203 NVSP_STAT_PROTOCOL_TOO_OLD,
204 NVSP_STAT_INVALID_RNDIS_PKT,
205 NVSP_STAT_BUSY,
Haiyang Zhangf157e782011-12-15 13:45:16 -0800206 NVSP_STAT_PROTOCOL_UNSUPPORTED,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700207 NVSP_STAT_MAX,
208};
209
210struct nvsp_message_header {
211 u32 msg_type;
212};
213
214/* Init Messages */
215
216/*
217 * This message is used by the VSC to initialize the channel after the channels
218 * has been opened. This message should never include anything other then
219 * versioning (i.e. this message will be the same for ever).
220 */
221struct nvsp_message_init {
222 u32 min_protocol_ver;
223 u32 max_protocol_ver;
224} __packed;
225
226/*
227 * This message is used by the VSP to complete the initialization of the
228 * channel. This message should never include anything other then versioning
229 * (i.e. this message will be the same for ever).
230 */
231struct nvsp_message_init_complete {
232 u32 negotiated_protocol_ver;
233 u32 max_mdl_chain_len;
234 u32 status;
235} __packed;
236
237union nvsp_message_init_uber {
238 struct nvsp_message_init init;
239 struct nvsp_message_init_complete init_complete;
240} __packed;
241
242/* Version 1 Messages */
243
244/*
245 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
246 * can use this information when handling OIDs sent by the VSC.
247 */
248struct nvsp_1_message_send_ndis_version {
249 u32 ndis_major_ver;
250 u32 ndis_minor_ver;
251} __packed;
252
253/*
254 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
255 * can then use the receive buffer to send data to the VSC.
256 */
257struct nvsp_1_message_send_receive_buffer {
258 u32 gpadl_handle;
259 u16 id;
260} __packed;
261
262struct nvsp_1_receive_buffer_section {
263 u32 offset;
264 u32 sub_alloc_size;
265 u32 num_sub_allocs;
266 u32 end_offset;
267} __packed;
268
269/*
270 * This message is used by the VSP to acknowledge a receive buffer send by the
271 * VSC. This message must be sent by the VSP before the VSP uses the receive
272 * buffer.
273 */
274struct nvsp_1_message_send_receive_buffer_complete {
275 u32 status;
276 u32 num_sections;
277
278 /*
279 * The receive buffer is split into two parts, a large suballocation
280 * section and a small suballocation section. These sections are then
281 * suballocated by a certain size.
282 */
283
284 /*
285 * For example, the following break up of the receive buffer has 6
286 * large suballocations and 10 small suballocations.
287 */
288
289 /*
290 * | Large Section | | Small Section |
291 * ------------------------------------------------------------
292 * | | | | | | | | | | | | | | | | | |
293 * | |
294 * LargeOffset SmallOffset
295 */
296
297 struct nvsp_1_receive_buffer_section sections[1];
298} __packed;
299
300/*
301 * This message is sent by the VSC to revoke the receive buffer. After the VSP
302 * completes this transaction, the vsp should never use the receive buffer
303 * again.
304 */
305struct nvsp_1_message_revoke_receive_buffer {
306 u16 id;
307};
308
309/*
310 * This message is used by the VSC to send a send buffer to the VSP. The VSC
311 * can then use the send buffer to send data to the VSP.
312 */
313struct nvsp_1_message_send_send_buffer {
314 u32 gpadl_handle;
315 u16 id;
316} __packed;
317
318/*
319 * This message is used by the VSP to acknowledge a send buffer sent by the
320 * VSC. This message must be sent by the VSP before the VSP uses the sent
321 * buffer.
322 */
323struct nvsp_1_message_send_send_buffer_complete {
324 u32 status;
325
326 /*
327 * The VSC gets to choose the size of the send buffer and the VSP gets
328 * to choose the sections size of the buffer. This was done to enable
329 * dynamic reconfigurations when the cost of GPA-direct buffers
330 * decreases.
331 */
332 u32 section_size;
333} __packed;
334
335/*
336 * This message is sent by the VSC to revoke the send buffer. After the VSP
337 * completes this transaction, the vsp should never use the send buffer again.
338 */
339struct nvsp_1_message_revoke_send_buffer {
340 u16 id;
341};
342
343/*
344 * This message is used by both the VSP and the VSC to send a RNDIS message to
345 * the opposite channel endpoint.
346 */
347struct nvsp_1_message_send_rndis_packet {
348 /*
349 * This field is specified by RNIDS. They assume there's two different
350 * channels of communication. However, the Network VSP only has one.
351 * Therefore, the channel travels with the RNDIS packet.
352 */
353 u32 channel_type;
354
355 /*
356 * This field is used to send part or all of the data through a send
357 * buffer. This values specifies an index into the send buffer. If the
358 * index is 0xFFFFFFFF, then the send buffer is not being used and all
359 * of the data was sent through other VMBus mechanisms.
360 */
361 u32 send_buf_section_index;
362 u32 send_buf_section_size;
363} __packed;
364
365/*
366 * This message is used by both the VSP and the VSC to complete a RNDIS message
367 * to the opposite channel endpoint. At this point, the initiator of this
368 * message cannot use any resources associated with the original RNDIS packet.
369 */
370struct nvsp_1_message_send_rndis_packet_complete {
371 u32 status;
372};
373
374union nvsp_1_message_uber {
375 struct nvsp_1_message_send_ndis_version send_ndis_ver;
376
377 struct nvsp_1_message_send_receive_buffer send_recv_buf;
378 struct nvsp_1_message_send_receive_buffer_complete
379 send_recv_buf_complete;
380 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
381
382 struct nvsp_1_message_send_send_buffer send_send_buf;
383 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
384 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
385
386 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
387 struct nvsp_1_message_send_rndis_packet_complete
388 send_rndis_pkt_complete;
389} __packed;
390
Haiyang Zhangf157e782011-12-15 13:45:16 -0800391
392/*
393 * Network VSP protocol version 2 messages:
394 */
395struct nvsp_2_vsc_capability {
396 union {
397 u64 data;
398 struct {
399 u64 vmq:1;
400 u64 chimney:1;
401 u64 sriov:1;
402 u64 ieee8021q:1;
403 u64 correlation_id:1;
404 };
405 };
406} __packed;
407
408struct nvsp_2_send_ndis_config {
409 u32 mtu;
410 u32 reserved;
411 struct nvsp_2_vsc_capability capability;
412} __packed;
413
414/* Allocate receive buffer */
415struct nvsp_2_alloc_rxbuf {
416 /* Allocation ID to match the allocation request and response */
417 u32 alloc_id;
418
419 /* Length of the VM shared memory receive buffer that needs to
420 * be allocated
421 */
422 u32 len;
423} __packed;
424
425/* Allocate receive buffer complete */
426struct nvsp_2_alloc_rxbuf_comp {
427 /* The NDIS_STATUS code for buffer allocation */
428 u32 status;
429
430 u32 alloc_id;
431
432 /* GPADL handle for the allocated receive buffer */
433 u32 gpadl_handle;
434
435 /* Receive buffer ID */
436 u64 recv_buf_id;
437} __packed;
438
439struct nvsp_2_free_rxbuf {
440 u64 recv_buf_id;
441} __packed;
442
443union nvsp_2_message_uber {
444 struct nvsp_2_send_ndis_config send_ndis_config;
445 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
446 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
447 struct nvsp_2_free_rxbuf free_rxbuf;
448} __packed;
449
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700450union nvsp_all_messages {
451 union nvsp_message_init_uber init_msg;
452 union nvsp_1_message_uber v1_msg;
Haiyang Zhangf157e782011-12-15 13:45:16 -0800453 union nvsp_2_message_uber v2_msg;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700454} __packed;
455
456/* ALL Messages */
457struct nvsp_message {
458 struct nvsp_message_header hdr;
459 union nvsp_all_messages msg;
460} __packed;
461
462
Haiyang Zhang4d447c92011-12-15 13:45:17 -0800463#define NETVSC_MTU 65536
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700464
Haiyang Zhangb679ef72014-01-27 15:03:42 -0800465#define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700466
467#define NETVSC_RECEIVE_BUFFER_ID 0xcafe
468
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700469/* Preallocated receive packets */
470#define NETVSC_RECEIVE_PACKETLIST_COUNT 256
471
472#define NETVSC_PACKET_SIZE 2048
473
474/* Per netvsc channel-specific */
475struct netvsc_device {
476 struct hv_device *dev;
477
Haiyang Zhangf157e782011-12-15 13:45:16 -0800478 u32 nvsp_version;
479
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700480 atomic_t num_outstanding_sends;
Haiyang Zhangdc5cd892012-06-04 06:42:38 +0000481 wait_queue_head_t wait_drain;
Haiyang Zhang4d447c92011-12-15 13:45:17 -0800482 bool start_remove;
K. Y. Srinivasanc38b9c72011-08-27 11:31:12 -0700483 bool destroy;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700484 /*
485 * List of free preallocated hv_netvsc_packet to represent receive
486 * packet
487 */
488 struct list_head recv_pkt_list;
489 spinlock_t recv_pkt_list_lock;
490
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700491 /* Receive buffer allocated by us but manages by NetVSP */
492 void *recv_buf;
493 u32 recv_buf_size;
494 u32 recv_buf_gpadl_handle;
495 u32 recv_section_cnt;
496 struct nvsp_1_receive_buffer_section *recv_section;
497
498 /* Used for NetVSP initialization protocol */
499 struct completion channel_init_wait;
500 struct nvsp_message channel_init_pkt;
501
502 struct nvsp_message revoke_packet;
503 /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
504
K. Y. Srinivasan2ddd5e5f2011-09-13 10:59:49 -0700505 struct net_device *ndev;
506
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700507 /* Holds rndis device info */
508 void *extension;
KY Srinivasanee0c4c32014-02-16 16:38:45 -0800509 /* The recive buffer for this device */
510 unsigned char cb_buffer[NETVSC_PACKET_SIZE];
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700511};
512
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700513/* NdisInitialize message */
514struct rndis_initialize_request {
515 u32 req_id;
516 u32 major_ver;
517 u32 minor_ver;
518 u32 max_xfer_size;
519};
520
521/* Response to NdisInitialize */
522struct rndis_initialize_complete {
523 u32 req_id;
524 u32 status;
525 u32 major_ver;
526 u32 minor_ver;
527 u32 dev_flags;
528 u32 medium;
529 u32 max_pkt_per_msg;
530 u32 max_xfer_size;
531 u32 pkt_alignment_factor;
532 u32 af_list_offset;
533 u32 af_list_size;
534};
535
536/* Call manager devices only: Information about an address family */
537/* supported by the device is appended to the response to NdisInitialize. */
538struct rndis_co_address_family {
539 u32 address_family;
540 u32 major_ver;
541 u32 minor_ver;
542};
543
544/* NdisHalt message */
545struct rndis_halt_request {
546 u32 req_id;
547};
548
549/* NdisQueryRequest message */
550struct rndis_query_request {
551 u32 req_id;
552 u32 oid;
553 u32 info_buflen;
554 u32 info_buf_offset;
555 u32 dev_vc_handle;
556};
557
558/* Response to NdisQueryRequest */
559struct rndis_query_complete {
560 u32 req_id;
561 u32 status;
562 u32 info_buflen;
563 u32 info_buf_offset;
564};
565
566/* NdisSetRequest message */
567struct rndis_set_request {
568 u32 req_id;
569 u32 oid;
570 u32 info_buflen;
571 u32 info_buf_offset;
572 u32 dev_vc_handle;
573};
574
575/* Response to NdisSetRequest */
576struct rndis_set_complete {
577 u32 req_id;
578 u32 status;
579};
580
581/* NdisReset message */
582struct rndis_reset_request {
583 u32 reserved;
584};
585
586/* Response to NdisReset */
587struct rndis_reset_complete {
588 u32 status;
589 u32 addressing_reset;
590};
591
592/* NdisMIndicateStatus message */
593struct rndis_indicate_status {
594 u32 status;
595 u32 status_buflen;
596 u32 status_buf_offset;
597};
598
599/* Diagnostic information passed as the status buffer in */
600/* struct rndis_indicate_status messages signifying error conditions. */
601struct rndis_diagnostic_info {
602 u32 diag_status;
603 u32 error_offset;
604};
605
606/* NdisKeepAlive message */
607struct rndis_keepalive_request {
608 u32 req_id;
609};
610
611/* Response to NdisKeepAlive */
612struct rndis_keepalive_complete {
613 u32 req_id;
614 u32 status;
615};
616
617/*
618 * Data message. All Offset fields contain byte offsets from the beginning of
619 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
620 * to 0 for connectionless data, otherwise it contains the VC handle.
621 */
622struct rndis_packet {
623 u32 data_offset;
624 u32 data_len;
625 u32 oob_data_offset;
626 u32 oob_data_len;
627 u32 num_oob_data_elements;
628 u32 per_pkt_info_offset;
629 u32 per_pkt_info_len;
630 u32 vc_handle;
631 u32 reserved;
632};
633
634/* Optional Out of Band data associated with a Data message. */
635struct rndis_oobd {
636 u32 size;
637 u32 type;
638 u32 class_info_offset;
639};
640
641/* Packet extension field contents associated with a Data message. */
642struct rndis_per_packet_info {
643 u32 size;
644 u32 type;
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000645 u32 ppi_offset;
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700646};
647
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000648enum ndis_per_pkt_info_type {
649 TCPIP_CHKSUM_PKTINFO,
650 IPSEC_PKTINFO,
651 TCP_LARGESEND_PKTINFO,
652 CLASSIFICATION_HANDLE_PKTINFO,
653 NDIS_RESERVED,
654 SG_LIST_PKTINFO,
655 IEEE_8021Q_INFO,
656 ORIGINAL_PKTINFO,
657 PACKET_CANCEL_ID,
658 ORIGINAL_NET_BUFLIST,
659 CACHED_NET_BUFLIST,
660 SHORT_PKT_PADINFO,
661 MAX_PER_PKT_INFO
662};
663
664struct ndis_pkt_8021q_info {
665 union {
666 struct {
667 u32 pri:3; /* User Priority */
668 u32 cfi:1; /* Canonical Format ID */
669 u32 vlanid:12; /* VLAN ID */
670 u32 reserved:16;
671 };
672 u32 value;
673 };
674};
675
676#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
677 sizeof(struct ndis_pkt_8021q_info))
678
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700679/* Format of Information buffer passed in a SetRequest for the OID */
680/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
681struct rndis_config_parameter_info {
682 u32 parameter_name_offset;
683 u32 parameter_name_length;
684 u32 parameter_type;
685 u32 parameter_value_offset;
686 u32 parameter_value_length;
687};
688
689/* Values for ParameterType in struct rndis_config_parameter_info */
690#define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
691#define RNDIS_CONFIG_PARAM_TYPE_STRING 2
692
693/* CONDIS Miniport messages for connection oriented devices */
694/* that do not implement a call manager. */
695
696/* CoNdisMiniportCreateVc message */
697struct rcondis_mp_create_vc {
698 u32 req_id;
699 u32 ndis_vc_handle;
700};
701
702/* Response to CoNdisMiniportCreateVc */
703struct rcondis_mp_create_vc_complete {
704 u32 req_id;
705 u32 dev_vc_handle;
706 u32 status;
707};
708
709/* CoNdisMiniportDeleteVc message */
710struct rcondis_mp_delete_vc {
711 u32 req_id;
712 u32 dev_vc_handle;
713};
714
715/* Response to CoNdisMiniportDeleteVc */
716struct rcondis_mp_delete_vc_complete {
717 u32 req_id;
718 u32 status;
719};
720
721/* CoNdisMiniportQueryRequest message */
722struct rcondis_mp_query_request {
723 u32 req_id;
724 u32 request_type;
725 u32 oid;
726 u32 dev_vc_handle;
727 u32 info_buflen;
728 u32 info_buf_offset;
729};
730
731/* CoNdisMiniportSetRequest message */
732struct rcondis_mp_set_request {
733 u32 req_id;
734 u32 request_type;
735 u32 oid;
736 u32 dev_vc_handle;
737 u32 info_buflen;
738 u32 info_buf_offset;
739};
740
741/* CoNdisIndicateStatus message */
742struct rcondis_indicate_status {
743 u32 ndis_vc_handle;
744 u32 status;
745 u32 status_buflen;
746 u32 status_buf_offset;
747};
748
749/* CONDIS Call/VC parameters */
750struct rcondis_specific_parameters {
751 u32 parameter_type;
752 u32 parameter_length;
753 u32 parameter_lffset;
754};
755
756struct rcondis_media_parameters {
757 u32 flags;
758 u32 reserved1;
759 u32 reserved2;
760 struct rcondis_specific_parameters media_specific;
761};
762
763struct rndis_flowspec {
764 u32 token_rate;
765 u32 token_bucket_size;
766 u32 peak_bandwidth;
767 u32 latency;
768 u32 delay_variation;
769 u32 service_type;
770 u32 max_sdu_size;
771 u32 minimum_policed_size;
772};
773
774struct rcondis_call_manager_parameters {
775 struct rndis_flowspec transmit;
776 struct rndis_flowspec receive;
777 struct rcondis_specific_parameters call_mgr_specific;
778};
779
780/* CoNdisMiniportActivateVc message */
781struct rcondis_mp_activate_vc_request {
782 u32 req_id;
783 u32 flags;
784 u32 dev_vc_handle;
785 u32 media_params_offset;
786 u32 media_params_length;
787 u32 call_mgr_params_offset;
788 u32 call_mgr_params_length;
789};
790
791/* Response to CoNdisMiniportActivateVc */
792struct rcondis_mp_activate_vc_complete {
793 u32 req_id;
794 u32 status;
795};
796
797/* CoNdisMiniportDeactivateVc message */
798struct rcondis_mp_deactivate_vc_request {
799 u32 req_id;
800 u32 flags;
801 u32 dev_vc_handle;
802};
803
804/* Response to CoNdisMiniportDeactivateVc */
805struct rcondis_mp_deactivate_vc_complete {
806 u32 req_id;
807 u32 status;
808};
809
810
811/* union with all of the RNDIS messages */
812union rndis_message_container {
813 struct rndis_packet pkt;
814 struct rndis_initialize_request init_req;
815 struct rndis_halt_request halt_req;
816 struct rndis_query_request query_req;
817 struct rndis_set_request set_req;
818 struct rndis_reset_request reset_req;
819 struct rndis_keepalive_request keep_alive_req;
820 struct rndis_indicate_status indicate_status;
821 struct rndis_initialize_complete init_complete;
822 struct rndis_query_complete query_complete;
823 struct rndis_set_complete set_complete;
824 struct rndis_reset_complete reset_complete;
825 struct rndis_keepalive_complete keep_alive_complete;
826 struct rcondis_mp_create_vc co_miniport_create_vc;
827 struct rcondis_mp_delete_vc co_miniport_delete_vc;
828 struct rcondis_indicate_status co_indicate_status;
829 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
830 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
831 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
832 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
833 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
834 struct rcondis_mp_deactivate_vc_complete
835 co_miniport_deactivate_vc_complete;
836};
837
838/* Remote NDIS message format */
839struct rndis_message {
840 u32 ndis_msg_type;
841
842 /* Total length of this message, from the beginning */
843 /* of the sruct rndis_message, in bytes. */
844 u32 msg_len;
845
846 /* Actual message */
847 union rndis_message_container msg;
848};
849
K. Y. Srinivasan9dbfd152011-05-12 19:35:00 -0700850
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700851/* Handy macros */
852
853/* get the size of an RNDIS message. Pass in the message type, */
854/* struct rndis_set_request, struct rndis_packet for example */
855#define RNDIS_MESSAGE_SIZE(msg) \
856 (sizeof(msg) + (sizeof(struct rndis_message) - \
857 sizeof(union rndis_message_container)))
858
859/* get pointer to info buffer with message pointer */
860#define MESSAGE_TO_INFO_BUFFER(msg) \
861 (((unsigned char *)(msg)) + msg->info_buf_offset)
862
863/* get pointer to status buffer with message pointer */
864#define MESSAGE_TO_STATUS_BUFFER(msg) \
865 (((unsigned char *)(msg)) + msg->status_buf_offset)
866
867/* get pointer to OOBD buffer with message pointer */
868#define MESSAGE_TO_OOBD_BUFFER(msg) \
869 (((unsigned char *)(msg)) + msg->oob_data_offset)
870
871/* get pointer to data buffer with message pointer */
872#define MESSAGE_TO_DATA_BUFFER(msg) \
873 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
874
875/* get pointer to contained message from NDIS_MESSAGE pointer */
876#define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
877 ((void *) &rndis_msg->msg)
878
879/* get pointer to contained message from NDIS_MESSAGE pointer */
880#define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
881 ((void *) rndis_msg)
882
K. Y. Srinivasan299d09252011-05-12 19:34:41 -0700883
884#define __struct_bcount(x)
885
886
887
888#define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
889 sizeof(union rndis_message_container))
890
891#define NDIS_PACKET_TYPE_DIRECTED 0x00000001
892#define NDIS_PACKET_TYPE_MULTICAST 0x00000002
893#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
894#define NDIS_PACKET_TYPE_BROADCAST 0x00000008
895#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
896#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
897#define NDIS_PACKET_TYPE_SMT 0x00000040
898#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
899#define NDIS_PACKET_TYPE_GROUP 0x00000100
900#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
901#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
902#define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
903
904
K. Y. Srinivasan299d09252011-05-12 19:34:41 -0700905
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -0700906#endif /* _HYPERV_NET_H */