if_em.h revision 1.11 
1/**************************************************************************
2
3Copyright (c) 2001-2003, Intel Corporation
4All rights reserved.
5
6Redistribution and use in source and binary forms, with or without
7modification, 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
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30POSSIBILITY OF SUCH DAMAGE.
31
32***************************************************************************/
33
34/* $FreeBSD: if_em.h,v 1.26 2004/09/01 23:22:41 pdeuskar Exp $ */
35/* $OpenBSD: if_em.h,v 1.11 2005/05/04 02:33:31 brad 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
199/* Defines for printing debug information */
200#define DEBUG_INIT  0
201#define DEBUG_IOCTL 0
202#define DEBUG_HW    0
203
204#define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
205#define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
206#define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
207#define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
208#define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
209#define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
210#define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
211#define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
212#define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
213
214
215/* Supported RX Buffer Sizes */
216#define EM_RXBUFFER_2048        2048
217#define EM_RXBUFFER_4096        4096
218#define EM_RXBUFFER_8192        8192
219#define EM_RXBUFFER_16384      16384
220
221#define EM_MAX_SCATTER            64
222
223struct em_buffer {
224        struct mbuf    *m_head;
225	bus_dmamap_t	map;		/* bus_dma map for packet */
226};
227
228struct em_q {
229	bus_dmamap_t       map;         /* bus_dma map for packet */
230};
231
232/*
233 * Bus dma allocation structure used by
234 * em_dma_malloc and em_dma_free.
235 */
236struct em_dma_alloc {
237	bus_addr_t              dma_paddr;
238	caddr_t                 dma_vaddr;
239	bus_dma_tag_t           dma_tag;
240	bus_dmamap_t            dma_map;
241	bus_dma_segment_t       dma_seg;
242	bus_size_t              dma_size;
243	int                     dma_nseg;
244};
245
246typedef enum _XSUM_CONTEXT_T {
247	OFFLOAD_NONE,
248	OFFLOAD_TCP_IP,
249	OFFLOAD_UDP_IP
250} XSUM_CONTEXT_T;
251
252struct em_softc;
253struct em_int_delay_info {
254        struct em_softc *sc;    /* Back-pointer to the sc struct */
255        int offset;                     /* Register offset to read/write */
256        int value;                      /* Current value in usecs */
257};
258
259/* For 82544 PCIX  Workaround */
260typedef struct _ADDRESS_LENGTH_PAIR
261{
262    u_int64_t   address;
263    u_int32_t   length;
264} ADDRESS_LENGTH_PAIR, *PADDRESS_LENGTH_PAIR;
265
266typedef struct _DESCRIPTOR_PAIR
267{
268    ADDRESS_LENGTH_PAIR descriptor[4];
269    u_int32_t   elements;
270} DESC_ARRAY, *PDESC_ARRAY;
271
272/* Our adapter structure */
273struct em_softc {
274	struct device	sc_dv;
275	struct arpcom	interface_data;
276	struct em_softc *next;
277	struct em_softc *prev;
278	struct em_hw    hw;
279
280	/* OpenBSD operating-system-specific structures */
281	struct em_osdep osdep;
282	struct ifmedia  media;
283	int             io_rid;
284
285	void           *sc_intrhand;
286	struct timeout	em_intr_enable;
287	struct timeout	timer_handle;
288	struct timeout	tx_fifo_timer_handle;
289	void		*sc_powerhook;
290
291#ifdef __STRICT_ALIGNMENT
292	/* Used for carrying forward alignment adjustments */
293	unsigned char	align_buf[ETHER_ALIGN];	/* tail of unaligned packet */
294	u_int8_t	align_buf_len;		/* bytes in tail */
295#endif /* __STRICT_ALIGNMENT */
296
297	/* Info about the board itself */
298	u_int32_t       part_num;
299	u_int8_t        link_active;
300	u_int16_t       link_speed;
301	u_int16_t       link_duplex;
302	u_int32_t       smartspeed;
303	struct em_int_delay_info tx_int_delay;
304	struct em_int_delay_info tx_abs_int_delay;
305	struct em_int_delay_info rx_int_delay;
306	struct em_int_delay_info rx_abs_int_delay;
307
308	XSUM_CONTEXT_T  active_checksum_context;
309
310        /*
311         * Transmit definitions
312         *
313         * We have an array of num_tx_desc descriptors (handled
314         * by the controller) paired with an array of tx_buffers
315         * (at tx_buffer_area).
316         * The index of the next available descriptor is next_avail_tx_desc.
317         * The number of remaining tx_desc is num_tx_desc_avail.
318         */
319	struct em_dma_alloc	txdma;		/* bus_dma glue for tx desc */
320	struct em_tx_desc	*tx_desc_base;
321	u_int32_t		next_avail_tx_desc;
322	u_int32_t		oldest_used_tx_desc;
323	volatile u_int16_t	num_tx_desc_avail;
324	u_int16_t		num_tx_desc;
325	u_int32_t		txd_cmd;
326	struct em_buffer	*tx_buffer_area;
327	bus_dma_tag_t		txtag;		/* dma tag for tx */
328
329        /*
330         * Receive definitions
331         *
332         * we have an array of num_rx_desc rx_desc (handled by the
333         * controller), and paired with an array of rx_buffers
334         * (at rx_buffer_area).
335         * The next pair to check on receive is at offset next_rx_desc_to_check
336         */
337	struct em_dma_alloc	rxdma;		/* bus_dma glue for rx desc */
338	struct em_rx_desc	*rx_desc_base;
339	u_int32_t		next_rx_desc_to_check;
340	u_int16_t		num_rx_desc;
341	u_int32_t		rx_buffer_len;
342	struct em_buffer	*rx_buffer_area;
343	bus_dma_tag_t		rxtag;
344
345	/* Jumbo frame */
346	struct mbuf        *fmp;
347	struct mbuf        *lmp;
348
349	/* Misc stats maintained by the driver */
350	unsigned long   dropped_pkts;
351	unsigned long   mbuf_alloc_failed;
352	unsigned long   mbuf_cluster_failed;
353	unsigned long   no_tx_desc_avail1;
354	unsigned long   no_tx_desc_avail2;
355	unsigned long   no_tx_map_avail;
356        unsigned long   no_tx_dma_setup;
357
358	/* Used in for 82547 10Mb Half workaround */
359	#define EM_PBA_BYTES_SHIFT	0xA
360	#define EM_TX_HEAD_ADDR_SHIFT	7
361	#define EM_PBA_TX_MASK		0xFFFF0000
362	#define EM_FIFO_HDR              0x10
363
364	#define EM_82547_PKT_THRESH      0x3e0
365
366	u_int32_t       tx_fifo_size;
367	u_int32_t       tx_fifo_head;
368	u_int32_t       tx_fifo_head_addr;
369	u_int64_t       tx_fifo_reset_cnt;
370	u_int64_t       tx_fifo_wrk_cnt;
371	u_int32_t       tx_head_addr;
372
373        /* For 82544 PCIX Workaround */
374        boolean_t       pcix_82544;
375        boolean_t       in_detach;
376
377#ifdef DBG_STATS
378	unsigned long   no_pkts_avail;
379	unsigned long   clean_tx_interrupts;
380
381#endif
382	struct em_hw_stats stats;
383};
384
385static inline int spl_use_arg(void *);
386static inline int spl_use_arg(void *v) { return splnet(); }
387#define EM_LOCK_INIT(_sc, _name)
388#define EM_LOCK_DESTROY(_sc)
389#define EM_LOCK_STATE()		int em_hidden_splnet_s
390#define EM_LOCK(_sc)		em_hidden_splnet_s = spl_use_arg(_sc)
391#define EM_UNLOCK(_sc)		splx(em_hidden_splnet_s)
392#define EM_LOCK_ASSERT(_sc)	splassert(IPL_NET)
393
394#endif                                                  /* _EM_H_DEFINED_ */
395