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