/*      $NetBSD: if_wi_pci.c,v 1.57 2018/12/09 11:14:02 jdolecek Exp $  */

/*-
* Copyright (c) 2001 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Hideaki Imaizumi <[email protected]>
* and Ichiro FUKUHARA ([email protected]).
*
* 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.
*/

/*
* PCI bus front-end for the Intersil PCI WaveLan.
* Works with Prism2.5 Mini-PCI wavelan.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_wi_pci.c,v 1.57 2018/12/09 11:14:02 jdolecek Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/mbuf.h>
#include <sys/syslog.h>
#include <sys/socket.h>
#include <sys/device.h>
#include <sys/callout.h>

#include <net/if.h>
#include <net/if_ether.h>
#include <net/if_media.h>

#include <net80211/ieee80211_netbsd.h>
#include <net80211/ieee80211_var.h>
#include <net80211/ieee80211_radiotap.h>
#include <net80211/ieee80211_rssadapt.h>

#include <sys/bus.h>
#include <sys/intr.h>

#include <dev/pci/pcireg.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/pcidevs.h>

#include <dev/ic/wi_ieee.h>
#include <dev/ic/wireg.h>
#include <dev/ic/wivar.h>

#define WI_PCI_CBMA PCI_BAR(0)  /* Configuration Base Memory Address */
#define WI_PCI_PLX_LOMEM        0x10    /* PLX chip membase */
#define WI_PCI_PLX_LOIO PCI_BAR(1)      /* PLX chip iobase */
#define WI_PCI_LOMEM PCI_BAR(2) /* ISA membase */
#define WI_PCI_LOIO PCI_BAR(3)  /* ISA iobase */

#define CHIP_PLX_OTHER          0x01
#define CHIP_PLX_9052           0x02
#define CHIP_TMD_7160           0x03

#define WI_PLX_COR_OFFSET       0x3E0
#define WI_PLX_COR_VALUE        0x41

struct wi_pci_softc {
       struct wi_softc psc_wi;         /* real "wi" softc */

       /* PCI-specific goo */
       pci_intr_handle_t psc_ih;
       pci_chipset_tag_t psc_pc;
       pcitag_t psc_pcitag;
};

static int      wi_pci_match(device_t, cfdata_t, void *);
static void     wi_pci_attach(device_t, device_t, void *);
static int      wi_pci_enable(device_t, int);
static void     wi_pci_reset(struct wi_softc *);

static const struct wi_pci_product
       *wi_pci_lookup(struct pci_attach_args *);

CFATTACH_DECL_NEW(wi_pci, sizeof(struct wi_pci_softc),
   wi_pci_match, wi_pci_attach, NULL, NULL);

static const struct wi_pci_product {
       pci_vendor_id_t         wpp_vendor;     /* vendor ID */
       pci_product_id_t        wpp_product;    /* product ID */
       int                     wpp_chip;       /* uses other chip */
} wi_pci_products[] = {
       { PCI_VENDOR_GLOBALSUN,         PCI_PRODUCT_GLOBALSUN_GL24110P,
         CHIP_PLX_OTHER },
       { PCI_VENDOR_GLOBALSUN,         PCI_PRODUCT_GLOBALSUN_GL24110P02,
         CHIP_PLX_OTHER },
       { PCI_VENDOR_EUMITCOM,          PCI_PRODUCT_EUMITCOM_WL11000P,
         CHIP_PLX_OTHER },
       { PCI_VENDOR_3COM,              PCI_PRODUCT_3COM_3CRWE777A,
         CHIP_PLX_OTHER },
       { PCI_VENDOR_NETGEAR,           PCI_PRODUCT_NETGEAR_MA301,
         CHIP_PLX_OTHER },
       { PCI_VENDOR_INTERSIL,          PCI_PRODUCT_INTERSIL_MINI_PCI_WLAN,
         0 },
       { PCI_VENDOR_NDC,               PCI_PRODUCT_NDC_NCP130,
         CHIP_PLX_9052 },
       { PCI_VENDOR_USR2,              PCI_PRODUCT_USR2_2415,
         CHIP_PLX_OTHER },
       { PCI_VENDOR_NDC,               PCI_PRODUCT_NDC_NCP130A2,
         CHIP_TMD_7160 },
       { 0,                            0,
         0},
};

