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_stats {
 221         uint64_t                        *reset_vals;
 222
 223         rte_spinlock_t                  queues_bitmap_lock;
 224         void                            *queues_bitmap_mem;
 225         struct rte_bitmap               *queues_bitmap;
 226 };
 227
 228 /* Adapter private data */
 229 struct sfc_adapter {
 230         /*
 231          * It must be the first field of the sfc_adapter structure since
 232          * sfc_adapter is the primary process private data (i.e.  process
 233          * private data plus additional primary process specific data).
 234          */
 235         struct sfc_adapter_priv         priv;
 236
 237         /*
 238          * PMD setup and configuration is not thread safe. Since it is not
 239          * performance sensitive, it is better to guarantee thread-safety
 240          * and add device level lock. Adapter control operations which
 241          * change its state should acquire the lock.
 242          */
 243         rte_spinlock_t                  lock;
 244         enum sfc_adapter_state          state;
 245         struct rte_eth_dev              *eth_dev;
 246         struct rte_kvargs               *kvargs;
 247         int                             socket_id;
 248         efsys_bar_t                     mem_bar;
 249         /* Function control window offset */
 250         efsys_dma_addr_t                fcw_offset;
 251         efx_family_t                    family;
 252         efx_nic_t                       *nic;
 253         rte_spinlock_t                  nic_lock;
 254         rte_atomic32_t                  restart_required;
 255
 256         struct sfc_efx_mcdi             mcdi;
 257         struct sfc_sriov                sriov;
 258         struct sfc_intr                 intr;
 259         struct sfc_port                 port;
 260         struct sfc_sw_stats             sw_stats;
 261         struct sfc_filter               filter;
 262         struct sfc_mae                  mae;
 263
 264         struct sfc_flow_list            flow_list;
 265
 266         unsigned int                    rxq_max;
 267         unsigned int                    txq_max;
 268
 269         unsigned int                    rxq_max_entries;
 270         unsigned int                    rxq_min_entries;
 271
 272         unsigned int                    txq_max_entries;
 273         unsigned int                    txq_min_entries;
 274
 275         unsigned int                    evq_max_entries;
 276         unsigned int                    evq_min_entries;
 277
 278         uint32_t                        evq_flags;
 279         unsigned int                    evq_count;
 280
 281         unsigned int                    mgmt_evq_index;
 282         /*
 283          * The lock is used to serialise management event queue polling
 284          * which can be done from different context. Also the lock
 285          * guarantees that mgmt_evq_running is preserved while the lock
 286          * is held. It is used to serialise polling and start/stop
 287          * operations.
 288          *
 289          * Locks which may be held when the lock is acquired:
 290          *  - adapter lock, when:
 291          *    - device start/stop to change mgmt_evq_running
 292          *    - any control operations in client side MCDI proxy handling to
 293          *      poll management event queue waiting for proxy response
 294          *  - MCDI lock, when:
 295          *    - any control operations in client side MCDI proxy handling to
 296          *      poll management event queue waiting for proxy response
 297          *
 298          * Locks which are acquired with the lock held:
 299          *  - nic_lock, when:
 300          *    - MC event processing on management event queue polling
 301          *      (e.g. MC REBOOT or BADASSERT events)
 302          */
 303         rte_spinlock_t                  mgmt_evq_lock;
 304         bool                            mgmt_evq_running;
 305         struct sfc_evq                  *mgmt_evq;
 306
 307         struct sfc_counter_rxq          counter_rxq;
 308
 309         struct sfc_rxq                  *rxq_ctrl;
 310         struct sfc_txq                  *txq_ctrl;
 311
 312         boolean_t                       tso;
 313         boolean_t                       tso_encap;
 314
 315         uint32_t                        rxd_wait_timeout_ns;
 316 };
 317
 318 static inline struct sfc_adapter_shared *
 319 sfc_adapter_shared_by_eth_dev(struct rte_eth_dev *eth_dev)
 320 {
 321         struct sfc_adapter_shared *sas = eth_dev->data->dev_private;
 322
 323         return sas;
 324 }
 325
 326 static inline struct sfc_adapter *
 327 sfc_adapter_by_eth_dev(struct rte_eth_dev *eth_dev)
 328 {
 329         struct sfc_adapter_priv *sap = sfc_adapter_priv_by_eth_dev(eth_dev);
 330
 331         SFC_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
 332
 333         return container_of(sap, struct sfc_adapter, priv);
 334 }
 335
 336 static inline struct sfc_adapter_shared *
 337 sfc_sa2shared(struct sfc_adapter *sa)
 338 {
 339         return sa->priv.shared;
 340 }
 341
 342 /*
 343  * Add wrapper functions to acquire/release lock to be able to remove or
 344  * change the lock in one place.
 345  */
 346
 347 static inline void
 348 sfc_adapter_lock_init(struct sfc_adapter *sa)
 349 {
 350         rte_spinlock_init(&sa->lock);
 351 }
 352
 353 static inline int
 354 sfc_adapter_is_locked(struct sfc_adapter *sa)
 355 {
 356         return rte_spinlock_is_locked(&sa->lock);
 357 }
 358
 359 static inline void
 360 sfc_adapter_lock(struct sfc_adapter *sa)
 361 {
 362         rte_spinlock_lock(&sa->lock);
 363 }
 364
 365 static inline int
 366 sfc_adapter_trylock(struct sfc_adapter *sa)
 367 {
 368         return rte_spinlock_trylock(&sa->lock);
 369 }
 370
 371 static inline void
 372 sfc_adapter_unlock(struct sfc_adapter *sa)
 373 {
 374         rte_spinlock_unlock(&sa->lock);
 375 }
 376
 377 static inline void
 378 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
 379 {
 380         /* Just for symmetry of the API */
 381 }
 382
 383 static inline unsigned int
 384 sfc_nb_counter_rxq(const struct sfc_adapter_shared *sas)
 385 {
 386         return sas->counters_rxq_allocated ? 1 : 0;
 387 }
 388
 389 /** Get the number of milliseconds since boot from the default timer */
 390 static inline uint64_t
 391 sfc_get_system_msecs(void)
 392 {
 393         return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
 394 }
 395
 396 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
 397                   size_t len, int socket_id, efsys_mem_t *esmp);
 398 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 399
 400 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
 401                               const char *lt_prefix_str,
 402                               uint32_t ll_default);
 403
 404 int sfc_probe(struct sfc_adapter *sa);
 405 void sfc_unprobe(struct sfc_adapter *sa);
 406 int sfc_attach(struct sfc_adapter *sa);
 407 void sfc_detach(struct sfc_adapter *sa);
 408 int sfc_start(struct sfc_adapter *sa);
 409 void sfc_stop(struct sfc_adapter *sa);
 410
 411 void sfc_schedule_restart(struct sfc_adapter *sa);
 412
 413 int sfc_mcdi_init(struct sfc_adapter *sa);
 414 void sfc_mcdi_fini(struct sfc_adapter *sa);
 415
 416 int sfc_configure(struct sfc_adapter *sa);
 417 void sfc_close(struct sfc_adapter *sa);
 418
 419 int sfc_intr_attach(struct sfc_adapter *sa);
 420 void sfc_intr_detach(struct sfc_adapter *sa);
 421 int sfc_intr_configure(struct sfc_adapter *sa);
 422 void sfc_intr_close(struct sfc_adapter *sa);
 423 int sfc_intr_start(struct sfc_adapter *sa);
 424 void sfc_intr_stop(struct sfc_adapter *sa);
 425
 426 int sfc_port_attach(struct sfc_adapter *sa);
 427 void sfc_port_detach(struct sfc_adapter *sa);
 428 int sfc_port_configure(struct sfc_adapter *sa);
 429 void sfc_port_close(struct sfc_adapter *sa);
 430 int sfc_port_start(struct sfc_adapter *sa);
 431 void sfc_port_stop(struct sfc_adapter *sa);
 432 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
 433                                 struct rte_eth_link *link_info);
 434 int sfc_port_update_mac_stats(struct sfc_adapter *sa, boolean_t manual_update);
 435 int sfc_port_get_mac_stats(struct sfc_adapter *sa, struct rte_eth_xstat *xstats,
 436                            unsigned int xstats_count, unsigned int *nb_written);
 437 int sfc_port_get_mac_stats_by_id(struct sfc_adapter *sa, const uint64_t *ids,
 438                                  uint64_t *values, unsigned int n);
 439 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
 440 int sfc_set_rx_mode(struct sfc_adapter *sa);
 441 int sfc_set_rx_mode_unchecked(struct sfc_adapter *sa);
 442
 443 struct sfc_hw_switch_id;
 444
 445 int sfc_hw_switch_id_init(struct sfc_adapter *sa,
 446                           struct sfc_hw_switch_id **idp);
 447 void sfc_hw_switch_id_fini(struct sfc_adapter *sa,
 448                            struct sfc_hw_switch_id *idp);
 449 bool sfc_hw_switch_ids_equal(const struct sfc_hw_switch_id *left,
 450                              const struct sfc_hw_switch_id *right);
 451
 452 #ifdef __cplusplus
 453 }
 454 #endif
 455
 456 #endif  /* _SFC_H */