xref: /netbsd-src/sys/dev/pci/if_rtk_pci.c (revision d48f14661dda8638fee055ba15d35bdfb29b9fa8)
1 /*	$NetBSD: if_rtk_pci.c,v 1.24 2006/03/09 22:17:49 he 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 #include <sys/cdefs.h>
50 __KERNEL_RCSID(0, "$NetBSD: if_rtk_pci.c,v 1.24 2006/03/09 22:17:49 he Exp $");
51 
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/callout.h>
55 #include <sys/device.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 
62 #include <net/if.h>
63 #include <net/if_arp.h>
64 #include <net/if_ether.h>
65 #include <net/if_dl.h>
66 #include <net/if_media.h>
67 
68 #include <machine/bus.h>
69 
70 #include <dev/pci/pcireg.h>
71 #include <dev/pci/pcivar.h>
72 #include <dev/pci/pcidevs.h>
73 
74 #include <dev/mii/mii.h>
75 #include <dev/mii/miivar.h>
76 
77 /*
78  * Default to using PIO access for this driver. On SMP systems,
79  * there appear to be problems with memory mapped mode: it looks like
80  * doing too many memory mapped access back to back in rapid succession
81  * can hang the bus. I'm inclined to blame this on crummy design/construction
82  * on the part of Realtek. Memory mapped mode does appear to work on
83  * uniprocessor systems though.
84  */
85 #ifndef dreamcast		/* XXX */
86 #define RTK_USEIOSPACE
87 #endif
88 
89 #include <dev/ic/rtl81x9reg.h>
90 #include <dev/ic/rtl81x9var.h>
91 
92 struct rtk_pci_softc {
93 	struct rtk_softc sc_rtk;	/* real rtk softc */
94 
95 	/* PCI-specific goo.*/
96 	void *sc_ih;
97 	pci_chipset_tag_t sc_pc; 	/* PCI chipset */
98 	pcitag_t sc_pcitag;		/* PCI tag */
99 
100 	void *sc_powerhook;		/* powerhook ctxt. */
101 	struct pci_conf_state sc_pciconf;
102 };
103 
104 static const struct rtk_type rtk_pci_devs[] = {
105 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8129,
106 		RTK_8129, "Realtek 8129 10/100BaseTX" },
107 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
108 		RTK_8139, "Realtek 8139 10/100BaseTX" },
109 	{ PCI_VENDOR_ACCTON, PCI_PRODUCT_ACCTON_MPX5030,
110 		RTK_8139, "Accton MPX 5030/5038 10/100BaseTX" },
111 	{ PCI_VENDOR_DELTA, PCI_PRODUCT_DELTA_8139,
112 		RTK_8139, "Delta Electronics 8139 10/100BaseTX" },
113 	{ PCI_VENDOR_ADDTRON, PCI_PRODUCT_ADDTRON_8139,
114 		RTK_8139, "Addtron Technology 8139 10/100BaseTX" },
115 	{ PCI_VENDOR_SEGA, PCI_PRODUCT_SEGA_BROADBAND,
116 		RTK_8139, "SEGA Broadband Adapter" },
117 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE530TXPLUS,
118 		RTK_8139, "D-Link Systems DFE 530TX+" },
119 	{ PCI_VENDOR_NORTEL, PCI_PRODUCT_NORTEL_BAYSTACK_21,
120 		RTK_8139, "Baystack 21 (MPX EN5038) 10/100BaseTX" },
121 	{ 0, 0, 0, NULL }
122 };
123 
124 static int	rtk_pci_match(struct device *, struct cfdata *, void *);
125 static void	rtk_pci_attach(struct device *, struct device *, void *);
126 static void	rtk_pci_powerhook(int, void *);
127 
128 CFATTACH_DECL(rtk_pci, sizeof(struct rtk_pci_softc),
129     rtk_pci_match, rtk_pci_attach, NULL, NULL);
130 
131 static const struct rtk_type *
132 rtk_pci_lookup(const struct pci_attach_args *pa)
133 {
134 	const struct rtk_type *t;
135 
136 	for (t = rtk_pci_devs; t->rtk_name != NULL; t++) {
137 		if (PCI_VENDOR(pa->pa_id) == t->rtk_vid &&
138 		    PCI_PRODUCT(pa->pa_id) == t->rtk_did) {
139 			return (t);
140 		}
141 	}
142 	return (NULL);
143 }
144 
145 static int
146 rtk_pci_match(struct device *parent, struct cfdata *match, void *aux)
147 {
148 	struct pci_attach_args *pa = aux;
149 
150 	if (rtk_pci_lookup(pa) != NULL)
151 		return (1);
152 
153 	return (0);
154 }
155 
156 /*
157  * Attach the interface. Allocate softc structures, do ifmedia
158  * setup and ethernet/BPF attach.
159  */
160 static void
161 rtk_pci_attach(struct device *parent, struct device *self, void *aux)
162 {
163 	struct rtk_pci_softc *psc = (struct rtk_pci_softc *)self;
164 	struct rtk_softc *sc = &psc->sc_rtk;
165 	pcireg_t command;
166 	struct pci_attach_args *pa = aux;
167 	pci_chipset_tag_t pc = pa->pa_pc;
168 	pci_intr_handle_t ih;
169 	const char *intrstr = NULL;
170 	const struct rtk_type *t;
171 	int pmreg;
172 
173 	psc->sc_pc = pa->pa_pc;
174 	psc->sc_pcitag = pa->pa_tag;
175 
176 	t = rtk_pci_lookup(pa);
177 	if (t == NULL) {
178 		printf("\n");
179 		panic("rtk_pci_attach: impossible");
180 	}
181 	printf(": %s\n", t->rtk_name);
182 
183 	/*
184 	 * Handle power management nonsense.
185 	 */
186 
187 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
188 		command = pci_conf_read(pc, pa->pa_tag, pmreg + 4);
189 		if (command & RTK_PSTATE_MASK) {
190 			pcireg_t iobase, membase, irq;
191 
192 			/* Save important PCI config data. */
193 			iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
194 			membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
195 			irq = pci_conf_read(pc, pa->pa_tag, PCI_INTERRUPT_REG);
196 
197 			/* Reset the power state. */
198 			printf("%s: chip is in D%d power mode "
199 			    "-- setting to D0\n", sc->sc_dev.dv_xname,
200 			    command & RTK_PSTATE_MASK);
201 			command &= 0xFFFFFFFC;
202 			pci_conf_write(pc, pa->pa_tag, pmreg + 4, command);
203 
204 			/* Restore PCI config data. */
205 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
206 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
207 			pci_conf_write(pc, pa->pa_tag, PCI_INTERRUPT_REG, irq);
208 		}
209 	}
210 
211 	/*
212 	 * Map control/status registers.
213 	 */
214 #ifdef RTK_USEIOSPACE
215 	if (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
216 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, NULL)) {
217 		printf("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
218 		return;
219 	}
220 #else
221 	if (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
222 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, NULL)) {
223 		printf("%s: can't map mem space\n", sc->sc_dev.dv_xname);
224 		return;
225 	}
226 #endif
227 
228 	/* Allocate interrupt */
229 	if (pci_intr_map(pa, &ih)) {
230 		printf("%s: couldn't map interrupt\n", sc->sc_dev.dv_xname);
231 		return;
232 	}
233 	intrstr = pci_intr_string(pc, ih);
234 	psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, rtk_intr, sc);
235 	if (psc->sc_ih == NULL) {
236 		printf("%s: couldn't establish interrupt",
237 		    sc->sc_dev.dv_xname);
238 		if (intrstr != NULL)
239 			printf(" at %s", intrstr);
240 		printf("\n");
241 		return;
242 	}
243 
244 	sc->rtk_type = t->rtk_basetype;
245 
246 	printf("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
247 
248 	sc->sc_dmat = pa->pa_dmat;
249 	sc->sc_flags |= RTK_ENABLED;
250 
251 	psc->sc_powerhook = powerhook_establish(rtk_pci_powerhook, psc);
252 	if (psc->sc_powerhook == NULL)
253 		printf("%s: WARNING: unable to establish pci power hook\n",
254 			sc->sc_dev.dv_xname);
255 
256 	rtk_attach(sc);
257 }
258 
259 static void
260 rtk_pci_powerhook(int why, void *arg)
261 {
262 	struct rtk_pci_softc *sc = (struct rtk_pci_softc *)arg;
263 	int s;
264 
265 	s = splnet();
266 	switch (why) {
267 	case PWR_SUSPEND:
268 	case PWR_STANDBY:
269 		pci_conf_capture(sc->sc_pc, sc->sc_pcitag, &sc->sc_pciconf);
270 		break;
271 	case PWR_RESUME:
272 		pci_conf_restore(sc->sc_pc, sc->sc_pcitag, &sc->sc_pciconf);
273 		break;
274 	case PWR_SOFTSUSPEND:
275 	case PWR_SOFTSTANDBY:
276 	case PWR_SOFTRESUME:
277 		break;
278 	}
279 	splx(s);
280 }
281