xref: /netbsd-src/sys/dev/mca/if_we_mca.c (revision f3b496ec9be495acbb17756f05d342b6b7b495e9)
1 /*	$NetBSD: if_we_mca.c,v 1.16 2006/08/30 17:01:45 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1997, 1998, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center, and Jaromir Dolecek.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 /*
41  * Device driver for National Semiconductor DS8390/WD83C690 based ethernet
42  * adapters.
43  *
44  * Copyright (c) 1994, 1995 Charles M. Hannum.  All rights reserved.
45  *
46  * Copyright (C) 1993, David Greenman.  This software may be used, modified,
47  * copied, distributed, and sold, in both source and binary form provided that
48  * the above copyright and these terms are retained.  Under no circumstances is
49  * the author responsible for the proper functioning of this software, nor does
50  * the author assume any responsibility for damages incurred with its use.
51  */
52 
53 /*
54  * Device driver for the Western Digital/SMC 8003 and 8013 series,
55  * and the SMC Elite Ultra (8216).
56  *
57  * Currently only tested with WD8003W/A and EtherCard PLUS Elite 10T/A
58  * (8013WP/A). Other WD8003 and SMC Elite based cards should work
59  * without problems too.
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: if_we_mca.c,v 1.16 2006/08/30 17:01:45 christos Exp $");
64 
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/device.h>
68 #include <sys/socket.h>
69 #include <sys/mbuf.h>
70 
71 #include <net/if.h>
72 #include <net/if_types.h>
73 #include <net/if_media.h>
74 #include <net/if_ether.h>
75 
76 #include <machine/bus.h>
77 
78 #include <dev/mca/mcareg.h>
79 #include <dev/mca/mcavar.h>
80 #include <dev/mca/mcadevs.h>
81 
82 #include <dev/ic/dp8390reg.h>
83 #include <dev/ic/dp8390var.h>
84 #include <dev/ic/wereg.h>
85 #include <dev/ic/wevar.h>
86 
87 #define WD_8003		0x01
88 #define WD_ELITE	0x02
89 
90 int we_mca_probe(struct device *, struct cfdata *, void *);
91 void we_mca_attach(struct device *, struct device *, void *);
92 void we_mca_init_hook(struct we_softc *);
93 
94 CFATTACH_DECL(we_mca, sizeof(struct we_softc),
95     we_mca_probe, we_mca_attach, NULL, NULL);
96 
97 /*
98  * The types for some cards may not be correct; hopefully it's close
99  * enough.
100  */
101 static const struct we_mca_product {
102 	u_int32_t we_id;
103 	const char *we_name;
104 	int we_flag;
105 	int we_type;
106 	const char *we_typestr;
107 } we_mca_products[] = {
108 	{ MCA_PRODUCT_WD_8013EP, "EtherCard PLUS Elite/A (8013EP/A)",
109 		WD_ELITE,	WE_TYPE_WD8013EP, "WD8013EP/A" },
110 	{ MCA_PRODUCT_WD_8013WP, "EtherCard PLUS Elite 10T/A (8013WP/A)",
111 		WD_ELITE,	WE_TYPE_WD8013EP, "WD8013WP/A" },
112 	{ MCA_PRODUCT_IBM_WD_2,"IBM PS/2 Adapter/A for Ethernet Networks (UTP)",
113 		WD_ELITE, WE_TYPE_WD8013EP, "WD8013WP/A"},
114 	{ MCA_PRODUCT_IBM_WD_T,"IBM PS/2 Adapter/A for Ethernet Networks (BNC)",
115 		WD_ELITE, WE_TYPE_WD8013EP, "WD8013WP/A"},
116 	{ MCA_PRODUCT_WD_8003E,	"WD EtherCard PLUS/A (WD8003E/A or WD8003ET/A)",
117 		WD_8003,	WE_TYPE_WD8003E, "WD8003E/A or WD8003ET/A" },
118 	{ MCA_PRODUCT_WD_8003ST,"WD StarCard PLUS/A (WD8003ST/A)",
119 		WD_8003,	WE_TYPE_WD8003W, "WD8003ST/A" }, /* XXX */
120 	{ MCA_PRODUCT_WD_8003W,	"WD EtherCard PLUS 10T/A (WD8003W/A)",
121 		WD_8003,	WE_TYPE_WD8003W, "WD8003W/A" },
122 	{ MCA_PRODUCT_IBM_WD_O, "IBM PS/2 Adapter/A for Ethernet Networks",
123 		WD_8003,	WE_TYPE_WD8003W, "IBM PS/2 Adapter/A" },
124 	{ 0x0000,		NULL,
125 		0,		0,		 NULL },
126 };
127 
128 /* see POS description in we_mca_attach() */
129 static const int we_mca_irq[] = {
130 	3, 4, 10, 15,
131 };
132 
133 static const struct we_mca_product *we_mca_lookup(int);
134 
135 static const struct we_mca_product *
136 we_mca_lookup(id)
137 	int id;
138 {
139 	const struct we_mca_product *wep;
140 
141 	for(wep = we_mca_products; wep->we_name; wep++)
142 		if (wep->we_id == id)
143 			return (wep);
144 
145 	return (NULL);
146 }
147 
148 int
149 we_mca_probe(parent, cf, aux)
150 	struct device *parent;
151 	struct cfdata *cf;
152 	void *aux;
153 {
154 	struct mca_attach_args *ma = aux;
155 
156 	return (we_mca_lookup(ma->ma_id) != NULL);
157 }
158 
159 void
160 we_mca_attach(parent, self, aux)
161 	struct device *parent, *self;
162 	void *aux;
163 {
164 	struct we_softc *wsc = device_private(self);
165 	struct dp8390_softc *sc = &wsc->sc_dp8390;
166 	struct mca_attach_args *ma = aux;
167 	const struct we_mca_product *wep;
168 	bus_space_tag_t nict, asict, memt;
169 	bus_space_handle_t nich, asich, memh;
170 	const char *typestr;
171 	int irq, iobase, maddr;
172 	int pos2, pos3, pos5;
173 
174 	pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);
175 	pos3 = mca_conf_read(ma->ma_mc, ma->ma_slot, 3);
176 	pos5 = mca_conf_read(ma->ma_mc, ma->ma_slot, 5);
177 
178 	/*
179 	 * POS registers differ a lot between 8003 and 8013, so they are
180 	 * divided to two sections.
181 	 *
182 	 * 8003: POS register 2: (adf pos0)
183 	 * 7 6 5 4 3 2 1 0
184 	 * 0 0 1 \_____/ \__ enable: 0=adapter disabled, 1=adapter enabled
185 	 *             \____ Adapter I/O Space: 0x200-0x21F + XX*0x20
186 	 *
187 	 * 8003: POS register 3: (adf pos1)
188 	 * 7 6 5 4 3 2 1 0
189 	 * 1 1 0 \___/ 1 X
190 	 *           \______ Shared Ram Space (16K Bytes):
191 	 *                     0xC0000-0xC3FFF + XX * 0x4000
192 	 *
193 	 * 8003: POS register 5: (adf pos3)
194 	 * 7 6 5 4 3 2 1 0
195 	 *             \_/
196 	 *               \__ Interrupt Level: 00=3 01=4 10=10 11=15
197 	 *
198 	 * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
199 	 *
200 	 * 8013: POS register 2: (adf pos0)
201 	 * 7 6 5 4 3 2 1 0
202 	 * \____/        \__ enable: 0=adapter disabled, 1=adapter enabled
203 	 *      \___________ Adapter I/O Space: 0x0800-0x081F + XX * 0x1000
204 	 *
205 	 * 8013: POS register 3: (adf pos1)
206 	 * 7 6 5 4 3 2 1 0
207 	 * | X 0 | \_____/
208 	 * |     |       \__ Shared RAM Base Address
209 	 * |     |                0xc0000 + ((xx & 0x0f) * 0x2000)
210 	 * |      \____________ Ram size: 0 = 8k, 1 = 16k
211 	 * |                      some size and address combinations are
212 	 * |                        not supported, varies by card :(
213 	 *  \__________________ If set, add 0xf00000 to shared RAM base addr
214 	 *                      puts shared RAM near top of 16MB address space
215 	 *
216 	 * 8013: POS register 5: (adf pos3)
217 	 * 7 6 5 4 3 2 1 0
218 	 *         \_/ \_/
219 	 *           \   \__ Media Select: 00=TwPr (no link) 10=BNC
220 	 *            \          01=AUI|AUI or 10BaseT
221 	 *             \____ Interrupt Level: 00=3 01=4 10=10 11=14
222 	 */
223 
224 	wep = we_mca_lookup(ma->ma_id);
225 #ifdef DIAGNOSTIC
226 	if (wep == NULL) {
227 		printf("\n%s: where did the card go?\n", sc->sc_dev.dv_xname);
228 		return;
229 	}
230 #endif
231 
232 	if (wep->we_flag & WD_8003) {
233 		/* WD8003 based */
234 		iobase = 0x200 + (((pos2 & 0x0e) >> 1) * 0x020);
235 		maddr  = 0xC0000 + (((pos3 & 0x1c) >> 2) * 0x04000);
236 		irq = we_mca_irq[(pos5 & 0x03)];
237 		sc->mem_size = 16384;
238 	} else {
239 		/* SMC Elite */
240 		iobase = 0x800 + (((pos2 & 0xf0) >> 4) * 0x1000);
241 		maddr = 0xC0000 + ((pos3 & 0x0f) * 0x2000)
242 		    + ((pos3 & 0x80) ? 0xF00000 : 0);
243 		irq = we_mca_irq[(pos5 & 0x0c) >> 2];
244 		sc->mem_size = (pos3 & 0x10) ? 16384 : 8192;
245 	}
246 
247 	nict = asict = ma->ma_iot;
248 	memt = ma->ma_memt;
249 
250 	printf(" slot %d port %#x-%#x mem %#x-%#x irq %d: %s\n",
251 		ma->ma_slot + 1,
252 		iobase, iobase + WE_NPORTS - 1,
253 		maddr, maddr + sc->mem_size - 1,
254 		irq, wep->we_name);
255 
256 	/* Map the device. */
257 	if (bus_space_map(asict, iobase, WE_NPORTS, 0, &asich)) {
258 		printf("%s: can't map nic i/o space\n",
259 		    sc->sc_dev.dv_xname);
260 		return;
261 	}
262 
263 	if (bus_space_subregion(asict, asich, WE_NIC_OFFSET, WE_NIC_NPORTS,
264 	    &nich)) {
265 		printf("%s: can't subregion i/o space\n",
266 		    sc->sc_dev.dv_xname);
267 		return;
268 	}
269 
270 	wsc->sc_type = wep->we_type;
271 	/* all cards we support are 16bit native (no need for reset) */
272 	wsc->sc_flags = WE_16BIT_ENABLE|WE_16BIT_NOTOGGLE;
273 	sc->is790 = 0;
274 	typestr = wep->we_typestr;
275 
276 	/*
277 	 * Map memory space.
278 	 */
279 	if (bus_space_map(memt, maddr, sc->mem_size, 0, &memh)) {
280 		printf("%s: can't map shared memory %#x-%#x\n",
281 		    sc->sc_dev.dv_xname,
282 		    maddr, maddr + sc->mem_size - 1);
283 		return;
284 	}
285 
286 	wsc->sc_asict = asict;
287 	wsc->sc_asich = asich;
288 
289 	sc->sc_regt = nict;
290 	sc->sc_regh = nich;
291 
292 	sc->sc_buft = memt;
293 	sc->sc_bufh = memh;
294 
295 	wsc->sc_maddr = maddr;
296 
297 	/* Interface is always enabled. */
298 	sc->sc_enabled = 1;
299 
300 	wsc->sc_init_hook = we_mca_init_hook;
301 
302 	if (we_config(self, wsc, typestr))
303 		return;
304 
305 	/* Map and establish the interrupt. */
306 	wsc->sc_ih = mca_intr_establish(ma->ma_mc, irq,
307 			    IPL_NET, dp8390_intr, sc);
308 	if (wsc->sc_ih == NULL) {
309 		printf("%s: can't establish interrupt\n", sc->sc_dev.dv_xname);
310 		return;
311 	}
312 }
313 
314 void
315 we_mca_init_hook(wsc)
316 	struct we_softc *wsc;
317 {
318 	/*
319 	 * This quirk really needs to be here, at least for WD8003W/A. Without
320 	 * this, the card doesn't send any interrupts in 16bit mode. The quirk
321 	 * was taken from Linux smc-mca.c driver.
322 	 * I do not know why it's necessary. I don't want to know. It works
323 	 * and that is enough for me.
324 	 */
325 	bus_space_write_1(wsc->sc_asict, wsc->sc_asich, WE_LAAR, 0x04);
326 	wsc->sc_laar_proto |= 0x04;
327 }
328