drivers/net/sfc/sfc.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  * Copyright (c) 2016-2017 Solarflare Communications Inc.
   5  * All rights reserved.
   6  *
   7  * This software was jointly developed between OKTET Labs (under contract
   8  * for Solarflare) and Solarflare Communications, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright notice,
  14  *    this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  *    this list of conditions and the following disclaimer in the documentation
  17  *    and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  29  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _SFC_H
  33 #define _SFC_H
  34
  35 #include <stdbool.h>
  36
  37 #include <rte_pci.h>
  38 #include <rte_bus_pci.h>
  39 #include <rte_ethdev.h>
  40 #include <rte_kvargs.h>
  41 #include <rte_spinlock.h>
  42
  43 #include "efx.h"
  44
  45 #include "sfc_filter.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 #if EFSYS_OPT_RX_SCALE
  52 /** RSS hash offloads mask */
  53 #define SFC_RSS_OFFLOADS        (ETH_RSS_IP | ETH_RSS_TCP)
  54 #endif
  55
  56 /*
  57  * +---------------+
  58  * | UNINITIALIZED |<-----------+
  59  * +---------------+            |
  60  *      |.eth_dev_init          |.eth_dev_uninit
  61  *      V                       |
  62  * +---------------+------------+
  63  * |  INITIALIZED  |
  64  * +---------------+<-----------<---------------+
  65  *      |.dev_configure         |               |
  66  *      V                       |failed         |
  67  * +---------------+------------+               |
  68  * |  CONFIGURING  |                            |
  69  * +---------------+----+                       |
  70  *      |success        |                       |
  71  *      |               |               +---------------+
  72  *      |               |               |    CLOSING    |
  73  *      |               |               +---------------+
  74  *      |               |                       ^
  75  *      V               |.dev_configure         |
  76  * +---------------+----+                       |.dev_close
  77  * |  CONFIGURED   |----------------------------+
  78  * +---------------+<-----------+
  79  *      |.dev_start             |
  80  *      V                       |
  81  * +---------------+            |
  82  * |   STARTING    |------------^
  83  * +---------------+ failed     |
  84  *      |success                |
  85  *      |               +---------------+
  86  *      |               |   STOPPING    |
  87  *      |               +---------------+
  88  *      |                       ^
  89  *      V                       |.dev_stop
  90  * +---------------+------------+
  91  * |    STARTED    |
  92  * +---------------+
  93  */
  94 enum sfc_adapter_state {
  95         SFC_ADAPTER_UNINITIALIZED = 0,
  96         SFC_ADAPTER_INITIALIZED,
  97         SFC_ADAPTER_CONFIGURING,
  98         SFC_ADAPTER_CONFIGURED,
  99         SFC_ADAPTER_CLOSING,
 100         SFC_ADAPTER_STARTING,
 101         SFC_ADAPTER_STARTED,
 102         SFC_ADAPTER_STOPPING,
 103
 104         SFC_ADAPTER_NSTATES
 105 };
 106
 107 enum sfc_dev_filter_mode {
 108         SFC_DEV_FILTER_MODE_PROMISC = 0,
 109         SFC_DEV_FILTER_MODE_ALLMULTI,
 110
 111         SFC_DEV_FILTER_NMODES
 112 };
 113
 114 enum sfc_mcdi_state {
 115         SFC_MCDI_UNINITIALIZED = 0,
 116         SFC_MCDI_INITIALIZED,
 117         SFC_MCDI_BUSY,
 118         SFC_MCDI_COMPLETED,
 119
 120         SFC_MCDI_NSTATES
 121 };
 122
 123 struct sfc_mcdi {
 124         rte_spinlock_t                  lock;
 125         efsys_mem_t                     mem;
 126         enum sfc_mcdi_state             state;
 127         efx_mcdi_transport_t            transport;
 128         bool                            logging;
 129         uint32_t                        proxy_handle;
 130         efx_rc_t                        proxy_result;
 131 };
 132
 133 struct sfc_intr {
 134         efx_intr_type_t                 type;
 135         rte_intr_callback_fn            handler;
 136         boolean_t                       lsc_intr;
 137 };
 138
 139 struct sfc_rxq_info;
 140 struct sfc_txq_info;
 141 struct sfc_dp_rx;
 142
 143 struct sfc_port {
 144         unsigned int                    lsc_seq;
 145
 146         uint32_t                        phy_adv_cap_mask;
 147         uint32_t                        phy_adv_cap;
 148
 149         unsigned int                    flow_ctrl;
 150         boolean_t                       flow_ctrl_autoneg;
 151         size_t                          pdu;
 152
 153         /*
 154          * Flow API isolated mode overrides promisc and allmulti settings;
 155          * they won't be applied if isolated mode is active
 156          */
 157         boolean_t                       isolated;
 158         boolean_t                       promisc;
 159         boolean_t                       allmulti;
 160
 161         unsigned int                    max_mcast_addrs;
 162         unsigned int                    nb_mcast_addrs;
 163         uint8_t                         *mcast_addrs;
 164
 165         rte_spinlock_t                  mac_stats_lock;
 166         uint64_t                        *mac_stats_buf;
 167         unsigned int                    mac_stats_nb_supported;
 168         efsys_mem_t                     mac_stats_dma_mem;
 169         boolean_t                       mac_stats_reset_pending;
 170         uint16_t                        mac_stats_update_period_ms;
 171         uint32_t                        mac_stats_update_generation;
 172         boolean_t                       mac_stats_periodic_dma_supported;
 173         uint64_t                        mac_stats_last_request_timestamp;
 174
 175         uint32_t                mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
 176 };
 177
 178 /* Adapter private data */
 179 struct sfc_adapter {
 180         /*
 181          * PMD setup and configuration is not thread safe. Since it is not
 182          * performance sensitive, it is better to guarantee thread-safety
 183          * and add device level lock. Adapter control operations which
 184          * change its state should acquire the lock.
 185          */
 186         rte_spinlock_t                  lock;
 187         enum sfc_adapter_state          state;
 188         struct rte_pci_addr             pci_addr;
 189         uint16_t                        port_id;
 190         struct rte_eth_dev              *eth_dev;
 191         struct rte_kvargs               *kvargs;
 192         bool                            debug_init;
 193         int                             socket_id;
 194         efsys_bar_t                     mem_bar;
 195         efx_family_t                    family;
 196         efx_nic_t                       *nic;
 197         rte_spinlock_t                  nic_lock;
 198
 199         struct sfc_mcdi                 mcdi;
 200         struct sfc_intr                 intr;
 201         struct sfc_port                 port;
 202         struct sfc_filter               filter;
 203
 204         unsigned int                    rxq_max;
 205         unsigned int                    txq_max;
 206
 207         unsigned int                    txq_max_entries;
 208
 209         uint32_t                        evq_flags;
 210         unsigned int                    evq_count;
 211
 212         unsigned int                    mgmt_evq_index;
 213         rte_spinlock_t                  mgmt_evq_lock;
 214         struct sfc_evq                  *mgmt_evq;
 215
 216         unsigned int                    rxq_count;
 217         struct sfc_rxq_info             *rxq_info;
 218
 219         unsigned int                    txq_count;
 220         struct sfc_txq_info             *txq_info;
 221
 222         boolean_t                       tso;
 223
 224         unsigned int                    rss_channels;
 225
 226 #if EFSYS_OPT_RX_SCALE
 227         efx_rx_scale_context_type_t     rss_support;
 228         efx_rx_hash_support_t           hash_support;
 229         efx_rx_hash_type_t              rss_hash_types;
 230         unsigned int                    rss_tbl[EFX_RSS_TBL_SIZE];
 231         uint8_t                         rss_key[EFX_RSS_KEY_SIZE];
 232 #endif
 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 int sfc_probe(struct sfc_adapter *sa);
 302 void sfc_unprobe(struct sfc_adapter *sa);
 303 int sfc_attach(struct sfc_adapter *sa);
 304 void sfc_detach(struct sfc_adapter *sa);
 305 int sfc_start(struct sfc_adapter *sa);
 306 void sfc_stop(struct sfc_adapter *sa);
 307
 308 int sfc_mcdi_init(struct sfc_adapter *sa);
 309 void sfc_mcdi_fini(struct sfc_adapter *sa);
 310
 311 int sfc_configure(struct sfc_adapter *sa);
 312 void sfc_close(struct sfc_adapter *sa);
 313
 314 int sfc_intr_attach(struct sfc_adapter *sa);
 315 void sfc_intr_detach(struct sfc_adapter *sa);
 316 int sfc_intr_configure(struct sfc_adapter *sa);
 317 void sfc_intr_close(struct sfc_adapter *sa);
 318 int sfc_intr_start(struct sfc_adapter *sa);
 319 void sfc_intr_stop(struct sfc_adapter *sa);
 320
 321 int sfc_port_attach(struct sfc_adapter *sa);
 322 void sfc_port_detach(struct sfc_adapter *sa);
 323 int sfc_port_configure(struct sfc_adapter *sa);
 324 void sfc_port_close(struct sfc_adapter *sa);
 325 int sfc_port_start(struct sfc_adapter *sa);
 326 void sfc_port_stop(struct sfc_adapter *sa);
 327 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
 328                                 struct rte_eth_link *link_info);
 329 int sfc_port_update_mac_stats(struct sfc_adapter *sa);
 330 int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
 331 int sfc_set_rx_mode(struct sfc_adapter *sa);
 332
 333
 334 #ifdef __cplusplus
 335 }
 336 #endif
 337
 338 #endif  /* _SFC_H */