drivers/net/nfp/nfp_net_pmd.h

   1 /*
   2  * Copyright (c) 2014-2018 Netronome Systems, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *  this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *  notice, this list of conditions and the following disclaimer in the
  13  *  documentation and/or other materials provided with the distribution
  14  *
  15  * 3. Neither the name of the copyright holder nor the names of its
  16  *  contributors may be used to endorse or promote products derived from this
  17  *  software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * vim:shiftwidth=8:noexpandtab
  34  *
  35  * @file dpdk/pmd/nfp_net_pmd.h
  36  *
  37  * Netronome NFP_NET PDM driver
  38  */
  39
  40 #ifndef _NFP_NET_PMD_H_
  41 #define _NFP_NET_PMD_H_
  42
  43 #define NFP_NET_PMD_VERSION "0.1"
  44 #define PCI_VENDOR_ID_NETRONOME         0x19ee
  45 #define PCI_DEVICE_ID_NFP4000_PF_NIC    0x4000
  46 #define PCI_DEVICE_ID_NFP6000_PF_NIC    0x6000
  47 #define PCI_DEVICE_ID_NFP6000_VF_NIC    0x6003
  48
  49 /* Forward declaration */
  50 struct nfp_net_adapter;
  51
  52 /*
  53  * The maximum number of descriptors is limited by design as
  54  * DPDK uses uint16_t variables for these values
  55  */
  56 #define NFP_NET_MAX_TX_DESC (32 * 1024)
  57 #define NFP_NET_MIN_TX_DESC 64
  58
  59 #define NFP_NET_MAX_RX_DESC (32 * 1024)
  60 #define NFP_NET_MIN_RX_DESC 64
  61
  62 /* Bar allocation */
  63 #define NFP_NET_CRTL_BAR        0
  64 #define NFP_NET_TX_BAR          2
  65 #define NFP_NET_RX_BAR          2
  66 #define NFP_QCP_QUEUE_AREA_SZ                   0x80000
  67
  68 /* Macros for accessing the Queue Controller Peripheral 'CSRs' */
  69 #define NFP_QCP_QUEUE_OFF(_x)                 ((_x) * 0x800)
  70 #define NFP_QCP_QUEUE_ADD_RPTR                  0x0000
  71 #define NFP_QCP_QUEUE_ADD_WPTR                  0x0004
  72 #define NFP_QCP_QUEUE_STS_LO                    0x0008
  73 #define NFP_QCP_QUEUE_STS_LO_READPTR_mask     (0x3ffff)
  74 #define NFP_QCP_QUEUE_STS_HI                    0x000c
  75 #define NFP_QCP_QUEUE_STS_HI_WRITEPTR_mask    (0x3ffff)
  76
  77 /* Interrupt definitions */
  78 #define NFP_NET_IRQ_LSC_IDX             0
  79
  80 /* Default values for RX/TX configuration */
  81 #define DEFAULT_RX_FREE_THRESH  32
  82 #define DEFAULT_RX_PTHRESH      8
  83 #define DEFAULT_RX_HTHRESH      8
  84 #define DEFAULT_RX_WTHRESH      0
  85
  86 #define DEFAULT_TX_RS_THRESH    32
  87 #define DEFAULT_TX_FREE_THRESH  32
  88 #define DEFAULT_TX_PTHRESH      32
  89 #define DEFAULT_TX_HTHRESH      0
  90 #define DEFAULT_TX_WTHRESH      0
  91 #define DEFAULT_TX_RSBIT_THRESH 32
  92
  93 /* Alignment for dma zones */
  94 #define NFP_MEMZONE_ALIGN       128
  95
  96 /*
  97  * This is used by the reconfig protocol. It sets the maximum time waiting in
  98  * milliseconds before a reconfig timeout happens.
  99  */
 100 #define NFP_NET_POLL_TIMEOUT    5000
 101
 102 #define NFP_QCP_QUEUE_ADDR_SZ   (0x800)
 103
 104 #define NFP_NET_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
 105 #define NFP_NET_LINK_UP_CHECK_TIMEOUT   1000 /* ms */
 106
 107 /* Version number helper defines */
 108 #define NFD_CFG_CLASS_VER_msk       0xff
 109 #define NFD_CFG_CLASS_VER_shf       24
 110 #define NFD_CFG_CLASS_VER(x)        (((x) & 0xff) << 24)
 111 #define NFD_CFG_CLASS_VER_of(x)     (((x) >> 24) & 0xff)
 112 #define NFD_CFG_CLASS_TYPE_msk      0xff
 113 #define NFD_CFG_CLASS_TYPE_shf      16
 114 #define NFD_CFG_CLASS_TYPE(x)       (((x) & 0xff) << 16)
 115 #define NFD_CFG_CLASS_TYPE_of(x)    (((x) >> 16) & 0xff)
 116 #define NFD_CFG_MAJOR_VERSION_msk   0xff
 117 #define NFD_CFG_MAJOR_VERSION_shf   8
 118 #define NFD_CFG_MAJOR_VERSION(x)    (((x) & 0xff) << 8)
 119 #define NFD_CFG_MAJOR_VERSION_of(x) (((x) >> 8) & 0xff)
 120 #define NFD_CFG_MINOR_VERSION_msk   0xff
 121 #define NFD_CFG_MINOR_VERSION_shf   0
 122 #define NFD_CFG_MINOR_VERSION(x)    (((x) & 0xff) << 0)
 123 #define NFD_CFG_MINOR_VERSION_of(x) (((x) >> 0) & 0xff)
 124
 125 #include <linux/types.h>
 126 #include <rte_io.h>
 127
 128 static inline uint8_t nn_readb(volatile const void *addr)
 129 {
 130         return rte_read8(addr);
 131 }
 132
 133 static inline void nn_writeb(uint8_t val, volatile void *addr)
 134 {
 135         rte_write8(val, addr);
 136 }
 137
 138 static inline uint32_t nn_readl(volatile const void *addr)
 139 {
 140         return rte_read32(addr);
 141 }
 142
 143 static inline void nn_writel(uint32_t val, volatile void *addr)
 144 {
 145         rte_write32(val, addr);
 146 }
 147
 148 static inline void nn_writew(uint16_t val, volatile void *addr)
 149 {
 150         rte_write16(val, addr);
 151 }
 152
 153 static inline uint64_t nn_readq(volatile void *addr)
 154 {
 155         const volatile uint32_t *p = addr;
 156         uint32_t low, high;
 157
 158         high = nn_readl((volatile const void *)(p + 1));
 159         low = nn_readl((volatile const void *)p);
 160
 161         return low + ((uint64_t)high << 32);
 162 }
 163
 164 static inline void nn_writeq(uint64_t val, volatile void *addr)
 165 {
 166         nn_writel(val >> 32, (volatile char *)addr + 4);
 167         nn_writel(val, addr);
 168 }
 169
 170 /* TX descriptor format */
 171 #define PCIE_DESC_TX_EOP                (1 << 7)
 172 #define PCIE_DESC_TX_OFFSET_MASK        (0x7f)
 173
 174 /* Flags in the host TX descriptor */
 175 #define PCIE_DESC_TX_CSUM               (1 << 7)
 176 #define PCIE_DESC_TX_IP4_CSUM           (1 << 6)
 177 #define PCIE_DESC_TX_TCP_CSUM           (1 << 5)
 178 #define PCIE_DESC_TX_UDP_CSUM           (1 << 4)
 179 #define PCIE_DESC_TX_VLAN               (1 << 3)
 180 #define PCIE_DESC_TX_LSO                (1 << 2)
 181 #define PCIE_DESC_TX_ENCAP_NONE         (0)
 182 #define PCIE_DESC_TX_ENCAP_VXLAN        (1 << 1)
 183 #define PCIE_DESC_TX_ENCAP_GRE          (1 << 0)
 184
 185 struct nfp_net_tx_desc {
 186         union {
 187                 struct {
 188                         uint8_t dma_addr_hi;   /* High bits of host buf address */
 189                         __le16 dma_len;     /* Length to DMA for this desc */
 190                         uint8_t offset_eop;    /* Offset in buf where pkt starts +
 191                                              * highest bit is eop flag.
 192                                              */
 193                         __le32 dma_addr_lo; /* Low 32bit of host buf addr */
 194
 195                         __le16 lso;         /* MSS to be used for LSO */
 196                         uint8_t l4_offset;     /* LSO, where the L4 data starts */
 197                         uint8_t flags;         /* TX Flags, see @PCIE_DESC_TX_* */
 198
 199                         __le16 vlan;        /* VLAN tag to add if indicated */
 200                         __le16 data_len;    /* Length of frame + meta data */
 201                 } __attribute__((__packed__));
 202                 __le32 vals[4];
 203         };
 204 };
 205
 206 struct nfp_net_txq {
 207         struct nfp_net_hw *hw; /* Backpointer to nfp_net structure */
 208
 209         /*
 210          * Queue information: @qidx is the queue index from Linux's
 211          * perspective.  @tx_qcidx is the index of the Queue
 212          * Controller Peripheral queue relative to the TX queue BAR.
 213          * @cnt is the size of the queue in number of
 214          * descriptors. @qcp_q is a pointer to the base of the queue
 215          * structure on the NFP
 216          */
 217         uint8_t *qcp_q;
 218
 219         /*
 220          * Read and Write pointers.  @wr_p and @rd_p are host side pointer,
 221          * they are free running and have little relation to the QCP pointers *
 222          * @qcp_rd_p is a local copy queue controller peripheral read pointer
 223          */
 224
 225         uint32_t wr_p;
 226         uint32_t rd_p;
 227
 228         uint32_t tx_count;
 229
 230         uint32_t tx_free_thresh;
 231
 232         /*
 233          * For each descriptor keep a reference to the mbuff and
 234          * DMA address used until completion is signalled.
 235          */
 236         struct {
 237                 struct rte_mbuf *mbuf;
 238         } *txbufs;
 239
 240         /*
 241          * Information about the host side queue location. @txds is
 242          * the virtual address for the queue, @dma is the DMA address
 243          * of the queue and @size is the size in bytes for the queue
 244          * (needed for free)
 245          */
 246         struct nfp_net_tx_desc *txds;
 247
 248         /*
 249          * At this point 48 bytes have been used for all the fields in the
 250          * TX critical path. We have room for 8 bytes and still all placed
 251          * in a cache line. We are not using the threshold values below but
 252          * if we need to, we can add the most used in the remaining bytes.
 253          */
 254         uint32_t tx_rs_thresh; /* not used by now. Future? */
 255         uint32_t tx_pthresh;   /* not used by now. Future? */
 256         uint32_t tx_hthresh;   /* not used by now. Future? */
 257         uint32_t tx_wthresh;   /* not used by now. Future? */
 258         uint16_t port_id;
 259         int qidx;
 260         int tx_qcidx;
 261         __le64 dma;
 262 } __attribute__ ((__aligned__(64)));
 263
 264 /* RX and freelist descriptor format */
 265 #define PCIE_DESC_RX_DD                 (1 << 7)
 266 #define PCIE_DESC_RX_META_LEN_MASK      (0x7f)
 267
 268 /* Flags in the RX descriptor */
 269 #define PCIE_DESC_RX_RSS                (1 << 15)
 270 #define PCIE_DESC_RX_I_IP4_CSUM         (1 << 14)
 271 #define PCIE_DESC_RX_I_IP4_CSUM_OK      (1 << 13)
 272 #define PCIE_DESC_RX_I_TCP_CSUM         (1 << 12)
 273 #define PCIE_DESC_RX_I_TCP_CSUM_OK      (1 << 11)
 274 #define PCIE_DESC_RX_I_UDP_CSUM         (1 << 10)
 275 #define PCIE_DESC_RX_I_UDP_CSUM_OK      (1 <<  9)
 276 #define PCIE_DESC_RX_SPARE              (1 <<  8)
 277 #define PCIE_DESC_RX_EOP                (1 <<  7)
 278 #define PCIE_DESC_RX_IP4_CSUM           (1 <<  6)
 279 #define PCIE_DESC_RX_IP4_CSUM_OK        (1 <<  5)
 280 #define PCIE_DESC_RX_TCP_CSUM           (1 <<  4)
 281 #define PCIE_DESC_RX_TCP_CSUM_OK        (1 <<  3)
 282 #define PCIE_DESC_RX_UDP_CSUM           (1 <<  2)
 283 #define PCIE_DESC_RX_UDP_CSUM_OK        (1 <<  1)
 284 #define PCIE_DESC_RX_VLAN               (1 <<  0)
 285
 286 struct nfp_net_rx_desc {
 287         union {
 288                 /* Freelist descriptor */
 289                 struct {
 290                         uint8_t dma_addr_hi;
 291                         __le16 spare;
 292                         uint8_t dd;
 293
 294                         __le32 dma_addr_lo;
 295                 } __attribute__((__packed__)) fld;
 296
 297                 /* RX descriptor */
 298                 struct {
 299                         __le16 data_len;
 300                         uint8_t reserved;
 301                         uint8_t meta_len_dd;
 302
 303                         __le16 flags;
 304                         __le16 vlan;
 305                 } __attribute__((__packed__)) rxd;
 306
 307                 __le32 vals[2];
 308         };
 309 };
 310
 311 struct nfp_net_rx_buff {
 312         struct rte_mbuf *mbuf;
 313 };
 314
 315 struct nfp_net_rxq {
 316         struct nfp_net_hw *hw;  /* Backpointer to nfp_net structure */
 317
 318          /*
 319           * @qcp_fl and @qcp_rx are pointers to the base addresses of the
 320           * freelist and RX queue controller peripheral queue structures on the
 321           * NFP
 322           */
 323         uint8_t *qcp_fl;
 324         uint8_t *qcp_rx;
 325
 326         /*
 327          * Read and Write pointers.  @wr_p and @rd_p are host side
 328          * pointer, they are free running and have little relation to
 329          * the QCP pointers. @wr_p is where the driver adds new
 330          * freelist descriptors and @rd_p is where the driver start
 331          * reading descriptors for newly arrive packets from.
 332          */
 333         uint32_t rd_p;
 334
 335         /*
 336          * For each buffer placed on the freelist, record the
 337          * associated SKB
 338          */
 339         struct nfp_net_rx_buff *rxbufs;
 340
 341         /*
 342          * Information about the host side queue location.  @rxds is
 343          * the virtual address for the queue
 344          */
 345         struct nfp_net_rx_desc *rxds;
 346
 347         /*
 348          * The mempool is created by the user specifying a mbuf size.
 349          * We save here the reference of the mempool needed in the RX
 350          * path and the mbuf size for checking received packets can be
 351          * safely copied to the mbuf using the NFP_NET_RX_OFFSET
 352          */
 353         struct rte_mempool *mem_pool;
 354         uint16_t mbuf_size;
 355
 356         /*
 357          * Next two fields are used for giving more free descriptors
 358          * to the NFP
 359          */
 360         uint16_t rx_free_thresh;
 361         uint16_t nb_rx_hold;
 362
 363          /* the size of the queue in number of descriptors */
 364         uint16_t rx_count;
 365
 366         /*
 367          * Fields above this point fit in a single cache line and are all used
 368          * in the RX critical path. Fields below this point are just used
 369          * during queue configuration or not used at all (yet)
 370          */
 371
 372         /* referencing dev->data->port_id */
 373         uint16_t port_id;
 374
 375         uint8_t  crc_len; /* Not used by now */
 376         uint8_t  drop_en; /* Not used by now */
 377
 378         /* DMA address of the queue */
 379         __le64 dma;
 380
 381         /*
 382          * Queue information: @qidx is the queue index from Linux's
 383          * perspective.  @fl_qcidx is the index of the Queue
 384          * Controller peripheral queue relative to the RX queue BAR
 385          * used for the freelist and @rx_qcidx is the Queue Controller
 386          * Peripheral index for the RX queue.
 387          */
 388         int qidx;
 389         int fl_qcidx;
 390         int rx_qcidx;
 391 } __attribute__ ((__aligned__(64)));
 392
 393 struct nfp_net_hw {
 394         /* Info from the firmware */
 395         uint32_t ver;
 396         uint32_t cap;
 397         uint32_t max_mtu;
 398         uint32_t mtu;
 399         uint32_t rx_offset;
 400
 401         /* Current values for control */
 402         uint32_t ctrl;
 403
 404         uint8_t *ctrl_bar;
 405         uint8_t *tx_bar;
 406         uint8_t *rx_bar;
 407
 408         int stride_rx;
 409         int stride_tx;
 410
 411         uint8_t *qcp_cfg;
 412         rte_spinlock_t reconfig_lock;
 413
 414         uint32_t max_tx_queues;
 415         uint32_t max_rx_queues;
 416         uint16_t flbufsz;
 417         uint16_t device_id;
 418         uint16_t vendor_id;
 419         uint16_t subsystem_device_id;
 420         uint16_t subsystem_vendor_id;
 421 #if defined(DSTQ_SELECTION)
 422 #if DSTQ_SELECTION
 423         uint16_t device_function;
 424 #endif
 425 #endif
 426
 427         uint8_t mac_addr[ETHER_ADDR_LEN];
 428
 429         /* Records starting point for counters */
 430         struct rte_eth_stats eth_stats_base;
 431
 432         struct nfp_cpp *cpp;
 433         struct nfp_cpp_area *ctrl_area;
 434         struct nfp_cpp_area *hwqueues_area;
 435         struct nfp_cpp_area *msix_area;
 436
 437         uint8_t *hw_queues;
 438         uint8_t is_pf;
 439         uint8_t pf_port_idx;
 440         uint8_t pf_multiport_enabled;
 441         uint8_t total_ports;
 442
 443         union eth_table_entry *eth_table;
 444
 445         struct nfp_hwinfo *hwinfo;
 446         struct nfp_rtsym_table *sym_tbl;
 447 };
 448
 449 struct nfp_net_adapter {
 450         struct nfp_net_hw hw;
 451 };
 452
 453 #define NFP_NET_DEV_PRIVATE_TO_HW(adapter)\
 454         (&((struct nfp_net_adapter *)adapter)->hw)
 455
 456 #endif /* _NFP_NET_PMD_H_ */
 457 /*
 458  * Local variables:
 459  * c-file-style: "Linux"
 460  * indent-tabs-mode: t
 461  * End:
 462  */