xref: /dragonfly/sys/dev/netif/re/if_revar.h (revision 19fe1c42)
1 /*
2  * Copyright (c) 2004
3  *	Joerg Sonnenberger <joerg@bec.de>.  All rights reserved.
4  *
5  * Copyright (c) 1997, 1998-2003
6  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by Bill Paul.
19  * 4. Neither the name of the author nor the names of any co-contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
33  * THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  * $FreeBSD: src/sys/pci/if_rlreg.h,v 1.42 2004/05/24 19:39:23 jhb Exp $
36  * $DragonFly: src/sys/dev/netif/re/if_revar.h,v 1.31 2008/10/21 12:31:01 sephe Exp $
37  */
38 
39 #define RE_RX_DESC_CNT_8139CP	64
40 #define RE_TX_DESC_CNT_8139CP	64
41 
42 #define RE_RX_DESC_CNT_DEF	256
43 #define RE_TX_DESC_CNT_DEF	256
44 #define RE_RX_DESC_CNT_MAX	1024
45 #define RE_TX_DESC_CNT_MAX	1024
46 
47 #define RE_RX_LIST_SZ(sc)	((sc)->re_rx_desc_cnt * sizeof(struct re_desc))
48 #define RE_TX_LIST_SZ(sc)	((sc)->re_tx_desc_cnt * sizeof(struct re_desc))
49 #define RE_RING_ALIGN		256
50 #define RE_IFQ_MAXLEN		512
51 #define RE_MAXSEGS		16
52 #define RE_TXDESC_SPARE		4
53 #define RE_JBUF_COUNT(sc)	(((sc)->re_rx_desc_cnt * 3) / 2)
54 
55 #define RE_RXDESC_INC(sc, x)	(x = (x + 1) % (sc)->re_rx_desc_cnt)
56 #define RE_TXDESC_INC(sc, x)	(x = (x + 1) % (sc)->re_tx_desc_cnt)
57 #define RE_OWN(x)		(le32toh((x)->re_cmdstat) & RE_RDESC_STAT_OWN)
58 #define RE_RXBYTES(x)		(le32toh((x)->re_cmdstat) & sc->re_rxlenmask)
59 #define RE_PKTSZ(x)		((x)/* >> 3*/)
60 
61 #define RE_ADDR_LO(y)		((uint64_t) (y) & 0xFFFFFFFF)
62 #define RE_ADDR_HI(y)		((uint64_t) (y) >> 32)
63 
64 #define RE_MTU_6K		(6 * 1024)
65 #define RE_MTU_9K		(9 * 1024)
66 
67 #define RE_ETHER_EXTRA		(ETHER_HDR_LEN + ETHER_CRC_LEN + EVL_ENCAPLEN)
68 #define RE_FRAMELEN(mtu)	((mtu) + RE_ETHER_EXTRA)
69 
70 #define RE_FRAMELEN_6K		RE_FRAMELEN(RE_MTU_6K)
71 #define RE_FRAMELEN_9K		RE_FRAMELEN(RE_MTU_9K)
72 #define RE_FRAMELEN_MAX		RE_FRAMELEN_9K
73 
74 #define RE_BUF_ALIGN		8
75 #define RE_JBUF_SIZE		roundup2(RE_FRAMELEN_MAX, RE_BUF_ALIGN)
76 
77 #define	RE_TIMEOUT		1000
78 
79 struct re_hwrev {
80 	uint32_t		re_hwrev;
81 	uint32_t		re_macver;	/* see RE_MACVER_ */
82 	int			re_maxmtu;
83 	uint32_t		re_caps;	/* see RE_C_ */
84 };
85 
86 #define RE_MACVER_UNKN		0
87 #define RE_MACVER_03		0x03
88 #define RE_MACVER_04		0x04
89 #define RE_MACVER_05		0x05
90 #define RE_MACVER_06		0x06
91 #define RE_MACVER_11		0x11
92 #define RE_MACVER_12		0x12
93 #define RE_MACVER_13		0x13
94 #define RE_MACVER_14		0x14
95 #define RE_MACVER_15		0x15
96 #define RE_MACVER_16		0x16
97 #define RE_MACVER_21		0x21
98 #define RE_MACVER_22		0x22
99 #define RE_MACVER_23		0x23
100 #define RE_MACVER_24		0x24
101 #define RE_MACVER_25		0x25
102 #define RE_MACVER_26		0x26
103 #define RE_MACVER_27		0x27
104 #define RE_MACVER_28		0x28
105 #define RE_MACVER_29		0x29
106 #define RE_MACVER_2A		0x2a
107 #define RE_MACVER_2B		0x2b
108 
109 struct re_dmaload_arg {
110 	int			re_nsegs;
111 	bus_dma_segment_t	*re_segs;
112 };
113 
114 struct re_softc;
115 struct re_jbuf {
116 	struct re_softc 	*re_sc;
117 	int			re_inuse;
118 	int			re_slot;
119 	caddr_t			re_buf;
120 	bus_addr_t		re_paddr;
121 	SLIST_ENTRY(re_jbuf)	re_link;
122 };
123 
124 struct re_list_data {
125 	struct mbuf		**re_tx_mbuf;
126 	struct mbuf		**re_rx_mbuf;
127 	bus_addr_t		*re_rx_paddr;
128 	int			re_tx_prodidx;
129 	int			re_rx_prodidx;
130 	int			re_tx_considx;
131 	int			re_tx_free;
132 	bus_dmamap_t		*re_tx_dmamap;
133 	bus_dmamap_t		*re_rx_dmamap;
134 	bus_dmamap_t		re_rx_spare;
135 	bus_dma_tag_t		re_mtag;	/* mbuf mapping tag */
136 	bus_dma_tag_t		re_stag;	/* stats mapping tag */
137 	bus_dmamap_t		re_smap;	/* stats map */
138 	struct re_stats		*re_stats;
139 	bus_addr_t		re_stats_addr;
140 	bus_dma_tag_t		re_rx_list_tag;
141 	bus_dmamap_t		re_rx_list_map;
142 	struct re_desc		*re_rx_list;
143 	bus_addr_t		re_rx_list_addr;
144 	bus_dma_tag_t		re_tx_list_tag;
145 	bus_dmamap_t		re_tx_list_map;
146 	struct re_desc		*re_tx_list;
147 	bus_addr_t		re_tx_list_addr;
148 
149 	bus_dma_tag_t		re_jpool_tag;
150 	bus_dmamap_t		re_jpool_map;
151 	caddr_t			re_jpool;
152 	struct re_jbuf		*re_jbuf;
153 	struct lwkt_serialize	re_jbuf_serializer;
154 	SLIST_HEAD(, re_jbuf)	re_jbuf_free;
155 };
156 
157 struct re_softc {
158 	struct arpcom		arpcom;		/* interface info */
159 	device_t		re_dev;
160 	bus_space_handle_t	re_bhandle;	/* bus space handle */
161 	bus_space_tag_t		re_btag;	/* bus space tag */
162 	struct resource		*re_res;
163 	struct resource		*re_irq;
164 	void			*re_intrhand;
165 	device_t		re_miibus;
166 	bus_dma_tag_t		re_parent_tag;
167 	bus_dma_tag_t		re_tag;
168 	uint32_t		re_hwrev;
169 	struct re_list_data	re_ldata;
170 	struct callout		re_timer;
171 	struct mbuf		*re_head;
172 	struct mbuf		*re_tail;
173 	uint32_t		re_caps;	/* see RE_C_ */
174 	uint32_t		re_macver;	/* see RE_MACVER_ */
175 	uint32_t		re_rxlenmask;
176 	int			re_txstart;
177 	int			re_eewidth;
178 	int			re_maxmtu;
179 	int			re_rx_desc_cnt;
180 	int			re_tx_desc_cnt;
181 	int			re_bus_speed;
182 	int			rxcycles;
183 	int			re_rxbuf_size;
184 	int			(*re_newbuf)(struct re_softc *, int, int);
185 
186 	uint32_t		re_flags;	/* see RE_F_ */
187 	int			re_if_flags;	/* saved ifnet.if_flags */
188 
189 	struct sysctl_ctx_list	re_sysctl_ctx;
190 	struct sysctl_oid	*re_sysctl_tree;
191 	uint16_t		re_intrs;
192 	uint16_t		re_tx_ack;
193 	uint16_t		re_rx_ack;
194 	int			re_tx_time;
195 	int			re_rx_time;
196 	int			re_sim_time;
197 	int			re_imtype;	/* see RE_IMTYPE_ */
198 
199 	uint32_t		saved_maps[5];	/* pci data */
200 	uint32_t		saved_biosaddr;
201 	uint8_t			saved_intline;
202 	uint8_t			saved_cachelnsz;
203 	uint8_t			saved_lattimer;
204 };
205 
206 #define RE_C_PCIE		0x1	/* PCI-E */
207 #define RE_C_PCI64		0x2	/* PCI64 */
208 #define RE_C_HWIM		0x4	/* hardware interrupt moderation */
209 #define RE_C_HWCSUM		0x8	/* hardware csum offload */
210 #define RE_C_8139CP		0x20	/* is 8139C+ */
211 #define RE_C_MAC2		0x40	/* MAC style 2 */
212 #define RE_C_PHYPMGT		0x80	/* PHY supports power mgmt */
213 #define RE_C_8169		0x100	/* is 8110/8169 */
214 #define RE_C_AUTOPAD		0x200	/* hardware auto-pad short frames */
215 #define RE_C_CONTIGRX		0x400	/* need contig buf to RX jumbo frames */
216 #define RE_C_STOP_RXTX		0x800	/* could stop RX/TX engine */
217 #define RE_C_FASTE		0x1000	/* 10/100 only NIC */
218 
219 #define RE_IS_8139CP(sc)	((sc)->re_caps & RE_C_8139CP)
220 #define RE_IS_8169(sc)		((sc)->re_caps & RE_C_8169)
221 
222 /* Interrupt moderation types */
223 #define RE_IMTYPE_NONE		0
224 #define RE_IMTYPE_SIM		1	/* simulated */
225 #define RE_IMTYPE_HW		2	/* hardware based */
226 
227 #define RE_F_TIMER_INTR		0x1
228 #define RE_F_USE_JPOOL		0x2
229 #define RE_F_DROP_RXFRAG	0x4
230 #define RE_F_LINKED		0x8
231 #define RE_F_SUSPENDED		0x10
232 #define RE_F_TESTMODE		0x20
233 
234 /*
235  * register space access macros
236  */
237 #define CSR_WRITE_STREAM_4(sc, reg, val)	\
238 	bus_space_write_stream_4(sc->re_btag, sc->re_bhandle, reg, val)
239 #define CSR_WRITE_4(sc, reg, val)	\
240 	bus_space_write_4(sc->re_btag, sc->re_bhandle, reg, val)
241 #define CSR_WRITE_2(sc, reg, val)	\
242 	bus_space_write_2(sc->re_btag, sc->re_bhandle, reg, val)
243 #define CSR_WRITE_1(sc, reg, val)	\
244 	bus_space_write_1(sc->re_btag, sc->re_bhandle, reg, val)
245 
246 #define CSR_READ_4(sc, reg)		\
247 	bus_space_read_4(sc->re_btag, sc->re_bhandle, reg)
248 #define CSR_READ_2(sc, reg)		\
249 	bus_space_read_2(sc->re_btag, sc->re_bhandle, reg)
250 #define CSR_READ_1(sc, reg)		\
251 	bus_space_read_1(sc->re_btag, sc->re_bhandle, reg)
252 
253 #define CSR_SETBIT_1(sc, reg, val)	\
254 	CSR_WRITE_1(sc, reg, CSR_READ_1(sc, reg) | (val))
255 #define CSR_CLRBIT_1(sc, reg, val)	\
256 	CSR_WRITE_1(sc, reg, CSR_READ_1(sc, reg) & ~(val))
257