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         rte_spinlock_t                  mac_stats_lock;
 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         uint64_t                        ipackets;
 146 };
 147
 148 struct sfc_rss_hf_rte_to_efx {
 149         uint64_t                        rte;
 150         efx_rx_hash_type_t              efx;
 151 };
 152
 153 struct sfc_rss {
 154         unsigned int                    channels;
 155         efx_rx_scale_context_type_t     context_type;
 156         efx_rx_hash_support_t           hash_support;
 157         efx_rx_hash_alg_t               hash_alg;
 158         unsigned int                    hf_map_nb_entries;
 159         struct sfc_rss_hf_rte_to_efx    *hf_map;
 160
 161         efx_rx_hash_type_t              hash_types;
 162         unsigned int                    tbl[EFX_RSS_TBL_SIZE];
 163         uint8_t                         key[EFX_RSS_KEY_SIZE];
 164
 165         uint32_t                        dummy_rss_context;
 166 };
 167
 168 /* Adapter private data shared by primary and secondary processes */
 169 struct sfc_adapter_shared {
 170         unsigned int                    rxq_count;
 171         struct sfc_rxq_info             *rxq_info;
 172         unsigned int                    ethdev_rxq_count;
 173
 174         unsigned int                    txq_count;
 175         struct sfc_txq_info             *txq_info;
 176         unsigned int                    ethdev_txq_count;
 177
 178         struct sfc_rss                  rss;
 179
 180         boolean_t                       isolated;
 181         uint32_t                        tunnel_encaps;
 182
 183         char                            log_prefix[SFC_LOG_PREFIX_MAX];
 184         struct rte_pci_addr             pci_addr;
 185         uint16_t                        port_id;
 186
 187         char                            *dp_rx_name;
 188         char                            *dp_tx_name;
 189 };
 190
 191 /* Adapter process private data */
 192 struct sfc_adapter_priv {
 193         struct sfc_adapter_shared       *shared;
 194         const struct sfc_dp_rx          *dp_rx;
 195         const struct sfc_dp_tx          *dp_tx;
 196         uint32_t                        logtype_main;
 197 };
 198
 199 static inline struct sfc_adapter_priv *
 200 sfc_adapter_priv_by_eth_dev(struct rte_eth_dev *eth_dev)
 201 {
 202         struct sfc_adapter_priv *sap = eth_dev->process_private;
 203
 204         SFC_ASSERT(sap != NULL);
 205         return sap;
 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_adapter_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_filter               filter;
 241         struct sfc_mae                  mae;
 242
 243         struct sfc_flow_list            flow_list;
 244
 245         unsigned int                    rxq_max;
 246         unsigned int                    txq_max;
 247
 248         unsigned int                    rxq_max_entries;
 249         unsigned int                    rxq_min_entries;
 250
 251         unsigned int                    txq_max_entries;
 252         unsigned int                    txq_min_entries;
 253
 254         unsigned int                    evq_max_entries;
 255         unsigned int                    evq_min_entries;
 256
 257         uint32_t                        evq_flags;
 258         unsigned int                    evq_count;
 259
 260         unsigned int                    mgmt_evq_index;
 261         /*
 262          * The lock is used to serialise management event queue polling
 263          * which can be done from different context. Also the lock
 264          * guarantees that mgmt_evq_running is preserved while the lock
 265          * is held. It is used to serialise polling and start/stop
 266          * operations.
 267          *
 268          * Locks which may be held when the lock is acquired:
 269          *  - adapter lock, when:
 270          *    - device start/stop to change mgmt_evq_running
 271          *    - any control operations in client side MCDI proxy handling to
 272          *      poll management event queue waiting for proxy response
 273          *  - MCDI lock, when:
 274          *    - any control operations in client side MCDI proxy handling to
 275          *      poll management event queue waiting for proxy response
 276          *
 277          * Locks which are acquired with the lock held:
 278          *  - nic_lock, when:
 279          *    - MC event processing on management event queue polling
 280          *      (e.g. MC REBOOT or BADASSERT events)
 281          */
 282         rte_spinlock_t                  mgmt_evq_lock;
 283         bool                            mgmt_evq_running;
 284         struct sfc_evq                  *mgmt_evq;
 285
 286         struct sfc_rxq                  *rxq_ctrl;
 287         struct sfc_txq                  *txq_ctrl;
 288
 289         boolean_t                       tso;
 290         boolean_t                       tso_encap;
 291
 292         uint32_t                        rxd_wait_timeout_ns;
 293 };
 294
 295 static inline struct sfc_adapter_shared *
 296 sfc_adapter_shared_by_eth_dev(struct rte_eth_dev *eth_dev)
 297 {
 298         struct sfc_adapter_shared *sas = eth_dev->data->dev_private;
 299
 300         return sas;
 301 }
 302
 303 static inline struct sfc_adapter *
 304 sfc_adapter_by_eth_dev(struct rte_eth_dev *eth_dev)
 305 {
 306         struct sfc_adapter_priv *sap = sfc_adapter_priv_by_eth_dev(eth_dev);
 307
 308         SFC_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
 309
 310         return container_of(sap, struct sfc_adapter, priv);
 311 }
 312
 313 static inline struct sfc_adapter_shared *
 314 sfc_sa2shared(struct sfc_adapter *sa)
 315 {
 316         return sa->priv.shared;
 317 }
 318
 319 /*
 320  * Add wrapper functions to acquire/release lock to be able to remove or
 321  * change the lock in one place.
 322  */
 323
 324 static inline void
 325 sfc_adapter_lock_init(struct sfc_adapter *sa)
 326 {
 327         rte_spinlock_init(&sa->lock);
 328 }
 329
 330 static inline int
 331 sfc_adapter_is_locked(struct sfc_adapter *sa)
 332 {
 333         return rte_spinlock_is_locked(&sa->lock);
 334 }
 335
 336 static inline void
 337 sfc_adapter_lock(struct sfc_adapter *sa)
 338 {
 339         rte_spinlock_lock(&sa->lock);
 340 }
 341
 342 static inline int
 343 sfc_adapter_trylock(struct sfc_adapter *sa)
 344 {
 345         return rte_spinlock_trylock(&sa->lock);
 346 }
 347
 348 static inline void
 349 sfc_adapter_unlock(struct sfc_adapter *sa)
 350 {
 351         rte_spinlock_unlock(&sa->lock);
 352 }
 353
 354 static inline void
 355 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
 356 {
 357         /* Just for symmetry of the API */
 358 }
 359
 360 /** Get the number of milliseconds since boot from the default timer */
 361 static inline uint64_t
 362 sfc_get_system_msecs(void)
 363 {
 364         return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
 365 }
 366
 367 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
 368                   size_t len, int socket_id, efsys_mem_t *esmp);
 369 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 370
 371 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
 372                               const char *lt_prefix_str,
 373                               uint32_t ll_default);
 374
 375 int sfc_probe(struct sfc_adapter *sa);
 376 void sfc_unprobe(struct sfc_adapter *sa);
 377 int sfc_attach(struct sfc_adapter *sa);
 378 void sfc_detach(struct sfc_adapter *sa);
 379 int sfc_start(struct sfc_adapter *sa);
 380 void sfc_stop(struct sfc_adapter *sa);
 381
 382 void sfc_schedule_restart(struct sfc_adapter *sa);
 383
 384 int sfc_mcdi_init(struct sfc_adapter *sa);
 385 void sfc_mcdi_fini(struct sfc_adapter *sa);
 386
 387 int sfc_configure(struct sfc_adapter *sa);
 388 void sfc_close(struct sfc_adapter *sa);
 389
 390 int sfc_intr_attach(struct sfc_adapter *sa);
 391 void sfc_intr_detach(struct sfc_adapter *sa);
 392 int sfc_intr_configure(struct sfc_adapter *sa);
 393 void sfc_intr_close(struct sfc_adapter *sa);
 394 int sfc_intr_start(struct sfc_adapter *sa);
 395 void sfc_intr_stop(struct sfc_adapter *sa);
 396
 397 int sfc_port_attach(struct sfc_adapter *sa);
 398 void sfc_port_detach(struct sfc_adapter *sa);
 399 int sfc_port_configure(struct sfc_adapter *sa);
 400 void sfc_port_close(struct sfc_adapter *sa);
 401 int sfc_port_start(struct sfc_adapter *sa);
 402 void sfc_port_stop(struct sfc_adapter *sa);
 403 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
 404                                 struct rte_eth_link *link_info);
 405 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
 406 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
 407 int sfc_set_rx_mode(struct sfc_adapter *sa);
 408 int sfc_set_rx_mode_unchecked(struct sfc_adapter *sa);
 409
 410 struct sfc_hw_switch_id;
 411
 412 int sfc_hw_switch_id_init(struct sfc_adapter *sa,
 413                           struct sfc_hw_switch_id **idp);
 414 void sfc_hw_switch_id_fini(struct sfc_adapter *sa,
 415                            struct sfc_hw_switch_id *idp);
 416 bool sfc_hw_switch_ids_equal(const struct sfc_hw_switch_id *left,
 417                              const struct sfc_hw_switch_id *right);
 418
 419 #ifdef __cplusplus
 420 }
 421 #endif
 422
 423 #endif  /* _SFC_H */