/*      $NetBSD: if_atw_pci.c,v 1.29 2022/09/25 17:52:25 thorpej Exp $  */

/*-
* Copyright (c) 1998, 1999, 2000, 2002 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; Charles M. Hannum; and 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 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 ADMtek ADM8211 802.11 MAC/BBP chip.
*
* Derived from the ``Tulip'' PCI bus front-end.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_atw_pci.c,v 1.29 2022/09/25 17:52:25 thorpej Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/mbuf.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/atwreg.h>
#include <dev/ic/rf3000reg.h>
#include <dev/ic/si4136reg.h>
#include <dev/ic/atwvar.h>

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

/*
* PCI configuration space registers used by the ADM8211.
*/
#define ATW_PCI_IOBA PCI_BAR(0) /* i/o mapped base */
#define ATW_PCI_MMBA PCI_BAR(1) /* memory mapped base */

struct atw_pci_softc {
       struct atw_softc        psc_atw;        /* real ADM8211 softc */

       pci_intr_handle_t       psc_ih;         /* interrupt handle */
       void                    *psc_intrcookie;

       pci_chipset_tag_t       psc_pc;         /* our PCI chipset */
       pcitag_t                psc_pcitag;     /* our PCI tag */
};

static int      atw_pci_match(device_t, cfdata_t, void *);
static void     atw_pci_attach(device_t, device_t, void *);
static bool     atw_pci_suspend(device_t, const pmf_qual_t *);
static bool     atw_pci_resume(device_t, const pmf_qual_t *);

CFATTACH_DECL_NEW(atw_pci, sizeof(struct atw_pci_softc),
   atw_pci_match, atw_pci_attach, NULL, NULL);

static const struct atw_pci_product {
       u_int32_t       app_vendor;     /* PCI vendor ID */
       u_int32_t       app_product;    /* PCI product ID */
       const char      *app_product_name;
} atw_pci_products[] = {
       { PCI_VENDOR_ADMTEK,            PCI_PRODUCT_ADMTEK_ADM8211,
         "ADMtek ADM8211 802.11 MAC/BBP" },

       { 0,                            0,                              NULL },
};

static const struct atw_pci_product *
atw_pci_lookup(const struct pci_attach_args *pa)
{
       const struct atw_pci_product *app;

       for (app = atw_pci_products;
            app->app_product_name != NULL;
            app++) {
               if (PCI_VENDOR(pa->pa_id) == app->app_vendor &&
                   PCI_PRODUCT(pa->pa_id) == app->app_product)
                       return (app);
       }
       return (NULL);
}

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

       if (atw_pci_lookup(pa) != NULL)
               return (1);

       return (0);
}

static bool
atw_pci_resume(device_t self, const pmf_qual_t *qual)
{
       struct atw_pci_softc *psc = device_private(self);
       struct atw_softc *sc = &psc->psc_atw;

       /* XXX re-establishing interrupt shouldn't be needed */
       psc->psc_intrcookie = pci_intr_establish_xname(psc->psc_pc, psc->psc_ih,
           IPL_NET, atw_intr, sc, device_xname(self));
       if (psc->psc_intrcookie == NULL) {
               aprint_error_dev(sc->sc_dev, "unable to establish interrupt\n");
               return false;
       }

       return true;
}

static bool
atw_pci_suspend(device_t self, const pmf_qual_t *qual)
{
       struct atw_pci_softc *psc = device_private(self);

       /* Unhook the interrupt handler. */
       pci_intr_disestablish(psc->psc_pc, psc->psc_intrcookie);
       psc->psc_intrcookie = NULL;

       return atw_suspend(self, qual);
}

