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