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