static int
wi_pci_enable(device_t self, int onoff)
{
       struct wi_pci_softc *psc = device_private(self);
       struct wi_softc *sc = &psc->psc_wi;

       if (onoff) {
               /* XXX re-establishing interrupt shouldn't be needed */
               sc->sc_ih = pci_intr_establish_xname(psc->psc_pc,
                   psc->psc_ih, IPL_NET, wi_intr, sc, device_xname(self));
               if (sc->sc_ih == NULL) {
                       aprint_error_dev(sc->sc_dev,
                           "couldn't establish interrupt\n");
                       return EIO;
               }

               /* reset HFA3842 MAC core */
               if (sc->sc_reset != NULL)
                       wi_pci_reset(sc);

       } else
               pci_intr_disestablish(psc->psc_pc, sc->sc_ih);
       return 0;
}

static void
wi_pci_reset(struct wi_softc *sc)
{
       int i, secs, usecs;

       bus_space_write_2(sc->sc_iot, sc->sc_ioh,
           WI_PCI_COR, WI_COR_SOFT_RESET);
       DELAY(250*1000); /* 1/4 second */

       bus_space_write_2(sc->sc_iot, sc->sc_ioh,
           WI_PCI_COR, WI_COR_CLEAR);
       DELAY(500*1000); /* 1/2 second */

       /* wait 2 seconds for firmware to complete initialization. */

       for (i = 200000; i--; DELAY(10))
               if (!(CSR_READ_2(sc, WI_COMMAND) & WI_CMD_BUSY))
                       break;

       if (i < 0) {
               printf("%s: PCI reset timed out\n", device_xname(sc->sc_dev));
       } else if (sc->sc_if.if_flags & IFF_DEBUG) {
               usecs = (200000 - i) * 10;
               secs = usecs / 1000000;
               usecs %= 1000000;

               printf("%s: PCI reset in %d.%06d seconds\n",
                      device_xname(sc->sc_dev), secs, usecs);
       }

       return;
}

static const struct wi_pci_product *
wi_pci_lookup(struct pci_attach_args *pa)
{
       const struct wi_pci_product *wpp;

       for (wpp = wi_pci_products; wpp->wpp_vendor != 0; wpp++) {
               if (PCI_VENDOR(pa->pa_id) == wpp->wpp_vendor &&
                   PCI_PRODUCT(pa->pa_id) == wpp->wpp_product)
                       return (wpp);
       }
       return (NULL);
}

static int
wi_pci_match(device_t parent, cfdata_t match, void *aux)
{
       struct pci_attach_args *pa = aux;

       if (wi_pci_lookup(pa) != NULL)
               return (1);
       return (0);
}

