sys/dev/sfxge/sfxge.h

   1 /*-
   2  * Copyright (c) 2010-2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * This software was developed in part by Philip Paeps under contract for
   6  * Solarflare Communications, Inc.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright notice,
  12  *    this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  *    this list of conditions and the following disclaimer in the documentation
  15  *    and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  24  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  27  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * The views and conclusions contained in the software and documentation are
  30  * those of the authors and should not be interpreted as representing official
  31  * policies, either expressed or implied, of the FreeBSD Project.
  32  *
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _SFXGE_H
  37 #define _SFXGE_H
  38
  39 #include <sys/param.h>
  40 #include <sys/kernel.h>
  41 #include <sys/socket.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/sx.h>
  44 #include <vm/uma.h>
  45
  46 #include <net/ethernet.h>
  47 #include <net/if.h>
  48 #include <net/if_media.h>
  49 #include <net/if_types.h>
  50
  51 #include "sfxge_ioc.h"
  52
  53 /*
  54  * Debugging
  55  */
  56 #if 0
  57 #define DBGPRINT(dev, fmt, args...) \
  58         device_printf(dev, "%s: " fmt "\n", __func__, ## args)
  59 #else
  60 #define DBGPRINT(dev, fmt, args...)
  61 #endif
  62
  63 /*
  64  * Backward-compatibility
  65  */
  66 #ifndef CACHE_LINE_SIZE
  67 /* This should be right on most machines the driver will be used on, and
  68  * we needn't care too much about wasting a few KB per interface.
  69  */
  70 #define CACHE_LINE_SIZE 128
  71 #endif
  72
  73 #ifndef IFCAP_LINKSTATE
  74 #define IFCAP_LINKSTATE 0
  75 #endif
  76
  77 #ifndef IFCAP_VLAN_HWTSO
  78 #define IFCAP_VLAN_HWTSO 0
  79 #endif
  80
  81 #ifndef IFM_10G_T
  82 #define IFM_10G_T IFM_UNKNOWN
  83 #endif
  84
  85 #ifndef IFM_10G_KX4
  86 #define IFM_10G_KX4 IFM_10G_CX4
  87 #endif
  88
  89 #ifndef IFM_40G_CR4
  90 #define IFM_40G_CR4 IFM_UNKNOWN
  91 #endif
  92
  93 #if (__FreeBSD_version >= 800501 && __FreeBSD_version < 900000) || \
  94         __FreeBSD_version >= 900003
  95 #define SFXGE_HAVE_DESCRIBE_INTR
  96 #endif
  97
  98 #ifdef IFM_ETH_RXPAUSE
  99 #define SFXGE_HAVE_PAUSE_MEDIAOPTS
 100 #endif
 101
 102 #ifndef CTLTYPE_U64
 103 #define CTLTYPE_U64 CTLTYPE_QUAD
 104 #endif
 105
 106 #include "sfxge_rx.h"
 107 #include "sfxge_tx.h"
 108
 109 #define ROUNDUP_POW_OF_TWO(_n)  (1ULL << flsl((_n) - 1))
 110
 111 #define SFXGE_IP_ALIGN  2
 112
 113 #define SFXGE_ETHERTYPE_LOOPBACK        0x9000  /* Xerox loopback */
 114
 115
 116 #define SFXGE_MAGIC_RESERVED            0x8000
 117
 118 #define SFXGE_MAGIC_DMAQ_LABEL_WIDTH    6
 119 #define SFXGE_MAGIC_DMAQ_LABEL_MASK \
 120         ((1 << SFXGE_MAGIC_DMAQ_LABEL_WIDTH) - 1)
 121
 122 enum sfxge_sw_ev {
 123         SFXGE_SW_EV_RX_QFLUSH_DONE = 1,
 124         SFXGE_SW_EV_RX_QFLUSH_FAILED,
 125         SFXGE_SW_EV_RX_QREFILL,
 126         SFXGE_SW_EV_TX_QFLUSH_DONE,
 127 };
 128
 129 #define SFXGE_SW_EV_MAGIC(_sw_ev) \
 130         (SFXGE_MAGIC_RESERVED | ((_sw_ev) << SFXGE_MAGIC_DMAQ_LABEL_WIDTH))
 131
 132 static inline uint16_t
 133 sfxge_sw_ev_mk_magic(enum sfxge_sw_ev sw_ev, unsigned int label)
 134 {
 135         KASSERT((label & SFXGE_MAGIC_DMAQ_LABEL_MASK) == label,
 136             ("(label & SFXGE_MAGIC_DMAQ_LABEL_MASK) != label"));
 137         return SFXGE_SW_EV_MAGIC(sw_ev) | label;
 138 }
 139
 140 static inline uint16_t
 141 sfxge_sw_ev_rxq_magic(enum sfxge_sw_ev sw_ev, struct sfxge_rxq *rxq)
 142 {
 143         return sfxge_sw_ev_mk_magic(sw_ev, 0);
 144 }
 145
 146 static inline uint16_t
 147 sfxge_sw_ev_txq_magic(enum sfxge_sw_ev sw_ev, struct sfxge_txq *txq)
 148 {
 149         return sfxge_sw_ev_mk_magic(sw_ev, txq->type);
 150 }
 151
 152 enum sfxge_evq_state {
 153         SFXGE_EVQ_UNINITIALIZED = 0,
 154         SFXGE_EVQ_INITIALIZED,
 155         SFXGE_EVQ_STARTING,
 156         SFXGE_EVQ_STARTED
 157 };
 158
 159 #define SFXGE_EV_BATCH  16384
 160
 161 #define SFXGE_STATS_UPDATE_PERIOD_MS    1000
 162
 163 struct sfxge_evq {
 164         /* Structure members below are sorted by usage order */
 165         struct sfxge_softc      *sc;
 166         struct mtx              lock;
 167         unsigned int            index;
 168         enum sfxge_evq_state    init_state;
 169         efsys_mem_t             mem;
 170         efx_evq_t               *common;
 171         unsigned int            read_ptr;
 172         boolean_t               exception;
 173         unsigned int            rx_done;
 174         unsigned int            tx_done;
 175
 176         /* Linked list of TX queues with completions to process */
 177         struct sfxge_txq        *txq;
 178         struct sfxge_txq        **txqs;
 179
 180         /* Structure members not used on event processing path */
 181         unsigned int            buf_base_id;
 182         unsigned int            entries;
 183         char                    lock_name[SFXGE_LOCK_NAME_MAX];
 184 } __aligned(CACHE_LINE_SIZE);
 185
 186 #define SFXGE_NDESCS    1024
 187 #define SFXGE_MODERATION        30
 188
 189 enum sfxge_intr_state {
 190         SFXGE_INTR_UNINITIALIZED = 0,
 191         SFXGE_INTR_INITIALIZED,
 192         SFXGE_INTR_TESTING,
 193         SFXGE_INTR_STARTED
 194 };
 195
 196 struct sfxge_intr_hdl {
 197         int                     eih_rid;
 198         void                    *eih_tag;
 199         struct resource         *eih_res;
 200 };
 201
 202 struct sfxge_intr {
 203         enum sfxge_intr_state   state;
 204         struct resource         *msix_res;
 205         struct sfxge_intr_hdl   *table;
 206         int                     n_alloc;
 207         int                     type;
 208         efsys_mem_t             status;
 209         uint32_t                zero_count;
 210 };
 211
 212 enum sfxge_mcdi_state {
 213         SFXGE_MCDI_UNINITIALIZED = 0,
 214         SFXGE_MCDI_INITIALIZED,
 215         SFXGE_MCDI_BUSY,
 216         SFXGE_MCDI_COMPLETED
 217 };
 218
 219 struct sfxge_mcdi {
 220         struct mtx              lock;
 221         efsys_mem_t             mem;
 222         enum sfxge_mcdi_state   state;
 223         efx_mcdi_transport_t    transport;
 224
 225         /* Only used in debugging output */
 226         char                    lock_name[SFXGE_LOCK_NAME_MAX];
 227 };
 228
 229 struct sfxge_hw_stats {
 230         clock_t                 update_time;
 231         efsys_mem_t             dma_buf;
 232         void                    *decode_buf;
 233 };
 234
 235 enum sfxge_port_state {
 236         SFXGE_PORT_UNINITIALIZED = 0,
 237         SFXGE_PORT_INITIALIZED,
 238         SFXGE_PORT_STARTED
 239 };
 240
 241 struct sfxge_port {
 242         struct sfxge_softc      *sc;
 243         struct mtx              lock;
 244         enum sfxge_port_state   init_state;
 245 #ifndef SFXGE_HAVE_PAUSE_MEDIAOPTS
 246         unsigned int            wanted_fc;
 247 #endif
 248         struct sfxge_hw_stats   phy_stats;
 249         struct sfxge_hw_stats   mac_stats;
 250         uint16_t                stats_update_period_ms;
 251         efx_link_mode_t         link_mode;
 252         uint8_t                 mcast_addrs[EFX_MAC_MULTICAST_LIST_MAX *
 253                                             EFX_MAC_ADDR_LEN];
 254         unsigned int            mcast_count;
 255
 256         /* Only used in debugging output */
 257         char                    lock_name[SFXGE_LOCK_NAME_MAX];
 258 };
 259
 260 enum sfxge_softc_state {
 261         SFXGE_UNINITIALIZED = 0,
 262         SFXGE_INITIALIZED,
 263         SFXGE_REGISTERED,
 264         SFXGE_STARTED
 265 };
 266
 267 struct sfxge_softc {
 268         device_t                        dev;
 269         struct sx                       softc_lock;
 270         char                            softc_lock_name[SFXGE_LOCK_NAME_MAX];
 271         enum sfxge_softc_state          init_state;
 272         struct ifnet                    *ifnet;
 273         unsigned int                    if_flags;
 274         struct sysctl_oid               *stats_node;
 275         struct sysctl_oid               *txqs_node;
 276
 277         struct task                     task_reset;
 278
 279         efx_family_t                    family;
 280         caddr_t                         vpd_data;
 281         size_t                          vpd_size;
 282         efx_nic_t                       *enp;
 283         efsys_lock_t                    enp_lock;
 284
 285         unsigned int                    rxq_entries;
 286         unsigned int                    txq_entries;
 287
 288         bus_dma_tag_t                   parent_dma_tag;
 289         efsys_bar_t                     bar;
 290
 291         struct sfxge_intr               intr;
 292         struct sfxge_mcdi               mcdi;
 293         struct sfxge_port               port;
 294         uint32_t                        buffer_table_next;
 295
 296         struct sfxge_evq                *evq[SFXGE_RX_SCALE_MAX];
 297         unsigned int                    ev_moderation;
 298 #if EFSYS_OPT_QSTATS
 299         clock_t                         ev_stats_update_time;
 300         uint64_t                        ev_stats[EV_NQSTATS];
 301 #endif
 302
 303         unsigned int                    max_rss_channels;
 304         uma_zone_t                      rxq_cache;
 305         struct sfxge_rxq                *rxq[SFXGE_RX_SCALE_MAX];
 306         unsigned int                    rx_indir_table[EFX_RSS_TBL_SIZE];
 307
 308         struct sfxge_txq                *txq[SFXGE_TXQ_NTYPES + SFXGE_RX_SCALE_MAX];
 309
 310         struct ifmedia                  media;
 311
 312         size_t                          rx_prefix_size;
 313         size_t                          rx_buffer_size;
 314         size_t                          rx_buffer_align;
 315         uma_zone_t                      rx_buffer_zone;
 316
 317         struct callout                  tick_callout;
 318
 319         unsigned int                    evq_max;
 320         unsigned int                    evq_count;
 321         unsigned int                    rxq_count;
 322         unsigned int                    txq_count;
 323
 324         unsigned int                    tso_fw_assisted;
 325 #define SFXGE_FATSOV1   (1 << 0)
 326 #define SFXGE_FATSOV2   (1 << 1)
 327
 328 #if EFSYS_OPT_MCDI_LOGGING
 329         int                             mcdi_logging;
 330 #endif
 331 };
 332
 333 #define SFXGE_LINK_UP(sc) \
 334         ((sc)->port.link_mode != EFX_LINK_DOWN && \
 335          (sc)->port.link_mode != EFX_LINK_UNKNOWN)
 336 #define SFXGE_RUNNING(sc) ((sc)->ifnet->if_drv_flags & IFF_DRV_RUNNING)
 337
 338 #define SFXGE_PARAM(_name)      "hw.sfxge." #_name
 339
 340 SYSCTL_DECL(_hw_sfxge);
 341
 342 /*
 343  * From sfxge.c.
 344  */
 345 extern void sfxge_schedule_reset(struct sfxge_softc *sc);
 346 extern void sfxge_sram_buf_tbl_alloc(struct sfxge_softc *sc, size_t n,
 347                                      uint32_t *idp);
 348
 349 /*
 350  * From sfxge_dma.c.
 351  */
 352 extern int sfxge_dma_init(struct sfxge_softc *sc);
 353 extern void sfxge_dma_fini(struct sfxge_softc *sc);
 354 extern int sfxge_dma_alloc(struct sfxge_softc *sc, bus_size_t len,
 355                            efsys_mem_t *esmp);
 356 extern void sfxge_dma_free(efsys_mem_t *esmp);
 357 extern int sfxge_dma_map_sg_collapse(bus_dma_tag_t tag, bus_dmamap_t map,
 358                                      struct mbuf **mp,
 359                                      bus_dma_segment_t *segs,
 360                                      int *nsegs, int maxsegs);
 361
 362 /*
 363  * From sfxge_ev.c.
 364  */
 365 extern int sfxge_ev_init(struct sfxge_softc *sc);
 366 extern void sfxge_ev_fini(struct sfxge_softc *sc);
 367 extern int sfxge_ev_start(struct sfxge_softc *sc);
 368 extern void sfxge_ev_stop(struct sfxge_softc *sc);
 369 extern int sfxge_ev_qpoll(struct sfxge_evq *evq);
 370
 371 /*
 372  * From sfxge_intr.c.
 373  */
 374 extern int sfxge_intr_init(struct sfxge_softc *sc);
 375 extern void sfxge_intr_fini(struct sfxge_softc *sc);
 376 extern int sfxge_intr_start(struct sfxge_softc *sc);
 377 extern void sfxge_intr_stop(struct sfxge_softc *sc);
 378
 379 /*
 380  * From sfxge_mcdi.c.
 381  */
 382 extern int sfxge_mcdi_init(struct sfxge_softc *sc);
 383 extern void sfxge_mcdi_fini(struct sfxge_softc *sc);
 384 extern int sfxge_mcdi_ioctl(struct sfxge_softc *sc, sfxge_ioc_t *ip);
 385
 386 /*
 387  * From sfxge_nvram.c.
 388  */
 389 extern int sfxge_nvram_ioctl(struct sfxge_softc *sc, sfxge_ioc_t *ip);
 390
 391 /*
 392  * From sfxge_port.c.
 393  */
 394 extern int sfxge_port_init(struct sfxge_softc *sc);
 395 extern void sfxge_port_fini(struct sfxge_softc *sc);
 396 extern int sfxge_port_start(struct sfxge_softc *sc);
 397 extern void sfxge_port_stop(struct sfxge_softc *sc);
 398 extern void sfxge_mac_link_update(struct sfxge_softc *sc,
 399                                   efx_link_mode_t mode);
 400 extern int sfxge_mac_filter_set(struct sfxge_softc *sc);
 401 extern int sfxge_port_ifmedia_init(struct sfxge_softc *sc);
 402 extern void sfxge_port_update_stats(struct sfxge_softc *sc);
 403
 404 #define SFXGE_MAX_MTU (9 * 1024)
 405
 406 #define SFXGE_ADAPTER_LOCK_INIT(_sc, _ifname)                           \
 407         do {                                                            \
 408                 struct sfxge_softc *__sc = (_sc);                       \
 409                                                                         \
 410                 snprintf((__sc)->softc_lock_name,                       \
 411                          sizeof((__sc)->softc_lock_name),               \
 412                          "%s:softc", (_ifname));                        \
 413                 sx_init(&(__sc)->softc_lock, (__sc)->softc_lock_name);  \
 414         } while (B_FALSE)
 415 #define SFXGE_ADAPTER_LOCK_DESTROY(_sc)                                 \
 416         sx_destroy(&(_sc)->softc_lock)
 417 #define SFXGE_ADAPTER_LOCK(_sc)                                         \
 418         sx_xlock(&(_sc)->softc_lock)
 419 #define SFXGE_ADAPTER_UNLOCK(_sc)                                       \
 420         sx_xunlock(&(_sc)->softc_lock)
 421 #define SFXGE_ADAPTER_LOCK_ASSERT_OWNED(_sc)                            \
 422         sx_assert(&(_sc)->softc_lock, LA_XLOCKED)
 423
 424 #define SFXGE_PORT_LOCK_INIT(_port, _ifname)                            \
 425         do {                                                            \
 426                 struct sfxge_port *__port = (_port);                    \
 427                                                                         \
 428                 snprintf((__port)->lock_name,                           \
 429                          sizeof((__port)->lock_name),                   \
 430                          "%s:port", (_ifname));                         \
 431                 mtx_init(&(__port)->lock, (__port)->lock_name,          \
 432                          NULL, MTX_DEF);                                \
 433         } while (B_FALSE)
 434 #define SFXGE_PORT_LOCK_DESTROY(_port)                                  \
 435         mtx_destroy(&(_port)->lock)
 436 #define SFXGE_PORT_LOCK(_port)                                          \
 437         mtx_lock(&(_port)->lock)
 438 #define SFXGE_PORT_UNLOCK(_port)                                        \
 439         mtx_unlock(&(_port)->lock)
 440 #define SFXGE_PORT_LOCK_ASSERT_OWNED(_port)                             \
 441         mtx_assert(&(_port)->lock, MA_OWNED)
 442
 443 #define SFXGE_MCDI_LOCK_INIT(_mcdi, _ifname)                            \
 444         do {                                                            \
 445                 struct sfxge_mcdi  *__mcdi = (_mcdi);                   \
 446                                                                         \
 447                 snprintf((__mcdi)->lock_name,                           \
 448                          sizeof((__mcdi)->lock_name),                   \
 449                          "%s:mcdi", (_ifname));                         \
 450                 mtx_init(&(__mcdi)->lock, (__mcdi)->lock_name,          \
 451                          NULL, MTX_DEF);                                \
 452         } while (B_FALSE)
 453 #define SFXGE_MCDI_LOCK_DESTROY(_mcdi)                                  \
 454         mtx_destroy(&(_mcdi)->lock)
 455 #define SFXGE_MCDI_LOCK(_mcdi)                                          \
 456         mtx_lock(&(_mcdi)->lock)
 457 #define SFXGE_MCDI_UNLOCK(_mcdi)                                        \
 458         mtx_unlock(&(_mcdi)->lock)
 459 #define SFXGE_MCDI_LOCK_ASSERT_OWNED(_mcdi)                             \
 460         mtx_assert(&(_mcdi)->lock, MA_OWNED)
 461
 462 #define SFXGE_EVQ_LOCK_INIT(_evq, _ifname, _evq_index)                  \
 463         do {                                                            \
 464                 struct sfxge_evq  *__evq = (_evq);                      \
 465                                                                         \
 466                 snprintf((__evq)->lock_name,                            \
 467                          sizeof((__evq)->lock_name),                    \
 468                          "%s:evq%u", (_ifname), (_evq_index));          \
 469                 mtx_init(&(__evq)->lock, (__evq)->lock_name,            \
 470                          NULL, MTX_DEF);                                \
 471         } while (B_FALSE)
 472 #define SFXGE_EVQ_LOCK_DESTROY(_evq)                                    \
 473         mtx_destroy(&(_evq)->lock)
 474 #define SFXGE_EVQ_LOCK(_evq)                                            \
 475         mtx_lock(&(_evq)->lock)
 476 #define SFXGE_EVQ_UNLOCK(_evq)                                          \
 477         mtx_unlock(&(_evq)->lock)
 478 #define SFXGE_EVQ_LOCK_ASSERT_OWNED(_evq)                               \
 479         mtx_assert(&(_evq)->lock, MA_OWNED)
 480
 481 #endif /* _SFXGE_H */