1 /******************************************************************************
3 Copyright (c) 2001-2011, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
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.
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.
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.
32 ******************************************************************************/
36 #ifndef _EM_H_DEFINED_
37 #define _EM_H_DEFINED_
43 * EM_TXD: Maximum number of Transmit Descriptors
44 * Valid Range: 80-256 for 82542 and 82543-based adapters
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
55 #define EM_MAX_TXD 4096
56 #define EM_DEFAULT_TXD 1024
59 * EM_RXD - Maximum number of receive Descriptors
60 * Valid Range: 80-256 for 82542 and 82543-based adapters
63 * This value is the number of receive descriptors allocated by the driver.
64 * Increasing this value allows the driver to buffer more incoming packets.
65 * Each descriptor is 16 bytes. A receive buffer is also allocated for each
66 * descriptor. The maximum MTU size is 16110.
67 * Since TDLEN should be multiple of 128bytes, the number of transmit
68 * desscriptors should meet the following condition.
69 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
72 #define EM_MAX_RXD 4096
73 #define EM_DEFAULT_RXD 1024
76 * EM_TIDV - Transmit Interrupt Delay Value
77 * Valid Range: 0-65535 (0=off)
79 * This value delays the generation of transmit interrupts in units of
80 * 1.024 microseconds. Transmit interrupt reduction can improve CPU
81 * efficiency if properly tuned for specific network traffic. If the
82 * system is reporting dropped transmits, this value may be set too high
83 * causing the driver to run out of available transmit descriptors.
88 * EM_TADV - Transmit Absolute Interrupt Delay Value
89 * (Not valid for 82542/82543/82544)
90 * Valid Range: 0-65535 (0=off)
92 * This value, in units of 1.024 microseconds, limits the delay in which a
93 * transmit interrupt is generated. Useful only if EM_TIDV is non-zero,
94 * this value ensures that an interrupt is generated after the initial
95 * packet is sent on the wire within the set amount of time. Proper tuning,
96 * along with EM_TIDV, may improve traffic throughput in specific
102 * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer)
103 * Valid Range: 0-65535 (0=off)
105 * This value delays the generation of receive interrupts in units of 1.024
106 * microseconds. Receive interrupt reduction can improve CPU efficiency if
107 * properly tuned for specific network traffic. Increasing this value adds
108 * extra latency to frame reception and can end up decreasing the throughput
109 * of TCP traffic. If the system is reporting dropped receives, this value
110 * may be set too high, causing the driver to run out of available receive
113 * CAUTION: When setting EM_RDTR to a value other than 0, adapters
114 * may hang (stop transmitting) under certain network conditions.
115 * If this occurs a WATCHDOG message is logged in the system
116 * event log. In addition, the controller is automatically reset,
117 * restoring the network connection. To eliminate the potential
118 * for the hang ensure that EM_RDTR is set to 0.
123 * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544)
124 * Valid Range: 0-65535 (0=off)
126 * This value, in units of 1.024 microseconds, limits the delay in which a
127 * receive interrupt is generated. Useful only if EM_RDTR is non-zero,
128 * this value ensures that an interrupt is generated after the initial
129 * packet is received within the set amount of time. Proper tuning,
130 * along with EM_RDTR, may improve traffic throughput in specific network
136 * This parameter controls the max duration of transmit watchdog.
138 #define EM_WATCHDOG (10 * hz)
141 * This parameter controls when the driver calls the routine to reclaim
142 * transmit descriptors.
144 #define EM_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8)
147 * This parameter controls whether or not autonegotation is enabled.
148 * 0 - Disable autonegotiation
149 * 1 - Enable autonegotiation
151 #define DO_AUTO_NEG 1
154 * This parameter control whether or not the driver will wait for
155 * autonegotiation to complete.
156 * 1 - Wait for autonegotiation to complete
157 * 0 - Don't wait for autonegotiation to complete
159 #define WAIT_FOR_AUTO_NEG_DEFAULT 0
161 /* Tunables -- End */
163 #define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
164 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
167 #define AUTO_ALL_MODES 0
169 /* PHY master/slave setting */
170 #define EM_MASTER_SLAVE e1000_ms_hw_default
173 * Micellaneous constants
175 #define EM_VENDOR_ID 0x8086
176 #define EM_FLASH 0x0014
178 #define EM_JUMBO_PBA 0x00000028
179 #define EM_DEFAULT_PBA 0x00000030
180 #define EM_SMARTSPEED_DOWNSHIFT 3
181 #define EM_SMARTSPEED_MAX 15
182 #define EM_MAX_LOOP 10
184 #define MAX_NUM_MULTICAST_ADDRESSES 128
185 #define PCI_ANY_ID (~0U)
186 #define ETHER_ALIGN 2
187 #define EM_FC_PAUSE_TIME 0x0680
188 #define EM_EEPROM_APME 0x400;
189 #define EM_82544_APME 0x0004;
191 #define EM_QUEUE_IDLE 0
192 #define EM_QUEUE_WORKING 1
193 #define EM_QUEUE_HUNG 2
196 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
197 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will
198 * also optimize cache line size effect. H/W supports up to cache line size 128.
200 #define EM_DBA_ALIGN 128
202 #define SPEED_MODE_BIT (1<<21) /* On PCI-E MACs only */
204 /* PCI Config defines */
205 #define EM_BAR_TYPE(v) ((v) & EM_BAR_TYPE_MASK)
206 #define EM_BAR_TYPE_MASK 0x00000001
207 #define EM_BAR_TYPE_MMEM 0x00000000
208 #define EM_BAR_TYPE_FLASH 0x0014
209 #define EM_BAR_MEM_TYPE(v) ((v) & EM_BAR_MEM_TYPE_MASK)
210 #define EM_BAR_MEM_TYPE_MASK 0x00000006
211 #define EM_BAR_MEM_TYPE_32BIT 0x00000000
212 #define EM_BAR_MEM_TYPE_64BIT 0x00000004
213 #define EM_MSIX_BAR 3 /* On 82575 */
215 /* More backward compatibility */
216 #if __FreeBSD_version < 900000
217 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
220 /* Defines for printing debug information */
222 #define DEBUG_IOCTL 0
225 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n")
226 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A)
227 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B)
228 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n")
229 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A)
230 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B)
231 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n")
232 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A)
233 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B)
235 #define EM_MAX_SCATTER 32
236 #define EM_VFTA_SIZE 128
237 #define EM_TSO_SIZE (65535 + sizeof(struct ether_vlan_header))
238 #define EM_TSO_SEG_SIZE 4096 /* Max dma segment size */
239 #define EM_MSIX_MASK 0x01F00000 /* For 82574 use */
240 #define EM_MSIX_LINK 0x01000000 /* For 82574 use */
242 #define ETH_ADDR_LEN 6
243 #define CSUM_OFFLOAD 7 /* Offload bits in mbuf flag */
246 * 82574 has a nonstandard address for EIAC
247 * and since its only used in MSIX, and in
248 * the em driver only 82574 uses MSIX we can
249 * solve it just using this define.
251 #define EM_EIAC 0x000DC
254 * Bus dma allocation structure used by
255 * e1000_dma_malloc and e1000_dma_free.
257 struct em_dma_alloc {
258 bus_addr_t dma_paddr;
260 bus_dma_tag_t dma_tag;
261 bus_dmamap_t dma_map;
262 bus_dma_segment_t dma_seg;
268 struct em_int_delay_info {
269 struct adapter *adapter; /* Back-pointer to the adapter struct */
270 int offset; /* Register offset to read/write */
271 int value; /* Current value in usecs */
275 * The transmit ring, one per tx queue
278 struct adapter *adapter;
286 struct em_dma_alloc txdma;
287 struct e1000_tx_desc *tx_base;
289 struct taskqueue *tq;
292 struct em_buffer *tx_buffers;
293 volatile u16 tx_avail;
294 u32 tx_tso; /* last tx was tso */
300 #if __FreeBSD_version >= 800000
303 /* Interrupt resources */
306 struct resource *res;
307 unsigned long tx_irq;
308 unsigned long no_desc_avail;
312 * The Receive ring, one per rx queue
315 struct adapter *adapter;
323 struct taskqueue *tq;
324 struct e1000_rx_desc *rx_base;
325 struct em_dma_alloc rxdma;
328 struct em_buffer *rx_buffers;
332 /* Interrupt resources */
334 struct resource *res;
339 unsigned long rx_irq;
340 unsigned long rx_discarded;
341 unsigned long rx_packets;
342 unsigned long rx_bytes;
346 /* Our adapter structure */
351 /* FreeBSD operating-system-specific structures. */
352 struct e1000_osdep osdep;
354 struct cdev *led_dev;
356 struct resource *memory;
357 struct resource *flash;
358 struct resource *msix_mem;
360 struct resource *res;
365 struct ifmedia media;
366 struct callout timer;
373 int em_insert_vlan_header;
377 /* Task for FAST handling */
378 struct task link_task;
379 struct task que_task;
380 struct taskqueue *tq; /* private task queue */
382 eventhandler_tag vlan_attach;
383 eventhandler_tag vlan_detach;
390 * Allocated at run time, an array of rings.
392 struct tx_ring *tx_rings;
398 * Allocated at run time, an array of rings.
400 struct rx_ring *rx_rings;
402 u32 rx_process_limit;
405 /* Management and WOL features */
410 /* Multicast array memory */
414 ** Shadow VFTA table, this is needed because
415 ** the real vlan filter table gets cleared during
416 ** a soft reset and the driver needs to be able
419 u32 shadow_vfta[EM_VFTA_SIZE];
421 /* Info about the interface */
428 struct em_int_delay_info tx_int_delay;
429 struct em_int_delay_info tx_abs_int_delay;
430 struct em_int_delay_info rx_int_delay;
431 struct em_int_delay_info rx_abs_int_delay;
432 struct em_int_delay_info tx_itr;
434 /* Misc stats maintained by the driver */
435 unsigned long dropped_pkts;
436 unsigned long mbuf_alloc_failed;
437 unsigned long mbuf_cluster_failed;
438 unsigned long no_tx_map_avail;
439 unsigned long no_tx_dma_setup;
440 unsigned long rx_overruns;
441 unsigned long watchdog_events;
442 unsigned long link_irq;
444 struct e1000_hw_stats stats;
447 /********************************************************************************
450 * This array contains the list of Subvendor/Subdevice IDs on which the driver
453 ********************************************************************************/
454 typedef struct _em_vendor_info_t {
455 unsigned int vendor_id;
456 unsigned int device_id;
457 unsigned int subvendor_id;
458 unsigned int subdevice_id;
463 int next_eop; /* Index of the desc to watch */
465 bus_dmamap_t map; /* bus_dma map for packet */
470 ** Find the number of unrefreshed RX descriptors
473 e1000_rx_unrefreshed(struct rx_ring *rxr)
475 struct adapter *adapter = rxr->adapter;
477 if (rxr->next_to_check > rxr->next_to_refresh)
478 return (rxr->next_to_check - rxr->next_to_refresh - 1);
480 return ((adapter->num_rx_desc + rxr->next_to_check) -
481 rxr->next_to_refresh - 1);
484 #define EM_CORE_LOCK_INIT(_sc, _name) \
485 mtx_init(&(_sc)->core_mtx, _name, "EM Core Lock", MTX_DEF)
486 #define EM_TX_LOCK_INIT(_sc, _name) \
487 mtx_init(&(_sc)->tx_mtx, _name, "EM TX Lock", MTX_DEF)
488 #define EM_RX_LOCK_INIT(_sc, _name) \
489 mtx_init(&(_sc)->rx_mtx, _name, "EM RX Lock", MTX_DEF)
490 #define EM_CORE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->core_mtx)
491 #define EM_TX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->tx_mtx)
492 #define EM_RX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->rx_mtx)
493 #define EM_CORE_LOCK(_sc) mtx_lock(&(_sc)->core_mtx)
494 #define EM_TX_LOCK(_sc) mtx_lock(&(_sc)->tx_mtx)
495 #define EM_TX_TRYLOCK(_sc) mtx_trylock(&(_sc)->tx_mtx)
496 #define EM_RX_LOCK(_sc) mtx_lock(&(_sc)->rx_mtx)
497 #define EM_CORE_UNLOCK(_sc) mtx_unlock(&(_sc)->core_mtx)
498 #define EM_TX_UNLOCK(_sc) mtx_unlock(&(_sc)->tx_mtx)
499 #define EM_RX_UNLOCK(_sc) mtx_unlock(&(_sc)->rx_mtx)
500 #define EM_CORE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->core_mtx, MA_OWNED)
501 #define EM_TX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->tx_mtx, MA_OWNED)
502 #define EM_RX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->rx_mtx, MA_OWNED)
504 #endif /* _EM_H_DEFINED_ */