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