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 /** RSS hash offloads mask */
  31 #define SFC_RSS_OFFLOADS        (ETH_RSS_IP | ETH_RSS_TCP)
  32
  33 /*
  34  * +---------------+
  35  * | UNINITIALIZED |<-----------+
  36  * +---------------+            |
  37  *      |.eth_dev_init          |.eth_dev_uninit
  38  *      V                       |
  39  * +---------------+------------+
  40  * |  INITIALIZED  |
  41  * +---------------+<-----------<---------------+
  42  *      |.dev_configure         |               |
  43  *      V                       |failed         |
  44  * +---------------+------------+               |
  45  * |  CONFIGURING  |                            |
  46  * +---------------+----+                       |
  47  *      |success        |                       |
  48  *      |               |               +---------------+
  49  *      |               |               |    CLOSING    |
  50  *      |               |               +---------------+
  51  *      |               |                       ^
  52  *      V               |.dev_configure         |
  53  * +---------------+----+                       |.dev_close
  54  * |  CONFIGURED   |----------------------------+
  55  * +---------------+<-----------+
  56  *      |.dev_start             |
  57  *      V                       |
  58  * +---------------+            |
  59  * |   STARTING    |------------^
  60  * +---------------+ failed     |
  61  *      |success                |
  62  *      |               +---------------+
  63  *      |               |   STOPPING    |
  64  *      |               +---------------+
  65  *      |                       ^
  66  *      V                       |.dev_stop
  67  * +---------------+------------+
  68  * |    STARTED    |
  69  * +---------------+
  70  */
  71 enum sfc_adapter_state {
  72         SFC_ADAPTER_UNINITIALIZED = 0,
  73         SFC_ADAPTER_INITIALIZED,
  74         SFC_ADAPTER_CONFIGURING,
  75         SFC_ADAPTER_CONFIGURED,
  76         SFC_ADAPTER_CLOSING,
  77         SFC_ADAPTER_STARTING,
  78         SFC_ADAPTER_STARTED,
  79         SFC_ADAPTER_STOPPING,
  80
  81         SFC_ADAPTER_NSTATES
  82 };
  83
  84 enum sfc_dev_filter_mode {
  85         SFC_DEV_FILTER_MODE_PROMISC = 0,
  86         SFC_DEV_FILTER_MODE_ALLMULTI,
  87
  88         SFC_DEV_FILTER_NMODES
  89 };
  90
  91 enum sfc_mcdi_state {
  92         SFC_MCDI_UNINITIALIZED = 0,
  93         SFC_MCDI_INITIALIZED,
  94         SFC_MCDI_BUSY,
  95         SFC_MCDI_COMPLETED,
  96
  97         SFC_MCDI_NSTATES
  98 };
  99
 100 struct sfc_mcdi {
 101         rte_spinlock_t                  lock;
 102         efsys_mem_t                     mem;
 103         enum sfc_mcdi_state             state;
 104         efx_mcdi_transport_t            transport;
 105         uint32_t                        logtype;
 106         uint32_t                        proxy_handle;
 107         efx_rc_t                        proxy_result;
 108 };
 109
 110 struct sfc_intr {
 111         efx_intr_type_t                 type;
 112         rte_intr_callback_fn            handler;
 113         boolean_t                       lsc_intr;
 114 };
 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
 157 /* Adapter private data */
 158 struct sfc_adapter {
 159         /*
 160          * PMD setup and configuration is not thread safe. Since it is not
 161          * performance sensitive, it is better to guarantee thread-safety
 162          * and add device level lock. Adapter control operations which
 163          * change its state should acquire the lock.
 164          */
 165         rte_spinlock_t                  lock;
 166         enum sfc_adapter_state          state;
 167         struct rte_pci_addr             pci_addr;
 168         uint16_t                        port_id;
 169         struct rte_eth_dev              *eth_dev;
 170         struct rte_kvargs               *kvargs;
 171         uint32_t                        logtype_main;
 172         int                             socket_id;
 173         efsys_bar_t                     mem_bar;
 174         efx_family_t                    family;
 175         efx_nic_t                       *nic;
 176         rte_spinlock_t                  nic_lock;
 177         rte_atomic32_t                  restart_required;
 178
 179         struct sfc_mcdi                 mcdi;
 180         struct sfc_intr                 intr;
 181         struct sfc_port                 port;
 182         struct sfc_filter               filter;
 183
 184         unsigned int                    rxq_max;
 185         unsigned int                    txq_max;
 186
 187         unsigned int                    txq_max_entries;
 188
 189         uint32_t                        evq_flags;
 190         unsigned int                    evq_count;
 191
 192         unsigned int                    mgmt_evq_index;
 193         /*
 194          * The lock is used to serialise management event queue polling
 195          * which can be done from different context. Also the lock
 196          * guarantees that mgmt_evq_running is preserved while the lock
 197          * is held. It is used to serialise polling and start/stop
 198          * operations.
 199          *
 200          * Locks which may be held when the lock is acquired:
 201          *  - adapter lock, when:
 202          *    - device start/stop to change mgmt_evq_running
 203          *    - any control operations in client side MCDI proxy handling to
 204          *      poll management event queue waiting for proxy response
 205          *  - MCDI lock, when:
 206          *    - any control operations in client side MCDI proxy handling to
 207          *      poll management event queue waiting for proxy response
 208          *
 209          * Locks which are acquired with the lock held:
 210          *  - nic_lock, when:
 211          *    - MC event processing on management event queue polling
 212          *      (e.g. MC REBOOT or BADASSERT events)
 213          */
 214         rte_spinlock_t                  mgmt_evq_lock;
 215         bool                            mgmt_evq_running;
 216         struct sfc_evq                  *mgmt_evq;
 217
 218         unsigned int                    rxq_count;
 219         struct sfc_rxq_info             *rxq_info;
 220
 221         unsigned int                    txq_count;
 222         struct sfc_txq_info             *txq_info;
 223
 224         boolean_t                       tso;
 225
 226         unsigned int                    rss_channels;
 227
 228         efx_rx_scale_context_type_t     rss_support;
 229         efx_rx_hash_support_t           hash_support;
 230         efx_rx_hash_type_t              rss_hash_types;
 231         unsigned int                    rss_tbl[EFX_RSS_TBL_SIZE];
 232         uint8_t                         rss_key[EFX_RSS_KEY_SIZE];
 233
 234         /*
 235          * Shared memory copy of the Rx datapath name to be used by
 236          * the secondary process to find Rx datapath to be used.
 237          */
 238         char                            *dp_rx_name;
 239         const struct sfc_dp_rx          *dp_rx;
 240
 241         /*
 242          * Shared memory copy of the Tx datapath name to be used by
 243          * the secondary process to find Rx datapath to be used.
 244          */
 245         char                            *dp_tx_name;
 246         const struct sfc_dp_tx          *dp_tx;
 247 };
 248
 249 /*
 250  * Add wrapper functions to acquire/release lock to be able to remove or
 251  * change the lock in one place.
 252  */
 253
 254 static inline void
 255 sfc_adapter_lock_init(struct sfc_adapter *sa)
 256 {
 257         rte_spinlock_init(&sa->lock);
 258 }
 259
 260 static inline int
 261 sfc_adapter_is_locked(struct sfc_adapter *sa)
 262 {
 263         return rte_spinlock_is_locked(&sa->lock);
 264 }
 265
 266 static inline void
 267 sfc_adapter_lock(struct sfc_adapter *sa)
 268 {
 269         rte_spinlock_lock(&sa->lock);
 270 }
 271
 272 static inline int
 273 sfc_adapter_trylock(struct sfc_adapter *sa)
 274 {
 275         return rte_spinlock_trylock(&sa->lock);
 276 }
 277
 278 static inline void
 279 sfc_adapter_unlock(struct sfc_adapter *sa)
 280 {
 281         rte_spinlock_unlock(&sa->lock);
 282 }
 283
 284 static inline void
 285 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
 286 {
 287         /* Just for symmetry of the API */
 288 }
 289
 290 /** Get the number of milliseconds since boot from the default timer */
 291 static inline uint64_t
 292 sfc_get_system_msecs(void)
 293 {
 294         return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
 295 }
 296
 297 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
 298                   size_t len, int socket_id, efsys_mem_t *esmp);
 299 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 300
 301 uint32_t sfc_register_logtype(struct sfc_adapter *sa,
 302                               const char *lt_prefix_str,
 303                               uint32_t ll_default);
 304
 305 int sfc_probe(struct sfc_adapter *sa);
 306 void sfc_unprobe(struct sfc_adapter *sa);
 307 int sfc_attach(struct sfc_adapter *sa);
 308 void sfc_detach(struct sfc_adapter *sa);
 309 int sfc_start(struct sfc_adapter *sa);
 310 void sfc_stop(struct sfc_adapter *sa);
 311
 312 void sfc_schedule_restart(struct sfc_adapter *sa);
 313
 314 int sfc_mcdi_init(struct sfc_adapter *sa);
 315 void sfc_mcdi_fini(struct sfc_adapter *sa);
 316
 317 int sfc_configure(struct sfc_adapter *sa);
 318 void sfc_close(struct sfc_adapter *sa);
 319
 320 int sfc_intr_attach(struct sfc_adapter *sa);
 321 void sfc_intr_detach(struct sfc_adapter *sa);
 322 int sfc_intr_configure(struct sfc_adapter *sa);
 323 void sfc_intr_close(struct sfc_adapter *sa);
 324 int sfc_intr_start(struct sfc_adapter *sa);
 325 void sfc_intr_stop(struct sfc_adapter *sa);
 326
 327 int sfc_port_attach(struct sfc_adapter *sa);
 328 void sfc_port_detach(struct sfc_adapter *sa);
 329 int sfc_port_configure(struct sfc_adapter *sa);
 330 void sfc_port_close(struct sfc_adapter *sa);
 331 int sfc_port_start(struct sfc_adapter *sa);
 332 void sfc_port_stop(struct sfc_adapter *sa);
 333 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
 334                                 struct rte_eth_link *link_info);
 335 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
 336 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
 337 int sfc_set_rx_mode(struct sfc_adapter *sa);
 338
 339
 340 #ifdef __cplusplus
 341 }
 342 #endif
 343
 344 #endif  /* _SFC_H */