sys/dev/sfxge/sfxge.h

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