1/* $OpenBSD: if_mskvar.h,v 1.3 2006/12/28 16:34:42 kettenis Exp $ */
2/* $NetBSD: if_mskvar.h,v 1.12 2015/04/13 16:33:25 riastradh 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
86struct sk_jpool_entry {
87 int slot;
88 LIST_ENTRY(sk_jpool_entry) jpool_entries;
89};
90
91struct sk_chain {
92 void *sk_le;
93 struct mbuf *sk_mbuf;
94 struct sk_chain *sk_next;
95};
96
97/*
98 * Number of DMA segments in a TxCB. Note that this is carefully
99 * chosen to make the total struct size an even power of two. It's
100 * critical that no TxCB be split across a page boundary since
101 * no attempt is made to allocate physically contiguous memory.
102 *
103 */
104#define SK_NTXSEG 30
105
106struct sk_txmap_entry {
107 bus_dmamap_t dmamap;
108 SIMPLEQ_ENTRY(sk_txmap_entry) link;
109};
110
111struct msk_chain_data {
112 struct sk_chain sk_tx_chain[MSK_TX_RING_CNT];
113 struct sk_chain sk_rx_chain[MSK_RX_RING_CNT];
114 struct sk_txmap_entry *sk_tx_map[MSK_TX_RING_CNT];
115 bus_dmamap_t sk_rx_map[MSK_RX_RING_CNT];
116 bus_dmamap_t sk_rx_jumbo_map;
117 int sk_tx_prod;
118 int sk_tx_cons;
119 int sk_tx_cnt;
120 int sk_rx_prod;
121 int sk_rx_cons;
122 int sk_rx_cnt;
123 /* Stick the jumbo mem management stuff here too. */
124 void * sk_jslots[MSK_JSLOTS];
125 void *sk_jumbo_buf;
126};
127
128struct msk_ring_data {
129 struct msk_tx_desc sk_tx_ring[MSK_TX_RING_CNT];
130 struct msk_rx_desc sk_rx_ring[MSK_RX_RING_CNT];
131};
132
133#define MSK_TX_RING_ADDR(sc, i) \
134 ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
135 offsetof(struct msk_ring_data, sk_tx_ring[(i)]))
136
137#define MSK_RX_RING_ADDR(sc, i) \
138 ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
139 offsetof(struct msk_ring_data, sk_rx_ring[(i)]))
140
141#define MSK_CDOFF(x) offsetof(struct msk_ring_data, x)
142#define MSK_CDTXOFF(x) MSK_CDOFF(sk_tx_ring[(x)])
143#define MSK_CDRXOFF(x) MSK_CDOFF(sk_rx_ring[(x)])
144#define MSK_CDSTOFF(x) ((x) * sizeof(struct msk_status_desc))
145
146#define MSK_CDTXSYNC(sc, x, n, ops) \
147do { \
148 int __x, __n; \
149 \
150 __x = (x); \
151 __n = (n); \
152 \
153 /* If it will wrap around, sync to the end of the ring. */ \
154 if ((__x + __n) > MSK_TX_RING_CNT) { \
155 bus_dmamap_sync((sc)->sk_softc->sc_dmatag, \
156 (sc)->sk_ring_map, MSK_CDTXOFF(__x), \
157 sizeof(struct msk_tx_desc) * (MSK_TX_RING_CNT - __x), \
158 (ops)); \
159 __n -= (MSK_TX_RING_CNT - __x); \
160 __x = 0; \
161 } \
162 \
163 /* Now sync whatever is left. */ \
164 bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map, \
165 MSK_CDTXOFF((__x)), sizeof(struct msk_tx_desc) * __n, (ops)); \
166} while (/*CONSTCOND*/0)
167
168#define MSK_CDRXSYNC(sc, x, ops) \
169do { \
170 bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map, \
171 MSK_CDRXOFF((x)), sizeof(struct msk_rx_desc), (ops)); \
172} while (/*CONSTCOND*/0)
173
174#define MSK_CDSTSYNC(sc, x, ops) \
175do { \
176 bus_dmamap_sync((sc)->sc_dmatag, (sc)->sk_status_map, \
177 MSK_CDSTOFF((x)), sizeof(struct msk_status_desc), (ops)); \
178} while (/*CONSTCOND*/0)
179
180#define SK_INC(x, y) (x) = (x + 1) % y
181
182/* Forward decl. */
183struct sk_if_softc;
184
185/* Softc for the Yukon-II controller. */
186struct sk_softc {
187 device_t sk_dev;
188 bus_space_handle_t sk_bhandle; /* bus space handle */
189 bus_space_tag_t sk_btag; /* bus space tag */
190 void *sk_intrhand; /* irq handler handle */
191 u_int8_t sk_type;
192 u_int8_t sk_rev;
193 u_int32_t sk_workaround;
194 u_int8_t sk_macs; /* # of MACs */
195 const char *sk_name;
196 u_int32_t sk_rboff; /* RAMbuffer offset */
197 u_int32_t sk_ramsize; /* amount of RAM on NIC */
198 u_int32_t sk_intrmask;
199 struct sysctllog *sk_clog;
200 int sk_int_mod;
201 int sk_int_mod_pending;
202 bus_dma_tag_t sc_dmatag;
203 struct sk_if_softc *sk_if[2];
204 struct msk_status_desc *sk_status_ring;
205 bus_dmamap_t sk_status_map;
206 int sk_status_idx;
207 int sk_status_own_idx;
208 krndsource_t rnd_source;
209};
210
211/* Softc for each logical interface */
212struct sk_if_softc {
213 device_t sk_dev;
214 struct ethercom sk_ethercom; /* interface info */
215 struct mii_data sk_mii;
216 u_int8_t sk_enaddr[ETHER_ADDR_LEN]; /* station addr */
217 u_int8_t sk_port; /* port # on controller */
218 u_int32_t sk_rx_ramstart;
219 u_int32_t sk_rx_ramend;
220 u_int32_t sk_tx_ramstart;
221 u_int32_t sk_tx_ramend;
222 int sk_cnt;
223 int sk_link;
224 struct callout sk_tick_ch;
225 struct msk_chain_data sk_cdata;
226 struct msk_ring_data *sk_rdata;
227 bus_dmamap_t sk_ring_map;
228 int sk_status_idx;
229 struct sk_softc *sk_softc; /* parent controller */
230 int sk_if_flags;
231 kmutex_t sk_jpool_mtx;
232 LIST_HEAD(__sk_jfreehead, sk_jpool_entry) sk_jfree_listhead;
233 LIST_HEAD(__sk_jinusehead, sk_jpool_entry) sk_jinuse_listhead;
234 SIMPLEQ_HEAD(__sk_txmaphead, sk_txmap_entry) sk_txmap_head;
235};
236
237struct skc_attach_args {
238 u_int16_t skc_port;
239 u_int8_t skc_type;
240 u_int8_t skc_rev;
241};
242
243#endif /* _DEV_PCI_IF_MSKVAR_H_ */
244