2 * Copyright (c) 2001-2011, Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the Intel Corporation nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
40 #define IGB_MAX_RING_82575 4
41 #define IGB_MAX_RING_I350 8
42 #define IGB_MAX_RING_82580 8
43 #define IGB_MAX_RING_82576 16
44 #define IGB_MIN_RING 1
45 #define IGB_MIN_RING_RSS 2
48 * Max TX/RX interrupt bits
50 #define IGB_MAX_TXRXINT_82575 4 /* XXX not used */
51 #define IGB_MAX_TXRXINT_I350 8
52 #define IGB_MAX_TXRXINT_82580 8
53 #define IGB_MAX_TXRXINT_82576 16
54 #define IGB_MIN_TXRXINT 2 /* XXX VF? */
59 #define IGB_MAX_IVAR_I350 4
60 #define IGB_MAX_IVAR_82580 4
61 #define IGB_MAX_IVAR_82576 8
62 #define IGB_MAX_IVAR_VF 1
65 * IGB_TXD: Maximum number of Transmit Descriptors
67 * This value is the number of transmit descriptors allocated by the driver.
68 * Increasing this value allows the driver to queue more transmits. Each
69 * descriptor is 16 bytes.
70 * Since TDLEN should be multiple of 128bytes, the number of transmit
71 * desscriptors should meet the following condition.
72 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
74 #define IGB_MIN_TXD 256
75 #define IGB_DEFAULT_TXD 1024
76 #define IGB_MAX_TXD 4096
79 * IGB_RXD: Maximum number of Transmit Descriptors
81 * This value is the number of receive descriptors allocated by the driver.
82 * Increasing this value allows the driver to buffer more incoming packets.
83 * Each descriptor is 16 bytes. A receive buffer is also allocated for each
84 * descriptor. The maximum MTU size is 16110.
85 * Since TDLEN should be multiple of 128bytes, the number of transmit
86 * desscriptors should meet the following condition.
87 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
89 #define IGB_MIN_RXD 256
90 #define IGB_DEFAULT_RXD 512
91 #define IGB_MAX_RXD 4096
94 * This parameter controls when the driver calls the routine to reclaim
95 * transmit descriptors. Cleaning earlier seems a win.
97 #define IGB_TX_CLEANUP_THRESHOLD(sc) ((sc)->num_tx_desc / 2)
100 * This parameter controls whether or not autonegotation is enabled.
101 * 0 - Disable autonegotiation
102 * 1 - Enable autonegotiation
104 #define DO_AUTO_NEG 1
107 * This parameter control whether or not the driver will wait for
108 * autonegotiation to complete.
109 * 1 - Wait for autonegotiation to complete
110 * 0 - Don't wait for autonegotiation to complete
112 #define WAIT_FOR_AUTO_NEG_DEFAULT 0
114 /* Tunables -- End */
116 #define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
117 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
120 #define AUTO_ALL_MODES 0
122 /* PHY master/slave setting */
123 #define IGB_MASTER_SLAVE e1000_ms_hw_default
126 * Micellaneous constants
128 #define IGB_VENDOR_ID 0x8086
130 #define IGB_JUMBO_PBA 0x00000028
131 #define IGB_DEFAULT_PBA 0x00000030
132 #define IGB_SMARTSPEED_DOWNSHIFT 3
133 #define IGB_SMARTSPEED_MAX 15
134 #define IGB_MAX_LOOP 10
136 #define IGB_RX_PTHRESH (hw->mac.type <= e1000_82576 ? 16 : 8)
137 #define IGB_RX_HTHRESH 8
138 #define IGB_RX_WTHRESH 1
140 #define IGB_TX_PTHRESH 8
141 #define IGB_TX_HTHRESH 1
142 #define IGB_TX_WTHRESH 16
144 #define MAX_NUM_MULTICAST_ADDRESSES 128
145 #define IGB_FC_PAUSE_TIME 0x0680
147 #define IGB_INTR_RATE 6000
148 #define IGB_MSIX_RX_RATE 6000
149 #define IGB_MSIX_TX_RATE 4000
152 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
153 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will
154 * also optimize cache line size effect. H/W supports up to cache line size 128.
156 #define IGB_DBA_ALIGN 128
158 /* PCI Config defines */
159 #define IGB_MSIX_BAR 3
161 #define IGB_MAX_SCATTER 64
162 #define IGB_VFTA_SIZE 128
163 #define IGB_TSO_SIZE (IP_MAXPACKET + \
164 sizeof(struct ether_vlan_header))
165 #define IGB_HDR_BUF 128
166 #define IGB_PKTTYPE_MASK 0x0000FFF0
168 #define IGB_CSUM_FEATURES (CSUM_IP | CSUM_TCP | CSUM_UDP)
169 #define IGB_IPVHL_SIZE 1 /* sizeof(ip.ip_vhl) */
170 #define IGB_TXCSUM_MINHL (ETHER_HDR_LEN + EVL_ENCAPLEN + \
173 /* One for TX csum offloading desc, the other 2 are reserved */
174 #define IGB_TX_RESERVED 3
176 /* Large enough for 64K TSO */
177 #define IGB_TX_SPARE 33
179 #define IGB_TX_OACTIVE_MAX 64
181 /* main + 16x RX + 16x TX */
182 #define IGB_NSERIALIZE 33
184 #define IGB_NRSSRK 10
185 #define IGB_RSSRK_SIZE 4
186 #define IGB_RSSRK_VAL(key, i) (key[(i) * IGB_RSSRK_SIZE] | \
187 key[(i) * IGB_RSSRK_SIZE + 1] << 8 | \
188 key[(i) * IGB_RSSRK_SIZE + 2] << 16 | \
189 key[(i) * IGB_RSSRK_SIZE + 3] << 24)
192 #define IGB_RETA_SIZE 4
193 #define IGB_RETA_SHIFT 0
194 #define IGB_RETA_SHIFT_82575 6
196 #define IGB_EITR_INTVL_MASK 0x7ffc
197 #define IGB_EITR_INTVL_SHIFT 2
202 * Bus dma information structure
205 bus_addr_t dma_paddr;
207 bus_dma_tag_t dma_tag;
208 bus_dmamap_t dma_map;
212 * Transmit ring: one per queue
215 struct lwkt_serialize tx_serialize;
216 struct igb_softc *sc;
218 struct igb_dma txdma;
219 bus_dma_tag_t tx_hdr_dtag;
220 bus_dmamap_t tx_hdr_dmap;
221 bus_addr_t tx_hdr_paddr;
222 struct e1000_tx_desc *tx_base;
224 uint32_t next_avail_desc;
225 uint32_t next_to_clean;
228 struct igb_tx_buf *tx_buf;
229 bus_dma_tag_t tx_tag;
236 uint32_t tx_intr_mask;
238 u_long no_desc_avail;
243 * Receive ring: one per queue
246 struct lwkt_serialize rx_serialize;
247 struct igb_softc *sc;
249 struct igb_dma rxdma;
250 union e1000_adv_rx_desc *rx_base;
253 uint32_t next_to_check;
254 struct igb_rx_buf *rx_buf;
255 bus_dma_tag_t rx_tag;
256 bus_dmamap_t rx_sparemap;
258 uint32_t rx_intr_mask;
261 * First/last mbuf pointers, for
262 * collecting multisegment RX packets.
271 struct igb_msix_data {
272 struct lwkt_serialize *msix_serialize;
273 struct lwkt_serialize msix_serialize0;
274 struct igb_softc *msix_sc;
276 struct igb_rx_ring *msix_rx;
277 struct igb_tx_ring *msix_tx;
279 driver_intr_t *msix_func;
285 struct resource *msix_res;
289 char msix_rate_desc[32];
293 struct arpcom arpcom;
296 struct e1000_osdep osdep;
299 #define IGB_FLAG_SHARED_INTR 0x1
300 #define IGB_FLAG_HAS_MGMT 0x2
301 #define IGB_FLAG_TSO_IPLEN0 0x4
303 bus_dma_tag_t parent_tag;
306 struct resource *mem_res;
308 struct ifmedia media;
309 struct callout timer;
313 struct resource *intr_res;
319 uint16_t vf_ifp; /* a VF interface */
321 /* Management and WOL features */
324 /* Info about the interface */
327 uint16_t link_duplex;
329 uint32_t dma_coalesce;
331 /* Multicast array pointer */
337 struct lwkt_serialize *serializes[IGB_NSERIALIZE];
338 struct lwkt_serialize main_serialize;
343 uint32_t sts_intr_mask;
349 struct igb_tx_ring *tx_rings;
358 struct igb_rx_ring *rx_rings;
360 /* Misc stats maintained by the driver */
362 u_long mbuf_defrag_failed;
363 u_long no_tx_dma_setup;
364 u_long watchdog_events;
366 u_long device_control;
370 u_long packet_buf_alloc_rx;
371 u_long packet_buf_alloc_tx;
373 /* sysctl tree glue */
374 struct sysctl_ctx_list sysctl_ctx;
375 struct sysctl_oid *sysctl_tree;
381 struct resource *msix_mem_res;
383 struct igb_msix_data *msix_data;
386 #define IGB_ENABLE_HWRSS(sc) ((sc)->rx_ring_cnt > 1)
390 bus_dmamap_t map; /* bus_dma map for packet */
395 bus_dmamap_t map; /* bus_dma map for packet */
399 #define UPDATE_VF_REG(reg, last, cur) \
401 uint32_t new = E1000_READ_REG(hw, reg); \
403 cur += 0x100000000LL; \
405 cur &= 0xFFFFFFFF00000000LL; \
409 #define IGB_IS_OACTIVE(txr) ((txr)->tx_avail < (txr)->oact_lo_desc)
410 #define IGB_IS_NOT_OACTIVE(txr) ((txr)->tx_avail >= (txr)->oact_hi_desc)
412 #endif /* _IF_IGB_H_ */