drivers/net/sfc/sfc.h

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