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                       isolated;
 135         boolean_t                       promisc;
 136         boolean_t                       allmulti;
 137
 138         struct ether_addr               default_mac_addr;
 139
 140         unsigned int                    max_mcast_addrs;
 141         unsigned int                    nb_mcast_addrs;
 142         uint8_t                         *mcast_addrs;
 143
 144         rte_spinlock_t                  mac_stats_lock;
 145         uint64_t                        *mac_stats_buf;
 146         unsigned int                    mac_stats_nb_supported;
 147         efsys_mem_t                     mac_stats_dma_mem;
 148         boolean_t                       mac_stats_reset_pending;
 149         uint16_t                        mac_stats_update_period_ms;
 150         uint32_t                        mac_stats_update_generation;
 151         boolean_t                       mac_stats_periodic_dma_supported;
 152         uint64_t                        mac_stats_last_request_timestamp;
 153
 154         uint32_t                mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
 155
 156         uint64_t                        ipackets;
 157 };
 158
 159 struct sfc_rss_hf_rte_to_efx {
 160         uint64_t                        rte;
 161         efx_rx_hash_type_t              efx;
 162 };
 163
 164 struct sfc_rss {
 165         unsigned int                    channels;
 166         efx_rx_scale_context_type_t     context_type;
 167         efx_rx_hash_support_t           hash_support;
 168         efx_rx_hash_alg_t               hash_alg;
 169         unsigned int                    hf_map_nb_entries;
 170         struct sfc_rss_hf_rte_to_efx    *hf_map;
 171
 172         efx_rx_hash_type_t              hash_types;
 173         unsigned int                    tbl[EFX_RSS_TBL_SIZE];
 174         uint8_t                         key[EFX_RSS_KEY_SIZE];
 175 };
 176
 177 /* Adapter process private data */
 178 struct sfc_adapter_priv {
 179         const struct sfc_dp_rx          *dp_rx;
 180         const struct sfc_dp_tx          *dp_tx;
 181         uint32_t                        logtype_main;
 182 };
 183
 184 static inline struct sfc_adapter_priv *
 185 sfc_adapter_priv_by_eth_dev(struct rte_eth_dev *eth_dev)
 186 {
 187         struct sfc_adapter_priv *sap = eth_dev->process_private;
 188
 189         SFC_ASSERT(sap != NULL);
 190         return sap;
 191 }
 192
 193 /* Adapter private data */
 194 struct sfc_adapter {
 195         /*
 196          * It must be the first field of the sfc_adapter structure since
 197          * sfc_adapter is the primary process private data (i.e.  process
 198          * private data plus additional primary process specific data).
 199          */
 200         struct sfc_adapter_priv         priv;
 201
 202         /*
 203          * PMD setup and configuration is not thread safe. Since it is not
 204          * performance sensitive, it is better to guarantee thread-safety
 205          * and add device level lock. Adapter control operations which
 206          * change its state should acquire the lock.
 207          */
 208         rte_spinlock_t                  lock;
 209         enum sfc_adapter_state          state;
 210         struct rte_pci_addr             pci_addr;
 211         uint16_t                        port_id;
 212         struct rte_eth_dev              *eth_dev;
 213         struct rte_kvargs               *kvargs;
 214         int                             socket_id;
 215         efsys_bar_t                     mem_bar;
 216         efx_family_t                    family;
 217         efx_nic_t                       *nic;
 218         rte_spinlock_t                  nic_lock;
 219         rte_atomic32_t                  restart_required;
 220
 221         struct sfc_mcdi                 mcdi;
 222         struct sfc_intr                 intr;
 223         struct sfc_port                 port;
 224         struct sfc_filter               filter;
 225
 226         unsigned int                    rxq_max;
 227         unsigned int                    txq_max;
 228
 229         unsigned int                    txq_max_entries;
 230
 231         uint32_t                        evq_flags;
 232         unsigned int                    evq_count;
 233
 234         unsigned int                    mgmt_evq_index;
 235         /*
 236          * The lock is used to serialise management event queue polling
 237          * which can be done from different context. Also the lock
 238          * guarantees that mgmt_evq_running is preserved while the lock
 239          * is held. It is used to serialise polling and start/stop
 240          * operations.
 241          *
 242          * Locks which may be held when the lock is acquired:
 243          *  - adapter lock, when:
 244          *    - device start/stop to change mgmt_evq_running
 245          *    - any control operations in client side MCDI proxy handling to
 246          *      poll management event queue waiting for proxy response
 247          *  - MCDI lock, when:
 248          *    - any control operations in client side MCDI proxy handling to
 249          *      poll management event queue waiting for proxy response
 250          *
 251          * Locks which are acquired with the lock held:
 252          *  - nic_lock, when:
 253          *    - MC event processing on management event queue polling
 254          *      (e.g. MC REBOOT or BADASSERT events)
 255          */
 256         rte_spinlock_t                  mgmt_evq_lock;
 257         bool                            mgmt_evq_running;
 258         struct sfc_evq                  *mgmt_evq;
 259
 260         unsigned int                    rxq_count;
 261         struct sfc_rxq_info             *rxq_info;
 262         struct sfc_rxq                  *rxq_ctrl;
 263
 264         unsigned int                    txq_count;
 265         struct sfc_txq_info             *txq_info;
 266         struct sfc_txq                  *txq_ctrl;
 267
 268         boolean_t                       tso;
 269
 270         uint32_t                        rxd_wait_timeout_ns;
 271
 272         struct sfc_rss                  rss;
 273
 274         /*
 275          * Shared memory copy of the Rx datapath name to be used by
 276          * the secondary process to find Rx datapath to be used.
 277          */
 278         char                            *dp_rx_name;
 279
 280         /*
 281          * Shared memory copy of the Tx datapath name to be used by
 282          * the secondary process to find Tx datapath to be used.
 283          */
 284         char                            *dp_tx_name;
 285 };
 286
 287 /*
 288  * Add wrapper functions to acquire/release lock to be able to remove or
 289  * change the lock in one place.
 290  */
 291
 292 static inline void
 293 sfc_adapter_lock_init(struct sfc_adapter *sa)
 294 {
 295         rte_spinlock_init(&sa->lock);
 296 }
 297
 298 static inline int
 299 sfc_adapter_is_locked(struct sfc_adapter *sa)
 300 {
 301         return rte_spinlock_is_locked(&sa->lock);
 302 }
 303
 304 static inline void
 305 sfc_adapter_lock(struct sfc_adapter *sa)
 306 {
 307         rte_spinlock_lock(&sa->lock);
 308 }
 309
 310 static inline int
 311 sfc_adapter_trylock(struct sfc_adapter *sa)
 312 {
 313         return rte_spinlock_trylock(&sa->lock);
 314 }
 315
 316 static inline void
 317 sfc_adapter_unlock(struct sfc_adapter *sa)
 318 {
 319         rte_spinlock_unlock(&sa->lock);
 320 }
 321
 322 static inline void
 323 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
 324 {
 325         /* Just for symmetry of the API */
 326 }
 327
 328 /** Get the number of milliseconds since boot from the default timer */
 329 static inline uint64_t
 330 sfc_get_system_msecs(void)
 331 {
 332         return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
 333 }
 334
 335 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
 336                   size_t len, int socket_id, efsys_mem_t *esmp);
 337 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 338
 339 uint32_t sfc_register_logtype(const struct rte_pci_addr *pci_addr,
 340                               const char *lt_prefix_str,
 341                               uint32_t ll_default);
 342
 343 int sfc_probe(struct sfc_adapter *sa);
 344 void sfc_unprobe(struct sfc_adapter *sa);
 345 int sfc_attach(struct sfc_adapter *sa);
 346 void sfc_detach(struct sfc_adapter *sa);
 347 int sfc_start(struct sfc_adapter *sa);
 348 void sfc_stop(struct sfc_adapter *sa);
 349
 350 void sfc_schedule_restart(struct sfc_adapter *sa);
 351
 352 int sfc_mcdi_init(struct sfc_adapter *sa);
 353 void sfc_mcdi_fini(struct sfc_adapter *sa);
 354
 355 int sfc_configure(struct sfc_adapter *sa);
 356 void sfc_close(struct sfc_adapter *sa);
 357
 358 int sfc_intr_attach(struct sfc_adapter *sa);
 359 void sfc_intr_detach(struct sfc_adapter *sa);
 360 int sfc_intr_configure(struct sfc_adapter *sa);
 361 void sfc_intr_close(struct sfc_adapter *sa);
 362 int sfc_intr_start(struct sfc_adapter *sa);
 363 void sfc_intr_stop(struct sfc_adapter *sa);
 364
 365 int sfc_port_attach(struct sfc_adapter *sa);
 366 void sfc_port_detach(struct sfc_adapter *sa);
 367 int sfc_port_configure(struct sfc_adapter *sa);
 368 void sfc_port_close(struct sfc_adapter *sa);
 369 int sfc_port_start(struct sfc_adapter *sa);
 370 void sfc_port_stop(struct sfc_adapter *sa);
 371 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
 372                                 struct rte_eth_link *link_info);
 373 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
 374 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
 375 int sfc_set_rx_mode(struct sfc_adapter *sa);
 376
 377
 378 #ifdef __cplusplus
 379 }
 380 #endif
 381
 382 #endif  /* _SFC_H */