drivers/net/fm10k/fm10k.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _FM10K_H_
  35 #define _FM10K_H_
  36
  37 #include <stdint.h>
  38 #include <rte_mbuf.h>
  39 #include <rte_mempool.h>
  40 #include <rte_malloc.h>
  41 #include <rte_spinlock.h>
  42 #include "fm10k_logs.h"
  43 #include "base/fm10k_type.h"
  44
  45 /* descriptor ring base addresses must be aligned to the following */
  46 #define FM10K_ALIGN_RX_DESC  128
  47 #define FM10K_ALIGN_TX_DESC  128
  48
  49 /* The maximum packet size that FM10K supports */
  50 #define FM10K_MAX_PKT_SIZE  (15 * 1024)
  51
  52 /* Minimum size of RX buffer FM10K supported */
  53 #define FM10K_MIN_RX_BUF_SIZE  256
  54
  55 /* The maximum of SRIOV VFs per port supported */
  56 #define FM10K_MAX_VF_NUM    64
  57
  58 /* number of descriptors must be a multiple of the following */
  59 #define FM10K_MULT_RX_DESC  FM10K_REQ_RX_DESCRIPTOR_MULTIPLE
  60 #define FM10K_MULT_TX_DESC  FM10K_REQ_TX_DESCRIPTOR_MULTIPLE
  61
  62 /* maximum size of descriptor rings */
  63 #define FM10K_MAX_RX_RING_SZ  (512 * 1024)
  64 #define FM10K_MAX_TX_RING_SZ  (512 * 1024)
  65
  66 /* minimum and maximum number of descriptors in a ring */
  67 #define FM10K_MIN_RX_DESC  32
  68 #define FM10K_MIN_TX_DESC  32
  69 #define FM10K_MAX_RX_DESC  (FM10K_MAX_RX_RING_SZ / sizeof(union fm10k_rx_desc))
  70 #define FM10K_MAX_TX_DESC  (FM10K_MAX_TX_RING_SZ / sizeof(struct fm10k_tx_desc))
  71
  72 /*
  73  * byte aligment for HW RX data buffer
  74  * Datasheet requires RX buffer addresses shall either be 512-byte aligned or
  75  * be 8-byte aligned but without crossing host memory pages (4KB alignment
  76  * boundaries). Satisfy first option.
  77  */
  78 #define FM10K_RX_DATABUF_ALIGN 512
  79
  80 /*
  81  * threshold default, min, max, and divisor constraints
  82  * the configured values must satisfy the following:
  83  *   MIN <= value <= MAX
  84  *   DIV % value == 0
  85  */
  86 #define FM10K_RX_FREE_THRESH_DEFAULT(rxq)  32
  87 #define FM10K_RX_FREE_THRESH_MIN(rxq)      1
  88 #define FM10K_RX_FREE_THRESH_MAX(rxq)      ((rxq)->nb_desc - 1)
  89 #define FM10K_RX_FREE_THRESH_DIV(rxq)      ((rxq)->nb_desc)
  90
  91 #define FM10K_TX_FREE_THRESH_DEFAULT(txq)  32
  92 #define FM10K_TX_FREE_THRESH_MIN(txq)      1
  93 #define FM10K_TX_FREE_THRESH_MAX(txq)      ((txq)->nb_desc - 3)
  94 #define FM10K_TX_FREE_THRESH_DIV(txq)      0
  95
  96 #define FM10K_DEFAULT_RX_PTHRESH      8
  97 #define FM10K_DEFAULT_RX_HTHRESH      8
  98 #define FM10K_DEFAULT_RX_WTHRESH      0
  99
 100 #define FM10K_DEFAULT_TX_PTHRESH      32
 101 #define FM10K_DEFAULT_TX_HTHRESH      0
 102 #define FM10K_DEFAULT_TX_WTHRESH      0
 103
 104 #define FM10K_TX_RS_THRESH_DEFAULT(txq)    32
 105 #define FM10K_TX_RS_THRESH_MIN(txq)        1
 106 #define FM10K_TX_RS_THRESH_MAX(txq)        \
 107         RTE_MIN(((txq)->nb_desc - 2), (txq)->free_thresh)
 108 #define FM10K_TX_RS_THRESH_DIV(txq)        ((txq)->nb_desc)
 109
 110 #define FM10K_VLAN_TAG_SIZE 4
 111
 112 /* Maximum number of MAC addresses per PF/VF */
 113 #define FM10K_MAX_MACADDR_NUM       64
 114
 115 #define FM10K_UINT32_BIT_SIZE      (CHAR_BIT * sizeof(uint32_t))
 116 #define FM10K_VFTA_SIZE            (4096 / FM10K_UINT32_BIT_SIZE)
 117
 118 /* vlan_id is a 12 bit number.
 119  * The VFTA array is actually a 4096 bit array, 128 of 32bit elements.
 120  * 2^5 = 32. The val of lower 5 bits specifies the bit in the 32bit element.
 121  * The higher 7 bit val specifies VFTA array index.
 122  */
 123 #define FM10K_VFTA_BIT(vlan_id)    (1 << ((vlan_id) & 0x1F))
 124 #define FM10K_VFTA_IDX(vlan_id)    ((vlan_id) >> 5)
 125
 126 struct fm10k_macvlan_filter_info {
 127         uint16_t vlan_num;       /* Total VLAN number */
 128         uint16_t mac_num;        /* Total mac number */
 129         uint32_t vfta[FM10K_VFTA_SIZE];        /* VLAN bitmap */
 130 };
 131
 132 struct fm10k_dev_info {
 133         volatile uint32_t enable;
 134         volatile uint32_t glort;
 135         /* Protect the mailbox to avoid race condition */
 136         rte_spinlock_t    mbx_lock;
 137         struct fm10k_macvlan_filter_info    macvlan;
 138 };
 139
 140 /*
 141  * Structure to store private data for each driver instance.
 142  */
 143 struct fm10k_adapter {
 144         struct fm10k_hw             hw;
 145         struct fm10k_hw_stats       stats;
 146         struct fm10k_dev_info       info;
 147 };
 148
 149 #define FM10K_DEV_PRIVATE_TO_HW(adapter) \
 150         (&((struct fm10k_adapter *)adapter)->hw)
 151
 152 #define FM10K_DEV_PRIVATE_TO_STATS(adapter) \
 153         (&((struct fm10k_adapter *)adapter)->stats)
 154
 155 #define FM10K_DEV_PRIVATE_TO_INFO(adapter) \
 156         (&((struct fm10k_adapter *)adapter)->info)
 157
 158 #define FM10K_DEV_PRIVATE_TO_MBXLOCK(adapter) \
 159         (&(((struct fm10k_adapter *)adapter)->info.mbx_lock))
 160
 161 #define FM10K_DEV_PRIVATE_TO_MACVLAN(adapter) \
 162                 (&(((struct fm10k_adapter *)adapter)->info.macvlan))
 163
 164 struct fm10k_rx_queue {
 165         struct rte_mempool *mp;
 166         struct rte_mbuf **sw_ring;
 167         volatile union fm10k_rx_desc *hw_ring;
 168         struct rte_mbuf *pkt_first_seg; /**< First segment of current packet. */
 169         struct rte_mbuf *pkt_last_seg;  /**< Last segment of current packet. */
 170         uint64_t hw_ring_phys_addr;
 171         uint16_t next_dd;
 172         uint16_t next_alloc;
 173         uint16_t next_trigger;
 174         uint16_t alloc_thresh;
 175         volatile uint32_t *tail_ptr;
 176         uint16_t nb_desc;
 177         uint16_t queue_id;
 178         uint8_t port_id;
 179         uint8_t drop_en;
 180         uint8_t rx_deferred_start; /**< don't start this queue in dev start. */
 181 };
 182
 183 /*
 184  * a FIFO is used to track which descriptors have their RS bit set for Tx
 185  * queues which are configured to allow multiple descriptors per packet
 186  */
 187 struct fifo {
 188         uint16_t *list;
 189         uint16_t *head;
 190         uint16_t *tail;
 191         uint16_t *endp;
 192 };
 193
 194 struct fm10k_tx_queue {
 195         struct rte_mbuf **sw_ring;
 196         struct fm10k_tx_desc *hw_ring;
 197         uint64_t hw_ring_phys_addr;
 198         struct fifo rs_tracker;
 199         uint16_t last_free;
 200         uint16_t next_free;
 201         uint16_t nb_free;
 202         uint16_t nb_used;
 203         uint16_t free_thresh;
 204         uint16_t rs_thresh;
 205         volatile uint32_t *tail_ptr;
 206         uint16_t nb_desc;
 207         uint8_t port_id;
 208         uint8_t tx_deferred_start; /** < don't start this queue in dev start. */
 209         uint16_t queue_id;
 210 };
 211
 212 #define MBUF_DMA_ADDR(mb) \
 213         ((uint64_t) ((mb)->buf_physaddr + (mb)->data_off))
 214
 215 /* enforce 512B alignment on default Rx DMA addresses */
 216 #define MBUF_DMA_ADDR_DEFAULT(mb) \
 217         ((uint64_t) RTE_ALIGN(((mb)->buf_physaddr + RTE_PKTMBUF_HEADROOM),\
 218                         FM10K_RX_DATABUF_ALIGN))
 219
 220 static inline void fifo_reset(struct fifo *fifo, uint32_t len)
 221 {
 222         fifo->head = fifo->tail = fifo->list;
 223         fifo->endp = fifo->list + len;
 224 }
 225
 226 static inline void fifo_insert(struct fifo *fifo, uint16_t val)
 227 {
 228         *fifo->head = val;
 229         if (++fifo->head == fifo->endp)
 230                 fifo->head = fifo->list;
 231 }
 232
 233 /* do not worry about list being empty since we only check it once we know
 234  * we have used enough descriptors to set the RS bit at least once */
 235 static inline uint16_t fifo_peek(struct fifo *fifo)
 236 {
 237         return *fifo->tail;
 238 }
 239
 240 static inline uint16_t fifo_remove(struct fifo *fifo)
 241 {
 242         uint16_t val;
 243         val = *fifo->tail;
 244         if (++fifo->tail == fifo->endp)
 245                 fifo->tail = fifo->list;
 246         return val;
 247 }
 248
 249 static inline void
 250 fm10k_pktmbuf_reset(struct rte_mbuf *mb, uint8_t in_port)
 251 {
 252         rte_mbuf_refcnt_set(mb, 1);
 253         mb->next = NULL;
 254         mb->nb_segs = 1;
 255
 256         /* enforce 512B alignment on default Rx virtual addresses */
 257         mb->data_off = (uint16_t)(RTE_PTR_ALIGN((char *)mb->buf_addr +
 258                         RTE_PKTMBUF_HEADROOM, FM10K_RX_DATABUF_ALIGN)
 259                         - (char *)mb->buf_addr);
 260         mb->port = in_port;
 261 }
 262
 263 /*
 264  * Verify Rx packet buffer alignment is valid.
 265  *
 266  * Hardware requires specific alignment for Rx packet buffers. At
 267  * least one of the following two conditions must be satisfied.
 268  *  1. Address is 512B aligned
 269  *  2. Address is 8B aligned and buffer does not cross 4K boundary.
 270  *
 271  * Return 1 if buffer alignment satisfies at least one condition,
 272  * otherwise return 0.
 273  *
 274  * Note: Alignment is checked by the driver when the Rx queue is reset. It
 275  *       is assumed that if an entire descriptor ring can be filled with
 276  *       buffers containing valid alignment, then all buffers in that mempool
 277  *       have valid address alignment. It is the responsibility of the user
 278  *       to ensure all buffers have valid alignment, as it is the user who
 279  *       creates the mempool.
 280  * Note: It is assumed the buffer needs only to store a maximum size Ethernet
 281  *       frame.
 282  */
 283 static inline int
 284 fm10k_addr_alignment_valid(struct rte_mbuf *mb)
 285 {
 286         uint64_t addr = MBUF_DMA_ADDR_DEFAULT(mb);
 287         uint64_t boundary1, boundary2;
 288
 289         /* 512B aligned? */
 290         if (RTE_ALIGN(addr, FM10K_RX_DATABUF_ALIGN) == addr)
 291                 return 1;
 292
 293         /* 8B aligned, and max Ethernet frame would not cross a 4KB boundary? */
 294         if (RTE_ALIGN(addr, 8) == addr) {
 295                 boundary1 = RTE_ALIGN_FLOOR(addr, 4096);
 296                 boundary2 = RTE_ALIGN_FLOOR(addr + ETHER_MAX_VLAN_FRAME_LEN,
 297                                                 4096);
 298                 if (boundary1 == boundary2)
 299                         return 1;
 300         }
 301
 302         PMD_INIT_LOG(ERR, "Error: Invalid buffer alignment!");
 303
 304         return 0;
 305 }
 306
 307 /* Rx and Tx prototypes */
 308 uint16_t fm10k_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 309         uint16_t nb_pkts);
 310
 311 uint16_t fm10k_recv_scattered_pkts(void *rx_queue,
 312                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 313
 314 uint16_t fm10k_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 315         uint16_t nb_pkts);
 316 #endif