xref: /netbsd/sys/dev/pci/if_mskvar.h (revision c7ac3c4a)
1 /*	$OpenBSD: if_mskvar.h,v 1.3 2006/12/28 16:34:42 kettenis Exp $	*/
2 /*	$NetBSD: if_mskvar.h,v 1.25 2020/04/29 20:03:52 jakllsch Exp $	*/
3 
4 /*-
5  * Copyright (c) 2003 The NetBSD Foundation, Inc.
6  * 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  *
17  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 /*	$OpenBSD: if_mskvar.h,v 1.1 2006/08/16 21:06:23 kettenis Exp $	*/
30 
31 /*
32  * Copyright (c) 1997, 1998, 1999, 2000
33  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
34  *
35  * Redistribution and use in source and binary forms, with or without
36  * modification, are permitted provided that the following conditions
37  * are met:
38  * 1. Redistributions of source code must retain the above copyright
39  *    notice, this list of conditions and the following disclaimer.
40  * 2. Redistributions in binary form must reproduce the above copyright
41  *    notice, this list of conditions and the following disclaimer in the
42  *    documentation and/or other materials provided with the distribution.
43  * 3. All advertising materials mentioning features or use of this software
44  *    must display the following acknowledgement:
45  *	This product includes software developed by Bill Paul.
46  * 4. Neither the name of the author nor the names of any co-contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
54  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
55  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
56  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
57  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
58  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
60  * THE POSSIBILITY OF SUCH DAMAGE.
61  *
62  * $FreeBSD: /c/ncvs/src/sys/pci/if_skreg.h,v 1.9 2000/04/22 02:16:37 wpaul Exp $
63  */
64 
65 /*
66  * Copyright (c) 2003 Nathan L. Binkert <binkertn@umich.edu>
67  *
68  * Permission to use, copy, modify, and distribute this software for any
69  * purpose with or without fee is hereby granted, provided that the above
70  * copyright notice and this permission notice appear in all copies.
71  *
72  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
73  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
74  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
75  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
76  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
77  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
78  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
79  */
80 
81 #ifndef _DEV_PCI_IF_MSKVAR_H_
82 #define _DEV_PCI_IF_MSKVAR_H_
83 
84 #include <sys/rndsource.h>
85 
86 struct sk_jpool_entry {
87 	int                             slot;
88 	LIST_ENTRY(sk_jpool_entry)	jpool_entries;
89 };
90 
91 struct sk_chain {
92 	struct mbuf		*sk_mbuf;
93 	bus_dmamap_t		sk_dmamap;
94 };
95 
96 /*
97  * Number of DMA segments in a TxCB. Note that this is carefully
98  * chosen to make the total struct size an even power of two. It's
99  * critical that no TxCB be split across a page boundary since
100  * no attempt is made to allocate physically contiguous memory.
101  *
102  */
103 #define SK_NTXSEG      30
104 
105 struct msk_chain_data {
106 	struct sk_chain		sk_tx_chain[MSK_TX_RING_CNT];
107 	struct sk_chain		sk_rx_chain[MSK_RX_RING_CNT];
108 	bus_dmamap_t		sk_rx_jumbo_map;
109 	unsigned		sk_tx_prod;
110 	unsigned		sk_tx_cons;
111 	unsigned		sk_tx_cnt;
112 	u_int32_t		sk_tx_hiaddr;
113 	unsigned		sk_rx_prod;
114 	unsigned		sk_rx_cons;
115 	unsigned		sk_rx_cnt;
116 	u_int32_t		sk_rx_hiaddr;
117 	/* Stick the jumbo mem management stuff here too. */
118 	void *			sk_jslots[MSK_JSLOTS];
119 	void			*sk_jumbo_buf;
120 	bus_dma_segment_t	sk_jumbo_seg;
121 	int			sk_jumbo_nseg;
122 };
123 
124 struct msk_ring_data {
125 	struct msk_tx_desc	sk_tx_ring[MSK_TX_RING_CNT];
126 	struct msk_rx_desc	sk_rx_ring[MSK_RX_RING_CNT];
127 };
128 
129 #define MSK_TX_RING_ADDR(sc, i) \
130     ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
131      offsetof(struct msk_ring_data, sk_tx_ring[(i)]))
132 
133 #define MSK_RX_RING_ADDR(sc, i) \
134     ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
135      offsetof(struct msk_ring_data, sk_rx_ring[(i)]))
136 
137 #define MSK_CDOFF(x)	offsetof(struct msk_ring_data, x)
138 #define MSK_CDTXOFF(x)	MSK_CDOFF(sk_tx_ring[(x)])
139 #define MSK_CDRXOFF(x)	MSK_CDOFF(sk_rx_ring[(x)])
140 #define MSK_CDSTOFF(x)	((x) * sizeof(struct msk_status_desc))
141 
142 #define MSK_CDTXSYNC(sc, x, n, ops)					\
143 do {									\
144 	int __x, __n;							\
145 									\
146 	__x = (x);							\
147 	__n = (n);							\
148 									\
149 	/* If it will wrap around, sync to the end of the ring. */	\
150 	if ((__x + __n) > MSK_TX_RING_CNT) {				\
151 		bus_dmamap_sync((sc)->sk_softc->sc_dmatag,		\
152 		    (sc)->sk_ring_map, MSK_CDTXOFF(__x),		\
153 		    sizeof(struct msk_tx_desc) * (MSK_TX_RING_CNT - __x), \
154 		    (ops));						\
155 		__n -= (MSK_TX_RING_CNT - __x);				\
156 		__x = 0;						\
157 	}								\
158 									\
159 	/* Now sync whatever is left. */				\
160 	bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map,	\
161 	    MSK_CDTXOFF((__x)), sizeof(struct msk_tx_desc) * __n, (ops)); \
162 } while (/*CONSTCOND*/0)
163 
164 #define MSK_CDRXSYNC(sc, x, ops)					\
165 do {									\
166 	bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map,	\
167 	    MSK_CDRXOFF((x)), sizeof(struct msk_rx_desc), (ops));	\
168 } while (/*CONSTCOND*/0)
169 
170 #define MSK_CDSTSYNC(sc, x, ops)					\
171 do {									\
172 	bus_dmamap_sync((sc)->sc_dmatag, (sc)->sk_status_map,		\
173 	    MSK_CDSTOFF((x)), sizeof(struct msk_status_desc), (ops));	\
174 } while (/*CONSTCOND*/0)
175 
176 #define SK_INC(x, y)	(x) = (x + 1) % y
177 
178 /* Forward decl. */
179 struct sk_if_softc;
180 
181 /* Softc for the Yukon-II controller. */
182 struct sk_softc {
183 	device_t		sk_dev;
184 	bus_space_handle_t	sk_bhandle;	/* bus space handle */
185 	bus_space_tag_t		sk_btag;	/* bus space tag */
186 	bus_size_t		sk_bsize;	/* bus space size */
187 	void			*sk_intrhand;	/* irq handler handle */
188 	pci_intr_handle_t	*sk_pihp;
189 	pci_chipset_tag_t	sk_pc;
190 	u_int8_t		sk_fibertype;
191 	u_int8_t		sk_type;
192 	u_int8_t		sk_rev;
193 	u_int8_t		sk_macs;	/* # of MACs */
194 	const char		*sk_name;
195 	u_int32_t		sk_ramsize;	/* amount of RAM on NIC */
196 	u_int32_t		sk_intrmask;
197 	struct sysctllog	*sk_clog;
198 	int			sk_int_mod;
199 	int			sk_int_mod_pending;
200 	bus_dma_tag_t		sc_dmatag;
201 	struct sk_if_softc	*sk_if[2];
202 	struct msk_status_desc	*sk_status_ring;
203 	bus_dmamap_t		sk_status_map;
204 	bus_dma_segment_t	sk_status_seg;
205 	int			sk_status_nseg;
206 	int			sk_status_idx;
207 	int			sk_status_own_idx;
208 	u_int8_t		rnd_attached;
209 	krndsource_t		rnd_source;
210 };
211 
212 /* Softc for each logical interface */
213 struct sk_if_softc {
214 	device_t		sk_dev;
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_int32_t		sk_rx_ramstart;
220 	u_int32_t		sk_rx_ramend;
221 	u_int32_t		sk_tx_ramstart;
222 	u_int32_t		sk_tx_ramend;
223 	int			sk_pktlen;	/* XXX set but unused for now */
224 	int			sk_link;
225 	struct callout		sk_tick_ch;
226 	struct callout		sk_tick_rx;
227 	struct msk_chain_data	sk_cdata;
228 	struct msk_ring_data	*sk_rdata;
229 	bus_dmamap_t		sk_ring_map;
230 	bus_dma_segment_t	sk_ring_seg;
231 	int			sk_ring_nseg;
232 	int			sk_status_idx;
233 	struct sk_softc		*sk_softc;	/* parent controller */
234 	u_short			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 };
239 
240 struct skc_attach_args {
241 	u_int16_t	skc_port;
242 	u_int8_t	skc_type;
243 	u_int8_t	skc_rev;
244 };
245 
246 #endif /* _DEV_PCI_IF_MSKVAR_H_ */
247