drivers/net/hyperv/hyperv_net.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  *
   4  * Copyright (c) 2011, Microsoft Corporation.
   5  *
   6  * Authors:
   7  *   Haiyang Zhang <[email protected]>
   8  *   Hank Janssen  <[email protected]>
   9  *   K. Y. Srinivasan <[email protected]>
  10  */
  11
  12 #ifndef _HYPERV_NET_H
  13 #define _HYPERV_NET_H
  14
  15 #include <linux/list.h>
  16 #include <linux/hyperv.h>
  17 #include <linux/rndis.h>
  18 #include <linux/jhash.h>
  19
  20 /* RSS related */
  21 #define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203  /* query only */
  22 #define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204  /* query and set */
  23
  24 #define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88
  25 #define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89
  26 #define NDIS_OBJECT_TYPE_OFFLOAD        0xa7
  27
  28 #define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
  29 #define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
  30
  31 struct ndis_obj_header {
  32         u8 type;
  33         u8 rev;
  34         u16 size;
  35 } __packed;
  36
  37 /* ndis_recv_scale_cap/cap_flag */
  38 #define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
  39 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR       0x02000000
  40 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC       0x04000000
  41 #define NDIS_RSS_CAPS_USING_MSI_X                 0x08000000
  42 #define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS      0x10000000
  43 #define NDIS_RSS_CAPS_SUPPORTS_MSI_X              0x20000000
  44 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4          0x00000100
  45 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6          0x00000200
  46 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX       0x00000400
  47
  48 struct ndis_recv_scale_cap { /* NDIS_RECEIVE_SCALE_CAPABILITIES */
  49         struct ndis_obj_header hdr;
  50         u32 cap_flag;
  51         u32 num_int_msg;
  52         u32 num_recv_que;
  53         u16 num_indirect_tabent;
  54 } __packed;
  55
  56
  57 /* ndis_recv_scale_param flags */
  58 #define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED     0x0001
  59 #define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED    0x0002
  60 #define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED       0x0004
  61 #define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED     0x0008
  62 #define NDIS_RSS_PARAM_FLAG_DISABLE_RSS            0x0010
  63
  64 /* Hash info bits */
  65 #define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
  66 #define NDIS_HASH_IPV4          0x00000100
  67 #define NDIS_HASH_TCP_IPV4      0x00000200
  68 #define NDIS_HASH_IPV6          0x00000400
  69 #define NDIS_HASH_IPV6_EX       0x00000800
  70 #define NDIS_HASH_TCP_IPV6      0x00001000
  71 #define NDIS_HASH_TCP_IPV6_EX   0x00002000
  72
  73 #define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
  74 #define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2   40
  75
  76 #define ITAB_NUM 128
  77 #define ITAB_NUM_MAX 256
  78
  79 struct ndis_recv_scale_param { /* NDIS_RECEIVE_SCALE_PARAMETERS */
  80         struct ndis_obj_header hdr;
  81
  82         /* Qualifies the rest of the information */
  83         u16 flag;
  84
  85         /* The base CPU number to do receive processing. not used */
  86         u16 base_cpu_number;
  87
  88         /* This describes the hash function and type being enabled */
  89         u32 hashinfo;
  90
  91         /* The size of indirection table array */
  92         u16 indirect_tabsize;
  93
  94         /* The offset of the indirection table from the beginning of this
  95          * structure
  96          */
  97         u32 indirect_taboffset;
  98
  99         /* The size of the hash secret key */
 100         u16 hashkey_size;
 101
 102         /* The offset of the secret key from the beginning of this structure */
 103         u32 hashkey_offset;
 104
 105         u32 processor_masks_offset;
 106         u32 num_processor_masks;
 107         u32 processor_masks_entry_size;
 108 };
 109
 110 struct ndis_tcp_ip_checksum_info {
 111         union {
 112                 struct {
 113                         u32 is_ipv4:1;
 114                         u32 is_ipv6:1;
 115                         u32 tcp_checksum:1;
 116                         u32 udp_checksum:1;
 117                         u32 ip_header_checksum:1;
 118                         u32 reserved:11;
 119                         u32 tcp_header_offset:10;
 120                 } transmit;
 121                 struct {
 122                         u32 tcp_checksum_failed:1;
 123                         u32 udp_checksum_failed:1;
 124                         u32 ip_checksum_failed:1;
 125                         u32 tcp_checksum_succeeded:1;
 126                         u32 udp_checksum_succeeded:1;
 127                         u32 ip_checksum_succeeded:1;
 128                         u32 loopback:1;
 129                         u32 tcp_checksum_value_invalid:1;
 130                         u32 ip_checksum_value_invalid:1;
 131                 } receive;
 132                 u32  value;
 133         };
 134 };
 135
 136 struct ndis_pkt_8021q_info {
 137         union {
 138                 struct {
 139                         u32 pri:3; /* User Priority */
 140                         u32 cfi:1; /* Canonical Format ID */
 141                         u32 vlanid:12; /* VLAN ID */
 142                         u32 reserved:16;
 143                 };
 144                 u32 value;
 145         };
 146 };
 147
 148 /*
 149  * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
 150  * within the RNDIS
 151  *
 152  * The size of this structure is less than 48 bytes and we can now
 153  * place this structure in the skb->cb field.
 154  */
 155 struct hv_netvsc_packet {
 156         /* Bookkeeping stuff */
 157         u8 cp_partial; /* partial copy into send buffer */
 158
 159         u8 rmsg_size; /* RNDIS header and PPI size */
 160         u8 rmsg_pgcnt; /* page count of RNDIS header and PPI */
 161         u8 page_buf_cnt;
 162
 163         u16 q_idx;
 164         u16 total_packets;
 165
 166         u32 total_bytes;
 167         u32 send_buf_index;
 168         u32 total_data_buflen;
 169         struct hv_dma_range *dma_range;
 170 };
 171
 172 #define NETVSC_HASH_KEYLEN 40
 173
 174 struct netvsc_device_info {
 175         unsigned char mac_adr[ETH_ALEN];
 176         u32  num_chn;
 177         u32  send_sections;
 178         u32  recv_sections;
 179         u32  send_section_size;
 180         u32  recv_section_size;
 181
 182         struct bpf_prog *bprog;
 183
 184         u8 rss_key[NETVSC_HASH_KEYLEN];
 185 };
 186
 187 enum rndis_device_state {
 188         RNDIS_DEV_UNINITIALIZED = 0,
 189         RNDIS_DEV_INITIALIZING,
 190         RNDIS_DEV_INITIALIZED,
 191         RNDIS_DEV_DATAINITIALIZED,
 192 };
 193
 194 struct rndis_device {
 195         struct net_device *ndev;
 196
 197         enum rndis_device_state state;
 198
 199         atomic_t new_req_id;
 200
 201         spinlock_t request_lock;
 202         struct list_head req_list;
 203
 204         struct work_struct mcast_work;
 205         u32 filter;
 206
 207         bool link_state;        /* 0 - link up, 1 - link down */
 208
 209         u8 hw_mac_adr[ETH_ALEN];
 210         u8 rss_key[NETVSC_HASH_KEYLEN];
 211 };
 212
 213
 214 /* Interface */
 215 struct rndis_message;
 216 struct ndis_offload_params;
 217 struct netvsc_device;
 218 struct netvsc_channel;
 219 struct net_device_context;
 220
 221 extern u32 netvsc_ring_bytes;
 222
 223 struct netvsc_device *netvsc_device_add(struct hv_device *device,
 224                                         const struct netvsc_device_info *info);
 225 int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
 226 void netvsc_device_remove(struct hv_device *device);
 227 int netvsc_send(struct net_device *net,
 228                 struct hv_netvsc_packet *packet,
 229                 struct rndis_message *rndis_msg,
 230                 struct hv_page_buffer *page_buffer,
 231                 struct sk_buff *skb,
 232                 bool xdp_tx);
 233 void netvsc_linkstatus_callback(struct net_device *net,
 234                                 struct rndis_message *resp,
 235                                 void *data, u32 data_buflen);
 236 int netvsc_recv_callback(struct net_device *net,
 237                          struct netvsc_device *nvdev,
 238                          struct netvsc_channel *nvchan);
 239 void netvsc_channel_cb(void *context);
 240 int netvsc_poll(struct napi_struct *napi, int budget);
 241
 242 void netvsc_xdp_xmit(struct sk_buff *skb, struct net_device *ndev);
 243 u32 netvsc_run_xdp(struct net_device *ndev, struct netvsc_channel *nvchan,
 244                    struct xdp_buff *xdp);
 245 unsigned int netvsc_xdp_fraglen(unsigned int len);
 246 struct bpf_prog *netvsc_xdp_get(struct netvsc_device *nvdev);
 247 int netvsc_xdp_set(struct net_device *dev, struct bpf_prog *prog,
 248                    struct netlink_ext_ack *extack,
 249                    struct netvsc_device *nvdev);
 250 int netvsc_vf_setxdp(struct net_device *vf_netdev, struct bpf_prog *prog);
 251 int netvsc_bpf(struct net_device *dev, struct netdev_bpf *bpf);
 252 int netvsc_ndoxdp_xmit(struct net_device *ndev, int n,
 253                        struct xdp_frame **frames, u32 flags);
 254
 255 int rndis_set_subchannel(struct net_device *ndev,
 256                          struct netvsc_device *nvdev,
 257                          struct netvsc_device_info *dev_info);
 258 int rndis_filter_open(struct netvsc_device *nvdev);
 259 int rndis_filter_close(struct netvsc_device *nvdev);
 260 struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
 261                                               struct netvsc_device_info *info);
 262 void rndis_filter_update(struct netvsc_device *nvdev);
 263 void rndis_filter_device_remove(struct hv_device *dev,
 264                                 struct netvsc_device *nvdev);
 265 int rndis_filter_set_rss_param(struct rndis_device *rdev,
 266                                const u8 *key);
 267 int rndis_filter_set_offload_params(struct net_device *ndev,
 268                                     struct netvsc_device *nvdev,
 269                                     struct ndis_offload_params *req_offloads);
 270 int rndis_filter_receive(struct net_device *ndev,
 271                          struct netvsc_device *net_dev,
 272                          struct netvsc_channel *nvchan,
 273                          void *data, u32 buflen);
 274
 275 int rndis_filter_set_device_mac(struct netvsc_device *ndev,
 276                                 const char *mac);
 277
 278 int netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
 279
 280 #define NVSP_INVALID_PROTOCOL_VERSION   ((u32)0xFFFFFFFF)
 281
 282 #define NVSP_PROTOCOL_VERSION_1         2
 283 #define NVSP_PROTOCOL_VERSION_2         0x30002
 284 #define NVSP_PROTOCOL_VERSION_4         0x40000
 285 #define NVSP_PROTOCOL_VERSION_5         0x50000
 286 #define NVSP_PROTOCOL_VERSION_6         0x60000
 287 #define NVSP_PROTOCOL_VERSION_61        0x60001
 288
 289 enum {
 290         NVSP_MSG_TYPE_NONE = 0,
 291
 292         /* Init Messages */
 293         NVSP_MSG_TYPE_INIT                      = 1,
 294         NVSP_MSG_TYPE_INIT_COMPLETE             = 2,
 295
 296         NVSP_VERSION_MSG_START                  = 100,
 297
 298         /* Version 1 Messages */
 299         NVSP_MSG1_TYPE_SEND_NDIS_VER            = NVSP_VERSION_MSG_START,
 300
 301         NVSP_MSG1_TYPE_SEND_RECV_BUF,
 302         NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
 303         NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
 304
 305         NVSP_MSG1_TYPE_SEND_SEND_BUF,
 306         NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
 307         NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
 308
 309         NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
 310         NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
 311
 312         /* Version 2 messages */
 313         NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
 314         NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
 315         NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
 316
 317         NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
 318
 319         NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
 320         NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
 321
 322         NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
 323
 324         NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
 325         NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
 326
 327         NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
 328         NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
 329
 330         NVSP_MSG2_TYPE_ALLOC_RXBUF,
 331         NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
 332
 333         NVSP_MSG2_TYPE_FREE_RXBUF,
 334
 335         NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
 336         NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
 337
 338         NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
 339
 340         NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
 341         NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 342
 343         NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 344
 345         /* Version 4 messages */
 346         NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
 347         NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
 348         NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 349
 350         NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 351
 352         /* Version 5 messages */
 353         NVSP_MSG5_TYPE_OID_QUERY_EX,
 354         NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
 355         NVSP_MSG5_TYPE_SUBCHANNEL,
 356         NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 357
 358         NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 359
 360         /* Version 6 messages */
 361         NVSP_MSG6_TYPE_PD_API,
 362         NVSP_MSG6_TYPE_PD_POST_BATCH,
 363
 364         NVSP_MSG6_MAX = NVSP_MSG6_TYPE_PD_POST_BATCH
 365 };
 366
 367 enum {
 368         NVSP_STAT_NONE = 0,
 369         NVSP_STAT_SUCCESS,
 370         NVSP_STAT_FAIL,
 371         NVSP_STAT_PROTOCOL_TOO_NEW,
 372         NVSP_STAT_PROTOCOL_TOO_OLD,
 373         NVSP_STAT_INVALID_RNDIS_PKT,
 374         NVSP_STAT_BUSY,
 375         NVSP_STAT_PROTOCOL_UNSUPPORTED,
 376         NVSP_STAT_MAX,
 377 };
 378
 379 struct nvsp_message_header {
 380         u32 msg_type;
 381 };
 382
 383 /* Init Messages */
 384
 385 /*
 386  * This message is used by the VSC to initialize the channel after the channels
 387  * has been opened. This message should never include anything other then
 388  * versioning (i.e. this message will be the same for ever).
 389  */
 390 struct nvsp_message_init {
 391         u32 min_protocol_ver;
 392         u32 max_protocol_ver;
 393 } __packed;
 394
 395 /*
 396  * This message is used by the VSP to complete the initialization of the
 397  * channel. This message should never include anything other then versioning
 398  * (i.e. this message will be the same for ever).
 399  */
 400 struct nvsp_message_init_complete {
 401         u32 negotiated_protocol_ver;
 402         u32 max_mdl_chain_len;
 403         u32 status;
 404 } __packed;
 405
 406 union nvsp_message_init_uber {
 407         struct nvsp_message_init init;
 408         struct nvsp_message_init_complete init_complete;
 409 } __packed;
 410
 411 /* Version 1 Messages */
 412
 413 /*
 414  * This message is used by the VSC to send the NDIS version to the VSP. The VSP
 415  * can use this information when handling OIDs sent by the VSC.
 416  */
 417 struct nvsp_1_message_send_ndis_version {
 418         u32 ndis_major_ver;
 419         u32 ndis_minor_ver;
 420 } __packed;
 421
 422 /*
 423  * This message is used by the VSC to send a receive buffer to the VSP. The VSP
 424  * can then use the receive buffer to send data to the VSC.
 425  */
 426 struct nvsp_1_message_send_receive_buffer {
 427         u32 gpadl_handle;
 428         u16 id;
 429 } __packed;
 430
 431 struct nvsp_1_receive_buffer_section {
 432         u32 offset;
 433         u32 sub_alloc_size;
 434         u32 num_sub_allocs;
 435         u32 end_offset;
 436 } __packed;
 437
 438 /*
 439  * This message is used by the VSP to acknowledge a receive buffer send by the
 440  * VSC. This message must be sent by the VSP before the VSP uses the receive
 441  * buffer.
 442  */
 443 struct nvsp_1_message_send_receive_buffer_complete {
 444         u32 status;
 445         u32 num_sections;
 446
 447         /*
 448          * The receive buffer is split into two parts, a large suballocation
 449          * section and a small suballocation section. These sections are then
 450          * suballocated by a certain size.
 451          */
 452
 453         /*
 454          * For example, the following break up of the receive buffer has 6
 455          * large suballocations and 10 small suballocations.
 456          */
 457
 458         /*
 459          * |            Large Section          |  |   Small Section   |
 460          * ------------------------------------------------------------
 461          * |     |     |     |     |     |     |  | | | | | | | | | | |
 462          * |                                      |
 463          *  LargeOffset                            SmallOffset
 464          */
 465
 466         struct nvsp_1_receive_buffer_section sections[1];
 467 } __packed;
 468
 469 /*
 470  * This message is sent by the VSC to revoke the receive buffer.  After the VSP
 471  * completes this transaction, the vsp should never use the receive buffer
 472  * again.
 473  */
 474 struct nvsp_1_message_revoke_receive_buffer {
 475         u16 id;
 476 };
 477
 478 /*
 479  * This message is used by the VSC to send a send buffer to the VSP. The VSC
 480  * can then use the send buffer to send data to the VSP.
 481  */
 482 struct nvsp_1_message_send_send_buffer {
 483         u32 gpadl_handle;
 484         u16 id;
 485 } __packed;
 486
 487 /*
 488  * This message is used by the VSP to acknowledge a send buffer sent by the
 489  * VSC. This message must be sent by the VSP before the VSP uses the sent
 490  * buffer.
 491  */
 492 struct nvsp_1_message_send_send_buffer_complete {
 493         u32 status;
 494
 495         /*
 496          * The VSC gets to choose the size of the send buffer and the VSP gets
 497          * to choose the sections size of the buffer.  This was done to enable
 498          * dynamic reconfigurations when the cost of GPA-direct buffers
 499          * decreases.
 500          */
 501         u32 section_size;
 502 } __packed;
 503
 504 /*
 505  * This message is sent by the VSC to revoke the send buffer.  After the VSP
 506  * completes this transaction, the vsp should never use the send buffer again.
 507  */
 508 struct nvsp_1_message_revoke_send_buffer {
 509         u16 id;
 510 };
 511
 512 /*
 513  * This message is used by both the VSP and the VSC to send a RNDIS message to
 514  * the opposite channel endpoint.
 515  */
 516 struct nvsp_1_message_send_rndis_packet {
 517         /*
 518          * This field is specified by RNDIS. They assume there's two different
 519          * channels of communication. However, the Network VSP only has one.
 520          * Therefore, the channel travels with the RNDIS packet.
 521          */
 522         u32 channel_type;
 523
 524         /*
 525          * This field is used to send part or all of the data through a send
 526          * buffer. This values specifies an index into the send buffer. If the
 527          * index is 0xFFFFFFFF, then the send buffer is not being used and all
 528          * of the data was sent through other VMBus mechanisms.
 529          */
 530         u32 send_buf_section_index;
 531         u32 send_buf_section_size;
 532 } __packed;
 533
 534 /*
 535  * This message is used by both the VSP and the VSC to complete a RNDIS message
 536  * to the opposite channel endpoint. At this point, the initiator of this
 537  * message cannot use any resources associated with the original RNDIS packet.
 538  */
 539 struct nvsp_1_message_send_rndis_packet_complete {
 540         u32 status;
 541 };
 542
 543 union nvsp_1_message_uber {
 544         struct nvsp_1_message_send_ndis_version send_ndis_ver;
 545
 546         struct nvsp_1_message_send_receive_buffer send_recv_buf;
 547         struct nvsp_1_message_send_receive_buffer_complete
 548                                                 send_recv_buf_complete;
 549         struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
 550
 551         struct nvsp_1_message_send_send_buffer send_send_buf;
 552         struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
 553         struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
 554
 555         struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
 556         struct nvsp_1_message_send_rndis_packet_complete
 557                                                 send_rndis_pkt_complete;
 558 } __packed;
 559
 560
 561 /*
 562  * Network VSP protocol version 2 messages:
 563  */
 564 struct nvsp_2_vsc_capability {
 565         union {
 566                 u64 data;
 567                 struct {
 568                         u64 vmq:1;
 569                         u64 chimney:1;
 570                         u64 sriov:1;
 571                         u64 ieee8021q:1;
 572                         u64 correlation_id:1;
 573                         u64 teaming:1;
 574                         u64 vsubnetid:1;
 575                         u64 rsc:1;
 576                 };
 577         };
 578 } __packed;
 579
 580 struct nvsp_2_send_ndis_config {
 581         u32 mtu;
 582         u32 reserved;
 583         struct nvsp_2_vsc_capability capability;
 584 } __packed;
 585
 586 /* Allocate receive buffer */
 587 struct nvsp_2_alloc_rxbuf {
 588         /* Allocation ID to match the allocation request and response */
 589         u32 alloc_id;
 590
 591         /* Length of the VM shared memory receive buffer that needs to
 592          * be allocated
 593          */
 594         u32 len;
 595 } __packed;
 596
 597 /* Allocate receive buffer complete */
 598 struct nvsp_2_alloc_rxbuf_comp {
 599         /* The NDIS_STATUS code for buffer allocation */
 600         u32 status;
 601
 602         u32 alloc_id;
 603
 604         /* GPADL handle for the allocated receive buffer */
 605         u32 gpadl_handle;
 606
 607         /* Receive buffer ID */
 608         u64 recv_buf_id;
 609 } __packed;
 610
 611 struct nvsp_2_free_rxbuf {
 612         u64 recv_buf_id;
 613 } __packed;
 614
 615 union nvsp_2_message_uber {
 616         struct nvsp_2_send_ndis_config send_ndis_config;
 617         struct nvsp_2_alloc_rxbuf alloc_rxbuf;
 618         struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
 619         struct nvsp_2_free_rxbuf free_rxbuf;
 620 } __packed;
 621
 622 struct nvsp_4_send_vf_association {
 623         /* 1: allocated, serial number is valid. 0: not allocated */
 624         u32 allocated;
 625
 626         /* Serial number of the VF to team with */
 627         u32 serial;
 628 } __packed;
 629
 630 enum nvsp_vm_datapath {
 631         NVSP_DATAPATH_SYNTHETIC = 0,
 632         NVSP_DATAPATH_VF,
 633         NVSP_DATAPATH_MAX
 634 };
 635
 636 struct nvsp_4_sw_datapath {
 637         u32 active_datapath; /* active data path in VM */
 638 } __packed;
 639
 640 union nvsp_4_message_uber {
 641         struct nvsp_4_send_vf_association vf_assoc;
 642         struct nvsp_4_sw_datapath active_dp;
 643 } __packed;
 644
 645 enum nvsp_subchannel_operation {
 646         NVSP_SUBCHANNEL_NONE = 0,
 647         NVSP_SUBCHANNEL_ALLOCATE,
 648         NVSP_SUBCHANNEL_MAX
 649 };
 650
 651 struct nvsp_5_subchannel_request {
 652         u32 op;
 653         u32 num_subchannels;
 654 } __packed;
 655
 656 struct nvsp_5_subchannel_complete {
 657         u32 status;
 658         u32 num_subchannels; /* Actual number of subchannels allocated */
 659 } __packed;
 660
 661 struct nvsp_5_send_indirect_table {
 662         /* The number of entries in the send indirection table */
 663         u32 count;
 664
 665         /* The offset of the send indirection table from the beginning of
 666          * struct nvsp_message.
 667          * The send indirection table tells which channel to put the send
 668          * traffic on. Each entry is a channel number.
 669          */
 670         u32 offset;
 671 } __packed;
 672
 673 union nvsp_5_message_uber {
 674         struct nvsp_5_subchannel_request subchn_req;
 675         struct nvsp_5_subchannel_complete subchn_comp;
 676         struct nvsp_5_send_indirect_table send_table;
 677 } __packed;
 678
 679 enum nvsp_6_pd_api_op {
 680         PD_API_OP_CONFIG = 1,
 681         PD_API_OP_SW_DATAPATH, /* Switch Datapath */
 682         PD_API_OP_OPEN_PROVIDER,
 683         PD_API_OP_CLOSE_PROVIDER,
 684         PD_API_OP_CREATE_QUEUE,
 685         PD_API_OP_FLUSH_QUEUE,
 686         PD_API_OP_FREE_QUEUE,
 687         PD_API_OP_ALLOC_COM_BUF, /* Allocate Common Buffer */
 688         PD_API_OP_FREE_COM_BUF, /* Free Common Buffer */
 689         PD_API_OP_MAX
 690 };
 691
 692 struct grp_affinity {
 693         u64 mask;
 694         u16 grp;
 695         u16 reserved[3];
 696 } __packed;
 697
 698 struct nvsp_6_pd_api_req {
 699         u32 op;
 700
 701         union {
 702                 /* MMIO information is sent from the VM to VSP */
 703                 struct __packed {
 704                         u64 mmio_pa; /* MMIO Physical Address */
 705                         u32 mmio_len;
 706
 707                         /* Number of PD queues a VM can support */
 708                         u16 num_subchn;
 709                 } config;
 710
 711                 /* Switch Datapath */
 712                 struct __packed {
 713                         /* Host Datapath Is PacketDirect */
 714                         u8 host_dpath_is_pd;
 715
 716                         /* Guest PacketDirect Is Enabled */
 717                         u8 guest_pd_enabled;
 718                 } sw_dpath;
 719
 720                 /* Open Provider*/
 721                 struct __packed {
 722                         u32 prov_id; /* Provider id */
 723                         u32 flag;
 724                 } open_prov;
 725
 726                 /* Close Provider */
 727                 struct __packed {
 728                         u32 prov_id;
 729                 } cls_prov;
 730
 731                 /* Create Queue*/
 732                 struct __packed {
 733                         u32 prov_id;
 734                         u16 q_id;
 735                         u16 q_size;
 736                         u8 is_recv_q;
 737                         u8 is_rss_q;
 738                         u32 recv_data_len;
 739                         struct grp_affinity affy;
 740                 } cr_q;
 741
 742                 /* Delete Queue*/
 743                 struct __packed {
 744                         u32 prov_id;
 745                         u16 q_id;
 746                 } del_q;
 747
 748                 /* Flush Queue */
 749                 struct __packed {
 750                         u32 prov_id;
 751                         u16 q_id;
 752                 } flush_q;
 753
 754                 /* Allocate Common Buffer */
 755                 struct __packed {
 756                         u32 len;
 757                         u32 pf_node; /* Preferred Node */
 758                         u16 region_id;
 759                 } alloc_com_buf;
 760
 761                 /* Free Common Buffer */
 762                 struct __packed {
 763                         u32 len;
 764                         u64 pa; /* Physical Address */
 765                         u32 pf_node; /* Preferred Node */
 766                         u16 region_id;
 767                         u8 cache_type;
 768                 } free_com_buf;
 769         } __packed;
 770 } __packed;
 771
 772 struct nvsp_6_pd_api_comp {
 773         u32 op;
 774         u32 status;
 775
 776         union {
 777                 struct __packed {
 778                         /* actual number of PD queues allocated to the VM */
 779                         u16 num_pd_q;
 780
 781                         /* Num Receive Rss PD Queues */
 782                         u8 num_rss_q;
 783
 784                         u8 is_supported; /* Is supported by VSP */
 785                         u8 is_enabled; /* Is enabled by VSP */
 786                 } config;
 787
 788                 /* Open Provider */
 789                 struct __packed {
 790                         u32 prov_id;
 791                 } open_prov;
 792
 793                 /* Create Queue */
 794                 struct __packed {
 795                         u32 prov_id;
 796                         u16 q_id;
 797                         u16 q_size;
 798                         u32 recv_data_len;
 799                         struct grp_affinity affy;
 800                 } cr_q;
 801
 802                 /* Allocate Common Buffer */
 803                 struct __packed {
 804                         u64 pa; /* Physical Address */
 805                         u32 len;
 806                         u32 pf_node; /* Preferred Node */
 807                         u16 region_id;
 808                         u8 cache_type;
 809                 } alloc_com_buf;
 810         } __packed;
 811 } __packed;
 812
 813 struct nvsp_6_pd_buf {
 814         u32 region_offset;
 815         u16 region_id;
 816         u16 is_partial:1;
 817         u16 reserved:15;
 818 } __packed;
 819
 820 struct nvsp_6_pd_batch_msg {
 821         struct nvsp_message_header hdr;
 822         u16 count;
 823         u16 guest2host:1;
 824         u16 is_recv:1;
 825         u16 reserved:14;
 826         struct nvsp_6_pd_buf pd_buf[0];
 827 } __packed;
 828
 829 union nvsp_6_message_uber {
 830         struct nvsp_6_pd_api_req pd_req;
 831         struct nvsp_6_pd_api_comp pd_comp;
 832 } __packed;
 833
 834 union nvsp_all_messages {
 835         union nvsp_message_init_uber init_msg;
 836         union nvsp_1_message_uber v1_msg;
 837         union nvsp_2_message_uber v2_msg;
 838         union nvsp_4_message_uber v4_msg;
 839         union nvsp_5_message_uber v5_msg;
 840         union nvsp_6_message_uber v6_msg;
 841 } __packed;
 842
 843 /* ALL Messages */
 844 struct nvsp_message {
 845         struct nvsp_message_header hdr;
 846         union nvsp_all_messages msg;
 847 } __packed;
 848
 849
 850 #define NETVSC_MTU 65535
 851 #define NETVSC_MTU_MIN ETH_MIN_MTU
 852
 853 /* Max buffer sizes allowed by a host */
 854 #define NETVSC_RECEIVE_BUFFER_SIZE              (1024 * 1024 * 31) /* 31MB */
 855 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY       (1024 * 1024 * 15) /* 15MB */
 856 #define NETVSC_RECEIVE_BUFFER_DEFAULT           (1024 * 1024 * 16)
 857
 858 #define NETVSC_SEND_BUFFER_SIZE                 (1024 * 1024 * 15)  /* 15MB */
 859 #define NETVSC_SEND_BUFFER_DEFAULT              (1024 * 1024)
 860
 861 #define NETVSC_INVALID_INDEX                    -1
 862
 863 #define NETVSC_SEND_SECTION_SIZE                6144
 864 #define NETVSC_RECV_SECTION_SIZE                1728
 865
 866 /* Default size of TX buf: 1MB, RX buf: 16MB */
 867 #define NETVSC_MIN_TX_SECTIONS  10
 868 #define NETVSC_DEFAULT_TX       (NETVSC_SEND_BUFFER_DEFAULT \
 869                                  / NETVSC_SEND_SECTION_SIZE)
 870 #define NETVSC_MIN_RX_SECTIONS  10
 871 #define NETVSC_DEFAULT_RX       (NETVSC_RECEIVE_BUFFER_DEFAULT \
 872                                  / NETVSC_RECV_SECTION_SIZE)
 873
 874 #define NETVSC_RECEIVE_BUFFER_ID                0xcafe
 875 #define NETVSC_SEND_BUFFER_ID                   0
 876
 877 #define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
 878                                       NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
 879                                       NETIF_F_TSO6 | NETIF_F_LRO | \
 880                                       NETIF_F_SG | NETIF_F_RXHASH)
 881
 882 #define VRSS_SEND_TAB_SIZE 16  /* must be power of 2 */
 883 #define VRSS_CHANNEL_MAX 64
 884 #define VRSS_CHANNEL_DEFAULT 8
 885
 886 #define RNDIS_MAX_PKT_DEFAULT 8
 887 #define RNDIS_PKT_ALIGN_DEFAULT 8
 888
 889 #define NETVSC_XDP_HDRM 256
 890
 891 #define NETVSC_MIN_OUT_MSG_SIZE (sizeof(struct vmpacket_descriptor) + \
 892                                  sizeof(struct nvsp_message))
 893 #define NETVSC_MIN_IN_MSG_SIZE sizeof(struct vmpacket_descriptor)
 894
 895 /* Estimated requestor size:
 896  * out_ring_size/min_out_msg_size + in_ring_size/min_in_msg_size
 897  */
 898 static inline u32 netvsc_rqstor_size(unsigned long ringbytes)
 899 {
 900         return ringbytes / NETVSC_MIN_OUT_MSG_SIZE +
 901                 ringbytes / NETVSC_MIN_IN_MSG_SIZE;
 902 }
 903
 904 /* XFER PAGE packets can specify a maximum of 375 ranges for NDIS >= 6.0
 905  * and a maximum of 64 ranges for NDIS < 6.0 with no RSC; with RSC, this
 906  * limit is raised to 562 (= NVSP_RSC_MAX).
 907  */
 908 #define NETVSC_MAX_XFER_PAGE_RANGES NVSP_RSC_MAX
 909 #define NETVSC_XFER_HEADER_SIZE(rng_cnt) \
 910                 (offsetof(struct vmtransfer_page_packet_header, ranges) + \
 911                 (rng_cnt) * sizeof(struct vmtransfer_page_range))
 912 #define NETVSC_MAX_PKT_SIZE (NETVSC_XFER_HEADER_SIZE(NETVSC_MAX_XFER_PAGE_RANGES) + \
 913                 sizeof(struct nvsp_message) + (sizeof(u32) * VRSS_SEND_TAB_SIZE))
 914
 915 struct multi_send_data {
 916         struct sk_buff *skb; /* skb containing the pkt */
 917         struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
 918         u32 count; /* counter of batched packets */
 919 };
 920
 921 struct recv_comp_data {
 922         u64 tid; /* transaction id */
 923         u32 status;
 924 };
 925
 926 struct multi_recv_comp {
 927         struct recv_comp_data *slots;
 928         u32 first;      /* first data entry */
 929         u32 next;       /* next entry for writing */
 930 };
 931
 932 #define NVSP_RSC_MAX 562 /* Max #RSC frags in a vmbus xfer page pkt */
 933
 934 struct nvsc_rsc {
 935         struct ndis_pkt_8021q_info vlan;
 936         struct ndis_tcp_ip_checksum_info csum_info;
 937         u32 hash_info;
 938         u8 ppi_flags; /* valid/present bits for the above PPIs */
 939         u8 is_last; /* last RNDIS msg in a vmtransfer_page */
 940         u32 cnt; /* #fragments in an RSC packet */
 941         u32 pktlen; /* Full packet length */
 942         void *data[NVSP_RSC_MAX];
 943         u32 len[NVSP_RSC_MAX];
 944 };
 945
 946 #define NVSC_RSC_VLAN           BIT(0)  /* valid/present bit for 'vlan' */
 947 #define NVSC_RSC_CSUM_INFO      BIT(1)  /* valid/present bit for 'csum_info' */
 948 #define NVSC_RSC_HASH_INFO      BIT(2)  /* valid/present bit for 'hash_info' */
 949
 950 struct netvsc_stats_tx {
 951         u64 packets;
 952         u64 bytes;
 953         u64 xdp_xmit;
 954         struct u64_stats_sync syncp;
 955 };
 956
 957 struct netvsc_stats_rx {
 958         u64 packets;
 959         u64 bytes;
 960         u64 broadcast;
 961         u64 multicast;
 962         u64 xdp_drop;
 963         u64 xdp_redirect;
 964         u64 xdp_tx;
 965         struct u64_stats_sync syncp;
 966 };
 967
 968 struct netvsc_ethtool_stats {
 969         unsigned long tx_scattered;
 970         unsigned long tx_no_memory;
 971         unsigned long tx_no_space;
 972         unsigned long tx_too_big;
 973         unsigned long tx_busy;
 974         unsigned long tx_send_full;
 975         unsigned long rx_comp_busy;
 976         unsigned long rx_no_memory;
 977         unsigned long stop_queue;
 978         unsigned long wake_queue;
 979         unsigned long vlan_error;
 980 };
 981
 982 struct netvsc_ethtool_pcpu_stats {
 983         u64     rx_packets;
 984         u64     rx_bytes;
 985         u64     tx_packets;
 986         u64     tx_bytes;
 987         u64     vf_rx_packets;
 988         u64     vf_rx_bytes;
 989         u64     vf_tx_packets;
 990         u64     vf_tx_bytes;
 991 };
 992
 993 struct netvsc_vf_pcpu_stats {
 994         u64     rx_packets;
 995         u64     rx_bytes;
 996         u64     tx_packets;
 997         u64     tx_bytes;
 998         struct u64_stats_sync   syncp;
 999         u32     tx_dropped;
1000 };
1001
1002 struct netvsc_reconfig {
1003         struct list_head list;
1004         u32 event;
1005 };
1006
1007 /* L4 hash bits for different protocols */
1008 #define HV_TCP4_L4HASH 1
1009 #define HV_TCP6_L4HASH 2
1010 #define HV_UDP4_L4HASH 4
1011 #define HV_UDP6_L4HASH 8
1012 #define HV_DEFAULT_L4HASH (HV_TCP4_L4HASH | HV_TCP6_L4HASH | HV_UDP4_L4HASH | \
1013                            HV_UDP6_L4HASH)
1014
1015 /* The context of the netvsc device  */
1016 struct net_device_context {
1017         /* point back to our device context */
1018         struct hv_device *device_ctx;
1019         /* netvsc_device */
1020         struct netvsc_device __rcu *nvdev;
1021         /* list of netvsc net_devices */
1022         struct list_head list;
1023         /* reconfigure work */
1024         struct delayed_work dwork;
1025         /* last reconfig time */
1026         unsigned long last_reconfig;
1027         /* reconfig events */
1028         struct list_head reconfig_events;
1029         /* list protection */
1030         spinlock_t lock;
1031
1032         u32 msg_enable; /* debug level */
1033
1034         u32 tx_checksum_mask;
1035
1036         u32 tx_table[VRSS_SEND_TAB_SIZE];
1037
1038         u16 *rx_table;
1039
1040         u32 rx_table_sz;
1041
1042         /* Ethtool settings */
1043         u8 duplex;
1044         u32 speed;
1045         u32 l4_hash; /* L4 hash settings */
1046         struct netvsc_ethtool_stats eth_stats;
1047
1048         /* State to manage the associated VF interface. */
1049         struct net_device __rcu *vf_netdev;
1050         struct netvsc_vf_pcpu_stats __percpu *vf_stats;
1051         struct delayed_work vf_takeover;
1052
1053         /* 1: allocated, serial number is valid. 0: not allocated */
1054         u32 vf_alloc;
1055         /* Serial number of the VF to team with */
1056         u32 vf_serial;
1057         /* completion variable to confirm vf association */
1058         struct completion vf_add;
1059         /* Is the current data path through the VF NIC? */
1060         bool  data_path_is_vf;
1061
1062         /* Used to temporarily save the config info across hibernation */
1063         struct netvsc_device_info *saved_netvsc_dev_info;
1064 };
1065
1066 /* Azure hosts don't support non-TCP port numbers in hashing for fragmented
1067  * packets. We can use ethtool to change UDP hash level when necessary.
1068  */
1069 static inline u32 netvsc_get_hash(struct sk_buff *skb,
1070                                   const struct net_device_context *ndc)
1071 {
1072         struct flow_keys flow;
1073         u32 hash, pkt_proto = 0;
1074         static u32 hashrnd __read_mostly;
1075
1076         net_get_random_once(&hashrnd, sizeof(hashrnd));
1077
1078         if (!skb_flow_dissect_flow_keys(skb, &flow, 0))
1079                 return 0;
1080
1081         switch (flow.basic.ip_proto) {
1082         case IPPROTO_TCP:
1083                 if (flow.basic.n_proto == htons(ETH_P_IP))
1084                         pkt_proto = HV_TCP4_L4HASH;
1085                 else if (flow.basic.n_proto == htons(ETH_P_IPV6))
1086                         pkt_proto = HV_TCP6_L4HASH;
1087
1088                 break;
1089
1090         case IPPROTO_UDP:
1091                 if (flow.basic.n_proto == htons(ETH_P_IP))
1092                         pkt_proto = HV_UDP4_L4HASH;
1093                 else if (flow.basic.n_proto == htons(ETH_P_IPV6))
1094                         pkt_proto = HV_UDP6_L4HASH;
1095
1096                 break;
1097         }
1098
1099         if (pkt_proto & ndc->l4_hash) {
1100                 return skb_get_hash(skb);
1101         } else {
1102                 if (flow.basic.n_proto == htons(ETH_P_IP))
1103                         hash = jhash2((u32 *)&flow.addrs.v4addrs, 2, hashrnd);
1104                 else if (flow.basic.n_proto == htons(ETH_P_IPV6))
1105                         hash = jhash2((u32 *)&flow.addrs.v6addrs, 8, hashrnd);
1106                 else
1107                         return 0;
1108
1109                 __skb_set_sw_hash(skb, hash, false);
1110         }
1111
1112         return hash;
1113 }
1114
1115 /* Per channel data */
1116 struct netvsc_channel {
1117         struct vmbus_channel *channel;
1118         struct netvsc_device *net_device;
1119         void *recv_buf; /* buffer to copy packets out from the receive buffer */
1120         const struct vmpacket_descriptor *desc;
1121         struct napi_struct napi;
1122         struct multi_send_data msd;
1123         struct multi_recv_comp mrc;
1124         atomic_t queue_sends;
1125         struct nvsc_rsc rsc;
1126
1127         struct bpf_prog __rcu *bpf_prog;
1128         struct xdp_rxq_info xdp_rxq;
1129         bool xdp_flush;
1130
1131         struct netvsc_stats_tx tx_stats;
1132         struct netvsc_stats_rx rx_stats;
1133 };
1134
1135 /* Per netvsc device */
1136 struct netvsc_device {
1137         u32 nvsp_version;
1138
1139         wait_queue_head_t wait_drain;
1140         bool destroy;
1141         bool tx_disable; /* if true, do not wake up queue again */
1142
1143         /* Receive buffer allocated by us but manages by NetVSP */
1144         void *recv_buf;
1145         u32 recv_buf_size; /* allocated bytes */
1146         struct vmbus_gpadl recv_buf_gpadl_handle;
1147         u32 recv_section_cnt;
1148         u32 recv_section_size;
1149         u32 recv_completion_cnt;
1150
1151         /* Send buffer allocated by us */
1152         void *send_buf;
1153         u32 send_buf_size;
1154         struct vmbus_gpadl send_buf_gpadl_handle;
1155         u32 send_section_cnt;
1156         u32 send_section_size;
1157         unsigned long *send_section_map;
1158
1159         /* Used for NetVSP initialization protocol */
1160         struct completion channel_init_wait;
1161         struct nvsp_message channel_init_pkt;
1162
1163         struct nvsp_message revoke_packet;
1164
1165         u32 max_chn;
1166         u32 num_chn;
1167
1168         atomic_t open_chn;
1169         struct work_struct subchan_work;
1170         wait_queue_head_t subchan_open;
1171
1172         struct rndis_device *extension;
1173
1174         u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
1175         u32 pkt_align; /* alignment bytes, e.g. 8 */
1176
1177         struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
1178
1179         struct rcu_head rcu;
1180 };
1181
1182 /* NdisInitialize message */
1183 struct rndis_initialize_request {
1184         u32 req_id;
1185         u32 major_ver;
1186         u32 minor_ver;
1187         u32 max_xfer_size;
1188 };
1189
1190 /* Response to NdisInitialize */
1191 struct rndis_initialize_complete {
1192         u32 req_id;
1193         u32 status;
1194         u32 major_ver;
1195         u32 minor_ver;
1196         u32 dev_flags;
1197         u32 medium;
1198         u32 max_pkt_per_msg;
1199         u32 max_xfer_size;
1200         u32 pkt_alignment_factor;
1201         u32 af_list_offset;
1202         u32 af_list_size;
1203 };
1204
1205 /* Call manager devices only: Information about an address family */
1206 /* supported by the device is appended to the response to NdisInitialize. */
1207 struct rndis_co_address_family {
1208         u32 address_family;
1209         u32 major_ver;
1210         u32 minor_ver;
1211 };
1212
1213 /* NdisHalt message */
1214 struct rndis_halt_request {
1215         u32 req_id;
1216 };
1217
1218 /* NdisQueryRequest message */
1219 struct rndis_query_request {
1220         u32 req_id;
1221         u32 oid;
1222         u32 info_buflen;
1223         u32 info_buf_offset;
1224         u32 dev_vc_handle;
1225 };
1226
1227 /* Response to NdisQueryRequest */
1228 struct rndis_query_complete {
1229         u32 req_id;
1230         u32 status;
1231         u32 info_buflen;
1232         u32 info_buf_offset;
1233 };
1234
1235 /* NdisSetRequest message */
1236 struct rndis_set_request {
1237         u32 req_id;
1238         u32 oid;
1239         u32 info_buflen;
1240         u32 info_buf_offset;
1241         u32 dev_vc_handle;
1242         u8  info_buf[];
1243 };
1244
1245 /* Response to NdisSetRequest */
1246 struct rndis_set_complete {
1247         u32 req_id;
1248         u32 status;
1249 };
1250
1251 /* NdisReset message */
1252 struct rndis_reset_request {
1253         u32 reserved;
1254 };
1255
1256 /* Response to NdisReset */
1257 struct rndis_reset_complete {
1258         u32 status;
1259         u32 addressing_reset;
1260 };
1261
1262 /* NdisMIndicateStatus message */
1263 struct rndis_indicate_status {
1264         u32 status;
1265         u32 status_buflen;
1266         u32 status_buf_offset;
1267 };
1268
1269 /* Diagnostic information passed as the status buffer in */
1270 /* struct rndis_indicate_status messages signifying error conditions. */
1271 struct rndis_diagnostic_info {
1272         u32 diag_status;
1273         u32 error_offset;
1274 };
1275
1276 /* NdisKeepAlive message */
1277 struct rndis_keepalive_request {
1278         u32 req_id;
1279 };
1280
1281 /* Response to NdisKeepAlive */
1282 struct rndis_keepalive_complete {
1283         u32 req_id;
1284         u32 status;
1285 };
1286
1287 /*
1288  * Data message. All Offset fields contain byte offsets from the beginning of
1289  * struct rndis_packet. All Length fields are in bytes.  VcHandle is set
1290  * to 0 for connectionless data, otherwise it contains the VC handle.
1291  */
1292 struct rndis_packet {
1293         u32 data_offset;
1294         u32 data_len;
1295         u32 oob_data_offset;
1296         u32 oob_data_len;
1297         u32 num_oob_data_elements;
1298         u32 per_pkt_info_offset;
1299         u32 per_pkt_info_len;
1300         u32 vc_handle;
1301         u32 reserved;
1302 };
1303
1304 /* Optional Out of Band data associated with a Data message. */
1305 struct rndis_oobd {
1306         u32 size;
1307         u32 type;
1308         u32 class_info_offset;
1309 };
1310
1311 /* Packet extension field contents associated with a Data message. */
1312 struct rndis_per_packet_info {
1313         u32 size;
1314         u32 type:31;
1315         u32 internal:1;
1316         u32 ppi_offset;
1317 };
1318
1319 enum ndis_per_pkt_info_type {
1320         TCPIP_CHKSUM_PKTINFO,
1321         IPSEC_PKTINFO,
1322         TCP_LARGESEND_PKTINFO,
1323         CLASSIFICATION_HANDLE_PKTINFO,
1324         NDIS_RESERVED,
1325         SG_LIST_PKTINFO,
1326         IEEE_8021Q_INFO,
1327         ORIGINAL_PKTINFO,
1328         PACKET_CANCEL_ID,
1329         NBL_HASH_VALUE = PACKET_CANCEL_ID,
1330         ORIGINAL_NET_BUFLIST,
1331         CACHED_NET_BUFLIST,
1332         SHORT_PKT_PADINFO,
1333         MAX_PER_PKT_INFO
1334 };
1335
1336 enum rndis_per_pkt_info_interal_type {
1337         RNDIS_PKTINFO_ID = 1,
1338         /* Add more members here */
1339
1340         RNDIS_PKTINFO_MAX
1341 };
1342
1343 #define RNDIS_PKTINFO_SUBALLOC BIT(0)
1344 #define RNDIS_PKTINFO_1ST_FRAG BIT(1)
1345 #define RNDIS_PKTINFO_LAST_FRAG BIT(2)
1346
1347 #define RNDIS_PKTINFO_ID_V1 1
1348
1349 struct rndis_pktinfo_id {
1350         u8 ver;
1351         u8 flag;
1352         u16 pkt_id;
1353 };
1354
1355 struct ndis_object_header {
1356         u8 type;
1357         u8 revision;
1358         u16 size;
1359 };
1360
1361 #define NDIS_OBJECT_TYPE_DEFAULT        0x80
1362 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
1363 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
1364 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
1365
1366 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
1367 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
1368 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED  2
1369 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED  2
1370 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
1371 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1372 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1373 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1374 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1375 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1376
1377 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE     1
1378 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4        0
1379 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6        1
1380
1381 #define VERSION_4_OFFLOAD_SIZE                  22
1382 /*
1383  * New offload OIDs for NDIS 6
1384  */
1385 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1386 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C           /* set only */
1387 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1388 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1389 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1390 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1391
1392 /*
1393  * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1394  * ndis_type: NDIS_OBJTYPE_OFFLOAD
1395  */
1396
1397 #define NDIS_OFFLOAD_ENCAP_NONE         0x0000
1398 #define NDIS_OFFLOAD_ENCAP_NULL         0x0001
1399 #define NDIS_OFFLOAD_ENCAP_8023         0x0002
1400 #define NDIS_OFFLOAD_ENCAP_8023PQ       0x0004
1401 #define NDIS_OFFLOAD_ENCAP_8023PQ_OOB   0x0008
1402 #define NDIS_OFFLOAD_ENCAP_RFC1483      0x0010
1403
1404 struct ndis_csum_offload {
1405         u32     ip4_txenc;
1406         u32     ip4_txcsum;
1407 #define NDIS_TXCSUM_CAP_IP4OPT          0x001
1408 #define NDIS_TXCSUM_CAP_TCP4OPT         0x004
1409 #define NDIS_TXCSUM_CAP_TCP4            0x010
1410 #define NDIS_TXCSUM_CAP_UDP4            0x040
1411 #define NDIS_TXCSUM_CAP_IP4             0x100
1412
1413 #define NDIS_TXCSUM_ALL_TCP4    (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1414
1415         u32     ip4_rxenc;
1416         u32     ip4_rxcsum;
1417 #define NDIS_RXCSUM_CAP_IP4OPT          0x001
1418 #define NDIS_RXCSUM_CAP_TCP4OPT         0x004
1419 #define NDIS_RXCSUM_CAP_TCP4            0x010
1420 #define NDIS_RXCSUM_CAP_UDP4            0x040
1421 #define NDIS_RXCSUM_CAP_IP4             0x100
1422         u32     ip6_txenc;
1423         u32     ip6_txcsum;
1424 #define NDIS_TXCSUM_CAP_IP6EXT          0x001
1425 #define NDIS_TXCSUM_CAP_TCP6OPT         0x004
1426 #define NDIS_TXCSUM_CAP_TCP6            0x010
1427 #define NDIS_TXCSUM_CAP_UDP6            0x040
1428         u32     ip6_rxenc;
1429         u32     ip6_rxcsum;
1430 #define NDIS_RXCSUM_CAP_IP6EXT          0x001
1431 #define NDIS_RXCSUM_CAP_TCP6OPT         0x004
1432 #define NDIS_RXCSUM_CAP_TCP6            0x010
1433 #define NDIS_RXCSUM_CAP_UDP6            0x040
1434
1435 #define NDIS_TXCSUM_ALL_TCP6    (NDIS_TXCSUM_CAP_TCP6 |         \
1436                                  NDIS_TXCSUM_CAP_TCP6OPT |      \
1437                                  NDIS_TXCSUM_CAP_IP6EXT)
1438 };
1439
1440 struct ndis_lsov1_offload {
1441         u32     encap;
1442         u32     maxsize;
1443         u32     minsegs;
1444         u32     opts;
1445 };
1446
1447 struct ndis_ipsecv1_offload {
1448         u32     encap;
1449         u32     ah_esp;
1450         u32     xport_tun;
1451         u32     ip4_opts;
1452         u32     flags;
1453         u32     ip4_ah;
1454         u32     ip4_esp;
1455 };
1456
1457 struct ndis_lsov2_offload {
1458         u32     ip4_encap;
1459         u32     ip4_maxsz;
1460         u32     ip4_minsg;
1461         u32     ip6_encap;
1462         u32     ip6_maxsz;
1463         u32     ip6_minsg;
1464         u32     ip6_opts;
1465 #define NDIS_LSOV2_CAP_IP6EXT           0x001
1466 #define NDIS_LSOV2_CAP_TCP6OPT          0x004
1467
1468 #define NDIS_LSOV2_CAP_IP6              (NDIS_LSOV2_CAP_IP6EXT | \
1469                                          NDIS_LSOV2_CAP_TCP6OPT)
1470 };
1471
1472 struct ndis_ipsecv2_offload {
1473         u32     encap;
1474         u8      ip6;
1475         u8      ip4opt;
1476         u8      ip6ext;
1477         u8      ah;
1478         u8      esp;
1479         u8      ah_esp;
1480         u8      xport;
1481         u8      tun;
1482         u8      xport_tun;
1483         u8      lso;
1484         u8      extseq;
1485         u32     udp_esp;
1486         u32     auth;
1487         u32     crypto;
1488         u32     sa_caps;
1489 };
1490
1491 struct ndis_rsc_offload {
1492         u8      ip4;
1493         u8      ip6;
1494 };
1495
1496 struct ndis_encap_offload {
1497         u32     flags;
1498         u32     maxhdr;
1499 };
1500
1501 struct ndis_offload {
1502         struct ndis_object_header       header;
1503         struct ndis_csum_offload        csum;
1504         struct ndis_lsov1_offload       lsov1;
1505         struct ndis_ipsecv1_offload     ipsecv1;
1506         struct ndis_lsov2_offload       lsov2;
1507         u32                             flags;
1508         /* NDIS >= 6.1 */
1509         struct ndis_ipsecv2_offload     ipsecv2;
1510         /* NDIS >= 6.30 */
1511         struct ndis_rsc_offload         rsc;
1512         struct ndis_encap_offload       encap_gre;
1513 };
1514
1515 #define NDIS_OFFLOAD_SIZE               sizeof(struct ndis_offload)
1516 #define NDIS_OFFLOAD_SIZE_6_0           offsetof(struct ndis_offload, ipsecv2)
1517 #define NDIS_OFFLOAD_SIZE_6_1           offsetof(struct ndis_offload, rsc)
1518
1519 struct ndis_offload_params {
1520         struct ndis_object_header header;
1521         u8 ip_v4_csum;
1522         u8 tcp_ip_v4_csum;
1523         u8 udp_ip_v4_csum;
1524         u8 tcp_ip_v6_csum;
1525         u8 udp_ip_v6_csum;
1526         u8 lso_v1;
1527         u8 ip_sec_v1;
1528         u8 lso_v2_ipv4;
1529         u8 lso_v2_ipv6;
1530         u8 tcp_connection_ip_v4;
1531         u8 tcp_connection_ip_v6;
1532         u32 flags;
1533         u8 ip_sec_v2;
1534         u8 ip_sec_v2_ip_v4;
1535         struct {
1536                 u8 rsc_ip_v4;
1537                 u8 rsc_ip_v6;
1538         };
1539         struct {
1540                 u8 encapsulated_packet_task_offload;
1541                 u8 encapsulation_types;
1542         };
1543 };
1544
1545 struct ndis_tcp_lso_info {
1546         union {
1547                 struct {
1548                         u32 unused:30;
1549                         u32 type:1;
1550                         u32 reserved2:1;
1551                 } transmit;
1552                 struct {
1553                         u32 mss:20;
1554                         u32 tcp_header_offset:10;
1555                         u32 type:1;
1556                         u32 reserved2:1;
1557                 } lso_v1_transmit;
1558                 struct {
1559                         u32 tcp_payload:30;
1560                         u32 type:1;
1561                         u32 reserved2:1;
1562                 } lso_v1_transmit_complete;
1563                 struct {
1564                         u32 mss:20;
1565                         u32 tcp_header_offset:10;
1566                         u32 type:1;
1567                         u32 ip_version:1;
1568                 } lso_v2_transmit;
1569                 struct {
1570                         u32 reserved:30;
1571                         u32 type:1;
1572                         u32 reserved2:1;
1573                 } lso_v2_transmit_complete;
1574                 u32  value;
1575         };
1576 };
1577
1578 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1579                 sizeof(struct ndis_pkt_8021q_info))
1580
1581 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1582                 sizeof(struct ndis_tcp_ip_checksum_info))
1583
1584 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1585                 sizeof(struct ndis_tcp_lso_info))
1586
1587 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1588                 sizeof(u32))
1589
1590 /* Total size of all PPI data */
1591 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1592                            NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1593
1594 /* Format of Information buffer passed in a SetRequest for the OID */
1595 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1596 struct rndis_config_parameter_info {
1597         u32 parameter_name_offset;
1598         u32 parameter_name_length;
1599         u32 parameter_type;
1600         u32 parameter_value_offset;
1601         u32 parameter_value_length;
1602 };
1603
1604 /* Values for ParameterType in struct rndis_config_parameter_info */
1605 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER     0
1606 #define RNDIS_CONFIG_PARAM_TYPE_STRING      2
1607
1608 /* CONDIS Miniport messages for connection oriented devices */
1609 /* that do not implement a call manager. */
1610
1611 /* CoNdisMiniportCreateVc message */
1612 struct rcondis_mp_create_vc {
1613         u32 req_id;
1614         u32 ndis_vc_handle;
1615 };
1616
1617 /* Response to CoNdisMiniportCreateVc */
1618 struct rcondis_mp_create_vc_complete {
1619         u32 req_id;
1620         u32 dev_vc_handle;
1621         u32 status;
1622 };
1623
1624 /* CoNdisMiniportDeleteVc message */
1625 struct rcondis_mp_delete_vc {
1626         u32 req_id;
1627         u32 dev_vc_handle;
1628 };
1629
1630 /* Response to CoNdisMiniportDeleteVc */
1631 struct rcondis_mp_delete_vc_complete {
1632         u32 req_id;
1633         u32 status;
1634 };
1635
1636 /* CoNdisMiniportQueryRequest message */
1637 struct rcondis_mp_query_request {
1638         u32 req_id;
1639         u32 request_type;
1640         u32 oid;
1641         u32 dev_vc_handle;
1642         u32 info_buflen;
1643         u32 info_buf_offset;
1644 };
1645
1646 /* CoNdisMiniportSetRequest message */
1647 struct rcondis_mp_set_request {
1648         u32 req_id;
1649         u32 request_type;
1650         u32 oid;
1651         u32 dev_vc_handle;
1652         u32 info_buflen;
1653         u32 info_buf_offset;
1654 };
1655
1656 /* CoNdisIndicateStatus message */
1657 struct rcondis_indicate_status {
1658         u32 ndis_vc_handle;
1659         u32 status;
1660         u32 status_buflen;
1661         u32 status_buf_offset;
1662 };
1663
1664 /* CONDIS Call/VC parameters */
1665 struct rcondis_specific_parameters {
1666         u32 parameter_type;
1667         u32 parameter_length;
1668         u32 parameter_lffset;
1669 };
1670
1671 struct rcondis_media_parameters {
1672         u32 flags;
1673         u32 reserved1;
1674         u32 reserved2;
1675         struct rcondis_specific_parameters media_specific;
1676 };
1677
1678 struct rndis_flowspec {
1679         u32 token_rate;
1680         u32 token_bucket_size;
1681         u32 peak_bandwidth;
1682         u32 latency;
1683         u32 delay_variation;
1684         u32 service_type;
1685         u32 max_sdu_size;
1686         u32 minimum_policed_size;
1687 };
1688
1689 struct rcondis_call_manager_parameters {
1690         struct rndis_flowspec transmit;
1691         struct rndis_flowspec receive;
1692         struct rcondis_specific_parameters call_mgr_specific;
1693 };
1694
1695 /* CoNdisMiniportActivateVc message */
1696 struct rcondis_mp_activate_vc_request {
1697         u32 req_id;
1698         u32 flags;
1699         u32 dev_vc_handle;
1700         u32 media_params_offset;
1701         u32 media_params_length;
1702         u32 call_mgr_params_offset;
1703         u32 call_mgr_params_length;
1704 };
1705
1706 /* Response to CoNdisMiniportActivateVc */
1707 struct rcondis_mp_activate_vc_complete {
1708         u32 req_id;
1709         u32 status;
1710 };
1711
1712 /* CoNdisMiniportDeactivateVc message */
1713 struct rcondis_mp_deactivate_vc_request {
1714         u32 req_id;
1715         u32 flags;
1716         u32 dev_vc_handle;
1717 };
1718
1719 /* Response to CoNdisMiniportDeactivateVc */
1720 struct rcondis_mp_deactivate_vc_complete {
1721         u32 req_id;
1722         u32 status;
1723 };
1724
1725
1726 /* union with all of the RNDIS messages */
1727 union rndis_message_container {
1728         struct rndis_packet pkt;
1729         struct rndis_initialize_request init_req;
1730         struct rndis_halt_request halt_req;
1731         struct rndis_query_request query_req;
1732         struct rndis_set_request set_req;
1733         struct rndis_reset_request reset_req;
1734         struct rndis_keepalive_request keep_alive_req;
1735         struct rndis_indicate_status indicate_status;
1736         struct rndis_initialize_complete init_complete;
1737         struct rndis_query_complete query_complete;
1738         struct rndis_set_complete set_complete;
1739         struct rndis_reset_complete reset_complete;
1740         struct rndis_keepalive_complete keep_alive_complete;
1741         struct rcondis_mp_create_vc co_miniport_create_vc;
1742         struct rcondis_mp_delete_vc co_miniport_delete_vc;
1743         struct rcondis_indicate_status co_indicate_status;
1744         struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1745         struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1746         struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1747         struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1748         struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1749         struct rcondis_mp_deactivate_vc_complete
1750                 co_miniport_deactivate_vc_complete;
1751 };
1752
1753 /* Remote NDIS message format */
1754 struct rndis_message {
1755         u32 ndis_msg_type;
1756
1757         /* Total length of this message, from the beginning */
1758         /* of the struct rndis_message, in bytes. */
1759         u32 msg_len;
1760
1761         /* Actual message */
1762         union rndis_message_container msg;
1763 };
1764
1765
1766 /* Handy macros */
1767
1768 /* get the size of an RNDIS message. Pass in the message type, */
1769 /* struct rndis_set_request, struct rndis_packet for example */
1770 #define RNDIS_MESSAGE_SIZE(msg)                         \
1771         (sizeof(msg) + (sizeof(struct rndis_message) -  \
1772          sizeof(union rndis_message_container)))
1773
1774 #define RNDIS_HEADER_SIZE       (sizeof(struct rndis_message) - \
1775                                  sizeof(union rndis_message_container))
1776
1777 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1778
1779 #define NDIS_PACKET_TYPE_DIRECTED       0x00000001
1780 #define NDIS_PACKET_TYPE_MULTICAST      0x00000002
1781 #define NDIS_PACKET_TYPE_ALL_MULTICAST  0x00000004
1782 #define NDIS_PACKET_TYPE_BROADCAST      0x00000008
1783 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1784 #define NDIS_PACKET_TYPE_PROMISCUOUS    0x00000020
1785 #define NDIS_PACKET_TYPE_SMT            0x00000040
1786 #define NDIS_PACKET_TYPE_ALL_LOCAL      0x00000080
1787 #define NDIS_PACKET_TYPE_GROUP          0x00000100
1788 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1789 #define NDIS_PACKET_TYPE_FUNCTIONAL     0x00000400
1790 #define NDIS_PACKET_TYPE_MAC_FRAME      0x00000800
1791
1792 #define TRANSPORT_INFO_NOT_IP   0
1793 #define TRANSPORT_INFO_IPV4_TCP 0x01
1794 #define TRANSPORT_INFO_IPV4_UDP 0x02
1795 #define TRANSPORT_INFO_IPV6_TCP 0x10
1796 #define TRANSPORT_INFO_IPV6_UDP 0x20
1797
1798 #define RETRY_US_LO     5000
1799 #define RETRY_US_HI     10000
1800 #define RETRY_MAX       2000    /* >10 sec */
1801
1802 void netvsc_dma_unmap(struct hv_device *hv_dev,
1803                       struct hv_netvsc_packet *packet);
1804 #endif /* _HYPERV_NET_H */