1 /**************************************************************************
2
3 Copyright (c) 2001-2003, 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
34 /*$FreeBSD: if_em.h,v 1.24 2003/11/14 18:02:24 pdeuskar Exp $*/
35 /* $OpenBSD: if_em.h,v 1.5 2004/04/26 17:17:15 deraadt Exp $ */
36
37 #ifndef _EM_H_DEFINED_
38 #define _EM_H_DEFINED_
39
40 #include <dev/pci/if_em_hw.h>
41
42 /* Tunables */
43
44 /*
45 * EM_MAX_TXD: Maximum number of Transmit Descriptors
46 * Valid Range: 80-256 for 82542 and 82543-based adapters
47 * 80-4096 for others
48 * Default Value: 256
49 * This value is the number of transmit descriptors allocated by the driver.
50 * Increasing this value allows the driver to queue more transmits. Each
51 * descriptor is 16 bytes.
52 */
53 #define EM_MIN_TXD 12
54 #define EM_MAX_TXD 256
55
56 /*
57 * EM_MAX_RXD - Maximum number of receive Descriptors
58 * Valid Range: 80-256 for 82542 and 82543-based adapters
59 * 80-4096 for others
60 * Default Value: 256
61 * This value is the number of receive descriptors allocated by the driver.
62 * Increasing this value allows the driver to buffer more incoming packets.
63 * Each descriptor is 16 bytes. A receive buffer is also allocated for each
64 * descriptor. The maximum MTU size is 16110.
65 *
66 */
67 #define EM_MIN_RXD 12
68 #define EM_MAX_RXD 256
69
70 /*
71 * EM_TIDV - Transmit Interrupt Delay Value
72 * Valid Range: 0-65535 (0=off)
73 * Default Value: 64
74 * This value delays the generation of transmit interrupts in units of
75 * 1.024 microseconds. Transmit interrupt reduction can improve CPU
76 * efficiency if properly tuned for specific network traffic. If the
77 * system is reporting dropped transmits, this value may be set too high
78 * causing the driver to run out of available transmit descriptors.
79 */
80 #define EM_TIDV 64
81
82 /*
83 * EM_TADV - Transmit Absolute Interrupt Delay Value (Not valid for 82542/82543/82544)
84 * Valid Range: 0-65535 (0=off)
85 * Default Value: 64
86 * This value, in units of 1.024 microseconds, limits the delay in which a
87 * transmit interrupt is generated. Useful only if EM_TIDV is non-zero,
88 * this value ensures that an interrupt is generated after the initial
89 * packet is sent on the wire within the set amount of time. Proper tuning,
90 * along with EM_TIDV, may improve traffic throughput in specific
91 * network conditions.
92 */
93 #define EM_TADV 64
94
95 /*
96 * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer)
97 * Valid Range: 0-65535 (0=off)
98 * Default Value: 0
99 * This value delays the generation of receive interrupts in units of 1.024
100 * microseconds. Receive interrupt reduction can improve CPU efficiency if
101 * properly tuned for specific network traffic. Increasing this value adds
102 * extra latency to frame reception and can end up decreasing the throughput
103 * of TCP traffic. If the system is reporting dropped receives, this value
104 * may be set too high, causing the driver to run out of available receive
105 * descriptors.
106 *
107 * CAUTION: When setting EM_RDTR to a value other than 0, adapters
108 * may hang (stop transmitting) under certain network conditions.
109 * If this occurs a WATCHDOG message is logged in the system event log.
110 * In addition, the controller is automatically reset, restoring the
111 * network connection. To eliminate the potential for the hang
112 * ensure that EM_RDTR is set to 0.
113 */
114 #define EM_RDTR 0
115
116 /*
117 * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544)
118 * Valid Range: 0-65535 (0=off)
119 * Default Value: 64
120 * This value, in units of 1.024 microseconds, limits the delay in which a
121 * receive interrupt is generated. Useful only if EM_RDTR is non-zero,
122 * this value ensures that an interrupt is generated after the initial
123 * packet is received within the set amount of time. Proper tuning,
124 * along with EM_RDTR, may improve traffic throughput in specific network
125 * conditions.
126 */
127 #define EM_RADV 64
128
129
130 /*
131 * This parameter controls the maximum no of times the driver will loop
132 * in the isr.
133 * Minimum Value = 1
134 */
135 #define EM_MAX_INTR 3
136
137 /*
138 * Inform the stack about transmit checksum offload capabilities.
139 */
140 #define EM_CHECKSUM_FEATURES (CSUM_TCP | CSUM_UDP)
141
142 /*
143 * This parameter controls the duration of transmit watchdog timer.
144 */
145 #define EM_TX_TIMEOUT 5 /* set to 5 seconds */
146
147 /*
148 * This parameter controls when the driver calls the routine to reclaim
149 * transmit descriptors.
150 */
151 #define EM_TX_CLEANUP_THRESHOLD EM_MAX_TXD / 8
152
153 /*
154 * This parameter controls whether or not autonegotation is enabled.
155 * 0 - Disable autonegotiation
156 * 1 - Enable autonegotiation
157 */
158 #define DO_AUTO_NEG 1
159
160 /*
161 * This parameter control whether or not the driver will wait for
162 * autonegotiation to complete.
163 * 1 - Wait for autonegotiation to complete
164 * 0 - Don't wait for autonegotiation to complete
165 */
166 #define WAIT_FOR_AUTO_NEG_DEFAULT 0
167
168 /*
169 * EM_MASTER_SLAVE is only defined to enable a workaround for a known compatibility issue
170 * with 82541/82547 devices and some switches. See the "Known Limitations" section of
171 * the README file for a complete description and a list of affected switches.
172 *
173 * 0 = Hardware default
174 * 1 = Master mode
175 * 2 = Slave mode
176 * 3 = Auto master/slave
177 */
178 /* #define EM_MASTER_SLAVE 2 */
179
180 /* Tunables -- End */
181
182 #define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
183 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
184 ADVERTISE_1000_FULL)
185
186 #define EM_VENDOR_ID 0x8086
187 #define EM_MMBA 0x0010 /* Mem base address */
188 #define EM_ROUNDUP(size, unit) (((size) + (unit) - 1) & ~((unit) - 1))
189
190 #define EM_JUMBO_PBA 0x00000028
191 #define EM_DEFAULT_PBA 0x00000030
192 #define EM_SMARTSPEED_DOWNSHIFT 3
193 #define EM_SMARTSPEED_MAX 15
194
195
196 #define MAX_NUM_MULTICAST_ADDRESSES 128
197 #define PCI_ANY_ID (~0U)
198 #define ETHER_ALIGN 2
199
200 /* Defines for printing debug information */
201 #define DEBUG_INIT 0
202 #define DEBUG_IOCTL 0
203 #define DEBUG_HW 0
204
205 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n")
206 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A)
207 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B)
208 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n")
209 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A)
210 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B)
211 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n")
212 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A)
213 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B)
214
215
216 /* Supported RX Buffer Sizes */
217 #define EM_RXBUFFER_2048 2048
218 #define EM_RXBUFFER_4096 4096
219 #define EM_RXBUFFER_8192 8192
220 #define EM_RXBUFFER_16384 16384
221
222 #define EM_MAX_SCATTER 64
223
224 /* ******************************************************************************
225 * vendor_info_array
226 *
227 * This array contains the list of Subvendor/Subdevice IDs on which the driver
228 * should load.
229 *
230 * ******************************************************************************/
231 #ifdef __FreeBSD__
232 typedef struct _em_vendor_info_t {
233 unsigned int vendor_id;
234 unsigned int device_id;
235 unsigned int subvendor_id;
236 unsigned int subdevice_id;
237 unsigned int index;
238 } em_vendor_info_t;
239 #endif /* __FreeBSD__ */
240
241
242 struct em_buffer {
243 struct mbuf *m_head;
244 bus_dmamap_t map; /* bus_dma map for packet */
245 };
246
247 struct em_q {
248 bus_dmamap_t map; /* bus_dma map for packet */
249 #ifdef __FreeBSD__
250 int nsegs; /* # of segments/descriptors */
251 bus_dma_segment_t segs[EM_MAX_SCATTER];
252 #endif /* __FreeBSD__ */
253 };
254
255 /*
256 * Bus dma allocation structure used by
257 * em_dma_malloc and em_dma_free.
258 */
259 struct em_dma_alloc {
260 bus_addr_t dma_paddr;
261 caddr_t dma_vaddr;
262 bus_dma_tag_t dma_tag;
263 bus_dmamap_t dma_map;
264 bus_dma_segment_t dma_seg;
265 bus_size_t dma_size;
266 int dma_nseg;
267 };
268
269 typedef enum _XSUM_CONTEXT_T {
270 OFFLOAD_NONE,
271 OFFLOAD_TCP_IP,
272 OFFLOAD_UDP_IP
273 } XSUM_CONTEXT_T;
274
275 struct em_softc;
276 struct em_int_delay_info {
277 struct em_softc *sc; /* Back-pointer to the sc struct */
278 int offset; /* Register offset to read/write */
279 int value; /* Current value in usecs */
280 };
281
282 /* For 82544 PCIX Workaround */
283 typedef struct _ADDRESS_LENGTH_PAIR
284 {
285 u_int64_t address;
286 u_int32_t length;
287 } ADDRESS_LENGTH_PAIR, *PADDRESS_LENGTH_PAIR;
288
289 typedef struct _DESCRIPTOR_PAIR
290 {
291 ADDRESS_LENGTH_PAIR descriptor[4];
292 u_int32_t elements;
293 } DESC_ARRAY, *PDESC_ARRAY;
294
295 /* Our adapter structure */
296 struct em_softc {
297 #ifdef __OpenBSD__
298 struct device sc_dv;
299 #endif
300 struct arpcom interface_data;
301 struct em_softc *next;
302 struct em_softc *prev;
303 struct em_hw hw;
304
305 /* FreeBSD operating-system-specific structures */
306 struct em_osdep osdep;
307 #ifdef __FreeBSD__
308 struct device *dev;
309 struct resource *res_memory;
310 struct resource *res_ioport;
311 struct resource *res_interrupt;
312 void *int_handler_tag;
313 #endif /* __FreeBSD__ */
314 struct ifmedia media;
315 #ifdef __FreeBSD__
316 struct callout timer;
317 struct callout tx_fifo_timer;
318 #endif /* __FreeBSD__ */
319 int io_rid;
320 #ifdef __FreeBSD__
321 u_int8_t unit;
322 struct mtx mtx;
323 #endif /* __FreeBSD__ */
324
325 #ifdef __OpenBSD__
326 void *sc_intrhand;
327 struct timeout em_intr_enable;
328 struct timeout timer_handle;
329 struct timeout tx_fifo_timer_handle;
330 #endif /* __OpenBSD__ */
331
332 /* Info about the board itself */
333 u_int32_t part_num;
334 u_int8_t link_active;
335 u_int16_t link_speed;
336 u_int16_t link_duplex;
337 u_int32_t smartspeed;
338 struct em_int_delay_info tx_int_delay;
339 struct em_int_delay_info tx_abs_int_delay;
340 struct em_int_delay_info rx_int_delay;
341 struct em_int_delay_info rx_abs_int_delay;
342
343 XSUM_CONTEXT_T active_checksum_context;
344
345 /*
346 * Transmit definitions
347 *
348 * We have an array of num_tx_desc descriptors (handled
349 * by the controller) paired with an array of tx_buffers
350 * (at tx_buffer_area).
351 * The index of the next available descriptor is next_avail_tx_desc.
352 * The number of remaining tx_desc is num_tx_desc_avail.
353 */
354 struct em_dma_alloc txdma; /* bus_dma glue for tx desc */
355 struct em_tx_desc *tx_desc_base;
356 u_int32_t next_avail_tx_desc;
357 u_int32_t oldest_used_tx_desc;
358 volatile u_int16_t num_tx_desc_avail;
359 u_int16_t num_tx_desc;
360 u_int32_t txd_cmd;
361 struct em_buffer *tx_buffer_area;
362 bus_dma_tag_t txtag; /* dma tag for tx */
363
364 /*
365 * Receive definitions
366 *
367 * we have an array of num_rx_desc rx_desc (handled by the
368 * controller), and paired with an array of rx_buffers
369 * (at rx_buffer_area).
370 * The next pair to check on receive is at offset next_rx_desc_to_check
371 */
372 struct em_dma_alloc rxdma; /* bus_dma glue for rx desc */
373 struct em_rx_desc *rx_desc_base;
374 u_int32_t next_rx_desc_to_check;
375 u_int16_t num_rx_desc;
376 u_int32_t rx_buffer_len;
377 struct em_buffer *rx_buffer_area;
378 bus_dma_tag_t rxtag;
379
380 /* Jumbo frame */
381 struct mbuf *fmp;
382 struct mbuf *lmp;
383
384 u_int16_t tx_fifo_head;
385
386 #ifdef __FreeBSD__
387 struct sysctl_ctx_list sysctl_ctx;
388 struct sysctl_oid *sysctl_tree;
389 #endif /* __FreeBSD__ */
390
391 /* Misc stats maintained by the driver */
392 unsigned long dropped_pkts;
393 unsigned long mbuf_alloc_failed;
394 unsigned long mbuf_cluster_failed;
395 unsigned long no_tx_desc_avail1;
396 unsigned long no_tx_desc_avail2;
397 unsigned long no_tx_map_avail;
398 unsigned long no_tx_dma_setup;
399 u_int64_t tx_fifo_reset;
400 u_int64_t tx_fifo_wrk;
401
402 /* For 82544 PCIX Workaround */
403 boolean_t pcix_82544;
404 boolean_t in_detach;
405
406 #ifdef DBG_STATS
407 unsigned long no_pkts_avail;
408 unsigned long clean_tx_interrupts;
409
410 #endif
411 struct em_hw_stats stats;
412 };
413
414 #ifdef __FreeBSD__
415 #define EM_LOCK_INIT(_sc, _name) \
416 mtx_init(&(_sc)->mtx, _name, MTX_NETWORK_LOCK, MTX_DEF)
417 #define EM_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->mtx)
418 #define EM_LOCK(_sc) mtx_lock(&(_sc)->mtx)
419 #define EM_UNLOCK(_sc) mtx_unlock(&(_sc)->mtx)
420 #define EM_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->mtx, MA_OWNED)
421 #endif /* __FreeBSD__ */
422
423 #ifdef __OpenBSD__
424 static inline int spl_use_arg(void *);
spl_use_arg(void * v)425 static inline int spl_use_arg(void *v) { return splnet(); }
426 #define EM_LOCK_INIT(_sc, _name)
427 #define EM_LOCK_DESTROY(_sc)
428 #define EM_LOCK_STATE() int em_hidden_splnet_s
429 #define EM_LOCK(_sc) em_hidden_splnet_s = spl_use_arg(_sc)
430 #define EM_UNLOCK(_sc) splx(em_hidden_splnet_s)
431 #define EM_LOCK_ASSERT(_sc) splassert(IPL_NET)
432 #endif /* __OpenBSD__ */
433
434 #endif /* _EM_H_DEFINED_ */
435