/* $NetBSD: if_rtw_cardbus.c,v 1.45 2016/07/07 06:55:41 msaitoh Exp $ */
/*-
* Copyright (c) 2004, 2005 David Young. All rights reserved.
*
* Adapted for the RTL8180 by David Young.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY David Young ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL David
* Young BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*/
/*-
* Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
* NASA Ames Research Center.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Cardbus front-end for the Realtek RTL8180 802.11 MAC/BBP driver.
*
* TBD factor with atw, tlp Cardbus front-ends?
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_rtw_cardbus.c,v 1.45 2016/07/07 06:55:41 msaitoh Exp $");
#include "opt_inet.h"
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/mbuf.h>
#include <sys/malloc.h>
#include <sys/kernel.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <sys/errno.h>
#include <sys/device.h>
#include <machine/endian.h>
#include <net/if.h>
#include <net/if_dl.h>
#include <net/if_media.h>
#include <net/if_ether.h>
#include <net80211/ieee80211_netbsd.h>
#include <net80211/ieee80211_radiotap.h>
#include <net80211/ieee80211_var.h>
#include <sys/bus.h>
#include <sys/intr.h>
#include <dev/ic/rtwreg.h>
#include <dev/ic/rtwvar.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/pcireg.h>
#include <dev/pci/pcidevs.h>
#include <dev/cardbus/cardbusvar.h>
#include <dev/pci/pcidevs.h>
/*
* PCI configuration space registers used by the RTL8180.
*/
#define RTW_PCI_IOBA PCI_BAR(0) /* i/o mapped base */
#define RTW_PCI_MMBA PCI_BAR(1) /* memory mapped base */
struct rtw_cardbus_softc {
struct rtw_softc sc_rtw; /* real RTL8180 softc */
/* CardBus-specific goo. */
void *sc_ih; /* interrupt handle */
cardbus_devfunc_t sc_ct; /* our CardBus devfuncs */
pcitag_t sc_tag; /* our CardBus tag */
int sc_csr; /* CSR bits */
bus_size_t sc_mapsize; /* size of the mapped bus space
* region
*/
int sc_bar; /* which BAR to use */
};
int rtw_cardbus_match(device_t, cfdata_t, void *);
void rtw_cardbus_attach(device_t, device_t, void *);
int rtw_cardbus_detach(device_t, int);
CFATTACH_DECL3_NEW(rtw_cardbus, sizeof(struct rtw_cardbus_softc),
rtw_cardbus_match, rtw_cardbus_attach, rtw_cardbus_detach, NULL, NULL,
NULL, DVF_DETACH_SHUTDOWN);
void rtw_cardbus_setup(struct rtw_cardbus_softc *);
bool rtw_cardbus_resume(device_t, const pmf_qual_t *);
bool rtw_cardbus_suspend(device_t, const pmf_qual_t *);
const struct rtw_cardbus_product *rtw_cardbus_lookup(
const struct cardbus_attach_args *);
const struct rtw_cardbus_product {
u_int32_t rcp_vendor; /* PCI vendor ID */
u_int32_t rcp_product; /* PCI product ID */
const char *rcp_product_name;
} rtw_cardbus_products[] = {
{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8180,
"Realtek RTL8180 802.11 MAC/BBP" },
{ PCI_VENDOR_BELKIN, PCI_PRODUCT_BELKIN_F5D6020V3,
"Belkin F5D6020v3 802.11b (RTL8180 MAC/BBP)" },
{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DWL610,
"DWL-610 D-Link Air 802.11b (RTL8180 MAC/BBP)" },
{ 0, 0, NULL },
};
const struct rtw_cardbus_product *
rtw_cardbus_lookup(const struct cardbus_attach_args *ca)
{
const struct rtw_cardbus_product *rcp;
for (rcp = rtw_cardbus_products; rcp->rcp_product_name != NULL; rcp++) {
if (PCI_VENDOR(ca->ca_id) == rcp->rcp_vendor &&
PCI_PRODUCT(ca->ca_id) == rcp->rcp_product)
return rcp;
}
return NULL;
}
int
rtw_cardbus_match(device_t parent, cfdata_t match, void *aux)
{
struct cardbus_attach_args *ca = aux;
if (rtw_cardbus_lookup(ca) != NULL)
return 1;
return 0;
}
static void
rtw_cardbus_funcregen(struct rtw_regs *regs, int enable)
{
u_int32_t reg;
rtw_config0123_enable(regs, 1);
reg = RTW_READ(regs, RTW_CONFIG3);
if (enable)
RTW_WRITE(regs, RTW_CONFIG3, reg | RTW_CONFIG3_FUNCREGEN);
else
RTW_WRITE(regs, RTW_CONFIG3, reg & ~RTW_CONFIG3_FUNCREGEN);
rtw_config0123_enable(regs, 0);
}
void
rtw_cardbus_attach(device_t parent, device_t self, void *aux)
{
struct rtw_cardbus_softc *csc = device_private(self);
struct rtw_softc *sc = &csc->sc_rtw;
struct rtw_regs *regs = &sc->sc_regs;
struct cardbus_attach_args *ca = aux;
cardbus_devfunc_t ct = ca->ca_ct;
const struct rtw_cardbus_product *rcp;
bus_addr_t adr;
sc->sc_dev = self;
sc->sc_dmat = ca->ca_dmat;
csc->sc_ct = ct;
csc->sc_tag = ca->ca_tag;
rcp = rtw_cardbus_lookup(ca);
if (rcp == NULL) {
printf("\n");
panic("rtw_cardbus_attach: impossible");
}
printf(": %s\n", rcp->rcp_product_name);
#ifdef notyet
/* Get revision info. */
int rev = PCI_REVISION(ca->ca_class);
RTW_DPRINTF(RTW_DEBUG_ATTACH,
("%s: pass %d.%d signature %08x\n", device_xname(self),
(rev >> 4) & 0xf, rev & 0xf,
Cardbus_conf_read(ct, csc->sc_tag, 0x80)));
#endif
/*
* Map the device.
*/
csc->sc_csr = PCI_COMMAND_MASTER_ENABLE |
PCI_COMMAND_PARITY_ENABLE |
PCI_COMMAND_SERR_ENABLE;
if (Cardbus_mapreg_map(ct, RTW_PCI_MMBA, PCI_MAPREG_TYPE_MEM, 0,
®s->r_bt, ®s->r_bh, &adr, ®s->r_sz) == 0) {
RTW_DPRINTF(RTW_DEBUG_ATTACH,
("%s: %s mapped %" PRIuMAX " bytes mem space\n",
device_xname(self), __func__, (uintmax_t)regs->r_sz));
csc->sc_csr |= PCI_COMMAND_MEM_ENABLE;
csc->sc_bar = RTW_PCI_MMBA;
} else if (Cardbus_mapreg_map(ct, RTW_PCI_IOBA, PCI_MAPREG_TYPE_IO,
0, ®s->r_bt, ®s->r_bh, &adr, ®s->r_sz) == 0) {
RTW_DPRINTF(RTW_DEBUG_ATTACH,
("%s: %s mapped %" PRIuMAX " bytes I/O space\n",
device_xname(self), __func__, (uintmax_t)regs->r_sz));
csc->sc_csr |= PCI_COMMAND_IO_ENABLE;
csc->sc_bar = RTW_PCI_IOBA;
} else {
aprint_error_dev(self, "unable to map device registers\n");
return;
}
/*
* Bring the chip out of powersave mode and initialize the
* configuration registers.
*/
rtw_cardbus_setup(csc);
/*
* Finish off the attach.
*/
rtw_attach(sc);
rtw_cardbus_funcregen(regs, 1);
RTW_WRITE(regs, RTW_FEMR, 0);
RTW_WRITE(regs, RTW_FER, RTW_READ(regs, RTW_FER));
if (pmf_device_register(self,
rtw_cardbus_suspend, rtw_cardbus_resume)) {
pmf_class_network_register(self, &sc->sc_if);
/*
* Power down the socket.
*/
pmf_device_suspend(self, &sc->sc_qual);
} else
aprint_error_dev(self, "couldn't establish power handler\n");
}
int
rtw_cardbus_detach(device_t self, int flags)
{
struct rtw_cardbus_softc *csc = device_private(self);
struct rtw_softc *sc = &csc->sc_rtw;
struct rtw_regs *regs = &sc->sc_regs;
struct cardbus_devfunc *ct = csc->sc_ct;
int rc;
#if defined(DIAGNOSTIC)
if (ct == NULL)
panic("%s: data structure lacks", device_xname(self));
#endif
if ((rc = rtw_detach(sc)) != 0)
return rc;
/*
* Unhook the interrupt handler.
*/
if (csc->sc_ih != NULL)
Cardbus_intr_disestablish(ct, csc->sc_ih);
/*
* Release bus space and close window.
*/
if (csc->sc_bar != 0)
Cardbus_mapreg_unmap(ct, csc->sc_bar,
regs->r_bt, regs->r_bh, regs->r_sz);
return 0;
}
bool
rtw_cardbus_resume(device_t self, const pmf_qual_t *qual)
{
struct rtw_cardbus_softc *csc = device_private(self);
struct rtw_softc *sc = &csc->sc_rtw;
cardbus_devfunc_t ct = csc->sc_ct;
/*
* Map and establish the interrupt.
*/
csc->sc_ih = Cardbus_intr_establish(ct, IPL_NET, rtw_intr, sc);
if (csc->sc_ih == NULL) {
aprint_error_dev(sc->sc_dev,
"unable to establish interrupt\n");
return false;
}
rtw_cardbus_funcregen(&sc->sc_regs, 1);
RTW_WRITE(&sc->sc_regs, RTW_FEMR, RTW_FEMR_INTR);
RTW_WRITE(&sc->sc_regs, RTW_FER, RTW_FER_INTR);
return rtw_resume(self, qual);
}
bool
rtw_cardbus_suspend(device_t self, const pmf_qual_t *qual)
{
struct rtw_cardbus_softc *csc = device_private(self);
struct rtw_softc *sc = &csc->sc_rtw;
cardbus_devfunc_t ct = csc->sc_ct;
if (!rtw_suspend(self, qual))
return false;
RTW_WRITE(&sc->sc_regs, RTW_FEMR,
RTW_READ(&sc->sc_regs, RTW_FEMR) & ~RTW_FEMR_INTR);
rtw_cardbus_funcregen(&sc->sc_regs, 0);
/* Unhook the interrupt handler. */
Cardbus_intr_disestablish(ct, csc->sc_ih);
csc->sc_ih = NULL;
return true;
}
void
rtw_cardbus_setup(struct rtw_cardbus_softc *csc)
{
pcitag_t tag = csc->sc_tag;
cardbus_devfunc_t ct = csc->sc_ct;
pcireg_t bhlc, csr, lattimer;
(void)cardbus_set_powerstate(ct, tag, PCI_PWR_D0);
/* I believe the datasheet tries to warn us that the RTL8180
* wants for 16 (0x10) to divide the latency timer.
*/
bhlc = Cardbus_conf_read(ct, tag, PCI_BHLC_REG);
lattimer = rounddown(PCI_LATTIMER(bhlc), 0x10);
if (PCI_LATTIMER(bhlc) != lattimer) {
bhlc &= ~(PCI_LATTIMER_MASK << PCI_LATTIMER_SHIFT);
bhlc |= (lattimer << PCI_LATTIMER_SHIFT);
Cardbus_conf_write(ct, tag, PCI_BHLC_REG, bhlc);
}
/* Enable the appropriate bits in the PCI CSR. */
csr = Cardbus_conf_read(ct, tag, PCI_COMMAND_STATUS_REG);
csr &= ~(PCI_COMMAND_IO_ENABLE|PCI_COMMAND_MEM_ENABLE);
csr |= csc->sc_csr;
Cardbus_conf_write(ct, tag, PCI_COMMAND_STATUS_REG, csr);
}