drivers/net/ethernet/intel/i40e/i40e.h

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Driver
   4  * Copyright(c) 2013 - 2016 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * The full GNU General Public License is included in this distribution in
  19  * the file called "COPYING".
  20  *
  21  * Contact Information:
  22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  ******************************************************************************/
  26
  27 #ifndef _I40E_H_
  28 #define _I40E_H_
  29
  30 #include <net/tcp.h>
  31 #include <net/udp.h>
  32 #include <linux/types.h>
  33 #include <linux/errno.h>
  34 #include <linux/module.h>
  35 #include <linux/pci.h>
  36 #include <linux/aer.h>
  37 #include <linux/netdevice.h>
  38 #include <linux/ioport.h>
  39 #include <linux/iommu.h>
  40 #include <linux/slab.h>
  41 #include <linux/list.h>
  42 #include <linux/hashtable.h>
  43 #include <linux/string.h>
  44 #include <linux/in.h>
  45 #include <linux/ip.h>
  46 #include <linux/sctp.h>
  47 #include <linux/pkt_sched.h>
  48 #include <linux/ipv6.h>
  49 #include <net/checksum.h>
  50 #include <net/ip6_checksum.h>
  51 #include <linux/ethtool.h>
  52 #include <linux/if_vlan.h>
  53 #include <linux/if_bridge.h>
  54 #include <linux/clocksource.h>
  55 #include <linux/net_tstamp.h>
  56 #include <linux/ptp_clock_kernel.h>
  57 #include "i40e_type.h"
  58 #include "i40e_prototype.h"
  59 #ifdef I40E_FCOE
  60 #include "i40e_fcoe.h"
  61 #endif
  62 #include "i40e_client.h"
  63 #include "i40e_virtchnl.h"
  64 #include "i40e_virtchnl_pf.h"
  65 #include "i40e_txrx.h"
  66 #include "i40e_dcb.h"
  67
  68 /* Useful i40e defaults */
  69 #define I40E_MAX_VEB                    16
  70
  71 #define I40E_MAX_NUM_DESCRIPTORS        4096
  72 #define I40E_MAX_CSR_SPACE              (4 * 1024 * 1024 - 64 * 1024)
  73 #define I40E_DEFAULT_NUM_DESCRIPTORS    512
  74 #define I40E_REQ_DESCRIPTOR_MULTIPLE    32
  75 #define I40E_MIN_NUM_DESCRIPTORS        64
  76 #define I40E_MIN_MSIX                   2
  77 #define I40E_DEFAULT_NUM_VMDQ_VSI       8 /* max 256 VSIs */
  78 #define I40E_MIN_VSI_ALLOC              83 /* LAN, ATR, FCOE, 64 VF */
  79 /* max 16 qps */
  80 #define i40e_default_queues_per_vmdq(pf) \
  81                 (((pf)->flags & I40E_FLAG_RSS_AQ_CAPABLE) ? 4 : 1)
  82 #define I40E_DEFAULT_QUEUES_PER_VF      4
  83 #define I40E_DEFAULT_QUEUES_PER_TC      1 /* should be a power of 2 */
  84 #define i40e_pf_get_max_q_per_tc(pf) \
  85                 (((pf)->flags & I40E_FLAG_128_QP_RSS_CAPABLE) ? 128 : 64)
  86 #define I40E_FDIR_RING                  0
  87 #define I40E_FDIR_RING_COUNT            32
  88 #ifdef I40E_FCOE
  89 #define I40E_DEFAULT_FCOE               8 /* default number of QPs for FCoE */
  90 #define I40E_MINIMUM_FCOE               1 /* minimum number of QPs for FCoE */
  91 #endif /* I40E_FCOE */
  92 #define I40E_MAX_AQ_BUF_SIZE            4096
  93 #define I40E_AQ_LEN                     256
  94 #define I40E_AQ_WORK_LIMIT              66 /* max number of VFs + a little */
  95 #define I40E_MAX_USER_PRIORITY          8
  96 #define I40E_DEFAULT_TRAFFIC_CLASS      BIT(0)
  97 #define I40E_DEFAULT_MSG_ENABLE         4
  98 #define I40E_QUEUE_WAIT_RETRY_LIMIT     10
  99 #define I40E_INT_NAME_STR_LEN           (IFNAMSIZ + 16)
 100
 101 /* Ethtool Private Flags */
 102 #define I40E_PRIV_FLAGS_MFP_FLAG                BIT(0)
 103 #define I40E_PRIV_FLAGS_LINKPOLL_FLAG           BIT(1)
 104 #define I40E_PRIV_FLAGS_FD_ATR                  BIT(2)
 105 #define I40E_PRIV_FLAGS_VEB_STATS               BIT(3)
 106 #define I40E_PRIV_FLAGS_HW_ATR_EVICT            BIT(4)
 107 #define I40E_PRIV_FLAGS_TRUE_PROMISC_SUPPORT    BIT(5)
 108
 109 #define I40E_NVM_VERSION_LO_SHIFT       0
 110 #define I40E_NVM_VERSION_LO_MASK        (0xff << I40E_NVM_VERSION_LO_SHIFT)
 111 #define I40E_NVM_VERSION_HI_SHIFT       12
 112 #define I40E_NVM_VERSION_HI_MASK        (0xf << I40E_NVM_VERSION_HI_SHIFT)
 113 #define I40E_OEM_VER_BUILD_MASK         0xffff
 114 #define I40E_OEM_VER_PATCH_MASK         0xff
 115 #define I40E_OEM_VER_BUILD_SHIFT        8
 116 #define I40E_OEM_VER_SHIFT              24
 117 #define I40E_PHY_DEBUG_ALL \
 118         (I40E_AQ_PHY_DEBUG_DISABLE_LINK_FW | \
 119         I40E_AQ_PHY_DEBUG_DISABLE_ALL_LINK_FW)
 120
 121 /* The values in here are decimal coded as hex as is the case in the NVM map*/
 122 #define I40E_CURRENT_NVM_VERSION_HI     0x2
 123 #define I40E_CURRENT_NVM_VERSION_LO     0x40
 124
 125 #define I40E_RX_DESC(R, i)      \
 126         (&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
 127 #define I40E_TX_DESC(R, i)      \
 128         (&(((struct i40e_tx_desc *)((R)->desc))[i]))
 129 #define I40E_TX_CTXTDESC(R, i)  \
 130         (&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
 131 #define I40E_TX_FDIRDESC(R, i)  \
 132         (&(((struct i40e_filter_program_desc *)((R)->desc))[i]))
 133
 134 /* default to trying for four seconds */
 135 #define I40E_TRY_LINK_TIMEOUT   (4 * HZ)
 136
 137 /* driver state flags */
 138 enum i40e_state_t {
 139         __I40E_TESTING,
 140         __I40E_CONFIG_BUSY,
 141         __I40E_CONFIG_DONE,
 142         __I40E_DOWN,
 143         __I40E_NEEDS_RESTART,
 144         __I40E_SERVICE_SCHED,
 145         __I40E_ADMINQ_EVENT_PENDING,
 146         __I40E_MDD_EVENT_PENDING,
 147         __I40E_VFLR_EVENT_PENDING,
 148         __I40E_RESET_RECOVERY_PENDING,
 149         __I40E_RESET_INTR_RECEIVED,
 150         __I40E_REINIT_REQUESTED,
 151         __I40E_PF_RESET_REQUESTED,
 152         __I40E_CORE_RESET_REQUESTED,
 153         __I40E_GLOBAL_RESET_REQUESTED,
 154         __I40E_EMP_RESET_REQUESTED,
 155         __I40E_EMP_RESET_INTR_RECEIVED,
 156         __I40E_FILTER_OVERFLOW_PROMISC,
 157         __I40E_SUSPENDED,
 158         __I40E_PTP_TX_IN_PROGRESS,
 159         __I40E_BAD_EEPROM,
 160         __I40E_DOWN_REQUESTED,
 161         __I40E_FD_FLUSH_REQUESTED,
 162         __I40E_RESET_FAILED,
 163         __I40E_PORT_TX_SUSPENDED,
 164         __I40E_VF_DISABLE,
 165 };
 166
 167 enum i40e_interrupt_policy {
 168         I40E_INTERRUPT_BEST_CASE,
 169         I40E_INTERRUPT_MEDIUM,
 170         I40E_INTERRUPT_LOWEST
 171 };
 172
 173 struct i40e_lump_tracking {
 174         u16 num_entries;
 175         u16 search_hint;
 176         u16 list[0];
 177 #define I40E_PILE_VALID_BIT  0x8000
 178 #define I40E_IWARP_IRQ_PILE_ID  (I40E_PILE_VALID_BIT - 2)
 179 };
 180
 181 #define I40E_DEFAULT_ATR_SAMPLE_RATE    20
 182 #define I40E_FDIR_MAX_RAW_PACKET_SIZE   512
 183 #define I40E_FDIR_BUFFER_FULL_MARGIN    10
 184 #define I40E_FDIR_BUFFER_HEAD_ROOM      32
 185 #define I40E_FDIR_BUFFER_HEAD_ROOM_FOR_ATR (I40E_FDIR_BUFFER_HEAD_ROOM * 4)
 186
 187 #define I40E_HKEY_ARRAY_SIZE    ((I40E_PFQF_HKEY_MAX_INDEX + 1) * 4)
 188 #define I40E_HLUT_ARRAY_SIZE    ((I40E_PFQF_HLUT_MAX_INDEX + 1) * 4)
 189 #define I40E_VF_HLUT_ARRAY_SIZE ((I40E_VFQF_HLUT1_MAX_INDEX + 1) * 4)
 190
 191 enum i40e_fd_stat_idx {
 192         I40E_FD_STAT_ATR,
 193         I40E_FD_STAT_SB,
 194         I40E_FD_STAT_ATR_TUNNEL,
 195         I40E_FD_STAT_PF_COUNT
 196 };
 197 #define I40E_FD_STAT_PF_IDX(pf_id) ((pf_id) * I40E_FD_STAT_PF_COUNT)
 198 #define I40E_FD_ATR_STAT_IDX(pf_id) \
 199                         (I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_ATR)
 200 #define I40E_FD_SB_STAT_IDX(pf_id)  \
 201                         (I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_SB)
 202 #define I40E_FD_ATR_TUNNEL_STAT_IDX(pf_id) \
 203                         (I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_ATR_TUNNEL)
 204
 205 struct i40e_fdir_filter {
 206         struct hlist_node fdir_node;
 207         /* filter ipnut set */
 208         u8 flow_type;
 209         u8 ip4_proto;
 210         /* TX packet view of src and dst */
 211         __be32 dst_ip;
 212         __be32 src_ip;
 213         __be16 src_port;
 214         __be16 dst_port;
 215         __be32 sctp_v_tag;
 216         /* filter control */
 217         u16 q_index;
 218         u8  flex_off;
 219         u8  pctype;
 220         u16 dest_vsi;
 221         u8  dest_ctl;
 222         u8  fd_status;
 223         u16 cnt_index;
 224         u32 fd_id;
 225 };
 226
 227 #define I40E_ETH_P_LLDP                 0x88cc
 228
 229 #define I40E_DCB_PRIO_TYPE_STRICT       0
 230 #define I40E_DCB_PRIO_TYPE_ETS          1
 231 #define I40E_DCB_STRICT_PRIO_CREDITS    127
 232 /* DCB per TC information data structure */
 233 struct i40e_tc_info {
 234         u16     qoffset;        /* Queue offset from base queue */
 235         u16     qcount;         /* Total Queues */
 236         u8      netdev_tc;      /* Netdev TC index if netdev associated */
 237 };
 238
 239 /* TC configuration data structure */
 240 struct i40e_tc_configuration {
 241         u8      numtc;          /* Total number of enabled TCs */
 242         u8      enabled_tc;     /* TC map */
 243         struct i40e_tc_info tc_info[I40E_MAX_TRAFFIC_CLASS];
 244 };
 245
 246 struct i40e_udp_port_config {
 247         /* AdminQ command interface expects port number in Host byte order */
 248         u16 index;
 249         u8 type;
 250 };
 251
 252 /* struct that defines the Ethernet device */
 253 struct i40e_pf {
 254         struct pci_dev *pdev;
 255         struct i40e_hw hw;
 256         unsigned long state;
 257         struct msix_entry *msix_entries;
 258         bool fc_autoneg_status;
 259
 260         u16 eeprom_version;
 261         u16 num_vmdq_vsis;         /* num vmdq vsis this PF has set up */
 262         u16 num_vmdq_qps;          /* num queue pairs per vmdq pool */
 263         u16 num_vmdq_msix;         /* num queue vectors per vmdq pool */
 264         u16 num_req_vfs;           /* num VFs requested for this VF */
 265         u16 num_vf_qps;            /* num queue pairs per VF */
 266 #ifdef I40E_FCOE
 267         u16 num_fcoe_qps;          /* num fcoe queues this PF has set up */
 268         u16 num_fcoe_msix;         /* num queue vectors per fcoe pool */
 269 #endif /* I40E_FCOE */
 270         u16 num_lan_qps;           /* num lan queues this PF has set up */
 271         u16 num_lan_msix;          /* num queue vectors for the base PF vsi */
 272         u16 num_fdsb_msix;         /* num queue vectors for sideband Fdir */
 273         u16 num_iwarp_msix;        /* num of iwarp vectors for this PF */
 274         int iwarp_base_vector;
 275         int queues_left;           /* queues left unclaimed */
 276         u16 alloc_rss_size;        /* allocated RSS queues */
 277         u16 rss_size_max;          /* HW defined max RSS queues */
 278         u16 fdir_pf_filter_count;  /* num of guaranteed filters for this PF */
 279         u16 num_alloc_vsi;         /* num VSIs this driver supports */
 280         u8 atr_sample_rate;
 281         bool wol_en;
 282
 283         struct hlist_head fdir_filter_list;
 284         u16 fdir_pf_active_filters;
 285         unsigned long fd_flush_timestamp;
 286         u32 fd_flush_cnt;
 287         u32 fd_add_err;
 288         u32 fd_atr_cnt;
 289         u32 fd_tcp_rule;
 290
 291         struct i40e_udp_port_config udp_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
 292         u16 pending_udp_bitmap;
 293
 294         enum i40e_interrupt_policy int_policy;
 295         u16 rx_itr_default;
 296         u16 tx_itr_default;
 297         u32 msg_enable;
 298         char int_name[I40E_INT_NAME_STR_LEN];
 299         u16 adminq_work_limit; /* num of admin receive queue desc to process */
 300         unsigned long service_timer_period;
 301         unsigned long service_timer_previous;
 302         struct timer_list service_timer;
 303         struct work_struct service_task;
 304
 305         u64 flags;
 306 #define I40E_FLAG_RX_CSUM_ENABLED               BIT_ULL(1)
 307 #define I40E_FLAG_MSI_ENABLED                   BIT_ULL(2)
 308 #define I40E_FLAG_MSIX_ENABLED                  BIT_ULL(3)
 309 #define I40E_FLAG_RSS_ENABLED                   BIT_ULL(6)
 310 #define I40E_FLAG_VMDQ_ENABLED                  BIT_ULL(7)
 311 #define I40E_FLAG_FDIR_REQUIRES_REINIT          BIT_ULL(8)
 312 #define I40E_FLAG_NEED_LINK_UPDATE              BIT_ULL(9)
 313 #define I40E_FLAG_IWARP_ENABLED                 BIT_ULL(10)
 314 #ifdef I40E_FCOE
 315 #define I40E_FLAG_FCOE_ENABLED                  BIT_ULL(11)
 316 #endif /* I40E_FCOE */
 317 #define I40E_FLAG_CLEAN_ADMINQ                  BIT_ULL(14)
 318 #define I40E_FLAG_FILTER_SYNC                   BIT_ULL(15)
 319 #define I40E_FLAG_SERVICE_CLIENT_REQUESTED      BIT_ULL(16)
 320 #define I40E_FLAG_PROCESS_MDD_EVENT             BIT_ULL(17)
 321 #define I40E_FLAG_PROCESS_VFLR_EVENT            BIT_ULL(18)
 322 #define I40E_FLAG_SRIOV_ENABLED                 BIT_ULL(19)
 323 #define I40E_FLAG_DCB_ENABLED                   BIT_ULL(20)
 324 #define I40E_FLAG_FD_SB_ENABLED                 BIT_ULL(21)
 325 #define I40E_FLAG_FD_ATR_ENABLED                BIT_ULL(22)
 326 #define I40E_FLAG_PTP                           BIT_ULL(25)
 327 #define I40E_FLAG_MFP_ENABLED                   BIT_ULL(26)
 328 #define I40E_FLAG_UDP_FILTER_SYNC               BIT_ULL(27)
 329 #define I40E_FLAG_PORT_ID_VALID                 BIT_ULL(28)
 330 #define I40E_FLAG_DCB_CAPABLE                   BIT_ULL(29)
 331 #define I40E_FLAG_RSS_AQ_CAPABLE                BIT_ULL(31)
 332 #define I40E_FLAG_HW_ATR_EVICT_CAPABLE          BIT_ULL(32)
 333 #define I40E_FLAG_OUTER_UDP_CSUM_CAPABLE        BIT_ULL(33)
 334 #define I40E_FLAG_128_QP_RSS_CAPABLE            BIT_ULL(34)
 335 #define I40E_FLAG_WB_ON_ITR_CAPABLE             BIT_ULL(35)
 336 #define I40E_FLAG_VEB_STATS_ENABLED             BIT_ULL(37)
 337 #define I40E_FLAG_MULTIPLE_TCP_UDP_RSS_PCTYPE   BIT_ULL(38)
 338 #define I40E_FLAG_LINK_POLLING_ENABLED          BIT_ULL(39)
 339 #define I40E_FLAG_VEB_MODE_ENABLED              BIT_ULL(40)
 340 #define I40E_FLAG_GENEVE_OFFLOAD_CAPABLE        BIT_ULL(41)
 341 #define I40E_FLAG_NO_PCI_LINK_CHECK             BIT_ULL(42)
 342 #define I40E_FLAG_100M_SGMII_CAPABLE            BIT_ULL(43)
 343 #define I40E_FLAG_RESTART_AUTONEG               BIT_ULL(44)
 344 #define I40E_FLAG_NO_DCB_SUPPORT                BIT_ULL(45)
 345 #define I40E_FLAG_USE_SET_LLDP_MIB              BIT_ULL(46)
 346 #define I40E_FLAG_STOP_FW_LLDP                  BIT_ULL(47)
 347 #define I40E_FLAG_PHY_CONTROLS_LEDS             BIT_ULL(48)
 348 #define I40E_FLAG_PF_MAC                        BIT_ULL(50)
 349 #define I40E_FLAG_TRUE_PROMISC_SUPPORT          BIT_ULL(51)
 350 #define I40E_FLAG_HAVE_CRT_RETIMER              BIT_ULL(52)
 351 #define I40E_FLAG_PTP_L4_CAPABLE                BIT_ULL(53)
 352 #define I40E_FLAG_CLIENT_RESET                  BIT_ULL(54)
 353 #define I40E_FLAG_TEMP_LINK_POLLING             BIT_ULL(55)
 354 #define I40E_FLAG_CLIENT_L2_CHANGE              BIT_ULL(56)
 355 #define I40E_FLAG_WOL_MC_MAGIC_PKT_WAKE         BIT_ULL(57)
 356
 357         /* Tracks features that are disabled due to hw limitations.
 358          * If a bit is set here, it means that the corresponding
 359          * bit in the 'flags' field is cleared i.e that feature
 360          * is disabled
 361          */
 362         u64 hw_disabled_flags;
 363
 364 #ifdef I40E_FCOE
 365         struct i40e_fcoe fcoe;
 366
 367 #endif /* I40E_FCOE */
 368         struct i40e_client_instance *cinst;
 369         bool stat_offsets_loaded;
 370         struct i40e_hw_port_stats stats;
 371         struct i40e_hw_port_stats stats_offsets;
 372         u32 tx_timeout_count;
 373         u32 tx_timeout_recovery_level;
 374         unsigned long tx_timeout_last_recovery;
 375         u32 tx_sluggish_count;
 376         u32 hw_csum_rx_error;
 377         u32 led_status;
 378         u16 corer_count; /* Core reset count */
 379         u16 globr_count; /* Global reset count */
 380         u16 empr_count; /* EMP reset count */
 381         u16 pfr_count; /* PF reset count */
 382         u16 sw_int_count; /* SW interrupt count */
 383
 384         struct mutex switch_mutex;
 385         u16 lan_vsi;       /* our default LAN VSI */
 386         u16 lan_veb;       /* initial relay, if exists */
 387 #define I40E_NO_VEB     0xffff
 388 #define I40E_NO_VSI     0xffff
 389         u16 next_vsi;      /* Next unallocated VSI - 0-based! */
 390         struct i40e_vsi **vsi;
 391         struct i40e_veb *veb[I40E_MAX_VEB];
 392
 393         struct i40e_lump_tracking *qp_pile;
 394         struct i40e_lump_tracking *irq_pile;
 395
 396         /* switch config info */
 397         u16 pf_seid;
 398         u16 main_vsi_seid;
 399         u16 mac_seid;
 400         struct kobject *switch_kobj;
 401 #ifdef CONFIG_DEBUG_FS
 402         struct dentry *i40e_dbg_pf;
 403 #endif /* CONFIG_DEBUG_FS */
 404         bool cur_promisc;
 405
 406         u16 instance; /* A unique number per i40e_pf instance in the system */
 407
 408         /* sr-iov config info */
 409         struct i40e_vf *vf;
 410         int num_alloc_vfs;      /* actual number of VFs allocated */
 411         u32 vf_aq_requests;
 412         u32 arq_overflows;      /* Not fatal, possibly indicative of problems */
 413
 414         /* DCBx/DCBNL capability for PF that indicates
 415          * whether DCBx is managed by firmware or host
 416          * based agent (LLDPAD). Also, indicates what
 417          * flavor of DCBx protocol (IEEE/CEE) is supported
 418          * by the device. For now we're supporting IEEE
 419          * mode only.
 420          */
 421         u16 dcbx_cap;
 422
 423         u32 fcoe_hmc_filt_num;
 424         u32 fcoe_hmc_cntx_num;
 425         struct i40e_filter_control_settings filter_settings;
 426
 427         struct ptp_clock *ptp_clock;
 428         struct ptp_clock_info ptp_caps;
 429         struct sk_buff *ptp_tx_skb;
 430         struct hwtstamp_config tstamp_config;
 431         struct mutex tmreg_lock; /* Used to protect the SYSTIME registers. */
 432         u64 ptp_base_adj;
 433         u32 tx_hwtstamp_timeouts;
 434         u32 rx_hwtstamp_cleared;
 435         u32 latch_event_flags;
 436         spinlock_t ptp_rx_lock; /* Used to protect Rx timestamp registers. */
 437         unsigned long latch_events[4];
 438         bool ptp_tx;
 439         bool ptp_rx;
 440         u16 rss_table_size; /* HW RSS table size */
 441         /* These are only valid in NPAR modes */
 442         u32 npar_max_bw;
 443         u32 npar_min_bw;
 444
 445         u32 ioremap_len;
 446         u32 fd_inv;
 447         u16 phy_led_val;
 448 };
 449
 450 /**
 451  * i40e_mac_to_hkey - Convert a 6-byte MAC Address to a u64 hash key
 452  * @macaddr: the MAC Address as the base key
 453  *
 454  * Simply copies the address and returns it as a u64 for hashing
 455  **/
 456 static inline u64 i40e_addr_to_hkey(const u8 *macaddr)
 457 {
 458         u64 key = 0;
 459
 460         ether_addr_copy((u8 *)&key, macaddr);
 461         return key;
 462 }
 463
 464 enum i40e_filter_state {
 465         I40E_FILTER_INVALID = 0,        /* Invalid state */
 466         I40E_FILTER_NEW,                /* New, not sent to FW yet */
 467         I40E_FILTER_ACTIVE,             /* Added to switch by FW */
 468         I40E_FILTER_FAILED,             /* Rejected by FW */
 469         I40E_FILTER_REMOVE,             /* To be removed */
 470 /* There is no 'removed' state; the filter struct is freed */
 471 };
 472 struct i40e_mac_filter {
 473         struct hlist_node hlist;
 474         u8 macaddr[ETH_ALEN];
 475 #define I40E_VLAN_ANY -1
 476         s16 vlan;
 477         enum i40e_filter_state state;
 478 };
 479
 480 /* Wrapper structure to keep track of filters while we are preparing to send
 481  * firmware commands. We cannot send firmware commands while holding a
 482  * spinlock, since it might sleep. To avoid this, we wrap the added filters in
 483  * a separate structure, which will track the state change and update the real
 484  * filter while under lock. We can't simply hold the filters in a separate
 485  * list, as this opens a window for a race condition when adding new MAC
 486  * addresses to all VLANs, or when adding new VLANs to all MAC addresses.
 487  */
 488 struct i40e_new_mac_filter {
 489         struct hlist_node hlist;
 490         struct i40e_mac_filter *f;
 491
 492         /* Track future changes to state separately */
 493         enum i40e_filter_state state;
 494 };
 495
 496 struct i40e_veb {
 497         struct i40e_pf *pf;
 498         u16 idx;
 499         u16 veb_idx;            /* index of VEB parent */
 500         u16 seid;
 501         u16 uplink_seid;
 502         u16 stats_idx;          /* index of VEB parent */
 503         u8  enabled_tc;
 504         u16 bridge_mode;        /* Bridge Mode (VEB/VEPA) */
 505         u16 flags;
 506         u16 bw_limit;
 507         u8  bw_max_quanta;
 508         bool is_abs_credits;
 509         u8  bw_tc_share_credits[I40E_MAX_TRAFFIC_CLASS];
 510         u16 bw_tc_limit_credits[I40E_MAX_TRAFFIC_CLASS];
 511         u8  bw_tc_max_quanta[I40E_MAX_TRAFFIC_CLASS];
 512         struct kobject *kobj;
 513         bool stat_offsets_loaded;
 514         struct i40e_eth_stats stats;
 515         struct i40e_eth_stats stats_offsets;
 516         struct i40e_veb_tc_stats tc_stats;
 517         struct i40e_veb_tc_stats tc_stats_offsets;
 518 };
 519
 520 /* struct that defines a VSI, associated with a dev */
 521 struct i40e_vsi {
 522         struct net_device *netdev;
 523         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
 524         bool netdev_registered;
 525         bool stat_offsets_loaded;
 526
 527         u32 current_netdev_flags;
 528         unsigned long state;
 529 #define I40E_VSI_FLAG_FILTER_CHANGED    BIT(0)
 530 #define I40E_VSI_FLAG_VEB_OWNER         BIT(1)
 531         unsigned long flags;
 532
 533         /* Per VSI lock to protect elements/hash (MAC filter) */
 534         spinlock_t mac_filter_hash_lock;
 535         /* Fixed size hash table with 2^8 buckets for MAC filters */
 536         DECLARE_HASHTABLE(mac_filter_hash, 8);
 537         bool has_vlan_filter;
 538
 539         /* VSI stats */
 540         struct rtnl_link_stats64 net_stats;
 541         struct rtnl_link_stats64 net_stats_offsets;
 542         struct i40e_eth_stats eth_stats;
 543         struct i40e_eth_stats eth_stats_offsets;
 544 #ifdef I40E_FCOE
 545         struct i40e_fcoe_stats fcoe_stats;
 546         struct i40e_fcoe_stats fcoe_stats_offsets;
 547         bool fcoe_stat_offsets_loaded;
 548 #endif
 549         u32 tx_restart;
 550         u32 tx_busy;
 551         u64 tx_linearize;
 552         u64 tx_force_wb;
 553         u64 tx_lost_interrupt;
 554         u32 rx_buf_failed;
 555         u32 rx_page_failed;
 556
 557         /* These are containers of ring pointers, allocated at run-time */
 558         struct i40e_ring **rx_rings;
 559         struct i40e_ring **tx_rings;
 560
 561         u32  active_filters;
 562         u32  promisc_threshold;
 563
 564         u16 work_limit;
 565         u16 int_rate_limit;     /* value in usecs */
 566
 567         u16 rss_table_size;     /* HW RSS table size */
 568         u16 rss_size;           /* Allocated RSS queues */
 569         u8  *rss_hkey_user;     /* User configured hash keys */
 570         u8  *rss_lut_user;      /* User configured lookup table entries */
 571
 572
 573         u16 max_frame;
 574         u16 rx_buf_len;
 575
 576         /* List of q_vectors allocated to this VSI */
 577         struct i40e_q_vector **q_vectors;
 578         int num_q_vectors;
 579         int base_vector;
 580         bool irqs_ready;
 581
 582         u16 seid;               /* HW index of this VSI (absolute index) */
 583         u16 id;                 /* VSI number */
 584         u16 uplink_seid;
 585
 586         u16 base_queue;         /* vsi's first queue in hw array */
 587         u16 alloc_queue_pairs;  /* Allocated Tx/Rx queues */
 588         u16 req_queue_pairs;    /* User requested queue pairs */
 589         u16 num_queue_pairs;    /* Used tx and rx pairs */
 590         u16 num_desc;
 591         enum i40e_vsi_type type;  /* VSI type, e.g., LAN, FCoE, etc */
 592         s16 vf_id;              /* Virtual function ID for SRIOV VSIs */
 593
 594         struct i40e_tc_configuration tc_config;
 595         struct i40e_aqc_vsi_properties_data info;
 596
 597         /* VSI BW limit (absolute across all TCs) */
 598         u16 bw_limit;           /* VSI BW Limit (0 = disabled) */
 599         u8  bw_max_quanta;      /* Max Quanta when BW limit is enabled */
 600
 601         /* Relative TC credits across VSIs */
 602         u8  bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
 603         /* TC BW limit credits within VSI */
 604         u16  bw_ets_limit_credits[I40E_MAX_TRAFFIC_CLASS];
 605         /* TC BW limit max quanta within VSI */
 606         u8  bw_ets_max_quanta[I40E_MAX_TRAFFIC_CLASS];
 607
 608         struct i40e_pf *back;   /* Backreference to associated PF */
 609         u16 idx;                /* index in pf->vsi[] */
 610         u16 veb_idx;            /* index of VEB parent */
 611         struct kobject *kobj;   /* sysfs object */
 612         bool current_isup;      /* Sync 'link up' logging */
 613         enum i40e_aq_link_speed current_speed;  /* Sync link speed logging */
 614
 615         void *priv;     /* client driver data reference. */
 616
 617         /* VSI specific handlers */
 618         irqreturn_t (*irq_handler)(int irq, void *data);
 619 } ____cacheline_internodealigned_in_smp;
 620
 621 struct i40e_netdev_priv {
 622         struct i40e_vsi *vsi;
 623 };
 624
 625 /* struct that defines an interrupt vector */
 626 struct i40e_q_vector {
 627         struct i40e_vsi *vsi;
 628
 629         u16 v_idx;              /* index in the vsi->q_vector array. */
 630         u16 reg_idx;            /* register index of the interrupt */
 631
 632         struct napi_struct napi;
 633
 634         struct i40e_ring_container rx;
 635         struct i40e_ring_container tx;
 636
 637         u8 num_ringpairs;       /* total number of ring pairs in vector */
 638
 639 #define I40E_Q_VECTOR_HUNG_DETECT 0 /* Bit Index for hung detection logic */
 640         unsigned long hung_detected; /* Set/Reset for hung_detection logic */
 641
 642         cpumask_t affinity_mask;
 643         struct irq_affinity_notify affinity_notify;
 644
 645         struct rcu_head rcu;    /* to avoid race with update stats on free */
 646         char name[I40E_INT_NAME_STR_LEN];
 647         bool arm_wb_state;
 648 #define ITR_COUNTDOWN_START 100
 649         u8 itr_countdown;       /* when 0 should adjust ITR */
 650 } ____cacheline_internodealigned_in_smp;
 651
 652 /* lan device */
 653 struct i40e_device {
 654         struct list_head list;
 655         struct i40e_pf *pf;
 656 };
 657
 658 /**
 659  * i40e_nvm_version_str - format the NVM version strings
 660  * @hw: ptr to the hardware info
 661  **/
 662 static inline char *i40e_nvm_version_str(struct i40e_hw *hw)
 663 {
 664         static char buf[32];
 665         u32 full_ver;
 666         u8 ver, patch;
 667         u16 build;
 668
 669         full_ver = hw->nvm.oem_ver;
 670         ver = (u8)(full_ver >> I40E_OEM_VER_SHIFT);
 671         build = (u16)((full_ver >> I40E_OEM_VER_BUILD_SHIFT) &
 672                  I40E_OEM_VER_BUILD_MASK);
 673         patch = (u8)(full_ver & I40E_OEM_VER_PATCH_MASK);
 674
 675         snprintf(buf, sizeof(buf),
 676                  "%x.%02x 0x%x %d.%d.%d",
 677                  (hw->nvm.version & I40E_NVM_VERSION_HI_MASK) >>
 678                         I40E_NVM_VERSION_HI_SHIFT,
 679                  (hw->nvm.version & I40E_NVM_VERSION_LO_MASK) >>
 680                         I40E_NVM_VERSION_LO_SHIFT,
 681                  hw->nvm.eetrack, ver, build, patch);
 682
 683         return buf;
 684 }
 685
 686 /**
 687  * i40e_netdev_to_pf: Retrieve the PF struct for given netdev
 688  * @netdev: the corresponding netdev
 689  *
 690  * Return the PF struct for the given netdev
 691  **/
 692 static inline struct i40e_pf *i40e_netdev_to_pf(struct net_device *netdev)
 693 {
 694         struct i40e_netdev_priv *np = netdev_priv(netdev);
 695         struct i40e_vsi *vsi = np->vsi;
 696
 697         return vsi->back;
 698 }
 699
 700 static inline void i40e_vsi_setup_irqhandler(struct i40e_vsi *vsi,
 701                                 irqreturn_t (*irq_handler)(int, void *))
 702 {
 703         vsi->irq_handler = irq_handler;
 704 }
 705
 706 /**
 707  * i40e_rx_is_programming_status - check for programming status descriptor
 708  * @qw: the first quad word of the program status descriptor
 709  *
 710  * The value of in the descriptor length field indicate if this
 711  * is a programming status descriptor for flow director or FCoE
 712  * by the value of I40E_RX_PROG_STATUS_DESC_LENGTH, otherwise
 713  * it is a packet descriptor.
 714  **/
 715 static inline bool i40e_rx_is_programming_status(u64 qw)
 716 {
 717         return I40E_RX_PROG_STATUS_DESC_LENGTH ==
 718                 (qw >> I40E_RX_PROG_STATUS_DESC_LENGTH_SHIFT);
 719 }
 720
 721 /**
 722  * i40e_get_fd_cnt_all - get the total FD filter space available
 723  * @pf: pointer to the PF struct
 724  **/
 725 static inline int i40e_get_fd_cnt_all(struct i40e_pf *pf)
 726 {
 727         return pf->hw.fdir_shared_filter_count + pf->fdir_pf_filter_count;
 728 }
 729
 730 /* needed by i40e_ethtool.c */
 731 int i40e_up(struct i40e_vsi *vsi);
 732 void i40e_down(struct i40e_vsi *vsi);
 733 extern const char i40e_driver_name[];
 734 extern const char i40e_driver_version_str[];
 735 void i40e_do_reset_safe(struct i40e_pf *pf, u32 reset_flags);
 736 void i40e_do_reset(struct i40e_pf *pf, u32 reset_flags);
 737 int i40e_config_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
 738 int i40e_get_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
 739 void i40e_fill_rss_lut(struct i40e_pf *pf, u8 *lut,
 740                        u16 rss_table_size, u16 rss_size);
 741 struct i40e_vsi *i40e_find_vsi_from_id(struct i40e_pf *pf, u16 id);
 742 /**
 743  * i40e_find_vsi_by_type - Find and return Flow Director VSI
 744  * @pf: PF to search for VSI
 745  * @type: Value indicating type of VSI we are looking for
 746  **/
 747 static inline struct i40e_vsi *
 748 i40e_find_vsi_by_type(struct i40e_pf *pf, u16 type)
 749 {
 750         int i;
 751
 752         for (i = 0; i < pf->num_alloc_vsi; i++) {
 753                 struct i40e_vsi *vsi = pf->vsi[i];
 754
 755                 if (vsi && vsi->type == type)
 756                         return vsi;
 757         }
 758
 759         return NULL;
 760 }
 761 void i40e_update_stats(struct i40e_vsi *vsi);
 762 void i40e_update_eth_stats(struct i40e_vsi *vsi);
 763 struct rtnl_link_stats64 *i40e_get_vsi_stats_struct(struct i40e_vsi *vsi);
 764 int i40e_fetch_switch_configuration(struct i40e_pf *pf,
 765                                     bool printconfig);
 766
 767 int i40e_add_del_fdir(struct i40e_vsi *vsi,
 768                       struct i40e_fdir_filter *input, bool add);
 769 void i40e_fdir_check_and_reenable(struct i40e_pf *pf);
 770 u32 i40e_get_current_fd_count(struct i40e_pf *pf);
 771 u32 i40e_get_cur_guaranteed_fd_count(struct i40e_pf *pf);
 772 u32 i40e_get_current_atr_cnt(struct i40e_pf *pf);
 773 u32 i40e_get_global_fd_count(struct i40e_pf *pf);
 774 bool i40e_set_ntuple(struct i40e_pf *pf, netdev_features_t features);
 775 void i40e_set_ethtool_ops(struct net_device *netdev);
 776 struct i40e_mac_filter *i40e_add_filter(struct i40e_vsi *vsi,
 777                                         const u8 *macaddr, s16 vlan);
 778 void __i40e_del_filter(struct i40e_vsi *vsi, struct i40e_mac_filter *f);
 779 void i40e_del_filter(struct i40e_vsi *vsi, const u8 *macaddr, s16 vlan);
 780 int i40e_sync_vsi_filters(struct i40e_vsi *vsi);
 781 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf, u8 type,
 782                                 u16 uplink, u32 param1);
 783 int i40e_vsi_release(struct i40e_vsi *vsi);
 784 #ifdef I40E_FCOE
 785 void i40e_vsi_setup_queue_map(struct i40e_vsi *vsi,
 786                               struct i40e_vsi_context *ctxt,
 787                               u8 enabled_tc, bool is_add);
 788 #endif
 789 void i40e_service_event_schedule(struct i40e_pf *pf);
 790 void i40e_notify_client_of_vf_msg(struct i40e_vsi *vsi, u32 vf_id,
 791                                   u8 *msg, u16 len);
 792
 793 int i40e_vsi_start_rings(struct i40e_vsi *vsi);
 794 void i40e_vsi_stop_rings(struct i40e_vsi *vsi);
 795 int i40e_reconfig_rss_queues(struct i40e_pf *pf, int queue_count);
 796 struct i40e_veb *i40e_veb_setup(struct i40e_pf *pf, u16 flags, u16 uplink_seid,
 797                                 u16 downlink_seid, u8 enabled_tc);
 798 void i40e_veb_release(struct i40e_veb *veb);
 799
 800 int i40e_veb_config_tc(struct i40e_veb *veb, u8 enabled_tc);
 801 int i40e_vsi_add_pvid(struct i40e_vsi *vsi, u16 vid);
 802 void i40e_vsi_remove_pvid(struct i40e_vsi *vsi);
 803 void i40e_vsi_reset_stats(struct i40e_vsi *vsi);
 804 void i40e_pf_reset_stats(struct i40e_pf *pf);
 805 #ifdef CONFIG_DEBUG_FS
 806 void i40e_dbg_pf_init(struct i40e_pf *pf);
 807 void i40e_dbg_pf_exit(struct i40e_pf *pf);
 808 void i40e_dbg_init(void);
 809 void i40e_dbg_exit(void);
 810 #else
 811 static inline void i40e_dbg_pf_init(struct i40e_pf *pf) {}
 812 static inline void i40e_dbg_pf_exit(struct i40e_pf *pf) {}
 813 static inline void i40e_dbg_init(void) {}
 814 static inline void i40e_dbg_exit(void) {}
 815 #endif /* CONFIG_DEBUG_FS*/
 816 /* needed by client drivers */
 817 int i40e_lan_add_device(struct i40e_pf *pf);
 818 int i40e_lan_del_device(struct i40e_pf *pf);
 819 void i40e_client_subtask(struct i40e_pf *pf);
 820 void i40e_notify_client_of_l2_param_changes(struct i40e_vsi *vsi);
 821 void i40e_notify_client_of_netdev_close(struct i40e_vsi *vsi, bool reset);
 822 void i40e_notify_client_of_vf_enable(struct i40e_pf *pf, u32 num_vfs);
 823 void i40e_notify_client_of_vf_reset(struct i40e_pf *pf, u32 vf_id);
 824 int i40e_vf_client_capable(struct i40e_pf *pf, u32 vf_id);
 825 /**
 826  * i40e_irq_dynamic_enable - Enable default interrupt generation settings
 827  * @vsi: pointer to a vsi
 828  * @vector: enable a particular Hw Interrupt vector, without base_vector
 829  **/
 830 static inline void i40e_irq_dynamic_enable(struct i40e_vsi *vsi, int vector)
 831 {
 832         struct i40e_pf *pf = vsi->back;
 833         struct i40e_hw *hw = &pf->hw;
 834         u32 val;
 835
 836         /* definitely clear the PBA here, as this function is meant to
 837          * clean out all previous interrupts AND enable the interrupt
 838          */
 839         val = I40E_PFINT_DYN_CTLN_INTENA_MASK |
 840               I40E_PFINT_DYN_CTLN_CLEARPBA_MASK |
 841               (I40E_ITR_NONE << I40E_PFINT_DYN_CTLN_ITR_INDX_SHIFT);
 842         wr32(hw, I40E_PFINT_DYN_CTLN(vector + vsi->base_vector - 1), val);
 843         /* skip the flush */
 844 }
 845
 846 void i40e_irq_dynamic_disable_icr0(struct i40e_pf *pf);
 847 void i40e_irq_dynamic_enable_icr0(struct i40e_pf *pf, bool clearpba);
 848 #ifdef I40E_FCOE
 849 void i40e_get_netdev_stats_struct(struct net_device *netdev,
 850                                   struct rtnl_link_stats64 *storage);
 851 int i40e_set_mac(struct net_device *netdev, void *p);
 852 void i40e_set_rx_mode(struct net_device *netdev);
 853 #endif
 854 int i40e_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd);
 855 #ifdef I40E_FCOE
 856 void i40e_tx_timeout(struct net_device *netdev);
 857 int i40e_vlan_rx_add_vid(struct net_device *netdev,
 858                          __always_unused __be16 proto, u16 vid);
 859 int i40e_vlan_rx_kill_vid(struct net_device *netdev,
 860                           __always_unused __be16 proto, u16 vid);
 861 #endif
 862 int i40e_open(struct net_device *netdev);
 863 int i40e_close(struct net_device *netdev);
 864 int i40e_vsi_open(struct i40e_vsi *vsi);
 865 void i40e_vlan_stripping_disable(struct i40e_vsi *vsi);
 866 int i40e_add_vlan_all_mac(struct i40e_vsi *vsi, s16 vid);
 867 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, u16 vid);
 868 void i40e_rm_vlan_all_mac(struct i40e_vsi *vsi, s16 vid);
 869 void i40e_vsi_kill_vlan(struct i40e_vsi *vsi, u16 vid);
 870 struct i40e_mac_filter *i40e_add_mac_filter(struct i40e_vsi *vsi,
 871                                             const u8 *macaddr);
 872 int i40e_del_mac_filter(struct i40e_vsi *vsi, const u8 *macaddr);
 873 bool i40e_is_vsi_in_vlan(struct i40e_vsi *vsi);
 874 struct i40e_mac_filter *i40e_find_mac(struct i40e_vsi *vsi, const u8 *macaddr);
 875 #ifdef I40E_FCOE
 876 int __i40e_setup_tc(struct net_device *netdev, u32 handle, __be16 proto,
 877                     struct tc_to_netdev *tc);
 878 void i40e_netpoll(struct net_device *netdev);
 879 int i40e_fcoe_enable(struct net_device *netdev);
 880 int i40e_fcoe_disable(struct net_device *netdev);
 881 int i40e_fcoe_vsi_init(struct i40e_vsi *vsi, struct i40e_vsi_context *ctxt);
 882 u8 i40e_get_fcoe_tc_map(struct i40e_pf *pf);
 883 void i40e_fcoe_config_netdev(struct net_device *netdev, struct i40e_vsi *vsi);
 884 void i40e_fcoe_vsi_setup(struct i40e_pf *pf);
 885 void i40e_init_pf_fcoe(struct i40e_pf *pf);
 886 int i40e_fcoe_setup_ddp_resources(struct i40e_vsi *vsi);
 887 void i40e_fcoe_free_ddp_resources(struct i40e_vsi *vsi);
 888 int i40e_fcoe_handle_offload(struct i40e_ring *rx_ring,
 889                              union i40e_rx_desc *rx_desc,
 890                              struct sk_buff *skb);
 891 void i40e_fcoe_handle_status(struct i40e_ring *rx_ring,
 892                              union i40e_rx_desc *rx_desc, u8 prog_id);
 893 #endif /* I40E_FCOE */
 894 void i40e_vlan_stripping_enable(struct i40e_vsi *vsi);
 895 #ifdef CONFIG_I40E_DCB
 896 void i40e_dcbnl_flush_apps(struct i40e_pf *pf,
 897                            struct i40e_dcbx_config *old_cfg,
 898                            struct i40e_dcbx_config *new_cfg);
 899 void i40e_dcbnl_set_all(struct i40e_vsi *vsi);
 900 void i40e_dcbnl_setup(struct i40e_vsi *vsi);
 901 bool i40e_dcb_need_reconfig(struct i40e_pf *pf,
 902                             struct i40e_dcbx_config *old_cfg,
 903                             struct i40e_dcbx_config *new_cfg);
 904 #endif /* CONFIG_I40E_DCB */
 905 void i40e_ptp_rx_hang(struct i40e_vsi *vsi);
 906 void i40e_ptp_tx_hwtstamp(struct i40e_pf *pf);
 907 void i40e_ptp_rx_hwtstamp(struct i40e_pf *pf, struct sk_buff *skb, u8 index);
 908 void i40e_ptp_set_increment(struct i40e_pf *pf);
 909 int i40e_ptp_set_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
 910 int i40e_ptp_get_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
 911 void i40e_ptp_init(struct i40e_pf *pf);
 912 void i40e_ptp_stop(struct i40e_pf *pf);
 913 int i40e_is_vsi_uplink_mode_veb(struct i40e_vsi *vsi);
 914 i40e_status i40e_get_npar_bw_setting(struct i40e_pf *pf);
 915 i40e_status i40e_set_npar_bw_setting(struct i40e_pf *pf);
 916 i40e_status i40e_commit_npar_bw_setting(struct i40e_pf *pf);
 917 void i40e_print_link_message(struct i40e_vsi *vsi, bool isup);
 918 #endif /* _I40E_H_ */