drivers/net/fm10k/fm10k.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2013-2015 Intel Corporation
   3  */
   4
   5 #ifndef _FM10K_H_
   6 #define _FM10K_H_
   7
   8 #include <stdint.h>
   9 #include <rte_mbuf.h>
  10 #include <rte_mempool.h>
  11 #include <rte_malloc.h>
  12 #include <rte_spinlock.h>
  13 #include "fm10k_logs.h"
  14 #include "base/fm10k_type.h"
  15
  16 /* descriptor ring base addresses must be aligned to the following */
  17 #define FM10K_ALIGN_RX_DESC  128
  18 #define FM10K_ALIGN_TX_DESC  128
  19
  20 /* The maximum packet size that FM10K supports */
  21 #define FM10K_MAX_PKT_SIZE  (15 * 1024)
  22
  23 /* Minimum size of RX buffer FM10K supported */
  24 #define FM10K_MIN_RX_BUF_SIZE  256
  25
  26 /* The maximum of SRIOV VFs per port supported */
  27 #define FM10K_MAX_VF_NUM    64
  28
  29 /* number of descriptors must be a multiple of the following */
  30 #define FM10K_MULT_RX_DESC  FM10K_REQ_RX_DESCRIPTOR_MULTIPLE
  31 #define FM10K_MULT_TX_DESC  FM10K_REQ_TX_DESCRIPTOR_MULTIPLE
  32
  33 /* maximum size of descriptor rings */
  34 #define FM10K_MAX_RX_RING_SZ  (512 * 1024)
  35 #define FM10K_MAX_TX_RING_SZ  (512 * 1024)
  36
  37 /* minimum and maximum number of descriptors in a ring */
  38 #define FM10K_MIN_RX_DESC  32
  39 #define FM10K_MIN_TX_DESC  32
  40 #define FM10K_MAX_RX_DESC  (FM10K_MAX_RX_RING_SZ / sizeof(union fm10k_rx_desc))
  41 #define FM10K_MAX_TX_DESC  (FM10K_MAX_TX_RING_SZ / sizeof(struct fm10k_tx_desc))
  42
  43 #define FM10K_TX_MAX_SEG     UINT8_MAX
  44 #define FM10K_TX_MAX_MTU_SEG UINT8_MAX
  45
  46 /*
  47  * byte aligment for HW RX data buffer
  48  * Datasheet requires RX buffer addresses shall either be 512-byte aligned or
  49  * be 8-byte aligned but without crossing host memory pages (4KB alignment
  50  * boundaries). Satisfy first option.
  51  */
  52 #define FM10K_RX_DATABUF_ALIGN 512
  53
  54 /*
  55  * threshold default, min, max, and divisor constraints
  56  * the configured values must satisfy the following:
  57  *   MIN <= value <= MAX
  58  *   DIV % value == 0
  59  */
  60 #define FM10K_RX_FREE_THRESH_DEFAULT(rxq)  32
  61 #define FM10K_RX_FREE_THRESH_MIN(rxq)      1
  62 #define FM10K_RX_FREE_THRESH_MAX(rxq)      ((rxq)->nb_desc - 1)
  63 #define FM10K_RX_FREE_THRESH_DIV(rxq)      ((rxq)->nb_desc)
  64
  65 #define FM10K_TX_FREE_THRESH_DEFAULT(txq)  32
  66 #define FM10K_TX_FREE_THRESH_MIN(txq)      1
  67 #define FM10K_TX_FREE_THRESH_MAX(txq)      ((txq)->nb_desc - 3)
  68 #define FM10K_TX_FREE_THRESH_DIV(txq)      0
  69
  70 #define FM10K_DEFAULT_RX_PTHRESH      8
  71 #define FM10K_DEFAULT_RX_HTHRESH      8
  72 #define FM10K_DEFAULT_RX_WTHRESH      0
  73
  74 #define FM10K_DEFAULT_TX_PTHRESH      32
  75 #define FM10K_DEFAULT_TX_HTHRESH      0
  76 #define FM10K_DEFAULT_TX_WTHRESH      0
  77
  78 #define FM10K_TX_RS_THRESH_DEFAULT(txq)    32
  79 #define FM10K_TX_RS_THRESH_MIN(txq)        1
  80 #define FM10K_TX_RS_THRESH_MAX(txq)        \
  81         RTE_MIN(((txq)->nb_desc - 2), (txq)->free_thresh)
  82 #define FM10K_TX_RS_THRESH_DIV(txq)        ((txq)->nb_desc)
  83
  84 #define FM10K_VLAN_TAG_SIZE 4
  85
  86 /* Maximum number of MAC addresses per PF/VF */
  87 #define FM10K_MAX_MACADDR_NUM       64
  88
  89 #define FM10K_UINT32_BIT_SIZE      (CHAR_BIT * sizeof(uint32_t))
  90 #define FM10K_VFTA_SIZE            (4096 / FM10K_UINT32_BIT_SIZE)
  91
  92 /* vlan_id is a 12 bit number.
  93  * The VFTA array is actually a 4096 bit array, 128 of 32bit elements.
  94  * 2^5 = 32. The val of lower 5 bits specifies the bit in the 32bit element.
  95  * The higher 7 bit val specifies VFTA array index.
  96  */
  97 #define FM10K_VFTA_BIT(vlan_id)    (1 << ((vlan_id) & 0x1F))
  98 #define FM10K_VFTA_IDX(vlan_id)    ((vlan_id) >> 5)
  99
 100 #define RTE_FM10K_RXQ_REARM_THRESH      32
 101 #define RTE_FM10K_VPMD_TX_BURST         32
 102 #define RTE_FM10K_MAX_RX_BURST          RTE_FM10K_RXQ_REARM_THRESH
 103 #define RTE_FM10K_TX_MAX_FREE_BUF_SZ    64
 104 #define RTE_FM10K_DESCS_PER_LOOP    4
 105
 106 #define FM10K_MISC_VEC_ID               RTE_INTR_VEC_ZERO_OFFSET
 107 #define FM10K_RX_VEC_START              RTE_INTR_VEC_RXTX_OFFSET
 108
 109 #define FM10K_SIMPLE_TX_FLAG ((uint32_t)ETH_TXQ_FLAGS_NOMULTSEGS | \
 110                                 ETH_TXQ_FLAGS_NOOFFLOADS)
 111
 112 struct fm10k_macvlan_filter_info {
 113         uint16_t vlan_num;       /* Total VLAN number */
 114         uint16_t mac_num;        /* Total mac number */
 115         uint16_t nb_queue_pools; /* Active queue pools number */
 116         /* VMDQ ID for each MAC address */
 117         uint8_t  mac_vmdq_id[FM10K_MAX_MACADDR_NUM];
 118         uint32_t vfta[FM10K_VFTA_SIZE];        /* VLAN bitmap */
 119 };
 120
 121 struct fm10k_dev_info {
 122         volatile uint32_t enable;
 123         volatile uint32_t glort;
 124         /* Protect the mailbox to avoid race condition */
 125         rte_spinlock_t    mbx_lock;
 126         struct fm10k_macvlan_filter_info    macvlan;
 127         /* Flag to indicate if RX vector conditions satisfied */
 128         bool rx_vec_allowed;
 129         bool sm_down;
 130 };
 131
 132 /*
 133  * Structure to store private data for each driver instance.
 134  */
 135 struct fm10k_adapter {
 136         struct fm10k_hw             hw;
 137         struct fm10k_hw_stats       stats;
 138         struct fm10k_dev_info       info;
 139 };
 140
 141 #define FM10K_DEV_PRIVATE_TO_HW(adapter) \
 142         (&((struct fm10k_adapter *)adapter)->hw)
 143
 144 #define FM10K_DEV_PRIVATE_TO_STATS(adapter) \
 145         (&((struct fm10k_adapter *)adapter)->stats)
 146
 147 #define FM10K_DEV_PRIVATE_TO_INFO(adapter) \
 148         (&((struct fm10k_adapter *)adapter)->info)
 149
 150 #define FM10K_DEV_PRIVATE_TO_MBXLOCK(adapter) \
 151         (&(((struct fm10k_adapter *)adapter)->info.mbx_lock))
 152
 153 #define FM10K_DEV_PRIVATE_TO_MACVLAN(adapter) \
 154                 (&(((struct fm10k_adapter *)adapter)->info.macvlan))
 155
 156 struct fm10k_rx_queue {
 157         struct rte_mempool *mp;
 158         struct rte_mbuf **sw_ring;
 159         volatile union fm10k_rx_desc *hw_ring;
 160         struct rte_mbuf *pkt_first_seg; /* First segment of current packet. */
 161         struct rte_mbuf *pkt_last_seg;  /* Last segment of current packet. */
 162         uint64_t hw_ring_phys_addr;
 163         uint64_t mbuf_initializer; /* value to init mbufs */
 164         /* need to alloc dummy mbuf, for wraparound when scanning hw ring */
 165         struct rte_mbuf fake_mbuf;
 166         uint16_t next_dd;
 167         uint16_t next_alloc;
 168         uint16_t next_trigger;
 169         uint16_t alloc_thresh;
 170         volatile uint32_t *tail_ptr;
 171         uint16_t nb_desc;
 172         /* Number of faked desc added at the tail for Vector RX function */
 173         uint16_t nb_fake_desc;
 174         uint16_t queue_id;
 175         /* Below 2 fields only valid in case vPMD is applied. */
 176         uint16_t rxrearm_nb;     /* number of remaining to be re-armed */
 177         uint16_t rxrearm_start;  /* the idx we start the re-arming from */
 178         uint16_t rx_using_sse; /* indicates that vector RX is in use */
 179         uint16_t port_id;
 180         uint8_t drop_en;
 181         uint8_t rx_deferred_start; /* don't start this queue in dev start. */
 182         uint16_t rx_ftag_en; /* indicates FTAG RX supported */
 183 };
 184
 185 /*
 186  * a FIFO is used to track which descriptors have their RS bit set for Tx
 187  * queues which are configured to allow multiple descriptors per packet
 188  */
 189 struct fifo {
 190         uint16_t *list;
 191         uint16_t *head;
 192         uint16_t *tail;
 193         uint16_t *endp;
 194 };
 195
 196 struct fm10k_txq_ops;
 197
 198 struct fm10k_tx_queue {
 199         struct rte_mbuf **sw_ring;
 200         struct fm10k_tx_desc *hw_ring;
 201         uint64_t hw_ring_phys_addr;
 202         struct fifo rs_tracker;
 203         const struct fm10k_txq_ops *ops; /* txq ops */
 204         uint16_t last_free;
 205         uint16_t next_free;
 206         uint16_t nb_free;
 207         uint16_t nb_used;
 208         uint16_t free_thresh;
 209         uint16_t rs_thresh;
 210         /* Below 2 fields only valid in case vPMD is applied. */
 211         uint16_t next_rs; /* Next pos to set RS flag */
 212         uint16_t next_dd; /* Next pos to check DD flag */
 213         volatile uint32_t *tail_ptr;
 214         uint32_t txq_flags; /* Holds flags for this TXq */
 215         uint16_t nb_desc;
 216         uint16_t port_id;
 217         uint8_t tx_deferred_start; /** don't start this queue in dev start. */
 218         uint16_t queue_id;
 219         uint16_t tx_ftag_en; /* indicates FTAG TX supported */
 220 };
 221
 222 struct fm10k_txq_ops {
 223         void (*reset)(struct fm10k_tx_queue *txq);
 224 };
 225
 226 #define MBUF_DMA_ADDR(mb) \
 227         ((uint64_t) ((mb)->buf_iova + (mb)->data_off))
 228
 229 /* enforce 512B alignment on default Rx DMA addresses */
 230 #define MBUF_DMA_ADDR_DEFAULT(mb) \
 231         ((uint64_t) RTE_ALIGN(((mb)->buf_iova + RTE_PKTMBUF_HEADROOM),\
 232                         FM10K_RX_DATABUF_ALIGN))
 233
 234 static inline void fifo_reset(struct fifo *fifo, uint32_t len)
 235 {
 236         fifo->head = fifo->tail = fifo->list;
 237         fifo->endp = fifo->list + len;
 238 }
 239
 240 static inline void fifo_insert(struct fifo *fifo, uint16_t val)
 241 {
 242         *fifo->head = val;
 243         if (++fifo->head == fifo->endp)
 244                 fifo->head = fifo->list;
 245 }
 246
 247 /* do not worry about list being empty since we only check it once we know
 248  * we have used enough descriptors to set the RS bit at least once */
 249 static inline uint16_t fifo_peek(struct fifo *fifo)
 250 {
 251         return *fifo->tail;
 252 }
 253
 254 static inline uint16_t fifo_remove(struct fifo *fifo)
 255 {
 256         uint16_t val;
 257         val = *fifo->tail;
 258         if (++fifo->tail == fifo->endp)
 259                 fifo->tail = fifo->list;
 260         return val;
 261 }
 262
 263 static inline void
 264 fm10k_pktmbuf_reset(struct rte_mbuf *mb, uint16_t in_port)
 265 {
 266         rte_mbuf_refcnt_set(mb, 1);
 267         mb->next = NULL;
 268         mb->nb_segs = 1;
 269
 270         /* enforce 512B alignment on default Rx virtual addresses */
 271         mb->data_off = (uint16_t)(RTE_PTR_ALIGN((char *)mb->buf_addr +
 272                         RTE_PKTMBUF_HEADROOM, FM10K_RX_DATABUF_ALIGN)
 273                         - (char *)mb->buf_addr);
 274         mb->port = in_port;
 275 }
 276
 277 /*
 278  * Verify Rx packet buffer alignment is valid.
 279  *
 280  * Hardware requires specific alignment for Rx packet buffers. At
 281  * least one of the following two conditions must be satisfied.
 282  *  1. Address is 512B aligned
 283  *  2. Address is 8B aligned and buffer does not cross 4K boundary.
 284  *
 285  * Return 1 if buffer alignment satisfies at least one condition,
 286  * otherwise return 0.
 287  *
 288  * Note: Alignment is checked by the driver when the Rx queue is reset. It
 289  *       is assumed that if an entire descriptor ring can be filled with
 290  *       buffers containing valid alignment, then all buffers in that mempool
 291  *       have valid address alignment. It is the responsibility of the user
 292  *       to ensure all buffers have valid alignment, as it is the user who
 293  *       creates the mempool.
 294  * Note: It is assumed the buffer needs only to store a maximum size Ethernet
 295  *       frame.
 296  */
 297 static inline int
 298 fm10k_addr_alignment_valid(struct rte_mbuf *mb)
 299 {
 300         uint64_t addr = MBUF_DMA_ADDR_DEFAULT(mb);
 301         uint64_t boundary1, boundary2;
 302
 303         /* 512B aligned? */
 304         if (RTE_ALIGN(addr, FM10K_RX_DATABUF_ALIGN) == addr)
 305                 return 1;
 306
 307         /* 8B aligned, and max Ethernet frame would not cross a 4KB boundary? */
 308         if (RTE_ALIGN(addr, 8) == addr) {
 309                 boundary1 = RTE_ALIGN_FLOOR(addr, 4096);
 310                 boundary2 = RTE_ALIGN_FLOOR(addr + ETHER_MAX_VLAN_FRAME_LEN,
 311                                                 4096);
 312                 if (boundary1 == boundary2)
 313                         return 1;
 314         }
 315
 316         PMD_INIT_LOG(ERR, "Error: Invalid buffer alignment!");
 317
 318         return 0;
 319 }
 320
 321 /* Rx and Tx prototypes */
 322 uint16_t fm10k_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 323         uint16_t nb_pkts);
 324
 325 uint16_t fm10k_recv_scattered_pkts(void *rx_queue,
 326                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 327
 328 int
 329 fm10k_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 330
 331 uint16_t fm10k_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 332         uint16_t nb_pkts);
 333
 334 uint16_t fm10k_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 335         uint16_t nb_pkts);
 336
 337 int fm10k_rxq_vec_setup(struct fm10k_rx_queue *rxq);
 338 int fm10k_rx_vec_condition_check(struct rte_eth_dev *);
 339 void fm10k_rx_queue_release_mbufs_vec(struct fm10k_rx_queue *rxq);
 340 uint16_t fm10k_recv_pkts_vec(void *, struct rte_mbuf **, uint16_t);
 341 uint16_t fm10k_recv_scattered_pkts_vec(void *, struct rte_mbuf **,
 342                                         uint16_t);
 343 uint16_t fm10k_xmit_fixed_burst_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
 344                                     uint16_t nb_pkts);
 345 void fm10k_txq_vec_setup(struct fm10k_tx_queue *txq);
 346 int fm10k_tx_vec_condition_check(struct fm10k_tx_queue *txq);
 347
 348 #endif