bnx: Properly setup RX return ring cons index position
[dragonfly.git] / sys / dev / netif / bnx / if_bnxvar.h
1 /*
2  * Copyright (c) 2001 Wind River Systems
3  * Copyright (c) 1997, 1998, 1999, 2001
4  *      Bill Paul <wpaul@windriver.com>.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
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  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by Bill Paul.
17  * 4. Neither the name of the author nor the names of any co-contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31  * THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * $FreeBSD: src/sys/dev/bge/if_bgereg.h,v 1.1.2.16 2004/09/23 20:11:18 ps Exp $
34  * $DragonFly: src/sys/dev/netif/bge/if_bgereg.h,v 1.25 2008/10/22 14:24:24 sephe Exp $
35  */
36
37 #ifndef _IF_BNXVAR_H_
38 #define _IF_BNXVAR_H_
39
40 /*
41  * Tigon general information block. This resides in host memory
42  * and contains the status counters, ring control blocks and
43  * producer pointers.
44  */
45
46 struct bnx_gib {
47         struct bge_stats        bnx_stats;
48         struct bge_rcb          bnx_tx_rcb[16];
49         struct bge_rcb          bnx_std_rx_rcb;
50         struct bge_rcb          bnx_jumbo_rx_rcb;
51         struct bge_rcb          bnx_mini_rx_rcb;
52         struct bge_rcb          bnx_return_rcb;
53 };
54
55 #define BNX_MIN_FRAMELEN        60
56 #define BNX_MAX_FRAMELEN        1536
57 #define BNX_JUMBO_FRAMELEN      9018
58 #define BNX_JUMBO_MTU           (BNX_JUMBO_FRAMELEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
59
60 #define BNX_TIMEOUT             5000
61 #define BNX_FIRMWARE_TIMEOUT    100000
62 #define BNX_TXCONS_UNSET        0xFFFF  /* impossible value */
63
64 /*
65  * Other utility macros.
66  */
67 #define BNX_INC(x, y)           (x) = ((x) + 1) % (y)
68
69 /*
70  * Register access macros. The Tigon always uses memory mapped register
71  * accesses and all registers must be accessed with 32 bit operations.
72  */
73
74 #define CSR_WRITE_4(sc, reg, val)       \
75         bus_space_write_4(sc->bnx_btag, sc->bnx_bhandle, reg, val)
76
77 #define CSR_READ_4(sc, reg)             \
78         bus_space_read_4(sc->bnx_btag, sc->bnx_bhandle, reg)
79
80 #define BNX_SETBIT(sc, reg, x)  \
81         CSR_WRITE_4(sc, reg, (CSR_READ_4(sc, reg) | x))
82
83 #define BNX_CLRBIT(sc, reg, x)  \
84         CSR_WRITE_4(sc, reg, (CSR_READ_4(sc, reg) & ~x))
85
86 #define BNX_MEMWIN_READ(sc, x, val)                             \
87 do {                                                            \
88         pci_write_config(sc->bnx_dev, BGE_PCI_MEMWIN_BASEADDR,  \
89             (0xFFFF0000 & x), 4);                               \
90         val = CSR_READ_4(sc, BGE_MEMWIN_START + (x & 0xFFFF));  \
91 } while(0)
92
93 #define BNX_MEMWIN_WRITE(sc, x, val)                            \
94 do {                                                            \
95         pci_write_config(sc->bnx_dev, BGE_PCI_MEMWIN_BASEADDR,  \
96             (0xFFFF0000 & x), 4);                               \
97         CSR_WRITE_4(sc, BGE_MEMWIN_START + (x & 0xFFFF), val);  \
98 } while(0)
99
100 #define RCB_WRITE_4(sc, rcb, offset, val)                       \
101         bus_space_write_4(sc->bnx_btag, sc->bnx_bhandle,        \
102                           rcb + offsetof(struct bge_rcb, offset), val)
103
104 /*
105  * Memory management stuff. Note: the SSLOTS, MSLOTS and JSLOTS
106  * values are tuneable. They control the actual amount of buffers
107  * allocated for the standard, mini and jumbo receive rings.
108  */
109
110 #define BNX_SSLOTS      256
111 #define BNX_MSLOTS      256
112 #define BNX_JSLOTS      384
113
114 #define BNX_JRAWLEN (BNX_JUMBO_FRAMELEN + ETHER_ALIGN)
115 #define BNX_JLEN (BNX_JRAWLEN + \
116         (sizeof(uint64_t) - BNX_JRAWLEN % sizeof(uint64_t)))
117 #define BNX_JPAGESZ PAGE_SIZE
118 #define BNX_RESID (BNX_JPAGESZ - (BNX_JLEN * BNX_JSLOTS) % BNX_JPAGESZ)
119 #define BNX_JMEM ((BNX_JLEN * BNX_JSLOTS) + BNX_RESID)
120
121 struct bnx_softc;
122
123 struct bnx_jslot {
124         struct bnx_softc        *bnx_sc;
125         void                    *bnx_buf;
126         bus_addr_t              bnx_paddr;
127         int                     bnx_inuse;
128         int                     bnx_slot;
129         SLIST_ENTRY(bnx_jslot)  jslot_link;
130 };
131
132 /*
133  * Ring structures. Most of these reside in host memory and we tell
134  * the NIC where they are via the ring control blocks. The exceptions
135  * are the tx and command rings, which live in NIC memory and which
136  * we access via the shared memory window.
137  */
138 struct bnx_ring_data {
139         struct bge_rx_bd        *bnx_rx_jumbo_ring;
140         bus_addr_t              bnx_rx_jumbo_ring_paddr;
141         struct bge_status_block *bnx_status_block;
142         bus_addr_t              bnx_status_block_paddr;
143         void                    *bnx_jumbo_buf;
144         struct bnx_gib          bnx_info;
145 };
146
147 struct bnx_rx_buf {
148         bus_dmamap_t            bnx_rx_dmamap;
149         struct mbuf             *bnx_rx_mbuf;
150         bus_addr_t              bnx_rx_paddr;
151         int                     bnx_rx_refilled;
152 } __cachealign;
153
154 struct bnx_rx_std_ring {
155         struct lwkt_serialize   bnx_rx_std_serialize;
156         struct bnx_softc        *bnx_sc;
157
158         volatile uint16_t       bnx_rx_std_stop;
159         uint16_t                bnx_rx_std;     /* current prod ring head */
160         struct bge_rx_bd        *bnx_rx_std_ring;
161
162         int                     bnx_rx_std_refill __cachealign;
163         u_int                   bnx_rx_std_running;
164         struct thread           bnx_rx_std_ithread;
165
166         struct bnx_rx_buf       bnx_rx_std_buf[BGE_STD_RX_RING_CNT];
167
168         bus_dma_tag_t           bnx_rx_mtag;    /* RX mbuf DMA tag */
169
170         bus_dma_tag_t           bnx_rx_std_ring_tag;
171         bus_dmamap_t            bnx_rx_std_ring_map;
172         bus_addr_t              bnx_rx_std_ring_paddr;
173 } __cachealign;
174
175 struct bnx_rx_ret_ring {
176         struct lwkt_serialize   bnx_rx_ret_serialize;
177         int                     bnx_rx_mbx;
178         uint32_t                bnx_saved_status_tag;
179         volatile uint32_t       *bnx_hw_status_tag;
180         struct bnx_softc        *bnx_sc;
181         struct bnx_rx_std_ring  *bnx_std;
182
183         /* Shadow of bnx_rx_std_ring's bnx_rx_mtag */
184         bus_dma_tag_t           bnx_rx_mtag;
185
186         volatile uint16_t       *bnx_rx_considx;
187         uint16_t                bnx_rx_saved_considx;
188         uint16_t                bnx_rx_cnt;
189         uint16_t                bnx_rx_cntmax;
190         uint16_t                bnx_rx_mask;
191         struct bge_rx_bd        *bnx_rx_ret_ring;
192         bus_dmamap_t            bnx_rx_tmpmap;
193
194         bus_dma_tag_t           bnx_rx_ret_ring_tag;
195         bus_dmamap_t            bnx_rx_ret_ring_map;
196         bus_addr_t              bnx_rx_ret_ring_paddr;
197 } __cachealign;
198
199 /*
200  * Mbuf pointers. We need these to keep track of the virtual addresses
201  * of our mbuf chains since we can only convert from physical to virtual,
202  * not the other way around.
203  */
204 struct bnx_chain_data {
205         bus_dma_tag_t           bnx_parent_tag;
206         bus_dma_tag_t           bnx_rx_jumbo_ring_tag;
207         bus_dma_tag_t           bnx_status_tag;
208         bus_dma_tag_t           bnx_jumbo_tag;
209         bus_dmamap_t            bnx_rx_jumbo_ring_map;
210         bus_dmamap_t            bnx_status_map;
211         bus_dmamap_t            bnx_jumbo_map;
212         struct bnx_rx_buf       bnx_rx_jumbo_chain[BGE_JUMBO_RX_RING_CNT];
213         /* Stick the jumbo mem management stuff here too. */
214         struct bnx_jslot        bnx_jslots[BNX_JSLOTS];
215 };
216
217 struct bnx_tx_buf {
218         bus_dmamap_t            bnx_tx_dmamap;
219         struct mbuf             *bnx_tx_mbuf;
220 };
221
222 struct bnx_tx_ring {
223         struct lwkt_serialize   bnx_tx_serialize;
224         uint32_t                bnx_saved_status_tag;
225         struct bnx_softc        *bnx_sc;
226         struct ifaltq_subque    *bnx_ifsq;
227         volatile uint16_t       *bnx_tx_considx;
228         uint16_t                bnx_tx_flags;
229 #define BNX_TX_FLAG_SHORTDMA            0x0001
230 #define BNX_TX_FLAG_FORCE_DEFRAG        0x0002
231         uint16_t                bnx_tx_saved_considx;
232         int                     bnx_tx_cnt;
233         uint32_t                bnx_tx_prodidx;
234         int                     bnx_tx_wreg;
235         int                     bnx_tx_mbx;
236         struct ifsubq_watchdog  bnx_tx_watchdog;
237
238         struct bge_tx_bd        *bnx_tx_ring;
239
240         bus_dma_tag_t           bnx_tx_mtag;    /* TX mbuf DMA tag */
241         struct bnx_tx_buf       bnx_tx_buf[BGE_TX_RING_CNT];
242
243         bus_dma_tag_t           bnx_tx_ring_tag;
244         bus_dmamap_t            bnx_tx_ring_map;
245         bus_addr_t              bnx_tx_ring_paddr;
246         int                     bnx_tx_cpuid;
247 } __cachealign;
248
249 struct bnx_intr_data {
250         struct bnx_softc        *bnx_sc;
251         struct bnx_rx_ret_ring  *bnx_ret;
252         struct bnx_tx_ring      *bnx_txr;
253
254         int                     bnx_intr_cpuid;
255         struct lwkt_serialize   *bnx_intr_serialize;
256         struct callout          bnx_intr_timer;
257         void                    (*bnx_intr_check)(void *);
258         uint16_t                bnx_rx_check_considx;
259         uint16_t                bnx_tx_check_considx;
260         boolean_t               bnx_intr_maylose;
261
262         void                    *bnx_intr_arg;
263         driver_intr_t           *bnx_intr_func;
264         void                    *bnx_intr_hand;
265         struct resource         *bnx_intr_res;
266         int                     bnx_intr_rid;
267         const uint32_t          *bnx_saved_status_tag;
268
269         const char              *bnx_intr_desc;
270         char                    bnx_intr_desc0[64];
271 } __cachealign;
272
273 #define BNX_INTR_MAX            5
274
275 struct bnx_softc {
276         struct arpcom           arpcom;         /* interface info */
277         device_t                bnx_dev;
278         device_t                bnx_miibus;
279         bus_space_handle_t      bnx_bhandle;
280         bus_space_tag_t         bnx_btag;
281         struct resource         *bnx_res;
282         struct ifmedia          bnx_ifmedia;    /* TBI media info */
283         int                     bnx_pciecap;
284         uint32_t                bnx_flags;      /* BNX_FLAG_ */
285 #define BNX_FLAG_TBI            0x00000001
286 #define BNX_FLAG_JUMBO          0x00000002
287 #define BNX_FLAG_ONESHOT_MSI    0x00000004
288 #define BNX_FLAG_5717_PLUS      0x00000008
289 #define BNX_FLAG_MII_SERDES     0x00000010
290 #define BNX_FLAG_CPMU           0x00000020
291 #define BNX_FLAG_57765_PLUS     0x00000040
292 #define BNX_FLAG_57765_FAMILY   0x00000080
293 #define BNX_FLAG_STATUSTAG_BUG  0x00000100
294 #define BNX_FLAG_TSO            0x00000200
295 #define BNX_FLAG_NO_EEPROM      0x10000000
296 #define BNX_FLAG_RXTX_BUNDLE    0x20000000
297 #define BNX_FLAG_STD_THREAD     0x40000000
298
299         uint32_t                bnx_chipid;
300         uint32_t                bnx_asicrev;
301         uint32_t                bnx_chiprev;
302         struct bnx_ring_data    bnx_ldata;      /* rings */
303         struct bnx_chain_data   bnx_cdata;      /* mbufs */
304
305         struct lwkt_serialize   bnx_main_serialize;
306         int                     bnx_serialize_cnt;
307         struct lwkt_serialize   **bnx_serialize;
308
309         int                     bnx_tx_ringcnt;
310         struct bnx_tx_ring      *bnx_tx_ring;
311         int                     bnx_rx_retcnt;
312         struct bnx_rx_ret_ring  *bnx_rx_ret_ring;
313         struct bnx_rx_std_ring  bnx_rx_std_ring;
314
315         uint16_t                bnx_jumbo;      /* current jumo ring head */
316         SLIST_HEAD(__bnx_jfreehead, bnx_jslot)  bnx_jfree_listhead;
317         struct lwkt_serialize   bnx_jslot_serializer;
318         uint32_t                bnx_rx_coal_ticks;
319         uint32_t                bnx_tx_coal_ticks;
320         uint32_t                bnx_rx_coal_bds;
321         uint32_t                bnx_tx_coal_bds;
322         uint32_t                bnx_rx_coal_bds_int;
323         uint32_t                bnx_tx_coal_bds_int;
324         uint32_t                bnx_mi_mode;
325         int                     bnx_if_flags;
326         int                     bnx_link;
327         int                     bnx_link_evt;
328         int                     bnx_tick_cpuid;
329         struct callout          bnx_tick_timer;
330
331         int                     bnx_npoll_rxoff;
332         int                     bnx_npoll_txoff;
333
334         int                     bnx_intr_type;
335         int                     bnx_intr_cnt;
336         struct bnx_intr_data    bnx_intr_data[BNX_INTR_MAX];
337
338         struct sysctl_ctx_list  bnx_sysctl_ctx;
339         struct sysctl_oid       *bnx_sysctl_tree;
340
341         int                     bnx_phyno;
342         uint32_t                bnx_coal_chg;
343 #define BNX_RX_COAL_TICKS_CHG           0x01
344 #define BNX_TX_COAL_TICKS_CHG           0x02
345 #define BNX_RX_COAL_BDS_CHG             0x04
346 #define BNX_TX_COAL_BDS_CHG             0x08
347 #define BNX_RX_COAL_BDS_INT_CHG         0x40
348 #define BNX_TX_COAL_BDS_INT_CHG         0x80
349
350         void                    (*bnx_link_upd)(struct bnx_softc *, uint32_t);
351         uint32_t                bnx_link_chg;
352
353 #define BNX_TSO_NSTATS          45
354         u_long                  bnx_tsosegs[BNX_TSO_NSTATS];
355 };
356
357 #define BNX_NSEG_NEW            40
358 #define BNX_NSEG_SPARE          33      /* enough for 64K TSO segment */
359 #define BNX_NSEG_RSVD           4
360
361 /* RX coalesce ticks, unit: us */
362 #define BNX_RX_COAL_TICKS_MIN   0
363 #define BNX_RX_COAL_TICKS_DEF   160
364 #define BNX_RX_COAL_TICKS_MAX   1023
365
366 /* TX coalesce ticks, unit: us */
367 #define BNX_TX_COAL_TICKS_MIN   0
368 #define BNX_TX_COAL_TICKS_DEF   1023
369 #define BNX_TX_COAL_TICKS_MAX   1023
370
371 /* RX coalesce BDs */
372 #define BNX_RX_COAL_BDS_MIN     0
373 #define BNX_RX_COAL_BDS_DEF     0
374 #define BNX_RX_COAL_BDS_INT_DEF 80
375 #define BNX_RX_COAL_BDS_MAX     255
376
377 /* TX coalesce BDs */
378 #define BNX_TX_COAL_BDS_MIN     0
379 #define BNX_TX_COAL_BDS_DEF     64
380 #define BNX_TX_COAL_BDS_INT_DEF 64
381 #define BNX_TX_COAL_BDS_MAX     255
382
383 /* Number of segments sent before writing to TX related registers */
384 #define BNX_TX_WREG_NSEGS       8
385
386 /* Return ring descriptor count */
387 #define BNX_RETURN_RING_CNT     512
388
389 #define BNX_TX_RING_MAX         4
390
391 #endif  /* !_IF_BNXVAR_H_ */