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