drivers/net/sfc/sfc.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2 *
   3  * Copyright(c) 2019-2021 Xilinx, Inc.
   4  * Copyright(c) 2016-2019 Solarflare Communications Inc.
   5  *
   6  * This software was jointly developed between OKTET Labs (under contract
   7  * for Solarflare) and Solarflare Communications, Inc.
   8  */
   9
  10 #ifndef _SFC_H
  11 #define _SFC_H
  12
  13 #include <stdbool.h>
  14
  15 #include <rte_pci.h>
  16 #include <rte_bus_pci.h>
  17 #include <ethdev_driver.h>
  18 #include <rte_kvargs.h>
  19 #include <rte_spinlock.h>
  20 #include <rte_atomic.h>
  21
  22 #include "efx.h"
  23
  24 #include "sfc_efx_mcdi.h"
  25 #include "sfc_efx.h"
  26
  27 #include "sfc_debug.h"
  28 #include "sfc_log.h"
  29 #include "sfc_filter.h"
  30 #include "sfc_flow_tunnel.h"
  31 #include "sfc_sriov.h"
  32 #include "sfc_mae.h"
  33 #include "sfc_dp.h"
  34 #include "sfc_sw_stats.h"
  35 #include "sfc_repr_proxy.h"
  36 #include "sfc_service.h"
  37 #include "sfc_ethdev_state.h"
  38 #include "sfc_nic_dma_dp.h"
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 enum sfc_dev_filter_mode {
  45         SFC_DEV_FILTER_MODE_PROMISC = 0,
  46         SFC_DEV_FILTER_MODE_ALLMULTI,
  47
  48         SFC_DEV_FILTER_NMODES
  49 };
  50
  51 struct sfc_intr {
  52         efx_intr_type_t                 type;
  53         rte_intr_callback_fn            handler;
  54         boolean_t                       lsc_intr;
  55         boolean_t                       rxq_intr;
  56 };
  57
  58 struct sfc_rxq;
  59 struct sfc_txq;
  60
  61 struct sfc_rxq_info;
  62 struct sfc_txq_info;
  63 struct sfc_dp_rx;
  64
  65 struct sfc_port {
  66         unsigned int                    lsc_seq;
  67
  68         uint32_t                        phy_adv_cap_mask;
  69         uint32_t                        phy_adv_cap;
  70
  71         unsigned int                    flow_ctrl;
  72         boolean_t                       flow_ctrl_autoneg;
  73         size_t                          pdu;
  74
  75         /*
  76          * Flow API isolated mode overrides promisc and allmulti settings;
  77          * they won't be applied if isolated mode is active
  78          */
  79         boolean_t                       promisc;
  80         boolean_t                       allmulti;
  81
  82         struct rte_ether_addr           default_mac_addr;
  83
  84         unsigned int                    max_mcast_addrs;
  85         unsigned int                    nb_mcast_addrs;
  86         uint8_t                         *mcast_addrs;
  87
  88         uint64_t                        *mac_stats_buf;
  89         unsigned int                    mac_stats_nb_supported;
  90         efsys_mem_t                     mac_stats_dma_mem;
  91         boolean_t                       mac_stats_reset_pending;
  92         uint16_t                        mac_stats_update_period_ms;
  93         uint32_t                        mac_stats_update_generation;
  94         boolean_t                       mac_stats_periodic_dma_supported;
  95         uint64_t                        mac_stats_last_request_timestamp;
  96
  97         uint32_t                mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
  98
  99         unsigned int                    mac_stats_by_id[EFX_MAC_NSTATS];
 100
 101         uint64_t                        ipackets;
 102 };
 103
 104 struct sfc_rss_hf_rte_to_efx {
 105         uint64_t                        rte;
 106         efx_rx_hash_type_t              efx;
 107 };
 108
 109 struct sfc_rss {
 110         unsigned int                    channels;
 111         efx_rx_scale_context_type_t     context_type;
 112         efx_rx_hash_support_t           hash_support;
 113         efx_rx_hash_alg_t               hash_alg;
 114         unsigned int                    hf_map_nb_entries;
 115         struct sfc_rss_hf_rte_to_efx    *hf_map;
 116
 117         efx_rx_hash_type_t              hash_types;
 118         unsigned int                    tbl[EFX_RSS_TBL_SIZE];
 119         uint8_t                         key[EFX_RSS_KEY_SIZE];
 120
 121         uint32_t                        dummy_rss_context;
 122 };
 123
 124 /* Adapter private data shared by primary and secondary processes */
 125 struct sfc_adapter_shared {
 126         unsigned int                    rxq_count;
 127         struct sfc_rxq_info             *rxq_info;
 128         unsigned int                    ethdev_rxq_count;
 129
 130         unsigned int                    txq_count;
 131         struct sfc_txq_info             *txq_info;
 132         unsigned int                    ethdev_txq_count;
 133
 134         struct sfc_rss                  rss;
 135
 136         boolean_t                       isolated;
 137         uint32_t                        tunnel_encaps;
 138
 139         char                            log_prefix[SFC_LOG_PREFIX_MAX];
 140         struct rte_pci_addr             pci_addr;
 141         uint16_t                        port_id;
 142
 143         char                            *dp_rx_name;
 144         char                            *dp_tx_name;
 145
 146         bool                            counters_rxq_allocated;
 147         unsigned int                    nb_repr_rxq;
 148         unsigned int                    nb_repr_txq;
 149
 150         struct sfc_nic_dma_info         nic_dma_info;
 151 };
 152
 153 /* Adapter process private data */
 154 struct sfc_adapter_priv {
 155         struct sfc_adapter_shared       *shared;
 156         const struct sfc_dp_rx          *dp_rx;
 157         const struct sfc_dp_tx          *dp_tx;
 158         uint32_t                        logtype_main;
 159 };
 160
 161 static inline struct sfc_adapter_priv *
 162 sfc_adapter_priv_by_eth_dev(struct rte_eth_dev *eth_dev)
 163 {
 164         struct sfc_adapter_priv *sap = eth_dev->process_private;
 165
 166         SFC_ASSERT(sap != NULL);
 167         return sap;
 168 }
 169
 170 /* RxQ dedicated for counters (counter only RxQ) data */
 171 struct sfc_counter_rxq {
 172         unsigned int                    state;
 173 #define SFC_COUNTER_RXQ_ATTACHED                0x1
 174 #define SFC_COUNTER_RXQ_INITIALIZED             0x2
 175         sfc_sw_index_t                  sw_index;
 176         struct rte_mempool              *mp;
 177 };
 178
 179 struct sfc_sw_stat_data {
 180         const struct sfc_sw_stat_descr *descr;
 181         /* Cache fragment */
 182         uint64_t                        *cache;
 183 };
 184
 185 struct sfc_sw_stats {
 186         /* Number extended statistics provided by SW stats */
 187         unsigned int                    xstats_count;
 188         /* Supported SW statistics */
 189         struct sfc_sw_stat_data         *supp;
 190         unsigned int                    supp_count;
 191
 192         /* Cache for all supported SW statistics */
 193         uint64_t                        *cache;
 194         unsigned int                    cache_count;
 195
 196         uint64_t                        *reset_vals;
 197         /* Location of per-queue reset values for packets/bytes in reset_vals */
 198         uint64_t                        *reset_rx_pkts;
 199         uint64_t                        *reset_rx_bytes;
 200         uint64_t                        *reset_tx_pkts;
 201         uint64_t                        *reset_tx_bytes;
 202
 203         rte_spinlock_t                  queues_bitmap_lock;
 204         void                            *queues_bitmap_mem;
 205         struct rte_bitmap               *queues_bitmap;
 206 };
 207
 208 /* Adapter private data */
 209 struct sfc_adapter {
 210         /*
 211          * It must be the first field of the sfc_adapter structure since
 212          * sfc_adapter is the primary process private data (i.e.  process
 213          * private data plus additional primary process specific data).
 214          */
 215         struct sfc_adapter_priv         priv;
 216
 217         /*
 218          * PMD setup and configuration is not thread safe. Since it is not
 219          * performance sensitive, it is better to guarantee thread-safety
 220          * and add device level lock. Adapter control operations which
 221          * change its state should acquire the lock.
 222          */
 223         rte_spinlock_t                  lock;
 224         enum sfc_ethdev_state           state;
 225         struct rte_eth_dev              *eth_dev;
 226         struct rte_kvargs               *kvargs;
 227         int                             socket_id;
 228         efsys_bar_t                     mem_bar;
 229         /* Function control window offset */
 230         efsys_dma_addr_t                fcw_offset;
 231         efx_family_t                    family;
 232         efx_nic_t                       *nic;
 233         rte_spinlock_t                  nic_lock;
 234         rte_atomic32_t                  restart_required;
 235
 236         struct sfc_efx_mcdi             mcdi;
 237         struct sfc_sriov                sriov;
 238         struct sfc_intr                 intr;
 239         struct sfc_port                 port;
 240         struct sfc_sw_stats             sw_stats;
 241         /* Registry of tunnel offload contexts */
 242         struct sfc_flow_tunnel          flow_tunnels[SFC_FT_MAX_NTUNNELS];
 243         struct sfc_filter               filter;
 244         struct sfc_mae                  mae;
 245         struct sfc_repr_proxy           repr_proxy;
 246
 247         struct sfc_flow_list            flow_list;
 248
 249         unsigned int                    rxq_max;
 250         unsigned int                    txq_max;
 251
 252         unsigned int                    rxq_max_entries;
 253         unsigned int                    rxq_min_entries;
 254
 255         unsigned int                    txq_max_entries;
 256         unsigned int                    txq_min_entries;
 257
 258         unsigned int                    evq_max_entries;
 259         unsigned int                    evq_min_entries;
 260
 261         uint32_t                        evq_flags;
 262         unsigned int                    evq_count;
 263
 264         unsigned int                    mgmt_evq_index;
 265         /*
 266          * The lock is used to serialise management event queue polling
 267          * which can be done from different context. Also the lock
 268          * guarantees that mgmt_evq_running is preserved while the lock
 269          * is held. It is used to serialise polling and start/stop
 270          * operations.
 271          *
 272          * Locks which may be held when the lock is acquired:
 273          *  - adapter lock, when:
 274          *    - device start/stop to change mgmt_evq_running
 275          *    - any control operations in client side MCDI proxy handling to
 276          *      poll management event queue waiting for proxy response
 277          *  - MCDI lock, when:
 278          *    - any control operations in client side MCDI proxy handling to
 279          *      poll management event queue waiting for proxy response
 280          *
 281          * Locks which are acquired with the lock held:
 282          *  - nic_lock, when:
 283          *    - MC event processing on management event queue polling
 284          *      (e.g. MC REBOOT or BADASSERT events)
 285          */
 286         rte_spinlock_t                  mgmt_evq_lock;
 287         bool                            mgmt_evq_running;
 288         struct sfc_evq                  *mgmt_evq;
 289
 290         struct sfc_counter_rxq          counter_rxq;
 291
 292         struct sfc_rxq                  *rxq_ctrl;
 293         struct sfc_txq                  *txq_ctrl;
 294
 295         boolean_t                       tso;
 296         boolean_t                       tso_encap;
 297
 298         uint64_t                        negotiated_rx_metadata;
 299
 300         uint32_t                        rxd_wait_timeout_ns;
 301
 302         bool                            switchdev;
 303 };
 304
 305 static inline struct sfc_adapter_shared *
 306 sfc_adapter_shared_by_eth_dev(struct rte_eth_dev *eth_dev)
 307 {
 308         struct sfc_adapter_shared *sas = eth_dev->data->dev_private;
 309
 310         return sas;
 311 }
 312
 313 static inline struct sfc_adapter *
 314 sfc_adapter_by_eth_dev(struct rte_eth_dev *eth_dev)
 315 {
 316         struct sfc_adapter_priv *sap = sfc_adapter_priv_by_eth_dev(eth_dev);
 317
 318         SFC_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
 319
 320         return container_of(sap, struct sfc_adapter, priv);
 321 }
 322
 323 static inline struct sfc_adapter_shared *
 324 sfc_sa2shared(struct sfc_adapter *sa)
 325 {
 326         return sa->priv.shared;
 327 }
 328
 329 /*
 330  * Add wrapper functions to acquire/release lock to be able to remove or
 331  * change the lock in one place.
 332  */
 333
 334 static inline void
 335 sfc_adapter_lock_init(struct sfc_adapter *sa)
 336 {
 337         rte_spinlock_init(&sa->lock);
 338 }
 339
 340 static inline int
 341 sfc_adapter_is_locked(struct sfc_adapter *sa)
 342 {
 343         return rte_spinlock_is_locked(&sa->lock);
 344 }
 345
 346 static inline void
 347 sfc_adapter_lock(struct sfc_adapter *sa)
 348 {
 349         rte_spinlock_lock(&sa->lock);
 350 }
 351
 352 static inline int
 353 sfc_adapter_trylock(struct sfc_adapter *sa)
 354 {
 355         return rte_spinlock_trylock(&sa->lock);
 356 }
 357
 358 static inline void
 359 sfc_adapter_unlock(struct sfc_adapter *sa)
 360 {
 361         rte_spinlock_unlock(&sa->lock);
 362 }
 363
 364 static inline void
 365 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
 366 {
 367         /* Just for symmetry of the API */
 368 }
 369
 370 static inline unsigned int
 371 sfc_nb_counter_rxq(const struct sfc_adapter_shared *sas)
 372 {
 373         return sas->counters_rxq_allocated ? 1 : 0;
 374 }
 375
 376 bool sfc_repr_supported(const struct sfc_adapter *sa);
 377 bool sfc_repr_available(const struct sfc_adapter_shared *sas);
 378
 379 static inline unsigned int
 380 sfc_repr_nb_rxq(const struct sfc_adapter_shared *sas)
 381 {
 382         return sas->nb_repr_rxq;
 383 }
 384
 385 static inline unsigned int
 386 sfc_repr_nb_txq(const struct sfc_adapter_shared *sas)
 387 {
 388         return sas->nb_repr_txq;
 389 }
 390
 391 /** Get the number of milliseconds since boot from the default timer */
 392 static inline uint64_t
 393 sfc_get_system_msecs(void)
 394 {
 395         return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
 396 }
 397
 398 int sfc_dma_alloc(struct sfc_adapter *sa, const char *name, uint16_t id,
 399                   efx_nic_dma_addr_type_t addr_type, size_t len, int socket_id,
 400                   efsys_mem_t *esmp);
 401 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 402
 403 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
 404                               const char *lt_prefix_str,
 405                               uint32_t ll_default);
 406
 407 int sfc_probe(struct sfc_adapter *sa);
 408 void sfc_unprobe(struct sfc_adapter *sa);
 409 int sfc_attach(struct sfc_adapter *sa);
 410 void sfc_pre_detach(struct sfc_adapter *sa);
 411 void sfc_detach(struct sfc_adapter *sa);
 412 int sfc_start(struct sfc_adapter *sa);
 413 void sfc_stop(struct sfc_adapter *sa);
 414
 415 void sfc_schedule_restart(struct sfc_adapter *sa);
 416
 417 int sfc_mcdi_init(struct sfc_adapter *sa);
 418 void sfc_mcdi_fini(struct sfc_adapter *sa);
 419
 420 int sfc_configure(struct sfc_adapter *sa);
 421 void sfc_close(struct sfc_adapter *sa);
 422
 423 int sfc_intr_attach(struct sfc_adapter *sa);
 424 void sfc_intr_detach(struct sfc_adapter *sa);
 425 int sfc_intr_configure(struct sfc_adapter *sa);
 426 void sfc_intr_close(struct sfc_adapter *sa);
 427 int sfc_intr_start(struct sfc_adapter *sa);
 428 void sfc_intr_stop(struct sfc_adapter *sa);
 429
 430 int sfc_port_attach(struct sfc_adapter *sa);
 431 void sfc_port_detach(struct sfc_adapter *sa);
 432 int sfc_port_configure(struct sfc_adapter *sa);
 433 void sfc_port_close(struct sfc_adapter *sa);
 434 int sfc_port_start(struct sfc_adapter *sa);
 435 void sfc_port_stop(struct sfc_adapter *sa);
 436 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
 437                                 struct rte_eth_link *link_info);
 438 int sfc_port_update_mac_stats(struct sfc_adapter *sa, boolean_t manual_update);
 439 int sfc_port_get_mac_stats(struct sfc_adapter *sa, struct rte_eth_xstat *xstats,
 440                            unsigned int xstats_count, unsigned int *nb_written);
 441 int sfc_port_get_mac_stats_by_id(struct sfc_adapter *sa, const uint64_t *ids,
 442                                  uint64_t *values, unsigned int n);
 443 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
 444 int sfc_set_rx_mode(struct sfc_adapter *sa);
 445 int sfc_set_rx_mode_unchecked(struct sfc_adapter *sa);
 446
 447 struct sfc_hw_switch_id;
 448
 449 int sfc_hw_switch_id_init(struct sfc_adapter *sa,
 450                           struct sfc_hw_switch_id **idp);
 451 void sfc_hw_switch_id_fini(struct sfc_adapter *sa,
 452                            struct sfc_hw_switch_id *idp);
 453 bool sfc_hw_switch_ids_equal(const struct sfc_hw_switch_id *left,
 454                              const struct sfc_hw_switch_id *right);
 455
 456 #ifdef __cplusplus
 457 }
 458 #endif
 459
 460 #endif  /* _SFC_H */