1 /****************************************************************************** 2 3 Copyright (c) 2001-2008, Intel Corporation 4 All rights reserved. 5 6 Redistribution and use in source and binary forms, with or without 7 modification, 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 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 POSSIBILITY OF SUCH DAMAGE. 31 32 ******************************************************************************/ 33 /*$FreeBSD$*/ 34 35 36 #ifndef _EM_H_DEFINED_ 37 #define _EM_H_DEFINED_ 38 39 #define IFNET_BUF_RING 40 /* Tunables */ 41 42 /* 43 * EM_TXD: Maximum number of Transmit Descriptors 44 * Valid Range: 80-256 for 82542 and 82543-based adapters 45 * 80-4096 for others 46 * Default Value: 256 47 * This value is the number of transmit descriptors allocated by the driver. 48 * Increasing this value allows the driver to queue more transmits. Each 49 * descriptor is 16 bytes. 50 * Since TDLEN should be multiple of 128bytes, the number of transmit 51 * desscriptors should meet the following condition. 52 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0 53 */ 54 #define EM_MIN_TXD 80 55 #define EM_MAX_TXD_82543 256 56 #define EM_MAX_TXD 4096 57 #define EM_DEFAULT_TXD EM_MAX_TXD_82543 58 59 /* 60 * EM_RXD - Maximum number of receive Descriptors 61 * Valid Range: 80-256 for 82542 and 82543-based adapters 62 * 80-4096 for others 63 * Default Value: 256 64 * This value is the number of receive descriptors allocated by the driver. 65 * Increasing this value allows the driver to buffer more incoming packets. 66 * Each descriptor is 16 bytes. A receive buffer is also allocated for each 67 * descriptor. The maximum MTU size is 16110. 68 * Since TDLEN should be multiple of 128bytes, the number of transmit 69 * desscriptors should meet the following condition. 70 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0 71 */ 72 #define EM_MIN_RXD 80 73 #define EM_MAX_RXD_82543 256 74 #define EM_MAX_RXD 4096 75 #define EM_DEFAULT_RXD EM_MAX_RXD_82543 76 77 /* 78 * EM_TIDV - Transmit Interrupt Delay Value 79 * Valid Range: 0-65535 (0=off) 80 * Default Value: 64 81 * This value delays the generation of transmit interrupts in units of 82 * 1.024 microseconds. Transmit interrupt reduction can improve CPU 83 * efficiency if properly tuned for specific network traffic. If the 84 * system is reporting dropped transmits, this value may be set too high 85 * causing the driver to run out of available transmit descriptors. 86 */ 87 #define EM_TIDV 64 88 89 /* 90 * EM_TADV - Transmit Absolute Interrupt Delay Value 91 * (Not valid for 82542/82543/82544) 92 * Valid Range: 0-65535 (0=off) 93 * Default Value: 64 94 * This value, in units of 1.024 microseconds, limits the delay in which a 95 * transmit interrupt is generated. Useful only if EM_TIDV is non-zero, 96 * this value ensures that an interrupt is generated after the initial 97 * packet is sent on the wire within the set amount of time. Proper tuning, 98 * along with EM_TIDV, may improve traffic throughput in specific 99 * network conditions. 100 */ 101 #define EM_TADV 64 102 103 /* 104 * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer) 105 * Valid Range: 0-65535 (0=off) 106 * Default Value: 0 107 * This value delays the generation of receive interrupts in units of 1.024 108 * microseconds. Receive interrupt reduction can improve CPU efficiency if 109 * properly tuned for specific network traffic. Increasing this value adds 110 * extra latency to frame reception and can end up decreasing the throughput 111 * of TCP traffic. If the system is reporting dropped receives, this value 112 * may be set too high, causing the driver to run out of available receive 113 * descriptors. 114 * 115 * CAUTION: When setting EM_RDTR to a value other than 0, adapters 116 * may hang (stop transmitting) under certain network conditions. 117 * If this occurs a WATCHDOG message is logged in the system 118 * event log. In addition, the controller is automatically reset, 119 * restoring the network connection. To eliminate the potential 120 * for the hang ensure that EM_RDTR is set to 0. 121 */ 122 #define EM_RDTR 0 123 124 /* 125 * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544) 126 * Valid Range: 0-65535 (0=off) 127 * Default Value: 64 128 * This value, in units of 1.024 microseconds, limits the delay in which a 129 * receive interrupt is generated. Useful only if EM_RDTR is non-zero, 130 * this value ensures that an interrupt is generated after the initial 131 * packet is received within the set amount of time. Proper tuning, 132 * along with EM_RDTR, may improve traffic throughput in specific network 133 * conditions. 134 */ 135 #define EM_RADV 64 136 137 /* 138 * This parameter controls the duration of transmit watchdog timer. 139 */ 140 #define EM_TX_TIMEOUT 5 141 142 /* 143 * This parameter controls when the driver calls the routine to reclaim 144 * transmit descriptors. 145 */ 146 #define EM_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8) 147 #define EM_TX_OP_THRESHOLD (adapter->num_tx_desc / 32) 148 149 /* 150 * This parameter controls whether or not autonegotation is enabled. 151 * 0 - Disable autonegotiation 152 * 1 - Enable autonegotiation 153 */ 154 #define DO_AUTO_NEG 1 155 156 /* 157 * This parameter control whether or not the driver will wait for 158 * autonegotiation to complete. 159 * 1 - Wait for autonegotiation to complete 160 * 0 - Don't wait for autonegotiation to complete 161 */ 162 #define WAIT_FOR_AUTO_NEG_DEFAULT 0 163 164 /* Tunables -- End */ 165 166 #define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \ 167 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \ 168 ADVERTISE_1000_FULL) 169 170 #define AUTO_ALL_MODES 0 171 172 /* PHY master/slave setting */ 173 #define EM_MASTER_SLAVE e1000_ms_hw_default 174 175 /* 176 * Micellaneous constants 177 */ 178 #define EM_VENDOR_ID 0x8086 179 #define EM_FLASH 0x0014 180 181 #define EM_JUMBO_PBA 0x00000028 182 #define EM_DEFAULT_PBA 0x00000030 183 #define EM_SMARTSPEED_DOWNSHIFT 3 184 #define EM_SMARTSPEED_MAX 15 185 #define EM_MAX_INTR 10 186 187 #define MAX_NUM_MULTICAST_ADDRESSES 128 188 #define PCI_ANY_ID (~0U) 189 #define ETHER_ALIGN 2 190 #define EM_FC_PAUSE_TIME 0x0680 191 #define EM_EEPROM_APME 0x400; 192 193 /* Code compatilbility between 6 and 7 */ 194 #ifndef ETHER_BPF_MTAP 195 #define ETHER_BPF_MTAP BPF_MTAP 196 #endif 197 198 /* 199 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be 200 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will 201 * also optimize cache line size effect. H/W supports up to cache line size 128. 202 */ 203 #define EM_DBA_ALIGN 128 204 205 #define SPEED_MODE_BIT (1<<21) /* On PCI-E MACs only */ 206 207 /* PCI Config defines */ 208 #define EM_BAR_TYPE(v) ((v) & EM_BAR_TYPE_MASK) 209 #define EM_BAR_TYPE_MASK 0x00000001 210 #define EM_BAR_TYPE_MMEM 0x00000000 211 #define EM_BAR_TYPE_IO 0x00000001 212 #define EM_BAR_TYPE_FLASH 0x0014 213 #define EM_BAR_MEM_TYPE(v) ((v) & EM_BAR_MEM_TYPE_MASK) 214 #define EM_BAR_MEM_TYPE_MASK 0x00000006 215 #define EM_BAR_MEM_TYPE_32BIT 0x00000000 216 #define EM_BAR_MEM_TYPE_64BIT 0x00000004 217 #define EM_MSIX_BAR 3 /* On 82575 */ 218 219 /* Defines for printing debug information */ 220 #define DEBUG_INIT 0 221 #define DEBUG_IOCTL 0 222 #define DEBUG_HW 0 223 224 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n") 225 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A) 226 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B) 227 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n") 228 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A) 229 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B) 230 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n") 231 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A) 232 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B) 233 234 #define EM_MAX_SCATTER 64 235 #define EM_TSO_SIZE (65535 + sizeof(struct ether_vlan_header)) 236 #define EM_TSO_SEG_SIZE 4096 /* Max dma segment size */ 237 #define EM_MSIX_MASK 0x01F00000 /* For 82574 use */ 238 #define ETH_ZLEN 60 239 #define ETH_ADDR_LEN 6 240 #define CSUM_OFFLOAD 7 /* Offload bits in mbuf flag */ 241 242 /* 243 * 82574 has a nonstandard address for EIAC 244 * and since its only used in MSIX, and in 245 * the em driver only 82574 uses MSIX we can 246 * solve it just using this define. 247 */ 248 #define EM_EIAC 0x000DC 249 250 /* Used in for 82547 10Mb Half workaround */ 251 #define EM_PBA_BYTES_SHIFT 0xA 252 #define EM_TX_HEAD_ADDR_SHIFT 7 253 #define EM_PBA_TX_MASK 0xFFFF0000 254 #define EM_FIFO_HDR 0x10 255 #define EM_82547_PKT_THRESH 0x3e0 256 257 #ifdef EM_TIMESYNC 258 /* Precision Time Sync (IEEE 1588) defines */ 259 #define ETHERTYPE_IEEE1588 0x88F7 260 #define PICOSECS_PER_TICK 20833 261 #define TSYNC_PORT 319 /* UDP port for the protocol */ 262 263 /* TIMESYNC IOCTL defines */ 264 #define EM_TIMESYNC_READTS _IOWR('i', 127, struct em_tsync_read) 265 266 /* Used in the READTS IOCTL */ 267 struct em_tsync_read { 268 int read_current_time; 269 struct timespec system_time; 270 u64 network_time; 271 u64 rx_stamp; 272 u64 tx_stamp; 273 u16 seqid; 274 unsigned char srcid[6]; 275 int rx_valid; 276 int tx_valid; 277 }; 278 279 #endif /* EM_TIMESYNC */ 280 281 struct adapter; 282 283 struct em_int_delay_info { 284 struct adapter *adapter; /* Back-pointer to the adapter struct */ 285 int offset; /* Register offset to read/write */ 286 int value; /* Current value in usecs */ 287 }; 288 289 /* 290 * Bus dma allocation structure used by 291 * e1000_dma_malloc and e1000_dma_free. 292 */ 293 struct em_dma_alloc { 294 bus_addr_t dma_paddr; 295 caddr_t dma_vaddr; 296 bus_dma_tag_t dma_tag; 297 bus_dmamap_t dma_map; 298 bus_dma_segment_t dma_seg; 299 int dma_nseg; 300 }; 301 302 /* Our adapter structure */ 303 struct adapter { 304 struct ifnet *ifp; 305 #ifdef IFNET_BUF_RING 306 struct buf_ring *br; 307 #else 308 void *br; 309 #endif 310 struct e1000_hw hw; 311 312 /* FreeBSD operating-system-specific structures. */ 313 struct e1000_osdep osdep; 314 struct device *dev; 315 316 struct resource *memory; 317 struct resource *flash; 318 struct resource *msix; 319 320 struct resource *ioport; 321 int io_rid; 322 323 /* 82574 uses 3 int vectors */ 324 struct resource *res[3]; 325 void *tag[3]; 326 int rid[3]; 327 328 struct ifmedia media; 329 struct callout timer; 330 struct callout tx_fifo_timer; 331 int watchdog_timer; 332 int msi; 333 int if_flags; 334 int max_frame_size; 335 int min_frame_size; 336 struct mtx core_mtx; 337 struct mtx tx_mtx; 338 struct mtx rx_mtx; 339 int em_insert_vlan_header; 340 341 /* Task for FAST handling */ 342 struct task link_task; 343 struct task rxtx_task; 344 struct task rx_task; 345 struct task tx_task; 346 struct taskqueue *tq; /* private task queue */ 347 348 eventhandler_tag vlan_attach; 349 eventhandler_tag vlan_detach; 350 351 /* Management and WOL features */ 352 int wol; 353 int has_manage; 354 355 /* Info about the board itself */ 356 uint8_t link_active; 357 uint16_t link_speed; 358 uint16_t link_duplex; 359 uint32_t smartspeed; 360 struct em_int_delay_info tx_int_delay; 361 struct em_int_delay_info tx_abs_int_delay; 362 struct em_int_delay_info rx_int_delay; 363 struct em_int_delay_info rx_abs_int_delay; 364 365 /* 366 * Transmit definitions 367 * 368 * We have an array of num_tx_desc descriptors (handled 369 * by the controller) paired with an array of tx_buffers 370 * (at tx_buffer_area). 371 * The index of the next available descriptor is next_avail_tx_desc. 372 * The number of remaining tx_desc is num_tx_desc_avail. 373 */ 374 struct em_dma_alloc txdma; /* bus_dma glue for tx desc */ 375 struct e1000_tx_desc *tx_desc_base; 376 uint32_t next_avail_tx_desc; 377 uint32_t next_tx_to_clean; 378 volatile uint16_t num_tx_desc_avail; 379 uint16_t num_tx_desc; 380 uint32_t txd_cmd; 381 struct em_buffer *tx_buffer_area; 382 bus_dma_tag_t txtag; /* dma tag for tx */ 383 uint32_t tx_tso; /* last tx was tso */ 384 385 /* 386 * Receive definitions 387 * 388 * we have an array of num_rx_desc rx_desc (handled by the 389 * controller), and paired with an array of rx_buffers 390 * (at rx_buffer_area). 391 * The next pair to check on receive is at offset next_rx_desc_to_check 392 */ 393 struct em_dma_alloc rxdma; /* bus_dma glue for rx desc */ 394 struct e1000_rx_desc *rx_desc_base; 395 uint32_t next_rx_desc_to_check; 396 uint32_t rx_buffer_len; 397 uint16_t num_rx_desc; 398 int rx_process_limit; 399 struct em_buffer *rx_buffer_area; 400 bus_dma_tag_t rxtag; 401 bus_dmamap_t rx_sparemap; 402 403 /* 404 * First/last mbuf pointers, for 405 * collecting multisegment RX packets. 406 */ 407 struct mbuf *fmp; 408 struct mbuf *lmp; 409 410 /* Misc stats maintained by the driver */ 411 unsigned long dropped_pkts; 412 unsigned long mbuf_alloc_failed; 413 unsigned long mbuf_cluster_failed; 414 unsigned long no_tx_desc_avail1; 415 unsigned long no_tx_desc_avail2; 416 unsigned long no_tx_map_avail; 417 unsigned long no_tx_dma_setup; 418 unsigned long watchdog_events; 419 unsigned long rx_overruns; 420 unsigned long rx_irq; 421 unsigned long tx_irq; 422 unsigned long link_irq; 423 424 /* 82547 workaround */ 425 uint32_t tx_fifo_size; 426 uint32_t tx_fifo_head; 427 uint32_t tx_fifo_head_addr; 428 uint64_t tx_fifo_reset_cnt; 429 uint64_t tx_fifo_wrk_cnt; 430 uint32_t tx_head_addr; 431 432 /* For 82544 PCIX Workaround */ 433 boolean_t pcix_82544; 434 boolean_t in_detach; 435 436 #ifdef EM_TIMESYNC 437 u64 last_stamp; 438 u64 last_sec; 439 u32 last_ns; 440 #endif 441 442 struct e1000_hw_stats stats; 443 }; 444 445 /* ****************************************************************************** 446 * vendor_info_array 447 * 448 * This array contains the list of Subvendor/Subdevice IDs on which the driver 449 * should load. 450 * 451 * ******************************************************************************/ 452 typedef struct _em_vendor_info_t { 453 unsigned int vendor_id; 454 unsigned int device_id; 455 unsigned int subvendor_id; 456 unsigned int subdevice_id; 457 unsigned int index; 458 } em_vendor_info_t; 459 460 461 struct em_buffer { 462 int next_eop; /* Index of the desc to watch */ 463 struct mbuf *m_head; 464 bus_dmamap_t map; /* bus_dma map for packet */ 465 }; 466 467 /* For 82544 PCIX Workaround */ 468 typedef struct _ADDRESS_LENGTH_PAIR 469 { 470 uint64_t address; 471 uint32_t length; 472 } ADDRESS_LENGTH_PAIR, *PADDRESS_LENGTH_PAIR; 473 474 typedef struct _DESCRIPTOR_PAIR 475 { 476 ADDRESS_LENGTH_PAIR descriptor[4]; 477 uint32_t elements; 478 } DESC_ARRAY, *PDESC_ARRAY; 479 480 #define EM_CORE_LOCK_INIT(_sc, _name) \ 481 mtx_init(&(_sc)->core_mtx, _name, "EM Core Lock", MTX_DEF) 482 #define EM_TX_LOCK_INIT(_sc, _name) \ 483 mtx_init(&(_sc)->tx_mtx, _name, "EM TX Lock", MTX_DEF) 484 #define EM_RX_LOCK_INIT(_sc, _name) \ 485 mtx_init(&(_sc)->rx_mtx, _name, "EM RX Lock", MTX_DEF) 486 #define EM_CORE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->core_mtx) 487 #define EM_TX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->tx_mtx) 488 #define EM_RX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->rx_mtx) 489 #define EM_CORE_LOCK(_sc) mtx_lock(&(_sc)->core_mtx) 490 #define EM_TX_LOCK(_sc) mtx_lock(&(_sc)->tx_mtx) 491 #define EM_TX_TRYLOCK(_sc) mtx_trylock(&(_sc)->tx_mtx) 492 #define EM_RX_LOCK(_sc) mtx_lock(&(_sc)->rx_mtx) 493 #define EM_CORE_UNLOCK(_sc) mtx_unlock(&(_sc)->core_mtx) 494 #define EM_TX_UNLOCK(_sc) mtx_unlock(&(_sc)->tx_mtx) 495 #define EM_RX_UNLOCK(_sc) mtx_unlock(&(_sc)->rx_mtx) 496 #define EM_CORE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->core_mtx, MA_OWNED) 497 #define EM_TX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->tx_mtx, MA_OWNED) 498 499 #ifdef IFNET_BUF_RING 500 #define ADAPTER_RING_EMPTY(adapter) drbr_empty((adapter)->ifp, (adapter)->br) 501 #define em_dequeue drbr_dequeue 502 503 #else 504 #define ADAPTER_RING_EMPTY(adapter) IFQ_DRV_IS_EMPTY(&((adapter)->ifp->if_snd)) 505 #define drbr_free(br, type) 506 static __inline struct mbuf * 507 em_dequeue(struct ifnet *ifp, struct buf_ring *br) 508 { 509 struct mbuf *m; 510 511 IFQ_DRV_DEQUEUE(&ifp->if_snd, m); 512 return (m); 513 } 514 #ifdef BUF_RING_UNDEFINED 515 516 struct buf_ring { 517 }; 518 519 #endif 520 #endif 521 522 #endif /* _EM_H_DEFINED_ */ 523