Home | History | Annotate | Line # | Download | only in cardbus
if_rtk_cardbus.c revision 1.3
      1 /*	$NetBSD: if_rtk_cardbus.c,v 1.3 2000/05/19 13:42:30 tsutsui Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2000 Masanori Kanaoka
      5  * 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. The name of the author may not be used to endorse or promote products
     16  *    derived from this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 /*
     31  * if_rtk_cardbus.c:
     32  *	Cardbus specific routines for RealTek 8139 ethernet adapter.
     33  *	Tested for
     34  *		- elecom-Laneed	LD-10/100CBA (Accton MPX5030)
     35  *		- MELCO		LPC3-TX-CB   (RealTek 8139)
     36  */
     37 
     38 #include "opt_inet.h"
     39 #include "opt_ns.h"
     40 #include "bpfilter.h"
     41 #include "rnd.h"
     42 
     43 #include <sys/param.h>
     44 #include <sys/systm.h>
     45 #include <sys/callout.h>
     46 #include <sys/device.h>
     47 #include <sys/sockio.h>
     48 #include <sys/mbuf.h>
     49 #include <sys/malloc.h>
     50 #include <sys/kernel.h>
     51 #include <sys/socket.h>
     52 
     53 #include <net/if.h>
     54 #include <net/if_arp.h>
     55 #include <net/if_ether.h>
     56 #include <net/if_dl.h>
     57 #include <net/if_media.h>
     58 #ifdef INET
     59 #include <netinet/in.h>
     60 #include <netinet/if_inarp.h>
     61 #endif
     62 #ifdef NS
     63 #include <netns/ns.h>
     64 #include <netns/ns_if.h>
     65 #endif
     66 
     67 #if NBPFILTER > 0
     68 #include <net/bpf.h>
     69 #endif
     70 #if NRND > 0
     71 #include <sys/rnd.h>
     72 #endif
     73 
     74 #include <machine/bus.h>
     75 
     76 #include <dev/pci/pcireg.h>
     77 #include <dev/pci/pcivar.h>
     78 #include <dev/pci/pcidevs.h>
     79 
     80 #include <dev/cardbus/cardbusvar.h>
     81 #include <dev/cardbus/cardbusdevs.h>
     82 
     83 #include <dev/mii/mii.h>
     84 #include <dev/mii/miivar.h>
     85 
     86 /*
     87  * Default to using PIO access for this driver. On SMP systems,
     88  * there appear to be problems with memory mapped mode: it looks like
     89  * doing too many memory mapped access back to back in rapid succession
     90  * can hang the bus. I'm inclined to blame this on crummy design/construction
     91  * on the part of RealTek. Memory mapped mode does appear to work on
     92  * uniprocessor systems though.
     93  */
     94 #define RTK_USEIOSPACE
     95 
     96 #include <dev/ic/rtl81x9reg.h>
     97 #include <dev/ic/rtl81x9var.h>
     98 
     99 /*
    100  * Various supported device vendors/types and their names.
    101  */
    102 static const struct rtk_type rtk_cardbus_devs[] = {
    103 	{ CARDBUS_VENDOR_ACCTON, CARDBUS_PRODUCT_ACCTON_MPX5030,
    104 		"Accton MPX 5030/5038 10/100BaseTX",
    105 		RTK_8139 },
    106 	{ CARDBUS_VENDOR_REALTEK, CARDBUS_PRODUCT_REALTEK_RT8138,
    107 		"RealTek 8138 10/100BaseTX", RTK_8139 },
    108 	{ 0, 0, NULL, 0 }
    109 };
    110 
    111 static int rtk_cardbus_match	__P((struct device *, struct cfdata *, void *));
    112 static void rtk_cardbus_attach	__P((struct device *, struct device *, void *));
    113 static int rtk_cardbus_detach	__P((struct device *, int));
    114 
    115 struct rtk_cardbus_softc {
    116 	struct rtk_softc sc_rtk;	/* real rtk softc */
    117 
    118 	/* CardBus-specific goo. */
    119 	void *sc_ih;
    120 	cardbus_devfunc_t sc_ct;
    121 	cardbustag_t sc_tag;
    122 	int sc_csr;
    123 	int sc_cben;
    124 	int sc_bar_reg;
    125 	pcireg_t sc_bar_val;
    126 	bus_size_t sc_mapsize;
    127 	int sc_intrline;
    128 };
    129 
    130 struct cfattach rtk_cardbus_ca = {
    131 	sizeof(struct rtk_cardbus_softc),
    132 	rtk_cardbus_match, rtk_cardbus_attach,
    133 	rtk_cardbus_detach, rtk_activate,
    134 };
    135 
    136 const struct rtk_type *rtk_cardbus_lookup
    137 	__P((const struct cardbus_attach_args *));
    138 
    139 void rtk_cardbus_setup		__P((struct rtk_cardbus_softc *));
    140 
    141 int rtk_cardbus_enable		__P((struct rtk_softc *));
    142 void rtk_cardbus_disable	__P((struct rtk_softc *));
    143 void rtk_cardbus_power		__P((struct rtk_softc *, int));
    144 const struct rtk_type *
    145 rtk_cardbus_lookup(ca)
    146 	const struct cardbus_attach_args *ca;
    147 {
    148 	const struct rtk_type *t;
    149 
    150 	for (t = rtk_cardbus_devs; t->rtk_name != NULL; t++){
    151 		if (CARDBUS_VENDOR(ca->ca_id) == t->rtk_vid &&
    152 		    CARDBUS_PRODUCT(ca->ca_id) == t->rtk_did) {
    153 			return (t);
    154 		}
    155 	}
    156 	return (NULL);
    157 }
    158 
    159 int
    160 rtk_cardbus_match(parent, match, aux)
    161 	struct device *parent;
    162 	struct cfdata *match;
    163 	void *aux;
    164 {
    165 	struct cardbus_attach_args *ca = aux;
    166 
    167 	if (rtk_cardbus_lookup(ca) != NULL)
    168 		return (1);
    169 
    170 	return (0);
    171 }
    172 
    173 
    174 void
    175 rtk_cardbus_attach(parent, self, aux)
    176 	struct device *parent, *self;
    177 	void *aux;
    178 {
    179 	struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)self;
    180 	struct rtk_softc *sc = &csc->sc_rtk;
    181 	struct cardbus_attach_args *ca = aux;
    182 	cardbus_devfunc_t ct = ca->ca_ct;
    183 	const struct rtk_type *t;
    184 	bus_addr_t adr;
    185 
    186 	sc->sc_dmat = ca->ca_dmat;
    187 	csc->sc_ct = ct;
    188 	csc->sc_tag = ca->ca_tag;
    189 	csc->sc_intrline = ca->ca_intrline;
    190 
    191 	t = rtk_cardbus_lookup(ca);
    192 	if (t == NULL) {
    193 		printf("\n");
    194 		panic("rtk_cardbus_attach: impossible");
    195 	 }
    196 	printf(": %s\n", t->rtk_name);
    197 
    198 	/*
    199 	 * Power management hooks.
    200 	 */
    201 	sc->sc_enable = rtk_cardbus_enable;
    202 	sc->sc_disable = rtk_cardbus_disable;
    203 	sc->sc_power = rtk_cardbus_power;
    204 
    205 	/*
    206 	 * Map control/status registers.
    207 	 */
    208 	csc->sc_csr = CARDBUS_COMMAND_MASTER_ENABLE;
    209 #ifdef RTK_USEIOSPACE
    210 	if (Cardbus_mapreg_map(ct, RTK_PCI_LOIO, CARDBUS_MAPREG_TYPE_IO, 0,
    211 	    &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
    212 #if rbus
    213 #else
    214 		(*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr+csc->sc_mapsize);
    215 #endif
    216 		csc->sc_cben = CARDBUS_IO_ENABLE;
    217 		csc->sc_csr |= CARDBUS_COMMAND_IO_ENABLE;
    218 		csc->sc_bar_reg = RTK_PCI_LOIO;
    219 		csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO;
    220 	}
    221 #else
    222 	if (Cardbus_mapreg_map(ct, RTK_PCI_LOMEM, CARDBUS_MAPREG_TYPE_MEM, 0,
    223 	    &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
    224 #if rbus
    225 #else
    226 		(*ct->ct_cf->cardbus_mem_open)(cc, 0, adr, adr+csc->sc_mapsize);
    227 #endif
    228 		csc->sc_cben = CARDBUS_MEM_ENABLE;
    229 		csc->sc_csr |= CARDBUS_COMMAND_MEM_ENABLE;
    230 		csc->sc_bar_reg = RTK_PCI_LOMEM;
    231 		csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_MEM;
    232 	}
    233 #endif
    234 	else {
    235 		printf("%s: unable to map deviceregisters\n",
    236 			 sc->sc_dev.dv_xname);
    237 		return;
    238 	}
    239 	/*
    240 	 * Handle power management nonsense and initialize the
    241 	 * configuration registers.
    242 	 */
    243 	rtk_cardbus_setup(csc);
    244 	sc->rtk_type = t->rtk_type;
    245 
    246 	rtk_attach(sc);
    247 
    248 	/*
    249 	 * Power down the socket.
    250 	 */
    251 	Cardbus_function_disable(csc->sc_ct);
    252 }
    253 
    254 int
    255 rtk_cardbus_detach(self, flags)
    256 	struct device *self;
    257 	int flags;
    258 {
    259 	struct rtk_cardbus_softc *csc = (void *) self;
    260 	struct rtk_softc *sc = &csc->sc_rtk;
    261 	struct cardbus_devfunc *ct = csc->sc_ct;
    262 	int	rv;
    263 
    264 #ifdef DIAGNOSTIC
    265 	if (ct == NULL)
    266 		panic("%s: data structure lacks\n", sc->sc_dev.dv_xname);
    267 #endif
    268 	rv = rtk_detach(sc);
    269 	if (rv)
    270 		return (rv);
    271 	/*
    272 	 * Unhook the interrut handler.
    273 	 */
    274 	if (csc->sc_ih != NULL)
    275 		cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, csc->sc_ih);
    276 
    277 	/*
    278 	 * Release bus space and close window.
    279 	 */
    280 	if (csc->sc_bar_reg != 0)
    281 		Cardbus_mapreg_unmap(ct, csc->sc_bar_reg,
    282 			sc->rtk_btag, sc->rtk_bhandle, csc->sc_mapsize);
    283 
    284 	return (0);
    285 }
    286 
    287 void
    288 rtk_cardbus_setup(csc)
    289 	struct rtk_cardbus_softc *csc;
    290 {
    291 	struct rtk_softc *sc = &csc->sc_rtk;
    292 	cardbus_devfunc_t ct = csc->sc_ct;
    293 	cardbus_chipset_tag_t cc = ct->ct_cc;
    294 	cardbus_function_tag_t cf = ct->ct_cf;
    295 	pcireg_t	reg,command;
    296 	int		pmreg;
    297 
    298 	/*
    299 	 * Handle power management nonsense.
    300 	 */
    301 	if (cardbus_get_capability(cc, cf, csc->sc_tag,
    302 	    PCI_CAP_PWRMGMT, &pmreg, 0)) {
    303 		command = cardbus_conf_read(cc, cf, csc->sc_tag, pmreg + 4);
    304 		if (command & RTK_PSTATE_MASK) {
    305 			pcireg_t		iobase, membase, irq;
    306 
    307 			/* Save important PCI config data. */
    308 			iobase = cardbus_conf_read(cc, cf, csc->sc_tag,
    309 			    RTK_PCI_LOIO);
    310 			membase = cardbus_conf_read(cc, cf,csc->sc_tag,
    311 			    RTK_PCI_LOMEM);
    312 			irq = cardbus_conf_read(cc, cf,csc->sc_tag,
    313 			    PCI_PRODUCT_DELTA_8139);
    314 
    315 			/* Reset the power state. */
    316 			printf("%s: chip is is in D%d power mode "
    317 			    "-- setting to D0\n", sc->sc_dev.dv_xname,
    318 			    command & RTK_PSTATE_MASK);
    319 			command &= 0xFFFFFFFC;
    320 			cardbus_conf_write(cc, cf, csc->sc_tag,
    321 			    pmreg + 4, command);
    322 
    323 			/* Restore PCI config data. */
    324 			cardbus_conf_write(cc, cf, csc->sc_tag,
    325 			    RTK_PCI_LOIO, iobase);
    326 			cardbus_conf_write(cc, cf, csc->sc_tag,
    327 			    RTK_PCI_LOMEM, membase);
    328 			cardbus_conf_write(cc, cf, csc->sc_tag,
    329 			    PCI_PRODUCT_DELTA_8139, irq);
    330 		}
    331 	}
    332 
    333 	/* Make sure the right access type is on the CardBus bridge. */
    334 	(*ct->ct_cf->cardbus_ctrl)(cc, csc->sc_cben);
    335 	(*ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
    336 
    337 	/* Program the BAR */
    338 	cardbus_conf_write(cc, cf, csc->sc_tag,
    339 		csc->sc_bar_reg, csc->sc_bar_val);
    340 
    341 	/* Enable the appropriate bits in the CARDBUS CSR. */
    342 	reg = cardbus_conf_read(cc, cf, csc->sc_tag,
    343 	    CARDBUS_COMMAND_STATUS_REG);
    344 	reg &= ~(CARDBUS_COMMAND_IO_ENABLE|CARDBUS_COMMAND_MEM_ENABLE);
    345 	reg |= csc->sc_csr;
    346 	cardbus_conf_write(cc, cf, csc->sc_tag,
    347 	    CARDBUS_COMMAND_STATUS_REG, reg);
    348 
    349 	/*
    350 	 * Make sure the latency timer is set to some reasonable
    351 	 * value.
    352 	 */
    353 	reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
    354 	if (CARDBUS_LATTIMER(reg) < 0x20) {
    355 		reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
    356 		reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
    357 		cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
    358 	}
    359 }
    360 
    361 int
    362 rtk_cardbus_enable(sc)
    363 	struct rtk_softc *sc;
    364 {
    365 	struct rtk_cardbus_softc *csc = (void *) sc;
    366 	cardbus_devfunc_t ct = csc->sc_ct;
    367 	cardbus_chipset_tag_t cc = ct->ct_cc;
    368 	cardbus_function_tag_t cf = ct->ct_cf;
    369 
    370 	/*
    371 	 * Power on the socket.
    372 	 */
    373 	Cardbus_function_enable(ct);
    374 
    375 	/*
    376 	 * Set up the PCI configuration registers.
    377 	 */
    378 	rtk_cardbus_setup(csc);
    379 
    380 	/*
    381 	 * Map and establish the interrupt.
    382 	 */
    383 	csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
    384 		IPL_NET, rtk_intr, sc);
    385 	if (csc->sc_ih == NULL) {
    386 		printf("%s: unable to establish interrupt at %d\n",
    387 			sc->sc_dev.dv_xname, csc->sc_intrline);
    388 		Cardbus_function_disable(csc->sc_ct);
    389 		return (1);
    390 	}
    391 	printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
    392 		csc->sc_intrline);
    393 	return (0);
    394 }
    395 
    396 void
    397 rtk_cardbus_disable(sc)
    398 	struct rtk_softc *sc;
    399 {
    400 	struct rtk_cardbus_softc *csc = (void *) sc;
    401 	cardbus_devfunc_t ct = csc->sc_ct;
    402 	cardbus_chipset_tag_t cc = ct->ct_cc;
    403 	cardbus_function_tag_t cf = ct->ct_cf;
    404 
    405 	/* Unhook the interrupt handler. */
    406 	cardbus_intr_disestablish(cc, cf, csc->sc_ih);
    407 
    408 	/* Power down the socket. */
    409 	Cardbus_function_disable(ct);
    410 }
    411 
    412 void
    413 rtk_cardbus_power(sc, why)
    414 	struct rtk_softc *sc;
    415 	int why;
    416 {
    417 	struct rtk_cardbus_softc *csc = (void *) sc;
    418 
    419 	if (why == PWR_RESUME) {
    420 		/*
    421 		 * Give the PCI configuration registers a kick
    422 		 * in the head.
    423 		 */
    424 #ifdef DIAGNOSTIC
    425 		if (RTK_IS_ENABLED(sc) == 0)
    426 			panic("rtk_cardbus_power");
    427 #endif
    428 		rtk_cardbus_setup(csc);
    429 	}
    430 }
    431