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