if_em.h revision 1.16
1/************************************************************************** 2 3Copyright (c) 2001-2003, Intel Corporation 4All rights reserved. 5 6Redistribution and use in source and binary forms, with or without 7modification, are permitted provided that the following conditions are met: 8 9 1. Redistributions of source code must retain the above copyright notice, 10 this list of conditions and the following disclaimer. 11 12 2. Redistributions in binary form must reproduce the above copyright 13 notice, this list of conditions and the following disclaimer in the 14 documentation and/or other materials provided with the distribution. 15 16 3. Neither the name of the Intel Corporation nor the names of its 17 contributors may be used to endorse or promote products derived from 18 this software without specific prior written permission. 19 20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30POSSIBILITY OF SUCH DAMAGE. 31 32***************************************************************************/ 33 34/* $FreeBSD: if_em.h,v 1.26 2004/09/01 23:22:41 pdeuskar Exp $ */ 35/* $OpenBSD: if_em.h,v 1.16 2005/10/21 02:10:34 brad Exp $ */ 36 37#ifndef _EM_H_DEFINED_ 38#define _EM_H_DEFINED_ 39 40#include "bpfilter.h" 41#include "vlan.h" 42 43#include <sys/param.h> 44#include <sys/systm.h> 45#include <sys/sockio.h> 46#include <sys/mbuf.h> 47#include <sys/malloc.h> 48#include <sys/kernel.h> 49#include <sys/device.h> 50#include <sys/socket.h> 51 52#include <net/if.h> 53#include <net/if_dl.h> 54#include <net/if_media.h> 55 56#ifdef INET 57#include <netinet/in.h> 58#include <netinet/in_systm.h> 59#include <netinet/in_var.h> 60#include <netinet/ip.h> 61#include <netinet/if_ether.h> 62#include <netinet/tcp.h> 63#include <netinet/udp.h> 64#endif 65 66#if NVLAN > 0 67#include <net/if_types.h> 68#include <net/if_vlan_var.h> 69#endif 70 71#if NBPFILTER > 0 72#include <net/bpf.h> 73#endif 74 75#include <uvm/uvm_extern.h> 76 77#include <dev/pci/pcireg.h> 78#include <dev/pci/pcivar.h> 79#include <dev/pci/pcidevs.h> 80 81#include <dev/pci/if_em_hw.h> 82 83/* Tunables */ 84 85/* 86 * EM_MAX_TXD: Maximum number of Transmit Descriptors 87 * Valid Range: 80-256 for 82542 and 82543-based adapters 88 * 80-4096 for others 89 * Default Value: 256 90 * This value is the number of transmit descriptors allocated by the driver. 91 * Increasing this value allows the driver to queue more transmits. Each 92 * descriptor is 16 bytes. 93 */ 94#define EM_MIN_TXD 12 95#define EM_MAX_TXD 256 96 97/* 98 * EM_MAX_RXD - Maximum number of receive Descriptors 99 * Valid Range: 80-256 for 82542 and 82543-based adapters 100 * 80-4096 for others 101 * Default Value: 256 102 * This value is the number of receive descriptors allocated by the driver. 103 * Increasing this value allows the driver to buffer more incoming packets. 104 * Each descriptor is 16 bytes. A receive buffer is also allocated for each 105 * descriptor. The maximum MTU size is 16110. 106 * 107 */ 108#define EM_MIN_RXD 12 109#define EM_MAX_RXD 256 110 111/* 112 * EM_TIDV - Transmit Interrupt Delay Value 113 * Valid Range: 0-65535 (0=off) 114 * Default Value: 64 115 * This value delays the generation of transmit interrupts in units of 116 * 1.024 microseconds. Transmit interrupt reduction can improve CPU 117 * efficiency if properly tuned for specific network traffic. If the 118 * system is reporting dropped transmits, this value may be set too high 119 * causing the driver to run out of available transmit descriptors. 120 */ 121#define EM_TIDV 64 122 123/* 124 * EM_TADV - Transmit Absolute Interrupt Delay Value (Not valid for 82542/82543/82544) 125 * Valid Range: 0-65535 (0=off) 126 * Default Value: 64 127 * This value, in units of 1.024 microseconds, limits the delay in which a 128 * transmit interrupt is generated. Useful only if EM_TIDV is non-zero, 129 * this value ensures that an interrupt is generated after the initial 130 * packet is sent on the wire within the set amount of time. Proper tuning, 131 * along with EM_TIDV, may improve traffic throughput in specific 132 * network conditions. 133 */ 134#define EM_TADV 64 135 136/* 137 * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer) 138 * Valid Range: 0-65535 (0=off) 139 * Default Value: 0 140 * This value delays the generation of receive interrupts in units of 1.024 141 * microseconds. Receive interrupt reduction can improve CPU efficiency if 142 * properly tuned for specific network traffic. Increasing this value adds 143 * extra latency to frame reception and can end up decreasing the throughput 144 * of TCP traffic. If the system is reporting dropped receives, this value 145 * may be set too high, causing the driver to run out of available receive 146 * descriptors. 147 * 148 * CAUTION: When setting EM_RDTR to a value other than 0, adapters 149 * may hang (stop transmitting) under certain network conditions. 150 * If this occurs a WATCHDOG message is logged in the system event log. 151 * In addition, the controller is automatically reset, restoring the 152 * network connection. To eliminate the potential for the hang 153 * ensure that EM_RDTR is set to 0. 154 */ 155#define EM_RDTR 0 156 157/* 158 * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544) 159 * Valid Range: 0-65535 (0=off) 160 * Default Value: 64 161 * This value, in units of 1.024 microseconds, limits the delay in which a 162 * receive interrupt is generated. Useful only if EM_RDTR is non-zero, 163 * this value ensures that an interrupt is generated after the initial 164 * packet is received within the set amount of time. Proper tuning, 165 * along with EM_RDTR, may improve traffic throughput in specific network 166 * conditions. 167 */ 168#define EM_RADV 64 169 170/* 171 * This parameter controls the maximum no of times the driver will loop 172 * in the isr. 173 * Minimum Value = 1 174 */ 175#define EM_MAX_INTR 3 176 177/* 178 * This parameter controls the duration of transmit watchdog timer. 179 */ 180#define EM_TX_TIMEOUT 5 /* set to 5 seconds */ 181 182/* 183 * This parameter controls when the driver calls the routine to reclaim 184 * transmit descriptors. 185 */ 186#define EM_TX_CLEANUP_THRESHOLD EM_MAX_TXD / 8 187 188/* 189 * This parameter controls whether or not autonegotation is enabled. 190 * 0 - Disable autonegotiation 191 * 1 - Enable autonegotiation 192 */ 193#define DO_AUTO_NEG 1 194 195/* 196 * This parameter control whether or not the driver will wait for 197 * autonegotiation to complete. 198 * 1 - Wait for autonegotiation to complete 199 * 0 - Don't wait for autonegotiation to complete 200 */ 201#define WAIT_FOR_AUTO_NEG_DEFAULT 0 202 203/* 204 * EM_MASTER_SLAVE is only defined to enable a workaround for a known compatibility issue 205 * with 82541/82547 devices and some switches. See the "Known Limitations" section of 206 * the README file for a complete description and a list of affected switches. 207 * 208 * 0 = Hardware default 209 * 1 = Master mode 210 * 2 = Slave mode 211 * 3 = Auto master/slave 212 */ 213/* #define EM_MASTER_SLAVE 2 */ 214 215/* Tunables -- End */ 216 217#define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \ 218 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \ 219 ADVERTISE_1000_FULL) 220 221#define EM_MMBA 0x0010 /* Mem base address */ 222#define EM_ROUNDUP(size, unit) (((size) + (unit) - 1) & ~((unit) - 1)) 223 224#define EM_JUMBO_PBA 0x00000028 225#define EM_DEFAULT_PBA 0x00000030 226#define EM_SMARTSPEED_DOWNSHIFT 3 227#define EM_SMARTSPEED_MAX 15 228 229#define MAX_NUM_MULTICAST_ADDRESSES 128 230 231/* Defines for printing debug information */ 232#define DEBUG_INIT 0 233#define DEBUG_IOCTL 0 234#define DEBUG_HW 0 235 236#define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n") 237#define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A) 238#define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B) 239#define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n") 240#define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A) 241#define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B) 242#define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n") 243#define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A) 244#define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B) 245 246/* Supported RX Buffer Sizes */ 247#define EM_RXBUFFER_2048 2048 248#define EM_RXBUFFER_4096 4096 249#define EM_RXBUFFER_8192 8192 250#define EM_RXBUFFER_16384 16384 251 252#define EM_MAX_SCATTER 64 253 254struct em_buffer { 255 struct mbuf *m_head; 256 bus_dmamap_t map; /* bus_dma map for packet */ 257}; 258 259struct em_q { 260 bus_dmamap_t map; /* bus_dma map for packet */ 261}; 262 263/* 264 * Bus dma allocation structure used by 265 * em_dma_malloc and em_dma_free. 266 */ 267struct em_dma_alloc { 268 bus_addr_t dma_paddr; 269 caddr_t dma_vaddr; 270 bus_dma_tag_t dma_tag; 271 bus_dmamap_t dma_map; 272 bus_dma_segment_t dma_seg; 273 bus_size_t dma_size; 274 int dma_nseg; 275}; 276 277typedef enum _XSUM_CONTEXT_T { 278 OFFLOAD_NONE, 279 OFFLOAD_TCP_IP, 280 OFFLOAD_UDP_IP 281} XSUM_CONTEXT_T; 282 283/* For 82544 PCIX Workaround */ 284typedef struct _ADDRESS_LENGTH_PAIR 285{ 286 u_int64_t address; 287 u_int32_t length; 288} ADDRESS_LENGTH_PAIR, *PADDRESS_LENGTH_PAIR; 289 290typedef struct _DESCRIPTOR_PAIR 291{ 292 ADDRESS_LENGTH_PAIR descriptor[4]; 293 u_int32_t elements; 294} DESC_ARRAY, *PDESC_ARRAY; 295 296/* Our adapter structure */ 297struct em_softc { 298 struct device sc_dv; 299 struct arpcom interface_data; 300 struct em_hw hw; 301 302 /* OpenBSD operating-system-specific structures */ 303 struct em_osdep osdep; 304 struct ifmedia media; 305 int io_rid; 306 307 void *sc_intrhand; 308 struct timeout em_intr_enable; 309 struct timeout timer_handle; 310 struct timeout tx_fifo_timer_handle; 311 void *sc_powerhook; 312 313#ifdef __STRICT_ALIGNMENT 314 /* Used for carrying forward alignment adjustments */ 315 unsigned char align_buf[ETHER_ALIGN]; /* tail of unaligned packet */ 316 u_int8_t align_buf_len; /* bytes in tail */ 317#endif /* __STRICT_ALIGNMENT */ 318 319 /* Info about the board itself */ 320 u_int32_t part_num; 321 u_int8_t link_active; 322 u_int16_t link_speed; 323 u_int16_t link_duplex; 324 u_int32_t smartspeed; 325 u_int32_t tx_int_delay; 326 u_int32_t tx_abs_int_delay; 327 u_int32_t rx_int_delay; 328 u_int32_t rx_abs_int_delay; 329 330 XSUM_CONTEXT_T active_checksum_context; 331 332 /* 333 * Transmit definitions 334 * 335 * We have an array of num_tx_desc descriptors (handled 336 * by the controller) paired with an array of tx_buffers 337 * (at tx_buffer_area). 338 * The index of the next available descriptor is next_avail_tx_desc. 339 * The number of remaining tx_desc is num_tx_desc_avail. 340 */ 341 struct em_dma_alloc txdma; /* bus_dma glue for tx desc */ 342 struct em_tx_desc *tx_desc_base; 343 u_int32_t next_avail_tx_desc; 344 u_int32_t oldest_used_tx_desc; 345 volatile u_int16_t num_tx_desc_avail; 346 u_int16_t num_tx_desc; 347 u_int32_t txd_cmd; 348 struct em_buffer *tx_buffer_area; 349 bus_dma_tag_t txtag; /* dma tag for tx */ 350 351 /* 352 * Receive definitions 353 * 354 * we have an array of num_rx_desc rx_desc (handled by the 355 * controller), and paired with an array of rx_buffers 356 * (at rx_buffer_area). 357 * The next pair to check on receive is at offset next_rx_desc_to_check 358 */ 359 struct em_dma_alloc rxdma; /* bus_dma glue for rx desc */ 360 struct em_rx_desc *rx_desc_base; 361 u_int32_t next_rx_desc_to_check; 362 u_int16_t num_rx_desc; 363 u_int32_t rx_buffer_len; 364 struct em_buffer *rx_buffer_area; 365 bus_dma_tag_t rxtag; 366 367 /* Jumbo frame */ 368 struct mbuf *fmp; 369 struct mbuf *lmp; 370 371 /* Misc stats maintained by the driver */ 372 unsigned long dropped_pkts; 373 unsigned long mbuf_alloc_failed; 374 unsigned long mbuf_cluster_failed; 375 unsigned long no_tx_desc_avail1; 376 unsigned long no_tx_desc_avail2; 377 unsigned long no_tx_map_avail; 378 unsigned long no_tx_dma_setup; 379 380 /* Used in for 82547 10Mb Half workaround */ 381 #define EM_PBA_BYTES_SHIFT 0xA 382 #define EM_TX_HEAD_ADDR_SHIFT 7 383 #define EM_PBA_TX_MASK 0xFFFF0000 384 #define EM_FIFO_HDR 0x10 385 386 #define EM_82547_PKT_THRESH 0x3e0 387 388 u_int32_t tx_fifo_size; 389 u_int32_t tx_fifo_head; 390 u_int32_t tx_fifo_head_addr; 391 u_int64_t tx_fifo_reset_cnt; 392 u_int64_t tx_fifo_wrk_cnt; 393 u_int32_t tx_head_addr; 394 395 /* For 82544 PCIX Workaround */ 396 boolean_t pcix_82544; 397 boolean_t in_detach; 398 399 struct em_hw_stats stats; 400}; 401 402#endif /* _EM_H_DEFINED_ */ 403