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