sfxge.h revision 280432
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: head/sys/dev/sfxge/sfxge.h 280432 2015-03-24 11:25:19Z arybchik $ 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 59#ifndef IFCAP_LINKSTATE 60#define IFCAP_LINKSTATE 0 61#endif 62 63#ifndef IFCAP_VLAN_HWTSO 64#define IFCAP_VLAN_HWTSO 0 65#endif 66 67#ifndef IFM_10G_T 68#define IFM_10G_T IFM_UNKNOWN 69#endif 70 71#ifndef IFM_10G_KX4 72#define IFM_10G_KX4 IFM_10G_CX4 73#endif 74 75#if (__FreeBSD_version >= 800501 && __FreeBSD_version < 900000) || \ 76 __FreeBSD_version >= 900003 77#define SFXGE_HAVE_DESCRIBE_INTR 78#endif 79 80#ifdef IFM_ETH_RXPAUSE 81#define SFXGE_HAVE_PAUSE_MEDIAOPTS 82#endif 83 84#ifndef CTLTYPE_U64 85#define CTLTYPE_U64 CTLTYPE_QUAD 86#endif 87 88#include "sfxge_rx.h" 89#include "sfxge_tx.h" 90 91#define ROUNDUP_POW_OF_TWO(_n) (1ULL << flsl((_n) - 1)) 92 93#define SFXGE_IP_ALIGN 2 94 95#define SFXGE_ETHERTYPE_LOOPBACK 0x9000 /* Xerox loopback */ 96 97enum sfxge_evq_state { 98 SFXGE_EVQ_UNINITIALIZED = 0, 99 SFXGE_EVQ_INITIALIZED, 100 SFXGE_EVQ_STARTING, 101 SFXGE_EVQ_STARTED 102}; 103 104#define SFXGE_EV_BATCH 16384 105 106struct sfxge_evq { 107 /* Structure members below are sorted by usage order */ 108 struct sfxge_softc *sc; 109 struct mtx lock; 110 unsigned int index; 111 enum sfxge_evq_state init_state; 112 efsys_mem_t mem; 113 efx_evq_t *common; 114 unsigned int read_ptr; 115 boolean_t exception; 116 unsigned int rx_done; 117 unsigned int tx_done; 118 119 /* Linked list of TX queues with completions to process */ 120 struct sfxge_txq *txq; 121 struct sfxge_txq **txqs; 122 123 /* Structure members not used on event processing path */ 124 unsigned int buf_base_id; 125 unsigned int entries; 126 char lock_name[SFXGE_LOCK_NAME_MAX]; 127} __aligned(CACHE_LINE_SIZE); 128 129#define SFXGE_NDESCS 1024 130#define SFXGE_MODERATION 30 131 132enum sfxge_intr_state { 133 SFXGE_INTR_UNINITIALIZED = 0, 134 SFXGE_INTR_INITIALIZED, 135 SFXGE_INTR_TESTING, 136 SFXGE_INTR_STARTED 137}; 138 139struct sfxge_intr_hdl { 140 int eih_rid; 141 void *eih_tag; 142 struct resource *eih_res; 143}; 144 145struct sfxge_intr { 146 enum sfxge_intr_state state; 147 struct resource *msix_res; 148 struct sfxge_intr_hdl *table; 149 int n_alloc; 150 int type; 151 efsys_mem_t status; 152 uint32_t zero_count; 153}; 154 155enum sfxge_mcdi_state { 156 SFXGE_MCDI_UNINITIALIZED = 0, 157 SFXGE_MCDI_INITIALIZED, 158 SFXGE_MCDI_BUSY, 159 SFXGE_MCDI_COMPLETED 160}; 161 162struct sfxge_mcdi { 163 struct mtx lock; 164 struct cv cv; 165 enum sfxge_mcdi_state state; 166 efx_mcdi_transport_t transport; 167 168 /* Only used in debugging output */ 169 char lock_name[SFXGE_LOCK_NAME_MAX]; 170}; 171 172struct sfxge_hw_stats { 173 clock_t update_time; 174 efsys_mem_t dma_buf; 175 void *decode_buf; 176}; 177 178enum sfxge_port_state { 179 SFXGE_PORT_UNINITIALIZED = 0, 180 SFXGE_PORT_INITIALIZED, 181 SFXGE_PORT_STARTED 182}; 183 184struct sfxge_port { 185 struct sfxge_softc *sc; 186 struct mtx lock; 187 enum sfxge_port_state init_state; 188#ifndef SFXGE_HAVE_PAUSE_MEDIAOPTS 189 unsigned int wanted_fc; 190#endif 191 struct sfxge_hw_stats phy_stats; 192 struct sfxge_hw_stats mac_stats; 193 efx_link_mode_t link_mode; 194 195 /* Only used in debugging output */ 196 char lock_name[SFXGE_LOCK_NAME_MAX]; 197}; 198 199enum sfxge_softc_state { 200 SFXGE_UNINITIALIZED = 0, 201 SFXGE_INITIALIZED, 202 SFXGE_REGISTERED, 203 SFXGE_STARTED 204}; 205 206struct sfxge_softc { 207 device_t dev; 208 struct sx softc_lock; 209 char softc_lock_name[SFXGE_LOCK_NAME_MAX]; 210 enum sfxge_softc_state init_state; 211 struct ifnet *ifnet; 212 unsigned int if_flags; 213 struct sysctl_oid *stats_node; 214 struct sysctl_oid *txqs_node; 215 216 struct task task_reset; 217 218 efx_family_t family; 219 caddr_t vpd_data; 220 size_t vpd_size; 221 efx_nic_t *enp; 222 efsys_lock_t enp_lock; 223 224 unsigned int rxq_entries; 225 unsigned int txq_entries; 226 227 bus_dma_tag_t parent_dma_tag; 228 efsys_bar_t bar; 229 230 struct sfxge_intr intr; 231 struct sfxge_mcdi mcdi; 232 struct sfxge_port port; 233 uint32_t buffer_table_next; 234 235 struct sfxge_evq *evq[SFXGE_RX_SCALE_MAX]; 236 unsigned int ev_moderation; 237#if EFSYS_OPT_QSTATS 238 clock_t ev_stats_update_time; 239 uint64_t ev_stats[EV_NQSTATS]; 240#endif 241 242 unsigned int max_rss_channels; 243 uma_zone_t rxq_cache; 244 struct sfxge_rxq *rxq[SFXGE_RX_SCALE_MAX]; 245 unsigned int rx_indir_table[SFXGE_RX_SCALE_MAX]; 246 247 struct sfxge_txq *txq[SFXGE_TXQ_NTYPES + SFXGE_RX_SCALE_MAX]; 248 249 struct ifmedia media; 250 251 size_t rx_prefix_size; 252 size_t rx_buffer_size; 253 uma_zone_t rx_buffer_zone; 254 255 unsigned int evq_count; 256 unsigned int rxq_count; 257 unsigned int txq_count; 258}; 259 260#define SFXGE_LINK_UP(sc) ((sc)->port.link_mode != EFX_LINK_DOWN) 261#define SFXGE_RUNNING(sc) ((sc)->ifnet->if_drv_flags & IFF_DRV_RUNNING) 262 263#define SFXGE_PARAM(_name) "hw.sfxge." #_name 264 265SYSCTL_DECL(_hw_sfxge); 266 267/* 268 * From sfxge.c. 269 */ 270extern void sfxge_schedule_reset(struct sfxge_softc *sc); 271extern void sfxge_sram_buf_tbl_alloc(struct sfxge_softc *sc, size_t n, 272 uint32_t *idp); 273 274/* 275 * From sfxge_dma.c. 276 */ 277extern int sfxge_dma_init(struct sfxge_softc *sc); 278extern void sfxge_dma_fini(struct sfxge_softc *sc); 279extern int sfxge_dma_alloc(struct sfxge_softc *sc, bus_size_t len, 280 efsys_mem_t *esmp); 281extern void sfxge_dma_free(efsys_mem_t *esmp); 282extern int sfxge_dma_map_sg_collapse(bus_dma_tag_t tag, bus_dmamap_t map, 283 struct mbuf **mp, bus_dma_segment_t *segs, int *nsegs, int maxsegs); 284 285/* 286 * From sfxge_ev.c. 287 */ 288extern int sfxge_ev_init(struct sfxge_softc *sc); 289extern void sfxge_ev_fini(struct sfxge_softc *sc); 290extern int sfxge_ev_start(struct sfxge_softc *sc); 291extern void sfxge_ev_stop(struct sfxge_softc *sc); 292extern int sfxge_ev_qpoll(struct sfxge_evq *evq); 293 294/* 295 * From sfxge_intr.c. 296 */ 297extern int sfxge_intr_init(struct sfxge_softc *sc); 298extern void sfxge_intr_fini(struct sfxge_softc *sc); 299extern int sfxge_intr_start(struct sfxge_softc *sc); 300extern void sfxge_intr_stop(struct sfxge_softc *sc); 301 302/* 303 * From sfxge_mcdi.c. 304 */ 305extern int sfxge_mcdi_init(struct sfxge_softc *sc); 306extern void sfxge_mcdi_fini(struct sfxge_softc *sc); 307 308/* 309 * From sfxge_port.c. 310 */ 311extern int sfxge_port_init(struct sfxge_softc *sc); 312extern void sfxge_port_fini(struct sfxge_softc *sc); 313extern int sfxge_port_start(struct sfxge_softc *sc); 314extern void sfxge_port_stop(struct sfxge_softc *sc); 315extern void sfxge_mac_link_update(struct sfxge_softc *sc, 316 efx_link_mode_t mode); 317extern int sfxge_mac_filter_set(struct sfxge_softc *sc); 318extern int sfxge_port_ifmedia_init(struct sfxge_softc *sc); 319extern uint64_t sfxge_get_counter(struct ifnet *ifp, ift_counter c); 320 321#define SFXGE_MAX_MTU (9 * 1024) 322 323#define SFXGE_ADAPTER_LOCK_INIT(_sc, _ifname) \ 324 do { \ 325 struct sfxge_softc *__sc = (_sc); \ 326 \ 327 snprintf((__sc)->softc_lock_name, \ 328 sizeof((__sc)->softc_lock_name), \ 329 "%s:softc", (_ifname)); \ 330 sx_init(&(__sc)->softc_lock, (__sc)->softc_lock_name); \ 331 } while (B_FALSE) 332#define SFXGE_ADAPTER_LOCK_DESTROY(_sc) \ 333 sx_destroy(&(_sc)->softc_lock) 334#define SFXGE_ADAPTER_LOCK(_sc) \ 335 sx_xlock(&(_sc)->softc_lock) 336#define SFXGE_ADAPTER_UNLOCK(_sc) \ 337 sx_xunlock(&(_sc)->softc_lock) 338#define SFXGE_ADAPTER_LOCK_ASSERT_OWNED(_sc) \ 339 sx_assert(&(_sc)->softc_lock, LA_XLOCKED) 340 341#define SFXGE_PORT_LOCK_INIT(_port, _ifname) \ 342 do { \ 343 struct sfxge_port *__port = (_port); \ 344 \ 345 snprintf((__port)->lock_name, \ 346 sizeof((__port)->lock_name), \ 347 "%s:port", (_ifname)); \ 348 mtx_init(&(__port)->lock, (__port)->lock_name, \ 349 NULL, MTX_DEF); \ 350 } while (B_FALSE) 351#define SFXGE_PORT_LOCK_DESTROY(_port) \ 352 mtx_destroy(&(_port)->lock) 353#define SFXGE_PORT_LOCK(_port) \ 354 mtx_lock(&(_port)->lock) 355#define SFXGE_PORT_UNLOCK(_port) \ 356 mtx_unlock(&(_port)->lock) 357#define SFXGE_PORT_LOCK_ASSERT_OWNED(_port) \ 358 mtx_assert(&(_port)->lock, MA_OWNED) 359 360#define SFXGE_MCDI_LOCK_INIT(_mcdi, _ifname) \ 361 do { \ 362 struct sfxge_mcdi *__mcdi = (_mcdi); \ 363 \ 364 snprintf((__mcdi)->lock_name, \ 365 sizeof((__mcdi)->lock_name), \ 366 "%s:mcdi", (_ifname)); \ 367 mtx_init(&(__mcdi)->lock, (__mcdi)->lock_name, \ 368 NULL, MTX_DEF); \ 369 } while (B_FALSE) 370#define SFXGE_MCDI_LOCK_DESTROY(_mcdi) \ 371 mtx_destroy(&(_mcdi)->lock) 372#define SFXGE_MCDI_LOCK(_mcdi) \ 373 mtx_lock(&(_mcdi)->lock) 374#define SFXGE_MCDI_UNLOCK(_mcdi) \ 375 mtx_unlock(&(_mcdi)->lock) 376#define SFXGE_MCDI_LOCK_ASSERT_OWNED(_mcdi) \ 377 mtx_assert(&(_mcdi)->lock, MA_OWNED) 378 379#define SFXGE_EVQ_LOCK_INIT(_evq, _ifname, _evq_index) \ 380 do { \ 381 struct sfxge_evq *__evq = (_evq); \ 382 \ 383 snprintf((__evq)->lock_name, \ 384 sizeof((__evq)->lock_name), \ 385 "%s:evq%u", (_ifname), (_evq_index)); \ 386 mtx_init(&(__evq)->lock, (__evq)->lock_name, \ 387 NULL, MTX_DEF); \ 388 } while (B_FALSE) 389#define SFXGE_EVQ_LOCK_DESTROY(_evq) \ 390 mtx_destroy(&(_evq)->lock) 391#define SFXGE_EVQ_LOCK(_evq) \ 392 mtx_lock(&(_evq)->lock) 393#define SFXGE_EVQ_UNLOCK(_evq) \ 394 mtx_unlock(&(_evq)->lock) 395#define SFXGE_EVQ_LOCK_ASSERT_OWNED(_evq) \ 396 mtx_assert(&(_evq)->lock, MA_OWNED) 397 398#endif /* _SFXGE_H */ 399