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