root/sys/dev/pcmcia/if_sm_pcmcia.c
/*      $OpenBSD: if_sm_pcmcia.c,v 1.41 2024/05/26 08:46:28 jsg Exp $   */
/*      $NetBSD: if_sm_pcmcia.c,v 1.11 1998/08/15 20:47:32 thorpej 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/param.h>
#include <sys/systm.h>
#include <sys/timeout.h>
#include <sys/device.h>

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

#include <netinet/in.h>
#include <netinet/if_ether.h>

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

#include <dev/mii/miivar.h>

#include <dev/ic/smc91cxxvar.h>

#include <dev/pcmcia/pcmciareg.h>
#include <dev/pcmcia/pcmciavar.h>
#include <dev/pcmcia/pcmciadevs.h>

int     sm_pcmcia_match(struct device *, void *, void *);
void    sm_pcmcia_attach(struct device *, struct device *, void *);
int     sm_pcmcia_detach(struct device *, int);
int     sm_pcmcia_activate(struct device *, int);

struct sm_pcmcia_softc {
        struct  smc91cxx_softc sc_smc;          /* real "smc" softc */

        /* PCMCIA-specific goo. */
        struct  pcmcia_io_handle sc_pcioh;      /* PCMCIA i/o space info */
        int     sc_io_window;                   /* our i/o window */
        void    *sc_ih;                         /* interrupt cookie */
        struct  pcmcia_function *sc_pf;         /* our PCMCIA function */
};

const struct cfattach sm_pcmcia_ca = {
        sizeof(struct sm_pcmcia_softc), sm_pcmcia_match, sm_pcmcia_attach,
        sm_pcmcia_detach, sm_pcmcia_activate
};

int     sm_pcmcia_enable(struct smc91cxx_softc *);
void    sm_pcmcia_disable(struct smc91cxx_softc *);

int     sm_pcmcia_ascii_enaddr(const char *, u_int8_t *);
int     sm_pcmcia_funce_enaddr(struct device *, u_int8_t *);

int     sm_pcmcia_lannid_ciscallback(struct pcmcia_tuple *, void *);

struct sm_pcmcia_product {
        u_int16_t       spp_vendor;     /* vendor ID */
        u_int16_t       spp_product;    /* product ID */
        int             spp_expfunc;    /* expected function */
} sm_pcmcia_prod[] = {
        { PCMCIA_VENDOR_MEGAHERTZ2,     PCMCIA_PRODUCT_MEGAHERTZ2_XJACK,
          0 },
        { PCMCIA_VENDOR_MEGAHERTZ2,     PCMCIA_PRODUCT_MEGAHERTZ2_XJEM1144,
          0 },
        { PCMCIA_VENDOR_NEWMEDIA,       PCMCIA_PRODUCT_NEWMEDIA_BASICS,
          0 },
        { PCMCIA_VENDOR_SMC,            PCMCIA_PRODUCT_SMC_8020,
          0 },
        { PCMCIA_VENDOR_PSION,          PCMCIA_PRODUCT_PSION_GOLDCARD,
          0 }
};

int
sm_pcmcia_match(struct device *parent, void *match, void *aux)
{
        struct pcmcia_attach_args *pa = aux;
        int i;

        for (i = 0; i < nitems(sm_pcmcia_prod); i++)
                if (pa->manufacturer == sm_pcmcia_prod[i].spp_vendor &&
                    pa->product == sm_pcmcia_prod[i].spp_product &&
                    pa->pf->number == sm_pcmcia_prod[i].spp_expfunc)
                        return (1);
        return (0);
}

void
sm_pcmcia_attach(struct device *parent, struct device *self, void *aux)
{
        struct sm_pcmcia_softc *psc = (struct sm_pcmcia_softc *)self;
        struct smc91cxx_softc *sc = &psc->sc_smc;
        struct pcmcia_attach_args *pa = aux;
        struct pcmcia_config_entry *cfe;
        u_int8_t myla[ETHER_ADDR_LEN], *enaddr = NULL;
        const char *intrstr;

        psc->sc_pf = pa->pf;
        cfe = SIMPLEQ_FIRST(&pa->pf->cfe_head);

        /* Enable the card. */
        pcmcia_function_init(pa->pf, cfe);
        if (pcmcia_function_enable(pa->pf)) {
                printf(": function enable failed\n");
                return;
        }

        /* XXX sanity check number of mem and i/o spaces */

        /* Allocate and map i/o space for the card. */
        if (pcmcia_io_alloc(pa->pf, 0, cfe->iospace[0].length,
            cfe->iospace[0].length, &psc->sc_pcioh)) {
                printf(": can't allocate i/o space\n");
                return;
        }

        sc->sc_bst = psc->sc_pcioh.iot;
        sc->sc_bsh = psc->sc_pcioh.ioh;

#ifdef notyet
        sc->sc_enable = sm_pcmcia_enable;
        sc->sc_disable = sm_pcmcia_disable;
#endif
        sc->sc_enabled = 1;

        if (pcmcia_io_map(pa->pf, (cfe->flags & PCMCIA_CFE_IO16) ?
            PCMCIA_WIDTH_IO16 : PCMCIA_WIDTH_IO8, 0, cfe->iospace[0].length,
            &psc->sc_pcioh, &psc->sc_io_window)) {
                printf(": can't map i/o space\n");
                return;
        }

        printf(" port 0x%lx/%lu", psc->sc_pcioh.addr,
            (u_long)psc->sc_pcioh.size);

        /*
         * First try to get the Ethernet address from FUNCE/LANNID tuple.
         */
        if (sm_pcmcia_funce_enaddr(parent, myla))
                enaddr = myla;

        /*
         * If that failed, try one of the CIS info strings.
         */
        if (enaddr == NULL) {
                char *cisstr = NULL;

                switch (pa->manufacturer) {
                case PCMCIA_VENDOR_MEGAHERTZ2:
                        cisstr = pa->pf->sc->card.cis1_info[3];
                        break;
                case PCMCIA_VENDOR_SMC:
                        cisstr = pa->pf->sc->card.cis1_info[2];
                        break;
                }
                if (cisstr != NULL && sm_pcmcia_ascii_enaddr(cisstr, myla))
                        enaddr = myla;
        }

        if (enaddr == NULL)
                printf(", unable to get Ethernet address\n");

        psc->sc_ih = pcmcia_intr_establish(psc->sc_pf, IPL_NET,
            smc91cxx_intr, sc, sc->sc_dev.dv_xname);
        intrstr = pcmcia_intr_string(psc->sc_pf, psc->sc_ih);
        if (*intrstr)
                printf(", %s", intrstr);

        /* Perform generic initialization. */
        smc91cxx_attach(sc, enaddr);

#ifdef notyet
        pcmcia_function_disable(pa->pf);
#endif
}

