xref: /netbsd-src/sys/dev/pci/if_re_pci.c (revision df0caa2637da0538ecdf6b878c4d08e684b43d8f)
1 /*	$NetBSD: if_re_pci.c,v 1.10 2005/06/15 11:27:39 cube 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_COREGA, PCI_PRODUCT_COREGA_LAPCIGT, RTK_HWREV_8169S,
110 		"Corega CG-LAPCIGT Gigabit Ethernet" },
111 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RTK_HWREV_8110S,
112 		"RealTek 8110S Single-chip Gigabit Ethernet" },
113 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T, RTK_HWREV_8169S,
114 		"D-Link DGE-528T Gigabit Ethernet" },
115 	{ PCI_VENDOR_USR2, PCI_PRODUCT_USR2_USR997902, RTK_HWREV_8169S,
116 		"US Robotics (3Com) USR997902 Gigabit Ethernet" },
117 	{ 0, 0, 0, NULL }
118 };
119 
120 static const struct rtk_hwrev re_hwrevs[] = {
121 	{ RTK_HWREV_8139, RTK_8139,  "" },
122 	{ RTK_HWREV_8139A, RTK_8139, "A" },
123 	{ RTK_HWREV_8139AG, RTK_8139, "A-G" },
124 	{ RTK_HWREV_8139B, RTK_8139, "B" },
125 	{ RTK_HWREV_8130, RTK_8139, "8130" },
126 	{ RTK_HWREV_8139C, RTK_8139, "C" },
127 	{ RTK_HWREV_8139D, RTK_8139, "8139D/8100B/8100C" },
128 	{ RTK_HWREV_8139CPLUS, RTK_8139CPLUS, "C+"},
129 	{ RTK_HWREV_8169, RTK_8169, "8169"},
130 	{ RTK_HWREV_8169S, RTK_8169, "8169S"},
131 	{ RTK_HWREV_8110S, RTK_8169, "8110S"},
132 	{ RTK_HWREV_8100, RTK_8139, "8100"},
133 	{ RTK_HWREV_8101, RTK_8139, "8101"},
134 	{ 0, 0, NULL }
135 };
136 
137 CFATTACH_DECL(re_pci, sizeof(struct re_pci_softc), re_pci_probe, re_pci_attach,
138 	      NULL, NULL);
139 
140 /*
141  * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
142  * IDs against our list and return a device name if we find a match.
143  */
144 static int
145 re_pci_probe(struct device *parent, struct cfdata *match, void *aux)
146 {
147 	const struct rtk_type		*t;
148 	struct pci_attach_args	*pa = aux;
149 	bus_space_tag_t		rtk_btag;
150 	bus_space_handle_t	rtk_bhandle;
151 	bus_size_t		bsize;
152 	u_int32_t		hwrev;
153 
154 	t = re_devs;
155 
156 	while (t->rtk_name != NULL) {
157 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
158 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
159 
160 			/*
161 			 * Temporarily map the I/O space
162 			 * so we can read the chip ID register.
163 			 */
164 #ifdef RE_USEIOSPACE
165 			if (pci_mapreg_map(pa, RTK_PCI_LOIO,
166 			    PCI_MAPREG_TYPE_IO, 0, &rtk_btag,
167 			    &rtk_bhandle, NULL, &bsize)) {
168 				aprint_error("can't map i/o space\n");
169 				return 0;
170 			}
171 #else
172 			if (pci_mapreg_map(pa, RTK_PCI_LOMEM,
173 			    PCI_MAPREG_TYPE_MEM, 0, &rtk_btag,
174 			    &rtk_bhandle, NULL, &bsize)) {
175 				aprint_error("can't map mem space\n");
176 				return 0;
177 			}
178 #endif
179 			hwrev = bus_space_read_4(rtk_btag, rtk_bhandle,
180 			    RTK_TXCFG) & RTK_TXCFG_HWREV;
181 			bus_space_unmap(rtk_btag, rtk_bhandle, bsize);
182 			if (t->rtk_basetype == hwrev)
183 				return 2;	/* defeat rtk(4) */
184 		}
185 		t++;
186 	}
187 
188 	return 0;
189 }
190 
191 static void
192 re_pci_attach(struct device *parent, struct device *self, void *aux)
193 {
194 	struct re_pci_softc	*psc = (void *)self;
195 	struct rtk_softc	*sc = &psc->sc_rtk;
196 	struct pci_attach_args 	*pa = aux;
197 	pci_chipset_tag_t pc = pa->pa_pc;
198 	pci_intr_handle_t ih;
199 	const char *intrstr = NULL;
200 	const struct rtk_type	*t;
201 	const struct rtk_hwrev	*hw_rev;
202 	int			hwrev;
203 	int			error = 0;
204 	int			pmreg;
205 	pcireg_t		command;
206 	bus_size_t		bsize;
207 
208 
209 	/*
210 	 * Handle power management nonsense.
211 	 */
212 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
213 		command = pci_conf_read(pc, pa->pa_tag, pmreg + PCI_PMCSR);
214 		if (command & RTK_PSTATE_MASK) {
215 			u_int32_t		iobase, membase, irq;
216 
217 			/* Save important PCI config data. */
218 			iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
219 			membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
220 			irq = pci_conf_read(pc, pa->pa_tag, PCI_INTERRUPT_REG);
221 
222 			/* Reset the power state. */
223 			aprint_normal("%s: chip is is in D%d power mode "
224 		    	    "-- setting to D0\n", sc->sc_dev.dv_xname,
225 		    	    command & RTK_PSTATE_MASK);
226 
227 			command &= ~RTK_PSTATE_MASK;
228 			pci_conf_write(pc, pa->pa_tag,
229 			    pmreg + PCI_PMCSR, command);
230 
231 			/* Restore PCI config data. */
232 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
233 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
234 			pci_conf_write(pc, pa->pa_tag, PCI_INTERRUPT_REG, irq);
235 		}
236 	}
237 
238 	/*
239 	 * Map control/status registers.
240 	 */
241 	command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
242 	command |= PCI_COMMAND_MASTER_ENABLE;
243 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
244 
245 #ifdef RE_USEIOSPACE
246 	if (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
247 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, &bsize)) {
248 		aprint_error("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
249 		return;
250 	}
251 #else
252 	if (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
253 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, &bsize)) {
254 		aprint_error("%s: can't map mem space\n", sc->sc_dev.dv_xname);
255 		return;
256 	}
257 #endif
258 	t = re_devs;
259 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
260 
261 	while (t->rtk_name != NULL) {
262 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
263 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
264 
265 			if (t->rtk_basetype == hwrev)
266 				break;
267 		}
268 		t++;
269 	}
270 	aprint_normal(": %s\n", t->rtk_name);
271 
272 	hw_rev = re_hwrevs;
273 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
274 	while (hw_rev->rtk_desc != NULL) {
275 		if (hw_rev->rtk_rev == hwrev) {
276 			sc->rtk_type = hw_rev->rtk_type;
277 			break;
278 		}
279 		hw_rev++;
280 	}
281 
282 	sc->sc_dmat = pa->pa_dmat;
283 
284 	/*
285 	 * No power/enable/disable machinery for PCI attac;
286 	 * mark the card enabled now.
287 	 */
288 	sc->sc_flags |= RTK_ENABLED;
289 
290 	/* Hook interrupt last to avoid having to lock softc */
291 	/* Allocate interrupt */
292 	if (pci_intr_map(pa, &ih)) {
293 		aprint_error("%s: couldn't map interrupt\n",
294 		    sc->sc_dev.dv_xname);
295 		return;
296 	}
297 	intrstr = pci_intr_string(pc, ih);
298 	psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, re_intr, sc);
299 	if (psc->sc_ih == NULL) {
300 		aprint_error("%s: couldn't establish interrupt",
301 		    sc->sc_dev.dv_xname);
302 		if (intrstr != NULL)
303 			aprint_error(" at %s", intrstr);
304 		aprint_error("\n");
305 		return;
306 	}
307 	aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
308 
309 	re_attach(sc);
310 
311 	/*
312 	 * Perform hardware diagnostic.
313 	 * XXX: this diagnostic only makes sense for attachemnts with 64-bit
314 	 * busses: PCI, but not CardBus.
315 	 */
316 	error = re_diag(sc);
317 	if (error) {
318 		aprint_error(
319 		    "%s: attach aborted due to hardware diag failure\n",
320 		    sc->sc_dev.dv_xname);
321 
322 		re_detach(sc);
323 
324 		if (psc->sc_ih != NULL) {
325 			pci_intr_disestablish(pc, psc->sc_ih);
326 			psc->sc_ih = NULL;
327 		}
328 
329 		if (bsize)
330 			bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle, bsize);
331 	}
332 }
333