kernel/drivers/net/ethernet/cavium/thunder/nic.h

   1 /*
   2  * Copyright (C) 2015 Cavium, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License
   6  * as published by the Free Software Foundation.
   7  */
   8
   9 #ifndef NIC_H
  10 #define NIC_H
  11
  12 #include <linux/netdevice.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/pci.h>
  15 #include "thunder_bgx.h"
  16
  17 /* PCI device IDs */
  18 #define PCI_DEVICE_ID_THUNDER_NIC_PF            0xA01E
  19 #define PCI_DEVICE_ID_THUNDER_PASS1_NIC_VF      0x0011
  20 #define PCI_DEVICE_ID_THUNDER_NIC_VF            0xA034
  21 #define PCI_DEVICE_ID_THUNDER_BGX               0xA026
  22
  23 /* PCI BAR nos */
  24 #define PCI_CFG_REG_BAR_NUM             0
  25 #define PCI_MSIX_REG_BAR_NUM            4
  26
  27 /* NIC SRIOV VF count */
  28 #define MAX_NUM_VFS_SUPPORTED           128
  29 #define DEFAULT_NUM_VF_ENABLED          8
  30
  31 #define NIC_TNS_BYPASS_MODE             0
  32 #define NIC_TNS_MODE                    1
  33
  34 /* NIC priv flags */
  35 #define NIC_SRIOV_ENABLED               BIT(0)
  36
  37 /* Min/Max packet size */
  38 #define NIC_HW_MIN_FRS                  64
  39 #define NIC_HW_MAX_FRS                  9200 /* 9216 max packet including FCS */
  40
  41 /* Max pkinds */
  42 #define NIC_MAX_PKIND                   16
  43
  44 /* Rx Channels */
  45 /* Receive channel configuration in TNS bypass mode
  46  * Below is configuration in TNS bypass mode
  47  * BGX0-LMAC0-CHAN0 - VNIC CHAN0
  48  * BGX0-LMAC1-CHAN0 - VNIC CHAN16
  49  * ...
  50  * BGX1-LMAC0-CHAN0 - VNIC CHAN128
  51  * ...
  52  * BGX1-LMAC3-CHAN0 - VNIC CHAN174
  53  */
  54 #define NIC_INTF_COUNT                  2  /* Interfaces btw VNIC and TNS/BGX */
  55 #define NIC_CHANS_PER_INF               128
  56 #define NIC_MAX_CHANS                   (NIC_INTF_COUNT * NIC_CHANS_PER_INF)
  57 #define NIC_CPI_COUNT                   2048 /* No of channel parse indices */
  58
  59 /* TNS bypass mode: 1-1 mapping between VNIC and BGX:LMAC */
  60 #define NIC_MAX_BGX                     MAX_BGX_PER_CN88XX
  61 #define NIC_CPI_PER_BGX                 (NIC_CPI_COUNT / NIC_MAX_BGX)
  62 #define NIC_MAX_CPI_PER_LMAC            64 /* Max when CPI_ALG is IP diffserv */
  63 #define NIC_RSSI_PER_BGX                (NIC_RSSI_COUNT / NIC_MAX_BGX)
  64
  65 /* Tx scheduling */
  66 #define NIC_MAX_TL4                     1024
  67 #define NIC_MAX_TL4_SHAPERS             256 /* 1 shaper for 4 TL4s */
  68 #define NIC_MAX_TL3                     256
  69 #define NIC_MAX_TL3_SHAPERS             64  /* 1 shaper for 4 TL3s */
  70 #define NIC_MAX_TL2                     64
  71 #define NIC_MAX_TL2_SHAPERS             2  /* 1 shaper for 32 TL2s */
  72 #define NIC_MAX_TL1                     2
  73
  74 /* TNS bypass mode */
  75 #define NIC_TL2_PER_BGX                 32
  76 #define NIC_TL4_PER_BGX                 (NIC_MAX_TL4 / NIC_MAX_BGX)
  77 #define NIC_TL4_PER_LMAC                (NIC_MAX_TL4 / NIC_CHANS_PER_INF)
  78
  79 /* NIC VF Interrupts */
  80 #define NICVF_INTR_CQ                   0
  81 #define NICVF_INTR_SQ                   1
  82 #define NICVF_INTR_RBDR                 2
  83 #define NICVF_INTR_PKT_DROP             3
  84 #define NICVF_INTR_TCP_TIMER            4
  85 #define NICVF_INTR_MBOX                 5
  86 #define NICVF_INTR_QS_ERR               6
  87
  88 #define NICVF_INTR_CQ_SHIFT             0
  89 #define NICVF_INTR_SQ_SHIFT             8
  90 #define NICVF_INTR_RBDR_SHIFT           16
  91 #define NICVF_INTR_PKT_DROP_SHIFT       20
  92 #define NICVF_INTR_TCP_TIMER_SHIFT      21
  93 #define NICVF_INTR_MBOX_SHIFT           22
  94 #define NICVF_INTR_QS_ERR_SHIFT         23
  95
  96 #define NICVF_INTR_CQ_MASK              (0xFF << NICVF_INTR_CQ_SHIFT)
  97 #define NICVF_INTR_SQ_MASK              (0xFF << NICVF_INTR_SQ_SHIFT)
  98 #define NICVF_INTR_RBDR_MASK            (0x03 << NICVF_INTR_RBDR_SHIFT)
  99 #define NICVF_INTR_PKT_DROP_MASK        BIT(NICVF_INTR_PKT_DROP_SHIFT)
 100 #define NICVF_INTR_TCP_TIMER_MASK       BIT(NICVF_INTR_TCP_TIMER_SHIFT)
 101 #define NICVF_INTR_MBOX_MASK            BIT(NICVF_INTR_MBOX_SHIFT)
 102 #define NICVF_INTR_QS_ERR_MASK          BIT(NICVF_INTR_QS_ERR_SHIFT)
 103
 104 /* MSI-X interrupts */
 105 #define NIC_PF_MSIX_VECTORS             10
 106 #define NIC_VF_MSIX_VECTORS             20
 107
 108 #define NIC_PF_INTR_ID_ECC0_SBE         0
 109 #define NIC_PF_INTR_ID_ECC0_DBE         1
 110 #define NIC_PF_INTR_ID_ECC1_SBE         2
 111 #define NIC_PF_INTR_ID_ECC1_DBE         3
 112 #define NIC_PF_INTR_ID_ECC2_SBE         4
 113 #define NIC_PF_INTR_ID_ECC2_DBE         5
 114 #define NIC_PF_INTR_ID_ECC3_SBE         6
 115 #define NIC_PF_INTR_ID_ECC3_DBE         7
 116 #define NIC_PF_INTR_ID_MBOX0            8
 117 #define NIC_PF_INTR_ID_MBOX1            9
 118
 119 /* Minimum FIFO level before all packets for the CQ are dropped
 120  *
 121  * This value ensures that once a packet has been "accepted"
 122  * for reception it will not get dropped due to non-availability
 123  * of CQ descriptor. An errata in HW mandates this value to be
 124  * atleast 0x100.
 125  */
 126 #define NICPF_CQM_MIN_DROP_LEVEL       0x100
 127
 128 /* Global timer for CQ timer thresh interrupts
 129  * Calculated for SCLK of 700Mhz
 130  * value written should be a 1/16th of what is expected
 131  *
 132  * 1 tick per 0.025usec
 133  */
 134 #define NICPF_CLK_PER_INT_TICK          1
 135
 136 /* Time to wait before we decide that a SQ is stuck.
 137  *
 138  * Since both pkt rx and tx notifications are done with same CQ,
 139  * when packets are being received at very high rate (eg: L2 forwarding)
 140  * then freeing transmitted skbs will be delayed and watchdog
 141  * will kick in, resetting interface. Hence keeping this value high.
 142  */
 143 #define NICVF_TX_TIMEOUT                (50 * HZ)
 144
 145 struct nicvf_cq_poll {
 146         struct  nicvf *nicvf;
 147         u8      cq_idx;         /* Completion queue index */
 148         struct  napi_struct napi;
 149 };
 150
 151 #define NIC_RSSI_COUNT                  4096 /* Total no of RSS indices */
 152 #define NIC_MAX_RSS_HASH_BITS           8
 153 #define NIC_MAX_RSS_IDR_TBL_SIZE        (1 << NIC_MAX_RSS_HASH_BITS)
 154 #define RSS_HASH_KEY_SIZE               5 /* 320 bit key */
 155
 156 struct nicvf_rss_info {
 157         bool enable;
 158 #define RSS_L2_EXTENDED_HASH_ENA        BIT(0)
 159 #define RSS_IP_HASH_ENA                 BIT(1)
 160 #define RSS_TCP_HASH_ENA                BIT(2)
 161 #define RSS_TCP_SYN_DIS                 BIT(3)
 162 #define RSS_UDP_HASH_ENA                BIT(4)
 163 #define RSS_L4_EXTENDED_HASH_ENA        BIT(5)
 164 #define RSS_ROCE_ENA                    BIT(6)
 165 #define RSS_L3_BI_DIRECTION_ENA         BIT(7)
 166 #define RSS_L4_BI_DIRECTION_ENA         BIT(8)
 167         u64 cfg;
 168         u8  hash_bits;
 169         u16 rss_size;
 170         u8  ind_tbl[NIC_MAX_RSS_IDR_TBL_SIZE];
 171         u64 key[RSS_HASH_KEY_SIZE];
 172 } ____cacheline_aligned_in_smp;
 173
 174 enum rx_stats_reg_offset {
 175         RX_OCTS = 0x0,
 176         RX_UCAST = 0x1,
 177         RX_BCAST = 0x2,
 178         RX_MCAST = 0x3,
 179         RX_RED = 0x4,
 180         RX_RED_OCTS = 0x5,
 181         RX_ORUN = 0x6,
 182         RX_ORUN_OCTS = 0x7,
 183         RX_FCS = 0x8,
 184         RX_L2ERR = 0x9,
 185         RX_DRP_BCAST = 0xa,
 186         RX_DRP_MCAST = 0xb,
 187         RX_DRP_L3BCAST = 0xc,
 188         RX_DRP_L3MCAST = 0xd,
 189         RX_STATS_ENUM_LAST,
 190 };
 191
 192 enum tx_stats_reg_offset {
 193         TX_OCTS = 0x0,
 194         TX_UCAST = 0x1,
 195         TX_BCAST = 0x2,
 196         TX_MCAST = 0x3,
 197         TX_DROP = 0x4,
 198         TX_STATS_ENUM_LAST,
 199 };
 200
 201 struct nicvf_hw_stats {
 202         u64 rx_bytes;
 203         u64 rx_ucast_frames;
 204         u64 rx_bcast_frames;
 205         u64 rx_mcast_frames;
 206         u64 rx_fcs_errors;
 207         u64 rx_l2_errors;
 208         u64 rx_drop_red;
 209         u64 rx_drop_red_bytes;
 210         u64 rx_drop_overrun;
 211         u64 rx_drop_overrun_bytes;
 212         u64 rx_drop_bcast;
 213         u64 rx_drop_mcast;
 214         u64 rx_drop_l3_bcast;
 215         u64 rx_drop_l3_mcast;
 216         u64 rx_bgx_truncated_pkts;
 217         u64 rx_jabber_errs;
 218         u64 rx_fcs_errs;
 219         u64 rx_bgx_errs;
 220         u64 rx_prel2_errs;
 221         u64 rx_l2_hdr_malformed;
 222         u64 rx_oversize;
 223         u64 rx_undersize;
 224         u64 rx_l2_len_mismatch;
 225         u64 rx_l2_pclp;
 226         u64 rx_ip_ver_errs;
 227         u64 rx_ip_csum_errs;
 228         u64 rx_ip_hdr_malformed;
 229         u64 rx_ip_payload_malformed;
 230         u64 rx_ip_ttl_errs;
 231         u64 rx_l3_pclp;
 232         u64 rx_l4_malformed;
 233         u64 rx_l4_csum_errs;
 234         u64 rx_udp_len_errs;
 235         u64 rx_l4_port_errs;
 236         u64 rx_tcp_flag_errs;
 237         u64 rx_tcp_offset_errs;
 238         u64 rx_l4_pclp;
 239         u64 rx_truncated_pkts;
 240
 241         u64 tx_bytes_ok;
 242         u64 tx_ucast_frames_ok;
 243         u64 tx_bcast_frames_ok;
 244         u64 tx_mcast_frames_ok;
 245         u64 tx_drops;
 246 };
 247
 248 struct nicvf_drv_stats {
 249         /* Rx */
 250         u64 rx_frames_ok;
 251         u64 rx_frames_64;
 252         u64 rx_frames_127;
 253         u64 rx_frames_255;
 254         u64 rx_frames_511;
 255         u64 rx_frames_1023;
 256         u64 rx_frames_1518;
 257         u64 rx_frames_jumbo;
 258         u64 rx_drops;
 259
 260         /* Tx */
 261         u64 tx_frames_ok;
 262         u64 tx_drops;
 263         u64 tx_tso;
 264         u64 txq_stop;
 265         u64 txq_wake;
 266 };
 267
 268 struct nicvf {
 269         struct nicvf            *pnicvf;
 270         struct net_device       *netdev;
 271         struct pci_dev          *pdev;
 272         u8                      vf_id;
 273         u8                      node;
 274         u8                      tns_mode:1;
 275         u8                      sqs_mode:1;
 276         u8                      loopback_supported:1;
 277         u16                     mtu;
 278         struct queue_set        *qs;
 279 #define MAX_SQS_PER_VF_SINGLE_NODE              5
 280 #define MAX_SQS_PER_VF                          11
 281         u8                      sqs_id;
 282         u8                      sqs_count; /* Secondary Qset count */
 283         struct nicvf            *snicvf[MAX_SQS_PER_VF];
 284         u8                      rx_queues;
 285         u8                      tx_queues;
 286         u8                      max_queues;
 287         void __iomem            *reg_base;
 288         bool                    link_up;
 289         u8                      duplex;
 290         u32                     speed;
 291         struct page             *rb_page;
 292         u32                     rb_page_offset;
 293         bool                    rb_alloc_fail;
 294         bool                    rb_work_scheduled;
 295         struct delayed_work     rbdr_work;
 296         struct tasklet_struct   rbdr_task;
 297         struct tasklet_struct   qs_err_task;
 298         struct tasklet_struct   cq_task;
 299         struct nicvf_cq_poll    *napi[8];
 300         struct nicvf_rss_info   rss_info;
 301         u8                      cpi_alg;
 302         /* Interrupt coalescing settings */
 303         u32                     cq_coalesce_usecs;
 304
 305         u32                     msg_enable;
 306         struct nicvf_hw_stats   hw_stats;
 307         struct nicvf_drv_stats  drv_stats;
 308         struct bgx_stats        bgx_stats;
 309         struct work_struct      reset_task;
 310
 311         /* MSI-X  */
 312         bool                    msix_enabled;
 313         u8                      num_vec;
 314         struct msix_entry       msix_entries[NIC_VF_MSIX_VECTORS];
 315         char                    irq_name[NIC_VF_MSIX_VECTORS][20];
 316         bool                    irq_allocated[NIC_VF_MSIX_VECTORS];
 317
 318         /* VF <-> PF mailbox communication */
 319         bool                    pf_acked;
 320         bool                    pf_nacked;
 321         bool                    set_mac_pending;
 322 } ____cacheline_aligned_in_smp;
 323
 324 /* PF <--> VF Mailbox communication
 325  * Eight 64bit registers are shared between PF and VF.
 326  * Separate set for each VF.
 327  * Writing '1' into last register mbx7 means end of message.
 328  */
 329
 330 /* PF <--> VF mailbox communication */
 331 #define NIC_PF_VF_MAILBOX_SIZE          2
 332 #define NIC_MBOX_MSG_TIMEOUT            2000 /* ms */
 333
 334 /* Mailbox message types */
 335 #define NIC_MBOX_MSG_READY              0x01    /* Is PF ready to rcv msgs */
 336 #define NIC_MBOX_MSG_ACK                0x02    /* ACK the message received */
 337 #define NIC_MBOX_MSG_NACK               0x03    /* NACK the message received */
 338 #define NIC_MBOX_MSG_QS_CFG             0x04    /* Configure Qset */
 339 #define NIC_MBOX_MSG_RQ_CFG             0x05    /* Configure receive queue */
 340 #define NIC_MBOX_MSG_SQ_CFG             0x06    /* Configure Send queue */
 341 #define NIC_MBOX_MSG_RQ_DROP_CFG        0x07    /* Configure receive queue */
 342 #define NIC_MBOX_MSG_SET_MAC            0x08    /* Add MAC ID to DMAC filter */
 343 #define NIC_MBOX_MSG_SET_MAX_FRS        0x09    /* Set max frame size */
 344 #define NIC_MBOX_MSG_CPI_CFG            0x0A    /* Config CPI, RSSI */
 345 #define NIC_MBOX_MSG_RSS_SIZE           0x0B    /* Get RSS indir_tbl size */
 346 #define NIC_MBOX_MSG_RSS_CFG            0x0C    /* Config RSS table */
 347 #define NIC_MBOX_MSG_RSS_CFG_CONT       0x0D    /* RSS config continuation */
 348 #define NIC_MBOX_MSG_RQ_BP_CFG          0x0E    /* RQ backpressure config */
 349 #define NIC_MBOX_MSG_RQ_SW_SYNC         0x0F    /* Flush inflight pkts to RQ */
 350 #define NIC_MBOX_MSG_BGX_STATS          0x10    /* Get stats from BGX */
 351 #define NIC_MBOX_MSG_BGX_LINK_CHANGE    0x11    /* BGX:LMAC link status */
 352 #define NIC_MBOX_MSG_ALLOC_SQS          0x12    /* Allocate secondary Qset */
 353 #define NIC_MBOX_MSG_NICVF_PTR          0x13    /* Send nicvf ptr to PF */
 354 #define NIC_MBOX_MSG_PNICVF_PTR         0x14    /* Get primary qset nicvf ptr */
 355 #define NIC_MBOX_MSG_SNICVF_PTR         0x15    /* Send sqet nicvf ptr to PVF */
 356 #define NIC_MBOX_MSG_LOOPBACK           0x16    /* Set interface in loopback */
 357 #define NIC_MBOX_MSG_CFG_DONE           0xF0    /* VF configuration done */
 358 #define NIC_MBOX_MSG_SHUTDOWN           0xF1    /* VF is being shutdown */
 359
 360 struct nic_cfg_msg {
 361         u8    msg;
 362         u8    vf_id;
 363         u8    node_id;
 364         u8    tns_mode:1;
 365         u8    sqs_mode:1;
 366         u8    loopback_supported:1;
 367         u8    mac_addr[ETH_ALEN];
 368 };
 369
 370 /* Qset configuration */
 371 struct qs_cfg_msg {
 372         u8    msg;
 373         u8    num;
 374         u8    sqs_count;
 375         u64   cfg;
 376 };
 377
 378 /* Receive queue configuration */
 379 struct rq_cfg_msg {
 380         u8    msg;
 381         u8    qs_num;
 382         u8    rq_num;
 383         u64   cfg;
 384 };
 385
 386 /* Send queue configuration */
 387 struct sq_cfg_msg {
 388         u8    msg;
 389         u8    qs_num;
 390         u8    sq_num;
 391         bool  sqs_mode;
 392         u64   cfg;
 393 };
 394
 395 /* Set VF's MAC address */
 396 struct set_mac_msg {
 397         u8    msg;
 398         u8    vf_id;
 399         u8    mac_addr[ETH_ALEN];
 400 };
 401
 402 /* Set Maximum frame size */
 403 struct set_frs_msg {
 404         u8    msg;
 405         u8    vf_id;
 406         u16   max_frs;
 407 };
 408
 409 /* Set CPI algorithm type */
 410 struct cpi_cfg_msg {
 411         u8    msg;
 412         u8    vf_id;
 413         u8    rq_cnt;
 414         u8    cpi_alg;
 415 };
 416
 417 /* Get RSS table size */
 418 struct rss_sz_msg {
 419         u8    msg;
 420         u8    vf_id;
 421         u16   ind_tbl_size;
 422 };
 423
 424 /* Set RSS configuration */
 425 struct rss_cfg_msg {
 426         u8    msg;
 427         u8    vf_id;
 428         u8    hash_bits;
 429         u8    tbl_len;
 430         u8    tbl_offset;
 431 #define RSS_IND_TBL_LEN_PER_MBX_MSG     8
 432         u8    ind_tbl[RSS_IND_TBL_LEN_PER_MBX_MSG];
 433 };
 434
 435 struct bgx_stats_msg {
 436         u8    msg;
 437         u8    vf_id;
 438         u8    rx;
 439         u8    idx;
 440         u64   stats;
 441 };
 442
 443 /* Physical interface link status */
 444 struct bgx_link_status {
 445         u8    msg;
 446         u8    link_up;
 447         u8    duplex;
 448         u32   speed;
 449 };
 450
 451 /* Get Extra Qset IDs */
 452 struct sqs_alloc {
 453         u8    msg;
 454         u8    vf_id;
 455         u8    qs_count;
 456 };
 457
 458 struct nicvf_ptr {
 459         u8    msg;
 460         u8    vf_id;
 461         bool  sqs_mode;
 462         u8    sqs_id;
 463         u64   nicvf;
 464 };
 465
 466 /* Set interface in loopback mode */
 467 struct set_loopback {
 468         u8    msg;
 469         u8    vf_id;
 470         bool  enable;
 471 };
 472
 473 /* 128 bit shared memory between PF and each VF */
 474 union nic_mbx {
 475         struct { u8 msg; }      msg;
 476         struct nic_cfg_msg      nic_cfg;
 477         struct qs_cfg_msg       qs;
 478         struct rq_cfg_msg       rq;
 479         struct sq_cfg_msg       sq;
 480         struct set_mac_msg      mac;
 481         struct set_frs_msg      frs;
 482         struct cpi_cfg_msg      cpi_cfg;
 483         struct rss_sz_msg       rss_size;
 484         struct rss_cfg_msg      rss_cfg;
 485         struct bgx_stats_msg    bgx_stats;
 486         struct bgx_link_status  link_status;
 487         struct sqs_alloc        sqs_alloc;
 488         struct nicvf_ptr        nicvf;
 489         struct set_loopback     lbk;
 490 };
 491
 492 #define NIC_NODE_ID_MASK        0x03
 493 #define NIC_NODE_ID_SHIFT       44
 494
 495 static inline int nic_get_node_id(struct pci_dev *pdev)
 496 {
 497         u64 addr = pci_resource_start(pdev, PCI_CFG_REG_BAR_NUM);
 498         return ((addr >> NIC_NODE_ID_SHIFT) & NIC_NODE_ID_MASK);
 499 }
 500
 501 int nicvf_set_real_num_queues(struct net_device *netdev,
 502                               int tx_queues, int rx_queues);
 503 int nicvf_open(struct net_device *netdev);
 504 int nicvf_stop(struct net_device *netdev);
 505 int nicvf_send_msg_to_pf(struct nicvf *vf, union nic_mbx *mbx);
 506 void nicvf_config_rss(struct nicvf *nic);
 507 void nicvf_set_rss_key(struct nicvf *nic);
 508 void nicvf_set_ethtool_ops(struct net_device *netdev);
 509 void nicvf_update_stats(struct nicvf *nic);
 510 void nicvf_update_lmac_stats(struct nicvf *nic);
 511
 512 #endif /* NIC_H */