xref: /netbsd-src/sys/dev/pci/if_re_pci.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: if_re_pci.c,v 1.12 2005/12/25 19:55:41 rpaulo Exp $	*/
2 
3 /*
4  * Copyright (c) 1997, 1998-2003
5  *	Bill Paul <wpaul@windriver.com>.  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 
35 /* $FreeBSD: /repoman/r/ncvs/src/sys/dev/re/if_re.c,v 1.20 2004/04/11 20:34:08 ru Exp $ */
36 
37 /*
38  * RealTek 8139C+/8169/8169S/8110S PCI NIC driver
39  *
40  * Written by Bill Paul <wpaul@windriver.com>
41  * Senior Networking Software Engineer
42  * Wind River Systems
43  *
44  * Netbsd bus-specific frontends for written by
45  * Jonathan Stone <jonathan@netbsd.org>
46  */
47 
48 #include "bpfilter.h"
49 #include "vlan.h"
50 
51 #include <sys/types.h>
52 
53 #include <sys/param.h>
54 #include <sys/endian.h>
55 #include <sys/systm.h>
56 #include <sys/sockio.h>
57 #include <sys/mbuf.h>
58 #include <sys/malloc.h>
59 #include <sys/kernel.h>
60 #include <sys/socket.h>
61 #include <sys/device.h>
62 
63 #include <net/if.h>
64 #include <net/if_arp.h>
65 #include <net/if_dl.h>
66 #include <net/if_ether.h>
67 #include <net/if_media.h>
68 #include <net/if_vlanvar.h>
69 
70 #include <machine/bus.h>
71 
72 #include <dev/mii/mii.h>
73 #include <dev/mii/miivar.h>
74 
75 #include <dev/pci/pcireg.h>
76 #include <dev/pci/pcivar.h>
77 #include <dev/pci/pcidevs.h>
78 
79 /*
80  * Default to using PIO access for this driver.
81  */
82 #define RE_USEIOSPACE
83 
84 #include <dev/ic/rtl81x9reg.h>
85 #include <dev/ic/rtl81x9var.h>
86 #include <dev/ic/rtl8169var.h>
87 
88 struct re_pci_softc {
89 	struct rtk_softc sc_rtk;
90 
91 	void *sc_ih;
92 	pci_chipset_tag_t sc_pc;
93 	pcitag_t sc_pcitag;
94 };
95 
96 static int	re_pci_probe(struct device *, struct cfdata *, void *);
97 static void	re_pci_attach(struct device *, struct device *, void *);
98 
99 /*
100  * Various supported device vendors/types and their names.
101  */
102 static const struct rtk_type re_devs[] = {
103 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139, RTK_HWREV_8139CPLUS,
104 		"RealTek 8139C+ 10/100BaseTX" },
105 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RTK_HWREV_8169,
106 		"RealTek 8169 Gigabit Ethernet" },
107 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RTK_HWREV_8169S,
108 		"RealTek 8169S Single-chip Gigabit Ethernet" },
109 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RTK_HWREV_8169SB,
110 		"RealTek 8169SB Single-chip Gigabit Ethernet" },
111 	{ PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_LAPCIGT, RTK_HWREV_8169S,
112 		"Corega CG-LAPCIGT Gigabit Ethernet" },
113 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RTK_HWREV_8110S,
114 		"RealTek 8110S Single-chip Gigabit Ethernet" },
115 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T, RTK_HWREV_8169S,
116 		"D-Link DGE-528T Gigabit Ethernet" },
117 	{ PCI_VENDOR_USR2, PCI_PRODUCT_USR2_USR997902, RTK_HWREV_8169S,
118 		"US Robotics (3Com) USR997902 Gigabit Ethernet" },
119 	{ PCI_VENDOR_LINKSYS, PCI_PRODUCT_LINKSYS_EG1032, RTK_HWREV_8169S,
120 		"Linksys EG1032 rev. 3 Gigabit Ethernet" },
121 	{ 0, 0, 0, NULL }
122 };
123 
124 static const struct rtk_hwrev re_hwrevs[] = {
125 	{ RTK_HWREV_8139, RTK_8139,  "" },
126 	{ RTK_HWREV_8139A, RTK_8139, "A" },
127 	{ RTK_HWREV_8139AG, RTK_8139, "A-G" },
128 	{ RTK_HWREV_8139B, RTK_8139, "B" },
129 	{ RTK_HWREV_8130, RTK_8139, "8130" },
130 	{ RTK_HWREV_8139C, RTK_8139, "C" },
131 	{ RTK_HWREV_8139D, RTK_8139, "8139D/8100B/8100C" },
132 	{ RTK_HWREV_8139CPLUS, RTK_8139CPLUS, "C+"},
133 	{ RTK_HWREV_8169, RTK_8169, "8169"},
134 	{ RTK_HWREV_8169S, RTK_8169, "8169S"},
135 	{ RTK_HWREV_8169SB, RTK_8169, "8169SB"},
136 	{ RTK_HWREV_8110S, RTK_8169, "8110S"},
137 	{ RTK_HWREV_8100, RTK_8139, "8100"},
138 	{ RTK_HWREV_8101, RTK_8139, "8101"},
139 	{ 0, 0, NULL }
140 };
141 
142 #define RE_LINKSYS_EG1032_SUBID	0x00241737
143 
144 CFATTACH_DECL(re_pci, sizeof(struct re_pci_softc), re_pci_probe, re_pci_attach,
145 	      NULL, NULL);
146 
147 /*
148  * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
149  * IDs against our list and return a device name if we find a match.
150  */
151 static int
152 re_pci_probe(struct device *parent, struct cfdata *match, void *aux)
153 {
154 	const struct rtk_type		*t;
155 	struct pci_attach_args	*pa = aux;
156 	bus_space_tag_t		rtk_btag;
157 	bus_space_handle_t	rtk_bhandle;
158 	bus_size_t		bsize;
159 	u_int32_t		hwrev;
160 	pcireg_t subid;
161 
162 	subid = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG);
163 
164 	/* special-case Linksys EG1032, since rev 2 uses sk(4) */
165 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_LINKSYS &&
166 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_LINKSYS_EG1032 &&
167 	    subid == RE_LINKSYS_EG1032_SUBID)
168 		return 1;
169 
170 	t = re_devs;
171 
172 	while (t->rtk_name != NULL) {
173 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
174 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
175 
176 			/*
177 			 * Temporarily map the I/O space
178 			 * so we can read the chip ID register.
179 			 */
180 #ifdef RE_USEIOSPACE
181 			if (pci_mapreg_map(pa, RTK_PCI_LOIO,
182 			    PCI_MAPREG_TYPE_IO, 0, &rtk_btag,
183 			    &rtk_bhandle, NULL, &bsize)) {
184 				aprint_error("can't map i/o space\n");
185 				return 0;
186 			}
187 #else
188 			if (pci_mapreg_map(pa, RTK_PCI_LOMEM,
189 			    PCI_MAPREG_TYPE_MEM, 0, &rtk_btag,
190 			    &rtk_bhandle, NULL, &bsize)) {
191 				aprint_error("can't map mem space\n");
192 				return 0;
193 			}
194 #endif
195 			hwrev = bus_space_read_4(rtk_btag, rtk_bhandle,
196 			    RTK_TXCFG) & RTK_TXCFG_HWREV;
197 			bus_space_unmap(rtk_btag, rtk_bhandle, bsize);
198 			if (t->rtk_basetype == hwrev)
199 				return 2;	/* defeat rtk(4) */
200 		}
201 		t++;
202 	}
203 
204 	return 0;
205 }
206 
207 static void
208 re_pci_attach(struct device *parent, struct device *self, void *aux)
209 {
210 	struct re_pci_softc	*psc = (void *)self;
211 	struct rtk_softc	*sc = &psc->sc_rtk;
212 	struct pci_attach_args 	*pa = aux;
213 	pci_chipset_tag_t pc = pa->pa_pc;
214 	pci_intr_handle_t ih;
215 	const char *intrstr = NULL;
216 	const struct rtk_type	*t;
217 	const struct rtk_hwrev	*hw_rev;
218 	int			hwrev;
219 	int			error = 0;
220 	int			pmreg;
221 	pcireg_t		command;
222 	bus_size_t		bsize;
223 
224 
225 	/*
226 	 * Handle power management nonsense.
227 	 */
228 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
229 		command = pci_conf_read(pc, pa->pa_tag, pmreg + PCI_PMCSR);
230 		if (command & RTK_PSTATE_MASK) {
231 			u_int32_t		iobase, membase, irq;
232 
233 			/* Save important PCI config data. */
234 			iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
235 			membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
236 			irq = pci_conf_read(pc, pa->pa_tag, PCI_INTERRUPT_REG);
237 
238 			/* Reset the power state. */
239 			aprint_normal("%s: chip is is in D%d power mode "
240 		    	    "-- setting to D0\n", sc->sc_dev.dv_xname,
241 		    	    command & RTK_PSTATE_MASK);
242 
243 			command &= ~RTK_PSTATE_MASK;
244 			pci_conf_write(pc, pa->pa_tag,
245 			    pmreg + PCI_PMCSR, command);
246 
247 			/* Restore PCI config data. */
248 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
249 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
250 			pci_conf_write(pc, pa->pa_tag, PCI_INTERRUPT_REG, irq);
251 		}
252 	}
253 
254 	/*
255 	 * Map control/status registers.
256 	 */
257 	command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
258 	command |= PCI_COMMAND_MASTER_ENABLE;
259 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
260 
261 #ifdef RE_USEIOSPACE
262 	if (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
263 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, &bsize)) {
264 		aprint_error("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
265 		return;
266 	}
267 #else
268 	if (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
269 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, &bsize)) {
270 		aprint_error("%s: can't map mem space\n", sc->sc_dev.dv_xname);
271 		return;
272 	}
273 #endif
274 	t = re_devs;
275 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
276 
277 	while (t->rtk_name != NULL) {
278 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
279 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
280 
281 			if (t->rtk_basetype == hwrev)
282 				break;
283 		}
284 		t++;
285 	}
286 	aprint_normal(": %s\n", t->rtk_name);
287 
288 	hw_rev = re_hwrevs;
289 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
290 	while (hw_rev->rtk_desc != NULL) {
291 		if (hw_rev->rtk_rev == hwrev) {
292 			sc->rtk_type = hw_rev->rtk_type;
293 			break;
294 		}
295 		hw_rev++;
296 	}
297 
298 	sc->sc_dmat = pa->pa_dmat;
299 
300 	/*
301 	 * No power/enable/disable machinery for PCI attac;
302 	 * mark the card enabled now.
303 	 */
304 	sc->sc_flags |= RTK_ENABLED;
305 
306 	/* Hook interrupt last to avoid having to lock softc */
307 	/* Allocate interrupt */
308 	if (pci_intr_map(pa, &ih)) {
309 		aprint_error("%s: couldn't map interrupt\n",
310 		    sc->sc_dev.dv_xname);
311 		return;
312 	}
313 	intrstr = pci_intr_string(pc, ih);
314 	psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, re_intr, sc);
315 	if (psc->sc_ih == NULL) {
316 		aprint_error("%s: couldn't establish interrupt",
317 		    sc->sc_dev.dv_xname);
318 		if (intrstr != NULL)
319 			aprint_error(" at %s", intrstr);
320 		aprint_error("\n");
321 		return;
322 	}
323 	aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
324 
325 	re_attach(sc);
326 
327 	/*
328 	 * Perform hardware diagnostic.
329 	 * XXX: this diagnostic only makes sense for attachemnts with 64-bit
330 	 * busses: PCI, but not CardBus.
331 	 */
332 	error = re_diag(sc);
333 	if (error) {
334 		aprint_error(
335 		    "%s: attach aborted due to hardware diag failure\n",
336 		    sc->sc_dev.dv_xname);
337 
338 		re_detach(sc);
339 
340 		if (psc->sc_ih != NULL) {
341 			pci_intr_disestablish(pc, psc->sc_ih);
342 			psc->sc_ih = NULL;
343 		}
344 
345 		if (bsize)
346 			bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle, bsize);
347 	}
348 }
349