xref: /freebsd/sys/dev/mwl/if_mwl_pci.c (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2007-2009 Sam Leffler, Errno Consulting
5  * Copyright (c) 2007-2009 Marvell Semiconductor, 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  *    without modification.
14  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
16  *    redistribution must be conditioned upon including a substantially
17  *    similar Disclaimer requirement for further binary redistribution.
18  *
19  * NO WARRANTY
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
23  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
24  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
25  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
28  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30  * THE POSSIBILITY OF SUCH DAMAGES.
31  */
32 
33 #include <sys/cdefs.h>
34 #ifdef __FreeBSD__
35 #endif
36 
37 /*
38  * PCI front-end for the Marvell Wireless LAN controller driver.
39  */
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/module.h>
44 #include <sys/kernel.h>
45 #include <sys/lock.h>
46 #include <sys/malloc.h>
47 #include <sys/mbuf.h>
48 #include <sys/mutex.h>
49 #include <sys/errno.h>
50 
51 #include <machine/bus.h>
52 #include <machine/resource.h>
53 #include <sys/bus.h>
54 #include <sys/rman.h>
55 
56 #include <sys/socket.h>
57 
58 #include <net/ethernet.h>
59 #include <net/if.h>
60 #include <net/if_media.h>
61 #include <net/if_arp.h>
62 #include <net/route.h>
63 
64 #include <net80211/ieee80211_var.h>
65 
66 #include <dev/mwl/if_mwlvar.h>
67 
68 #include <dev/pci/pcivar.h>
69 #include <dev/pci/pcireg.h>
70 
71 /*
72  * PCI glue.
73  */
74 
75 struct mwl_pci_softc {
76 	struct mwl_softc	sc_sc;
77 	struct resource		*sc_sr0;	/* BAR0 memory resource */
78 	struct resource		*sc_sr1;	/* BAR1 memory resource */
79 	struct resource		*sc_irq;	/* irq resource */
80 	void			*sc_ih;		/* interrupt handler */
81 };
82 
83 #define	BS_BAR0	0x10
84 #define	BS_BAR1	0x14
85 
86 struct mwl_pci_ident {
87 	uint16_t	vendor;
88 	uint16_t	device;
89 	const char	*name;
90 };
91 
92 static const struct mwl_pci_ident mwl_pci_ids[] = {
93 	{ 0x11ab, 0x2a02, "Marvell 88W8363" },
94 	{ 0x11ab, 0x2a03, "Marvell 88W8363" },
95 	{ 0x11ab, 0x2a0a, "Marvell 88W8363" },
96 	{ 0x11ab, 0x2a0b, "Marvell 88W8363" },
97 	{ 0x11ab, 0x2a0c, "Marvell 88W8363" },
98 	{ 0x11ab, 0x2a21, "Marvell 88W8363" },
99 	{ 0x11ab, 0x2a24, "Marvell 88W8363" },
100 	{ 0, 0, NULL }
101 };
102 
103 const static struct mwl_pci_ident *
104 mwl_pci_lookup(int vendor, int device)
105 {
106 	const struct mwl_pci_ident *ident;
107 
108 	for (ident = mwl_pci_ids; ident->name != NULL; ident++)
109 		if (vendor == ident->vendor && device == ident->device)
110 			return ident;
111 	return NULL;
112 }
113 
114 static int
115 mwl_pci_probe(device_t dev)
116 {
117 	const struct mwl_pci_ident *ident;
118 
119 	ident = mwl_pci_lookup(pci_get_vendor(dev), pci_get_device(dev));
120 	if (ident != NULL) {
121 		device_set_desc(dev, ident->name);
122 		return BUS_PROBE_DEFAULT;
123 	}
124 	return ENXIO;
125 }
126 
127 static int
128 mwl_pci_attach(device_t dev)
129 {
130 	struct mwl_pci_softc *psc = device_get_softc(dev);
131 	struct mwl_softc *sc = &psc->sc_sc;
132 	int rid, error = ENXIO;
133 
134 	sc->sc_dev = dev;
135 
136 	pci_enable_busmaster(dev);
137 
138 	/*
139 	 * Setup memory-mapping of PCI registers.
140 	 */
141 	rid = BS_BAR0;
142 	psc->sc_sr0 = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
143 					    RF_ACTIVE);
144 	if (psc->sc_sr0 == NULL) {
145 		device_printf(dev, "cannot map BAR0 register space\n");
146 		goto bad;
147 	}
148 	rid = BS_BAR1;
149 	psc->sc_sr1 = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
150 					    RF_ACTIVE);
151 	if (psc->sc_sr1 == NULL) {
152 		device_printf(dev, "cannot map BAR1 register space\n");
153 		goto bad1;
154 	}
155 	sc->sc_invalid = 1;
156 
157 	/*
158 	 * Arrange interrupt line.
159 	 */
160 	rid = 0;
161 	psc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
162 					     RF_SHAREABLE|RF_ACTIVE);
163 	if (psc->sc_irq == NULL) {
164 		device_printf(dev, "could not map interrupt\n");
165 		goto bad2;
166 	}
167 	if (bus_setup_intr(dev, psc->sc_irq,
168 			   INTR_TYPE_NET | INTR_MPSAFE,
169 			   NULL, mwl_intr, sc, &psc->sc_ih)) {
170 		device_printf(dev, "could not establish interrupt\n");
171 		goto bad3;
172 	}
173 
174 	/*
175 	 * Setup DMA descriptor area.
176 	 */
177 	if (bus_dma_tag_create(bus_get_dma_tag(dev),	/* parent */
178 			       1, 0,			/* alignment, bounds */
179 			       BUS_SPACE_MAXADDR_32BIT,	/* lowaddr */
180 			       BUS_SPACE_MAXADDR,	/* highaddr */
181 			       NULL, NULL,		/* filter, filterarg */
182 			       BUS_SPACE_MAXSIZE,	/* maxsize */
183 			       MWL_TXDESC,		/* nsegments */
184 			       BUS_SPACE_MAXSIZE,	/* maxsegsize */
185 			       0,			/* flags */
186 			       NULL,			/* lockfunc */
187 			       NULL,			/* lockarg */
188 			       &sc->sc_dmat)) {
189 		device_printf(dev, "cannot allocate DMA tag\n");
190 		goto bad4;
191 	}
192 
193 	/*
194 	 * Finish off the attach.
195 	 */
196 	MWL_LOCK_INIT(sc);
197 	sc->sc_io0t = rman_get_bustag(psc->sc_sr0);
198 	sc->sc_io0h = rman_get_bushandle(psc->sc_sr0);
199 	sc->sc_io1t = rman_get_bustag(psc->sc_sr1);
200 	sc->sc_io1h = rman_get_bushandle(psc->sc_sr1);
201 	if (mwl_attach(pci_get_device(dev), sc) == 0)
202 		return (0);
203 
204 	MWL_LOCK_DESTROY(sc);
205 	bus_dma_tag_destroy(sc->sc_dmat);
206 bad4:
207 	bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
208 bad3:
209 	bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
210 bad2:
211 	bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR1, psc->sc_sr1);
212 bad1:
213 	bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR0, psc->sc_sr0);
214 bad:
215 	return (error);
216 }
217 
218 static int
219 mwl_pci_detach(device_t dev)
220 {
221 	struct mwl_pci_softc *psc = device_get_softc(dev);
222 	struct mwl_softc *sc = &psc->sc_sc;
223 
224 	/* check if device was removed */
225 	sc->sc_invalid = !bus_child_present(dev);
226 
227 	mwl_detach(sc);
228 
229 	bus_generic_detach(dev);
230 	bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
231 	bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
232 
233 	bus_dma_tag_destroy(sc->sc_dmat);
234 	bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR1, psc->sc_sr1);
235 	bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR0, psc->sc_sr0);
236 
237 	MWL_LOCK_DESTROY(sc);
238 
239 	return (0);
240 }
241 
242 static int
243 mwl_pci_shutdown(device_t dev)
244 {
245 	struct mwl_pci_softc *psc = device_get_softc(dev);
246 
247 	mwl_shutdown(&psc->sc_sc);
248 	return (0);
249 }
250 
251 static int
252 mwl_pci_suspend(device_t dev)
253 {
254 	struct mwl_pci_softc *psc = device_get_softc(dev);
255 
256 	mwl_suspend(&psc->sc_sc);
257 
258 	return (0);
259 }
260 
261 static int
262 mwl_pci_resume(device_t dev)
263 {
264 	struct mwl_pci_softc *psc = device_get_softc(dev);
265 
266 	pci_enable_busmaster(dev);
267 
268 	mwl_resume(&psc->sc_sc);
269 
270 	return (0);
271 }
272 
273 static device_method_t mwl_pci_methods[] = {
274 	/* Device interface */
275 	DEVMETHOD(device_probe,		mwl_pci_probe),
276 	DEVMETHOD(device_attach,	mwl_pci_attach),
277 	DEVMETHOD(device_detach,	mwl_pci_detach),
278 	DEVMETHOD(device_shutdown,	mwl_pci_shutdown),
279 	DEVMETHOD(device_suspend,	mwl_pci_suspend),
280 	DEVMETHOD(device_resume,	mwl_pci_resume),
281 	{ 0,0 }
282 };
283 
284 static driver_t mwl_pci_driver = {
285 	"mwl",
286 	mwl_pci_methods,
287 	sizeof (struct mwl_pci_softc)
288 };
289 
290 DRIVER_MODULE(mwl, pci, mwl_pci_driver, 0, 0);
291 MODULE_VERSION(mwl, 1);
292 MODULE_DEPEND(mwl, wlan, 1, 1, 1);		/* 802.11 media layer */
293 MODULE_DEPEND(mwl, firmware, 1, 1, 1);
294