1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1997, 1998, 1999
5  *	Bill Paul <wpaul@ctr.columbia.edu>.  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  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD: stable/12/sys/dev/wi/if_wi_pci.c 365608 2020-09-10 19:00:17Z bz $
35  */
36 
37 /*
38  * Lucent WaveLAN/IEEE 802.11 PCMCIA driver for FreeBSD.
39  *
40  * Written by Bill Paul <wpaul@ctr.columbia.edu>
41  * Electrical Engineering Department
42  * Columbia University, New York City
43  */
44 
45 #include <sys/param.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #include <sys/socket.h>
49 #include <sys/systm.h>
50 #include <sys/module.h>
51 #include <sys/bus.h>
52 
53 #include <machine/bus.h>
54 #include <machine/resource.h>
55 #include <sys/rman.h>
56 
57 #include <dev/pci/pcireg.h>
58 #include <dev/pci/pcivar.h>
59 
60 #include <net/if.h>
61 #include <net/if_var.h>
62 #include <net/if_arp.h>
63 #include <net/ethernet.h>
64 #include <net/if_media.h>
65 #include <net/if_types.h>
66 
67 #include <net80211/ieee80211_var.h>
68 #include <net80211/ieee80211_radiotap.h>
69 
70 #include <dev/wi/if_wavelan_ieee.h>
71 #include <dev/wi/if_wireg.h>
72 #include <dev/wi/if_wivar.h>
73 
74 static int wi_pci_probe(device_t);
75 static int wi_pci_attach(device_t);
76 static int wi_pci_suspend(device_t);
77 static int wi_pci_resume(device_t);
78 
79 static device_method_t wi_pci_methods[] = {
80 	/* Device interface */
81 	DEVMETHOD(device_probe,		wi_pci_probe),
82 	DEVMETHOD(device_attach,	wi_pci_attach),
83 	DEVMETHOD(device_detach,	wi_detach),
84 	DEVMETHOD(device_shutdown,	wi_shutdown),
85 	DEVMETHOD(device_suspend,	wi_pci_suspend),
86 	DEVMETHOD(device_resume,	wi_pci_resume),
87 	{ 0, 0 }
88 };
89 
90 static driver_t wi_pci_driver = {
91 	"wi",
92 	wi_pci_methods,
93 	sizeof(struct wi_softc)
94 };
95 
96 static struct {
97 	unsigned int vendor,device;
98 	int bus_type;
99 	char *desc;
100 } pci_ids[] = {
101 	/* Sorted by description */
102 	{0x10b7, 0x7770, WI_BUS_PCI_PLX, "3Com Airconnect"},
103 	{0x16ab, 0x1101, WI_BUS_PCI_PLX, "GLPRISM2 WaveLAN"},
104 	{0x1260, 0x3872, WI_BUS_PCI_NATIVE, "Intersil Prism3"},
105 	{0x1260, 0x3873, WI_BUS_PCI_NATIVE, "Intersil Prism2.5"},
106 	{0x16ab, 0x1102, WI_BUS_PCI_PLX, "Linksys WDT11"},
107 	{0x1385, 0x4100, WI_BUS_PCI_PLX, "Netgear MA301"},
108 	{0x1638, 0x1100, WI_BUS_PCI_PLX, "PRISM2STA WaveLAN"},
109 	{0x111a, 0x1023, WI_BUS_PCI_PLX, "Siemens SpeedStream"},
110 	{0x10b5, 0x9050, WI_BUS_PCI_PLX, "SMC 2602W"},
111 	{0x16ec, 0x3685, WI_BUS_PCI_PLX, "US Robotics 2415"},
112 	{0x4033, 0x7001, WI_BUS_PCI_PLX, "Addtron AWA-100 PCI"},
113 	{0, 0, 0, NULL}
114 };
115 
116 DRIVER_MODULE(wi, pci, wi_pci_driver, wi_devclass, 0, 0);
117 MODULE_DEPEND(wi, pci, 1, 1, 1);
118 MODULE_DEPEND(wi, wlan, 1, 1, 1);
119 
120 static int
wi_pci_probe(dev)121 wi_pci_probe(dev)
122 	device_t	dev;
123 {
124 	struct wi_softc		*sc;
125 	int i;
126 
127 	sc = device_get_softc(dev);
128 	for(i=0; pci_ids[i].vendor != 0; i++) {
129 		if ((pci_get_vendor(dev) == pci_ids[i].vendor) &&
130 			(pci_get_device(dev) == pci_ids[i].device)) {
131 			sc->wi_bus_type = pci_ids[i].bus_type;
132 			device_set_desc(dev, pci_ids[i].desc);
133 			return (BUS_PROBE_DEFAULT);
134 		}
135 	}
136 	return(ENXIO);
137 }
138 
139 static int
wi_pci_attach(device_t dev)140 wi_pci_attach(device_t dev)
141 {
142 	struct wi_softc		*sc;
143 	u_int32_t		command;
144 	u_int16_t		reg;
145 	int			error;
146 	int			timeout;
147 
148 	sc = device_get_softc(dev);
149 
150 	if (sc->wi_bus_type != WI_BUS_PCI_NATIVE) {
151 		error = wi_alloc(dev, WI_PCI_IORES);
152 		if (error)
153 			return (error);
154 
155 		/* Make sure interrupts are disabled. */
156 		CSR_WRITE_2(sc, WI_INT_EN, 0);
157 		CSR_WRITE_2(sc, WI_EVENT_ACK, 0xFFFF);
158 
159 		/* We have to do a magic PLX poke to enable interrupts */
160 		sc->local_rid = WI_PCI_LOCALRES;
161 		sc->local = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
162 		    &sc->local_rid, RF_ACTIVE);
163 		sc->wi_localtag = rman_get_bustag(sc->local);
164 		sc->wi_localhandle = rman_get_bushandle(sc->local);
165 		command = bus_space_read_4(sc->wi_localtag, sc->wi_localhandle,
166 		    WI_LOCAL_INTCSR);
167 		command |= WI_LOCAL_INTEN;
168 		bus_space_write_4(sc->wi_localtag, sc->wi_localhandle,
169 		    WI_LOCAL_INTCSR, command);
170 		bus_release_resource(dev, SYS_RES_IOPORT, sc->local_rid,
171 		    sc->local);
172 		sc->local = NULL;
173 
174 		sc->mem_rid = WI_PCI_MEMRES;
175 		sc->mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
176 					&sc->mem_rid, RF_ACTIVE);
177 		if (sc->mem == NULL) {
178 			device_printf(dev, "couldn't allocate memory\n");
179 			wi_free(dev);
180 			return (ENXIO);
181 		}
182 		sc->wi_bmemtag = rman_get_bustag(sc->mem);
183 		sc->wi_bmemhandle = rman_get_bushandle(sc->mem);
184 
185 		/*
186 		 * Write COR to enable PC card
187 		 * This is a subset of the protocol that the pccard bus code
188 		 * would do.  In theory, we should parse the CIS to find the
189 		 * COR offset.  In practice, the COR_OFFSET is always 0x3e0.
190 		 */
191 		CSM_WRITE_1(sc, WI_COR_OFFSET, WI_COR_VALUE);
192 		reg = CSM_READ_1(sc, WI_COR_OFFSET);
193 		if (reg != WI_COR_VALUE) {
194 			device_printf(dev, "CSM_READ_1(WI_COR_OFFSET) "
195 			    "wanted %d, got %d\n", WI_COR_VALUE, reg);
196 			wi_free(dev);
197 			return (ENXIO);
198 		}
199 	} else {
200 		error = wi_alloc(dev, WI_PCI_LMEMRES);
201 		if (error)
202 			return (error);
203 
204 		CSR_WRITE_2(sc, WI_PCICOR_OFF, WI_PCICOR_RESET);
205 		DELAY(250000);
206 
207 		CSR_WRITE_2(sc, WI_PCICOR_OFF, 0x0000);
208 		DELAY(500000);
209 
210 		timeout=2000000;
211 		while ((--timeout > 0) &&
212 		    (CSR_READ_2(sc, WI_COMMAND) & WI_CMD_BUSY))
213 			DELAY(10);
214 
215 		if (timeout == 0) {
216 			device_printf(dev, "couldn't reset prism pci core.\n");
217 			wi_free(dev);
218 			return(ENXIO);
219 		}
220 	}
221 
222 	CSR_WRITE_2(sc, WI_HFA384X_SWSUPPORT0_OFF, WI_PRISM2STA_MAGIC);
223 	reg = CSR_READ_2(sc, WI_HFA384X_SWSUPPORT0_OFF);
224 	if (reg != WI_PRISM2STA_MAGIC) {
225 		device_printf(dev,
226 		    "CSR_READ_2(WI_HFA384X_SWSUPPORT0_OFF) "
227 		    "wanted %d, got %d\n", WI_PRISM2STA_MAGIC, reg);
228 		wi_free(dev);
229 		return (ENXIO);
230 	}
231 
232 	error = wi_attach(dev);
233 	if (error != 0)
234 		wi_free(dev);
235 	else
236 		gone_in_dev(dev, 13, "pccard removed, wi doesn't support modern crypto");
237 	return (error);
238 }
239 
240 static int
wi_pci_suspend(device_t dev)241 wi_pci_suspend(device_t dev)
242 {
243 	struct wi_softc	*sc = device_get_softc(dev);
244 
245 	WI_LOCK(sc);
246 	wi_stop(sc, 1);
247 	WI_UNLOCK(sc);
248 
249 	return (0);
250 }
251 
252 static int
wi_pci_resume(device_t dev)253 wi_pci_resume(device_t dev)
254 {
255 	struct wi_softc	*sc = device_get_softc(dev);
256 	struct ieee80211com *ic = &sc->sc_ic;
257 
258 	WI_LOCK(sc);
259 	if (sc->wi_bus_type != WI_BUS_PCI_NATIVE) {
260 		WI_UNLOCK(sc);
261 		return (0);
262 	}
263 	if (ic->ic_nrunning > 0)
264 		wi_init(sc);
265 	WI_UNLOCK(sc);
266 	return (0);
267 }
268