em: Utilize mbuf's header length to setup TX csum context
[dragonfly.git] / sys / dev / netif / em / if_em.h
CommitLineData
9c80d176
SZ
1/*
2 * Copyright (c) 2001-2008, Intel Corporation
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * 3. Neither the name of the Intel Corporation nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
984263bc 31
9c80d176
SZ
32#ifndef _IF_EM_H_
33#define _IF_EM_H_
984263bc 34
984263bc
MD
35/* Tunables */
36
37/*
1eca7b82 38 * EM_TXD: Maximum number of Transmit Descriptors
9f60d74b
SZ
39 * Valid Range: 256 for 82542 and 82543-based adapters
40 * 256-4096 for others
984263bc
MD
41 * Default Value: 256
42 * This value is the number of transmit descriptors allocated by the driver.
43 * Increasing this value allows the driver to queue more transmits. Each
44 * descriptor is 16 bytes.
1eca7b82
SZ
45 * Since TDLEN should be multiple of 128bytes, the number of transmit
46 * desscriptors should meet the following condition.
9c80d176 47 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
984263bc 48 */
9f60d74b
SZ
49#define EM_MIN_TXD 256
50#define EM_MAX_TXD_82543 EM_MIN_TXD
9c80d176 51#define EM_MAX_TXD 4096
df2de25f 52#define EM_DEFAULT_TXD 512
984263bc
MD
53
54/*
1eca7b82 55 * EM_RXD - Maximum number of receive Descriptors
9f60d74b
SZ
56 * Valid Range: 256 for 82542 and 82543-based adapters
57 * 256-4096 for others
984263bc
MD
58 * Default Value: 256
59 * This value is the number of receive descriptors allocated by the driver.
60 * Increasing this value allows the driver to buffer more incoming packets.
61 * Each descriptor is 16 bytes. A receive buffer is also allocated for each
62 * descriptor. The maximum MTU size is 16110.
1eca7b82
SZ
63 * Since TDLEN should be multiple of 128bytes, the number of transmit
64 * desscriptors should meet the following condition.
9c80d176 65 * (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
984263bc 66 */
9f60d74b
SZ
67#define EM_MIN_RXD 256
68#define EM_MAX_RXD_82543 EM_MIN_RXD
9c80d176 69#define EM_MAX_RXD 4096
df2de25f 70#define EM_DEFAULT_RXD 512
984263bc
MD
71
72/*
9ccd8c1f 73 * EM_TIDV - Transmit Interrupt Delay Value
984263bc
MD
74 * Valid Range: 0-65535 (0=off)
75 * Default Value: 64
76 * This value delays the generation of transmit interrupts in units of
77 * 1.024 microseconds. Transmit interrupt reduction can improve CPU
78 * efficiency if properly tuned for specific network traffic. If the
79 * system is reporting dropped transmits, this value may be set too high
80 * causing the driver to run out of available transmit descriptors.
91e8debf
SZ
81 *
82 * NOTE:
83 * It is not used. In DragonFly the TX interrupt moderation is done by
84 * conditionally setting RS bit in TX descriptors. See the description
85 * in struct adapter.
984263bc 86 */
9c80d176 87#define EM_TIDV 64
984263bc
MD
88
89/*
87307ba1
SZ
90 * EM_TADV - Transmit Absolute Interrupt Delay Value
91 * (Not valid for 82542/82543/82544)
984263bc
MD
92 * Valid Range: 0-65535 (0=off)
93 * Default Value: 64
94 * This value, in units of 1.024 microseconds, limits the delay in which a
0d366ee7 95 * transmit interrupt is generated. Useful only if EM_TIDV is non-zero,
984263bc
MD
96 * this value ensures that an interrupt is generated after the initial
97 * packet is sent on the wire within the set amount of time. Proper tuning,
0d366ee7 98 * along with EM_TIDV, may improve traffic throughput in specific
984263bc 99 * network conditions.
91e8debf
SZ
100 *
101 * NOTE:
102 * It is not used. In DragonFly the TX interrupt moderation is done by
103 * conditionally setting RS bit in TX descriptors. See the description
104 * in struct adapter.
984263bc 105 */
9c80d176 106#define EM_TADV 64
984263bc
MD
107
108/*
2cc36323 109 * Receive Interrupt Delay Timer (Packet Timer)
984263bc 110 *
2cc36323
SZ
111 * NOTE:
112 * RDTR and RADV are deprecated; use ITR instead. They are only used to
113 * workaround hardware bug on certain 82573 based NICs.
984263bc 114 */
2cc36323 115#define EM_RDTR_82573 32
984263bc
MD
116
117/*
0d366ee7 118 * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544)
2cc36323
SZ
119 *
120 * NOTE:
121 * RDTR and RADV are deprecated; use ITR instead. They are only used to
122 * workaround hardware bug on certain 82573 based NICs.
984263bc 123 */
2cc36323 124#define EM_RADV_82573 64
984263bc
MD
125
126/*
127 * This parameter controls the duration of transmit watchdog timer.
128 */
9c80d176
SZ
129#define EM_TX_TIMEOUT 5
130
dc07210e
SZ
131/* One for TX csum offloading desc, the other 2 are reserved */
132#define EM_TX_RESERVED 3
9c80d176
SZ
133
134/* Large enough for 16K jumbo frame */
135#define EM_TX_SPARE 8
136
9f60d74b
SZ
137#define EM_TX_OACTIVE_MAX 64
138
9c80d176 139/* Interrupt throttle rate */
3245f71e 140#define EM_DEFAULT_ITR 6000
984263bc
MD
141
142/*
984263bc
MD
143 * This parameter controls whether or not autonegotation is enabled.
144 * 0 - Disable autonegotiation
145 * 1 - Enable autonegotiation
146 */
9c80d176 147#define DO_AUTO_NEG 1
984263bc
MD
148
149/*
150 * This parameter control whether or not the driver will wait for
151 * autonegotiation to complete.
152 * 1 - Wait for autonegotiation to complete
153 * 0 - Don't wait for autonegotiation to complete
154 */
9c80d176 155#define WAIT_FOR_AUTO_NEG_DEFAULT 0
984263bc
MD
156
157/* Tunables -- End */
158
9c80d176
SZ
159#define AUTONEG_ADV_DEFAULT (ADVERTISE_10_HALF | \
160 ADVERTISE_10_FULL | \
161 ADVERTISE_100_HALF | \
162 ADVERTISE_100_FULL | \
163 ADVERTISE_1000_FULL)
984263bc 164
9c80d176 165#define AUTO_ALL_MODES 0
984263bc 166
9c80d176
SZ
167/* PHY master/slave setting */
168#define EM_MASTER_SLAVE e1000_ms_hw_default
984263bc 169
9c80d176
SZ
170/*
171 * Micellaneous constants
172 */
173#define EM_VENDOR_ID 0x8086
87307ba1 174
9c80d176
SZ
175#define EM_BAR_MEM PCIR_BAR(0)
176#define EM_BAR_FLASH PCIR_BAR(1)
177
178#define EM_JUMBO_PBA 0x00000028
179#define EM_DEFAULT_PBA 0x00000030
180#define EM_SMARTSPEED_DOWNSHIFT 3
181#define EM_SMARTSPEED_MAX 15
182#define EM_MAX_INTR 10
183
184#define MAX_NUM_MULTICAST_ADDRESSES 128
185#define PCI_ANY_ID (~0U)
186#define EM_FC_PAUSE_TIME 1000
187#define EM_EEPROM_APME 0x400;
87307ba1
SZ
188
189/*
190 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
191 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will
192 * also optimize cache line size effect. H/W supports up to cache line size 128.
193 */
194#define EM_DBA_ALIGN 128
195
9c80d176 196#define SPEED_MODE_BIT (1 << 21) /* On PCI-E MACs only */
87307ba1
SZ
197
198/* PCI Config defines */
199#define EM_BAR_TYPE(v) ((v) & EM_BAR_TYPE_MASK)
200#define EM_BAR_TYPE_MASK 0x00000001
201#define EM_BAR_TYPE_MMEM 0x00000000
202#define EM_BAR_TYPE_IO 0x00000001
203#define EM_BAR_MEM_TYPE(v) ((v) & EM_BAR_MEM_TYPE_MASK)
204#define EM_BAR_MEM_TYPE_MASK 0x00000006
205#define EM_BAR_MEM_TYPE_32BIT 0x00000000
206#define EM_BAR_MEM_TYPE_64BIT 0x00000004
207
9c80d176
SZ
208#define EM_MAX_SCATTER 64
209#define EM_TSO_SIZE (65535 + \
210 sizeof(struct ether_vlan_header))
211#define EM_MAX_SEGSIZE 4096
212#define EM_MSIX_MASK 0x01F00000 /* For 82574 use */
213#define ETH_ZLEN 60
214
215#define EM_CSUM_FEATURES (CSUM_IP | CSUM_TCP | CSUM_UDP)
9c80d176 216
87307ba1 217/*
9c80d176
SZ
218 * 82574 has a nonstandard address for EIAC
219 * and since its only used in MSIX, and in
220 * the em driver only 82574 uses MSIX we can
221 * solve it just using this define.
87307ba1 222 */
9c80d176 223#define EM_EIAC 0x000DC
984263bc 224
9c80d176
SZ
225/* Used in for 82547 10Mb Half workaround */
226#define EM_PBA_BYTES_SHIFT 0xA
227#define EM_TX_HEAD_ADDR_SHIFT 7
228#define EM_PBA_TX_MASK 0xFFFF0000
229#define EM_FIFO_HDR 0x10
230#define EM_82547_PKT_THRESH 0x3e0
984263bc 231
9ccd8c1f
JS
232/*
233 * Bus dma allocation structure used by
f7b52b45 234 * em_dma_malloc and em_dma_free.
9ccd8c1f
JS
235 */
236struct em_dma_alloc {
237 bus_addr_t dma_paddr;
9c80d176 238 void *dma_vaddr;
9ccd8c1f
JS
239 bus_dma_tag_t dma_tag;
240 bus_dmamap_t dma_map;
9ccd8c1f 241};
984263bc 242
9c80d176
SZ
243/* Our adapter structure */
244struct adapter {
245 struct arpcom arpcom;
246 struct e1000_hw hw;
87ab432b 247 int flags;
79878f87
SZ
248#define EM_FLAG_SHARED_INTR 0x0001
249#define EM_FLAG_HAS_MGMT 0x0002
250#define EM_FLAG_HAS_AMT 0x0004
251#define EM_FLAG_HW_CTRL 0x0008
984263bc 252
9c80d176
SZ
253 /* DragonFly operating-system-specific structures. */
254 struct e1000_osdep osdep;
255 device_t dev;
0d366ee7 256
9c80d176 257 bus_dma_tag_t parent_dtag;
0d366ee7 258
9c80d176
SZ
259 struct resource *memory;
260 int memory_rid;
261 struct resource *flash;
262 int flash_rid;
9ccd8c1f 263
9c80d176
SZ
264 struct resource *ioport;
265 int io_rid;
266
267 struct resource *intr_res;
268 void *intr_tag;
269 int intr_rid;
053f3ae6 270 int intr_type;
9c80d176
SZ
271
272 struct ifmedia media;
273 struct callout timer;
274 struct callout tx_fifo_timer;
275 int if_flags;
276 int max_frame_size;
277 int min_frame_size;
278
79878f87 279 /* WOL register value */
9c80d176 280 int wol;
2d0e5700
SZ
281
282 /* Multicast array memory */
283 uint8_t *mta;
984263bc
MD
284
285 /* Info about the board itself */
9c80d176
SZ
286 uint8_t link_active;
287 uint16_t link_speed;
288 uint16_t link_duplex;
289 uint32_t smartspeed;
9c80d176 290 int int_throttle_ceil;
984263bc
MD
291
292 /*
87307ba1
SZ
293 * Transmit definitions
294 *
295 * We have an array of num_tx_desc descriptors (handled
296 * by the controller) paired with an array of tx_buffers
297 * (at tx_buffer_area).
298 * The index of the next available descriptor is next_avail_tx_desc.
299 * The number of remaining tx_desc is num_tx_desc_avail.
300 */
9ccd8c1f 301 struct em_dma_alloc txdma; /* bus_dma glue for tx desc */
9c80d176 302 struct e1000_tx_desc *tx_desc_base;
9f60d74b 303 struct em_buffer *tx_buffer_area;
87307ba1
SZ
304 uint32_t next_avail_tx_desc;
305 uint32_t next_tx_to_clean;
9c80d176
SZ
306 int num_tx_desc_avail;
307 int num_tx_desc;
9ccd8c1f 308 bus_dma_tag_t txtag; /* dma tag for tx */
9c80d176 309 int spare_tx_desc;
9f60d74b 310 int oact_tx_desc;
984263bc 311
51e6819f
SZ
312 /* Saved csum offloading context information */
313 int csum_flags;
ed4fc0fe 314 int csum_lhlen;
51e6819f
SZ
315 int csum_iphlen;
316 uint32_t csum_txd_upper;
317 uint32_t csum_txd_lower;
318
319 /*
9f60d74b
SZ
320 * Variables used to reduce TX interrupt rate and
321 * number of device's TX ring write requests.
322 *
323 * tx_nsegs:
324 * Number of TX descriptors setup so far.
325 *
326 * tx_int_nsegs:
327 * Once tx_nsegs > tx_int_nsegs, RS bit will be set
328 * in the last TX descriptor of the packet, and
329 * tx_nsegs will be reset to 0. So TX interrupt and
330 * TX ring write request should be generated roughly
331 * every tx_int_nsegs TX descriptors.
332 *
333 * tx_dd[]:
334 * Index of the TX descriptors which have RS bit set,
335 * i.e. DD bit will be set on this TX descriptor after
336 * the data of the TX descriptor are transfered to
337 * hardware's internal packet buffer. Only the TX
338 * descriptors listed in tx_dd[] will be checked upon
339 * TX interrupt. This array is used as circular ring.
340 *
341 * tx_dd_tail, tx_dd_head:
342 * Tail and head index of valid elements in tx_dd[].
343 * tx_dd_tail == tx_dd_head means there is no valid
344 * elements in tx_dd[]. tx_dd_tail points to the position
345 * which is one beyond the last valid element in tx_dd[].
346 * tx_dd_head points to the first valid element in
347 * tx_dd[].
348 */
349 int tx_int_nsegs;
350 int tx_nsegs;
351 int tx_dd_tail;
352 int tx_dd_head;
353#define EM_TXDD_MAX 64
af2ee69f 354#define EM_TXDD_SAFE 48 /* must be less than EM_TXDD_MAX */
9f60d74b
SZ
355 int tx_dd[EM_TXDD_MAX];
356
357 /*
984263bc 358 * Receive definitions
87307ba1
SZ
359 *
360 * we have an array of num_rx_desc rx_desc (handled by the
361 * controller), and paired with an array of rx_buffers
362 * (at rx_buffer_area).
363 * The next pair to check on receive is at offset next_rx_desc_to_check
364 */
9ccd8c1f 365 struct em_dma_alloc rxdma; /* bus_dma glue for rx desc */
9c80d176 366 struct e1000_rx_desc *rx_desc_base;
87307ba1 367 uint32_t next_rx_desc_to_check;
87307ba1 368 uint32_t rx_buffer_len;
9c80d176 369 int num_rx_desc;
87307ba1 370 struct em_buffer *rx_buffer_area;
9ccd8c1f 371 bus_dma_tag_t rxtag;
9c80d176 372 bus_dmamap_t rx_sparemap;
984263bc 373
87307ba1
SZ
374 /*
375 * First/last mbuf pointers, for
376 * collecting multisegment RX packets.
377 */
378 struct mbuf *fmp;
379 struct mbuf *lmp;
984263bc 380
9c80d176
SZ
381 /* Misc stats maintained by the driver */
382 unsigned long dropped_pkts;
383 unsigned long mbuf_alloc_failed;
384 unsigned long mbuf_cluster_failed;
385 unsigned long no_tx_desc_avail1;
386 unsigned long no_tx_desc_avail2;
387 unsigned long no_tx_map_avail;
388 unsigned long no_tx_dma_setup;
389 unsigned long watchdog_events;
390 unsigned long rx_overruns;
391 unsigned long rx_irq;
392 unsigned long tx_irq;
393 unsigned long link_irq;
394
395 /* sysctl tree glue */
87307ba1
SZ
396 struct sysctl_ctx_list sysctl_ctx;
397 struct sysctl_oid *sysctl_tree;
984263bc 398
9c80d176
SZ
399 /* 82547 workaround */
400 uint32_t tx_fifo_size;
401 uint32_t tx_fifo_head;
402 uint32_t tx_fifo_head_addr;
403 uint64_t tx_fifo_reset_cnt;
404 uint64_t tx_fifo_wrk_cnt;
405 uint32_t tx_head_addr;
406
407 /* For 82544 PCIX Workaround */
408 boolean_t pcix_82544;
9c80d176
SZ
409
410 struct e1000_hw_stats stats;
411};
412
413struct em_vendor_info {
414 uint16_t vendor_id;
415 uint16_t device_id;
96ced48a 416 int ret;
9c80d176
SZ
417 const char *desc;
418};
419
420struct em_buffer {
9c80d176
SZ
421 struct mbuf *m_head;
422 bus_dmamap_t map; /* bus_dma map for packet */
984263bc
MD
423};
424
9c80d176
SZ
425/* For 82544 PCIX Workaround */
426typedef struct _ADDRESS_LENGTH_PAIR {
427 uint64_t address;
428 uint32_t length;
429} ADDRESS_LENGTH_PAIR, *PADDRESS_LENGTH_PAIR;
430
431typedef struct _DESCRIPTOR_PAIR {
432 ADDRESS_LENGTH_PAIR descriptor[4];
433 uint32_t elements;
434} DESC_ARRAY, *PDESC_ARRAY;
435
436#define EM_IS_OACTIVE(adapter) \
9f60d74b
SZ
437 ((adapter)->num_tx_desc_avail <= (adapter)->oact_tx_desc)
438
439#define EM_INC_TXDD_IDX(idx) \
440do { \
441 if (++(idx) == EM_TXDD_MAX) \
442 (idx) = 0; \
443} while (0)
9c80d176
SZ
444
445#endif /* _IF_EM_H_ */