if_em.h revision 114554 
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: head/sys/dev/em/if_em.h 114554 2003-05-02 21:17:08Z pdeuskar $*/
35
36#ifndef _EM_H_DEFINED_
37#define _EM_H_DEFINED_
38
39
40#include <sys/param.h>
41#include <sys/systm.h>
42#include <sys/mbuf.h>
43#include <sys/protosw.h>
44#include <sys/socket.h>
45#include <sys/malloc.h>
46#include <sys/kernel.h>
47#include <sys/sockio.h>
48
49#include <net/if.h>
50#include <net/if_arp.h>
51#include <net/ethernet.h>
52#include <net/if_dl.h>
53#include <net/if_media.h>
54
55#include <net/bpf.h>
56#include <net/if_types.h>
57#include <net/if_vlan_var.h>
58
59#include <netinet/in_systm.h>
60#include <netinet/in.h>
61#include <netinet/ip.h>
62#include <netinet/tcp.h>
63#include <netinet/udp.h>
64
65#include <sys/bus.h>
66#include <machine/bus.h>
67#include <sys/rman.h>
68#include <machine/resource.h>
69#include <vm/vm.h>
70#include <vm/pmap.h>
71#include <machine/clock.h>
72#include <pci/pcivar.h>
73#include <pci/pcireg.h>
74#include <sys/endian.h>
75#include "opt_bdg.h"
76
77#include <dev/em/if_em_hw.h>
78
79/* Tunables */
80
81/*
82 * TxDescriptors
83 * Valid Range: 80-256 for 82542 and 82543-based adapters
84 *            80-4096 for 82540, 82544, 82545, and 82546-based adapters
85 * Default Value: 256
86 *   This value is the number of transmit descriptors allocated by the driver.
87 *   Increasing this value allows the driver to queue more transmits. Each
88 *   descriptor is 16 bytes.
89 */
90#define EM_MAX_TXD                      256
91
92/*
93 * RxDescriptors
94 * Valid Range: 80-256 for 82542 and 82543-based adapters
95 *            80-4096 for 82540, 82544, 82545, and 82546-based adapters
96 * Default Value: 256
97 *   This value is the number of receive descriptors allocated by the driver.
98 *   Increasing this value allows the driver to buffer more incoming packets.
99 *   Each descriptor is 16 bytes.  A receive buffer is also allocated for each
100 *   descriptor. The maximum MTU size is 16110.
101 *
102 */
103#define EM_MAX_RXD                      256
104
105/*
106 * TxIntDelay
107 * Valid Range: 0-65535 (0=off)
108 * Default Value: 64
109 *   This value delays the generation of transmit interrupts in units of
110 *   1.024 microseconds. Transmit interrupt reduction can improve CPU
111 *   efficiency if properly tuned for specific network traffic. If the
112 *   system is reporting dropped transmits, this value may be set too high
113 *   causing the driver to run out of available transmit descriptors.
114 */
115#define EM_TIDV                         64
116
117/*
118 * TxAbsIntDelay (82540, 82545, and 82546-based adapters only)
119 * Valid Range: 0-65535 (0=off)
120 * Default Value: 64
121 *   This value, in units of 1.024 microseconds, limits the delay in which a
122 *   transmit interrupt is generated. Useful only if TxIntDelay is non-zero,
123 *   this value ensures that an interrupt is generated after the initial
124 *   packet is sent on the wire within the set amount of time.  Proper tuning,
125 *   along with TxIntDelay, may improve traffic throughput in specific
126 *   network conditions.
127 */
128#define EM_TADV                         64
129
130/*
131 * RxIntDelay
132 * Valid Range: 0-65535 (0=off)
133 * Default Value: 0
134 *   This value delays the generation of receive interrupts in units of 1.024
135 *   microseconds.  Receive interrupt reduction can improve CPU efficiency if
136 *   properly tuned for specific network traffic. Increasing this value adds
137 *   extra latency to frame reception and can end up decreasing the throughput
138 *   of TCP traffic. If the system is reporting dropped receives, this value
139 *   may be set too high, causing the driver to run out of available receive
140 *   descriptors.
141 *
142 *   CAUTION: When setting RxIntDelay to a value other than 0, adapters
143 *            may hang (stop transmitting) under certain network conditions.
144 *            If this occurs a WATCHDOG message is logged in the system event log.
145 *            In addition, the controller is automatically reset, restoring the
146 *            network connection. To eliminate the potential for the hang
147 *            ensure that RxIntDelay is set to 0.
148 */
149#define EM_RDTR                         0
150
151/*
152 * RxAbsIntDelay (82540, 82545, and 82546-based adapters only)
153 * Valid Range: 0-65535 (0=off)
154 * Default Value: 64
155 *   This value, in units of 1.024 microseconds, limits the delay in which a
156 *   receive interrupt is generated. Useful only if RxIntDelay is non-zero,
157 *   this value ensures that an interrupt is generated after the initial
158 *   packet is received within the set amount of time.  Proper tuning,
159 *   along with RxIntDelay, may improve traffic throughput in specific network
160 *   conditions.
161 */
162#define EM_RADV                         64
163
164
165/*
166 * This parameter controls the maximum no of times the driver will loop
167 * in the isr.
168 *           Minimum Value = 1
169 */
170#define EM_MAX_INTR                     3
171
172/*
173 * Inform the stack about transmit checksum offload capabilities.
174 */
175#define EM_CHECKSUM_FEATURES            (CSUM_TCP | CSUM_UDP)
176
177/*
178 * This parameter controls the duration of transmit watchdog timer.
179 */
180#define EM_TX_TIMEOUT                   5    /* set to 5 seconds */
181
182/*
183 * This parameter controls when the driver calls the routine to reclaim
184 * transmit descriptors.
185 */
186#define EM_TX_CLEANUP_THRESHOLD         EM_MAX_TXD / 8
187
188/*
189 * This parameter controls whether or not autonegotation is enabled.
190 *              0 - Disable autonegotiation
191 *              1 - Enable  autonegotiation
192 */
193#define DO_AUTO_NEG                     1
194
195/*
196 * This parameter control whether or not the driver will wait for
197 * autonegotiation to complete.
198 *              1 - Wait for autonegotiation to complete
199 *              0 - Don't wait for autonegotiation to complete
200 */
201#define WAIT_FOR_AUTO_NEG_DEFAULT       1
202
203
204/* Tunables -- End */
205
206#define AUTONEG_ADV_DEFAULT             (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
207                                         ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
208                                         ADVERTISE_1000_FULL)
209
210#define EM_VENDOR_ID                    0x8086
211#define EM_MMBA                         0x0010 /* Mem base address */
212#define EM_ROUNDUP(size, unit) (((size) + (unit) - 1) & ~((unit) - 1))
213
214#define EM_JUMBO_PBA                    0x00000028
215#define EM_DEFAULT_PBA                  0x00000030
216#define EM_SMARTSPEED_DOWNSHIFT         3
217#define EM_SMARTSPEED_MAX               15
218
219
220#define MAX_NUM_MULTICAST_ADDRESSES     128
221#define PCI_ANY_ID                      (~0U)
222#define ETHER_ALIGN                     2
223
224/* Defines for printing debug information */
225#define DEBUG_INIT  0
226#define DEBUG_IOCTL 0
227#define DEBUG_HW    0
228
229#define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
230#define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
231#define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
232#define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
233#define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
234#define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
235#define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
236#define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
237#define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
238
239
240/* Supported RX Buffer Sizes */
241#define EM_RXBUFFER_2048        2048
242#define EM_RXBUFFER_4096        4096
243#define EM_RXBUFFER_8192        8192
244#define EM_RXBUFFER_16384      16384
245
246#define EM_MAX_SCATTER            64
247
248#ifdef __alpha__
249	#undef vtophys
250	#define vtophys(va)     alpha_XXX_dmamap((vm_offset_t)(va))
251#endif /* __alpha__ */
252
253/* ******************************************************************************
254 * vendor_info_array
255 *
256 * This array contains the list of Subvendor/Subdevice IDs on which the driver
257 * should load.
258 *
259 * ******************************************************************************/
260typedef struct _em_vendor_info_t {
261	unsigned int vendor_id;
262	unsigned int device_id;
263	unsigned int subvendor_id;
264	unsigned int subdevice_id;
265	unsigned int index;
266} em_vendor_info_t;
267
268
269struct em_buffer {
270        struct mbuf    *m_head;
271        bus_dmamap_t    map;         /* bus_dma map for packet */
272};
273
274struct em_q {
275        bus_dmamap_t       map;         /* bus_dma map for packet */
276        int                nsegs;       /* # of segments/descriptors */
277        bus_dma_segment_t  segs[EM_MAX_SCATTER];
278};
279
280/*
281 * Bus dma allocation structure used by
282 * em_dma_malloc and em_dma_free.
283 */
284struct em_dma_alloc {
285        u_int32_t               dma_paddr;
286        caddr_t                 dma_vaddr;
287        bus_dma_tag_t           dma_tag;
288        bus_dmamap_t            dma_map;
289        bus_dma_segment_t       dma_seg;
290        bus_size_t              dma_size;
291        int                     dma_nseg;
292};
293
294typedef enum _XSUM_CONTEXT_T {
295	OFFLOAD_NONE,
296	OFFLOAD_TCP_IP,
297	OFFLOAD_UDP_IP
298} XSUM_CONTEXT_T;
299
300/* Our adapter structure */
301struct adapter {
302	struct arpcom   interface_data;
303	struct adapter *next;
304	struct adapter *prev;
305	struct em_hw    hw;
306
307	/* FreeBSD operating-system-specific structures */
308	struct em_osdep osdep;
309	struct device   *dev;
310	struct resource *res_memory;
311	struct resource *res_ioport;
312	struct resource *res_interrupt;
313	void            *int_handler_tag;
314	struct ifmedia  media;
315	struct callout_handle timer_handle;
316	struct callout_handle tx_fifo_timer_handle;
317	int             io_rid;
318	u_int8_t        unit;
319
320	/* Info about the board itself */
321	u_int32_t       part_num;
322	u_int8_t        link_active;
323	u_int16_t       link_speed;
324	u_int16_t       link_duplex;
325	u_int32_t       smartspeed;
326	u_int32_t       tx_int_delay;
327	u_int32_t       tx_abs_int_delay;
328	u_int32_t       rx_int_delay;
329	u_int32_t       rx_abs_int_delay;
330
331	XSUM_CONTEXT_T  active_checksum_context;
332
333	/*
334         * Transmit definitions
335         *
336         * We have an array of num_tx_desc descriptors (handled
337         * by the controller) paired with an array of tx_buffers
338         * (at tx_buffer_area).
339         * The index of the next available descriptor is next_avail_tx_desc.
340         * The number of remaining tx_desc is num_tx_desc_avail.
341         */
342	struct em_dma_alloc txdma;              /* bus_dma glue for tx desc */
343        struct em_tx_desc *tx_desc_base;
344        u_int32_t          next_avail_tx_desc;
345	u_int32_t          oldest_used_tx_desc;
346        volatile u_int16_t num_tx_desc_avail;
347        u_int16_t          num_tx_desc;
348        u_int32_t          txd_cmd;
349        struct em_buffer   *tx_buffer_area;
350	bus_dma_tag_t      txtag;               /* dma tag for tx */
351
352	/*
353	 * Receive definitions
354         *
355         * we have an array of num_rx_desc rx_desc (handled by the
356         * controller), and paired with an array of rx_buffers
357         * (at rx_buffer_area).
358         * The next pair to check on receive is at offset next_rx_desc_to_check
359         */
360	struct em_dma_alloc rxdma;              /* bus_dma glue for rx desc */
361        struct em_rx_desc *rx_desc_base;
362        u_int32_t          next_rx_desc_to_check;
363        u_int16_t          num_rx_desc;
364        u_int32_t          rx_buffer_len;
365        struct em_buffer   *rx_buffer_area;
366	bus_dma_tag_t      rxtag;
367
368	/* Jumbo frame */
369	struct mbuf        *fmp;
370	struct mbuf        *lmp;
371
372	u_int16_t          tx_fifo_head;
373
374	/* Misc stats maintained by the driver */
375	unsigned long   dropped_pkts;
376	unsigned long   mbuf_alloc_failed;
377	unsigned long   mbuf_cluster_failed;
378	unsigned long   no_tx_desc_avail1;
379	unsigned long   no_tx_desc_avail2;
380	unsigned long   no_tx_map_avail;
381        unsigned long   no_tx_dma_setup;
382	u_int64_t       tx_fifo_reset;
383	u_int64_t       tx_fifo_wrk;
384
385#ifdef DBG_STATS
386	unsigned long   no_pkts_avail;
387	unsigned long   clean_tx_interrupts;
388
389#endif
390	struct em_hw_stats stats;
391};
392
393#endif                                                  /* _EM_H_DEFINED_ */
394