xref: /netbsd-src/sys/dev/pci/if_wi_pci.c (revision b8c616269f5ebf18ab2e35cb8099d683130a177c)
1 /*      $NetBSD: if_wi_pci.c,v 1.16 2003/01/02 06:26:49 dyoung Exp $  */
2 
3 /*-
4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Hideaki Imaizumi <hiddy@sfc.wide.ad.jp>
9  * and Ichiro FUKUHARA (ichiro@ichiro.org).
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  * PCI bus front-end for the Intersil PCI WaveLan.
42  * Works with Prism2.5 Mini-PCI wavelan.
43  */
44 
45 #include <sys/cdefs.h>
46 __KERNEL_RCSID(0, "$NetBSD: if_wi_pci.c,v 1.16 2003/01/02 06:26:49 dyoung Exp $");
47 
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/mbuf.h>
51 #include <sys/syslog.h>
52 #include <sys/socket.h>
53 #include <sys/device.h>
54 #include <sys/callout.h>
55 
56 #include <net/if.h>
57 #include <net/if_ether.h>
58 #include <net/if_media.h>
59 #include <net/if_ieee80211.h>
60 
61 #include <machine/bus.h>
62 #include <machine/intr.h>
63 
64 #include <dev/pci/pcireg.h>
65 #include <dev/pci/pcivar.h>
66 #include <dev/pci/pcidevs.h>
67 
68 #include <dev/ic/wi_ieee.h>
69 #include <dev/ic/wireg.h>
70 #include <dev/ic/wivar.h>
71 
72 #define WI_PCI_CBMA		0x10	/* Configuration Base Memory Address */
73 #define WI_PCI_PLX_LOMEM	0x10	/* PLX chip membase */
74 #define WI_PCI_PLX_LOIO		0x14	/* PLX chip iobase */
75 #define WI_PCI_LOMEM		0x18	/* ISA membase */
76 #define WI_PCI_LOIO		0x1C	/* ISA iobase */
77 
78 #define WI_PLX_COR_OFFSET       0x3E0
79 #define WI_PLX_COR_VALUE        0x41
80 
81 struct wi_pci_softc {
82 	struct wi_softc psc_wi;		/* real "wi" softc */
83 
84 	/* PCI-specific goo */
85 	pci_intr_handle_t psc_ih;
86 	struct pci_attach_args *psc_pa;
87 
88 	void *sc_powerhook;		/* power hook descriptor */
89 };
90 
91 static int	wi_pci_match __P((struct device *, struct cfdata *, void *));
92 static void	wi_pci_attach __P((struct device *, struct device *, void *));
93 static int	wi_pci_enable __P((struct wi_softc *));
94 static void	wi_pci_disable __P((struct wi_softc *));
95 static void	wi_pci_reset __P((struct wi_softc *));
96 static void	wi_pci_powerhook __P((int, void *));
97 
98 static const struct wi_pci_product
99 	*wi_pci_lookup __P((struct pci_attach_args *));
100 
101 CFATTACH_DECL(wi_pci, sizeof(struct wi_pci_softc),
102     wi_pci_match, wi_pci_attach, NULL, NULL);
103 
104 const struct wi_pci_product {
105 	pci_vendor_id_t		wpp_vendor;	/* vendor ID */
106 	pci_product_id_t	wpp_product;	/* product ID */
107 	const char		*wpp_name;	/* product name */
108 	int			wpp_plx;	/* uses PLX chip */
109 } wi_pci_products[] = {
110 	{ PCI_VENDOR_GLOBALSUN,		PCI_PRODUCT_GLOBALSUN_GL24110P,
111 	  NULL, 1 },
112 	{ PCI_VENDOR_GLOBALSUN,		PCI_PRODUCT_GLOBALSUN_GL24110P02,
113 	  NULL, 1 },
114 	{ PCI_VENDOR_EUMITCOM,		PCI_PRODUCT_EUMITCOM_WL11000P,
115 	  NULL, 1 },
116 	{ PCI_VENDOR_3COM,		PCI_PRODUCT_3COM_3CRWE777A,
117 	  NULL, 1 },
118 	{ PCI_VENDOR_NETGEAR,		PCI_PRODUCT_NETGEAR_MA301,
119 	  NULL, 1 },
120 	{ PCI_VENDOR_INTERSIL,		PCI_PRODUCT_INTERSIL_MINI_PCI_WLAN,
121 	  "Intersil Prism2.5", 0 },
122 	{ 0,				0,
123 	  NULL, 0},
124 };
125 
126 static int
127 wi_pci_enable(sc)
128 	struct wi_softc *sc;
129 {
130 	struct wi_pci_softc *psc = (struct wi_pci_softc *)sc;
131 
132 	/* establish the interrupt. */
133 	sc->sc_ih = pci_intr_establish(psc->psc_pa->pa_pc,
134 					psc->psc_ih, IPL_NET, wi_intr, sc);
135 	if (sc->sc_ih == NULL) {
136 		printf("%s: couldn't establish interrupt\n",
137 		    sc->sc_dev.dv_xname);
138 		return (EIO);
139 	}
140 
141 	/* reset HFA3842 MAC core */
142 	wi_pci_reset(sc);
143 
144 	return (0);
145 }
146 
147 static void
148 wi_pci_disable(sc)
149 	struct wi_softc *sc;
150 {
151 	struct wi_pci_softc *psc = (struct wi_pci_softc *)sc;
152 
153 	pci_intr_disestablish(psc->psc_pa->pa_pc, sc->sc_ih);
154 }
155 
156 static void
157 wi_pci_reset(sc)
158 	struct wi_softc		*sc;
159 {
160 	int i, secs, usecs;
161 
162 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,
163 	    WI_PCI_COR, WI_COR_SOFT_RESET);
164 	DELAY(250*1000); /* 1/4 second */
165 
166 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,
167 	    WI_PCI_COR, WI_COR_CLEAR);
168 	DELAY(500*1000); /* 1/2 second */
169 
170 	/* wait 2 seconds for firmware to complete initialization. */
171 
172 	for (i = 200000; i--; DELAY(10))
173 		if (!(CSR_READ_2(sc, WI_COMMAND) & WI_CMD_BUSY))
174 			break;
175 
176 	if (i < 0) {
177 		printf("%s: PCI reset timed out\n", sc->sc_dev.dv_xname);
178 	} else if (sc->sc_if.if_flags & IFF_DEBUG) {
179 		usecs = (200000 - i) * 10;
180 		secs = usecs / 1000000;
181 		usecs %= 1000000;
182 
183 		printf("%s: PCI reset in %d.%06d seconds\n",
184                        sc->sc_dev.dv_xname, secs, usecs);
185 	}
186 
187 	return;
188 }
189 
190 static const struct wi_pci_product *
191 wi_pci_lookup(pa)
192 	struct pci_attach_args *pa;
193 {
194 	const struct wi_pci_product *wpp;
195 
196 	for (wpp = wi_pci_products; wpp->wpp_vendor != 0; wpp++) {
197 		if (PCI_VENDOR(pa->pa_id) == wpp->wpp_vendor &&
198 		    PCI_PRODUCT(pa->pa_id) == wpp->wpp_product)
199 			return (wpp);
200 	}
201 	return (NULL);
202 }
203 
204 static int
205 wi_pci_match(parent, match, aux)
206 	struct device *parent;
207 	struct cfdata *match;
208 	void *aux;
209 {
210 	struct pci_attach_args *pa = aux;
211 
212 	if (wi_pci_lookup(pa) != NULL)
213 		return (1);
214 	return (0);
215 }
216 
217 static void
218 wi_pci_attach(parent, self, aux)
219 	struct device *parent, *self;
220 	void *aux;
221 {
222 	struct wi_pci_softc *psc = (struct wi_pci_softc *)self;
223 	struct wi_softc *sc = &psc->psc_wi;
224 	struct pci_attach_args *pa = aux;
225 	pci_chipset_tag_t pc = pa->pa_pc;
226 	const char *intrstr;
227 	const struct wi_pci_product *wpp;
228 	pci_intr_handle_t ih;
229 	bus_space_tag_t memt, iot;
230 	bus_space_handle_t memh, ioh;
231 
232 	psc->psc_pa = pa;
233 
234 	wpp = wi_pci_lookup(pa);
235 #ifdef DIAGNOSTIC
236 	if (wpp == NULL) {
237 		printf("\n");
238 		panic("wi_pci_attach: impossible");
239 	}
240 #endif
241 
242 	if (wpp->wpp_plx) {
243 		/* Map memory and I/O registers. */
244 		if (pci_mapreg_map(pa, WI_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
245 		    &memt, &memh, NULL, NULL) != 0) {
246 			printf(": can't map mem space\n");
247 			return;
248 		}
249 		if (pci_mapreg_map(pa, WI_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
250 		    &iot, &ioh, NULL, NULL) != 0) {
251 			printf(": can't map I/O space\n");
252 			return;
253 		}
254 	} else {
255 		if (pci_mapreg_map(pa, WI_PCI_CBMA,
256 		    PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT,
257 		    0, &iot, &ioh, NULL, NULL) != 0) {
258 			printf(": can't map mem space\n");
259 			return;
260 		}
261 
262 		memt = iot;
263 		memh = ioh;
264 		sc->sc_pci = 1;
265 	}
266 
267 	if (wpp->wpp_name != NULL) {
268 		printf(": %s Wireless Lan\n", wpp->wpp_name);
269 	} else {
270 		char devinfo[256];
271 
272 		pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo);
273 		printf(": %s (rev. 0x%02x)\n", devinfo,
274 		       PCI_REVISION(pa->pa_class));
275 	}
276 
277 	sc->sc_enabled = 1;
278 	sc->sc_enable = wi_pci_enable;
279 	sc->sc_disable = wi_pci_disable;
280 
281 	sc->sc_iot = iot;
282 	sc->sc_ioh = ioh;
283 	/* Make sure interrupts are disabled. */
284 	CSR_WRITE_2(sc, WI_INT_EN, 0);
285 	CSR_WRITE_2(sc, WI_EVENT_ACK, 0xFFFF);
286 
287 	/* Map and establish the interrupt. */
288 	if (pci_intr_map(pa, &ih)) {
289 		printf("%s: couldn't map interrupt\n", sc->sc_dev.dv_xname);
290 		return;
291 	}
292 	intrstr = pci_intr_string(pc, ih);
293 
294 	psc->psc_ih = ih;
295 	sc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, wi_intr, sc);
296 	if (sc->sc_ih == NULL) {
297 		printf("%s: couldn't establish interrupt",
298 		    sc->sc_dev.dv_xname);
299 		if (intrstr != NULL)
300 			printf(" at %s", intrstr);
301 		printf("\n");
302 		return;
303 	}
304 
305 	printf("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
306 
307 	if (wpp->wpp_plx) {
308 		/*
309 		 * Setup the PLX chip for level interrupts and config index 1
310 		 * XXX - should really reset the PLX chip too.
311 		 */
312 		bus_space_write_1(memt, memh,
313 		    WI_PLX_COR_OFFSET, WI_PLX_COR_VALUE);
314 	} else {
315 		/* reset HFA3842 MAC core */
316 		wi_pci_reset(sc);
317 	}
318 
319 	printf("%s:", sc->sc_dev.dv_xname);
320 	if (wi_attach(sc) != 0) {
321 		printf("%s: failed to attach controller\n",
322 			sc->sc_dev.dv_xname);
323 		pci_intr_disestablish(pa->pa_pc, sc->sc_ih);
324 		return;
325 	}
326 
327 	/* Add a suspend hook to restore PCI config state */
328 	psc->sc_powerhook = powerhook_establish(wi_pci_powerhook, psc);
329 	if (psc->sc_powerhook == NULL)
330 		printf ("%s: WARNING: unable to establish pci power hook\n",
331 		        sc->sc_dev.dv_xname);
332 }
333 
334 static void
335 wi_pci_powerhook(why, arg)
336 	int why;
337 	void *arg;
338 {
339 	struct wi_pci_softc *psc = arg;
340 	struct wi_softc *sc = &psc->psc_wi;
341 
342 	wi_power(sc, why);
343 }
344