1 /* $NetBSD: if_rtk_pci.c,v 1.48 2022/09/24 18:12:42 thorpej 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.48 2022/09/24 18:12:42 thorpej 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/kernel.h>
59 #include <sys/socket.h>
60
61 #include <net/if.h>
62 #include <net/if_arp.h>
63 #include <net/if_ether.h>
64 #include <net/if_dl.h>
65 #include <net/if_media.h>
66
67 #include <sys/bus.h>
68
69 #include <dev/pci/pcireg.h>
70 #include <dev/pci/pcivar.h>
71 #include <dev/pci/pcidevs.h>
72
73 #include <dev/mii/mii.h>
74 #include <dev/mii/miivar.h>
75
76 #include <dev/ic/rtl81x9reg.h>
77 #include <dev/ic/rtl81x9var.h>
78
79 struct rtk_pci_softc {
80 struct rtk_softc sc_rtk; /* real rtk softc */
81
82 /* PCI-specific goo.*/
83 void *sc_ih;
84 pci_chipset_tag_t sc_pc;
85 };
86
87 static const struct rtk_type rtk_pci_devs[] = {
88 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8129,
89 RTK_8129, "Realtek 8129 10/100BaseTX" },
90 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
91 RTK_8139, "Realtek 8139 10/100BaseTX" },
92 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8138,
93 RTK_8139, "Realtek 8138 10/100BaseTX" },
94 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139D,
95 RTK_8139, "Realtek 8139D 10/100BaseTX" },
96 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8100,
97 RTK_8139, "Realtek 8100 10/100BaseTX" },
98 { PCI_VENDOR_ACCTON, PCI_PRODUCT_ACCTON_MPX5030,
99 RTK_8139, "Accton MPX 5030/5038 10/100BaseTX" },
100 { PCI_VENDOR_DELTA, PCI_PRODUCT_DELTA_8139,
101 RTK_8139, "Delta Electronics 8139 10/100BaseTX" },
102 { PCI_VENDOR_ADDTRON, PCI_PRODUCT_ADDTRON_8139,
103 RTK_8139, "Addtron Technology 8139 10/100BaseTX" },
104 { PCI_VENDOR_SEGA, PCI_PRODUCT_SEGA_BROADBAND,
105 RTK_8139, "SEGA Broadband Adapter" },
106 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE520TX,
107 RTK_8139, "D-Link Systems DFE 520TX" },
108 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE530TXPLUS,
109 RTK_8139, "D-Link Systems DFE 530TX+" },
110 { PCI_VENDOR_NORTEL, PCI_PRODUCT_NORTEL_BAYSTACK_21,
111 RTK_8139, "Baystack 21 (MPX EN5038) 10/100BaseTX" },
112 };
113
114 static int rtk_pci_match(device_t, cfdata_t, void *);
115 static void rtk_pci_attach(device_t, device_t, void *);
116 static int rtk_pci_detach(device_t, int);
117
118 CFATTACH_DECL_NEW(rtk_pci, sizeof(struct rtk_pci_softc),
119 rtk_pci_match, rtk_pci_attach, rtk_pci_detach, NULL);
120
121 static const struct rtk_type *
rtk_pci_lookup(const struct pci_attach_args * pa)122 rtk_pci_lookup(const struct pci_attach_args *pa)
123 {
124 int i;
125
126 for (i = 0; i < __arraycount(rtk_pci_devs); i++) {
127 if (PCI_VENDOR(pa->pa_id) != rtk_pci_devs[i].rtk_vid)
128 continue;
129 if (PCI_PRODUCT(pa->pa_id) == rtk_pci_devs[i].rtk_did)
130 return &rtk_pci_devs[i];
131 }
132
133 return NULL;
134 }
135
136 static int
rtk_pci_match(device_t parent,cfdata_t cf,void * aux)137 rtk_pci_match(device_t parent, cfdata_t cf, void *aux)
138 {
139 struct pci_attach_args *pa = aux;
140
141 if (rtk_pci_lookup(pa) != NULL)
142 return 1;
143
144 return 0;
145 }
146
147 /*
148 * Attach the interface. Allocate softc structures, do ifmedia
149 * setup and ethernet/BPF attach.
150 */
151 static void
rtk_pci_attach(device_t parent,device_t self,void * aux)152 rtk_pci_attach(device_t parent, device_t self, void *aux)
153 {
154 struct rtk_pci_softc *psc = device_private(self);
155 struct rtk_softc *sc = &psc->sc_rtk;
156 struct pci_attach_args *pa = aux;
157 pci_chipset_tag_t pc = pa->pa_pc;
158 pci_intr_handle_t ih;
159 bus_space_tag_t iot, memt;
160 bus_space_handle_t ioh, memh;
161 bus_size_t iosize, memsize;
162 pcireg_t csr;
163 const char *intrstr = NULL;
164 const struct rtk_type *t;
165 bool ioh_valid, memh_valid;
166 char intrbuf[PCI_INTRSTR_LEN];
167
168 sc->sc_dev = self;
169 psc->sc_pc = pa->pa_pc;
170
171 t = rtk_pci_lookup(pa);
172 KASSERT(t != NULL);
173
174 pci_aprint_devinfo_fancy(pa, NULL, t->rtk_name, 1);
175
176 /*
177 * Map control/status registers.
178 *
179 * The original FreeBSD's driver has the following comment:
180 *
181 * Default to using PIO access for this driver. On SMP systems,
182 * there appear to be problems with memory mapped mode:
183 * it looks like doing too many memory mapped access
184 * back to back in rapid succession can hang the bus.
185 * I'm inclined to blame this on crummy design/construction
186 * on the part of Realtek. Memory mapped mode does appear to
187 * work on uniprocessor systems though.
188 *
189 * On NetBSD, some ports don't support PCI I/O space properly,
190 * so we try to map both and prefer I/O space to mem space.
191 */
192 ioh_valid = (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
193 &iot, &ioh, NULL, &iosize) == 0);
194 memh_valid = (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
195 &memt, &memh, NULL, &memsize) == 0);
196 if (ioh_valid) {
197 sc->rtk_btag = iot;
198 sc->rtk_bhandle = ioh;
199 sc->rtk_bsize = iosize;
200 if (memh_valid)
201 bus_space_unmap(memt, memh, memsize);
202 } else if (memh_valid) {
203 sc->rtk_btag = memt;
204 sc->rtk_bhandle = memh;
205 sc->rtk_bsize = memsize;
206 } else {
207 aprint_error_dev(self, "can't map registers\n");
208 return;
209 }
210
211 /* Allocate interrupt */
212 if (pci_intr_map(pa, &ih)) {
213 aprint_error_dev(self, "couldn't map interrupt\n");
214 return;
215 }
216 intrstr = pci_intr_string(pc, ih, intrbuf, sizeof(intrbuf));
217 psc->sc_ih = pci_intr_establish_xname(pc, ih, IPL_NET, rtk_intr, sc,
218 device_xname(self));
219 if (psc->sc_ih == NULL) {
220 aprint_error_dev(self, "couldn't establish interrupt");
221 if (intrstr != NULL)
222 aprint_error(" at %s", intrstr);
223 aprint_error("\n");
224 return;
225 }
226
227 if (t->rtk_basetype == RTK_8129)
228 sc->sc_quirk |= RTKQ_8129;
229
230 aprint_normal_dev(self, "interrupting at %s\n", intrstr);
231
232 csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
233 csr |= PCI_COMMAND_MASTER_ENABLE;
234 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, csr);
235
236 sc->sc_dmat = pa->pa_dmat;
237 sc->sc_flags |= RTK_ENABLED;
238
239 if (pmf_device_register(self, NULL, NULL))
240 pmf_class_network_register(self, &sc->ethercom.ec_if);
241 else
242 aprint_error_dev(self, "couldn't establish power handler\n");
243
244 rtk_attach(sc);
245 }
246
247 static int
rtk_pci_detach(device_t self,int flags)248 rtk_pci_detach(device_t self, int flags)
249 {
250 struct rtk_pci_softc *psc = device_private(self);
251 struct rtk_softc *sc = &psc->sc_rtk;
252 int rv;
253
254 /* rtk_stop() */
255 sc->ethercom.ec_if.if_stop(&sc->ethercom.ec_if, 0);
256
257 rv = rtk_detach(sc);
258 if (rv)
259 return rv;
260
261 if (psc->sc_ih != NULL) {
262 pci_intr_disestablish(psc->sc_pc, psc->sc_ih);
263 psc->sc_ih = NULL;
264 }
265
266 if (sc->rtk_bsize != 0) {
267 bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle, sc->rtk_bsize);
268 sc->rtk_bsize = 0;
269 }
270
271 return 0;
272 }
273