int
sm_pcmcia_detach(struct device *dev, int flags)
{
        struct sm_pcmcia_softc *psc = (struct sm_pcmcia_softc *)dev;
        struct ifnet *ifp = &psc->sc_smc.sc_arpcom.ac_if;
        int rv = 0;

        pcmcia_io_unmap(psc->sc_pf, psc->sc_io_window);
        pcmcia_io_free(psc->sc_pf, &psc->sc_pcioh);

        ether_ifdetach(ifp);
        if_detach(ifp);

        return (rv);
}

int
sm_pcmcia_activate(struct device *dev, int act)
{
        struct sm_pcmcia_softc *sc = (struct sm_pcmcia_softc *)dev;
        struct ifnet *ifp = &sc->sc_smc.sc_arpcom.ac_if;

        switch (act) {
        case DVACT_DEACTIVATE:
                ifp->if_timer = 0;
                if (ifp->if_flags & IFF_RUNNING)
                        smc91cxx_stop(&sc->sc_smc);
                if (sc->sc_ih)
                        pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
                sc->sc_ih = NULL;
                pcmcia_function_disable(sc->sc_pf);
                break;
        }
        return (0);
}

int
sm_pcmcia_ascii_enaddr(const char *cisstr, u_int8_t *myla)
{
        char enaddr_str[12];
        int i, j;

        if (strlen(cisstr) != 12) {
                /* Bogus address! */
                return (0);
        }
        bcopy(cisstr, enaddr_str, sizeof enaddr_str);
        for (i = 0; i < 6; i++) {
                for (j = 0; j < 2; j++) {
                        /* Convert to upper case. */
                        if (enaddr_str[(i * 2) + j] >= 'a' &&
                            enaddr_str[(i * 2) + j] <= 'z')
                                enaddr_str[(i * 2) + j] -= 'a' - 'A';

                        /* Parse the digit. */
                        if (enaddr_str[(i * 2) + j] >= '0' &&
                            enaddr_str[(i * 2) + j] <= '9')
                                myla[i] |= enaddr_str[(i * 2) + j]
                                    - '0';
                        else if (enaddr_str[(i * 2) + j] >= 'A' &&
                                 enaddr_str[(i * 2) + j] <= 'F')
                                myla[i] |= enaddr_str[(i * 2) + j]
                                    - 'A' + 10;
                        else {
                                /* Bogus digit!! */
                                return (0);
                        }

                        /* Compensate for ordering of digits. */
                        if (j == 0)
                                myla[i] <<= 4;
                }
        }

        return (1);
}

int
sm_pcmcia_funce_enaddr(struct device *parent, u_int8_t *myla)
{

        return (pcmcia_scan_cis(parent, sm_pcmcia_lannid_ciscallback, myla));
}

int
sm_pcmcia_lannid_ciscallback(struct pcmcia_tuple *tuple, void *arg)
{
        u_int8_t *myla = arg;
        int i;

        if (tuple->code == PCMCIA_CISTPL_FUNCE || tuple->code ==
            PCMCIA_CISTPL_SPCL) {
                /* subcode, length */
                if (tuple->length < 2)
                        return (0);

                if ((pcmcia_tuple_read_1(tuple, 0) !=
                     PCMCIA_TPLFE_TYPE_LAN_NID) ||
                    (pcmcia_tuple_read_1(tuple, 1) != ETHER_ADDR_LEN))
                        return (0);

                for (i = 0; i < ETHER_ADDR_LEN; i++)
                        myla[i] = pcmcia_tuple_read_1(tuple, i + 2);
                return (1);
        }
        return (0);
}

int
sm_pcmcia_enable(struct smc91cxx_softc *sc)
{
        struct sm_pcmcia_softc *psc = (struct sm_pcmcia_softc *)sc;

        /* Establish the interrupt handler. */
        psc->sc_ih = pcmcia_intr_establish(psc->sc_pf, IPL_NET, smc91cxx_intr,
            sc, sc->sc_dev.dv_xname);
        if (psc->sc_ih == NULL) {
                printf("%s: couldn't establish interrupt handler\n",
                    sc->sc_dev.dv_xname);
                return (1);
        }

        return (pcmcia_function_enable(psc->sc_pf));
}

void
sm_pcmcia_disable(struct smc91cxx_softc *sc)
{
        struct sm_pcmcia_softc *psc = (struct sm_pcmcia_softc *)sc;

        pcmcia_intr_disestablish(psc->sc_pf, psc->sc_ih);
        pcmcia_function_disable(psc->sc_pf);
}