718cf2ccb9
Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts.
416 lines
12 KiB
C
416 lines
12 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* Copyright (c) 2000 Matthew R. Green
|
|
* Copyright (c) 2007 Marius Strobl <marius@FreeBSD.org>
|
|
* All rights reserved.
|
|
*
|
|
* 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.
|
|
* 3. The name of the author may not be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
|
*
|
|
* from: NetBSD: if_hme_pci.c,v 1.14 2004/03/17 08:58:23 martin Exp
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
/*
|
|
* PCI front-end device driver for the HME ethernet device.
|
|
*/
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/systm.h>
|
|
#include <sys/bus.h>
|
|
#include <sys/kernel.h>
|
|
#include <sys/lock.h>
|
|
#include <sys/malloc.h>
|
|
#include <sys/module.h>
|
|
#include <sys/mutex.h>
|
|
#include <sys/resource.h>
|
|
#include <sys/socket.h>
|
|
|
|
#include <machine/bus.h>
|
|
#if defined(__powerpc__) || defined(__sparc64__)
|
|
#include <dev/ofw/openfirm.h>
|
|
#include <machine/ofw_machdep.h>
|
|
#endif
|
|
#include <machine/resource.h>
|
|
|
|
#include <sys/rman.h>
|
|
|
|
#include <net/ethernet.h>
|
|
#include <net/if.h>
|
|
#include <net/if_arp.h>
|
|
#include <net/if_dl.h>
|
|
#include <net/if_media.h>
|
|
|
|
#include <dev/mii/mii.h>
|
|
#include <dev/mii/miivar.h>
|
|
|
|
#include <dev/pci/pcivar.h>
|
|
#include <dev/pci/pcireg.h>
|
|
|
|
#include <dev/hme/if_hmereg.h>
|
|
#include <dev/hme/if_hmevar.h>
|
|
|
|
#include "miibus_if.h"
|
|
|
|
struct hme_pci_softc {
|
|
struct hme_softc hsc_hme; /* HME device */
|
|
struct resource *hsc_sres;
|
|
struct resource *hsc_ires;
|
|
void *hsc_ih;
|
|
};
|
|
|
|
static int hme_pci_probe(device_t);
|
|
static int hme_pci_attach(device_t);
|
|
static int hme_pci_detach(device_t);
|
|
static int hme_pci_suspend(device_t);
|
|
static int hme_pci_resume(device_t);
|
|
|
|
static device_method_t hme_pci_methods[] = {
|
|
/* Device interface */
|
|
DEVMETHOD(device_probe, hme_pci_probe),
|
|
DEVMETHOD(device_attach, hme_pci_attach),
|
|
DEVMETHOD(device_detach, hme_pci_detach),
|
|
DEVMETHOD(device_suspend, hme_pci_suspend),
|
|
DEVMETHOD(device_resume, hme_pci_resume),
|
|
/* Can just use the suspend method here. */
|
|
DEVMETHOD(device_shutdown, hme_pci_suspend),
|
|
|
|
/* MII interface */
|
|
DEVMETHOD(miibus_readreg, hme_mii_readreg),
|
|
DEVMETHOD(miibus_writereg, hme_mii_writereg),
|
|
DEVMETHOD(miibus_statchg, hme_mii_statchg),
|
|
|
|
DEVMETHOD_END
|
|
};
|
|
|
|
static driver_t hme_pci_driver = {
|
|
"hme",
|
|
hme_pci_methods,
|
|
sizeof(struct hme_pci_softc)
|
|
};
|
|
|
|
DRIVER_MODULE(hme, pci, hme_pci_driver, hme_devclass, 0, 0);
|
|
MODULE_DEPEND(hme, pci, 1, 1, 1);
|
|
MODULE_DEPEND(hme, ether, 1, 1, 1);
|
|
|
|
#define PCI_VENDOR_SUN 0x108e
|
|
#define PCI_PRODUCT_SUN_EBUS 0x1000
|
|
#define PCI_PRODUCT_SUN_HMENETWORK 0x1001
|
|
|
|
int
|
|
hme_pci_probe(device_t dev)
|
|
{
|
|
|
|
if (pci_get_vendor(dev) == PCI_VENDOR_SUN &&
|
|
pci_get_device(dev) == PCI_PRODUCT_SUN_HMENETWORK) {
|
|
device_set_desc(dev, "Sun HME 10/100 Ethernet");
|
|
return (BUS_PROBE_DEFAULT);
|
|
}
|
|
return (ENXIO);
|
|
}
|
|
|
|
int
|
|
hme_pci_attach(device_t dev)
|
|
{
|
|
struct hme_pci_softc *hsc;
|
|
struct hme_softc *sc;
|
|
bus_space_tag_t memt;
|
|
bus_space_handle_t memh;
|
|
int i, error = 0;
|
|
#if !(defined(__powerpc__) || defined(__sparc64__))
|
|
device_t *children, ebus_dev;
|
|
struct resource *ebus_rres;
|
|
int j, slot;
|
|
#endif
|
|
|
|
pci_enable_busmaster(dev);
|
|
/*
|
|
* Some Sun HMEs do have their intpin register bogusly set to 0,
|
|
* although it should be 1. Correct that.
|
|
*/
|
|
if (pci_get_intpin(dev) == 0)
|
|
pci_set_intpin(dev, 1);
|
|
|
|
hsc = device_get_softc(dev);
|
|
sc = &hsc->hsc_hme;
|
|
sc->sc_dev = dev;
|
|
sc->sc_flags |= HME_PCI;
|
|
mtx_init(&sc->sc_lock, device_get_nameunit(dev), MTX_NETWORK_LOCK,
|
|
MTX_DEF);
|
|
|
|
/*
|
|
* Map five register banks:
|
|
*
|
|
* bank 0: HME SEB registers: +0x0000
|
|
* bank 1: HME ETX registers: +0x2000
|
|
* bank 2: HME ERX registers: +0x4000
|
|
* bank 3: HME MAC registers: +0x6000
|
|
* bank 4: HME MIF registers: +0x7000
|
|
*
|
|
*/
|
|
i = PCIR_BAR(0);
|
|
hsc->hsc_sres = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
|
|
&i, RF_ACTIVE);
|
|
if (hsc->hsc_sres == NULL) {
|
|
device_printf(dev, "could not map device registers\n");
|
|
error = ENXIO;
|
|
goto fail_mtx;
|
|
}
|
|
i = 0;
|
|
hsc->hsc_ires = bus_alloc_resource_any(dev, SYS_RES_IRQ,
|
|
&i, RF_SHAREABLE | RF_ACTIVE);
|
|
if (hsc->hsc_ires == NULL) {
|
|
device_printf(dev, "could not allocate interrupt\n");
|
|
error = ENXIO;
|
|
goto fail_sres;
|
|
}
|
|
memt = rman_get_bustag(hsc->hsc_sres);
|
|
memh = rman_get_bushandle(hsc->hsc_sres);
|
|
sc->sc_sebt = sc->sc_etxt = sc->sc_erxt = sc->sc_mact = sc->sc_mift =
|
|
memt;
|
|
bus_space_subregion(memt, memh, 0x0000, 0x1000, &sc->sc_sebh);
|
|
bus_space_subregion(memt, memh, 0x2000, 0x1000, &sc->sc_etxh);
|
|
bus_space_subregion(memt, memh, 0x4000, 0x1000, &sc->sc_erxh);
|
|
bus_space_subregion(memt, memh, 0x6000, 0x1000, &sc->sc_mach);
|
|
bus_space_subregion(memt, memh, 0x7000, 0x1000, &sc->sc_mifh);
|
|
|
|
#if defined(__powerpc__) || defined(__sparc64__)
|
|
OF_getetheraddr(dev, sc->sc_enaddr);
|
|
#else
|
|
/*
|
|
* Dig out VPD (vital product data) and read NA (network address).
|
|
*
|
|
* The PCI HME is a PCIO chip, which is composed of two functions:
|
|
* function 0: PCI-EBus2 bridge, and
|
|
* function 1: HappyMeal Ethernet controller.
|
|
*
|
|
* The VPD of HME resides in the Boot PROM (PCI FCode) attached
|
|
* to the EBus bridge and can't be accessed via the PCI capability
|
|
* pointer.
|
|
* ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later)
|
|
* chapter 2 describes the data structure.
|
|
*
|
|
* We don't have a MI EBus driver since no EBus device exists
|
|
* (besides the FCode PROM) on add-on HME boards. The ``no driver
|
|
* attached'' message for function 0 therefore is what is expected.
|
|
*/
|
|
|
|
#define PCI_ROMHDR_SIZE 0x1c
|
|
#define PCI_ROMHDR_SIG 0x00
|
|
#define PCI_ROMHDR_SIG_MAGIC 0xaa55 /* little endian */
|
|
#define PCI_ROMHDR_PTR_DATA 0x18
|
|
#define PCI_ROM_SIZE 0x18
|
|
#define PCI_ROM_SIG 0x00
|
|
#define PCI_ROM_SIG_MAGIC 0x52494350 /* "PCIR", endian */
|
|
/* reversed */
|
|
#define PCI_ROM_VENDOR 0x04
|
|
#define PCI_ROM_DEVICE 0x06
|
|
#define PCI_ROM_PTR_VPD 0x08
|
|
#define PCI_VPDRES_BYTE0 0x00
|
|
#define PCI_VPDRES_ISLARGE(x) ((x) & 0x80)
|
|
#define PCI_VPDRES_LARGE_NAME(x) ((x) & 0x7f)
|
|
#define PCI_VPDRES_TYPE_VPD 0x10 /* large */
|
|
#define PCI_VPDRES_LARGE_LEN_LSB 0x01
|
|
#define PCI_VPDRES_LARGE_LEN_MSB 0x02
|
|
#define PCI_VPDRES_LARGE_DATA 0x03
|
|
#define PCI_VPD_SIZE 0x03
|
|
#define PCI_VPD_KEY0 0x00
|
|
#define PCI_VPD_KEY1 0x01
|
|
#define PCI_VPD_LEN 0x02
|
|
#define PCI_VPD_DATA 0x03
|
|
|
|
#define HME_ROM_READ_N(n, offs) bus_space_read_ ## n (memt, memh, (offs))
|
|
#define HME_ROM_READ_1(offs) HME_ROM_READ_N(1, (offs))
|
|
#define HME_ROM_READ_2(offs) HME_ROM_READ_N(2, (offs))
|
|
#define HME_ROM_READ_4(offs) HME_ROM_READ_N(4, (offs))
|
|
|
|
/* Search accompanying EBus bridge. */
|
|
slot = pci_get_slot(dev);
|
|
if (device_get_children(device_get_parent(dev), &children, &i) != 0) {
|
|
device_printf(dev, "could not get children\n");
|
|
error = ENXIO;
|
|
goto fail_sres;
|
|
}
|
|
ebus_dev = NULL;
|
|
for (j = 0; j < i; j++) {
|
|
if (pci_get_class(children[j]) == PCIC_BRIDGE &&
|
|
pci_get_vendor(children[j]) == PCI_VENDOR_SUN &&
|
|
pci_get_device(children[j]) == PCI_PRODUCT_SUN_EBUS &&
|
|
pci_get_slot(children[j]) == slot) {
|
|
ebus_dev = children[j];
|
|
break;
|
|
}
|
|
}
|
|
if (ebus_dev == NULL) {
|
|
device_printf(dev, "could not find EBus bridge\n");
|
|
error = ENXIO;
|
|
goto fail_children;
|
|
}
|
|
|
|
/* Map EBus bridge PROM registers. */
|
|
i = PCIR_BAR(0);
|
|
if ((ebus_rres = bus_alloc_resource_any(ebus_dev, SYS_RES_MEMORY,
|
|
&i, RF_ACTIVE)) == NULL) {
|
|
device_printf(dev, "could not map PROM registers\n");
|
|
error = ENXIO;
|
|
goto fail_children;
|
|
}
|
|
memt = rman_get_bustag(ebus_rres);
|
|
memh = rman_get_bushandle(ebus_rres);
|
|
|
|
/* Read PCI Expansion ROM header. */
|
|
if (HME_ROM_READ_2(PCI_ROMHDR_SIG) != PCI_ROMHDR_SIG_MAGIC ||
|
|
(i = HME_ROM_READ_2(PCI_ROMHDR_PTR_DATA)) < PCI_ROMHDR_SIZE) {
|
|
device_printf(dev, "unexpected PCI Expansion ROM header\n");
|
|
error = ENXIO;
|
|
goto fail_rres;
|
|
}
|
|
|
|
/* Read PCI Expansion ROM data. */
|
|
if (HME_ROM_READ_4(i + PCI_ROM_SIG) != PCI_ROM_SIG_MAGIC ||
|
|
HME_ROM_READ_2(i + PCI_ROM_VENDOR) != pci_get_vendor(dev) ||
|
|
HME_ROM_READ_2(i + PCI_ROM_DEVICE) != pci_get_device(dev) ||
|
|
(j = HME_ROM_READ_2(i + PCI_ROM_PTR_VPD)) < i + PCI_ROM_SIZE) {
|
|
device_printf(dev, "unexpected PCI Expansion ROM data\n");
|
|
error = ENXIO;
|
|
goto fail_rres;
|
|
}
|
|
|
|
/*
|
|
* Read PCI VPD.
|
|
* SUNW,hme cards have a single large resource VPD-R tag
|
|
* containing one NA. SUNW,qfe cards have four large resource
|
|
* VPD-R tags containing one NA each (all four HME chips share
|
|
* the same PROM).
|
|
* The VPD used on both cards is not in PCI 2.2 standard format
|
|
* however. The length in the resource header is in big endian
|
|
* and the end tag is non-standard (0x79) and followed by an
|
|
* all-zero "checksum" byte. Sun calls this a "Fresh Choice
|
|
* Ethernet" VPD...
|
|
*/
|
|
/* Look at the end tag to determine whether this is a VPD with 4 NAs. */
|
|
if (HME_ROM_READ_1(j + PCI_VPDRES_LARGE_DATA + PCI_VPD_SIZE +
|
|
ETHER_ADDR_LEN) != 0x79 &&
|
|
HME_ROM_READ_1(j + 4 * (PCI_VPDRES_LARGE_DATA + PCI_VPD_SIZE +
|
|
ETHER_ADDR_LEN)) == 0x79)
|
|
/* Use the Nth NA for the Nth HME on this SUNW,qfe. */
|
|
j += slot * (PCI_VPDRES_LARGE_DATA + PCI_VPD_SIZE +
|
|
ETHER_ADDR_LEN);
|
|
if (PCI_VPDRES_ISLARGE(HME_ROM_READ_1(j + PCI_VPDRES_BYTE0)) == 0 ||
|
|
PCI_VPDRES_LARGE_NAME(HME_ROM_READ_1(j + PCI_VPDRES_BYTE0)) !=
|
|
PCI_VPDRES_TYPE_VPD ||
|
|
(HME_ROM_READ_1(j + PCI_VPDRES_LARGE_LEN_LSB) << 8 |
|
|
HME_ROM_READ_1(j + PCI_VPDRES_LARGE_LEN_MSB)) !=
|
|
PCI_VPD_SIZE + ETHER_ADDR_LEN ||
|
|
HME_ROM_READ_1(j + PCI_VPDRES_LARGE_DATA + PCI_VPD_KEY0) !=
|
|
0x4e /* N */ ||
|
|
HME_ROM_READ_1(j + PCI_VPDRES_LARGE_DATA + PCI_VPD_KEY1) !=
|
|
0x41 /* A */ ||
|
|
HME_ROM_READ_1(j + PCI_VPDRES_LARGE_DATA + PCI_VPD_LEN) !=
|
|
ETHER_ADDR_LEN) {
|
|
device_printf(dev, "unexpected PCI VPD\n");
|
|
error = ENXIO;
|
|
goto fail_rres;
|
|
}
|
|
bus_space_read_region_1(memt, memh, j + PCI_VPDRES_LARGE_DATA +
|
|
PCI_VPD_DATA, sc->sc_enaddr, ETHER_ADDR_LEN);
|
|
|
|
fail_rres:
|
|
bus_release_resource(ebus_dev, SYS_RES_MEMORY,
|
|
rman_get_rid(ebus_rres), ebus_rres);
|
|
fail_children:
|
|
free(children, M_TEMP);
|
|
if (error != 0)
|
|
goto fail_sres;
|
|
#endif
|
|
|
|
sc->sc_burst = 64; /* XXX */
|
|
|
|
/*
|
|
* call the main configure
|
|
*/
|
|
if ((error = hme_config(sc)) != 0) {
|
|
device_printf(dev, "could not be configured\n");
|
|
goto fail_ires;
|
|
}
|
|
|
|
if ((error = bus_setup_intr(dev, hsc->hsc_ires, INTR_TYPE_NET |
|
|
INTR_MPSAFE, NULL, hme_intr, sc, &hsc->hsc_ih)) != 0) {
|
|
device_printf(dev, "couldn't establish interrupt\n");
|
|
hme_detach(sc);
|
|
goto fail_ires;
|
|
}
|
|
return (0);
|
|
|
|
fail_ires:
|
|
bus_release_resource(dev, SYS_RES_IRQ,
|
|
rman_get_rid(hsc->hsc_ires), hsc->hsc_ires);
|
|
fail_sres:
|
|
bus_release_resource(dev, SYS_RES_MEMORY,
|
|
rman_get_rid(hsc->hsc_sres), hsc->hsc_sres);
|
|
fail_mtx:
|
|
mtx_destroy(&sc->sc_lock);
|
|
return (error);
|
|
}
|
|
|
|
static int
|
|
hme_pci_detach(device_t dev)
|
|
{
|
|
struct hme_pci_softc *hsc;
|
|
struct hme_softc *sc;
|
|
|
|
hsc = device_get_softc(dev);
|
|
sc = &hsc->hsc_hme;
|
|
bus_teardown_intr(dev, hsc->hsc_ires, hsc->hsc_ih);
|
|
hme_detach(sc);
|
|
bus_release_resource(dev, SYS_RES_IRQ,
|
|
rman_get_rid(hsc->hsc_ires), hsc->hsc_ires);
|
|
bus_release_resource(dev, SYS_RES_MEMORY,
|
|
rman_get_rid(hsc->hsc_sres), hsc->hsc_sres);
|
|
mtx_destroy(&sc->sc_lock);
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
hme_pci_suspend(device_t dev)
|
|
{
|
|
struct hme_pci_softc *hsc;
|
|
|
|
hsc = device_get_softc(dev);
|
|
hme_suspend(&hsc->hsc_hme);
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
hme_pci_resume(device_t dev)
|
|
{
|
|
struct hme_pci_softc *hsc;
|
|
|
|
hsc = device_get_softc(dev);
|
|
hme_resume(&hsc->hsc_hme);
|
|
return (0);
|
|
}
|