1 /* $NetBSD: if_re_pci.c,v 1.53 2024/02/28 18:55:11 jakllsch 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 <sys/cdefs.h>
49 __KERNEL_RCSID(0, "$NetBSD: if_re_pci.c,v 1.53 2024/02/28 18:55:11 jakllsch Exp $");
50
51 #include <sys/types.h>
52
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/device.h>
56
57 #include <net/if.h>
58 #include <net/if_ether.h>
59 #include <net/if_media.h>
60
61 #include <sys/bus.h>
62
63 #include <dev/mii/mii.h>
64 #include <dev/mii/miivar.h>
65
66 #include <dev/pci/pcireg.h>
67 #include <dev/pci/pcivar.h>
68 #include <dev/pci/pcidevs.h>
69
70 #include <dev/ic/rtl81x9reg.h>
71 #include <dev/ic/rtl81x9var.h>
72 #include <dev/ic/rtl8169var.h>
73
74 struct re_pci_softc {
75 struct rtk_softc sc_rtk;
76
77 void *sc_ih;
78 pci_intr_handle_t *sc_pihp;
79 pci_chipset_tag_t sc_pc;
80 };
81
82 static int re_pci_match(device_t, cfdata_t, void *);
83 static void re_pci_attach(device_t, device_t, void *);
84 static int re_pci_detach(device_t, int);
85
86 CFATTACH_DECL_NEW(re_pci, sizeof(struct re_pci_softc),
87 re_pci_match, re_pci_attach, re_pci_detach, NULL);
88
89 /*
90 * Various supported device vendors/types and their names.
91 */
92 static const struct rtk_type re_devs[] = {
93 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
94 RTK_8139CPLUS,
95 "RealTek 8139C+ 10/100BaseTX" },
96 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8101E,
97 RTK_8101E,
98 "RealTek 8100E/8101E/8102E/8102EL PCIe 10/100BaseTX" },
99 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8168,
100 RTK_8168,
101 "RealTek 8168/8111 PCIe Gigabit Ethernet" },
102 { PCI_VENDOR_NCUBE, PCI_PRODUCT_NCUBE_TG3648,
103 RTK_8168,
104 "TP-Link TG-3468 v2 (RTL8168) Gigabit Ethernet" },
105 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
106 RTK_8169,
107 "RealTek 8169/8110 Gigabit Ethernet" },
108 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169SC,
109 RTK_8169,
110 "RealTek 8169SC/8110SC Single-chip Gigabit Ethernet" },
111 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_E2600,
112 RTK_8169,
113 "Killer E2600 Gigabit Ethernet" },
114 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_LAPCIGT,
115 RTK_8169,
116 "Corega CG-LAPCIGT Gigabit Ethernet" },
117 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T,
118 RTK_8169,
119 "D-Link DGE-528T Gigabit Ethernet" },
120 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE530T_C1,
121 RTK_8169,
122 "D-Link DGE-530T C1 Gigabit Ethernet" },
123 { PCI_VENDOR_USR2, PCI_PRODUCT_USR2_USR997902,
124 RTK_8169,
125 "US Robotics (3Com) USR997902 Gigabit Ethernet" },
126 { PCI_VENDOR_LINKSYS, PCI_PRODUCT_LINKSYS_EG1032,
127 RTK_8169,
128 "Linksys EG1032 rev. 3 Gigabit Ethernet" },
129 };
130
131 static const struct rtk_type *
re_pci_lookup(const struct pci_attach_args * pa)132 re_pci_lookup(const struct pci_attach_args * pa)
133 {
134 int i;
135
136 for (i = 0; i < __arraycount(re_devs); i++) {
137 if (PCI_VENDOR(pa->pa_id) != re_devs[i].rtk_vid)
138 continue;
139 if (PCI_PRODUCT(pa->pa_id) == re_devs[i].rtk_did)
140 return &re_devs[i];
141 }
142
143 return NULL;
144 }
145
146 #define RE_LINKSYS_EG1032_SUBID 0x00241737
147
148 /*
149 * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
150 * IDs against our list and return a device name if we find a match.
151 */
152 static int
re_pci_match(device_t parent,cfdata_t cf,void * aux)153 re_pci_match(device_t parent, cfdata_t cf, void *aux)
154 {
155 struct pci_attach_args *pa = aux;
156 pcireg_t subid;
157
158 subid = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG);
159
160 /* special-case Linksys EG1032, since rev 2 uses sk(4) */
161 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_LINKSYS &&
162 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_LINKSYS_EG1032) {
163 if (subid != RE_LINKSYS_EG1032_SUBID)
164 return 0;
165 }
166
167 /* Don't match 8139 other than C-PLUS */
168 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_REALTEK &&
169 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_REALTEK_RT8139) {
170 if (PCI_REVISION(pa->pa_class) != 0x20)
171 return 0;
172 }
173
174 if (re_pci_lookup(pa) != NULL)
175 return 2; /* defeat rtk(4) */
176
177 return 0;
178 }
179
180 static void
re_pci_attach(device_t parent,device_t self,void * aux)181 re_pci_attach(device_t parent, device_t self, void *aux)
182 {
183 struct re_pci_softc *psc = device_private(self);
184 struct rtk_softc *sc = &psc->sc_rtk;
185 struct pci_attach_args *pa = aux;
186 pci_chipset_tag_t pc = pa->pa_pc;
187 const char *intrstr = NULL;
188 const struct rtk_type *t;
189 uint32_t hwrev;
190 pcireg_t command, memtype;
191 bool ioh_valid, memh_valid;
192 bus_space_tag_t iot, memt;
193 bus_space_handle_t ioh, memh;
194 bus_size_t iosize, memsize;
195 char intrbuf[PCI_INTRSTR_LEN];
196 bool prefer_io = false;
197
198 sc->sc_dev = self;
199 psc->sc_pc = pa->pa_pc;
200
201 command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
202 command |= PCI_COMMAND_MASTER_ENABLE;
203 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
204
205 /*
206 * Map control/status registers.
207 */
208 ioh_valid = (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
209 &iot, &ioh, NULL, &iosize) == 0);
210 memtype = pci_mapreg_type(pa->pa_pc, pa->pa_tag, RTK_PCI_LOMEM);
211 switch (memtype) {
212 case PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT:
213 case PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_64BIT:
214 memh_valid =
215 (pci_mapreg_map(pa, RTK_PCI_LOMEM,
216 memtype, 0, &memt, &memh, NULL, &memsize) == 0) ||
217 (pci_mapreg_map(pa, RTK_PCI_LOMEM + 4,
218 PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_64BIT,
219 0, &memt, &memh, NULL, &memsize) == 0);
220 break;
221 default:
222 memh_valid = 0;
223 break;
224 }
225
226 switch (PCI_VENDOR(pa->pa_id)) {
227 case PCI_VENDOR_REALTEK:
228 switch (PCI_PRODUCT(pa->pa_id)) {
229 case PCI_PRODUCT_REALTEK_RT8169SC:
230 prefer_io = true;
231 break;
232 }
233 break;
234 }
235 if (!memh_valid)
236 prefer_io = true;
237
238 if (ioh_valid && prefer_io) {
239 sc->rtk_btag = iot;
240 sc->rtk_bhandle = ioh;
241 sc->rtk_bsize = iosize;
242 if (memh_valid)
243 bus_space_unmap(memt, memh, memsize);
244
245 command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
246 command |= PCI_COMMAND_IO_ENABLE;
247 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
248 } else if (memh_valid) {
249 sc->rtk_btag = memt;
250 sc->rtk_bhandle = memh;
251 sc->rtk_bsize = memsize;
252 if (ioh_valid)
253 bus_space_unmap(iot, ioh, iosize);
254
255 command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
256 command |= PCI_COMMAND_MEM_ENABLE;
257 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
258 } else {
259 aprint_error(": can't map registers\n");
260 return;
261 }
262
263 t = re_pci_lookup(pa);
264 KASSERT(t != NULL);
265
266 pci_aprint_devinfo_fancy(pa, NULL, t->rtk_name, 1);
267
268 if (t->rtk_basetype == RTK_8139CPLUS)
269 sc->sc_quirk |= RTKQ_8139CPLUS;
270
271 if (t->rtk_basetype == RTK_8168 ||
272 t->rtk_basetype == RTK_8101E)
273 sc->sc_quirk |= RTKQ_PCIE;
274
275 if (t->rtk_basetype == RTK_8168)
276 sc->sc_quirk |= RTKQ_IM_HW;
277
278 if (pci_dma64_available(pa) && (sc->sc_quirk & RTKQ_PCIE))
279 sc->sc_dmat = pa->pa_dmat64;
280 else
281 sc->sc_dmat = pa->pa_dmat;
282
283 /*
284 * No power/enable/disable machinery for PCI attach;
285 * mark the card enabled now.
286 */
287 sc->sc_flags |= RTK_ENABLED;
288
289 /* Hook interrupt last to avoid having to lock softc */
290 /* Allocate interrupt */
291 if (pci_intr_alloc(pa, &psc->sc_pihp, NULL, 0)) {
292 aprint_error_dev(self, "couldn't map interrupt\n");
293 return;
294 }
295 intrstr = pci_intr_string(pc, psc->sc_pihp[0], intrbuf,
296 sizeof(intrbuf));
297 psc->sc_ih = pci_intr_establish_xname(pc, psc->sc_pihp[0], IPL_NET,
298 re_intr, sc, device_xname(sc->sc_dev));
299 if (psc->sc_ih == NULL) {
300 aprint_error_dev(self, "couldn't establish interrupt");
301 if (intrstr != NULL)
302 aprint_error(" at %s", intrstr);
303 aprint_error("\n");
304 return;
305 }
306 aprint_normal_dev(self, "interrupting at %s\n", intrstr);
307
308 re_attach(sc);
309
310 hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
311
312 /*
313 * Perform hardware diagnostic on the original RTL8169.
314 * Some 32-bit cards were incorrectly wired and would
315 * malfunction if plugged into a 64-bit slot.
316 */
317 if (hwrev == RTK_HWREV_8169) {
318 if (re_diag(sc)) {
319 re_pci_detach(self, 0);
320 aprint_error_dev(self, "disabled\n");
321 }
322 }
323 }
324
325 static int
re_pci_detach(device_t self,int flags)326 re_pci_detach(device_t self, int flags)
327 {
328 struct re_pci_softc *psc = device_private(self);
329 struct rtk_softc *sc = &psc->sc_rtk;
330 int rv;
331
332 if ((sc->sc_flags & RTK_ATTACHED) != 0)
333 /* re_stop() */
334 sc->ethercom.ec_if.if_stop(&sc->ethercom.ec_if, 0);
335
336 rv = re_detach(sc);
337 if (rv)
338 return rv;
339
340 if (psc->sc_ih != NULL) {
341 pci_intr_disestablish(psc->sc_pc, psc->sc_ih);
342 psc->sc_ih = NULL;
343 }
344
345 if (psc->sc_pihp != NULL) {
346 pci_intr_release(psc->sc_pc, psc->sc_pihp, 1);
347 psc->sc_pihp = NULL;
348 }
349
350 if (sc->rtk_bsize != 0) {
351 bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle, sc->rtk_bsize);
352 sc->rtk_bsize = 0;
353 }
354
355 return 0;
356 }
357