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