xref: /netbsd-src/sys/dev/pci/if_rtk_pci.c (revision 1ca5c1b28139779176bd5c13ad7c5f25c0bcd5f8)
1 /*	$NetBSD: if_rtk_pci.c,v 1.10 2001/11/13 07:48:44 lukem Exp $	*/
2 
3 /*
4  * Copyright (c) 1997, 1998
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 Id: if_rl.c,v 1.17 1999/06/19 20:17:37 wpaul Exp
35  */
36 
37 /*
38  * RealTek 8129/8139 PCI NIC driver
39  *
40  * Supports several extremely cheap PCI 10/100 adapters based on
41  * the RealTek chipset. Datasheets can be obtained from
42  * www.realtek.com.tw.
43  *
44  * Written by Bill Paul <wpaul@ctr.columbia.edu>
45  * Electrical Engineering Department
46  * Columbia University, New York City
47  */
48 
49 /*
50  * The RealTek 8139 PCI NIC redefines the meaning of 'low end.' This is
51  * probably the worst PCI ethernet controller ever made, with the possible
52  * exception of the FEAST chip made by SMC. The 8139 supports bus-master
53  * DMA, but it has a terrible interface that nullifies any performance
54  * gains that bus-master DMA usually offers.
55  *
56  * For transmission, the chip offers a series of four TX descriptor
57  * registers. Each transmit frame must be in a contiguous buffer, aligned
58  * on a longword (32-bit) boundary. This means we almost always have to
59  * do mbuf copies in order to transmit a frame, except in the unlikely
60  * case where a) the packet fits into a single mbuf, and b) the packet
61  * is 32-bit aligned within the mbuf's data area. The presence of only
62  * four descriptor registers means that we can never have more than four
63  * packets queued for transmission at any one time.
64  *
65  * Reception is not much better. The driver has to allocate a single large
66  * buffer area (up to 64K in size) into which the chip will DMA received
67  * frames. Because we don't know where within this region received packets
68  * will begin or end, we have no choice but to copy data from the buffer
69  * area into mbufs in order to pass the packets up to the higher protocol
70  * levels.
71  *
72  * It's impossible given this rotten design to really achieve decent
73  * performance at 100Mbps, unless you happen to have a 400Mhz PII or
74  * some equally overmuscled CPU to drive it.
75  *
76  * On the bright side, the 8139 does have a built-in PHY, although
77  * rather than using an MDIO serial interface like most other NICs, the
78  * PHY registers are directly accessible through the 8139's register
79  * space. The 8139 supports autonegotiation, as well as a 64-bit multicast
80  * filter.
81  *
82  * The 8129 chip is an older version of the 8139 that uses an external PHY
83  * chip. The 8129 has a serial MDIO interface for accessing the MII where
84  * the 8139 lets you directly access the on-board PHY registers. We need
85  * to select which interface to use depending on the chip type.
86  */
87 
88 #include <sys/cdefs.h>
89 __KERNEL_RCSID(0, "$NetBSD: if_rtk_pci.c,v 1.10 2001/11/13 07:48:44 lukem Exp $");
90 
91 #include <sys/param.h>
92 #include <sys/systm.h>
93 #include <sys/callout.h>
94 #include <sys/device.h>
95 #include <sys/sockio.h>
96 #include <sys/mbuf.h>
97 #include <sys/malloc.h>
98 #include <sys/kernel.h>
99 #include <sys/socket.h>
100 
101 #include <net/if.h>
102 #include <net/if_arp.h>
103 #include <net/if_ether.h>
104 #include <net/if_dl.h>
105 #include <net/if_media.h>
106 
107 #include <machine/bus.h>
108 
109 #include <dev/pci/pcireg.h>
110 #include <dev/pci/pcivar.h>
111 #include <dev/pci/pcidevs.h>
112 
113 #include <dev/mii/mii.h>
114 #include <dev/mii/miivar.h>
115 
116 /*
117  * Default to using PIO access for this driver. On SMP systems,
118  * there appear to be problems with memory mapped mode: it looks like
119  * doing too many memory mapped access back to back in rapid succession
120  * can hang the bus. I'm inclined to blame this on crummy design/construction
121  * on the part of RealTek. Memory mapped mode does appear to work on
122  * uniprocessor systems though.
123  */
124 #ifndef dreamcast		/* XXX */
125 #define RTK_USEIOSPACE
126 #endif
127 
128 #include <dev/ic/rtl81x9reg.h>
129 #include <dev/ic/rtl81x9var.h>
130 
131 struct rtk_pci_softc {
132 	struct rtk_softc sc_rtk;	/* real rtk softc */
133 
134 	/* PCI-specific goo.*/
135 	void *sc_ih;
136 	pci_chipset_tag_t sc_pc; 	/* PCI chipset */
137 	pcitag_t sc_pcitag;		/* PCI tag */
138 };
139 
140 static const struct rtk_type rtk_pci_devs[] = {
141 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8129,
142 		"RealTek 8129 10/100BaseTX",
143 		RTK_8129 },
144 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
145 		"RealTek 8139 10/100BaseTX",
146 		RTK_8139 },
147 	{ PCI_VENDOR_ACCTON, PCI_PRODUCT_ACCTON_MPX5030,
148 		"Accton MPX 5030/5038 10/100BaseTX",
149 		RTK_8139 },
150 	{ PCI_VENDOR_DELTA, PCI_PRODUCT_DELTA_8139,
151 		"Delta Electronics 8139 10/100BaseTX",
152 		RTK_8139 },
153 	{ PCI_VENDOR_ADDTRON, PCI_PRODUCT_ADDTRON_8139,
154 		"Addtron Technology 8139 10/100BaseTX",
155 		RTK_8139 },
156 	{ PCI_VENDOR_SEGA, PCI_PRODUCT_SEGA_BROADBAND,
157 		"SEGA Broadband Adapter",
158 		RTK_8139 },
159 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE530TXPLUS,
160 		"D-Link Systems DFE 530TX+",
161 		RTK_8139 },
162 	{ 0, 0, NULL, 0 }
163 };
164 
165 const struct rtk_type *rtk_pci_lookup __P((const struct pci_attach_args *));
166 
167 int	rtk_pci_match __P((struct device *, struct cfdata *, void *));
168 void	rtk_pci_attach __P((struct device *, struct device *, void *));
169 
170 struct cfattach rtk_pci_ca = {
171 	sizeof(struct rtk_pci_softc), rtk_pci_match, rtk_pci_attach,
172 };
173 
174 const struct rtk_type *
175 rtk_pci_lookup(pa)
176 	const struct pci_attach_args *pa;
177 {
178 	const struct rtk_type *t;
179 
180 	for (t = rtk_pci_devs; t->rtk_name != NULL; t++){
181 		if (PCI_VENDOR(pa->pa_id) == t->rtk_vid &&
182 		    PCI_PRODUCT(pa->pa_id) == t->rtk_did) {
183 			return (t);
184 		}
185 	}
186 	return (NULL);
187 }
188 
189 int
190 rtk_pci_match(parent, match, aux)
191 	struct device *parent;
192 	struct cfdata *match;
193 	void *aux;
194 {
195 	struct pci_attach_args *pa = aux;
196 
197 	if (rtk_pci_lookup(pa) != NULL)
198 		return (1);
199 
200 	return (0);
201 }
202 
203 /*
204  * Attach the interface. Allocate softc structures, do ifmedia
205  * setup and ethernet/BPF attach.
206  */
207 void
208 rtk_pci_attach(parent, self, aux)
209 	struct device *parent, *self;
210 	void *aux;
211 {
212 	struct rtk_pci_softc *psc = (struct rtk_pci_softc *)self;
213 	struct rtk_softc *sc = &psc->sc_rtk;
214 	pcireg_t command;
215 	struct pci_attach_args *pa = aux;
216 	pci_chipset_tag_t pc = pa->pa_pc;
217 	pci_intr_handle_t ih;
218 	const char *intrstr = NULL;
219 	const struct rtk_type *t;
220 	int pmreg;
221 
222 	psc->sc_pc = pa->pa_pc;
223 	psc->sc_pcitag = pa->pa_tag;
224 
225 	t = rtk_pci_lookup(pa);
226 	if (t == NULL) {
227 		printf("\n");
228 		panic("rtk_pci_attach: impossible");
229 	}
230 	printf(": %s\n", t->rtk_name);
231 
232 	/*
233 	 * Handle power management nonsense.
234 	 */
235 
236 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
237 		command = pci_conf_read(pc, pa->pa_tag, pmreg + 4);
238 		if (command & RTK_PSTATE_MASK) {
239 			pcireg_t iobase, membase, irq;
240 
241 			/* Save important PCI config data. */
242 			iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
243 			membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
244 			irq = pci_conf_read(pc, pa->pa_tag,
245 					    PCI_PRODUCT_DELTA_8139);
246 
247 			/* Reset the power state. */
248 			printf("%s: chip is is in D%d power mode "
249 			"-- setting to D0\n", sc->sc_dev.dv_xname,
250 			       command & RTK_PSTATE_MASK);
251 			command &= 0xFFFFFFFC;
252 			pci_conf_write(pc, pa->pa_tag, pmreg + 4, command);
253 
254 			/* Restore PCI config data. */
255 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
256 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
257 			pci_conf_write(pc, pa->pa_tag,
258 				       PCI_PRODUCT_DELTA_8139, irq);
259 		}
260 	}
261 
262 	/*
263 	 * Map control/status registers.
264 	 */
265 #ifdef RTK_USEIOSPACE
266 	if (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
267 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, NULL)) {
268 		printf("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
269 		return;
270 	}
271 #else
272 	if (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
273 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, NULL)) {
274 		printf("%s: can't map mem space\n", sc->sc_dev.dv_xname);
275 		return;
276 	}
277 #endif
278 
279 	/* Allocate interrupt */
280 	if (pci_intr_map(pa, &ih)) {
281 		printf("%s: couldn't map interrupt\n", sc->sc_dev.dv_xname);
282 		return;
283 	}
284 	intrstr = pci_intr_string(pc, ih);
285 	psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, rtk_intr, sc);
286 	if (psc->sc_ih == NULL) {
287 		printf("%s: couldn't establish interrupt",
288 		    sc->sc_dev.dv_xname);
289 		if (intrstr != NULL)
290 			printf(" at %s", intrstr);
291 		printf("\n");
292 		return;
293 	}
294 
295 	sc->rtk_type = t->rtk_type;
296 
297 	printf("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
298 
299 	sc->sc_dmat = pa->pa_dmat;
300 
301 	rtk_attach(sc);
302 }
303