static void
wi_pci_attach(device_t parent, device_t self, void *aux)
{
       struct wi_pci_softc *psc = device_private(self);
       struct wi_softc *sc = &psc->psc_wi;
       struct pci_attach_args *pa = aux;
       pci_chipset_tag_t pc = pa->pa_pc;
       const char *intrstr;
       const struct wi_pci_product *wpp;
       pci_intr_handle_t ih;
       bus_space_tag_t memt, iot, plxt, tmdt;
       bus_space_handle_t memh, ioh, plxh, tmdh;
       char intrbuf[PCI_INTRSTR_LEN];

       sc->sc_dev = self;
       psc->psc_pc = pc;
       psc->psc_pcitag = pa->pa_tag;

       wpp = wi_pci_lookup(pa);
#ifdef DIAGNOSTIC
       if (wpp == NULL) {
               printf("\n");
               panic("wi_pci_attach: impossible");
       }
#endif

       switch (wpp->wpp_chip) {
       case CHIP_PLX_OTHER:
       case CHIP_PLX_9052:
               /* Map memory and I/O registers. */
               if (pci_mapreg_map(pa, WI_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
                   &memt, &memh, NULL, NULL) != 0) {
                       aprint_error(": can't map mem space\n");
                       return;
               }
               if (pci_mapreg_map(pa, WI_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
                   &iot, &ioh, NULL, NULL) != 0) {
                       aprint_error(": can't map I/O space\n");
                       return;
               }

               if (wpp->wpp_chip == CHIP_PLX_OTHER) {
                       /* The PLX 9052 doesn't have IO at 0x14.  Perhaps
                          other chips have, so we'll make this conditional. */
                       if (pci_mapreg_map(pa, WI_PCI_PLX_LOIO,
                           PCI_MAPREG_TYPE_IO, 0, &plxt, &plxh, NULL, NULL)
                           != 0) {
                               aprint_error(": can't map PLX\n");
                               return;
                       }
               }
               break;
       case CHIP_TMD_7160:
               /* Used instead of PLX on at least one revision of
                * the National Datacomm Corporation NCP130. Values
                * for registers acquired from OpenBSD, which in
                * turn got them from a Linux driver.
                */
               /* Map COR and I/O registers. */
               if (pci_mapreg_map(pa, WI_TMD_COR, PCI_MAPREG_TYPE_IO, 0,
                   &tmdt, &tmdh, NULL, NULL) != 0) {
                       aprint_error(": can't map TMD\n");
                       return;
               }
               if (pci_mapreg_map(pa, WI_TMD_IO, PCI_MAPREG_TYPE_IO, 0,
                   &iot, &ioh, NULL, NULL) != 0) {
                       aprint_error(": can't map I/O space\n");
                       return;
               }
               break;
       default:
               if (pci_mapreg_map(pa, WI_PCI_CBMA,
                   PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT,
                   0, &iot, &ioh, NULL, NULL) != 0) {
                       aprint_error(": can't map mem space\n");
                       return;
               }

               memt = iot;
               memh = ioh;
               sc->sc_pci = 1;
               break;
       }

       pci_aprint_devinfo(pa, NULL);

       sc->sc_enabled = 1;
       sc->sc_enable = wi_pci_enable;

       sc->sc_iot = iot;
       sc->sc_ioh = ioh;
       /* Make sure interrupts are disabled. */
       CSR_WRITE_2(sc, WI_INT_EN, 0);
       CSR_WRITE_2(sc, WI_EVENT_ACK, 0xFFFF);

       if (wpp->wpp_chip == CHIP_PLX_OTHER) {
               uint32_t command;
#define WI_LOCAL_INTCSR         0x4c
#define WI_LOCAL_INTEN          0x40    /* poke this into INTCSR */

               command = bus_space_read_4(plxt, plxh, WI_LOCAL_INTCSR);
               command |= WI_LOCAL_INTEN;
               bus_space_write_4(plxt, plxh, WI_LOCAL_INTCSR, command);
       }

       /* Map and establish the interrupt. */
       if (pci_intr_map(pa, &ih)) {
               aprint_error_dev(self, "couldn't map interrupt\n");
               return;
       }
       intrstr = pci_intr_string(pc, ih, intrbuf, sizeof(intrbuf));

       psc->psc_ih = ih;
       sc->sc_ih = pci_intr_establish_xname(pc, ih, IPL_NET, wi_intr, sc,
           device_xname(self));
       if (sc->sc_ih == NULL) {
               aprint_error_dev(self, "couldn't establish interrupt");
               if (intrstr != NULL)
                       aprint_error(" at %s", intrstr);
               aprint_error("\n");
               return;
       }

       aprint_normal_dev(self, "interrupting at %s\n", intrstr);

       switch (wpp->wpp_chip) {
       case CHIP_PLX_OTHER:
       case CHIP_PLX_9052:
               /*
                * Setup the PLX chip for level interrupts and config index 1
                * XXX - should really reset the PLX chip too.
                */
               bus_space_write_1(memt, memh,
                   WI_PLX_COR_OFFSET, WI_PLX_COR_VALUE);
               break;
       case CHIP_TMD_7160:
               /* Enable I/O mode and level interrupts on the embedded
                * card. The card's COR is the first byte of BAR 0.
                */
               bus_space_write_1(tmdt, tmdh, 0, WI_COR_IOMODE);
               break;
       default:
               /* reset HFA3842 MAC core */
               wi_pci_reset(sc);
               break;
       }

       printf("%s:", device_xname(self));

       if (wi_attach(sc, 0) != 0) {
               aprint_error_dev(self, "failed to attach controller\n");
               pci_intr_disestablish(pa->pa_pc, sc->sc_ih);
               return;
       }

       if (!wpp->wpp_chip)
               sc->sc_reset = wi_pci_reset;

       if (pmf_device_register(self, NULL, NULL))
               pmf_class_network_register(self, &sc->sc_if);
       else
               aprint_error_dev(self, "couldn't establish power handler\n");
}