xref: /netbsd-src/sys/dev/pci/if_rtw_pci.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: if_rtw_pci.c,v 1.4 2005/12/04 17:44:02 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2002 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; Charles M. Hannum; and David Young.
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 Realtek RTL8180 802.11 MAC/BBP chip.
42  *
43  * Derived from the ADMtek ADM8211 PCI bus front-end.
44  *
45  * Derived from the ``Tulip'' PCI bus front-end.
46  */
47 
48 #include <sys/cdefs.h>
49 __KERNEL_RCSID(0, "$NetBSD: if_rtw_pci.c,v 1.4 2005/12/04 17:44:02 christos Exp $");
50 
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/mbuf.h>
54 #include <sys/malloc.h>
55 #include <sys/kernel.h>
56 #include <sys/socket.h>
57 #include <sys/ioctl.h>
58 #include <sys/errno.h>
59 #include <sys/device.h>
60 
61 #include <machine/endian.h>
62 
63 #include <net/if.h>
64 #include <net/if_dl.h>
65 #include <net/if_media.h>
66 #include <net/if_ether.h>
67 
68 #include <net80211/ieee80211_netbsd.h>
69 #include <net80211/ieee80211_radiotap.h>
70 #include <net80211/ieee80211_var.h>
71 
72 #include <machine/bus.h>
73 #include <machine/intr.h>
74 
75 #include <dev/ic/rtwreg.h>
76 #include <dev/ic/sa2400reg.h>
77 #include <dev/ic/rtwvar.h>
78 
79 #include <dev/pci/pcivar.h>
80 #include <dev/pci/pcireg.h>
81 #include <dev/pci/pcidevs.h>
82 
83 /*
84  * PCI configuration space registers used by the ADM8211.
85  */
86 #define	RTW_PCI_IOBA		0x10	/* i/o mapped base */
87 #define	RTW_PCI_MMBA		0x14	/* memory mapped base */
88 
89 struct rtw_pci_softc {
90 	struct rtw_softc	psc_rtw;	/* real ADM8211 softc */
91 
92 	pci_intr_handle_t	psc_ih;		/* interrupt handle */
93 	void			*psc_intrcookie;
94 
95 	pci_chipset_tag_t	psc_pc;		/* our PCI chipset */
96 	pcitag_t		psc_pcitag;	/* our PCI tag */
97 };
98 
99 static int	rtw_pci_match(struct device *, struct cfdata *, void *);
100 static void	rtw_pci_attach(struct device *, struct device *, void *);
101 
102 CFATTACH_DECL(rtw_pci, sizeof(struct rtw_pci_softc),
103     rtw_pci_match, rtw_pci_attach, NULL, NULL);
104 
105 static const struct rtw_pci_product {
106 	u_int32_t	app_vendor;	/* PCI vendor ID */
107 	u_int32_t	app_product;	/* PCI product ID */
108 	const char	*app_product_name;
109 } rtw_pci_products[] = {
110 	{ PCI_VENDOR_REALTEK,		PCI_PRODUCT_REALTEK_RT8180,
111 	  "Realtek RTL8180 802.11 MAC/BBP" },
112 	{ PCI_VENDOR_BELKIN,		PCI_PRODUCT_BELKIN_F5D6001,
113 	  "Belkin F5D6001" },
114 
115 	{ 0,				0,				NULL },
116 };
117 
118 static const struct rtw_pci_product *
119 rtw_pci_lookup(const struct pci_attach_args *pa)
120 {
121 	const struct rtw_pci_product *app;
122 
123 	for (app = rtw_pci_products;
124 	     app->app_product_name != NULL;
125 	     app++) {
126 		if (PCI_VENDOR(pa->pa_id) == app->app_vendor &&
127 		    PCI_PRODUCT(pa->pa_id) == app->app_product)
128 			return (app);
129 	}
130 	return (NULL);
131 }
132 
133 static int
134 rtw_pci_match(struct device *parent, struct cfdata *match, void *aux)
135 {
136 	struct pci_attach_args *pa = aux;
137 
138 	if (rtw_pci_lookup(pa) != NULL)
139 		return (1);
140 
141 	return (0);
142 }
143 
144 static int
145 rtw_pci_enable(struct rtw_softc *sc)
146 {
147 	struct rtw_pci_softc *psc = (void *)sc;
148 
149 	/* Establish the interrupt. */
150 	psc->psc_intrcookie = pci_intr_establish(psc->psc_pc, psc->psc_ih,
151 	    IPL_NET, rtw_intr, sc);
152 	if (psc->psc_intrcookie == NULL) {
153 		printf("%s: unable to establish interrupt\n",
154 		    sc->sc_dev.dv_xname);
155 		return (1);
156 	}
157 
158 	return (0);
159 }
160 
161 static void
162 rtw_pci_disable(struct rtw_softc *sc)
163 {
164 	struct rtw_pci_softc *psc = (void *)sc;
165 
166 	/* Unhook the interrupt handler. */
167 	pci_intr_disestablish(psc->psc_pc, psc->psc_intrcookie);
168 	psc->psc_intrcookie = NULL;
169 }
170 
171 static void
172 rtw_pci_attach(struct device *parent, struct device *self, void *aux)
173 {
174 	struct rtw_pci_softc *psc = (void *) self;
175 	struct rtw_softc *sc = &psc->psc_rtw;
176 	struct rtw_regs *regs = &sc->sc_regs;
177 	struct pci_attach_args *pa = aux;
178 	pci_chipset_tag_t pc = pa->pa_pc;
179 	const char *intrstr = NULL;
180 	bus_space_tag_t iot, memt;
181 	bus_space_handle_t ioh, memh;
182 	int ioh_valid, memh_valid;
183 	const struct rtw_pci_product *app;
184 	pcireg_t reg;
185 	int pmreg;
186 
187 	psc->psc_pc = pa->pa_pc;
188 	psc->psc_pcitag = pa->pa_tag;
189 
190 	app = rtw_pci_lookup(pa);
191 	if (app == NULL) {
192 		printf("\n");
193 		panic("rtw_pci_attach: impossible");
194 	}
195 
196 	/*
197 	 * No power management hooks.
198 	 * XXX Maybe we should add some!
199 	 */
200 	sc->sc_flags |= RTW_F_ENABLED;
201 
202 	/*
203 	 * Get revision info, and set some chip-specific variables.
204 	 */
205 	sc->sc_rev = PCI_REVISION(pa->pa_class);
206 	printf(": %s, revision %d.%d\n", app->app_product_name,
207 	    (sc->sc_rev >> 4) & 0xf, sc->sc_rev & 0xf);
208 
209 	/*
210 	 * Check to see if the device is in power-save mode, and
211 	 * being it out if necessary.
212 	 *
213 	 * XXX This code comes almost verbatim from if_tlp_pci.c. I do
214 	 * not understand it. Tulip clears the "sleep mode" bit in the
215 	 * CFDA register, first.  There is an equivalent (?) register at the
216 	 * same place in the ADM8211, but the docs do not assign its bits
217 	 * any meanings. -dcy
218 	 */
219 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
220 		reg = pci_conf_read(pc, pa->pa_tag, pmreg + PCI_PMCSR);
221 		switch (reg & PCI_PMCSR_STATE_MASK) {
222 		case PCI_PMCSR_STATE_D1:
223 		case PCI_PMCSR_STATE_D2:
224 			printf(": waking up from power state D%d\n%s",
225 			    reg & PCI_PMCSR_STATE_MASK, sc->sc_dev.dv_xname);
226 			pci_conf_write(pc, pa->pa_tag, pmreg + PCI_PMCSR,
227 			    (reg & ~PCI_PMCSR_STATE_MASK) |
228 			    PCI_PMCSR_STATE_D0);
229 			break;
230 		case PCI_PMCSR_STATE_D3:
231 			/*
232 			 * The card has lost all configuration data in
233 			 * this state, so punt.
234 			 */
235 			printf(": unable to wake up from power state D3, "
236 			       "reboot required.\n");
237 			pci_conf_write(pc, pa->pa_tag, pmreg + PCI_PMCSR,
238 			    (reg & ~PCI_PMCSR_STATE_MASK) |
239 			    PCI_PMCSR_STATE_D0);
240 			return;
241 		}
242 	}
243 
244 	/*
245 	 * Map the device.
246 	 */
247 	ioh_valid = (pci_mapreg_map(pa, RTW_PCI_IOBA,
248 	    PCI_MAPREG_TYPE_IO, 0,
249 	    &iot, &ioh, NULL, NULL) == 0);
250 	memh_valid = (pci_mapreg_map(pa, RTW_PCI_MMBA,
251 	    PCI_MAPREG_TYPE_MEM|PCI_MAPREG_MEM_TYPE_32BIT, 0,
252 	    &memt, &memh, NULL, NULL) == 0);
253 
254 	if (memh_valid) {
255 		regs->r_bt = memt;
256 		regs->r_bh = memh;
257 	} else if (ioh_valid) {
258 		regs->r_bt = iot;
259 		regs->r_bh = ioh;
260 	} else {
261 		printf(": unable to map device registers\n");
262 		return;
263 	}
264 
265 	sc->sc_dmat = pa->pa_dmat;
266 
267 	/*
268 	 * Make sure bus mastering is enabled.
269 	 */
270 	pci_conf_write(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
271 	    pci_conf_read(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG) |
272 	    PCI_COMMAND_MASTER_ENABLE);
273 
274 	/*
275 	 * Map and establish our interrupt.
276 	 */
277 	if (pci_intr_map(pa, &psc->psc_ih)) {
278 		printf("%s: unable to map interrupt\n",
279 		    sc->sc_dev.dv_xname);
280 		return;
281 	}
282 	intrstr = pci_intr_string(pc, psc->psc_ih);
283 	psc->psc_intrcookie = pci_intr_establish(pc, psc->psc_ih, IPL_NET,
284 	    rtw_intr, sc);
285 	if (psc->psc_intrcookie == NULL) {
286 		printf("%s: unable to establish interrupt",
287 		    sc->sc_dev.dv_xname);
288 		if (intrstr != NULL)
289 			printf(" at %s", intrstr);
290 		printf("\n");
291 		return;
292 	}
293 
294 	printf("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
295 
296 	sc->sc_enable = rtw_pci_enable;
297 	sc->sc_disable = rtw_pci_disable;
298 
299 	/*
300 	 * Finish off the attach.
301 	 */
302 	rtw_attach(sc);
303 }
304