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_var.h>
  46 #include <net/if_media.h>
  47 #include <net/if_types.h>
  48
  49 /*
  50  * Backward-compatibility
  51  */
  52 #ifndef CACHE_LINE_SIZE
  53 /* This should be right on most machines the driver will be used on, and
  54  * we needn't care too much about wasting a few KB per interface.
  55  */
  56 #define CACHE_LINE_SIZE 128
  57 #endif
  58 #ifndef IFCAP_LINKSTATE
  59 #define IFCAP_LINKSTATE 0
  60 #endif
  61 #ifndef IFCAP_VLAN_HWTSO
  62 #define IFCAP_VLAN_HWTSO 0
  63 #endif
  64 #ifndef IFM_10G_T
  65 #define IFM_10G_T IFM_UNKNOWN
  66 #endif
  67 #ifndef IFM_10G_KX4
  68 #define IFM_10G_KX4 IFM_10G_CX4
  69 #endif
  70 #if __FreeBSD_version >= 800054
  71 /* Networking core is multiqueue aware. We can manage our own TX
  72  * queues and use m_pkthdr.flowid.
  73  */
  74 #define SFXGE_HAVE_MQ
  75 #endif
  76 #if (__FreeBSD_version >= 800501 && __FreeBSD_version < 900000) || \
  77         __FreeBSD_version >= 900003
  78 #define SFXGE_HAVE_DESCRIBE_INTR
  79 #endif
  80 #ifdef IFM_ETH_RXPAUSE
  81 #define SFXGE_HAVE_PAUSE_MEDIAOPTS
  82 #endif
  83 #ifndef CTLTYPE_U64
  84 #define CTLTYPE_U64 CTLTYPE_QUAD
  85 #endif
  86
  87 #include "sfxge_rx.h"
  88 #include "sfxge_tx.h"
  89
  90 #define ROUNDUP_POW_OF_TWO(_n)  (1ULL << flsl((_n) - 1))
  91
  92 #define SFXGE_IP_ALIGN  2
  93
  94 #define SFXGE_ETHERTYPE_LOOPBACK        0x9000  /* Xerox loopback */
  95
  96 enum sfxge_evq_state {
  97         SFXGE_EVQ_UNINITIALIZED = 0,
  98         SFXGE_EVQ_INITIALIZED,
  99         SFXGE_EVQ_STARTING,
 100         SFXGE_EVQ_STARTED
 101 };
 102
 103 #define SFXGE_EV_BATCH  16384
 104
 105 struct sfxge_evq {
 106         struct sfxge_softc      *sc  __aligned(CACHE_LINE_SIZE);
 107         struct mtx              lock __aligned(CACHE_LINE_SIZE);
 108
 109         enum sfxge_evq_state    init_state;
 110         unsigned int            index;
 111         unsigned int            entries;
 112         efsys_mem_t             mem;
 113         unsigned int            buf_base_id;
 114
 115         boolean_t               exception;
 116
 117         efx_evq_t               *common;
 118         unsigned int            read_ptr;
 119         unsigned int            rx_done;
 120         unsigned int            tx_done;
 121
 122         /* Linked list of TX queues with completions to process */
 123         struct sfxge_txq        *txq;
 124         struct sfxge_txq        **txqs;
 125 };
 126
 127 #define SFXGE_NDESCS    1024
 128 #define SFXGE_MODERATION        30
 129
 130 enum sfxge_intr_state {
 131         SFXGE_INTR_UNINITIALIZED = 0,
 132         SFXGE_INTR_INITIALIZED,
 133         SFXGE_INTR_TESTING,
 134         SFXGE_INTR_STARTED
 135 };
 136
 137 struct sfxge_intr_hdl {
 138         int                     eih_rid;
 139         void                    *eih_tag;
 140         struct resource         *eih_res;
 141 };
 142
 143 struct sfxge_intr {
 144         enum sfxge_intr_state   state;
 145         struct resource         *msix_res;
 146         struct sfxge_intr_hdl   *table;
 147         int                     n_alloc;
 148         int                     type;
 149         efsys_mem_t             status;
 150         uint32_t                zero_count;
 151 };
 152
 153 enum sfxge_mcdi_state {
 154         SFXGE_MCDI_UNINITIALIZED = 0,
 155         SFXGE_MCDI_INITIALIZED,
 156         SFXGE_MCDI_BUSY,
 157         SFXGE_MCDI_COMPLETED
 158 };
 159
 160 struct sfxge_mcdi {
 161         struct mtx              lock;
 162         struct cv               cv;
 163         enum sfxge_mcdi_state   state;
 164         efx_mcdi_transport_t    transport;
 165 };
 166
 167 struct sfxge_hw_stats {
 168         clock_t                 update_time;
 169         efsys_mem_t             dma_buf;
 170         void                    *decode_buf;
 171 };
 172
 173 enum sfxge_port_state {
 174         SFXGE_PORT_UNINITIALIZED = 0,
 175         SFXGE_PORT_INITIALIZED,
 176         SFXGE_PORT_STARTED
 177 };
 178
 179 struct sfxge_port {
 180         struct sfxge_softc      *sc;
 181         struct mtx              lock;
 182         enum sfxge_port_state   init_state;
 183 #ifndef SFXGE_HAVE_PAUSE_MEDIAOPTS
 184         unsigned int            wanted_fc;
 185 #endif
 186         struct sfxge_hw_stats   phy_stats;
 187         struct sfxge_hw_stats   mac_stats;
 188         efx_link_mode_t         link_mode;
 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         enum sfxge_softc_state          init_state;
 202         struct ifnet                    *ifnet;
 203         unsigned int                    if_flags;
 204         struct sysctl_oid               *stats_node;
 205         struct sysctl_oid               *txqs_node;
 206
 207         struct task                     task_reset;
 208
 209         efx_family_t                    family;
 210         caddr_t                         vpd_data;
 211         size_t                          vpd_size;
 212         efx_nic_t                       *enp;
 213         struct mtx                      enp_lock;
 214
 215         unsigned int                    rxq_entries;
 216         unsigned int                    txq_entries;
 217
 218         bus_dma_tag_t                   parent_dma_tag;
 219         efsys_bar_t                     bar;
 220
 221         struct sfxge_intr               intr;
 222         struct sfxge_mcdi               mcdi;
 223         struct sfxge_port               port;
 224         uint32_t                        buffer_table_next;
 225
 226         struct sfxge_evq                *evq[SFXGE_RX_SCALE_MAX];
 227         unsigned int                    ev_moderation;
 228         clock_t                         ev_stats_update_time;
 229         uint64_t                        ev_stats[EV_NQSTATS];
 230
 231         uma_zone_t                      rxq_cache;
 232         struct sfxge_rxq                *rxq[SFXGE_RX_SCALE_MAX];
 233         unsigned int                    rx_indir_table[SFXGE_RX_SCALE_MAX];
 234
 235 #ifdef SFXGE_HAVE_MQ
 236         struct sfxge_txq                *txq[SFXGE_TXQ_NTYPES + SFXGE_RX_SCALE_MAX];
 237 #else
 238         struct sfxge_txq                *txq[SFXGE_TXQ_NTYPES];
 239 #endif
 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 #ifndef SFXGE_HAVE_MQ
 248         struct mtx                      tx_lock __aligned(CACHE_LINE_SIZE);
 249 #endif
 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_softc *sc, unsigned int index);
 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 #endif /* _SFXGE_H */