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