drivers/net/ngbe/ngbe_ethdev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd.
   3  * Copyright(c) 2010-2017 Intel Corporation
   4  */
   5
   6 #ifndef _NGBE_ETHDEV_H_
   7 #define _NGBE_ETHDEV_H_
   8
   9 #include "ngbe_ptypes.h"
  10
  11 /* need update link, bit flag */
  12 #define NGBE_FLAG_NEED_LINK_UPDATE  ((uint32_t)(1 << 0))
  13 #define NGBE_FLAG_MAILBOX           ((uint32_t)(1 << 1))
  14 #define NGBE_FLAG_PHY_INTERRUPT     ((uint32_t)(1 << 2))
  15 #define NGBE_FLAG_MACSEC            ((uint32_t)(1 << 3))
  16 #define NGBE_FLAG_NEED_LINK_CONFIG  ((uint32_t)(1 << 4))
  17
  18 #define NGBE_VFTA_SIZE 128
  19 #define NGBE_VLAN_TAG_SIZE 4
  20 /*Default value of Max Rx Queue*/
  21 #define NGBE_MAX_RX_QUEUE_NUM   8
  22
  23 #ifndef NBBY
  24 #define NBBY    8       /* number of bits in a byte */
  25 #endif
  26 #define NGBE_HWSTRIP_BITMAP_SIZE \
  27         (NGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
  28
  29 #define NGBE_QUEUE_ITR_INTERVAL_DEFAULT 500 /* 500us */
  30
  31 /* The overhead from MTU to max frame size. */
  32 #define NGBE_ETH_OVERHEAD (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN)
  33
  34 #define NGBE_MISC_VEC_ID               RTE_INTR_VEC_ZERO_OFFSET
  35 #define NGBE_RX_VEC_START              RTE_INTR_VEC_RXTX_OFFSET
  36
  37 /* structure for interrupt relative data */
  38 struct ngbe_interrupt {
  39         uint32_t flags;
  40         uint32_t mask_misc;
  41         uint32_t mask_misc_orig; /* save mask during delayed handler */
  42         uint64_t mask;
  43         uint64_t mask_orig; /* save mask during delayed handler */
  44 };
  45
  46 #define NGBE_NB_STAT_MAPPING  32
  47 #define NB_QMAP_FIELDS_PER_QSM_REG 4
  48 #define QMAP_FIELD_RESERVED_BITS_MASK 0x0f
  49 struct ngbe_stat_mappings {
  50         uint32_t tqsm[NGBE_NB_STAT_MAPPING];
  51         uint32_t rqsm[NGBE_NB_STAT_MAPPING];
  52 };
  53
  54 struct ngbe_vfta {
  55         uint32_t vfta[NGBE_VFTA_SIZE];
  56 };
  57
  58 struct ngbe_hwstrip {
  59         uint32_t bitmap[NGBE_HWSTRIP_BITMAP_SIZE];
  60 };
  61
  62 /*
  63  * Structure to store private data for each driver instance (for each port).
  64  */
  65 struct ngbe_adapter {
  66         struct ngbe_hw             hw;
  67         struct ngbe_hw_stats       stats;
  68         struct ngbe_interrupt      intr;
  69         struct ngbe_stat_mappings  stat_mappings;
  70         struct ngbe_vfta           shadow_vfta;
  71         struct ngbe_hwstrip        hwstrip;
  72         bool                       rx_bulk_alloc_allowed;
  73 };
  74
  75 static inline struct ngbe_adapter *
  76 ngbe_dev_adapter(struct rte_eth_dev *dev)
  77 {
  78         struct ngbe_adapter *ad = dev->data->dev_private;
  79
  80         return ad;
  81 }
  82
  83 static inline struct ngbe_hw *
  84 ngbe_dev_hw(struct rte_eth_dev *dev)
  85 {
  86         struct ngbe_adapter *ad = ngbe_dev_adapter(dev);
  87         struct ngbe_hw *hw = &ad->hw;
  88
  89         return hw;
  90 }
  91
  92 #define NGBE_DEV_STATS(dev) \
  93         (&((struct ngbe_adapter *)(dev)->data->dev_private)->stats)
  94
  95 static inline struct ngbe_interrupt *
  96 ngbe_dev_intr(struct rte_eth_dev *dev)
  97 {
  98         struct ngbe_adapter *ad = ngbe_dev_adapter(dev);
  99         struct ngbe_interrupt *intr = &ad->intr;
 100
 101         return intr;
 102 }
 103
 104 #define NGBE_DEV_STAT_MAPPINGS(dev) \
 105         (&((struct ngbe_adapter *)(dev)->data->dev_private)->stat_mappings)
 106
 107 #define NGBE_DEV_VFTA(dev) \
 108         (&((struct ngbe_adapter *)(dev)->data->dev_private)->shadow_vfta)
 109
 110 #define NGBE_DEV_HWSTRIP(dev) \
 111         (&((struct ngbe_adapter *)(dev)->data->dev_private)->hwstrip)
 112
 113 /*
 114  * Rx/Tx function prototypes
 115  */
 116 void ngbe_dev_clear_queues(struct rte_eth_dev *dev);
 117
 118 void ngbe_dev_free_queues(struct rte_eth_dev *dev);
 119
 120 void ngbe_dev_rx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
 121
 122 void ngbe_dev_tx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
 123
 124 int  ngbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 125                 uint16_t nb_rx_desc, unsigned int socket_id,
 126                 const struct rte_eth_rxconf *rx_conf,
 127                 struct rte_mempool *mb_pool);
 128
 129 int  ngbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 130                 uint16_t nb_tx_desc, unsigned int socket_id,
 131                 const struct rte_eth_txconf *tx_conf);
 132
 133 int ngbe_dev_rx_init(struct rte_eth_dev *dev);
 134
 135 void ngbe_dev_tx_init(struct rte_eth_dev *dev);
 136
 137 int ngbe_dev_rxtx_start(struct rte_eth_dev *dev);
 138
 139 void ngbe_dev_save_rx_queue(struct ngbe_hw *hw, uint16_t rx_queue_id);
 140 void ngbe_dev_store_rx_queue(struct ngbe_hw *hw, uint16_t rx_queue_id);
 141 void ngbe_dev_save_tx_queue(struct ngbe_hw *hw, uint16_t tx_queue_id);
 142 void ngbe_dev_store_tx_queue(struct ngbe_hw *hw, uint16_t tx_queue_id);
 143
 144 int ngbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 145
 146 int ngbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 147
 148 int ngbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 149
 150 int ngbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 151
 152 int
 153 ngbe_rx_burst_mode_get(struct rte_eth_dev *dev, __rte_unused uint16_t queue_id,
 154                       struct rte_eth_burst_mode *mode);
 155 int
 156 ngbe_tx_burst_mode_get(struct rte_eth_dev *dev, __rte_unused uint16_t queue_id,
 157                       struct rte_eth_burst_mode *mode);
 158
 159 uint16_t ngbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 160                 uint16_t nb_pkts);
 161
 162 uint16_t ngbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 163                                     uint16_t nb_pkts);
 164
 165 uint16_t ngbe_recv_pkts_sc_single_alloc(void *rx_queue,
 166                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 167 uint16_t ngbe_recv_pkts_sc_bulk_alloc(void *rx_queue,
 168                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 169
 170 uint16_t ngbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 171                 uint16_t nb_pkts);
 172
 173 uint16_t ngbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 174                 uint16_t nb_pkts);
 175
 176 uint16_t ngbe_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 177                 uint16_t nb_pkts);
 178
 179 void ngbe_set_ivar_map(struct ngbe_hw *hw, int8_t direction,
 180                                uint8_t queue, uint8_t msix_vector);
 181
 182 void ngbe_configure_port(struct rte_eth_dev *dev);
 183
 184 int
 185 ngbe_dev_link_update_share(struct rte_eth_dev *dev,
 186                 int wait_to_complete);
 187
 188 /*
 189  * misc function prototypes
 190  */
 191 void ngbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
 192
 193 void ngbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
 194
 195 void ngbe_vlan_hw_strip_config(struct rte_eth_dev *dev);
 196
 197 #define NGBE_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
 198 #define NGBE_LINK_UP_CHECK_TIMEOUT   1000 /* ms */
 199 #define NGBE_VMDQ_NUM_UC_MAC         4096 /* Maximum nb. of UC MAC addr. */
 200
 201 /*
 202  *  Default values for Rx/Tx configuration
 203  */
 204 #define NGBE_DEFAULT_RX_FREE_THRESH  32
 205 #define NGBE_DEFAULT_RX_PTHRESH      8
 206 #define NGBE_DEFAULT_RX_HTHRESH      8
 207 #define NGBE_DEFAULT_RX_WTHRESH      0
 208
 209 #define NGBE_DEFAULT_TX_FREE_THRESH  32
 210 #define NGBE_DEFAULT_TX_PTHRESH      32
 211 #define NGBE_DEFAULT_TX_HTHRESH      0
 212 #define NGBE_DEFAULT_TX_WTHRESH      0
 213
 214 /* store statistics names and its offset in stats structure */
 215 struct rte_ngbe_xstats_name_off {
 216         char name[RTE_ETH_XSTATS_NAME_SIZE];
 217         unsigned int offset;
 218 };
 219
 220 const uint32_t *ngbe_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 221 void ngbe_vlan_hw_strip_bitmap_set(struct rte_eth_dev *dev,
 222                 uint16_t queue, bool on);
 223 void ngbe_config_vlan_strip_on_all_queues(struct rte_eth_dev *dev,
 224                                                   int mask);
 225 void ngbe_read_stats_registers(struct ngbe_hw *hw,
 226                            struct ngbe_hw_stats *hw_stats);
 227
 228 #endif /* _NGBE_ETHDEV_H_ */