if_em.h revision 114554
187189Spdeuskar/************************************************************************** 287189Spdeuskar 3112472SpdeuskarCopyright (c) 2001-2003, Intel Corporation 487189SpdeuskarAll rights reserved. 587189Spdeuskar 6103895SpdeuskarRedistribution and use in source and binary forms, with or without 7103895Spdeuskarmodification, are permitted provided that the following conditions are met: 887189Spdeuskar 9103895Spdeuskar 1. Redistributions of source code must retain the above copyright notice, 10103895Spdeuskar this list of conditions and the following disclaimer. 1187189Spdeuskar 12103895Spdeuskar 2. Redistributions in binary form must reproduce the above copyright 13103895Spdeuskar notice, this list of conditions and the following disclaimer in the 14103895Spdeuskar documentation and/or other materials provided with the distribution. 1587189Spdeuskar 1687189Spdeuskar 3. Neither the name of the Intel Corporation nor the names of its 17103895Spdeuskar contributors may be used to endorse or promote products derived from 18103895Spdeuskar this software without specific prior written permission. 1987189Spdeuskar 2087189SpdeuskarTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 2187189SpdeuskarAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2287189SpdeuskarIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23103895SpdeuskarARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24103895SpdeuskarLIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25103895SpdeuskarCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26103895SpdeuskarSUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27103895SpdeuskarINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28103895SpdeuskarCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29103895SpdeuskarARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30103895SpdeuskarPOSSIBILITY OF SUCH DAMAGE. 3187189Spdeuskar 3287189Spdeuskar***************************************************************************/ 3387189Spdeuskar 3490628Spdeuskar/*$FreeBSD: head/sys/dev/em/if_em.h 114554 2003-05-02 21:17:08Z pdeuskar $*/ 3590628Spdeuskar 3687189Spdeuskar#ifndef _EM_H_DEFINED_ 3787189Spdeuskar#define _EM_H_DEFINED_ 3887189Spdeuskar 3987189Spdeuskar 4087189Spdeuskar#include <sys/param.h> 4187189Spdeuskar#include <sys/systm.h> 4287189Spdeuskar#include <sys/mbuf.h> 4387189Spdeuskar#include <sys/protosw.h> 4487189Spdeuskar#include <sys/socket.h> 4587189Spdeuskar#include <sys/malloc.h> 4687189Spdeuskar#include <sys/kernel.h> 4797785Spdeuskar#include <sys/sockio.h> 4887189Spdeuskar 4987189Spdeuskar#include <net/if.h> 5097785Spdeuskar#include <net/if_arp.h> 5197785Spdeuskar#include <net/ethernet.h> 5287189Spdeuskar#include <net/if_dl.h> 5387189Spdeuskar#include <net/if_media.h> 5497785Spdeuskar 5587189Spdeuskar#include <net/bpf.h> 5697785Spdeuskar#include <net/if_types.h> 5797785Spdeuskar#include <net/if_vlan_var.h> 5887189Spdeuskar 5987189Spdeuskar#include <netinet/in_systm.h> 6087189Spdeuskar#include <netinet/in.h> 6187189Spdeuskar#include <netinet/ip.h> 6287189Spdeuskar#include <netinet/tcp.h> 6387189Spdeuskar#include <netinet/udp.h> 6487189Spdeuskar 6587189Spdeuskar#include <sys/bus.h> 6687189Spdeuskar#include <machine/bus.h> 6787189Spdeuskar#include <sys/rman.h> 6887189Spdeuskar#include <machine/resource.h> 6987189Spdeuskar#include <vm/vm.h> 7087189Spdeuskar#include <vm/pmap.h> 7187189Spdeuskar#include <machine/clock.h> 7287189Spdeuskar#include <pci/pcivar.h> 7387189Spdeuskar#include <pci/pcireg.h> 74114554Spdeuskar#include <sys/endian.h> 7587189Spdeuskar#include "opt_bdg.h" 7687189Spdeuskar 7797785Spdeuskar#include <dev/em/if_em_hw.h> 7887189Spdeuskar 79108229Spdeuskar/* Tunables */ 80108229Spdeuskar 81108229Spdeuskar/* 82106649Spdeuskar * TxDescriptors 83106649Spdeuskar * Valid Range: 80-256 for 82542 and 82543-based adapters 84106649Spdeuskar * 80-4096 for 82540, 82544, 82545, and 82546-based adapters 85106649Spdeuskar * Default Value: 256 86106649Spdeuskar * This value is the number of transmit descriptors allocated by the driver. 87106649Spdeuskar * Increasing this value allows the driver to queue more transmits. Each 88108229Spdeuskar * descriptor is 16 bytes. 89108229Spdeuskar */ 90106649Spdeuskar#define EM_MAX_TXD 256 91106649Spdeuskar 92106649Spdeuskar/* 93106649Spdeuskar * RxDescriptors 94106649Spdeuskar * Valid Range: 80-256 for 82542 and 82543-based adapters 95106649Spdeuskar * 80-4096 for 82540, 82544, 82545, and 82546-based adapters 96108229Spdeuskar * Default Value: 256 97106649Spdeuskar * This value is the number of receive descriptors allocated by the driver. 98106649Spdeuskar * Increasing this value allows the driver to buffer more incoming packets. 99106649Spdeuskar * Each descriptor is 16 bytes. A receive buffer is also allocated for each 100106649Spdeuskar * descriptor. The maximum MTU size is 16110. 101108229Spdeuskar * 102106649Spdeuskar */ 103106649Spdeuskar#define EM_MAX_RXD 256 104106649Spdeuskar 105106649Spdeuskar/* 106106649Spdeuskar * TxIntDelay 107106649Spdeuskar * Valid Range: 0-65535 (0=off) 108106649Spdeuskar * Default Value: 64 109106649Spdeuskar * This value delays the generation of transmit interrupts in units of 110106649Spdeuskar * 1.024 microseconds. Transmit interrupt reduction can improve CPU 111106649Spdeuskar * efficiency if properly tuned for specific network traffic. If the 112106649Spdeuskar * system is reporting dropped transmits, this value may be set too high 113106649Spdeuskar * causing the driver to run out of available transmit descriptors. 114106649Spdeuskar */ 115108229Spdeuskar#define EM_TIDV 64 116106649Spdeuskar 117106649Spdeuskar/* 118108229Spdeuskar * TxAbsIntDelay (82540, 82545, and 82546-based adapters only) 119108229Spdeuskar * Valid Range: 0-65535 (0=off) 120108229Spdeuskar * Default Value: 64 121108229Spdeuskar * This value, in units of 1.024 microseconds, limits the delay in which a 122108229Spdeuskar * transmit interrupt is generated. Useful only if TxIntDelay is non-zero, 123108229Spdeuskar * this value ensures that an interrupt is generated after the initial 124108229Spdeuskar * packet is sent on the wire within the set amount of time. Proper tuning, 125108229Spdeuskar * along with TxIntDelay, may improve traffic throughput in specific 126108229Spdeuskar * network conditions. 127108229Spdeuskar */ 128108229Spdeuskar#define EM_TADV 64 129108229Spdeuskar 130108229Spdeuskar/* 131106649Spdeuskar * RxIntDelay 132106649Spdeuskar * Valid Range: 0-65535 (0=off) 133106649Spdeuskar * Default Value: 0 134106649Spdeuskar * This value delays the generation of receive interrupts in units of 1.024 135106649Spdeuskar * microseconds. Receive interrupt reduction can improve CPU efficiency if 136106649Spdeuskar * properly tuned for specific network traffic. Increasing this value adds 137106649Spdeuskar * extra latency to frame reception and can end up decreasing the throughput 138106649Spdeuskar * of TCP traffic. If the system is reporting dropped receives, this value 139106649Spdeuskar * may be set too high, causing the driver to run out of available receive 140106649Spdeuskar * descriptors. 141106649Spdeuskar * 142106649Spdeuskar * CAUTION: When setting RxIntDelay to a value other than 0, adapters 143108229Spdeuskar * may hang (stop transmitting) under certain network conditions. 144106649Spdeuskar * If this occurs a WATCHDOG message is logged in the system event log. 145106649Spdeuskar * In addition, the controller is automatically reset, restoring the 146106649Spdeuskar * network connection. To eliminate the potential for the hang 147106649Spdeuskar * ensure that RxIntDelay is set to 0. 148106649Spdeuskar */ 149108229Spdeuskar#define EM_RDTR 0 150106649Spdeuskar 151108229Spdeuskar/* 152108229Spdeuskar * RxAbsIntDelay (82540, 82545, and 82546-based adapters only) 153108229Spdeuskar * Valid Range: 0-65535 (0=off) 154108229Spdeuskar * Default Value: 64 155108229Spdeuskar * This value, in units of 1.024 microseconds, limits the delay in which a 156108229Spdeuskar * receive interrupt is generated. Useful only if RxIntDelay is non-zero, 157108229Spdeuskar * this value ensures that an interrupt is generated after the initial 158108229Spdeuskar * packet is received within the set amount of time. Proper tuning, 159108229Spdeuskar * along with RxIntDelay, may improve traffic throughput in specific network 160108229Spdeuskar * conditions. 161108229Spdeuskar */ 162108229Spdeuskar#define EM_RADV 64 163106649Spdeuskar 164108229Spdeuskar 165106649Spdeuskar/* 166106649Spdeuskar * This parameter controls the maximum no of times the driver will loop 167106649Spdeuskar * in the isr. 168106649Spdeuskar * Minimum Value = 1 169106649Spdeuskar */ 170106649Spdeuskar#define EM_MAX_INTR 3 171106649Spdeuskar 172106649Spdeuskar/* 173106649Spdeuskar * Inform the stack about transmit checksum offload capabilities. 174106649Spdeuskar */ 17587189Spdeuskar#define EM_CHECKSUM_FEATURES (CSUM_TCP | CSUM_UDP) 176106649Spdeuskar 177106649Spdeuskar/* 178106649Spdeuskar * This parameter controls the duration of transmit watchdog timer. 179106649Spdeuskar */ 18087189Spdeuskar#define EM_TX_TIMEOUT 5 /* set to 5 seconds */ 18187189Spdeuskar 182106649Spdeuskar/* 183106649Spdeuskar * This parameter controls when the driver calls the routine to reclaim 184106649Spdeuskar * transmit descriptors. 185106649Spdeuskar */ 186106649Spdeuskar#define EM_TX_CLEANUP_THRESHOLD EM_MAX_TXD / 8 18787189Spdeuskar 188106649Spdeuskar/* 189106649Spdeuskar * This parameter controls whether or not autonegotation is enabled. 190106649Spdeuskar * 0 - Disable autonegotiation 191106649Spdeuskar * 1 - Enable autonegotiation 192106649Spdeuskar */ 193106649Spdeuskar#define DO_AUTO_NEG 1 194106649Spdeuskar 195106649Spdeuskar/* 196106649Spdeuskar * This parameter control whether or not the driver will wait for 197106649Spdeuskar * autonegotiation to complete. 198106649Spdeuskar * 1 - Wait for autonegotiation to complete 199106649Spdeuskar * 0 - Don't wait for autonegotiation to complete 200106649Spdeuskar */ 201106649Spdeuskar#define WAIT_FOR_AUTO_NEG_DEFAULT 1 202106649Spdeuskar 203106649Spdeuskar 204106649Spdeuskar/* Tunables -- End */ 205106649Spdeuskar 206106649Spdeuskar#define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \ 207106649Spdeuskar ADVERTISE_100_HALF | ADVERTISE_100_FULL | \ 208106649Spdeuskar ADVERTISE_1000_FULL) 209108229Spdeuskar 21087189Spdeuskar#define EM_VENDOR_ID 0x8086 21187189Spdeuskar#define EM_MMBA 0x0010 /* Mem base address */ 21287189Spdeuskar#define EM_ROUNDUP(size, unit) (((size) + (unit) - 1) & ~((unit) - 1)) 213112472Spdeuskar 21487189Spdeuskar#define EM_JUMBO_PBA 0x00000028 21587189Spdeuskar#define EM_DEFAULT_PBA 0x00000030 216112472Spdeuskar#define EM_SMARTSPEED_DOWNSHIFT 3 217112472Spdeuskar#define EM_SMARTSPEED_MAX 15 21887189Spdeuskar 219112472Spdeuskar 22087189Spdeuskar#define MAX_NUM_MULTICAST_ADDRESSES 128 22187189Spdeuskar#define PCI_ANY_ID (~0U) 22287189Spdeuskar#define ETHER_ALIGN 2 223108229Spdeuskar 22487189Spdeuskar/* Defines for printing debug information */ 22587189Spdeuskar#define DEBUG_INIT 0 22687189Spdeuskar#define DEBUG_IOCTL 0 22787189Spdeuskar#define DEBUG_HW 0 22887189Spdeuskar 22987189Spdeuskar#define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n") 23087189Spdeuskar#define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A) 23187189Spdeuskar#define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B) 23287189Spdeuskar#define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n") 23387189Spdeuskar#define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A) 23487189Spdeuskar#define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B) 23587189Spdeuskar#define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n") 23687189Spdeuskar#define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A) 23787189Spdeuskar#define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B) 23887189Spdeuskar 23987189Spdeuskar 24087189Spdeuskar/* Supported RX Buffer Sizes */ 24187189Spdeuskar#define EM_RXBUFFER_2048 2048 24287189Spdeuskar#define EM_RXBUFFER_4096 4096 24387189Spdeuskar#define EM_RXBUFFER_8192 8192 24487189Spdeuskar#define EM_RXBUFFER_16384 16384 24587189Spdeuskar 246114554Spdeuskar#define EM_MAX_SCATTER 64 247114554Spdeuskar 24893914Spdeuskar#ifdef __alpha__ 24997785Spdeuskar #undef vtophys 25097785Spdeuskar #define vtophys(va) alpha_XXX_dmamap((vm_offset_t)(va)) 25193914Spdeuskar#endif /* __alpha__ */ 25287189Spdeuskar 25387189Spdeuskar/* ****************************************************************************** 25487189Spdeuskar * vendor_info_array 25587189Spdeuskar * 25687189Spdeuskar * This array contains the list of Subvendor/Subdevice IDs on which the driver 25787189Spdeuskar * should load. 25887189Spdeuskar * 25987189Spdeuskar * ******************************************************************************/ 260106649Spdeuskartypedef struct _em_vendor_info_t { 26197785Spdeuskar unsigned int vendor_id; 26297785Spdeuskar unsigned int device_id; 26397785Spdeuskar unsigned int subvendor_id; 26497785Spdeuskar unsigned int subdevice_id; 26597785Spdeuskar unsigned int index; 26687189Spdeuskar} em_vendor_info_t; 26787189Spdeuskar 26887189Spdeuskar 269108229Spdeuskarstruct em_buffer { 270114554Spdeuskar struct mbuf *m_head; 271114554Spdeuskar bus_dmamap_t map; /* bus_dma map for packet */ 27287189Spdeuskar}; 27387189Spdeuskar 274114554Spdeuskarstruct em_q { 275114554Spdeuskar bus_dmamap_t map; /* bus_dma map for packet */ 276114554Spdeuskar int nsegs; /* # of segments/descriptors */ 277114554Spdeuskar bus_dma_segment_t segs[EM_MAX_SCATTER]; 278114554Spdeuskar}; 27987189Spdeuskar 280114554Spdeuskar/* 281114554Spdeuskar * Bus dma allocation structure used by 282114554Spdeuskar * em_dma_malloc and em_dma_free. 283114554Spdeuskar */ 284114554Spdeuskarstruct em_dma_alloc { 285114554Spdeuskar u_int32_t dma_paddr; 286114554Spdeuskar caddr_t dma_vaddr; 287114554Spdeuskar bus_dma_tag_t dma_tag; 288114554Spdeuskar bus_dmamap_t dma_map; 289114554Spdeuskar bus_dma_segment_t dma_seg; 290114554Spdeuskar bus_size_t dma_size; 291114554Spdeuskar int dma_nseg; 292114554Spdeuskar}; 293114554Spdeuskar 29487189Spdeuskartypedef enum _XSUM_CONTEXT_T { 29597785Spdeuskar OFFLOAD_NONE, 29697785Spdeuskar OFFLOAD_TCP_IP, 29797785Spdeuskar OFFLOAD_UDP_IP 29887189Spdeuskar} XSUM_CONTEXT_T; 29987189Spdeuskar 30087189Spdeuskar/* Our adapter structure */ 30187189Spdeuskarstruct adapter { 30297785Spdeuskar struct arpcom interface_data; 30397785Spdeuskar struct adapter *next; 30497785Spdeuskar struct adapter *prev; 30597785Spdeuskar struct em_hw hw; 30687189Spdeuskar 30797785Spdeuskar /* FreeBSD operating-system-specific structures */ 30897785Spdeuskar struct em_osdep osdep; 30997785Spdeuskar struct device *dev; 31097785Spdeuskar struct resource *res_memory; 311100184Spdeuskar struct resource *res_ioport; 31297785Spdeuskar struct resource *res_interrupt; 31397785Spdeuskar void *int_handler_tag; 31497785Spdeuskar struct ifmedia media; 31597785Spdeuskar struct callout_handle timer_handle; 316112472Spdeuskar struct callout_handle tx_fifo_timer_handle; 317100184Spdeuskar int io_rid; 31897785Spdeuskar u_int8_t unit; 31987189Spdeuskar 32097785Spdeuskar /* Info about the board itself */ 32197785Spdeuskar u_int32_t part_num; 32297785Spdeuskar u_int8_t link_active; 32397785Spdeuskar u_int16_t link_speed; 32497785Spdeuskar u_int16_t link_duplex; 325112472Spdeuskar u_int32_t smartspeed; 32697785Spdeuskar u_int32_t tx_int_delay; 327108229Spdeuskar u_int32_t tx_abs_int_delay; 32897785Spdeuskar u_int32_t rx_int_delay; 329108229Spdeuskar u_int32_t rx_abs_int_delay; 33087189Spdeuskar 33197785Spdeuskar XSUM_CONTEXT_T active_checksum_context; 33287189Spdeuskar 333108229Spdeuskar /* 334108229Spdeuskar * Transmit definitions 335108229Spdeuskar * 336108229Spdeuskar * We have an array of num_tx_desc descriptors (handled 337108229Spdeuskar * by the controller) paired with an array of tx_buffers 338108229Spdeuskar * (at tx_buffer_area). 339108229Spdeuskar * The index of the next available descriptor is next_avail_tx_desc. 340108229Spdeuskar * The number of remaining tx_desc is num_tx_desc_avail. 341108229Spdeuskar */ 342114554Spdeuskar struct em_dma_alloc txdma; /* bus_dma glue for tx desc */ 343108229Spdeuskar struct em_tx_desc *tx_desc_base; 344108229Spdeuskar u_int32_t next_avail_tx_desc; 345108229Spdeuskar u_int32_t oldest_used_tx_desc; 346108229Spdeuskar volatile u_int16_t num_tx_desc_avail; 347108229Spdeuskar u_int16_t num_tx_desc; 348108229Spdeuskar u_int32_t txd_cmd; 349108229Spdeuskar struct em_buffer *tx_buffer_area; 350114554Spdeuskar bus_dma_tag_t txtag; /* dma tag for tx */ 35187189Spdeuskar 352108229Spdeuskar /* 353108229Spdeuskar * Receive definitions 354108229Spdeuskar * 355108229Spdeuskar * we have an array of num_rx_desc rx_desc (handled by the 356108229Spdeuskar * controller), and paired with an array of rx_buffers 357108229Spdeuskar * (at rx_buffer_area). 358108229Spdeuskar * The next pair to check on receive is at offset next_rx_desc_to_check 359108229Spdeuskar */ 360114554Spdeuskar struct em_dma_alloc rxdma; /* bus_dma glue for rx desc */ 361108229Spdeuskar struct em_rx_desc *rx_desc_base; 362108229Spdeuskar u_int32_t next_rx_desc_to_check; 363108229Spdeuskar u_int16_t num_rx_desc; 364108229Spdeuskar u_int32_t rx_buffer_len; 365108229Spdeuskar struct em_buffer *rx_buffer_area; 366114554Spdeuskar bus_dma_tag_t rxtag; 36787189Spdeuskar 36897785Spdeuskar /* Jumbo frame */ 369112472Spdeuskar struct mbuf *fmp; 370112472Spdeuskar struct mbuf *lmp; 37187189Spdeuskar 372112472Spdeuskar u_int16_t tx_fifo_head; 37387189Spdeuskar 37497785Spdeuskar /* Misc stats maintained by the driver */ 37597785Spdeuskar unsigned long dropped_pkts; 37697785Spdeuskar unsigned long mbuf_alloc_failed; 37797785Spdeuskar unsigned long mbuf_cluster_failed; 378106649Spdeuskar unsigned long no_tx_desc_avail1; 379106649Spdeuskar unsigned long no_tx_desc_avail2; 380114554Spdeuskar unsigned long no_tx_map_avail; 381114554Spdeuskar unsigned long no_tx_dma_setup; 382112472Spdeuskar u_int64_t tx_fifo_reset; 383112472Spdeuskar u_int64_t tx_fifo_wrk; 384112472Spdeuskar 38597785Spdeuskar#ifdef DBG_STATS 38697785Spdeuskar unsigned long no_pkts_avail; 38797785Spdeuskar unsigned long clean_tx_interrupts; 38893914Spdeuskar 38987189Spdeuskar#endif 39097785Spdeuskar struct em_hw_stats stats; 39187189Spdeuskar}; 39287189Spdeuskar 39387189Spdeuskar#endif /* _EM_H_DEFINED_ */ 394