root/sys/dev/pci/if_ne_pci.c
/*      $NetBSD: if_ne_pci.c,v 1.40 2019/01/27 02:08:42 pgoyette Exp $  */

/*-
 * Copyright (c) 1997, 1998 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.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_ne_pci.c,v 1.40 2019/01/27 02:08:42 pgoyette 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 <net/if.h>
#include <net/if_ether.h>
#include <net/if_media.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/dp8390reg.h>
#include <dev/ic/dp8390var.h>

#include <dev/ic/ne2000reg.h>
#include <dev/ic/ne2000var.h>

#include <dev/ic/rtl80x9reg.h>
#include <dev/ic/rtl80x9var.h>

struct ne_pci_softc {
        struct ne2000_softc sc_ne2000;          /* real "ne2000" softc */

        /* PCI-specific goo */
        void *sc_ih;                            /* interrupt handle */
};

static int      ne_pci_match(device_t, cfdata_t, void *);
static void     ne_pci_attach(device_t, device_t, void *);

CFATTACH_DECL_NEW(ne_pci, sizeof(struct ne_pci_softc),
    ne_pci_match, ne_pci_attach, NULL, NULL);

static const struct ne_pci_product {
        pci_vendor_id_t npp_vendor;
        pci_product_id_t npp_product;
        int (*npp_mediachange)(struct dp8390_softc *);
        void (*npp_mediastatus)(struct dp8390_softc *, struct ifmediareq *);
        void (*npp_init_card)(struct dp8390_softc *);
        void (*npp_media_init)(struct dp8390_softc *);
        const char *npp_name;
} ne_pci_products[] = {
        { PCI_VENDOR_REALTEK,           PCI_PRODUCT_REALTEK_RT8029,
          rtl80x9_mediachange,          rtl80x9_mediastatus,
          rtl80x9_init_card,            rtl80x9_media_init,
          "Realtek 8029" },

        { PCI_VENDOR_WINBOND,           PCI_PRODUCT_WINBOND_W89C940F,
          NULL,                         NULL,
          NULL,                         NULL,
          "Winbond 89C940F" },

        { PCI_VENDOR_WINBOND,           PCI_PRODUCT_WINBOND_W89C940F_1,
          NULL,                         NULL,
          NULL,                         NULL,
          "Winbond 89C940F" },

        { PCI_VENDOR_VIATECH,           PCI_PRODUCT_VIATECH_VT86C926,
          NULL,                         NULL,
          NULL,                         NULL,
          "VIA Technologies VT86C926" },

        { PCI_VENDOR_SURECOM,           PCI_PRODUCT_SURECOM_NE34,
          NULL,                         NULL,
          NULL,                         NULL,
          "Surecom NE-34" },

        { PCI_VENDOR_NETVIN,            PCI_PRODUCT_NETVIN_5000,
          NULL,                         NULL,
          NULL,                         NULL,
          "NetVin 5000" },

        /* XXX The following entries need sanity checking in pcidevs */
        { PCI_VENDOR_COMPEX,            PCI_PRODUCT_COMPEX_NE2KETHER,
          NULL,                         NULL,
          NULL,                         NULL,
          "Compex" },

        { PCI_VENDOR_PROLAN,            PCI_PRODUCT_PROLAN_NE2KETHER,
          NULL,                         NULL,
          NULL,                         NULL,
          "ProLAN" },

        { PCI_VENDOR_KTI,               PCI_PRODUCT_KTI_NE2KETHER,
          NULL,                         NULL,
          NULL,                         NULL,
          "KTI" },

        { 0,                            0,
          NULL,                         NULL,
          NULL,                         NULL,
          NULL },
};

static const struct ne_pci_product *
ne_pci_lookup(const struct pci_attach_args *pa)
{
        const struct ne_pci_product *npp;

        for (npp = ne_pci_products; npp->npp_name != NULL; npp++) {
                if (PCI_VENDOR(pa->pa_id) == npp->npp_vendor &&
                    PCI_PRODUCT(pa->pa_id) == npp->npp_product)
                        return (npp);
        }
        return (NULL);
}

/*
 * PCI constants.
 * XXX These should be in a common file!
 */
#define PCI_CBIO PCI_BAR(0)             /* Configuration Base IO Address */

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

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

        return (0);
}

static void
ne_pci_attach(device_t parent, device_t self, void *aux)
{
        struct ne_pci_softc *psc = device_private(self);
        struct ne2000_softc *nsc = &psc->sc_ne2000;
        struct dp8390_softc *dsc = &nsc->sc_dp8390;
        struct pci_attach_args *pa = aux;
        pci_chipset_tag_t pc = pa->pa_pc;
        bus_space_tag_t nict;
        bus_space_handle_t nich;
        bus_space_tag_t asict;
        bus_space_handle_t asich;
        const char *intrstr;
        const struct ne_pci_product *npp;
        pci_intr_handle_t ih;
        pcireg_t csr;
        char intrbuf[PCI_INTRSTR_LEN];

        npp = ne_pci_lookup(pa);
        if (npp == NULL) {
                printf("\n");
                panic("ne_pci_attach: impossible");
        }

        dsc->sc_dev = self;

        printf(": %s Ethernet\n", npp->npp_name);

        if (pci_mapreg_map(pa, PCI_CBIO, PCI_MAPREG_TYPE_IO, 0,
            &nict, &nich, NULL, NULL)) {
                aprint_error_dev(dsc->sc_dev, "can't map i/o space\n");
                return;
        }

        asict = nict;
        if (bus_space_subregion(nict, nich, NE2000_ASIC_OFFSET,
            NE2000_ASIC_NPORTS, &asich)) {
                aprint_error_dev(dsc->sc_dev, "can't subregion i/o space\n");
                return;
        }

        dsc->sc_regt = nict;
        dsc->sc_regh = nich;

        nsc->sc_asict = asict;
        nsc->sc_asich = asich;

        /* Enable the card. */
        csr = pci_conf_read(pc, pa->pa_tag,
            PCI_COMMAND_STATUS_REG);
        pci_conf_write(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
            csr | PCI_COMMAND_MASTER_ENABLE);

        /* This interface is always enabled. */
        dsc->sc_enabled = 1;

        dsc->sc_mediachange = npp->npp_mediachange;
        dsc->sc_mediastatus = npp->npp_mediastatus;
        dsc->sc_media_init = npp->npp_media_init;
        dsc->init_card = npp->npp_init_card;

        /*
         * Do generic NE2000 attach.  This will read the station address
         * from the EEPROM.
         */
        ne2000_attach(nsc, NULL);

        /* Map and establish the interrupt. */
        if (pci_intr_map(pa, &ih)) {
                aprint_error_dev(dsc->sc_dev, "couldn't map interrupt\n");
                return;
        }
        intrstr = pci_intr_string(pc, ih, intrbuf, sizeof(intrbuf));
        psc->sc_ih = pci_intr_establish_xname(pc, ih, IPL_NET, dp8390_intr,
            dsc, device_xname(self));
        if (psc->sc_ih == NULL) {
                aprint_error_dev(dsc->sc_dev, "couldn't establish interrupt");
                if (intrstr != NULL)
                        aprint_error(" at %s", intrstr);
                aprint_error("\n");
                return;
        }
        aprint_normal_dev(dsc->sc_dev, "interrupting at %s\n", intrstr);
}