static void
atw_pci_attach(device_t parent, device_t self, void *aux)
{
       struct atw_pci_softc *psc = device_private(self);
       struct atw_softc *sc = &psc->psc_atw;
       struct pci_attach_args *pa = aux;
       pci_chipset_tag_t pc = pa->pa_pc;
       const char *intrstr = NULL;
       bus_space_tag_t iot, memt;
       bus_space_handle_t ioh, memh;
       int ioh_valid, memh_valid;
       const struct atw_pci_product *app;
       int error;
       char intrbuf[PCI_INTRSTR_LEN];

       sc->sc_dev = self;

       psc->psc_pc = pa->pa_pc;
       psc->psc_pcitag = pa->pa_tag;

       app = atw_pci_lookup(pa);
       if (app == NULL) {
               printf("\n");
               panic("atw_pci_attach: impossible");
       }

       aprint_naive("\n");
       /*
        * Get revision info, and set some chip-specific variables.
        */
       sc->sc_rev = PCI_REVISION(pa->pa_class);
       aprint_normal(": %s, revision %d.%d\n", app->app_product_name,
           (sc->sc_rev >> 4) & 0xf, sc->sc_rev & 0xf);

       /* power up chip */
       if ((error = pci_activate(pa->pa_pc, pa->pa_tag, self,
           NULL)) && error != EOPNOTSUPP) {
               aprint_error_dev(self, "cannot activate %d\n", error);
               return;
       }

       /*
        * Map the device.
        */
       ioh_valid = (pci_mapreg_map(pa, ATW_PCI_IOBA,
           PCI_MAPREG_TYPE_IO, 0,
           &iot, &ioh, NULL, NULL) == 0);
       memh_valid = (pci_mapreg_map(pa, ATW_PCI_MMBA,
           PCI_MAPREG_TYPE_MEM|PCI_MAPREG_MEM_TYPE_32BIT, 0,
           &memt, &memh, NULL, NULL) == 0);

       if (memh_valid) {
               sc->sc_st = memt;
               sc->sc_sh = memh;
       } else if (ioh_valid) {
               sc->sc_st = iot;
               sc->sc_sh = ioh;
       } else {
               aprint_error_dev(self, "unable to map device registers\n");
               return;
       }

       sc->sc_dmat = pa->pa_dmat;

       /*
        * Make sure bus mastering is enabled.
        */
       pci_conf_write(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
           pci_conf_read(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG) |
           PCI_COMMAND_MASTER_ENABLE);

       /*
        * Get the cacheline size.
        */
       sc->sc_cacheline = PCI_CACHELINE(pci_conf_read(pc, pa->pa_tag,
           PCI_BHLC_REG));

       /*
        * Get PCI data moving command info.
        */
       if (pa->pa_flags & PCI_FLAGS_MRL_OKAY) /* read line */
               sc->sc_flags |= ATWF_MRL;
       if (pa->pa_flags & PCI_FLAGS_MRM_OKAY) /* read multiple */
               sc->sc_flags |= ATWF_MRM;
       if (pa->pa_flags & PCI_FLAGS_MWI_OKAY) /* write invalidate */
               sc->sc_flags |= ATWF_MWI;

       /*
        * Map and establish our interrupt.
        */
       if (pci_intr_map(pa, &psc->psc_ih)) {
               aprint_error_dev(self, "unable to map interrupt\n");
               return;
       }
       intrstr = pci_intr_string(pc, psc->psc_ih, intrbuf, sizeof(intrbuf));
       psc->psc_intrcookie = pci_intr_establish_xname(pc, psc->psc_ih, IPL_NET,
           atw_intr, sc, device_xname(self));
       if (psc->psc_intrcookie == NULL) {
               aprint_error_dev(self, "unable to establish interrupt");
               if (intrstr != NULL)
                       aprint_error(" at %s", intrstr);
               aprint_error("\n");
               return;
       }

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

       /*
        * Bus-independent attach.
        */
       atw_attach(sc);

       if (pmf_device_register1(sc->sc_dev, atw_pci_suspend, atw_pci_resume,
           atw_shutdown))
               pmf_class_network_register(sc->sc_dev, &sc->sc_if);
       else
               aprint_error_dev(self, "couldn't establish power handler\n");

       /*
        * Power down the socket.
        */
       pmf_device_suspend(sc->sc_dev, &sc->sc_qual);
}