if_rtk_pci.c revision 1.22.4.3 1 /* $NetBSD: if_rtk_pci.c,v 1.22.4.3 2007/10/04 18:50:24 bouyer Exp $ */
2
3 /*
4 * Copyright (c) 1997, 1998
5 * Bill Paul <wpaul (at) 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 (at) 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.22.4.3 2007/10/04 18:50:24 bouyer 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, void *aux)
135 {
136 struct pci_attach_args *pa = aux;
137
138 if (rtk_pci_lookup(pa) != NULL)
139 return (1);
140
141 return (0);
142 }
143
144 /*
145 * Attach the interface. Allocate softc structures, do ifmedia
146 * setup and ethernet/BPF attach.
147 */
148 static void
149 rtk_pci_attach(struct device *parent, struct device *self, void *aux)
150 {
151 struct rtk_pci_softc *psc = (struct rtk_pci_softc *)self;
152 struct rtk_softc *sc = &psc->sc_rtk;
153 pcireg_t command;
154 struct pci_attach_args *pa = aux;
155 pci_chipset_tag_t pc = pa->pa_pc;
156 pci_intr_handle_t ih;
157 bus_space_tag_t iot, memt;
158 bus_space_handle_t ioh, memh;
159 const char *intrstr = NULL;
160 const struct rtk_type *t;
161 int pmreg;
162 int ioh_valid, memh_valid;
163
164 psc->sc_pc = pa->pa_pc;
165 psc->sc_pcitag = pa->pa_tag;
166
167 t = rtk_pci_lookup(pa);
168 if (t == NULL) {
169 printf("\n");
170 panic("rtk_pci_attach: impossible");
171 }
172 printf(": %s (rev. 0x%02x)\n", t->rtk_name, PCI_REVISION(pa->pa_class));
173
174 /*
175 * Handle power management nonsense.
176 */
177
178 if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
179 command = pci_conf_read(pc, pa->pa_tag, pmreg + PCI_PMCSR);
180 if (command & PCI_PMCSR_STATE_MASK) {
181 pcireg_t iobase, membase, irq;
182
183 /* Save important PCI config data. */
184 iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
185 membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
186 irq = pci_conf_read(pc, pa->pa_tag, PCI_INTERRUPT_REG);
187
188 /* Reset the power state. */
189 printf("%s: chip is in D%d power mode "
190 "-- setting to D0\n", sc->sc_dev.dv_xname,
191 command & PCI_PMCSR_STATE_MASK);
192 command &= ~PCI_PMCSR_STATE_MASK;
193 pci_conf_write(pc, pa->pa_tag,
194 pmreg + PCI_PMCSR, command);
195
196 /* Restore PCI config data. */
197 pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
198 pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
199 pci_conf_write(pc, pa->pa_tag, PCI_INTERRUPT_REG, irq);
200 }
201 }
202
203 /*
204 * Map control/status registers.
205 *
206 * The original FreeBSD's driver has the following comment:
207 *
208 * Default to using PIO access for this driver. On SMP systems,
209 * there appear to be problems with memory mapped mode:
210 * it looks like doing too many memory mapped access
211 * back to back in rapid succession can hang the bus.
212 * I'm inclined to blame this on crummy design/construction
213 * on the part of Realtek. Memory mapped mode does appear to
214 * work on uniprocessor systems though.
215 *
216 * On NetBSD, some port doesn't support PCI I/O space properly,
217 * so we try to map both and prefer I/O space to mem space.
218 */
219 ioh_valid = (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
220 &iot, &ioh, NULL, NULL) == 0);
221 memh_valid = (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
222 &memt, &memh, NULL, NULL) == 0);
223 if (ioh_valid) {
224 sc->rtk_btag = iot;
225 sc->rtk_bhandle = ioh;
226 } else if (memh_valid) {
227 sc->rtk_btag = memt;
228 sc->rtk_bhandle = memh;
229 } else {
230 aprint_error("%s: can't map registers\n", sc->sc_dev.dv_xname);
231 return;
232 }
233
234 /* Allocate interrupt */
235 if (pci_intr_map(pa, &ih)) {
236 printf("%s: couldn't map interrupt\n", sc->sc_dev.dv_xname);
237 return;
238 }
239 intrstr = pci_intr_string(pc, ih);
240 psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, rtk_intr, sc);
241 if (psc->sc_ih == NULL) {
242 printf("%s: couldn't establish interrupt",
243 sc->sc_dev.dv_xname);
244 if (intrstr != NULL)
245 printf(" at %s", intrstr);
246 printf("\n");
247 return;
248 }
249
250 if (t->rtk_basetype == RTK_8129)
251 sc->sc_quirk |= RTKQ_8129;
252
253 printf("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
254
255 sc->sc_dmat = pa->pa_dmat;
256 sc->sc_flags |= RTK_ENABLED;
257
258 psc->sc_powerhook = powerhook_establish(rtk_pci_powerhook, psc);
259 if (psc->sc_powerhook == NULL)
260 printf("%s: WARNING: unable to establish pci power hook\n",
261 sc->sc_dev.dv_xname);
262
263 rtk_attach(sc);
264 }
265
266 static void
267 rtk_pci_powerhook(int why, void *arg)
268 {
269 struct rtk_pci_softc *sc = (struct rtk_pci_softc *)arg;
270 int s;
271
272 s = splnet();
273 switch (why) {
274 case PWR_SUSPEND:
275 case PWR_STANDBY:
276 pci_conf_capture(sc->sc_pc, sc->sc_pcitag, &sc->sc_pciconf);
277 break;
278 case PWR_RESUME:
279 pci_conf_restore(sc->sc_pc, sc->sc_pcitag, &sc->sc_pciconf);
280 break;
281 case PWR_SOFTSUSPEND:
282 case PWR_SOFTSTANDBY:
283 case PWR_SOFTRESUME:
284 break;
285 }
286 splx(s);
287 }
288