xref: /netbsd/sys/dev/pci/if_skvar.h (revision 6550d01e)
1 /* $NetBSD: if_skvar.h,v 1.15 2008/09/08 21:20:03 christos Exp $ */
2 
3 /*-
4  * Copyright (c) 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
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  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 /*	$OpenBSD: if_skreg.h,v 1.10 2003/08/12 05:23:06 nate Exp $	*/
29 
30 /*
31  * Copyright (c) 1997, 1998, 1999, 2000
32  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
33  *
34  * Redistribution and use in source and binary forms, with or without
35  * modification, are permitted provided that the following conditions
36  * are met:
37  * 1. Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in the
41  *    documentation and/or other materials provided with the distribution.
42  * 3. All advertising materials mentioning features or use of this software
43  *    must display the following acknowledgement:
44  *	This product includes software developed by Bill Paul.
45  * 4. Neither the name of the author nor the names of any co-contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
53  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
54  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
55  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
56  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
57  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
58  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
59  * THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  * $FreeBSD: /c/ncvs/src/sys/pci/if_skreg.h,v 1.9 2000/04/22 02:16:37 wpaul Exp $
62  */
63 
64 /*
65  * Copyright (c) 2003 Nathan L. Binkert <binkertn@umich.edu>
66  *
67  * Permission to use, copy, modify, and distribute this software for any
68  * purpose with or without fee is hereby granted, provided that the above
69  * copyright notice and this permission notice appear in all copies.
70  *
71  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
72  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
73  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
74  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
75  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
76  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
77  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
78  */
79 
80 #ifndef _DEV_PCI_IF_SKVAR_H_
81 #define _DEV_PCI_IF_SKVAR_H_
82 
83 #include "rnd.h"
84 
85 #if NRND > 0
86 #include <sys/rnd.h>
87 #endif
88 
89 struct sk_jpool_entry {
90 	int                             slot;
91 	LIST_ENTRY(sk_jpool_entry)	jpool_entries;
92 };
93 
94 struct sk_chain {
95 	void			*sk_desc;
96 	struct mbuf		*sk_mbuf;
97 	struct sk_chain		*sk_next;
98 };
99 
100 /*
101  * Number of DMA segments in a TxCB. Note that this is carefully
102  * chosen to make the total struct size an even power of two. It's
103  * critical that no TxCB be split across a page boundary since
104  * no attempt is made to allocate physically contiguous memory.
105  *
106  */
107 #define SK_NTXSEG      30
108 
109 struct sk_txmap_entry {
110 	bus_dmamap_t			dmamap;
111 	SIMPLEQ_ENTRY(sk_txmap_entry)	link;
112 };
113 
114 struct sk_chain_data {
115 	struct sk_chain		sk_tx_chain[SK_TX_RING_CNT];
116 	struct sk_chain		sk_rx_chain[SK_RX_RING_CNT];
117 	struct sk_txmap_entry	*sk_tx_map[SK_TX_RING_CNT];
118 	bus_dmamap_t		sk_rx_map[SK_RX_RING_CNT];
119 	bus_dmamap_t		sk_rx_jumbo_map;
120 	int			sk_tx_prod;
121 	int			sk_tx_cons;
122 	int			sk_tx_cnt;
123 	int			sk_rx_prod;
124 	int			sk_rx_cons;
125 	int			sk_rx_cnt;
126 	/* Stick the jumbo mem management stuff here too. */
127 	void *			sk_jslots[SK_JSLOTS];
128 	void			*sk_jumbo_buf;
129 
130 };
131 
132 struct sk_ring_data {
133 	struct sk_tx_desc	sk_tx_ring[SK_TX_RING_CNT];
134 	struct sk_rx_desc	sk_rx_ring[SK_RX_RING_CNT];
135 };
136 
137 #define SK_TX_RING_ADDR(sc, i) \
138     ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
139      offsetof(struct sk_ring_data, sk_tx_ring[(i)]))
140 
141 #define SK_RX_RING_ADDR(sc, i) \
142     ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
143      offsetof(struct sk_ring_data, sk_rx_ring[(i)]))
144 
145 #define SK_CDOFF(x)	offsetof(struct sk_ring_data, x)
146 #define SK_CDTXOFF(x)	SK_CDOFF(sk_tx_ring[(x)])
147 #define SK_CDRXOFF(x)	SK_CDOFF(sk_rx_ring[(x)])
148 
149 #define SK_CDTXSYNC(sc, x, n, ops)					\
150 do {									\
151 	int __x, __n;							\
152 									\
153 	__x = (x);							\
154 	__n = (n);							\
155 									\
156 	/* If it will wrap around, sync to the end of the ring. */	\
157 	if ((__x + __n) > SK_TX_RING_CNT) {				\
158 		bus_dmamap_sync((sc)->sk_softc->sc_dmatag,		\
159 		    (sc)->sk_ring_map, SK_CDTXOFF(__x),			\
160 		    sizeof(struct sk_tx_desc) *	 (SK_TX_RING_CNT - __x),\
161 		    (ops));						\
162 		__n -= (SK_TX_RING_CNT - __x);				\
163 		__x = 0;						\
164 	}								\
165 									\
166 	/* Now sync whatever is left. */				\
167 	bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map,	\
168 	    SK_CDTXOFF((__x)), sizeof(struct sk_tx_desc) * __n, (ops));	\
169 } while (/*CONSTCOND*/0)
170 
171 #define SK_CDRXSYNC(sc, x, ops)						\
172 do {									\
173 	bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map,	\
174 	    SK_CDRXOFF((x)), sizeof(struct sk_rx_desc), (ops));		\
175 } while (/*CONSTCOND*/0)
176 
177 struct sk_bcom_hack {
178 	int			reg;
179 	int			val;
180 };
181 
182 #define SK_INC(x, y)	(x) = (x + 1) % y
183 
184 /* Forward decl. */
185 struct sk_if_softc;
186 
187 /* Softc for the GEnesis controller. */
188 struct sk_softc {
189 	device_t		sk_dev;		/* generic device */
190 	bus_space_handle_t	sk_bhandle;	/* bus space handle */
191 	bus_space_tag_t		sk_btag;	/* bus space tag */
192 	void			*sk_intrhand;	/* irq handler handle */
193 	u_int8_t		sk_type;
194 	u_int8_t		sk_rev;
195   	const char		*sk_name;
196 	char			*sk_vpd_prodname;
197 	char			*sk_vpd_readonly;
198 	u_int32_t		sk_rboff;	/* RAMbuffer offset */
199 	u_int32_t		sk_ramsize;	/* amount of RAM on NIC */
200 	u_int32_t		sk_pmd;		/* physical media type */
201 	u_int32_t		sk_intrmask;
202 	struct sysctllog	*sk_clog;
203 	int			sk_int_mod;
204 	int			sk_int_mod_pending;
205 	bus_dma_tag_t		sc_dmatag;
206 	struct sk_if_softc	*sk_if[2];
207 #if NRND > 0
208 	rndsource_element_t     rnd_source;
209 #endif
210 };
211 
212 /* Softc for each logical interface */
213 struct sk_if_softc {
214 	device_t		sk_dev;		/* generic device */
215 	struct ethercom		sk_ethercom;	/* interface info */
216 	struct mii_data		sk_mii;
217 	u_int8_t                sk_enaddr[ETHER_ADDR_LEN]; /* station addr */
218 	u_int8_t		sk_port;	/* port # on controller */
219 	u_int8_t		sk_xmac_rev;	/* XMAC chip rev (B2 or C1) */
220 	u_int32_t		sk_rx_ramstart;
221 	u_int32_t		sk_rx_ramend;
222 	u_int32_t		sk_tx_ramstart;
223 	u_int32_t		sk_tx_ramend;
224 	int			sk_phytype;
225 	int			sk_phyaddr;
226 	int			sk_cnt;
227 	int			sk_link;
228 	struct callout		sk_tick_ch;
229 	struct sk_chain_data	sk_cdata;
230 	struct sk_ring_data	*sk_rdata;
231 	bus_dmamap_t		sk_ring_map;
232 	struct sk_softc		*sk_softc;	/* parent controller */
233 	int			sk_tx_bmu;	/* TX BMU register */
234 	int			sk_if_flags;
235 	kmutex_t		sk_jpool_mtx;
236 	LIST_HEAD(__sk_jfreehead, sk_jpool_entry)	sk_jfree_listhead;
237 	LIST_HEAD(__sk_jinusehead, sk_jpool_entry)	sk_jinuse_listhead;
238 	SIMPLEQ_HEAD(__sk_txmaphead, sk_txmap_entry) sk_txmap_head;
239 };
240 
241 struct skc_attach_args {
242 	u_int16_t	skc_port;
243 };
244 
245 #endif /* _DEV_PCI_IF_SKVAR_H_ */
246