/*      $OpenBSD: if_ral_cardbus.c,v 1.24 2024/05/24 06:26:47 jsg Exp $  */

/*-
 * Copyright (c) 2005-2010 Damien Bergamini <damien.bergamini@free.fr>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * CardBus front-end for the Ralink RT2560/RT2561/RT2860/RT3090 driver.
 */

#include "bpfilter.h"

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/timeout.h>
#include <sys/device.h>

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

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

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

#include <net80211/ieee80211_var.h>
#include <net80211/ieee80211_amrr.h>
#include <net80211/ieee80211_radiotap.h>

#include <dev/ic/rt2560var.h>
#include <dev/ic/rt2661var.h>
#include <dev/ic/rt2860var.h>

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

#include <dev/cardbus/cardbusvar.h>

static struct ral_opns {
        int     (*attach)(void *, int);
        int     (*detach)(void *);
        void    (*suspend)(void *);
        void    (*resume)(void *);
        int     (*intr)(void *);

}  ral_rt2560_opns = {
        rt2560_attach,
        rt2560_detach,
        rt2560_suspend,
        rt2560_wakeup,
        rt2560_intr

}, ral_rt2661_opns = {
        rt2661_attach,
        rt2661_detach,
        rt2661_suspend,
        rt2661_wakeup,
        rt2661_intr

}, ral_rt2860_opns = {
        rt2860_attach,
        rt2860_detach,
        rt2860_suspend,
        rt2860_wakeup,
        rt2860_intr
};

struct ral_cardbus_softc {
        union {
                struct rt2560_softc     sc_rt2560;
                struct rt2661_softc     sc_rt2661;
                struct rt2860_softc     sc_rt2860;
        } u;
#define sc_sc   u.sc_rt2560

        /* cardbus specific goo */
        struct ral_opns         *sc_opns;
        cardbus_devfunc_t       sc_ct;
        pcitag_t                sc_tag;
        void                    *sc_ih;
        bus_size_t              sc_mapsize;
        pcireg_t                sc_bar_val;
        int                     sc_intrline;
        pci_chipset_tag_t       sc_pc;
};

int     ral_cardbus_match(struct device *, void *, void *);
void    ral_cardbus_attach(struct device *, struct device *, void *);
int     ral_cardbus_detach(struct device *, int);
int     ral_cardbus_activate(struct device *, int);

const struct cfattach ral_cardbus_ca = {
        sizeof (struct ral_cardbus_softc), ral_cardbus_match,
        ral_cardbus_attach, ral_cardbus_detach,
        ral_cardbus_activate
};

static const struct pci_matchid ral_cardbus_devices[] = {
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2560 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2561 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2561S },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2661 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2860 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2890 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2760 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2790 },
        { PCI_VENDOR_AWT,    PCI_PRODUCT_AWT_RT2890 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_1 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_2 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_3 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_4 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_5 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_6 },
        { PCI_VENDOR_EDIMAX, PCI_PRODUCT_EDIMAX_RT2860_7 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3062 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3090 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3091 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3092 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3562 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3592 },
        { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT3593 }
};

int     ral_cardbus_enable(struct rt2560_softc *);
void    ral_cardbus_disable(struct rt2560_softc *);
void    ral_cardbus_setup(struct ral_cardbus_softc *);
void    ral_cardbus_wakeup(struct ral_cardbus_softc *);

int
ral_cardbus_match(struct device *parent, void *match, void *aux)
{
        return (cardbus_matchbyid((struct cardbus_attach_args *)aux,
            ral_cardbus_devices, nitems(ral_cardbus_devices)));
}

void
ral_cardbus_attach(struct device *parent, struct device *self, void *aux)
{
        struct ral_cardbus_softc *csc = (struct ral_cardbus_softc *)self;
        struct rt2560_softc *sc = &csc->sc_sc;
        struct cardbus_attach_args *ca = aux;
        cardbus_devfunc_t ct = ca->ca_ct;
        bus_addr_t base;
        int error;

        if (PCI_VENDOR(ca->ca_id) == PCI_VENDOR_RALINK) {
                switch (PCI_PRODUCT(ca->ca_id)) {
                case PCI_PRODUCT_RALINK_RT2560:
                        csc->sc_opns = &ral_rt2560_opns;
                        break;
                case PCI_PRODUCT_RALINK_RT2561:
                case PCI_PRODUCT_RALINK_RT2561S:
                case PCI_PRODUCT_RALINK_RT2661:
                        csc->sc_opns = &ral_rt2661_opns;
                        break;
                default:
                        csc->sc_opns = &ral_rt2860_opns;
                        break;
                }
        } else {
                /* all other vendors are RT2860 only */
                csc->sc_opns = &ral_rt2860_opns;
        }
        sc->sc_dmat = ca->ca_dmat;
        csc->sc_ct = ct;
        csc->sc_tag = ca->ca_tag;
        csc->sc_intrline = ca->ca_intrline;
        csc->sc_pc = ca->ca_pc;

        /* power management hooks */
        sc->sc_enable = ral_cardbus_enable;
        sc->sc_disable = ral_cardbus_disable;

        /* map control/status registers */
        error = Cardbus_mapreg_map(ct, CARDBUS_BASE0_REG,
            PCI_MAPREG_TYPE_MEM, 0, &sc->sc_st, &sc->sc_sh, &base,
            &csc->sc_mapsize);
        if (error != 0) {
                printf(": can't map mem space\n");
                return;
        }

        csc->sc_bar_val = base | PCI_MAPREG_TYPE_MEM;

        /* set up the PCI configuration registers */
        ral_cardbus_setup(csc);

        printf(": irq %d", csc->sc_intrline);

        (*csc->sc_opns->attach)(sc, PCI_PRODUCT(ca->ca_id));

        Cardbus_function_disable(ct);
}

