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