drivers/net/sfc/sfc.h

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