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