int
ral_cardbus_detach(struct device *self, int flags)
{
        struct ral_cardbus_softc *csc = (struct ral_cardbus_softc *)self;
        struct rt2560_softc *sc = &csc->sc_sc;
        cardbus_devfunc_t ct = csc->sc_ct;
        cardbus_chipset_tag_t cc = ct->ct_cc;
        cardbus_function_tag_t cf = ct->ct_cf;
        int error;

        error = (*csc->sc_opns->detach)(sc);
        if (error != 0)
                return error;

        /* unhook the interrupt handler */
        if (csc->sc_ih != NULL) {
                cardbus_intr_disestablish(cc, cf, csc->sc_ih);
                csc->sc_ih = NULL;
        }

        /* release bus space and close window */
        Cardbus_mapreg_unmap(ct, CARDBUS_BASE0_REG, sc->sc_st, sc->sc_sh,
            csc->sc_mapsize);

        return 0;
}

int
ral_cardbus_activate(struct device *self, int act)
{
        struct ral_cardbus_softc *csc = (struct ral_cardbus_softc *)self;
        struct rt2560_softc *sc = &csc->sc_sc;

        switch (act) {
        case DVACT_SUSPEND:
                (*csc->sc_opns->suspend)(sc);
                break;
        case DVACT_WAKEUP:
                ral_cardbus_wakeup(csc);
                break;
        }

        return 0;
}

int
ral_cardbus_enable(struct rt2560_softc *sc)
{
        struct ral_cardbus_softc *csc = (struct ral_cardbus_softc *)sc;
        cardbus_devfunc_t ct = csc->sc_ct;
        cardbus_chipset_tag_t cc = ct->ct_cc;
        cardbus_function_tag_t cf = ct->ct_cf;

        /* power on the socket */
        Cardbus_function_enable(ct);

        /* setup the PCI configuration registers */
        ral_cardbus_setup(csc);

        /* map and establish the interrupt handler */
        csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline, IPL_NET,
            csc->sc_opns->intr, sc, sc->sc_dev.dv_xname);
        if (csc->sc_ih == NULL) {
                printf("%s: could not establish interrupt at %d\n",
                    sc->sc_dev.dv_xname, csc->sc_intrline);
                Cardbus_function_disable(ct);
                return 1;
        }

        return 0;
}

void
ral_cardbus_disable(struct rt2560_softc *sc)
{
        struct ral_cardbus_softc *csc = (struct ral_cardbus_softc *)sc;
        cardbus_devfunc_t ct = csc->sc_ct;
        cardbus_chipset_tag_t cc = ct->ct_cc;
        cardbus_function_tag_t cf = ct->ct_cf;

        /* unhook the interrupt handler */
        cardbus_intr_disestablish(cc, cf, csc->sc_ih);
        csc->sc_ih = NULL;

        /* power down the socket */
        Cardbus_function_disable(ct);
}

void
ral_cardbus_setup(struct ral_cardbus_softc *csc)
{
        cardbus_devfunc_t ct = csc->sc_ct;
        cardbus_chipset_tag_t cc = ct->ct_cc;
        pci_chipset_tag_t pc = csc->sc_pc;
        cardbus_function_tag_t cf = ct->ct_cf;
        pcireg_t reg;

        /* program the BAR */
        pci_conf_write(pc, csc->sc_tag, CARDBUS_BASE0_REG,
            csc->sc_bar_val);

        /* make sure the right access type is on the cardbus bridge */
        (*cf->cardbus_ctrl)(cc, CARDBUS_MEM_ENABLE);
        (*cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);

        /* enable the appropriate bits in the PCI CSR */
        reg = pci_conf_read(pc, csc->sc_tag,
            PCI_COMMAND_STATUS_REG);
        reg |= PCI_COMMAND_MASTER_ENABLE | PCI_COMMAND_MEM_ENABLE;
        pci_conf_write(pc, csc->sc_tag, PCI_COMMAND_STATUS_REG,
            reg);
}

void
ral_cardbus_wakeup(struct ral_cardbus_softc *csc)
{
        struct rt2560_softc *sc = &csc->sc_sc;
        int s;

        s = splnet();
        (*csc->sc_opns->resume)(sc);
        splx(s);
}