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 #include <rte_time.h>
  11 #include <rte_ethdev.h>
  12 #include <rte_ethdev_core.h>
  13
  14 /* need update link, bit flag */
  15 #define NGBE_FLAG_NEED_LINK_UPDATE  ((uint32_t)(1 << 0))
  16 #define NGBE_FLAG_MAILBOX           ((uint32_t)(1 << 1))
  17 #define NGBE_FLAG_PHY_INTERRUPT     ((uint32_t)(1 << 2))
  18 #define NGBE_FLAG_MACSEC            ((uint32_t)(1 << 3))
  19 #define NGBE_FLAG_NEED_LINK_CONFIG  ((uint32_t)(1 << 4))
  20
  21 #define NGBE_VFTA_SIZE 128
  22 #define NGBE_VLAN_TAG_SIZE 4
  23 #define NGBE_HKEY_MAX_INDEX 10
  24 /*Default value of Max Rx Queue*/
  25 #define NGBE_MAX_RX_QUEUE_NUM   8
  26
  27 #ifndef NBBY
  28 #define NBBY    8       /* number of bits in a byte */
  29 #endif
  30 #define NGBE_HWSTRIP_BITMAP_SIZE \
  31         (NGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
  32
  33 #define NGBE_QUEUE_ITR_INTERVAL_DEFAULT 500 /* 500us */
  34
  35 /* The overhead from MTU to max frame size. */
  36 #define NGBE_ETH_OVERHEAD (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN)
  37
  38 #define NGBE_RSS_OFFLOAD_ALL ( \
  39         RTE_ETH_RSS_IPV4 | \
  40         RTE_ETH_RSS_NONFRAG_IPV4_TCP | \
  41         RTE_ETH_RSS_NONFRAG_IPV4_UDP | \
  42         RTE_ETH_RSS_IPV6 | \
  43         RTE_ETH_RSS_NONFRAG_IPV6_TCP | \
  44         RTE_ETH_RSS_NONFRAG_IPV6_UDP | \
  45         RTE_ETH_RSS_IPV6_EX | \
  46         RTE_ETH_RSS_IPV6_TCP_EX | \
  47         RTE_ETH_RSS_IPV6_UDP_EX)
  48
  49 #define NGBE_MISC_VEC_ID               RTE_INTR_VEC_ZERO_OFFSET
  50 #define NGBE_RX_VEC_START              RTE_INTR_VEC_RXTX_OFFSET
  51
  52 /* structure for interrupt relative data */
  53 struct ngbe_interrupt {
  54         uint32_t flags;
  55         uint32_t mask_misc;
  56         uint32_t mask_misc_orig; /* save mask during delayed handler */
  57         uint64_t mask;
  58         uint64_t mask_orig; /* save mask during delayed handler */
  59 };
  60
  61 #define NGBE_NB_STAT_MAPPING  32
  62 #define NB_QMAP_FIELDS_PER_QSM_REG 4
  63 #define QMAP_FIELD_RESERVED_BITS_MASK 0x0f
  64 struct ngbe_stat_mappings {
  65         uint32_t tqsm[NGBE_NB_STAT_MAPPING];
  66         uint32_t rqsm[NGBE_NB_STAT_MAPPING];
  67 };
  68
  69 struct ngbe_vfta {
  70         uint32_t vfta[NGBE_VFTA_SIZE];
  71 };
  72
  73 struct ngbe_hwstrip {
  74         uint32_t bitmap[NGBE_HWSTRIP_BITMAP_SIZE];
  75 };
  76
  77 /**
  78  * Response sent back to ngbe driver from user app after callback
  79  */
  80 enum ngbe_mb_event_rsp {
  81         NGBE_MB_EVENT_NOOP_ACK,  /**< skip mbox request and ACK */
  82         NGBE_MB_EVENT_NOOP_NACK, /**< skip mbox request and NACK */
  83         NGBE_MB_EVENT_PROCEED,  /**< proceed with mbox request  */
  84         NGBE_MB_EVENT_MAX       /**< max value of this enum */
  85 };
  86
  87 /**
  88  * Data sent to the user application when the callback is executed.
  89  */
  90 struct ngbe_mb_event_param {
  91         uint16_t vfid;     /**< Virtual Function number */
  92         uint16_t msg_type; /**< VF to PF message type, defined in ngbe_mbx.h */
  93         uint16_t retval;   /**< return value */
  94         void *msg;         /**< pointer to message */
  95 };
  96
  97 /*
  98  * VF data which used by PF host only
  99  */
 100 #define NGBE_MAX_VF_MC_ENTRIES      30
 101
 102 struct ngbe_uta_info {
 103         uint8_t  uc_filter_type;
 104         uint16_t uta_in_use;
 105         uint32_t uta_shadow[NGBE_MAX_UTA];
 106 };
 107
 108 struct ngbe_vf_info {
 109         uint8_t vf_mac_addresses[RTE_ETHER_ADDR_LEN];
 110         uint16_t vf_mc_hashes[NGBE_MAX_VF_MC_ENTRIES];
 111         uint16_t num_vf_mc_hashes;
 112         bool clear_to_send;
 113         uint16_t vlan_count;
 114         uint8_t api_version;
 115         uint16_t switch_domain_id;
 116         uint16_t xcast_mode;
 117         uint16_t mac_count;
 118 };
 119
 120 /*
 121  * Structure to store private data for each driver instance (for each port).
 122  */
 123 struct ngbe_adapter {
 124         struct ngbe_hw             hw;
 125         struct ngbe_hw_stats       stats;
 126         struct ngbe_interrupt      intr;
 127         struct ngbe_stat_mappings  stat_mappings;
 128         struct ngbe_vfta           shadow_vfta;
 129         struct ngbe_hwstrip        hwstrip;
 130         struct ngbe_vf_info        *vfdata;
 131         struct ngbe_uta_info       uta_info;
 132         bool                       rx_bulk_alloc_allowed;
 133         struct rte_timecounter     systime_tc;
 134         struct rte_timecounter     rx_tstamp_tc;
 135         struct rte_timecounter     tx_tstamp_tc;
 136
 137         /* For RSS reta table update */
 138         uint8_t rss_reta_updated;
 139 };
 140
 141 static inline struct ngbe_adapter *
 142 ngbe_dev_adapter(struct rte_eth_dev *dev)
 143 {
 144         struct ngbe_adapter *ad = dev->data->dev_private;
 145
 146         return ad;
 147 }
 148
 149 static inline struct ngbe_hw *
 150 ngbe_dev_hw(struct rte_eth_dev *dev)
 151 {
 152         struct ngbe_adapter *ad = ngbe_dev_adapter(dev);
 153         struct ngbe_hw *hw = &ad->hw;
 154
 155         return hw;
 156 }
 157
 158 #define NGBE_DEV_STATS(dev) \
 159         (&((struct ngbe_adapter *)(dev)->data->dev_private)->stats)
 160
 161 static inline struct ngbe_interrupt *
 162 ngbe_dev_intr(struct rte_eth_dev *dev)
 163 {
 164         struct ngbe_adapter *ad = ngbe_dev_adapter(dev);
 165         struct ngbe_interrupt *intr = &ad->intr;
 166
 167         return intr;
 168 }
 169
 170 #define NGBE_DEV_STAT_MAPPINGS(dev) \
 171         (&((struct ngbe_adapter *)(dev)->data->dev_private)->stat_mappings)
 172
 173 #define NGBE_DEV_VFTA(dev) \
 174         (&((struct ngbe_adapter *)(dev)->data->dev_private)->shadow_vfta)
 175
 176 #define NGBE_DEV_HWSTRIP(dev) \
 177         (&((struct ngbe_adapter *)(dev)->data->dev_private)->hwstrip)
 178
 179 #define NGBE_DEV_VFDATA(dev) \
 180         (&((struct ngbe_adapter *)(dev)->data->dev_private)->vfdata)
 181
 182 #define NGBE_DEV_UTA_INFO(dev) \
 183         (&((struct ngbe_adapter *)(dev)->data->dev_private)->uta_info)
 184
 185 /*
 186  * Rx/Tx function prototypes
 187  */
 188 void ngbe_dev_clear_queues(struct rte_eth_dev *dev);
 189
 190 void ngbe_dev_free_queues(struct rte_eth_dev *dev);
 191
 192 void ngbe_dev_rx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
 193
 194 void ngbe_dev_tx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
 195
 196 int  ngbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 197                 uint16_t nb_rx_desc, unsigned int socket_id,
 198                 const struct rte_eth_rxconf *rx_conf,
 199                 struct rte_mempool *mb_pool);
 200
 201 int  ngbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 202                 uint16_t nb_tx_desc, unsigned int socket_id,
 203                 const struct rte_eth_txconf *tx_conf);
 204
 205 int ngbe_dev_rx_init(struct rte_eth_dev *dev);
 206
 207 void ngbe_dev_tx_init(struct rte_eth_dev *dev);
 208
 209 int ngbe_dev_rxtx_start(struct rte_eth_dev *dev);
 210
 211 void ngbe_dev_save_rx_queue(struct ngbe_hw *hw, uint16_t rx_queue_id);
 212 void ngbe_dev_store_rx_queue(struct ngbe_hw *hw, uint16_t rx_queue_id);
 213 void ngbe_dev_save_tx_queue(struct ngbe_hw *hw, uint16_t tx_queue_id);
 214 void ngbe_dev_store_tx_queue(struct ngbe_hw *hw, uint16_t tx_queue_id);
 215
 216 int ngbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 217
 218 int ngbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 219
 220 int ngbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 221
 222 int ngbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 223
 224 int
 225 ngbe_rx_burst_mode_get(struct rte_eth_dev *dev, __rte_unused uint16_t queue_id,
 226                       struct rte_eth_burst_mode *mode);
 227 int
 228 ngbe_tx_burst_mode_get(struct rte_eth_dev *dev, __rte_unused uint16_t queue_id,
 229                       struct rte_eth_burst_mode *mode);
 230
 231 uint16_t ngbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 232                 uint16_t nb_pkts);
 233
 234 uint16_t ngbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 235                                     uint16_t nb_pkts);
 236
 237 uint16_t ngbe_recv_pkts_sc_single_alloc(void *rx_queue,
 238                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 239 uint16_t ngbe_recv_pkts_sc_bulk_alloc(void *rx_queue,
 240                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 241
 242 uint16_t ngbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 243                 uint16_t nb_pkts);
 244
 245 uint16_t ngbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 246                 uint16_t nb_pkts);
 247
 248 uint16_t ngbe_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 249                 uint16_t nb_pkts);
 250
 251 int ngbe_dev_rss_hash_update(struct rte_eth_dev *dev,
 252                               struct rte_eth_rss_conf *rss_conf);
 253
 254 int ngbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
 255                                 struct rte_eth_rss_conf *rss_conf);
 256
 257 void ngbe_set_ivar_map(struct ngbe_hw *hw, int8_t direction,
 258                                uint8_t queue, uint8_t msix_vector);
 259
 260 void ngbe_configure_port(struct rte_eth_dev *dev);
 261
 262 int
 263 ngbe_dev_link_update_share(struct rte_eth_dev *dev,
 264                 int wait_to_complete);
 265
 266 /*
 267  * misc function prototypes
 268  */
 269 void ngbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
 270
 271 void ngbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
 272
 273 void ngbe_vlan_hw_strip_config(struct rte_eth_dev *dev);
 274
 275 int ngbe_pf_host_init(struct rte_eth_dev *eth_dev);
 276
 277 void ngbe_pf_host_uninit(struct rte_eth_dev *eth_dev);
 278
 279 void ngbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
 280
 281 int ngbe_pf_host_configure(struct rte_eth_dev *eth_dev);
 282
 283 /* High threshold controlling when to start sending XOFF frames. */
 284 #define NGBE_FC_XOFF_HITH              128 /*KB*/
 285 /* Low threshold controlling when to start sending XON frames. */
 286 #define NGBE_FC_XON_LOTH               64 /*KB*/
 287
 288 /* Timer value included in XOFF frames. */
 289 #define NGBE_FC_PAUSE_TIME 0x680
 290
 291 #define NGBE_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
 292 #define NGBE_LINK_UP_CHECK_TIMEOUT   1000 /* ms */
 293 #define NGBE_VMDQ_NUM_UC_MAC         4096 /* Maximum nb. of UC MAC addr. */
 294
 295 /*
 296  *  Default values for Rx/Tx configuration
 297  */
 298 #define NGBE_DEFAULT_RX_FREE_THRESH  32
 299 #define NGBE_DEFAULT_RX_PTHRESH      8
 300 #define NGBE_DEFAULT_RX_HTHRESH      8
 301 #define NGBE_DEFAULT_RX_WTHRESH      0
 302
 303 #define NGBE_DEFAULT_TX_FREE_THRESH  32
 304 #define NGBE_DEFAULT_TX_PTHRESH      32
 305 #define NGBE_DEFAULT_TX_HTHRESH      0
 306 #define NGBE_DEFAULT_TX_WTHRESH      0
 307
 308 /* Additional timesync values. */
 309 #define NGBE_INCVAL_1GB         0x2000000 /* all speed is same in Emerald */
 310 #define NGBE_INCVAL_SHIFT_1GB   22 /* all speed is same in Emerald */
 311
 312 #define NGBE_CYCLECOUNTER_MASK   0xffffffffffffffffULL
 313
 314 /* store statistics names and its offset in stats structure */
 315 struct rte_ngbe_xstats_name_off {
 316         char name[RTE_ETH_XSTATS_NAME_SIZE];
 317         unsigned int offset;
 318 };
 319
 320 const uint32_t *ngbe_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 321 int ngbe_dev_set_mc_addr_list(struct rte_eth_dev *dev,
 322                                       struct rte_ether_addr *mc_addr_set,
 323                                       uint32_t nb_mc_addr);
 324 int ngbe_dev_rss_reta_update(struct rte_eth_dev *dev,
 325                         struct rte_eth_rss_reta_entry64 *reta_conf,
 326                         uint16_t reta_size);
 327 int ngbe_dev_rss_reta_query(struct rte_eth_dev *dev,
 328                         struct rte_eth_rss_reta_entry64 *reta_conf,
 329                         uint16_t reta_size);
 330 void ngbe_vlan_hw_strip_bitmap_set(struct rte_eth_dev *dev,
 331                 uint16_t queue, bool on);
 332 void ngbe_config_vlan_strip_on_all_queues(struct rte_eth_dev *dev,
 333                                                   int mask);
 334 void ngbe_read_stats_registers(struct ngbe_hw *hw,
 335                            struct ngbe_hw_stats *hw_stats);
 336
 337 #endif /* _NGBE_ETHDEV_H_ */